1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/arch/arm/plat-pxa/gpio.c
5 * Generic PXA GPIO handling
7 * Author: Nicolas Pitre
8 * Created: Jun 15, 2001
9 * Copyright: MontaVista Software Inc.
11 #include <linux/module.h>
12 #include <linux/clk.h>
13 #include <linux/err.h>
14 #include <linux/gpio/driver.h>
15 #include <linux/gpio-pxa.h>
16 #include <linux/init.h>
17 #include <linux/interrupt.h>
18 #include <linux/irq.h>
19 #include <linux/irqdomain.h>
20 #include <linux/irqchip/chained_irq.h>
23 #include <linux/pinctrl/consumer.h>
24 #include <linux/platform_device.h>
25 #include <linux/syscore_ops.h>
26 #include <linux/slab.h>
29 * We handle the GPIOs by banks, each bank covers up to 32 GPIOs with
30 * one set of registers. The register offsets are organized below:
32 * GPLR GPDR GPSR GPCR GRER GFER GEDR
33 * BANK 0 - 0x0000 0x000C 0x0018 0x0024 0x0030 0x003C 0x0048
34 * BANK 1 - 0x0004 0x0010 0x001C 0x0028 0x0034 0x0040 0x004C
35 * BANK 2 - 0x0008 0x0014 0x0020 0x002C 0x0038 0x0044 0x0050
37 * BANK 3 - 0x0100 0x010C 0x0118 0x0124 0x0130 0x013C 0x0148
38 * BANK 4 - 0x0104 0x0110 0x011C 0x0128 0x0134 0x0140 0x014C
39 * BANK 5 - 0x0108 0x0114 0x0120 0x012C 0x0138 0x0144 0x0150
41 * BANK 6 - 0x0200 0x020C 0x0218 0x0224 0x0230 0x023C 0x0248
44 * BANK 3 is only available on PXA27x and later processors.
45 * BANK 4 and 5 are only available on PXA935, PXA1928
46 * BANK 6 is only available on PXA1928
49 #define GPLR_OFFSET 0x00
50 #define GPDR_OFFSET 0x0C
51 #define GPSR_OFFSET 0x18
52 #define GPCR_OFFSET 0x24
53 #define GRER_OFFSET 0x30
54 #define GFER_OFFSET 0x3C
55 #define GEDR_OFFSET 0x48
56 #define GAFR_OFFSET 0x54
57 #define ED_MASK_OFFSET 0x9C /* GPIO edge detection for AP side */
59 #define BANK_OFF(n) (((n) / 3) << 8) + (((n) % 3) << 2)
64 struct pxa_gpio_bank {
65 void __iomem *regbase;
66 unsigned long irq_mask;
67 unsigned long irq_edge_rise;
68 unsigned long irq_edge_fall;
71 unsigned long saved_gplr;
72 unsigned long saved_gpdr;
73 unsigned long saved_grer;
74 unsigned long saved_gfer;
78 struct pxa_gpio_chip {
80 struct gpio_chip chip;
81 struct pxa_gpio_bank *banks;
82 struct irq_domain *irqdomain;
86 int (*set_wake)(unsigned int gpio, unsigned int on);
101 enum pxa_gpio_type type;
105 static DEFINE_SPINLOCK(gpio_lock);
106 static struct pxa_gpio_chip *pxa_gpio_chip;
107 static enum pxa_gpio_type gpio_type;
109 static struct pxa_gpio_id pxa25x_id = {
114 static struct pxa_gpio_id pxa26x_id = {
119 static struct pxa_gpio_id pxa27x_id = {
124 static struct pxa_gpio_id pxa3xx_id = {
129 static struct pxa_gpio_id pxa93x_id = {
134 static struct pxa_gpio_id mmp_id = {
139 static struct pxa_gpio_id mmp2_id = {
144 static struct pxa_gpio_id pxa1928_id = {
145 .type = PXA1928_GPIO,
149 #define for_each_gpio_bank(i, b, pc) \
150 for (i = 0, b = pc->banks; i <= pxa_last_gpio; i += 32, b++)
152 static inline struct pxa_gpio_chip *chip_to_pxachip(struct gpio_chip *c)
154 struct pxa_gpio_chip *pxa_chip = gpiochip_get_data(c);
159 static inline void __iomem *gpio_bank_base(struct gpio_chip *c, int gpio)
161 struct pxa_gpio_chip *p = gpiochip_get_data(c);
162 struct pxa_gpio_bank *bank = p->banks + (gpio / 32);
164 return bank->regbase;
167 static inline struct pxa_gpio_bank *gpio_to_pxabank(struct gpio_chip *c,
170 return chip_to_pxachip(c)->banks + gpio / 32;
173 static inline int gpio_is_mmp_type(int type)
175 return (type & MMP_GPIO) != 0;
178 /* GPIO86/87/88/89 on PXA26x have their direction bits in PXA_GPDR(2 inverted,
179 * as well as their Alternate Function value being '1' for GPIO in GAFRx.
181 static inline int __gpio_is_inverted(int gpio)
183 if ((gpio_type == PXA26X_GPIO) && (gpio > 85))
189 * On PXA25x and PXA27x, GAFRx and GPDRx together decide the alternate
190 * function of a GPIO, and GPDRx cannot be altered once configured. It
191 * is attributed as "occupied" here (I know this terminology isn't
192 * accurate, you are welcome to propose a better one :-)
194 static inline int __gpio_is_occupied(struct pxa_gpio_chip *pchip, unsigned gpio)
197 unsigned long gafr = 0, gpdr = 0;
198 int ret, af = 0, dir = 0;
200 base = gpio_bank_base(&pchip->chip, gpio);
201 gpdr = readl_relaxed(base + GPDR_OFFSET);
207 gafr = readl_relaxed(base + GAFR_OFFSET);
208 af = (gafr >> ((gpio & 0xf) * 2)) & 0x3;
209 dir = gpdr & GPIO_bit(gpio);
211 if (__gpio_is_inverted(gpio))
212 ret = (af != 1) || (dir == 0);
214 ret = (af != 0) || (dir != 0);
217 ret = gpdr & GPIO_bit(gpio);
223 int pxa_irq_to_gpio(int irq)
225 struct pxa_gpio_chip *pchip = pxa_gpio_chip;
228 irq_gpio0 = irq_find_mapping(pchip->irqdomain, 0);
230 return irq - irq_gpio0;
235 static bool pxa_gpio_has_pinctrl(void)
248 static int pxa_gpio_to_irq(struct gpio_chip *chip, unsigned offset)
250 struct pxa_gpio_chip *pchip = chip_to_pxachip(chip);
252 return irq_find_mapping(pchip->irqdomain, offset);
255 static int pxa_gpio_direction_input(struct gpio_chip *chip, unsigned offset)
257 void __iomem *base = gpio_bank_base(chip, offset);
258 uint32_t value, mask = GPIO_bit(offset);
262 if (pxa_gpio_has_pinctrl()) {
263 ret = pinctrl_gpio_direction_input(chip->base + offset);
268 spin_lock_irqsave(&gpio_lock, flags);
270 value = readl_relaxed(base + GPDR_OFFSET);
271 if (__gpio_is_inverted(chip->base + offset))
275 writel_relaxed(value, base + GPDR_OFFSET);
277 spin_unlock_irqrestore(&gpio_lock, flags);
281 static int pxa_gpio_direction_output(struct gpio_chip *chip,
282 unsigned offset, int value)
284 void __iomem *base = gpio_bank_base(chip, offset);
285 uint32_t tmp, mask = GPIO_bit(offset);
289 writel_relaxed(mask, base + (value ? GPSR_OFFSET : GPCR_OFFSET));
291 if (pxa_gpio_has_pinctrl()) {
292 ret = pinctrl_gpio_direction_output(chip->base + offset);
297 spin_lock_irqsave(&gpio_lock, flags);
299 tmp = readl_relaxed(base + GPDR_OFFSET);
300 if (__gpio_is_inverted(chip->base + offset))
304 writel_relaxed(tmp, base + GPDR_OFFSET);
306 spin_unlock_irqrestore(&gpio_lock, flags);
310 static int pxa_gpio_get(struct gpio_chip *chip, unsigned offset)
312 void __iomem *base = gpio_bank_base(chip, offset);
313 u32 gplr = readl_relaxed(base + GPLR_OFFSET);
315 return !!(gplr & GPIO_bit(offset));
318 static void pxa_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
320 void __iomem *base = gpio_bank_base(chip, offset);
322 writel_relaxed(GPIO_bit(offset),
323 base + (value ? GPSR_OFFSET : GPCR_OFFSET));
326 #ifdef CONFIG_OF_GPIO
327 static int pxa_gpio_of_xlate(struct gpio_chip *gc,
328 const struct of_phandle_args *gpiospec,
331 if (gpiospec->args[0] > pxa_last_gpio)
335 *flags = gpiospec->args[1];
337 return gpiospec->args[0];
341 static int pxa_init_gpio_chip(struct pxa_gpio_chip *pchip, int ngpio, void __iomem *regbase)
343 int i, gpio, nbanks = DIV_ROUND_UP(ngpio, 32);
344 struct pxa_gpio_bank *bank;
346 pchip->banks = devm_kcalloc(pchip->dev, nbanks, sizeof(*pchip->banks),
351 pchip->chip.parent = pchip->dev;
352 pchip->chip.label = "gpio-pxa";
353 pchip->chip.direction_input = pxa_gpio_direction_input;
354 pchip->chip.direction_output = pxa_gpio_direction_output;
355 pchip->chip.get = pxa_gpio_get;
356 pchip->chip.set = pxa_gpio_set;
357 pchip->chip.to_irq = pxa_gpio_to_irq;
358 pchip->chip.ngpio = ngpio;
359 pchip->chip.request = gpiochip_generic_request;
360 pchip->chip.free = gpiochip_generic_free;
362 #ifdef CONFIG_OF_GPIO
363 pchip->chip.of_xlate = pxa_gpio_of_xlate;
364 pchip->chip.of_gpio_n_cells = 2;
367 for (i = 0, gpio = 0; i < nbanks; i++, gpio += 32) {
368 bank = pchip->banks + i;
369 bank->regbase = regbase + BANK_OFF(i);
372 return gpiochip_add_data(&pchip->chip, pchip);
375 /* Update only those GRERx and GFERx edge detection register bits if those
376 * bits are set in c->irq_mask
378 static inline void update_edge_detect(struct pxa_gpio_bank *c)
382 grer = readl_relaxed(c->regbase + GRER_OFFSET) & ~c->irq_mask;
383 gfer = readl_relaxed(c->regbase + GFER_OFFSET) & ~c->irq_mask;
384 grer |= c->irq_edge_rise & c->irq_mask;
385 gfer |= c->irq_edge_fall & c->irq_mask;
386 writel_relaxed(grer, c->regbase + GRER_OFFSET);
387 writel_relaxed(gfer, c->regbase + GFER_OFFSET);
390 static int pxa_gpio_irq_type(struct irq_data *d, unsigned int type)
392 struct pxa_gpio_chip *pchip = irq_data_get_irq_chip_data(d);
393 unsigned int gpio = irqd_to_hwirq(d);
394 struct pxa_gpio_bank *c = gpio_to_pxabank(&pchip->chip, gpio);
395 unsigned long gpdr, mask = GPIO_bit(gpio);
397 if (type == IRQ_TYPE_PROBE) {
398 /* Don't mess with enabled GPIOs using preconfigured edges or
399 * GPIOs set to alternate function or to output during probe
401 if ((c->irq_edge_rise | c->irq_edge_fall) & GPIO_bit(gpio))
404 if (__gpio_is_occupied(pchip, gpio))
407 type = IRQ_TYPE_EDGE_RISING | IRQ_TYPE_EDGE_FALLING;
410 gpdr = readl_relaxed(c->regbase + GPDR_OFFSET);
412 if (__gpio_is_inverted(gpio))
413 writel_relaxed(gpdr | mask, c->regbase + GPDR_OFFSET);
415 writel_relaxed(gpdr & ~mask, c->regbase + GPDR_OFFSET);
417 if (type & IRQ_TYPE_EDGE_RISING)
418 c->irq_edge_rise |= mask;
420 c->irq_edge_rise &= ~mask;
422 if (type & IRQ_TYPE_EDGE_FALLING)
423 c->irq_edge_fall |= mask;
425 c->irq_edge_fall &= ~mask;
427 update_edge_detect(c);
429 pr_debug("%s: IRQ%d (GPIO%d) - edge%s%s\n", __func__, d->irq, gpio,
430 ((type & IRQ_TYPE_EDGE_RISING) ? " rising" : ""),
431 ((type & IRQ_TYPE_EDGE_FALLING) ? " falling" : ""));
435 static irqreturn_t pxa_gpio_demux_handler(int in_irq, void *d)
437 int loop, gpio, n, handled = 0;
439 struct pxa_gpio_chip *pchip = d;
440 struct pxa_gpio_bank *c;
444 for_each_gpio_bank(gpio, c, pchip) {
445 gedr = readl_relaxed(c->regbase + GEDR_OFFSET);
446 gedr = gedr & c->irq_mask;
447 writel_relaxed(gedr, c->regbase + GEDR_OFFSET);
449 for_each_set_bit(n, &gedr, BITS_PER_LONG) {
452 generic_handle_domain_irq(pchip->irqdomain,
459 return handled ? IRQ_HANDLED : IRQ_NONE;
462 static irqreturn_t pxa_gpio_direct_handler(int in_irq, void *d)
464 struct pxa_gpio_chip *pchip = d;
466 if (in_irq == pchip->irq0) {
467 generic_handle_domain_irq(pchip->irqdomain, 0);
468 } else if (in_irq == pchip->irq1) {
469 generic_handle_domain_irq(pchip->irqdomain, 1);
471 pr_err("%s() unknown irq %d\n", __func__, in_irq);
477 static void pxa_ack_muxed_gpio(struct irq_data *d)
479 struct pxa_gpio_chip *pchip = irq_data_get_irq_chip_data(d);
480 unsigned int gpio = irqd_to_hwirq(d);
481 void __iomem *base = gpio_bank_base(&pchip->chip, gpio);
483 writel_relaxed(GPIO_bit(gpio), base + GEDR_OFFSET);
486 static void pxa_mask_muxed_gpio(struct irq_data *d)
488 struct pxa_gpio_chip *pchip = irq_data_get_irq_chip_data(d);
489 unsigned int gpio = irqd_to_hwirq(d);
490 struct pxa_gpio_bank *b = gpio_to_pxabank(&pchip->chip, gpio);
491 void __iomem *base = gpio_bank_base(&pchip->chip, gpio);
494 b->irq_mask &= ~GPIO_bit(gpio);
496 grer = readl_relaxed(base + GRER_OFFSET) & ~GPIO_bit(gpio);
497 gfer = readl_relaxed(base + GFER_OFFSET) & ~GPIO_bit(gpio);
498 writel_relaxed(grer, base + GRER_OFFSET);
499 writel_relaxed(gfer, base + GFER_OFFSET);
502 static int pxa_gpio_set_wake(struct irq_data *d, unsigned int on)
504 struct pxa_gpio_chip *pchip = irq_data_get_irq_chip_data(d);
505 unsigned int gpio = irqd_to_hwirq(d);
508 return pchip->set_wake(gpio, on);
513 static void pxa_unmask_muxed_gpio(struct irq_data *d)
515 struct pxa_gpio_chip *pchip = irq_data_get_irq_chip_data(d);
516 unsigned int gpio = irqd_to_hwirq(d);
517 struct pxa_gpio_bank *c = gpio_to_pxabank(&pchip->chip, gpio);
519 c->irq_mask |= GPIO_bit(gpio);
520 update_edge_detect(c);
523 static struct irq_chip pxa_muxed_gpio_chip = {
525 .irq_ack = pxa_ack_muxed_gpio,
526 .irq_mask = pxa_mask_muxed_gpio,
527 .irq_unmask = pxa_unmask_muxed_gpio,
528 .irq_set_type = pxa_gpio_irq_type,
529 .irq_set_wake = pxa_gpio_set_wake,
532 static int pxa_gpio_nums(struct platform_device *pdev)
534 const struct platform_device_id *id = platform_get_device_id(pdev);
535 struct pxa_gpio_id *pxa_id = (struct pxa_gpio_id *)id->driver_data;
538 switch (pxa_id->type) {
547 gpio_type = pxa_id->type;
548 count = pxa_id->gpio_nums - 1;
557 static int pxa_irq_domain_map(struct irq_domain *d, unsigned int irq,
560 irq_set_chip_and_handler(irq, &pxa_muxed_gpio_chip,
562 irq_set_chip_data(irq, d->host_data);
563 irq_set_noprobe(irq);
567 static const struct irq_domain_ops pxa_irq_domain_ops = {
568 .map = pxa_irq_domain_map,
569 .xlate = irq_domain_xlate_twocell,
573 static const struct of_device_id pxa_gpio_dt_ids[] = {
574 { .compatible = "intel,pxa25x-gpio", .data = &pxa25x_id, },
575 { .compatible = "intel,pxa26x-gpio", .data = &pxa26x_id, },
576 { .compatible = "intel,pxa27x-gpio", .data = &pxa27x_id, },
577 { .compatible = "intel,pxa3xx-gpio", .data = &pxa3xx_id, },
578 { .compatible = "marvell,pxa93x-gpio", .data = &pxa93x_id, },
579 { .compatible = "marvell,mmp-gpio", .data = &mmp_id, },
580 { .compatible = "marvell,mmp2-gpio", .data = &mmp2_id, },
581 { .compatible = "marvell,pxa1928-gpio", .data = &pxa1928_id, },
585 static int pxa_gpio_probe_dt(struct platform_device *pdev,
586 struct pxa_gpio_chip *pchip)
589 const struct pxa_gpio_id *gpio_id;
591 gpio_id = of_device_get_match_data(&pdev->dev);
592 gpio_type = gpio_id->type;
594 nr_gpios = gpio_id->gpio_nums;
595 pxa_last_gpio = nr_gpios - 1;
597 irq_base = devm_irq_alloc_descs(&pdev->dev, -1, 0, nr_gpios, 0);
599 dev_err(&pdev->dev, "Failed to allocate IRQ numbers\n");
605 #define pxa_gpio_probe_dt(pdev, pchip) (-1)
608 static int pxa_gpio_probe(struct platform_device *pdev)
610 struct pxa_gpio_chip *pchip;
611 struct pxa_gpio_bank *c;
613 struct pxa_gpio_platform_data *info;
614 void __iomem *gpio_reg_base;
616 int irq0 = 0, irq1 = 0, irq_mux;
618 pchip = devm_kzalloc(&pdev->dev, sizeof(*pchip), GFP_KERNEL);
621 pchip->dev = &pdev->dev;
623 info = dev_get_platdata(&pdev->dev);
625 irq_base = info->irq_base;
628 pxa_last_gpio = pxa_gpio_nums(pdev);
629 pchip->set_wake = info->gpio_set_wake;
631 irq_base = pxa_gpio_probe_dt(pdev, pchip);
639 pchip->irqdomain = irq_domain_add_legacy(pdev->dev.of_node,
640 pxa_last_gpio + 1, irq_base,
641 0, &pxa_irq_domain_ops, pchip);
642 if (!pchip->irqdomain)
645 irq0 = platform_get_irq_byname_optional(pdev, "gpio0");
646 irq1 = platform_get_irq_byname_optional(pdev, "gpio1");
647 irq_mux = platform_get_irq_byname(pdev, "gpio_mux");
648 if ((irq0 > 0 && irq1 <= 0) || (irq0 <= 0 && irq1 > 0)
655 gpio_reg_base = devm_platform_ioremap_resource(pdev, 0);
656 if (IS_ERR(gpio_reg_base))
657 return PTR_ERR(gpio_reg_base);
659 clk = devm_clk_get_enabled(&pdev->dev, NULL);
661 dev_err(&pdev->dev, "Error %ld to get gpio clock\n",
666 /* Initialize GPIO chips */
667 ret = pxa_init_gpio_chip(pchip, pxa_last_gpio + 1, gpio_reg_base);
671 /* clear all GPIO edge detects */
672 for_each_gpio_bank(gpio, c, pchip) {
673 writel_relaxed(0, c->regbase + GFER_OFFSET);
674 writel_relaxed(0, c->regbase + GRER_OFFSET);
675 writel_relaxed(~0, c->regbase + GEDR_OFFSET);
676 /* unmask GPIO edge detect for AP side */
677 if (gpio_is_mmp_type(gpio_type))
678 writel_relaxed(~0, c->regbase + ED_MASK_OFFSET);
682 ret = devm_request_irq(&pdev->dev,
683 irq0, pxa_gpio_direct_handler, 0,
686 dev_err(&pdev->dev, "request of gpio0 irq failed: %d\n",
690 ret = devm_request_irq(&pdev->dev,
691 irq1, pxa_gpio_direct_handler, 0,
694 dev_err(&pdev->dev, "request of gpio1 irq failed: %d\n",
697 ret = devm_request_irq(&pdev->dev,
698 irq_mux, pxa_gpio_demux_handler, 0,
701 dev_err(&pdev->dev, "request of gpio-mux irq failed: %d\n",
704 pxa_gpio_chip = pchip;
709 static const struct platform_device_id gpio_id_table[] = {
710 { "pxa25x-gpio", (unsigned long)&pxa25x_id },
711 { "pxa26x-gpio", (unsigned long)&pxa26x_id },
712 { "pxa27x-gpio", (unsigned long)&pxa27x_id },
713 { "pxa3xx-gpio", (unsigned long)&pxa3xx_id },
714 { "pxa93x-gpio", (unsigned long)&pxa93x_id },
715 { "mmp-gpio", (unsigned long)&mmp_id },
716 { "mmp2-gpio", (unsigned long)&mmp2_id },
717 { "pxa1928-gpio", (unsigned long)&pxa1928_id },
721 static struct platform_driver pxa_gpio_driver = {
722 .probe = pxa_gpio_probe,
725 .of_match_table = of_match_ptr(pxa_gpio_dt_ids),
727 .id_table = gpio_id_table,
730 static int __init pxa_gpio_legacy_init(void)
732 if (of_have_populated_dt())
735 return platform_driver_register(&pxa_gpio_driver);
737 postcore_initcall(pxa_gpio_legacy_init);
739 static int __init pxa_gpio_dt_init(void)
741 if (of_have_populated_dt())
742 return platform_driver_register(&pxa_gpio_driver);
746 device_initcall(pxa_gpio_dt_init);
749 static int pxa_gpio_suspend(void)
751 struct pxa_gpio_chip *pchip = pxa_gpio_chip;
752 struct pxa_gpio_bank *c;
758 for_each_gpio_bank(gpio, c, pchip) {
759 c->saved_gplr = readl_relaxed(c->regbase + GPLR_OFFSET);
760 c->saved_gpdr = readl_relaxed(c->regbase + GPDR_OFFSET);
761 c->saved_grer = readl_relaxed(c->regbase + GRER_OFFSET);
762 c->saved_gfer = readl_relaxed(c->regbase + GFER_OFFSET);
764 /* Clear GPIO transition detect bits */
765 writel_relaxed(0xffffffff, c->regbase + GEDR_OFFSET);
770 static void pxa_gpio_resume(void)
772 struct pxa_gpio_chip *pchip = pxa_gpio_chip;
773 struct pxa_gpio_bank *c;
779 for_each_gpio_bank(gpio, c, pchip) {
780 /* restore level with set/clear */
781 writel_relaxed(c->saved_gplr, c->regbase + GPSR_OFFSET);
782 writel_relaxed(~c->saved_gplr, c->regbase + GPCR_OFFSET);
784 writel_relaxed(c->saved_grer, c->regbase + GRER_OFFSET);
785 writel_relaxed(c->saved_gfer, c->regbase + GFER_OFFSET);
786 writel_relaxed(c->saved_gpdr, c->regbase + GPDR_OFFSET);
790 #define pxa_gpio_suspend NULL
791 #define pxa_gpio_resume NULL
794 static struct syscore_ops pxa_gpio_syscore_ops = {
795 .suspend = pxa_gpio_suspend,
796 .resume = pxa_gpio_resume,
799 static int __init pxa_gpio_sysinit(void)
801 register_syscore_ops(&pxa_gpio_syscore_ops);
804 postcore_initcall(pxa_gpio_sysinit);