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/twl4030.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 /* SIR ignored -- set interrupt, for testing only */
82 /* + 2 bytes padding */
85 #define SIH_INITIALIZER(modname, nbits) \
86 .module = TWL4030_MODULE_ ## modname, \
87 .control_offset = TWL4030_ ## modname ## _SIH_CTRL, \
89 .bytes_ixr = DIV_ROUND_UP(nbits, 8), \
90 .edr_offset = TWL4030_ ## modname ## _EDR, \
91 .bytes_edr = DIV_ROUND_UP((2*(nbits)), 8), \
93 .isr_offset = TWL4030_ ## modname ## _ISR1, \
94 .imr_offset = TWL4030_ ## modname ## _IMR1, \
97 .isr_offset = TWL4030_ ## modname ## _ISR2, \
98 .imr_offset = TWL4030_ ## modname ## _IMR2, \
101 /* register naming policies are inconsistent ... */
102 #define TWL4030_INT_PWR_EDR TWL4030_INT_PWR_EDR1
103 #define TWL4030_MODULE_KEYPAD_KEYP TWL4030_MODULE_KEYPAD
104 #define TWL4030_MODULE_INT_PWR TWL4030_MODULE_INT
107 /* Order in this table matches order in PIH_ISR. That is,
108 * BIT(n) in PIH_ISR is sih_modules[n].
110 static const struct sih sih_modules[6] = {
113 .module = TWL4030_MODULE_GPIO,
114 .control_offset = REG_GPIO_SIH_CTRL,
116 .bits = TWL4030_GPIO_MAX,
118 /* Note: *all* of these IRQs default to no-trigger */
119 .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,
140 .edr_offset = TWL4030_INTERRUPTS_BCIEDR1,
141 /* Note: most of these IRQs default to no-trigger */
144 .isr_offset = TWL4030_INTERRUPTS_BCIISR1A,
145 .imr_offset = TWL4030_INTERRUPTS_BCIIMR1A,
147 .isr_offset = TWL4030_INTERRUPTS_BCIISR1B,
148 .imr_offset = TWL4030_INTERRUPTS_BCIIMR1B,
153 SIH_INITIALIZER(MADC, 4)
156 /* USB doesn't use the same SIH organization */
162 SIH_INITIALIZER(INT_PWR, 8)
164 /* there are no SIH modules #6 or #7 ... */
167 #undef TWL4030_MODULE_KEYPAD_KEYP
168 #undef TWL4030_MODULE_INT_PWR
169 #undef TWL4030_INT_PWR_EDR
171 /*----------------------------------------------------------------------*/
173 static unsigned twl4030_irq_base;
175 static struct completion irq_event;
178 * This thread processes interrupts reported by the Primary Interrupt Handler.
180 static int twl4030_irq_thread(void *data)
182 long irq = (long)data;
183 struct irq_desc *desc = irq_to_desc(irq);
184 static unsigned i2c_errors;
185 static const unsigned max_i2c_errors = 100;
188 pr_err("twl4030: Invalid IRQ: %ld\n", irq);
192 current->flags |= PF_NOFREEZE;
194 while (!kthread_should_stop()) {
199 /* Wait for IRQ, then read PIH irq status (also blocking) */
200 wait_for_completion_interruptible(&irq_event);
202 ret = twl4030_i2c_read_u8(TWL4030_MODULE_PIH, &pih_isr,
205 pr_warning("twl4030: I2C error %d reading PIH ISR\n",
207 if (++i2c_errors >= max_i2c_errors) {
208 printk(KERN_ERR "Maximum I2C error count"
209 " exceeded. Terminating %s.\n",
213 complete(&irq_event);
217 /* these handlers deal with the relevant SIH irq status */
219 for (module_irq = twl4030_irq_base;
221 pih_isr >>= 1, module_irq++) {
223 struct irq_desc *d = irq_to_desc(module_irq);
226 pr_err("twl4030: Invalid SIH IRQ: %d\n",
231 /* These can't be masked ... always warn
232 * if we get any surprises.
234 if (d->status & IRQ_DISABLED)
235 note_interrupt(module_irq, d,
238 d->handle_irq(module_irq, d);
243 desc->chip->unmask(irq);
250 * handle_twl4030_pih() is the desc->handle method for the twl4030 interrupt.
251 * This is a chained interrupt, so there is no desc->action method for it.
252 * Now we need to query the interrupt controller in the twl4030 to determine
253 * which module is generating the interrupt request. However, we can't do i2c
254 * transactions in interrupt context, so we must defer that work to a kernel
255 * thread. All we do here is acknowledge and mask the interrupt and wakeup
258 static void handle_twl4030_pih(unsigned int irq, irq_desc_t *desc)
260 /* Acknowledge, clear *AND* mask the interrupt... */
261 desc->chip->ack(irq);
262 complete(&irq_event);
265 static struct task_struct *start_twl4030_irq_thread(long irq)
267 struct task_struct *thread;
269 init_completion(&irq_event);
270 thread = kthread_run(twl4030_irq_thread, (void *)irq, "twl4030-irq");
272 pr_err("twl4030: could not create irq %ld thread!\n", irq);
277 /*----------------------------------------------------------------------*/
280 * twl4030_init_sih_modules() ... start from a known state where no
281 * IRQs will be coming in, and where we can quickly enable them then
282 * handle them as they arrive. Mask all IRQs: maybe init SIH_CTRL.
284 * NOTE: we don't touch EDR registers here; they stay with hardware
285 * defaults or whatever the last value was. Note that when both EDR
286 * bits for an IRQ are clear, that's as if its IMR bit is set...
288 static int twl4030_init_sih_modules(unsigned line)
290 const struct sih *sih;
295 /* line 0 == int1_n signal; line 1 == int2_n signal */
301 /* disable all interrupts on our line */
302 memset(buf, 0xff, sizeof buf);
304 for (i = 0; i < ARRAY_SIZE(sih_modules); i++, sih++) {
306 /* skip USB -- it's funky */
310 status = twl4030_i2c_write(sih->module, buf,
311 sih->mask[line].imr_offset, sih->bytes_ixr);
313 pr_err("twl4030: err %d initializing %s %s\n",
314 status, sih->name, "IMR");
316 /* Maybe disable "exclusive" mode; buffer second pending irq;
317 * set Clear-On-Read (COR) bit.
319 * NOTE that sometimes COR polarity is documented as being
320 * inverted: for MADC and BCI, COR=1 means "clear on write".
321 * And for PWR_INT it's not documented...
324 status = twl4030_i2c_write_u8(sih->module,
325 TWL4030_SIH_CTRL_COR_MASK,
326 sih->control_offset);
328 pr_err("twl4030: err %d initializing %s %s\n",
329 status, sih->name, "SIH_CTRL");
334 for (i = 0; i < ARRAY_SIZE(sih_modules); i++, sih++) {
342 /* Clear pending interrupt status. Either the read was
343 * enough, or we need to write those bits. Repeat, in
344 * case an IRQ is pending (PENDDIS=0) ... that's not
345 * uncommon with PWR_INT.PWRON.
347 for (j = 0; j < 2; j++) {
348 status = twl4030_i2c_read(sih->module, rxbuf,
349 sih->mask[line].isr_offset, sih->bytes_ixr);
351 pr_err("twl4030: err %d initializing %s %s\n",
352 status, sih->name, "ISR");
355 status = twl4030_i2c_write(sih->module, buf,
356 sih->mask[line].isr_offset,
358 /* else COR=1 means read sufficed.
359 * (for most SIH modules...)
367 static inline void activate_irq(int irq)
370 /* ARM requires an extra step to clear IRQ_NOREQUEST, which it
371 * sets on behalf of every irq_chip. Also sets IRQ_NOPROBE.
373 set_irq_flags(irq, IRQF_VALID);
375 /* same effect on other architectures */
376 set_irq_noprobe(irq);
380 /*----------------------------------------------------------------------*/
382 static DEFINE_SPINLOCK(sih_agent_lock);
384 static struct workqueue_struct *wq;
388 const struct sih *sih;
391 bool imr_change_pending;
392 struct work_struct mask_work;
395 struct work_struct edge_work;
398 static void twl4030_sih_do_mask(struct work_struct *work)
400 struct sih_agent *agent;
401 const struct sih *sih;
408 agent = container_of(work, struct sih_agent, mask_work);
410 /* see what work we have */
411 spin_lock_irq(&sih_agent_lock);
412 if (agent->imr_change_pending) {
414 /* byte[0] gets overwritten as we write ... */
415 imr.word = cpu_to_le32(agent->imr << 8);
416 agent->imr_change_pending = false;
419 spin_unlock_irq(&sih_agent_lock);
423 /* write the whole mask ... simpler than subsetting it */
424 status = twl4030_i2c_write(sih->module, imr.bytes,
425 sih->mask[irq_line].imr_offset, sih->bytes_ixr);
427 pr_err("twl4030: %s, %s --> %d\n", __func__,
431 static void twl4030_sih_do_edge(struct work_struct *work)
433 struct sih_agent *agent;
434 const struct sih *sih;
439 agent = container_of(work, struct sih_agent, edge_work);
441 /* see what work we have */
442 spin_lock_irq(&sih_agent_lock);
443 edge_change = agent->edge_change;
444 agent->edge_change = 0;;
445 sih = edge_change ? agent->sih : NULL;
446 spin_unlock_irq(&sih_agent_lock);
450 /* Read, reserving first byte for write scratch. Yes, this
451 * could be cached for some speedup ... but be careful about
452 * any processor on the other IRQ line, EDR registers are
455 status = twl4030_i2c_read(sih->module, bytes + 1,
456 sih->edr_offset, sih->bytes_edr);
458 pr_err("twl4030: %s, %s --> %d\n", __func__,
463 /* Modify only the bits we know must change */
464 while (edge_change) {
465 int i = fls(edge_change) - 1;
466 struct irq_desc *d = irq_to_desc(i + agent->irq_base);
467 int byte = 1 + (i >> 2);
468 int off = (i & 0x3) * 2;
471 pr_err("twl4030: Invalid IRQ: %d\n",
472 i + agent->irq_base);
476 bytes[byte] &= ~(0x03 << off);
478 spin_lock_irq(&d->lock);
479 if (d->status & IRQ_TYPE_EDGE_RISING)
480 bytes[byte] |= BIT(off + 1);
481 if (d->status & IRQ_TYPE_EDGE_FALLING)
482 bytes[byte] |= BIT(off + 0);
483 spin_unlock_irq(&d->lock);
485 edge_change &= ~BIT(i);
489 status = twl4030_i2c_write(sih->module, bytes,
490 sih->edr_offset, sih->bytes_edr);
492 pr_err("twl4030: %s, %s --> %d\n", __func__,
496 /*----------------------------------------------------------------------*/
499 * All irq_chip methods get issued from code holding irq_desc[irq].lock,
500 * which can't perform the underlying I2C operations (because they sleep).
501 * So we must hand them off to a thread (workqueue) and cope with asynch
502 * completion, potentially including some re-ordering, of these requests.
505 static void twl4030_sih_mask(unsigned irq)
507 struct sih_agent *sih = get_irq_chip_data(irq);
510 spin_lock_irqsave(&sih_agent_lock, flags);
511 sih->imr |= BIT(irq - sih->irq_base);
512 sih->imr_change_pending = true;
513 queue_work(wq, &sih->mask_work);
514 spin_unlock_irqrestore(&sih_agent_lock, flags);
517 static void twl4030_sih_unmask(unsigned irq)
519 struct sih_agent *sih = get_irq_chip_data(irq);
522 spin_lock_irqsave(&sih_agent_lock, flags);
523 sih->imr &= ~BIT(irq - sih->irq_base);
524 sih->imr_change_pending = true;
525 queue_work(wq, &sih->mask_work);
526 spin_unlock_irqrestore(&sih_agent_lock, flags);
529 static int twl4030_sih_set_type(unsigned irq, unsigned trigger)
531 struct sih_agent *sih = get_irq_chip_data(irq);
532 struct irq_desc *desc = irq_to_desc(irq);
536 pr_err("twl4030: Invalid IRQ: %d\n", irq);
540 if (trigger & ~(IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
543 spin_lock_irqsave(&sih_agent_lock, flags);
544 if ((desc->status & IRQ_TYPE_SENSE_MASK) != trigger) {
545 desc->status &= ~IRQ_TYPE_SENSE_MASK;
546 desc->status |= trigger;
547 sih->edge_change |= BIT(irq - sih->irq_base);
548 queue_work(wq, &sih->edge_work);
550 spin_unlock_irqrestore(&sih_agent_lock, flags);
554 static struct irq_chip twl4030_sih_irq_chip = {
556 .mask = twl4030_sih_mask,
557 .unmask = twl4030_sih_unmask,
558 .set_type = twl4030_sih_set_type,
561 /*----------------------------------------------------------------------*/
563 static inline int sih_read_isr(const struct sih *sih)
571 /* FIXME need retry-on-error ... */
574 status = twl4030_i2c_read(sih->module, isr.bytes,
575 sih->mask[irq_line].isr_offset, sih->bytes_ixr);
577 return (status < 0) ? status : le32_to_cpu(isr.word);
581 * Generic handler for SIH interrupts ... we "know" this is called
582 * in task context, with IRQs enabled.
584 static void handle_twl4030_sih(unsigned irq, struct irq_desc *desc)
586 struct sih_agent *agent = get_irq_data(irq);
587 const struct sih *sih = agent->sih;
590 /* reading ISR acks the IRQs, using clear-on-read mode */
592 isr = sih_read_isr(sih);
596 pr_err("twl4030: %s SIH, read ISR error %d\n",
598 /* REVISIT: recover; eventually mask it all, etc */
608 generic_handle_irq(agent->irq_base + irq);
610 pr_err("twl4030: %s SIH, invalid ISR bit %d\n",
615 static unsigned twl4030_irq_next;
617 /* returns the first IRQ used by this SIH bank,
620 int twl4030_sih_setup(int module)
623 const struct sih *sih = NULL;
624 struct sih_agent *agent;
626 int status = -EINVAL;
627 unsigned irq_base = twl4030_irq_next;
629 /* only support modules with standard clear-on-read for now */
630 for (sih_mod = 0, sih = sih_modules;
631 sih_mod < ARRAY_SIZE(sih_modules);
633 if (sih->module == module && sih->set_cor) {
634 if (!WARN((irq_base + sih->bits) > NR_IRQS,
635 "irq %d for %s too big\n",
636 irq_base + sih->bits,
645 agent = kzalloc(sizeof *agent, GFP_KERNEL);
651 agent->irq_base = irq_base;
654 INIT_WORK(&agent->mask_work, twl4030_sih_do_mask);
655 INIT_WORK(&agent->edge_work, twl4030_sih_do_edge);
657 for (i = 0; i < sih->bits; i++) {
660 set_irq_chip_and_handler(irq, &twl4030_sih_irq_chip,
662 set_irq_chip_data(irq, agent);
667 twl4030_irq_next += i;
669 /* replace generic PIH handler (handle_simple_irq) */
670 irq = sih_mod + twl4030_irq_base;
671 set_irq_data(irq, agent);
672 set_irq_chained_handler(irq, handle_twl4030_sih);
674 pr_info("twl4030: %s (irq %d) chaining IRQs %d..%d\n", sih->name,
675 irq, irq_base, twl4030_irq_next - 1);
680 /* FIXME need a call to reverse twl4030_sih_setup() ... */
683 /*----------------------------------------------------------------------*/
685 /* FIXME pass in which interrupt line we'll use ... */
686 #define twl_irq_line 0
688 int twl_init_irq(int irq_num, unsigned irq_base, unsigned irq_end)
690 static struct irq_chip twl4030_irq_chip;
694 struct task_struct *task;
697 * Mask and clear all TWL4030 interrupts since initially we do
698 * not have any TWL4030 module interrupt handlers present
700 status = twl4030_init_sih_modules(twl_irq_line);
704 wq = create_singlethread_workqueue("twl4030-irqchip");
706 pr_err("twl4030: workqueue FAIL\n");
710 twl4030_irq_base = irq_base;
712 /* install an irq handler for each of the SIH modules;
713 * clone dummy irq_chip since PIH can't *do* anything
715 twl4030_irq_chip = dummy_irq_chip;
716 twl4030_irq_chip.name = "twl4030";
718 twl4030_sih_irq_chip.ack = dummy_irq_chip.ack;
720 for (i = irq_base; i < irq_end; i++) {
721 set_irq_chip_and_handler(i, &twl4030_irq_chip,
725 twl4030_irq_next = i;
726 pr_info("twl4030: %s (irq %d) chaining IRQs %d..%d\n", "PIH",
727 irq_num, irq_base, twl4030_irq_next - 1);
729 /* ... and the PWR_INT module ... */
730 status = twl4030_sih_setup(TWL4030_MODULE_INT);
732 pr_err("twl4030: sih_setup PWR INT --> %d\n", status);
736 /* install an irq handler to demultiplex the TWL4030 interrupt */
737 task = start_twl4030_irq_thread(irq_num);
739 pr_err("twl4030: irq thread FAIL\n");
744 set_irq_data(irq_num, task);
745 set_irq_chained_handler(irq_num, handle_twl4030_pih);
750 for (i = irq_base; i < irq_end; i++)
751 set_irq_chip_and_handler(i, NULL, NULL);
752 destroy_workqueue(wq);
757 int twl_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");