1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (C) 2003-2015 Broadcom Corporation
4 * All Rights Reserved
5 */
6
7#include <linux/gpio/driver.h>
8#include <linux/platform_device.h>
9#include <linux/module.h>
10#include <linux/irq.h>
11#include <linux/interrupt.h>
12#include <linux/irqchip/chained_irq.h>
13#include <linux/acpi.h>
14
15/*
16 * XLP GPIO has multiple 32 bit registers for each feature where each register
17 * controls 32 pins. So, pins up to 64 require 2 32-bit registers and up to 96
18 * require 3 32-bit registers for each feature.
19 * Here we only define offset of the first register for each feature. Offset of
20 * the registers for pins greater than 32 can be calculated as following(Use
21 * GPIO_INT_STAT as example):
22 *
23 * offset = (gpio / XLP_GPIO_REGSZ) * 4;
24 * reg_addr = addr + offset;
25 *
26 * where addr is base address of the that feature register and gpio is the pin.
27 */
28#define GPIO_9XX_BYTESWAP 0X00
29#define GPIO_9XX_CTRL 0X04
30#define GPIO_9XX_OUTPUT_EN 0x14
31#define GPIO_9XX_PADDRV 0x24
32/*
33 * Only for 4 interrupt enable reg are defined for now,
34 * total reg available are 12.
35 */
36#define GPIO_9XX_INT_EN00 0x44
37#define GPIO_9XX_INT_EN10 0x54
38#define GPIO_9XX_INT_EN20 0x64
39#define GPIO_9XX_INT_EN30 0x74
40#define GPIO_9XX_INT_POL 0x104
41#define GPIO_9XX_INT_TYPE 0x114
42#define GPIO_9XX_INT_STAT 0x124
43
44/* Interrupt type register mask */
45#define XLP_GPIO_IRQ_TYPE_LVL 0x0
46#define XLP_GPIO_IRQ_TYPE_EDGE 0x1
47
48/* Interrupt polarity register mask */
49#define XLP_GPIO_IRQ_POL_HIGH 0x0
50#define XLP_GPIO_IRQ_POL_LOW 0x1
51
52#define XLP_GPIO_REGSZ 32
53#define XLP_GPIO_IRQ_BASE 768
54#define XLP_MAX_NR_GPIO 96
55
56struct xlp_gpio_priv {
57 struct gpio_chip chip;
58 DECLARE_BITMAP(gpio_enabled_mask, XLP_MAX_NR_GPIO);
59 void __iomem *gpio_intr_en; /* pointer to first intr enable reg */
60 void __iomem *gpio_intr_stat; /* pointer to first intr status reg */
61 void __iomem *gpio_intr_type; /* pointer to first intr type reg */
62 void __iomem *gpio_intr_pol; /* pointer to first intr polarity reg */
63 void __iomem *gpio_out_en; /* pointer to first output enable reg */
64 void __iomem *gpio_paddrv; /* pointer to first pad drive reg */
65 spinlock_t lock;
66};
67
68static int xlp_gpio_get_reg(void __iomem *addr, unsigned gpio)
69{
70 u32 pos, regset;
71
72 pos = gpio % XLP_GPIO_REGSZ;
73 regset = (gpio / XLP_GPIO_REGSZ) * 4;
74 return !!(readl(addr: addr + regset) & BIT(pos));
75}
76
77static void xlp_gpio_set_reg(void __iomem *addr, unsigned gpio, int state)
78{
79 u32 value, pos, regset;
80
81 pos = gpio % XLP_GPIO_REGSZ;
82 regset = (gpio / XLP_GPIO_REGSZ) * 4;
83 value = readl(addr: addr + regset);
84
85 if (state)
86 value |= BIT(pos);
87 else
88 value &= ~BIT(pos);
89
90 writel(val: value, addr: addr + regset);
91}
92
93static void xlp_gpio_irq_enable(struct irq_data *d)
94{
95 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
96
97 gpiochip_enable_irq(gc, offset: irqd_to_hwirq(d));
98}
99
100static void xlp_gpio_irq_disable(struct irq_data *d)
101{
102 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
103 struct xlp_gpio_priv *priv = gpiochip_get_data(gc);
104 unsigned long flags;
105
106 spin_lock_irqsave(&priv->lock, flags);
107 xlp_gpio_set_reg(addr: priv->gpio_intr_en, gpio: d->hwirq, state: 0x0);
108 __clear_bit(d->hwirq, priv->gpio_enabled_mask);
109 spin_unlock_irqrestore(lock: &priv->lock, flags);
110 gpiochip_disable_irq(gc, offset: irqd_to_hwirq(d));
111}
112
113static void xlp_gpio_irq_mask_ack(struct irq_data *d)
114{
115 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
116 struct xlp_gpio_priv *priv = gpiochip_get_data(gc);
117 unsigned long flags;
118
119 spin_lock_irqsave(&priv->lock, flags);
120 xlp_gpio_set_reg(addr: priv->gpio_intr_en, gpio: d->hwirq, state: 0x0);
121 xlp_gpio_set_reg(addr: priv->gpio_intr_stat, gpio: d->hwirq, state: 0x1);
122 __clear_bit(d->hwirq, priv->gpio_enabled_mask);
123 spin_unlock_irqrestore(lock: &priv->lock, flags);
124}
125
126static void xlp_gpio_irq_unmask(struct irq_data *d)
127{
128 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
129 struct xlp_gpio_priv *priv = gpiochip_get_data(gc);
130 unsigned long flags;
131
132 spin_lock_irqsave(&priv->lock, flags);
133 xlp_gpio_set_reg(addr: priv->gpio_intr_en, gpio: d->hwirq, state: 0x1);
134 __set_bit(d->hwirq, priv->gpio_enabled_mask);
135 spin_unlock_irqrestore(lock: &priv->lock, flags);
136}
137
138static int xlp_gpio_set_irq_type(struct irq_data *d, unsigned int type)
139{
140 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
141 struct xlp_gpio_priv *priv = gpiochip_get_data(gc);
142 int pol, irq_type;
143
144 switch (type) {
145 case IRQ_TYPE_EDGE_RISING:
146 irq_type = XLP_GPIO_IRQ_TYPE_EDGE;
147 pol = XLP_GPIO_IRQ_POL_HIGH;
148 break;
149 case IRQ_TYPE_EDGE_FALLING:
150 irq_type = XLP_GPIO_IRQ_TYPE_EDGE;
151 pol = XLP_GPIO_IRQ_POL_LOW;
152 break;
153 case IRQ_TYPE_LEVEL_HIGH:
154 irq_type = XLP_GPIO_IRQ_TYPE_LVL;
155 pol = XLP_GPIO_IRQ_POL_HIGH;
156 break;
157 case IRQ_TYPE_LEVEL_LOW:
158 irq_type = XLP_GPIO_IRQ_TYPE_LVL;
159 pol = XLP_GPIO_IRQ_POL_LOW;
160 break;
161 default:
162 return -EINVAL;
163 }
164
165 xlp_gpio_set_reg(addr: priv->gpio_intr_type, gpio: d->hwirq, state: irq_type);
166 xlp_gpio_set_reg(addr: priv->gpio_intr_pol, gpio: d->hwirq, state: pol);
167
168 return 0;
169}
170
171static struct irq_chip xlp_gpio_irq_chip = {
172 .name = "XLP-GPIO",
173 .irq_mask_ack = xlp_gpio_irq_mask_ack,
174 .irq_enable = xlp_gpio_irq_enable,
175 .irq_disable = xlp_gpio_irq_disable,
176 .irq_set_type = xlp_gpio_set_irq_type,
177 .irq_unmask = xlp_gpio_irq_unmask,
178 .flags = IRQCHIP_ONESHOT_SAFE | IRQCHIP_IMMUTABLE,
179 GPIOCHIP_IRQ_RESOURCE_HELPERS,
180};
181
182static void xlp_gpio_generic_handler(struct irq_desc *desc)
183{
184 struct xlp_gpio_priv *priv = irq_desc_get_handler_data(desc);
185 struct irq_chip *irqchip = irq_desc_get_chip(desc);
186 int gpio, regoff;
187 u32 gpio_stat;
188
189 regoff = -1;
190 gpio_stat = 0;
191
192 chained_irq_enter(chip: irqchip, desc);
193 for_each_set_bit(gpio, priv->gpio_enabled_mask, XLP_MAX_NR_GPIO) {
194 if (regoff != gpio / XLP_GPIO_REGSZ) {
195 regoff = gpio / XLP_GPIO_REGSZ;
196 gpio_stat = readl(addr: priv->gpio_intr_stat + regoff * 4);
197 }
198
199 if (gpio_stat & BIT(gpio % XLP_GPIO_REGSZ))
200 generic_handle_domain_irq(domain: priv->chip.irq.domain, hwirq: gpio);
201 }
202 chained_irq_exit(chip: irqchip, desc);
203}
204
205static int xlp_gpio_dir_output(struct gpio_chip *gc, unsigned gpio, int state)
206{
207 struct xlp_gpio_priv *priv = gpiochip_get_data(gc);
208
209 BUG_ON(gpio >= gc->ngpio);
210 xlp_gpio_set_reg(addr: priv->gpio_out_en, gpio, state: 0x1);
211
212 return 0;
213}
214
215static int xlp_gpio_dir_input(struct gpio_chip *gc, unsigned gpio)
216{
217 struct xlp_gpio_priv *priv = gpiochip_get_data(gc);
218
219 BUG_ON(gpio >= gc->ngpio);
220 xlp_gpio_set_reg(addr: priv->gpio_out_en, gpio, state: 0x0);
221
222 return 0;
223}
224
225static int xlp_gpio_get(struct gpio_chip *gc, unsigned gpio)
226{
227 struct xlp_gpio_priv *priv = gpiochip_get_data(gc);
228
229 BUG_ON(gpio >= gc->ngpio);
230 return xlp_gpio_get_reg(addr: priv->gpio_paddrv, gpio);
231}
232
233static void xlp_gpio_set(struct gpio_chip *gc, unsigned gpio, int state)
234{
235 struct xlp_gpio_priv *priv = gpiochip_get_data(gc);
236
237 BUG_ON(gpio >= gc->ngpio);
238 xlp_gpio_set_reg(addr: priv->gpio_paddrv, gpio, state);
239}
240
241static int xlp_gpio_probe(struct platform_device *pdev)
242{
243 struct gpio_chip *gc;
244 struct gpio_irq_chip *girq;
245 struct xlp_gpio_priv *priv;
246 void __iomem *gpio_base;
247 int irq, err;
248
249 priv = devm_kzalloc(dev: &pdev->dev, size: sizeof(*priv), GFP_KERNEL);
250 if (!priv)
251 return -ENOMEM;
252
253 gpio_base = devm_platform_ioremap_resource(pdev, index: 0);
254 if (IS_ERR(ptr: gpio_base))
255 return PTR_ERR(ptr: gpio_base);
256
257 irq = platform_get_irq(pdev, 0);
258 if (irq < 0)
259 return irq;
260
261 priv->gpio_out_en = gpio_base + GPIO_9XX_OUTPUT_EN;
262 priv->gpio_paddrv = gpio_base + GPIO_9XX_PADDRV;
263 priv->gpio_intr_stat = gpio_base + GPIO_9XX_INT_STAT;
264 priv->gpio_intr_type = gpio_base + GPIO_9XX_INT_TYPE;
265 priv->gpio_intr_pol = gpio_base + GPIO_9XX_INT_POL;
266 priv->gpio_intr_en = gpio_base + GPIO_9XX_INT_EN00;
267
268 bitmap_zero(dst: priv->gpio_enabled_mask, XLP_MAX_NR_GPIO);
269
270 gc = &priv->chip;
271
272 gc->owner = THIS_MODULE;
273 gc->label = dev_name(dev: &pdev->dev);
274 gc->base = 0;
275 gc->parent = &pdev->dev;
276 gc->ngpio = 70;
277 gc->direction_output = xlp_gpio_dir_output;
278 gc->direction_input = xlp_gpio_dir_input;
279 gc->set = xlp_gpio_set;
280 gc->get = xlp_gpio_get;
281
282 spin_lock_init(&priv->lock);
283
284 girq = &gc->irq;
285 gpio_irq_chip_set_chip(girq, chip: &xlp_gpio_irq_chip);
286 girq->parent_handler = xlp_gpio_generic_handler;
287 girq->num_parents = 1;
288 girq->parents = devm_kcalloc(dev: &pdev->dev, n: 1,
289 size: sizeof(*girq->parents),
290 GFP_KERNEL);
291 if (!girq->parents)
292 return -ENOMEM;
293 girq->parents[0] = irq;
294 girq->first = 0;
295 girq->default_type = IRQ_TYPE_NONE;
296 girq->handler = handle_level_irq;
297
298 err = gpiochip_add_data(gc, priv);
299 if (err < 0)
300 return err;
301
302 dev_info(&pdev->dev, "registered %d GPIOs\n", gc->ngpio);
303
304 return 0;
305}
306
307#ifdef CONFIG_ACPI
308static const struct acpi_device_id xlp_gpio_acpi_match[] = {
309 { "BRCM9006" },
310 { "CAV9006" },
311 {},
312};
313MODULE_DEVICE_TABLE(acpi, xlp_gpio_acpi_match);
314#endif
315
316static struct platform_driver xlp_gpio_driver = {
317 .driver = {
318 .name = "xlp-gpio",
319 .acpi_match_table = ACPI_PTR(xlp_gpio_acpi_match),
320 },
321 .probe = xlp_gpio_probe,
322};
323module_platform_driver(xlp_gpio_driver);
324
325MODULE_AUTHOR("Kamlakant Patel <kamlakant.patel@broadcom.com>");
326MODULE_AUTHOR("Ganesan Ramalingam <ganesanr@broadcom.com>");
327MODULE_DESCRIPTION("Netlogic XLP GPIO Driver");
328MODULE_LICENSE("GPL v2");
329

source code of linux/drivers/gpio/gpio-xlp.c