x86: APIC cleanup
[akaros.git] / kern / arch / x86 / apic.h
1 /*
2  * Copyright (c) 2009 The Regents of the University of California
3  * Barret Rhoden <brho@cs.berkeley.edu>
4  * See LICENSE for details.
5  */
6
7 #ifndef ROS_KERN_APIC_H
8 #define ROS_KERN_APIC_H
9
10 /* 
11  * Functions and definitions for dealing with the APIC and PIC, specific to
12  * Intel.  Does not handle an x2APIC.
13  */
14 #include <arch/mmu.h>
15 #include <arch/x86.h>
16 #include <atomic.h>
17
18 // Local APIC
19 /* PBASE is the physical address.  It is mapped in at the VADDR LAPIC_BASE.
20  * 64 bit note: it looks like this is mapped to the same place in 64 bit address
21  * spaces.  We just happen to have a slight 'hole' in addressable physical
22  * memory.  We can move the PBASE, but we're limited to 32 bit (physical)
23  * addresses. */
24 #define LAPIC_PBASE                                     0xfee00000      /* default *physical* address */
25 #define LAPIC_EOI                                       (LAPIC_BASE + 0x0b0)
26 #define LAPIC_SPURIOUS                          (LAPIC_BASE + 0x0f0)
27 #define LAPIC_VERSION                           (LAPIC_BASE + 0x030)
28 #define LAPIC_ERROR                                     (LAPIC_BASE + 0x280)
29 #define LAPIC_ID                                        (LAPIC_BASE + 0x020)
30 #define LAPIC_LOGICAL_ID                        (LAPIC_BASE + 0x0d0)
31 // LAPIC Local Vector Table
32 #define LAPIC_LVT_TIMER                         (LAPIC_BASE + 0x320)
33 #define LAPIC_LVT_THERMAL                       (LAPIC_BASE + 0x330)
34 #define LAPIC_LVT_PERFMON                       (LAPIC_BASE + 0x340)
35 #define LAPIC_LVT_LINT0                         (LAPIC_BASE + 0x350)
36 #define LAPIC_LVT_LINT1                         (LAPIC_BASE + 0x360)
37 #define LAPIC_LVT_ERROR                         (LAPIC_BASE + 0x370)
38 #define LAPIC_LVT_MASK                          0x00010000
39 // LAPIC Timer
40 #define LAPIC_TIMER_INIT                        (LAPIC_BASE + 0x380)
41 #define LAPIC_TIMER_CURRENT                     (LAPIC_BASE + 0x390)
42 #define LAPIC_TIMER_DIVIDE                      (LAPIC_BASE + 0x3e0)
43 #define LAPIC_TIMER_DEFAULT_VECTOR      0xeb    /* Aka 235, IRQ203 */
44 /* Quick note on the divisor.  The LAPIC timer ticks once per divisor-bus ticks
45  * (system bus or APIC bus, depending on the model).  Ex: A divisor of 128 means
46  * 128 bus ticks results in 1 timer tick.  The divisor increases the time range
47  * and decreases the granularity of the timer.  Numbers are appx, based on 4
48  * billion ticks, vs 2^32 ticks.
49  * Ex:   1GHz bus, div 001:    4sec max,    1ns granularity
50  * Ex:   1GHz bus, div 128:  512sec max,  128ns granularity
51  * Ex: 100MHz bus, div 001:   40sec max,   10ns granularity
52  * Ex: 100MHz bus, div 128: 5120sec max, 1280ns granularity */
53 #define LAPIC_TIMER_DIVISOR_VAL         32      /* seems reasonable */
54 #define LAPIC_TIMER_DIVISOR_BITS        0x8     /* Div = 32 */
55
56 // IPI Interrupt Command Register
57 #define LAPIC_IPI_ICR_LOWER                     (LAPIC_BASE + 0x300)
58 #define LAPIC_IPI_ICR_UPPER                     (LAPIC_BASE + 0x310)
59 /* Interrupts being serviced (in-service) and pending (interrupt request reg).
60  * Note these registers are not normal bitmaps, but instead are 8 separate
61  * 32-bit registers, spaced/aligned on 16 byte boundaries in the LAPIC address
62  * space. */
63 #define LAPIC_ISR                                       (LAPIC_BASE + 0x100)
64 #define LAPIC_IRR                                       (LAPIC_BASE + 0x200)
65
66 /* Tracks whether it is safe to execute core_id() or not.  If we're using the
67  * LAPIC, we need to have the LAPIC mapped into VM.  vm_init() sets this to
68  * TRUE.
69  *
70  * If we're using rdtscp, if the instruction is supported, we can call core_id()
71  * without rebooting.  cpuinfo should have panic'd if we're running on a machine
72  * that doesn't support rdtscp, before vm_init().
73  *
74  * If we're using something else (like segmentation), then that will need to get
75  * set up before vm_init(), at least for core 0.
76  *
77  * Note that core_id() will return 0 (or possibly another wrong answer) on cores
78  * other than core 0 when it is called before smp_boot completes. */
79 extern bool core_id_ready;
80
81 bool lapic_check_spurious(int trap_nr);
82 bool lapic_get_isr_bit(uint8_t vector);
83 bool lapic_get_irr_bit(uint8_t vector);
84 void lapic_print_isr(void);
85 void lapic_mask_irq(int apic_vector);
86 void lapic_unmask_irq(int apic_vector);
87 bool ipi_is_pending(uint8_t vector);
88 void __lapic_set_timer(uint32_t ticks, uint8_t vec, bool periodic, uint8_t div);
89 void lapic_set_timer(uint32_t usec, bool periodic);
90 uint32_t lapic_get_default_id(void);
91 int apiconline(void);
92
93 static inline void lapic_send_eoi(int unused);
94 static inline uint32_t lapic_get_version(void);
95 static inline uint32_t lapic_get_error(void);
96 static inline uint32_t lapic_get_id(void);
97 static inline void lapic_set_id(uint8_t id);    // Careful, may not actually work
98 static inline uint8_t lapic_get_logid(void);
99 static inline void lapic_set_logid(uint8_t id);
100 static inline void lapic_disable_timer(void);
101 static inline void lapic_disable(void);
102 static inline void lapic_enable(void);
103 static inline void lapic_wait_to_send(void);
104 static inline void send_init_ipi(void);
105 static inline void send_startup_ipi(uint8_t vector);
106 static inline void send_self_ipi(uint8_t vector);
107 static inline void send_broadcast_ipi(uint8_t vector);
108 static inline void send_all_others_ipi(uint8_t vector);
109 static inline void __send_ipi(uint8_t hw_coreid, uint8_t vector);
110 static inline void send_group_ipi(uint8_t hw_groupid, uint8_t vector);
111 static inline void __send_nmi(uint8_t hw_coreid);
112
113 /* XXX: remove these */
114 #define mask_lapic_lvt(entry) \
115         write_mmreg32(entry, read_mmreg32(entry) | LAPIC_LVT_MASK)
116 #define unmask_lapic_lvt(entry) \
117         write_mmreg32(entry, read_mmreg32(entry) & ~LAPIC_LVT_MASK)
118
119 static inline void lapic_send_eoi(int unused)
120 {
121         write_mmreg32(LAPIC_EOI, 0);
122 }
123
124 static inline uint32_t lapic_get_version(void)
125 {
126         return read_mmreg32(LAPIC_VERSION);
127 }
128
129 static inline uint32_t lapic_get_error(void)
130 {
131         write_mmreg32(LAPIC_ERROR, 0xdeadbeef);
132         return read_mmreg32(LAPIC_ERROR);
133 }
134
135 static inline uint32_t lapic_get_id(void)
136 {
137         return read_mmreg32(LAPIC_ID) >> 24;
138 }
139
140 static inline void lapic_set_id(uint8_t id)
141 {
142         write_mmreg32(LAPIC_ID, id << 24);
143 }
144
145 static inline uint8_t lapic_get_logid(void)
146 {
147         return read_mmreg32(LAPIC_LOGICAL_ID) >> 24;
148 }
149
150 static inline void lapic_set_logid(uint8_t id)
151 {
152         write_mmreg32(LAPIC_LOGICAL_ID, id << 24);
153 }
154
155 static inline void lapic_disable_timer(void)
156 {
157         write_mmreg32(LAPIC_LVT_TIMER, 0);
158 }
159
160 /* There are a couple ways to do it.  The MSR route doesn't seem to work
161  * in KVM.  It's also a somewhat permanent thing
162  */
163 static inline void lapic_disable(void)
164 {
165         write_mmreg32(LAPIC_SPURIOUS, read_mmreg32(LAPIC_SPURIOUS) & 0xffffefff);
166         //write_msr(IA32_APIC_BASE, read_msr(IA32_APIC_BASE) & ~MSR_APIC_ENABLE);
167 }
168
169 /* Spins until previous IPIs are delivered.  Not sure if we want it inlined
170  * Also not sure when we really need to do this. 
171  */
172 static inline void lapic_wait_to_send(void)
173 {
174         while (read_mmreg32(LAPIC_IPI_ICR_LOWER) & 0x1000)
175                 __cpu_relax();
176 }
177
178 static inline void lapic_enable(void)
179 {
180         write_mmreg32(LAPIC_SPURIOUS, read_mmreg32(LAPIC_SPURIOUS) | 0x00000100);
181 }
182
183 static inline void send_init_ipi(void)
184 {
185         write_mmreg32(LAPIC_IPI_ICR_LOWER, 0x000c4500);
186         lapic_wait_to_send();
187 }
188
189 static inline void send_startup_ipi(uint8_t vector)
190 {
191         write_mmreg32(LAPIC_IPI_ICR_LOWER, 0x000c4600 | vector);
192         lapic_wait_to_send();
193 }
194
195 static inline void send_self_ipi(uint8_t vector)
196 {
197         write_mmreg32(LAPIC_IPI_ICR_LOWER, 0x00044000 | vector);
198         lapic_wait_to_send();
199 }
200
201 static inline void send_broadcast_ipi(uint8_t vector)
202 {
203         write_mmreg32(LAPIC_IPI_ICR_LOWER, 0x00084000 | vector);
204         lapic_wait_to_send();
205 }
206
207 static inline void send_all_others_ipi(uint8_t vector)
208 {
209         write_mmreg32(LAPIC_IPI_ICR_LOWER, 0x000c4000 | vector);
210         lapic_wait_to_send();
211 }
212
213 static inline void __send_ipi(uint8_t hw_coreid, uint8_t vector)
214 {
215         write_mmreg32(LAPIC_IPI_ICR_UPPER, hw_coreid << 24);
216         write_mmreg32(LAPIC_IPI_ICR_LOWER, 0x00004000 | vector);
217         lapic_wait_to_send();
218 }
219
220 static inline void send_group_ipi(uint8_t hw_groupid, uint8_t vector)
221 {
222         write_mmreg32(LAPIC_IPI_ICR_UPPER, hw_groupid << 24);
223         write_mmreg32(LAPIC_IPI_ICR_LOWER, 0x00004800 | vector);
224         lapic_wait_to_send();
225 }
226
227 static inline void __send_nmi(uint8_t hw_coreid)
228 {
229         if (hw_coreid == 255)
230                 return;
231         write_mmreg32(LAPIC_IPI_ICR_UPPER, hw_coreid << 24);
232         write_mmreg32(LAPIC_IPI_ICR_LOWER, 0x00004400);
233         lapic_wait_to_send();
234 }
235
236 /* To change the LAPIC Base (not recommended):
237         msr_val = read_msr(IA32_APIC_BASE);
238         msr_val = msr_val & ~MSR_APIC_BASE_ADDRESS | 0xfaa00000;
239         write_msr(IA32_APIC_BASE, msr_val);
240 */
241
242 /* 
243  * This file is part of the UCB release of Plan 9. It is subject to the license
244  * terms in the LICENSE file found in the top-level directory of this
245  * distribution and at http://akaros.cs.berkeley.edu/files/Plan9License. No
246  * part of the UCB release of Plan 9, including this file, may be copied,
247  * modified, propagated, or distributed except according to the terms contained
248  * in the LICENSE file.
249  */
250
251 /*
252  * There are 2 flavours of APIC, Local APIC and IOAPIC,
253  * Each I/O APIC has a unique physical address,
254  * Local APICs are all at the same physical address as they can only be
255  * accessed by the local CPU.  APIC ids are unique to the
256  * APIC type, so an IOAPIC and APIC both with id 0 is ok.
257  */
258
259 struct ioapic {
260         spinlock_t lock;                        /* IOAPIC: register access */
261         uintptr_t addr;                         /* IOAPIC: register base */
262         uintptr_t paddr;                        /* register base */
263         int nrdt;                                       /* IOAPIC: size of RDT */
264         int ibase;                                      /* global interrupt base */
265 };
266
267 struct lapic {
268         int machno;                                     /* similar to os_coreid, unused */
269
270         uint32_t lvt[6];
271         int nlvt;
272         int ver;
273 };
274
275 struct apic {
276         int useable;                            /* en */
277         struct ioapic;
278         struct lapic;
279 };
280
281 enum {
282         Nbus = 256,
283         Napic = 254,    /* xAPIC architectural limit */
284         Nrdt = 64,
285 };
286
287 /*
288  * Common bits for
289  *      IOAPIC Redirection Table Entry (RDT);
290  *      APIC Local Vector Table Entry (LVT);
291  *      APIC Interrupt Command Register (ICR).
292  * [10:8] Message Type
293  * [11] Destination Mode (RW)
294  * [12] Delivery Status (RO)
295  * [13] Interrupt Input Pin Polarity (RW)
296  * [14] Remote IRR (RO)
297  * [15] Trigger Mode (RW)
298  * [16] Interrupt Mask
299  */
300 enum {
301         MTf = 0x00000000,                       /* Fixed */
302         MTlp = 0x00000100,      /* Lowest Priority */
303         MTsmi = 0x00000200,     /* SMI */
304         MTrr = 0x00000300,      /* Remote Read */
305         MTnmi = 0x00000400,     /* NMI */
306         MTir = 0x00000500,      /* INIT/RESET */
307         MTsipi = 0x00000600,    /* Startup IPI */
308         MTei = 0x00000700,      /* ExtINT */
309
310         Pm = 0x00000000,        /* Physical Mode */
311         Lm = 0x00000800,        /* Logical Mode */
312
313         Ds = 0x00001000,        /* Delivery Status */
314         IPhigh = 0x00000000,    /* IIPP High */
315         IPlow = 0x00002000,     /* IIPP Low */
316         Rirr = 0x00004000,      /* Remote IRR */
317         TMedge = 0x00000000,    /* Trigger Mode Edge */
318         TMlevel = 0x00008000,   /* Trigger Mode Level */
319         Im = 0x00010000,        /* Interrupt Mask */
320 };
321
322 extern struct apic xlapic[Napic];
323 extern struct apic xioapic[Napic];
324
325 #define l16get(p)       (((p)[1]<<8)|(p)[0])
326 #define l32get(p)       (((uint32_t)l16get(p+2)<<16)|l16get(p))
327 #define l64get(p)       (((uint64_t)l32get(p+4)<<32)|l32get(p))
328
329 #include <arch/ioapic.h>
330
331 char *apicdump(char *, char *);
332 void apictimerenab(void);
333 void apicinit(int apicno, uintptr_t pa, int isbp);
334
335 /*
336 extern int pcimsienable(Pcidev*, uint64_t);
337 extern int pcimsimask(Pcidev*, int);
338 */
339
340 #endif /* ROS_KERN_APIC_H */