2 * twl4030-irq.c - TWL4030/TPS659x0 irq support
4 * Copyright (C) 2005-2006 Texas Instruments, Inc.
6 * Modifications to defer interrupt handling to a kernel thread:
7 * Copyright (C) 2006 MontaVista Software, Inc.
9 * Based on tlv320aic23.c:
10 * Copyright (c) by Kai Svahn <kai.svahn@nokia.com>
12 * Code cleanup and modifications to IRQ handler.
13 * by syed khasim <x0khasim@ti.com>
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program; if not, write to the Free Software
27 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 #include <linux/init.h>
31 #include <linux/export.h>
32 #include <linux/interrupt.h>
33 #include <linux/irq.h>
34 #include <linux/slab.h>
36 #include <linux/irqdomain.h>
37 #include <linux/i2c/twl.h>
42 * TWL4030 IRQ handling has two stages in hardware, and thus in software.
43 * The Primary Interrupt Handler (PIH) stage exposes status bits saying
44 * which Secondary Interrupt Handler (SIH) stage is raising an interrupt.
45 * SIH modules are more traditional IRQ components, which support per-IRQ
46 * enable/disable and trigger controls; they do most of the work.
48 * These chips are designed to support IRQ handling from two different
49 * I2C masters. Each has a dedicated IRQ line, and dedicated IRQ status
50 * and mask registers in the PIH and SIH modules.
52 * We set up IRQs starting at a platform-specified base, always starting
53 * with PIH and the SIH for PWR_INT and then usually adding GPIO:
54 * base + 0 .. base + 7 PIH
55 * base + 8 .. base + 15 SIH for PWR_INT
56 * base + 16 .. base + 33 SIH for GPIO
58 #define TWL4030_CORE_NR_IRQS 8
59 #define TWL4030_PWR_NR_IRQS 8
61 /* PIH register offsets */
62 #define REG_PIH_ISR_P1 0x01
63 #define REG_PIH_ISR_P2 0x02
64 #define REG_PIH_SIR 0x03 /* for testing */
66 /* Linux could (eventually) use either IRQ line */
71 u8 module; /* module id */
72 u8 control_offset; /* for SIH_CTRL */
75 u8 bits; /* valid in isr/imr */
76 u8 bytes_ixr; /* bytelen of ISR/IMR/SIR */
79 u8 bytes_edr; /* bytelen of EDR */
81 u8 irq_lines; /* number of supported irq lines */
83 /* SIR ignored -- set interrupt, for testing only */
88 /* + 2 bytes padding */
91 static const struct sih *sih_modules;
92 static int nr_sih_modules;
94 #define SIH_INITIALIZER(modname, nbits) \
95 .module = TWL4030_MODULE_ ## modname, \
96 .control_offset = TWL4030_ ## modname ## _SIH_CTRL, \
98 .bytes_ixr = DIV_ROUND_UP(nbits, 8), \
99 .edr_offset = TWL4030_ ## modname ## _EDR, \
100 .bytes_edr = DIV_ROUND_UP((2*(nbits)), 8), \
103 .isr_offset = TWL4030_ ## modname ## _ISR1, \
104 .imr_offset = TWL4030_ ## modname ## _IMR1, \
107 .isr_offset = TWL4030_ ## modname ## _ISR2, \
108 .imr_offset = TWL4030_ ## modname ## _IMR2, \
111 /* register naming policies are inconsistent ... */
112 #define TWL4030_INT_PWR_EDR TWL4030_INT_PWR_EDR1
113 #define TWL4030_MODULE_KEYPAD_KEYP TWL4030_MODULE_KEYPAD
114 #define TWL4030_MODULE_INT_PWR TWL4030_MODULE_INT
118 * Order in this table matches order in PIH_ISR. That is,
119 * BIT(n) in PIH_ISR is sih_modules[n].
121 /* sih_modules_twl4030 is used both in twl4030 and twl5030 */
122 static const struct sih sih_modules_twl4030[6] = {
125 .module = TWL4030_MODULE_GPIO,
126 .control_offset = REG_GPIO_SIH_CTRL,
128 .bits = TWL4030_GPIO_MAX,
130 /* Note: *all* of these IRQs default to no-trigger */
131 .edr_offset = REG_GPIO_EDR1,
135 .isr_offset = REG_GPIO_ISR1A,
136 .imr_offset = REG_GPIO_IMR1A,
138 .isr_offset = REG_GPIO_ISR1B,
139 .imr_offset = REG_GPIO_IMR1B,
145 SIH_INITIALIZER(KEYPAD_KEYP, 4)
149 .module = TWL4030_MODULE_INTERRUPTS,
150 .control_offset = TWL4030_INTERRUPTS_BCISIHCTRL,
154 .edr_offset = TWL4030_INTERRUPTS_BCIEDR1,
155 /* Note: most of these IRQs default to no-trigger */
159 .isr_offset = TWL4030_INTERRUPTS_BCIISR1A,
160 .imr_offset = TWL4030_INTERRUPTS_BCIIMR1A,
162 .isr_offset = TWL4030_INTERRUPTS_BCIISR1B,
163 .imr_offset = TWL4030_INTERRUPTS_BCIIMR1B,
168 SIH_INITIALIZER(MADC, 4)
171 /* USB doesn't use the same SIH organization */
177 SIH_INITIALIZER(INT_PWR, 8)
179 /* there are no SIH modules #6 or #7 ... */
182 static const struct sih sih_modules_twl5031[8] = {
185 .module = TWL4030_MODULE_GPIO,
186 .control_offset = REG_GPIO_SIH_CTRL,
188 .bits = TWL4030_GPIO_MAX,
190 /* Note: *all* of these IRQs default to no-trigger */
191 .edr_offset = REG_GPIO_EDR1,
195 .isr_offset = REG_GPIO_ISR1A,
196 .imr_offset = REG_GPIO_IMR1A,
198 .isr_offset = REG_GPIO_ISR1B,
199 .imr_offset = REG_GPIO_IMR1B,
205 SIH_INITIALIZER(KEYPAD_KEYP, 4)
209 .module = TWL5031_MODULE_INTERRUPTS,
210 .control_offset = TWL5031_INTERRUPTS_BCISIHCTRL,
213 .edr_offset = TWL5031_INTERRUPTS_BCIEDR1,
214 /* Note: most of these IRQs default to no-trigger */
218 .isr_offset = TWL5031_INTERRUPTS_BCIISR1,
219 .imr_offset = TWL5031_INTERRUPTS_BCIIMR1,
221 .isr_offset = TWL5031_INTERRUPTS_BCIISR2,
222 .imr_offset = TWL5031_INTERRUPTS_BCIIMR2,
227 SIH_INITIALIZER(MADC, 4)
230 /* USB doesn't use the same SIH organization */
236 SIH_INITIALIZER(INT_PWR, 8)
240 * ECI/DBI doesn't use the same SIH organization.
241 * For example, it supports only one interrupt output line.
242 * That is, the interrupts are seen on both INT1 and INT2 lines.
245 .module = TWL5031_MODULE_ACCESSORY,
250 .isr_offset = TWL5031_ACIIDR_LSB,
251 .imr_offset = TWL5031_ACIIMR_LSB,
256 /* Audio accessory */
258 .module = TWL5031_MODULE_ACCESSORY,
259 .control_offset = TWL5031_ACCSIHCTRL,
262 .edr_offset = TWL5031_ACCEDR1,
263 /* Note: most of these IRQs default to no-trigger */
267 .isr_offset = TWL5031_ACCISR1,
268 .imr_offset = TWL5031_ACCIMR1,
270 .isr_offset = TWL5031_ACCISR2,
271 .imr_offset = TWL5031_ACCIMR2,
276 #undef TWL4030_MODULE_KEYPAD_KEYP
277 #undef TWL4030_MODULE_INT_PWR
278 #undef TWL4030_INT_PWR_EDR
280 /*----------------------------------------------------------------------*/
282 static unsigned twl4030_irq_base;
285 * handle_twl4030_pih() is the desc->handle method for the twl4030 interrupt.
286 * This is a chained interrupt, so there is no desc->action method for it.
287 * Now we need to query the interrupt controller in the twl4030 to determine
288 * which module is generating the interrupt request. However, we can't do i2c
289 * transactions in interrupt context, so we must defer that work to a kernel
290 * thread. All we do here is acknowledge and mask the interrupt and wakeup
293 static irqreturn_t handle_twl4030_pih(int irq, void *devid)
298 ret = twl_i2c_read_u8(TWL_MODULE_PIH, &pih_isr,
301 pr_warning("twl4030: I2C error %d reading PIH ISR\n", ret);
306 unsigned long pending = __ffs(pih_isr);
309 pih_isr &= ~BIT(pending);
310 irq = pending + twl4030_irq_base;
311 handle_nested_irq(irq);
317 /*----------------------------------------------------------------------*/
320 * twl4030_init_sih_modules() ... start from a known state where no
321 * IRQs will be coming in, and where we can quickly enable them then
322 * handle them as they arrive. Mask all IRQs: maybe init SIH_CTRL.
324 * NOTE: we don't touch EDR registers here; they stay with hardware
325 * defaults or whatever the last value was. Note that when both EDR
326 * bits for an IRQ are clear, that's as if its IMR bit is set...
328 static int twl4030_init_sih_modules(unsigned line)
330 const struct sih *sih;
335 /* line 0 == int1_n signal; line 1 == int2_n signal */
341 /* disable all interrupts on our line */
342 memset(buf, 0xff, sizeof buf);
344 for (i = 0; i < nr_sih_modules; i++, sih++) {
345 /* skip USB -- it's funky */
349 /* Not all the SIH modules support multiple interrupt lines */
350 if (sih->irq_lines <= line)
353 status = twl_i2c_write(sih->module, buf,
354 sih->mask[line].imr_offset, sih->bytes_ixr);
356 pr_err("twl4030: err %d initializing %s %s\n",
357 status, sih->name, "IMR");
360 * Maybe disable "exclusive" mode; buffer second pending irq;
361 * set Clear-On-Read (COR) bit.
363 * NOTE that sometimes COR polarity is documented as being
364 * inverted: for MADC, COR=1 means "clear on write".
365 * And for PWR_INT it's not documented...
368 status = twl_i2c_write_u8(sih->module,
369 TWL4030_SIH_CTRL_COR_MASK,
370 sih->control_offset);
372 pr_err("twl4030: err %d initializing %s %s\n",
373 status, sih->name, "SIH_CTRL");
378 for (i = 0; i < nr_sih_modules; i++, sih++) {
386 /* Not all the SIH modules support multiple interrupt lines */
387 if (sih->irq_lines <= line)
391 * Clear pending interrupt status. Either the read was
392 * enough, or we need to write those bits. Repeat, in
393 * case an IRQ is pending (PENDDIS=0) ... that's not
394 * uncommon with PWR_INT.PWRON.
396 for (j = 0; j < 2; j++) {
397 status = twl_i2c_read(sih->module, rxbuf,
398 sih->mask[line].isr_offset, sih->bytes_ixr);
400 pr_err("twl4030: err %d initializing %s %s\n",
401 status, sih->name, "ISR");
404 status = twl_i2c_write(sih->module, buf,
405 sih->mask[line].isr_offset,
408 * else COR=1 means read sufficed.
409 * (for most SIH modules...)
417 static inline void activate_irq(int irq)
421 * ARM requires an extra step to clear IRQ_NOREQUEST, which it
422 * sets on behalf of every irq_chip. Also sets IRQ_NOPROBE.
424 set_irq_flags(irq, IRQF_VALID);
426 /* same effect on other architectures */
427 irq_set_noprobe(irq);
431 /*----------------------------------------------------------------------*/
435 const struct sih *sih;
438 bool imr_change_pending;
442 struct mutex irq_lock;
446 /*----------------------------------------------------------------------*/
449 * All irq_chip methods get issued from code holding irq_desc[irq].lock,
450 * which can't perform the underlying I2C operations (because they sleep).
451 * So we must hand them off to a thread (workqueue) and cope with asynch
452 * completion, potentially including some re-ordering, of these requests.
455 static void twl4030_sih_mask(struct irq_data *data)
457 struct sih_agent *agent = irq_data_get_irq_chip_data(data);
459 agent->imr |= BIT(data->irq - agent->irq_base);
460 agent->imr_change_pending = true;
463 static void twl4030_sih_unmask(struct irq_data *data)
465 struct sih_agent *agent = irq_data_get_irq_chip_data(data);
467 agent->imr &= ~BIT(data->irq - agent->irq_base);
468 agent->imr_change_pending = true;
471 static int twl4030_sih_set_type(struct irq_data *data, unsigned trigger)
473 struct sih_agent *agent = irq_data_get_irq_chip_data(data);
475 if (trigger & ~(IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
478 if (irqd_get_trigger_type(data) != trigger)
479 agent->edge_change |= BIT(data->irq - agent->irq_base);
484 static void twl4030_sih_bus_lock(struct irq_data *data)
486 struct sih_agent *agent = irq_data_get_irq_chip_data(data);
488 mutex_lock(&agent->irq_lock);
491 static void twl4030_sih_bus_sync_unlock(struct irq_data *data)
493 struct sih_agent *agent = irq_data_get_irq_chip_data(data);
494 const struct sih *sih = agent->sih;
497 if (agent->imr_change_pending) {
503 /* byte[0] gets overwritten as we write ... */
504 imr.word = cpu_to_le32(agent->imr);
505 agent->imr_change_pending = false;
507 /* write the whole mask ... simpler than subsetting it */
508 status = twl_i2c_write(sih->module, imr.bytes,
509 sih->mask[irq_line].imr_offset,
512 pr_err("twl4030: %s, %s --> %d\n", __func__,
516 if (agent->edge_change) {
520 edge_change = agent->edge_change;
521 agent->edge_change = 0;
524 * Read, reserving first byte for write scratch. Yes, this
525 * could be cached for some speedup ... but be careful about
526 * any processor on the other IRQ line, EDR registers are
529 status = twl_i2c_read(sih->module, bytes,
530 sih->edr_offset, sih->bytes_edr);
532 pr_err("twl4030: %s, %s --> %d\n", __func__,
537 /* Modify only the bits we know must change */
538 while (edge_change) {
539 int i = fls(edge_change) - 1;
541 int off = (i & 0x3) * 2;
544 bytes[byte] &= ~(0x03 << off);
546 type = irq_get_trigger_type(i + agent->irq_base);
547 if (type & IRQ_TYPE_EDGE_RISING)
548 bytes[byte] |= BIT(off + 1);
549 if (type & IRQ_TYPE_EDGE_FALLING)
550 bytes[byte] |= BIT(off + 0);
552 edge_change &= ~BIT(i);
556 status = twl_i2c_write(sih->module, bytes,
557 sih->edr_offset, sih->bytes_edr);
559 pr_err("twl4030: %s, %s --> %d\n", __func__,
563 mutex_unlock(&agent->irq_lock);
566 static struct irq_chip twl4030_sih_irq_chip = {
568 .irq_mask = twl4030_sih_mask,
569 .irq_unmask = twl4030_sih_unmask,
570 .irq_set_type = twl4030_sih_set_type,
571 .irq_bus_lock = twl4030_sih_bus_lock,
572 .irq_bus_sync_unlock = twl4030_sih_bus_sync_unlock,
575 /*----------------------------------------------------------------------*/
577 static inline int sih_read_isr(const struct sih *sih)
585 /* FIXME need retry-on-error ... */
588 status = twl_i2c_read(sih->module, isr.bytes,
589 sih->mask[irq_line].isr_offset, sih->bytes_ixr);
591 return (status < 0) ? status : le32_to_cpu(isr.word);
595 * Generic handler for SIH interrupts ... we "know" this is called
596 * in task context, with IRQs enabled.
598 static irqreturn_t handle_twl4030_sih(int irq, void *data)
600 struct sih_agent *agent = irq_get_handler_data(irq);
601 const struct sih *sih = agent->sih;
604 /* reading ISR acks the IRQs, using clear-on-read mode */
605 isr = sih_read_isr(sih);
608 pr_err("twl4030: %s SIH, read ISR error %d\n",
610 /* REVISIT: recover; eventually mask it all, etc */
620 handle_nested_irq(agent->irq_base + irq);
622 pr_err("twl4030: %s SIH, invalid ISR bit %d\n",
628 /* returns the first IRQ used by this SIH bank, or negative errno */
629 int twl4030_sih_setup(struct device *dev, int module, int irq_base)
632 const struct sih *sih = NULL;
633 struct sih_agent *agent;
635 int status = -EINVAL;
637 /* only support modules with standard clear-on-read for now */
638 for (sih_mod = 0, sih = sih_modules; sih_mod < nr_sih_modules;
640 if (sih->module == module && sih->set_cor) {
649 agent = kzalloc(sizeof *agent, GFP_KERNEL);
653 agent->irq_base = irq_base;
656 mutex_init(&agent->irq_lock);
658 for (i = 0; i < sih->bits; i++) {
661 irq_set_chip_data(irq, agent);
662 irq_set_chip_and_handler(irq, &twl4030_sih_irq_chip,
664 irq_set_nested_thread(irq, 1);
668 /* replace generic PIH handler (handle_simple_irq) */
669 irq = sih_mod + twl4030_irq_base;
670 irq_set_handler_data(irq, agent);
671 agent->irq_name = kasprintf(GFP_KERNEL, "twl4030_%s", sih->name);
672 status = request_threaded_irq(irq, NULL, handle_twl4030_sih,
674 agent->irq_name ?: sih->name, NULL);
676 dev_info(dev, "%s (irq %d) chaining IRQs %d..%d\n", sih->name,
677 irq, irq_base, irq_base + i - 1);
679 return status < 0 ? status : irq_base;
682 /* FIXME need a call to reverse twl4030_sih_setup() ... */
684 /*----------------------------------------------------------------------*/
686 /* FIXME pass in which interrupt line we'll use ... */
687 #define twl_irq_line 0
689 int twl4030_init_irq(struct device *dev, int irq_num)
691 static struct irq_chip twl4030_irq_chip;
693 int irq_base, irq_end, nr_irqs;
694 struct device_node *node = dev->of_node;
697 * TWL core and pwr interrupts must be contiguous because
698 * the hwirqs numbers are defined contiguously from 1 to 15.
699 * Create only one domain for both.
701 nr_irqs = TWL4030_PWR_NR_IRQS + TWL4030_CORE_NR_IRQS;
703 irq_base = irq_alloc_descs(-1, 0, nr_irqs, 0);
704 if (IS_ERR_VALUE(irq_base)) {
705 dev_err(dev, "Fail to allocate IRQ descs\n");
709 irq_domain_add_legacy(node, nr_irqs, irq_base, 0,
710 &irq_domain_simple_ops, NULL);
712 irq_end = irq_base + TWL4030_CORE_NR_IRQS;
715 * Mask and clear all TWL4030 interrupts since initially we do
716 * not have any TWL4030 module interrupt handlers present
718 status = twl4030_init_sih_modules(twl_irq_line);
722 twl4030_irq_base = irq_base;
725 * Install an irq handler for each of the SIH modules;
726 * clone dummy irq_chip since PIH can't *do* anything
728 twl4030_irq_chip = dummy_irq_chip;
729 twl4030_irq_chip.name = "twl4030";
731 twl4030_sih_irq_chip.irq_ack = dummy_irq_chip.irq_ack;
733 for (i = irq_base; i < irq_end; i++) {
734 irq_set_chip_and_handler(i, &twl4030_irq_chip,
736 irq_set_nested_thread(i, 1);
740 dev_info(dev, "%s (irq %d) chaining IRQs %d..%d\n", "PIH",
741 irq_num, irq_base, irq_end);
743 /* ... and the PWR_INT module ... */
744 status = twl4030_sih_setup(dev, TWL4030_MODULE_INT, irq_end);
746 dev_err(dev, "sih_setup PWR INT --> %d\n", status);
750 /* install an irq handler to demultiplex the TWL4030 interrupt */
751 status = request_threaded_irq(irq_num, NULL, handle_twl4030_pih,
753 "TWL4030-PIH", NULL);
755 dev_err(dev, "could not claim irq%d: %d\n", irq_num, status);
758 enable_irq_wake(irq_num);
762 /* clean up twl4030_sih_setup */
764 for (i = irq_base; i < irq_end; i++) {
765 irq_set_nested_thread(i, 0);
766 irq_set_chip_and_handler(i, NULL, NULL);
772 int twl4030_exit_irq(void)
774 /* FIXME undo twl_init_irq() */
775 if (twl4030_irq_base) {
776 pr_err("twl4030: can't yet clean up IRQs?\n");
782 int twl4030_init_chip_irq(const char *chip)
784 if (!strcmp(chip, "twl5031")) {
785 sih_modules = sih_modules_twl5031;
786 nr_sih_modules = ARRAY_SIZE(sih_modules_twl5031);
788 sih_modules = sih_modules_twl4030;
789 nr_sih_modules = ARRAY_SIZE(sih_modules_twl4030);