1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * TI DaVinci GPIO Support
5 * Copyright (c) 2006-2007 David Brownell
6 * Copyright (c) 2007, MontaVista Software, Inc. <source@mvista.com>
9 #include <linux/gpio/driver.h>
10 #include <linux/errno.h>
11 #include <linux/kernel.h>
12 #include <linux/clk.h>
13 #include <linux/err.h>
15 #include <linux/irq.h>
16 #include <linux/irqdomain.h>
17 #include <linux/module.h>
19 #include <linux/of_device.h>
20 #include <linux/pinctrl/consumer.h>
21 #include <linux/platform_device.h>
22 #include <linux/platform_data/gpio-davinci.h>
23 #include <linux/irqchip/chained_irq.h>
24 #include <linux/spinlock.h>
26 #include <asm-generic/gpio.h>
28 #define MAX_REGS_BANKS 5
29 #define MAX_INT_PER_BANK 32
31 struct davinci_gpio_regs
{
44 typedef struct irq_chip
*(*gpio_get_irq_chip_cb_t
)(unsigned int irq
);
46 #define BINTEN 0x8 /* GPIO Interrupt Per-Bank Enable Register */
48 static void __iomem
*gpio_base
;
49 static unsigned int offset_array
[5] = {0x10, 0x38, 0x60, 0x88, 0xb0};
51 struct davinci_gpio_irq_data
{
53 struct davinci_gpio_controller
*chip
;
57 struct davinci_gpio_controller
{
58 struct gpio_chip chip
;
59 struct irq_domain
*irq_domain
;
60 /* Serialize access to GPIO registers */
62 void __iomem
*regs
[MAX_REGS_BANKS
];
64 int irqs
[MAX_INT_PER_BANK
];
67 static inline u32
__gpio_mask(unsigned gpio
)
69 return 1 << (gpio
% 32);
72 static inline struct davinci_gpio_regs __iomem
*irq2regs(struct irq_data
*d
)
74 struct davinci_gpio_regs __iomem
*g
;
76 g
= (__force
struct davinci_gpio_regs __iomem
*)irq_data_get_irq_chip_data(d
);
81 static int davinci_gpio_irq_setup(struct platform_device
*pdev
);
83 /*--------------------------------------------------------------------------*/
85 /* board setup code *MUST* setup pinmux and enable the GPIO clock. */
86 static inline int __davinci_direction(struct gpio_chip
*chip
,
87 unsigned offset
, bool out
, int value
)
89 struct davinci_gpio_controller
*d
= gpiochip_get_data(chip
);
90 struct davinci_gpio_regs __iomem
*g
;
93 int bank
= offset
/ 32;
94 u32 mask
= __gpio_mask(offset
);
97 spin_lock_irqsave(&d
->lock
, flags
);
98 temp
= readl_relaxed(&g
->dir
);
101 writel_relaxed(mask
, value
? &g
->set_data
: &g
->clr_data
);
105 writel_relaxed(temp
, &g
->dir
);
106 spin_unlock_irqrestore(&d
->lock
, flags
);
111 static int davinci_direction_in(struct gpio_chip
*chip
, unsigned offset
)
113 return __davinci_direction(chip
, offset
, false, 0);
117 davinci_direction_out(struct gpio_chip
*chip
, unsigned offset
, int value
)
119 return __davinci_direction(chip
, offset
, true, value
);
123 * Read the pin's value (works even if it's set up as output);
124 * returns zero/nonzero.
126 * Note that changes are synched to the GPIO clock, so reading values back
127 * right after you've set them may give old values.
129 static int davinci_gpio_get(struct gpio_chip
*chip
, unsigned offset
)
131 struct davinci_gpio_controller
*d
= gpiochip_get_data(chip
);
132 struct davinci_gpio_regs __iomem
*g
;
133 int bank
= offset
/ 32;
137 return !!(__gpio_mask(offset
) & readl_relaxed(&g
->in_data
));
141 * Assuming the pin is muxed as a gpio output, set its output value.
144 davinci_gpio_set(struct gpio_chip
*chip
, unsigned offset
, int value
)
146 struct davinci_gpio_controller
*d
= gpiochip_get_data(chip
);
147 struct davinci_gpio_regs __iomem
*g
;
148 int bank
= offset
/ 32;
152 writel_relaxed(__gpio_mask(offset
),
153 value
? &g
->set_data
: &g
->clr_data
);
156 static struct davinci_gpio_platform_data
*
157 davinci_gpio_get_pdata(struct platform_device
*pdev
)
159 struct device_node
*dn
= pdev
->dev
.of_node
;
160 struct davinci_gpio_platform_data
*pdata
;
164 if (!IS_ENABLED(CONFIG_OF
) || !pdev
->dev
.of_node
)
165 return dev_get_platdata(&pdev
->dev
);
167 pdata
= devm_kzalloc(&pdev
->dev
, sizeof(*pdata
), GFP_KERNEL
);
171 ret
= of_property_read_u32(dn
, "ti,ngpio", &val
);
177 ret
= of_property_read_u32(dn
, "ti,davinci-gpio-unbanked", &val
);
181 pdata
->gpio_unbanked
= val
;
186 dev_err(&pdev
->dev
, "Populating pdata from DT failed: err %d\n", ret
);
190 static int davinci_gpio_probe(struct platform_device
*pdev
)
192 int bank
, i
, ret
= 0;
193 unsigned int ngpio
, nbank
, nirq
;
194 struct davinci_gpio_controller
*chips
;
195 struct davinci_gpio_platform_data
*pdata
;
196 struct device
*dev
= &pdev
->dev
;
198 pdata
= davinci_gpio_get_pdata(pdev
);
200 dev_err(dev
, "No platform data found\n");
204 dev
->platform_data
= pdata
;
207 * The gpio banks conceptually expose a segmented bitmap,
208 * and "ngpio" is one more than the largest zero-based
209 * bit index that's valid.
211 ngpio
= pdata
->ngpio
;
213 dev_err(dev
, "How many GPIOs?\n");
217 if (WARN_ON(ARCH_NR_GPIOS
< ngpio
))
218 ngpio
= ARCH_NR_GPIOS
;
221 * If there are unbanked interrupts then the number of
222 * interrupts is equal to number of gpios else all are banked so
223 * number of interrupts is equal to number of banks(each with 16 gpios)
225 if (pdata
->gpio_unbanked
)
226 nirq
= pdata
->gpio_unbanked
;
228 nirq
= DIV_ROUND_UP(ngpio
, 16);
230 chips
= devm_kzalloc(dev
, sizeof(*chips
), GFP_KERNEL
);
234 gpio_base
= devm_platform_ioremap_resource(pdev
, 0);
235 if (IS_ERR(gpio_base
))
236 return PTR_ERR(gpio_base
);
238 for (i
= 0; i
< nirq
; i
++) {
239 chips
->irqs
[i
] = platform_get_irq(pdev
, i
);
240 if (chips
->irqs
[i
] < 0)
241 return dev_err_probe(dev
, chips
->irqs
[i
], "IRQ not populated\n");
244 chips
->chip
.label
= dev_name(dev
);
246 chips
->chip
.direction_input
= davinci_direction_in
;
247 chips
->chip
.get
= davinci_gpio_get
;
248 chips
->chip
.direction_output
= davinci_direction_out
;
249 chips
->chip
.set
= davinci_gpio_set
;
251 chips
->chip
.ngpio
= ngpio
;
252 chips
->chip
.base
= pdata
->no_auto_base
? pdata
->base
: -1;
254 #ifdef CONFIG_OF_GPIO
255 chips
->chip
.of_gpio_n_cells
= 2;
256 chips
->chip
.parent
= dev
;
257 chips
->chip
.of_node
= dev
->of_node
;
258 chips
->chip
.request
= gpiochip_generic_request
;
259 chips
->chip
.free
= gpiochip_generic_free
;
261 spin_lock_init(&chips
->lock
);
263 nbank
= DIV_ROUND_UP(ngpio
, 32);
264 for (bank
= 0; bank
< nbank
; bank
++)
265 chips
->regs
[bank
] = gpio_base
+ offset_array
[bank
];
267 ret
= devm_gpiochip_add_data(dev
, &chips
->chip
, chips
);
271 platform_set_drvdata(pdev
, chips
);
272 ret
= davinci_gpio_irq_setup(pdev
);
279 /*--------------------------------------------------------------------------*/
281 * We expect irqs will normally be set up as input pins, but they can also be
282 * used as output pins ... which is convenient for testing.
284 * NOTE: The first few GPIOs also have direct INTC hookups in addition
285 * to their GPIOBNK0 irq, with a bit less overhead.
287 * All those INTC hookups (direct, plus several IRQ banks) can also
288 * serve as EDMA event triggers.
291 static void gpio_irq_disable(struct irq_data
*d
)
293 struct davinci_gpio_regs __iomem
*g
= irq2regs(d
);
294 uintptr_t mask
= (uintptr_t)irq_data_get_irq_handler_data(d
);
296 writel_relaxed(mask
, &g
->clr_falling
);
297 writel_relaxed(mask
, &g
->clr_rising
);
300 static void gpio_irq_enable(struct irq_data
*d
)
302 struct davinci_gpio_regs __iomem
*g
= irq2regs(d
);
303 uintptr_t mask
= (uintptr_t)irq_data_get_irq_handler_data(d
);
304 unsigned status
= irqd_get_trigger_type(d
);
306 status
&= IRQ_TYPE_EDGE_FALLING
| IRQ_TYPE_EDGE_RISING
;
308 status
= IRQ_TYPE_EDGE_FALLING
| IRQ_TYPE_EDGE_RISING
;
310 if (status
& IRQ_TYPE_EDGE_FALLING
)
311 writel_relaxed(mask
, &g
->set_falling
);
312 if (status
& IRQ_TYPE_EDGE_RISING
)
313 writel_relaxed(mask
, &g
->set_rising
);
316 static int gpio_irq_type(struct irq_data
*d
, unsigned trigger
)
318 if (trigger
& ~(IRQ_TYPE_EDGE_FALLING
| IRQ_TYPE_EDGE_RISING
))
324 static struct irq_chip gpio_irqchip
= {
326 .irq_enable
= gpio_irq_enable
,
327 .irq_disable
= gpio_irq_disable
,
328 .irq_set_type
= gpio_irq_type
,
329 .flags
= IRQCHIP_SET_TYPE_MASKED
,
332 static void gpio_irq_handler(struct irq_desc
*desc
)
334 struct davinci_gpio_regs __iomem
*g
;
337 struct davinci_gpio_controller
*d
;
338 struct davinci_gpio_irq_data
*irqdata
;
340 irqdata
= (struct davinci_gpio_irq_data
*)irq_desc_get_handler_data(desc
);
341 bank_num
= irqdata
->bank_num
;
345 /* we only care about one bank */
346 if ((bank_num
% 2) == 1)
349 /* temporarily mask (level sensitive) parent IRQ */
350 chained_irq_enter(irq_desc_get_chip(desc
), desc
);
354 irq_hw_number_t hw_irq
;
357 status
= readl_relaxed(&g
->intstat
) & mask
;
360 writel_relaxed(status
, &g
->intstat
);
362 /* now demux them to the right lowlevel handler */
367 /* Max number of gpios per controller is 144 so
368 * hw_irq will be in [0..143]
370 hw_irq
= (bank_num
/ 2) * 32 + bit
;
373 irq_find_mapping(d
->irq_domain
, hw_irq
));
376 chained_irq_exit(irq_desc_get_chip(desc
), desc
);
377 /* now it may re-trigger */
380 static int gpio_to_irq_banked(struct gpio_chip
*chip
, unsigned offset
)
382 struct davinci_gpio_controller
*d
= gpiochip_get_data(chip
);
385 return irq_create_mapping(d
->irq_domain
, offset
);
390 static int gpio_to_irq_unbanked(struct gpio_chip
*chip
, unsigned offset
)
392 struct davinci_gpio_controller
*d
= gpiochip_get_data(chip
);
395 * NOTE: we assume for now that only irqs in the first gpio_chip
396 * can provide direct-mapped IRQs to AINTC (up to 32 GPIOs).
398 if (offset
< d
->gpio_unbanked
)
399 return d
->irqs
[offset
];
404 static int gpio_irq_type_unbanked(struct irq_data
*data
, unsigned trigger
)
406 struct davinci_gpio_controller
*d
;
407 struct davinci_gpio_regs __iomem
*g
;
410 d
= (struct davinci_gpio_controller
*)irq_data_get_irq_handler_data(data
);
411 g
= (struct davinci_gpio_regs __iomem
*)d
->regs
[0];
412 for (i
= 0; i
< MAX_INT_PER_BANK
; i
++)
413 if (data
->irq
== d
->irqs
[i
])
416 if (i
== MAX_INT_PER_BANK
)
419 mask
= __gpio_mask(i
);
421 if (trigger
& ~(IRQ_TYPE_EDGE_FALLING
| IRQ_TYPE_EDGE_RISING
))
424 writel_relaxed(mask
, (trigger
& IRQ_TYPE_EDGE_FALLING
)
425 ? &g
->set_falling
: &g
->clr_falling
);
426 writel_relaxed(mask
, (trigger
& IRQ_TYPE_EDGE_RISING
)
427 ? &g
->set_rising
: &g
->clr_rising
);
433 davinci_gpio_irq_map(struct irq_domain
*d
, unsigned int irq
,
436 struct davinci_gpio_controller
*chips
=
437 (struct davinci_gpio_controller
*)d
->host_data
;
438 struct davinci_gpio_regs __iomem
*g
= chips
->regs
[hw
/ 32];
440 irq_set_chip_and_handler_name(irq
, &gpio_irqchip
, handle_simple_irq
,
442 irq_set_irq_type(irq
, IRQ_TYPE_NONE
);
443 irq_set_chip_data(irq
, (__force
void *)g
);
444 irq_set_handler_data(irq
, (void *)(uintptr_t)__gpio_mask(hw
));
449 static const struct irq_domain_ops davinci_gpio_irq_ops
= {
450 .map
= davinci_gpio_irq_map
,
451 .xlate
= irq_domain_xlate_onetwocell
,
454 static struct irq_chip
*davinci_gpio_get_irq_chip(unsigned int irq
)
456 static struct irq_chip_type gpio_unbanked
;
458 gpio_unbanked
= *irq_data_get_chip_type(irq_get_irq_data(irq
));
460 return &gpio_unbanked
.chip
;
463 static struct irq_chip
*keystone_gpio_get_irq_chip(unsigned int irq
)
465 static struct irq_chip gpio_unbanked
;
467 gpio_unbanked
= *irq_get_chip(irq
);
468 return &gpio_unbanked
;
471 static const struct of_device_id davinci_gpio_ids
[];
474 * NOTE: for suspend/resume, probably best to make a platform_device with
475 * suspend_late/resume_resume calls hooking into results of the set_wake()
476 * calls ... so if no gpios are wakeup events the clock can be disabled,
477 * with outputs left at previously set levels, and so that VDD3P3V.IOPWDN0
478 * (dm6446) can be set appropriately for GPIOV33 pins.
481 static int davinci_gpio_irq_setup(struct platform_device
*pdev
)
489 struct device
*dev
= &pdev
->dev
;
490 struct davinci_gpio_controller
*chips
= platform_get_drvdata(pdev
);
491 struct davinci_gpio_platform_data
*pdata
= dev
->platform_data
;
492 struct davinci_gpio_regs __iomem
*g
;
493 struct irq_domain
*irq_domain
= NULL
;
494 const struct of_device_id
*match
;
495 struct irq_chip
*irq_chip
;
496 struct davinci_gpio_irq_data
*irqdata
;
497 gpio_get_irq_chip_cb_t gpio_get_irq_chip
;
500 * Use davinci_gpio_get_irq_chip by default to handle non DT cases
502 gpio_get_irq_chip
= davinci_gpio_get_irq_chip
;
503 match
= of_match_device(of_match_ptr(davinci_gpio_ids
),
506 gpio_get_irq_chip
= (gpio_get_irq_chip_cb_t
)match
->data
;
508 ngpio
= pdata
->ngpio
;
510 clk
= devm_clk_get(dev
, "gpio");
512 dev_err(dev
, "Error %ld getting gpio clock\n", PTR_ERR(clk
));
516 ret
= clk_prepare_enable(clk
);
520 if (!pdata
->gpio_unbanked
) {
521 irq
= devm_irq_alloc_descs(dev
, -1, 0, ngpio
, 0);
523 dev_err(dev
, "Couldn't allocate IRQ numbers\n");
524 clk_disable_unprepare(clk
);
528 irq_domain
= irq_domain_add_legacy(dev
->of_node
, ngpio
, irq
, 0,
529 &davinci_gpio_irq_ops
,
532 dev_err(dev
, "Couldn't register an IRQ domain\n");
533 clk_disable_unprepare(clk
);
539 * Arrange gpio_to_irq() support, handling either direct IRQs or
540 * banked IRQs. Having GPIOs in the first GPIO bank use direct
541 * IRQs, while the others use banked IRQs, would need some setup
542 * tweaks to recognize hardware which can do that.
544 chips
->chip
.to_irq
= gpio_to_irq_banked
;
545 chips
->irq_domain
= irq_domain
;
548 * AINTC can handle direct/unbanked IRQs for GPIOs, with the GPIO
549 * controller only handling trigger modes. We currently assume no
550 * IRQ mux conflicts; gpio_irq_type_unbanked() is only for GPIOs.
552 if (pdata
->gpio_unbanked
) {
553 /* pass "bank 0" GPIO IRQs to AINTC */
554 chips
->chip
.to_irq
= gpio_to_irq_unbanked
;
555 chips
->gpio_unbanked
= pdata
->gpio_unbanked
;
556 binten
= GENMASK(pdata
->gpio_unbanked
/ 16, 0);
558 /* AINTC handles mask/unmask; GPIO handles triggering */
559 irq
= chips
->irqs
[0];
560 irq_chip
= gpio_get_irq_chip(irq
);
561 irq_chip
->name
= "GPIO-AINTC";
562 irq_chip
->irq_set_type
= gpio_irq_type_unbanked
;
564 /* default trigger: both edges */
566 writel_relaxed(~0, &g
->set_falling
);
567 writel_relaxed(~0, &g
->set_rising
);
569 /* set the direct IRQs up to use that irqchip */
570 for (gpio
= 0; gpio
< pdata
->gpio_unbanked
; gpio
++) {
571 irq_set_chip(chips
->irqs
[gpio
], irq_chip
);
572 irq_set_handler_data(chips
->irqs
[gpio
], chips
);
573 irq_set_status_flags(chips
->irqs
[gpio
],
581 * Or, AINTC can handle IRQs for banks of 16 GPIO IRQs, which we
582 * then chain through our own handler.
584 for (gpio
= 0, bank
= 0; gpio
< ngpio
; bank
++, gpio
+= 16) {
585 /* disabled by default, enabled only as needed
586 * There are register sets for 32 GPIOs. 2 banks of 16
587 * GPIOs are covered by each set of registers hence divide by 2
589 g
= chips
->regs
[bank
/ 2];
590 writel_relaxed(~0, &g
->clr_falling
);
591 writel_relaxed(~0, &g
->clr_rising
);
594 * Each chip handles 32 gpios, and each irq bank consists of 16
595 * gpio irqs. Pass the irq bank's corresponding controller to
596 * the chained irq handler.
598 irqdata
= devm_kzalloc(&pdev
->dev
,
600 davinci_gpio_irq_data
),
603 clk_disable_unprepare(clk
);
608 irqdata
->bank_num
= bank
;
609 irqdata
->chip
= chips
;
611 irq_set_chained_handler_and_data(chips
->irqs
[bank
],
612 gpio_irq_handler
, irqdata
);
619 * BINTEN -- per-bank interrupt enable. genirq would also let these
620 * bits be set/cleared dynamically.
622 writel_relaxed(binten
, gpio_base
+ BINTEN
);
627 static const struct of_device_id davinci_gpio_ids
[] = {
628 { .compatible
= "ti,keystone-gpio", keystone_gpio_get_irq_chip
},
629 { .compatible
= "ti,am654-gpio", keystone_gpio_get_irq_chip
},
630 { .compatible
= "ti,dm6441-gpio", davinci_gpio_get_irq_chip
},
633 MODULE_DEVICE_TABLE(of
, davinci_gpio_ids
);
635 static struct platform_driver davinci_gpio_driver
= {
636 .probe
= davinci_gpio_probe
,
638 .name
= "davinci_gpio",
639 .of_match_table
= of_match_ptr(davinci_gpio_ids
),
644 * GPIO driver registration needs to be done before machine_init functions
645 * access GPIO. Hence davinci_gpio_drv_reg() is a postcore_initcall.
647 static int __init
davinci_gpio_drv_reg(void)
649 return platform_driver_register(&davinci_gpio_driver
);
651 postcore_initcall(davinci_gpio_drv_reg
);