2 * Copyright (c) 2011 Jamie Iles
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
8 * All enquiries to support@picochip.com
10 #include <linux/basic_mmio_gpio.h>
11 #include <linux/err.h>
12 #include <linux/init.h>
13 #include <linux/interrupt.h>
15 #include <linux/ioport.h>
16 #include <linux/irq.h>
17 #include <linux/irqdomain.h>
18 #include <linux/module.h>
20 #include <linux/of_address.h>
21 #include <linux/of_irq.h>
22 #include <linux/platform_device.h>
23 #include <linux/spinlock.h>
24 #include <linux/platform_data/gpio-dwapb.h>
25 #include <linux/slab.h>
27 #define GPIO_SWPORTA_DR 0x00
28 #define GPIO_SWPORTA_DDR 0x04
29 #define GPIO_SWPORTB_DR 0x0c
30 #define GPIO_SWPORTB_DDR 0x10
31 #define GPIO_SWPORTC_DR 0x18
32 #define GPIO_SWPORTC_DDR 0x1c
33 #define GPIO_SWPORTD_DR 0x24
34 #define GPIO_SWPORTD_DDR 0x28
35 #define GPIO_INTEN 0x30
36 #define GPIO_INTMASK 0x34
37 #define GPIO_INTTYPE_LEVEL 0x38
38 #define GPIO_INT_POLARITY 0x3c
39 #define GPIO_INTSTATUS 0x40
40 #define GPIO_PORTA_DEBOUNCE 0x48
41 #define GPIO_PORTA_EOI 0x4c
42 #define GPIO_EXT_PORTA 0x50
43 #define GPIO_EXT_PORTB 0x54
44 #define GPIO_EXT_PORTC 0x58
45 #define GPIO_EXT_PORTD 0x5c
47 #define DWAPB_MAX_PORTS 4
48 #define GPIO_EXT_PORT_SIZE (GPIO_EXT_PORTB - GPIO_EXT_PORTA)
49 #define GPIO_SWPORT_DR_SIZE (GPIO_SWPORTB_DR - GPIO_SWPORTA_DR)
50 #define GPIO_SWPORT_DDR_SIZE (GPIO_SWPORTB_DDR - GPIO_SWPORTA_DDR)
54 #ifdef CONFIG_PM_SLEEP
55 /* Store GPIO context across system-wide suspend/resume transitions */
56 struct dwapb_context {
68 struct dwapb_gpio_port {
69 struct bgpio_chip bgc;
71 struct dwapb_gpio *gpio;
72 #ifdef CONFIG_PM_SLEEP
73 struct dwapb_context *ctx;
81 struct dwapb_gpio_port *ports;
82 unsigned int nr_ports;
83 struct irq_domain *domain;
86 static inline struct dwapb_gpio_port *
87 to_dwapb_gpio_port(struct bgpio_chip *bgc)
89 return container_of(bgc, struct dwapb_gpio_port, bgc);
92 static inline u32 dwapb_read(struct dwapb_gpio *gpio, unsigned int offset)
94 struct bgpio_chip *bgc = &gpio->ports[0].bgc;
95 void __iomem *reg_base = gpio->regs;
97 return bgc->read_reg(reg_base + offset);
100 static inline void dwapb_write(struct dwapb_gpio *gpio, unsigned int offset,
103 struct bgpio_chip *bgc = &gpio->ports[0].bgc;
104 void __iomem *reg_base = gpio->regs;
106 bgc->write_reg(reg_base + offset, val);
109 static int dwapb_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
111 struct bgpio_chip *bgc = to_bgpio_chip(gc);
112 struct dwapb_gpio_port *port = to_dwapb_gpio_port(bgc);
113 struct dwapb_gpio *gpio = port->gpio;
115 return irq_find_mapping(gpio->domain, offset);
118 static void dwapb_toggle_trigger(struct dwapb_gpio *gpio, unsigned int offs)
120 u32 v = dwapb_read(gpio, GPIO_INT_POLARITY);
122 if (gpio_get_value(gpio->ports[0].bgc.gc.base + offs))
127 dwapb_write(gpio, GPIO_INT_POLARITY, v);
130 static u32 dwapb_do_irq(struct dwapb_gpio *gpio)
132 u32 irq_status = readl_relaxed(gpio->regs + GPIO_INTSTATUS);
133 u32 ret = irq_status;
136 int hwirq = fls(irq_status) - 1;
137 int gpio_irq = irq_find_mapping(gpio->domain, hwirq);
139 generic_handle_irq(gpio_irq);
140 irq_status &= ~BIT(hwirq);
142 if ((irq_get_trigger_type(gpio_irq) & IRQ_TYPE_SENSE_MASK)
143 == IRQ_TYPE_EDGE_BOTH)
144 dwapb_toggle_trigger(gpio, hwirq);
150 static void dwapb_irq_handler(u32 irq, struct irq_desc *desc)
152 struct dwapb_gpio *gpio = irq_get_handler_data(irq);
153 struct irq_chip *chip = irq_desc_get_chip(desc);
158 chip->irq_eoi(irq_desc_get_irq_data(desc));
161 static void dwapb_irq_enable(struct irq_data *d)
163 struct irq_chip_generic *igc = irq_data_get_irq_chip_data(d);
164 struct dwapb_gpio *gpio = igc->private;
165 struct bgpio_chip *bgc = &gpio->ports[0].bgc;
169 spin_lock_irqsave(&bgc->lock, flags);
170 val = dwapb_read(gpio, GPIO_INTEN);
171 val |= BIT(d->hwirq);
172 dwapb_write(gpio, GPIO_INTEN, val);
173 spin_unlock_irqrestore(&bgc->lock, flags);
176 static void dwapb_irq_disable(struct irq_data *d)
178 struct irq_chip_generic *igc = irq_data_get_irq_chip_data(d);
179 struct dwapb_gpio *gpio = igc->private;
180 struct bgpio_chip *bgc = &gpio->ports[0].bgc;
184 spin_lock_irqsave(&bgc->lock, flags);
185 val = dwapb_read(gpio, GPIO_INTEN);
186 val &= ~BIT(d->hwirq);
187 dwapb_write(gpio, GPIO_INTEN, val);
188 spin_unlock_irqrestore(&bgc->lock, flags);
191 static int dwapb_irq_reqres(struct irq_data *d)
193 struct irq_chip_generic *igc = irq_data_get_irq_chip_data(d);
194 struct dwapb_gpio *gpio = igc->private;
195 struct bgpio_chip *bgc = &gpio->ports[0].bgc;
197 if (gpiochip_lock_as_irq(&bgc->gc, irqd_to_hwirq(d))) {
198 dev_err(gpio->dev, "unable to lock HW IRQ %lu for IRQ\n",
205 static void dwapb_irq_relres(struct irq_data *d)
207 struct irq_chip_generic *igc = irq_data_get_irq_chip_data(d);
208 struct dwapb_gpio *gpio = igc->private;
209 struct bgpio_chip *bgc = &gpio->ports[0].bgc;
211 gpiochip_unlock_as_irq(&bgc->gc, irqd_to_hwirq(d));
214 static int dwapb_irq_set_type(struct irq_data *d, u32 type)
216 struct irq_chip_generic *igc = irq_data_get_irq_chip_data(d);
217 struct dwapb_gpio *gpio = igc->private;
218 struct bgpio_chip *bgc = &gpio->ports[0].bgc;
220 unsigned long level, polarity, flags;
222 if (type & ~(IRQ_TYPE_EDGE_RISING | IRQ_TYPE_EDGE_FALLING |
223 IRQ_TYPE_LEVEL_HIGH | IRQ_TYPE_LEVEL_LOW))
226 spin_lock_irqsave(&bgc->lock, flags);
227 level = dwapb_read(gpio, GPIO_INTTYPE_LEVEL);
228 polarity = dwapb_read(gpio, GPIO_INT_POLARITY);
231 case IRQ_TYPE_EDGE_BOTH:
233 dwapb_toggle_trigger(gpio, bit);
235 case IRQ_TYPE_EDGE_RISING:
237 polarity |= BIT(bit);
239 case IRQ_TYPE_EDGE_FALLING:
241 polarity &= ~BIT(bit);
243 case IRQ_TYPE_LEVEL_HIGH:
245 polarity |= BIT(bit);
247 case IRQ_TYPE_LEVEL_LOW:
249 polarity &= ~BIT(bit);
253 irq_setup_alt_chip(d, type);
255 dwapb_write(gpio, GPIO_INTTYPE_LEVEL, level);
256 dwapb_write(gpio, GPIO_INT_POLARITY, polarity);
257 spin_unlock_irqrestore(&bgc->lock, flags);
262 static int dwapb_gpio_set_debounce(struct gpio_chip *gc,
263 unsigned offset, unsigned debounce)
265 struct bgpio_chip *bgc = to_bgpio_chip(gc);
266 struct dwapb_gpio_port *port = to_dwapb_gpio_port(bgc);
267 struct dwapb_gpio *gpio = port->gpio;
268 unsigned long flags, val_deb;
269 unsigned long mask = bgc->pin2mask(bgc, offset);
271 spin_lock_irqsave(&bgc->lock, flags);
273 val_deb = dwapb_read(gpio, GPIO_PORTA_DEBOUNCE);
275 dwapb_write(gpio, GPIO_PORTA_DEBOUNCE, val_deb | mask);
277 dwapb_write(gpio, GPIO_PORTA_DEBOUNCE, val_deb & ~mask);
279 spin_unlock_irqrestore(&bgc->lock, flags);
284 static irqreturn_t dwapb_irq_handler_mfd(int irq, void *dev_id)
287 struct dwapb_gpio *gpio = dev_id;
289 worked = dwapb_do_irq(gpio);
291 return worked ? IRQ_HANDLED : IRQ_NONE;
294 static void dwapb_configure_irqs(struct dwapb_gpio *gpio,
295 struct dwapb_gpio_port *port,
296 struct dwapb_port_property *pp)
298 struct gpio_chip *gc = &port->bgc.gc;
299 struct device_node *node = pp->node;
300 struct irq_chip_generic *irq_gc = NULL;
301 unsigned int hwirq, ngpio = gc->ngpio;
302 struct irq_chip_type *ct;
305 gpio->domain = irq_domain_add_linear(node, ngpio,
306 &irq_generic_chip_ops, gpio);
310 err = irq_alloc_domain_generic_chips(gpio->domain, ngpio, 2,
311 "gpio-dwapb", handle_level_irq,
313 IRQ_GC_INIT_NESTED_LOCK);
315 dev_info(gpio->dev, "irq_alloc_domain_generic_chips failed\n");
316 irq_domain_remove(gpio->domain);
321 irq_gc = irq_get_domain_generic_chip(gpio->domain, 0);
323 irq_domain_remove(gpio->domain);
328 irq_gc->reg_base = gpio->regs;
329 irq_gc->private = gpio;
331 for (i = 0; i < 2; i++) {
332 ct = &irq_gc->chip_types[i];
333 ct->chip.irq_ack = irq_gc_ack_set_bit;
334 ct->chip.irq_mask = irq_gc_mask_set_bit;
335 ct->chip.irq_unmask = irq_gc_mask_clr_bit;
336 ct->chip.irq_set_type = dwapb_irq_set_type;
337 ct->chip.irq_enable = dwapb_irq_enable;
338 ct->chip.irq_disable = dwapb_irq_disable;
339 ct->chip.irq_request_resources = dwapb_irq_reqres;
340 ct->chip.irq_release_resources = dwapb_irq_relres;
341 ct->regs.ack = GPIO_PORTA_EOI;
342 ct->regs.mask = GPIO_INTMASK;
343 ct->type = IRQ_TYPE_LEVEL_MASK;
346 irq_gc->chip_types[0].type = IRQ_TYPE_LEVEL_MASK;
347 irq_gc->chip_types[1].type = IRQ_TYPE_EDGE_BOTH;
348 irq_gc->chip_types[1].handler = handle_edge_irq;
350 if (!pp->irq_shared) {
351 irq_set_chained_handler(pp->irq, dwapb_irq_handler);
352 irq_set_handler_data(pp->irq, gpio);
355 * Request a shared IRQ since where MFD would have devices
356 * using the same irq pin
358 err = devm_request_irq(gpio->dev, pp->irq,
359 dwapb_irq_handler_mfd,
360 IRQF_SHARED, "gpio-dwapb-mfd", gpio);
362 dev_err(gpio->dev, "error requesting IRQ\n");
363 irq_domain_remove(gpio->domain);
369 for (hwirq = 0 ; hwirq < ngpio ; hwirq++)
370 irq_create_mapping(gpio->domain, hwirq);
372 port->bgc.gc.to_irq = dwapb_gpio_to_irq;
375 static void dwapb_irq_teardown(struct dwapb_gpio *gpio)
377 struct dwapb_gpio_port *port = &gpio->ports[0];
378 struct gpio_chip *gc = &port->bgc.gc;
379 unsigned int ngpio = gc->ngpio;
380 irq_hw_number_t hwirq;
385 for (hwirq = 0 ; hwirq < ngpio ; hwirq++)
386 irq_dispose_mapping(irq_find_mapping(gpio->domain, hwirq));
388 irq_domain_remove(gpio->domain);
392 static int dwapb_gpio_add_port(struct dwapb_gpio *gpio,
393 struct dwapb_port_property *pp,
396 struct dwapb_gpio_port *port;
397 void __iomem *dat, *set, *dirout;
400 port = &gpio->ports[offs];
404 #ifdef CONFIG_PM_SLEEP
405 port->ctx = devm_kzalloc(gpio->dev, sizeof(*port->ctx), GFP_KERNEL);
410 dat = gpio->regs + GPIO_EXT_PORTA + (pp->idx * GPIO_EXT_PORT_SIZE);
411 set = gpio->regs + GPIO_SWPORTA_DR + (pp->idx * GPIO_SWPORT_DR_SIZE);
412 dirout = gpio->regs + GPIO_SWPORTA_DDR +
413 (pp->idx * GPIO_SWPORT_DDR_SIZE);
415 err = bgpio_init(&port->bgc, gpio->dev, 4, dat, set, NULL, dirout,
418 dev_err(gpio->dev, "failed to init gpio chip for %s\n",
423 #ifdef CONFIG_OF_GPIO
424 port->bgc.gc.of_node = pp->node;
426 port->bgc.gc.ngpio = pp->ngpio;
427 port->bgc.gc.base = pp->gpio_base;
429 /* Only port A support debounce */
431 port->bgc.gc.set_debounce = dwapb_gpio_set_debounce;
434 dwapb_configure_irqs(gpio, port, pp);
436 err = gpiochip_add(&port->bgc.gc);
438 dev_err(gpio->dev, "failed to register gpiochip for %s\n",
441 port->is_registered = true;
446 static void dwapb_gpio_unregister(struct dwapb_gpio *gpio)
450 for (m = 0; m < gpio->nr_ports; ++m)
451 if (gpio->ports[m].is_registered)
452 gpiochip_remove(&gpio->ports[m].bgc.gc);
455 static struct dwapb_platform_data *
456 dwapb_gpio_get_pdata_of(struct device *dev)
458 struct device_node *node, *port_np;
459 struct dwapb_platform_data *pdata;
460 struct dwapb_port_property *pp;
465 if (!IS_ENABLED(CONFIG_OF_GPIO) || !node)
466 return ERR_PTR(-ENODEV);
468 nports = of_get_child_count(node);
470 return ERR_PTR(-ENODEV);
472 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
474 return ERR_PTR(-ENOMEM);
476 pdata->properties = devm_kcalloc(dev, nports, sizeof(*pp), GFP_KERNEL);
477 if (!pdata->properties)
478 return ERR_PTR(-ENOMEM);
480 pdata->nports = nports;
483 for_each_child_of_node(node, port_np) {
484 pp = &pdata->properties[i++];
487 if (of_property_read_u32(port_np, "reg", &pp->idx) ||
488 pp->idx >= DWAPB_MAX_PORTS) {
489 dev_err(dev, "missing/invalid port index for %s\n",
491 return ERR_PTR(-EINVAL);
494 if (of_property_read_u32(port_np, "snps,nr-gpios",
496 dev_info(dev, "failed to get number of gpios for %s\n",
502 * Only port A can provide interrupts in all configurations of
506 of_property_read_bool(port_np, "interrupt-controller")) {
507 pp->irq = irq_of_parse_and_map(port_np, 0);
509 dev_warn(dev, "no irq for bank %s\n",
514 pp->irq_shared = false;
516 pp->name = port_np->full_name;
522 static int dwapb_gpio_probe(struct platform_device *pdev)
525 struct resource *res;
526 struct dwapb_gpio *gpio;
528 struct device *dev = &pdev->dev;
529 struct dwapb_platform_data *pdata = dev_get_platdata(dev);
532 pdata = dwapb_gpio_get_pdata_of(dev);
534 return PTR_ERR(pdata);
540 gpio = devm_kzalloc(&pdev->dev, sizeof(*gpio), GFP_KERNEL);
544 gpio->dev = &pdev->dev;
545 gpio->nr_ports = pdata->nports;
547 gpio->ports = devm_kcalloc(&pdev->dev, gpio->nr_ports,
548 sizeof(*gpio->ports), GFP_KERNEL);
552 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
553 gpio->regs = devm_ioremap_resource(&pdev->dev, res);
554 if (IS_ERR(gpio->regs))
555 return PTR_ERR(gpio->regs);
557 for (i = 0; i < gpio->nr_ports; i++) {
558 err = dwapb_gpio_add_port(gpio, &pdata->properties[i], i);
562 platform_set_drvdata(pdev, gpio);
567 dwapb_gpio_unregister(gpio);
568 dwapb_irq_teardown(gpio);
573 static int dwapb_gpio_remove(struct platform_device *pdev)
575 struct dwapb_gpio *gpio = platform_get_drvdata(pdev);
577 dwapb_gpio_unregister(gpio);
578 dwapb_irq_teardown(gpio);
583 static const struct of_device_id dwapb_of_match[] = {
584 { .compatible = "snps,dw-apb-gpio" },
587 MODULE_DEVICE_TABLE(of, dwapb_of_match);
589 #ifdef CONFIG_PM_SLEEP
590 static int dwapb_gpio_suspend(struct device *dev)
592 struct platform_device *pdev = to_platform_device(dev);
593 struct dwapb_gpio *gpio = platform_get_drvdata(pdev);
594 struct bgpio_chip *bgc = &gpio->ports[0].bgc;
598 spin_lock_irqsave(&bgc->lock, flags);
599 for (i = 0; i < gpio->nr_ports; i++) {
601 unsigned int idx = gpio->ports[i].idx;
602 struct dwapb_context *ctx = gpio->ports[i].ctx;
606 offset = GPIO_SWPORTA_DDR + idx * GPIO_SWPORT_DDR_SIZE;
607 ctx->dir = dwapb_read(gpio, offset);
609 offset = GPIO_SWPORTA_DR + idx * GPIO_SWPORT_DR_SIZE;
610 ctx->data = dwapb_read(gpio, offset);
612 offset = GPIO_EXT_PORTA + idx * GPIO_EXT_PORT_SIZE;
613 ctx->ext = dwapb_read(gpio, offset);
615 /* Only port A can provide interrupts */
617 ctx->int_mask = dwapb_read(gpio, GPIO_INTMASK);
618 ctx->int_en = dwapb_read(gpio, GPIO_INTEN);
619 ctx->int_pol = dwapb_read(gpio, GPIO_INT_POLARITY);
620 ctx->int_type = dwapb_read(gpio, GPIO_INTTYPE_LEVEL);
621 ctx->int_deb = dwapb_read(gpio, GPIO_PORTA_DEBOUNCE);
623 /* Mask out interrupts */
624 dwapb_write(gpio, GPIO_INTMASK, 0xffffffff);
627 spin_unlock_irqrestore(&bgc->lock, flags);
632 static int dwapb_gpio_resume(struct device *dev)
634 struct platform_device *pdev = to_platform_device(dev);
635 struct dwapb_gpio *gpio = platform_get_drvdata(pdev);
636 struct bgpio_chip *bgc = &gpio->ports[0].bgc;
640 spin_lock_irqsave(&bgc->lock, flags);
641 for (i = 0; i < gpio->nr_ports; i++) {
643 unsigned int idx = gpio->ports[i].idx;
644 struct dwapb_context *ctx = gpio->ports[i].ctx;
648 offset = GPIO_SWPORTA_DR + idx * GPIO_SWPORT_DR_SIZE;
649 dwapb_write(gpio, offset, ctx->data);
651 offset = GPIO_SWPORTA_DDR + idx * GPIO_SWPORT_DDR_SIZE;
652 dwapb_write(gpio, offset, ctx->dir);
654 offset = GPIO_EXT_PORTA + idx * GPIO_EXT_PORT_SIZE;
655 dwapb_write(gpio, offset, ctx->ext);
657 /* Only port A can provide interrupts */
659 dwapb_write(gpio, GPIO_INTTYPE_LEVEL, ctx->int_type);
660 dwapb_write(gpio, GPIO_INT_POLARITY, ctx->int_pol);
661 dwapb_write(gpio, GPIO_PORTA_DEBOUNCE, ctx->int_deb);
662 dwapb_write(gpio, GPIO_INTEN, ctx->int_en);
663 dwapb_write(gpio, GPIO_INTMASK, ctx->int_mask);
665 /* Clear out spurious interrupts */
666 dwapb_write(gpio, GPIO_PORTA_EOI, 0xffffffff);
669 spin_unlock_irqrestore(&bgc->lock, flags);
675 static SIMPLE_DEV_PM_OPS(dwapb_gpio_pm_ops, dwapb_gpio_suspend,
678 static struct platform_driver dwapb_gpio_driver = {
680 .name = "gpio-dwapb",
681 .pm = &dwapb_gpio_pm_ops,
682 .of_match_table = of_match_ptr(dwapb_of_match),
684 .probe = dwapb_gpio_probe,
685 .remove = dwapb_gpio_remove,
688 module_platform_driver(dwapb_gpio_driver);
690 MODULE_LICENSE("GPL");
691 MODULE_AUTHOR("Jamie Iles");
692 MODULE_DESCRIPTION("Synopsys DesignWare APB GPIO driver");