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