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