src/util.h

   1 // Basic x86 asm functions and function defs.
   2 //
   3 // Copyright (C) 2008  Kevin O'Connor <kevin@koconnor.net>
   4 //
   5 // This file may be distributed under the terms of the GNU GPLv3 license.
   6 #ifndef __UTIL_H
   7 #define __UTIL_H
   8
   9 #include "ioport.h" // outb
  10 #include "biosvar.h" // struct bregs
  11
  12 static inline void irq_disable(void)
  13 {
  14     asm volatile("cli": : :"memory");
  15 }
  16
  17 static inline void irq_enable(void)
  18 {
  19     asm volatile("sti": : :"memory");
  20 }
  21
  22 static inline unsigned long irq_save(void)
  23 {
  24     unsigned long flags;
  25     asm volatile("pushfl ; popl %0" : "=g" (flags));
  26     irq_disable();
  27     return flags;
  28 }
  29
  30 static inline void irq_restore(unsigned long flags)
  31 {
  32     asm volatile("pushl %0 ; popfl" : : "g" (flags) : "memory", "cc");
  33 }
  34
  35 static inline void cpu_relax(void)
  36 {
  37     asm volatile("rep ; nop": : :"memory");
  38 }
  39
  40 static inline void nop(void)
  41 {
  42     asm volatile("nop");
  43 }
  44
  45 static inline void hlt(void)
  46 {
  47     asm volatile("hlt");
  48 }
  49
  50 static inline void wbinvd(void)
  51 {
  52     asm volatile("wbinvd");
  53 }
  54
  55 static inline void cpuid(u32 index, u32 *eax, u32 *ebx, u32 *ecx, u32 *edx)
  56 {
  57     asm("cpuid"
  58         : "=a" (*eax), "=b" (*ebx), "=c" (*ecx), "=d" (*edx)
  59         : "0" (index));
  60 }
  61
  62 void *memset(void *s, int c, size_t n);
  63 void *memcpy(void *d1, const void *s1, size_t len);
  64 void *memmove(void *d, const void *s, size_t len);
  65
  66 // Call a function with a specified register state.  Note that on
  67 // return, the interrupt enable/disable flag may be altered.
  68 static inline
  69 void call16(struct bregs *callregs)
  70 {
  71     asm volatile(
  72 #ifdef MODE16
  73         "calll __call16\n"
  74 #else
  75         "calll __call16_from32\n"
  76 #endif
  77         : "+a" (callregs), "+m" (*callregs)
  78         :
  79         : "ebx", "ecx", "edx", "esi", "edi", "ebp", "cc");
  80 }
  81
  82 static inline
  83 void __call16_int(struct bregs *callregs, u16 offset)
  84 {
  85     callregs->cs = SEG_BIOS;
  86     callregs->ip = offset;
  87     call16(callregs);
  88 }
  89
  90 #ifdef MODE16
  91 #define call16_int(nr, callregs) do {                           \
  92         extern void irq_trampoline_ ##nr ();                    \
  93         __call16_int((callregs), (u32)&irq_trampoline_ ##nr );  \
  94     } while (0)
  95 #else
  96 #include "../out/rom16.offset.auto.h"
  97 #define call16_int(nr, callregs)                                \
  98     __call16_int((callregs), OFFSET_irq_trampoline_ ##nr )
  99 #endif
 100
 101 // output.c
 102 void debug_serial_setup();
 103 void BX_PANIC(const char *fmt, ...)
 104     __attribute__ ((format (printf, 1, 2)))
 105     __attribute__ ((noreturn));
 106 void printf(const char *fmt, ...)
 107     __attribute__ ((format (printf, 1, 2)));
 108 void __dprintf(const char *fmt, ...)
 109     __attribute__ ((format (printf, 1, 2)));
 110 #define dprintf(lvl, fmt, args...) do {                         \
 111         if (CONFIG_DEBUG_LEVEL && (lvl) <= CONFIG_DEBUG_LEVEL)  \
 112             __dprintf((fmt) , ##args );                         \
 113     } while (0)
 114 void __debug_enter(const char *fname, struct bregs *regs);
 115 void __debug_fail(const char *fname, struct bregs *regs);
 116 void __debug_stub(const char *fname, struct bregs *regs);
 117 void __debug_isr(const char *fname);
 118 #define debug_enter(regs, lvl) do {                     \
 119         if ((lvl) && (lvl) <= CONFIG_DEBUG_LEVEL)       \
 120             __debug_enter(__func__, regs);              \
 121     } while (0)
 122 #define debug_isr(lvl) do {                             \
 123         if ((lvl) && (lvl) <= CONFIG_DEBUG_LEVEL)       \
 124             __debug_isr(__func__);                      \
 125     } while (0)
 126 #define debug_stub(regs) \
 127     __debug_stub(__func__, regs)
 128
 129 // Frequently used return codes
 130 #define RET_EUNSUPPORTED 0x86
 131 static inline void
 132 set_success(struct bregs *regs)
 133 {
 134     set_cf(regs, 0);
 135 }
 136
 137 static inline void
 138 set_code_success(struct bregs *regs)
 139 {
 140     regs->ah = 0;
 141     set_cf(regs, 0);
 142 }
 143
 144 static inline void
 145 set_fail_silent(struct bregs *regs)
 146 {
 147     set_cf(regs, 1);
 148 }
 149
 150 static inline void
 151 set_code_fail_silent(struct bregs *regs, u8 code)
 152 {
 153     regs->ah = code;
 154     set_cf(regs, 1);
 155 }
 156
 157 void __set_fail(const char *fname, struct bregs *regs);
 158 void __set_code_fail(const char *fname, struct bregs *regs, u8 code);
 159
 160 #define set_fail(regs) \
 161     __set_fail(__func__, (regs))
 162 #define set_code_fail(regs, code)               \
 163     __set_code_fail(__func__, (regs), (code))
 164
 165 // kbd.c
 166 void handle_15c2(struct bregs *regs);
 167
 168 // mouse.c
 169 void mouse_setup();
 170
 171 // system.c
 172 void mathcp_setup();
 173
 174 // serial.c
 175 void serial_setup();
 176 void lpt_setup();
 177
 178 // clock.c
 179 void timer_setup();
 180 int usleep(u32 count);
 181 void handle_1583(struct bregs *regs);
 182 void handle_1586(struct bregs *regs);
 183
 184 // apm.c
 185 void VISIBLE16 handle_1553(struct bregs *regs);
 186
 187 // pcibios.c
 188 void handle_1ab1(struct bregs *regs);
 189
 190 // util.c
 191 u8 checksum(u8 *far_data, u32 len);
 192
 193 // shadow.c
 194 void make_bios_writable();
 195 void make_bios_readonly();
 196
 197 // pciinit.c
 198 void pci_bios_setup(void);
 199
 200 // smm.c
 201 void smm_init();
 202
 203 // smpdetect.c
 204 int smp_probe(void);
 205
 206 // mptable.c
 207 void mptable_init(void);
 208
 209 // smbios.c
 210 void smbios_init(void);
 211
 212 // boot.c
 213 void printf_bootdev(u16 bootdev);
 214
 215 // post_menu.c
 216 void interactive_bootmenu();
 217
 218 // coreboot.c
 219 void coreboot_fill_map();
 220
 221 #endif // util.h