Add NEWBUS infrastructure for interrupt enablement and disablement. This
[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.13 2005/05/23 18:19:53 dillon Exp $
35  */
36
37 #ifndef _I386_ISA_INTR_MACHDEP_H_
38 #define _I386_ISA_INTR_MACHDEP_H_
39
40 #ifndef _SYS_INTERRUPT_H_
41 #ifndef LOCORE
42 #include <sys/interrupt.h>
43 #endif
44 #endif
45
46 /*
47  * Low level interrupt code.
48  */ 
49
50 #ifdef _KERNEL
51
52 #if defined(SMP) || defined(APIC_IO)
53 /*
54  * XXX FIXME: rethink location for all IPI vectors.
55  */
56
57 /*
58     APIC TPR priority vector levels:
59
60         0xff (255) +-------------+
61                    |             | 15 (IPIs: Xspuriousint)
62         0xf0 (240) +-------------+
63                    |             | 14
64         0xe0 (224) +-------------+
65                    |             | 13
66         0xd0 (208) +-------------+
67                    |             | 12
68         0xc0 (192) +-------------+
69                    |             | 11
70         0xb0 (176) +-------------+
71                    |             | 10 (IPIs: Xcpustop)
72         0xa0 (160) +-------------+
73                    |             |  9 (IPIs: Xinvltlb)
74         0x90 (144) +-------------+
75                    |             |  8 (linux/BSD syscall, IGNORE FAST HW INTS)
76         0x80 (128) +-------------+
77                    |             |  7 (FAST_INTR 16-23)
78         0x70 (112) +-------------+
79                    |             |  6 (FAST_INTR 0-15)
80         0x60 (96)  +-------------+
81                    |             |  5 (IGNORE HW INTS)
82         0x50 (80)  +-------------+
83                    |             |  4 (2nd IO APIC)
84         0x40 (64)  +------+------+
85                    |      |      |  3 (upper APIC hardware INTs: PCI)
86         0x30 (48)  +------+------+
87                    |             |  2 (start of hardware INTs: ISA)
88         0x20 (32)  +-------------+
89                    |             |  1 (exceptions, traps, etc.)
90         0x10 (16)  +-------------+
91                    |             |  0 (exceptions, traps, etc.)
92         0x00 (0)   +-------------+
93  */
94
95 /* IDT vector base for regular (aka. slow) and fast interrupts */
96 #define TPR_SLOW_INTS           0x20
97 #define TPR_FAST_INTS           0x60
98
99 /* blocking values for local APIC Task Priority Register */
100 #define TPR_BLOCK_HWI           0x4f            /* hardware INTs */
101 #define TPR_IGNORE_HWI          0x5f            /* ignore INTs */
102 #define TPR_BLOCK_FHWI          0x7f            /* hardware FAST INTs */
103 #define TPR_IGNORE_FHWI         0x8f            /* ignore FAST INTs */
104 #define TPR_IPI_ONLY            0x8f            /* ignore FAST INTs */
105 #define TPR_BLOCK_XINVLTLB      0x9f            /*  */
106 #define TPR_BLOCK_XCPUSTOP      0xaf            /*  */
107 #define TPR_BLOCK_ALL           0xff            /* all INTs */
108
109
110 #ifdef TEST_TEST1
111 /* put a 'fake' HWI in top of APIC prio 0x3x, 32 + 31 = 63 = 0x3f */
112 #define XTEST1_OFFSET           (ICU_OFFSET + 31)
113 #endif /** TEST_TEST1 */
114
115 /* TLB shootdowns */
116 #define XINVLTLB_OFFSET         (ICU_OFFSET + 112)
117
118 /* unused/open (was inter-cpu clock handling) */
119 #define XUNUSED113_OFFSET       (ICU_OFFSET + 113)
120
121 /* inter-CPU rendezvous */
122 #define XRENDEZVOUS_OFFSET      (ICU_OFFSET + 114)
123
124 /* IPIQ rendezvous */
125 #define XIPIQ_OFFSET            (ICU_OFFSET + 115)
126
127 /* IPI to signal CPUs to stop and wait for another CPU to restart them */
128 #define XCPUSTOP_OFFSET         (ICU_OFFSET + 128)
129
130 /*
131  * Note: this vector MUST be xxxx1111, 32 + 223 = 255 = 0xff:
132  */
133 #define XSPURIOUSINT_OFFSET     (ICU_OFFSET + 223)
134
135 #endif /* SMP || APIC_IO */
136
137 #ifndef LOCORE
138
139 /*
140  * Type of the first (asm) part of an interrupt handler.
141  */
142 typedef void inthand_t(u_int cs, u_int ef, u_int esp, u_int ss);
143 typedef void unpendhand_t(void);
144
145 #define IDTVEC(name)    __CONCAT(X,name)
146
147 extern u_long *intr_countp[];   /* pointers into intrcnt[] */
148 extern inthand2_t *intr_handler[];      /* C entry points for FAST ints */
149 extern u_int intr_mask[];       /* sets of intrs masked during handling of 1 */
150 extern void *intr_unit[];       /* cookies to pass to intr handlers */
151
152 inthand_t
153         IDTVEC(fastintr0), IDTVEC(fastintr1),
154         IDTVEC(fastintr2), IDTVEC(fastintr3),
155         IDTVEC(fastintr4), IDTVEC(fastintr5),
156         IDTVEC(fastintr6), IDTVEC(fastintr7),
157         IDTVEC(fastintr8), IDTVEC(fastintr9),
158         IDTVEC(fastintr10), IDTVEC(fastintr11),
159         IDTVEC(fastintr12), IDTVEC(fastintr13),
160         IDTVEC(fastintr14), IDTVEC(fastintr15);
161 inthand_t
162         IDTVEC(intr0), IDTVEC(intr1), IDTVEC(intr2), IDTVEC(intr3),
163         IDTVEC(intr4), IDTVEC(intr5), IDTVEC(intr6), IDTVEC(intr7),
164         IDTVEC(intr8), IDTVEC(intr9), IDTVEC(intr10), IDTVEC(intr11),
165         IDTVEC(intr12), IDTVEC(intr13), IDTVEC(intr14), IDTVEC(intr15);
166
167 unpendhand_t
168         IDTVEC(fastunpend0), IDTVEC(fastunpend1),
169         IDTVEC(fastunpend2), IDTVEC(fastunpend3),
170         IDTVEC(fastunpend4), IDTVEC(fastunpend5),
171         IDTVEC(fastunpend6), IDTVEC(fastunpend7),
172         IDTVEC(fastunpend8), IDTVEC(fastunpend9),
173         IDTVEC(fastunpend10), IDTVEC(fastunpend11),
174         IDTVEC(fastunpend12), IDTVEC(fastunpend13),
175         IDTVEC(fastunpend14), IDTVEC(fastunpend15);
176
177 #if defined(APIC_IO)
178 inthand_t
179         IDTVEC(fastintr16), IDTVEC(fastintr17),
180         IDTVEC(fastintr18), IDTVEC(fastintr19),
181         IDTVEC(fastintr20), IDTVEC(fastintr21),
182         IDTVEC(fastintr22), IDTVEC(fastintr23);
183 inthand_t
184         IDTVEC(intr16), IDTVEC(intr17), IDTVEC(intr18), IDTVEC(intr19),
185         IDTVEC(intr20), IDTVEC(intr21), IDTVEC(intr22), IDTVEC(intr23);
186 unpendhand_t
187         IDTVEC(fastunpend16), IDTVEC(fastunpend17),
188         IDTVEC(fastunpend18), IDTVEC(fastunpend19),
189         IDTVEC(fastunpend20), IDTVEC(fastunpend21),
190         IDTVEC(fastunpend22), IDTVEC(fastunpend23);
191 #endif
192
193 #if defined(SMP)
194 inthand_t
195         Xinvltlb,       /* TLB shootdowns */
196         Xcpuast,        /* Additional software trap on other cpu */ 
197         Xforward_irq,   /* Forward irq to cpu holding ISR lock */
198         Xcpustop,       /* CPU stops & waits for another CPU to restart it */
199         Xspuriousint,   /* handle APIC "spurious INTs" */
200         Xipiq,          /* handle lwkt_send_ipiq() requests */
201         Xrendezvous;    /* handle CPU rendezvous */
202
203 #ifdef TEST_TEST1
204 inthand_t
205         Xtest1;         /* 'fake' HWI at top of APIC prio 0x3x, 32+31 = 0x3f */
206 #endif /** TEST_TEST1 */
207 #endif /* SMP */
208
209 void    call_fast_unpend(int irq);
210 void    isa_defaultirq (void);
211 int     isa_nmi (int cd);
212 int     icu_setup (int intr, inthand2_t *func, void *arg, 
213                        u_int *maskptr, int flags);
214 int     icu_unset (int intr, inthand2_t *handler);
215 void    icu_reinit (void);
216 int     update_intr_masks (void);
217
218 /*
219  * WARNING: These are internal functions and not to be used by device drivers!
220  * They are subject to change without notice. 
221  */
222 struct intrec *inthand_add(const char *name, int irq, inthand2_t handler,
223                            void *arg, intrmask_t *maskptr, int flags);
224
225 int inthand_remove(struct intrec *idesc);
226 void inthand_enabled(struct intrec *idesc);
227 void inthand_disabled(struct intrec *idesc);
228 void forward_fastint_remote(void *arg);
229
230 #endif /* LOCORE */
231
232 #endif /* _KERNEL */
233
234 #endif /* !_I386_ISA_INTR_MACHDEP_H_ */