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