xref: /netbsd-src/sys/arch/x86/include/intr.h (revision eb7c1594f145c931049e1fd9eb056a5987e87e59)
1 /*	$NetBSD: intr.h,v 1.5 2003/06/23 14:59:21 martin Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 2001 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Charles M. Hannum, and by Jason R. Thorpe.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 #ifndef _X86_INTR_H_
40 #define _X86_INTR_H_
41 
42 #ifdef _KERNEL_OPT
43 #include "opt_multiprocessor.h"
44 #endif
45 
46 #include <machine/intrdefs.h>
47 
48 #ifndef _LOCORE
49 #include <machine/cpu.h>
50 #include <machine/pic.h>
51 
52 /*
53  * Struct describing an interrupt source for a CPU. struct cpu_info
54  * has an array of MAX_INTR_SOURCES of these. The index in the array
55  * is equal to the stub number of the stubcode as present in vector.s
56  *
57  * The primary CPU's array of interrupt sources has its first 16
58  * entries reserved for legacy ISA irq handlers. This means that
59  * they have a 1:1 mapping for arrayindex:irq_num. This is not
60  * true for interrupts that come in through IO APICs, to find
61  * their source, go through ci->ci_isources[index].is_pic
62  *
63  * It's possible to always maintain a 1:1 mapping, but that means
64  * limiting the total number of interrupt sources to MAX_INTR_SOURCES
65  * (32), instead of 32 per CPU. It also would mean that having multiple
66  * IO APICs which deliver interrupts from an equal pin number would
67  * overlap if they were to be sent to the same CPU.
68  */
69 
70 struct intrstub {
71 	void *ist_entry;
72 	void *ist_recurse;
73 	void *ist_resume;
74 };
75 
76 struct intrsource {
77 	int is_maxlevel;		/* max. IPL for this source */
78 	int is_pin;			/* IRQ for legacy; pin for IO APIC */
79 	struct intrhand *is_handlers;	/* handler chain */
80 	struct pic *is_pic;		/* originating PIC */
81 	void *is_recurse;		/* entry for spllower */
82 	void *is_resume;		/* entry for doreti */
83 	struct evcnt is_evcnt;		/* interrupt counter */
84 	char is_evname[32];		/* event counter name */
85 	int is_flags;			/* see below */
86 	int is_type;			/* level, edge */
87 	int is_idtvec;
88 	int is_minlevel;
89 };
90 
91 #define IS_LEGACY	0x0001		/* legacy ISA irq source */
92 #define IS_IPI		0x0002
93 #define IS_LOG		0x0004
94 
95 
96 /*
97  * Interrupt handler chains.  *_intr_establish() insert a handler into
98  * the list.  The handler is called with its (single) argument.
99  */
100 
101 struct intrhand {
102 	int	(*ih_fun)(void *);
103 	void	*ih_arg;
104 	int	ih_level;
105 	struct	intrhand *ih_next;
106 	int	ih_pin;
107 	int	ih_slot;
108 	struct cpu_info *ih_cpu;
109 };
110 
111 #define IMASK(ci,level) (ci)->ci_imask[(level)]
112 #define IUNMASK(ci,level) (ci)->ci_iunmask[(level)]
113 
114 extern void Xspllower __P((int));
115 
116 static __inline int splraise __P((int));
117 static __inline void spllower __P((int));
118 static __inline void softintr __P((int));
119 
120 /*
121  * Convert spl level to local APIC level
122  */
123 #define APIC_LEVEL(l)   ((l) << 4)
124 
125 /*
126  * compiler barrier: prevent reordering of instructions.
127  * XXX something similar will move to <sys/cdefs.h>
128  * or thereabouts.
129  * This prevents the compiler from reordering code around
130  * this "instruction", acting as a sequence point for code generation.
131  */
132 
133 #define	__splbarrier() __asm __volatile("":::"memory")
134 
135 /*
136  * Add a mask to cpl, and return the old value of cpl.
137  */
138 static __inline int
139 splraise(int nlevel)
140 {
141 	int olevel;
142 	struct cpu_info *ci = curcpu();
143 
144 	olevel = ci->ci_ilevel;
145 	if (nlevel > olevel)
146 		ci->ci_ilevel = nlevel;
147 	__splbarrier();
148 	return (olevel);
149 }
150 
151 /*
152  * Restore a value to cpl (unmasking interrupts).  If any unmasked
153  * interrupts are pending, call Xspllower() to process them.
154  */
155 static __inline void
156 spllower(int nlevel)
157 {
158 	struct cpu_info *ci = curcpu();
159 
160 	__splbarrier();
161 	/*
162 	 * Since this should only lower the interrupt level,
163 	 * the XOR below should only show interrupts that
164 	 * are being unmasked.
165 	 */
166 	if (ci->ci_ipending & IUNMASK(ci,nlevel))
167 		Xspllower(nlevel);
168 	else
169 		ci->ci_ilevel = nlevel;
170 }
171 
172 /*
173  * Hardware interrupt masks
174  */
175 #define	splbio()	splraise(IPL_BIO)
176 #define	splnet()	splraise(IPL_NET)
177 #define	spltty()	splraise(IPL_TTY)
178 #define	splaudio()	splraise(IPL_AUDIO)
179 #define	splclock()	splraise(IPL_CLOCK)
180 #define	splstatclock()	splclock()
181 #define	splserial()	splraise(IPL_SERIAL)
182 #define splipi()	splraise(IPL_IPI)
183 
184 #define spllpt()	spltty()
185 
186 #define SPL_ASSERT_BELOW(x) KDASSERT(curcpu()->ci_ilevel < (x))
187 #define	spllpt()	spltty()
188 
189 /*
190  * Software interrupt masks
191  *
192  * NOTE: splsoftclock() is used by hardclock() to lower the priority from
193  * clock to softclock before it calls softclock().
194  */
195 #define	spllowersoftclock() spllower(IPL_SOFTCLOCK)
196 
197 #define	splsoftclock()	splraise(IPL_SOFTCLOCK)
198 #define	splsoftnet()	splraise(IPL_SOFTNET)
199 #define	splsoftserial()	splraise(IPL_SOFTSERIAL)
200 
201 /*
202  * Miscellaneous
203  */
204 #define	splvm()		splraise(IPL_VM)
205 #define	splhigh()	splraise(IPL_HIGH)
206 #define	spl0()		spllower(IPL_NONE)
207 #define	splsched()	splraise(IPL_SCHED)
208 #define spllock() 	splhigh()
209 #define	splx(x)		spllower(x)
210 
211 /*
212  * Software interrupt registration
213  *
214  * We hand-code this to ensure that it's atomic.
215  *
216  * XXX always scheduled on the current CPU.
217  */
218 static __inline void
219 softintr(int sir)
220 {
221 	struct cpu_info *ci = curcpu();
222 
223 	__asm __volatile("lock ; orl %1, %0" :
224 	    "=m"(ci->ci_ipending) : "ir" (1 << sir));
225 }
226 
227 /*
228  * XXX
229  */
230 #define	setsoftnet()	softintr(SIR_NET)
231 
232 /*
233  * Stub declarations.
234  */
235 
236 extern void Xsoftclock(void);
237 extern void Xsoftnet(void);
238 extern void Xsoftserial(void);
239 
240 extern struct intrstub i8259_stubs[];
241 extern struct intrstub ioapic_edge_stubs[];
242 extern struct intrstub ioapic_level_stubs[];
243 
244 struct cpu_info;
245 
246 extern char idt_allocmap[];
247 
248 void intr_default_setup(void);
249 int x86_nmi(void);
250 void intr_calculatemasks(struct cpu_info *);
251 int intr_allocate_slot_cpu(struct cpu_info *, struct pic *, int, int *);
252 int intr_allocate_slot(struct pic *, int, int, int, struct cpu_info **, int *,
253 		       int *);
254 void *intr_establish(int, struct pic *, int, int, int, int (*)(void *), void *);
255 void intr_disestablish(struct intrhand *);
256 void cpu_intr_init(struct cpu_info *);
257 int intr_find_mpmapping(int bus, int pin, int *handle);
258 #ifdef INTRDEBUG
259 void intr_printconfig(void);
260 #endif
261 
262 #ifdef MULTIPROCESSOR
263 int x86_send_ipi(struct cpu_info *, int);
264 void x86_broadcast_ipi(int);
265 void x86_multicast_ipi(int, int);
266 void x86_ipi_handler(void);
267 void x86_intlock(struct intrframe);
268 void x86_intunlock(struct intrframe);
269 void x86_softintlock(void);
270 void x86_softintunlock(void);
271 
272 extern void (*ipifunc[X86_NIPI])(struct cpu_info *);
273 #endif
274 
275 #endif /* !_LOCORE */
276 
277 /*
278  * Generic software interrupt support.
279  */
280 
281 #define	X86_SOFTINTR_SOFTCLOCK		0
282 #define	X86_SOFTINTR_SOFTNET		1
283 #define	X86_SOFTINTR_SOFTSERIAL	2
284 #define	X86_NSOFTINTR			3
285 
286 #ifndef _LOCORE
287 #include <sys/queue.h>
288 
289 struct x86_soft_intrhand {
290 	TAILQ_ENTRY(x86_soft_intrhand)
291 		sih_q;
292 	struct x86_soft_intr *sih_intrhead;
293 	void	(*sih_fn)(void *);
294 	void	*sih_arg;
295 	int	sih_pending;
296 };
297 
298 struct x86_soft_intr {
299 	TAILQ_HEAD(, x86_soft_intrhand)
300 		softintr_q;
301 	int softintr_ssir;
302 	struct simplelock softintr_slock;
303 };
304 
305 #define	x86_softintr_lock(si, s)					\
306 do {									\
307 	(s) = splhigh();						\
308 	simple_lock(&si->softintr_slock);				\
309 } while (/*CONSTCOND*/ 0)
310 
311 #define	x86_softintr_unlock(si, s)					\
312 do {									\
313 	simple_unlock(&si->softintr_slock);				\
314 	splx((s));							\
315 } while (/*CONSTCOND*/ 0)
316 
317 void	*softintr_establish(int, void (*)(void *), void *);
318 void	softintr_disestablish(void *);
319 void	softintr_init(void);
320 void	softintr_dispatch(int);
321 
322 #define	softintr_schedule(arg)						\
323 do {									\
324 	struct x86_soft_intrhand *__sih = (arg);			\
325 	struct x86_soft_intr *__si = __sih->sih_intrhead;		\
326 	int __s;							\
327 									\
328 	x86_softintr_lock(__si, __s);					\
329 	if (__sih->sih_pending == 0) {					\
330 		TAILQ_INSERT_TAIL(&__si->softintr_q, __sih, sih_q);	\
331 		__sih->sih_pending = 1;					\
332 		softintr(__si->softintr_ssir);				\
333 	}								\
334 	x86_softintr_unlock(__si, __s);					\
335 } while (/*CONSTCOND*/ 0)
336 #endif /* _LOCORE */
337 
338 #endif /* !_X86_INTR_H_ */
339