[linux-2.6-block.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/boot.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>
	26	#include <asm/boot.h>
fa76dab9	27	#include <asm/setup.h>
c2dcfde8	28	#include "bitops.h"
6238b47b	29	#include "ctype.h"
dd78b973	30	#include "cpuflags.h"
7b27718b	31
62bd0337 PA	32	/* Useful macros */
	33	#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
	34
1b72691c AK	35	#define ARRAY_SIZE(x) (sizeof(x) / sizeof(*(x)))
1b72691c AK	36
62bd0337 PA	37	extern struct setup_header hdr;
	38	extern struct boot_params boot_params;
	39
fa97bdf9 PE	40	#define cpu_relax() asm volatile("rep; nop")
fa97bdf9 PE	41
62bd0337 PA	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	{
5593eaa8	67	asm volatile("outl %0,%1" : : "a" (v), "dN" (port));
62bd0337	68	}
35f1790e	69	static inline u32 inl(u16 port)
62bd0337 PA	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;
b015124e	98	asm volatile("movw %%fs,%0" : "=rm" (seg));
62bd0337 PA	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;
b015124e	109	asm volatile("movw %%gs,%0" : "=rm" (seg));
62bd0337 PA	110	return seg;
	111	}
	112
	113	typedef unsigned int addr_t;
	114
	115	static inline u8 rdfs8(addr_t addr)
	116	{
	117	u8 v;
811a0fff	118	asm volatile("movb %%fs:%1,%0" : "=q" (v) : "m" ((u8 )addr));
62bd0337 PA	119	return v;
	120	}
	121	static inline u16 rdfs16(addr_t addr)
	122	{
	123	u16 v;
b015124e	124	asm volatile("movw %%fs:%1,%0" : "=r" (v) : "m" ((u16 )addr));
62bd0337 PA	125	return v;
	126	}
	127	static inline u32 rdfs32(addr_t addr)
	128	{
	129	u32 v;
b015124e	130	asm volatile("movl %%fs:%1,%0" : "=r" (v) : "m" ((u32 )addr));
62bd0337 PA	131	return v;
	132	}
	133
	134	static inline void wrfs8(u8 v, addr_t addr)
	135	{
811a0fff	136	asm volatile("movb %1,%%fs:%0" : "+m" ((u8 )addr) : "qi" (v));
62bd0337 PA	137	}
	138	static inline void wrfs16(u16 v, addr_t addr)
	139	{
811a0fff	140	asm volatile("movw %1,%%fs:%0" : "+m" ((u16 )addr) : "ri" (v));
62bd0337 PA	141	}
	142	static inline void wrfs32(u32 v, addr_t addr)
	143	{
811a0fff	144	asm volatile("movl %1,%%fs:%0" : "+m" ((u32 )addr) : "ri" (v));
62bd0337 PA	145	}
	146
	147	static inline u8 rdgs8(addr_t addr)
	148	{
	149	u8 v;
811a0fff	150	asm volatile("movb %%gs:%1,%0" : "=q" (v) : "m" ((u8 )addr));
62bd0337 PA	151	return v;
	152	}
	153	static inline u16 rdgs16(addr_t addr)
	154	{
	155	u16 v;
b015124e	156	asm volatile("movw %%gs:%1,%0" : "=r" (v) : "m" ((u16 )addr));
62bd0337 PA	157	return v;
	158	}
	159	static inline u32 rdgs32(addr_t addr)
	160	{
	161	u32 v;
b015124e	162	asm volatile("movl %%gs:%1,%0" : "=r" (v) : "m" ((u32 )addr));
62bd0337 PA	163	return v;
	164	}
	165
	166	static inline void wrgs8(u8 v, addr_t addr)
	167	{
811a0fff	168	asm volatile("movb %1,%%gs:%0" : "+m" ((u8 )addr) : "qi" (v));
62bd0337 PA	169	}
	170	static inline void wrgs16(u16 v, addr_t addr)
	171	{
811a0fff	172	asm volatile("movw %1,%%gs:%0" : "+m" ((u16 )addr) : "ri" (v));
62bd0337 PA	173	}
	174	static inline void wrgs32(u32 v, addr_t addr)
	175	{
811a0fff	176	asm volatile("movl %1,%%gs:%0" : "+m" ((u32 )addr) : "ri" (v));
62bd0337 PA	177	}
	178
	179	/* Note: these only return true/false, not a signed return value! */
62bd0337 PA	180	static inline int memcmp_fs(const void *s1, addr_t s2, size_t len)
	181	{
	182	u8 diff;
b015124e PA	183	asm volatile("fs; repe; cmpsb; setnz %0"
b015124e PA	184	: "=qm" (diff), "+D" (s1), "+S" (s2), "+c" (len));
62bd0337 PA	185	return diff;
	186	}
	187	static inline int memcmp_gs(const void *s1, addr_t s2, size_t len)
	188	{
	189	u8 diff;
b015124e PA	190	asm volatile("gs; repe; cmpsb; setnz %0"
b015124e PA	191	: "=qm" (diff), "+D" (s1), "+S" (s2), "+c" (len));
62bd0337 PA	192	return diff;
	193	}
	194
