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 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 static inline void nop(void)
  40 {
  41     asm volatile("nop");
  42 }
  43
  44 static inline void hlt(void)
  45 {
  46     asm volatile("hlt");
  47 }
  48
  49 static inline void wbinvd(void)
  50 {
  51     asm volatile("wbinvd");
  52 }
  53
  54 static inline void cpuid(u32 index, u32 *eax, u32 *ebx, u32 *ecx, u32 *edx)
  55 {
  56     asm("cpuid"
  57         : "=a" (*eax), "=b" (*ebx), "=c" (*ecx), "=d" (*edx)
  58         : "0" (index));
  59 }
  60
  61 static inline u64 rdtscll(void)
  62 {
  63     u64 val;
  64     asm volatile("rdtsc" : "=A" (val));
  65     return val;
  66 }
  67
  68 // util.c
  69 inline u32 stack_hop(u32 eax, u32 edx, u32 ecx, void *func);
  70 u8 checksum_far(u16 buf_seg, void *buf_far, u32 len);
  71 u8 checksum(void *buf, u32 len);
  72 int memcmp(const void *s1, const void *s2, size_t n);
  73 size_t strlen(const char *s);
  74 int strcmp(const char *s1, const char *s2);
  75 void *memset(void *s, int c, size_t n);
  76 void *memcpy(void *d1, const void *s1, size_t len);
  77 inline void memcpy_far(u16 d_seg, void *d_far
  78                        , u16 s_seg, const void *s_far, size_t len);
  79 void *memmove(void *d, const void *s, size_t len);
  80 char *strtcpy(char *dest, const char *src, size_t len);
  81 struct bregs;
  82 inline void call16(struct bregs *callregs);
  83 inline void call16big(struct bregs *callregs);
  84 inline void __call16_int(struct bregs *callregs, u16 offset);
  85 #define call16_int(nr, callregs) do {                           \
  86         extern void irq_trampoline_ ##nr ();                    \
  87         __call16_int((callregs), (u32)&irq_trampoline_ ##nr );  \
  88     } while (0)
  89 inline void call16_simpint(int nr, u32 *eax, u32 *flags);
  90 void usleep(u32 usec);
  91 int get_keystroke(int msec);
  92
  93 // output.c
  94 void debug_serial_setup();
  95 void panic(const char *fmt, ...)
  96     __attribute__ ((format (printf, 1, 2)))
  97     __attribute__ ((noreturn));
  98 void printf(const char *fmt, ...)
  99     __attribute__ ((format (printf, 1, 2)));
 100 void __dprintf(const char *fmt, ...)
 101     __attribute__ ((format (printf, 1, 2)));
 102 #define dprintf(lvl, fmt, args...) do {                         \
 103         if (CONFIG_DEBUG_LEVEL && (lvl) <= CONFIG_DEBUG_LEVEL)  \
 104             __dprintf((fmt) , ##args );                         \
 105     } while (0)
 106 void __debug_enter(struct bregs *regs, const char *fname);
 107 void __debug_stub(struct bregs *regs, int lineno, const char *fname);
 108 void __debug_isr(const char *fname);
 109 #define debug_enter(regs, lvl) do {                     \
 110         if ((lvl) && (lvl) <= CONFIG_DEBUG_LEVEL)       \
 111             __debug_enter((regs), __func__);            \
 112     } while (0)
 113 #define debug_isr(lvl) do {                             \
 114         if ((lvl) && (lvl) <= CONFIG_DEBUG_LEVEL)       \
 115             __debug_isr(__func__);                      \
 116     } while (0)
 117 #define debug_stub(regs)                        \
 118     __debug_stub((regs), __LINE__, __func__)
 119 void hexdump(void *d, int len);
 120
 121 // kbd.c
 122 void kbd_setup();
 123 void handle_15c2(struct bregs *regs);
 124
 125 // mouse.c
 126 void mouse_setup();
 127
 128 // system.c
 129 extern u32 RamSize;
 130 extern u64 RamSizeOver4G;
 131 void mathcp_setup();
 132
 133 // serial.c
 134 void serial_setup();
 135 void lpt_setup();
 136
 137 // clock.c
 138 void timer_setup();
 139 void ndelay(u32 count);
 140 void udelay(u32 count);
 141 void mdelay(u32 count);
 142 u64 calc_future_tsc(u32 msecs);
 143 void handle_1583(struct bregs *regs);
 144 void handle_1586(struct bregs *regs);
 145
 146 // apm.c
 147 void VISIBLE16 handle_1553(struct bregs *regs);
 148
 149 // pcibios.c
 150 void handle_1ab1(struct bregs *regs);
 151
 152 // shadow.c
 153 void make_bios_writable();
 154 void make_bios_readonly();
 155
 156 // pciinit.c
 157 void pci_bios_setup(void);
 158
 159 // smm.c
 160 void smm_init();
 161
 162 // smpdetect.c
 163 int smp_probe(void);
 164 void smp_probe_setup(void);
 165
 166 // smbios.c
 167 void smbios_init(void);
 168
 169 // coreboot.c
 170 const char *cbfs_findNprefix(const char *prefix, int n);
 171 void *cb_find_optionrom(u32 vendev);
 172 void cbfs_run_payload(const char *filename);
 173 void coreboot_setup();
 174
 175 // vgahooks.c
 176 void handle_155f();
 177
 178 // optionroms.c
 179 void call_bcv(u16 seg, u16 ip);
 180 void vga_setup();
 181 void optionrom_setup();
 182
 183 // resume.c
 184 void init_dma();
 185
 186 // pnpbios.c
 187 #define PNP_SIGNATURE 0x506e5024 // $PnP
 188 u16 get_pnp_offset();
 189 void pnp_setup();
 190
 191 // mtrr.c
 192 void mtrr_setup(void);
 193
 194 // romlayout.S
 195 void reset_vector() __attribute__ ((noreturn));
 196
 197 // misc.c
 198 extern u8 BiosChecksum;
 199
 200 #endif // util.h