source: mainline/kernel/arch/ia32/include/smp/apic.h@ cefb126

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since cefb126 was 99718a2e, checked in by Martin Decky <martin@…>, 15 years ago

improve code readability
  • Property mode set to 100644
File size: 10.4 KB
Line 
1/*
2 * Copyright (c) 2001-2004 Jakub Jermar
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 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup ia32
30 * @{
31 */
32/** @file
33 */
34
35#ifndef KERN_ia32_APIC_H_
36#define KERN_ia32_APIC_H_
37
38#include <typedefs.h>
39#include <cpu.h>
40
41#define FIXED (0 << 0)
42#define LOPRI (1 << 0)
43
44#define APIC_ID_COUNT 16
45
46/* local APIC macros */
47#define IPI_INIT 0
48#define IPI_STARTUP 0
49
50/** Delivery modes. */
51#define DELMOD_FIXED 0x0
52#define DELMOD_LOWPRI 0x1
53#define DELMOD_SMI 0x2
54/* 0x3 reserved */
55#define DELMOD_NMI 0x4
56#define DELMOD_INIT 0x5
57#define DELMOD_STARTUP 0x6
58#define DELMOD_EXTINT 0x7
59
60/** Destination modes. */
61#define DESTMOD_PHYS 0x0
62#define DESTMOD_LOGIC 0x1
63
64/** Trigger Modes. */
65#define TRIGMOD_EDGE 0x0
66#define TRIGMOD_LEVEL 0x1
67
68/** Levels. */
69#define LEVEL_DEASSERT 0x0
70#define LEVEL_ASSERT 0x1
71
72/** Destination Shorthands. */
73#define SHORTHAND_NONE 0x0
74#define SHORTHAND_SELF 0x1
75#define SHORTHAND_ALL_INCL 0x2
76#define SHORTHAND_ALL_EXCL 0x3
77
78/** Interrupt Input Pin Polarities. */
79#define POLARITY_HIGH 0x0
80#define POLARITY_LOW 0x1
81
82/** Divide Values. (Bit 2 is always 0) */
83#define DIVIDE_2 0x0
84#define DIVIDE_4 0x1
85#define DIVIDE_8 0x2
86#define DIVIDE_16 0x3
87#define DIVIDE_32 0x8
88#define DIVIDE_64 0x9
89#define DIVIDE_128 0xa
90#define DIVIDE_1 0xb
91
92/** Timer Modes. */
93#define TIMER_ONESHOT 0x0
94#define TIMER_PERIODIC 0x1
95
96/** Delivery status. */
97#define DELIVS_IDLE 0x0
98#define DELIVS_PENDING 0x1
99
100/** Destination masks. */
101#define DEST_ALL 0xff
102
103/** Dest format models. */
104#define MODEL_FLAT 0xf
105#define MODEL_CLUSTER 0x0
106
107/** Interrupt Command Register. */
108#define ICRlo (0x300 / sizeof(uint32_t))
109#define ICRhi (0x310 / sizeof(uint32_t))
110
111typedef struct {
112 union {
113 uint32_t lo;
114 struct {
115 uint8_t vector; /**< Interrupt Vector. */
116 unsigned int delmod : 3; /**< Delivery Mode. */
117 unsigned int destmod : 1; /**< Destination Mode. */
118 unsigned int delivs : 1; /**< Delivery status (RO). */
119 unsigned int : 1; /**< Reserved. */
120 unsigned int level : 1; /**< Level. */
121 unsigned int trigger_mode : 1; /**< Trigger Mode. */
122 unsigned int : 2; /**< Reserved. */
123 unsigned int shorthand : 2; /**< Destination Shorthand. */
124 unsigned int : 12; /**< Reserved. */
125 } __attribute__ ((packed));
126 };
127 union {
128 uint32_t hi;
129 struct {
130 unsigned int : 24; /**< Reserved. */
131 uint8_t dest; /**< Destination field. */
132 } __attribute__ ((packed));
133 };
134} __attribute__ ((packed)) icr_t;
135
136/* End Of Interrupt. */
137#define EOI (0x0b0 / sizeof(uint32_t))
138
139/** Error Status Register. */
140#define ESR (0x280 / sizeof(uint32_t))
141
142typedef union {
143 uint32_t value;
144 uint8_t err_bitmap;
145 struct {
146 unsigned int send_checksum_error : 1;
147 unsigned int receive_checksum_error : 1;
148 unsigned int send_accept_error : 1;
149 unsigned int receive_accept_error : 1;
150 unsigned int : 1;
151 unsigned int send_illegal_vector : 1;
152 unsigned int received_illegal_vector : 1;
153 unsigned int illegal_register_address : 1;
154 unsigned int : 24;
155 } __attribute__ ((packed));
156} esr_t;
157
158/* Task Priority Register */
159#define TPR (0x080 / sizeof(uint32_t))
160
161typedef union {
162 uint32_t value;
163 struct {
164 unsigned int pri_sc : 4; /**< Task Priority Sub-Class. */
165 unsigned int pri : 4; /**< Task Priority. */
166 } __attribute__ ((packed));
167} tpr_t;
168
169/** Spurious-Interrupt Vector Register. */
170#define SVR (0x0f0 / sizeof(uint32_t))
171
172typedef union {
173 uint32_t value;
174 struct {
175 uint8_t vector; /**< Spurious Vector. */
176 unsigned int lapic_enabled : 1; /**< APIC Software Enable/Disable. */
177 unsigned int focus_checking : 1; /**< Focus Processor Checking. */
178 unsigned int : 22; /**< Reserved. */
179 } __attribute__ ((packed));
180} svr_t;
181
182/** Time Divide Configuration Register. */
183#define TDCR (0x3e0 / sizeof(uint32_t))
184
185typedef union {
186 uint32_t value;
187 struct {
188 unsigned int div_value : 4; /**< Divide Value, bit 2 is always 0. */
189 unsigned int : 28; /**< Reserved. */
190 } __attribute__ ((packed));
191} tdcr_t;
192
193/* Initial Count Register for Timer */
194#define ICRT (0x380 / sizeof(uint32_t))
195
196/* Current Count Register for Timer */
197#define CCRT (0x390 / sizeof(uint32_t))
198
199/** LVT Timer register. */
200#define LVT_Tm (0x320 / sizeof(uint32_t))
201
202typedef union {
203 uint32_t value;
204 struct {
205 uint8_t vector; /**< Local Timer Interrupt vector. */
206 unsigned int : 4; /**< Reserved. */
207 unsigned int delivs : 1; /**< Delivery status (RO). */
208 unsigned int : 3; /**< Reserved. */
209 unsigned int masked : 1; /**< Interrupt Mask. */
210 unsigned int mode : 1; /**< Timer Mode. */
211 unsigned int : 14; /**< Reserved. */
212 } __attribute__ ((packed));
213} lvt_tm_t;
214
215/** LVT LINT registers. */
216#define LVT_LINT0 (0x350 / sizeof(uint32_t))
217#define LVT_LINT1 (0x360 / sizeof(uint32_t))
218
219typedef union {
220 uint32_t value;
221 struct {
222 uint8_t vector; /**< LINT Interrupt vector. */
223 unsigned int delmod : 3; /**< Delivery Mode. */
224 unsigned int : 1; /**< Reserved. */
225 unsigned int delivs : 1; /**< Delivery status (RO). */
226 unsigned int intpol : 1; /**< Interrupt Input Pin Polarity. */
227 unsigned int irr : 1; /**< Remote IRR (RO). */
228 unsigned int trigger_mode : 1; /**< Trigger Mode. */
229 unsigned int masked : 1; /**< Interrupt Mask. */
230 unsigned int : 15; /**< Reserved. */
231 } __attribute__ ((packed));
232} lvt_lint_t;
233
234/** LVT Error register. */
235#define LVT_Err (0x370 / sizeof(uint32_t))
236
237typedef union {
238 uint32_t value;
239 struct {
240 uint8_t vector; /**< Local Timer Interrupt vector. */
241 unsigned int : 4; /**< Reserved. */
242 unsigned int delivs : 1; /**< Delivery status (RO). */
243 unsigned int : 3; /**< Reserved. */
244 unsigned int masked : 1; /**< Interrupt Mask. */
245 unsigned int : 15; /**< Reserved. */
246 } __attribute__ ((packed));
247} lvt_error_t;
248
249/** Local APIC ID Register. */
250#define L_APIC_ID (0x020 / sizeof(uint32_t))
251
252typedef union {
253 uint32_t value;
254 struct {
255 unsigned int : 24; /**< Reserved. */
256 uint8_t apic_id; /**< Local APIC ID. */
257 } __attribute__ ((packed));
258} l_apic_id_t;
259
260/** Local APIC Version Register */
261#define LAVR (0x030 / sizeof(uint32_t))
262#define LAVR_Mask 0xff
263
264#define is_local_apic(x) (((x) & LAVR_Mask & 0xf0) == 0x1)
265#define is_82489DX_apic(x) ((((x) & LAVR_Mask & 0xf0) == 0x0))
266#define is_local_xapic(x) (((x) & LAVR_Mask) == 0x14)
267
268/** Logical Destination Register. */
269#define LDR (0x0d0 / sizeof(uint32_t))
270
271typedef union {
272 uint32_t value;
273 struct {
274 unsigned int : 24; /**< Reserved. */
275 uint8_t id; /**< Logical APIC ID. */
276 } __attribute__ ((packed));
277} ldr_t;
278
279/** Destination Format Register. */
280#define DFR (0x0e0 / sizeof(uint32_t))
281
282typedef union {
283 uint32_t value;
284 struct {
285 unsigned int : 28; /**< Reserved, all ones. */
286 unsigned int model : 4; /**< Model. */
287 } __attribute__ ((packed));
288} dfr_t;
289
290/* IO APIC */
291#define IOREGSEL (0x00 / sizeof(uint32_t))
292#define IOWIN (0x10 / sizeof(uint32_t))
293
294#define IOAPICID 0x00
295#define IOAPICVER 0x01
296#define IOAPICARB 0x02
297#define IOREDTBL 0x10
298
299/** I/O Register Select Register. */
300typedef union {
301 uint32_t value;
302 struct {
303 uint8_t reg_addr; /**< APIC Register Address. */
304 unsigned int : 24; /**< Reserved. */
305 } __attribute__ ((packed));
306} io_regsel_t;
307
308/** I/O Redirection Register. */
309typedef struct io_redirection_reg {
310 union {
311 uint32_t lo;
312 struct {
313 uint8_t intvec; /**< Interrupt Vector. */
314 unsigned int delmod : 3; /**< Delivery Mode. */
315 unsigned int destmod : 1; /**< Destination mode. */
316 unsigned int delivs : 1; /**< Delivery status (RO). */
317 unsigned int intpol : 1; /**< Interrupt Input Pin Polarity. */
318 unsigned int irr : 1; /**< Remote IRR (RO). */
319 unsigned int trigger_mode : 1; /**< Trigger Mode. */
320 unsigned int masked : 1; /**< Interrupt Mask. */
321 unsigned int : 15; /**< Reserved. */
322 } __attribute__ ((packed));
323 };
324 union {
325 uint32_t hi;
326 struct {
327 unsigned int : 24; /**< Reserved. */
328 uint8_t dest : 8; /**< Destination Field. */
329 } __attribute__ ((packed));
330 };
331
332} __attribute__ ((packed)) io_redirection_reg_t;
333
334
335/** IO APIC Identification Register. */
336typedef union {
337 uint32_t value;
338 struct {
339 unsigned int : 24; /**< Reserved. */
340 unsigned int apic_id : 4; /**< IO APIC ID. */
341 unsigned int : 4; /**< Reserved. */
342 } __attribute__ ((packed));
343} io_apic_id_t;
344
345extern volatile uint32_t *l_apic;
346extern volatile uint32_t *io_apic;
347
348extern uint32_t apic_id_mask;
349extern uint8_t bsp_l_apic;
350
351extern void apic_init(void);
352
353extern void l_apic_init(void);
354extern void l_apic_eoi(void);
355extern int l_apic_broadcast_custom_ipi(uint8_t);
356extern int l_apic_send_init_ipi(uint8_t);
357extern void l_apic_debug(void);
358
359extern uint32_t io_apic_read(uint8_t);
360extern void io_apic_write(uint8_t, uint32_t);
361extern void io_apic_change_ioredtbl(uint8_t pin, uint8_t dest, uint8_t v, unsigned int);
362extern void io_apic_disable_irqs(uint16_t);
363extern void io_apic_enable_irqs(uint16_t);
364
365#endif
366
367/** @}
368 */
Note: See TracBrowser for help on using the repository browser.