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