[linux-2.6-block.git] / arch / x86 / include / uapi / asm / bootparam.h

/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
#ifndef _ASM_X86_BOOTPARAM_H
#define _ASM_X86_BOOTPARAM_H

/* setup_data/setup_indirect types */
#define SETUP_NONE			0
#define SETUP_E820_EXT			1
#define SETUP_DTB			2
#define SETUP_PCI			3
#define SETUP_EFI			4
#define SETUP_APPLE_PROPERTIES		5
#define SETUP_JAILHOUSE			6

#define SETUP_INDIRECT			(1<<31)

/* SETUP_INDIRECT | max(SETUP_*) */
#define SETUP_TYPE_MAX			(SETUP_INDIRECT | SETUP_JAILHOUSE)

/* 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)
#define XLF_5LEVEL			(1<<5)
#define XLF_5LEVEL_ENABLED		(1<<6)

#ifndef __ASSEMBLY__

#include <linux/types.h>
#include <linux/screen_info.h>
#include <linux/apm_bios.h>
#include <linux/edd.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];
};

/* extensible setup indirect data node */
struct setup_indirect {
	__u32 type;
	__u32 reserved;  /* Reserved, must be set to zero. */
	__u64 len;
	__u64 addr;
};

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_seg;
	__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;
	__u32	kernel_info_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;
};

/*
 * This is the maximum number of entries in struct boot_params::e820_table
 * (the zeropage), which is part of the x86 boot protocol ABI:
 */
#define E820_MAX_ENTRIES_ZEROPAGE 128

/*
 * The E820 memory region entry of the boot protocol ABI:
 */
struct boot_e820_entry {
	__u64 addr;
	__u64 size;
	__u32 type;
} __attribute__((packed));

/*
 * Smallest compatible version of jailhouse_setup_data required by this kernel.
 */
#define JAILHOUSE_SETUP_REQUIRED_VERSION	1

/*
 * The boot loader is passing platform information via this Jailhouse-specific
 * setup data structure.
 */
struct jailhouse_setup_data {
	struct {
		__u16	version;
		__u16	compatible_version;
	} __attribute__((packed)) hdr;
	struct {
		__u16	pm_timer_address;
		__u16	num_cpus;
		__u64	pci_mmconfig_base;
		__u32	tsc_khz;
		__u32	apic_khz;
		__u8	standard_ioapic;
		__u8	cpu_ids[255];
	} __attribute__((packed)) v1;
	struct {
		__u32	flags;
	} __attribute__((packed)) v2;
} __attribute__((packed));

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