[deliverable/linux.git] / arch / x86 / boot / boot.h

/* -*- linux-c -*- ------------------------------------------------------- *
 *
 *   Copyright (C) 1991, 1992 Linus Torvalds
 *   Copyright 2007 rPath, Inc. - All Rights Reserved
 *   Copyright 2009 Intel Corporation; author H. Peter Anvin
 *
 *   This file is part of the Linux kernel, and is made available under
 *   the terms of the GNU General Public License version 2.
 *
 * ----------------------------------------------------------------------- */

/*
 * Header file for the real-mode kernel code
 */

#ifndef BOOT_BOOT_H
#define BOOT_BOOT_H

#define STACK_SIZE	512	/* Minimum number of bytes for stack */

#ifndef __ASSEMBLY__

#include <stdarg.h>
#include <linux/types.h>
#include <linux/edd.h>
#include <asm/setup.h>
#include "bitops.h"
#include "ctype.h"
#include "cpuflags.h"

/* Useful macros */
#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))

#define ARRAY_SIZE(x) (sizeof(x) / sizeof(*(x)))

extern struct setup_header hdr;
extern struct boot_params boot_params;

#define cpu_relax()	asm volatile("rep; nop")

/* Basic port I/O */
static inline void outb(u8 v, u16 port)
{
	asm volatile("outb %0,%1" : : "a" (v), "dN" (port));
}
static inline u8 inb(u16 port)
{
	u8 v;
	asm volatile("inb %1,%0" : "=a" (v) : "dN" (port));
	return v;
}

static inline void outw(u16 v, u16 port)
{
	asm volatile("outw %0,%1" : : "a" (v), "dN" (port));
}
static inline u16 inw(u16 port)
{
	u16 v;
	asm volatile("inw %1,%0" : "=a" (v) : "dN" (port));
	return v;
}

static inline void outl(u32 v, u16 port)
{
	asm volatile("outl %0,%1" : : "a" (v), "dN" (port));
}
static inline u32 inl(u16 port)
{
	u32 v;
	asm volatile("inl %1,%0" : "=a" (v) : "dN" (port));
	return v;
}

static inline void io_delay(void)
{
	const u16 DELAY_PORT = 0x80;
	asm volatile("outb %%al,%0" : : "dN" (DELAY_PORT));
}

/* These functions are used to reference data in other segments. */

static inline u16 ds(void)
{
	u16 seg;
	asm("movw %%ds,%0" : "=rm" (seg));
	return seg;
}

static inline void set_fs(u16 seg)
{
	asm volatile("movw %0,%%fs" : : "rm" (seg));
}
static inline u16 fs(void)
{
	u16 seg;
	asm volatile("movw %%fs,%0" : "=rm" (seg));
	return seg;
}

static inline void set_gs(u16 seg)
{
	asm volatile("movw %0,%%gs" : : "rm" (seg));
}
static inline u16 gs(void)
{
	u16 seg;
	asm volatile("movw %%gs,%0" : "=rm" (seg));
	return seg;
}

typedef unsigned int addr_t;

static inline u8 rdfs8(addr_t addr)
{
	u8 v;
	asm volatile("movb %%fs:%1,%0" : "=q" (v) : "m" (*(u8 *)addr));
	return v;
}
static inline u16 rdfs16(addr_t addr)
{
	u16 v;
	asm volatile("movw %%fs:%1,%0" : "=r" (v) : "m" (*(u16 *)addr));
	return v;
}
static inline u32 rdfs32(addr_t addr)
{
	u32 v;
	asm volatile("movl %%fs:%1,%0" : "=r" (v) : "m" (*(u32 *)addr));
	return v;
}

static inline void wrfs8(u8 v, addr_t addr)
{
	asm volatile("movb %1,%%fs:%0" : "+m" (*(u8 *)addr) : "qi" (v));
}
static inline void wrfs16(u16 v, addr_t addr)
{
	asm volatile("movw %1,%%fs:%0" : "+m" (*(u16 *)addr) : "ri" (v));
}
static inline void wrfs32(u32 v, addr_t addr)
{
	asm volatile("movl %1,%%fs:%0" : "+m" (*(u32 *)addr) : "ri" (v));
}

