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.
10 #include <linux/acpi.h>
11 #include <linux/gpio/driver.h>
12 /* FIXME: for gpio_get_value(), replace this with direct register read */
13 #include <linux/gpio.h>
14 #include <linux/err.h>
15 #include <linux/init.h>
16 #include <linux/interrupt.h>
18 #include <linux/ioport.h>
19 #include <linux/irq.h>
20 #include <linux/irqdomain.h>
21 #include <linux/module.h>
23 #include <linux/of_address.h>
24 #include <linux/of_device.h>
25 #include <linux/of_irq.h>
26 #include <linux/platform_device.h>
27 #include <linux/property.h>
28 #include <linux/spinlock.h>
29 #include <linux/platform_data/gpio-dwapb.h>
30 #include <linux/slab.h>
34 #define GPIO_SWPORTA_DR 0x00
35 #define GPIO_SWPORTA_DDR 0x04
36 #define GPIO_SWPORTB_DR 0x0c
37 #define GPIO_SWPORTB_DDR 0x10
38 #define GPIO_SWPORTC_DR 0x18
39 #define GPIO_SWPORTC_DDR 0x1c
40 #define GPIO_SWPORTD_DR 0x24
41 #define GPIO_SWPORTD_DDR 0x28
42 #define GPIO_INTEN 0x30
43 #define GPIO_INTMASK 0x34
44 #define GPIO_INTTYPE_LEVEL 0x38
45 #define GPIO_INT_POLARITY 0x3c
46 #define GPIO_INTSTATUS 0x40
47 #define GPIO_PORTA_DEBOUNCE 0x48
48 #define GPIO_PORTA_EOI 0x4c
49 #define GPIO_EXT_PORTA 0x50
50 #define GPIO_EXT_PORTB 0x54
51 #define GPIO_EXT_PORTC 0x58
52 #define GPIO_EXT_PORTD 0x5c
54 #define DWAPB_MAX_PORTS 4
55 #define GPIO_EXT_PORT_SIZE (GPIO_EXT_PORTB - GPIO_EXT_PORTA)
56 #define GPIO_SWPORT_DR_SIZE (GPIO_SWPORTB_DR - GPIO_SWPORTA_DR)
57 #define GPIO_SWPORT_DDR_SIZE (GPIO_SWPORTB_DDR - GPIO_SWPORTA_DDR)
59 #define GPIO_REG_OFFSET_V2 1
61 #define GPIO_INTMASK_V2 0x44
62 #define GPIO_INTTYPE_LEVEL_V2 0x34
63 #define GPIO_INT_POLARITY_V2 0x38
64 #define GPIO_INTSTATUS_V2 0x3c
65 #define GPIO_PORTA_EOI_V2 0x40
69 #ifdef CONFIG_PM_SLEEP
70 /* Store GPIO context across system-wide suspend/resume transitions */
71 struct dwapb_context {
83 struct dwapb_gpio_port {
86 struct dwapb_gpio *gpio;
87 #ifdef CONFIG_PM_SLEEP
88 struct dwapb_context *ctx;
96 struct dwapb_gpio_port *ports;
97 unsigned int nr_ports;
98 struct irq_domain *domain;
102 static inline u32 gpio_reg_v2_convert(unsigned int offset)
106 return GPIO_INTMASK_V2;
107 case GPIO_INTTYPE_LEVEL:
108 return GPIO_INTTYPE_LEVEL_V2;
109 case GPIO_INT_POLARITY:
110 return GPIO_INT_POLARITY_V2;
112 return GPIO_INTSTATUS_V2;
114 return GPIO_PORTA_EOI_V2;
120 static inline u32 gpio_reg_convert(struct dwapb_gpio *gpio, unsigned int offset)
122 if (gpio->flags & GPIO_REG_OFFSET_V2)
123 return gpio_reg_v2_convert(offset);
128 static inline u32 dwapb_read(struct dwapb_gpio *gpio, unsigned int offset)
130 struct gpio_chip *gc = &gpio->ports[0].gc;
131 void __iomem *reg_base = gpio->regs;
133 return gc->read_reg(reg_base + gpio_reg_convert(gpio, offset));
136 static inline void dwapb_write(struct dwapb_gpio *gpio, unsigned int offset,
139 struct gpio_chip *gc = &gpio->ports[0].gc;
140 void __iomem *reg_base = gpio->regs;
142 gc->write_reg(reg_base + gpio_reg_convert(gpio, offset), val);
145 static int dwapb_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
147 struct dwapb_gpio_port *port = gpiochip_get_data(gc);
148 struct dwapb_gpio *gpio = port->gpio;
150 return irq_find_mapping(gpio->domain, offset);
153 static void dwapb_toggle_trigger(struct dwapb_gpio *gpio, unsigned int offs)
155 u32 v = dwapb_read(gpio, GPIO_INT_POLARITY);
157 if (gpio_get_value(gpio->ports[0].gc.base + offs))
162 dwapb_write(gpio, GPIO_INT_POLARITY, v);
165 static u32 dwapb_do_irq(struct dwapb_gpio *gpio)
167 u32 irq_status = dwapb_read(gpio, GPIO_INTSTATUS);
168 u32 ret = irq_status;
171 int hwirq = fls(irq_status) - 1;
172 int gpio_irq = irq_find_mapping(gpio->domain, hwirq);
174 generic_handle_irq(gpio_irq);
175 irq_status &= ~BIT(hwirq);
177 if ((irq_get_trigger_type(gpio_irq) & IRQ_TYPE_SENSE_MASK)
178 == IRQ_TYPE_EDGE_BOTH)
179 dwapb_toggle_trigger(gpio, hwirq);
185 static void dwapb_irq_handler(struct irq_desc *desc)
187 struct dwapb_gpio *gpio = irq_desc_get_handler_data(desc);
188 struct irq_chip *chip = irq_desc_get_chip(desc);
193 chip->irq_eoi(irq_desc_get_irq_data(desc));
196 static void dwapb_irq_enable(struct irq_data *d)
198 struct irq_chip_generic *igc = irq_data_get_irq_chip_data(d);
199 struct dwapb_gpio *gpio = igc->private;
200 struct gpio_chip *gc = &gpio->ports[0].gc;
204 spin_lock_irqsave(&gc->bgpio_lock, flags);
205 val = dwapb_read(gpio, GPIO_INTEN);
206 val |= BIT(d->hwirq);
207 dwapb_write(gpio, GPIO_INTEN, val);
208 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
211 static void dwapb_irq_disable(struct irq_data *d)
213 struct irq_chip_generic *igc = irq_data_get_irq_chip_data(d);
214 struct dwapb_gpio *gpio = igc->private;
215 struct gpio_chip *gc = &gpio->ports[0].gc;
219 spin_lock_irqsave(&gc->bgpio_lock, flags);
220 val = dwapb_read(gpio, GPIO_INTEN);
221 val &= ~BIT(d->hwirq);
222 dwapb_write(gpio, GPIO_INTEN, val);
223 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
226 static int dwapb_irq_reqres(struct irq_data *d)
228 struct irq_chip_generic *igc = irq_data_get_irq_chip_data(d);
229 struct dwapb_gpio *gpio = igc->private;
230 struct gpio_chip *gc = &gpio->ports[0].gc;
232 if (gpiochip_lock_as_irq(gc, irqd_to_hwirq(d))) {
233 dev_err(gpio->dev, "unable to lock HW IRQ %lu for IRQ\n",
240 static void dwapb_irq_relres(struct irq_data *d)
242 struct irq_chip_generic *igc = irq_data_get_irq_chip_data(d);
243 struct dwapb_gpio *gpio = igc->private;
244 struct gpio_chip *gc = &gpio->ports[0].gc;
246 gpiochip_unlock_as_irq(gc, irqd_to_hwirq(d));
249 static int dwapb_irq_set_type(struct irq_data *d, u32 type)
251 struct irq_chip_generic *igc = irq_data_get_irq_chip_data(d);
252 struct dwapb_gpio *gpio = igc->private;
253 struct gpio_chip *gc = &gpio->ports[0].gc;
255 unsigned long level, polarity, flags;
257 if (type & ~(IRQ_TYPE_EDGE_RISING | IRQ_TYPE_EDGE_FALLING |
258 IRQ_TYPE_LEVEL_HIGH | IRQ_TYPE_LEVEL_LOW))
261 spin_lock_irqsave(&gc->bgpio_lock, flags);
262 level = dwapb_read(gpio, GPIO_INTTYPE_LEVEL);
263 polarity = dwapb_read(gpio, GPIO_INT_POLARITY);
266 case IRQ_TYPE_EDGE_BOTH:
268 dwapb_toggle_trigger(gpio, bit);
270 case IRQ_TYPE_EDGE_RISING:
272 polarity |= BIT(bit);
274 case IRQ_TYPE_EDGE_FALLING:
276 polarity &= ~BIT(bit);
278 case IRQ_TYPE_LEVEL_HIGH:
280 polarity |= BIT(bit);
282 case IRQ_TYPE_LEVEL_LOW:
284 polarity &= ~BIT(bit);
288 irq_setup_alt_chip(d, type);
290 dwapb_write(gpio, GPIO_INTTYPE_LEVEL, level);
291 dwapb_write(gpio, GPIO_INT_POLARITY, polarity);
292 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
297 static int dwapb_gpio_set_debounce(struct gpio_chip *gc,
298 unsigned offset, unsigned debounce)
300 struct dwapb_gpio_port *port = gpiochip_get_data(gc);
301 struct dwapb_gpio *gpio = port->gpio;
302 unsigned long flags, val_deb;
303 unsigned long mask = gc->pin2mask(gc, offset);
305 spin_lock_irqsave(&gc->bgpio_lock, flags);
307 val_deb = dwapb_read(gpio, GPIO_PORTA_DEBOUNCE);
309 dwapb_write(gpio, GPIO_PORTA_DEBOUNCE, val_deb | mask);
311 dwapb_write(gpio, GPIO_PORTA_DEBOUNCE, val_deb & ~mask);
313 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
318 static int dwapb_gpio_set_config(struct gpio_chip *gc, unsigned offset,
319 unsigned long config)
323 if (pinconf_to_config_param(config) != PIN_CONFIG_INPUT_DEBOUNCE)
326 debounce = pinconf_to_config_argument(config);
327 return dwapb_gpio_set_debounce(gc, offset, debounce);
330 static irqreturn_t dwapb_irq_handler_mfd(int irq, void *dev_id)
333 struct dwapb_gpio *gpio = dev_id;
335 worked = dwapb_do_irq(gpio);
337 return worked ? IRQ_HANDLED : IRQ_NONE;
340 static void dwapb_configure_irqs(struct dwapb_gpio *gpio,
341 struct dwapb_gpio_port *port,
342 struct dwapb_port_property *pp)
344 struct gpio_chip *gc = &port->gc;
345 struct fwnode_handle *fwnode = pp->fwnode;
346 struct irq_chip_generic *irq_gc = NULL;
347 unsigned int hwirq, ngpio = gc->ngpio;
348 struct irq_chip_type *ct;
351 gpio->domain = irq_domain_create_linear(fwnode, ngpio,
352 &irq_generic_chip_ops, gpio);
356 err = irq_alloc_domain_generic_chips(gpio->domain, ngpio, 2,
357 "gpio-dwapb", handle_level_irq,
359 IRQ_GC_INIT_NESTED_LOCK);
361 dev_info(gpio->dev, "irq_alloc_domain_generic_chips failed\n");
362 irq_domain_remove(gpio->domain);
367 irq_gc = irq_get_domain_generic_chip(gpio->domain, 0);
369 irq_domain_remove(gpio->domain);
374 irq_gc->reg_base = gpio->regs;
375 irq_gc->private = gpio;
377 for (i = 0; i < 2; i++) {
378 ct = &irq_gc->chip_types[i];
379 ct->chip.irq_ack = irq_gc_ack_set_bit;
380 ct->chip.irq_mask = irq_gc_mask_set_bit;
381 ct->chip.irq_unmask = irq_gc_mask_clr_bit;
382 ct->chip.irq_set_type = dwapb_irq_set_type;
383 ct->chip.irq_enable = dwapb_irq_enable;
384 ct->chip.irq_disable = dwapb_irq_disable;
385 ct->chip.irq_request_resources = dwapb_irq_reqres;
386 ct->chip.irq_release_resources = dwapb_irq_relres;
387 ct->regs.ack = gpio_reg_convert(gpio, GPIO_PORTA_EOI);
388 ct->regs.mask = gpio_reg_convert(gpio, GPIO_INTMASK);
389 ct->type = IRQ_TYPE_LEVEL_MASK;
392 irq_gc->chip_types[0].type = IRQ_TYPE_LEVEL_MASK;
393 irq_gc->chip_types[1].type = IRQ_TYPE_EDGE_BOTH;
394 irq_gc->chip_types[1].handler = handle_edge_irq;
396 if (!pp->irq_shared) {
397 irq_set_chained_handler_and_data(pp->irq, dwapb_irq_handler,
401 * Request a shared IRQ since where MFD would have devices
402 * using the same irq pin
404 err = devm_request_irq(gpio->dev, pp->irq,
405 dwapb_irq_handler_mfd,
406 IRQF_SHARED, "gpio-dwapb-mfd", gpio);
408 dev_err(gpio->dev, "error requesting IRQ\n");
409 irq_domain_remove(gpio->domain);
415 for (hwirq = 0 ; hwirq < ngpio ; hwirq++)
416 irq_create_mapping(gpio->domain, hwirq);
418 port->gc.to_irq = dwapb_gpio_to_irq;
421 static void dwapb_irq_teardown(struct dwapb_gpio *gpio)
423 struct dwapb_gpio_port *port = &gpio->ports[0];
424 struct gpio_chip *gc = &port->gc;
425 unsigned int ngpio = gc->ngpio;
426 irq_hw_number_t hwirq;
431 for (hwirq = 0 ; hwirq < ngpio ; hwirq++)
432 irq_dispose_mapping(irq_find_mapping(gpio->domain, hwirq));
434 irq_domain_remove(gpio->domain);
438 static int dwapb_gpio_add_port(struct dwapb_gpio *gpio,
439 struct dwapb_port_property *pp,
442 struct dwapb_gpio_port *port;
443 void __iomem *dat, *set, *dirout;
446 port = &gpio->ports[offs];
450 #ifdef CONFIG_PM_SLEEP
451 port->ctx = devm_kzalloc(gpio->dev, sizeof(*port->ctx), GFP_KERNEL);
456 dat = gpio->regs + GPIO_EXT_PORTA + (pp->idx * GPIO_EXT_PORT_SIZE);
457 set = gpio->regs + GPIO_SWPORTA_DR + (pp->idx * GPIO_SWPORT_DR_SIZE);
458 dirout = gpio->regs + GPIO_SWPORTA_DDR +
459 (pp->idx * GPIO_SWPORT_DDR_SIZE);
461 err = bgpio_init(&port->gc, gpio->dev, 4, dat, set, NULL, dirout,
464 dev_err(gpio->dev, "failed to init gpio chip for port%d\n",
469 #ifdef CONFIG_OF_GPIO
470 port->gc.of_node = to_of_node(pp->fwnode);
472 port->gc.ngpio = pp->ngpio;
473 port->gc.base = pp->gpio_base;
475 /* Only port A support debounce */
477 port->gc.set_config = dwapb_gpio_set_config;
480 dwapb_configure_irqs(gpio, port, pp);
482 err = gpiochip_add_data(&port->gc, port);
484 dev_err(gpio->dev, "failed to register gpiochip for port%d\n",
487 port->is_registered = true;
489 /* Add GPIO-signaled ACPI event support */
491 acpi_gpiochip_request_interrupts(&port->gc);
496 static void dwapb_gpio_unregister(struct dwapb_gpio *gpio)
500 for (m = 0; m < gpio->nr_ports; ++m)
501 if (gpio->ports[m].is_registered)
502 gpiochip_remove(&gpio->ports[m].gc);
505 static struct dwapb_platform_data *
506 dwapb_gpio_get_pdata(struct device *dev)
508 struct fwnode_handle *fwnode;
509 struct dwapb_platform_data *pdata;
510 struct dwapb_port_property *pp;
514 nports = device_get_child_node_count(dev);
516 return ERR_PTR(-ENODEV);
518 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
520 return ERR_PTR(-ENOMEM);
522 pdata->properties = devm_kcalloc(dev, nports, sizeof(*pp), GFP_KERNEL);
523 if (!pdata->properties)
524 return ERR_PTR(-ENOMEM);
526 pdata->nports = nports;
529 device_for_each_child_node(dev, fwnode) {
530 pp = &pdata->properties[i++];
533 if (fwnode_property_read_u32(fwnode, "reg", &pp->idx) ||
534 pp->idx >= DWAPB_MAX_PORTS) {
536 "missing/invalid port index for port%d\n", i);
537 fwnode_handle_put(fwnode);
538 return ERR_PTR(-EINVAL);
541 if (fwnode_property_read_u32(fwnode, "snps,nr-gpios",
544 "failed to get number of gpios for port%d\n",
550 * Only port A can provide interrupts in all configurations of
553 if (dev->of_node && pp->idx == 0 &&
554 fwnode_property_read_bool(fwnode,
555 "interrupt-controller")) {
556 pp->irq = irq_of_parse_and_map(to_of_node(fwnode), 0);
558 dev_warn(dev, "no irq for port%d\n", pp->idx);
561 if (has_acpi_companion(dev) && pp->idx == 0)
562 pp->irq = platform_get_irq(to_platform_device(dev), 0);
564 pp->irq_shared = false;
571 static const struct of_device_id dwapb_of_match[] = {
572 { .compatible = "snps,dw-apb-gpio", .data = (void *)0},
573 { .compatible = "apm,xgene-gpio-v2", .data = (void *)GPIO_REG_OFFSET_V2},
576 MODULE_DEVICE_TABLE(of, dwapb_of_match);
578 static const struct acpi_device_id dwapb_acpi_match[] = {
581 {"APMC0D81", GPIO_REG_OFFSET_V2},
584 MODULE_DEVICE_TABLE(acpi, dwapb_acpi_match);
586 static int dwapb_gpio_probe(struct platform_device *pdev)
589 struct resource *res;
590 struct dwapb_gpio *gpio;
592 struct device *dev = &pdev->dev;
593 struct dwapb_platform_data *pdata = dev_get_platdata(dev);
596 pdata = dwapb_gpio_get_pdata(dev);
598 return PTR_ERR(pdata);
604 gpio = devm_kzalloc(&pdev->dev, sizeof(*gpio), GFP_KERNEL);
608 gpio->dev = &pdev->dev;
609 gpio->nr_ports = pdata->nports;
611 gpio->ports = devm_kcalloc(&pdev->dev, gpio->nr_ports,
612 sizeof(*gpio->ports), GFP_KERNEL);
616 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
617 gpio->regs = devm_ioremap_resource(&pdev->dev, res);
618 if (IS_ERR(gpio->regs))
619 return PTR_ERR(gpio->regs);
623 const struct of_device_id *of_devid;
625 of_devid = of_match_device(dwapb_of_match, dev);
628 gpio->flags = (uintptr_t)of_devid->data;
630 } else if (has_acpi_companion(dev)) {
631 const struct acpi_device_id *acpi_id;
633 acpi_id = acpi_match_device(dwapb_acpi_match, dev);
635 if (acpi_id->driver_data)
636 gpio->flags = acpi_id->driver_data;
640 for (i = 0; i < gpio->nr_ports; i++) {
641 err = dwapb_gpio_add_port(gpio, &pdata->properties[i], i);
645 platform_set_drvdata(pdev, gpio);
650 dwapb_gpio_unregister(gpio);
651 dwapb_irq_teardown(gpio);
656 static int dwapb_gpio_remove(struct platform_device *pdev)
658 struct dwapb_gpio *gpio = platform_get_drvdata(pdev);
660 dwapb_gpio_unregister(gpio);
661 dwapb_irq_teardown(gpio);
666 #ifdef CONFIG_PM_SLEEP
667 static int dwapb_gpio_suspend(struct device *dev)
669 struct platform_device *pdev = to_platform_device(dev);
670 struct dwapb_gpio *gpio = platform_get_drvdata(pdev);
671 struct gpio_chip *gc = &gpio->ports[0].gc;
675 spin_lock_irqsave(&gc->bgpio_lock, flags);
676 for (i = 0; i < gpio->nr_ports; i++) {
678 unsigned int idx = gpio->ports[i].idx;
679 struct dwapb_context *ctx = gpio->ports[i].ctx;
683 offset = GPIO_SWPORTA_DDR + idx * GPIO_SWPORT_DDR_SIZE;
684 ctx->dir = dwapb_read(gpio, offset);
686 offset = GPIO_SWPORTA_DR + idx * GPIO_SWPORT_DR_SIZE;
687 ctx->data = dwapb_read(gpio, offset);
689 offset = GPIO_EXT_PORTA + idx * GPIO_EXT_PORT_SIZE;
690 ctx->ext = dwapb_read(gpio, offset);
692 /* Only port A can provide interrupts */
694 ctx->int_mask = dwapb_read(gpio, GPIO_INTMASK);
695 ctx->int_en = dwapb_read(gpio, GPIO_INTEN);
696 ctx->int_pol = dwapb_read(gpio, GPIO_INT_POLARITY);
697 ctx->int_type = dwapb_read(gpio, GPIO_INTTYPE_LEVEL);
698 ctx->int_deb = dwapb_read(gpio, GPIO_PORTA_DEBOUNCE);
700 /* Mask out interrupts */
701 dwapb_write(gpio, GPIO_INTMASK, 0xffffffff);
704 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
709 static int dwapb_gpio_resume(struct device *dev)
711 struct platform_device *pdev = to_platform_device(dev);
712 struct dwapb_gpio *gpio = platform_get_drvdata(pdev);
713 struct gpio_chip *gc = &gpio->ports[0].gc;
717 spin_lock_irqsave(&gc->bgpio_lock, flags);
718 for (i = 0; i < gpio->nr_ports; i++) {
720 unsigned int idx = gpio->ports[i].idx;
721 struct dwapb_context *ctx = gpio->ports[i].ctx;
725 offset = GPIO_SWPORTA_DR + idx * GPIO_SWPORT_DR_SIZE;
726 dwapb_write(gpio, offset, ctx->data);
728 offset = GPIO_SWPORTA_DDR + idx * GPIO_SWPORT_DDR_SIZE;
729 dwapb_write(gpio, offset, ctx->dir);
731 offset = GPIO_EXT_PORTA + idx * GPIO_EXT_PORT_SIZE;
732 dwapb_write(gpio, offset, ctx->ext);
734 /* Only port A can provide interrupts */
736 dwapb_write(gpio, GPIO_INTTYPE_LEVEL, ctx->int_type);
737 dwapb_write(gpio, GPIO_INT_POLARITY, ctx->int_pol);
738 dwapb_write(gpio, GPIO_PORTA_DEBOUNCE, ctx->int_deb);
739 dwapb_write(gpio, GPIO_INTEN, ctx->int_en);
740 dwapb_write(gpio, GPIO_INTMASK, ctx->int_mask);
742 /* Clear out spurious interrupts */
743 dwapb_write(gpio, GPIO_PORTA_EOI, 0xffffffff);
746 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
752 static SIMPLE_DEV_PM_OPS(dwapb_gpio_pm_ops, dwapb_gpio_suspend,
755 static struct platform_driver dwapb_gpio_driver = {
757 .name = "gpio-dwapb",
758 .pm = &dwapb_gpio_pm_ops,
759 .of_match_table = of_match_ptr(dwapb_of_match),
760 .acpi_match_table = ACPI_PTR(dwapb_acpi_match),
762 .probe = dwapb_gpio_probe,
763 .remove = dwapb_gpio_remove,
766 module_platform_driver(dwapb_gpio_driver);
768 MODULE_LICENSE("GPL");
769 MODULE_AUTHOR("Jamie Iles");
770 MODULE_DESCRIPTION("Synopsys DesignWare APB GPIO driver");