src/util.h

   1 // Basic x86 asm functions and function defs.
   2 //
   3 // Copyright (C) 2008,2009  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));
  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 // Atomically enable irqs and sleep until an irq; then re-disable irqs.
  40 static inline void wait_irq(void)
  41 {
  42     asm volatile("sti ; hlt ; cli ; cld": : :"memory");
  43 }
  44
  45 static inline void nop(void)
  46 {
  47     asm volatile("nop");
  48 }
  49
  50 static inline void hlt(void)
  51 {
  52     asm volatile("hlt");
  53 }
  54
  55 static inline void wbinvd(void)
  56 {
  57     asm volatile("wbinvd");
  58 }
  59
  60 #define CPUID_MSR (1 << 5)
  61 #define CPUID_APIC (1 << 9)
  62 #define CPUID_MTRR (1 << 12)
  63 static inline void cpuid(u32 index, u32 *eax, u32 *ebx, u32 *ecx, u32 *edx)
  64 {
  65     asm("cpuid"
  66         : "=a" (*eax), "=b" (*ebx), "=c" (*ecx), "=d" (*edx)
  67         : "0" (index));
  68 }
  69
  70 static inline u64 rdmsr(u32 index)
  71 {
  72     u64 ret;
  73     asm ("rdmsr" : "=A"(ret) : "c"(index));
  74     return ret;
  75 }
  76
  77 static inline void wrmsr(u32 index, u64 val)
  78 {
  79     asm volatile ("wrmsr" : : "c"(index), "A"(val));
  80 }
  81
  82 static inline u64 rdtscll(void)
  83 {
  84     u64 val;
  85     asm volatile("rdtsc" : "=A" (val));
  86     return val;
  87 }
  88
  89 static inline u32 __ffs(u32 word)
  90 {
  91     asm("bsf %1,%0"
  92         : "=r" (word)
  93         : "rm" (word));
  94     return word;
  95 }
  96 static inline u32 __fls(u32 word)
  97 {
  98     asm("bsr %1,%0"
  99         : "=r" (word)
 100         : "rm" (word));
 101     return word;
 102 }
 103
 104 static inline void writel(void *addr, u32 val) {
 105     *(volatile u32 *)addr = val;
 106 }
 107 static inline void writew(void *addr, u16 val) {
 108     *(volatile u16 *)addr = val;
 109 }
 110 static inline void writeb(void *addr, u8 val) {
 111     *(volatile u8 *)addr = val;
 112 }
 113 static inline u32 readl(const void *addr) {
 114     return *(volatile const u32 *)addr;
 115 }
 116 static inline u16 readw(const void *addr) {
 117     return *(volatile const u16 *)addr;
 118 }
 119 static inline u8 readb(const void *addr) {
 120     return *(volatile const u8 *)addr;
 121 }
 122
 123 // GDT bit manipulation
 124 #define GDT_BASE(v)  ((((u64)(v) & 0xff000000) << 32)           \
 125                       | (((u64)(v) & 0x00ffffff) << 16))
 126 #define GDT_LIMIT(v) ((((u64)(v) & 0x000f0000) << 32)   \
 127                       | (((u64)(v) & 0x0000ffff) << 0))
 128 #define GDT_CODE     (0x9bULL << 40) // Code segment - P,R,A bits also set
 129 #define GDT_DATA     (0x93ULL << 40) // Data segment - W,A bits also set
 130 #define GDT_B        (0x1ULL << 54)  // Big flag
 131 #define GDT_G        (0x1ULL << 55)  // Granularity flag
 132
 133 #define call16_simpint(nr, peax, pflags) do {                           \
 134         ASSERT16();                                                     \
 135         asm volatile(                                                   \
 136             "stc\n"                                                     \
 137             "int %2\n"                                                  \
 138             "pushfl\n"                                                  \
 139             "popl %1\n"                                                 \
 140             "cli\n"                                                     \
 141             "cld"                                                       \
 142             : "+a"(*peax), "=r"(*pflags)                                \
 143             : "i"(nr)                                                   \
 144             : "cc", "memory");                                          \
 145     } while (0)
 146
 147 // util.c
 148 inline u32 stack_hop(u32 eax, u32 edx, u32 ecx, void *func);
 149 extern struct thread_info MainThread;
 150 struct thread_info *getCurThread();
 151 void run_thread(void (*func)(void*), void *data);
 152 void wait_threads();
 153 u8 checksum_far(u16 buf_seg, void *buf_far, u32 len);
 154 u8 checksum(void *buf, u32 len);
 155 int memcmp(const void *s1, const void *s2, size_t n);
 156 size_t strlen(const char *s);
 157 int strcmp(const char *s1, const char *s2);
 158 inline void memset_far(u16 d_seg, void *d_far, u8 c, size_t len);
 159 inline void memset16_far(u16 d_seg, void *d_far, u16 c, size_t len);
 160 void *memset(void *s, int c, size_t n);
 161 void *memcpy(void *d1, const void *s1, size_t len);
 162 #if MODE16 == 0
 163 #define memcpy __builtin_memcpy
 164 #endif
 165 inline void memcpy_far(u16 d_seg, void *d_far
 166                        , u16 s_seg, const void *s_far, size_t len);
 167 void *memmove(void *d, const void *s, size_t len);
 168 char *strtcpy(char *dest, const char *src, size_t len);
 169 struct bregs;
 170 inline void call16(struct bregs *callregs);
 171 inline void call16big(struct bregs *callregs);
 172 inline void __call16_int(struct bregs *callregs, u16 offset);
 173 #define call16_int(nr, callregs) do {                           \
 174         extern void irq_trampoline_ ##nr ();                    \
 175         __call16_int((callregs), (u32)&irq_trampoline_ ##nr );  \
 176     } while (0)
 177 void yield();
 178 void biosusleep(u32 usec);
 179 int get_keystroke(int msec);
 180
 181 // output.c
 182 void debug_serial_setup();
 183 void panic(const char *fmt, ...)
 184     __attribute__ ((format (printf, 1, 2)))
 185     __attribute__ ((noreturn));
 186 void printf(const char *fmt, ...)
 187     __attribute__ ((format (printf, 1, 2)));
 188 void __dprintf(const char *fmt, ...)
 189     __attribute__ ((format (printf, 1, 2)));
 190 void snprintf(char *str, size_t size, const char *fmt, ...)
 191     __attribute__ ((format (printf, 3, 4)));
 192 #define dprintf(lvl, fmt, args...) do {                         \
 193         if (CONFIG_DEBUG_LEVEL && (lvl) <= CONFIG_DEBUG_LEVEL)  \
 194             __dprintf((fmt) , ##args );                         \
 195     } while (0)
 196 void __debug_enter(struct bregs *regs, const char *fname);
 197 void __debug_stub(struct bregs *regs, int lineno, const char *fname);
 198 void __debug_isr(const char *fname);
 199 #define debug_enter(regs, lvl) do {                     \
 200         if ((lvl) && (lvl) <= CONFIG_DEBUG_LEVEL)       \
 201             __debug_enter((regs), __func__);            \
 202     } while (0)
 203 #define debug_isr(lvl) do {                             \
 204         if ((lvl) && (lvl) <= CONFIG_DEBUG_LEVEL)       \
 205             __debug_isr(__func__);                      \
 206     } while (0)
 207 #define debug_stub(regs)                        \
 208     __debug_stub((regs), __LINE__, __func__)
 209 void hexdump(const void *d, int len);
 210
 211 // kbd.c
 212 void kbd_setup();
 213 void handle_15c2(struct bregs *regs);
 214 void process_key(u8 key);
 215
 216 // mouse.c
 217 void mouse_setup();
 218
 219 // system.c
 220 extern u32 RamSize;
 221 extern u64 RamSizeOver4G;
 222 void mathcp_setup();
 223
 224 // serial.c
 225 void serial_setup();
 226 void lpt_setup();
 227
 228 // clock.c
 229 static inline int check_time(u64 end) {
 230     return (s64)(rdtscll() - end) > 0;
 231 }
 232 void timer_setup();
 233 void ndelay(u32 count);
 234 void udelay(u32 count);
 235 void mdelay(u32 count);
 236 void nsleep(u32 count);
 237 void usleep(u32 count);
 238 void msleep(u32 count);
 239 u64 calc_future_tsc(u32 msecs);
 240 u64 calc_future_tsc_usec(u32 usecs);
 241 void handle_1583(struct bregs *regs);
 242 void handle_1586(struct bregs *regs);
 243
 244 // apm.c
 245 void VISIBLE16 handle_1553(struct bregs *regs);
 246
 247 // pcibios.c
 248 void handle_1ab1(struct bregs *regs);
 249
 250 // shadow.c
 251 void make_bios_writable();
 252 void make_bios_readonly();
 253
 254 // pciinit.c
 255 void pci_setup(void);
 256
 257 // smm.c
 258 void smm_init();
 259
 260 // smp.c
 261 extern u32 CountCPUs;
 262 extern u32 MaxCountCPUs;
 263 void wrmsr_smp(u32 index, u64 val);
 264 void smp_probe(void);
 265 void smp_probe_setup(void);
 266
 267 // coreboot.c
 268 struct cbfs_file;
 269 struct cbfs_file *cbfs_findprefix(const char *prefix, struct cbfs_file *last);
 270 u32 cbfs_datasize(struct cbfs_file *file);
 271 const char *cbfs_filename(struct cbfs_file *file);
 272 int cbfs_copyfile(struct cbfs_file *file, void *dst, u32 maxlen);
 273 int cbfs_copy_optionrom(void *dst, u32 maxlen, u32 vendev);
 274 void cbfs_run_payload(struct cbfs_file *file);
 275
 276 void coreboot_copy_biostable();
 277 void coreboot_setup();
 278
 279 // vgahooks.c
 280 extern int VGAbdf;
 281 void handle_155f();
 282 void vgahook_setup(const char *vendor, const char *part);
 283
 284 // optionroms.c
 285 void call_bcv(u16 seg, u16 ip);
 286 void optionrom_setup();
 287 void vga_setup();
 288 void s3_resume_vga_init();
 289 extern u32 RomEnd;
 290
 291 // resume.c
 292 void init_dma();
 293
 294 // pnpbios.c
 295 #define PNP_SIGNATURE 0x506e5024 // $PnP
 296 u16 get_pnp_offset();
 297 void pnp_setup();
 298
 299 // pmm.c
 300 extern struct zone_s ZoneLow, ZoneHigh, ZoneFSeg, ZoneTmpLow, ZoneTmpHigh;
 301 void malloc_setup();
 302 void malloc_finalize();
 303 void *pmm_malloc(struct zone_s *zone, u32 handle, u32 size, u32 align);
 304 int pmm_free(void *data);
 305 void pmm_setup();
 306 void pmm_finalize();
 307 #define PMM_DEFAULT_HANDLE 0xFFFFFFFF
 308 // Minimum alignment of malloc'd memory
 309 #define MALLOC_MIN_ALIGN 16
 310 // Helper functions for memory allocation.
 311 static inline void *malloc_low(u32 size) {
 312     return pmm_malloc(&ZoneLow, PMM_DEFAULT_HANDLE, size, MALLOC_MIN_ALIGN);
 313 }
 314 static inline void *malloc_high(u32 size) {
 315     return pmm_malloc(&ZoneHigh, PMM_DEFAULT_HANDLE, size, MALLOC_MIN_ALIGN);
 316 }
 317 static inline void *malloc_fseg(u32 size) {
 318     return pmm_malloc(&ZoneFSeg, PMM_DEFAULT_HANDLE, size, MALLOC_MIN_ALIGN);
 319 }
 320 static inline void *malloc_tmphigh(u32 size) {
 321     return pmm_malloc(&ZoneTmpHigh, PMM_DEFAULT_HANDLE, size, MALLOC_MIN_ALIGN);
 322 }
 323 static inline void *memalign_low(u32 align, u32 size) {
 324     return pmm_malloc(&ZoneLow, PMM_DEFAULT_HANDLE, size, align);
 325 }
 326 static inline void *memalign_high(u32 align, u32 size) {
 327     return pmm_malloc(&ZoneHigh, PMM_DEFAULT_HANDLE, size, align);
 328 }
 329 static inline void *memalign_tmphigh(u32 align, u32 size) {
 330     return pmm_malloc(&ZoneTmpHigh, PMM_DEFAULT_HANDLE, size, align);
 331 }
 332 static inline void free(void *data) {
 333     pmm_free(data);
 334 }
 335
 336 // mtrr.c
 337 void mtrr_setup(void);
 338
 339 // romlayout.S
 340 void reset_vector() __attribute__ ((noreturn));
 341
 342 // misc.c
 343 extern u8 BiosChecksum;
 344
 345 // version (auto generated file out/version.c)
 346 extern const char VERSION[];
 347
 348 #endif // util.h