static inline u8 rdgs8(addr_t addr)
{
	u8 v;
	asm volatile("movb %%gs:%1,%0" : "=q" (v) : "m" (*(u8 *)addr));
	return v;
}
static inline u16 rdgs16(addr_t addr)
{
	u16 v;
	asm volatile("movw %%gs:%1,%0" : "=r" (v) : "m" (*(u16 *)addr));
	return v;
}
static inline u32 rdgs32(addr_t addr)
{
	u32 v;
	asm volatile("movl %%gs:%1,%0" : "=r" (v) : "m" (*(u32 *)addr));
	return v;
}

static inline void wrgs8(u8 v, addr_t addr)
{
	asm volatile("movb %1,%%gs:%0" : "+m" (*(u8 *)addr) : "qi" (v));
}
static inline void wrgs16(u16 v, addr_t addr)
{
	asm volatile("movw %1,%%gs:%0" : "+m" (*(u16 *)addr) : "ri" (v));
}
static inline void wrgs32(u32 v, addr_t addr)
{
	asm volatile("movl %1,%%gs:%0" : "+m" (*(u32 *)addr) : "ri" (v));
}

/* Note: these only return true/false, not a signed return value! */
static inline int memcmp_fs(const void *s1, addr_t s2, size_t len)
{
	u8 diff;
	asm volatile("fs; repe; cmpsb; setnz %0"
		     : "=qm" (diff), "+D" (s1), "+S" (s2), "+c" (len));
	return diff;
}
static inline int memcmp_gs(const void *s1, addr_t s2, size_t len)
{
	u8 diff;
	asm volatile("gs; repe; cmpsb; setnz %0"
		     : "=qm" (diff), "+D" (s1), "+S" (s2), "+c" (len));
	return diff;
}

/* Heap -- available for dynamic lists. */
extern char _end[];
extern char *HEAP;
extern char *heap_end;
#define RESET_HEAP() ((void *)( HEAP = _end ))
static inline char *__get_heap(size_t s, size_t a, size_t n)
{
	char *tmp;

	HEAP = (char *)(((size_t)HEAP+(a-1)) & ~(a-1));
	tmp = HEAP;
	HEAP += s*n;
	return tmp;
}
#define GET_HEAP(type, n) \
	((type *)__get_heap(sizeof(type),__alignof__(type),(n)))

static inline bool heap_free(size_t n)
{
	return (int)(heap_end-HEAP) >= (int)n;
}

/* copy.S */

void copy_to_fs(addr_t dst, void *src, size_t len);
void *copy_from_fs(void *dst, addr_t src, size_t len);
void copy_to_gs(addr_t dst, void *src, size_t len);
void *copy_from_gs(void *dst, addr_t src, size_t len);

/* a20.c */
int enable_a20(void);

/* apm.c */
int query_apm_bios(void);

/* bioscall.c */
struct biosregs {
	union {
		struct {
			u32 edi;
			u32 esi;
			u32 ebp;
			u32 _esp;
			u32 ebx;
			u32 edx;
			u32 ecx;
			u32 eax;
			u32 _fsgs;
			u32 _dses;
			u32 eflags;
		};
		struct {
			u16 di, hdi;
			u16 si, hsi;
			u16 bp, hbp;
			u16 _sp, _hsp;
			u16 bx, hbx;
			u16 dx, hdx;
			u16 cx, hcx;
			u16 ax, hax;
			u16 gs, fs;
			u16 es, ds;
			u16 flags, hflags;
		};
		struct {
			u8 dil, dih, edi2, edi3;
			u8 sil, sih, esi2, esi3;
			u8 bpl, bph, ebp2, ebp3;
			u8 _spl, _sph, _esp2, _esp3;
			u8 bl, bh, ebx2, ebx3;
			u8 dl, dh, edx2, edx3;
			u8 cl, ch, ecx2, ecx3;
			u8 al, ah, eax2, eax3;
		};
	};
};
void intcall(u8 int_no, const struct biosregs *ireg, struct biosregs *oreg);

/* cmdline.c */
int __cmdline_find_option(unsigned long cmdline_ptr, const char *option, char *buffer, int bufsize);
int __cmdline_find_option_bool(unsigned long cmdline_ptr, const char *option);
static inline int cmdline_find_option(const char *option, char *buffer, int bufsize)
{
	unsigned long cmd_line_ptr = boot_params.hdr.cmd_line_ptr;

	if (cmd_line_ptr >= 0x100000)
		return -1;      /* inaccessible */

	return __cmdline_find_option(cmd_line_ptr, option, buffer, bufsize);
}

