1 // SPDX-License-Identifier: GPL-2.0+
3 * Freescale vf610 GPIO support through PORT and GPIO
5 * Copyright (c) 2014 Toradex AG.
7 * Author: Stefan Agner <stefan@agner.ch>.
9 #include <linux/bitops.h>
10 #include <linux/clk.h>
11 #include <linux/err.h>
12 #include <linux/gpio/driver.h>
13 #include <linux/init.h>
14 #include <linux/interrupt.h>
16 #include <linux/ioport.h>
17 #include <linux/irq.h>
18 #include <linux/platform_device.h>
20 #include <linux/of_irq.h>
21 #include <linux/pinctrl/consumer.h>
23 #define VF610_GPIO_PER_PORT 32
25 struct fsl_gpio_soc_data {
26 /* SoCs has a Port Data Direction Register (PDDR) */
30 struct vf610_gpio_port {
33 void __iomem *gpio_base;
34 const struct fsl_gpio_soc_data *sdata;
35 u8 irqc[VF610_GPIO_PER_PORT];
41 #define GPIO_PDOR 0x00
42 #define GPIO_PSOR 0x04
43 #define GPIO_PCOR 0x08
44 #define GPIO_PTOR 0x0c
45 #define GPIO_PDIR 0x10
46 #define GPIO_PDDR 0x14
48 #define PORT_PCR(n) ((n) * 0x4)
49 #define PORT_PCR_IRQC_OFFSET 16
51 #define PORT_ISFR 0xa0
52 #define PORT_DFER 0xc0
53 #define PORT_DFCR 0xc4
54 #define PORT_DFWR 0xc8
56 #define PORT_INT_OFF 0x0
57 #define PORT_INT_LOGIC_ZERO 0x8
58 #define PORT_INT_RISING_EDGE 0x9
59 #define PORT_INT_FALLING_EDGE 0xa
60 #define PORT_INT_EITHER_EDGE 0xb
61 #define PORT_INT_LOGIC_ONE 0xc
63 static const struct fsl_gpio_soc_data imx_data = {
67 static const struct of_device_id vf610_gpio_dt_ids[] = {
68 { .compatible = "fsl,vf610-gpio", .data = NULL, },
69 { .compatible = "fsl,imx7ulp-gpio", .data = &imx_data, },
73 static inline void vf610_gpio_writel(u32 val, void __iomem *reg)
75 writel_relaxed(val, reg);
78 static inline u32 vf610_gpio_readl(void __iomem *reg)
80 return readl_relaxed(reg);
83 static int vf610_gpio_get(struct gpio_chip *gc, unsigned int gpio)
85 struct vf610_gpio_port *port = gpiochip_get_data(gc);
86 unsigned long mask = BIT(gpio);
87 unsigned long offset = GPIO_PDIR;
89 if (port->sdata && port->sdata->have_paddr) {
90 mask &= vf610_gpio_readl(port->gpio_base + GPIO_PDDR);
95 return !!(vf610_gpio_readl(port->gpio_base + offset) & BIT(gpio));
98 static void vf610_gpio_set(struct gpio_chip *gc, unsigned int gpio, int val)
100 struct vf610_gpio_port *port = gpiochip_get_data(gc);
101 unsigned long mask = BIT(gpio);
102 unsigned long offset = val ? GPIO_PSOR : GPIO_PCOR;
104 vf610_gpio_writel(mask, port->gpio_base + offset);
107 static int vf610_gpio_direction_input(struct gpio_chip *chip, unsigned gpio)
109 struct vf610_gpio_port *port = gpiochip_get_data(chip);
110 unsigned long mask = BIT(gpio);
113 if (port->sdata && port->sdata->have_paddr) {
114 val = vf610_gpio_readl(port->gpio_base + GPIO_PDDR);
116 vf610_gpio_writel(val, port->gpio_base + GPIO_PDDR);
119 return pinctrl_gpio_direction_input(chip->base + gpio);
122 static int vf610_gpio_direction_output(struct gpio_chip *chip, unsigned gpio,
125 struct vf610_gpio_port *port = gpiochip_get_data(chip);
126 unsigned long mask = BIT(gpio);
129 vf610_gpio_set(chip, gpio, value);
131 if (port->sdata && port->sdata->have_paddr) {
132 val = vf610_gpio_readl(port->gpio_base + GPIO_PDDR);
134 vf610_gpio_writel(val, port->gpio_base + GPIO_PDDR);
137 return pinctrl_gpio_direction_output(chip->base + gpio);
140 static void vf610_gpio_irq_handler(struct irq_desc *desc)
142 struct vf610_gpio_port *port =
143 gpiochip_get_data(irq_desc_get_handler_data(desc));
144 struct irq_chip *chip = irq_desc_get_chip(desc);
146 unsigned long irq_isfr;
148 chained_irq_enter(chip, desc);
150 irq_isfr = vf610_gpio_readl(port->base + PORT_ISFR);
152 for_each_set_bit(pin, &irq_isfr, VF610_GPIO_PER_PORT) {
153 vf610_gpio_writel(BIT(pin), port->base + PORT_ISFR);
155 generic_handle_domain_irq(port->gc.irq.domain, pin);
158 chained_irq_exit(chip, desc);
161 static void vf610_gpio_irq_ack(struct irq_data *d)
163 struct vf610_gpio_port *port =
164 gpiochip_get_data(irq_data_get_irq_chip_data(d));
167 vf610_gpio_writel(BIT(gpio), port->base + PORT_ISFR);
170 static int vf610_gpio_irq_set_type(struct irq_data *d, u32 type)
172 struct vf610_gpio_port *port =
173 gpiochip_get_data(irq_data_get_irq_chip_data(d));
177 case IRQ_TYPE_EDGE_RISING:
178 irqc = PORT_INT_RISING_EDGE;
180 case IRQ_TYPE_EDGE_FALLING:
181 irqc = PORT_INT_FALLING_EDGE;
183 case IRQ_TYPE_EDGE_BOTH:
184 irqc = PORT_INT_EITHER_EDGE;
186 case IRQ_TYPE_LEVEL_LOW:
187 irqc = PORT_INT_LOGIC_ZERO;
189 case IRQ_TYPE_LEVEL_HIGH:
190 irqc = PORT_INT_LOGIC_ONE;
196 port->irqc[d->hwirq] = irqc;
198 if (type & IRQ_TYPE_LEVEL_MASK)
199 irq_set_handler_locked(d, handle_level_irq);
201 irq_set_handler_locked(d, handle_edge_irq);
206 static void vf610_gpio_irq_mask(struct irq_data *d)
208 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
209 struct vf610_gpio_port *port = gpiochip_get_data(gc);
210 irq_hw_number_t gpio_num = irqd_to_hwirq(d);
211 void __iomem *pcr_base = port->base + PORT_PCR(gpio_num);
213 vf610_gpio_writel(0, pcr_base);
214 gpiochip_disable_irq(gc, gpio_num);
217 static void vf610_gpio_irq_unmask(struct irq_data *d)
219 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
220 struct vf610_gpio_port *port = gpiochip_get_data(gc);
221 irq_hw_number_t gpio_num = irqd_to_hwirq(d);
222 void __iomem *pcr_base = port->base + PORT_PCR(gpio_num);
224 gpiochip_enable_irq(gc, gpio_num);
225 vf610_gpio_writel(port->irqc[gpio_num] << PORT_PCR_IRQC_OFFSET,
229 static int vf610_gpio_irq_set_wake(struct irq_data *d, u32 enable)
231 struct vf610_gpio_port *port =
232 gpiochip_get_data(irq_data_get_irq_chip_data(d));
235 enable_irq_wake(port->irq);
237 disable_irq_wake(port->irq);
242 static const struct irq_chip vf610_irqchip = {
243 .name = "gpio-vf610",
244 .irq_ack = vf610_gpio_irq_ack,
245 .irq_mask = vf610_gpio_irq_mask,
246 .irq_unmask = vf610_gpio_irq_unmask,
247 .irq_set_type = vf610_gpio_irq_set_type,
248 .irq_set_wake = vf610_gpio_irq_set_wake,
249 .flags = IRQCHIP_IMMUTABLE | IRQCHIP_MASK_ON_SUSPEND
250 | IRQCHIP_ENABLE_WAKEUP_ON_SUSPEND,
251 GPIOCHIP_IRQ_RESOURCE_HELPERS,
254 static void vf610_gpio_disable_clk(void *data)
256 clk_disable_unprepare(data);
259 static int vf610_gpio_probe(struct platform_device *pdev)
261 struct device *dev = &pdev->dev;
262 struct vf610_gpio_port *port;
263 struct gpio_chip *gc;
264 struct gpio_irq_chip *girq;
268 port = devm_kzalloc(dev, sizeof(*port), GFP_KERNEL);
272 port->sdata = of_device_get_match_data(dev);
273 port->base = devm_platform_ioremap_resource(pdev, 0);
274 if (IS_ERR(port->base))
275 return PTR_ERR(port->base);
277 port->gpio_base = devm_platform_ioremap_resource(pdev, 1);
278 if (IS_ERR(port->gpio_base))
279 return PTR_ERR(port->gpio_base);
281 port->irq = platform_get_irq(pdev, 0);
285 port->clk_port = devm_clk_get(dev, "port");
286 ret = PTR_ERR_OR_ZERO(port->clk_port);
288 ret = clk_prepare_enable(port->clk_port);
291 ret = devm_add_action_or_reset(dev, vf610_gpio_disable_clk,
295 } else if (ret == -EPROBE_DEFER) {
297 * Percolate deferrals, for anything else,
298 * just live without the clocking.
303 port->clk_gpio = devm_clk_get(dev, "gpio");
304 ret = PTR_ERR_OR_ZERO(port->clk_gpio);
306 ret = clk_prepare_enable(port->clk_gpio);
309 ret = devm_add_action_or_reset(dev, vf610_gpio_disable_clk,
313 } else if (ret == -EPROBE_DEFER) {
319 gc->label = dev_name(dev);
320 gc->ngpio = VF610_GPIO_PER_PORT;
323 gc->request = gpiochip_generic_request;
324 gc->free = gpiochip_generic_free;
325 gc->direction_input = vf610_gpio_direction_input;
326 gc->get = vf610_gpio_get;
327 gc->direction_output = vf610_gpio_direction_output;
328 gc->set = vf610_gpio_set;
330 /* Mask all GPIO interrupts */
331 for (i = 0; i < gc->ngpio; i++)
332 vf610_gpio_writel(0, port->base + PORT_PCR(i));
334 /* Clear the interrupt status register for all GPIO's */
335 vf610_gpio_writel(~0, port->base + PORT_ISFR);
338 gpio_irq_chip_set_chip(girq, &vf610_irqchip);
339 girq->parent_handler = vf610_gpio_irq_handler;
340 girq->num_parents = 1;
341 girq->parents = devm_kcalloc(&pdev->dev, 1,
342 sizeof(*girq->parents),
346 girq->parents[0] = port->irq;
347 girq->default_type = IRQ_TYPE_NONE;
348 girq->handler = handle_edge_irq;
350 return devm_gpiochip_add_data(dev, gc, port);
353 static struct platform_driver vf610_gpio_driver = {
355 .name = "gpio-vf610",
356 .of_match_table = vf610_gpio_dt_ids,
358 .probe = vf610_gpio_probe,
361 builtin_platform_driver(vf610_gpio_driver);