1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2018 Spreadtrum Communications Inc.
4 * Copyright (C) 2018 Linaro Ltd.
7 #include <linux/bitops.h>
8 #include <linux/gpio/driver.h>
9 #include <linux/interrupt.h>
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/of_device.h>
13 #include <linux/platform_device.h>
14 #include <linux/spinlock.h>
16 /* EIC registers definition */
17 #define SPRD_EIC_DBNC_DATA 0x0
18 #define SPRD_EIC_DBNC_DMSK 0x4
19 #define SPRD_EIC_DBNC_IEV 0x14
20 #define SPRD_EIC_DBNC_IE 0x18
21 #define SPRD_EIC_DBNC_RIS 0x1c
22 #define SPRD_EIC_DBNC_MIS 0x20
23 #define SPRD_EIC_DBNC_IC 0x24
24 #define SPRD_EIC_DBNC_TRIG 0x28
25 #define SPRD_EIC_DBNC_CTRL0 0x40
27 #define SPRD_EIC_LATCH_INTEN 0x0
28 #define SPRD_EIC_LATCH_INTRAW 0x4
29 #define SPRD_EIC_LATCH_INTMSK 0x8
30 #define SPRD_EIC_LATCH_INTCLR 0xc
31 #define SPRD_EIC_LATCH_INTPOL 0x10
32 #define SPRD_EIC_LATCH_INTMODE 0x14
34 #define SPRD_EIC_ASYNC_INTIE 0x0
35 #define SPRD_EIC_ASYNC_INTRAW 0x4
36 #define SPRD_EIC_ASYNC_INTMSK 0x8
37 #define SPRD_EIC_ASYNC_INTCLR 0xc
38 #define SPRD_EIC_ASYNC_INTMODE 0x10
39 #define SPRD_EIC_ASYNC_INTBOTH 0x14
40 #define SPRD_EIC_ASYNC_INTPOL 0x18
41 #define SPRD_EIC_ASYNC_DATA 0x1c
43 #define SPRD_EIC_SYNC_INTIE 0x0
44 #define SPRD_EIC_SYNC_INTRAW 0x4
45 #define SPRD_EIC_SYNC_INTMSK 0x8
46 #define SPRD_EIC_SYNC_INTCLR 0xc
47 #define SPRD_EIC_SYNC_INTMODE 0x10
48 #define SPRD_EIC_SYNC_INTBOTH 0x14
49 #define SPRD_EIC_SYNC_INTPOL 0x18
50 #define SPRD_EIC_SYNC_DATA 0x1c
53 * The digital-chip EIC controller can support maximum 3 banks, and each bank
56 #define SPRD_EIC_MAX_BANK 3
57 #define SPRD_EIC_PER_BANK_NR 8
58 #define SPRD_EIC_DATA_MASK GENMASK(7, 0)
59 #define SPRD_EIC_BIT(x) ((x) & (SPRD_EIC_PER_BANK_NR - 1))
60 #define SPRD_EIC_DBNC_MASK GENMASK(11, 0)
63 * The Spreadtrum EIC (external interrupt controller) can be used only in
64 * input mode to generate interrupts if detecting input signals.
66 * The Spreadtrum digital-chip EIC controller contains 4 sub-modules:
67 * debounce EIC, latch EIC, async EIC and sync EIC,
69 * The debounce EIC is used to capture the input signals' stable status
70 * (millisecond resolution) and a single-trigger mechanism is introduced
71 * into this sub-module to enhance the input event detection reliability.
72 * The debounce range is from 1ms to 4s with a step size of 1ms.
74 * The latch EIC is used to latch some special power down signals and
75 * generate interrupts, since the latch EIC does not depend on the APB clock
78 * The async EIC uses a 32k clock to capture the short signals (microsecond
79 * resolution) to generate interrupts by level or edge trigger.
81 * The EIC-sync is similar with GPIO's input function, which is a synchronized
82 * signal input register.
93 struct gpio_chip chip;
95 void __iomem *base[SPRD_EIC_MAX_BANK];
96 enum sprd_eic_type type;
101 struct sprd_eic_variant_data {
102 enum sprd_eic_type type;
106 static const char *sprd_eic_label_name[SPRD_EIC_MAX] = {
107 "eic-debounce", "eic-latch", "eic-async",
111 static const struct sprd_eic_variant_data sc9860_eic_dbnc_data = {
112 .type = SPRD_EIC_DEBOUNCE,
116 static const struct sprd_eic_variant_data sc9860_eic_latch_data = {
117 .type = SPRD_EIC_LATCH,
121 static const struct sprd_eic_variant_data sc9860_eic_async_data = {
122 .type = SPRD_EIC_ASYNC,
126 static const struct sprd_eic_variant_data sc9860_eic_sync_data = {
127 .type = SPRD_EIC_SYNC,
131 static inline void __iomem *sprd_eic_offset_base(struct sprd_eic *sprd_eic,
134 if (bank >= SPRD_EIC_MAX_BANK)
137 return sprd_eic->base[bank];
140 static void sprd_eic_update(struct gpio_chip *chip, unsigned int offset,
141 u16 reg, unsigned int val)
143 struct sprd_eic *sprd_eic = gpiochip_get_data(chip);
145 sprd_eic_offset_base(sprd_eic, offset / SPRD_EIC_PER_BANK_NR);
149 spin_lock_irqsave(&sprd_eic->lock, flags);
150 tmp = readl_relaxed(base + reg);
153 tmp |= BIT(SPRD_EIC_BIT(offset));
155 tmp &= ~BIT(SPRD_EIC_BIT(offset));
157 writel_relaxed(tmp, base + reg);
158 spin_unlock_irqrestore(&sprd_eic->lock, flags);
161 static int sprd_eic_read(struct gpio_chip *chip, unsigned int offset, u16 reg)
163 struct sprd_eic *sprd_eic = gpiochip_get_data(chip);
165 sprd_eic_offset_base(sprd_eic, offset / SPRD_EIC_PER_BANK_NR);
167 return !!(readl_relaxed(base + reg) & BIT(SPRD_EIC_BIT(offset)));
170 static int sprd_eic_request(struct gpio_chip *chip, unsigned int offset)
172 sprd_eic_update(chip, offset, SPRD_EIC_DBNC_DMSK, 1);
176 static void sprd_eic_free(struct gpio_chip *chip, unsigned int offset)
178 sprd_eic_update(chip, offset, SPRD_EIC_DBNC_DMSK, 0);
181 static int sprd_eic_get(struct gpio_chip *chip, unsigned int offset)
183 struct sprd_eic *sprd_eic = gpiochip_get_data(chip);
185 switch (sprd_eic->type) {
186 case SPRD_EIC_DEBOUNCE:
187 return sprd_eic_read(chip, offset, SPRD_EIC_DBNC_DATA);
189 return sprd_eic_read(chip, offset, SPRD_EIC_ASYNC_DATA);
191 return sprd_eic_read(chip, offset, SPRD_EIC_SYNC_DATA);
197 static int sprd_eic_direction_input(struct gpio_chip *chip, unsigned int offset)
199 /* EICs are always input, nothing need to do here. */
203 static void sprd_eic_set(struct gpio_chip *chip, unsigned int offset, int value)
205 /* EICs are always input, nothing need to do here. */
208 static int sprd_eic_set_debounce(struct gpio_chip *chip, unsigned int offset,
209 unsigned int debounce)
211 struct sprd_eic *sprd_eic = gpiochip_get_data(chip);
213 sprd_eic_offset_base(sprd_eic, offset / SPRD_EIC_PER_BANK_NR);
214 u32 reg = SPRD_EIC_DBNC_CTRL0 + SPRD_EIC_BIT(offset) * 0x4;
215 u32 value = readl_relaxed(base + reg) & ~SPRD_EIC_DBNC_MASK;
217 value |= (debounce / 1000) & SPRD_EIC_DBNC_MASK;
218 writel_relaxed(value, base + reg);
223 static int sprd_eic_set_config(struct gpio_chip *chip, unsigned int offset,
224 unsigned long config)
226 unsigned long param = pinconf_to_config_param(config);
227 u32 arg = pinconf_to_config_argument(config);
229 if (param == PIN_CONFIG_INPUT_DEBOUNCE)
230 return sprd_eic_set_debounce(chip, offset, arg);
235 static void sprd_eic_irq_mask(struct irq_data *data)
237 struct gpio_chip *chip = irq_data_get_irq_chip_data(data);
238 struct sprd_eic *sprd_eic = gpiochip_get_data(chip);
239 u32 offset = irqd_to_hwirq(data);
241 switch (sprd_eic->type) {
242 case SPRD_EIC_DEBOUNCE:
243 sprd_eic_update(chip, offset, SPRD_EIC_DBNC_IE, 0);
244 sprd_eic_update(chip, offset, SPRD_EIC_DBNC_TRIG, 0);
247 sprd_eic_update(chip, offset, SPRD_EIC_LATCH_INTEN, 0);
250 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTIE, 0);
253 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTIE, 0);
256 dev_err(chip->parent, "Unsupported EIC type.\n");
260 static void sprd_eic_irq_unmask(struct irq_data *data)
262 struct gpio_chip *chip = irq_data_get_irq_chip_data(data);
263 struct sprd_eic *sprd_eic = gpiochip_get_data(chip);
264 u32 offset = irqd_to_hwirq(data);
266 switch (sprd_eic->type) {
267 case SPRD_EIC_DEBOUNCE:
268 sprd_eic_update(chip, offset, SPRD_EIC_DBNC_IE, 1);
269 sprd_eic_update(chip, offset, SPRD_EIC_DBNC_TRIG, 1);
272 sprd_eic_update(chip, offset, SPRD_EIC_LATCH_INTEN, 1);
275 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTIE, 1);
278 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTIE, 1);
281 dev_err(chip->parent, "Unsupported EIC type.\n");
285 static void sprd_eic_irq_ack(struct irq_data *data)
287 struct gpio_chip *chip = irq_data_get_irq_chip_data(data);
288 struct sprd_eic *sprd_eic = gpiochip_get_data(chip);
289 u32 offset = irqd_to_hwirq(data);
291 switch (sprd_eic->type) {
292 case SPRD_EIC_DEBOUNCE:
293 sprd_eic_update(chip, offset, SPRD_EIC_DBNC_IC, 1);
296 sprd_eic_update(chip, offset, SPRD_EIC_LATCH_INTCLR, 1);
299 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTCLR, 1);
302 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTCLR, 1);
305 dev_err(chip->parent, "Unsupported EIC type.\n");
309 static int sprd_eic_irq_set_type(struct irq_data *data, unsigned int flow_type)
311 struct gpio_chip *chip = irq_data_get_irq_chip_data(data);
312 struct sprd_eic *sprd_eic = gpiochip_get_data(chip);
313 u32 offset = irqd_to_hwirq(data);
316 switch (sprd_eic->type) {
317 case SPRD_EIC_DEBOUNCE:
319 case IRQ_TYPE_LEVEL_HIGH:
320 sprd_eic_update(chip, offset, SPRD_EIC_DBNC_IEV, 1);
322 case IRQ_TYPE_LEVEL_LOW:
323 sprd_eic_update(chip, offset, SPRD_EIC_DBNC_IEV, 0);
325 case IRQ_TYPE_EDGE_RISING:
326 case IRQ_TYPE_EDGE_FALLING:
327 case IRQ_TYPE_EDGE_BOTH:
328 state = sprd_eic_get(chip, offset);
330 sprd_eic_update(chip, offset,
331 SPRD_EIC_DBNC_IEV, 0);
333 sprd_eic_update(chip, offset,
334 SPRD_EIC_DBNC_IEV, 1);
340 irq_set_handler_locked(data, handle_level_irq);
344 case IRQ_TYPE_LEVEL_HIGH:
345 sprd_eic_update(chip, offset, SPRD_EIC_LATCH_INTPOL, 0);
347 case IRQ_TYPE_LEVEL_LOW:
348 sprd_eic_update(chip, offset, SPRD_EIC_LATCH_INTPOL, 1);
350 case IRQ_TYPE_EDGE_RISING:
351 case IRQ_TYPE_EDGE_FALLING:
352 case IRQ_TYPE_EDGE_BOTH:
353 state = sprd_eic_get(chip, offset);
355 sprd_eic_update(chip, offset,
356 SPRD_EIC_LATCH_INTPOL, 0);
358 sprd_eic_update(chip, offset,
359 SPRD_EIC_LATCH_INTPOL, 1);
365 irq_set_handler_locked(data, handle_level_irq);
369 case IRQ_TYPE_EDGE_RISING:
370 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTBOTH, 0);
371 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTMODE, 0);
372 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTPOL, 1);
373 irq_set_handler_locked(data, handle_edge_irq);
375 case IRQ_TYPE_EDGE_FALLING:
376 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTBOTH, 0);
377 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTMODE, 0);
378 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTPOL, 0);
379 irq_set_handler_locked(data, handle_edge_irq);
381 case IRQ_TYPE_EDGE_BOTH:
382 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTMODE, 0);
383 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTBOTH, 1);
384 irq_set_handler_locked(data, handle_edge_irq);
386 case IRQ_TYPE_LEVEL_HIGH:
387 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTBOTH, 0);
388 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTMODE, 1);
389 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTPOL, 1);
390 irq_set_handler_locked(data, handle_level_irq);
392 case IRQ_TYPE_LEVEL_LOW:
393 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTBOTH, 0);
394 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTMODE, 1);
395 sprd_eic_update(chip, offset, SPRD_EIC_ASYNC_INTPOL, 0);
396 irq_set_handler_locked(data, handle_level_irq);
404 case IRQ_TYPE_EDGE_RISING:
405 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTBOTH, 0);
406 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTMODE, 0);
407 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTPOL, 1);
408 irq_set_handler_locked(data, handle_edge_irq);
410 case IRQ_TYPE_EDGE_FALLING:
411 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTBOTH, 0);
412 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTMODE, 0);
413 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTPOL, 0);
414 irq_set_handler_locked(data, handle_edge_irq);
416 case IRQ_TYPE_EDGE_BOTH:
417 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTMODE, 0);
418 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTBOTH, 1);
419 irq_set_handler_locked(data, handle_edge_irq);
421 case IRQ_TYPE_LEVEL_HIGH:
422 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTBOTH, 0);
423 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTMODE, 1);
424 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTPOL, 1);
425 irq_set_handler_locked(data, handle_level_irq);
427 case IRQ_TYPE_LEVEL_LOW:
428 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTBOTH, 0);
429 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTMODE, 1);
430 sprd_eic_update(chip, offset, SPRD_EIC_SYNC_INTPOL, 0);
431 irq_set_handler_locked(data, handle_level_irq);
438 dev_err(chip->parent, "Unsupported EIC type.\n");
445 static void sprd_eic_toggle_trigger(struct gpio_chip *chip, unsigned int irq,
448 struct sprd_eic *sprd_eic = gpiochip_get_data(chip);
449 struct irq_data *data = irq_get_irq_data(irq);
450 u32 trigger = irqd_get_trigger_type(data);
451 int state, post_state;
454 * The debounce EIC and latch EIC can only support level trigger, so we
455 * can toggle the level trigger to emulate the edge trigger.
457 if ((sprd_eic->type != SPRD_EIC_DEBOUNCE &&
458 sprd_eic->type != SPRD_EIC_LATCH) ||
459 !(trigger & IRQ_TYPE_EDGE_BOTH))
462 sprd_eic_irq_mask(data);
463 state = sprd_eic_get(chip, offset);
466 switch (sprd_eic->type) {
467 case SPRD_EIC_DEBOUNCE:
469 sprd_eic_update(chip, offset, SPRD_EIC_DBNC_IEV, 0);
471 sprd_eic_update(chip, offset, SPRD_EIC_DBNC_IEV, 1);
475 sprd_eic_update(chip, offset, SPRD_EIC_LATCH_INTPOL, 0);
477 sprd_eic_update(chip, offset, SPRD_EIC_LATCH_INTPOL, 1);
480 sprd_eic_irq_unmask(data);
484 post_state = sprd_eic_get(chip, offset);
485 if (state != post_state) {
486 dev_warn(chip->parent, "EIC level was changed.\n");
491 sprd_eic_irq_unmask(data);
494 static int sprd_eic_match_chip_by_type(struct gpio_chip *chip, void *data)
496 enum sprd_eic_type type = *(enum sprd_eic_type *)data;
498 return !strcmp(chip->label, sprd_eic_label_name[type]);
501 static void sprd_eic_handle_one_type(struct gpio_chip *chip)
503 struct sprd_eic *sprd_eic = gpiochip_get_data(chip);
506 for (bank = 0; bank * SPRD_EIC_PER_BANK_NR < chip->ngpio; bank++) {
507 void __iomem *base = sprd_eic_offset_base(sprd_eic, bank);
510 switch (sprd_eic->type) {
511 case SPRD_EIC_DEBOUNCE:
512 reg = readl_relaxed(base + SPRD_EIC_DBNC_MIS) &
516 reg = readl_relaxed(base + SPRD_EIC_LATCH_INTMSK) &
520 reg = readl_relaxed(base + SPRD_EIC_ASYNC_INTMSK) &
524 reg = readl_relaxed(base + SPRD_EIC_SYNC_INTMSK) &
528 dev_err(chip->parent, "Unsupported EIC type.\n");
532 for_each_set_bit(n, ®, SPRD_EIC_PER_BANK_NR) {
533 u32 offset = bank * SPRD_EIC_PER_BANK_NR + n;
535 girq = irq_find_mapping(chip->irq.domain, offset);
537 generic_handle_irq(girq);
538 sprd_eic_toggle_trigger(chip, girq, offset);
543 static void sprd_eic_irq_handler(struct irq_desc *desc)
545 struct irq_chip *ic = irq_desc_get_chip(desc);
546 struct gpio_chip *chip;
547 enum sprd_eic_type type;
549 chained_irq_enter(ic, desc);
552 * Since the digital-chip EIC 4 sub-modules (debounce, latch, async
553 * and sync) share one same interrupt line, we should iterate each
554 * EIC module to check if there are EIC interrupts were triggered.
556 for (type = SPRD_EIC_DEBOUNCE; type < SPRD_EIC_MAX; type++) {
557 chip = gpiochip_find(&type, sprd_eic_match_chip_by_type);
561 sprd_eic_handle_one_type(chip);
564 chained_irq_exit(ic, desc);
567 static int sprd_eic_probe(struct platform_device *pdev)
569 const struct sprd_eic_variant_data *pdata;
570 struct gpio_irq_chip *irq;
571 struct sprd_eic *sprd_eic;
572 struct resource *res;
575 pdata = of_device_get_match_data(&pdev->dev);
577 dev_err(&pdev->dev, "No matching driver data found.\n");
581 sprd_eic = devm_kzalloc(&pdev->dev, sizeof(*sprd_eic), GFP_KERNEL);
585 spin_lock_init(&sprd_eic->lock);
586 sprd_eic->type = pdata->type;
588 sprd_eic->irq = platform_get_irq(pdev, 0);
589 if (sprd_eic->irq < 0)
590 return sprd_eic->irq;
592 for (i = 0; i < SPRD_EIC_MAX_BANK; i++) {
594 * We can have maximum 3 banks EICs, and each EIC has
595 * its own base address. But some platform maybe only
596 * have one bank EIC, thus base[1] and base[2] can be
599 res = platform_get_resource(pdev, IORESOURCE_MEM, i);
603 sprd_eic->base[i] = devm_ioremap_resource(&pdev->dev, res);
604 if (IS_ERR(sprd_eic->base[i]))
605 return PTR_ERR(sprd_eic->base[i]);
608 sprd_eic->chip.label = sprd_eic_label_name[sprd_eic->type];
609 sprd_eic->chip.ngpio = pdata->num_eics;
610 sprd_eic->chip.base = -1;
611 sprd_eic->chip.parent = &pdev->dev;
612 sprd_eic->chip.of_node = pdev->dev.of_node;
613 sprd_eic->chip.direction_input = sprd_eic_direction_input;
614 switch (sprd_eic->type) {
615 case SPRD_EIC_DEBOUNCE:
616 sprd_eic->chip.request = sprd_eic_request;
617 sprd_eic->chip.free = sprd_eic_free;
618 sprd_eic->chip.set_config = sprd_eic_set_config;
619 sprd_eic->chip.set = sprd_eic_set;
623 sprd_eic->chip.get = sprd_eic_get;
630 sprd_eic->intc.name = dev_name(&pdev->dev);
631 sprd_eic->intc.irq_ack = sprd_eic_irq_ack;
632 sprd_eic->intc.irq_mask = sprd_eic_irq_mask;
633 sprd_eic->intc.irq_unmask = sprd_eic_irq_unmask;
634 sprd_eic->intc.irq_set_type = sprd_eic_irq_set_type;
635 sprd_eic->intc.flags = IRQCHIP_SKIP_SET_WAKE;
637 irq = &sprd_eic->chip.irq;
638 irq->chip = &sprd_eic->intc;
639 irq->handler = handle_bad_irq;
640 irq->default_type = IRQ_TYPE_NONE;
641 irq->parent_handler = sprd_eic_irq_handler;
642 irq->parent_handler_data = sprd_eic;
643 irq->num_parents = 1;
644 irq->parents = &sprd_eic->irq;
646 ret = devm_gpiochip_add_data(&pdev->dev, &sprd_eic->chip, sprd_eic);
648 dev_err(&pdev->dev, "Could not register gpiochip %d.\n", ret);
652 platform_set_drvdata(pdev, sprd_eic);
656 static const struct of_device_id sprd_eic_of_match[] = {
658 .compatible = "sprd,sc9860-eic-debounce",
659 .data = &sc9860_eic_dbnc_data,
662 .compatible = "sprd,sc9860-eic-latch",
663 .data = &sc9860_eic_latch_data,
666 .compatible = "sprd,sc9860-eic-async",
667 .data = &sc9860_eic_async_data,
670 .compatible = "sprd,sc9860-eic-sync",
671 .data = &sc9860_eic_sync_data,
677 MODULE_DEVICE_TABLE(of, sprd_eic_of_match);
679 static struct platform_driver sprd_eic_driver = {
680 .probe = sprd_eic_probe,
683 .of_match_table = sprd_eic_of_match,
687 module_platform_driver(sprd_eic_driver);
689 MODULE_DESCRIPTION("Spreadtrum EIC driver");
690 MODULE_LICENSE("GPL v2");