static inline int cmdline_find_option_bool(const char *option)
{
	unsigned long cmd_line_ptr = boot_params.hdr.cmd_line_ptr;

	if (cmd_line_ptr >= 0x100000)
		return -1;      /* inaccessible */

	return __cmdline_find_option_bool(cmd_line_ptr, option);
}

/* cpu.c, cpucheck.c */
int check_cpu(int *cpu_level_ptr, int *req_level_ptr, u32 **err_flags_ptr);
int validate_cpu(void);

/* early_serial_console.c */
extern int early_serial_base;
void console_init(void);

/* edd.c */
void query_edd(void);

/* header.S */
void __attribute__((noreturn)) die(void);

/* memory.c */
int detect_memory(void);

/* pm.c */
void __attribute__((noreturn)) go_to_protected_mode(void);

/* pmjump.S */
void __attribute__((noreturn))
	protected_mode_jump(u32 entrypoint, u32 bootparams);

/* printf.c */
int sprintf(char *buf, const char *fmt, ...);
int vsprintf(char *buf, const char *fmt, va_list args);
int printf(const char *fmt, ...);

/* regs.c */
void initregs(struct biosregs *regs);

/* string.c */
int strcmp(const char *str1, const char *str2);
int strncmp(const char *cs, const char *ct, size_t count);
size_t strnlen(const char *s, size_t maxlen);
unsigned int atou(const char *s);
unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base);
size_t strlen(const char *s);

/* tty.c */
void puts(const char *);
void putchar(int);
int getchar(void);
void kbd_flush(void);
int getchar_timeout(void);

/* video.c */
void set_video(void);

/* video-mode.c */
int set_mode(u16 mode);
int mode_defined(u16 mode);
void probe_cards(int unsafe);

/* video-vesa.c */
void vesa_store_edid(void);

#endif /* __ASSEMBLY__ */

#endif /* BOOT_BOOT_H */
Commit	Line	Data
62bd0337 PA	1	/* -- linux-c -- ------------------------------------------------------- *
	2	*
	3	* Copyright (C) 1991, 1992 Linus Torvalds
	4	* Copyright 2007 rPath, Inc. - All Rights Reserved
7a734e7d	5	* Copyright 2009 Intel Corporation; author H. Peter Anvin
62bd0337 PA	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	/*
62bd0337 PA	13	* Header file for the real-mode kernel code
	14	*/
	15
	16	#ifndef BOOT_BOOT_H
	17	#define BOOT_BOOT_H
	18
6b6815c6 PA	19	#define STACK_SIZE 512 /* Minimum number of bytes for stack */
6b6815c6 PA	20
62bd0337 PA	21	#ifndef __ASSEMBLY__
	22
	23	#include <stdarg.h>
	24	#include <linux/types.h>
	25	#include <linux/edd.h>
fa76dab9	26	#include <asm/setup.h>
c2dcfde8	27	#include "bitops.h"
6238b47b	28	#include "ctype.h"
dd78b973	29	#include "cpuflags.h"
7b27718b	30
62bd0337 PA	31	/* Useful macros */
	32	#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
	33
1b72691c AK	34	#define ARRAY_SIZE(x) (sizeof(x) / sizeof(*(x)))
1b72691c AK	35
62bd0337 PA	36	extern struct setup_header hdr;
	37	extern struct boot_params boot_params;
	38
