Loading...
1// SPDX-License-Identifier: GPL-2.0+
2//
3// MXC GPIO support. (c) 2008 Daniel Mack <daniel@caiaq.de>
4// Copyright 2008 Juergen Beisert, kernel@pengutronix.de
5//
6// Based on code from Freescale Semiconductor,
7// Authors: Daniel Mack, Juergen Beisert.
8// Copyright (C) 2004-2010 Freescale Semiconductor, Inc. All Rights Reserved.
9
10#include <linux/clk.h>
11#include <linux/err.h>
12#include <linux/init.h>
13#include <linux/interrupt.h>
14#include <linux/io.h>
15#include <linux/irq.h>
16#include <linux/irqdomain.h>
17#include <linux/irqchip/chained_irq.h>
18#include <linux/platform_device.h>
19#include <linux/slab.h>
20#include <linux/syscore_ops.h>
21#include <linux/gpio/driver.h>
22#include <linux/of.h>
23#include <linux/of_device.h>
24#include <linux/bug.h>
25
26enum mxc_gpio_hwtype {
27 IMX1_GPIO, /* runs on i.mx1 */
28 IMX21_GPIO, /* runs on i.mx21 and i.mx27 */
29 IMX31_GPIO, /* runs on i.mx31 */
30 IMX35_GPIO, /* runs on all other i.mx */
31};
32
33/* device type dependent stuff */
34struct mxc_gpio_hwdata {
35 unsigned dr_reg;
36 unsigned gdir_reg;
37 unsigned psr_reg;
38 unsigned icr1_reg;
39 unsigned icr2_reg;
40 unsigned imr_reg;
41 unsigned isr_reg;
42 int edge_sel_reg;
43 unsigned low_level;
44 unsigned high_level;
45 unsigned rise_edge;
46 unsigned fall_edge;
47};
48
49struct mxc_gpio_reg_saved {
50 u32 icr1;
51 u32 icr2;
52 u32 imr;
53 u32 gdir;
54 u32 edge_sel;
55 u32 dr;
56};
57
58struct mxc_gpio_port {
59 struct list_head node;
60 void __iomem *base;
61 struct clk *clk;
62 int irq;
63 int irq_high;
64 struct irq_domain *domain;
65 struct gpio_chip gc;
66 struct device *dev;
67 u32 both_edges;
68 struct mxc_gpio_reg_saved gpio_saved_reg;
69 bool power_off;
70};
71
72static struct mxc_gpio_hwdata imx1_imx21_gpio_hwdata = {
73 .dr_reg = 0x1c,
74 .gdir_reg = 0x00,
75 .psr_reg = 0x24,
76 .icr1_reg = 0x28,
77 .icr2_reg = 0x2c,
78 .imr_reg = 0x30,
79 .isr_reg = 0x34,
80 .edge_sel_reg = -EINVAL,
81 .low_level = 0x03,
82 .high_level = 0x02,
83 .rise_edge = 0x00,
84 .fall_edge = 0x01,
85};
86
87static struct mxc_gpio_hwdata imx31_gpio_hwdata = {
88 .dr_reg = 0x00,
89 .gdir_reg = 0x04,
90 .psr_reg = 0x08,
91 .icr1_reg = 0x0c,
92 .icr2_reg = 0x10,
93 .imr_reg = 0x14,
94 .isr_reg = 0x18,
95 .edge_sel_reg = -EINVAL,
96 .low_level = 0x00,
97 .high_level = 0x01,
98 .rise_edge = 0x02,
99 .fall_edge = 0x03,
100};
101
102static struct mxc_gpio_hwdata imx35_gpio_hwdata = {
103 .dr_reg = 0x00,
104 .gdir_reg = 0x04,
105 .psr_reg = 0x08,
106 .icr1_reg = 0x0c,
107 .icr2_reg = 0x10,
108 .imr_reg = 0x14,
109 .isr_reg = 0x18,
110 .edge_sel_reg = 0x1c,
111 .low_level = 0x00,
112 .high_level = 0x01,
113 .rise_edge = 0x02,
114 .fall_edge = 0x03,
115};
116
117static enum mxc_gpio_hwtype mxc_gpio_hwtype;
118static struct mxc_gpio_hwdata *mxc_gpio_hwdata;
119
120#define GPIO_DR (mxc_gpio_hwdata->dr_reg)
121#define GPIO_GDIR (mxc_gpio_hwdata->gdir_reg)
122#define GPIO_PSR (mxc_gpio_hwdata->psr_reg)
123#define GPIO_ICR1 (mxc_gpio_hwdata->icr1_reg)
124#define GPIO_ICR2 (mxc_gpio_hwdata->icr2_reg)
125#define GPIO_IMR (mxc_gpio_hwdata->imr_reg)
126#define GPIO_ISR (mxc_gpio_hwdata->isr_reg)
127#define GPIO_EDGE_SEL (mxc_gpio_hwdata->edge_sel_reg)
128
129#define GPIO_INT_LOW_LEV (mxc_gpio_hwdata->low_level)
130#define GPIO_INT_HIGH_LEV (mxc_gpio_hwdata->high_level)
131#define GPIO_INT_RISE_EDGE (mxc_gpio_hwdata->rise_edge)
132#define GPIO_INT_FALL_EDGE (mxc_gpio_hwdata->fall_edge)
133#define GPIO_INT_BOTH_EDGES 0x4
134
135static const struct platform_device_id mxc_gpio_devtype[] = {
136 {
137 .name = "imx1-gpio",
138 .driver_data = IMX1_GPIO,
139 }, {
140 .name = "imx21-gpio",
141 .driver_data = IMX21_GPIO,
142 }, {
143 .name = "imx31-gpio",
144 .driver_data = IMX31_GPIO,
145 }, {
146 .name = "imx35-gpio",
147 .driver_data = IMX35_GPIO,
148 }, {
149 /* sentinel */
150 }
151};
152
153static const struct of_device_id mxc_gpio_dt_ids[] = {
154 { .compatible = "fsl,imx1-gpio", .data = &mxc_gpio_devtype[IMX1_GPIO], },
155 { .compatible = "fsl,imx21-gpio", .data = &mxc_gpio_devtype[IMX21_GPIO], },
156 { .compatible = "fsl,imx31-gpio", .data = &mxc_gpio_devtype[IMX31_GPIO], },
157 { .compatible = "fsl,imx35-gpio", .data = &mxc_gpio_devtype[IMX35_GPIO], },
158 { .compatible = "fsl,imx7d-gpio", .data = &mxc_gpio_devtype[IMX35_GPIO], },
159 { /* sentinel */ }
160};
161
162/*
163 * MX2 has one interrupt *for all* gpio ports. The list is used
164 * to save the references to all ports, so that mx2_gpio_irq_handler
165 * can walk through all interrupt status registers.
166 */
167static LIST_HEAD(mxc_gpio_ports);
168
169/* Note: This driver assumes 32 GPIOs are handled in one register */
170
171static int gpio_set_irq_type(struct irq_data *d, u32 type)
172{
173 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
174 struct mxc_gpio_port *port = gc->private;
175 u32 bit, val;
176 u32 gpio_idx = d->hwirq;
177 int edge;
178 void __iomem *reg = port->base;
179
180 port->both_edges &= ~(1 << gpio_idx);
181 switch (type) {
182 case IRQ_TYPE_EDGE_RISING:
183 edge = GPIO_INT_RISE_EDGE;
184 break;
185 case IRQ_TYPE_EDGE_FALLING:
186 edge = GPIO_INT_FALL_EDGE;
187 break;
188 case IRQ_TYPE_EDGE_BOTH:
189 if (GPIO_EDGE_SEL >= 0) {
190 edge = GPIO_INT_BOTH_EDGES;
191 } else {
192 val = port->gc.get(&port->gc, gpio_idx);
193 if (val) {
194 edge = GPIO_INT_LOW_LEV;
195 pr_debug("mxc: set GPIO %d to low trigger\n", gpio_idx);
196 } else {
197 edge = GPIO_INT_HIGH_LEV;
198 pr_debug("mxc: set GPIO %d to high trigger\n", gpio_idx);
199 }
200 port->both_edges |= 1 << gpio_idx;
201 }
202 break;
203 case IRQ_TYPE_LEVEL_LOW:
204 edge = GPIO_INT_LOW_LEV;
205 break;
206 case IRQ_TYPE_LEVEL_HIGH:
207 edge = GPIO_INT_HIGH_LEV;
208 break;
209 default:
210 return -EINVAL;
211 }
212
213 if (GPIO_EDGE_SEL >= 0) {
214 val = readl(port->base + GPIO_EDGE_SEL);
215 if (edge == GPIO_INT_BOTH_EDGES)
216 writel(val | (1 << gpio_idx),
217 port->base + GPIO_EDGE_SEL);
218 else
219 writel(val & ~(1 << gpio_idx),
220 port->base + GPIO_EDGE_SEL);
221 }
222
223 if (edge != GPIO_INT_BOTH_EDGES) {
224 reg += GPIO_ICR1 + ((gpio_idx & 0x10) >> 2); /* lower or upper register */
225 bit = gpio_idx & 0xf;
226 val = readl(reg) & ~(0x3 << (bit << 1));
227 writel(val | (edge << (bit << 1)), reg);
228 }
229
230 writel(1 << gpio_idx, port->base + GPIO_ISR);
231
232 return 0;
233}
234
235static void mxc_flip_edge(struct mxc_gpio_port *port, u32 gpio)
236{
237 void __iomem *reg = port->base;
238 u32 bit, val;
239 int edge;
240
241 reg += GPIO_ICR1 + ((gpio & 0x10) >> 2); /* lower or upper register */
242 bit = gpio & 0xf;
243 val = readl(reg);
244 edge = (val >> (bit << 1)) & 3;
245 val &= ~(0x3 << (bit << 1));
246 if (edge == GPIO_INT_HIGH_LEV) {
247 edge = GPIO_INT_LOW_LEV;
248 pr_debug("mxc: switch GPIO %d to low trigger\n", gpio);
249 } else if (edge == GPIO_INT_LOW_LEV) {
250 edge = GPIO_INT_HIGH_LEV;
251 pr_debug("mxc: switch GPIO %d to high trigger\n", gpio);
252 } else {
253 pr_err("mxc: invalid configuration for GPIO %d: %x\n",
254 gpio, edge);
255 return;
256 }
257 writel(val | (edge << (bit << 1)), reg);
258}
259
260/* handle 32 interrupts in one status register */
261static void mxc_gpio_irq_handler(struct mxc_gpio_port *port, u32 irq_stat)
262{
263 while (irq_stat != 0) {
264 int irqoffset = fls(irq_stat) - 1;
265
266 if (port->both_edges & (1 << irqoffset))
267 mxc_flip_edge(port, irqoffset);
268
269 generic_handle_irq(irq_find_mapping(port->domain, irqoffset));
270
271 irq_stat &= ~(1 << irqoffset);
272 }
273}
274
275/* MX1 and MX3 has one interrupt *per* gpio port */
276static void mx3_gpio_irq_handler(struct irq_desc *desc)
277{
278 u32 irq_stat;
279 struct mxc_gpio_port *port = irq_desc_get_handler_data(desc);
280 struct irq_chip *chip = irq_desc_get_chip(desc);
281
282 chained_irq_enter(chip, desc);
283
284 irq_stat = readl(port->base + GPIO_ISR) & readl(port->base + GPIO_IMR);
285
286 mxc_gpio_irq_handler(port, irq_stat);
287
288 chained_irq_exit(chip, desc);
289}
290
291/* MX2 has one interrupt *for all* gpio ports */
292static void mx2_gpio_irq_handler(struct irq_desc *desc)
293{
294 u32 irq_msk, irq_stat;
295 struct mxc_gpio_port *port;
296 struct irq_chip *chip = irq_desc_get_chip(desc);
297
298 chained_irq_enter(chip, desc);
299
300 /* walk through all interrupt status registers */
301 list_for_each_entry(port, &mxc_gpio_ports, node) {
302 irq_msk = readl(port->base + GPIO_IMR);
303 if (!irq_msk)
304 continue;
305
306 irq_stat = readl(port->base + GPIO_ISR) & irq_msk;
307 if (irq_stat)
308 mxc_gpio_irq_handler(port, irq_stat);
309 }
310 chained_irq_exit(chip, desc);
311}
312
313/*
314 * Set interrupt number "irq" in the GPIO as a wake-up source.
315 * While system is running, all registered GPIO interrupts need to have
316 * wake-up enabled. When system is suspended, only selected GPIO interrupts
317 * need to have wake-up enabled.
318 * @param irq interrupt source number
319 * @param enable enable as wake-up if equal to non-zero
320 * @return This function returns 0 on success.
321 */
322static int gpio_set_wake_irq(struct irq_data *d, u32 enable)
323{
324 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
325 struct mxc_gpio_port *port = gc->private;
326 u32 gpio_idx = d->hwirq;
327 int ret;
328
329 if (enable) {
330 if (port->irq_high && (gpio_idx >= 16))
331 ret = enable_irq_wake(port->irq_high);
332 else
333 ret = enable_irq_wake(port->irq);
334 } else {
335 if (port->irq_high && (gpio_idx >= 16))
336 ret = disable_irq_wake(port->irq_high);
337 else
338 ret = disable_irq_wake(port->irq);
339 }
340
341 return ret;
342}
343
344static int mxc_gpio_init_gc(struct mxc_gpio_port *port, int irq_base)
345{
346 struct irq_chip_generic *gc;
347 struct irq_chip_type *ct;
348 int rv;
349
350 gc = devm_irq_alloc_generic_chip(port->dev, "gpio-mxc", 1, irq_base,
351 port->base, handle_level_irq);
352 if (!gc)
353 return -ENOMEM;
354 gc->private = port;
355
356 ct = gc->chip_types;
357 ct->chip.irq_ack = irq_gc_ack_set_bit;
358 ct->chip.irq_mask = irq_gc_mask_clr_bit;
359 ct->chip.irq_unmask = irq_gc_mask_set_bit;
360 ct->chip.irq_set_type = gpio_set_irq_type;
361 ct->chip.irq_set_wake = gpio_set_wake_irq;
362 ct->chip.flags = IRQCHIP_MASK_ON_SUSPEND;
363 ct->regs.ack = GPIO_ISR;
364 ct->regs.mask = GPIO_IMR;
365
366 rv = devm_irq_setup_generic_chip(port->dev, gc, IRQ_MSK(32),
367 IRQ_GC_INIT_NESTED_LOCK,
368 IRQ_NOREQUEST, 0);
369
370 return rv;
371}
372
373static void mxc_gpio_get_hw(struct platform_device *pdev)
374{
375 const struct of_device_id *of_id =
376 of_match_device(mxc_gpio_dt_ids, &pdev->dev);
377 enum mxc_gpio_hwtype hwtype;
378
379 if (of_id)
380 pdev->id_entry = of_id->data;
381 hwtype = pdev->id_entry->driver_data;
382
383 if (mxc_gpio_hwtype) {
384 /*
385 * The driver works with a reasonable presupposition,
386 * that is all gpio ports must be the same type when
387 * running on one soc.
388 */
389 BUG_ON(mxc_gpio_hwtype != hwtype);
390 return;
391 }
392
393 if (hwtype == IMX35_GPIO)
394 mxc_gpio_hwdata = &imx35_gpio_hwdata;
395 else if (hwtype == IMX31_GPIO)
396 mxc_gpio_hwdata = &imx31_gpio_hwdata;
397 else
398 mxc_gpio_hwdata = &imx1_imx21_gpio_hwdata;
399
400 mxc_gpio_hwtype = hwtype;
401}
402
403static int mxc_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
404{
405 struct mxc_gpio_port *port = gpiochip_get_data(gc);
406
407 return irq_find_mapping(port->domain, offset);
408}
409
410static int mxc_gpio_probe(struct platform_device *pdev)
411{
412 struct device_node *np = pdev->dev.of_node;
413 struct mxc_gpio_port *port;
414 int irq_count;
415 int irq_base;
416 int err;
417
418 mxc_gpio_get_hw(pdev);
419
420 port = devm_kzalloc(&pdev->dev, sizeof(*port), GFP_KERNEL);
421 if (!port)
422 return -ENOMEM;
423
424 port->dev = &pdev->dev;
425
426 port->base = devm_platform_ioremap_resource(pdev, 0);
427 if (IS_ERR(port->base))
428 return PTR_ERR(port->base);
429
430 irq_count = platform_irq_count(pdev);
431 if (irq_count < 0)
432 return irq_count;
433
434 if (irq_count > 1) {
435 port->irq_high = platform_get_irq(pdev, 1);
436 if (port->irq_high < 0)
437 port->irq_high = 0;
438 }
439
440 port->irq = platform_get_irq(pdev, 0);
441 if (port->irq < 0)
442 return port->irq;
443
444 /* the controller clock is optional */
445 port->clk = devm_clk_get_optional(&pdev->dev, NULL);
446 if (IS_ERR(port->clk))
447 return PTR_ERR(port->clk);
448
449 err = clk_prepare_enable(port->clk);
450 if (err) {
451 dev_err(&pdev->dev, "Unable to enable clock.\n");
452 return err;
453 }
454
455 if (of_device_is_compatible(np, "fsl,imx7d-gpio"))
456 port->power_off = true;
457
458 /* disable the interrupt and clear the status */
459 writel(0, port->base + GPIO_IMR);
460 writel(~0, port->base + GPIO_ISR);
461
462 if (mxc_gpio_hwtype == IMX21_GPIO) {
463 /*
464 * Setup one handler for all GPIO interrupts. Actually setting
465 * the handler is needed only once, but doing it for every port
466 * is more robust and easier.
467 */
468 irq_set_chained_handler(port->irq, mx2_gpio_irq_handler);
469 } else {
470 /* setup one handler for each entry */
471 irq_set_chained_handler_and_data(port->irq,
472 mx3_gpio_irq_handler, port);
473 if (port->irq_high > 0)
474 /* setup handler for GPIO 16 to 31 */
475 irq_set_chained_handler_and_data(port->irq_high,
476 mx3_gpio_irq_handler,
477 port);
478 }
479
480 err = bgpio_init(&port->gc, &pdev->dev, 4,
481 port->base + GPIO_PSR,
482 port->base + GPIO_DR, NULL,
483 port->base + GPIO_GDIR, NULL,
484 BGPIOF_READ_OUTPUT_REG_SET);
485 if (err)
486 goto out_bgio;
487
488 port->gc.request = gpiochip_generic_request;
489 port->gc.free = gpiochip_generic_free;
490 port->gc.to_irq = mxc_gpio_to_irq;
491 port->gc.base = (pdev->id < 0) ? of_alias_get_id(np, "gpio") * 32 :
492 pdev->id * 32;
493
494 err = devm_gpiochip_add_data(&pdev->dev, &port->gc, port);
495 if (err)
496 goto out_bgio;
497
498 irq_base = devm_irq_alloc_descs(&pdev->dev, -1, 0, 32, numa_node_id());
499 if (irq_base < 0) {
500 err = irq_base;
501 goto out_bgio;
502 }
503
504 port->domain = irq_domain_add_legacy(np, 32, irq_base, 0,
505 &irq_domain_simple_ops, NULL);
506 if (!port->domain) {
507 err = -ENODEV;
508 goto out_bgio;
509 }
510
511 /* gpio-mxc can be a generic irq chip */
512 err = mxc_gpio_init_gc(port, irq_base);
513 if (err < 0)
514 goto out_irqdomain_remove;
515
516 list_add_tail(&port->node, &mxc_gpio_ports);
517
518 platform_set_drvdata(pdev, port);
519
520 return 0;
521
522out_irqdomain_remove:
523 irq_domain_remove(port->domain);
524out_bgio:
525 clk_disable_unprepare(port->clk);
526 dev_info(&pdev->dev, "%s failed with errno %d\n", __func__, err);
527 return err;
528}
529
530static void mxc_gpio_save_regs(struct mxc_gpio_port *port)
531{
532 if (!port->power_off)
533 return;
534
535 port->gpio_saved_reg.icr1 = readl(port->base + GPIO_ICR1);
536 port->gpio_saved_reg.icr2 = readl(port->base + GPIO_ICR2);
537 port->gpio_saved_reg.imr = readl(port->base + GPIO_IMR);
538 port->gpio_saved_reg.gdir = readl(port->base + GPIO_GDIR);
539 port->gpio_saved_reg.edge_sel = readl(port->base + GPIO_EDGE_SEL);
540 port->gpio_saved_reg.dr = readl(port->base + GPIO_DR);
541}
542
543static void mxc_gpio_restore_regs(struct mxc_gpio_port *port)
544{
545 if (!port->power_off)
546 return;
547
548 writel(port->gpio_saved_reg.icr1, port->base + GPIO_ICR1);
549 writel(port->gpio_saved_reg.icr2, port->base + GPIO_ICR2);
550 writel(port->gpio_saved_reg.imr, port->base + GPIO_IMR);
551 writel(port->gpio_saved_reg.gdir, port->base + GPIO_GDIR);
552 writel(port->gpio_saved_reg.edge_sel, port->base + GPIO_EDGE_SEL);
553 writel(port->gpio_saved_reg.dr, port->base + GPIO_DR);
554}
555
556static int mxc_gpio_syscore_suspend(void)
557{
558 struct mxc_gpio_port *port;
559
560 /* walk through all ports */
561 list_for_each_entry(port, &mxc_gpio_ports, node) {
562 mxc_gpio_save_regs(port);
563 clk_disable_unprepare(port->clk);
564 }
565
566 return 0;
567}
568
569static void mxc_gpio_syscore_resume(void)
570{
571 struct mxc_gpio_port *port;
572 int ret;
573
574 /* walk through all ports */
575 list_for_each_entry(port, &mxc_gpio_ports, node) {
576 ret = clk_prepare_enable(port->clk);
577 if (ret) {
578 pr_err("mxc: failed to enable gpio clock %d\n", ret);
579 return;
580 }
581 mxc_gpio_restore_regs(port);
582 }
583}
584
585static struct syscore_ops mxc_gpio_syscore_ops = {
586 .suspend = mxc_gpio_syscore_suspend,
587 .resume = mxc_gpio_syscore_resume,
588};
589
590static struct platform_driver mxc_gpio_driver = {
591 .driver = {
592 .name = "gpio-mxc",
593 .of_match_table = mxc_gpio_dt_ids,
594 .suppress_bind_attrs = true,
595 },
596 .probe = mxc_gpio_probe,
597 .id_table = mxc_gpio_devtype,
598};
599
600static int __init gpio_mxc_init(void)
601{
602 register_syscore_ops(&mxc_gpio_syscore_ops);
603
604 return platform_driver_register(&mxc_gpio_driver);
605}
606subsys_initcall(gpio_mxc_init);
1/*
2 * MXC GPIO support. (c) 2008 Daniel Mack <daniel@caiaq.de>
3 * Copyright 2008 Juergen Beisert, kernel@pengutronix.de
4 *
5 * Based on code from Freescale,
6 * Copyright (C) 2004-2010 Freescale Semiconductor, Inc. All Rights Reserved.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 */
21
22#include <linux/err.h>
23#include <linux/init.h>
24#include <linux/interrupt.h>
25#include <linux/io.h>
26#include <linux/irq.h>
27#include <linux/irqdomain.h>
28#include <linux/irqchip/chained_irq.h>
29#include <linux/gpio.h>
30#include <linux/platform_device.h>
31#include <linux/slab.h>
32#include <linux/basic_mmio_gpio.h>
33#include <linux/of.h>
34#include <linux/of_device.h>
35#include <linux/module.h>
36#include <asm-generic/bug.h>
37
38enum mxc_gpio_hwtype {
39 IMX1_GPIO, /* runs on i.mx1 */
40 IMX21_GPIO, /* runs on i.mx21 and i.mx27 */
41 IMX31_GPIO, /* runs on i.mx31 */
42 IMX35_GPIO, /* runs on all other i.mx */
43};
44
45/* device type dependent stuff */
46struct mxc_gpio_hwdata {
47 unsigned dr_reg;
48 unsigned gdir_reg;
49 unsigned psr_reg;
50 unsigned icr1_reg;
51 unsigned icr2_reg;
52 unsigned imr_reg;
53 unsigned isr_reg;
54 int edge_sel_reg;
55 unsigned low_level;
56 unsigned high_level;
57 unsigned rise_edge;
58 unsigned fall_edge;
59};
60
61struct mxc_gpio_port {
62 struct list_head node;
63 void __iomem *base;
64 int irq;
65 int irq_high;
66 struct irq_domain *domain;
67 struct bgpio_chip bgc;
68 u32 both_edges;
69};
70
71static struct mxc_gpio_hwdata imx1_imx21_gpio_hwdata = {
72 .dr_reg = 0x1c,
73 .gdir_reg = 0x00,
74 .psr_reg = 0x24,
75 .icr1_reg = 0x28,
76 .icr2_reg = 0x2c,
77 .imr_reg = 0x30,
78 .isr_reg = 0x34,
79 .edge_sel_reg = -EINVAL,
80 .low_level = 0x03,
81 .high_level = 0x02,
82 .rise_edge = 0x00,
83 .fall_edge = 0x01,
84};
85
86static struct mxc_gpio_hwdata imx31_gpio_hwdata = {
87 .dr_reg = 0x00,
88 .gdir_reg = 0x04,
89 .psr_reg = 0x08,
90 .icr1_reg = 0x0c,
91 .icr2_reg = 0x10,
92 .imr_reg = 0x14,
93 .isr_reg = 0x18,
94 .edge_sel_reg = -EINVAL,
95 .low_level = 0x00,
96 .high_level = 0x01,
97 .rise_edge = 0x02,
98 .fall_edge = 0x03,
99};
100
101static struct mxc_gpio_hwdata imx35_gpio_hwdata = {
102 .dr_reg = 0x00,
103 .gdir_reg = 0x04,
104 .psr_reg = 0x08,
105 .icr1_reg = 0x0c,
106 .icr2_reg = 0x10,
107 .imr_reg = 0x14,
108 .isr_reg = 0x18,
109 .edge_sel_reg = 0x1c,
110 .low_level = 0x00,
111 .high_level = 0x01,
112 .rise_edge = 0x02,
113 .fall_edge = 0x03,
114};
115
116static enum mxc_gpio_hwtype mxc_gpio_hwtype;
117static struct mxc_gpio_hwdata *mxc_gpio_hwdata;
118
119#define GPIO_DR (mxc_gpio_hwdata->dr_reg)
120#define GPIO_GDIR (mxc_gpio_hwdata->gdir_reg)
121#define GPIO_PSR (mxc_gpio_hwdata->psr_reg)
122#define GPIO_ICR1 (mxc_gpio_hwdata->icr1_reg)
123#define GPIO_ICR2 (mxc_gpio_hwdata->icr2_reg)
124#define GPIO_IMR (mxc_gpio_hwdata->imr_reg)
125#define GPIO_ISR (mxc_gpio_hwdata->isr_reg)
126#define GPIO_EDGE_SEL (mxc_gpio_hwdata->edge_sel_reg)
127
128#define GPIO_INT_LOW_LEV (mxc_gpio_hwdata->low_level)
129#define GPIO_INT_HIGH_LEV (mxc_gpio_hwdata->high_level)
130#define GPIO_INT_RISE_EDGE (mxc_gpio_hwdata->rise_edge)
131#define GPIO_INT_FALL_EDGE (mxc_gpio_hwdata->fall_edge)
132#define GPIO_INT_BOTH_EDGES 0x4
133
134static struct platform_device_id mxc_gpio_devtype[] = {
135 {
136 .name = "imx1-gpio",
137 .driver_data = IMX1_GPIO,
138 }, {
139 .name = "imx21-gpio",
140 .driver_data = IMX21_GPIO,
141 }, {
142 .name = "imx31-gpio",
143 .driver_data = IMX31_GPIO,
144 }, {
145 .name = "imx35-gpio",
146 .driver_data = IMX35_GPIO,
147 }, {
148 /* sentinel */
149 }
150};
151
152static const struct of_device_id mxc_gpio_dt_ids[] = {
153 { .compatible = "fsl,imx1-gpio", .data = &mxc_gpio_devtype[IMX1_GPIO], },
154 { .compatible = "fsl,imx21-gpio", .data = &mxc_gpio_devtype[IMX21_GPIO], },
155 { .compatible = "fsl,imx31-gpio", .data = &mxc_gpio_devtype[IMX31_GPIO], },
156 { .compatible = "fsl,imx35-gpio", .data = &mxc_gpio_devtype[IMX35_GPIO], },
157 { /* sentinel */ }
158};
159
160/*
161 * MX2 has one interrupt *for all* gpio ports. The list is used
162 * to save the references to all ports, so that mx2_gpio_irq_handler
163 * can walk through all interrupt status registers.
164 */
165static LIST_HEAD(mxc_gpio_ports);
166
167/* Note: This driver assumes 32 GPIOs are handled in one register */
168
169static int gpio_set_irq_type(struct irq_data *d, u32 type)
170{
171 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
172 struct mxc_gpio_port *port = gc->private;
173 u32 bit, val;
174 u32 gpio_idx = d->hwirq;
175 u32 gpio = port->bgc.gc.base + gpio_idx;
176 int edge;
177 void __iomem *reg = port->base;
178
179 port->both_edges &= ~(1 << gpio_idx);
180 switch (type) {
181 case IRQ_TYPE_EDGE_RISING:
182 edge = GPIO_INT_RISE_EDGE;
183 break;
184 case IRQ_TYPE_EDGE_FALLING:
185 edge = GPIO_INT_FALL_EDGE;
186 break;
187 case IRQ_TYPE_EDGE_BOTH:
188 if (GPIO_EDGE_SEL >= 0) {
189 edge = GPIO_INT_BOTH_EDGES;
190 } else {
191 val = gpio_get_value(gpio);
192 if (val) {
193 edge = GPIO_INT_LOW_LEV;
194 pr_debug("mxc: set GPIO %d to low trigger\n", gpio);
195 } else {
196 edge = GPIO_INT_HIGH_LEV;
197 pr_debug("mxc: set GPIO %d to high trigger\n", gpio);
198 }
199 port->both_edges |= 1 << gpio_idx;
200 }
201 break;
202 case IRQ_TYPE_LEVEL_LOW:
203 edge = GPIO_INT_LOW_LEV;
204 break;
205 case IRQ_TYPE_LEVEL_HIGH:
206 edge = GPIO_INT_HIGH_LEV;
207 break;
208 default:
209 return -EINVAL;
210 }
211
212 if (GPIO_EDGE_SEL >= 0) {
213 val = readl(port->base + GPIO_EDGE_SEL);
214 if (edge == GPIO_INT_BOTH_EDGES)
215 writel(val | (1 << gpio_idx),
216 port->base + GPIO_EDGE_SEL);
217 else
218 writel(val & ~(1 << gpio_idx),
219 port->base + GPIO_EDGE_SEL);
220 }
221
222 if (edge != GPIO_INT_BOTH_EDGES) {
223 reg += GPIO_ICR1 + ((gpio_idx & 0x10) >> 2); /* lower or upper register */
224 bit = gpio_idx & 0xf;
225 val = readl(reg) & ~(0x3 << (bit << 1));
226 writel(val | (edge << (bit << 1)), reg);
227 }
228
229 writel(1 << gpio_idx, port->base + GPIO_ISR);
230
231 return 0;
232}
233
234static void mxc_flip_edge(struct mxc_gpio_port *port, u32 gpio)
235{
236 void __iomem *reg = port->base;
237 u32 bit, val;
238 int edge;
239
240 reg += GPIO_ICR1 + ((gpio & 0x10) >> 2); /* lower or upper register */
241 bit = gpio & 0xf;
242 val = readl(reg);
243 edge = (val >> (bit << 1)) & 3;
244 val &= ~(0x3 << (bit << 1));
245 if (edge == GPIO_INT_HIGH_LEV) {
246 edge = GPIO_INT_LOW_LEV;
247 pr_debug("mxc: switch GPIO %d to low trigger\n", gpio);
248 } else if (edge == GPIO_INT_LOW_LEV) {
249 edge = GPIO_INT_HIGH_LEV;
250 pr_debug("mxc: switch GPIO %d to high trigger\n", gpio);
251 } else {
252 pr_err("mxc: invalid configuration for GPIO %d: %x\n",
253 gpio, edge);
254 return;
255 }
256 writel(val | (edge << (bit << 1)), reg);
257}
258
259/* handle 32 interrupts in one status register */
260static void mxc_gpio_irq_handler(struct mxc_gpio_port *port, u32 irq_stat)
261{
262 while (irq_stat != 0) {
263 int irqoffset = fls(irq_stat) - 1;
264
265 if (port->both_edges & (1 << irqoffset))
266 mxc_flip_edge(port, irqoffset);
267
268 generic_handle_irq(irq_find_mapping(port->domain, irqoffset));
269
270 irq_stat &= ~(1 << irqoffset);
271 }
272}
273
274/* MX1 and MX3 has one interrupt *per* gpio port */
275static void mx3_gpio_irq_handler(u32 irq, struct irq_desc *desc)
276{
277 u32 irq_stat;
278 struct mxc_gpio_port *port = irq_get_handler_data(irq);
279 struct irq_chip *chip = irq_get_chip(irq);
280
281 chained_irq_enter(chip, desc);
282
283 irq_stat = readl(port->base + GPIO_ISR) & readl(port->base + GPIO_IMR);
284
285 mxc_gpio_irq_handler(port, irq_stat);
286
287 chained_irq_exit(chip, desc);
288}
289
290/* MX2 has one interrupt *for all* gpio ports */
291static void mx2_gpio_irq_handler(u32 irq, struct irq_desc *desc)
292{
293 u32 irq_msk, irq_stat;
294 struct mxc_gpio_port *port;
295 struct irq_chip *chip = irq_get_chip(irq);
296
297 chained_irq_enter(chip, desc);
298
299 /* walk through all interrupt status registers */
300 list_for_each_entry(port, &mxc_gpio_ports, node) {
301 irq_msk = readl(port->base + GPIO_IMR);
302 if (!irq_msk)
303 continue;
304
305 irq_stat = readl(port->base + GPIO_ISR) & irq_msk;
306 if (irq_stat)
307 mxc_gpio_irq_handler(port, irq_stat);
308 }
309 chained_irq_exit(chip, desc);
310}
311
312/*
313 * Set interrupt number "irq" in the GPIO as a wake-up source.
314 * While system is running, all registered GPIO interrupts need to have
315 * wake-up enabled. When system is suspended, only selected GPIO interrupts
316 * need to have wake-up enabled.
317 * @param irq interrupt source number
318 * @param enable enable as wake-up if equal to non-zero
319 * @return This function returns 0 on success.
320 */
321static int gpio_set_wake_irq(struct irq_data *d, u32 enable)
322{
323 struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
324 struct mxc_gpio_port *port = gc->private;
325 u32 gpio_idx = d->hwirq;
326
327 if (enable) {
328 if (port->irq_high && (gpio_idx >= 16))
329 enable_irq_wake(port->irq_high);
330 else
331 enable_irq_wake(port->irq);
332 } else {
333 if (port->irq_high && (gpio_idx >= 16))
334 disable_irq_wake(port->irq_high);
335 else
336 disable_irq_wake(port->irq);
337 }
338
339 return 0;
340}
341
342static void __init mxc_gpio_init_gc(struct mxc_gpio_port *port, int irq_base)
343{
344 struct irq_chip_generic *gc;
345 struct irq_chip_type *ct;
346
347 gc = irq_alloc_generic_chip("gpio-mxc", 1, irq_base,
348 port->base, handle_level_irq);
349 gc->private = port;
350
351 ct = gc->chip_types;
352 ct->chip.irq_ack = irq_gc_ack_set_bit;
353 ct->chip.irq_mask = irq_gc_mask_clr_bit;
354 ct->chip.irq_unmask = irq_gc_mask_set_bit;
355 ct->chip.irq_set_type = gpio_set_irq_type;
356 ct->chip.irq_set_wake = gpio_set_wake_irq;
357 ct->regs.ack = GPIO_ISR;
358 ct->regs.mask = GPIO_IMR;
359
360 irq_setup_generic_chip(gc, IRQ_MSK(32), IRQ_GC_INIT_NESTED_LOCK,
361 IRQ_NOREQUEST, 0);
362}
363
364static void mxc_gpio_get_hw(struct platform_device *pdev)
365{
366 const struct of_device_id *of_id =
367 of_match_device(mxc_gpio_dt_ids, &pdev->dev);
368 enum mxc_gpio_hwtype hwtype;
369
370 if (of_id)
371 pdev->id_entry = of_id->data;
372 hwtype = pdev->id_entry->driver_data;
373
374 if (mxc_gpio_hwtype) {
375 /*
376 * The driver works with a reasonable presupposition,
377 * that is all gpio ports must be the same type when
378 * running on one soc.
379 */
380 BUG_ON(mxc_gpio_hwtype != hwtype);
381 return;
382 }
383
384 if (hwtype == IMX35_GPIO)
385 mxc_gpio_hwdata = &imx35_gpio_hwdata;
386 else if (hwtype == IMX31_GPIO)
387 mxc_gpio_hwdata = &imx31_gpio_hwdata;
388 else
389 mxc_gpio_hwdata = &imx1_imx21_gpio_hwdata;
390
391 mxc_gpio_hwtype = hwtype;
392}
393
394static int mxc_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
395{
396 struct bgpio_chip *bgc = to_bgpio_chip(gc);
397 struct mxc_gpio_port *port =
398 container_of(bgc, struct mxc_gpio_port, bgc);
399
400 return irq_find_mapping(port->domain, offset);
401}
402
403static int mxc_gpio_probe(struct platform_device *pdev)
404{
405 struct device_node *np = pdev->dev.of_node;
406 struct mxc_gpio_port *port;
407 struct resource *iores;
408 int irq_base;
409 int err;
410
411 mxc_gpio_get_hw(pdev);
412
413 port = devm_kzalloc(&pdev->dev, sizeof(*port), GFP_KERNEL);
414 if (!port)
415 return -ENOMEM;
416
417 iores = platform_get_resource(pdev, IORESOURCE_MEM, 0);
418 port->base = devm_ioremap_resource(&pdev->dev, iores);
419 if (IS_ERR(port->base))
420 return PTR_ERR(port->base);
421
422 port->irq_high = platform_get_irq(pdev, 1);
423 port->irq = platform_get_irq(pdev, 0);
424 if (port->irq < 0)
425 return port->irq;
426
427 /* disable the interrupt and clear the status */
428 writel(0, port->base + GPIO_IMR);
429 writel(~0, port->base + GPIO_ISR);
430
431 if (mxc_gpio_hwtype == IMX21_GPIO) {
432 /*
433 * Setup one handler for all GPIO interrupts. Actually setting
434 * the handler is needed only once, but doing it for every port
435 * is more robust and easier.
436 */
437 irq_set_chained_handler(port->irq, mx2_gpio_irq_handler);
438 } else {
439 /* setup one handler for each entry */
440 irq_set_chained_handler(port->irq, mx3_gpio_irq_handler);
441 irq_set_handler_data(port->irq, port);
442 if (port->irq_high > 0) {
443 /* setup handler for GPIO 16 to 31 */
444 irq_set_chained_handler(port->irq_high,
445 mx3_gpio_irq_handler);
446 irq_set_handler_data(port->irq_high, port);
447 }
448 }
449
450 err = bgpio_init(&port->bgc, &pdev->dev, 4,
451 port->base + GPIO_PSR,
452 port->base + GPIO_DR, NULL,
453 port->base + GPIO_GDIR, NULL, 0);
454 if (err)
455 goto out_bgio;
456
457 port->bgc.gc.to_irq = mxc_gpio_to_irq;
458 port->bgc.gc.base = (pdev->id < 0) ? of_alias_get_id(np, "gpio") * 32 :
459 pdev->id * 32;
460
461 err = gpiochip_add(&port->bgc.gc);
462 if (err)
463 goto out_bgpio_remove;
464
465 irq_base = irq_alloc_descs(-1, 0, 32, numa_node_id());
466 if (irq_base < 0) {
467 err = irq_base;
468 goto out_gpiochip_remove;
469 }
470
471 port->domain = irq_domain_add_legacy(np, 32, irq_base, 0,
472 &irq_domain_simple_ops, NULL);
473 if (!port->domain) {
474 err = -ENODEV;
475 goto out_irqdesc_free;
476 }
477
478 /* gpio-mxc can be a generic irq chip */
479 mxc_gpio_init_gc(port, irq_base);
480
481 list_add_tail(&port->node, &mxc_gpio_ports);
482
483 return 0;
484
485out_irqdesc_free:
486 irq_free_descs(irq_base, 32);
487out_gpiochip_remove:
488 WARN_ON(gpiochip_remove(&port->bgc.gc) < 0);
489out_bgpio_remove:
490 bgpio_remove(&port->bgc);
491out_bgio:
492 dev_info(&pdev->dev, "%s failed with errno %d\n", __func__, err);
493 return err;
494}
495
496static struct platform_driver mxc_gpio_driver = {
497 .driver = {
498 .name = "gpio-mxc",
499 .owner = THIS_MODULE,
500 .of_match_table = mxc_gpio_dt_ids,
501 },
502 .probe = mxc_gpio_probe,
503 .id_table = mxc_gpio_devtype,
504};
505
506static int __init gpio_mxc_init(void)
507{
508 return platform_driver_register(&mxc_gpio_driver);
509}
510postcore_initcall(gpio_mxc_init);
511
512MODULE_AUTHOR("Freescale Semiconductor, "
513 "Daniel Mack <danielncaiaq.de>, "
514 "Juergen Beisert <kernel@pengutronix.de>");
515MODULE_DESCRIPTION("Freescale MXC GPIO");
516MODULE_LICENSE("GPL");