1 // SPDX-License-Identifier: GPL-2.0+
3 // MXC GPIO support. (c) 2008 Daniel Mack <daniel@caiaq.de>
4 // Copyright 2008 Juergen Beisert, kernel@pengutronix.de
6 // Based on code from Freescale Semiconductor,
7 // Authors: Daniel Mack, Juergen Beisert.
8 // Copyright (C) 2004-2010 Freescale Semiconductor, Inc. All Rights Reserved.
10 #include <linux/clk.h>
11 #include <linux/err.h>
12 #include <linux/init.h>
13 #include <linux/interrupt.h>
15 #include <linux/irq.h>
16 #include <linux/irqdomain.h>
17 #include <linux/irqchip/chained_irq.h>
18 #include <linux/module.h>
19 #include <linux/platform_device.h>
20 #include <linux/pm_runtime.h>
21 #include <linux/slab.h>
22 #include <linux/spinlock.h>
23 #include <linux/syscore_ops.h>
24 #include <linux/gpio/driver.h>
26 #include <linux/bug.h>
28 #define IMX_SCU_WAKEUP_OFF 0
29 #define IMX_SCU_WAKEUP_LOW_LVL 4
30 #define IMX_SCU_WAKEUP_FALL_EDGE 5
31 #define IMX_SCU_WAKEUP_RISE_EDGE 6
32 #define IMX_SCU_WAKEUP_HIGH_LVL 7
34 /* device type dependent stuff */
35 struct mxc_gpio_hwdata {
50 struct mxc_gpio_reg_saved {
59 struct mxc_gpio_port {
60 struct list_head node;
65 void (*mx_irq_handler)(struct irq_desc *desc);
66 struct irq_domain *domain;
70 struct mxc_gpio_reg_saved gpio_saved_reg;
75 const struct mxc_gpio_hwdata *hwdata;
78 static struct mxc_gpio_hwdata imx1_imx21_gpio_hwdata = {
86 .edge_sel_reg = -EINVAL,
93 static struct mxc_gpio_hwdata imx31_gpio_hwdata = {
101 .edge_sel_reg = -EINVAL,
108 static struct mxc_gpio_hwdata imx35_gpio_hwdata = {
116 .edge_sel_reg = 0x1c,
123 #define GPIO_DR (port->hwdata->dr_reg)
124 #define GPIO_GDIR (port->hwdata->gdir_reg)
125 #define GPIO_PSR (port->hwdata->psr_reg)
126 #define GPIO_ICR1 (port->hwdata->icr1_reg)
127 #define GPIO_ICR2 (port->hwdata->icr2_reg)
128 #define GPIO_IMR (port->hwdata->imr_reg)
129 #define GPIO_ISR (port->hwdata->isr_reg)
130 #define GPIO_EDGE_SEL (port->hwdata->edge_sel_reg)
132 #define GPIO_INT_LOW_LEV (port->hwdata->low_level)
133 #define GPIO_INT_HIGH_LEV (port->hwdata->high_level)
134 #define GPIO_INT_RISE_EDGE (port->hwdata->rise_edge)
135 #define GPIO_INT_FALL_EDGE (port->hwdata->fall_edge)
136 #define GPIO_INT_BOTH_EDGES 0x4
138 static const struct of_device_id mxc_gpio_dt_ids[] = {
139 { .compatible = "fsl,imx1-gpio", .data = &imx1_imx21_gpio_hwdata },
140 { .compatible = "fsl,imx21-gpio", .data = &imx1_imx21_gpio_hwdata },
141 { .compatible = "fsl,imx31-gpio", .data = &imx31_gpio_hwdata },
142 { .compatible = "fsl,imx35-gpio", .data = &imx35_gpio_hwdata },
143 { .compatible = "fsl,imx7d-gpio", .data = &imx35_gpio_hwdata },
144 { .compatible = "fsl,imx8dxl-gpio", .data = &imx35_gpio_hwdata },
145 { .compatible = "fsl,imx8qm-gpio", .data = &imx35_gpio_hwdata },
146 { .compatible = "fsl,imx8qxp-gpio", .data = &imx35_gpio_hwdata },
149 MODULE_DEVICE_TABLE(of, mxc_gpio_dt_ids);
152 * MX2 has one interrupt *for all* gpio ports. The list is used
153 * to save the references to all ports, so that mx2_gpio_irq_handler
154 * can walk through all interrupt status registers.
156 static LIST_HEAD(mxc_gpio_ports);
158 /* Note: This driver assumes 32 GPIOs are handled in one register */
160 static int gpio_set_irq_type(struct irq_data *d, u32 type)
162 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
163 struct mxc_gpio_port *port = gc->private;
166 u32 gpio_idx = d->hwirq;
168 void __iomem *reg = port->base;
170 port->both_edges &= ~(1 << gpio_idx);
172 case IRQ_TYPE_EDGE_RISING:
173 edge = GPIO_INT_RISE_EDGE;
175 case IRQ_TYPE_EDGE_FALLING:
176 edge = GPIO_INT_FALL_EDGE;
178 case IRQ_TYPE_EDGE_BOTH:
179 if (GPIO_EDGE_SEL >= 0) {
180 edge = GPIO_INT_BOTH_EDGES;
182 val = port->gc.get(&port->gc, gpio_idx);
184 edge = GPIO_INT_LOW_LEV;
185 pr_debug("mxc: set GPIO %d to low trigger\n", gpio_idx);
187 edge = GPIO_INT_HIGH_LEV;
188 pr_debug("mxc: set GPIO %d to high trigger\n", gpio_idx);
190 port->both_edges |= 1 << gpio_idx;
193 case IRQ_TYPE_LEVEL_LOW:
194 edge = GPIO_INT_LOW_LEV;
196 case IRQ_TYPE_LEVEL_HIGH:
197 edge = GPIO_INT_HIGH_LEV;
203 raw_spin_lock_irqsave(&port->gc.bgpio_lock, flags);
205 if (GPIO_EDGE_SEL >= 0) {
206 val = readl(port->base + GPIO_EDGE_SEL);
207 if (edge == GPIO_INT_BOTH_EDGES)
208 writel(val | (1 << gpio_idx),
209 port->base + GPIO_EDGE_SEL);
211 writel(val & ~(1 << gpio_idx),
212 port->base + GPIO_EDGE_SEL);
215 if (edge != GPIO_INT_BOTH_EDGES) {
216 reg += GPIO_ICR1 + ((gpio_idx & 0x10) >> 2); /* lower or upper register */
217 bit = gpio_idx & 0xf;
218 val = readl(reg) & ~(0x3 << (bit << 1));
219 writel(val | (edge << (bit << 1)), reg);
222 writel(1 << gpio_idx, port->base + GPIO_ISR);
223 port->pad_type[gpio_idx] = type;
225 raw_spin_unlock_irqrestore(&port->gc.bgpio_lock, flags);
227 return port->gc.direction_input(&port->gc, gpio_idx);
230 static void mxc_flip_edge(struct mxc_gpio_port *port, u32 gpio)
232 void __iomem *reg = port->base;
237 raw_spin_lock_irqsave(&port->gc.bgpio_lock, flags);
239 reg += GPIO_ICR1 + ((gpio & 0x10) >> 2); /* lower or upper register */
242 edge = (val >> (bit << 1)) & 3;
243 val &= ~(0x3 << (bit << 1));
244 if (edge == GPIO_INT_HIGH_LEV) {
245 edge = GPIO_INT_LOW_LEV;
246 pr_debug("mxc: switch GPIO %d to low trigger\n", gpio);
247 } else if (edge == GPIO_INT_LOW_LEV) {
248 edge = GPIO_INT_HIGH_LEV;
249 pr_debug("mxc: switch GPIO %d to high trigger\n", gpio);
251 pr_err("mxc: invalid configuration for GPIO %d: %x\n",
255 writel(val | (edge << (bit << 1)), reg);
258 raw_spin_unlock_irqrestore(&port->gc.bgpio_lock, flags);
261 /* handle 32 interrupts in one status register */
262 static void mxc_gpio_irq_handler(struct mxc_gpio_port *port, u32 irq_stat)
264 while (irq_stat != 0) {
265 int irqoffset = fls(irq_stat) - 1;
267 if (port->both_edges & (1 << irqoffset))
268 mxc_flip_edge(port, irqoffset);
270 generic_handle_domain_irq(port->domain, irqoffset);
272 irq_stat &= ~(1 << irqoffset);
276 /* MX1 and MX3 has one interrupt *per* gpio port */
277 static void mx3_gpio_irq_handler(struct irq_desc *desc)
280 struct mxc_gpio_port *port = irq_desc_get_handler_data(desc);
281 struct irq_chip *chip = irq_desc_get_chip(desc);
283 if (port->is_pad_wakeup)
286 chained_irq_enter(chip, desc);
288 irq_stat = readl(port->base + GPIO_ISR) & readl(port->base + GPIO_IMR);
290 mxc_gpio_irq_handler(port, irq_stat);
292 chained_irq_exit(chip, desc);
295 /* MX2 has one interrupt *for all* gpio ports */
296 static void mx2_gpio_irq_handler(struct irq_desc *desc)
298 u32 irq_msk, irq_stat;
299 struct mxc_gpio_port *port;
300 struct irq_chip *chip = irq_desc_get_chip(desc);
302 chained_irq_enter(chip, desc);
304 /* walk through all interrupt status registers */
305 list_for_each_entry(port, &mxc_gpio_ports, node) {
306 irq_msk = readl(port->base + GPIO_IMR);
310 irq_stat = readl(port->base + GPIO_ISR) & irq_msk;
312 mxc_gpio_irq_handler(port, irq_stat);
314 chained_irq_exit(chip, desc);
318 * Set interrupt number "irq" in the GPIO as a wake-up source.
319 * While system is running, all registered GPIO interrupts need to have
320 * wake-up enabled. When system is suspended, only selected GPIO interrupts
321 * need to have wake-up enabled.
322 * @param irq interrupt source number
323 * @param enable enable as wake-up if equal to non-zero
324 * @return This function returns 0 on success.
326 static int gpio_set_wake_irq(struct irq_data *d, u32 enable)
328 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
329 struct mxc_gpio_port *port = gc->private;
330 u32 gpio_idx = d->hwirq;
334 if (port->irq_high && (gpio_idx >= 16))
335 ret = enable_irq_wake(port->irq_high);
337 ret = enable_irq_wake(port->irq);
338 port->wakeup_pads |= (1 << gpio_idx);
340 if (port->irq_high && (gpio_idx >= 16))
341 ret = disable_irq_wake(port->irq_high);
343 ret = disable_irq_wake(port->irq);
344 port->wakeup_pads &= ~(1 << gpio_idx);
350 static int mxc_gpio_init_gc(struct mxc_gpio_port *port, int irq_base)
352 struct irq_chip_generic *gc;
353 struct irq_chip_type *ct;
356 gc = devm_irq_alloc_generic_chip(port->dev, "gpio-mxc", 1, irq_base,
357 port->base, handle_level_irq);
363 ct->chip.irq_ack = irq_gc_ack_set_bit;
364 ct->chip.irq_mask = irq_gc_mask_clr_bit;
365 ct->chip.irq_unmask = irq_gc_mask_set_bit;
366 ct->chip.irq_set_type = gpio_set_irq_type;
367 ct->chip.irq_set_wake = gpio_set_wake_irq;
368 ct->chip.flags = IRQCHIP_MASK_ON_SUSPEND | IRQCHIP_ENABLE_WAKEUP_ON_SUSPEND;
369 ct->regs.ack = GPIO_ISR;
370 ct->regs.mask = GPIO_IMR;
372 rv = devm_irq_setup_generic_chip(port->dev, gc, IRQ_MSK(32),
373 IRQ_GC_INIT_NESTED_LOCK,
379 static int mxc_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
381 struct mxc_gpio_port *port = gpiochip_get_data(gc);
383 return irq_find_mapping(port->domain, offset);
386 static int mxc_gpio_request(struct gpio_chip *chip, unsigned int offset)
390 ret = gpiochip_generic_request(chip, offset);
394 return pm_runtime_resume_and_get(chip->parent);
397 static void mxc_gpio_free(struct gpio_chip *chip, unsigned int offset)
399 gpiochip_generic_free(chip, offset);
400 pm_runtime_put(chip->parent);
403 static void mxc_update_irq_chained_handler(struct mxc_gpio_port *port, bool enable)
406 irq_set_chained_handler_and_data(port->irq, port->mx_irq_handler, port);
408 irq_set_chained_handler_and_data(port->irq, NULL, NULL);
410 /* setup handler for GPIO 16 to 31 */
411 if (port->irq_high > 0) {
413 irq_set_chained_handler_and_data(port->irq_high,
414 port->mx_irq_handler,
417 irq_set_chained_handler_and_data(port->irq_high, NULL, NULL);
421 static int mxc_gpio_probe(struct platform_device *pdev)
423 struct device_node *np = pdev->dev.of_node;
424 struct mxc_gpio_port *port;
429 port = devm_kzalloc(&pdev->dev, sizeof(*port), GFP_KERNEL);
433 port->dev = &pdev->dev;
434 port->hwdata = device_get_match_data(&pdev->dev);
436 port->base = devm_platform_ioremap_resource(pdev, 0);
437 if (IS_ERR(port->base))
438 return PTR_ERR(port->base);
440 irq_count = platform_irq_count(pdev);
445 port->irq_high = platform_get_irq(pdev, 1);
446 if (port->irq_high < 0)
450 port->irq = platform_get_irq(pdev, 0);
454 /* the controller clock is optional */
455 port->clk = devm_clk_get_optional_enabled(&pdev->dev, NULL);
456 if (IS_ERR(port->clk))
457 return PTR_ERR(port->clk);
459 if (of_device_is_compatible(np, "fsl,imx7d-gpio"))
460 port->power_off = true;
462 pm_runtime_get_noresume(&pdev->dev);
463 pm_runtime_set_active(&pdev->dev);
464 pm_runtime_enable(&pdev->dev);
466 /* disable the interrupt and clear the status */
467 writel(0, port->base + GPIO_IMR);
468 writel(~0, port->base + GPIO_ISR);
470 if (of_device_is_compatible(np, "fsl,imx21-gpio")) {
472 * Setup one handler for all GPIO interrupts. Actually setting
473 * the handler is needed only once, but doing it for every port
474 * is more robust and easier.
477 port->mx_irq_handler = mx2_gpio_irq_handler;
479 port->mx_irq_handler = mx3_gpio_irq_handler;
481 mxc_update_irq_chained_handler(port, true);
482 err = bgpio_init(&port->gc, &pdev->dev, 4,
483 port->base + GPIO_PSR,
484 port->base + GPIO_DR, NULL,
485 port->base + GPIO_GDIR, NULL,
486 BGPIOF_READ_OUTPUT_REG_SET);
490 port->gc.request = mxc_gpio_request;
491 port->gc.free = mxc_gpio_free;
492 port->gc.to_irq = mxc_gpio_to_irq;
493 port->gc.base = (pdev->id < 0) ? of_alias_get_id(np, "gpio") * 32 :
496 err = devm_gpiochip_add_data(&pdev->dev, &port->gc, port);
500 irq_base = devm_irq_alloc_descs(&pdev->dev, -1, 0, 32, numa_node_id());
506 port->domain = irq_domain_add_legacy(np, 32, irq_base, 0,
507 &irq_domain_simple_ops, NULL);
513 irq_domain_set_pm_device(port->domain, &pdev->dev);
515 /* gpio-mxc can be a generic irq chip */
516 err = mxc_gpio_init_gc(port, irq_base);
518 goto out_irqdomain_remove;
520 list_add_tail(&port->node, &mxc_gpio_ports);
522 platform_set_drvdata(pdev, port);
523 pm_runtime_put_autosuspend(&pdev->dev);
527 out_irqdomain_remove:
528 irq_domain_remove(port->domain);
530 pm_runtime_disable(&pdev->dev);
531 pm_runtime_put_noidle(&pdev->dev);
532 dev_info(&pdev->dev, "%s failed with errno %d\n", __func__, err);
536 static void mxc_gpio_save_regs(struct mxc_gpio_port *port)
538 if (!port->power_off)
541 port->gpio_saved_reg.icr1 = readl(port->base + GPIO_ICR1);
542 port->gpio_saved_reg.icr2 = readl(port->base + GPIO_ICR2);
543 port->gpio_saved_reg.imr = readl(port->base + GPIO_IMR);
544 port->gpio_saved_reg.gdir = readl(port->base + GPIO_GDIR);
545 port->gpio_saved_reg.edge_sel = readl(port->base + GPIO_EDGE_SEL);
546 port->gpio_saved_reg.dr = readl(port->base + GPIO_DR);
549 static void mxc_gpio_restore_regs(struct mxc_gpio_port *port)
551 if (!port->power_off)
554 writel(port->gpio_saved_reg.icr1, port->base + GPIO_ICR1);
555 writel(port->gpio_saved_reg.icr2, port->base + GPIO_ICR2);
556 writel(port->gpio_saved_reg.imr, port->base + GPIO_IMR);
557 writel(port->gpio_saved_reg.gdir, port->base + GPIO_GDIR);
558 writel(port->gpio_saved_reg.edge_sel, port->base + GPIO_EDGE_SEL);
559 writel(port->gpio_saved_reg.dr, port->base + GPIO_DR);
562 static bool mxc_gpio_generic_config(struct mxc_gpio_port *port,
563 unsigned int offset, unsigned long conf)
565 struct device_node *np = port->dev->of_node;
567 if (of_device_is_compatible(np, "fsl,imx8dxl-gpio") ||
568 of_device_is_compatible(np, "fsl,imx8qxp-gpio") ||
569 of_device_is_compatible(np, "fsl,imx8qm-gpio"))
570 return (gpiochip_generic_config(&port->gc, offset, conf) == 0);
575 static bool mxc_gpio_set_pad_wakeup(struct mxc_gpio_port *port, bool enable)
577 unsigned long config;
581 static const u32 pad_type_map[] = {
582 IMX_SCU_WAKEUP_OFF, /* 0 */
583 IMX_SCU_WAKEUP_RISE_EDGE, /* IRQ_TYPE_EDGE_RISING */
584 IMX_SCU_WAKEUP_FALL_EDGE, /* IRQ_TYPE_EDGE_FALLING */
585 IMX_SCU_WAKEUP_FALL_EDGE, /* IRQ_TYPE_EDGE_BOTH */
586 IMX_SCU_WAKEUP_HIGH_LVL, /* IRQ_TYPE_LEVEL_HIGH */
587 IMX_SCU_WAKEUP_OFF, /* 5 */
588 IMX_SCU_WAKEUP_OFF, /* 6 */
589 IMX_SCU_WAKEUP_OFF, /* 7 */
590 IMX_SCU_WAKEUP_LOW_LVL, /* IRQ_TYPE_LEVEL_LOW */
593 for (i = 0; i < 32; i++) {
594 if ((port->wakeup_pads & (1 << i))) {
595 type = port->pad_type[i];
597 config = pad_type_map[type];
599 config = IMX_SCU_WAKEUP_OFF;
600 ret |= mxc_gpio_generic_config(port, i, config);
607 static int mxc_gpio_runtime_suspend(struct device *dev)
609 struct mxc_gpio_port *port = dev_get_drvdata(dev);
611 mxc_gpio_save_regs(port);
612 clk_disable_unprepare(port->clk);
613 mxc_update_irq_chained_handler(port, false);
618 static int mxc_gpio_runtime_resume(struct device *dev)
620 struct mxc_gpio_port *port = dev_get_drvdata(dev);
623 mxc_update_irq_chained_handler(port, true);
624 ret = clk_prepare_enable(port->clk);
626 mxc_update_irq_chained_handler(port, false);
630 mxc_gpio_restore_regs(port);
635 static int mxc_gpio_noirq_suspend(struct device *dev)
637 struct platform_device *pdev = to_platform_device(dev);
638 struct mxc_gpio_port *port = platform_get_drvdata(pdev);
640 if (port->wakeup_pads > 0)
641 port->is_pad_wakeup = mxc_gpio_set_pad_wakeup(port, true);
646 static int mxc_gpio_noirq_resume(struct device *dev)
648 struct platform_device *pdev = to_platform_device(dev);
649 struct mxc_gpio_port *port = platform_get_drvdata(pdev);
651 if (port->wakeup_pads > 0)
652 mxc_gpio_set_pad_wakeup(port, false);
653 port->is_pad_wakeup = false;
658 static const struct dev_pm_ops mxc_gpio_dev_pm_ops = {
659 NOIRQ_SYSTEM_SLEEP_PM_OPS(mxc_gpio_noirq_suspend, mxc_gpio_noirq_resume)
660 RUNTIME_PM_OPS(mxc_gpio_runtime_suspend, mxc_gpio_runtime_resume, NULL)
663 static int mxc_gpio_syscore_suspend(void)
665 struct mxc_gpio_port *port;
668 /* walk through all ports */
669 list_for_each_entry(port, &mxc_gpio_ports, node) {
670 ret = clk_prepare_enable(port->clk);
673 mxc_gpio_save_regs(port);
674 clk_disable_unprepare(port->clk);
680 static void mxc_gpio_syscore_resume(void)
682 struct mxc_gpio_port *port;
685 /* walk through all ports */
686 list_for_each_entry(port, &mxc_gpio_ports, node) {
687 ret = clk_prepare_enable(port->clk);
689 pr_err("mxc: failed to enable gpio clock %d\n", ret);
692 mxc_gpio_restore_regs(port);
693 clk_disable_unprepare(port->clk);
697 static struct syscore_ops mxc_gpio_syscore_ops = {
698 .suspend = mxc_gpio_syscore_suspend,
699 .resume = mxc_gpio_syscore_resume,
702 static struct platform_driver mxc_gpio_driver = {
705 .of_match_table = mxc_gpio_dt_ids,
706 .suppress_bind_attrs = true,
707 .pm = pm_ptr(&mxc_gpio_dev_pm_ops),
709 .probe = mxc_gpio_probe,
712 static int __init gpio_mxc_init(void)
714 register_syscore_ops(&mxc_gpio_syscore_ops);
716 return platform_driver_register(&mxc_gpio_driver);
718 subsys_initcall(gpio_mxc_init);
720 MODULE_AUTHOR("Shawn Guo <shawn.guo@linaro.org>");
721 MODULE_DESCRIPTION("i.MX GPIO Driver");
722 MODULE_LICENSE("GPL");