fa97bdf9 PE	39	#define cpu_relax() asm volatile("rep; nop")
fa97bdf9 PE	40
62bd0337 PA	41	/* Basic port I/O */
	42	static inline void outb(u8 v, u16 port)
	43	{
	44	asm volatile("outb %0,%1" : : "a" (v), "dN" (port));
	45	}
	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
	53	static inline void outw(u16 v, u16 port)
	54	{
	55	asm volatile("outw %0,%1" : : "a" (v), "dN" (port));
	56	}
	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
	64	static inline void outl(u32 v, u16 port)
	65	{
5593eaa8	66	asm volatile("outl %0,%1" : : "a" (v), "dN" (port));
62bd0337	67	}
35f1790e	68	static inline u32 inl(u16 port)
62bd0337 PA	69	{
	70	u32 v;
	71	asm volatile("inl %1,%0" : "=a" (v) : "dN" (port));
	72	return v;
	73	}
	74
	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
	83	static inline u16 ds(void)
	84	{
	85	u16 seg;
	86	asm("movw %%ds,%0" : "=rm" (seg));
	87	return seg;
	88	}
	89
	90	static inline void set_fs(u16 seg)
	91	{
	92	asm volatile("movw %0,%%fs" : : "rm" (seg));
	93	}
	94	static inline u16 fs(void)
	95	{
	96	u16 seg;
b015124e	97	asm volatile("movw %%fs,%0" : "=rm" (seg));
62bd0337 PA	98	return seg;
	99	}
	100
	101	static inline void set_gs(u16 seg)
	102	{
	103	asm volatile("movw %0,%%gs" : : "rm" (seg));
	104	}
	105	static inline u16 gs(void)
	106	{
	107	u16 seg;
b015124e	108	asm volatile("movw %%gs,%0" : "=rm" (seg));
62bd0337 PA	109	return seg;
	110	}
	111
	112	typedef unsigned int addr_t;
	113
	114	static inline u8 rdfs8(addr_t addr)
	115	{
	116	u8 v;
811a0fff	117	asm volatile("movb %%fs:%1,%0" : "=q" (v) : "m" ((u8 )addr));
62bd0337 PA	118	return v;
	119	}
	120	static inline u16 rdfs16(addr_t addr)
	121	{
	122	u16 v;
b015124e	123	asm volatile("movw %%fs:%1,%0" : "=r" (v) : "m" ((u16 )addr));
62bd0337 PA	124	return v;
	125	}
	126	static inline u32 rdfs32(addr_t addr)
	127	{
	128	u32 v;
b015124e	129	asm volatile("movl %%fs:%1,%0" : "=r" (v) : "m" ((u32 )addr));
62bd0337 PA	130	return v;
	131	}
	132
	133	static inline void wrfs8(u8 v, addr_t addr)
	134	{
811a0fff	135	asm volatile("movb %1,%%fs:%0" : "+m" ((u8 )addr) : "qi" (v));
62bd0337 PA	136	}
	137	static inline void wrfs16(u16 v, addr_t addr)
	138	{
811a0fff	139	asm volatile("movw %1,%%fs:%0" : "+m" ((u16 )addr) : "ri" (v));
62bd0337 PA	140	}
	141	static inline void wrfs32(u32 v, addr_t addr)
	142	{
811a0fff	143	asm volatile("movl %1,%%fs:%0" : "+m" ((u32 )addr) : "ri" (v));
62bd0337 PA	144	}
	145
	146	static inline u8 rdgs8(addr_t addr)
	147	{
	148	u8 v;
811a0fff	149	asm volatile("movb %%gs:%1,%0" : "=q" (v) : "m" ((u8 )addr));
62bd0337 PA	150	return v;
	151	}
	152	static inline u16 rdgs16(addr_t addr)
	153	{
	154	u16 v;
b015124e	155	asm volatile("movw %%gs:%1,%0" : "=r" (v) : "m" ((u16 )addr));
62bd0337 PA	156	return v;
	157	}
	158	static inline u32 rdgs32(addr_t addr)
	159	{
	160	u32 v;
b015124e	161	asm volatile("movl %%gs:%1,%0" : "=r" (v) : "m" ((u32 )addr));
62bd0337 PA	162	return v;
	163	}
	164
	165	static inline void wrgs8(u8 v, addr_t addr)
	166	{
811a0fff	167	asm volatile("movb %1,%%gs:%0" : "+m" ((u8 )addr) : "qi" (v));
62bd0337 PA	168	}
	169	static inline void wrgs16(u16 v, addr_t addr)
	170	{
811a0fff	171	asm volatile("movw %1,%%gs:%0" : "+m" ((u16 )addr) : "ri" (v));
62bd0337 PA	172	}
	173	static inline void wrgs32(u32 v, addr_t addr)
	174	{
811a0fff	175	asm volatile("movl %1,%%gs:%0" : "+m" ((u32 )addr) : "ri" (v));
62bd0337 PA	176	}
	177
	178	/* Note: these only return true/false, not a signed return value! */
