Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (c) 2011 Jamie Iles
4 *
5 * All enquiries to support@picochip.com
6 */
7#include <linux/acpi.h>
8#include <linux/clk.h>
9#include <linux/err.h>
10#include <linux/gpio/driver.h>
11#include <linux/init.h>
12#include <linux/interrupt.h>
13#include <linux/io.h>
14#include <linux/ioport.h>
15#include <linux/irq.h>
16#include <linux/mod_devicetable.h>
17#include <linux/module.h>
18#include <linux/platform_device.h>
19#include <linux/property.h>
20#include <linux/reset.h>
21#include <linux/slab.h>
22#include <linux/spinlock.h>
23
24#include "gpiolib-acpi.h"
25
26#define GPIO_SWPORTA_DR 0x00
27#define GPIO_SWPORTA_DDR 0x04
28#define GPIO_SWPORTB_DR 0x0c
29#define GPIO_SWPORTB_DDR 0x10
30#define GPIO_SWPORTC_DR 0x18
31#define GPIO_SWPORTC_DDR 0x1c
32#define GPIO_SWPORTD_DR 0x24
33#define GPIO_SWPORTD_DDR 0x28
34#define GPIO_INTEN 0x30
35#define GPIO_INTMASK 0x34
36#define GPIO_INTTYPE_LEVEL 0x38
37#define GPIO_INT_POLARITY 0x3c
38#define GPIO_INTSTATUS 0x40
39#define GPIO_PORTA_DEBOUNCE 0x48
40#define GPIO_PORTA_EOI 0x4c
41#define GPIO_EXT_PORTA 0x50
42#define GPIO_EXT_PORTB 0x54
43#define GPIO_EXT_PORTC 0x58
44#define GPIO_EXT_PORTD 0x5c
45
46#define DWAPB_DRIVER_NAME "gpio-dwapb"
47#define DWAPB_MAX_PORTS 4
48#define DWAPB_MAX_GPIOS 32
49
50#define GPIO_EXT_PORT_STRIDE 0x04 /* register stride 32 bits */
51#define GPIO_SWPORT_DR_STRIDE 0x0c /* register stride 3*32 bits */
52#define GPIO_SWPORT_DDR_STRIDE 0x0c /* register stride 3*32 bits */
53
54#define GPIO_REG_OFFSET_V1 0
55#define GPIO_REG_OFFSET_V2 1
56#define GPIO_REG_OFFSET_MASK BIT(0)
57
58#define GPIO_INTMASK_V2 0x44
59#define GPIO_INTTYPE_LEVEL_V2 0x34
60#define GPIO_INT_POLARITY_V2 0x38
61#define GPIO_INTSTATUS_V2 0x3c
62#define GPIO_PORTA_EOI_V2 0x40
63
64#define DWAPB_NR_CLOCKS 2
65
66struct dwapb_gpio;
67
68struct dwapb_port_property {
69 struct fwnode_handle *fwnode;
70 unsigned int idx;
71 unsigned int ngpio;
72 unsigned int gpio_base;
73 int irq[DWAPB_MAX_GPIOS];
74};
75
76struct dwapb_platform_data {
77 struct dwapb_port_property *properties;
78 unsigned int nports;
79};
80
81#ifdef CONFIG_PM_SLEEP
82/* Store GPIO context across system-wide suspend/resume transitions */
83struct dwapb_context {
84 u32 data;
85 u32 dir;
86 u32 ext;
87 u32 int_en;
88 u32 int_mask;
89 u32 int_type;
90 u32 int_pol;
91 u32 int_deb;
92 u32 wake_en;
93};
94#endif
95
96struct dwapb_gpio_port_irqchip {
97 unsigned int nr_irqs;
98 unsigned int irq[DWAPB_MAX_GPIOS];
99};
100
101struct dwapb_gpio_port {
102 struct gpio_chip gc;
103 struct dwapb_gpio_port_irqchip *pirq;
104 struct dwapb_gpio *gpio;
105#ifdef CONFIG_PM_SLEEP
106 struct dwapb_context *ctx;
107#endif
108 unsigned int idx;
109};
110#define to_dwapb_gpio(_gc) \
111 (container_of(_gc, struct dwapb_gpio_port, gc)->gpio)
112
113struct dwapb_gpio {
114 struct device *dev;
115 void __iomem *regs;
116 struct dwapb_gpio_port *ports;
117 unsigned int nr_ports;
118 unsigned int flags;
119 struct reset_control *rst;
120 struct clk_bulk_data clks[DWAPB_NR_CLOCKS];
121};
122
123static inline u32 gpio_reg_v2_convert(unsigned int offset)
124{
125 switch (offset) {
126 case GPIO_INTMASK:
127 return GPIO_INTMASK_V2;
128 case GPIO_INTTYPE_LEVEL:
129 return GPIO_INTTYPE_LEVEL_V2;
130 case GPIO_INT_POLARITY:
131 return GPIO_INT_POLARITY_V2;
132 case GPIO_INTSTATUS:
133 return GPIO_INTSTATUS_V2;
134 case GPIO_PORTA_EOI:
135 return GPIO_PORTA_EOI_V2;
136 }
137
138 return offset;
139}
140
141static inline u32 gpio_reg_convert(struct dwapb_gpio *gpio, unsigned int offset)
142{
143 if ((gpio->flags & GPIO_REG_OFFSET_MASK) == GPIO_REG_OFFSET_V2)
144 return gpio_reg_v2_convert(offset);
145
146 return offset;
147}
148
149static inline u32 dwapb_read(struct dwapb_gpio *gpio, unsigned int offset)
150{
151 struct gpio_chip *gc = &gpio->ports[0].gc;
152 void __iomem *reg_base = gpio->regs;
153
154 return gc->read_reg(reg_base + gpio_reg_convert(gpio, offset));
155}
156
157static inline void dwapb_write(struct dwapb_gpio *gpio, unsigned int offset,
158 u32 val)
159{
160 struct gpio_chip *gc = &gpio->ports[0].gc;
161 void __iomem *reg_base = gpio->regs;
162
163 gc->write_reg(reg_base + gpio_reg_convert(gpio, offset), val);
164}
165
166static struct dwapb_gpio_port *dwapb_offs_to_port(struct dwapb_gpio *gpio, unsigned int offs)
167{
168 struct dwapb_gpio_port *port;
169 int i;
170
171 for (i = 0; i < gpio->nr_ports; i++) {
172 port = &gpio->ports[i];
173 if (port->idx == offs / DWAPB_MAX_GPIOS)
174 return port;
175 }
176
177 return NULL;
178}
179
180static void dwapb_toggle_trigger(struct dwapb_gpio *gpio, unsigned int offs)
181{
182 struct dwapb_gpio_port *port = dwapb_offs_to_port(gpio, offs);
183 struct gpio_chip *gc;
184 u32 pol;
185 int val;
186
187 if (!port)
188 return;
189 gc = &port->gc;
190
191 pol = dwapb_read(gpio, GPIO_INT_POLARITY);
192 /* Just read the current value right out of the data register */
193 val = gc->get(gc, offs % DWAPB_MAX_GPIOS);
194 if (val)
195 pol &= ~BIT(offs);
196 else
197 pol |= BIT(offs);
198
199 dwapb_write(gpio, GPIO_INT_POLARITY, pol);
200}
201
202static u32 dwapb_do_irq(struct dwapb_gpio *gpio)
203{
204 struct gpio_chip *gc = &gpio->ports[0].gc;
205 unsigned long irq_status;
206 irq_hw_number_t hwirq;
207
208 irq_status = dwapb_read(gpio, GPIO_INTSTATUS);
209 for_each_set_bit(hwirq, &irq_status, DWAPB_MAX_GPIOS) {
210 int gpio_irq = irq_find_mapping(gc->irq.domain, hwirq);
211 u32 irq_type = irq_get_trigger_type(gpio_irq);
212
213 generic_handle_irq(gpio_irq);
214
215 if ((irq_type & IRQ_TYPE_SENSE_MASK) == IRQ_TYPE_EDGE_BOTH)
216 dwapb_toggle_trigger(gpio, hwirq);
217 }
218
219 return irq_status;
220}
221
222static void dwapb_irq_handler(struct irq_desc *desc)
223{
224 struct dwapb_gpio *gpio = irq_desc_get_handler_data(desc);
225 struct irq_chip *chip = irq_desc_get_chip(desc);
226
227 chained_irq_enter(chip, desc);
228 dwapb_do_irq(gpio);
229 chained_irq_exit(chip, desc);
230}
231
232static irqreturn_t dwapb_irq_handler_mfd(int irq, void *dev_id)
233{
234 return IRQ_RETVAL(dwapb_do_irq(dev_id));
235}
236
237static void dwapb_irq_ack(struct irq_data *d)
238{
239 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
240 struct dwapb_gpio *gpio = to_dwapb_gpio(gc);
241 u32 val = BIT(irqd_to_hwirq(d));
242 unsigned long flags;
243
244 raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
245 dwapb_write(gpio, GPIO_PORTA_EOI, val);
246 raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
247}
248
249static void dwapb_irq_mask(struct irq_data *d)
250{
251 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
252 struct dwapb_gpio *gpio = to_dwapb_gpio(gc);
253 irq_hw_number_t hwirq = irqd_to_hwirq(d);
254 unsigned long flags;
255 u32 val;
256
257 raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
258 val = dwapb_read(gpio, GPIO_INTMASK) | BIT(hwirq);
259 dwapb_write(gpio, GPIO_INTMASK, val);
260 raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
261
262 gpiochip_disable_irq(gc, hwirq);
263}
264
265static void dwapb_irq_unmask(struct irq_data *d)
266{
267 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
268 struct dwapb_gpio *gpio = to_dwapb_gpio(gc);
269 irq_hw_number_t hwirq = irqd_to_hwirq(d);
270 unsigned long flags;
271 u32 val;
272
273 gpiochip_enable_irq(gc, hwirq);
274
275 raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
276 val = dwapb_read(gpio, GPIO_INTMASK) & ~BIT(hwirq);
277 dwapb_write(gpio, GPIO_INTMASK, val);
278 raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
279}
280
281static void dwapb_irq_enable(struct irq_data *d)
282{
283 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
284 struct dwapb_gpio *gpio = to_dwapb_gpio(gc);
285 irq_hw_number_t hwirq = irqd_to_hwirq(d);
286 unsigned long flags;
287 u32 val;
288
289 raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
290 val = dwapb_read(gpio, GPIO_INTEN) | BIT(hwirq);
291 dwapb_write(gpio, GPIO_INTEN, val);
292 val = dwapb_read(gpio, GPIO_INTMASK) & ~BIT(hwirq);
293 dwapb_write(gpio, GPIO_INTMASK, val);
294 raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
295}
296
297static void dwapb_irq_disable(struct irq_data *d)
298{
299 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
300 struct dwapb_gpio *gpio = to_dwapb_gpio(gc);
301 irq_hw_number_t hwirq = irqd_to_hwirq(d);
302 unsigned long flags;
303 u32 val;
304
305 raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
306 val = dwapb_read(gpio, GPIO_INTMASK) | BIT(hwirq);
307 dwapb_write(gpio, GPIO_INTMASK, val);
308 val = dwapb_read(gpio, GPIO_INTEN) & ~BIT(hwirq);
309 dwapb_write(gpio, GPIO_INTEN, val);
310 raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
311}
312
313static int dwapb_irq_set_type(struct irq_data *d, u32 type)
314{
315 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
316 struct dwapb_gpio *gpio = to_dwapb_gpio(gc);
317 irq_hw_number_t bit = irqd_to_hwirq(d);
318 unsigned long level, polarity, flags;
319
320 raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
321 level = dwapb_read(gpio, GPIO_INTTYPE_LEVEL);
322 polarity = dwapb_read(gpio, GPIO_INT_POLARITY);
323
324 switch (type) {
325 case IRQ_TYPE_EDGE_BOTH:
326 level |= BIT(bit);
327 dwapb_toggle_trigger(gpio, bit);
328 break;
329 case IRQ_TYPE_EDGE_RISING:
330 level |= BIT(bit);
331 polarity |= BIT(bit);
332 break;
333 case IRQ_TYPE_EDGE_FALLING:
334 level |= BIT(bit);
335 polarity &= ~BIT(bit);
336 break;
337 case IRQ_TYPE_LEVEL_HIGH:
338 level &= ~BIT(bit);
339 polarity |= BIT(bit);
340 break;
341 case IRQ_TYPE_LEVEL_LOW:
342 level &= ~BIT(bit);
343 polarity &= ~BIT(bit);
344 break;
345 }
346
347 if (type & IRQ_TYPE_LEVEL_MASK)
348 irq_set_handler_locked(d, handle_level_irq);
349 else if (type & IRQ_TYPE_EDGE_BOTH)
350 irq_set_handler_locked(d, handle_edge_irq);
351
352 dwapb_write(gpio, GPIO_INTTYPE_LEVEL, level);
353 if (type != IRQ_TYPE_EDGE_BOTH)
354 dwapb_write(gpio, GPIO_INT_POLARITY, polarity);
355 raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
356
357 return 0;
358}
359
360#ifdef CONFIG_PM_SLEEP
361static int dwapb_irq_set_wake(struct irq_data *d, unsigned int enable)
362{
363 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
364 struct dwapb_gpio *gpio = to_dwapb_gpio(gc);
365 struct dwapb_context *ctx = gpio->ports[0].ctx;
366 irq_hw_number_t bit = irqd_to_hwirq(d);
367
368 if (enable)
369 ctx->wake_en |= BIT(bit);
370 else
371 ctx->wake_en &= ~BIT(bit);
372
373 return 0;
374}
375#else
376#define dwapb_irq_set_wake NULL
377#endif
378
379static const struct irq_chip dwapb_irq_chip = {
380 .name = DWAPB_DRIVER_NAME,
381 .irq_ack = dwapb_irq_ack,
382 .irq_mask = dwapb_irq_mask,
383 .irq_unmask = dwapb_irq_unmask,
384 .irq_set_type = dwapb_irq_set_type,
385 .irq_enable = dwapb_irq_enable,
386 .irq_disable = dwapb_irq_disable,
387 .irq_set_wake = dwapb_irq_set_wake,
388 .flags = IRQCHIP_IMMUTABLE,
389 GPIOCHIP_IRQ_RESOURCE_HELPERS,
390};
391
392static int dwapb_gpio_set_debounce(struct gpio_chip *gc,
393 unsigned offset, unsigned debounce)
394{
395 struct dwapb_gpio_port *port = gpiochip_get_data(gc);
396 struct dwapb_gpio *gpio = port->gpio;
397 unsigned long flags, val_deb;
398 unsigned long mask = BIT(offset);
399
400 raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
401
402 val_deb = dwapb_read(gpio, GPIO_PORTA_DEBOUNCE);
403 if (debounce)
404 val_deb |= mask;
405 else
406 val_deb &= ~mask;
407 dwapb_write(gpio, GPIO_PORTA_DEBOUNCE, val_deb);
408
409 raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
410
411 return 0;
412}
413
414static int dwapb_gpio_set_config(struct gpio_chip *gc, unsigned offset,
415 unsigned long config)
416{
417 u32 debounce;
418
419 if (pinconf_to_config_param(config) == PIN_CONFIG_INPUT_DEBOUNCE) {
420 debounce = pinconf_to_config_argument(config);
421 return dwapb_gpio_set_debounce(gc, offset, debounce);
422 }
423
424 return gpiochip_generic_config(gc, offset, config);
425}
426
427static int dwapb_convert_irqs(struct dwapb_gpio_port_irqchip *pirq,
428 struct dwapb_port_property *pp)
429{
430 int i;
431
432 /* Group all available IRQs into an array of parental IRQs. */
433 for (i = 0; i < pp->ngpio; ++i) {
434 if (!pp->irq[i])
435 continue;
436
437 pirq->irq[pirq->nr_irqs++] = pp->irq[i];
438 }
439
440 return pirq->nr_irqs ? 0 : -ENOENT;
441}
442
443static void dwapb_configure_irqs(struct dwapb_gpio *gpio,
444 struct dwapb_gpio_port *port,
445 struct dwapb_port_property *pp)
446{
447 struct dwapb_gpio_port_irqchip *pirq;
448 struct gpio_chip *gc = &port->gc;
449 struct gpio_irq_chip *girq;
450 int err;
451
452 pirq = devm_kzalloc(gpio->dev, sizeof(*pirq), GFP_KERNEL);
453 if (!pirq)
454 return;
455
456 if (dwapb_convert_irqs(pirq, pp)) {
457 dev_warn(gpio->dev, "no IRQ for port%d\n", pp->idx);
458 goto err_kfree_pirq;
459 }
460
461 girq = &gc->irq;
462 girq->handler = handle_bad_irq;
463 girq->default_type = IRQ_TYPE_NONE;
464
465 port->pirq = pirq;
466
467 /*
468 * Intel ACPI-based platforms mostly have the DesignWare APB GPIO
469 * IRQ lane shared between several devices. In that case the parental
470 * IRQ has to be handled in the shared way so to be properly delivered
471 * to all the connected devices.
472 */
473 if (has_acpi_companion(gpio->dev)) {
474 girq->num_parents = 0;
475 girq->parents = NULL;
476 girq->parent_handler = NULL;
477
478 err = devm_request_irq(gpio->dev, pp->irq[0],
479 dwapb_irq_handler_mfd,
480 IRQF_SHARED, DWAPB_DRIVER_NAME, gpio);
481 if (err) {
482 dev_err(gpio->dev, "error requesting IRQ\n");
483 goto err_kfree_pirq;
484 }
485 } else {
486 girq->num_parents = pirq->nr_irqs;
487 girq->parents = pirq->irq;
488 girq->parent_handler_data = gpio;
489 girq->parent_handler = dwapb_irq_handler;
490 }
491
492 gpio_irq_chip_set_chip(girq, &dwapb_irq_chip);
493
494 return;
495
496err_kfree_pirq:
497 devm_kfree(gpio->dev, pirq);
498}
499
500static int dwapb_gpio_add_port(struct dwapb_gpio *gpio,
501 struct dwapb_port_property *pp,
502 unsigned int offs)
503{
504 struct dwapb_gpio_port *port;
505 void __iomem *dat, *set, *dirout;
506 int err;
507
508 port = &gpio->ports[offs];
509 port->gpio = gpio;
510 port->idx = pp->idx;
511
512#ifdef CONFIG_PM_SLEEP
513 port->ctx = devm_kzalloc(gpio->dev, sizeof(*port->ctx), GFP_KERNEL);
514 if (!port->ctx)
515 return -ENOMEM;
516#endif
517
518 dat = gpio->regs + GPIO_EXT_PORTA + pp->idx * GPIO_EXT_PORT_STRIDE;
519 set = gpio->regs + GPIO_SWPORTA_DR + pp->idx * GPIO_SWPORT_DR_STRIDE;
520 dirout = gpio->regs + GPIO_SWPORTA_DDR + pp->idx * GPIO_SWPORT_DDR_STRIDE;
521
522 /* This registers 32 GPIO lines per port */
523 err = bgpio_init(&port->gc, gpio->dev, 4, dat, set, NULL, dirout,
524 NULL, 0);
525 if (err) {
526 dev_err(gpio->dev, "failed to init gpio chip for port%d\n",
527 port->idx);
528 return err;
529 }
530
531 port->gc.fwnode = pp->fwnode;
532 port->gc.ngpio = pp->ngpio;
533 port->gc.base = pp->gpio_base;
534 port->gc.request = gpiochip_generic_request;
535 port->gc.free = gpiochip_generic_free;
536
537 /* Only port A support debounce */
538 if (pp->idx == 0)
539 port->gc.set_config = dwapb_gpio_set_config;
540 else
541 port->gc.set_config = gpiochip_generic_config;
542
543 /* Only port A can provide interrupts in all configurations of the IP */
544 if (pp->idx == 0)
545 dwapb_configure_irqs(gpio, port, pp);
546
547 err = devm_gpiochip_add_data(gpio->dev, &port->gc, port);
548 if (err) {
549 dev_err(gpio->dev, "failed to register gpiochip for port%d\n",
550 port->idx);
551 return err;
552 }
553
554 return 0;
555}
556
557static void dwapb_get_irq(struct device *dev, struct fwnode_handle *fwnode,
558 struct dwapb_port_property *pp)
559{
560 int irq, j;
561
562 for (j = 0; j < pp->ngpio; j++) {
563 if (has_acpi_companion(dev))
564 irq = platform_get_irq_optional(to_platform_device(dev), j);
565 else
566 irq = fwnode_irq_get(fwnode, j);
567 if (irq > 0)
568 pp->irq[j] = irq;
569 }
570}
571
572static struct dwapb_platform_data *dwapb_gpio_get_pdata(struct device *dev)
573{
574 struct dwapb_platform_data *pdata;
575 struct dwapb_port_property *pp;
576 int nports;
577 int i;
578
579 nports = device_get_child_node_count(dev);
580 if (nports == 0)
581 return ERR_PTR(-ENODEV);
582
583 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
584 if (!pdata)
585 return ERR_PTR(-ENOMEM);
586
587 pdata->properties = devm_kcalloc(dev, nports, sizeof(*pp), GFP_KERNEL);
588 if (!pdata->properties)
589 return ERR_PTR(-ENOMEM);
590
591 pdata->nports = nports;
592
593 i = 0;
594 device_for_each_child_node_scoped(dev, fwnode) {
595 pp = &pdata->properties[i++];
596 pp->fwnode = fwnode;
597
598 if (fwnode_property_read_u32(fwnode, "reg", &pp->idx) ||
599 pp->idx >= DWAPB_MAX_PORTS) {
600 dev_err(dev,
601 "missing/invalid port index for port%d\n", i);
602 return ERR_PTR(-EINVAL);
603 }
604
605 if (fwnode_property_read_u32(fwnode, "ngpios", &pp->ngpio) &&
606 fwnode_property_read_u32(fwnode, "snps,nr-gpios", &pp->ngpio)) {
607 dev_info(dev,
608 "failed to get number of gpios for port%d\n",
609 i);
610 pp->ngpio = DWAPB_MAX_GPIOS;
611 }
612
613 pp->gpio_base = -1;
614
615 /* For internal use only, new platforms mustn't exercise this */
616 if (is_software_node(fwnode))
617 fwnode_property_read_u32(fwnode, "gpio-base", &pp->gpio_base);
618
619 /*
620 * Only port A can provide interrupts in all configurations of
621 * the IP.
622 */
623 if (pp->idx == 0)
624 dwapb_get_irq(dev, fwnode, pp);
625 }
626
627 return pdata;
628}
629
630static void dwapb_assert_reset(void *data)
631{
632 struct dwapb_gpio *gpio = data;
633
634 reset_control_assert(gpio->rst);
635}
636
637static int dwapb_get_reset(struct dwapb_gpio *gpio)
638{
639 int err;
640
641 gpio->rst = devm_reset_control_get_optional_shared(gpio->dev, NULL);
642 if (IS_ERR(gpio->rst))
643 return dev_err_probe(gpio->dev, PTR_ERR(gpio->rst),
644 "Cannot get reset descriptor\n");
645
646 err = reset_control_deassert(gpio->rst);
647 if (err) {
648 dev_err(gpio->dev, "Cannot deassert reset lane\n");
649 return err;
650 }
651
652 return devm_add_action_or_reset(gpio->dev, dwapb_assert_reset, gpio);
653}
654
655static void dwapb_disable_clks(void *data)
656{
657 struct dwapb_gpio *gpio = data;
658
659 clk_bulk_disable_unprepare(DWAPB_NR_CLOCKS, gpio->clks);
660}
661
662static int dwapb_get_clks(struct dwapb_gpio *gpio)
663{
664 int err;
665
666 /* Optional bus and debounce clocks */
667 gpio->clks[0].id = "bus";
668 gpio->clks[1].id = "db";
669 err = devm_clk_bulk_get_optional(gpio->dev, DWAPB_NR_CLOCKS,
670 gpio->clks);
671 if (err)
672 return dev_err_probe(gpio->dev, err,
673 "Cannot get APB/Debounce clocks\n");
674
675 err = clk_bulk_prepare_enable(DWAPB_NR_CLOCKS, gpio->clks);
676 if (err) {
677 dev_err(gpio->dev, "Cannot enable APB/Debounce clocks\n");
678 return err;
679 }
680
681 return devm_add_action_or_reset(gpio->dev, dwapb_disable_clks, gpio);
682}
683
684static const struct of_device_id dwapb_of_match[] = {
685 { .compatible = "snps,dw-apb-gpio", .data = (void *)GPIO_REG_OFFSET_V1},
686 { .compatible = "apm,xgene-gpio-v2", .data = (void *)GPIO_REG_OFFSET_V2},
687 { /* Sentinel */ }
688};
689MODULE_DEVICE_TABLE(of, dwapb_of_match);
690
691static const struct acpi_device_id dwapb_acpi_match[] = {
692 {"HISI0181", GPIO_REG_OFFSET_V1},
693 {"APMC0D07", GPIO_REG_OFFSET_V1},
694 {"APMC0D81", GPIO_REG_OFFSET_V2},
695 {"FUJI200A", GPIO_REG_OFFSET_V1},
696 { }
697};
698MODULE_DEVICE_TABLE(acpi, dwapb_acpi_match);
699
700static int dwapb_gpio_probe(struct platform_device *pdev)
701{
702 unsigned int i;
703 struct dwapb_gpio *gpio;
704 int err;
705 struct dwapb_platform_data *pdata;
706 struct device *dev = &pdev->dev;
707
708 pdata = dwapb_gpio_get_pdata(dev);
709 if (IS_ERR(pdata))
710 return PTR_ERR(pdata);
711
712 gpio = devm_kzalloc(&pdev->dev, sizeof(*gpio), GFP_KERNEL);
713 if (!gpio)
714 return -ENOMEM;
715
716 gpio->dev = &pdev->dev;
717 gpio->nr_ports = pdata->nports;
718
719 err = dwapb_get_reset(gpio);
720 if (err)
721 return err;
722
723 gpio->ports = devm_kcalloc(&pdev->dev, gpio->nr_ports,
724 sizeof(*gpio->ports), GFP_KERNEL);
725 if (!gpio->ports)
726 return -ENOMEM;
727
728 gpio->regs = devm_platform_ioremap_resource(pdev, 0);
729 if (IS_ERR(gpio->regs))
730 return PTR_ERR(gpio->regs);
731
732 err = dwapb_get_clks(gpio);
733 if (err)
734 return err;
735
736 gpio->flags = (uintptr_t)device_get_match_data(dev);
737
738 for (i = 0; i < gpio->nr_ports; i++) {
739 err = dwapb_gpio_add_port(gpio, &pdata->properties[i], i);
740 if (err)
741 return err;
742 }
743
744 platform_set_drvdata(pdev, gpio);
745
746 return 0;
747}
748
749#ifdef CONFIG_PM_SLEEP
750static int dwapb_gpio_suspend(struct device *dev)
751{
752 struct dwapb_gpio *gpio = dev_get_drvdata(dev);
753 struct gpio_chip *gc = &gpio->ports[0].gc;
754 unsigned long flags;
755 int i;
756
757 raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
758 for (i = 0; i < gpio->nr_ports; i++) {
759 unsigned int offset;
760 unsigned int idx = gpio->ports[i].idx;
761 struct dwapb_context *ctx = gpio->ports[i].ctx;
762
763 offset = GPIO_SWPORTA_DDR + idx * GPIO_SWPORT_DDR_STRIDE;
764 ctx->dir = dwapb_read(gpio, offset);
765
766 offset = GPIO_SWPORTA_DR + idx * GPIO_SWPORT_DR_STRIDE;
767 ctx->data = dwapb_read(gpio, offset);
768
769 offset = GPIO_EXT_PORTA + idx * GPIO_EXT_PORT_STRIDE;
770 ctx->ext = dwapb_read(gpio, offset);
771
772 /* Only port A can provide interrupts */
773 if (idx == 0) {
774 ctx->int_mask = dwapb_read(gpio, GPIO_INTMASK);
775 ctx->int_en = dwapb_read(gpio, GPIO_INTEN);
776 ctx->int_pol = dwapb_read(gpio, GPIO_INT_POLARITY);
777 ctx->int_type = dwapb_read(gpio, GPIO_INTTYPE_LEVEL);
778 ctx->int_deb = dwapb_read(gpio, GPIO_PORTA_DEBOUNCE);
779
780 /* Mask out interrupts */
781 dwapb_write(gpio, GPIO_INTMASK, ~ctx->wake_en);
782 }
783 }
784 raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
785
786 clk_bulk_disable_unprepare(DWAPB_NR_CLOCKS, gpio->clks);
787
788 return 0;
789}
790
791static int dwapb_gpio_resume(struct device *dev)
792{
793 struct dwapb_gpio *gpio = dev_get_drvdata(dev);
794 struct gpio_chip *gc = &gpio->ports[0].gc;
795 unsigned long flags;
796 int i, err;
797
798 err = clk_bulk_prepare_enable(DWAPB_NR_CLOCKS, gpio->clks);
799 if (err) {
800 dev_err(gpio->dev, "Cannot reenable APB/Debounce clocks\n");
801 return err;
802 }
803
804 raw_spin_lock_irqsave(&gc->bgpio_lock, flags);
805 for (i = 0; i < gpio->nr_ports; i++) {
806 unsigned int offset;
807 unsigned int idx = gpio->ports[i].idx;
808 struct dwapb_context *ctx = gpio->ports[i].ctx;
809
810 offset = GPIO_SWPORTA_DR + idx * GPIO_SWPORT_DR_STRIDE;
811 dwapb_write(gpio, offset, ctx->data);
812
813 offset = GPIO_SWPORTA_DDR + idx * GPIO_SWPORT_DDR_STRIDE;
814 dwapb_write(gpio, offset, ctx->dir);
815
816 offset = GPIO_EXT_PORTA + idx * GPIO_EXT_PORT_STRIDE;
817 dwapb_write(gpio, offset, ctx->ext);
818
819 /* Only port A can provide interrupts */
820 if (idx == 0) {
821 dwapb_write(gpio, GPIO_INTTYPE_LEVEL, ctx->int_type);
822 dwapb_write(gpio, GPIO_INT_POLARITY, ctx->int_pol);
823 dwapb_write(gpio, GPIO_PORTA_DEBOUNCE, ctx->int_deb);
824 dwapb_write(gpio, GPIO_INTEN, ctx->int_en);
825 dwapb_write(gpio, GPIO_INTMASK, ctx->int_mask);
826
827 /* Clear out spurious interrupts */
828 dwapb_write(gpio, GPIO_PORTA_EOI, 0xffffffff);
829 }
830 }
831 raw_spin_unlock_irqrestore(&gc->bgpio_lock, flags);
832
833 return 0;
834}
835#endif
836
837static SIMPLE_DEV_PM_OPS(dwapb_gpio_pm_ops, dwapb_gpio_suspend,
838 dwapb_gpio_resume);
839
840static struct platform_driver dwapb_gpio_driver = {
841 .driver = {
842 .name = DWAPB_DRIVER_NAME,
843 .pm = &dwapb_gpio_pm_ops,
844 .of_match_table = dwapb_of_match,
845 .acpi_match_table = dwapb_acpi_match,
846 },
847 .probe = dwapb_gpio_probe,
848};
849
850module_platform_driver(dwapb_gpio_driver);
851
852MODULE_LICENSE("GPL");
853MODULE_AUTHOR("Jamie Iles");
854MODULE_DESCRIPTION("Synopsys DesignWare APB GPIO driver");
855MODULE_ALIAS("platform:" DWAPB_DRIVER_NAME);
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (c) 2011 Jamie Iles
4 *
5 * All enquiries to support@picochip.com
6 */
7#include <linux/acpi.h>
8#include <linux/clk.h>
9#include <linux/err.h>
10#include <linux/gpio/driver.h>
11#include <linux/init.h>
12#include <linux/interrupt.h>
13#include <linux/io.h>
14#include <linux/ioport.h>
15#include <linux/irq.h>
16#include <linux/irqdomain.h>
17#include <linux/module.h>
18#include <linux/of.h>
19#include <linux/of_address.h>
20#include <linux/of_device.h>
21#include <linux/of_irq.h>
22#include <linux/platform_device.h>
23#include <linux/property.h>
24#include <linux/reset.h>
25#include <linux/spinlock.h>
26#include <linux/platform_data/gpio-dwapb.h>
27#include <linux/slab.h>
28
29#include "gpiolib.h"
30#include "gpiolib-acpi.h"
31
32#define GPIO_SWPORTA_DR 0x00
33#define GPIO_SWPORTA_DDR 0x04
34#define GPIO_SWPORTB_DR 0x0c
35#define GPIO_SWPORTB_DDR 0x10
36#define GPIO_SWPORTC_DR 0x18
37#define GPIO_SWPORTC_DDR 0x1c
38#define GPIO_SWPORTD_DR 0x24
39#define GPIO_SWPORTD_DDR 0x28
40#define GPIO_INTEN 0x30
41#define GPIO_INTMASK 0x34
42#define GPIO_INTTYPE_LEVEL 0x38
43#define GPIO_INT_POLARITY 0x3c
44#define GPIO_INTSTATUS 0x40
45#define GPIO_PORTA_DEBOUNCE 0x48
46#define GPIO_PORTA_EOI 0x4c
47#define GPIO_EXT_PORTA 0x50
48#define GPIO_EXT_PORTB 0x54
49#define GPIO_EXT_PORTC 0x58
50#define GPIO_EXT_PORTD 0x5c
51
52#define DWAPB_DRIVER_NAME "gpio-dwapb"
53#define DWAPB_MAX_PORTS 4
54
55#define GPIO_EXT_PORT_STRIDE 0x04 /* register stride 32 bits */
56#define GPIO_SWPORT_DR_STRIDE 0x0c /* register stride 3*32 bits */
57#define GPIO_SWPORT_DDR_STRIDE 0x0c /* register stride 3*32 bits */
58
59#define GPIO_REG_OFFSET_V2 1
60
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
66
67#define DWAPB_NR_CLOCKS 2
68
69struct dwapb_gpio;
70
71#ifdef CONFIG_PM_SLEEP
72/* Store GPIO context across system-wide suspend/resume transitions */
73struct dwapb_context {
74 u32 data;
75 u32 dir;
76 u32 ext;
77 u32 int_en;
78 u32 int_mask;
79 u32 int_type;
80 u32 int_pol;
81 u32 int_deb;
82 u32 wake_en;
83};
84#endif
85
86struct dwapb_gpio_port {
87 struct gpio_chip gc;
88 bool is_registered;
89 struct dwapb_gpio *gpio;
90#ifdef CONFIG_PM_SLEEP
91 struct dwapb_context *ctx;
92#endif
93 unsigned int idx;
94};
95
96struct dwapb_gpio {
97 struct device *dev;
98 void __iomem *regs;
99 struct dwapb_gpio_port *ports;
100 unsigned int nr_ports;
101 struct irq_domain *domain;
102 unsigned int flags;
103 struct reset_control *rst;
104 struct clk_bulk_data clks[DWAPB_NR_CLOCKS];
105};
106
107static inline u32 gpio_reg_v2_convert(unsigned int offset)
108{
109 switch (offset) {
110 case GPIO_INTMASK:
111 return GPIO_INTMASK_V2;
112 case GPIO_INTTYPE_LEVEL:
113 return GPIO_INTTYPE_LEVEL_V2;
114 case GPIO_INT_POLARITY:
115 return GPIO_INT_POLARITY_V2;
116 case GPIO_INTSTATUS:
117 return GPIO_INTSTATUS_V2;
118 case GPIO_PORTA_EOI:
119 return GPIO_PORTA_EOI_V2;
120 }
121
122 return offset;
123}
124
125static inline u32 gpio_reg_convert(struct dwapb_gpio *gpio, unsigned int offset)
126{
127 if (gpio->flags & GPIO_REG_OFFSET_V2)
128 return gpio_reg_v2_convert(offset);
129
130 return offset;
131}
132
133static inline u32 dwapb_read(struct dwapb_gpio *gpio, unsigned int offset)
134{
135 struct gpio_chip *gc = &gpio->ports[0].gc;
136 void __iomem *reg_base = gpio->regs;
137
138 return gc->read_reg(reg_base + gpio_reg_convert(gpio, offset));
139}
140
141static inline void dwapb_write(struct dwapb_gpio *gpio, unsigned int offset,
142 u32 val)
143{
144 struct gpio_chip *gc = &gpio->ports[0].gc;
145 void __iomem *reg_base = gpio->regs;
146
147 gc->write_reg(reg_base + gpio_reg_convert(gpio, offset), val);
148}
149
150static int dwapb_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
151{
152 struct dwapb_gpio_port *port = gpiochip_get_data(gc);
153 struct dwapb_gpio *gpio = port->gpio;
154
155 return irq_find_mapping(gpio->domain, offset);
156}
157
158static struct dwapb_gpio_port *dwapb_offs_to_port(struct dwapb_gpio *gpio, unsigned int offs)
159{
160 struct dwapb_gpio_port *port;
161 int i;
162
163 for (i = 0; i < gpio->nr_ports; i++) {
164 port = &gpio->ports[i];
165 if (port->idx == offs / 32)
166 return port;
167 }
168
169 return NULL;
170}
171
172static void dwapb_toggle_trigger(struct dwapb_gpio *gpio, unsigned int offs)
173{
174 struct dwapb_gpio_port *port = dwapb_offs_to_port(gpio, offs);
175 struct gpio_chip *gc;
176 u32 pol;
177 int val;
178
179 if (!port)
180 return;
181 gc = &port->gc;
182
183 pol = dwapb_read(gpio, GPIO_INT_POLARITY);
184 /* Just read the current value right out of the data register */
185 val = gc->get(gc, offs % 32);
186 if (val)
187 pol &= ~BIT(offs);
188 else
189 pol |= BIT(offs);
190
191 dwapb_write(gpio, GPIO_INT_POLARITY, pol);
192}
193
194static u32 dwapb_do_irq(struct dwapb_gpio *gpio)
195{
196 unsigned long irq_status;
197 irq_hw_number_t hwirq;
198
199 irq_status = dwapb_read(gpio, GPIO_INTSTATUS);
200 for_each_set_bit(hwirq, &irq_status, 32) {
201 int gpio_irq = irq_find_mapping(gpio->domain, hwirq);
202 u32 irq_type = irq_get_trigger_type(gpio_irq);
203
204 generic_handle_irq(gpio_irq);
205
206 if ((irq_type & IRQ_TYPE_SENSE_MASK) == IRQ_TYPE_EDGE_BOTH)
207 dwapb_toggle_trigger(gpio, hwirq);
208 }
209
210 return irq_status;
211}
212
213static void dwapb_irq_handler(struct irq_desc *desc)
214{
215 struct dwapb_gpio *gpio = irq_desc_get_handler_data(desc);
216 struct irq_chip *chip = irq_desc_get_chip(desc);
217
218 chained_irq_enter(chip, desc);
219 dwapb_do_irq(gpio);
220 chained_irq_exit(chip, desc);
221}
222
223static void dwapb_irq_enable(struct irq_data *d)
224{
225 struct irq_chip_generic *igc = irq_data_get_irq_chip_data(d);
226 struct dwapb_gpio *gpio = igc->private;
227 struct gpio_chip *gc = &gpio->ports[0].gc;
228 unsigned long flags;
229 u32 val;
230
231 spin_lock_irqsave(&gc->bgpio_lock, flags);
232 val = dwapb_read(gpio, GPIO_INTEN);
233 val |= BIT(irqd_to_hwirq(d));
234 dwapb_write(gpio, GPIO_INTEN, val);
235 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
236}
237
238static void dwapb_irq_disable(struct irq_data *d)
239{
240 struct irq_chip_generic *igc = irq_data_get_irq_chip_data(d);
241 struct dwapb_gpio *gpio = igc->private;
242 struct gpio_chip *gc = &gpio->ports[0].gc;
243 unsigned long flags;
244 u32 val;
245
246 spin_lock_irqsave(&gc->bgpio_lock, flags);
247 val = dwapb_read(gpio, GPIO_INTEN);
248 val &= ~BIT(irqd_to_hwirq(d));
249 dwapb_write(gpio, GPIO_INTEN, val);
250 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
251}
252
253static int dwapb_irq_set_type(struct irq_data *d, u32 type)
254{
255 struct irq_chip_generic *igc = irq_data_get_irq_chip_data(d);
256 struct dwapb_gpio *gpio = igc->private;
257 struct gpio_chip *gc = &gpio->ports[0].gc;
258 irq_hw_number_t bit = irqd_to_hwirq(d);
259 unsigned long level, polarity, flags;
260
261 if (type & ~IRQ_TYPE_SENSE_MASK)
262 return -EINVAL;
263
264 spin_lock_irqsave(&gc->bgpio_lock, flags);
265 level = dwapb_read(gpio, GPIO_INTTYPE_LEVEL);
266 polarity = dwapb_read(gpio, GPIO_INT_POLARITY);
267
268 switch (type) {
269 case IRQ_TYPE_EDGE_BOTH:
270 level |= BIT(bit);
271 dwapb_toggle_trigger(gpio, bit);
272 break;
273 case IRQ_TYPE_EDGE_RISING:
274 level |= BIT(bit);
275 polarity |= BIT(bit);
276 break;
277 case IRQ_TYPE_EDGE_FALLING:
278 level |= BIT(bit);
279 polarity &= ~BIT(bit);
280 break;
281 case IRQ_TYPE_LEVEL_HIGH:
282 level &= ~BIT(bit);
283 polarity |= BIT(bit);
284 break;
285 case IRQ_TYPE_LEVEL_LOW:
286 level &= ~BIT(bit);
287 polarity &= ~BIT(bit);
288 break;
289 }
290
291 irq_setup_alt_chip(d, type);
292
293 dwapb_write(gpio, GPIO_INTTYPE_LEVEL, level);
294 if (type != IRQ_TYPE_EDGE_BOTH)
295 dwapb_write(gpio, GPIO_INT_POLARITY, polarity);
296 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
297
298 return 0;
299}
300
301#ifdef CONFIG_PM_SLEEP
302static int dwapb_irq_set_wake(struct irq_data *d, unsigned int enable)
303{
304 struct irq_chip_generic *igc = irq_data_get_irq_chip_data(d);
305 struct dwapb_gpio *gpio = igc->private;
306 struct dwapb_context *ctx = gpio->ports[0].ctx;
307 irq_hw_number_t bit = irqd_to_hwirq(d);
308
309 if (enable)
310 ctx->wake_en |= BIT(bit);
311 else
312 ctx->wake_en &= ~BIT(bit);
313
314 return 0;
315}
316#endif
317
318static int dwapb_gpio_set_debounce(struct gpio_chip *gc,
319 unsigned offset, unsigned debounce)
320{
321 struct dwapb_gpio_port *port = gpiochip_get_data(gc);
322 struct dwapb_gpio *gpio = port->gpio;
323 unsigned long flags, val_deb;
324 unsigned long mask = BIT(offset);
325
326 spin_lock_irqsave(&gc->bgpio_lock, flags);
327
328 val_deb = dwapb_read(gpio, GPIO_PORTA_DEBOUNCE);
329 if (debounce)
330 val_deb |= mask;
331 else
332 val_deb &= ~mask;
333 dwapb_write(gpio, GPIO_PORTA_DEBOUNCE, val_deb);
334
335 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
336
337 return 0;
338}
339
340static int dwapb_gpio_set_config(struct gpio_chip *gc, unsigned offset,
341 unsigned long config)
342{
343 u32 debounce;
344
345 if (pinconf_to_config_param(config) != PIN_CONFIG_INPUT_DEBOUNCE)
346 return -ENOTSUPP;
347
348 debounce = pinconf_to_config_argument(config);
349 return dwapb_gpio_set_debounce(gc, offset, debounce);
350}
351
352static irqreturn_t dwapb_irq_handler_mfd(int irq, void *dev_id)
353{
354 return IRQ_RETVAL(dwapb_do_irq(dev_id));
355}
356
357static void dwapb_configure_irqs(struct dwapb_gpio *gpio,
358 struct dwapb_gpio_port *port,
359 struct dwapb_port_property *pp)
360{
361 struct gpio_chip *gc = &port->gc;
362 struct fwnode_handle *fwnode = pp->fwnode;
363 struct irq_chip_generic *irq_gc = NULL;
364 unsigned int ngpio = gc->ngpio;
365 struct irq_chip_type *ct;
366 irq_hw_number_t hwirq;
367 int err, i;
368
369 if (memchr_inv(pp->irq, 0, sizeof(pp->irq)) == NULL) {
370 dev_warn(gpio->dev, "no IRQ for port%d\n", pp->idx);
371 return;
372 }
373
374 gpio->domain = irq_domain_create_linear(fwnode, ngpio,
375 &irq_generic_chip_ops, gpio);
376 if (!gpio->domain)
377 return;
378
379 err = irq_alloc_domain_generic_chips(gpio->domain, ngpio, 2,
380 DWAPB_DRIVER_NAME, handle_bad_irq,
381 IRQ_NOREQUEST, 0,
382 IRQ_GC_INIT_NESTED_LOCK);
383 if (err) {
384 dev_info(gpio->dev, "irq_alloc_domain_generic_chips failed\n");
385 irq_domain_remove(gpio->domain);
386 gpio->domain = NULL;
387 return;
388 }
389
390 irq_gc = irq_get_domain_generic_chip(gpio->domain, 0);
391 if (!irq_gc) {
392 irq_domain_remove(gpio->domain);
393 gpio->domain = NULL;
394 return;
395 }
396
397 irq_gc->reg_base = gpio->regs;
398 irq_gc->private = gpio;
399
400 for (i = 0; i < 2; i++) {
401 ct = &irq_gc->chip_types[i];
402 ct->chip.irq_ack = irq_gc_ack_set_bit;
403 ct->chip.irq_mask = irq_gc_mask_set_bit;
404 ct->chip.irq_unmask = irq_gc_mask_clr_bit;
405 ct->chip.irq_set_type = dwapb_irq_set_type;
406 ct->chip.irq_enable = dwapb_irq_enable;
407 ct->chip.irq_disable = dwapb_irq_disable;
408#ifdef CONFIG_PM_SLEEP
409 ct->chip.irq_set_wake = dwapb_irq_set_wake;
410#endif
411 ct->regs.ack = gpio_reg_convert(gpio, GPIO_PORTA_EOI);
412 ct->regs.mask = gpio_reg_convert(gpio, GPIO_INTMASK);
413 ct->type = IRQ_TYPE_LEVEL_MASK;
414 }
415
416 irq_gc->chip_types[0].type = IRQ_TYPE_LEVEL_MASK;
417 irq_gc->chip_types[0].handler = handle_level_irq;
418 irq_gc->chip_types[1].type = IRQ_TYPE_EDGE_BOTH;
419 irq_gc->chip_types[1].handler = handle_edge_irq;
420
421 if (!pp->irq_shared) {
422 int i;
423
424 for (i = 0; i < pp->ngpio; i++) {
425 if (pp->irq[i])
426 irq_set_chained_handler_and_data(pp->irq[i],
427 dwapb_irq_handler, gpio);
428 }
429 } else {
430 /*
431 * Request a shared IRQ since where MFD would have devices
432 * using the same irq pin
433 */
434 err = devm_request_irq(gpio->dev, pp->irq[0],
435 dwapb_irq_handler_mfd,
436 IRQF_SHARED, DWAPB_DRIVER_NAME, gpio);
437 if (err) {
438 dev_err(gpio->dev, "error requesting IRQ\n");
439 irq_domain_remove(gpio->domain);
440 gpio->domain = NULL;
441 return;
442 }
443 }
444
445 for (hwirq = 0; hwirq < ngpio; hwirq++)
446 irq_create_mapping(gpio->domain, hwirq);
447
448 port->gc.to_irq = dwapb_gpio_to_irq;
449}
450
451static void dwapb_irq_teardown(struct dwapb_gpio *gpio)
452{
453 struct dwapb_gpio_port *port = &gpio->ports[0];
454 struct gpio_chip *gc = &port->gc;
455 unsigned int ngpio = gc->ngpio;
456 irq_hw_number_t hwirq;
457
458 if (!gpio->domain)
459 return;
460
461 for (hwirq = 0; hwirq < ngpio; hwirq++)
462 irq_dispose_mapping(irq_find_mapping(gpio->domain, hwirq));
463
464 irq_domain_remove(gpio->domain);
465 gpio->domain = NULL;
466}
467
468static int dwapb_gpio_add_port(struct dwapb_gpio *gpio,
469 struct dwapb_port_property *pp,
470 unsigned int offs)
471{
472 struct dwapb_gpio_port *port;
473 void __iomem *dat, *set, *dirout;
474 int err;
475
476 port = &gpio->ports[offs];
477 port->gpio = gpio;
478 port->idx = pp->idx;
479
480#ifdef CONFIG_PM_SLEEP
481 port->ctx = devm_kzalloc(gpio->dev, sizeof(*port->ctx), GFP_KERNEL);
482 if (!port->ctx)
483 return -ENOMEM;
484#endif
485
486 dat = gpio->regs + GPIO_EXT_PORTA + pp->idx * GPIO_EXT_PORT_STRIDE;
487 set = gpio->regs + GPIO_SWPORTA_DR + pp->idx * GPIO_SWPORT_DR_STRIDE;
488 dirout = gpio->regs + GPIO_SWPORTA_DDR + pp->idx * GPIO_SWPORT_DDR_STRIDE;
489
490 /* This registers 32 GPIO lines per port */
491 err = bgpio_init(&port->gc, gpio->dev, 4, dat, set, NULL, dirout,
492 NULL, 0);
493 if (err) {
494 dev_err(gpio->dev, "failed to init gpio chip for port%d\n",
495 port->idx);
496 return err;
497 }
498
499#ifdef CONFIG_OF_GPIO
500 port->gc.of_node = to_of_node(pp->fwnode);
501#endif
502 port->gc.ngpio = pp->ngpio;
503 port->gc.base = pp->gpio_base;
504
505 /* Only port A support debounce */
506 if (pp->idx == 0)
507 port->gc.set_config = dwapb_gpio_set_config;
508
509 /* Only port A can provide interrupts in all configurations of the IP */
510 if (pp->idx == 0)
511 dwapb_configure_irqs(gpio, port, pp);
512
513 err = gpiochip_add_data(&port->gc, port);
514 if (err) {
515 dev_err(gpio->dev, "failed to register gpiochip for port%d\n",
516 port->idx);
517 return err;
518 }
519
520 /* Add GPIO-signaled ACPI event support */
521 acpi_gpiochip_request_interrupts(&port->gc);
522
523 port->is_registered = true;
524
525 return 0;
526}
527
528static void dwapb_gpio_unregister(struct dwapb_gpio *gpio)
529{
530 unsigned int m;
531
532 for (m = 0; m < gpio->nr_ports; ++m) {
533 struct dwapb_gpio_port *port = &gpio->ports[m];
534
535 if (!port->is_registered)
536 continue;
537
538 acpi_gpiochip_free_interrupts(&port->gc);
539 gpiochip_remove(&port->gc);
540 }
541}
542
543static void dwapb_get_irq(struct device *dev, struct fwnode_handle *fwnode,
544 struct dwapb_port_property *pp)
545{
546 struct device_node *np = NULL;
547 int irq = -ENXIO, j;
548
549 if (fwnode_property_read_bool(fwnode, "interrupt-controller"))
550 np = to_of_node(fwnode);
551
552 for (j = 0; j < pp->ngpio; j++) {
553 if (np)
554 irq = of_irq_get(np, j);
555 else if (has_acpi_companion(dev))
556 irq = platform_get_irq_optional(to_platform_device(dev), j);
557 if (irq > 0)
558 pp->irq[j] = irq;
559 }
560}
561
562static struct dwapb_platform_data *dwapb_gpio_get_pdata(struct device *dev)
563{
564 struct fwnode_handle *fwnode;
565 struct dwapb_platform_data *pdata;
566 struct dwapb_port_property *pp;
567 int nports;
568 int i;
569
570 nports = device_get_child_node_count(dev);
571 if (nports == 0)
572 return ERR_PTR(-ENODEV);
573
574 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
575 if (!pdata)
576 return ERR_PTR(-ENOMEM);
577
578 pdata->properties = devm_kcalloc(dev, nports, sizeof(*pp), GFP_KERNEL);
579 if (!pdata->properties)
580 return ERR_PTR(-ENOMEM);
581
582 pdata->nports = nports;
583
584 i = 0;
585 device_for_each_child_node(dev, fwnode) {
586 pp = &pdata->properties[i++];
587 pp->fwnode = fwnode;
588
589 if (fwnode_property_read_u32(fwnode, "reg", &pp->idx) ||
590 pp->idx >= DWAPB_MAX_PORTS) {
591 dev_err(dev,
592 "missing/invalid port index for port%d\n", i);
593 fwnode_handle_put(fwnode);
594 return ERR_PTR(-EINVAL);
595 }
596
597 if (fwnode_property_read_u32(fwnode, "snps,nr-gpios", &pp->ngpio)) {
598 dev_info(dev,
599 "failed to get number of gpios for port%d\n",
600 i);
601 pp->ngpio = 32;
602 }
603
604 pp->irq_shared = false;
605 pp->gpio_base = -1;
606
607 /*
608 * Only port A can provide interrupts in all configurations of
609 * the IP.
610 */
611 if (pp->idx == 0)
612 dwapb_get_irq(dev, fwnode, pp);
613 }
614
615 return pdata;
616}
617
618static const struct of_device_id dwapb_of_match[] = {
619 { .compatible = "snps,dw-apb-gpio", .data = (void *)0},
620 { .compatible = "apm,xgene-gpio-v2", .data = (void *)GPIO_REG_OFFSET_V2},
621 { /* Sentinel */ }
622};
623MODULE_DEVICE_TABLE(of, dwapb_of_match);
624
625static const struct acpi_device_id dwapb_acpi_match[] = {
626 {"HISI0181", 0},
627 {"APMC0D07", 0},
628 {"APMC0D81", GPIO_REG_OFFSET_V2},
629 { }
630};
631MODULE_DEVICE_TABLE(acpi, dwapb_acpi_match);
632
633static int dwapb_gpio_probe(struct platform_device *pdev)
634{
635 unsigned int i;
636 struct dwapb_gpio *gpio;
637 int err;
638 struct device *dev = &pdev->dev;
639 struct dwapb_platform_data *pdata = dev_get_platdata(dev);
640
641 if (!pdata) {
642 pdata = dwapb_gpio_get_pdata(dev);
643 if (IS_ERR(pdata))
644 return PTR_ERR(pdata);
645 }
646
647 if (!pdata->nports)
648 return -ENODEV;
649
650 gpio = devm_kzalloc(&pdev->dev, sizeof(*gpio), GFP_KERNEL);
651 if (!gpio)
652 return -ENOMEM;
653
654 gpio->dev = &pdev->dev;
655 gpio->nr_ports = pdata->nports;
656
657 gpio->rst = devm_reset_control_get_optional_shared(dev, NULL);
658 if (IS_ERR(gpio->rst))
659 return PTR_ERR(gpio->rst);
660
661 reset_control_deassert(gpio->rst);
662
663 gpio->ports = devm_kcalloc(&pdev->dev, gpio->nr_ports,
664 sizeof(*gpio->ports), GFP_KERNEL);
665 if (!gpio->ports)
666 return -ENOMEM;
667
668 gpio->regs = devm_platform_ioremap_resource(pdev, 0);
669 if (IS_ERR(gpio->regs))
670 return PTR_ERR(gpio->regs);
671
672 /* Optional bus and debounce clocks */
673 gpio->clks[0].id = "bus";
674 gpio->clks[1].id = "db";
675 err = devm_clk_bulk_get_optional(&pdev->dev, DWAPB_NR_CLOCKS,
676 gpio->clks);
677 if (err) {
678 dev_err(&pdev->dev, "Cannot get APB/Debounce clocks\n");
679 return err;
680 }
681
682 err = clk_bulk_prepare_enable(DWAPB_NR_CLOCKS, gpio->clks);
683 if (err) {
684 dev_err(&pdev->dev, "Cannot enable APB/Debounce clocks\n");
685 return err;
686 }
687
688 gpio->flags = (uintptr_t)device_get_match_data(dev);
689
690 for (i = 0; i < gpio->nr_ports; i++) {
691 err = dwapb_gpio_add_port(gpio, &pdata->properties[i], i);
692 if (err)
693 goto out_unregister;
694 }
695 platform_set_drvdata(pdev, gpio);
696
697 return 0;
698
699out_unregister:
700 dwapb_gpio_unregister(gpio);
701 dwapb_irq_teardown(gpio);
702 clk_bulk_disable_unprepare(DWAPB_NR_CLOCKS, gpio->clks);
703
704 return err;
705}
706
707static int dwapb_gpio_remove(struct platform_device *pdev)
708{
709 struct dwapb_gpio *gpio = platform_get_drvdata(pdev);
710
711 dwapb_gpio_unregister(gpio);
712 dwapb_irq_teardown(gpio);
713 reset_control_assert(gpio->rst);
714 clk_bulk_disable_unprepare(DWAPB_NR_CLOCKS, gpio->clks);
715
716 return 0;
717}
718
719#ifdef CONFIG_PM_SLEEP
720static int dwapb_gpio_suspend(struct device *dev)
721{
722 struct dwapb_gpio *gpio = dev_get_drvdata(dev);
723 struct gpio_chip *gc = &gpio->ports[0].gc;
724 unsigned long flags;
725 int i;
726
727 spin_lock_irqsave(&gc->bgpio_lock, flags);
728 for (i = 0; i < gpio->nr_ports; i++) {
729 unsigned int offset;
730 unsigned int idx = gpio->ports[i].idx;
731 struct dwapb_context *ctx = gpio->ports[i].ctx;
732
733 offset = GPIO_SWPORTA_DDR + idx * GPIO_SWPORT_DDR_STRIDE;
734 ctx->dir = dwapb_read(gpio, offset);
735
736 offset = GPIO_SWPORTA_DR + idx * GPIO_SWPORT_DR_STRIDE;
737 ctx->data = dwapb_read(gpio, offset);
738
739 offset = GPIO_EXT_PORTA + idx * GPIO_EXT_PORT_STRIDE;
740 ctx->ext = dwapb_read(gpio, offset);
741
742 /* Only port A can provide interrupts */
743 if (idx == 0) {
744 ctx->int_mask = dwapb_read(gpio, GPIO_INTMASK);
745 ctx->int_en = dwapb_read(gpio, GPIO_INTEN);
746 ctx->int_pol = dwapb_read(gpio, GPIO_INT_POLARITY);
747 ctx->int_type = dwapb_read(gpio, GPIO_INTTYPE_LEVEL);
748 ctx->int_deb = dwapb_read(gpio, GPIO_PORTA_DEBOUNCE);
749
750 /* Mask out interrupts */
751 dwapb_write(gpio, GPIO_INTMASK, ~ctx->wake_en);
752 }
753 }
754 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
755
756 clk_bulk_disable_unprepare(DWAPB_NR_CLOCKS, gpio->clks);
757
758 return 0;
759}
760
761static int dwapb_gpio_resume(struct device *dev)
762{
763 struct dwapb_gpio *gpio = dev_get_drvdata(dev);
764 struct gpio_chip *gc = &gpio->ports[0].gc;
765 unsigned long flags;
766 int i, err;
767
768 err = clk_bulk_prepare_enable(DWAPB_NR_CLOCKS, gpio->clks);
769 if (err) {
770 dev_err(gpio->dev, "Cannot reenable APB/Debounce clocks\n");
771 return err;
772 }
773
774 spin_lock_irqsave(&gc->bgpio_lock, flags);
775 for (i = 0; i < gpio->nr_ports; i++) {
776 unsigned int offset;
777 unsigned int idx = gpio->ports[i].idx;
778 struct dwapb_context *ctx = gpio->ports[i].ctx;
779
780 offset = GPIO_SWPORTA_DR + idx * GPIO_SWPORT_DR_STRIDE;
781 dwapb_write(gpio, offset, ctx->data);
782
783 offset = GPIO_SWPORTA_DDR + idx * GPIO_SWPORT_DDR_STRIDE;
784 dwapb_write(gpio, offset, ctx->dir);
785
786 offset = GPIO_EXT_PORTA + idx * GPIO_EXT_PORT_STRIDE;
787 dwapb_write(gpio, offset, ctx->ext);
788
789 /* Only port A can provide interrupts */
790 if (idx == 0) {
791 dwapb_write(gpio, GPIO_INTTYPE_LEVEL, ctx->int_type);
792 dwapb_write(gpio, GPIO_INT_POLARITY, ctx->int_pol);
793 dwapb_write(gpio, GPIO_PORTA_DEBOUNCE, ctx->int_deb);
794 dwapb_write(gpio, GPIO_INTEN, ctx->int_en);
795 dwapb_write(gpio, GPIO_INTMASK, ctx->int_mask);
796
797 /* Clear out spurious interrupts */
798 dwapb_write(gpio, GPIO_PORTA_EOI, 0xffffffff);
799 }
800 }
801 spin_unlock_irqrestore(&gc->bgpio_lock, flags);
802
803 return 0;
804}
805#endif
806
807static SIMPLE_DEV_PM_OPS(dwapb_gpio_pm_ops, dwapb_gpio_suspend,
808 dwapb_gpio_resume);
809
810static struct platform_driver dwapb_gpio_driver = {
811 .driver = {
812 .name = DWAPB_DRIVER_NAME,
813 .pm = &dwapb_gpio_pm_ops,
814 .of_match_table = dwapb_of_match,
815 .acpi_match_table = dwapb_acpi_match,
816 },
817 .probe = dwapb_gpio_probe,
818 .remove = dwapb_gpio_remove,
819};
820
821module_platform_driver(dwapb_gpio_driver);
822
823MODULE_LICENSE("GPL");
824MODULE_AUTHOR("Jamie Iles");
825MODULE_DESCRIPTION("Synopsys DesignWare APB GPIO driver");
826MODULE_ALIAS("platform:" DWAPB_DRIVER_NAME);