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/export.h>
31 #include <linux/interrupt.h>
32 #include <linux/irq.h>
33 #include <linux/slab.h>
35 #include <linux/irqdomain.h>
36 #include <linux/i2c/twl.h>
41 * TWL4030 IRQ handling has two stages in hardware, and thus in software.
42 * The Primary Interrupt Handler (PIH) stage exposes status bits saying
43 * which Secondary Interrupt Handler (SIH) stage is raising an interrupt.
44 * SIH modules are more traditional IRQ components, which support per-IRQ
45 * enable/disable and trigger controls; they do most of the work.
47 * These chips are designed to support IRQ handling from two different
48 * I2C masters. Each has a dedicated IRQ line, and dedicated IRQ status
49 * and mask registers in the PIH and SIH modules.
51 * We set up IRQs starting at a platform-specified base, always starting
52 * with PIH and the SIH for PWR_INT and then usually adding GPIO:
53 * base + 0 .. base + 7 PIH
54 * base + 8 .. base + 15 SIH for PWR_INT
55 * base + 16 .. base + 33 SIH for GPIO
57 #define TWL4030_CORE_NR_IRQS 8
58 #define TWL4030_PWR_NR_IRQS 8
60 /* PIH register offsets */
61 #define REG_PIH_ISR_P1 0x01
62 #define REG_PIH_ISR_P2 0x02
63 #define REG_PIH_SIR 0x03 /* for testing */
65 /* Linux could (eventually) use either IRQ line */
70 u8 module; /* module id */
71 u8 control_offset; /* for SIH_CTRL */
74 u8 bits; /* valid in isr/imr */
75 u8 bytes_ixr; /* bytelen of ISR/IMR/SIR */
78 u8 bytes_edr; /* bytelen of EDR */
80 u8 irq_lines; /* number of supported irq lines */
82 /* SIR ignored -- set interrupt, for testing only */
87 /* + 2 bytes padding */
90 static const struct sih *sih_modules;
91 static int nr_sih_modules;
93 #define SIH_INITIALIZER(modname, nbits) \
94 .module = TWL4030_MODULE_ ## modname, \
95 .control_offset = TWL4030_ ## modname ## _SIH_CTRL, \
97 .bytes_ixr = DIV_ROUND_UP(nbits, 8), \
98 .edr_offset = TWL4030_ ## modname ## _EDR, \
99 .bytes_edr = DIV_ROUND_UP((2*(nbits)), 8), \
102 .isr_offset = TWL4030_ ## modname ## _ISR1, \
103 .imr_offset = TWL4030_ ## modname ## _IMR1, \
106 .isr_offset = TWL4030_ ## modname ## _ISR2, \
107 .imr_offset = TWL4030_ ## modname ## _IMR2, \
110 /* register naming policies are inconsistent ... */
111 #define TWL4030_INT_PWR_EDR TWL4030_INT_PWR_EDR1
112 #define TWL4030_MODULE_KEYPAD_KEYP TWL4030_MODULE_KEYPAD
113 #define TWL4030_MODULE_INT_PWR TWL4030_MODULE_INT
117 * Order in this table matches order in PIH_ISR. That is,
118 * BIT(n) in PIH_ISR is sih_modules[n].
120 /* sih_modules_twl4030 is used both in twl4030 and twl5030 */
121 static const struct sih sih_modules_twl4030[6] = {
124 .module = TWL4030_MODULE_GPIO,
125 .control_offset = REG_GPIO_SIH_CTRL,
127 .bits = TWL4030_GPIO_MAX,
129 /* Note: *all* of these IRQs default to no-trigger */
130 .edr_offset = REG_GPIO_EDR1,
134 .isr_offset = REG_GPIO_ISR1A,
135 .imr_offset = REG_GPIO_IMR1A,
137 .isr_offset = REG_GPIO_ISR1B,
138 .imr_offset = REG_GPIO_IMR1B,
144 SIH_INITIALIZER(KEYPAD_KEYP, 4)
148 .module = TWL4030_MODULE_INTERRUPTS,
149 .control_offset = TWL4030_INTERRUPTS_BCISIHCTRL,
153 .edr_offset = TWL4030_INTERRUPTS_BCIEDR1,
154 /* Note: most of these IRQs default to no-trigger */
158 .isr_offset = TWL4030_INTERRUPTS_BCIISR1A,
159 .imr_offset = TWL4030_INTERRUPTS_BCIIMR1A,
161 .isr_offset = TWL4030_INTERRUPTS_BCIISR1B,
162 .imr_offset = TWL4030_INTERRUPTS_BCIIMR1B,
167 SIH_INITIALIZER(MADC, 4)
170 /* USB doesn't use the same SIH organization */
176 SIH_INITIALIZER(INT_PWR, 8)
178 /* there are no SIH modules #6 or #7 ... */
181 static const struct sih sih_modules_twl5031[8] = {
184 .module = TWL4030_MODULE_GPIO,
185 .control_offset = REG_GPIO_SIH_CTRL,
187 .bits = TWL4030_GPIO_MAX,
189 /* Note: *all* of these IRQs default to no-trigger */
190 .edr_offset = REG_GPIO_EDR1,
194 .isr_offset = REG_GPIO_ISR1A,
195 .imr_offset = REG_GPIO_IMR1A,
197 .isr_offset = REG_GPIO_ISR1B,
198 .imr_offset = REG_GPIO_IMR1B,
204 SIH_INITIALIZER(KEYPAD_KEYP, 4)
208 .module = TWL5031_MODULE_INTERRUPTS,
209 .control_offset = TWL5031_INTERRUPTS_BCISIHCTRL,
212 .edr_offset = TWL5031_INTERRUPTS_BCIEDR1,
213 /* Note: most of these IRQs default to no-trigger */
217 .isr_offset = TWL5031_INTERRUPTS_BCIISR1,
218 .imr_offset = TWL5031_INTERRUPTS_BCIIMR1,
220 .isr_offset = TWL5031_INTERRUPTS_BCIISR2,
221 .imr_offset = TWL5031_INTERRUPTS_BCIIMR2,
226 SIH_INITIALIZER(MADC, 4)
229 /* USB doesn't use the same SIH organization */
235 SIH_INITIALIZER(INT_PWR, 8)
239 * ECI/DBI doesn't use the same SIH organization.
240 * For example, it supports only one interrupt output line.
241 * That is, the interrupts are seen on both INT1 and INT2 lines.
244 .module = TWL5031_MODULE_ACCESSORY,
249 .isr_offset = TWL5031_ACIIDR_LSB,
250 .imr_offset = TWL5031_ACIIMR_LSB,
255 /* Audio accessory */
257 .module = TWL5031_MODULE_ACCESSORY,
258 .control_offset = TWL5031_ACCSIHCTRL,
261 .edr_offset = TWL5031_ACCEDR1,
262 /* Note: most of these IRQs default to no-trigger */
266 .isr_offset = TWL5031_ACCISR1,
267 .imr_offset = TWL5031_ACCIMR1,
269 .isr_offset = TWL5031_ACCISR2,
270 .imr_offset = TWL5031_ACCIMR2,
275 #undef TWL4030_MODULE_KEYPAD_KEYP
276 #undef TWL4030_MODULE_INT_PWR
277 #undef TWL4030_INT_PWR_EDR
279 /*----------------------------------------------------------------------*/
281 static unsigned twl4030_irq_base;
284 * handle_twl4030_pih() is the desc->handle method for the twl4030 interrupt.
285 * This is a chained interrupt, so there is no desc->action method for it.
286 * Now we need to query the interrupt controller in the twl4030 to determine
287 * which module is generating the interrupt request. However, we can't do i2c
288 * transactions in interrupt context, so we must defer that work to a kernel
289 * thread. All we do here is acknowledge and mask the interrupt and wakeup
292 static irqreturn_t handle_twl4030_pih(int irq, void *devid)
297 ret = twl_i2c_read_u8(TWL_MODULE_PIH, &pih_isr,
300 pr_warn("twl4030: I2C error %d reading PIH ISR\n", ret);
305 unsigned long pending = __ffs(pih_isr);
308 pih_isr &= ~BIT(pending);
309 irq = pending + twl4030_irq_base;
310 handle_nested_irq(irq);
316 /*----------------------------------------------------------------------*/
319 * twl4030_init_sih_modules() ... start from a known state where no
320 * IRQs will be coming in, and where we can quickly enable them then
321 * handle them as they arrive. Mask all IRQs: maybe init SIH_CTRL.
323 * NOTE: we don't touch EDR registers here; they stay with hardware
324 * defaults or whatever the last value was. Note that when both EDR
325 * bits for an IRQ are clear, that's as if its IMR bit is set...
327 static int twl4030_init_sih_modules(unsigned line)
329 const struct sih *sih;
334 /* line 0 == int1_n signal; line 1 == int2_n signal */
340 /* disable all interrupts on our line */
341 memset(buf, 0xff, sizeof(buf));
343 for (i = 0; i < nr_sih_modules; i++, sih++) {
344 /* skip USB -- it's funky */
348 /* Not all the SIH modules support multiple interrupt lines */
349 if (sih->irq_lines <= line)
352 status = twl_i2c_write(sih->module, buf,
353 sih->mask[line].imr_offset, sih->bytes_ixr);
355 pr_err("twl4030: err %d initializing %s %s\n",
356 status, sih->name, "IMR");
359 * Maybe disable "exclusive" mode; buffer second pending irq;
360 * set Clear-On-Read (COR) bit.
362 * NOTE that sometimes COR polarity is documented as being
363 * inverted: for MADC, COR=1 means "clear on write".
364 * And for PWR_INT it's not documented...
367 status = twl_i2c_write_u8(sih->module,
368 TWL4030_SIH_CTRL_COR_MASK,
369 sih->control_offset);
371 pr_err("twl4030: err %d initializing %s %s\n",
372 status, sih->name, "SIH_CTRL");
377 for (i = 0; i < nr_sih_modules; i++, sih++) {
385 /* Not all the SIH modules support multiple interrupt lines */
386 if (sih->irq_lines <= line)
390 * Clear pending interrupt status. Either the read was
391 * enough, or we need to write those bits. Repeat, in
392 * case an IRQ is pending (PENDDIS=0) ... that's not
393 * uncommon with PWR_INT.PWRON.
395 for (j = 0; j < 2; j++) {
396 status = twl_i2c_read(sih->module, rxbuf,
397 sih->mask[line].isr_offset, sih->bytes_ixr);
399 pr_warn("twl4030: err %d initializing %s %s\n",
400 status, sih->name, "ISR");
403 status = twl_i2c_write(sih->module, buf,
404 sih->mask[line].isr_offset,
407 pr_warn("twl4030: write failed: %d\n",
411 * else COR=1 means read sufficed.
412 * (for most SIH modules...)
420 static inline void activate_irq(int irq)
422 irq_clear_status_flags(irq, IRQ_NOREQUEST | IRQ_NOPROBE);
425 /*----------------------------------------------------------------------*/
429 const struct sih *sih;
432 bool imr_change_pending;
436 struct mutex irq_lock;
440 /*----------------------------------------------------------------------*/
443 * All irq_chip methods get issued from code holding irq_desc[irq].lock,
444 * which can't perform the underlying I2C operations (because they sleep).
445 * So we must hand them off to a thread (workqueue) and cope with asynch
446 * completion, potentially including some re-ordering, of these requests.
449 static void twl4030_sih_mask(struct irq_data *data)
451 struct sih_agent *agent = irq_data_get_irq_chip_data(data);
453 agent->imr |= BIT(data->irq - agent->irq_base);
454 agent->imr_change_pending = true;
457 static void twl4030_sih_unmask(struct irq_data *data)
459 struct sih_agent *agent = irq_data_get_irq_chip_data(data);
461 agent->imr &= ~BIT(data->irq - agent->irq_base);
462 agent->imr_change_pending = true;
465 static int twl4030_sih_set_type(struct irq_data *data, unsigned trigger)
467 struct sih_agent *agent = irq_data_get_irq_chip_data(data);
469 if (trigger & ~(IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
472 if (irqd_get_trigger_type(data) != trigger)
473 agent->edge_change |= BIT(data->irq - agent->irq_base);
478 static void twl4030_sih_bus_lock(struct irq_data *data)
480 struct sih_agent *agent = irq_data_get_irq_chip_data(data);
482 mutex_lock(&agent->irq_lock);
485 static void twl4030_sih_bus_sync_unlock(struct irq_data *data)
487 struct sih_agent *agent = irq_data_get_irq_chip_data(data);
488 const struct sih *sih = agent->sih;
491 if (agent->imr_change_pending) {
497 /* byte[0] gets overwritten as we write ... */
498 imr.word = cpu_to_le32(agent->imr);
499 agent->imr_change_pending = false;
501 /* write the whole mask ... simpler than subsetting it */
502 status = twl_i2c_write(sih->module, imr.bytes,
503 sih->mask[irq_line].imr_offset,
506 pr_err("twl4030: %s, %s --> %d\n", __func__,
510 if (agent->edge_change) {
514 edge_change = agent->edge_change;
515 agent->edge_change = 0;
518 * Read, reserving first byte for write scratch. Yes, this
519 * could be cached for some speedup ... but be careful about
520 * any processor on the other IRQ line, EDR registers are
523 status = twl_i2c_read(sih->module, bytes,
524 sih->edr_offset, sih->bytes_edr);
526 pr_err("twl4030: %s, %s --> %d\n", __func__,
531 /* Modify only the bits we know must change */
532 while (edge_change) {
533 int i = fls(edge_change) - 1;
535 int off = (i & 0x3) * 2;
538 bytes[byte] &= ~(0x03 << off);
540 type = irq_get_trigger_type(i + agent->irq_base);
541 if (type & IRQ_TYPE_EDGE_RISING)
542 bytes[byte] |= BIT(off + 1);
543 if (type & IRQ_TYPE_EDGE_FALLING)
544 bytes[byte] |= BIT(off + 0);
546 edge_change &= ~BIT(i);
550 status = twl_i2c_write(sih->module, bytes,
551 sih->edr_offset, sih->bytes_edr);
553 pr_err("twl4030: %s, %s --> %d\n", __func__,
557 mutex_unlock(&agent->irq_lock);
560 static struct irq_chip twl4030_sih_irq_chip = {
562 .irq_mask = twl4030_sih_mask,
563 .irq_unmask = twl4030_sih_unmask,
564 .irq_set_type = twl4030_sih_set_type,
565 .irq_bus_lock = twl4030_sih_bus_lock,
566 .irq_bus_sync_unlock = twl4030_sih_bus_sync_unlock,
567 .flags = IRQCHIP_SKIP_SET_WAKE,
570 /*----------------------------------------------------------------------*/
572 static inline int sih_read_isr(const struct sih *sih)
580 /* FIXME need retry-on-error ... */
583 status = twl_i2c_read(sih->module, isr.bytes,
584 sih->mask[irq_line].isr_offset, sih->bytes_ixr);
586 return (status < 0) ? status : le32_to_cpu(isr.word);
590 * Generic handler for SIH interrupts ... we "know" this is called
591 * in task context, with IRQs enabled.
593 static irqreturn_t handle_twl4030_sih(int irq, void *data)
595 struct sih_agent *agent = irq_get_handler_data(irq);
596 const struct sih *sih = agent->sih;
599 /* reading ISR acks the IRQs, using clear-on-read mode */
600 isr = sih_read_isr(sih);
603 pr_err("twl4030: %s SIH, read ISR error %d\n",
605 /* REVISIT: recover; eventually mask it all, etc */
615 handle_nested_irq(agent->irq_base + irq);
617 pr_err("twl4030: %s SIH, invalid ISR bit %d\n",
623 /* returns the first IRQ used by this SIH bank, or negative errno */
624 int twl4030_sih_setup(struct device *dev, int module, int irq_base)
627 const struct sih *sih = NULL;
628 struct sih_agent *agent;
630 int status = -EINVAL;
632 /* only support modules with standard clear-on-read for now */
633 for (sih_mod = 0, sih = sih_modules; sih_mod < nr_sih_modules;
635 if (sih->module == module && sih->set_cor) {
644 agent = kzalloc(sizeof(*agent), GFP_KERNEL);
648 agent->irq_base = irq_base;
651 mutex_init(&agent->irq_lock);
653 for (i = 0; i < sih->bits; i++) {
656 irq_set_chip_data(irq, agent);
657 irq_set_chip_and_handler(irq, &twl4030_sih_irq_chip,
659 irq_set_nested_thread(irq, 1);
663 /* replace generic PIH handler (handle_simple_irq) */
664 irq = sih_mod + twl4030_irq_base;
665 irq_set_handler_data(irq, agent);
666 agent->irq_name = kasprintf(GFP_KERNEL, "twl4030_%s", sih->name);
667 status = request_threaded_irq(irq, NULL, handle_twl4030_sih,
668 IRQF_EARLY_RESUME | IRQF_ONESHOT,
669 agent->irq_name ?: sih->name, NULL);
671 dev_info(dev, "%s (irq %d) chaining IRQs %d..%d\n", sih->name,
672 irq, irq_base, irq_base + i - 1);
674 return status < 0 ? status : irq_base;
677 /* FIXME need a call to reverse twl4030_sih_setup() ... */
679 /*----------------------------------------------------------------------*/
681 /* FIXME pass in which interrupt line we'll use ... */
682 #define twl_irq_line 0
684 int twl4030_init_irq(struct device *dev, int irq_num)
686 static struct irq_chip twl4030_irq_chip;
688 int irq_base, irq_end, nr_irqs;
689 struct device_node *node = dev->of_node;
692 * TWL core and pwr interrupts must be contiguous because
693 * the hwirqs numbers are defined contiguously from 1 to 15.
694 * Create only one domain for both.
696 nr_irqs = TWL4030_PWR_NR_IRQS + TWL4030_CORE_NR_IRQS;
698 irq_base = irq_alloc_descs(-1, 0, nr_irqs, 0);
700 dev_err(dev, "Fail to allocate IRQ descs\n");
704 irq_domain_add_legacy(node, nr_irqs, irq_base, 0,
705 &irq_domain_simple_ops, NULL);
707 irq_end = irq_base + TWL4030_CORE_NR_IRQS;
710 * Mask and clear all TWL4030 interrupts since initially we do
711 * not have any TWL4030 module interrupt handlers present
713 status = twl4030_init_sih_modules(twl_irq_line);
717 twl4030_irq_base = irq_base;
720 * Install an irq handler for each of the SIH modules;
721 * clone dummy irq_chip since PIH can't *do* anything
723 twl4030_irq_chip = dummy_irq_chip;
724 twl4030_irq_chip.name = "twl4030";
726 twl4030_sih_irq_chip.irq_ack = dummy_irq_chip.irq_ack;
728 for (i = irq_base; i < irq_end; i++) {
729 irq_set_chip_and_handler(i, &twl4030_irq_chip,
731 irq_set_nested_thread(i, 1);
735 dev_info(dev, "%s (irq %d) chaining IRQs %d..%d\n", "PIH",
736 irq_num, irq_base, irq_end);
738 /* ... and the PWR_INT module ... */
739 status = twl4030_sih_setup(dev, TWL4030_MODULE_INT, irq_end);
741 dev_err(dev, "sih_setup PWR INT --> %d\n", status);
745 /* install an irq handler to demultiplex the TWL4030 interrupt */
746 status = request_threaded_irq(irq_num, NULL, handle_twl4030_pih,
748 "TWL4030-PIH", NULL);
750 dev_err(dev, "could not claim irq%d: %d\n", irq_num, status);
753 enable_irq_wake(irq_num);
757 /* clean up twl4030_sih_setup */
759 for (i = irq_base; i < irq_end; i++) {
760 irq_set_nested_thread(i, 0);
761 irq_set_chip_and_handler(i, NULL, NULL);
767 int twl4030_exit_irq(void)
769 /* FIXME undo twl_init_irq() */
770 if (twl4030_irq_base) {
771 pr_err("twl4030: can't yet clean up IRQs?\n");
777 int twl4030_init_chip_irq(const char *chip)
779 if (!strcmp(chip, "twl5031")) {
780 sih_modules = sih_modules_twl5031;
781 nr_sih_modules = ARRAY_SIZE(sih_modules_twl5031);
783 sih_modules = sih_modules_twl4030;
784 nr_sih_modules = ARRAY_SIZE(sih_modules_twl4030);