1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Freescale vf610 GPIO support through PORT and GPIO
4 *
5 * Copyright (c) 2014 Toradex AG.
6 *
7 * Author: Stefan Agner <stefan@agner.ch>.
8 */
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>
15 #include <linux/io.h>
16 #include <linux/ioport.h>
17 #include <linux/irq.h>
18 #include <linux/platform_device.h>
19 #include <linux/of.h>
20 #include <linux/of_device.h>
21 #include <linux/of_irq.h>
22 #include <linux/pinctrl/consumer.h>
23
24 #define VF610_GPIO_PER_PORT 32
25
26 struct fsl_gpio_soc_data {
27 /* SoCs has a Port Data Direction Register (PDDR) */
28 bool have_paddr;
29 };
30
31 struct vf610_gpio_port {
32 struct gpio_chip gc;
33 void __iomem *base;
34 void __iomem *gpio_base;
35 const struct fsl_gpio_soc_data *sdata;
36 u8 irqc[VF610_GPIO_PER_PORT];
37 struct clk *clk_port;
38 struct clk *clk_gpio;
39 int irq;
40 };
41
42 #define GPIO_PDOR 0x00
43 #define GPIO_PSOR 0x04
44 #define GPIO_PCOR 0x08
45 #define GPIO_PTOR 0x0c
46 #define GPIO_PDIR 0x10
47 #define GPIO_PDDR 0x14
48
49 #define PORT_PCR(n) ((n) * 0x4)
50 #define PORT_PCR_IRQC_OFFSET 16
51
52 #define PORT_ISFR 0xa0
53 #define PORT_DFER 0xc0
54 #define PORT_DFCR 0xc4
55 #define PORT_DFWR 0xc8
56
57 #define PORT_INT_OFF 0x0
58 #define PORT_INT_LOGIC_ZERO 0x8
59 #define PORT_INT_RISING_EDGE 0x9
60 #define PORT_INT_FALLING_EDGE 0xa
61 #define PORT_INT_EITHER_EDGE 0xb
62 #define PORT_INT_LOGIC_ONE 0xc
63
64 static const struct fsl_gpio_soc_data imx_data = {
65 .have_paddr = true,
66 };
67
68 static const struct of_device_id vf610_gpio_dt_ids[] = {
69 { .compatible = "fsl,vf610-gpio", .data = NULL, },
70 { .compatible = "fsl,imx7ulp-gpio", .data = &imx_data, },
71 { /* sentinel */ }
72 };
73
vf610_gpio_writel(u32 val,void __iomem * reg)74 static inline void vf610_gpio_writel(u32 val, void __iomem *reg)
75 {
76 writel_relaxed(val, reg);
77 }
78
vf610_gpio_readl(void __iomem * reg)79 static inline u32 vf610_gpio_readl(void __iomem *reg)
80 {
81 return readl_relaxed(reg);
82 }
83
vf610_gpio_get(struct gpio_chip * gc,unsigned int gpio)84 static int vf610_gpio_get(struct gpio_chip *gc, unsigned int gpio)
85 {
86 struct vf610_gpio_port *port = gpiochip_get_data(gc);
87 unsigned long mask = BIT(gpio);
88 unsigned long offset = GPIO_PDIR;
89
90 if (port->sdata && port->sdata->have_paddr) {
91 mask &= vf610_gpio_readl(port->gpio_base + GPIO_PDDR);
92 if (mask)
93 offset = GPIO_PDOR;
94 }
95
96 return !!(vf610_gpio_readl(port->gpio_base + offset) & BIT(gpio));
97 }
98
vf610_gpio_set(struct gpio_chip * gc,unsigned int gpio,int val)99 static void vf610_gpio_set(struct gpio_chip *gc, unsigned int gpio, int val)
100 {
101 struct vf610_gpio_port *port = gpiochip_get_data(gc);
102 unsigned long mask = BIT(gpio);
103 unsigned long offset = val ? GPIO_PSOR : GPIO_PCOR;
104
105 vf610_gpio_writel(mask, port->gpio_base + offset);
106 }
107
vf610_gpio_direction_input(struct gpio_chip * chip,unsigned gpio)108 static int vf610_gpio_direction_input(struct gpio_chip *chip, unsigned gpio)
109 {
110 struct vf610_gpio_port *port = gpiochip_get_data(chip);
111 unsigned long mask = BIT(gpio);
112 u32 val;
113
114 if (port->sdata && port->sdata->have_paddr) {
115 val = vf610_gpio_readl(port->gpio_base + GPIO_PDDR);
116 val &= ~mask;
117 vf610_gpio_writel(val, port->gpio_base + GPIO_PDDR);
118 }
119
120 return pinctrl_gpio_direction_input(chip->base + gpio);
121 }
122
vf610_gpio_direction_output(struct gpio_chip * chip,unsigned gpio,int value)123 static int vf610_gpio_direction_output(struct gpio_chip *chip, unsigned gpio,
124 int value)
125 {
126 struct vf610_gpio_port *port = gpiochip_get_data(chip);
127 unsigned long mask = BIT(gpio);
128 u32 val;
129
130 vf610_gpio_set(chip, gpio, value);
131
132 if (port->sdata && port->sdata->have_paddr) {
133 val = vf610_gpio_readl(port->gpio_base + GPIO_PDDR);
134 val |= mask;
135 vf610_gpio_writel(val, port->gpio_base + GPIO_PDDR);
136 }
137
138 return pinctrl_gpio_direction_output(chip->base + gpio);
139 }
140
vf610_gpio_irq_handler(struct irq_desc * desc)141 static void vf610_gpio_irq_handler(struct irq_desc *desc)
142 {
143 struct vf610_gpio_port *port =
144 gpiochip_get_data(irq_desc_get_handler_data(desc));
145 struct irq_chip *chip = irq_desc_get_chip(desc);
146 int pin;
147 unsigned long irq_isfr;
148
149 chained_irq_enter(chip, desc);
150
151 irq_isfr = vf610_gpio_readl(port->base + PORT_ISFR);
152
153 for_each_set_bit(pin, &irq_isfr, VF610_GPIO_PER_PORT) {
154 vf610_gpio_writel(BIT(pin), port->base + PORT_ISFR);
155
156 generic_handle_domain_irq(port->gc.irq.domain, pin);
157 }
158
159 chained_irq_exit(chip, desc);
160 }
161
vf610_gpio_irq_ack(struct irq_data * d)162 static void vf610_gpio_irq_ack(struct irq_data *d)
163 {
164 struct vf610_gpio_port *port =
165 gpiochip_get_data(irq_data_get_irq_chip_data(d));
166 int gpio = d->hwirq;
167
168 vf610_gpio_writel(BIT(gpio), port->base + PORT_ISFR);
169 }
170
vf610_gpio_irq_set_type(struct irq_data * d,u32 type)171 static int vf610_gpio_irq_set_type(struct irq_data *d, u32 type)
172 {
173 struct vf610_gpio_port *port =
174 gpiochip_get_data(irq_data_get_irq_chip_data(d));
175 u8 irqc;
176
177 switch (type) {
178 case IRQ_TYPE_EDGE_RISING:
179 irqc = PORT_INT_RISING_EDGE;
180 break;
181 case IRQ_TYPE_EDGE_FALLING:
182 irqc = PORT_INT_FALLING_EDGE;
183 break;
184 case IRQ_TYPE_EDGE_BOTH:
185 irqc = PORT_INT_EITHER_EDGE;
186 break;
187 case IRQ_TYPE_LEVEL_LOW:
188 irqc = PORT_INT_LOGIC_ZERO;
189 break;
190 case IRQ_TYPE_LEVEL_HIGH:
191 irqc = PORT_INT_LOGIC_ONE;
192 break;
193 default:
194 return -EINVAL;
195 }
196
197 port->irqc[d->hwirq] = irqc;
198
199 if (type & IRQ_TYPE_LEVEL_MASK)
200 irq_set_handler_locked(d, handle_level_irq);
201 else
202 irq_set_handler_locked(d, handle_edge_irq);
203
204 return 0;
205 }
206
vf610_gpio_irq_mask(struct irq_data * d)207 static void vf610_gpio_irq_mask(struct irq_data *d)
208 {
209 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
210 struct vf610_gpio_port *port = gpiochip_get_data(gc);
211 irq_hw_number_t gpio_num = irqd_to_hwirq(d);
212 void __iomem *pcr_base = port->base + PORT_PCR(gpio_num);
213
214 vf610_gpio_writel(0, pcr_base);
215 gpiochip_disable_irq(gc, gpio_num);
216 }
217
vf610_gpio_irq_unmask(struct irq_data * d)218 static void vf610_gpio_irq_unmask(struct irq_data *d)
219 {
220 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
221 struct vf610_gpio_port *port = gpiochip_get_data(gc);
222 irq_hw_number_t gpio_num = irqd_to_hwirq(d);
223 void __iomem *pcr_base = port->base + PORT_PCR(gpio_num);
224
225 gpiochip_enable_irq(gc, gpio_num);
226 vf610_gpio_writel(port->irqc[gpio_num] << PORT_PCR_IRQC_OFFSET,
227 pcr_base);
228 }
229
vf610_gpio_irq_set_wake(struct irq_data * d,u32 enable)230 static int vf610_gpio_irq_set_wake(struct irq_data *d, u32 enable)
231 {
232 struct vf610_gpio_port *port =
233 gpiochip_get_data(irq_data_get_irq_chip_data(d));
234
235 if (enable)
236 enable_irq_wake(port->irq);
237 else
238 disable_irq_wake(port->irq);
239
240 return 0;
241 }
242
243 static const struct irq_chip vf610_irqchip = {
244 .name = "gpio-vf610",
245 .irq_ack = vf610_gpio_irq_ack,
246 .irq_mask = vf610_gpio_irq_mask,
247 .irq_unmask = vf610_gpio_irq_unmask,
248 .irq_set_type = vf610_gpio_irq_set_type,
249 .irq_set_wake = vf610_gpio_irq_set_wake,
250 .flags = IRQCHIP_IMMUTABLE | IRQCHIP_MASK_ON_SUSPEND
251 | IRQCHIP_ENABLE_WAKEUP_ON_SUSPEND,
252 GPIOCHIP_IRQ_RESOURCE_HELPERS,
253 };
254
vf610_gpio_disable_clk(void * data)255 static void vf610_gpio_disable_clk(void *data)
256 {
257 clk_disable_unprepare(data);
258 }
259
vf610_gpio_probe(struct platform_device * pdev)260 static int vf610_gpio_probe(struct platform_device *pdev)
261 {
262 struct device *dev = &pdev->dev;
263 struct device_node *np = dev->of_node;
264 struct vf610_gpio_port *port;
265 struct gpio_chip *gc;
266 struct gpio_irq_chip *girq;
267 int i;
268 int ret;
269
270 port = devm_kzalloc(dev, sizeof(*port), GFP_KERNEL);
271 if (!port)
272 return -ENOMEM;
273
274 port->sdata = of_device_get_match_data(dev);
275 port->base = devm_platform_ioremap_resource(pdev, 0);
276 if (IS_ERR(port->base))
277 return PTR_ERR(port->base);
278
279 port->gpio_base = devm_platform_ioremap_resource(pdev, 1);
280 if (IS_ERR(port->gpio_base))
281 return PTR_ERR(port->gpio_base);
282
283 port->irq = platform_get_irq(pdev, 0);
284 if (port->irq < 0)
285 return port->irq;
286
287 port->clk_port = devm_clk_get(dev, "port");
288 ret = PTR_ERR_OR_ZERO(port->clk_port);
289 if (!ret) {
290 ret = clk_prepare_enable(port->clk_port);
291 if (ret)
292 return ret;
293 ret = devm_add_action_or_reset(dev, vf610_gpio_disable_clk,
294 port->clk_port);
295 if (ret)
296 return ret;
297 } else if (ret == -EPROBE_DEFER) {
298 /*
299 * Percolate deferrals, for anything else,
300 * just live without the clocking.
301 */
302 return ret;
303 }
304
305 port->clk_gpio = devm_clk_get(dev, "gpio");
306 ret = PTR_ERR_OR_ZERO(port->clk_gpio);
307 if (!ret) {
308 ret = clk_prepare_enable(port->clk_gpio);
309 if (ret)
310 return ret;
311 ret = devm_add_action_or_reset(dev, vf610_gpio_disable_clk,
312 port->clk_gpio);
313 if (ret)
314 return ret;
315 } else if (ret == -EPROBE_DEFER) {
316 return ret;
317 }
318
319 gc = &port->gc;
320 gc->parent = dev;
321 gc->label = dev_name(dev);
322 gc->ngpio = VF610_GPIO_PER_PORT;
323 gc->base = of_alias_get_id(np, "gpio") * VF610_GPIO_PER_PORT;
324
325 gc->request = gpiochip_generic_request;
326 gc->free = gpiochip_generic_free;
327 gc->direction_input = vf610_gpio_direction_input;
328 gc->get = vf610_gpio_get;
329 gc->direction_output = vf610_gpio_direction_output;
330 gc->set = vf610_gpio_set;
331
332 /* Mask all GPIO interrupts */
333 for (i = 0; i < gc->ngpio; i++)
334 vf610_gpio_writel(0, port->base + PORT_PCR(i));
335
336 /* Clear the interrupt status register for all GPIO's */
337 vf610_gpio_writel(~0, port->base + PORT_ISFR);
338
339 girq = &gc->irq;
340 gpio_irq_chip_set_chip(girq, &vf610_irqchip);
341 girq->parent_handler = vf610_gpio_irq_handler;
342 girq->num_parents = 1;
343 girq->parents = devm_kcalloc(&pdev->dev, 1,
344 sizeof(*girq->parents),
345 GFP_KERNEL);
346 if (!girq->parents)
347 return -ENOMEM;
348 girq->parents[0] = port->irq;
349 girq->default_type = IRQ_TYPE_NONE;
350 girq->handler = handle_edge_irq;
351
352 return devm_gpiochip_add_data(dev, gc, port);
353 }
354
355 static struct platform_driver vf610_gpio_driver = {
356 .driver = {
357 .name = "gpio-vf610",
358 .of_match_table = vf610_gpio_dt_ids,
359 },
360 .probe = vf610_gpio_probe,
361 };
362
363 builtin_platform_driver(vf610_gpio_driver);
364