src/util.h

   1 // Basic x86 asm functions and function defs.
   2 //
   3 // Copyright (C) 2008-2010  Kevin O'Connor <kevin@koconnor.net>
   4 //
   5 // This file may be distributed under the terms of the GNU LGPLv3 license.
   6 #ifndef __UTIL_H
   7 #define __UTIL_H
   8
   9 #include "types.h" // u32
  10
  11 static inline void irq_disable(void)
  12 {
  13     asm volatile("cli": : :"memory");
  14 }
  15
  16 static inline void irq_enable(void)
  17 {
  18     asm volatile("sti": : :"memory");
  19 }
  20
  21 static inline unsigned long irq_save(void)
  22 {
  23     unsigned long flags;
  24     asm volatile("pushfl ; popl %0" : "=g" (flags): :"memory");
  25     irq_disable();
  26     return flags;
  27 }
  28
  29 static inline void irq_restore(unsigned long flags)
  30 {
  31     asm volatile("pushl %0 ; popfl" : : "g" (flags) : "memory", "cc");
  32 }
  33
  34 static inline void cpu_relax(void)
  35 {
  36     asm volatile("rep ; nop": : :"memory");
  37 }
  38
  39 static inline void nop(void)
  40 {
  41     asm volatile("nop");
  42 }
  43
  44 static inline void hlt(void)
  45 {
  46     asm volatile("hlt": : :"memory");
  47 }
  48
  49 static inline void wbinvd(void)
  50 {
  51     asm volatile("wbinvd": : :"memory");
  52 }
  53
  54 #define CPUID_MSR (1 << 5)
  55 #define CPUID_APIC (1 << 9)
  56 #define CPUID_MTRR (1 << 12)
  57 static inline void cpuid(u32 index, u32 *eax, u32 *ebx, u32 *ecx, u32 *edx)
  58 {
  59     asm("cpuid"
  60         : "=a" (*eax), "=b" (*ebx), "=c" (*ecx), "=d" (*edx)
  61         : "0" (index));
  62 }
  63
  64 static inline u32 getcr0(void) {
  65     u32 cr0;
  66     asm("movl %%cr0, %0" : "=r"(cr0));
  67     return cr0;
  68 }
  69 static inline void setcr0(u32 cr0) {
  70     asm("movl %0, %%cr0" : : "r"(cr0));
  71 }
  72
  73 static inline u64 rdmsr(u32 index)
  74 {
  75     u64 ret;
  76     asm ("rdmsr" : "=A"(ret) : "c"(index));
  77     return ret;
  78 }
  79
  80 static inline void wrmsr(u32 index, u64 val)
  81 {
  82     asm volatile ("wrmsr" : : "c"(index), "A"(val));
  83 }
  84
  85 static inline u64 rdtscll(void)
  86 {
  87     u64 val;
  88     asm volatile("rdtsc" : "=A" (val));
  89     return val;
  90 }
  91
  92 static inline u32 __ffs(u32 word)
  93 {
  94     asm("bsf %1,%0"
  95         : "=r" (word)
  96         : "rm" (word));
  97     return word;
  98 }
  99 static inline u32 __fls(u32 word)
 100 {
 101     asm("bsr %1,%0"
 102         : "=r" (word)
 103         : "rm" (word));
 104     return word;
 105 }
 106
 107 static inline u16 __htons_constant(u16 val) {
 108     return (val<<8) | (val>>8);
 109 }
 110 static inline u32 __htonl_constant(u32 val) {
 111     return (val<<24) | ((val&0xff00)<<8) | ((val&0xff0000)>>8) | (val>>24);
 112 }
 113 static inline u32 __htonl(u32 val) {
 114     asm("bswapl %0" : "+r"(val));
 115     return val;
 116 }
 117 #define htonl(x) (__builtin_constant_p((u32)(x)) ? __htonl_constant(x) : __htonl(x))
 118 #define ntohl(x) htonl(x)
 119 #define htons(x) __htons_constant(x)
 120 #define ntohs(x) htons(x)
 121
 122 static inline u16 cpu_to_le16(u16 x)
 123 {
 124     return x;
 125 }
 126
 127 static inline u32 cpu_to_le32(u32 x)
 128 {
 129     return x;
 130 }
 131
 132 static inline u32 getesp(void) {
 133     u32 esp;
 134     asm("movl %%esp, %0" : "=rm"(esp));
 135     return esp;
 136 }
 137
 138 static inline void writel(void *addr, u32 val) {
 139     *(volatile u32 *)addr = val;
 140 }
 141 static inline void writew(void *addr, u16 val) {
 142     *(volatile u16 *)addr = val;
 143 }
 144 static inline void writeb(void *addr, u8 val) {
 145     *(volatile u8 *)addr = val;
 146 }
 147 static inline u32 readl(const void *addr) {
 148     return *(volatile const u32 *)addr;
 149 }
 150 static inline u16 readw(const void *addr) {
 151     return *(volatile const u16 *)addr;
 152 }
 153 static inline u8 readb(const void *addr) {
 154     return *(volatile const u8 *)addr;
 155 }
 156
 157 #define call16_simpint(nr, peax, pflags) do {                           \
 158         ASSERT16();                                                     \
 159         asm volatile(                                                   \
 160             "pushl %%ebp\n"                                             \
 161             "sti\n"                                                     \
 162             "stc\n"                                                     \
 163             "int %2\n"                                                  \
 164             "pushfl\n"                                                  \
 165             "popl %1\n"                                                 \
 166             "cli\n"                                                     \
 167             "cld\n"                                                     \
 168             "popl %%ebp"                                                \
 169             : "+a"(*peax), "=c"(*pflags)                                \
 170             : "i"(nr)                                                   \
 171             : "ebx", "edx", "esi", "edi", "cc", "memory");              \
 172     } while (0)
 173
 174 // GDT bits
 175 #define GDT_CODE     (0x9bULL << 40) // Code segment - P,R,A bits also set
 176 #define GDT_DATA     (0x93ULL << 40) // Data segment - W,A bits also set
 177 #define GDT_B        (0x1ULL << 54)  // Big flag
 178 #define GDT_G        (0x1ULL << 55)  // Granularity flag
 179 // GDT bits for segment base
 180 #define GDT_BASE(v)  ((((u64)(v) & 0xff000000) << 32)           \
 181                       | (((u64)(v) & 0x00ffffff) << 16))
 182 // GDT bits for segment limit (0-1Meg)
 183 #define GDT_LIMIT(v) ((((u64)(v) & 0x000f0000) << 32)   \
 184                       | (((u64)(v) & 0x0000ffff) << 0))
 185 // GDT bits for segment limit (0-4Gig in 4K chunks)
 186 #define GDT_GRANLIMIT(v) (GDT_G | GDT_LIMIT((v) >> 12))
 187
 188 struct descloc_s {
 189     u16 length;
 190     u32 addr;
 191 } PACKED;
 192
 193 // util.c
 194 struct bregs;
 195 inline void call16(struct bregs *callregs);
 196 inline void call16big(struct bregs *callregs);
 197 inline void __call16_int(struct bregs *callregs, u16 offset);
 198 #define call16_int(nr, callregs) do {                           \
 199         extern void irq_trampoline_ ##nr ();                    \
 200         __call16_int((callregs), (u32)&irq_trampoline_ ##nr );  \
 201     } while (0)
 202 u8 checksum_far(u16 buf_seg, void *buf_far, u32 len);
 203 u8 checksum(void *buf, u32 len);
 204 size_t strlen(const char *s);
 205 int memcmp(const void *s1, const void *s2, size_t n);
 206 int strcmp(const char *s1, const char *s2);
 207 inline void memset_far(u16 d_seg, void *d_far, u8 c, size_t len);
 208 inline void memset16_far(u16 d_seg, void *d_far, u16 c, size_t len);
 209 void *memset(void *s, int c, size_t n);
 210 void memset_fl(void *ptr, u8 val, size_t size);
 211 inline void memcpy_far(u16 d_seg, void *d_far
 212                        , u16 s_seg, const void *s_far, size_t len);
 213 void memcpy_fl(void *d_fl, const void *s_fl, size_t len);
 214 void *memcpy(void *d1, const void *s1, size_t len);
 215 #if MODESEGMENT == 0
 216 #define memcpy __builtin_memcpy
 217 #endif
 218 void iomemcpy(void *d, const void *s, u32 len);
 219 void *memmove(void *d, const void *s, size_t len);
 220 char *strtcpy(char *dest, const char *src, size_t len);
 221 char *strchr(const char *s, int c);
 222 void nullTrailingSpace(char *buf);
 223 int get_keystroke(int msec);
 224
 225 // stacks.c
 226 u32 call32(void *func, u32 eax, u32 errret);
 227 inline u32 stack_hop(u32 eax, u32 edx, void *func);
 228 extern struct thread_info MainThread;
 229 struct thread_info *getCurThread(void);
 230 void yield(void);
 231 void wait_irq(void);
 232 void run_thread(void (*func)(void*), void *data);
 233 void wait_threads(void);
 234 struct mutex_s { u32 isLocked; };
 235 void mutex_lock(struct mutex_s *mutex);
 236 void mutex_unlock(struct mutex_s *mutex);
 237 void start_preempt(void);
 238 void finish_preempt(void);
 239 int wait_preempt(void);
 240 void check_preempt(void);
 241
 242 // output.c
 243 void debug_serial_setup(void);
 244 void panic(const char *fmt, ...)
 245     __attribute__ ((format (printf, 1, 2))) __noreturn;
 246 void printf(const char *fmt, ...)
 247     __attribute__ ((format (printf, 1, 2)));
 248 int snprintf(char *str, size_t size, const char *fmt, ...)
 249     __attribute__ ((format (printf, 3, 4)));
 250 char * znprintf(size_t size, const char *fmt, ...)
 251     __attribute__ ((format (printf, 2, 3)));
 252 void __dprintf(const char *fmt, ...)
 253     __attribute__ ((format (printf, 1, 2)));
 254 void __debug_enter(struct bregs *regs, const char *fname);
 255 void __debug_isr(const char *fname);
 256 void __debug_stub(struct bregs *regs, int lineno, const char *fname);
 257 void __warn_invalid(struct bregs *regs, int lineno, const char *fname);
 258 void __warn_unimplemented(struct bregs *regs, int lineno, const char *fname);
 259 void __warn_internalerror(int lineno, const char *fname);
 260 void __warn_noalloc(int lineno, const char *fname);
 261 void __warn_timeout(int lineno, const char *fname);
 262 void __set_invalid(struct bregs *regs, int lineno, const char *fname);
 263 void __set_unimplemented(struct bregs *regs, int lineno, const char *fname);
 264 void __set_code_invalid(struct bregs *regs, u32 linecode, const char *fname);
 265 void __set_code_unimplemented(struct bregs *regs, u32 linecode
 266                               , const char *fname);
 267 void hexdump(const void *d, int len);
 268
 269 #define dprintf(lvl, fmt, args...) do {                         \
 270         if (CONFIG_DEBUG_LEVEL && (lvl) <= CONFIG_DEBUG_LEVEL)  \
 271             __dprintf((fmt) , ##args );                         \
 272     } while (0)
 273 #define debug_enter(regs, lvl) do {                     \
 274         if ((lvl) && (lvl) <= CONFIG_DEBUG_LEVEL)       \
 275             __debug_enter((regs), __func__);            \
 276     } while (0)
 277 #define debug_isr(lvl) do {                             \
 278         if ((lvl) && (lvl) <= CONFIG_DEBUG_LEVEL)       \
 279             __debug_isr(__func__);                      \
 280     } while (0)
 281 #define debug_stub(regs)                        \
 282     __debug_stub((regs), __LINE__, __func__)
 283 #define warn_invalid(regs)                      \
 284     __warn_invalid((regs), __LINE__, __func__)
 285 #define warn_unimplemented(regs)                        \
 286     __warn_unimplemented((regs), __LINE__, __func__)
 287 #define warn_internalerror()                    \
 288     __warn_internalerror(__LINE__, __func__)
 289 #define warn_noalloc()                          \
 290     __warn_noalloc(__LINE__, __func__)
 291 #define warn_timeout()                          \
 292     __warn_timeout(__LINE__, __func__)
 293 #define set_invalid(regs)                       \
 294     __set_invalid((regs), __LINE__, __func__)
 295 #define set_code_invalid(regs, code)                                    \
 296     __set_code_invalid((regs), (code) | (__LINE__ << 8), __func__)
 297 #define set_unimplemented(regs)                         \
 298     __set_unimplemented((regs), __LINE__, __func__)
 299 #define set_code_unimplemented(regs, code)                              \
 300     __set_code_unimplemented((regs), (code) | (__LINE__ << 8), __func__)
 301
 302 // kbd.c
 303 void kbd_setup(void);
 304 void handle_15c2(struct bregs *regs);
 305 void process_key(u8 key);
 306
 307 // mouse.c
 308 void mouse_setup(void);
 309 void process_mouse(u8 data);
 310
 311 // system.c
 312 extern u32 RamSize;
 313 extern u64 RamSizeOver4G;
 314 void mathcp_setup(void);
 315
 316 // serial.c
 317 void serial_setup(void);
 318 void lpt_setup(void);
 319
 320 // clock.c
 321 #define PIT_TICK_RATE 1193180   // Underlying HZ of PIT
 322 #define PIT_TICK_INTERVAL 65536 // Default interval for 18.2Hz timer
 323 static inline int check_tsc(u64 end) {
 324     return (s64)(rdtscll() - end) > 0;
 325 }
 326 void timer_setup(void);
 327 void ndelay(u32 count);
 328 void udelay(u32 count);
 329 void mdelay(u32 count);
 330 void nsleep(u32 count);
 331 void usleep(u32 count);
 332 void msleep(u32 count);
 333 u64 calc_future_tsc(u32 msecs);
 334 u64 calc_future_tsc_usec(u32 usecs);
 335 u32 calc_future_timer_ticks(u32 count);
 336 u32 calc_future_timer(u32 msecs);
 337 int check_timer(u32 end);
 338 void handle_1583(struct bregs *regs);
 339 void handle_1586(struct bregs *regs);
 340 void useRTC(void);
 341 void releaseRTC(void);
 342
 343 // apm.c
 344 void apm_shutdown(void);
 345 void handle_1553(struct bregs *regs);
 346
 347 // pcibios.c
 348 void handle_1ab1(struct bregs *regs);
 349 void bios32_setup(void);
 350
 351 // shadow.c
 352 void make_bios_writable(void);
 353 void make_bios_readonly(void);
 354 void qemu_prep_reset(void);
 355
 356 // pci_region.c
 357 // region allocator. pci region allocates the requested region
 358 // sequentially with overflow check.
 359 struct pci_region {
 360     // The region is [first, last].
 361     u32 first;
 362     u32 last;
 363
 364     // The next allocation starts from here.
 365     // i.e. [start, cur_first) is allocated.
 366     // Right after initialization cur_first == first.
 367     u32 cur_first;
 368 };
 369 // initialize the pci_region of [first, last]
 370 // last must not be 0xffffffff
 371 void pci_region_init(struct pci_region *r, u32 first, u32 last);
 372 // allocate the region of size
 373 u32 pci_region_alloc(struct pci_region *r, u32 size);
 374 // make the next allocation aligned to align
 375 u32 pci_region_align(struct pci_region *r, u32 align);
 376 // revert the allocation to addr.
 377 void pci_region_revert(struct pci_region *r, u32 addr);
 378 // make the allocation fail.
 379 u32 pci_region_disable(struct pci_region *r);
 380 // returns the current allocation point.
 381 u32 pci_region_addr(const struct pci_region *r);
 382 // returns the region size.
 383 u32 pci_region_size(const struct pci_region *r);
 384
 385 // pciinit.c
 386 extern const u8 pci_irqs[4];
 387 void pci_setup(void);
 388
 389 // smm.c
 390 void smm_init(void);
 391
 392 // smp.c
 393 extern u32 CountCPUs;
 394 extern u32 MaxCountCPUs;
 395 void wrmsr_smp(u32 index, u64 val);
 396 void smp_probe(void);
 397
 398 // coreboot.c
 399 extern const char *CBvendor, *CBpart;
 400 struct cbfs_file;
 401 struct cbfs_file *cbfs_finddatafile(const char *fname);
 402 struct cbfs_file *cbfs_findprefix(const char *prefix, struct cbfs_file *last);
 403 u32 cbfs_datasize(struct cbfs_file *file);
 404 const char *cbfs_filename(struct cbfs_file *file);
 405 int cbfs_copyfile(struct cbfs_file *file, void *dst, u32 maxlen);
 406 void cbfs_run_payload(struct cbfs_file *file);
 407 void coreboot_copy_biostable(void);
 408 void cbfs_payload_setup(void);
 409 void coreboot_setup(void);
 410
 411 // biostable.c
 412 void copy_pir(void *pos);
 413 void copy_mptable(void *pos);
 414 void copy_acpi_rsdp(void *pos);
 415 void copy_smbios(void *pos);
 416
 417 // vgahooks.c
 418 void handle_155f(struct bregs *regs);
 419 struct pci_device;
 420 void vgahook_setup(struct pci_device *pci);
 421
 422 // optionroms.c
 423 void call_bcv(u16 seg, u16 ip);
 424 void optionrom_setup(void);
 425 void vga_setup(void);
 426 void s3_resume_vga_init(void);
 427 extern u32 RomEnd;
 428 extern int ScreenAndDebug;
 429
 430 // bootsplash.c
 431 void enable_vga_console(void);
 432 void enable_bootsplash(void);
 433 void disable_bootsplash(void);
 434
 435 // resume.c
 436 extern int HaveRunPost;
 437 void init_dma(void);
 438
 439 // pnpbios.c
 440 #define PNP_SIGNATURE 0x506e5024 // $PnP
 441 u16 get_pnp_offset(void);
 442 void pnp_setup(void);
 443
 444 // pmm.c
 445 extern struct zone_s ZoneLow, ZoneHigh, ZoneFSeg, ZoneTmpLow, ZoneTmpHigh;
 446 void malloc_setup(void);
 447 void malloc_finalize(void);
 448 void *pmm_malloc(struct zone_s *zone, u32 handle, u32 size, u32 align);
 449 int pmm_free(void *data);
 450 void pmm_setup(void);
 451 void pmm_finalize(void);
 452 #define PMM_DEFAULT_HANDLE 0xFFFFFFFF
 453 // Minimum alignment of malloc'd memory
 454 #define MALLOC_MIN_ALIGN 16
 455 // Helper functions for memory allocation.
 456 static inline void *malloc_low(u32 size) {
 457     return pmm_malloc(&ZoneLow, PMM_DEFAULT_HANDLE, size, MALLOC_MIN_ALIGN);
 458 }
 459 static inline void *malloc_high(u32 size) {
 460     return pmm_malloc(&ZoneHigh, PMM_DEFAULT_HANDLE, size, MALLOC_MIN_ALIGN);
 461 }
 462 static inline void *malloc_fseg(u32 size) {
 463     return pmm_malloc(&ZoneFSeg, PMM_DEFAULT_HANDLE, size, MALLOC_MIN_ALIGN);
 464 }
 465 static inline void *malloc_tmplow(u32 size) {
 466     return pmm_malloc(&ZoneTmpLow, PMM_DEFAULT_HANDLE, size, MALLOC_MIN_ALIGN);
 467 }
 468 static inline void *malloc_tmphigh(u32 size) {
 469     return pmm_malloc(&ZoneTmpHigh, PMM_DEFAULT_HANDLE, size, MALLOC_MIN_ALIGN);
 470 }
 471 static inline void *malloc_tmp(u32 size) {
 472     void *ret = malloc_tmphigh(size);
 473     if (ret)
 474         return ret;
 475     return malloc_tmplow(size);
 476 }
 477 static inline void *memalign_low(u32 align, u32 size) {
 478     return pmm_malloc(&ZoneLow, PMM_DEFAULT_HANDLE, size, align);
 479 }
 480 static inline void *memalign_high(u32 align, u32 size) {
 481     return pmm_malloc(&ZoneHigh, PMM_DEFAULT_HANDLE, size, align);
 482 }
 483 static inline void *memalign_tmplow(u32 align, u32 size) {
 484     return pmm_malloc(&ZoneTmpLow, PMM_DEFAULT_HANDLE, size, align);
 485 }
 486 static inline void *memalign_tmphigh(u32 align, u32 size) {
 487     return pmm_malloc(&ZoneTmpHigh, PMM_DEFAULT_HANDLE, size, align);
 488 }
 489 static inline void *memalign_tmp(u32 align, u32 size) {
 490     void *ret = memalign_tmphigh(align, size);
 491     if (ret)
 492         return ret;
 493     return memalign_tmplow(align, size);
 494 }
 495 static inline void free(void *data) {
 496     pmm_free(data);
 497 }
 498
 499 // mtrr.c
 500 void mtrr_setup(void);
 501
 502 // romlayout.S
 503 void reset_vector(void) __noreturn;
 504
 505 // misc.c
 506 extern u8 BiosChecksum;
 507
 508 // version (auto generated file out/version.c)
 509 extern const char VERSION[];
 510
 511 #endif // util.h