2 * TI DaVinci GPIO Support
4 * Copyright (c) 2006-2007 David Brownell
5 * Copyright (c) 2007, MontaVista Software, Inc. <source@mvista.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 #include <linux/gpio.h>
13 #include <linux/errno.h>
14 #include <linux/kernel.h>
15 #include <linux/clk.h>
16 #include <linux/err.h>
18 #include <linux/irq.h>
19 #include <linux/irqdomain.h>
20 #include <linux/module.h>
22 #include <linux/of_device.h>
23 #include <linux/platform_device.h>
24 #include <linux/platform_data/gpio-davinci.h>
25 #include <linux/irqchip/chained_irq.h>
27 struct davinci_gpio_regs {
40 typedef struct irq_chip *(*gpio_get_irq_chip_cb_t)(unsigned int irq);
42 #define BINTEN 0x8 /* GPIO Interrupt Per-Bank Enable Register */
44 static void __iomem *gpio_base;
46 static struct davinci_gpio_regs __iomem *gpio2regs(unsigned gpio)
51 ptr = gpio_base + 0x10;
52 else if (gpio < 32 * 2)
53 ptr = gpio_base + 0x38;
54 else if (gpio < 32 * 3)
55 ptr = gpio_base + 0x60;
56 else if (gpio < 32 * 4)
57 ptr = gpio_base + 0x88;
58 else if (gpio < 32 * 5)
59 ptr = gpio_base + 0xb0;
65 static inline struct davinci_gpio_regs __iomem *irq2regs(struct irq_data *d)
67 struct davinci_gpio_regs __iomem *g;
69 g = (__force struct davinci_gpio_regs __iomem *)irq_data_get_irq_chip_data(d);
74 static int davinci_gpio_irq_setup(struct platform_device *pdev);
76 /*--------------------------------------------------------------------------*/
78 /* board setup code *MUST* setup pinmux and enable the GPIO clock. */
79 static inline int __davinci_direction(struct gpio_chip *chip,
80 unsigned offset, bool out, int value)
82 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
83 struct davinci_gpio_regs __iomem *g = d->regs;
86 u32 mask = 1 << offset;
88 spin_lock_irqsave(&d->lock, flags);
89 temp = readl_relaxed(&g->dir);
92 writel_relaxed(mask, value ? &g->set_data : &g->clr_data);
96 writel_relaxed(temp, &g->dir);
97 spin_unlock_irqrestore(&d->lock, flags);
102 static int davinci_direction_in(struct gpio_chip *chip, unsigned offset)
104 return __davinci_direction(chip, offset, false, 0);
108 davinci_direction_out(struct gpio_chip *chip, unsigned offset, int value)
110 return __davinci_direction(chip, offset, true, value);
114 * Read the pin's value (works even if it's set up as output);
115 * returns zero/nonzero.
117 * Note that changes are synched to the GPIO clock, so reading values back
118 * right after you've set them may give old values.
120 static int davinci_gpio_get(struct gpio_chip *chip, unsigned offset)
122 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
123 struct davinci_gpio_regs __iomem *g = d->regs;
125 return !!((1 << offset) & readl_relaxed(&g->in_data));
129 * Assuming the pin is muxed as a gpio output, set its output value.
132 davinci_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
134 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
135 struct davinci_gpio_regs __iomem *g = d->regs;
137 writel_relaxed((1 << offset), value ? &g->set_data : &g->clr_data);
140 static struct davinci_gpio_platform_data *
141 davinci_gpio_get_pdata(struct platform_device *pdev)
143 struct device_node *dn = pdev->dev.of_node;
144 struct davinci_gpio_platform_data *pdata;
148 if (!IS_ENABLED(CONFIG_OF) || !pdev->dev.of_node)
149 return dev_get_platdata(&pdev->dev);
151 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
155 ret = of_property_read_u32(dn, "ti,ngpio", &val);
161 ret = of_property_read_u32(dn, "ti,davinci-gpio-unbanked", &val);
165 pdata->gpio_unbanked = val;
170 dev_err(&pdev->dev, "Populating pdata from DT failed: err %d\n", ret);
174 #ifdef CONFIG_OF_GPIO
175 static int davinci_gpio_of_xlate(struct gpio_chip *gc,
176 const struct of_phandle_args *gpiospec,
179 struct davinci_gpio_controller *chips = dev_get_drvdata(gc->parent);
180 struct davinci_gpio_platform_data *pdata = dev_get_platdata(gc->parent);
182 if (gpiospec->args[0] > pdata->ngpio)
185 if (gc != &chips[gpiospec->args[0] / 32].chip)
189 *flags = gpiospec->args[1];
191 return gpiospec->args[0] % 32;
195 static int davinci_gpio_probe(struct platform_device *pdev)
198 unsigned ngpio, nbank;
199 struct davinci_gpio_controller *chips;
200 struct davinci_gpio_platform_data *pdata;
201 struct davinci_gpio_regs __iomem *regs;
202 struct device *dev = &pdev->dev;
203 struct resource *res;
205 pdata = davinci_gpio_get_pdata(pdev);
207 dev_err(dev, "No platform data found\n");
211 dev->platform_data = pdata;
214 * The gpio banks conceptually expose a segmented bitmap,
215 * and "ngpio" is one more than the largest zero-based
216 * bit index that's valid.
218 ngpio = pdata->ngpio;
220 dev_err(dev, "How many GPIOs?\n");
224 if (WARN_ON(ARCH_NR_GPIOS < ngpio))
225 ngpio = ARCH_NR_GPIOS;
227 nbank = DIV_ROUND_UP(ngpio, 32);
228 chips = devm_kzalloc(dev,
229 nbank * sizeof(struct davinci_gpio_controller),
234 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
235 gpio_base = devm_ioremap_resource(dev, res);
236 if (IS_ERR(gpio_base))
237 return PTR_ERR(gpio_base);
239 for (i = 0, base = 0; base < ngpio; i++, base += 32) {
240 chips[i].chip.label = "DaVinci";
242 chips[i].chip.direction_input = davinci_direction_in;
243 chips[i].chip.get = davinci_gpio_get;
244 chips[i].chip.direction_output = davinci_direction_out;
245 chips[i].chip.set = davinci_gpio_set;
247 chips[i].chip.base = base;
248 chips[i].chip.ngpio = ngpio - base;
249 if (chips[i].chip.ngpio > 32)
250 chips[i].chip.ngpio = 32;
252 #ifdef CONFIG_OF_GPIO
253 chips[i].chip.of_gpio_n_cells = 2;
254 chips[i].chip.of_xlate = davinci_gpio_of_xlate;
255 chips[i].chip.parent = dev;
256 chips[i].chip.of_node = dev->of_node;
258 spin_lock_init(&chips[i].lock);
260 regs = gpio2regs(base);
263 chips[i].regs = regs;
264 chips[i].set_data = ®s->set_data;
265 chips[i].clr_data = ®s->clr_data;
266 chips[i].in_data = ®s->in_data;
268 gpiochip_add_data(&chips[i].chip, &chips[i]);
271 platform_set_drvdata(pdev, chips);
272 davinci_gpio_irq_setup(pdev);
276 /*--------------------------------------------------------------------------*/
278 * We expect irqs will normally be set up as input pins, but they can also be
279 * used as output pins ... which is convenient for testing.
281 * NOTE: The first few GPIOs also have direct INTC hookups in addition
282 * to their GPIOBNK0 irq, with a bit less overhead.
284 * All those INTC hookups (direct, plus several IRQ banks) can also
285 * serve as EDMA event triggers.
288 static void gpio_irq_disable(struct irq_data *d)
290 struct davinci_gpio_regs __iomem *g = irq2regs(d);
291 u32 mask = (u32) irq_data_get_irq_handler_data(d);
293 writel_relaxed(mask, &g->clr_falling);
294 writel_relaxed(mask, &g->clr_rising);
297 static void gpio_irq_enable(struct irq_data *d)
299 struct davinci_gpio_regs __iomem *g = irq2regs(d);
300 u32 mask = (u32) irq_data_get_irq_handler_data(d);
301 unsigned status = irqd_get_trigger_type(d);
303 status &= IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING;
305 status = IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING;
307 if (status & IRQ_TYPE_EDGE_FALLING)
308 writel_relaxed(mask, &g->set_falling);
309 if (status & IRQ_TYPE_EDGE_RISING)
310 writel_relaxed(mask, &g->set_rising);
313 static int gpio_irq_type(struct irq_data *d, unsigned trigger)
315 if (trigger & ~(IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
321 static struct irq_chip gpio_irqchip = {
323 .irq_enable = gpio_irq_enable,
324 .irq_disable = gpio_irq_disable,
325 .irq_set_type = gpio_irq_type,
326 .flags = IRQCHIP_SET_TYPE_MASKED,
329 static void gpio_irq_handler(struct irq_desc *desc)
331 unsigned int irq = irq_desc_get_irq(desc);
332 struct davinci_gpio_regs __iomem *g;
334 struct davinci_gpio_controller *d;
336 d = (struct davinci_gpio_controller *)irq_desc_get_handler_data(desc);
337 g = (struct davinci_gpio_regs __iomem *)d->regs;
339 /* we only care about one bank */
343 /* temporarily mask (level sensitive) parent IRQ */
344 chained_irq_enter(irq_desc_get_chip(desc), desc);
350 status = readl_relaxed(&g->intstat) & mask;
353 writel_relaxed(status, &g->intstat);
355 /* now demux them to the right lowlevel handler */
361 irq_find_mapping(d->irq_domain,
362 d->chip.base + bit));
365 chained_irq_exit(irq_desc_get_chip(desc), desc);
366 /* now it may re-trigger */
369 static int gpio_to_irq_banked(struct gpio_chip *chip, unsigned offset)
371 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
374 return irq_create_mapping(d->irq_domain, d->chip.base + offset);
379 static int gpio_to_irq_unbanked(struct gpio_chip *chip, unsigned offset)
381 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
384 * NOTE: we assume for now that only irqs in the first gpio_chip
385 * can provide direct-mapped IRQs to AINTC (up to 32 GPIOs).
387 if (offset < d->gpio_unbanked)
388 return d->gpio_irq + offset;
393 static int gpio_irq_type_unbanked(struct irq_data *data, unsigned trigger)
395 struct davinci_gpio_controller *d;
396 struct davinci_gpio_regs __iomem *g;
399 d = (struct davinci_gpio_controller *)irq_data_get_irq_handler_data(data);
400 g = (struct davinci_gpio_regs __iomem *)d->regs;
401 mask = __gpio_mask(data->irq - d->gpio_irq);
403 if (trigger & ~(IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
406 writel_relaxed(mask, (trigger & IRQ_TYPE_EDGE_FALLING)
407 ? &g->set_falling : &g->clr_falling);
408 writel_relaxed(mask, (trigger & IRQ_TYPE_EDGE_RISING)
409 ? &g->set_rising : &g->clr_rising);
415 davinci_gpio_irq_map(struct irq_domain *d, unsigned int irq,
418 struct davinci_gpio_regs __iomem *g = gpio2regs(hw);
420 irq_set_chip_and_handler_name(irq, &gpio_irqchip, handle_simple_irq,
422 irq_set_irq_type(irq, IRQ_TYPE_NONE);
423 irq_set_chip_data(irq, (__force void *)g);
424 irq_set_handler_data(irq, (void *)__gpio_mask(hw));
429 static const struct irq_domain_ops davinci_gpio_irq_ops = {
430 .map = davinci_gpio_irq_map,
431 .xlate = irq_domain_xlate_onetwocell,
434 static struct irq_chip *davinci_gpio_get_irq_chip(unsigned int irq)
436 static struct irq_chip_type gpio_unbanked;
438 gpio_unbanked = *irq_data_get_chip_type(irq_get_irq_data(irq));
440 return &gpio_unbanked.chip;
443 static struct irq_chip *keystone_gpio_get_irq_chip(unsigned int irq)
445 static struct irq_chip gpio_unbanked;
447 gpio_unbanked = *irq_get_chip(irq);
448 return &gpio_unbanked;
451 static const struct of_device_id davinci_gpio_ids[];
454 * NOTE: for suspend/resume, probably best to make a platform_device with
455 * suspend_late/resume_resume calls hooking into results of the set_wake()
456 * calls ... so if no gpios are wakeup events the clock can be disabled,
457 * with outputs left at previously set levels, and so that VDD3P3V.IOPWDN0
458 * (dm6446) can be set appropriately for GPIOV33 pins.
461 static int davinci_gpio_irq_setup(struct platform_device *pdev)
467 unsigned ngpio, bank_irq;
468 struct device *dev = &pdev->dev;
469 struct resource *res;
470 struct davinci_gpio_controller *chips = platform_get_drvdata(pdev);
471 struct davinci_gpio_platform_data *pdata = dev->platform_data;
472 struct davinci_gpio_regs __iomem *g;
473 struct irq_domain *irq_domain = NULL;
474 const struct of_device_id *match;
475 struct irq_chip *irq_chip;
476 gpio_get_irq_chip_cb_t gpio_get_irq_chip;
479 * Use davinci_gpio_get_irq_chip by default to handle non DT cases
481 gpio_get_irq_chip = davinci_gpio_get_irq_chip;
482 match = of_match_device(of_match_ptr(davinci_gpio_ids),
485 gpio_get_irq_chip = (gpio_get_irq_chip_cb_t)match->data;
487 ngpio = pdata->ngpio;
488 res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
490 dev_err(dev, "Invalid IRQ resource\n");
494 bank_irq = res->start;
497 dev_err(dev, "Invalid IRQ resource\n");
501 clk = devm_clk_get(dev, "gpio");
503 printk(KERN_ERR "Error %ld getting gpio clock?\n",
507 clk_prepare_enable(clk);
509 if (!pdata->gpio_unbanked) {
510 irq = irq_alloc_descs(-1, 0, ngpio, 0);
512 dev_err(dev, "Couldn't allocate IRQ numbers\n");
516 irq_domain = irq_domain_add_legacy(dev->of_node, ngpio, irq, 0,
517 &davinci_gpio_irq_ops,
520 dev_err(dev, "Couldn't register an IRQ domain\n");
526 * Arrange gpio_to_irq() support, handling either direct IRQs or
527 * banked IRQs. Having GPIOs in the first GPIO bank use direct
528 * IRQs, while the others use banked IRQs, would need some setup
529 * tweaks to recognize hardware which can do that.
531 for (gpio = 0, bank = 0; gpio < ngpio; bank++, gpio += 32) {
532 chips[bank].chip.to_irq = gpio_to_irq_banked;
533 chips[bank].irq_domain = irq_domain;
537 * AINTC can handle direct/unbanked IRQs for GPIOs, with the GPIO
538 * controller only handling trigger modes. We currently assume no
539 * IRQ mux conflicts; gpio_irq_type_unbanked() is only for GPIOs.
541 if (pdata->gpio_unbanked) {
542 /* pass "bank 0" GPIO IRQs to AINTC */
543 chips[0].chip.to_irq = gpio_to_irq_unbanked;
544 chips[0].gpio_irq = bank_irq;
545 chips[0].gpio_unbanked = pdata->gpio_unbanked;
546 binten = GENMASK(pdata->gpio_unbanked / 16, 0);
548 /* AINTC handles mask/unmask; GPIO handles triggering */
550 irq_chip = gpio_get_irq_chip(irq);
551 irq_chip->name = "GPIO-AINTC";
552 irq_chip->irq_set_type = gpio_irq_type_unbanked;
554 /* default trigger: both edges */
556 writel_relaxed(~0, &g->set_falling);
557 writel_relaxed(~0, &g->set_rising);
559 /* set the direct IRQs up to use that irqchip */
560 for (gpio = 0; gpio < pdata->gpio_unbanked; gpio++, irq++) {
561 irq_set_chip(irq, irq_chip);
562 irq_set_handler_data(irq, &chips[gpio / 32]);
563 irq_set_status_flags(irq, IRQ_TYPE_EDGE_BOTH);
570 * Or, AINTC can handle IRQs for banks of 16 GPIO IRQs, which we
571 * then chain through our own handler.
573 for (gpio = 0, bank = 0; gpio < ngpio; bank++, bank_irq++, gpio += 16) {
574 /* disabled by default, enabled only as needed */
576 writel_relaxed(~0, &g->clr_falling);
577 writel_relaxed(~0, &g->clr_rising);
580 * Each chip handles 32 gpios, and each irq bank consists of 16
581 * gpio irqs. Pass the irq bank's corresponding controller to
582 * the chained irq handler.
584 irq_set_chained_handler_and_data(bank_irq, gpio_irq_handler,
592 * BINTEN -- per-bank interrupt enable. genirq would also let these
593 * bits be set/cleared dynamically.
595 writel_relaxed(binten, gpio_base + BINTEN);
600 #if IS_ENABLED(CONFIG_OF)
601 static const struct of_device_id davinci_gpio_ids[] = {
602 { .compatible = "ti,keystone-gpio", keystone_gpio_get_irq_chip},
603 { .compatible = "ti,dm6441-gpio", davinci_gpio_get_irq_chip},
606 MODULE_DEVICE_TABLE(of, davinci_gpio_ids);
609 static struct platform_driver davinci_gpio_driver = {
610 .probe = davinci_gpio_probe,
612 .name = "davinci_gpio",
613 .of_match_table = of_match_ptr(davinci_gpio_ids),
618 * GPIO driver registration needs to be done before machine_init functions
619 * access GPIO. Hence davinci_gpio_drv_reg() is a postcore_initcall.
621 static int __init davinci_gpio_drv_reg(void)
623 return platform_driver_register(&davinci_gpio_driver);
625 postcore_initcall(davinci_gpio_drv_reg);