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,
7 // Copyright (C) 2004-2010 Freescale Semiconductor, Inc. All Rights Reserved.
10 #include <linux/init.h>
11 #include <linux/interrupt.h>
13 #include <linux/irq.h>
14 #include <linux/irqdomain.h>
16 #include <linux/of_address.h>
17 #include <linux/of_device.h>
18 #include <linux/platform_device.h>
19 #include <linux/slab.h>
20 #include <linux/gpio/driver.h>
21 #include <linux/module.h>
26 #define PINCTRL_DOUT(p) ((is_imx23_gpio(p) ? 0x0500 : 0x0700) + (p->id) * 0x10)
27 #define PINCTRL_DIN(p) ((is_imx23_gpio(p) ? 0x0600 : 0x0900) + (p->id) * 0x10)
28 #define PINCTRL_DOE(p) ((is_imx23_gpio(p) ? 0x0700 : 0x0b00) + (p->id) * 0x10)
29 #define PINCTRL_PIN2IRQ(p) ((is_imx23_gpio(p) ? 0x0800 : 0x1000) + (p->id) * 0x10)
30 #define PINCTRL_IRQEN(p) ((is_imx23_gpio(p) ? 0x0900 : 0x1100) + (p->id) * 0x10)
31 #define PINCTRL_IRQLEV(p) ((is_imx23_gpio(p) ? 0x0a00 : 0x1200) + (p->id) * 0x10)
32 #define PINCTRL_IRQPOL(p) ((is_imx23_gpio(p) ? 0x0b00 : 0x1300) + (p->id) * 0x10)
33 #define PINCTRL_IRQSTAT(p) ((is_imx23_gpio(p) ? 0x0c00 : 0x1400) + (p->id) * 0x10)
35 #define GPIO_INT_FALL_EDGE 0x0
36 #define GPIO_INT_LOW_LEV 0x1
37 #define GPIO_INT_RISE_EDGE 0x2
38 #define GPIO_INT_HIGH_LEV 0x3
39 #define GPIO_INT_LEV_MASK (1 << 0)
40 #define GPIO_INT_POL_MASK (1 << 1)
47 struct mxs_gpio_port
{
51 struct irq_domain
*domain
;
54 enum mxs_gpio_id devid
;
58 static inline int is_imx23_gpio(struct mxs_gpio_port
*port
)
60 return port
->devid
== IMX23_GPIO
;
63 static inline int is_imx28_gpio(struct mxs_gpio_port
*port
)
65 return port
->devid
== IMX28_GPIO
;
68 /* Note: This driver assumes 32 GPIOs are handled in one register */
70 static int mxs_gpio_set_irq_type(struct irq_data
*d
, unsigned int type
)
73 u32 pin_mask
= 1 << d
->hwirq
;
74 struct irq_chip_generic
*gc
= irq_data_get_irq_chip_data(d
);
75 struct irq_chip_type
*ct
= irq_data_get_chip_type(d
);
76 struct mxs_gpio_port
*port
= gc
->private;
77 void __iomem
*pin_addr
;
80 if (!(ct
->type
& type
))
81 if (irq_setup_alt_chip(d
, type
))
84 port
->both_edges
&= ~pin_mask
;
86 case IRQ_TYPE_EDGE_BOTH
:
87 val
= readl(port
->base
+ PINCTRL_DIN(port
)) & pin_mask
;
89 edge
= GPIO_INT_FALL_EDGE
;
91 edge
= GPIO_INT_RISE_EDGE
;
92 port
->both_edges
|= pin_mask
;
94 case IRQ_TYPE_EDGE_RISING
:
95 edge
= GPIO_INT_RISE_EDGE
;
97 case IRQ_TYPE_EDGE_FALLING
:
98 edge
= GPIO_INT_FALL_EDGE
;
100 case IRQ_TYPE_LEVEL_LOW
:
101 edge
= GPIO_INT_LOW_LEV
;
103 case IRQ_TYPE_LEVEL_HIGH
:
104 edge
= GPIO_INT_HIGH_LEV
;
110 /* set level or edge */
111 pin_addr
= port
->base
+ PINCTRL_IRQLEV(port
);
112 if (edge
& GPIO_INT_LEV_MASK
) {
113 writel(pin_mask
, pin_addr
+ MXS_SET
);
114 writel(pin_mask
, port
->base
+ PINCTRL_IRQEN(port
) + MXS_SET
);
116 writel(pin_mask
, pin_addr
+ MXS_CLR
);
117 writel(pin_mask
, port
->base
+ PINCTRL_PIN2IRQ(port
) + MXS_SET
);
121 pin_addr
= port
->base
+ PINCTRL_IRQPOL(port
);
122 if (edge
& GPIO_INT_POL_MASK
)
123 writel(pin_mask
, pin_addr
+ MXS_SET
);
125 writel(pin_mask
, pin_addr
+ MXS_CLR
);
127 writel(pin_mask
, port
->base
+ PINCTRL_IRQSTAT(port
) + MXS_CLR
);
132 static void mxs_flip_edge(struct mxs_gpio_port
*port
, u32 gpio
)
135 void __iomem
*pin_addr
;
139 pin_addr
= port
->base
+ PINCTRL_IRQPOL(port
);
140 val
= readl(pin_addr
);
144 writel(bit
, pin_addr
+ MXS_CLR
);
146 writel(bit
, pin_addr
+ MXS_SET
);
149 /* MXS has one interrupt *per* gpio port */
150 static void mxs_gpio_irq_handler(struct irq_desc
*desc
)
153 struct mxs_gpio_port
*port
= irq_desc_get_handler_data(desc
);
155 desc
->irq_data
.chip
->irq_ack(&desc
->irq_data
);
157 irq_stat
= readl(port
->base
+ PINCTRL_IRQSTAT(port
)) &
158 readl(port
->base
+ PINCTRL_IRQEN(port
));
160 while (irq_stat
!= 0) {
161 int irqoffset
= fls(irq_stat
) - 1;
162 if (port
->both_edges
& (1 << irqoffset
))
163 mxs_flip_edge(port
, irqoffset
);
165 generic_handle_irq(irq_find_mapping(port
->domain
, irqoffset
));
166 irq_stat
&= ~(1 << irqoffset
);
171 * Set interrupt number "irq" in the GPIO as a wake-up source.
172 * While system is running, all registered GPIO interrupts need to have
173 * wake-up enabled. When system is suspended, only selected GPIO interrupts
174 * need to have wake-up enabled.
175 * @param irq interrupt source number
176 * @param enable enable as wake-up if equal to non-zero
177 * @return This function returns 0 on success.
179 static int mxs_gpio_set_wake_irq(struct irq_data
*d
, unsigned int enable
)
181 struct irq_chip_generic
*gc
= irq_data_get_irq_chip_data(d
);
182 struct mxs_gpio_port
*port
= gc
->private;
185 enable_irq_wake(port
->irq
);
187 disable_irq_wake(port
->irq
);
192 static int mxs_gpio_init_gc(struct mxs_gpio_port
*port
, int irq_base
)
194 struct irq_chip_generic
*gc
;
195 struct irq_chip_type
*ct
;
198 gc
= devm_irq_alloc_generic_chip(port
->dev
, "gpio-mxs", 2, irq_base
,
199 port
->base
, handle_level_irq
);
205 ct
= &gc
->chip_types
[0];
206 ct
->type
= IRQ_TYPE_LEVEL_HIGH
| IRQ_TYPE_LEVEL_LOW
;
207 ct
->chip
.irq_ack
= irq_gc_ack_set_bit
;
208 ct
->chip
.irq_mask
= irq_gc_mask_disable_reg
;
209 ct
->chip
.irq_unmask
= irq_gc_unmask_enable_reg
;
210 ct
->chip
.irq_set_type
= mxs_gpio_set_irq_type
;
211 ct
->chip
.irq_set_wake
= mxs_gpio_set_wake_irq
;
212 ct
->chip
.flags
= IRQCHIP_SET_TYPE_MASKED
;
213 ct
->regs
.ack
= PINCTRL_IRQSTAT(port
) + MXS_CLR
;
214 ct
->regs
.enable
= PINCTRL_PIN2IRQ(port
) + MXS_SET
;
215 ct
->regs
.disable
= PINCTRL_PIN2IRQ(port
) + MXS_CLR
;
217 ct
= &gc
->chip_types
[1];
218 ct
->type
= IRQ_TYPE_EDGE_RISING
| IRQ_TYPE_EDGE_FALLING
;
219 ct
->chip
.irq_ack
= irq_gc_ack_set_bit
;
220 ct
->chip
.irq_mask
= irq_gc_mask_disable_reg
;
221 ct
->chip
.irq_unmask
= irq_gc_unmask_enable_reg
;
222 ct
->chip
.irq_set_type
= mxs_gpio_set_irq_type
;
223 ct
->chip
.irq_set_wake
= mxs_gpio_set_wake_irq
;
224 ct
->chip
.flags
= IRQCHIP_SET_TYPE_MASKED
;
225 ct
->regs
.ack
= PINCTRL_IRQSTAT(port
) + MXS_CLR
;
226 ct
->regs
.enable
= PINCTRL_IRQEN(port
) + MXS_SET
;
227 ct
->regs
.disable
= PINCTRL_IRQEN(port
) + MXS_CLR
;
228 ct
->handler
= handle_level_irq
;
230 rv
= devm_irq_setup_generic_chip(port
->dev
, gc
, IRQ_MSK(32),
231 IRQ_GC_INIT_NESTED_LOCK
,
237 static int mxs_gpio_to_irq(struct gpio_chip
*gc
, unsigned offset
)
239 struct mxs_gpio_port
*port
= gpiochip_get_data(gc
);
241 return irq_find_mapping(port
->domain
, offset
);
244 static int mxs_gpio_get_direction(struct gpio_chip
*gc
, unsigned offset
)
246 struct mxs_gpio_port
*port
= gpiochip_get_data(gc
);
247 u32 mask
= 1 << offset
;
250 dir
= readl(port
->base
+ PINCTRL_DOE(port
));
252 return GPIO_LINE_DIRECTION_OUT
;
254 return GPIO_LINE_DIRECTION_IN
;
257 static const struct platform_device_id mxs_gpio_ids
[] = {
259 .name
= "imx23-gpio",
260 .driver_data
= IMX23_GPIO
,
262 .name
= "imx28-gpio",
263 .driver_data
= IMX28_GPIO
,
268 MODULE_DEVICE_TABLE(platform
, mxs_gpio_ids
);
270 static const struct of_device_id mxs_gpio_dt_ids
[] = {
271 { .compatible
= "fsl,imx23-gpio", .data
= (void *) IMX23_GPIO
, },
272 { .compatible
= "fsl,imx28-gpio", .data
= (void *) IMX28_GPIO
, },
275 MODULE_DEVICE_TABLE(of
, mxs_gpio_dt_ids
);
277 static int mxs_gpio_probe(struct platform_device
*pdev
)
279 struct device_node
*np
= pdev
->dev
.of_node
;
280 struct device_node
*parent
;
281 static void __iomem
*base
;
282 struct mxs_gpio_port
*port
;
286 port
= devm_kzalloc(&pdev
->dev
, sizeof(*port
), GFP_KERNEL
);
290 port
->id
= of_alias_get_id(np
, "gpio");
293 port
->devid
= (enum mxs_gpio_id
)of_device_get_match_data(&pdev
->dev
);
294 port
->dev
= &pdev
->dev
;
295 port
->irq
= platform_get_irq(pdev
, 0);
300 * map memory region only once, as all the gpio ports
304 parent
= of_get_parent(np
);
305 base
= of_iomap(parent
, 0);
308 return -EADDRNOTAVAIL
;
312 /* initially disable the interrupts */
313 writel(0, port
->base
+ PINCTRL_PIN2IRQ(port
));
314 writel(0, port
->base
+ PINCTRL_IRQEN(port
));
316 /* clear address has to be used to clear IRQSTAT bits */
317 writel(~0U, port
->base
+ PINCTRL_IRQSTAT(port
) + MXS_CLR
);
319 irq_base
= devm_irq_alloc_descs(&pdev
->dev
, -1, 0, 32, numa_node_id());
325 port
->domain
= irq_domain_add_legacy(np
, 32, irq_base
, 0,
326 &irq_domain_simple_ops
, NULL
);
332 /* gpio-mxs can be a generic irq chip */
333 err
= mxs_gpio_init_gc(port
, irq_base
);
335 goto out_irqdomain_remove
;
337 /* setup one handler for each entry */
338 irq_set_chained_handler_and_data(port
->irq
, mxs_gpio_irq_handler
,
341 err
= bgpio_init(&port
->gc
, &pdev
->dev
, 4,
342 port
->base
+ PINCTRL_DIN(port
),
343 port
->base
+ PINCTRL_DOUT(port
) + MXS_SET
,
344 port
->base
+ PINCTRL_DOUT(port
) + MXS_CLR
,
345 port
->base
+ PINCTRL_DOE(port
), NULL
, 0);
347 goto out_irqdomain_remove
;
349 port
->gc
.to_irq
= mxs_gpio_to_irq
;
350 port
->gc
.get_direction
= mxs_gpio_get_direction
;
351 port
->gc
.base
= port
->id
* 32;
353 err
= gpiochip_add_data(&port
->gc
, port
);
355 goto out_irqdomain_remove
;
359 out_irqdomain_remove
:
360 irq_domain_remove(port
->domain
);
366 static struct platform_driver mxs_gpio_driver
= {
369 .of_match_table
= mxs_gpio_dt_ids
,
370 .suppress_bind_attrs
= true,
372 .probe
= mxs_gpio_probe
,
373 .id_table
= mxs_gpio_ids
,
376 static int __init
mxs_gpio_init(void)
378 return platform_driver_register(&mxs_gpio_driver
);
380 postcore_initcall(mxs_gpio_init
);
382 MODULE_AUTHOR("Freescale Semiconductor, "
383 "Daniel Mack <danielncaiaq.de>, "
384 "Juergen Beisert <kernel@pengutronix.de>");
385 MODULE_DESCRIPTION("Freescale MXS GPIO");
386 MODULE_LICENSE("GPL");