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