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