62bd0337	195	/* Heap -- available for dynamic lists. */
62bd0337 PA	196	extern char _end[];
	197	extern char *HEAP;
	198	extern char *heap_end;
	199	#define RESET_HEAP() ((void *)( HEAP = _end ))
	200	static 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
e6e1ace9	212	static inline bool heap_free(size_t n)
62bd0337	213	{
e6e1ace9	214	return (int)(heap_end-HEAP) >= (int)n;
62bd0337 PA	215	}
	216
	217	/* copy.S */
	218
	219	void copy_to_fs(addr_t dst, void *src, size_t len);
	220	void copy_from_fs(void dst, addr_t src, size_t len);
	221	void copy_to_gs(addr_t dst, void *src, size_t len);
	222	void copy_from_gs(void dst, addr_t src, size_t len);
62bd0337 PA	223
	224	/* a20.c */
	225	int enable_a20(void);
	226
	227	/* apm.c */
	228	int query_apm_bios(void);
	229
7a734e7d PA	230	/* bioscall.c */
	231	struct 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	};
	271	void intcall(u8 int_no, const struct biosregs ireg, struct biosregs oreg);
	272
62bd0337	273	/* cmdline.c */
3db07e70 YL	274	int __cmdline_find_option(unsigned long cmdline_ptr, const char option, char buffer, int bufsize);
3db07e70 YL	275	int __cmdline_find_option_bool(unsigned long cmdline_ptr, const char *option);
f4ed2877 YL	276	static inline int cmdline_find_option(const char option, char buffer, int bufsize)
f4ed2877 YL	277	{
3db07e70	278	unsigned long cmd_line_ptr = boot_params.hdr.cmd_line_ptr;
16a4baa6 YL	279
	280	if (cmd_line_ptr >= 0x100000)
	281	return -1; /* inaccessible */
	282
	283	return __cmdline_find_option(cmd_line_ptr, option, buffer, bufsize);
f4ed2877 YL	284	}
	285
	286	static inline int cmdline_find_option_bool(const char *option)
	287	{
3db07e70	288	unsigned long cmd_line_ptr = boot_params.hdr.cmd_line_ptr;
16a4baa6 YL	289
	290	if (cmd_line_ptr >= 0x100000)
	291	return -1; /* inaccessible */
	292
	293	return __cmdline_find_option_bool(cmd_line_ptr, option);
f4ed2877 YL	294	}
f4ed2877 YL	295
62bd0337 PA	296	/* cpu.c, cpucheck.c */
	297	int check_cpu(int cpu_level_ptr, int req_level_ptr, u32 **err_flags_ptr);
	298	int validate_cpu(void);
	299
f4ed2877 YL	300	/* early_serial_console.c */
	301	extern int early_serial_base;
	302	void console_init(void);
	303
62bd0337 PA	304	/* edd.c */
	305	void query_edd(void);
	306
	307	/* header.S */
	308	void __attribute__((noreturn)) die(void);
	309
62bd0337 PA	310	/* memory.c */
	311	int detect_memory(void);
	312
	313	/* pm.c */
	314	void __attribute__((noreturn)) go_to_protected_mode(void);
	315
	316	/* pmjump.S */
	317	void __attribute__((noreturn))
	318	protected_mode_jump(u32 entrypoint, u32 bootparams);
	319
	320	/* printf.c */
	321	int sprintf(char buf, const char fmt, ...);
	322	int vsprintf(char buf, const char fmt, va_list args);
	323	int printf(const char *fmt, ...);
	324
7a734e7d PA	325	/* regs.c */
	326	void initregs(struct biosregs *regs);
	327
62bd0337 PA	328	/* string.c */
62bd0337 PA	329	int strcmp(const char str1, const char str2);
fa97bdf9	330	int strncmp(const char cs, const char ct, size_t count);
62bd0337 PA	331	size_t strnlen(const char *s, size_t maxlen);
62bd0337 PA	332	unsigned int atou(const char *s);
fa97bdf9	333	unsigned long long simple_strtoull(const char cp, char *endp, unsigned int base);
062fe8fe	334	size_t strlen(const char *s);
62bd0337 PA	335
	336	/* tty.c */
	337	void puts(const char *);
	338	void putchar(int);
	339	int getchar(void);
	340	void kbd_flush(void);
	341	int getchar_timeout(void);
	342
	343	/* video.c */
	344	void set_video(void);
	345
e44b7b75 PM	346	/* video-mode.c */
	347	int set_mode(u16 mode);
	348	int mode_defined(u16 mode);
	349	void probe_cards(int unsafe);
	350
62bd0337 PA	351	/* video-vesa.c */
	352	void vesa_store_edid(void);
	353
62bd0337 PA	354	#endif /* __ASSEMBLY__ */
	355
	356	#endif /* BOOT_BOOT_H */