1 // SPDX-License-Identifier: GPL-2.0+
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/slab.h>
21 #include <linux/spinlock.h>
22 #include <linux/syscore_ops.h>
23 #include <linux/gpio/driver.h>
25 #include <linux/of_device.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 struct irq_domain *domain;
69 struct mxc_gpio_reg_saved gpio_saved_reg;
74 const struct mxc_gpio_hwdata *hwdata;
77 static struct mxc_gpio_hwdata imx1_imx21_gpio_hwdata = {
85 .edge_sel_reg = -EINVAL,
92 static struct mxc_gpio_hwdata imx31_gpio_hwdata = {
100 .edge_sel_reg = -EINVAL,
107 static struct mxc_gpio_hwdata imx35_gpio_hwdata = {
115 .edge_sel_reg = 0x1c,
122 #define GPIO_DR (port->hwdata->dr_reg)
123 #define GPIO_GDIR (port->hwdata->gdir_reg)
124 #define GPIO_PSR (port->hwdata->psr_reg)
125 #define GPIO_ICR1 (port->hwdata->icr1_reg)
126 #define GPIO_ICR2 (port->hwdata->icr2_reg)
127 #define GPIO_IMR (port->hwdata->imr_reg)
128 #define GPIO_ISR (port->hwdata->isr_reg)
129 #define GPIO_EDGE_SEL (port->hwdata->edge_sel_reg)
131 #define GPIO_INT_LOW_LEV (port->hwdata->low_level)
132 #define GPIO_INT_HIGH_LEV (port->hwdata->high_level)
133 #define GPIO_INT_RISE_EDGE (port->hwdata->rise_edge)
134 #define GPIO_INT_FALL_EDGE (port->hwdata->fall_edge)
135 #define GPIO_INT_BOTH_EDGES 0x4
137 static const struct of_device_id mxc_gpio_dt_ids[] = {
138 { .compatible = "fsl,imx1-gpio", .data = &imx1_imx21_gpio_hwdata },
139 { .compatible = "fsl,imx21-gpio", .data = &imx1_imx21_gpio_hwdata },
140 { .compatible = "fsl,imx31-gpio", .data = &imx31_gpio_hwdata },
141 { .compatible = "fsl,imx35-gpio", .data = &imx35_gpio_hwdata },
142 { .compatible = "fsl,imx7d-gpio", .data = &imx35_gpio_hwdata },
143 { .compatible = "fsl,imx8dxl-gpio", .data = &imx35_gpio_hwdata },
144 { .compatible = "fsl,imx8qm-gpio", .data = &imx35_gpio_hwdata },
145 { .compatible = "fsl,imx8qxp-gpio", .data = &imx35_gpio_hwdata },
148 MODULE_DEVICE_TABLE(of, mxc_gpio_dt_ids);
151 * MX2 has one interrupt *for all* gpio ports. The list is used
152 * to save the references to all ports, so that mx2_gpio_irq_handler
153 * can walk through all interrupt status registers.
155 static LIST_HEAD(mxc_gpio_ports);
157 /* Note: This driver assumes 32 GPIOs are handled in one register */
159 static int gpio_set_irq_type(struct irq_data *d, u32 type)
161 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
162 struct mxc_gpio_port *port = gc->private;
165 u32 gpio_idx = d->hwirq;
167 void __iomem *reg = port->base;
169 port->both_edges &= ~(1 << gpio_idx);
171 case IRQ_TYPE_EDGE_RISING:
172 edge = GPIO_INT_RISE_EDGE;
174 case IRQ_TYPE_EDGE_FALLING:
175 edge = GPIO_INT_FALL_EDGE;
177 case IRQ_TYPE_EDGE_BOTH:
178 if (GPIO_EDGE_SEL >= 0) {
179 edge = GPIO_INT_BOTH_EDGES;
181 val = port->gc.get(&port->gc, gpio_idx);
183 edge = GPIO_INT_LOW_LEV;
184 pr_debug("mxc: set GPIO %d to low trigger\n", gpio_idx);
186 edge = GPIO_INT_HIGH_LEV;
187 pr_debug("mxc: set GPIO %d to high trigger\n", gpio_idx);
189 port->both_edges |= 1 << gpio_idx;
192 case IRQ_TYPE_LEVEL_LOW:
193 edge = GPIO_INT_LOW_LEV;
195 case IRQ_TYPE_LEVEL_HIGH:
196 edge = GPIO_INT_HIGH_LEV;
202 raw_spin_lock_irqsave(&port->gc.bgpio_lock, flags);
204 if (GPIO_EDGE_SEL >= 0) {
205 val = readl(port->base + GPIO_EDGE_SEL);
206 if (edge == GPIO_INT_BOTH_EDGES)
207 writel(val | (1 << gpio_idx),
208 port->base + GPIO_EDGE_SEL);
210 writel(val & ~(1 << gpio_idx),
211 port->base + GPIO_EDGE_SEL);
214 if (edge != GPIO_INT_BOTH_EDGES) {
215 reg += GPIO_ICR1 + ((gpio_idx & 0x10) >> 2); /* lower or upper register */
216 bit = gpio_idx & 0xf;
217 val = readl(reg) & ~(0x3 << (bit << 1));
218 writel(val | (edge << (bit << 1)), reg);
221 writel(1 << gpio_idx, port->base + GPIO_ISR);
222 port->pad_type[gpio_idx] = type;
224 raw_spin_unlock_irqrestore(&port->gc.bgpio_lock, flags);
226 return port->gc.direction_input(&port->gc, gpio_idx);
229 static void mxc_flip_edge(struct mxc_gpio_port *port, u32 gpio)
231 void __iomem *reg = port->base;
236 raw_spin_lock_irqsave(&port->gc.bgpio_lock, flags);
238 reg += GPIO_ICR1 + ((gpio & 0x10) >> 2); /* lower or upper register */
241 edge = (val >> (bit << 1)) & 3;
242 val &= ~(0x3 << (bit << 1));
243 if (edge == GPIO_INT_HIGH_LEV) {
244 edge = GPIO_INT_LOW_LEV;
245 pr_debug("mxc: switch GPIO %d to low trigger\n", gpio);
246 } else if (edge == GPIO_INT_LOW_LEV) {
247 edge = GPIO_INT_HIGH_LEV;
248 pr_debug("mxc: switch GPIO %d to high trigger\n", gpio);
250 pr_err("mxc: invalid configuration for GPIO %d: %x\n",
254 writel(val | (edge << (bit << 1)), reg);
257 raw_spin_unlock_irqrestore(&port->gc.bgpio_lock, flags);
260 /* handle 32 interrupts in one status register */
261 static void mxc_gpio_irq_handler(struct mxc_gpio_port *port, u32 irq_stat)
263 while (irq_stat != 0) {
264 int irqoffset = fls(irq_stat) - 1;
266 if (port->both_edges & (1 << irqoffset))
267 mxc_flip_edge(port, irqoffset);
269 generic_handle_domain_irq(port->domain, irqoffset);
271 irq_stat &= ~(1 << irqoffset);
275 /* MX1 and MX3 has one interrupt *per* gpio port */
276 static void mx3_gpio_irq_handler(struct irq_desc *desc)
279 struct mxc_gpio_port *port = irq_desc_get_handler_data(desc);
280 struct irq_chip *chip = irq_desc_get_chip(desc);
282 if (port->is_pad_wakeup)
285 chained_irq_enter(chip, desc);
287 irq_stat = readl(port->base + GPIO_ISR) & readl(port->base + GPIO_IMR);
289 mxc_gpio_irq_handler(port, irq_stat);
291 chained_irq_exit(chip, desc);
294 /* MX2 has one interrupt *for all* gpio ports */
295 static void mx2_gpio_irq_handler(struct irq_desc *desc)
297 u32 irq_msk, irq_stat;
298 struct mxc_gpio_port *port;
299 struct irq_chip *chip = irq_desc_get_chip(desc);
301 chained_irq_enter(chip, desc);
303 /* walk through all interrupt status registers */
304 list_for_each_entry(port, &mxc_gpio_ports, node) {
305 irq_msk = readl(port->base + GPIO_IMR);
309 irq_stat = readl(port->base + GPIO_ISR) & irq_msk;
311 mxc_gpio_irq_handler(port, irq_stat);
313 chained_irq_exit(chip, desc);
317 * Set interrupt number "irq" in the GPIO as a wake-up source.
318 * While system is running, all registered GPIO interrupts need to have
319 * wake-up enabled. When system is suspended, only selected GPIO interrupts
320 * need to have wake-up enabled.
321 * @param irq interrupt source number
322 * @param enable enable as wake-up if equal to non-zero
323 * @return This function returns 0 on success.
325 static int gpio_set_wake_irq(struct irq_data *d, u32 enable)
327 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
328 struct mxc_gpio_port *port = gc->private;
329 u32 gpio_idx = d->hwirq;
333 if (port->irq_high && (gpio_idx >= 16))
334 ret = enable_irq_wake(port->irq_high);
336 ret = enable_irq_wake(port->irq);
337 port->wakeup_pads |= (1 << gpio_idx);
339 if (port->irq_high && (gpio_idx >= 16))
340 ret = disable_irq_wake(port->irq_high);
342 ret = disable_irq_wake(port->irq);
343 port->wakeup_pads &= ~(1 << gpio_idx);
349 static int mxc_gpio_init_gc(struct mxc_gpio_port *port, int irq_base)
351 struct irq_chip_generic *gc;
352 struct irq_chip_type *ct;
355 gc = devm_irq_alloc_generic_chip(port->dev, "gpio-mxc", 1, irq_base,
356 port->base, handle_level_irq);
362 ct->chip.irq_ack = irq_gc_ack_set_bit;
363 ct->chip.irq_mask = irq_gc_mask_clr_bit;
364 ct->chip.irq_unmask = irq_gc_mask_set_bit;
365 ct->chip.irq_set_type = gpio_set_irq_type;
366 ct->chip.irq_set_wake = gpio_set_wake_irq;
367 ct->chip.flags = IRQCHIP_MASK_ON_SUSPEND | IRQCHIP_ENABLE_WAKEUP_ON_SUSPEND;
368 ct->regs.ack = GPIO_ISR;
369 ct->regs.mask = GPIO_IMR;
371 rv = devm_irq_setup_generic_chip(port->dev, gc, IRQ_MSK(32),
372 IRQ_GC_INIT_NESTED_LOCK,
378 static int mxc_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
380 struct mxc_gpio_port *port = gpiochip_get_data(gc);
382 return irq_find_mapping(port->domain, offset);
385 static int mxc_gpio_probe(struct platform_device *pdev)
387 struct device_node *np = pdev->dev.of_node;
388 struct mxc_gpio_port *port;
393 port = devm_kzalloc(&pdev->dev, sizeof(*port), GFP_KERNEL);
397 port->dev = &pdev->dev;
398 port->hwdata = device_get_match_data(&pdev->dev);
400 port->base = devm_platform_ioremap_resource(pdev, 0);
401 if (IS_ERR(port->base))
402 return PTR_ERR(port->base);
404 irq_count = platform_irq_count(pdev);
409 port->irq_high = platform_get_irq(pdev, 1);
410 if (port->irq_high < 0)
414 port->irq = platform_get_irq(pdev, 0);
418 /* the controller clock is optional */
419 port->clk = devm_clk_get_optional(&pdev->dev, NULL);
420 if (IS_ERR(port->clk))
421 return PTR_ERR(port->clk);
423 err = clk_prepare_enable(port->clk);
425 dev_err(&pdev->dev, "Unable to enable clock.\n");
429 if (of_device_is_compatible(np, "fsl,imx7d-gpio"))
430 port->power_off = true;
432 /* disable the interrupt and clear the status */
433 writel(0, port->base + GPIO_IMR);
434 writel(~0, port->base + GPIO_ISR);
436 if (of_device_is_compatible(np, "fsl,imx21-gpio")) {
438 * Setup one handler for all GPIO interrupts. Actually setting
439 * the handler is needed only once, but doing it for every port
440 * is more robust and easier.
442 irq_set_chained_handler(port->irq, mx2_gpio_irq_handler);
444 /* setup one handler for each entry */
445 irq_set_chained_handler_and_data(port->irq,
446 mx3_gpio_irq_handler, port);
447 if (port->irq_high > 0)
448 /* setup handler for GPIO 16 to 31 */
449 irq_set_chained_handler_and_data(port->irq_high,
450 mx3_gpio_irq_handler,
454 err = bgpio_init(&port->gc, &pdev->dev, 4,
455 port->base + GPIO_PSR,
456 port->base + GPIO_DR, NULL,
457 port->base + GPIO_GDIR, NULL,
458 BGPIOF_READ_OUTPUT_REG_SET);
462 port->gc.request = gpiochip_generic_request;
463 port->gc.free = gpiochip_generic_free;
464 port->gc.to_irq = mxc_gpio_to_irq;
465 port->gc.base = (pdev->id < 0) ? of_alias_get_id(np, "gpio") * 32 :
468 err = devm_gpiochip_add_data(&pdev->dev, &port->gc, port);
472 irq_base = devm_irq_alloc_descs(&pdev->dev, -1, 0, 32, numa_node_id());
478 port->domain = irq_domain_add_legacy(np, 32, irq_base, 0,
479 &irq_domain_simple_ops, NULL);
485 /* gpio-mxc can be a generic irq chip */
486 err = mxc_gpio_init_gc(port, irq_base);
488 goto out_irqdomain_remove;
490 list_add_tail(&port->node, &mxc_gpio_ports);
492 platform_set_drvdata(pdev, port);
496 out_irqdomain_remove:
497 irq_domain_remove(port->domain);
499 clk_disable_unprepare(port->clk);
500 dev_info(&pdev->dev, "%s failed with errno %d\n", __func__, err);
504 static void mxc_gpio_save_regs(struct mxc_gpio_port *port)
506 if (!port->power_off)
509 port->gpio_saved_reg.icr1 = readl(port->base + GPIO_ICR1);
510 port->gpio_saved_reg.icr2 = readl(port->base + GPIO_ICR2);
511 port->gpio_saved_reg.imr = readl(port->base + GPIO_IMR);
512 port->gpio_saved_reg.gdir = readl(port->base + GPIO_GDIR);
513 port->gpio_saved_reg.edge_sel = readl(port->base + GPIO_EDGE_SEL);
514 port->gpio_saved_reg.dr = readl(port->base + GPIO_DR);
517 static void mxc_gpio_restore_regs(struct mxc_gpio_port *port)
519 if (!port->power_off)
522 writel(port->gpio_saved_reg.icr1, port->base + GPIO_ICR1);
523 writel(port->gpio_saved_reg.icr2, port->base + GPIO_ICR2);
524 writel(port->gpio_saved_reg.imr, port->base + GPIO_IMR);
525 writel(port->gpio_saved_reg.gdir, port->base + GPIO_GDIR);
526 writel(port->gpio_saved_reg.edge_sel, port->base + GPIO_EDGE_SEL);
527 writel(port->gpio_saved_reg.dr, port->base + GPIO_DR);
530 static bool mxc_gpio_generic_config(struct mxc_gpio_port *port,
531 unsigned int offset, unsigned long conf)
533 struct device_node *np = port->dev->of_node;
535 if (of_device_is_compatible(np, "fsl,imx8dxl-gpio") ||
536 of_device_is_compatible(np, "fsl,imx8qxp-gpio") ||
537 of_device_is_compatible(np, "fsl,imx8qm-gpio"))
538 return (gpiochip_generic_config(&port->gc, offset, conf) == 0);
543 static bool mxc_gpio_set_pad_wakeup(struct mxc_gpio_port *port, bool enable)
545 unsigned long config;
549 static const u32 pad_type_map[] = {
550 IMX_SCU_WAKEUP_OFF, /* 0 */
551 IMX_SCU_WAKEUP_RISE_EDGE, /* IRQ_TYPE_EDGE_RISING */
552 IMX_SCU_WAKEUP_FALL_EDGE, /* IRQ_TYPE_EDGE_FALLING */
553 IMX_SCU_WAKEUP_FALL_EDGE, /* IRQ_TYPE_EDGE_BOTH */
554 IMX_SCU_WAKEUP_HIGH_LVL, /* IRQ_TYPE_LEVEL_HIGH */
555 IMX_SCU_WAKEUP_OFF, /* 5 */
556 IMX_SCU_WAKEUP_OFF, /* 6 */
557 IMX_SCU_WAKEUP_OFF, /* 7 */
558 IMX_SCU_WAKEUP_LOW_LVL, /* IRQ_TYPE_LEVEL_LOW */
561 for (i = 0; i < 32; i++) {
562 if ((port->wakeup_pads & (1 << i))) {
563 type = port->pad_type[i];
565 config = pad_type_map[type];
567 config = IMX_SCU_WAKEUP_OFF;
568 ret |= mxc_gpio_generic_config(port, i, config);
575 static int __maybe_unused mxc_gpio_noirq_suspend(struct device *dev)
577 struct platform_device *pdev = to_platform_device(dev);
578 struct mxc_gpio_port *port = platform_get_drvdata(pdev);
580 if (port->wakeup_pads > 0)
581 port->is_pad_wakeup = mxc_gpio_set_pad_wakeup(port, true);
586 static int __maybe_unused mxc_gpio_noirq_resume(struct device *dev)
588 struct platform_device *pdev = to_platform_device(dev);
589 struct mxc_gpio_port *port = platform_get_drvdata(pdev);
591 if (port->wakeup_pads > 0)
592 mxc_gpio_set_pad_wakeup(port, false);
593 port->is_pad_wakeup = false;
598 static const struct dev_pm_ops mxc_gpio_dev_pm_ops = {
599 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(mxc_gpio_noirq_suspend, mxc_gpio_noirq_resume)
602 static int mxc_gpio_syscore_suspend(void)
604 struct mxc_gpio_port *port;
606 /* walk through all ports */
607 list_for_each_entry(port, &mxc_gpio_ports, node) {
608 mxc_gpio_save_regs(port);
609 clk_disable_unprepare(port->clk);
615 static void mxc_gpio_syscore_resume(void)
617 struct mxc_gpio_port *port;
620 /* walk through all ports */
621 list_for_each_entry(port, &mxc_gpio_ports, node) {
622 ret = clk_prepare_enable(port->clk);
624 pr_err("mxc: failed to enable gpio clock %d\n", ret);
627 mxc_gpio_restore_regs(port);
631 static struct syscore_ops mxc_gpio_syscore_ops = {
632 .suspend = mxc_gpio_syscore_suspend,
633 .resume = mxc_gpio_syscore_resume,
636 static struct platform_driver mxc_gpio_driver = {
639 .of_match_table = mxc_gpio_dt_ids,
640 .suppress_bind_attrs = true,
641 .pm = &mxc_gpio_dev_pm_ops,
643 .probe = mxc_gpio_probe,
646 static int __init gpio_mxc_init(void)
648 register_syscore_ops(&mxc_gpio_syscore_ops);
650 return platform_driver_register(&mxc_gpio_driver);
652 subsys_initcall(gpio_mxc_init);
655 MODULE_DESCRIPTION("i.MX GPIO Driver");
656 MODULE_LICENSE("GPL");