[mirror_ubuntu-artful-kernel.git] / arch / x86 / include / uapi / asm / bootparam.h

#ifndef _ASM_X86_BOOTPARAM_H
#define _ASM_X86_BOOTPARAM_H

/* setup_data types */
#define SETUP_NONE			0
#define SETUP_E820_EXT			1
#define SETUP_DTB			2
#define SETUP_PCI			3
#define SETUP_EFI			4

/* ram_size flags */
#define RAMDISK_IMAGE_START_MASK	0x07FF
#define RAMDISK_PROMPT_FLAG		0x8000
#define RAMDISK_LOAD_FLAG		0x4000

/* loadflags */
#define LOADED_HIGH	(1<<0)
#define KASLR_FLAG	(1<<1)
#define QUIET_FLAG	(1<<5)
#define KEEP_SEGMENTS	(1<<6)
#define CAN_USE_HEAP	(1<<7)

/* xloadflags */
#define XLF_KERNEL_64			(1<<0)
#define XLF_CAN_BE_LOADED_ABOVE_4G	(1<<1)
#define XLF_EFI_HANDOVER_32		(1<<2)
#define XLF_EFI_HANDOVER_64		(1<<3)
#define XLF_EFI_KEXEC			(1<<4)

#ifndef __ASSEMBLY__

#include <linux/types.h>
#include <linux/screen_info.h>
#include <linux/apm_bios.h>
#include <linux/edd.h>
#include <asm/e820.h>
#include <asm/ist.h>
#include <video/edid.h>

/* extensible setup data list node */
struct setup_data {
	__u64 next;
	__u32 type;
	__u32 len;
	__u8 data[0];
};

struct setup_header {
	__u8	setup_sects;
	__u16	root_flags;
	__u32	syssize;
	__u16	ram_size;
	__u16	vid_mode;
	__u16	root_dev;
	__u16	boot_flag;
	__u16	jump;
	__u32	header;
	__u16	version;
	__u32	realmode_swtch;
	__u16	start_sys;
	__u16	kernel_version;
	__u8	type_of_loader;
	__u8	loadflags;
	__u16	setup_move_size;
	__u32	code32_start;
	__u32	ramdisk_image;
	__u32	ramdisk_size;
	__u32	bootsect_kludge;
	__u16	heap_end_ptr;
	__u8	ext_loader_ver;
	__u8	ext_loader_type;
	__u32	cmd_line_ptr;
	__u32	initrd_addr_max;
	__u32	kernel_alignment;
	__u8	relocatable_kernel;
	__u8	min_alignment;
	__u16	xloadflags;
	__u32	cmdline_size;
	__u32	hardware_subarch;
	__u64	hardware_subarch_data;
	__u32	payload_offset;
	__u32	payload_length;
	__u64	setup_data;
	__u64	pref_address;
	__u32	init_size;
	__u32	handover_offset;
} __attribute__((packed));

struct sys_desc_table {
	__u16 length;
	__u8  table[14];
};

/* Gleaned from OFW's set-parameters in cpu/x86/pc/linux.fth */
struct olpc_ofw_header {
	__u32 ofw_magic;	/* OFW signature */
	__u32 ofw_version;
	__u32 cif_handler;	/* callback into OFW */
	__u32 irq_desc_table;
} __attribute__((packed));

struct efi_info {
	__u32 efi_loader_signature;
	__u32 efi_systab;
	__u32 efi_memdesc_size;
	__u32 efi_memdesc_version;
	__u32 efi_memmap;
	__u32 efi_memmap_size;
	__u32 efi_systab_hi;
	__u32 efi_memmap_hi;
};