62bd0337 PA	179	static inline int memcmp_fs(const void *s1, addr_t s2, size_t len)
	180	{
	181	u8 diff;
b015124e PA	182	asm volatile("fs; repe; cmpsb; setnz %0"
b015124e PA	183	: "=qm" (diff), "+D" (s1), "+S" (s2), "+c" (len));
62bd0337 PA	184	return diff;
	185	}
	186	static inline int memcmp_gs(const void *s1, addr_t s2, size_t len)
	187	{
	188	u8 diff;
b015124e PA	189	asm volatile("gs; repe; cmpsb; setnz %0"
b015124e PA	190	: "=qm" (diff), "+D" (s1), "+S" (s2), "+c" (len));
62bd0337 PA	191	return diff;
	192	}
	193
62bd0337	194	/* Heap -- available for dynamic lists. */
62bd0337 PA	195	extern char _end[];
	196	extern char *HEAP;
	197	extern char *heap_end;
	198	#define RESET_HEAP() ((void *)( HEAP = _end ))
	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
e6e1ace9	211	static inline bool heap_free(size_t n)
62bd0337	212	{
e6e1ace9	213	return (int)(heap_end-HEAP) >= (int)n;
62bd0337 PA	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);
62bd0337 PA	222
	223	/* a20.c */
	224	int enable_a20(void);
	225
	226	/* apm.c */
	227	int query_apm_bios(void);
	228
7a734e7d PA	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
62bd0337	272	/* cmdline.c */
3db07e70 YL	273	int __cmdline_find_option(unsigned long cmdline_ptr, const char option, char buffer, int bufsize);
3db07e70 YL	274	int __cmdline_find_option_bool(unsigned long cmdline_ptr, const char *option);
f4ed2877 YL	275	static inline int cmdline_find_option(const char option, char buffer, int bufsize)
f4ed2877 YL	276	{
3db07e70	277	unsigned long cmd_line_ptr = boot_params.hdr.cmd_line_ptr;
16a4baa6 YL	278
	279	if (cmd_line_ptr >= 0x100000)
	280	return -1; /* inaccessible */
	281
	282	return __cmdline_find_option(cmd_line_ptr, option, buffer, bufsize);
f4ed2877 YL	283	}
	284
	285	static inline int cmdline_find_option_bool(const char *option)
	286	{
3db07e70	287	unsigned long cmd_line_ptr = boot_params.hdr.cmd_line_ptr;
16a4baa6 YL	288
	289	if (cmd_line_ptr >= 0x100000)
	290	return -1; /* inaccessible */
	291
	292	return __cmdline_find_option_bool(cmd_line_ptr, option);
f4ed2877 YL	293	}
f4ed2877 YL	294
62bd0337 PA	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
f4ed2877 YL	299	/* early_serial_console.c */
	300	extern int early_serial_base;
	301	void console_init(void);
	302
62bd0337 PA	303	/* edd.c */
	304	void query_edd(void);
	305
	306	/* header.S */
	307	void __attribute__((noreturn)) die(void);
	308
62bd0337 PA	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
7a734e7d PA	324	/* regs.c */
	325	void initregs(struct biosregs *regs);
	326
62bd0337 PA	327	/* string.c */
62bd0337 PA	328	int strcmp(const char str1, const char str2);
fa97bdf9	329	int strncmp(const char cs, const char ct, size_t count);
62bd0337 PA	330	size_t strnlen(const char *s, size_t maxlen);
62bd0337 PA	331	unsigned int atou(const char *s);
fa97bdf9	332	unsigned long long simple_strtoull(const char cp, char *endp, unsigned int base);
062fe8fe	333	size_t strlen(const char *s);
62bd0337 PA	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
e44b7b75 PM	345	/* video-mode.c */
	346	int set_mode(u16 mode);
	347	int mode_defined(u16 mode);
	348	void probe_cards(int unsafe);
	349
62bd0337 PA	350	/* video-vesa.c */
	351	void vesa_store_edid(void);
	352
62bd0337 PA	353	#endif /* __ASSEMBLY__ */
	354
	355	#endif /* BOOT_BOOT_H */