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