Migrated Akaros code to use pragma once (XCC)
[akaros.git] / kern / arch / x86 / x86.h
1 #pragma once
2
3 #include <ros/common.h>
4 #include <arch/mmu.h>
5
6 /* Model Specific Registers */
7 // TODO: figure out which are intel specific, and name them accordingly
8 #define IA32_APIC_BASE                          0x1b
9 /* These two are intel-only */
10 #define IA32_FEATURE_CONTROL            0x3a
11 #define IA32_MISC_ENABLE                        0x1a0
12
13 #define IA32_MTRR_DEF_TYPE                      0x2ff
14 #define IA32_MTRR_PHYSBASE0                     0x200
15 #define IA32_MTRR_PHYSMASK0                     0x201
16 #define IA32_MTRR_PHYSBASE1                     0x202
17 #define IA32_MTRR_PHYSMASK1                     0x203
18 #define IA32_MTRR_PHYSBASE2                     0x204
19 #define IA32_MTRR_PHYSMASK2                     0x205
20 #define IA32_MTRR_PHYSBASE3                     0x206
21 #define IA32_MTRR_PHYSMASK3                     0x207
22 #define IA32_MTRR_PHYSBASE4                     0x208
23 #define IA32_MTRR_PHYSMASK4                     0x209
24 #define IA32_MTRR_PHYSBASE5                     0x20a
25 #define IA32_MTRR_PHYSMASK5                     0x20b
26 #define IA32_MTRR_PHYSBASE6                     0x20c
27 #define IA32_MTRR_PHYSMASK6                     0x20d
28 #define IA32_MTRR_PHYSBASE7                     0x20e
29 #define IA32_MTRR_PHYSMASK7                     0x20f
30
31 #define MSR_APIC_ENABLE                         0x00000800
32 #define MSR_APIC_BASE_ADDRESS           0x0000000FFFFFF000
33
34 #define IA32_EFER_MSR                           0xc0000080
35 # define IA32_EFER_SYSCALL                      (1 << 0)
36 # define IA32_EFER_IA32E_EN                     (1 << 8)
37 # define IA32_EFER_IA32E_ACT            (1 << 10)
38 # define IA32_EFER_EXE_DIS_BIT          (1 << 11)
39
40 #define MSR_TSC_AUX                                     0xc0000103
41
42 #define MSR_FS_BASE                                     0xc0000100
43 #define MSR_GS_BASE                                     0xc0000101
44 #define MSR_KERN_GS_BASE                        0xc0000102
45
46 #define MSR_STAR                                        0xc0000081
47 #define MSR_LSTAR                                       0xc0000082
48 #define MSR_CSTAR                                       0xc0000083
49 #define MSR_SFMASK                                      0xc0000084
50
51 /* CPUID */
52 #define CPUID_PSE_SUPPORT                       0x00000008
53
54 /* Arch Constants */
55 #define MAX_NUM_CORES                           255
56
57 #define X86_REG_BP                                      "rbp"
58 #define X86_REG_SP                                      "rsp"
59 #define X86_REG_IP                                      "rip"
60 #define X86_REG_AX                                      "rax"
61 #define X86_REG_BX                                      "rbx"
62 #define X86_REG_CX                                      "rcx"
63 #define X86_REG_DX                                      "rdx"
64
65
66 /* Various flags defined: can be included from assembler. */
67
68 /*
69  * EFLAGS bits
70  */
71 #define X86_EFLAGS_CF   0x00000001 /* Carry Flag */
72 #define X86_EFLAGS_BIT1 0x00000002 /* Bit 1 - always on */
73 #define X86_EFLAGS_PF   0x00000004 /* Parity Flag */
74 #define X86_EFLAGS_AF   0x00000010 /* Auxiliary carry Flag */
75 #define X86_EFLAGS_ZF   0x00000040 /* Zero Flag */
76 #define X86_EFLAGS_SF   0x00000080 /* Sign Flag */
77 #define X86_EFLAGS_TF   0x00000100 /* Trap Flag */
78 #define X86_EFLAGS_IF   0x00000200 /* Interrupt Flag */
79 #define X86_EFLAGS_DF   0x00000400 /* Direction Flag */
80 #define X86_EFLAGS_OF   0x00000800 /* Overflow Flag */
81 #define X86_EFLAGS_IOPL 0x00003000 /* IOPL mask */
82 #define X86_EFLAGS_NT   0x00004000 /* Nested Task */
83 #define X86_EFLAGS_RF   0x00010000 /* Resume Flag */
84 #define X86_EFLAGS_VM   0x00020000 /* Virtual Mode */
85 #define X86_EFLAGS_AC   0x00040000 /* Alignment Check */
86 #define X86_EFLAGS_VIF  0x00080000 /* Virtual Interrupt Flag */
87 #define X86_EFLAGS_VIP  0x00100000 /* Virtual Interrupt Pending */
88 #define X86_EFLAGS_ID   0x00200000 /* CPUID detection flag */
89
90 /*
91  * Basic CPU control in CR0
92  */
93 #define X86_CR0_PE      0x00000001 /* Protection Enable */
94 #define X86_CR0_MP      0x00000002 /* Monitor Coprocessor */
95 #define X86_CR0_EM      0x00000004 /* Emulation */
96 #define X86_CR0_TS      0x00000008 /* Task Switched */
97 #define X86_CR0_ET      0x00000010 /* Extension Type */
98 #define X86_CR0_NE      0x00000020 /* Numeric Error */
99 #define X86_CR0_WP      0x00010000 /* Write Protect */
100 #define X86_CR0_AM      0x00040000 /* Alignment Mask */
101 #define X86_CR0_NW      0x20000000 /* Not Write-through */
102 #define X86_CR0_CD      0x40000000 /* Cache Disable */
103 #define X86_CR0_PG      0x80000000 /* Paging */
104
105 /*
106  * Paging options in CR3
107  */
108 #define X86_CR3_PWT     0x00000008 /* Page Write Through */
109 #define X86_CR3_PCD     0x00000010 /* Page Cache Disable */
110 #define X86_CR3_PCID_MASK 0x00000fff /* PCID Mask */
111
112 /*
113  * Intel CPU features in CR4
114  */
115 #define X86_CR4_VME     0x00000001 /* enable vm86 extensions */
116 #define X86_CR4_PVI     0x00000002 /* virtual interrupts flag enable */
117 #define X86_CR4_TSD     0x00000004 /* disable time stamp at ipl 3 */
118 #define X86_CR4_DE      0x00000008 /* enable debugging extensions */
119 #define X86_CR4_PSE     0x00000010 /* enable page size extensions */
120 #define X86_CR4_PAE     0x00000020 /* enable physical address extensions */
121 #define X86_CR4_MCE     0x00000040 /* Machine check enable */
122 #define X86_CR4_PGE     0x00000080 /* enable global pages */
123 #define X86_CR4_PCE     0x00000100 /* enable performance counters at ipl 3 */
124 #define X86_CR4_OSFXSR  0x00000200 /* enable fast FPU save and restore */
125 #define X86_CR4_OSXMMEXCPT 0x00000400 /* enable unmasked SSE exceptions */
126 #define X86_CR4_VMXE    0x00002000 /* enable VMX virtualization */
127 #define X86_CR4_RDWRGSFS 0x00010000 /* enable RDWRGSFS support */
128 #define X86_CR4_PCIDE   0x00020000 /* enable PCID support */
129 #define X86_CR4_OSXSAVE 0x00040000 /* enable xsave and xrestore */
130 #define X86_CR4_SMEP    0x00100000 /* enable SMEP support */
131 #define X86_CR4_SMAP    0x00200000 /* enable SMAP support */
132
133 /*
134  * x86-64 Task Priority Register, CR8
135  */
136 #define X86_CR8_TPR     0x0000000F /* task priority register */
137
138 #ifndef __ASSEMBLER__
139 static inline uint8_t inb(int port) __attribute__((always_inline));
140 static inline void insb(int port, void *addr, int cnt)
141               __attribute__((always_inline));
142 static inline uint16_t inw(int port) __attribute__((always_inline));
143 static inline void insw(int port, void *addr, int cnt)
144               __attribute__((always_inline));
145 static inline uint32_t inl(int port) __attribute__((always_inline));
146 static inline void insl(int port, void *addr, int cnt)
147               __attribute__((always_inline));
148 static inline void outb(int port, uint8_t data) __attribute__((always_inline));
149 static inline void outsb(int port, const void *addr, int cnt)
150               __attribute__((always_inline));
151 static inline void outw(int port, uint16_t data) __attribute__((always_inline));
152 static inline void outsw(int port, const void *addr, int cnt)
153               __attribute__((always_inline));
154 static inline void outsl(int port, const void *addr, int cnt)
155               __attribute__((always_inline));
156 static inline void outl(int port, uint32_t data) __attribute__((always_inline));
157 static inline void lidt(void *p) __attribute__((always_inline));
158 static inline void lldt(uint16_t sel) __attribute__((always_inline));
159 static inline void ltr(uint16_t sel) __attribute__((always_inline));
160 static inline void lcr0(unsigned long val) __attribute__((always_inline));
161 static inline unsigned long rcr0(void) __attribute__((always_inline));
162 static inline unsigned long rcr2(void) __attribute__((always_inline));
163 static inline void lcr3(unsigned long val) __attribute__((always_inline));
164 static inline unsigned long rcr3(void) __attribute__((always_inline));
165 static inline void lcr4(unsigned long val) __attribute__((always_inline));
166 static inline unsigned long rcr4(void) __attribute__((always_inline));
167 static inline unsigned long read_flags(void) __attribute__((always_inline));
168 static inline void write_eflags(unsigned long eflags)
169               __attribute__((always_inline));
170 static inline unsigned long read_bp(void) __attribute__((always_inline));
171 static inline unsigned long read_pc(void) __attribute__((always_inline));
172 static inline unsigned long read_sp(void) __attribute__((always_inline));
173 static inline void cpuid(uint32_t info1, uint32_t info2, uint32_t *eaxp,
174                          uint32_t *ebxp, uint32_t *ecxp, uint32_t *edxp)
175                                                                __attribute__((always_inline));
176 static inline uint32_t cpuid_ecx(uint32_t op) __attribute__((always_inline));
177 static inline uint64_t read_msr(uint32_t reg) __attribute__((always_inline));
178 static inline void write_msr(uint32_t reg, uint64_t val)
179               __attribute__((always_inline));
180 /* if we have mm64s, change the hpet helpers */
181 static inline void write_mmreg32(uintptr_t reg, uint32_t val)
182               __attribute__((always_inline));
183 static inline uint32_t read_mmreg32(uintptr_t reg)
184               __attribute__((always_inline));
185 static inline void wbinvd(void) __attribute__((always_inline));
186 static inline void __cpu_relax(void) __attribute__((always_inline));
187
188 static inline uint8_t inb(int port)
189 {
190         uint8_t data;
191         asm volatile("inb %w1,%0" : "=a" (data) : "d" (port));
192         return data;
193 }
194
195 static inline void insb(int port, void *addr, int cnt)
196 {
197         asm volatile("cld\n\trepne\n\tinsb"
198                      : "=D" (addr), "=c" (cnt)
199                      : "d" (port), "0" (addr), "1" (cnt)
200                      : "memory", "cc");
201 }
202
203 static inline uint16_t inw(int port)
204 {
205         uint16_t data;
206         asm volatile("inw %w1,%0" : "=a" (data) : "d" (port));
207         return data;
208 }
209
210 static inline void insw(int port, void *addr, int cnt)
211 {
212         asm volatile("cld\n\trepne\n\tinsw"
213                      : "=D" (addr), "=c" (cnt)
214                      : "d" (port), "0" (addr), "1" (cnt)
215                      : "memory", "cc");
216 }
217
218 static inline uint32_t inl(int port)
219 {
220         uint32_t data;
221         asm volatile("inl %w1,%0" : "=a" (data) : "d" (port));
222         return data;
223 }
224
225 static inline void insl(int port, void *addr, int cnt)
226 {
227         asm volatile("cld\n\trepne\n\tinsl"
228                      : "=D" (addr), "=c" (cnt)
229                      : "d" (port), "0" (addr), "1" (cnt)
230                      : "memory", "cc");
231 }
232
233 static inline void outb(int port, uint8_t data)
234 {
235         asm volatile("outb %0,%w1" : : "a" (data), "d" (port));
236 }
237
238 static inline void outsb(int port, const void *addr, int cnt)
239 {
240         asm volatile("cld\n\trepne\n\toutsb"
241                      : "=S" (addr), "=c" (cnt)
242                      : "d" (port), "0" (addr), "1" (cnt)
243                      : "cc");
244 }
245
246 static inline void outw(int port, uint16_t data)
247 {
248         asm volatile("outw %0,%w1" : : "a" (data), "d" (port));
249 }
250
251 static inline void outsw(int port, const void *addr, int cnt)
252 {
253         asm volatile("cld\n\trepne\n\toutsw"
254                      : "=S" (addr), "=c" (cnt)
255                      : "d" (port), "0" (addr), "1" (cnt)
256                      : "cc");
257 }
258
259 static inline void outsl(int port, const void *addr, int cnt)
260 {
261         asm volatile("cld\n\trepne\n\toutsl"
262                      : "=S" (addr), "=c" (cnt)
263                      : "d" (port), "0" (addr), "1" (cnt)
264                      : "cc");
265 }
266
267 static inline void outl(int port, uint32_t data)
268 {
269         asm volatile("outl %0,%w1" : : "a" (data), "d" (port));
270 }
271
272 static inline void lidt(void *p)
273 {
274         asm volatile("lidt (%0)" : : "r" (p));
275 }
276
277 static inline void lldt(uint16_t sel)
278 {
279         asm volatile("lldt %0" : : "r" (sel));
280 }
281
282 static inline void ltr(uint16_t sel)
283 {
284         asm volatile("ltr %0" : : "r" (sel));
285 }
286
287 static inline void lcr0(unsigned long val)
288 {
289         asm volatile("mov %0,%%cr0" : : "r" (val));
290 }
291
292 static inline unsigned long rcr0(void)
293 {
294         unsigned long val;
295         asm volatile("mov %%cr0,%0" : "=r" (val));
296         return val;
297 }
298
299 static inline unsigned long rcr2(void)
300 {
301         unsigned long val;
302         asm volatile("mov %%cr2,%0" : "=r" (val));
303         return val;
304 }
305
306 static inline void lcr3(unsigned long val)
307 {
308         asm volatile("mov %0,%%cr3" : : "r" (val));
309 }
310
311 static inline unsigned long rcr3(void)
312 {
313         unsigned long val;
314         asm volatile("mov %%cr3,%0" : "=r" (val));
315         return val;
316 }
317
318 static inline void lcr4(unsigned long val)
319 {
320         asm volatile("mov %0,%%cr4" : : "r" (val));
321 }
322
323 static inline unsigned long rcr4(void)
324 {
325         unsigned long cr4;
326         asm volatile("mov %%cr4,%0" : "=r" (cr4));
327         return cr4;
328 }
329
330 static inline unsigned long read_flags(void)
331 {
332         unsigned long eflags;
333         asm volatile("pushf; pop %0" : "=r" (eflags));
334         return eflags;
335 }
336
337 static inline void write_eflags(unsigned long eflags)
338 {
339         asm volatile("push %0; popf" : : "r" (eflags));
340 }
341
342 static inline unsigned long read_bp(void)
343 {
344         unsigned long bp;
345         asm volatile("mov %%"X86_REG_BP",%0" : "=r" (bp));
346         return bp;
347 }
348
349 static inline unsigned long read_pc(void)
350 {
351         unsigned long ip;
352         asm volatile("call 1f; 1: pop %0" : "=r"(ip));
353         return ip;
354 }
355
356 static inline unsigned long read_sp(void)
357 {
358         unsigned long sp;
359         asm volatile("mov %%"X86_REG_SP",%0" : "=r" (sp));
360         return sp;
361 }
362
363 static inline void cpuid(uint32_t info1, uint32_t info2, uint32_t *eaxp,
364                          uint32_t *ebxp, uint32_t *ecxp, uint32_t *edxp)
365 {
366         uint32_t eax, ebx, ecx, edx;
367         /* Can select with both eax (info1) and ecx (info2) */
368         asm volatile("cpuid" 
369                 : "=a" (eax), "=b" (ebx), "=c" (ecx), "=d" (edx)
370                 : "a" (info1), "c" (info2));
371         if (eaxp)
372                 *eaxp = eax;
373         if (ebxp)
374                 *ebxp = ebx;
375         if (ecxp)
376                 *ecxp = ecx;
377         if (edxp)
378                 *edxp = edx;
379 }
380
381 static inline uint32_t cpuid_ecx(uint32_t op)
382 {
383         uint32_t ecx;
384         cpuid(op, 0, NULL, NULL, &ecx, NULL);
385         return ecx;
386 }
387
388 // Might need to mfence rdmsr.  supposedly wrmsr serializes, but not for x2APIC
389 static inline uint64_t read_msr(uint32_t reg)
390 {
391         uint32_t edx, eax;
392         asm volatile("rdmsr; mfence" : "=d"(edx), "=a"(eax) : "c"(reg));
393         return (uint64_t)edx << 32 | eax;
394 }
395
396 static inline void write_msr(uint32_t reg, uint64_t val)
397 {
398         asm volatile("wrmsr" : : "d"((uint32_t)(val >> 32)),
399                                  "a"((uint32_t)(val & 0xFFFFFFFF)), 
400                                  "c"(reg));
401 }
402
403 static inline void write_mmreg32(uintptr_t reg, uint32_t val)
404 {
405         *((volatile uint32_t*)reg) = val;
406 }
407
408 static inline uint32_t read_mmreg32(uintptr_t reg)
409 {
410         return *((volatile uint32_t*)reg);
411 }
412
413 static inline void wbinvd(void)
414 {
415         asm volatile("wbinvd");
416 }
417
418 /* this version of cpu_relax is needed to resolve some circular dependencies
419  * with arch/arch.h and arch/apic.h */
420 static inline void __cpu_relax(void)
421 {
422         // in case the compiler doesn't serialize for pause, the "m" will make sure
423         // no memory is reordered around this instruction.
424         asm volatile("pause" : : : "memory");
425 }
426
427 #ifndef UNUSED_ARG
428 #define UNUSED_ARG(x) (void)x
429 #endif /* This prevents compiler warnings for UNUSED_ARG */ 
430 #endif /* !__ASSEMBLER__ */