x86: sends the EOI later in the IRQ path
[akaros.git] / kern / arch / x86 / apic.c
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 #ifdef __SHARC__
8 #pragma nosharc
9 #define SINIT(x) x
10 #endif
11
12 #include <arch/mmu.h>
13 #include <arch/x86.h>
14 #include <arch/arch.h>
15 #include <arch/apic.h>
16 #include <time.h>
17 #include <assert.h>
18 #include <stdio.h>
19 #include <bitmask.h>
20
21 system_timing_t RO system_timing = {0, 0, 0xffff, 0};
22 bool core_id_ready = FALSE;
23
24 /* * Remaps the Programmable Interrupt Controller to use IRQs 32-47
25  * http://wiki.osdev.org/PIC
26  * Check osdev for a more thorough explanation/implementation.
27  * http://bochs.sourceforge.net/techspec/PORTS.LST  */
28 void pic_remap() 
29 {
30         /* start initialization (ICW1) */
31         outb(PIC1_CMD, 0x11);
32         outb(PIC2_CMD, 0x11);
33         /* set new offsets (ICW2) */
34         outb(PIC1_DATA, PIC1_OFFSET);
35         outb(PIC2_DATA, PIC2_OFFSET);
36         /* set up cascading (ICW3) */
37         outb(PIC1_DATA, 0x04);
38         outb(PIC2_DATA, 0x02);
39         /* other stuff (put in 8086/88 mode, or whatever) (ICW4) */
40         outb(PIC1_DATA, 0x01);
41         outb(PIC2_DATA, 0x01);
42         /* Init done, further data R/W access the interrupt mask */
43         /* set masks, defaulting to all masked for now */
44         outb(PIC1_DATA, 0xff);
45         outb(PIC2_DATA, 0xff);
46 }
47
48 void pic_mask_irq(uint8_t irq)
49 {
50         if (irq > 7)
51                 outb(PIC2_DATA, inb(PIC2_DATA) | (1 << (irq - 8)));
52         else
53                 outb(PIC1_DATA, inb(PIC1_DATA) | (1 << irq));
54 }
55
56 void pic_unmask_irq(uint8_t irq)
57 {
58         if (irq > 7) {
59                 outb(PIC2_DATA, inb(PIC2_DATA) & ~(1 << (irq - 8)));
60                 outb(PIC1_DATA, inb(PIC1_DATA) & 0xfb); // make sure irq2 is unmasked
61         } else
62                 outb(PIC1_DATA, inb(PIC1_DATA) & ~(1 << irq));
63 }
64
65 /* Aka, the IMR.  Simply reading the data port are OCW1s. */
66 uint16_t pic_get_mask(void)
67 {
68         return (inb(PIC2_DATA) << 8) | inb(PIC1_DATA);
69 }
70
71 static uint16_t __pic_get_irq_reg(int ocw3)
72 {
73         /* OCW3 to PIC CMD to get the register values.  PIC2 is chained, and
74          * represents IRQs 8-15.  PIC1 is IRQs 0-7, with 2 being the chain */
75         outb(PIC1_CMD, ocw3);
76         outb(PIC2_CMD, ocw3);
77         return (inb(PIC2_CMD) << 8) | inb(PIC1_CMD);
78 }
79
80 /* Returns the combined value of the cascaded PICs irq request register */
81 uint16_t pic_get_irr(void)
82 {
83         return __pic_get_irq_reg(PIC_READ_IRR);
84 }
85
86 /* Returns the combined value of the cascaded PICs irq service register */
87 uint16_t pic_get_isr(void)
88 {
89         return __pic_get_irq_reg(PIC_READ_ISR);
90 }
91
92 /* Debugging helper.  Note the ISR/IRR are 32 bits at a time, spaced every 16
93  * bytes in the LAPIC address space. */
94 void lapic_print_isr(void)
95 {
96         printk("LAPIC ISR on core %d\n--------------\n", core_id());
97         for (int i = 7; i >= 0; i--)
98                 printk("%3d-%3d: %p\n", (i + 1) * 32 - 1, i * 32,
99                        *(uint32_t*)(LAPIC_ISR + i * 0x10));
100         printk("LAPIC IRR on core %d\n--------------\n", core_id());
101         for (int i = 7; i >= 0; i--)
102                 printk("%3d-%3d: %p\n", (i + 1) * 32 - 1, i * 32,
103                        *(uint32_t*)(LAPIC_IRR + i * 0x10));
104 }
105
106 /* Returns TRUE if the bit 'vector' is set in the LAPIC ISR or IRR (whatever you
107  * pass in.  These registers consist of 8, 32 byte registers spaced every 16
108  * bytes from the base in the LAPIC. */
109 static bool __lapic_get_isrr_bit(unsigned long base, uint8_t vector)
110 {
111         int which_reg = vector >> 5;    /* 32 bits per reg */
112         uint32_t *lapic_reg = (uint32_t*)(base + which_reg * 0x10);     /* offset 16 */
113         return (*lapic_reg & (1 << (vector % 32)) ? 1 : 0);
114 }
115
116 bool lapic_get_isr_bit(uint8_t vector)
117 {
118         return __lapic_get_isrr_bit(LAPIC_ISR, vector);
119 }
120
121 bool lapic_get_irr_bit(uint8_t vector)
122 {
123         return __lapic_get_isrr_bit(LAPIC_IRR, vector);
124 }
125
126 /* This works for any interrupt that goes through the LAPIC, but not things like
127  * ExtInts.  To prevent abuse, we'll use it just for IPIs for now (which only
128  * come via the APIC).
129  *
130  * We only check the IRR, due to how we send EOIs.  Since we don't send til
131  * after handlers return, the ISR will show pending for the current IRQ.  It is
132  * the EOI that clears the bit from the ISR. */
133 bool ipi_is_pending(uint8_t vector)
134 {
135         return lapic_get_isr_bit(vector);
136 }
137
138 /*
139  * Sets the LAPIC timer to go off after a certain number of ticks.  The primary
140  * clock freq is actually the bus clock, which we figure out during timer_init
141  * Unmasking is implied.  Ref SDM, 3A, 9.6.4
142  */
143 void __lapic_set_timer(uint32_t ticks, uint8_t vec, bool periodic, uint8_t div)
144 {
145         // clears bottom bit and then set divider
146         write_mmreg32(LAPIC_TIMER_DIVIDE, (read_mmreg32(LAPIC_TIMER_DIVIDE) &~0xf) |
147                       (div & 0xf));
148         // set LVT with interrupt handling information
149         write_mmreg32(LAPIC_LVT_TIMER, vec | (periodic << 17));
150         write_mmreg32(LAPIC_TIMER_INIT, ticks);
151         // For debugging when we expand this
152         //cprintf("LAPIC LVT Timer: 0x%08x\n", read_mmreg32(LAPIC_LVT_TIMER));
153         //cprintf("LAPIC Init Count: 0x%08x\n", read_mmreg32(LAPIC_TIMER_INIT));
154         //cprintf("LAPIC Current Count: 0x%08x\n", read_mmreg32(LAPIC_TIMER_CURRENT));
155 }
156
157 void lapic_set_timer(uint32_t usec, bool periodic)
158 {
159         /* If we overflowed a uint32, send in the max timer possible.  The lapic can
160          * only handle a 32 bit.  We could muck with changing the divisor, but even
161          * then, we might not be able to match 4000 sec (based on the bus speed).
162          * The kernel alarm code can handle spurious timer interrupts, so we just
163          * set the timer for as close as we can get to the desired time. */
164         uint64_t ticks64 = (usec * system_timing.bus_freq) / LAPIC_TIMER_DIVISOR_VAL
165                             / 1000000;
166         uint32_t ticks32 = ((ticks64 >> 32) ? 0xffffffff : ticks64);
167         assert(ticks32 > 0);
168         __lapic_set_timer(ticks32, LAPIC_TIMER_DEFAULT_VECTOR, periodic,
169                           LAPIC_TIMER_DIVISOR_BITS);
170 }
171
172 void set_core_timer(uint32_t usec, bool periodic)
173 {
174         if (usec)
175                 lapic_set_timer(usec, periodic);
176         else
177                 lapic_disable_timer();
178 }
179
180 uint32_t lapic_get_default_id(void)
181 {
182         uint32_t ebx;
183         cpuid(0x1, 0x0, 0, &ebx, 0, 0);
184         // p6 family only uses 4 bits here, and 0xf is reserved for the IOAPIC
185         return (ebx & 0xFF000000) >> 24;
186 }
187
188 // timer init calibrates both tsc timer and lapic timer using PIT
189 void timer_init(void){
190         uint64_t tscval[2];
191         long timercount[2];
192         pit_set_timer(0xffff, TIMER_RATEGEN);
193         // assume tsc exist
194         tscval[0] = read_tsc();
195         udelay_pit(1000000);
196         tscval[1] = read_tsc();
197         system_timing.tsc_freq = SINIT(tscval[1] - tscval[0]);
198         cprintf("TSC Frequency: %llu\n", system_timing.tsc_freq);
199         __lapic_set_timer(0xffffffff, LAPIC_TIMER_DEFAULT_VECTOR, FALSE,
200                           LAPIC_TIMER_DIVISOR_BITS);
201         // Mask the LAPIC Timer, so we never receive this interrupt (minor race)
202         mask_lapic_lvt(LAPIC_LVT_TIMER);
203         timercount[0] = read_mmreg32(LAPIC_TIMER_CURRENT);
204         udelay_pit(1000000);
205         timercount[1] = read_mmreg32(LAPIC_TIMER_CURRENT);
206         system_timing.bus_freq = (timercount[0] - timercount[1])
207                                  * LAPIC_TIMER_DIVISOR_VAL;
208         /* The time base for the timer is derived from the processor's bus clock,
209          * divided by the value specified in the divide configuration register.
210          * Note we mult and div by the divisor, saving the actual freq (even though
211          * we don't use it yet). */
212         cprintf("Bus Frequency: %llu\n", system_timing.bus_freq);
213 }
214
215 void pit_set_timer(uint32_t divisor, uint32_t mode)
216 {
217         if (divisor & 0xffff0000)
218                 warn("Divisor too large!");
219         mode = TIMER_SEL0|TIMER_16BIT|mode;
220         outb(TIMER_MODE, mode); 
221         outb(TIMER_CNTR0, divisor & 0xff);
222         outb(TIMER_CNTR0, (divisor >> 8) );
223         system_timing.pit_mode = SINIT(mode);
224         system_timing.pit_divisor = SINIT(divisor);
225         // cprintf("timer mode set to %d, divisor %d\n",mode, divisor);
226 }
227
228 static int getpit()
229 {
230     int high, low;
231         // TODO: need a lock to protect access to PIT
232
233     /* Select timer0 and latch counter value. */
234     outb(TIMER_MODE, TIMER_SEL0 | TIMER_LATCH);
235     
236     low = inb(TIMER_CNTR0);
237     high = inb(TIMER_CNTR0);
238
239     return ((high << 8) | low);
240 }
241
242 // forces cpu to relax for usec miliseconds.  declared in kern/include/time.h
243 void udelay(uint64_t usec)
244 {
245         #if !defined(__BOCHS__)
246         if (system_timing.tsc_freq != 0)
247         {
248                 uint64_t start, end, now;
249
250                 start = read_tsc();
251         end = start + usec2tsc(usec);
252         //cprintf("start %llu, end %llu\n", start, end);
253                 if (end == 0) cprintf("This is terribly wrong \n");
254                 do {
255             cpu_relax();
256             now = read_tsc();
257                         //cprintf("now %llu\n", now);
258                 } while (now < end || (now > start && end < start));
259         return;
260
261         } else
262         #endif
263         {
264                 udelay_pit(usec);
265         }
266 }
267
268 void udelay_pit(uint64_t usec)
269 {
270         
271         int64_t delta, prev_tick, tick, ticks_left;
272         prev_tick = getpit();
273         /*
274          * Calculate (n * (i8254_freq / 1e6)) without using floating point
275          * and without any avoidable overflows.
276          */
277         if (usec <= 0)
278                 ticks_left = 0;
279         // some optimization from bsd code
280         else if (usec < 256)
281                 /*
282                  * Use fixed point to avoid a slow division by 1000000.
283                  * 39099 = 1193182 * 2^15 / 10^6 rounded to nearest.
284                  * 2^15 is the first power of 2 that gives exact results
285                  * for n between 0 and 256.
286                  */
287                 ticks_left = ((uint64_t)usec * 39099 + (1 << 15) - 1) >> 15;
288         else
289                 // round up the ticks left
290                 ticks_left = ((uint64_t)usec * (long long)PIT_FREQ+ 999999)
291                              / 1000000; 
292         while (ticks_left > 0) {
293                 tick = getpit();
294                 delta = prev_tick - tick;
295                 prev_tick = tick;
296                 if (delta < 0) {
297                         // counter looped around during the delta time period
298                         delta += system_timing.pit_divisor; // maximum count 
299                         if (delta < 0)
300                                 delta = 0;
301                 }
302                 ticks_left -= delta;
303         }
304 }
305
306 uint64_t gettimer(void)
307 {
308         return read_tsc();      
309 }
310
311 uint64_t getfreq(void)
312 {
313         return system_timing.tsc_freq;
314 }