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