/* The so-called "zeropage" */
struct boot_params {
	struct screen_info screen_info;			/* 0x000 */
	struct apm_bios_info apm_bios_info;		/* 0x040 */
	__u8  _pad2[4];					/* 0x054 */
	__u64  tboot_addr;				/* 0x058 */
	struct ist_info ist_info;			/* 0x060 */
	__u8  _pad3[16];				/* 0x070 */
	__u8  hd0_info[16];	/* obsolete! */		/* 0x080 */
	__u8  hd1_info[16];	/* obsolete! */		/* 0x090 */
	struct sys_desc_table sys_desc_table; /* obsolete! */	/* 0x0a0 */
	struct olpc_ofw_header olpc_ofw_header;		/* 0x0b0 */
	__u32 ext_ramdisk_image;			/* 0x0c0 */
	__u32 ext_ramdisk_size;				/* 0x0c4 */
	__u32 ext_cmd_line_ptr;				/* 0x0c8 */
	__u8  _pad4[116];				/* 0x0cc */
	struct edid_info edid_info;			/* 0x140 */
	struct efi_info efi_info;			/* 0x1c0 */
	__u32 alt_mem_k;				/* 0x1e0 */
	__u32 scratch;		/* Scratch field! */	/* 0x1e4 */
	__u8  e820_entries;				/* 0x1e8 */
	__u8  eddbuf_entries;				/* 0x1e9 */
	__u8  edd_mbr_sig_buf_entries;			/* 0x1ea */
	__u8  kbd_status;				/* 0x1eb */
	__u8  _pad5[3];					/* 0x1ec */
	/*
	 * The sentinel is set to a nonzero value (0xff) in header.S.
	 *
	 * A bootloader is supposed to only take setup_header and put
	 * it into a clean boot_params buffer. If it turns out that
	 * it is clumsy or too generous with the buffer, it most
	 * probably will pick up the sentinel variable too. The fact
	 * that this variable then is still 0xff will let kernel
	 * know that some variables in boot_params are invalid and
	 * kernel should zero out certain portions of boot_params.
	 */
	__u8  sentinel;					/* 0x1ef */
	__u8  _pad6[1];					/* 0x1f0 */
	struct setup_header hdr;    /* setup header */	/* 0x1f1 */
	__u8  _pad7[0x290-0x1f1-sizeof(struct setup_header)];
	__u32 edd_mbr_sig_buffer[EDD_MBR_SIG_MAX];	/* 0x290 */
	struct e820entry e820_map[E820MAX];		/* 0x2d0 */
	__u8  _pad8[48];				/* 0xcd0 */
	struct edd_info eddbuf[EDDMAXNR];		/* 0xd00 */
	__u8  _pad9[276];				/* 0xeec */
} __attribute__((packed));

/**
 * enum x86_hardware_subarch - x86 hardware subarchitecture
 *
 * The x86 hardware_subarch and hardware_subarch_data were added as of the x86
 * boot protocol 2.07 to help distinguish and support custom x86 boot
 * sequences. This enum represents accepted values for the x86
 * hardware_subarch.  Custom x86 boot sequences (not X86_SUBARCH_PC) do not
 * have or simply *cannot* make use of natural stubs like BIOS or EFI, the
 * hardware_subarch can be used on the Linux entry path to revector to a
 * subarchitecture stub when needed. This subarchitecture stub can be used to
 * set up Linux boot parameters or for special care to account for nonstandard
 * handling of page tables.
 *
 * These enums should only ever be used by x86 code, and the code that uses
 * it should be well contained and compartamentalized.
 *
 * KVM and Xen HVM do not have a subarch as these are expected to follow
 * standard x86 boot entries. If there is a genuine need for "hypervisor" type
 * that should be considered separately in the future. Future guest types
 * should seriously consider working with standard x86 boot stubs such as
 * the BIOS or EFI boot stubs.
 *
 * WARNING: this enum is only used for legacy hacks, for platform features that
 *	    are not easily enumerated or discoverable. You should not ever use
 *	    this for new features.
 *
 * @X86_SUBARCH_PC: Should be used if the hardware is enumerable using standard
 *	PC mechanisms (PCI, ACPI) and doesn't need a special boot flow.
 * @X86_SUBARCH_LGUEST: Used for x86 hypervisor demo, lguest
 * @X86_SUBARCH_XEN: Used for Xen guest types which follow the PV boot path,
 * 	which start at asm startup_xen() entry point and later jump to the C
 * 	xen_start_kernel() entry point. Both domU and dom0 type of guests are
 * 	currently supportd through this PV boot path.
 * @X86_SUBARCH_INTEL_MID: Used for Intel MID (Mobile Internet Device) platform
 *	systems which do not have the PCI legacy interfaces.
 * @X86_SUBARCH_CE4100: Used for Intel CE media processor (CE4100) SoC for
 * 	for settop boxes and media devices, the use of a subarch for CE4100
 * 	is more of a hack...
 */
