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/interrupt.h>
32 #include <linux/irq.h>
33 #include <linux/kthread.h>
35 #include <linux/i2c/twl.h>
39 * TWL4030 IRQ handling has two stages in hardware, and thus in software.
40 * The Primary Interrupt Handler (PIH) stage exposes status bits saying
41 * which Secondary Interrupt Handler (SIH) stage is raising an interrupt.
42 * SIH modules are more traditional IRQ components, which support per-IRQ
43 * enable/disable and trigger controls; they do most of the work.
45 * These chips are designed to support IRQ handling from two different
46 * I2C masters. Each has a dedicated IRQ line, and dedicated IRQ status
47 * and mask registers in the PIH and SIH modules.
49 * We set up IRQs starting at a platform-specified base, always starting
50 * with PIH and the SIH for PWR_INT and then usually adding GPIO:
51 * base + 0 .. base + 7 PIH
52 * base + 8 .. base + 15 SIH for PWR_INT
53 * base + 16 .. base + 33 SIH for GPIO
56 /* PIH register offsets */
57 #define REG_PIH_ISR_P1 0x01
58 #define REG_PIH_ISR_P2 0x02
59 #define REG_PIH_SIR 0x03 /* for testing */
62 /* Linux could (eventually) use either IRQ line */
67 u8 module
; /* module id */
68 u8 control_offset
; /* for SIH_CTRL */
71 u8 bits
; /* valid in isr/imr */
72 u8 bytes_ixr
; /* bytelen of ISR/IMR/SIR */
75 u8 bytes_edr
; /* bytelen of EDR */
77 u8 irq_lines
; /* number of supported irq lines */
79 /* SIR ignored -- set interrupt, for testing only */
84 /* + 2 bytes padding */
87 static const struct sih
*sih_modules
;
88 static int nr_sih_modules
;
90 #define SIH_INITIALIZER(modname, nbits) \
91 .module = TWL4030_MODULE_ ## modname, \
92 .control_offset = TWL4030_ ## modname ## _SIH_CTRL, \
94 .bytes_ixr = DIV_ROUND_UP(nbits, 8), \
95 .edr_offset = TWL4030_ ## modname ## _EDR, \
96 .bytes_edr = DIV_ROUND_UP((2*(nbits)), 8), \
99 .isr_offset = TWL4030_ ## modname ## _ISR1, \
100 .imr_offset = TWL4030_ ## modname ## _IMR1, \
103 .isr_offset = TWL4030_ ## modname ## _ISR2, \
104 .imr_offset = TWL4030_ ## modname ## _IMR2, \
107 /* register naming policies are inconsistent ... */
108 #define TWL4030_INT_PWR_EDR TWL4030_INT_PWR_EDR1
109 #define TWL4030_MODULE_KEYPAD_KEYP TWL4030_MODULE_KEYPAD
110 #define TWL4030_MODULE_INT_PWR TWL4030_MODULE_INT
113 /* Order in this table matches order in PIH_ISR. That is,
114 * BIT(n) in PIH_ISR is sih_modules[n].
116 /* sih_modules_twl4030 is used both in twl4030 and twl5030 */
117 static const struct sih sih_modules_twl4030
[6] = {
120 .module
= TWL4030_MODULE_GPIO
,
121 .control_offset
= REG_GPIO_SIH_CTRL
,
123 .bits
= TWL4030_GPIO_MAX
,
125 /* Note: *all* of these IRQs default to no-trigger */
126 .edr_offset
= REG_GPIO_EDR1
,
130 .isr_offset
= REG_GPIO_ISR1A
,
131 .imr_offset
= REG_GPIO_IMR1A
,
133 .isr_offset
= REG_GPIO_ISR1B
,
134 .imr_offset
= REG_GPIO_IMR1B
,
140 SIH_INITIALIZER(KEYPAD_KEYP
, 4)
144 .module
= TWL4030_MODULE_INTERRUPTS
,
145 .control_offset
= TWL4030_INTERRUPTS_BCISIHCTRL
,
148 .edr_offset
= TWL4030_INTERRUPTS_BCIEDR1
,
149 /* Note: most of these IRQs default to no-trigger */
153 .isr_offset
= TWL4030_INTERRUPTS_BCIISR1A
,
154 .imr_offset
= TWL4030_INTERRUPTS_BCIIMR1A
,
156 .isr_offset
= TWL4030_INTERRUPTS_BCIISR1B
,
157 .imr_offset
= TWL4030_INTERRUPTS_BCIIMR1B
,
162 SIH_INITIALIZER(MADC
, 4)
165 /* USB doesn't use the same SIH organization */
171 SIH_INITIALIZER(INT_PWR
, 8)
173 /* there are no SIH modules #6 or #7 ... */
176 static const struct sih sih_modules_twl5031
[8] = {
179 .module
= TWL4030_MODULE_GPIO
,
180 .control_offset
= REG_GPIO_SIH_CTRL
,
182 .bits
= TWL4030_GPIO_MAX
,
184 /* Note: *all* of these IRQs default to no-trigger */
185 .edr_offset
= REG_GPIO_EDR1
,
189 .isr_offset
= REG_GPIO_ISR1A
,
190 .imr_offset
= REG_GPIO_IMR1A
,
192 .isr_offset
= REG_GPIO_ISR1B
,
193 .imr_offset
= REG_GPIO_IMR1B
,
199 SIH_INITIALIZER(KEYPAD_KEYP
, 4)
203 .module
= TWL5031_MODULE_INTERRUPTS
,
204 .control_offset
= TWL5031_INTERRUPTS_BCISIHCTRL
,
207 .edr_offset
= TWL5031_INTERRUPTS_BCIEDR1
,
208 /* Note: most of these IRQs default to no-trigger */
212 .isr_offset
= TWL5031_INTERRUPTS_BCIISR1
,
213 .imr_offset
= TWL5031_INTERRUPTS_BCIIMR1
,
215 .isr_offset
= TWL5031_INTERRUPTS_BCIISR2
,
216 .imr_offset
= TWL5031_INTERRUPTS_BCIIMR2
,
221 SIH_INITIALIZER(MADC
, 4)
224 /* USB doesn't use the same SIH organization */
230 SIH_INITIALIZER(INT_PWR
, 8)
234 * ACI doesn't use the same SIH organization.
235 * For example, it supports only one interrupt line
238 .module
= TWL5031_MODULE_ACCESSORY
,
243 .isr_offset
= TWL5031_ACIIDR_LSB
,
244 .imr_offset
= TWL5031_ACIIMR_LSB
,
251 .module
= TWL5031_MODULE_ACCESSORY
,
252 .control_offset
= TWL5031_ACCSIHCTRL
,
255 .edr_offset
= TWL5031_ACCEDR1
,
256 /* Note: most of these IRQs default to no-trigger */
260 .isr_offset
= TWL5031_ACCISR1
,
261 .imr_offset
= TWL5031_ACCIMR1
,
263 .isr_offset
= TWL5031_ACCISR2
,
264 .imr_offset
= TWL5031_ACCIMR2
,
269 #undef TWL4030_MODULE_KEYPAD_KEYP
270 #undef TWL4030_MODULE_INT_PWR
271 #undef TWL4030_INT_PWR_EDR
273 /*----------------------------------------------------------------------*/
275 static unsigned twl4030_irq_base
;
277 static struct completion irq_event
;
280 * This thread processes interrupts reported by the Primary Interrupt Handler.
282 static int twl4030_irq_thread(void *data
)
284 long irq
= (long)data
;
285 static unsigned i2c_errors
;
286 static const unsigned max_i2c_errors
= 100;
289 current
->flags
|= PF_NOFREEZE
;
291 while (!kthread_should_stop()) {
296 /* Wait for IRQ, then read PIH irq status (also blocking) */
297 wait_for_completion_interruptible(&irq_event
);
299 ret
= twl_i2c_read_u8(TWL4030_MODULE_PIH
, &pih_isr
,
302 pr_warning("twl4030: I2C error %d reading PIH ISR\n",
304 if (++i2c_errors
>= max_i2c_errors
) {
305 printk(KERN_ERR
"Maximum I2C error count"
306 " exceeded. Terminating %s.\n",
310 complete(&irq_event
);
314 /* these handlers deal with the relevant SIH irq status */
316 for (module_irq
= twl4030_irq_base
;
318 pih_isr
>>= 1, module_irq
++) {
320 struct irq_desc
*d
= irq_to_desc(module_irq
);
323 pr_err("twl4030: Invalid SIH IRQ: %d\n",
328 /* These can't be masked ... always warn
329 * if we get any surprises.
331 if (d
->status
& IRQ_DISABLED
)
332 note_interrupt(module_irq
, d
,
335 d
->handle_irq(module_irq
, d
);
347 * handle_twl4030_pih() is the desc->handle method for the twl4030 interrupt.
348 * This is a chained interrupt, so there is no desc->action method for it.
349 * Now we need to query the interrupt controller in the twl4030 to determine
350 * which module is generating the interrupt request. However, we can't do i2c
351 * transactions in interrupt context, so we must defer that work to a kernel
352 * thread. All we do here is acknowledge and mask the interrupt and wakeup
355 static irqreturn_t
handle_twl4030_pih(int irq
, void *devid
)
357 /* Acknowledge, clear *AND* mask the interrupt... */
358 disable_irq_nosync(irq
);
362 /*----------------------------------------------------------------------*/
365 * twl4030_init_sih_modules() ... start from a known state where no
366 * IRQs will be coming in, and where we can quickly enable them then
367 * handle them as they arrive. Mask all IRQs: maybe init SIH_CTRL.
369 * NOTE: we don't touch EDR registers here; they stay with hardware
370 * defaults or whatever the last value was. Note that when both EDR
371 * bits for an IRQ are clear, that's as if its IMR bit is set...
373 static int twl4030_init_sih_modules(unsigned line
)
375 const struct sih
*sih
;
380 /* line 0 == int1_n signal; line 1 == int2_n signal */
386 /* disable all interrupts on our line */
387 memset(buf
, 0xff, sizeof buf
);
389 for (i
= 0; i
< nr_sih_modules
; i
++, sih
++) {
391 /* skip USB -- it's funky */
395 /* Not all the SIH modules support multiple interrupt lines */
396 if (sih
->irq_lines
<= line
)
399 status
= twl_i2c_write(sih
->module
, buf
,
400 sih
->mask
[line
].imr_offset
, sih
->bytes_ixr
);
402 pr_err("twl4030: err %d initializing %s %s\n",
403 status
, sih
->name
, "IMR");
405 /* Maybe disable "exclusive" mode; buffer second pending irq;
406 * set Clear-On-Read (COR) bit.
408 * NOTE that sometimes COR polarity is documented as being
409 * inverted: for MADC and BCI, COR=1 means "clear on write".
410 * And for PWR_INT it's not documented...
413 status
= twl_i2c_write_u8(sih
->module
,
414 TWL4030_SIH_CTRL_COR_MASK
,
415 sih
->control_offset
);
417 pr_err("twl4030: err %d initializing %s %s\n",
418 status
, sih
->name
, "SIH_CTRL");
423 for (i
= 0; i
< nr_sih_modules
; i
++, sih
++) {
431 /* Not all the SIH modules support multiple interrupt lines */
432 if (sih
->irq_lines
<= line
)
435 /* Clear pending interrupt status. Either the read was
436 * enough, or we need to write those bits. Repeat, in
437 * case an IRQ is pending (PENDDIS=0) ... that's not
438 * uncommon with PWR_INT.PWRON.
440 for (j
= 0; j
< 2; j
++) {
441 status
= twl_i2c_read(sih
->module
, rxbuf
,
442 sih
->mask
[line
].isr_offset
, sih
->bytes_ixr
);
444 pr_err("twl4030: err %d initializing %s %s\n",
445 status
, sih
->name
, "ISR");
448 status
= twl_i2c_write(sih
->module
, buf
,
449 sih
->mask
[line
].isr_offset
,
451 /* else COR=1 means read sufficed.
452 * (for most SIH modules...)
460 static inline void activate_irq(int irq
)
463 /* ARM requires an extra step to clear IRQ_NOREQUEST, which it
464 * sets on behalf of every irq_chip. Also sets IRQ_NOPROBE.
466 set_irq_flags(irq
, IRQF_VALID
);
468 /* same effect on other architectures */
469 set_irq_noprobe(irq
);
473 /*----------------------------------------------------------------------*/
475 static DEFINE_SPINLOCK(sih_agent_lock
);
477 static struct workqueue_struct
*wq
;
481 const struct sih
*sih
;
484 bool imr_change_pending
;
485 struct work_struct mask_work
;
488 struct work_struct edge_work
;
491 static void twl4030_sih_do_mask(struct work_struct
*work
)
493 struct sih_agent
*agent
;
494 const struct sih
*sih
;
501 agent
= container_of(work
, struct sih_agent
, mask_work
);
503 /* see what work we have */
504 spin_lock_irq(&sih_agent_lock
);
505 if (agent
->imr_change_pending
) {
507 /* byte[0] gets overwritten as we write ... */
508 imr
.word
= cpu_to_le32(agent
->imr
<< 8);
509 agent
->imr_change_pending
= false;
512 spin_unlock_irq(&sih_agent_lock
);
516 /* write the whole mask ... simpler than subsetting it */
517 status
= twl_i2c_write(sih
->module
, imr
.bytes
,
518 sih
->mask
[irq_line
].imr_offset
, sih
->bytes_ixr
);
520 pr_err("twl4030: %s, %s --> %d\n", __func__
,
524 static void twl4030_sih_do_edge(struct work_struct
*work
)
526 struct sih_agent
*agent
;
527 const struct sih
*sih
;
532 agent
= container_of(work
, struct sih_agent
, edge_work
);
534 /* see what work we have */
535 spin_lock_irq(&sih_agent_lock
);
536 edge_change
= agent
->edge_change
;
537 agent
->edge_change
= 0;
538 sih
= edge_change
? agent
->sih
: NULL
;
539 spin_unlock_irq(&sih_agent_lock
);
543 /* Read, reserving first byte for write scratch. Yes, this
544 * could be cached for some speedup ... but be careful about
545 * any processor on the other IRQ line, EDR registers are
548 status
= twl_i2c_read(sih
->module
, bytes
+ 1,
549 sih
->edr_offset
, sih
->bytes_edr
);
551 pr_err("twl4030: %s, %s --> %d\n", __func__
,
556 /* Modify only the bits we know must change */
557 while (edge_change
) {
558 int i
= fls(edge_change
) - 1;
559 struct irq_desc
*d
= irq_to_desc(i
+ agent
->irq_base
);
560 int byte
= 1 + (i
>> 2);
561 int off
= (i
& 0x3) * 2;
564 pr_err("twl4030: Invalid IRQ: %d\n",
565 i
+ agent
->irq_base
);
569 bytes
[byte
] &= ~(0x03 << off
);
571 raw_spin_lock_irq(&d
->lock
);
572 if (d
->status
& IRQ_TYPE_EDGE_RISING
)
573 bytes
[byte
] |= BIT(off
+ 1);
574 if (d
->status
& IRQ_TYPE_EDGE_FALLING
)
575 bytes
[byte
] |= BIT(off
+ 0);
576 raw_spin_unlock_irq(&d
->lock
);
578 edge_change
&= ~BIT(i
);
582 status
= twl_i2c_write(sih
->module
, bytes
,
583 sih
->edr_offset
, sih
->bytes_edr
);
585 pr_err("twl4030: %s, %s --> %d\n", __func__
,
589 /*----------------------------------------------------------------------*/
592 * All irq_chip methods get issued from code holding irq_desc[irq].lock,
593 * which can't perform the underlying I2C operations (because they sleep).
594 * So we must hand them off to a thread (workqueue) and cope with asynch
595 * completion, potentially including some re-ordering, of these requests.
598 static void twl4030_sih_mask(unsigned irq
)
600 struct sih_agent
*sih
= get_irq_chip_data(irq
);
603 spin_lock_irqsave(&sih_agent_lock
, flags
);
604 sih
->imr
|= BIT(irq
- sih
->irq_base
);
605 sih
->imr_change_pending
= true;
606 queue_work(wq
, &sih
->mask_work
);
607 spin_unlock_irqrestore(&sih_agent_lock
, flags
);
610 static void twl4030_sih_unmask(unsigned irq
)
612 struct sih_agent
*sih
= get_irq_chip_data(irq
);
615 spin_lock_irqsave(&sih_agent_lock
, flags
);
616 sih
->imr
&= ~BIT(irq
- sih
->irq_base
);
617 sih
->imr_change_pending
= true;
618 queue_work(wq
, &sih
->mask_work
);
619 spin_unlock_irqrestore(&sih_agent_lock
, flags
);
622 static int twl4030_sih_set_type(unsigned irq
, unsigned trigger
)
624 struct sih_agent
*sih
= get_irq_chip_data(irq
);
625 struct irq_desc
*desc
= irq_to_desc(irq
);
629 pr_err("twl4030: Invalid IRQ: %d\n", irq
);
633 if (trigger
& ~(IRQ_TYPE_EDGE_FALLING
| IRQ_TYPE_EDGE_RISING
))
636 spin_lock_irqsave(&sih_agent_lock
, flags
);
637 if ((desc
->status
& IRQ_TYPE_SENSE_MASK
) != trigger
) {
638 desc
->status
&= ~IRQ_TYPE_SENSE_MASK
;
639 desc
->status
|= trigger
;
640 sih
->edge_change
|= BIT(irq
- sih
->irq_base
);
641 queue_work(wq
, &sih
->edge_work
);
643 spin_unlock_irqrestore(&sih_agent_lock
, flags
);
647 static struct irq_chip twl4030_sih_irq_chip
= {
649 .mask
= twl4030_sih_mask
,
650 .unmask
= twl4030_sih_unmask
,
651 .set_type
= twl4030_sih_set_type
,
654 /*----------------------------------------------------------------------*/
656 static inline int sih_read_isr(const struct sih
*sih
)
664 /* FIXME need retry-on-error ... */
667 status
= twl_i2c_read(sih
->module
, isr
.bytes
,
668 sih
->mask
[irq_line
].isr_offset
, sih
->bytes_ixr
);
670 return (status
< 0) ? status
: le32_to_cpu(isr
.word
);
674 * Generic handler for SIH interrupts ... we "know" this is called
675 * in task context, with IRQs enabled.
677 static void handle_twl4030_sih(unsigned irq
, struct irq_desc
*desc
)
679 struct sih_agent
*agent
= get_irq_data(irq
);
680 const struct sih
*sih
= agent
->sih
;
683 /* reading ISR acks the IRQs, using clear-on-read mode */
685 isr
= sih_read_isr(sih
);
689 pr_err("twl4030: %s SIH, read ISR error %d\n",
691 /* REVISIT: recover; eventually mask it all, etc */
701 generic_handle_irq(agent
->irq_base
+ irq
);
703 pr_err("twl4030: %s SIH, invalid ISR bit %d\n",
708 static unsigned twl4030_irq_next
;
710 /* returns the first IRQ used by this SIH bank,
713 int twl4030_sih_setup(int module
)
716 const struct sih
*sih
= NULL
;
717 struct sih_agent
*agent
;
719 int status
= -EINVAL
;
720 unsigned irq_base
= twl4030_irq_next
;
722 /* only support modules with standard clear-on-read for now */
723 for (sih_mod
= 0, sih
= sih_modules
;
724 sih_mod
< nr_sih_modules
;
726 if (sih
->module
== module
&& sih
->set_cor
) {
727 if (!WARN((irq_base
+ sih
->bits
) > NR_IRQS
,
728 "irq %d for %s too big\n",
729 irq_base
+ sih
->bits
,
738 agent
= kzalloc(sizeof *agent
, GFP_KERNEL
);
744 agent
->irq_base
= irq_base
;
747 INIT_WORK(&agent
->mask_work
, twl4030_sih_do_mask
);
748 INIT_WORK(&agent
->edge_work
, twl4030_sih_do_edge
);
750 for (i
= 0; i
< sih
->bits
; i
++) {
753 set_irq_chip_and_handler(irq
, &twl4030_sih_irq_chip
,
755 set_irq_chip_data(irq
, agent
);
760 twl4030_irq_next
+= i
;
762 /* replace generic PIH handler (handle_simple_irq) */
763 irq
= sih_mod
+ twl4030_irq_base
;
764 set_irq_data(irq
, agent
);
765 set_irq_chained_handler(irq
, handle_twl4030_sih
);
767 pr_info("twl4030: %s (irq %d) chaining IRQs %d..%d\n", sih
->name
,
768 irq
, irq_base
, twl4030_irq_next
- 1);
773 /* FIXME need a call to reverse twl4030_sih_setup() ... */
776 /*----------------------------------------------------------------------*/
778 /* FIXME pass in which interrupt line we'll use ... */
779 #define twl_irq_line 0
781 int twl4030_init_irq(int irq_num
, unsigned irq_base
, unsigned irq_end
)
783 static struct irq_chip twl4030_irq_chip
;
787 struct task_struct
*task
;
790 * Mask and clear all TWL4030 interrupts since initially we do
791 * not have any TWL4030 module interrupt handlers present
793 status
= twl4030_init_sih_modules(twl_irq_line
);
797 wq
= create_singlethread_workqueue("twl4030-irqchip");
799 pr_err("twl4030: workqueue FAIL\n");
803 twl4030_irq_base
= irq_base
;
805 /* install an irq handler for each of the SIH modules;
806 * clone dummy irq_chip since PIH can't *do* anything
808 twl4030_irq_chip
= dummy_irq_chip
;
809 twl4030_irq_chip
.name
= "twl4030";
811 twl4030_sih_irq_chip
.ack
= dummy_irq_chip
.ack
;
813 for (i
= irq_base
; i
< irq_end
; i
++) {
814 set_irq_chip_and_handler(i
, &twl4030_irq_chip
,
818 twl4030_irq_next
= i
;
819 pr_info("twl4030: %s (irq %d) chaining IRQs %d..%d\n", "PIH",
820 irq_num
, irq_base
, twl4030_irq_next
- 1);
822 /* ... and the PWR_INT module ... */
823 status
= twl4030_sih_setup(TWL4030_MODULE_INT
);
825 pr_err("twl4030: sih_setup PWR INT --> %d\n", status
);
829 /* install an irq handler to demultiplex the TWL4030 interrupt */
832 init_completion(&irq_event
);
834 status
= request_irq(irq_num
, handle_twl4030_pih
, IRQF_DISABLED
,
835 "TWL4030-PIH", &irq_event
);
837 pr_err("twl4030: could not claim irq%d: %d\n", irq_num
, status
);
841 task
= kthread_run(twl4030_irq_thread
, (void *)(long)irq_num
,
844 pr_err("twl4030: could not create irq %d thread!\n", irq_num
);
845 status
= PTR_ERR(task
);
850 free_irq(irq_num
, &irq_event
);
852 /* clean up twl4030_sih_setup */
854 for (i
= irq_base
; i
< irq_end
; i
++)
855 set_irq_chip_and_handler(i
, NULL
, NULL
);
856 destroy_workqueue(wq
);
861 int twl4030_exit_irq(void)
863 /* FIXME undo twl_init_irq() */
864 if (twl4030_irq_base
) {
865 pr_err("twl4030: can't yet clean up IRQs?\n");
871 int twl4030_init_chip_irq(const char *chip
)
873 if (!strcmp(chip
, "twl5031")) {
874 sih_modules
= sih_modules_twl5031
;
875 nr_sih_modules
= ARRAY_SIZE(sih_modules_twl5031
);
877 sih_modules
= sih_modules_twl4030
;
878 nr_sih_modules
= ARRAY_SIZE(sih_modules_twl4030
);