1 /* -*- linux-c -*- ------------------------------------------------------- *
2 *
3 * Copyright (C) 1991, 1992 Linus Torvalds
4 * Copyright 2007 rPath, Inc. - All Rights Reserved
5 * Copyright 2009 Intel Corporation; author H. Peter Anvin
6 *
7 * This file is part of the Linux kernel, and is made available under
8 * the terms of the GNU General Public License version 2.
9 *
10 * ----------------------------------------------------------------------- */
11
12 /*
13 * Header file for the real-mode kernel code
14 */
15
16 #ifndef BOOT_BOOT_H
17 #define BOOT_BOOT_H
18
19 #define STACK_SIZE 1024 /* Minimum number of bytes for stack */
20
21 #ifndef __ASSEMBLY__
22
23 #include <stdarg.h>
24 #include <linux/types.h>
25 #include <linux/edd.h>
26 #include <asm/setup.h>
27 #include "bitops.h"
28 #include "ctype.h"
29 #include "cpuflags.h"
30
31 /* Useful macros */
32 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
33
34 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(*(x)))
35
36 extern struct setup_header hdr;
37 extern struct boot_params boot_params;
38
39 #define cpu_relax() asm volatile("rep; nop")
40
41 /* Basic port I/O */
outb(u8 v,u16 port)42 static inline void outb(u8 v, u16 port)
43 {
44 asm volatile("outb %0,%1" : : "a" (v), "dN" (port));
45 }
inb(u16 port)46 static inline u8 inb(u16 port)
47 {
48 u8 v;
49 asm volatile("inb %1,%0" : "=a" (v) : "dN" (port));
50 return v;
51 }
52
outw(u16 v,u16 port)53 static inline void outw(u16 v, u16 port)
54 {
55 asm volatile("outw %0,%1" : : "a" (v), "dN" (port));
56 }
inw(u16 port)57 static inline u16 inw(u16 port)
58 {
59 u16 v;
60 asm volatile("inw %1,%0" : "=a" (v) : "dN" (port));
61 return v;
62 }
63
outl(u32 v,u16 port)64 static inline void outl(u32 v, u16 port)
65 {
66 asm volatile("outl %0,%1" : : "a" (v), "dN" (port));
67 }
inl(u16 port)68 static inline u32 inl(u16 port)
69 {
70 u32 v;
71 asm volatile("inl %1,%0" : "=a" (v) : "dN" (port));
72 return v;
73 }
74
io_delay(void)75 static inline void io_delay(void)
76 {
77 const u16 DELAY_PORT = 0x80;
78 asm volatile("outb %%al,%0" : : "dN" (DELAY_PORT));
79 }
80
81 /* These functions are used to reference data in other segments. */
82
ds(void)83 static inline u16 ds(void)
84 {
85 u16 seg;
86 asm("movw %%ds,%0" : "=rm" (seg));
87 return seg;
88 }
89
set_fs(u16 seg)90 static inline void set_fs(u16 seg)
91 {
92 asm volatile("movw %0,%%fs" : : "rm" (seg));
93 }
fs(void)94 static inline u16 fs(void)
95 {
96 u16 seg;
97 asm volatile("movw %%fs,%0" : "=rm" (seg));
98 return seg;
99 }
100
set_gs(u16 seg)101 static inline void set_gs(u16 seg)
102 {
103 asm volatile("movw %0,%%gs" : : "rm" (seg));
104 }
gs(void)105 static inline u16 gs(void)
106 {
107 u16 seg;
108 asm volatile("movw %%gs,%0" : "=rm" (seg));
109 return seg;
110 }
111
112 typedef unsigned int addr_t;
113
rdfs8(addr_t addr)114 static inline u8 rdfs8(addr_t addr)
115 {
116 u8 v;
117 asm volatile("movb %%fs:%1,%0" : "=q" (v) : "m" (*(u8 *)addr));
118 return v;
119 }
rdfs16(addr_t addr)120 static inline u16 rdfs16(addr_t addr)
121 {
122 u16 v;
123 asm volatile("movw %%fs:%1,%0" : "=r" (v) : "m" (*(u16 *)addr));
124 return v;
125 }
rdfs32(addr_t addr)126 static inline u32 rdfs32(addr_t addr)
127 {
128 u32 v;
129 asm volatile("movl %%fs:%1,%0" : "=r" (v) : "m" (*(u32 *)addr));
130 return v;
131 }
132
wrfs8(u8 v,addr_t addr)133 static inline void wrfs8(u8 v, addr_t addr)
134 {
135 asm volatile("movb %1,%%fs:%0" : "+m" (*(u8 *)addr) : "qi" (v));
136 }
wrfs16(u16 v,addr_t addr)137 static inline void wrfs16(u16 v, addr_t addr)
138 {
139 asm volatile("movw %1,%%fs:%0" : "+m" (*(u16 *)addr) : "ri" (v));
140 }
wrfs32(u32 v,addr_t addr)141 static inline void wrfs32(u32 v, addr_t addr)
142 {
143 asm volatile("movl %1,%%fs:%0" : "+m" (*(u32 *)addr) : "ri" (v));
144 }
145
rdgs8(addr_t addr)146 static inline u8 rdgs8(addr_t addr)
147 {
148 u8 v;
149 asm volatile("movb %%gs:%1,%0" : "=q" (v) : "m" (*(u8 *)addr));
150 return v;
151 }
rdgs16(addr_t addr)152 static inline u16 rdgs16(addr_t addr)
153 {
154 u16 v;
155 asm volatile("movw %%gs:%1,%0" : "=r" (v) : "m" (*(u16 *)addr));
156 return v;
157 }
rdgs32(addr_t addr)158 static inline u32 rdgs32(addr_t addr)
159 {
160 u32 v;
161 asm volatile("movl %%gs:%1,%0" : "=r" (v) : "m" (*(u32 *)addr));
162 return v;
163 }
164
wrgs8(u8 v,addr_t addr)165 static inline void wrgs8(u8 v, addr_t addr)
166 {
167 asm volatile("movb %1,%%gs:%0" : "+m" (*(u8 *)addr) : "qi" (v));
168 }
wrgs16(u16 v,addr_t addr)169 static inline void wrgs16(u16 v, addr_t addr)
170 {
171 asm volatile("movw %1,%%gs:%0" : "+m" (*(u16 *)addr) : "ri" (v));
172 }
wrgs32(u32 v,addr_t addr)173 static inline void wrgs32(u32 v, addr_t addr)
174 {
175 asm volatile("movl %1,%%gs:%0" : "+m" (*(u32 *)addr) : "ri" (v));
176 }
177
178 /* Note: these only return true/false, not a signed return value! */
memcmp_fs(const void * s1,addr_t s2,size_t len)179 static inline int memcmp_fs(const void *s1, addr_t s2, size_t len)
180 {
181 u8 diff;
182 asm volatile("fs; repe; cmpsb; setnz %0"
183 : "=qm" (diff), "+D" (s1), "+S" (s2), "+c" (len));
184 return diff;
185 }
memcmp_gs(const void * s1,addr_t s2,size_t len)186 static inline int memcmp_gs(const void *s1, addr_t s2, size_t len)
187 {
188 u8 diff;
189 asm volatile("gs; repe; cmpsb; setnz %0"
190 : "=qm" (diff), "+D" (s1), "+S" (s2), "+c" (len));
191 return diff;
192 }
193
194 /* Heap -- available for dynamic lists. */
195 extern char _end[];
196 extern char *HEAP;
197 extern char *heap_end;
198 #define RESET_HEAP() ((void *)( HEAP = _end ))
__get_heap(size_t s,size_t a,size_t n)199 static inline char *__get_heap(size_t s, size_t a, size_t n)
200 {
201 char *tmp;
202
203 HEAP = (char *)(((size_t)HEAP+(a-1)) & ~(a-1));
204 tmp = HEAP;
205 HEAP += s*n;
206 return tmp;
207 }
208 #define GET_HEAP(type, n) \
209 ((type *)__get_heap(sizeof(type),__alignof__(type),(n)))
210
heap_free(size_t n)211 static inline bool heap_free(size_t n)
212 {
213 return (int)(heap_end-HEAP) >= (int)n;
214 }
215
216 /* copy.S */
217
218 void copy_to_fs(addr_t dst, void *src, size_t len);
219 void *copy_from_fs(void *dst, addr_t src, size_t len);
220 void copy_to_gs(addr_t dst, void *src, size_t len);
221 void *copy_from_gs(void *dst, addr_t src, size_t len);
222
223 /* a20.c */
224 int enable_a20(void);
225
226 /* apm.c */
227 int query_apm_bios(void);
228
229 /* bioscall.c */
230 struct biosregs {
231 union {
232 struct {
233 u32 edi;
234 u32 esi;
235 u32 ebp;
236 u32 _esp;
237 u32 ebx;
238 u32 edx;
239 u32 ecx;
240 u32 eax;
241 u32 _fsgs;
242 u32 _dses;
243 u32 eflags;
244 };
245 struct {
246 u16 di, hdi;
247 u16 si, hsi;
248 u16 bp, hbp;
249 u16 _sp, _hsp;
250 u16 bx, hbx;
251 u16 dx, hdx;
252 u16 cx, hcx;
253 u16 ax, hax;
254 u16 gs, fs;
255 u16 es, ds;
256 u16 flags, hflags;
257 };
258 struct {
259 u8 dil, dih, edi2, edi3;
260 u8 sil, sih, esi2, esi3;
261 u8 bpl, bph, ebp2, ebp3;
262 u8 _spl, _sph, _esp2, _esp3;
263 u8 bl, bh, ebx2, ebx3;
264 u8 dl, dh, edx2, edx3;
265 u8 cl, ch, ecx2, ecx3;
266 u8 al, ah, eax2, eax3;
267 };
268 };
269 };
270 void intcall(u8 int_no, const struct biosregs *ireg, struct biosregs *oreg);
271
272 /* cmdline.c */
273 int __cmdline_find_option(unsigned long cmdline_ptr, const char *option, char *buffer, int bufsize);
274 int __cmdline_find_option_bool(unsigned long cmdline_ptr, const char *option);
cmdline_find_option(const char * option,char * buffer,int bufsize)275 static inline int cmdline_find_option(const char *option, char *buffer, int bufsize)
276 {
277 unsigned long cmd_line_ptr = boot_params.hdr.cmd_line_ptr;
278
279 if (cmd_line_ptr >= 0x100000)
280 return -1; /* inaccessible */
281
282 return __cmdline_find_option(cmd_line_ptr, option, buffer, bufsize);
283 }
284
cmdline_find_option_bool(const char * option)285 static inline int cmdline_find_option_bool(const char *option)
286 {
287 unsigned long cmd_line_ptr = boot_params.hdr.cmd_line_ptr;
288
289 if (cmd_line_ptr >= 0x100000)
290 return -1; /* inaccessible */
291
292 return __cmdline_find_option_bool(cmd_line_ptr, option);
293 }
294
295 /* cpu.c, cpucheck.c */
296 int check_cpu(int *cpu_level_ptr, int *req_level_ptr, u32 **err_flags_ptr);
297 int validate_cpu(void);
298
299 /* early_serial_console.c */
300 extern int early_serial_base;
301 void console_init(void);
302
303 /* edd.c */
304 void query_edd(void);
305
306 /* header.S */
307 void __attribute__((noreturn)) die(void);
308
309 /* memory.c */
310 int detect_memory(void);
311
312 /* pm.c */
313 void __attribute__((noreturn)) go_to_protected_mode(void);
314
315 /* pmjump.S */
316 void __attribute__((noreturn))
317 protected_mode_jump(u32 entrypoint, u32 bootparams);
318
319 /* printf.c */
320 int sprintf(char *buf, const char *fmt, ...);
321 int vsprintf(char *buf, const char *fmt, va_list args);
322 int printf(const char *fmt, ...);
323
324 /* regs.c */
325 void initregs(struct biosregs *regs);
326
327 /* string.c */
328 int strcmp(const char *str1, const char *str2);
329 int strncmp(const char *cs, const char *ct, size_t count);
330 size_t strnlen(const char *s, size_t maxlen);
331 unsigned int atou(const char *s);
332 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base);
333 size_t strlen(const char *s);
334
335 /* tty.c */
336 void puts(const char *);
337 void putchar(int);
338 int getchar(void);
339 void kbd_flush(void);
340 int getchar_timeout(void);
341
342 /* video.c */
343 void set_video(void);
344
345 /* video-mode.c */
346 int set_mode(u16 mode);
347 int mode_defined(u16 mode);
348 void probe_cards(int unsafe);
349
350 /* video-vesa.c */
351 void vesa_store_edid(void);
352
353 #endif /* __ASSEMBLY__ */
354
355 #endif /* BOOT_BOOT_H */
356