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