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