xref: /openbmc/linux/drivers/mfd/twl4030-irq.c (revision 8684014d)
1 /*
2  * twl4030-irq.c - TWL4030/TPS659x0 irq support
3  *
4  * Copyright (C) 2005-2006 Texas Instruments, Inc.
5  *
6  * Modifications to defer interrupt handling to a kernel thread:
7  * Copyright (C) 2006 MontaVista Software, Inc.
8  *
9  * Based on tlv320aic23.c:
10  * Copyright (c) by Kai Svahn <kai.svahn@nokia.com>
11  *
12  * Code cleanup and modifications to IRQ handler.
13  * by syed khasim <x0khasim@ti.com>
14  *
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.
19  *
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.
24  *
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
28  */
29 
30 #include <linux/export.h>
31 #include <linux/interrupt.h>
32 #include <linux/irq.h>
33 #include <linux/slab.h>
34 #include <linux/of.h>
35 #include <linux/irqdomain.h>
36 #include <linux/i2c/twl.h>
37 
38 #include "twl-core.h"
39 
40 /*
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.
46  *
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.
50  *
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
56  */
57 #define TWL4030_CORE_NR_IRQS	8
58 #define TWL4030_PWR_NR_IRQS	8
59 
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 */
64 
65 /* Linux could (eventually) use either IRQ line */
66 static int irq_line;
67 
68 struct sih {
69 	char	name[8];
70 	u8	module;			/* module id */
71 	u8	control_offset;		/* for SIH_CTRL */
72 	bool	set_cor;
73 
74 	u8	bits;			/* valid in isr/imr */
75 	u8	bytes_ixr;		/* bytelen of ISR/IMR/SIR */
76 
77 	u8	edr_offset;
78 	u8	bytes_edr;		/* bytelen of EDR */
79 
80 	u8	irq_lines;		/* number of supported irq lines */
81 
82 	/* SIR ignored -- set interrupt, for testing only */
83 	struct sih_irq_data {
84 		u8	isr_offset;
85 		u8	imr_offset;
86 	} mask[2];
87 	/* + 2 bytes padding */
88 };
89 
90 static const struct sih *sih_modules;
91 static int nr_sih_modules;
92 
93 #define SIH_INITIALIZER(modname, nbits) \
94 	.module		= TWL4030_MODULE_ ## modname, \
95 	.control_offset = TWL4030_ ## modname ## _SIH_CTRL, \
96 	.bits		= nbits, \
97 	.bytes_ixr	= DIV_ROUND_UP(nbits, 8), \
98 	.edr_offset	= TWL4030_ ## modname ## _EDR, \
99 	.bytes_edr	= DIV_ROUND_UP((2*(nbits)), 8), \
100 	.irq_lines	= 2, \
101 	.mask = { { \
102 		.isr_offset	= TWL4030_ ## modname ## _ISR1, \
103 		.imr_offset	= TWL4030_ ## modname ## _IMR1, \
104 	}, \
105 	{ \
106 		.isr_offset	= TWL4030_ ## modname ## _ISR2, \
107 		.imr_offset	= TWL4030_ ## modname ## _IMR2, \
108 	}, },
109 
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
114 
115 
116 /*
117  * Order in this table matches order in PIH_ISR.  That is,
118  * BIT(n) in PIH_ISR is sih_modules[n].
119  */
120 /* sih_modules_twl4030 is used both in twl4030 and twl5030 */
121 static const struct sih sih_modules_twl4030[6] = {
122 	[0] = {
123 		.name		= "gpio",
124 		.module		= TWL4030_MODULE_GPIO,
125 		.control_offset	= REG_GPIO_SIH_CTRL,
126 		.set_cor	= true,
127 		.bits		= TWL4030_GPIO_MAX,
128 		.bytes_ixr	= 3,
129 		/* Note: *all* of these IRQs default to no-trigger */
130 		.edr_offset	= REG_GPIO_EDR1,
131 		.bytes_edr	= 5,
132 		.irq_lines	= 2,
133 		.mask = { {
134 			.isr_offset	= REG_GPIO_ISR1A,
135 			.imr_offset	= REG_GPIO_IMR1A,
136 		}, {
137 			.isr_offset	= REG_GPIO_ISR1B,
138 			.imr_offset	= REG_GPIO_IMR1B,
139 		}, },
140 	},
141 	[1] = {
142 		.name		= "keypad",
143 		.set_cor	= true,
144 		SIH_INITIALIZER(KEYPAD_KEYP, 4)
145 	},
146 	[2] = {
147 		.name		= "bci",
148 		.module		= TWL4030_MODULE_INTERRUPTS,
149 		.control_offset	= TWL4030_INTERRUPTS_BCISIHCTRL,
150 		.set_cor	= true,
151 		.bits		= 12,
152 		.bytes_ixr	= 2,
153 		.edr_offset	= TWL4030_INTERRUPTS_BCIEDR1,
154 		/* Note: most of these IRQs default to no-trigger */
155 		.bytes_edr	= 3,
156 		.irq_lines	= 2,
157 		.mask = { {
158 			.isr_offset	= TWL4030_INTERRUPTS_BCIISR1A,
159 			.imr_offset	= TWL4030_INTERRUPTS_BCIIMR1A,
160 		}, {
161 			.isr_offset	= TWL4030_INTERRUPTS_BCIISR1B,
162 			.imr_offset	= TWL4030_INTERRUPTS_BCIIMR1B,
163 		}, },
164 	},
165 	[3] = {
166 		.name		= "madc",
167 		SIH_INITIALIZER(MADC, 4)
168 	},
169 	[4] = {
170 		/* USB doesn't use the same SIH organization */
171 		.name		= "usb",
172 	},
173 	[5] = {
174 		.name		= "power",
175 		.set_cor	= true,
176 		SIH_INITIALIZER(INT_PWR, 8)
177 	},
178 		/* there are no SIH modules #6 or #7 ... */
179 };
180 
181 static const struct sih sih_modules_twl5031[8] = {
182 	[0] = {
183 		.name		= "gpio",
184 		.module		= TWL4030_MODULE_GPIO,
185 		.control_offset	= REG_GPIO_SIH_CTRL,
186 		.set_cor	= true,
187 		.bits		= TWL4030_GPIO_MAX,
188 		.bytes_ixr	= 3,
189 		/* Note: *all* of these IRQs default to no-trigger */
190 		.edr_offset	= REG_GPIO_EDR1,
191 		.bytes_edr	= 5,
192 		.irq_lines	= 2,
193 		.mask = { {
194 			.isr_offset	= REG_GPIO_ISR1A,
195 			.imr_offset	= REG_GPIO_IMR1A,
196 		}, {
197 			.isr_offset	= REG_GPIO_ISR1B,
198 			.imr_offset	= REG_GPIO_IMR1B,
199 		}, },
200 	},
201 	[1] = {
202 		.name		= "keypad",
203 		.set_cor	= true,
204 		SIH_INITIALIZER(KEYPAD_KEYP, 4)
205 	},
206 	[2] = {
207 		.name		= "bci",
208 		.module		= TWL5031_MODULE_INTERRUPTS,
209 		.control_offset	= TWL5031_INTERRUPTS_BCISIHCTRL,
210 		.bits		= 7,
211 		.bytes_ixr	= 1,
212 		.edr_offset	= TWL5031_INTERRUPTS_BCIEDR1,
213 		/* Note: most of these IRQs default to no-trigger */
214 		.bytes_edr	= 2,
215 		.irq_lines	= 2,
216 		.mask = { {
217 			.isr_offset	= TWL5031_INTERRUPTS_BCIISR1,
218 			.imr_offset	= TWL5031_INTERRUPTS_BCIIMR1,
219 		}, {
220 			.isr_offset	= TWL5031_INTERRUPTS_BCIISR2,
221 			.imr_offset	= TWL5031_INTERRUPTS_BCIIMR2,
222 		}, },
223 	},
224 	[3] = {
225 		.name		= "madc",
226 		SIH_INITIALIZER(MADC, 4)
227 	},
228 	[4] = {
229 		/* USB doesn't use the same SIH organization */
230 		.name		= "usb",
231 	},
232 	[5] = {
233 		.name		= "power",
234 		.set_cor	= true,
235 		SIH_INITIALIZER(INT_PWR, 8)
236 	},
237 	[6] = {
238 		/*
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.
242 		 */
243 		.name		= "eci_dbi",
244 		.module		= TWL5031_MODULE_ACCESSORY,
245 		.bits		= 9,
246 		.bytes_ixr	= 2,
247 		.irq_lines	= 1,
248 		.mask = { {
249 			.isr_offset	= TWL5031_ACIIDR_LSB,
250 			.imr_offset	= TWL5031_ACIIMR_LSB,
251 		}, },
252 
253 	},
254 	[7] = {
255 		/* Audio accessory */
256 		.name		= "audio",
257 		.module		= TWL5031_MODULE_ACCESSORY,
258 		.control_offset	= TWL5031_ACCSIHCTRL,
259 		.bits		= 2,
260 		.bytes_ixr	= 1,
261 		.edr_offset	= TWL5031_ACCEDR1,
262 		/* Note: most of these IRQs default to no-trigger */
263 		.bytes_edr	= 1,
264 		.irq_lines	= 2,
265 		.mask = { {
266 			.isr_offset	= TWL5031_ACCISR1,
267 			.imr_offset	= TWL5031_ACCIMR1,
268 		}, {
269 			.isr_offset	= TWL5031_ACCISR2,
270 			.imr_offset	= TWL5031_ACCIMR2,
271 		}, },
272 	},
273 };
274 
275 #undef TWL4030_MODULE_KEYPAD_KEYP
276 #undef TWL4030_MODULE_INT_PWR
277 #undef TWL4030_INT_PWR_EDR
278 
279 /*----------------------------------------------------------------------*/
280 
281 static unsigned twl4030_irq_base;
282 
283 /*
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
290  * the kernel thread.
291  */
292 static irqreturn_t handle_twl4030_pih(int irq, void *devid)
293 {
294 	irqreturn_t	ret;
295 	u8		pih_isr;
296 
297 	ret = twl_i2c_read_u8(TWL_MODULE_PIH, &pih_isr,
298 			      REG_PIH_ISR_P1);
299 	if (ret) {
300 		pr_warn("twl4030: I2C error %d reading PIH ISR\n", ret);
301 		return IRQ_NONE;
302 	}
303 
304 	while (pih_isr) {
305 		unsigned long	pending = __ffs(pih_isr);
306 		unsigned int	irq;
307 
308 		pih_isr &= ~BIT(pending);
309 		irq = pending + twl4030_irq_base;
310 		handle_nested_irq(irq);
311 	}
312 
313 	return IRQ_HANDLED;
314 }
315 
316 /*----------------------------------------------------------------------*/
317 
318 /*
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.
322  *
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...
326  */
327 static int twl4030_init_sih_modules(unsigned line)
328 {
329 	const struct sih *sih;
330 	u8 buf[4];
331 	int i;
332 	int status;
333 
334 	/* line 0 == int1_n signal; line 1 == int2_n signal */
335 	if (line > 1)
336 		return -EINVAL;
337 
338 	irq_line = line;
339 
340 	/* disable all interrupts on our line */
341 	memset(buf, 0xff, sizeof(buf));
342 	sih = sih_modules;
343 	for (i = 0; i < nr_sih_modules; i++, sih++) {
344 		/* skip USB -- it's funky */
345 		if (!sih->bytes_ixr)
346 			continue;
347 
348 		/* Not all the SIH modules support multiple interrupt lines */
349 		if (sih->irq_lines <= line)
350 			continue;
351 
352 		status = twl_i2c_write(sih->module, buf,
353 				sih->mask[line].imr_offset, sih->bytes_ixr);
354 		if (status < 0)
355 			pr_err("twl4030: err %d initializing %s %s\n",
356 					status, sih->name, "IMR");
357 
358 		/*
359 		 * Maybe disable "exclusive" mode; buffer second pending irq;
360 		 * set Clear-On-Read (COR) bit.
361 		 *
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...
365 		 */
366 		if (sih->set_cor) {
367 			status = twl_i2c_write_u8(sih->module,
368 					TWL4030_SIH_CTRL_COR_MASK,
369 					sih->control_offset);
370 			if (status < 0)
371 				pr_err("twl4030: err %d initializing %s %s\n",
372 						status, sih->name, "SIH_CTRL");
373 		}
374 	}
375 
376 	sih = sih_modules;
377 	for (i = 0; i < nr_sih_modules; i++, sih++) {
378 		u8 rxbuf[4];
379 		int j;
380 
381 		/* skip USB */
382 		if (!sih->bytes_ixr)
383 			continue;
384 
385 		/* Not all the SIH modules support multiple interrupt lines */
386 		if (sih->irq_lines <= line)
387 			continue;
388 
389 		/*
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.
394 		 */
395 		for (j = 0; j < 2; j++) {
396 			status = twl_i2c_read(sih->module, rxbuf,
397 				sih->mask[line].isr_offset, sih->bytes_ixr);
398 			if (status < 0)
399 				pr_warn("twl4030: err %d initializing %s %s\n",
400 					status, sih->name, "ISR");
401 
402 			if (!sih->set_cor) {
403 				status = twl_i2c_write(sih->module, buf,
404 					sih->mask[line].isr_offset,
405 					sih->bytes_ixr);
406 				if (status < 0)
407 					pr_warn("twl4030: write failed: %d\n",
408 						status);
409 			}
410 			/*
411 			 * else COR=1 means read sufficed.
412 			 * (for most SIH modules...)
413 			 */
414 		}
415 	}
416 
417 	return 0;
418 }
419 
420 static inline void activate_irq(int irq)
421 {
422 #ifdef CONFIG_ARM
423 	/*
424 	 * ARM requires an extra step to clear IRQ_NOREQUEST, which it
425 	 * sets on behalf of every irq_chip.  Also sets IRQ_NOPROBE.
426 	 */
427 	set_irq_flags(irq, IRQF_VALID);
428 #else
429 	/* same effect on other architectures */
430 	irq_set_noprobe(irq);
431 #endif
432 }
433 
434 /*----------------------------------------------------------------------*/
435 
436 struct sih_agent {
437 	int			irq_base;
438 	const struct sih	*sih;
439 
440 	u32			imr;
441 	bool			imr_change_pending;
442 
443 	u32			edge_change;
444 
445 	struct mutex		irq_lock;
446 	char			*irq_name;
447 };
448 
449 /*----------------------------------------------------------------------*/
450 
451 /*
452  * All irq_chip methods get issued from code holding irq_desc[irq].lock,
453  * which can't perform the underlying I2C operations (because they sleep).
454  * So we must hand them off to a thread (workqueue) and cope with asynch
455  * completion, potentially including some re-ordering, of these requests.
456  */
457 
458 static void twl4030_sih_mask(struct irq_data *data)
459 {
460 	struct sih_agent *agent = irq_data_get_irq_chip_data(data);
461 
462 	agent->imr |= BIT(data->irq - agent->irq_base);
463 	agent->imr_change_pending = true;
464 }
465 
466 static void twl4030_sih_unmask(struct irq_data *data)
467 {
468 	struct sih_agent *agent = irq_data_get_irq_chip_data(data);
469 
470 	agent->imr &= ~BIT(data->irq - agent->irq_base);
471 	agent->imr_change_pending = true;
472 }
473 
474 static int twl4030_sih_set_type(struct irq_data *data, unsigned trigger)
475 {
476 	struct sih_agent *agent = irq_data_get_irq_chip_data(data);
477 
478 	if (trigger & ~(IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
479 		return -EINVAL;
480 
481 	if (irqd_get_trigger_type(data) != trigger)
482 		agent->edge_change |= BIT(data->irq - agent->irq_base);
483 
484 	return 0;
485 }
486 
487 static void twl4030_sih_bus_lock(struct irq_data *data)
488 {
489 	struct sih_agent	*agent = irq_data_get_irq_chip_data(data);
490 
491 	mutex_lock(&agent->irq_lock);
492 }
493 
494 static void twl4030_sih_bus_sync_unlock(struct irq_data *data)
495 {
496 	struct sih_agent	*agent = irq_data_get_irq_chip_data(data);
497 	const struct sih	*sih = agent->sih;
498 	int			status;
499 
500 	if (agent->imr_change_pending) {
501 		union {
502 			u32	word;
503 			u8	bytes[4];
504 		} imr;
505 
506 		/* byte[0] gets overwritten as we write ... */
507 		imr.word = cpu_to_le32(agent->imr);
508 		agent->imr_change_pending = false;
509 
510 		/* write the whole mask ... simpler than subsetting it */
511 		status = twl_i2c_write(sih->module, imr.bytes,
512 				sih->mask[irq_line].imr_offset,
513 				sih->bytes_ixr);
514 		if (status)
515 			pr_err("twl4030: %s, %s --> %d\n", __func__,
516 					"write", status);
517 	}
518 
519 	if (agent->edge_change) {
520 		u32		edge_change;
521 		u8		bytes[6];
522 
523 		edge_change = agent->edge_change;
524 		agent->edge_change = 0;
525 
526 		/*
527 		 * Read, reserving first byte for write scratch.  Yes, this
528 		 * could be cached for some speedup ... but be careful about
529 		 * any processor on the other IRQ line, EDR registers are
530 		 * shared.
531 		 */
532 		status = twl_i2c_read(sih->module, bytes,
533 				sih->edr_offset, sih->bytes_edr);
534 		if (status) {
535 			pr_err("twl4030: %s, %s --> %d\n", __func__,
536 					"read", status);
537 			return;
538 		}
539 
540 		/* Modify only the bits we know must change */
541 		while (edge_change) {
542 			int		i = fls(edge_change) - 1;
543 			int		byte = i >> 2;
544 			int		off = (i & 0x3) * 2;
545 			unsigned int	type;
546 
547 			bytes[byte] &= ~(0x03 << off);
548 
549 			type = irq_get_trigger_type(i + agent->irq_base);
550 			if (type & IRQ_TYPE_EDGE_RISING)
551 				bytes[byte] |= BIT(off + 1);
552 			if (type & IRQ_TYPE_EDGE_FALLING)
553 				bytes[byte] |= BIT(off + 0);
554 
555 			edge_change &= ~BIT(i);
556 		}
557 
558 		/* Write */
559 		status = twl_i2c_write(sih->module, bytes,
560 				sih->edr_offset, sih->bytes_edr);
561 		if (status)
562 			pr_err("twl4030: %s, %s --> %d\n", __func__,
563 					"write", status);
564 	}
565 
566 	mutex_unlock(&agent->irq_lock);
567 }
568 
569 static struct irq_chip twl4030_sih_irq_chip = {
570 	.name		= "twl4030",
571 	.irq_mask	= twl4030_sih_mask,
572 	.irq_unmask	= twl4030_sih_unmask,
573 	.irq_set_type	= twl4030_sih_set_type,
574 	.irq_bus_lock	= twl4030_sih_bus_lock,
575 	.irq_bus_sync_unlock = twl4030_sih_bus_sync_unlock,
576 	.flags		= IRQCHIP_SKIP_SET_WAKE,
577 };
578 
579 /*----------------------------------------------------------------------*/
580 
581 static inline int sih_read_isr(const struct sih *sih)
582 {
583 	int status;
584 	union {
585 		u8 bytes[4];
586 		u32 word;
587 	} isr;
588 
589 	/* FIXME need retry-on-error ... */
590 
591 	isr.word = 0;
592 	status = twl_i2c_read(sih->module, isr.bytes,
593 			sih->mask[irq_line].isr_offset, sih->bytes_ixr);
594 
595 	return (status < 0) ? status : le32_to_cpu(isr.word);
596 }
597 
598 /*
599  * Generic handler for SIH interrupts ... we "know" this is called
600  * in task context, with IRQs enabled.
601  */
602 static irqreturn_t handle_twl4030_sih(int irq, void *data)
603 {
604 	struct sih_agent *agent = irq_get_handler_data(irq);
605 	const struct sih *sih = agent->sih;
606 	int isr;
607 
608 	/* reading ISR acks the IRQs, using clear-on-read mode */
609 	isr = sih_read_isr(sih);
610 
611 	if (isr < 0) {
612 		pr_err("twl4030: %s SIH, read ISR error %d\n",
613 			sih->name, isr);
614 		/* REVISIT:  recover; eventually mask it all, etc */
615 		return IRQ_HANDLED;
616 	}
617 
618 	while (isr) {
619 		irq = fls(isr);
620 		irq--;
621 		isr &= ~BIT(irq);
622 
623 		if (irq < sih->bits)
624 			handle_nested_irq(agent->irq_base + irq);
625 		else
626 			pr_err("twl4030: %s SIH, invalid ISR bit %d\n",
627 				sih->name, irq);
628 	}
629 	return IRQ_HANDLED;
630 }
631 
632 /* returns the first IRQ used by this SIH bank, or negative errno */
633 int twl4030_sih_setup(struct device *dev, int module, int irq_base)
634 {
635 	int			sih_mod;
636 	const struct sih	*sih = NULL;
637 	struct sih_agent	*agent;
638 	int			i, irq;
639 	int			status = -EINVAL;
640 
641 	/* only support modules with standard clear-on-read for now */
642 	for (sih_mod = 0, sih = sih_modules; sih_mod < nr_sih_modules;
643 			sih_mod++, sih++) {
644 		if (sih->module == module && sih->set_cor) {
645 			status = 0;
646 			break;
647 		}
648 	}
649 
650 	if (status < 0)
651 		return status;
652 
653 	agent = kzalloc(sizeof(*agent), GFP_KERNEL);
654 	if (!agent)
655 		return -ENOMEM;
656 
657 	agent->irq_base = irq_base;
658 	agent->sih = sih;
659 	agent->imr = ~0;
660 	mutex_init(&agent->irq_lock);
661 
662 	for (i = 0; i < sih->bits; i++) {
663 		irq = irq_base + i;
664 
665 		irq_set_chip_data(irq, agent);
666 		irq_set_chip_and_handler(irq, &twl4030_sih_irq_chip,
667 					 handle_edge_irq);
668 		irq_set_nested_thread(irq, 1);
669 		activate_irq(irq);
670 	}
671 
672 	/* replace generic PIH handler (handle_simple_irq) */
673 	irq = sih_mod + twl4030_irq_base;
674 	irq_set_handler_data(irq, agent);
675 	agent->irq_name = kasprintf(GFP_KERNEL, "twl4030_%s", sih->name);
676 	status = request_threaded_irq(irq, NULL, handle_twl4030_sih,
677 				      IRQF_EARLY_RESUME,
678 				      agent->irq_name ?: sih->name, NULL);
679 
680 	dev_info(dev, "%s (irq %d) chaining IRQs %d..%d\n", sih->name,
681 			irq, irq_base, irq_base + i - 1);
682 
683 	return status < 0 ? status : irq_base;
684 }
685 
686 /* FIXME need a call to reverse twl4030_sih_setup() ... */
687 
688 /*----------------------------------------------------------------------*/
689 
690 /* FIXME pass in which interrupt line we'll use ... */
691 #define twl_irq_line	0
692 
693 int twl4030_init_irq(struct device *dev, int irq_num)
694 {
695 	static struct irq_chip	twl4030_irq_chip;
696 	int			status, i;
697 	int			irq_base, irq_end, nr_irqs;
698 	struct			device_node *node = dev->of_node;
699 
700 	/*
701 	 * TWL core and pwr interrupts must be contiguous because
702 	 * the hwirqs numbers are defined contiguously from 1 to 15.
703 	 * Create only one domain for both.
704 	 */
705 	nr_irqs = TWL4030_PWR_NR_IRQS + TWL4030_CORE_NR_IRQS;
706 
707 	irq_base = irq_alloc_descs(-1, 0, nr_irqs, 0);
708 	if (IS_ERR_VALUE(irq_base)) {
709 		dev_err(dev, "Fail to allocate IRQ descs\n");
710 		return irq_base;
711 	}
712 
713 	irq_domain_add_legacy(node, nr_irqs, irq_base, 0,
714 			      &irq_domain_simple_ops, NULL);
715 
716 	irq_end = irq_base + TWL4030_CORE_NR_IRQS;
717 
718 	/*
719 	 * Mask and clear all TWL4030 interrupts since initially we do
720 	 * not have any TWL4030 module interrupt handlers present
721 	 */
722 	status = twl4030_init_sih_modules(twl_irq_line);
723 	if (status < 0)
724 		return status;
725 
726 	twl4030_irq_base = irq_base;
727 
728 	/*
729 	 * Install an irq handler for each of the SIH modules;
730 	 * clone dummy irq_chip since PIH can't *do* anything
731 	 */
732 	twl4030_irq_chip = dummy_irq_chip;
733 	twl4030_irq_chip.name = "twl4030";
734 
735 	twl4030_sih_irq_chip.irq_ack = dummy_irq_chip.irq_ack;
736 
737 	for (i = irq_base; i < irq_end; i++) {
738 		irq_set_chip_and_handler(i, &twl4030_irq_chip,
739 					 handle_simple_irq);
740 		irq_set_nested_thread(i, 1);
741 		activate_irq(i);
742 	}
743 
744 	dev_info(dev, "%s (irq %d) chaining IRQs %d..%d\n", "PIH",
745 			irq_num, irq_base, irq_end);
746 
747 	/* ... and the PWR_INT module ... */
748 	status = twl4030_sih_setup(dev, TWL4030_MODULE_INT, irq_end);
749 	if (status < 0) {
750 		dev_err(dev, "sih_setup PWR INT --> %d\n", status);
751 		goto fail;
752 	}
753 
754 	/* install an irq handler to demultiplex the TWL4030 interrupt */
755 	status = request_threaded_irq(irq_num, NULL, handle_twl4030_pih,
756 				      IRQF_ONESHOT,
757 				      "TWL4030-PIH", NULL);
758 	if (status < 0) {
759 		dev_err(dev, "could not claim irq%d: %d\n", irq_num, status);
760 		goto fail_rqirq;
761 	}
762 	enable_irq_wake(irq_num);
763 
764 	return irq_base;
765 fail_rqirq:
766 	/* clean up twl4030_sih_setup */
767 fail:
768 	for (i = irq_base; i < irq_end; i++) {
769 		irq_set_nested_thread(i, 0);
770 		irq_set_chip_and_handler(i, NULL, NULL);
771 	}
772 
773 	return status;
774 }
775 
776 int twl4030_exit_irq(void)
777 {
778 	/* FIXME undo twl_init_irq() */
779 	if (twl4030_irq_base) {
780 		pr_err("twl4030: can't yet clean up IRQs?\n");
781 		return -ENOSYS;
782 	}
783 	return 0;
784 }
785 
786 int twl4030_init_chip_irq(const char *chip)
787 {
788 	if (!strcmp(chip, "twl5031")) {
789 		sih_modules = sih_modules_twl5031;
790 		nr_sih_modules = ARRAY_SIZE(sih_modules_twl5031);
791 	} else {
792 		sih_modules = sih_modules_twl4030;
793 		nr_sih_modules = ARRAY_SIZE(sih_modules_twl4030);
794 	}
795 
796 	return 0;
797 }
798