enum x86_hardware_subarch {
	X86_SUBARCH_PC = 0,
	X86_SUBARCH_LGUEST,
	X86_SUBARCH_XEN,
	X86_SUBARCH_INTEL_MID,
	X86_SUBARCH_CE4100,
	X86_NR_SUBARCHS,
};

#endif /* __ASSEMBLY__ */

#endif /* _ASM_X86_BOOTPARAM_H */
Commit	Line	Data
1965aae3 PA	1	#ifndef _ASM_X86_BOOTPARAM_H
1965aae3 PA	2	#define _ASM_X86_BOOTPARAM_H
48c7ae67	3
09c205af PA	4	/* setup_data types */
	5	#define SETUP_NONE 0
	6	#define SETUP_E820_EXT 1
	7	#define SETUP_DTB 2
	8	#define SETUP_PCI 3
1fec0533	9	#define SETUP_EFI 4
09c205af PA	10
	11	/* ram_size flags */
	12	#define RAMDISK_IMAGE_START_MASK 0x07FF
	13	#define RAMDISK_PROMPT_FLAG 0x8000
	14	#define RAMDISK_LOAD_FLAG 0x4000
	15
	16	/* loadflags */
	17	#define LOADED_HIGH (1<<0)
78cac48c	18	#define KASLR_FLAG (1<<1)
09c205af PA	19	#define QUIET_FLAG (1<<5)
	20	#define KEEP_SEGMENTS (1<<6)
	21	#define CAN_USE_HEAP (1<<7)
	22
	23	/* xloadflags */
	24	#define XLF_KERNEL_64 (1<<0)
	25	#define XLF_CAN_BE_LOADED_ABOVE_4G (1<<1)
	26	#define XLF_EFI_HANDOVER_32 (1<<2)
	27	#define XLF_EFI_HANDOVER_64 (1<<3)
456a29dd	28	#define XLF_EFI_KEXEC (1<<4)
09c205af PA	29
	30	#ifndef __ASSEMBLY__
	31
48c7ae67 PA	32	#include <linux/types.h>
	33	#include <linux/screen_info.h>
	34	#include <linux/apm_bios.h>
48c7ae67	35	#include <linux/edd.h>
238b706d PA	36	#include <asm/e820.h>
238b706d PA	37	#include <asm/ist.h>
48c7ae67 PA	38	#include <video/edid.h>
48c7ae67 PA	39
8b664aa6 HY	40	/* extensible setup data list node */
8b664aa6 HY	41	struct setup_data {
afaafe50 RR	42	__u64 next;
	43	__u32 type;
	44	__u32 len;
	45	__u8 data[0];
8b664aa6 HY	46	};
8b664aa6 HY	47
48c7ae67	48	struct setup_header {
ee8e7cfe RR	49	__u8 setup_sects;
	50	__u16 root_flags;
	51	__u32 syssize;
	52	__u16 ram_size;
ee8e7cfe RR	53	__u16 vid_mode;
	54	__u16 root_dev;
	55	__u16 boot_flag;
	56	__u16 jump;
	57	__u32 header;
	58	__u16 version;
	59	__u32 realmode_swtch;
	60	__u16 start_sys;
	61	__u16 kernel_version;
	62	__u8 type_of_loader;
	63	__u8 loadflags;
ee8e7cfe RR	64	__u16 setup_move_size;
	65	__u32 code32_start;
	66	__u32 ramdisk_image;
	67	__u32 ramdisk_size;
	68	__u32 bootsect_kludge;
	69	__u16 heap_end_ptr;
5031296c PA	70	__u8 ext_loader_ver;
5031296c PA	71	__u8 ext_loader_type;
ee8e7cfe RR	72	__u32 cmd_line_ptr;
	73	__u32 initrd_addr_max;
	74	__u32 kernel_alignment;
	75	__u8 relocatable_kernel;
09c205af PA	76	__u8 min_alignment;
09c205af PA	77	__u16 xloadflags;
ee8e7cfe RR	78	__u32 cmdline_size;
	79	__u32 hardware_subarch;
	80	__u64 hardware_subarch_data;
8b664aa6 HY	81	__u32 payload_offset;
	82	__u32 payload_length;
	83	__u64 setup_data;
8af21e7e MF	84	__u64 pref_address;
8af21e7e MF	85	__u32 init_size;
9ca8f72a	86	__u32 handover_offset;
48c7ae67 PA	87	} __attribute__((packed));
	88
	89	struct sys_desc_table {
ee8e7cfe RR	90	__u16 length;
ee8e7cfe RR	91	__u8 table[14];
48c7ae67 PA	92	};
48c7ae67 PA	93
fd699c76 AS	94	/* Gleaned from OFW's set-parameters in cpu/x86/pc/linux.fth */
	95	struct olpc_ofw_header {
	96	__u32 ofw_magic; /* OFW signature */
	97	__u32 ofw_version;
	98	__u32 cif_handler; /* callback into OFW */
	99	__u32 irq_desc_table;
	100	} __attribute__((packed));
	101
