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