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 void *memset(void *s, int c, size_t n);
  56 void *memcpy(void *d1, const void *s1, size_t len);
  57
  58 static inline void
  59 eoi_master_pic()
  60 {
  61     outb(PIC1_IRQ5, PORT_PIC1);
  62 }
  63
  64 static inline void
  65 eoi_both_pics()
  66 {
  67     outb(PIC2_IRQ13, PORT_PIC2);
  68     eoi_master_pic();
  69 }
  70
  71 // Call a function with a specified register state.  Note that on
  72 // return, the interrupt enable/disable flag may be altered.
  73 static inline
  74 void call16(struct bregs *callregs)
  75 {
  76     asm volatile(
  77 #ifdef MODE16
  78         "calll __call16\n"
  79 #else
  80         "calll __call16_from32\n"
  81 #endif
  82         : "+a" (callregs), "+m" (*callregs)
  83         :
  84         : "ebx", "ecx", "edx", "esi", "edi", "ebp", "cc");
  85 }
  86
  87 static inline
  88 void __call16_int(struct bregs *callregs, u16 offset)
  89 {
  90     callregs->cs = SEG_BIOS;
  91     callregs->ip = offset;
  92     call16(callregs);
  93 }
  94
  95 #ifdef MODE16
  96 #define call16_int(nr, callregs) do {                           \
  97         extern void irq_trampoline_ ##nr ();                    \
  98         __call16_int((callregs), (u32)&irq_trampoline_ ##nr );  \
  99     } while (0)
 100 #else
 101 #include "../out/rom16.offset.auto.h"
 102 #define call16_int(nr, callregs)                                \
 103     __call16_int((callregs), OFFSET_irq_trampoline_ ##nr )
 104 #endif
 105
 106 // output.c
 107 void BX_PANIC(const char *fmt, ...)
 108     __attribute__ ((format (printf, 1, 2)))
 109     __attribute__ ((noreturn));
 110 void printf(const char *fmt, ...)
 111     __attribute__ ((format (printf, 1, 2)));
 112 void __dprintf(const char *fmt, ...)
 113     __attribute__ ((format (printf, 1, 2)));
 114 #define dprintf(lvl, fmt, args...) do {                         \
 115         if (CONFIG_DEBUG_LEVEL && (lvl) <= CONFIG_DEBUG_LEVEL)  \
 116             __dprintf((fmt) , ##args );                         \
 117     } while (0)
 118 void __debug_enter(const char *fname, struct bregs *regs);
 119 void __debug_fail(const char *fname, struct bregs *regs);
 120 void __debug_stub(const char *fname, struct bregs *regs);
 121 void __debug_isr(const char *fname);
 122 #define debug_enter(regs) \
 123     __debug_enter(__func__, regs)
 124 #define debug_stub(regs) \
 125     __debug_stub(__func__, regs)
 126 #define debug_isr(regs) \
 127     __debug_isr(__func__)
 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 // serial.c
 169 void serial_setup();
 170 void lpt_setup();
 171
 172 // clock.c
 173 void timer_setup();
 174 int usleep(u32 count);
 175 void handle_1583(struct bregs *regs);
 176 void handle_1586(struct bregs *regs);
 177
 178 // apm.c
 179 void VISIBLE16 handle_1553(struct bregs *regs);
 180
 181 // pcibios.c
 182 void handle_1ab1(struct bregs *regs);
 183
 184 // util.c
 185 u8 checksum(u8 *far_data, u32 len);
 186
 187 // shadow.c
 188 void make_bios_writable();
 189 void make_bios_readonly();
 190
 191 // rombios32.c
 192 void rombios32_init(void);
 193
 194 // boot.c
 195 void printf_bootdev(u16 bootdev);
 196
 197 // post_menu.c
 198 void interactive_bootmenu();
 199
 200 #endif // util.h