Whoever put together the grub multiboot.h header is insane.
[people/xl0/gpxe.git] / src / arch / i386 / include / multiboot.h
1 #ifndef _MULTIBOOT_H
2 #define _MULTIBOOT_H
3
4 /**
5  * @file
6  *
7  * Multiboot operating systems
8  *
9  */
10
11 #include <stdint.h>
12
13 /** The magic number for the Multiboot header */
14 #define MULTIBOOT_HEADER_MAGIC 0x1BADB002
15
16 /** Boot modules must be page aligned */
17 #define MB_FLAG_PGALIGN 0x00000001
18
19 /** Memory map must be provided */
20 #define MB_FLAG_MEMMAP 0x00000002
21
22 /** Video mode information must be provided */
23 #define MB_FLAG_VIDMODE 0x00000004
24
25 /** Image is a raw multiboot image (not ELF) */
26 #define MB_FLAG_RAW 0x00010000
27
28 /**
29  * The magic number passed by a Multiboot-compliant boot loader
30  *
31  * Must be passed in register %eax when jumping to the Multiboot OS
32  * image.
33  */
34 #define MULTIBOOT_BOOTLOADER_MAGIC 0x2BADB002
35
36 /** Multiboot information structure mem_* fields are valid */
37 #define MBI_FLAG_MEM 0x00000001
38
39 /** Multiboot information structure boot_device field is valid */
40 #define MBI_FLAG_BOOTDEV 0x00000002
41
42 /** Multiboot information structure cmdline field is valid */
43 #define MBI_FLAG_CMDLINE 0x00000004
44
45 /** Multiboot information structure module fields are valid */
46 #define MBI_FLAG_MODS 0x00000008
47
48 /** Multiboot information structure a.out symbol table is valid */
49 #define MBI_FLAG_AOUT 0x00000010
50
51 /** Multiboot information struture ELF section header table is valid */
52 #define MBI_FLAG_ELF 0x00000020
53
54 /** Multiboot information structure memory map is valid */
55 #define MBI_FLAG_MMAP 0x00000040
56
57 /** Multiboot information structure drive list is valid */
58 #define MBI_FLAG_DRIVES 0x00000080
59
60 /** Multiboot information structure ROM configuration field is valid */
61 #define MBI_FLAG_CFGTBL 0x00000100
62
63 /** Multiboot information structure boot loader name field is valid */
64 #define MBI_FLAG_LOADER 0x00000200
65
66 /** Multiboot information structure APM table is valid */
67 #define MBI_FLAG_APM 0x00000400
68
69 /** Multiboot information structure video information is valid */
70 #define MBI_FLAG_VBE 0x00000800
71
72 /** A multiboot header */
73 struct multiboot_header {
74         uint32_t magic;
75         uint32_t flags;
76         uint32_t checksum;
77         uint32_t header_addr;
78         uint32_t load_addr;
79         uint32_t load_end_addr;
80         uint32_t bss_end_addr;
81         uint32_t entry_addr;
82 } __attribute__ (( packed, may_alias ));
83
84 /** A multiboot a.out symbol table */
85 struct multiboot_aout_symbol_table {
86         uint32_t tabsize;
87         uint32_t strsize;
88         uint32_t addr;
89         uint32_t reserved;
90 } __attribute__ (( packed, may_alias ));
91
92 /** A multiboot ELF section header table */
93 struct multiboot_elf_section_header_table {
94         uint32_t num;
95         uint32_t size;
96         uint32_t addr;
97         uint32_t shndx;
98 } __attribute__ (( packed, may_alias ));
99
100 /** A multiboot information structure */
101 struct multiboot_info {
102         uint32_t flags;
103         uint32_t mem_lower;
104         uint32_t mem_upper;
105         uint32_t boot_device;
106         uint32_t cmdline;
107         uint32_t mods_count;
108         uint32_t mods_addr;
109         union {
110                 struct multiboot_aout_symbol_table aout_syms;
111                 struct multiboot_elf_section_header_table elf_sections;
112         } syms;
113         uint32_t mmap_length;
114         uint32_t mmap_addr;
115         uint32_t drives_length;
116         uint32_t drives_addr;
117         uint32_t config_table;
118         uint32_t boot_loader_name;
119         uint32_t apm_table;
120         uint32_t vbe_control_info;
121         uint32_t vbe_mode_info;
122         uint16_t vbe_mode;
123         uint16_t vbe_interface_seg;
124         uint16_t vbe_interface_off;
125         uint16_t vbe_interface_len;
126 } __attribute__ (( packed, may_alias ));
127
128 /** A multiboot module structure */
129 struct multiboot_module {
130         uint32_t mod_start;
131         uint32_t mod_end;
132         uint32_t string;
133         uint32_t reserved;
134 } __attribute__ (( packed, may_alias ));
135
136 /** A multiboot memory map entry */
137 struct multiboot_memory_map {
138         uint32_t size;
139         uint64_t base_addr;
140         uint64_t length;
141         uint32_t type;
142 } __attribute__ (( packed, may_alias ));
143
144 /** Usable RAM */
145 #define MBMEM_RAM 1
146
147 #endif /* _MULTIBOOT_H */