48c7ae67	102	struct efi_info {
5b83683f	103	__u32 efi_loader_signature;
ee8e7cfe RR	104	__u32 efi_systab;
	105	__u32 efi_memdesc_size;
	106	__u32 efi_memdesc_version;
	107	__u32 efi_memmap;
	108	__u32 efi_memmap_size;
5b83683f HY	109	__u32 efi_systab_hi;
5b83683f HY	110	__u32 efi_memmap_hi;
48c7ae67 PA	111	};
	112
	113	/* The so-called "zeropage" */
	114	struct boot_params {
	115	struct screen_info screen_info; /* 0x000 */
	116	struct apm_bios_info apm_bios_info; /* 0x040 */
31625340 JC	117	__u8 _pad2[4]; /* 0x054 */
31625340 JC	118	__u64 tboot_addr; /* 0x058 */
238b706d	119	struct ist_info ist_info; /* 0x060 */
ee8e7cfe RR	120	__u8 _pad3[16]; /* 0x070 */
	121	__u8 hd0_info[16]; /* obsolete! / / 0x080 */
	122	__u8 hd1_info[16]; /* obsolete! / / 0x090 */
94916301	123	struct sys_desc_table sys_desc_table; /* obsolete! / / 0x0a0 */
fd699c76	124	struct olpc_ofw_header olpc_ofw_header; /* 0x0b0 */
09c205af PA	125	__u32 ext_ramdisk_image; /* 0x0c0 */
	126	__u32 ext_ramdisk_size; /* 0x0c4 */
	127	__u32 ext_cmd_line_ptr; /* 0x0c8 */
	128	__u8 _pad4[116]; /* 0x0cc */
48c7ae67 PA	129	struct edid_info edid_info; /* 0x140 */
48c7ae67 PA	130	struct efi_info efi_info; /* 0x1c0 */
ee8e7cfe RR	131	__u32 alt_mem_k; /* 0x1e0 */
	132	__u32 scratch; /* Scratch field! / / 0x1e4 */
	133	__u8 e820_entries; /* 0x1e8 */
	134	__u8 eddbuf_entries; /* 0x1e9 */
	135	__u8 edd_mbr_sig_buf_entries; /* 0x1ea */
b2d0b7a0	136	__u8 kbd_status; /* 0x1eb */
09c205af PA	137	__u8 _pad5[3]; /* 0x1ec */
	138	/*
	139	* The sentinel is set to a nonzero value (0xff) in header.S.
	140	*
	141	* A bootloader is supposed to only take setup_header and put
	142	* it into a clean boot_params buffer. If it turns out that
	143	* it is clumsy or too generous with the buffer, it most
	144	* probably will pick up the sentinel variable too. The fact
	145	* that this variable then is still 0xff will let kernel
	146	* know that some variables in boot_params are invalid and
	147	* kernel should zero out certain portions of boot_params.
	148	*/
	149	__u8 sentinel; /* 0x1ef */
	150	__u8 _pad6[1]; /* 0x1f0 */
48c7ae67	151	struct setup_header hdr; /* setup header / / 0x1f1 */
ee8e7cfe RR	152	__u8 _pad7[0x290-0x1f1-sizeof(struct setup_header)];
ee8e7cfe RR	153	__u32 edd_mbr_sig_buffer[EDD_MBR_SIG_MAX]; /* 0x290 */
48c7ae67	154	struct e820entry e820_map[E820MAX]; /* 0x2d0 */
ee8e7cfe	155	__u8 _pad8[48]; /* 0xcd0 */
48c7ae67	156	struct edd_info eddbuf[EDDMAXNR]; /* 0xd00 */
ee8e7cfe	157	__u8 _pad9[276]; /* 0xeec */
48c7ae67 PA	158	} __attribute__((packed));
48c7ae67 PA	159
18c78a96 LR	160	/**
	161	* enum x86_hardware_subarch - x86 hardware subarchitecture
	162	*
	163	* The x86 hardware_subarch and hardware_subarch_data were added as of the x86
	164	* boot protocol 2.07 to help distinguish and support custom x86 boot
	165	* sequences. This enum represents accepted values for the x86
	166	* hardware_subarch. Custom x86 boot sequences (not X86_SUBARCH_PC) do not
	167	* have or simply cannot make use of natural stubs like BIOS or EFI, the
	168	* hardware_subarch can be used on the Linux entry path to revector to a
	169	* subarchitecture stub when needed. This subarchitecture stub can be used to
	170	* set up Linux boot parameters or for special care to account for nonstandard
	171	* handling of page tables.
	172	*
	173	* These enums should only ever be used by x86 code, and the code that uses
	174	* it should be well contained and compartamentalized.
	175	*
	176	* KVM and Xen HVM do not have a subarch as these are expected to follow
	177	* standard x86 boot entries. If there is a genuine need for "hypervisor" type
	178	* that should be considered separately in the future. Future guest types
	179	* should seriously consider working with standard x86 boot stubs such as
	180	* the BIOS or EFI boot stubs.
	181	*
	182	* WARNING: this enum is only used for legacy hacks, for platform features that
	183	* are not easily enumerated or discoverable. You should not ever use
	184	* this for new features.
	185	*
	186	* @X86_SUBARCH_PC: Should be used if the hardware is enumerable using standard
	187	* PC mechanisms (PCI, ACPI) and doesn't need a special boot flow.
	188	* @X86_SUBARCH_LGUEST: Used for x86 hypervisor demo, lguest
	189	* @X86_SUBARCH_XEN: Used for Xen guest types which follow the PV boot path,
	190	* which start at asm startup_xen() entry point and later jump to the C
	191	* xen_start_kernel() entry point. Both domU and dom0 type of guests are
	192	* currently supportd through this PV boot path.
	193	* @X86_SUBARCH_INTEL_MID: Used for Intel MID (Mobile Internet Device) platform
	194	* systems which do not have the PCI legacy interfaces.
	195	* @X86_SUBARCH_CE4100: Used for Intel CE media processor (CE4100) SoC for
	196	* for settop boxes and media devices, the use of a subarch for CE4100
	197	* is more of a hack...
	198	*/
	199	enum x86_hardware_subarch {
162bc7ab PJ	200	X86_SUBARCH_PC = 0,
	201	X86_SUBARCH_LGUEST,
	202	X86_SUBARCH_XEN,
712b6aa8	203	X86_SUBARCH_INTEL_MID,
c751e17b	204	X86_SUBARCH_CE4100,
162bc7ab PJ	205	X86_NR_SUBARCHS,
	206	};
	207
09c205af	208	#endif /* __ASSEMBLY__ */
162bc7ab	209
1965aae3	210	#endif /* _ASM_X86_BOOTPARAM_H */