1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * TI DaVinci GPIO Support
5 * Copyright (c) 2006-2007 David Brownell
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>
25 #include <linux/pm_runtime.h>
27 #include <asm-generic/gpio.h>
29 #define MAX_REGS_BANKS 5
30 #define MAX_INT_PER_BANK 32
32 struct davinci_gpio_regs {
45 typedef struct irq_chip *(*gpio_get_irq_chip_cb_t)(unsigned int irq);
47 #define BINTEN 0x8 /* GPIO Interrupt Per-Bank Enable Register */
49 static void __iomem *gpio_base;
50 static unsigned int offset_array[5] = {0x10, 0x38, 0x60, 0x88, 0xb0};
52 struct davinci_gpio_irq_data {
54 struct davinci_gpio_controller *chip;
58 struct davinci_gpio_controller {
59 struct gpio_chip chip;
60 struct irq_domain *irq_domain;
61 /* Serialize access to GPIO registers */
63 void __iomem *regs[MAX_REGS_BANKS];
65 int irqs[MAX_INT_PER_BANK];
66 struct davinci_gpio_regs context[MAX_REGS_BANKS];
70 static inline u32 __gpio_mask(unsigned gpio)
72 return 1 << (gpio % 32);
75 static inline struct davinci_gpio_regs __iomem *irq2regs(struct irq_data *d)
77 struct davinci_gpio_regs __iomem *g;
79 g = (__force struct davinci_gpio_regs __iomem *)irq_data_get_irq_chip_data(d);
84 static int davinci_gpio_irq_setup(struct platform_device *pdev);
86 /*--------------------------------------------------------------------------*/
88 /* board setup code *MUST* setup pinmux and enable the GPIO clock. */
89 static inline int __davinci_direction(struct gpio_chip *chip,
90 unsigned offset, bool out, int value)
92 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
93 struct davinci_gpio_regs __iomem *g;
96 int bank = offset / 32;
97 u32 mask = __gpio_mask(offset);
100 spin_lock_irqsave(&d->lock, flags);
101 temp = readl_relaxed(&g->dir);
104 writel_relaxed(mask, value ? &g->set_data : &g->clr_data);
108 writel_relaxed(temp, &g->dir);
109 spin_unlock_irqrestore(&d->lock, flags);
114 static int davinci_direction_in(struct gpio_chip *chip, unsigned offset)
116 return __davinci_direction(chip, offset, false, 0);
120 davinci_direction_out(struct gpio_chip *chip, unsigned offset, int value)
122 return __davinci_direction(chip, offset, true, value);
126 * Read the pin's value (works even if it's set up as output);
127 * returns zero/nonzero.
129 * Note that changes are synched to the GPIO clock, so reading values back
130 * right after you've set them may give old values.
132 static int davinci_gpio_get(struct gpio_chip *chip, unsigned offset)
134 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
135 struct davinci_gpio_regs __iomem *g;
136 int bank = offset / 32;
140 return !!(__gpio_mask(offset) & readl_relaxed(&g->in_data));
144 * Assuming the pin is muxed as a gpio output, set its output value.
147 davinci_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
149 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
150 struct davinci_gpio_regs __iomem *g;
151 int bank = offset / 32;
155 writel_relaxed(__gpio_mask(offset),
156 value ? &g->set_data : &g->clr_data);
159 static struct davinci_gpio_platform_data *
160 davinci_gpio_get_pdata(struct platform_device *pdev)
162 struct device_node *dn = pdev->dev.of_node;
163 struct davinci_gpio_platform_data *pdata;
167 if (!IS_ENABLED(CONFIG_OF) || !pdev->dev.of_node)
168 return dev_get_platdata(&pdev->dev);
170 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
174 ret = of_property_read_u32(dn, "ti,ngpio", &val);
180 ret = of_property_read_u32(dn, "ti,davinci-gpio-unbanked", &val);
184 pdata->gpio_unbanked = val;
189 dev_err(&pdev->dev, "Populating pdata from DT failed: err %d\n", ret);
193 static int davinci_gpio_probe(struct platform_device *pdev)
195 int bank, i, ret = 0;
196 unsigned int ngpio, nbank, nirq;
197 struct davinci_gpio_controller *chips;
198 struct davinci_gpio_platform_data *pdata;
199 struct device *dev = &pdev->dev;
201 pdata = davinci_gpio_get_pdata(pdev);
203 dev_err(dev, "No platform data found\n");
207 dev->platform_data = pdata;
210 * The gpio banks conceptually expose a segmented bitmap,
211 * and "ngpio" is one more than the largest zero-based
212 * bit index that's valid.
214 ngpio = pdata->ngpio;
216 dev_err(dev, "How many GPIOs?\n");
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.request = gpiochip_generic_request;
258 chips->chip.free = gpiochip_generic_free;
260 spin_lock_init(&chips->lock);
262 nbank = DIV_ROUND_UP(ngpio, 32);
263 for (bank = 0; bank < nbank; bank++)
264 chips->regs[bank] = gpio_base + offset_array[bank];
266 ret = devm_gpiochip_add_data(dev, &chips->chip, chips);
270 platform_set_drvdata(pdev, chips);
271 ret = davinci_gpio_irq_setup(pdev);
278 /*--------------------------------------------------------------------------*/
280 * We expect irqs will normally be set up as input pins, but they can also be
281 * used as output pins ... which is convenient for testing.
283 * NOTE: The first few GPIOs also have direct INTC hookups in addition
284 * to their GPIOBNK0 irq, with a bit less overhead.
286 * All those INTC hookups (direct, plus several IRQ banks) can also
287 * serve as EDMA event triggers.
290 static void gpio_irq_disable(struct irq_data *d)
292 struct davinci_gpio_regs __iomem *g = irq2regs(d);
293 uintptr_t mask = (uintptr_t)irq_data_get_irq_handler_data(d);
295 writel_relaxed(mask, &g->clr_falling);
296 writel_relaxed(mask, &g->clr_rising);
299 static void gpio_irq_enable(struct irq_data *d)
301 struct davinci_gpio_regs __iomem *g = irq2regs(d);
302 uintptr_t mask = (uintptr_t)irq_data_get_irq_handler_data(d);
303 unsigned status = irqd_get_trigger_type(d);
305 status &= IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING;
307 status = IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING;
309 if (status & IRQ_TYPE_EDGE_FALLING)
310 writel_relaxed(mask, &g->set_falling);
311 if (status & IRQ_TYPE_EDGE_RISING)
312 writel_relaxed(mask, &g->set_rising);
315 static int gpio_irq_type(struct irq_data *d, unsigned trigger)
317 if (trigger & ~(IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
323 static struct irq_chip gpio_irqchip = {
325 .irq_enable = gpio_irq_enable,
326 .irq_disable = gpio_irq_disable,
327 .irq_set_type = gpio_irq_type,
328 .flags = IRQCHIP_SET_TYPE_MASKED,
331 static void gpio_irq_handler(struct irq_desc *desc)
333 struct davinci_gpio_regs __iomem *g;
336 struct davinci_gpio_controller *d;
337 struct davinci_gpio_irq_data *irqdata;
339 irqdata = (struct davinci_gpio_irq_data *)irq_desc_get_handler_data(desc);
340 bank_num = irqdata->bank_num;
344 /* we only care about one bank */
345 if ((bank_num % 2) == 1)
348 /* temporarily mask (level sensitive) parent IRQ */
349 chained_irq_enter(irq_desc_get_chip(desc), desc);
353 irq_hw_number_t hw_irq;
356 status = readl_relaxed(&g->intstat) & mask;
359 writel_relaxed(status, &g->intstat);
361 /* now demux them to the right lowlevel handler */
366 /* Max number of gpios per controller is 144 so
367 * hw_irq will be in [0..143]
369 hw_irq = (bank_num / 2) * 32 + bit;
371 generic_handle_domain_irq(d->irq_domain, hw_irq);
374 chained_irq_exit(irq_desc_get_chip(desc), desc);
375 /* now it may re-trigger */
378 static int gpio_to_irq_banked(struct gpio_chip *chip, unsigned offset)
380 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
383 return irq_create_mapping(d->irq_domain, offset);
388 static int gpio_to_irq_unbanked(struct gpio_chip *chip, unsigned offset)
390 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
393 * NOTE: we assume for now that only irqs in the first gpio_chip
394 * can provide direct-mapped IRQs to AINTC (up to 32 GPIOs).
396 if (offset < d->gpio_unbanked)
397 return d->irqs[offset];
402 static int gpio_irq_type_unbanked(struct irq_data *data, unsigned trigger)
404 struct davinci_gpio_controller *d;
405 struct davinci_gpio_regs __iomem *g;
408 d = (struct davinci_gpio_controller *)irq_data_get_irq_handler_data(data);
409 g = (struct davinci_gpio_regs __iomem *)d->regs[0];
410 for (i = 0; i < MAX_INT_PER_BANK; i++)
411 if (data->irq == d->irqs[i])
414 if (i == MAX_INT_PER_BANK)
417 mask = __gpio_mask(i);
419 if (trigger & ~(IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
422 writel_relaxed(mask, (trigger & IRQ_TYPE_EDGE_FALLING)
423 ? &g->set_falling : &g->clr_falling);
424 writel_relaxed(mask, (trigger & IRQ_TYPE_EDGE_RISING)
425 ? &g->set_rising : &g->clr_rising);
431 davinci_gpio_irq_map(struct irq_domain *d, unsigned int irq,
434 struct davinci_gpio_controller *chips =
435 (struct davinci_gpio_controller *)d->host_data;
436 struct davinci_gpio_regs __iomem *g = chips->regs[hw / 32];
438 irq_set_chip_and_handler_name(irq, &gpio_irqchip, handle_simple_irq,
440 irq_set_irq_type(irq, IRQ_TYPE_NONE);
441 irq_set_chip_data(irq, (__force void *)g);
442 irq_set_handler_data(irq, (void *)(uintptr_t)__gpio_mask(hw));
447 static const struct irq_domain_ops davinci_gpio_irq_ops = {
448 .map = davinci_gpio_irq_map,
449 .xlate = irq_domain_xlate_onetwocell,
452 static struct irq_chip *davinci_gpio_get_irq_chip(unsigned int irq)
454 static struct irq_chip_type gpio_unbanked;
456 gpio_unbanked = *irq_data_get_chip_type(irq_get_irq_data(irq));
458 return &gpio_unbanked.chip;
461 static struct irq_chip *keystone_gpio_get_irq_chip(unsigned int irq)
463 static struct irq_chip gpio_unbanked;
465 gpio_unbanked = *irq_get_chip(irq);
466 return &gpio_unbanked;
469 static const struct of_device_id davinci_gpio_ids[];
472 * NOTE: for suspend/resume, probably best to make a platform_device with
473 * suspend_late/resume_resume calls hooking into results of the set_wake()
474 * calls ... so if no gpios are wakeup events the clock can be disabled,
475 * with outputs left at previously set levels, and so that VDD3P3V.IOPWDN0
476 * (dm6446) can be set appropriately for GPIOV33 pins.
479 static int davinci_gpio_irq_setup(struct platform_device *pdev)
487 struct device *dev = &pdev->dev;
488 struct davinci_gpio_controller *chips = platform_get_drvdata(pdev);
489 struct davinci_gpio_platform_data *pdata = dev->platform_data;
490 struct davinci_gpio_regs __iomem *g;
491 struct irq_domain *irq_domain = NULL;
492 const struct of_device_id *match;
493 struct irq_chip *irq_chip;
494 struct davinci_gpio_irq_data *irqdata;
495 gpio_get_irq_chip_cb_t gpio_get_irq_chip;
498 * Use davinci_gpio_get_irq_chip by default to handle non DT cases
500 gpio_get_irq_chip = davinci_gpio_get_irq_chip;
501 match = of_match_device(of_match_ptr(davinci_gpio_ids),
504 gpio_get_irq_chip = (gpio_get_irq_chip_cb_t)match->data;
506 ngpio = pdata->ngpio;
508 clk = devm_clk_get(dev, "gpio");
510 dev_err(dev, "Error %ld getting gpio clock\n", PTR_ERR(clk));
514 ret = clk_prepare_enable(clk);
518 if (!pdata->gpio_unbanked) {
519 irq = devm_irq_alloc_descs(dev, -1, 0, ngpio, 0);
521 dev_err(dev, "Couldn't allocate IRQ numbers\n");
522 clk_disable_unprepare(clk);
526 irq_domain = irq_domain_add_legacy(dev->of_node, ngpio, irq, 0,
527 &davinci_gpio_irq_ops,
530 dev_err(dev, "Couldn't register an IRQ domain\n");
531 clk_disable_unprepare(clk);
537 * Arrange gpio_to_irq() support, handling either direct IRQs or
538 * banked IRQs. Having GPIOs in the first GPIO bank use direct
539 * IRQs, while the others use banked IRQs, would need some setup
540 * tweaks to recognize hardware which can do that.
542 chips->chip.to_irq = gpio_to_irq_banked;
543 chips->irq_domain = irq_domain;
546 * AINTC can handle direct/unbanked IRQs for GPIOs, with the GPIO
547 * controller only handling trigger modes. We currently assume no
548 * IRQ mux conflicts; gpio_irq_type_unbanked() is only for GPIOs.
550 if (pdata->gpio_unbanked) {
551 /* pass "bank 0" GPIO IRQs to AINTC */
552 chips->chip.to_irq = gpio_to_irq_unbanked;
553 chips->gpio_unbanked = pdata->gpio_unbanked;
554 binten = GENMASK(pdata->gpio_unbanked / 16, 0);
556 /* AINTC handles mask/unmask; GPIO handles triggering */
557 irq = chips->irqs[0];
558 irq_chip = gpio_get_irq_chip(irq);
559 irq_chip->name = "GPIO-AINTC";
560 irq_chip->irq_set_type = gpio_irq_type_unbanked;
562 /* default trigger: both edges */
564 writel_relaxed(~0, &g->set_falling);
565 writel_relaxed(~0, &g->set_rising);
567 /* set the direct IRQs up to use that irqchip */
568 for (gpio = 0; gpio < pdata->gpio_unbanked; gpio++) {
569 irq_set_chip(chips->irqs[gpio], irq_chip);
570 irq_set_handler_data(chips->irqs[gpio], chips);
571 irq_set_status_flags(chips->irqs[gpio],
579 * Or, AINTC can handle IRQs for banks of 16 GPIO IRQs, which we
580 * then chain through our own handler.
582 for (gpio = 0, bank = 0; gpio < ngpio; bank++, gpio += 16) {
583 /* disabled by default, enabled only as needed
584 * There are register sets for 32 GPIOs. 2 banks of 16
585 * GPIOs are covered by each set of registers hence divide by 2
587 g = chips->regs[bank / 2];
588 writel_relaxed(~0, &g->clr_falling);
589 writel_relaxed(~0, &g->clr_rising);
592 * Each chip handles 32 gpios, and each irq bank consists of 16
593 * gpio irqs. Pass the irq bank's corresponding controller to
594 * the chained irq handler.
596 irqdata = devm_kzalloc(&pdev->dev,
598 davinci_gpio_irq_data),
601 clk_disable_unprepare(clk);
606 irqdata->bank_num = bank;
607 irqdata->chip = chips;
609 irq_set_chained_handler_and_data(chips->irqs[bank],
610 gpio_irq_handler, irqdata);
617 * BINTEN -- per-bank interrupt enable. genirq would also let these
618 * bits be set/cleared dynamically.
620 writel_relaxed(binten, gpio_base + BINTEN);
625 static void davinci_gpio_save_context(struct davinci_gpio_controller *chips,
628 struct davinci_gpio_regs __iomem *g;
629 struct davinci_gpio_regs *context;
633 base = chips->regs[0] - offset_array[0];
634 chips->binten_context = readl_relaxed(base + BINTEN);
636 for (bank = 0; bank < nbank; bank++) {
637 g = chips->regs[bank];
638 context = &chips->context[bank];
639 context->dir = readl_relaxed(&g->dir);
640 context->set_data = readl_relaxed(&g->set_data);
641 context->set_rising = readl_relaxed(&g->set_rising);
642 context->set_falling = readl_relaxed(&g->set_falling);
645 /* Clear Bank interrupt enable bit */
646 writel_relaxed(0, base + BINTEN);
648 /* Clear all interrupt status registers */
649 writel_relaxed(GENMASK(31, 0), &g->intstat);
652 static void davinci_gpio_restore_context(struct davinci_gpio_controller *chips,
655 struct davinci_gpio_regs __iomem *g;
656 struct davinci_gpio_regs *context;
660 base = chips->regs[0] - offset_array[0];
662 if (readl_relaxed(base + BINTEN) != chips->binten_context)
663 writel_relaxed(chips->binten_context, base + BINTEN);
665 for (bank = 0; bank < nbank; bank++) {
666 g = chips->regs[bank];
667 context = &chips->context[bank];
668 if (readl_relaxed(&g->dir) != context->dir)
669 writel_relaxed(context->dir, &g->dir);
670 if (readl_relaxed(&g->set_data) != context->set_data)
671 writel_relaxed(context->set_data, &g->set_data);
672 if (readl_relaxed(&g->set_rising) != context->set_rising)
673 writel_relaxed(context->set_rising, &g->set_rising);
674 if (readl_relaxed(&g->set_falling) != context->set_falling)
675 writel_relaxed(context->set_falling, &g->set_falling);
679 static int davinci_gpio_suspend(struct device *dev)
681 struct davinci_gpio_controller *chips = dev_get_drvdata(dev);
682 struct davinci_gpio_platform_data *pdata = dev_get_platdata(dev);
683 u32 nbank = DIV_ROUND_UP(pdata->ngpio, 32);
685 davinci_gpio_save_context(chips, nbank);
690 static int davinci_gpio_resume(struct device *dev)
692 struct davinci_gpio_controller *chips = dev_get_drvdata(dev);
693 struct davinci_gpio_platform_data *pdata = dev_get_platdata(dev);
694 u32 nbank = DIV_ROUND_UP(pdata->ngpio, 32);
696 davinci_gpio_restore_context(chips, nbank);
701 DEFINE_SIMPLE_DEV_PM_OPS(davinci_gpio_dev_pm_ops, davinci_gpio_suspend,
702 davinci_gpio_resume);
704 static const struct of_device_id davinci_gpio_ids[] = {
705 { .compatible = "ti,keystone-gpio", keystone_gpio_get_irq_chip},
706 { .compatible = "ti,am654-gpio", keystone_gpio_get_irq_chip},
707 { .compatible = "ti,dm6441-gpio", davinci_gpio_get_irq_chip},
710 MODULE_DEVICE_TABLE(of, davinci_gpio_ids);
712 static struct platform_driver davinci_gpio_driver = {
713 .probe = davinci_gpio_probe,
715 .name = "davinci_gpio",
716 .pm = pm_sleep_ptr(&davinci_gpio_dev_pm_ops),
717 .of_match_table = of_match_ptr(davinci_gpio_ids),
722 * GPIO driver registration needs to be done before machine_init functions
723 * access GPIO. Hence davinci_gpio_drv_reg() is a postcore_initcall.
725 static int __init davinci_gpio_drv_reg(void)
727 return platform_driver_register(&davinci_gpio_driver);
729 postcore_initcall(davinci_gpio_drv_reg);
731 static void __exit davinci_gpio_exit(void)
733 platform_driver_unregister(&davinci_gpio_driver);
735 module_exit(davinci_gpio_exit);
738 MODULE_DESCRIPTION("DAVINCI GPIO driver");
739 MODULE_LICENSE("GPL");
740 MODULE_ALIAS("platform:gpio-davinci");