1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * twl4030-irq.c - TWL4030/TPS659x0 irq support
5 * Copyright (C) 2005-2006 Texas Instruments, Inc.
7 * Modifications to defer interrupt handling to a kernel thread:
8 * Copyright (C) 2006 MontaVista Software, Inc.
10 * Based on tlv320aic23.c:
11 * Copyright (c) by Kai Svahn <kai.svahn@nokia.com>
13 * Code cleanup and modifications to IRQ handler.
14 * by syed khasim <x0khasim@ti.com>
17 #include <linux/device.h>
18 #include <linux/export.h>
19 #include <linux/interrupt.h>
20 #include <linux/irq.h>
21 #include <linux/slab.h>
23 #include <linux/irqdomain.h>
24 #include <linux/mfd/twl.h>
29 * TWL4030 IRQ handling has two stages in hardware, and thus in software.
30 * The Primary Interrupt Handler (PIH) stage exposes status bits saying
31 * which Secondary Interrupt Handler (SIH) stage is raising an interrupt.
32 * SIH modules are more traditional IRQ components, which support per-IRQ
33 * enable/disable and trigger controls; they do most of the work.
35 * These chips are designed to support IRQ handling from two different
36 * I2C masters. Each has a dedicated IRQ line, and dedicated IRQ status
37 * and mask registers in the PIH and SIH modules.
39 * We set up IRQs starting at a platform-specified base, always starting
40 * with PIH and the SIH for PWR_INT and then usually adding GPIO:
41 * base + 0 .. base + 7 PIH
42 * base + 8 .. base + 15 SIH for PWR_INT
43 * base + 16 .. base + 33 SIH for GPIO
45 #define TWL4030_CORE_NR_IRQS 8
46 #define TWL4030_PWR_NR_IRQS 8
48 /* PIH register offsets */
49 #define REG_PIH_ISR_P1 0x01
50 #define REG_PIH_ISR_P2 0x02
51 #define REG_PIH_SIR 0x03 /* for testing */
53 /* Linux could (eventually) use either IRQ line */
58 u8 module
; /* module id */
59 u8 control_offset
; /* for SIH_CTRL */
62 u8 bits
; /* valid in isr/imr */
63 u8 bytes_ixr
; /* bytelen of ISR/IMR/SIR */
66 u8 bytes_edr
; /* bytelen of EDR */
68 u8 irq_lines
; /* number of supported irq lines */
70 /* SIR ignored -- set interrupt, for testing only */
75 /* + 2 bytes padding */
78 static const struct sih
*sih_modules
;
79 static int nr_sih_modules
;
81 #define SIH_INITIALIZER(modname, nbits) \
82 .module = TWL4030_MODULE_ ## modname, \
83 .control_offset = TWL4030_ ## modname ## _SIH_CTRL, \
85 .bytes_ixr = DIV_ROUND_UP(nbits, 8), \
86 .edr_offset = TWL4030_ ## modname ## _EDR, \
87 .bytes_edr = DIV_ROUND_UP((2*(nbits)), 8), \
90 .isr_offset = TWL4030_ ## modname ## _ISR1, \
91 .imr_offset = TWL4030_ ## modname ## _IMR1, \
94 .isr_offset = TWL4030_ ## modname ## _ISR2, \
95 .imr_offset = TWL4030_ ## modname ## _IMR2, \
98 /* register naming policies are inconsistent ... */
99 #define TWL4030_INT_PWR_EDR TWL4030_INT_PWR_EDR1
100 #define TWL4030_MODULE_KEYPAD_KEYP TWL4030_MODULE_KEYPAD
101 #define TWL4030_MODULE_INT_PWR TWL4030_MODULE_INT
105 * Order in this table matches order in PIH_ISR. That is,
106 * BIT(n) in PIH_ISR is sih_modules[n].
108 /* sih_modules_twl4030 is used both in twl4030 and twl5030 */
109 static const struct sih sih_modules_twl4030
[6] = {
112 .module
= TWL4030_MODULE_GPIO
,
113 .control_offset
= REG_GPIO_SIH_CTRL
,
115 .bits
= TWL4030_GPIO_MAX
,
117 /* Note: *all* of these IRQs default to no-trigger */
118 .edr_offset
= REG_GPIO_EDR1
,
122 .isr_offset
= REG_GPIO_ISR1A
,
123 .imr_offset
= REG_GPIO_IMR1A
,
125 .isr_offset
= REG_GPIO_ISR1B
,
126 .imr_offset
= REG_GPIO_IMR1B
,
132 SIH_INITIALIZER(KEYPAD_KEYP
, 4)
136 .module
= TWL4030_MODULE_INTERRUPTS
,
137 .control_offset
= TWL4030_INTERRUPTS_BCISIHCTRL
,
141 .edr_offset
= TWL4030_INTERRUPTS_BCIEDR1
,
142 /* Note: most of these IRQs default to no-trigger */
146 .isr_offset
= TWL4030_INTERRUPTS_BCIISR1A
,
147 .imr_offset
= TWL4030_INTERRUPTS_BCIIMR1A
,
149 .isr_offset
= TWL4030_INTERRUPTS_BCIISR1B
,
150 .imr_offset
= TWL4030_INTERRUPTS_BCIIMR1B
,
155 SIH_INITIALIZER(MADC
, 4)
158 /* USB doesn't use the same SIH organization */
164 SIH_INITIALIZER(INT_PWR
, 8)
166 /* there are no SIH modules #6 or #7 ... */
169 static const struct sih sih_modules_twl5031
[8] = {
172 .module
= TWL4030_MODULE_GPIO
,
173 .control_offset
= REG_GPIO_SIH_CTRL
,
175 .bits
= TWL4030_GPIO_MAX
,
177 /* Note: *all* of these IRQs default to no-trigger */
178 .edr_offset
= REG_GPIO_EDR1
,
182 .isr_offset
= REG_GPIO_ISR1A
,
183 .imr_offset
= REG_GPIO_IMR1A
,
185 .isr_offset
= REG_GPIO_ISR1B
,
186 .imr_offset
= REG_GPIO_IMR1B
,
192 SIH_INITIALIZER(KEYPAD_KEYP
, 4)
196 .module
= TWL5031_MODULE_INTERRUPTS
,
197 .control_offset
= TWL5031_INTERRUPTS_BCISIHCTRL
,
200 .edr_offset
= TWL5031_INTERRUPTS_BCIEDR1
,
201 /* Note: most of these IRQs default to no-trigger */
205 .isr_offset
= TWL5031_INTERRUPTS_BCIISR1
,
206 .imr_offset
= TWL5031_INTERRUPTS_BCIIMR1
,
208 .isr_offset
= TWL5031_INTERRUPTS_BCIISR2
,
209 .imr_offset
= TWL5031_INTERRUPTS_BCIIMR2
,
214 SIH_INITIALIZER(MADC
, 4)
217 /* USB doesn't use the same SIH organization */
223 SIH_INITIALIZER(INT_PWR
, 8)
227 * ECI/DBI doesn't use the same SIH organization.
228 * For example, it supports only one interrupt output line.
229 * That is, the interrupts are seen on both INT1 and INT2 lines.
232 .module
= TWL5031_MODULE_ACCESSORY
,
237 .isr_offset
= TWL5031_ACIIDR_LSB
,
238 .imr_offset
= TWL5031_ACIIMR_LSB
,
243 /* Audio accessory */
245 .module
= TWL5031_MODULE_ACCESSORY
,
246 .control_offset
= TWL5031_ACCSIHCTRL
,
249 .edr_offset
= TWL5031_ACCEDR1
,
250 /* Note: most of these IRQs default to no-trigger */
254 .isr_offset
= TWL5031_ACCISR1
,
255 .imr_offset
= TWL5031_ACCIMR1
,
257 .isr_offset
= TWL5031_ACCISR2
,
258 .imr_offset
= TWL5031_ACCIMR2
,
263 #undef TWL4030_MODULE_KEYPAD_KEYP
264 #undef TWL4030_MODULE_INT_PWR
265 #undef TWL4030_INT_PWR_EDR
267 /*----------------------------------------------------------------------*/
269 static unsigned twl4030_irq_base
;
272 * handle_twl4030_pih() is the desc->handle method for the twl4030 interrupt.
273 * This is a chained interrupt, so there is no desc->action method for it.
274 * Now we need to query the interrupt controller in the twl4030 to determine
275 * which module is generating the interrupt request. However, we can't do i2c
276 * transactions in interrupt context, so we must defer that work to a kernel
277 * thread. All we do here is acknowledge and mask the interrupt and wakeup
280 static irqreturn_t
handle_twl4030_pih(int irq
, void *devid
)
285 ret
= twl_i2c_read_u8(TWL_MODULE_PIH
, &pih_isr
,
288 pr_warn("twl4030: I2C error %d reading PIH ISR\n", ret
);
293 unsigned long pending
= __ffs(pih_isr
);
296 pih_isr
&= ~BIT(pending
);
297 irq
= pending
+ twl4030_irq_base
;
298 handle_nested_irq(irq
);
304 /*----------------------------------------------------------------------*/
307 * twl4030_init_sih_modules() ... start from a known state where no
308 * IRQs will be coming in, and where we can quickly enable them then
309 * handle them as they arrive. Mask all IRQs: maybe init SIH_CTRL.
311 * NOTE: we don't touch EDR registers here; they stay with hardware
312 * defaults or whatever the last value was. Note that when both EDR
313 * bits for an IRQ are clear, that's as if its IMR bit is set...
315 static int twl4030_init_sih_modules(unsigned line
)
317 const struct sih
*sih
;
322 /* line 0 == int1_n signal; line 1 == int2_n signal */
328 /* disable all interrupts on our line */
329 memset(buf
, 0xff, sizeof(buf
));
331 for (i
= 0; i
< nr_sih_modules
; i
++, sih
++) {
332 /* skip USB -- it's funky */
336 /* Not all the SIH modules support multiple interrupt lines */
337 if (sih
->irq_lines
<= line
)
340 status
= twl_i2c_write(sih
->module
, buf
,
341 sih
->mask
[line
].imr_offset
, sih
->bytes_ixr
);
343 pr_err("twl4030: err %d initializing %s %s\n",
344 status
, sih
->name
, "IMR");
347 * Maybe disable "exclusive" mode; buffer second pending irq;
348 * set Clear-On-Read (COR) bit.
350 * NOTE that sometimes COR polarity is documented as being
351 * inverted: for MADC, COR=1 means "clear on write".
352 * And for PWR_INT it's not documented...
355 status
= twl_i2c_write_u8(sih
->module
,
356 TWL4030_SIH_CTRL_COR_MASK
,
357 sih
->control_offset
);
359 pr_err("twl4030: err %d initializing %s %s\n",
360 status
, sih
->name
, "SIH_CTRL");
365 for (i
= 0; i
< nr_sih_modules
; i
++, sih
++) {
373 /* Not all the SIH modules support multiple interrupt lines */
374 if (sih
->irq_lines
<= line
)
378 * Clear pending interrupt status. Either the read was
379 * enough, or we need to write those bits. Repeat, in
380 * case an IRQ is pending (PENDDIS=0) ... that's not
381 * uncommon with PWR_INT.PWRON.
383 for (j
= 0; j
< 2; j
++) {
384 status
= twl_i2c_read(sih
->module
, rxbuf
,
385 sih
->mask
[line
].isr_offset
, sih
->bytes_ixr
);
387 pr_warn("twl4030: err %d initializing %s %s\n",
388 status
, sih
->name
, "ISR");
391 status
= twl_i2c_write(sih
->module
, buf
,
392 sih
->mask
[line
].isr_offset
,
395 pr_warn("twl4030: write failed: %d\n",
399 * else COR=1 means read sufficed.
400 * (for most SIH modules...)
408 static inline void activate_irq(int irq
)
410 irq_clear_status_flags(irq
, IRQ_NOREQUEST
| IRQ_NOPROBE
);
413 /*----------------------------------------------------------------------*/
417 const struct sih
*sih
;
420 bool imr_change_pending
;
424 struct mutex irq_lock
;
428 /*----------------------------------------------------------------------*/
431 * All irq_chip methods get issued from code holding irq_desc[irq].lock,
432 * which can't perform the underlying I2C operations (because they sleep).
433 * So we must hand them off to a thread (workqueue) and cope with asynch
434 * completion, potentially including some re-ordering, of these requests.
437 static void twl4030_sih_mask(struct irq_data
*data
)
439 struct sih_agent
*agent
= irq_data_get_irq_chip_data(data
);
441 agent
->imr
|= BIT(data
->irq
- agent
->irq_base
);
442 agent
->imr_change_pending
= true;
445 static void twl4030_sih_unmask(struct irq_data
*data
)
447 struct sih_agent
*agent
= irq_data_get_irq_chip_data(data
);
449 agent
->imr
&= ~BIT(data
->irq
- agent
->irq_base
);
450 agent
->imr_change_pending
= true;
453 static int twl4030_sih_set_type(struct irq_data
*data
, unsigned trigger
)
455 struct sih_agent
*agent
= irq_data_get_irq_chip_data(data
);
457 if (trigger
& ~(IRQ_TYPE_EDGE_FALLING
| IRQ_TYPE_EDGE_RISING
))
460 if (irqd_get_trigger_type(data
) != trigger
)
461 agent
->edge_change
|= BIT(data
->irq
- agent
->irq_base
);
466 static void twl4030_sih_bus_lock(struct irq_data
*data
)
468 struct sih_agent
*agent
= irq_data_get_irq_chip_data(data
);
470 mutex_lock(&agent
->irq_lock
);
473 static void twl4030_sih_bus_sync_unlock(struct irq_data
*data
)
475 struct sih_agent
*agent
= irq_data_get_irq_chip_data(data
);
476 const struct sih
*sih
= agent
->sih
;
479 if (agent
->imr_change_pending
) {
485 /* byte[0] gets overwritten as we write ... */
486 imr
.word
= cpu_to_le32(agent
->imr
);
487 agent
->imr_change_pending
= false;
489 /* write the whole mask ... simpler than subsetting it */
490 status
= twl_i2c_write(sih
->module
, imr
.bytes
,
491 sih
->mask
[irq_line
].imr_offset
,
494 pr_err("twl4030: %s, %s --> %d\n", __func__
,
498 if (agent
->edge_change
) {
502 edge_change
= agent
->edge_change
;
503 agent
->edge_change
= 0;
506 * Read, reserving first byte for write scratch. Yes, this
507 * could be cached for some speedup ... but be careful about
508 * any processor on the other IRQ line, EDR registers are
511 status
= twl_i2c_read(sih
->module
, bytes
,
512 sih
->edr_offset
, sih
->bytes_edr
);
514 pr_err("twl4030: %s, %s --> %d\n", __func__
,
519 /* Modify only the bits we know must change */
520 while (edge_change
) {
521 int i
= fls(edge_change
) - 1;
523 int off
= (i
& 0x3) * 2;
526 bytes
[byte
] &= ~(0x03 << off
);
528 type
= irq_get_trigger_type(i
+ agent
->irq_base
);
529 if (type
& IRQ_TYPE_EDGE_RISING
)
530 bytes
[byte
] |= BIT(off
+ 1);
531 if (type
& IRQ_TYPE_EDGE_FALLING
)
532 bytes
[byte
] |= BIT(off
+ 0);
534 edge_change
&= ~BIT(i
);
538 status
= twl_i2c_write(sih
->module
, bytes
,
539 sih
->edr_offset
, sih
->bytes_edr
);
541 pr_err("twl4030: %s, %s --> %d\n", __func__
,
545 mutex_unlock(&agent
->irq_lock
);
548 static struct irq_chip twl4030_sih_irq_chip
= {
550 .irq_mask
= twl4030_sih_mask
,
551 .irq_unmask
= twl4030_sih_unmask
,
552 .irq_set_type
= twl4030_sih_set_type
,
553 .irq_bus_lock
= twl4030_sih_bus_lock
,
554 .irq_bus_sync_unlock
= twl4030_sih_bus_sync_unlock
,
555 .flags
= IRQCHIP_SKIP_SET_WAKE
,
558 /*----------------------------------------------------------------------*/
560 static inline int sih_read_isr(const struct sih
*sih
)
568 /* FIXME need retry-on-error ... */
571 status
= twl_i2c_read(sih
->module
, isr
.bytes
,
572 sih
->mask
[irq_line
].isr_offset
, sih
->bytes_ixr
);
574 return (status
< 0) ? status
: le32_to_cpu(isr
.word
);
578 * Generic handler for SIH interrupts ... we "know" this is called
579 * in task context, with IRQs enabled.
581 static irqreturn_t
handle_twl4030_sih(int irq
, void *data
)
583 struct sih_agent
*agent
= irq_get_handler_data(irq
);
584 const struct sih
*sih
= agent
->sih
;
587 /* reading ISR acks the IRQs, using clear-on-read mode */
588 isr
= sih_read_isr(sih
);
591 pr_err("twl4030: %s SIH, read ISR error %d\n",
593 /* REVISIT: recover; eventually mask it all, etc */
603 handle_nested_irq(agent
->irq_base
+ irq
);
605 pr_err("twl4030: %s SIH, invalid ISR bit %d\n",
611 /* returns the first IRQ used by this SIH bank, or negative errno */
612 int twl4030_sih_setup(struct device
*dev
, int module
, int irq_base
)
615 const struct sih
*sih
= NULL
;
616 struct sih_agent
*agent
;
618 int status
= -EINVAL
;
620 /* only support modules with standard clear-on-read for now */
621 for (sih_mod
= 0, sih
= sih_modules
; sih_mod
< nr_sih_modules
;
623 if (sih
->module
== module
&& sih
->set_cor
) {
630 dev_err(dev
, "module to setup SIH for not found\n");
634 agent
= kzalloc(sizeof(*agent
), GFP_KERNEL
);
638 agent
->irq_base
= irq_base
;
641 mutex_init(&agent
->irq_lock
);
643 for (i
= 0; i
< sih
->bits
; i
++) {
646 irq_set_chip_data(irq
, agent
);
647 irq_set_chip_and_handler(irq
, &twl4030_sih_irq_chip
,
649 irq_set_nested_thread(irq
, 1);
653 /* replace generic PIH handler (handle_simple_irq) */
654 irq
= sih_mod
+ twl4030_irq_base
;
655 irq_set_handler_data(irq
, agent
);
656 agent
->irq_name
= kasprintf(GFP_KERNEL
, "twl4030_%s", sih
->name
);
657 status
= request_threaded_irq(irq
, NULL
, handle_twl4030_sih
,
658 IRQF_EARLY_RESUME
| IRQF_ONESHOT
,
659 agent
->irq_name
?: sih
->name
, NULL
);
661 dev_info(dev
, "%s (irq %d) chaining IRQs %d..%d\n", sih
->name
,
662 irq
, irq_base
, irq_base
+ i
- 1);
664 return status
< 0 ? status
: irq_base
;
667 /* FIXME need a call to reverse twl4030_sih_setup() ... */
669 /*----------------------------------------------------------------------*/
671 /* FIXME pass in which interrupt line we'll use ... */
672 #define twl_irq_line 0
674 int twl4030_init_irq(struct device
*dev
, int irq_num
)
676 static struct irq_chip twl4030_irq_chip
;
678 int irq_base
, irq_end
, nr_irqs
;
679 struct device_node
*node
= dev
->of_node
;
682 * TWL core and pwr interrupts must be contiguous because
683 * the hwirqs numbers are defined contiguously from 1 to 15.
684 * Create only one domain for both.
686 nr_irqs
= TWL4030_PWR_NR_IRQS
+ TWL4030_CORE_NR_IRQS
;
688 irq_base
= irq_alloc_descs(-1, 0, nr_irqs
, 0);
690 dev_err(dev
, "Fail to allocate IRQ descs\n");
694 irq_domain_add_legacy(node
, nr_irqs
, irq_base
, 0,
695 &irq_domain_simple_ops
, NULL
);
697 irq_end
= irq_base
+ TWL4030_CORE_NR_IRQS
;
700 * Mask and clear all TWL4030 interrupts since initially we do
701 * not have any TWL4030 module interrupt handlers present
703 status
= twl4030_init_sih_modules(twl_irq_line
);
707 twl4030_irq_base
= irq_base
;
710 * Install an irq handler for each of the SIH modules;
711 * clone dummy irq_chip since PIH can't *do* anything
713 twl4030_irq_chip
= dummy_irq_chip
;
714 twl4030_irq_chip
.name
= "twl4030";
716 twl4030_sih_irq_chip
.irq_ack
= dummy_irq_chip
.irq_ack
;
718 for (i
= irq_base
; i
< irq_end
; i
++) {
719 irq_set_chip_and_handler(i
, &twl4030_irq_chip
,
721 irq_set_nested_thread(i
, 1);
725 dev_info(dev
, "%s (irq %d) chaining IRQs %d..%d\n", "PIH",
726 irq_num
, irq_base
, irq_end
);
728 /* ... and the PWR_INT module ... */
729 status
= twl4030_sih_setup(dev
, TWL4030_MODULE_INT
, irq_end
);
731 dev_err(dev
, "sih_setup PWR INT --> %d\n", status
);
735 /* install an irq handler to demultiplex the TWL4030 interrupt */
736 status
= request_threaded_irq(irq_num
, NULL
, handle_twl4030_pih
,
738 "TWL4030-PIH", NULL
);
740 dev_err(dev
, "could not claim irq%d: %d\n", irq_num
, status
);
743 enable_irq_wake(irq_num
);
747 /* clean up twl4030_sih_setup */
749 for (i
= irq_base
; i
< irq_end
; i
++) {
750 irq_set_nested_thread(i
, 0);
751 irq_set_chip_and_handler(i
, NULL
, NULL
);
757 void twl4030_exit_irq(void)
759 /* FIXME undo twl_init_irq() */
760 if (twl4030_irq_base
)
761 pr_err("twl4030: can't yet clean up IRQs?\n");
764 int twl4030_init_chip_irq(const char *chip
)
766 if (!strcmp(chip
, "twl5031")) {
767 sih_modules
= sih_modules_twl5031
;
768 nr_sih_modules
= ARRAY_SIZE(sih_modules_twl5031
);
770 sih_modules
= sih_modules_twl4030
;
771 nr_sih_modules
= ARRAY_SIZE(sih_modules_twl4030
);