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