xref: /freebsd/sys/amd64/include/intr_machdep.h (revision 2357939bc239bd5334a169b62313806178dd8f30)
1 /*-
2  * Copyright (c) 2003 John Baldwin <jhb@FreeBSD.org>
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  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef __MACHINE_INTR_MACHDEP_H__
30 #define	__MACHINE_INTR_MACHDEP_H__
31 
32 #ifdef _KERNEL
33 
34 /* With I/O APIC's we can have up to 191 interrupts. */
35 #define	NUM_IO_INTS	191
36 #define	INTRCNT_COUNT	(1 + NUM_IO_INTS * 2)
37 
38 #ifndef LOCORE
39 
40 typedef void inthand_t(u_int cs, u_int ef, u_int esp, u_int ss);
41 
42 #define	IDTVEC(name)	__CONCAT(X,name)
43 
44 struct intsrc;
45 
46 /*
47  * Methods that a PIC provides to mask/unmask a given interrupt source,
48  * "turn on" the interrupt on the CPU side by setting up an IDT entry, and
49  * return the vector associated with this source.
50  */
51 struct pic {
52 	void (*pic_enable_source)(struct intsrc *);
53 	void (*pic_disable_source)(struct intsrc *);
54 	void (*pic_eoi_source)(struct intsrc *);
55 	void (*pic_enable_intr)(struct intsrc *);
56 	int (*pic_vector)(struct intsrc *);
57 	int (*pic_source_pending)(struct intsrc *);
58 	void (*pic_suspend)(struct intsrc *);
59 	void (*pic_resume)(struct intsrc *);
60 };
61 
62 /*
63  * An interrupt source.  The upper-layer code uses the PIC methods to
64  * control a given source.  The lower-layer PIC drivers can store additional
65  * private data in a given interrupt source such as an interrupt pin number
66  * or an I/O APIC pointer.
67  */
68 struct intsrc {
69 	struct pic *is_pic;
70 	struct ithd *is_ithread;
71 	u_long *is_count;
72 	u_long *is_straycount;
73 	u_int is_index;
74 };
75 
76 struct intrframe;
77 
78 extern struct mtx icu_lock;
79 
80 int	intr_add_handler(const char *name, int vector, driver_intr_t handler,
81     void *arg, enum intr_type flags, void **cookiep);
82 void	intr_execute_handlers(struct intsrc *isrc, struct intrframe *iframe);
83 struct intsrc *intr_lookup_source(int vector);
84 int	intr_register_source(struct intsrc *isrc);
85 int	intr_remove_handler(void *cookie);
86 void	intr_resume(void);
87 void	intr_suspend(void);
88 
89 #endif	/* !LOCORE */
90 #endif	/* _KERNEL */
91 #endif	/* !__MACHINE_INTR_MACHDEP_H__ */
92