2 * Shared interrupt handling code for IPR and INTC2 types of IRQs.
4 * Copyright (C) 2007, 2008 Magnus Damm
6 * Based on intc2.c and ipr.c
8 * Copyright (C) 1999 Niibe Yutaka & Takeshi Yaegashi
9 * Copyright (C) 2000 Kazumoto Kojima
10 * Copyright (C) 2001 David J. Mckay (david.mckay@st.com)
11 * Copyright (C) 2003 Takashi Kusuda <kusuda-takashi@hitachi-ul.co.jp>
12 * Copyright (C) 2005, 2006 Paul Mundt
14 * This file is subject to the terms and conditions of the GNU General Public
15 * License. See the file "COPYING" in the main directory of this archive
18 #include <linux/init.h>
19 #include <linux/irq.h>
20 #include <linux/module.h>
22 #include <linux/interrupt.h>
23 #include <linux/bootmem.h>
25 #define _INTC_MK(fn, mode, addr_e, addr_d, width, shift) \
26 ((shift) | ((width) << 5) | ((fn) << 9) | ((mode) << 13) | \
27 ((addr_e) << 16) | ((addr_d << 24)))
29 #define _INTC_SHIFT(h) (h & 0x1f)
30 #define _INTC_WIDTH(h) ((h >> 5) & 0xf)
31 #define _INTC_FN(h) ((h >> 9) & 0xf)
32 #define _INTC_MODE(h) ((h >> 13) & 0x7)
33 #define _INTC_ADDR_E(h) ((h >> 16) & 0xff)
34 #define _INTC_ADDR_D(h) ((h >> 24) & 0xff)
36 struct intc_handle_int {
41 struct intc_desc_int {
47 struct intc_handle_int *prio;
49 struct intc_handle_int *sense;
50 unsigned int nr_sense;
55 #define IS_SMP(x) x.smp
56 #define INTC_REG(d, x, c) (d->reg[(x)] + ((d->smp[(x)] & 0xff) * c))
57 #define SMP_NR(d, x) ((d->smp[(x)] >> 8) ? (d->smp[(x)] >> 8) : 1)
60 #define INTC_REG(d, x, c) (d->reg[(x)])
61 #define SMP_NR(d, x) 1
64 static unsigned int intc_prio_level[NR_IRQS]; /* for now */
66 static unsigned long ack_handle[NR_IRQS];
69 static inline struct intc_desc_int *get_intc_desc(unsigned int irq)
71 struct irq_chip *chip = get_irq_chip(irq);
72 return (void *)((char *)chip - offsetof(struct intc_desc_int, chip));
75 static inline unsigned int set_field(unsigned int value,
76 unsigned int field_value,
79 unsigned int width = _INTC_WIDTH(handle);
80 unsigned int shift = _INTC_SHIFT(handle);
82 value &= ~(((1 << width) - 1) << shift);
83 value |= field_value << shift;
87 static void write_8(unsigned long addr, unsigned long h, unsigned long data)
89 ctrl_outb(set_field(0, data, h), addr);
92 static void write_16(unsigned long addr, unsigned long h, unsigned long data)
94 ctrl_outw(set_field(0, data, h), addr);
97 static void write_32(unsigned long addr, unsigned long h, unsigned long data)
99 ctrl_outl(set_field(0, data, h), addr);
102 static void modify_8(unsigned long addr, unsigned long h, unsigned long data)
105 local_irq_save(flags);
106 ctrl_outb(set_field(ctrl_inb(addr), data, h), addr);
107 local_irq_restore(flags);
110 static void modify_16(unsigned long addr, unsigned long h, unsigned long data)
113 local_irq_save(flags);
114 ctrl_outw(set_field(ctrl_inw(addr), data, h), addr);
115 local_irq_restore(flags);
118 static void modify_32(unsigned long addr, unsigned long h, unsigned long data)
121 local_irq_save(flags);
122 ctrl_outl(set_field(ctrl_inl(addr), data, h), addr);
123 local_irq_restore(flags);
126 enum { REG_FN_ERR = 0, REG_FN_WRITE_BASE = 1, REG_FN_MODIFY_BASE = 5 };
128 static void (*intc_reg_fns[])(unsigned long addr,
130 unsigned long data) = {
131 [REG_FN_WRITE_BASE + 0] = write_8,
132 [REG_FN_WRITE_BASE + 1] = write_16,
133 [REG_FN_WRITE_BASE + 3] = write_32,
134 [REG_FN_MODIFY_BASE + 0] = modify_8,
135 [REG_FN_MODIFY_BASE + 1] = modify_16,
136 [REG_FN_MODIFY_BASE + 3] = modify_32,
139 enum { MODE_ENABLE_REG = 0, /* Bit(s) set -> interrupt enabled */
140 MODE_MASK_REG, /* Bit(s) set -> interrupt disabled */
141 MODE_DUAL_REG, /* Two registers, set bit to enable / disable */
142 MODE_PRIO_REG, /* Priority value written to enable interrupt */
143 MODE_PCLR_REG, /* Above plus all bits set to disable interrupt */
146 static void intc_mode_field(unsigned long addr,
147 unsigned long handle,
148 void (*fn)(unsigned long,
153 fn(addr, handle, ((1 << _INTC_WIDTH(handle)) - 1));
156 static void intc_mode_zero(unsigned long addr,
157 unsigned long handle,
158 void (*fn)(unsigned long,
166 static void intc_mode_prio(unsigned long addr,
167 unsigned long handle,
168 void (*fn)(unsigned long,
173 fn(addr, handle, intc_prio_level[irq]);
176 static void (*intc_enable_fns[])(unsigned long addr,
177 unsigned long handle,
178 void (*fn)(unsigned long,
181 unsigned int irq) = {
182 [MODE_ENABLE_REG] = intc_mode_field,
183 [MODE_MASK_REG] = intc_mode_zero,
184 [MODE_DUAL_REG] = intc_mode_field,
185 [MODE_PRIO_REG] = intc_mode_prio,
186 [MODE_PCLR_REG] = intc_mode_prio,
189 static void (*intc_disable_fns[])(unsigned long addr,
190 unsigned long handle,
191 void (*fn)(unsigned long,
194 unsigned int irq) = {
195 [MODE_ENABLE_REG] = intc_mode_zero,
196 [MODE_MASK_REG] = intc_mode_field,
197 [MODE_DUAL_REG] = intc_mode_field,
198 [MODE_PRIO_REG] = intc_mode_zero,
199 [MODE_PCLR_REG] = intc_mode_field,
202 static inline void _intc_enable(unsigned int irq, unsigned long handle)
204 struct intc_desc_int *d = get_intc_desc(irq);
208 for (cpu = 0; cpu < SMP_NR(d, _INTC_ADDR_E(handle)); cpu++) {
209 addr = INTC_REG(d, _INTC_ADDR_E(handle), cpu);
210 intc_enable_fns[_INTC_MODE(handle)](addr, handle, intc_reg_fns\
211 [_INTC_FN(handle)], irq);
215 static void intc_enable(unsigned int irq)
217 _intc_enable(irq, (unsigned long)get_irq_chip_data(irq));
220 static void intc_disable(unsigned int irq)
222 struct intc_desc_int *d = get_intc_desc(irq);
223 unsigned long handle = (unsigned long) get_irq_chip_data(irq);
227 for (cpu = 0; cpu < SMP_NR(d, _INTC_ADDR_D(handle)); cpu++) {
228 addr = INTC_REG(d, _INTC_ADDR_D(handle), cpu);
229 intc_disable_fns[_INTC_MODE(handle)](addr, handle,intc_reg_fns\
230 [_INTC_FN(handle)], irq);
234 #ifdef CONFIG_CPU_SH3
235 static void intc_mask_ack(unsigned int irq)
237 struct intc_desc_int *d = get_intc_desc(irq);
238 unsigned long handle = ack_handle[irq];
243 /* read register and write zero only to the assocaited bit */
246 addr = INTC_REG(d, _INTC_ADDR_D(handle), 0);
248 ctrl_outb(0x3f ^ set_field(0, 1, handle), addr);
253 static struct intc_handle_int *intc_find_irq(struct intc_handle_int *hp,
259 /* this doesn't scale well, but...
261 * this function should only be used for cerain uncommon
262 * operations such as intc_set_priority() and intc_set_sense()
263 * and in those rare cases performance doesn't matter that much.
264 * keeping the memory footprint low is more important.
266 * one rather simple way to speed this up and still keep the
267 * memory footprint down is to make sure the array is sorted
268 * and then perform a bisect to lookup the irq.
271 for (i = 0; i < nr_hp; i++) {
272 if ((hp + i)->irq != irq)
281 int intc_set_priority(unsigned int irq, unsigned int prio)
283 struct intc_desc_int *d = get_intc_desc(irq);
284 struct intc_handle_int *ihp;
286 if (!intc_prio_level[irq] || prio <= 1)
289 ihp = intc_find_irq(d->prio, d->nr_prio, irq);
291 if (prio >= (1 << _INTC_WIDTH(ihp->handle)))
294 intc_prio_level[irq] = prio;
297 * only set secondary masking method directly
298 * primary masking method is using intc_prio_level[irq]
299 * priority level will be set during next enable()
302 if (_INTC_FN(ihp->handle) != REG_FN_ERR)
303 _intc_enable(irq, ihp->handle);
308 #define VALID(x) (x | 0x80)
310 static unsigned char intc_irq_sense_table[IRQ_TYPE_SENSE_MASK + 1] = {
311 [IRQ_TYPE_EDGE_FALLING] = VALID(0),
312 [IRQ_TYPE_EDGE_RISING] = VALID(1),
313 [IRQ_TYPE_LEVEL_LOW] = VALID(2),
314 /* SH7706, SH7707 and SH7709 do not support high level triggered */
315 #if !defined(CONFIG_CPU_SUBTYPE_SH7706) && \
316 !defined(CONFIG_CPU_SUBTYPE_SH7707) && \
317 !defined(CONFIG_CPU_SUBTYPE_SH7709)
318 [IRQ_TYPE_LEVEL_HIGH] = VALID(3),
322 static int intc_set_sense(unsigned int irq, unsigned int type)
324 struct intc_desc_int *d = get_intc_desc(irq);
325 unsigned char value = intc_irq_sense_table[type & IRQ_TYPE_SENSE_MASK];
326 struct intc_handle_int *ihp;
332 ihp = intc_find_irq(d->sense, d->nr_sense, irq);
334 addr = INTC_REG(d, _INTC_ADDR_E(ihp->handle), 0);
335 intc_reg_fns[_INTC_FN(ihp->handle)](addr, ihp->handle, value);
340 static unsigned int __init intc_get_reg(struct intc_desc_int *d,
341 unsigned long address)
345 for (k = 0; k < d->nr_reg; k++) {
346 if (d->reg[k] == address)
354 static intc_enum __init intc_grp_id(struct intc_desc *desc,
357 struct intc_group *g = desc->groups;
360 for (i = 0; g && enum_id && i < desc->nr_groups; i++) {
361 g = desc->groups + i;
363 for (j = 0; g->enum_ids[j]; j++) {
364 if (g->enum_ids[j] != enum_id)
374 static unsigned int __init intc_mask_data(struct intc_desc *desc,
375 struct intc_desc_int *d,
376 intc_enum enum_id, int do_grps)
378 struct intc_mask_reg *mr = desc->mask_regs;
379 unsigned int i, j, fn, mode;
380 unsigned long reg_e, reg_d;
382 for (i = 0; mr && enum_id && i < desc->nr_mask_regs; i++) {
383 mr = desc->mask_regs + i;
385 for (j = 0; j < ARRAY_SIZE(mr->enum_ids); j++) {
386 if (mr->enum_ids[j] != enum_id)
389 if (mr->set_reg && mr->clr_reg) {
390 fn = REG_FN_WRITE_BASE;
391 mode = MODE_DUAL_REG;
395 fn = REG_FN_MODIFY_BASE;
397 mode = MODE_ENABLE_REG;
401 mode = MODE_MASK_REG;
407 fn += (mr->reg_width >> 3) - 1;
408 return _INTC_MK(fn, mode,
409 intc_get_reg(d, reg_e),
410 intc_get_reg(d, reg_d),
412 (mr->reg_width - 1) - j);
417 return intc_mask_data(desc, d, intc_grp_id(desc, enum_id), 0);
422 static unsigned int __init intc_prio_data(struct intc_desc *desc,
423 struct intc_desc_int *d,
424 intc_enum enum_id, int do_grps)
426 struct intc_prio_reg *pr = desc->prio_regs;
427 unsigned int i, j, fn, mode, bit;
428 unsigned long reg_e, reg_d;
430 for (i = 0; pr && enum_id && i < desc->nr_prio_regs; i++) {
431 pr = desc->prio_regs + i;
433 for (j = 0; j < ARRAY_SIZE(pr->enum_ids); j++) {
434 if (pr->enum_ids[j] != enum_id)
437 if (pr->set_reg && pr->clr_reg) {
438 fn = REG_FN_WRITE_BASE;
439 mode = MODE_PCLR_REG;
443 fn = REG_FN_MODIFY_BASE;
444 mode = MODE_PRIO_REG;
451 fn += (pr->reg_width >> 3) - 1;
452 bit = pr->reg_width - ((j + 1) * pr->field_width);
456 return _INTC_MK(fn, mode,
457 intc_get_reg(d, reg_e),
458 intc_get_reg(d, reg_d),
459 pr->field_width, bit);
464 return intc_prio_data(desc, d, intc_grp_id(desc, enum_id), 0);
469 #ifdef CONFIG_CPU_SH3
470 static unsigned int __init intc_ack_data(struct intc_desc *desc,
471 struct intc_desc_int *d,
474 struct intc_mask_reg *mr = desc->ack_regs;
475 unsigned int i, j, fn, mode;
476 unsigned long reg_e, reg_d;
478 for (i = 0; mr && enum_id && i < desc->nr_ack_regs; i++) {
479 mr = desc->ack_regs + i;
481 for (j = 0; j < ARRAY_SIZE(mr->enum_ids); j++) {
482 if (mr->enum_ids[j] != enum_id)
485 fn = REG_FN_MODIFY_BASE;
486 mode = MODE_ENABLE_REG;
490 fn += (mr->reg_width >> 3) - 1;
491 return _INTC_MK(fn, mode,
492 intc_get_reg(d, reg_e),
493 intc_get_reg(d, reg_d),
495 (mr->reg_width - 1) - j);
503 static unsigned int __init intc_sense_data(struct intc_desc *desc,
504 struct intc_desc_int *d,
507 struct intc_sense_reg *sr = desc->sense_regs;
508 unsigned int i, j, fn, bit;
510 for (i = 0; sr && enum_id && i < desc->nr_sense_regs; i++) {
511 sr = desc->sense_regs + i;
513 for (j = 0; j < ARRAY_SIZE(sr->enum_ids); j++) {
514 if (sr->enum_ids[j] != enum_id)
517 fn = REG_FN_MODIFY_BASE;
518 fn += (sr->reg_width >> 3) - 1;
519 bit = sr->reg_width - ((j + 1) * sr->field_width);
523 return _INTC_MK(fn, 0, intc_get_reg(d, sr->reg),
524 0, sr->field_width, bit);
531 static void __init intc_register_irq(struct intc_desc *desc,
532 struct intc_desc_int *d,
536 struct intc_handle_int *hp;
537 unsigned int data[2], primary;
539 /* Prefer single interrupt source bitmap over other combinations:
540 * 1. bitmap, single interrupt source
541 * 2. priority, single interrupt source
542 * 3. bitmap, multiple interrupt sources (groups)
543 * 4. priority, multiple interrupt sources (groups)
546 data[0] = intc_mask_data(desc, d, enum_id, 0);
547 data[1] = intc_prio_data(desc, d, enum_id, 0);
550 if (!data[0] && data[1])
553 data[0] = data[0] ? data[0] : intc_mask_data(desc, d, enum_id, 1);
554 data[1] = data[1] ? data[1] : intc_prio_data(desc, d, enum_id, 1);
559 BUG_ON(!data[primary]); /* must have primary masking method */
561 disable_irq_nosync(irq);
562 set_irq_chip_and_handler_name(irq, &d->chip,
563 handle_level_irq, "level");
564 set_irq_chip_data(irq, (void *)data[primary]);
566 /* set priority level
567 * - this needs to be at least 2 for 5-bit priorities on 7780
569 intc_prio_level[irq] = 2;
571 /* enable secondary masking method if present */
573 _intc_enable(irq, data[!primary]);
575 /* add irq to d->prio list if priority is available */
577 hp = d->prio + d->nr_prio;
579 hp->handle = data[1];
583 * only secondary priority should access registers, so
584 * set _INTC_FN(h) = REG_FN_ERR for intc_set_priority()
587 hp->handle &= ~_INTC_MK(0x0f, 0, 0, 0, 0, 0);
588 hp->handle |= _INTC_MK(REG_FN_ERR, 0, 0, 0, 0, 0);
593 /* add irq to d->sense list if sense is available */
594 data[0] = intc_sense_data(desc, d, enum_id);
596 (d->sense + d->nr_sense)->irq = irq;
597 (d->sense + d->nr_sense)->handle = data[0];
601 /* irq should be disabled by default */
604 #ifdef CONFIG_CPU_SH3
606 ack_handle[irq] = intc_ack_data(desc, d, enum_id);
610 static unsigned int __init save_reg(struct intc_desc_int *d,
627 void __init register_intc_controller(struct intc_desc *desc)
629 unsigned int i, k, smp;
630 struct intc_desc_int *d;
632 d = alloc_bootmem(sizeof(*d));
634 d->nr_reg = desc->mask_regs ? desc->nr_mask_regs * 2 : 0;
635 d->nr_reg += desc->prio_regs ? desc->nr_prio_regs * 2 : 0;
636 d->nr_reg += desc->sense_regs ? desc->nr_sense_regs : 0;
638 #ifdef CONFIG_CPU_SH3
639 d->nr_reg += desc->ack_regs ? desc->nr_ack_regs : 0;
641 d->reg = alloc_bootmem(d->nr_reg * sizeof(*d->reg));
643 d->smp = alloc_bootmem(d->nr_reg * sizeof(*d->smp));
647 if (desc->mask_regs) {
648 for (i = 0; i < desc->nr_mask_regs; i++) {
649 smp = IS_SMP(desc->mask_regs[i]);
650 k += save_reg(d, k, desc->mask_regs[i].set_reg, smp);
651 k += save_reg(d, k, desc->mask_regs[i].clr_reg, smp);
655 if (desc->prio_regs) {
656 d->prio = alloc_bootmem(desc->nr_vectors * sizeof(*d->prio));
658 for (i = 0; i < desc->nr_prio_regs; i++) {
659 smp = IS_SMP(desc->prio_regs[i]);
660 k += save_reg(d, k, desc->prio_regs[i].set_reg, smp);
661 k += save_reg(d, k, desc->prio_regs[i].clr_reg, smp);
665 if (desc->sense_regs) {
666 d->sense = alloc_bootmem(desc->nr_vectors * sizeof(*d->sense));
668 for (i = 0; i < desc->nr_sense_regs; i++) {
669 k += save_reg(d, k, desc->sense_regs[i].reg, 0);
673 d->chip.name = desc->name;
674 d->chip.mask = intc_disable;
675 d->chip.unmask = intc_enable;
676 d->chip.mask_ack = intc_disable;
677 d->chip.set_type = intc_set_sense;
679 #ifdef CONFIG_CPU_SH3
680 if (desc->ack_regs) {
681 for (i = 0; i < desc->nr_ack_regs; i++)
682 k += save_reg(d, k, desc->ack_regs[i].set_reg, 0);
684 d->chip.mask_ack = intc_mask_ack;
688 BUG_ON(k > 256); /* _INTC_ADDR_E() and _INTC_ADDR_D() are 8 bits */
690 for (i = 0; i < desc->nr_vectors; i++) {
691 struct intc_vect *vect = desc->vectors + i;
693 intc_register_irq(desc, d, vect->enum_id, evt2irq(vect->vect));