initial commit
[freebsd-arm:freebsd-arm.git] / amd64 / include / apicvar.h
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  * 3. Neither the name of the author nor the names of any co-contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31
32 #ifndef _MACHINE_APICVAR_H_
33 #define _MACHINE_APICVAR_H_
34
35 #include <machine/segments.h>
36
37 /*
38  * Local && I/O APIC variable definitions.
39  */
40
41 /*
42  * Layout of local APIC interrupt vectors:
43  *
44  *      0xff (255)  +-------------+
45  *                  |             | 15 (Spurious / IPIs / Local Interrupts)
46  *      0xf0 (240)  +-------------+
47  *                  |             | 14 (I/O Interrupts / Timer)
48  *      0xe0 (224)  +-------------+
49  *                  |             | 13 (I/O Interrupts)
50  *      0xd0 (208)  +-------------+
51  *                  |             | 12 (I/O Interrupts)
52  *      0xc0 (192)  +-------------+
53  *                  |             | 11 (I/O Interrupts)
54  *      0xb0 (176)  +-------------+
55  *                  |             | 10 (I/O Interrupts)
56  *      0xa0 (160)  +-------------+
57  *                  |             | 9 (I/O Interrupts)
58  *      0x90 (144)  +-------------+
59  *                  |             | 8 (I/O Interrupts / System Calls)
60  *      0x80 (128)  +-------------+
61  *                  |             | 7 (I/O Interrupts)
62  *      0x70 (112)  +-------------+
63  *                  |             | 6 (I/O Interrupts)
64  *      0x60 (96)   +-------------+
65  *                  |             | 5 (I/O Interrupts)
66  *      0x50 (80)   +-------------+
67  *                  |             | 4 (I/O Interrupts)
68  *      0x40 (64)   +-------------+
69  *                  |             | 3 (I/O Interrupts)
70  *      0x30 (48)   +-------------+
71  *                  |             | 2 (ATPIC Interrupts)
72  *      0x20 (32)   +-------------+
73  *                  |             | 1 (Exceptions, traps, faults, etc.)
74  *      0x10 (16)   +-------------+
75  *                  |             | 0 (Exceptions, traps, faults, etc.)
76  *      0x00 (0)    +-------------+
77  *
78  * Note: 0x80 needs to be handled specially and not allocated to an
79  * I/O device!
80  */
81
82 #define MAX_APIC_ID     0xfe
83 #define APIC_ID_ALL     0xff
84
85 /* I/O Interrupts are used for external devices such as ISA, PCI, etc. */
86 #define APIC_IO_INTS    (IDT_IO_INTS + 16)
87 #define APIC_NUM_IOINTS 191
88
89 /* The timer interrupt is used for clock handling and drives hardclock, etc. */
90 #define APIC_TIMER_INT  (APIC_IO_INTS + APIC_NUM_IOINTS)
91
92 /*  
93  ********************* !!! WARNING !!! ******************************
94  * Each local apic has an interrupt receive fifo that is two entries deep
95  * for each interrupt priority class (higher 4 bits of interrupt vector).
96  * Once the fifo is full the APIC can no longer receive interrupts for this
97  * class and sending IPIs from other CPUs will be blocked.
98  * To avoid deadlocks there should be no more than two IPI interrupts
99  * pending at the same time.
100  * Currently this is guaranteed by dividing the IPIs in two groups that have 
101  * each at most one IPI interrupt pending. The first group is protected by the
102  * smp_ipi_mtx and waits for the completion of the IPI (Only one IPI user 
103  * at a time) The second group uses a single interrupt and a bitmap to avoid
104  * redundant IPI interrupts.
105  */ 
106
107 /* Interrupts for local APIC LVT entries other than the timer. */
108 #define APIC_LOCAL_INTS 240
109 #define APIC_ERROR_INT  APIC_LOCAL_INTS
110 #define APIC_THERMAL_INT (APIC_LOCAL_INTS + 1)
111
112 #define APIC_IPI_INTS   (APIC_LOCAL_INTS + 2)
113 #define IPI_RENDEZVOUS  (APIC_IPI_INTS)         /* Inter-CPU rendezvous. */
114 #define IPI_INVLTLB     (APIC_IPI_INTS + 1)     /* TLB Shootdown IPIs */
115 #define IPI_INVLPG      (APIC_IPI_INTS + 2)
116 #define IPI_INVLRNG     (APIC_IPI_INTS + 3)
117 #define IPI_INVLCACHE   (APIC_IPI_INTS + 4)
118 /* Vector to handle bitmap based IPIs */
119 #define IPI_BITMAP_VECTOR       (APIC_IPI_INTS + 6) 
120
121 /* IPIs handled by IPI_BITMAPED_VECTOR  (XXX ups is there a better place?) */
122 #define IPI_AST         0       /* Generate software trap. */
123 #define IPI_PREEMPT     1
124 #define IPI_HARDCLOCK   2
125 #define IPI_STATCLOCK   3
126 #define IPI_PROFCLOCK   4
127 #define IPI_BITMAP_LAST IPI_PROFCLOCK
128 #define IPI_IS_BITMAPED(x) ((x) <= IPI_BITMAP_LAST)
129
130 #define IPI_STOP        (APIC_IPI_INTS + 7)     /* Stop CPU until restarted. */
131 #define IPI_SUSPEND     (APIC_IPI_INTS + 8)     /* Suspend CPU until restarted. */
132 #define IPI_STOP_HARD   (APIC_IPI_INTS + 9)     /* Stop CPU with a NMI. */
133
134 /*
135  * The spurious interrupt can share the priority class with the IPIs since
136  * it is not a normal interrupt. (Does not use the APIC's interrupt fifo)
137  */
138 #define APIC_SPURIOUS_INT 255
139
140 #define LVT_LINT0       0
141 #define LVT_LINT1       1
142 #define LVT_TIMER       2
143 #define LVT_ERROR       3
144 #define LVT_PMC         4
145 #define LVT_THERMAL     5
146 #define LVT_MAX         LVT_THERMAL
147
148 #ifndef LOCORE
149
150 #define APIC_IPI_DEST_SELF      -1
151 #define APIC_IPI_DEST_ALL       -2
152 #define APIC_IPI_DEST_OTHERS    -3
153
154 #define APIC_BUS_UNKNOWN        -1
155 #define APIC_BUS_ISA            0
156 #define APIC_BUS_EISA           1
157 #define APIC_BUS_PCI            2
158 #define APIC_BUS_MAX            APIC_BUS_PCI
159
160 enum lapic_clock {
161         LAPIC_CLOCK_NONE,
162         LAPIC_CLOCK_HARDCLOCK,
163         LAPIC_CLOCK_ALL
164 };
165
166 /*
167  * An APIC enumerator is a psuedo bus driver that enumerates APIC's including
168  * CPU's and I/O APIC's.
169  */
170 struct apic_enumerator {
171         const char *apic_name;
172         int (*apic_probe)(void);
173         int (*apic_probe_cpus)(void);
174         int (*apic_setup_local)(void);
175         int (*apic_setup_io)(void);
176         SLIST_ENTRY(apic_enumerator) apic_next;
177 };
178
179 inthand_t
180         IDTVEC(apic_isr1), IDTVEC(apic_isr2), IDTVEC(apic_isr3),
181         IDTVEC(apic_isr4), IDTVEC(apic_isr5), IDTVEC(apic_isr6),
182         IDTVEC(apic_isr7), IDTVEC(spuriousint), IDTVEC(timerint);
183
184 extern vm_paddr_t lapic_paddr;
185 extern int apic_cpuids[];
186
187 u_int   apic_alloc_vector(u_int apic_id, u_int irq);
188 u_int   apic_alloc_vectors(u_int apic_id, u_int *irqs, u_int count,
189             u_int align);
190 void    apic_disable_vector(u_int apic_id, u_int vector);
191 void    apic_enable_vector(u_int apic_id, u_int vector);
192 void    apic_free_vector(u_int apic_id, u_int vector, u_int irq);
193 u_int   apic_idt_to_irq(u_int apic_id, u_int vector);
194 void    apic_register_enumerator(struct apic_enumerator *enumerator);
195 u_int   apic_cpuid(u_int apic_id);
196 void    *ioapic_create(vm_paddr_t addr, int32_t apic_id, int intbase);
197 int     ioapic_disable_pin(void *cookie, u_int pin);
198 int     ioapic_get_vector(void *cookie, u_int pin);
199 void    ioapic_register(void *cookie);
200 int     ioapic_remap_vector(void *cookie, u_int pin, int vector);
201 int     ioapic_set_bus(void *cookie, u_int pin, int bus_type);
202 int     ioapic_set_extint(void *cookie, u_int pin);
203 int     ioapic_set_nmi(void *cookie, u_int pin);
204 int     ioapic_set_polarity(void *cookie, u_int pin, enum intr_polarity pol);
205 int     ioapic_set_triggermode(void *cookie, u_int pin,
206             enum intr_trigger trigger);
207 int     ioapic_set_smi(void *cookie, u_int pin);
208 void    lapic_create(u_int apic_id, int boot_cpu);
209 void    lapic_disable(void);
210 void    lapic_disable_pmc(void);
211 void    lapic_dump(const char *str);
212 int     lapic_enable_pmc(void);
213 void    lapic_eoi(void);
214 u_int   lapic_error(void);
215 int     lapic_id(void);
216 void    lapic_init(vm_paddr_t addr);
217 int     lapic_intr_pending(u_int vector);
218 void    lapic_ipi_raw(register_t icrlo, u_int dest);
219 void    lapic_ipi_vectored(u_int vector, int dest);
220 int     lapic_ipi_wait(int delay);
221 void    lapic_handle_intr(int vector, struct trapframe *frame);
222 void    lapic_handle_timer(struct trapframe *frame);
223 void    lapic_reenable_pmc(void);
224 void    lapic_set_logical_id(u_int apic_id, u_int cluster, u_int cluster_id);
225 int     lapic_set_lvt_mask(u_int apic_id, u_int lvt, u_char masked);
226 int     lapic_set_lvt_mode(u_int apic_id, u_int lvt, u_int32_t mode);
227 int     lapic_set_lvt_polarity(u_int apic_id, u_int lvt,
228             enum intr_polarity pol);
229 int     lapic_set_lvt_triggermode(u_int apic_id, u_int lvt,
230             enum intr_trigger trigger);
231 void    lapic_set_tpr(u_int vector);
232 void    lapic_setup(int boot);
233 enum lapic_clock        lapic_setup_clock(void);
234
235 #endif /* !LOCORE */
236 #endif /* _MACHINE_APICVAR_H_ */