Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * TI DaVinci GPIO Support
4 *
5 * Copyright (c) 2006-2007 David Brownell
6 * Copyright (c) 2007, MontaVista Software, Inc. <source@mvista.com>
7 */
8
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>
14#include <linux/io.h>
15#include <linux/irq.h>
16#include <linux/irqdomain.h>
17#include <linux/module.h>
18#include <linux/of.h>
19#include <linux/pinctrl/consumer.h>
20#include <linux/platform_device.h>
21#include <linux/platform_data/gpio-davinci.h>
22#include <linux/property.h>
23#include <linux/irqchip/chained_irq.h>
24#include <linux/spinlock.h>
25#include <linux/pm_runtime.h>
26
27#define MAX_REGS_BANKS 5
28#define MAX_INT_PER_BANK 32
29
30struct davinci_gpio_regs {
31 u32 dir;
32 u32 out_data;
33 u32 set_data;
34 u32 clr_data;
35 u32 in_data;
36 u32 set_rising;
37 u32 clr_rising;
38 u32 set_falling;
39 u32 clr_falling;
40 u32 intstat;
41};
42
43typedef struct irq_chip *(*gpio_get_irq_chip_cb_t)(unsigned int irq);
44
45#define BINTEN 0x8 /* GPIO Interrupt Per-Bank Enable Register */
46
47static void __iomem *gpio_base;
48static unsigned int offset_array[5] = {0x10, 0x38, 0x60, 0x88, 0xb0};
49
50struct davinci_gpio_irq_data {
51 void __iomem *regs;
52 struct davinci_gpio_controller *chip;
53 int bank_num;
54};
55
56struct davinci_gpio_controller {
57 struct gpio_chip chip;
58 struct irq_domain *irq_domain;
59 /* Serialize access to GPIO registers */
60 spinlock_t lock;
61 void __iomem *regs[MAX_REGS_BANKS];
62 int gpio_unbanked;
63 int irqs[MAX_INT_PER_BANK];
64 struct davinci_gpio_regs context[MAX_REGS_BANKS];
65 u32 binten_context;
66};
67
68static inline u32 __gpio_mask(unsigned gpio)
69{
70 return 1 << (gpio % 32);
71}
72
73static inline struct davinci_gpio_regs __iomem *irq2regs(struct irq_data *d)
74{
75 struct davinci_gpio_regs __iomem *g;
76
77 g = (__force struct davinci_gpio_regs __iomem *)irq_data_get_irq_chip_data(d);
78
79 return g;
80}
81
82static int davinci_gpio_irq_setup(struct platform_device *pdev);
83
84/*--------------------------------------------------------------------------*/
85
86/* board setup code *MUST* setup pinmux and enable the GPIO clock. */
87static inline int __davinci_direction(struct gpio_chip *chip,
88 unsigned offset, bool out, int value)
89{
90 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
91 struct davinci_gpio_regs __iomem *g;
92 unsigned long flags;
93 u32 temp;
94 int bank = offset / 32;
95 u32 mask = __gpio_mask(offset);
96
97 g = d->regs[bank];
98 spin_lock_irqsave(&d->lock, flags);
99 temp = readl_relaxed(&g->dir);
100 if (out) {
101 temp &= ~mask;
102 writel_relaxed(mask, value ? &g->set_data : &g->clr_data);
103 } else {
104 temp |= mask;
105 }
106 writel_relaxed(temp, &g->dir);
107 spin_unlock_irqrestore(&d->lock, flags);
108
109 return 0;
110}
111
112static int davinci_direction_in(struct gpio_chip *chip, unsigned offset)
113{
114 return __davinci_direction(chip, offset, false, 0);
115}
116
117static int
118davinci_direction_out(struct gpio_chip *chip, unsigned offset, int value)
119{
120 return __davinci_direction(chip, offset, true, value);
121}
122
123/*
124 * Read the pin's value (works even if it's set up as output);
125 * returns zero/nonzero.
126 *
127 * Note that changes are synched to the GPIO clock, so reading values back
128 * right after you've set them may give old values.
129 */
130static int davinci_gpio_get(struct gpio_chip *chip, unsigned offset)
131{
132 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
133 struct davinci_gpio_regs __iomem *g;
134 int bank = offset / 32;
135
136 g = d->regs[bank];
137
138 return !!(__gpio_mask(offset) & readl_relaxed(&g->in_data));
139}
140
141/*
142 * Assuming the pin is muxed as a gpio output, set its output value.
143 */
144static void
145davinci_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
146{
147 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
148 struct davinci_gpio_regs __iomem *g;
149 int bank = offset / 32;
150
151 g = d->regs[bank];
152
153 writel_relaxed(__gpio_mask(offset),
154 value ? &g->set_data : &g->clr_data);
155}
156
157static struct davinci_gpio_platform_data *
158davinci_gpio_get_pdata(struct platform_device *pdev)
159{
160 struct device_node *dn = pdev->dev.of_node;
161 struct davinci_gpio_platform_data *pdata;
162 int ret;
163 u32 val;
164
165 if (!IS_ENABLED(CONFIG_OF) || !pdev->dev.of_node)
166 return dev_get_platdata(&pdev->dev);
167
168 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
169 if (!pdata)
170 return NULL;
171
172 ret = of_property_read_u32(dn, "ti,ngpio", &val);
173 if (ret)
174 goto of_err;
175
176 pdata->ngpio = val;
177
178 ret = of_property_read_u32(dn, "ti,davinci-gpio-unbanked", &val);
179 if (ret)
180 goto of_err;
181
182 pdata->gpio_unbanked = val;
183
184 return pdata;
185
186of_err:
187 dev_err(&pdev->dev, "Populating pdata from DT failed: err %d\n", ret);
188 return NULL;
189}
190
191static int davinci_gpio_probe(struct platform_device *pdev)
192{
193 int bank, i, ret = 0;
194 unsigned int ngpio, nbank, nirq;
195 struct davinci_gpio_controller *chips;
196 struct davinci_gpio_platform_data *pdata;
197 struct device *dev = &pdev->dev;
198
199 pdata = davinci_gpio_get_pdata(pdev);
200 if (!pdata) {
201 dev_err(dev, "No platform data found\n");
202 return -EINVAL;
203 }
204
205 dev->platform_data = pdata;
206
207 /*
208 * The gpio banks conceptually expose a segmented bitmap,
209 * and "ngpio" is one more than the largest zero-based
210 * bit index that's valid.
211 */
212 ngpio = pdata->ngpio;
213 if (ngpio == 0) {
214 dev_err(dev, "How many GPIOs?\n");
215 return -EINVAL;
216 }
217
218 /*
219 * If there are unbanked interrupts then the number of
220 * interrupts is equal to number of gpios else all are banked so
221 * number of interrupts is equal to number of banks(each with 16 gpios)
222 */
223 if (pdata->gpio_unbanked)
224 nirq = pdata->gpio_unbanked;
225 else
226 nirq = DIV_ROUND_UP(ngpio, 16);
227
228 chips = devm_kzalloc(dev, sizeof(*chips), GFP_KERNEL);
229 if (!chips)
230 return -ENOMEM;
231
232 gpio_base = devm_platform_ioremap_resource(pdev, 0);
233 if (IS_ERR(gpio_base))
234 return PTR_ERR(gpio_base);
235
236 for (i = 0; i < nirq; i++) {
237 chips->irqs[i] = platform_get_irq(pdev, i);
238 if (chips->irqs[i] < 0)
239 return chips->irqs[i];
240 }
241
242 chips->chip.label = dev_name(dev);
243
244 chips->chip.direction_input = davinci_direction_in;
245 chips->chip.get = davinci_gpio_get;
246 chips->chip.direction_output = davinci_direction_out;
247 chips->chip.set = davinci_gpio_set;
248
249 chips->chip.ngpio = ngpio;
250 chips->chip.base = pdata->no_auto_base ? pdata->base : -1;
251
252#ifdef CONFIG_OF_GPIO
253 chips->chip.parent = dev;
254 chips->chip.request = gpiochip_generic_request;
255 chips->chip.free = gpiochip_generic_free;
256#endif
257 spin_lock_init(&chips->lock);
258
259 nbank = DIV_ROUND_UP(ngpio, 32);
260 for (bank = 0; bank < nbank; bank++)
261 chips->regs[bank] = gpio_base + offset_array[bank];
262
263 ret = devm_gpiochip_add_data(dev, &chips->chip, chips);
264 if (ret)
265 return ret;
266
267 platform_set_drvdata(pdev, chips);
268 ret = davinci_gpio_irq_setup(pdev);
269 if (ret)
270 return ret;
271
272 return 0;
273}
274
275/*--------------------------------------------------------------------------*/
276/*
277 * We expect irqs will normally be set up as input pins, but they can also be
278 * used as output pins ... which is convenient for testing.
279 *
280 * NOTE: The first few GPIOs also have direct INTC hookups in addition
281 * to their GPIOBNK0 irq, with a bit less overhead.
282 *
283 * All those INTC hookups (direct, plus several IRQ banks) can also
284 * serve as EDMA event triggers.
285 */
286
287static void gpio_irq_disable(struct irq_data *d)
288{
289 struct davinci_gpio_regs __iomem *g = irq2regs(d);
290 uintptr_t mask = (uintptr_t)irq_data_get_irq_handler_data(d);
291
292 writel_relaxed(mask, &g->clr_falling);
293 writel_relaxed(mask, &g->clr_rising);
294}
295
296static void gpio_irq_enable(struct irq_data *d)
297{
298 struct davinci_gpio_regs __iomem *g = irq2regs(d);
299 uintptr_t mask = (uintptr_t)irq_data_get_irq_handler_data(d);
300 unsigned status = irqd_get_trigger_type(d);
301
302 status &= IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING;
303 if (!status)
304 status = IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING;
305
306 if (status & IRQ_TYPE_EDGE_FALLING)
307 writel_relaxed(mask, &g->set_falling);
308 if (status & IRQ_TYPE_EDGE_RISING)
309 writel_relaxed(mask, &g->set_rising);
310}
311
312static int gpio_irq_type(struct irq_data *d, unsigned trigger)
313{
314 if (trigger & ~(IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
315 return -EINVAL;
316
317 return 0;
318}
319
320static struct irq_chip gpio_irqchip = {
321 .name = "GPIO",
322 .irq_enable = gpio_irq_enable,
323 .irq_disable = gpio_irq_disable,
324 .irq_set_type = gpio_irq_type,
325 .flags = IRQCHIP_SET_TYPE_MASKED | IRQCHIP_SKIP_SET_WAKE,
326};
327
328static void gpio_irq_handler(struct irq_desc *desc)
329{
330 struct davinci_gpio_regs __iomem *g;
331 u32 mask = 0xffff;
332 int bank_num;
333 struct davinci_gpio_controller *d;
334 struct davinci_gpio_irq_data *irqdata;
335
336 irqdata = (struct davinci_gpio_irq_data *)irq_desc_get_handler_data(desc);
337 bank_num = irqdata->bank_num;
338 g = irqdata->regs;
339 d = irqdata->chip;
340
341 /* we only care about one bank */
342 if ((bank_num % 2) == 1)
343 mask <<= 16;
344
345 /* temporarily mask (level sensitive) parent IRQ */
346 chained_irq_enter(irq_desc_get_chip(desc), desc);
347 while (1) {
348 u32 status;
349 int bit;
350 irq_hw_number_t hw_irq;
351
352 /* ack any irqs */
353 status = readl_relaxed(&g->intstat) & mask;
354 if (!status)
355 break;
356 writel_relaxed(status, &g->intstat);
357
358 /* now demux them to the right lowlevel handler */
359
360 while (status) {
361 bit = __ffs(status);
362 status &= ~BIT(bit);
363 /* Max number of gpios per controller is 144 so
364 * hw_irq will be in [0..143]
365 */
366 hw_irq = (bank_num / 2) * 32 + bit;
367
368 generic_handle_domain_irq(d->irq_domain, hw_irq);
369 }
370 }
371 chained_irq_exit(irq_desc_get_chip(desc), desc);
372 /* now it may re-trigger */
373}
374
375static int gpio_to_irq_banked(struct gpio_chip *chip, unsigned offset)
376{
377 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
378
379 if (d->irq_domain)
380 return irq_create_mapping(d->irq_domain, offset);
381 else
382 return -ENXIO;
383}
384
385static int gpio_to_irq_unbanked(struct gpio_chip *chip, unsigned offset)
386{
387 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
388
389 /*
390 * NOTE: we assume for now that only irqs in the first gpio_chip
391 * can provide direct-mapped IRQs to AINTC (up to 32 GPIOs).
392 */
393 if (offset < d->gpio_unbanked)
394 return d->irqs[offset];
395 else
396 return -ENODEV;
397}
398
399static int gpio_irq_type_unbanked(struct irq_data *data, unsigned trigger)
400{
401 struct davinci_gpio_controller *d;
402 struct davinci_gpio_regs __iomem *g;
403 u32 mask, i;
404
405 d = (struct davinci_gpio_controller *)irq_data_get_irq_handler_data(data);
406 g = (struct davinci_gpio_regs __iomem *)d->regs[0];
407 for (i = 0; i < MAX_INT_PER_BANK; i++)
408 if (data->irq == d->irqs[i])
409 break;
410
411 if (i == MAX_INT_PER_BANK)
412 return -EINVAL;
413
414 mask = __gpio_mask(i);
415
416 if (trigger & ~(IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
417 return -EINVAL;
418
419 writel_relaxed(mask, (trigger & IRQ_TYPE_EDGE_FALLING)
420 ? &g->set_falling : &g->clr_falling);
421 writel_relaxed(mask, (trigger & IRQ_TYPE_EDGE_RISING)
422 ? &g->set_rising : &g->clr_rising);
423
424 return 0;
425}
426
427static int
428davinci_gpio_irq_map(struct irq_domain *d, unsigned int irq,
429 irq_hw_number_t hw)
430{
431 struct davinci_gpio_controller *chips =
432 (struct davinci_gpio_controller *)d->host_data;
433 struct davinci_gpio_regs __iomem *g = chips->regs[hw / 32];
434
435 irq_set_chip_and_handler_name(irq, &gpio_irqchip, handle_simple_irq,
436 "davinci_gpio");
437 irq_set_irq_type(irq, IRQ_TYPE_NONE);
438 irq_set_chip_data(irq, (__force void *)g);
439 irq_set_handler_data(irq, (void *)(uintptr_t)__gpio_mask(hw));
440
441 return 0;
442}
443
444static const struct irq_domain_ops davinci_gpio_irq_ops = {
445 .map = davinci_gpio_irq_map,
446 .xlate = irq_domain_xlate_onetwocell,
447};
448
449static struct irq_chip *davinci_gpio_get_irq_chip(unsigned int irq)
450{
451 static struct irq_chip_type gpio_unbanked;
452
453 gpio_unbanked = *irq_data_get_chip_type(irq_get_irq_data(irq));
454
455 return &gpio_unbanked.chip;
456};
457
458static struct irq_chip *keystone_gpio_get_irq_chip(unsigned int irq)
459{
460 static struct irq_chip gpio_unbanked;
461
462 gpio_unbanked = *irq_get_chip(irq);
463 return &gpio_unbanked;
464};
465
466static const struct of_device_id davinci_gpio_ids[];
467
468/*
469 * NOTE: for suspend/resume, probably best to make a platform_device with
470 * suspend_late/resume_resume calls hooking into results of the set_wake()
471 * calls ... so if no gpios are wakeup events the clock can be disabled,
472 * with outputs left at previously set levels, and so that VDD3P3V.IOPWDN0
473 * (dm6446) can be set appropriately for GPIOV33 pins.
474 */
475
476static int davinci_gpio_irq_setup(struct platform_device *pdev)
477{
478 unsigned gpio, bank;
479 int irq;
480 int ret;
481 struct clk *clk;
482 u32 binten = 0;
483 unsigned ngpio;
484 struct device *dev = &pdev->dev;
485 struct davinci_gpio_controller *chips = platform_get_drvdata(pdev);
486 struct davinci_gpio_platform_data *pdata = dev->platform_data;
487 struct davinci_gpio_regs __iomem *g;
488 struct irq_domain *irq_domain = NULL;
489 struct irq_chip *irq_chip;
490 struct davinci_gpio_irq_data *irqdata;
491 gpio_get_irq_chip_cb_t gpio_get_irq_chip;
492
493 /*
494 * Use davinci_gpio_get_irq_chip by default to handle non DT cases
495 */
496 gpio_get_irq_chip = davinci_gpio_get_irq_chip;
497 if (dev->of_node)
498 gpio_get_irq_chip = (gpio_get_irq_chip_cb_t)device_get_match_data(dev);
499
500 ngpio = pdata->ngpio;
501
502 clk = devm_clk_get(dev, "gpio");
503 if (IS_ERR(clk)) {
504 dev_err(dev, "Error %ld getting gpio clock\n", PTR_ERR(clk));
505 return PTR_ERR(clk);
506 }
507
508 ret = clk_prepare_enable(clk);
509 if (ret)
510 return ret;
511
512 if (!pdata->gpio_unbanked) {
513 irq = devm_irq_alloc_descs(dev, -1, 0, ngpio, 0);
514 if (irq < 0) {
515 dev_err(dev, "Couldn't allocate IRQ numbers\n");
516 clk_disable_unprepare(clk);
517 return irq;
518 }
519
520 irq_domain = irq_domain_add_legacy(dev->of_node, ngpio, irq, 0,
521 &davinci_gpio_irq_ops,
522 chips);
523 if (!irq_domain) {
524 dev_err(dev, "Couldn't register an IRQ domain\n");
525 clk_disable_unprepare(clk);
526 return -ENODEV;
527 }
528 }
529
530 /*
531 * Arrange gpiod_to_irq() support, handling either direct IRQs or
532 * banked IRQs. Having GPIOs in the first GPIO bank use direct
533 * IRQs, while the others use banked IRQs, would need some setup
534 * tweaks to recognize hardware which can do that.
535 */
536 chips->chip.to_irq = gpio_to_irq_banked;
537 chips->irq_domain = irq_domain;
538
539 /*
540 * AINTC can handle direct/unbanked IRQs for GPIOs, with the GPIO
541 * controller only handling trigger modes. We currently assume no
542 * IRQ mux conflicts; gpio_irq_type_unbanked() is only for GPIOs.
543 */
544 if (pdata->gpio_unbanked) {
545 /* pass "bank 0" GPIO IRQs to AINTC */
546 chips->chip.to_irq = gpio_to_irq_unbanked;
547 chips->gpio_unbanked = pdata->gpio_unbanked;
548 binten = GENMASK(pdata->gpio_unbanked / 16, 0);
549
550 /* AINTC handles mask/unmask; GPIO handles triggering */
551 irq = chips->irqs[0];
552 irq_chip = gpio_get_irq_chip(irq);
553 irq_chip->name = "GPIO-AINTC";
554 irq_chip->irq_set_type = gpio_irq_type_unbanked;
555
556 /* default trigger: both edges */
557 g = chips->regs[0];
558 writel_relaxed(~0, &g->set_falling);
559 writel_relaxed(~0, &g->set_rising);
560
561 /* set the direct IRQs up to use that irqchip */
562 for (gpio = 0; gpio < pdata->gpio_unbanked; gpio++) {
563 irq_set_chip(chips->irqs[gpio], irq_chip);
564 irq_set_handler_data(chips->irqs[gpio], chips);
565 irq_set_status_flags(chips->irqs[gpio],
566 IRQ_TYPE_EDGE_BOTH);
567 }
568
569 goto done;
570 }
571
572 /*
573 * Or, AINTC can handle IRQs for banks of 16 GPIO IRQs, which we
574 * then chain through our own handler.
575 */
576 for (gpio = 0, bank = 0; gpio < ngpio; bank++, gpio += 16) {
577 /* disabled by default, enabled only as needed
578 * There are register sets for 32 GPIOs. 2 banks of 16
579 * GPIOs are covered by each set of registers hence divide by 2
580 */
581 g = chips->regs[bank / 2];
582 writel_relaxed(~0, &g->clr_falling);
583 writel_relaxed(~0, &g->clr_rising);
584
585 /*
586 * Each chip handles 32 gpios, and each irq bank consists of 16
587 * gpio irqs. Pass the irq bank's corresponding controller to
588 * the chained irq handler.
589 */
590 irqdata = devm_kzalloc(&pdev->dev,
591 sizeof(struct
592 davinci_gpio_irq_data),
593 GFP_KERNEL);
594 if (!irqdata) {
595 clk_disable_unprepare(clk);
596 return -ENOMEM;
597 }
598
599 irqdata->regs = g;
600 irqdata->bank_num = bank;
601 irqdata->chip = chips;
602
603 irq_set_chained_handler_and_data(chips->irqs[bank],
604 gpio_irq_handler, irqdata);
605
606 binten |= BIT(bank);
607 }
608
609done:
610 /*
611 * BINTEN -- per-bank interrupt enable. genirq would also let these
612 * bits be set/cleared dynamically.
613 */
614 writel_relaxed(binten, gpio_base + BINTEN);
615
616 return 0;
617}
618
619static void davinci_gpio_save_context(struct davinci_gpio_controller *chips,
620 u32 nbank)
621{
622 struct davinci_gpio_regs __iomem *g;
623 struct davinci_gpio_regs *context;
624 u32 bank;
625 void __iomem *base;
626
627 base = chips->regs[0] - offset_array[0];
628 chips->binten_context = readl_relaxed(base + BINTEN);
629
630 for (bank = 0; bank < nbank; bank++) {
631 g = chips->regs[bank];
632 context = &chips->context[bank];
633 context->dir = readl_relaxed(&g->dir);
634 context->set_data = readl_relaxed(&g->set_data);
635 context->set_rising = readl_relaxed(&g->set_rising);
636 context->set_falling = readl_relaxed(&g->set_falling);
637 }
638
639 /* Clear all interrupt status registers */
640 writel_relaxed(GENMASK(31, 0), &g->intstat);
641}
642
643static void davinci_gpio_restore_context(struct davinci_gpio_controller *chips,
644 u32 nbank)
645{
646 struct davinci_gpio_regs __iomem *g;
647 struct davinci_gpio_regs *context;
648 u32 bank;
649 void __iomem *base;
650
651 base = chips->regs[0] - offset_array[0];
652
653 if (readl_relaxed(base + BINTEN) != chips->binten_context)
654 writel_relaxed(chips->binten_context, base + BINTEN);
655
656 for (bank = 0; bank < nbank; bank++) {
657 g = chips->regs[bank];
658 context = &chips->context[bank];
659 if (readl_relaxed(&g->dir) != context->dir)
660 writel_relaxed(context->dir, &g->dir);
661 if (readl_relaxed(&g->set_data) != context->set_data)
662 writel_relaxed(context->set_data, &g->set_data);
663 if (readl_relaxed(&g->set_rising) != context->set_rising)
664 writel_relaxed(context->set_rising, &g->set_rising);
665 if (readl_relaxed(&g->set_falling) != context->set_falling)
666 writel_relaxed(context->set_falling, &g->set_falling);
667 }
668}
669
670static int davinci_gpio_suspend(struct device *dev)
671{
672 struct davinci_gpio_controller *chips = dev_get_drvdata(dev);
673 struct davinci_gpio_platform_data *pdata = dev_get_platdata(dev);
674 u32 nbank = DIV_ROUND_UP(pdata->ngpio, 32);
675
676 davinci_gpio_save_context(chips, nbank);
677
678 return 0;
679}
680
681static int davinci_gpio_resume(struct device *dev)
682{
683 struct davinci_gpio_controller *chips = dev_get_drvdata(dev);
684 struct davinci_gpio_platform_data *pdata = dev_get_platdata(dev);
685 u32 nbank = DIV_ROUND_UP(pdata->ngpio, 32);
686
687 davinci_gpio_restore_context(chips, nbank);
688
689 return 0;
690}
691
692static DEFINE_SIMPLE_DEV_PM_OPS(davinci_gpio_dev_pm_ops, davinci_gpio_suspend,
693 davinci_gpio_resume);
694
695static const struct of_device_id davinci_gpio_ids[] = {
696 { .compatible = "ti,keystone-gpio", keystone_gpio_get_irq_chip},
697 { .compatible = "ti,am654-gpio", keystone_gpio_get_irq_chip},
698 { .compatible = "ti,dm6441-gpio", davinci_gpio_get_irq_chip},
699 { /* sentinel */ },
700};
701MODULE_DEVICE_TABLE(of, davinci_gpio_ids);
702
703static struct platform_driver davinci_gpio_driver = {
704 .probe = davinci_gpio_probe,
705 .driver = {
706 .name = "davinci_gpio",
707 .pm = pm_sleep_ptr(&davinci_gpio_dev_pm_ops),
708 .of_match_table = of_match_ptr(davinci_gpio_ids),
709 },
710};
711
712/*
713 * GPIO driver registration needs to be done before machine_init functions
714 * access GPIO. Hence davinci_gpio_drv_reg() is a postcore_initcall.
715 */
716static int __init davinci_gpio_drv_reg(void)
717{
718 return platform_driver_register(&davinci_gpio_driver);
719}
720postcore_initcall(davinci_gpio_drv_reg);
721
722static void __exit davinci_gpio_exit(void)
723{
724 platform_driver_unregister(&davinci_gpio_driver);
725}
726module_exit(davinci_gpio_exit);
727
728MODULE_AUTHOR("Jan Kotas <jank@cadence.com>");
729MODULE_DESCRIPTION("DAVINCI GPIO driver");
730MODULE_LICENSE("GPL");
731MODULE_ALIAS("platform:gpio-davinci");
1/*
2 * TI DaVinci GPIO Support
3 *
4 * Copyright (c) 2006-2007 David Brownell
5 * Copyright (c) 2007, MontaVista Software, Inc. <source@mvista.com>
6 *
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.
11 */
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>
17#include <linux/io.h>
18#include <linux/irq.h>
19#include <linux/irqdomain.h>
20#include <linux/module.h>
21#include <linux/of.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>
27
28struct davinci_gpio_regs {
29 u32 dir;
30 u32 out_data;
31 u32 set_data;
32 u32 clr_data;
33 u32 in_data;
34 u32 set_rising;
35 u32 clr_rising;
36 u32 set_falling;
37 u32 clr_falling;
38 u32 intstat;
39};
40
41typedef struct irq_chip *(*gpio_get_irq_chip_cb_t)(unsigned int irq);
42
43#define BINTEN 0x8 /* GPIO Interrupt Per-Bank Enable Register */
44#define MAX_LABEL_SIZE 20
45
46static void __iomem *gpio_base;
47static unsigned int offset_array[5] = {0x10, 0x38, 0x60, 0x88, 0xb0};
48
49static inline struct davinci_gpio_regs __iomem *irq2regs(struct irq_data *d)
50{
51 struct davinci_gpio_regs __iomem *g;
52
53 g = (__force struct davinci_gpio_regs __iomem *)irq_data_get_irq_chip_data(d);
54
55 return g;
56}
57
58static int davinci_gpio_irq_setup(struct platform_device *pdev);
59
60/*--------------------------------------------------------------------------*/
61
62/* board setup code *MUST* setup pinmux and enable the GPIO clock. */
63static inline int __davinci_direction(struct gpio_chip *chip,
64 unsigned offset, bool out, int value)
65{
66 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
67 struct davinci_gpio_regs __iomem *g;
68 unsigned long flags;
69 u32 temp;
70 int bank = offset / 32;
71 u32 mask = __gpio_mask(offset);
72
73 g = d->regs[bank];
74 spin_lock_irqsave(&d->lock, flags);
75 temp = readl_relaxed(&g->dir);
76 if (out) {
77 temp &= ~mask;
78 writel_relaxed(mask, value ? &g->set_data : &g->clr_data);
79 } else {
80 temp |= mask;
81 }
82 writel_relaxed(temp, &g->dir);
83 spin_unlock_irqrestore(&d->lock, flags);
84
85 return 0;
86}
87
88static int davinci_direction_in(struct gpio_chip *chip, unsigned offset)
89{
90 return __davinci_direction(chip, offset, false, 0);
91}
92
93static int
94davinci_direction_out(struct gpio_chip *chip, unsigned offset, int value)
95{
96 return __davinci_direction(chip, offset, true, value);
97}
98
99/*
100 * Read the pin's value (works even if it's set up as output);
101 * returns zero/nonzero.
102 *
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.
105 */
106static int davinci_gpio_get(struct gpio_chip *chip, unsigned offset)
107{
108 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
109 struct davinci_gpio_regs __iomem *g;
110 int bank = offset / 32;
111
112 g = d->regs[bank];
113
114 return !!(__gpio_mask(offset) & readl_relaxed(&g->in_data));
115}
116
117/*
118 * Assuming the pin is muxed as a gpio output, set its output value.
119 */
120static void
121davinci_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
122{
123 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
124 struct davinci_gpio_regs __iomem *g;
125 int bank = offset / 32;
126
127 g = d->regs[bank];
128
129 writel_relaxed(__gpio_mask(offset),
130 value ? &g->set_data : &g->clr_data);
131}
132
133static struct davinci_gpio_platform_data *
134davinci_gpio_get_pdata(struct platform_device *pdev)
135{
136 struct device_node *dn = pdev->dev.of_node;
137 struct davinci_gpio_platform_data *pdata;
138 int ret;
139 u32 val;
140
141 if (!IS_ENABLED(CONFIG_OF) || !pdev->dev.of_node)
142 return dev_get_platdata(&pdev->dev);
143
144 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
145 if (!pdata)
146 return NULL;
147
148 ret = of_property_read_u32(dn, "ti,ngpio", &val);
149 if (ret)
150 goto of_err;
151
152 pdata->ngpio = val;
153
154 ret = of_property_read_u32(dn, "ti,davinci-gpio-unbanked", &val);
155 if (ret)
156 goto of_err;
157
158 pdata->gpio_unbanked = val;
159
160 return pdata;
161
162of_err:
163 dev_err(&pdev->dev, "Populating pdata from DT failed: err %d\n", ret);
164 return NULL;
165}
166
167static int davinci_gpio_probe(struct platform_device *pdev)
168{
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];
177
178 pdata = davinci_gpio_get_pdata(pdev);
179 if (!pdata) {
180 dev_err(dev, "No platform data found\n");
181 return -EINVAL;
182 }
183
184 dev->platform_data = pdata;
185
186 /*
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.
190 */
191 ngpio = pdata->ngpio;
192 if (ngpio == 0) {
193 dev_err(dev, "How many GPIOs?\n");
194 return -EINVAL;
195 }
196
197 if (WARN_ON(ARCH_NR_GPIOS < ngpio))
198 ngpio = ARCH_NR_GPIOS;
199
200 nbank = DIV_ROUND_UP(ngpio, 32);
201 chips = devm_kzalloc(dev,
202 nbank * sizeof(struct davinci_gpio_controller),
203 GFP_KERNEL);
204 if (!chips)
205 return -ENOMEM;
206
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);
211
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)
215 return -ENOMEM;
216
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;
221
222 chips->chip.ngpio = ngpio;
223 chips->chip.base = bank_base;
224
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;
229
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;
233 }
234#endif
235 spin_lock_init(&chips->lock);
236 bank_base += ngpio;
237
238 for (gpio = 0, bank = 0; gpio < ngpio; gpio += 32, bank++)
239 chips->regs[bank] = gpio_base + offset_array[bank];
240
241 ret = devm_gpiochip_add_data(dev, &chips->chip, chips);
242 if (ret)
243 goto err;
244
245 platform_set_drvdata(pdev, chips);
246 ret = davinci_gpio_irq_setup(pdev);
247 if (ret)
248 goto err;
249
250 return 0;
251
252err:
253 /* Revert the static variable increments */
254 ctrl_num--;
255 bank_base -= ngpio;
256
257 return ret;
258}
259
260/*--------------------------------------------------------------------------*/
261/*
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.
264 *
265 * NOTE: The first few GPIOs also have direct INTC hookups in addition
266 * to their GPIOBNK0 irq, with a bit less overhead.
267 *
268 * All those INTC hookups (direct, plus several IRQ banks) can also
269 * serve as EDMA event triggers.
270 */
271
272static void gpio_irq_disable(struct irq_data *d)
273{
274 struct davinci_gpio_regs __iomem *g = irq2regs(d);
275 u32 mask = (u32) irq_data_get_irq_handler_data(d);
276
277 writel_relaxed(mask, &g->clr_falling);
278 writel_relaxed(mask, &g->clr_rising);
279}
280
281static void gpio_irq_enable(struct irq_data *d)
282{
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);
286
287 status &= IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING;
288 if (!status)
289 status = IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING;
290
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);
295}
296
297static int gpio_irq_type(struct irq_data *d, unsigned trigger)
298{
299 if (trigger & ~(IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
300 return -EINVAL;
301
302 return 0;
303}
304
305static struct irq_chip gpio_irqchip = {
306 .name = "GPIO",
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,
311};
312
313static void gpio_irq_handler(struct irq_desc *desc)
314{
315 struct davinci_gpio_regs __iomem *g;
316 u32 mask = 0xffff;
317 int bank_num;
318 struct davinci_gpio_controller *d;
319 struct davinci_gpio_irq_data *irqdata;
320
321 irqdata = (struct davinci_gpio_irq_data *)irq_desc_get_handler_data(desc);
322 bank_num = irqdata->bank_num;
323 g = irqdata->regs;
324 d = irqdata->chip;
325
326 /* we only care about one bank */
327 if ((bank_num % 2) == 1)
328 mask <<= 16;
329
330 /* temporarily mask (level sensitive) parent IRQ */
331 chained_irq_enter(irq_desc_get_chip(desc), desc);
332 while (1) {
333 u32 status;
334 int bit;
335 irq_hw_number_t hw_irq;
336
337 /* ack any irqs */
338 status = readl_relaxed(&g->intstat) & mask;
339 if (!status)
340 break;
341 writel_relaxed(status, &g->intstat);
342
343 /* now demux them to the right lowlevel handler */
344
345 while (status) {
346 bit = __ffs(status);
347 status &= ~BIT(bit);
348 /* Max number of gpios per controller is 144 so
349 * hw_irq will be in [0..143]
350 */
351 hw_irq = (bank_num / 2) * 32 + bit;
352
353 generic_handle_irq(
354 irq_find_mapping(d->irq_domain, hw_irq));
355 }
356 }
357 chained_irq_exit(irq_desc_get_chip(desc), desc);
358 /* now it may re-trigger */
359}
360
361static int gpio_to_irq_banked(struct gpio_chip *chip, unsigned offset)
362{
363 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
364
365 if (d->irq_domain)
366 return irq_create_mapping(d->irq_domain, offset);
367 else
368 return -ENXIO;
369}
370
371static int gpio_to_irq_unbanked(struct gpio_chip *chip, unsigned offset)
372{
373 struct davinci_gpio_controller *d = gpiochip_get_data(chip);
374
375 /*
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).
378 */
379 if (offset < d->gpio_unbanked)
380 return d->base_irq + offset;
381 else
382 return -ENODEV;
383}
384
385static int gpio_irq_type_unbanked(struct irq_data *data, unsigned trigger)
386{
387 struct davinci_gpio_controller *d;
388 struct davinci_gpio_regs __iomem *g;
389 u32 mask;
390
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);
394
395 if (trigger & ~(IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
396 return -EINVAL;
397
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);
402
403 return 0;
404}
405
406static int
407davinci_gpio_irq_map(struct irq_domain *d, unsigned int irq,
408 irq_hw_number_t hw)
409{
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];
413
414 irq_set_chip_and_handler_name(irq, &gpio_irqchip, handle_simple_irq,
415 "davinci_gpio");
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));
419
420 return 0;
421}
422
423static const struct irq_domain_ops davinci_gpio_irq_ops = {
424 .map = davinci_gpio_irq_map,
425 .xlate = irq_domain_xlate_onetwocell,
426};
427
428static struct irq_chip *davinci_gpio_get_irq_chip(unsigned int irq)
429{
430 static struct irq_chip_type gpio_unbanked;
431
432 gpio_unbanked = *irq_data_get_chip_type(irq_get_irq_data(irq));
433
434 return &gpio_unbanked.chip;
435};
436
437static struct irq_chip *keystone_gpio_get_irq_chip(unsigned int irq)
438{
439 static struct irq_chip gpio_unbanked;
440
441 gpio_unbanked = *irq_get_chip(irq);
442 return &gpio_unbanked;
443};
444
445static const struct of_device_id davinci_gpio_ids[];
446
447/*
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.
453 */
454
455static int davinci_gpio_irq_setup(struct platform_device *pdev)
456{
457 unsigned gpio, bank;
458 int irq;
459 int ret;
460 struct clk *clk;
461 u32 binten = 0;
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;
473
474 /*
475 * Use davinci_gpio_get_irq_chip by default to handle non DT cases
476 */
477 gpio_get_irq_chip = davinci_gpio_get_irq_chip;
478 match = of_match_device(of_match_ptr(davinci_gpio_ids),
479 dev);
480 if (match)
481 gpio_get_irq_chip = (gpio_get_irq_chip_cb_t)match->data;
482
483 ngpio = pdata->ngpio;
484 res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
485 if (!res) {
486 dev_err(dev, "Invalid IRQ resource\n");
487 return -EBUSY;
488 }
489
490 bank_irq = res->start;
491
492 if (!bank_irq) {
493 dev_err(dev, "Invalid IRQ resource\n");
494 return -ENODEV;
495 }
496
497 clk = devm_clk_get(dev, "gpio");
498 if (IS_ERR(clk)) {
499 dev_err(dev, "Error %ld getting gpio clock\n", PTR_ERR(clk));
500 return PTR_ERR(clk);
501 }
502 ret = clk_prepare_enable(clk);
503 if (ret)
504 return ret;
505
506 if (!pdata->gpio_unbanked) {
507 irq = devm_irq_alloc_descs(dev, -1, 0, ngpio, 0);
508 if (irq < 0) {
509 dev_err(dev, "Couldn't allocate IRQ numbers\n");
510 clk_disable_unprepare(clk);
511 return irq;
512 }
513
514 irq_domain = irq_domain_add_legacy(dev->of_node, ngpio, irq, 0,
515 &davinci_gpio_irq_ops,
516 chips);
517 if (!irq_domain) {
518 dev_err(dev, "Couldn't register an IRQ domain\n");
519 clk_disable_unprepare(clk);
520 return -ENODEV;
521 }
522 }
523
524 /*
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.
529 */
530 chips->chip.to_irq = gpio_to_irq_banked;
531 chips->irq_domain = irq_domain;
532
533 /*
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.
537 */
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);
544
545 /* AINTC handles mask/unmask; GPIO handles triggering */
546 irq = bank_irq;
547 irq_chip = gpio_get_irq_chip(irq);
548 irq_chip->name = "GPIO-AINTC";
549 irq_chip->irq_set_type = gpio_irq_type_unbanked;
550
551 /* default trigger: both edges */
552 g = chips->regs[0];
553 writel_relaxed(~0, &g->set_falling);
554 writel_relaxed(~0, &g->set_rising);
555
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);
561 }
562
563 goto done;
564 }
565
566 /*
567 * Or, AINTC can handle IRQs for banks of 16 GPIO IRQs, which we
568 * then chain through our own handler.
569 */
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
574 */
575 g = chips->regs[bank / 2];
576 writel_relaxed(~0, &g->clr_falling);
577 writel_relaxed(~0, &g->clr_rising);
578
579 /*
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.
583 */
584 irqdata = devm_kzalloc(&pdev->dev,
585 sizeof(struct
586 davinci_gpio_irq_data),
587 GFP_KERNEL);
588 if (!irqdata) {
589 clk_disable_unprepare(clk);
590 return -ENOMEM;
591 }
592
593 irqdata->regs = g;
594 irqdata->bank_num = bank;
595 irqdata->chip = chips;
596
597 irq_set_chained_handler_and_data(bank_irq, gpio_irq_handler,
598 irqdata);
599
600 binten |= BIT(bank);
601 }
602
603done:
604 /*
605 * BINTEN -- per-bank interrupt enable. genirq would also let these
606 * bits be set/cleared dynamically.
607 */
608 writel_relaxed(binten, gpio_base + BINTEN);
609
610 return 0;
611}
612
613#if IS_ENABLED(CONFIG_OF)
614static const struct of_device_id davinci_gpio_ids[] = {
615 { .compatible = "ti,keystone-gpio", keystone_gpio_get_irq_chip},
616 { .compatible = "ti,dm6441-gpio", davinci_gpio_get_irq_chip},
617 { /* sentinel */ },
618};
619MODULE_DEVICE_TABLE(of, davinci_gpio_ids);
620#endif
621
622static struct platform_driver davinci_gpio_driver = {
623 .probe = davinci_gpio_probe,
624 .driver = {
625 .name = "davinci_gpio",
626 .of_match_table = of_match_ptr(davinci_gpio_ids),
627 },
628};
629
630/**
631 * GPIO driver registration needs to be done before machine_init functions
632 * access GPIO. Hence davinci_gpio_drv_reg() is a postcore_initcall.
633 */
634static int __init davinci_gpio_drv_reg(void)
635{
636 return platform_driver_register(&davinci_gpio_driver);
637}
638postcore_initcall(davinci_gpio_drv_reg);