Halt machine on call to BX_PANIC.
[people/mcb30/legacybios.git] / 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 nop(void)
36 {
37     asm volatile("nop");
38 }
39
40 static inline void hlt(void)
41 {
42     asm volatile("hlt");
43 }
44
45 // XXX - move this to a c file and use PANIC PORT.
46 #define BX_PANIC(fmt, args...) do { \
47         bprintf(0, fmt , ##args);   \
48         for (;;)                    \
49             hlt();                  \
50     } while (0)
51
52 #define BX_INFO(fmt, args...) bprintf(0, fmt , ##args)
53
54 static inline void
55 memset(void *s, int c, size_t n)
56 {
57     while (n)
58         ((char *)s)[--n] = c;
59 }
60
61 static inline void *
62 memcpy(void *d1, const void *s1, size_t len)
63 {
64     u8 *d = d1;
65     const u8 *s = s1;
66
67     while (len--) {
68         *d++ = *s++;
69     }
70     return d1;
71 }
72
73 static inline void
74 eoi_master_pic()
75 {
76     outb(PIC1_IRQ5, PORT_PIC1);
77 }
78
79 static inline void
80 eoi_both_pics()
81 {
82     outb(PIC2_IRQ13, PORT_PIC2);
83     eoi_master_pic();
84 }
85
86 static inline
87 void call16(struct bregs *callregs)
88 {
89     asm volatile(
90         "pushl %%ebp\n" // Save state
91         "pushfl\n"
92 #ifdef MODE16
93         "calll __call16\n"
94 #else
95         "calll __call16_from32\n"
96 #endif
97         "popfl\n"       // Restore state
98         "popl %%ebp\n"
99         : "+a" (callregs), "+m" (*callregs)
100         :
101         : "ebx", "ecx", "edx", "esi", "edi");
102 }
103
104 static inline
105 void __call16_int(struct bregs *callregs, u16 offset)
106 {
107     callregs->cs = SEG_BIOS;
108     callregs->ip = offset;
109     call16(callregs);
110 }
111
112 #ifdef MODE16
113 #define call16_int(nr, callregs) do {                           \
114         extern void irq_trampoline_ ##nr ();                    \
115         __call16_int((callregs), (u16)&irq_trampoline_ ##nr );  \
116     } while (0)
117 #else
118 #include "../out/rom16.offset.auto.h"
119 #define call16_int(nr, callregs)                                \
120     __call16_int((callregs), OFFSET_irq_trampoline_ ##nr )
121 #endif
122
123 // output.c
124 void bprintf(u16 action, const char *fmt, ...)
125     __attribute__ ((format (printf, 2, 3)));
126 void __debug_enter(const char *fname, struct bregs *regs);
127 void __debug_fail(const char *fname, struct bregs *regs);
128 void __debug_stub(const char *fname, struct bregs *regs);
129 void __debug_isr(const char *fname);
130 #define debug_enter(regs) \
131     __debug_enter(__func__, regs)
132 #define debug_stub(regs) \
133     __debug_stub(__func__, regs)
134 #define debug_isr(regs) \
135     __debug_isr(__func__)
136 #define printf(fmt, args...)                     \
137     bprintf(1, fmt , ##args )
138
139 // Frequently used return codes
140 #define RET_EUNSUPPORTED 0x86
141 static inline void
142 set_success(struct bregs *regs)
143 {
144     set_cf(regs, 0);
145 }
146
147 static inline void
148 set_code_success(struct bregs *regs)
149 {
150     regs->ah = 0;
151     set_cf(regs, 0);
152 }
153
154 #define set_fail(regs) do {                     \
155         __debug_fail(__func__, (regs));         \
156         set_cf((regs), 1);                      \
157     } while (0)
158
159 #define set_code_fail(regs, code) do {          \
160         set_fail(regs);                         \
161         (regs)->ah = (code);                    \
162     } while (0)
163
164 // kbd.c
165 void handle_15c2(struct bregs *regs);
166
167 // clock.c
168 void handle_1583(struct bregs *regs);
169
170 // apm.c
171 void VISIBLE16 handle_1553(struct bregs *regs);
172
173 // util.c
174 void usleep(u32 count);
175
176 // rombios32.c
177 void rombios32_init(void);
178
179 #endif // util.h