Major cleanup of the interrupt registration subsystem.
[dragonfly.git] / sys / platform / pc32 / isa / intr_machdep.h
1 /*-
2  * Copyright (c) 1991 The Regents of the University of California.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by the University of
16  *      California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * $FreeBSD: src/sys/i386/isa/intr_machdep.h,v 1.19.2.2 2001/10/14 20:05:50 luigi Exp $
34  * $DragonFly: src/sys/platform/pc32/isa/intr_machdep.h,v 1.18 2005/10/13 00:02:47 dillon Exp $
35  */
36
37 #ifndef _I386_ISA_INTR_MACHDEP_H_
38 #define _I386_ISA_INTR_MACHDEP_H_
39
40 #ifndef LOCORE
41 #ifndef _SYS_INTERRUPT_H_
42 #include <sys/interrupt.h>
43 #endif
44 #ifndef _SYS_SERIALIZE_H_
45 #include <sys/serialize.h>
46 #endif
47 #endif
48
49 /*
50  * Low level interrupt code.
51  */ 
52
53 #ifdef _KERNEL
54
55 #if defined(SMP) || defined(APIC_IO)
56 /*
57  * XXX FIXME: rethink location for all IPI vectors.
58  */
59
60 /*
61     APIC TPR priority vector levels:
62
63         0xff (255) +-------------+
64                    |             | 15 (IPIs: Xspuriousint)
65         0xf0 (240) +-------------+
66                    |             | 14
67         0xe0 (224) +-------------+
68                    |             | 13
69         0xd0 (208) +-------------+
70                    |             | 12
71         0xc0 (192) +-------------+
72                    |             | 11
73         0xb0 (176) +-------------+
74                    |             | 10 (IPIs: Xcpustop)
75         0xa0 (160) +-------------+
76                    |             |  9 (IPIs: Xinvltlb)
77         0x90 (144) +-------------+
78                    |             |  8 (linux/BSD syscall, IGNORE FAST HW INTS)
79         0x80 (128) +-------------+
80                    |             |  7 (FAST_INTR 16-23)
81         0x70 (112) +-------------+
82                    |             |  6 (FAST_INTR 0-15)
83         0x60 (96)  +-------------+
84                    |             |  5 (IGNORE HW INTS)
85         0x50 (80)  +-------------+
86                    |             |  4 (2nd IO APIC)
87         0x40 (64)  +------+------+
88                    |      |      |  3 (upper APIC hardware INTs: PCI)
89         0x30 (48)  +------+------+
90                    |             |  2 (start of hardware INTs: ISA)
91         0x20 (32)  +-------------+
92                    |             |  1 (exceptions, traps, etc.)
93         0x10 (16)  +-------------+
94                    |             |  0 (exceptions, traps, etc.)
95         0x00 (0)   +-------------+
96  */
97
98 /* IDT vector base for regular (aka. slow) and fast interrupts */
99 #define TPR_SLOW_INTS           0x20
100 #define TPR_FAST_INTS           0x60
101
102 /* blocking values for local APIC Task Priority Register */
103 #define TPR_BLOCK_HWI           0x4f            /* hardware INTs */
104 #define TPR_IGNORE_HWI          0x5f            /* ignore INTs */
105 #define TPR_BLOCK_FHWI          0x7f            /* hardware FAST INTs */
106 #define TPR_IGNORE_FHWI         0x8f            /* ignore FAST INTs */
107 #define TPR_IPI_ONLY            0x8f            /* ignore FAST INTs */
108 #define TPR_BLOCK_XINVLTLB      0x9f            /*  */
109 #define TPR_BLOCK_XCPUSTOP      0xaf            /*  */
110 #define TPR_BLOCK_ALL           0xff            /* all INTs */
111
112
113 #ifdef TEST_TEST1
114 /* put a 'fake' HWI in top of APIC prio 0x3x, 32 + 31 = 63 = 0x3f */
115 #define XTEST1_OFFSET           (ICU_OFFSET + 31)
116 #endif /** TEST_TEST1 */
117
118 /* TLB shootdowns */
119 #define XINVLTLB_OFFSET         (ICU_OFFSET + 112)
120
121 /* unused/open (was inter-cpu clock handling) */
122 #define XUNUSED113_OFFSET       (ICU_OFFSET + 113)
123
124 /* inter-CPU rendezvous */
125 #define XUNUSED114_OFFSET       (ICU_OFFSET + 114)
126
127 /* IPIQ rendezvous */
128 #define XIPIQ_OFFSET            (ICU_OFFSET + 115)
129
130 /* IPI to signal CPUs to stop and wait for another CPU to restart them */
131 #define XCPUSTOP_OFFSET         (ICU_OFFSET + 128)
132
133 /*
134  * Note: this vector MUST be xxxx1111, 32 + 223 = 255 = 0xff:
135  */
136 #define XSPURIOUSINT_OFFSET     (ICU_OFFSET + 223)
137
138 #endif /* SMP || APIC_IO */
139
140 #ifndef LOCORE
141
142 /*
143  * Type of the first (asm) part of an interrupt handler.
144  */
145 typedef void inthand_t(u_int cs, u_int ef, u_int esp, u_int ss);
146 typedef void unpendhand_t(void);
147
148 #define IDTVEC(name)    __CONCAT(X,name)
149
150 inthand_t
151         IDTVEC(fastintr0), IDTVEC(fastintr1),
152         IDTVEC(fastintr2), IDTVEC(fastintr3),
153         IDTVEC(fastintr4), IDTVEC(fastintr5),
154         IDTVEC(fastintr6), IDTVEC(fastintr7),
155         IDTVEC(fastintr8), IDTVEC(fastintr9),
156         IDTVEC(fastintr10), IDTVEC(fastintr11),
157         IDTVEC(fastintr12), IDTVEC(fastintr13),
158         IDTVEC(fastintr14), IDTVEC(fastintr15);
159 #if defined(APIC_IO)
160 inthand_t
161         IDTVEC(fastintr16), IDTVEC(fastintr17),
162         IDTVEC(fastintr18), IDTVEC(fastintr19),
163         IDTVEC(fastintr20), IDTVEC(fastintr21),
164         IDTVEC(fastintr22), IDTVEC(fastintr23);
165 #endif
166
167 inthand_t
168         IDTVEC(intr0), IDTVEC(intr1), IDTVEC(intr2), IDTVEC(intr3),
169         IDTVEC(intr4), IDTVEC(intr5), IDTVEC(intr6), IDTVEC(intr7),
170         IDTVEC(intr8), IDTVEC(intr9), IDTVEC(intr10), IDTVEC(intr11),
171         IDTVEC(intr12), IDTVEC(intr13), IDTVEC(intr14), IDTVEC(intr15);
172 #if defined(APIC_IO)
173 inthand_t
174         IDTVEC(intr16), IDTVEC(intr17), IDTVEC(intr18), IDTVEC(intr19),
175         IDTVEC(intr20), IDTVEC(intr21), IDTVEC(intr22), IDTVEC(intr23);
176 #endif
177
178 unpendhand_t
179         IDTVEC(fastunpend0), IDTVEC(fastunpend1),
180         IDTVEC(fastunpend2), IDTVEC(fastunpend3),
181         IDTVEC(fastunpend4), IDTVEC(fastunpend5),
182         IDTVEC(fastunpend6), IDTVEC(fastunpend7),
183         IDTVEC(fastunpend8), IDTVEC(fastunpend9),
184         IDTVEC(fastunpend10), IDTVEC(fastunpend11),
185         IDTVEC(fastunpend12), IDTVEC(fastunpend13),
186         IDTVEC(fastunpend14), IDTVEC(fastunpend15);
187 #if defined(APIC_IO)
188 unpendhand_t
189         IDTVEC(fastunpend16), IDTVEC(fastunpend17),
190         IDTVEC(fastunpend18), IDTVEC(fastunpend19),
191         IDTVEC(fastunpend20), IDTVEC(fastunpend21),
192         IDTVEC(fastunpend22), IDTVEC(fastunpend23);
193 #endif
194
195 #if defined(APIC_IO)
196 inthand_t
197         IDTVEC(wrongintr0), IDTVEC(wrongintr1),
198         IDTVEC(wrongintr2), IDTVEC(wrongintr3),
199         IDTVEC(wrongintr4), IDTVEC(wrongintr5),
200         IDTVEC(wrongintr6), IDTVEC(wrongintr7),
201         IDTVEC(wrongintr8), IDTVEC(wrongintr9),
202         IDTVEC(wrongintr10), IDTVEC(wrongintr11),
203         IDTVEC(wrongintr12), IDTVEC(wrongintr13),
204         IDTVEC(wrongintr14), IDTVEC(wrongintr15),
205         IDTVEC(wrongintr16), IDTVEC(wrongintr17),
206         IDTVEC(wrongintr18), IDTVEC(wrongintr19),
207         IDTVEC(wrongintr20), IDTVEC(wrongintr21),
208         IDTVEC(wrongintr22), IDTVEC(wrongintr23);
209 #endif
210
211 #if defined(SMP)
212 inthand_t
213         Xinvltlb,       /* TLB shootdowns */
214         Xcpuast,        /* Additional software trap on other cpu */ 
215         Xforward_irq,   /* Forward irq to cpu holding ISR lock */
216         Xcpustop,       /* CPU stops & waits for another CPU to restart it */
217         Xspuriousint,   /* handle APIC "spurious INTs" */
218         Xipiq;          /* handle lwkt_send_ipiq() requests */
219
220 #ifdef TEST_TEST1
221 inthand_t
222         Xtest1;         /* 'fake' HWI at top of APIC prio 0x3x, 32+31 = 0x3f */
223 #endif /** TEST_TEST1 */
224 #endif /* SMP */
225
226 void    call_fast_unpend(int irq);
227 void    isa_defaultirq (void);
228 int     isa_nmi (int cd);
229 void    icu_reinit (void);
230
231 /*
232  * WARNING: These are internal functions and not to be used by device drivers!
233  * They are subject to change without notice. 
234  */
235 void *inthand_add(const char *name, int irq, inthand2_t handler,
236                   void *arg, int flags, lwkt_serialize_t serializer);
237 int inthand_remove(void *id);
238 void forward_fastint_remote(void *arg);
239
240 #endif /* LOCORE */
241
242 #endif /* _KERNEL */
243
244 #endif /* !_I386_ISA_INTR_MACHDEP_H_ */