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/driver.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/pinctrl/consumer.h>
24 #include <linux/platform_device.h>
25 #include <linux/platform_data/gpio-davinci.h>
26 #include <linux/irqchip/chained_irq.h>
28 struct davinci_gpio_regs {
41 typedef struct irq_chip *(*gpio_get_irq_chip_cb_t)(unsigned int irq);
43 #define BINTEN 0x8 /* GPIO Interrupt Per-Bank Enable Register */
44 #define MAX_LABEL_SIZE 20
46 static void __iomem *gpio_base;
47 static unsigned int offset_array[5] = {0x10, 0x38, 0x60, 0x88, 0xb0};
49 static inline struct davinci_gpio_regs __iomem *irq2regs(struct irq_data *d)
51 struct davinci_gpio_regs __iomem *g;
53 g = (__force struct davinci_gpio_regs __iomem *)irq_data_get_irq_chip_data(d);
58 static int davinci_gpio_irq_setup(struct platform_device *pdev);
60 /*--------------------------------------------------------------------------*/
62 /* board setup code *MUST* setup pinmux and enable the GPIO clock. */
63 static inline int __davinci_direction(struct gpio_chip *chip,
64 unsigned offset, bool out, int value)
66 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
67 struct davinci_gpio_regs __iomem *g;
70 int bank = offset / 32;
71 u32 mask = __gpio_mask(offset);
74 spin_lock_irqsave(&d->lock, flags);
75 temp = readl_relaxed(&g->dir);
78 writel_relaxed(mask, value ? &g->set_data : &g->clr_data);
82 writel_relaxed(temp, &g->dir);
83 spin_unlock_irqrestore(&d->lock, flags);
88 static int davinci_direction_in(struct gpio_chip *chip, unsigned offset)
90 return __davinci_direction(chip, offset, false, 0);
94 davinci_direction_out(struct gpio_chip *chip, unsigned offset, int value)
96 return __davinci_direction(chip, offset, true, value);
100 * Read the pin's value (works even if it's set up as output);
101 * returns zero/nonzero.
103 * Note that changes are synched to the GPIO clock, so reading values back
104 * right after you've set them may give old values.
106 static int davinci_gpio_get(struct gpio_chip *chip, unsigned offset)
108 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
109 struct davinci_gpio_regs __iomem *g;
110 int bank = offset / 32;
114 return !!(__gpio_mask(offset) & readl_relaxed(&g->in_data));
118 * Assuming the pin is muxed as a gpio output, set its output value.
121 davinci_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
123 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
124 struct davinci_gpio_regs __iomem *g;
125 int bank = offset / 32;
129 writel_relaxed(__gpio_mask(offset),
130 value ? &g->set_data : &g->clr_data);
133 static struct davinci_gpio_platform_data *
134 davinci_gpio_get_pdata(struct platform_device *pdev)
136 struct device_node *dn = pdev->dev.of_node;
137 struct davinci_gpio_platform_data *pdata;
141 if (!IS_ENABLED(CONFIG_OF) || !pdev->dev.of_node)
142 return dev_get_platdata(&pdev->dev);
144 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
148 ret = of_property_read_u32(dn, "ti,ngpio", &val);
154 ret = of_property_read_u32(dn, "ti,davinci-gpio-unbanked", &val);
158 pdata->gpio_unbanked = val;
163 dev_err(&pdev->dev, "Populating pdata from DT failed: err %d\n", ret);
167 static int davinci_gpio_probe(struct platform_device *pdev)
169 static int ctrl_num, bank_base;
170 int gpio, bank, ret = 0;
171 unsigned ngpio, nbank;
172 struct davinci_gpio_controller *chips;
173 struct davinci_gpio_platform_data *pdata;
174 struct device *dev = &pdev->dev;
175 struct resource *res;
176 char label[MAX_LABEL_SIZE];
178 pdata = davinci_gpio_get_pdata(pdev);
180 dev_err(dev, "No platform data found\n");
184 dev->platform_data = pdata;
187 * The gpio banks conceptually expose a segmented bitmap,
188 * and "ngpio" is one more than the largest zero-based
189 * bit index that's valid.
191 ngpio = pdata->ngpio;
193 dev_err(dev, "How many GPIOs?\n");
197 if (WARN_ON(ARCH_NR_GPIOS < ngpio))
198 ngpio = ARCH_NR_GPIOS;
200 nbank = DIV_ROUND_UP(ngpio, 32);
201 chips = devm_kzalloc(dev,
202 nbank * sizeof(struct davinci_gpio_controller),
207 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
208 gpio_base = devm_ioremap_resource(dev, res);
209 if (IS_ERR(gpio_base))
210 return PTR_ERR(gpio_base);
212 snprintf(label, MAX_LABEL_SIZE, "davinci_gpio.%d", ctrl_num++);
213 chips->chip.label = devm_kstrdup(dev, label, GFP_KERNEL);
214 if (!chips->chip.label)
217 chips->chip.direction_input = davinci_direction_in;
218 chips->chip.get = davinci_gpio_get;
219 chips->chip.direction_output = davinci_direction_out;
220 chips->chip.set = davinci_gpio_set;
222 chips->chip.ngpio = ngpio;
223 chips->chip.base = bank_base;
225 #ifdef CONFIG_OF_GPIO
226 chips->chip.of_gpio_n_cells = 2;
227 chips->chip.parent = dev;
228 chips->chip.of_node = dev->of_node;
230 if (of_property_read_bool(dev->of_node, "gpio-ranges")) {
231 chips->chip.request = gpiochip_generic_request;
232 chips->chip.free = gpiochip_generic_free;
235 spin_lock_init(&chips->lock);
238 for (gpio = 0, bank = 0; gpio < ngpio; gpio += 32, bank++)
239 chips->regs[bank] = gpio_base + offset_array[bank];
241 ret = devm_gpiochip_add_data(dev, &chips->chip, chips);
245 platform_set_drvdata(pdev, chips);
246 ret = davinci_gpio_irq_setup(pdev);
253 /* Revert the static variable increments */
260 /*--------------------------------------------------------------------------*/
262 * We expect irqs will normally be set up as input pins, but they can also be
263 * used as output pins ... which is convenient for testing.
265 * NOTE: The first few GPIOs also have direct INTC hookups in addition
266 * to their GPIOBNK0 irq, with a bit less overhead.
268 * All those INTC hookups (direct, plus several IRQ banks) can also
269 * serve as EDMA event triggers.
272 static void gpio_irq_disable(struct irq_data *d)
274 struct davinci_gpio_regs __iomem *g = irq2regs(d);
275 u32 mask = (u32) irq_data_get_irq_handler_data(d);
277 writel_relaxed(mask, &g->clr_falling);
278 writel_relaxed(mask, &g->clr_rising);
281 static void gpio_irq_enable(struct irq_data *d)
283 struct davinci_gpio_regs __iomem *g = irq2regs(d);
284 u32 mask = (u32) irq_data_get_irq_handler_data(d);
285 unsigned status = irqd_get_trigger_type(d);
287 status &= IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING;
289 status = IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING;
291 if (status & IRQ_TYPE_EDGE_FALLING)
292 writel_relaxed(mask, &g->set_falling);
293 if (status & IRQ_TYPE_EDGE_RISING)
294 writel_relaxed(mask, &g->set_rising);
297 static int gpio_irq_type(struct irq_data *d, unsigned trigger)
299 if (trigger & ~(IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
305 static struct irq_chip gpio_irqchip = {
307 .irq_enable = gpio_irq_enable,
308 .irq_disable = gpio_irq_disable,
309 .irq_set_type = gpio_irq_type,
310 .flags = IRQCHIP_SET_TYPE_MASKED,
313 static void gpio_irq_handler(struct irq_desc *desc)
315 struct davinci_gpio_regs __iomem *g;
318 struct davinci_gpio_controller *d;
319 struct davinci_gpio_irq_data *irqdata;
321 irqdata = (struct davinci_gpio_irq_data *)irq_desc_get_handler_data(desc);
322 bank_num = irqdata->bank_num;
326 /* we only care about one bank */
327 if ((bank_num % 2) == 1)
330 /* temporarily mask (level sensitive) parent IRQ */
331 chained_irq_enter(irq_desc_get_chip(desc), desc);
335 irq_hw_number_t hw_irq;
338 status = readl_relaxed(&g->intstat) & mask;
341 writel_relaxed(status, &g->intstat);
343 /* now demux them to the right lowlevel handler */
348 /* Max number of gpios per controller is 144 so
349 * hw_irq will be in [0..143]
351 hw_irq = (bank_num / 2) * 32 + bit;
354 irq_find_mapping(d->irq_domain, hw_irq));
357 chained_irq_exit(irq_desc_get_chip(desc), desc);
358 /* now it may re-trigger */
361 static int gpio_to_irq_banked(struct gpio_chip *chip, unsigned offset)
363 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
366 return irq_create_mapping(d->irq_domain, offset);
371 static int gpio_to_irq_unbanked(struct gpio_chip *chip, unsigned offset)
373 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
376 * NOTE: we assume for now that only irqs in the first gpio_chip
377 * can provide direct-mapped IRQs to AINTC (up to 32 GPIOs).
379 if (offset < d->gpio_unbanked)
380 return d->base_irq + offset;
385 static int gpio_irq_type_unbanked(struct irq_data *data, unsigned trigger)
387 struct davinci_gpio_controller *d;
388 struct davinci_gpio_regs __iomem *g;
391 d = (struct davinci_gpio_controller *)irq_data_get_irq_handler_data(data);
392 g = (struct davinci_gpio_regs __iomem *)d->regs[0];
393 mask = __gpio_mask(data->irq - d->base_irq);
395 if (trigger & ~(IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
398 writel_relaxed(mask, (trigger & IRQ_TYPE_EDGE_FALLING)
399 ? &g->set_falling : &g->clr_falling);
400 writel_relaxed(mask, (trigger & IRQ_TYPE_EDGE_RISING)
401 ? &g->set_rising : &g->clr_rising);
407 davinci_gpio_irq_map(struct irq_domain *d, unsigned int irq,
410 struct davinci_gpio_controller *chips =
411 (struct davinci_gpio_controller *)d->host_data;
412 struct davinci_gpio_regs __iomem *g = chips->regs[hw / 32];
414 irq_set_chip_and_handler_name(irq, &gpio_irqchip, handle_simple_irq,
416 irq_set_irq_type(irq, IRQ_TYPE_NONE);
417 irq_set_chip_data(irq, (__force void *)g);
418 irq_set_handler_data(irq, (void *)__gpio_mask(hw));
423 static const struct irq_domain_ops davinci_gpio_irq_ops = {
424 .map = davinci_gpio_irq_map,
425 .xlate = irq_domain_xlate_onetwocell,
428 static struct irq_chip *davinci_gpio_get_irq_chip(unsigned int irq)
430 static struct irq_chip_type gpio_unbanked;
432 gpio_unbanked = *irq_data_get_chip_type(irq_get_irq_data(irq));
434 return &gpio_unbanked.chip;
437 static struct irq_chip *keystone_gpio_get_irq_chip(unsigned int irq)
439 static struct irq_chip gpio_unbanked;
441 gpio_unbanked = *irq_get_chip(irq);
442 return &gpio_unbanked;
445 static const struct of_device_id davinci_gpio_ids[];
448 * NOTE: for suspend/resume, probably best to make a platform_device with
449 * suspend_late/resume_resume calls hooking into results of the set_wake()
450 * calls ... so if no gpios are wakeup events the clock can be disabled,
451 * with outputs left at previously set levels, and so that VDD3P3V.IOPWDN0
452 * (dm6446) can be set appropriately for GPIOV33 pins.
455 static int davinci_gpio_irq_setup(struct platform_device *pdev)
462 unsigned ngpio, bank_irq;
463 struct device *dev = &pdev->dev;
464 struct resource *res;
465 struct davinci_gpio_controller *chips = platform_get_drvdata(pdev);
466 struct davinci_gpio_platform_data *pdata = dev->platform_data;
467 struct davinci_gpio_regs __iomem *g;
468 struct irq_domain *irq_domain = NULL;
469 const struct of_device_id *match;
470 struct irq_chip *irq_chip;
471 struct davinci_gpio_irq_data *irqdata;
472 gpio_get_irq_chip_cb_t gpio_get_irq_chip;
475 * Use davinci_gpio_get_irq_chip by default to handle non DT cases
477 gpio_get_irq_chip = davinci_gpio_get_irq_chip;
478 match = of_match_device(of_match_ptr(davinci_gpio_ids),
481 gpio_get_irq_chip = (gpio_get_irq_chip_cb_t)match->data;
483 ngpio = pdata->ngpio;
484 res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
486 dev_err(dev, "Invalid IRQ resource\n");
490 bank_irq = res->start;
493 dev_err(dev, "Invalid IRQ resource\n");
497 clk = devm_clk_get(dev, "gpio");
499 dev_err(dev, "Error %ld getting gpio clock\n", PTR_ERR(clk));
502 ret = clk_prepare_enable(clk);
506 if (!pdata->gpio_unbanked) {
507 irq = devm_irq_alloc_descs(dev, -1, 0, ngpio, 0);
509 dev_err(dev, "Couldn't allocate IRQ numbers\n");
510 clk_disable_unprepare(clk);
514 irq_domain = irq_domain_add_legacy(dev->of_node, ngpio, irq, 0,
515 &davinci_gpio_irq_ops,
518 dev_err(dev, "Couldn't register an IRQ domain\n");
519 clk_disable_unprepare(clk);
525 * Arrange gpio_to_irq() support, handling either direct IRQs or
526 * banked IRQs. Having GPIOs in the first GPIO bank use direct
527 * IRQs, while the others use banked IRQs, would need some setup
528 * tweaks to recognize hardware which can do that.
530 chips->chip.to_irq = gpio_to_irq_banked;
531 chips->irq_domain = irq_domain;
534 * AINTC can handle direct/unbanked IRQs for GPIOs, with the GPIO
535 * controller only handling trigger modes. We currently assume no
536 * IRQ mux conflicts; gpio_irq_type_unbanked() is only for GPIOs.
538 if (pdata->gpio_unbanked) {
539 /* pass "bank 0" GPIO IRQs to AINTC */
540 chips->chip.to_irq = gpio_to_irq_unbanked;
541 chips->base_irq = bank_irq;
542 chips->gpio_unbanked = pdata->gpio_unbanked;
543 binten = GENMASK(pdata->gpio_unbanked / 16, 0);
545 /* AINTC handles mask/unmask; GPIO handles triggering */
547 irq_chip = gpio_get_irq_chip(irq);
548 irq_chip->name = "GPIO-AINTC";
549 irq_chip->irq_set_type = gpio_irq_type_unbanked;
551 /* default trigger: both edges */
553 writel_relaxed(~0, &g->set_falling);
554 writel_relaxed(~0, &g->set_rising);
556 /* set the direct IRQs up to use that irqchip */
557 for (gpio = 0; gpio < pdata->gpio_unbanked; gpio++, irq++) {
558 irq_set_chip(irq, irq_chip);
559 irq_set_handler_data(irq, chips);
560 irq_set_status_flags(irq, IRQ_TYPE_EDGE_BOTH);
567 * Or, AINTC can handle IRQs for banks of 16 GPIO IRQs, which we
568 * then chain through our own handler.
570 for (gpio = 0, bank = 0; gpio < ngpio; bank++, bank_irq++, gpio += 16) {
571 /* disabled by default, enabled only as needed
572 * There are register sets for 32 GPIOs. 2 banks of 16
573 * GPIOs are covered by each set of registers hence divide by 2
575 g = chips->regs[bank / 2];
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 irqdata = devm_kzalloc(&pdev->dev,
586 davinci_gpio_irq_data),
589 clk_disable_unprepare(clk);
594 irqdata->bank_num = bank;
595 irqdata->chip = chips;
597 irq_set_chained_handler_and_data(bank_irq, gpio_irq_handler,
605 * BINTEN -- per-bank interrupt enable. genirq would also let these
606 * bits be set/cleared dynamically.
608 writel_relaxed(binten, gpio_base + BINTEN);
613 static const struct of_device_id davinci_gpio_ids[] = {
614 { .compatible = "ti,keystone-gpio", keystone_gpio_get_irq_chip},
615 { .compatible = "ti,dm6441-gpio", davinci_gpio_get_irq_chip},
618 MODULE_DEVICE_TABLE(of, davinci_gpio_ids);
620 static struct platform_driver davinci_gpio_driver = {
621 .probe = davinci_gpio_probe,
623 .name = "davinci_gpio",
624 .of_match_table = of_match_ptr(davinci_gpio_ids),
629 * GPIO driver registration needs to be done before machine_init functions
630 * access GPIO. Hence davinci_gpio_drv_reg() is a postcore_initcall.
632 static int __init davinci_gpio_drv_reg(void)
634 return platform_driver_register(&davinci_gpio_driver);
636 postcore_initcall(davinci_gpio_drv_reg);