1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 #ifndef _ASM_X86_BOOTPARAM_H
3 #define _ASM_X86_BOOTPARAM_H
5 /* setup_data/setup_indirect types */
7 #define SETUP_E820_EXT 1
11 #define SETUP_APPLE_PROPERTIES 5
12 #define SETUP_JAILHOUSE 6
13 #define SETUP_CC_BLOB 7
15 #define SETUP_INDIRECT (1<<31)
17 /* SETUP_INDIRECT | max(SETUP_*) */
18 #define SETUP_TYPE_MAX (SETUP_INDIRECT | SETUP_JAILHOUSE)
21 #define RAMDISK_IMAGE_START_MASK 0x07FF
22 #define RAMDISK_PROMPT_FLAG 0x8000
23 #define RAMDISK_LOAD_FLAG 0x4000
26 #define LOADED_HIGH (1<<0)
27 #define KASLR_FLAG (1<<1)
28 #define QUIET_FLAG (1<<5)
29 #define KEEP_SEGMENTS (1<<6)
30 #define CAN_USE_HEAP (1<<7)
33 #define XLF_KERNEL_64 (1<<0)
34 #define XLF_CAN_BE_LOADED_ABOVE_4G (1<<1)
35 #define XLF_EFI_HANDOVER_32 (1<<2)
36 #define XLF_EFI_HANDOVER_64 (1<<3)
37 #define XLF_EFI_KEXEC (1<<4)
38 #define XLF_5LEVEL (1<<5)
39 #define XLF_5LEVEL_ENABLED (1<<6)
43 #include <linux/types.h>
44 #include <linux/screen_info.h>
45 #include <linux/apm_bios.h>
46 #include <linux/edd.h>
48 #include <video/edid.h>
50 /* extensible setup data list node */
58 /* extensible setup indirect data node */
59 struct setup_indirect {
61 __u32 reserved; /* Reserved, must be set to zero. */
82 __u16 setup_move_size;
86 __u32 bootsect_kludge;
91 __u32 initrd_addr_max;
92 __u32 kernel_alignment;
93 __u8 relocatable_kernel;
97 __u32 hardware_subarch;
98 __u64 hardware_subarch_data;
100 __u32 payload_length;
104 __u32 handover_offset;
105 __u32 kernel_info_offset;
106 } __attribute__((packed));
108 struct sys_desc_table {
113 /* Gleaned from OFW's set-parameters in cpu/x86/pc/linux.fth */
114 struct olpc_ofw_header {
115 __u32 ofw_magic; /* OFW signature */
117 __u32 cif_handler; /* callback into OFW */
118 __u32 irq_desc_table;
119 } __attribute__((packed));
122 __u32 efi_loader_signature;
124 __u32 efi_memdesc_size;
125 __u32 efi_memdesc_version;
127 __u32 efi_memmap_size;
133 * This is the maximum number of entries in struct boot_params::e820_table
134 * (the zeropage), which is part of the x86 boot protocol ABI:
136 #define E820_MAX_ENTRIES_ZEROPAGE 128
139 * The E820 memory region entry of the boot protocol ABI:
141 struct boot_e820_entry {
145 } __attribute__((packed));
148 * Smallest compatible version of jailhouse_setup_data required by this kernel.
150 #define JAILHOUSE_SETUP_REQUIRED_VERSION 1
153 * The boot loader is passing platform information via this Jailhouse-specific
154 * setup data structure.
156 struct jailhouse_setup_data {
159 __u16 compatible_version;
160 } __attribute__((packed)) hdr;
162 __u16 pm_timer_address;
164 __u64 pci_mmconfig_base;
167 __u8 standard_ioapic;
169 } __attribute__((packed)) v1;
172 } __attribute__((packed)) v2;
173 } __attribute__((packed));
175 /* The so-called "zeropage" */
177 struct screen_info screen_info; /* 0x000 */
178 struct apm_bios_info apm_bios_info; /* 0x040 */
179 __u8 _pad2[4]; /* 0x054 */
180 __u64 tboot_addr; /* 0x058 */
181 struct ist_info ist_info; /* 0x060 */
182 __u64 acpi_rsdp_addr; /* 0x070 */
183 __u8 _pad3[8]; /* 0x078 */
184 __u8 hd0_info[16]; /* obsolete! */ /* 0x080 */
185 __u8 hd1_info[16]; /* obsolete! */ /* 0x090 */
186 struct sys_desc_table sys_desc_table; /* obsolete! */ /* 0x0a0 */
187 struct olpc_ofw_header olpc_ofw_header; /* 0x0b0 */
188 __u32 ext_ramdisk_image; /* 0x0c0 */
189 __u32 ext_ramdisk_size; /* 0x0c4 */
190 __u32 ext_cmd_line_ptr; /* 0x0c8 */
191 __u8 _pad4[112]; /* 0x0cc */
192 __u32 cc_blob_address; /* 0x13c */
193 struct edid_info edid_info; /* 0x140 */
194 struct efi_info efi_info; /* 0x1c0 */
195 __u32 alt_mem_k; /* 0x1e0 */
196 __u32 scratch; /* Scratch field! */ /* 0x1e4 */
197 __u8 e820_entries; /* 0x1e8 */
198 __u8 eddbuf_entries; /* 0x1e9 */
199 __u8 edd_mbr_sig_buf_entries; /* 0x1ea */
200 __u8 kbd_status; /* 0x1eb */
201 __u8 secure_boot; /* 0x1ec */
202 __u8 _pad5[2]; /* 0x1ed */
204 * The sentinel is set to a nonzero value (0xff) in header.S.
206 * A bootloader is supposed to only take setup_header and put
207 * it into a clean boot_params buffer. If it turns out that
208 * it is clumsy or too generous with the buffer, it most
209 * probably will pick up the sentinel variable too. The fact
210 * that this variable then is still 0xff will let kernel
211 * know that some variables in boot_params are invalid and
212 * kernel should zero out certain portions of boot_params.
214 __u8 sentinel; /* 0x1ef */
215 __u8 _pad6[1]; /* 0x1f0 */
216 struct setup_header hdr; /* setup header */ /* 0x1f1 */
217 __u8 _pad7[0x290-0x1f1-sizeof(struct setup_header)];
218 __u32 edd_mbr_sig_buffer[EDD_MBR_SIG_MAX]; /* 0x290 */
219 struct boot_e820_entry e820_table[E820_MAX_ENTRIES_ZEROPAGE]; /* 0x2d0 */
220 __u8 _pad8[48]; /* 0xcd0 */
221 struct edd_info eddbuf[EDDMAXNR]; /* 0xd00 */
222 __u8 _pad9[276]; /* 0xeec */
223 } __attribute__((packed));
226 * enum x86_hardware_subarch - x86 hardware subarchitecture
228 * The x86 hardware_subarch and hardware_subarch_data were added as of the x86
229 * boot protocol 2.07 to help distinguish and support custom x86 boot
230 * sequences. This enum represents accepted values for the x86
231 * hardware_subarch. Custom x86 boot sequences (not X86_SUBARCH_PC) do not
232 * have or simply *cannot* make use of natural stubs like BIOS or EFI, the
233 * hardware_subarch can be used on the Linux entry path to revector to a
234 * subarchitecture stub when needed. This subarchitecture stub can be used to
235 * set up Linux boot parameters or for special care to account for nonstandard
236 * handling of page tables.
238 * These enums should only ever be used by x86 code, and the code that uses
239 * it should be well contained and compartmentalized.
241 * KVM and Xen HVM do not have a subarch as these are expected to follow
242 * standard x86 boot entries. If there is a genuine need for "hypervisor" type
243 * that should be considered separately in the future. Future guest types
244 * should seriously consider working with standard x86 boot stubs such as
245 * the BIOS or EFI boot stubs.
247 * WARNING: this enum is only used for legacy hacks, for platform features that
248 * are not easily enumerated or discoverable. You should not ever use
249 * this for new features.
251 * @X86_SUBARCH_PC: Should be used if the hardware is enumerable using standard
252 * PC mechanisms (PCI, ACPI) and doesn't need a special boot flow.
253 * @X86_SUBARCH_LGUEST: Used for x86 hypervisor demo, lguest, deprecated
254 * @X86_SUBARCH_XEN: Used for Xen guest types which follow the PV boot path,
255 * which start at asm startup_xen() entry point and later jump to the C
256 * xen_start_kernel() entry point. Both domU and dom0 type of guests are
257 * currently supported through this PV boot path.
258 * @X86_SUBARCH_INTEL_MID: Used for Intel MID (Mobile Internet Device) platform
259 * systems which do not have the PCI legacy interfaces.
260 * @X86_SUBARCH_CE4100: Used for Intel CE media processor (CE4100) SoC
261 * for settop boxes and media devices, the use of a subarch for CE4100
262 * is more of a hack...
264 enum x86_hardware_subarch {
268 X86_SUBARCH_INTEL_MID,
273 #endif /* __ASSEMBLY__ */
275 #endif /* _ASM_X86_BOOTPARAM_H */