include/multiboot2.h

   1 /*  multiboot2.h - Multiboot 2 header file.  */
   2 /*  Copyright (C) 1999,2003,2007,2008,2009,2010  Free Software Foundation, Inc.
   3  *
   4  *  Permission is hereby granted, free of charge, to any person obtaining a copy
   5  *  of this software and associated documentation files (the "Software"), to
   6  *  deal in the Software without restriction, including without limitation the
   7  *  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   8  *  sell copies of the Software, and to permit persons to whom the Software is
   9  *  furnished to do so, subject to the following conditions:
  10  *
  11  *  The above copyright notice and this permission notice shall be included in
  12  *  all copies or substantial portions of the Software.
  13  *
  14  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL ANY
  17  *  DEVELOPER OR DISTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  18  *  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
  19  *  IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  20  */
  21
  22 #ifndef MULTIBOOT_HEADER
  23 #define MULTIBOOT_HEADER 1
  24
  25 /* How many bytes from the start of the file we search for the header.  */
  26 #define MULTIBOOT_SEARCH                        32768
  27 #define MULTIBOOT_HEADER_ALIGN                  8
  28
  29 /* The magic field should contain this.  */
  30 #define MULTIBOOT2_HEADER_MAGIC                 0xe85250d6
  31
  32 /* This should be in %eax.  */
  33 #define MULTIBOOT2_BOOTLOADER_MAGIC             0x36d76289
  34
  35 /* Alignment of multiboot modules.  */
  36 #define MULTIBOOT_MOD_ALIGN                     0x00001000
  37
  38 /* Alignment of the multiboot info structure.  */
  39 #define MULTIBOOT_INFO_ALIGN                    0x00000008
  40
  41 /* Flags set in the 'flags' member of the multiboot header.  */
  42
  43 #define MULTIBOOT_TAG_ALIGN                  8
  44 #define MULTIBOOT_TAG_TYPE_END               0
  45 #define MULTIBOOT_TAG_TYPE_CMDLINE           1
  46 #define MULTIBOOT_TAG_TYPE_BOOT_LOADER_NAME  2
  47 #define MULTIBOOT_TAG_TYPE_MODULE            3
  48 #define MULTIBOOT_TAG_TYPE_BASIC_MEMINFO     4
  49 #define MULTIBOOT_TAG_TYPE_BOOTDEV           5
  50 #define MULTIBOOT_TAG_TYPE_MMAP              6
  51 #define MULTIBOOT_TAG_TYPE_VBE               7
  52 #define MULTIBOOT_TAG_TYPE_FRAMEBUFFER       8
  53 #define MULTIBOOT_TAG_TYPE_ELF_SECTIONS      9
  54 #define MULTIBOOT_TAG_TYPE_APM               10
  55 #define MULTIBOOT_TAG_TYPE_EFI32             11
  56 #define MULTIBOOT_TAG_TYPE_EFI64             12
  57 #define MULTIBOOT_TAG_TYPE_SMBIOS            13
  58 #define MULTIBOOT_TAG_TYPE_ACPI_OLD          14
  59 #define MULTIBOOT_TAG_TYPE_ACPI_NEW          15
  60 #define MULTIBOOT_TAG_TYPE_NETWORK           16
  61 #define MULTIBOOT_TAG_TYPE_EFI_MMAP          17
  62
  63 #define MULTIBOOT_HEADER_TAG_END  0
  64 #define MULTIBOOT_HEADER_TAG_INFORMATION_REQUEST  1
  65 #define MULTIBOOT_HEADER_TAG_ADDRESS  2
  66 #define MULTIBOOT_HEADER_TAG_ENTRY_ADDRESS  3
  67 #define MULTIBOOT_HEADER_TAG_CONSOLE_FLAGS  4
  68 #define MULTIBOOT_HEADER_TAG_FRAMEBUFFER  5
  69 #define MULTIBOOT_HEADER_TAG_MODULE_ALIGN  6
  70
  71 #define MULTIBOOT_ARCHITECTURE_I386  0
  72 #define MULTIBOOT_ARCHITECTURE_MIPS32  4
  73 #define MULTIBOOT_HEADER_TAG_OPTIONAL 1
  74
  75 #define MULTIBOOT_CONSOLE_FLAGS_CONSOLE_REQUIRED 1
  76 #define MULTIBOOT_CONSOLE_FLAGS_EGA_TEXT_SUPPORTED 2
  77
  78 #ifndef ASM_FILE
  79
  80 typedef unsigned char           multiboot_uint8_t;
  81 typedef unsigned short          multiboot_uint16_t;
  82 typedef unsigned int            multiboot_uint32_t;
  83 typedef unsigned long long      multiboot_uint64_t;
  84
  85 struct multiboot_header
  86 {
  87   /* Must be MULTIBOOT_MAGIC - see above.  */
  88   multiboot_uint32_t magic;
  89
  90   /* ISA */
  91   multiboot_uint32_t architecture;
  92
  93   /* Total header length.  */
  94   multiboot_uint32_t header_length;
  95
  96   /* The above fields plus this one must equal 0 mod 2^32. */
  97   multiboot_uint32_t checksum;
  98 };
  99
 100 struct multiboot_header_tag
 101 {
 102   multiboot_uint16_t type;
 103   multiboot_uint16_t flags;
 104   multiboot_uint32_t size;
 105 };
 106
 107 struct multiboot_header_tag_information_request
 108 {
 109   multiboot_uint16_t type;
 110   multiboot_uint16_t flags;
 111   multiboot_uint32_t size;
 112   multiboot_uint32_t requests[0];
 113 };
 114
 115 struct multiboot_header_tag_address
 116 {
 117   multiboot_uint16_t type;
 118   multiboot_uint16_t flags;
 119   multiboot_uint32_t size;
 120   multiboot_uint32_t header_addr;
 121   multiboot_uint32_t load_addr;
 122   multiboot_uint32_t load_end_addr;
 123   multiboot_uint32_t bss_end_addr;
 124 };
 125
 126 struct multiboot_header_tag_entry_address
 127 {
 128   multiboot_uint16_t type;
 129   multiboot_uint16_t flags;
 130   multiboot_uint32_t size;
 131   multiboot_uint32_t entry_addr;
 132 };
 133
 134 struct multiboot_header_tag_console_flags
 135 {
 136   multiboot_uint16_t type;
 137   multiboot_uint16_t flags;
 138   multiboot_uint32_t size;
 139   multiboot_uint32_t console_flags;
 140 };
 141
 142 struct multiboot_header_tag_framebuffer
 143 {
 144   multiboot_uint16_t type;
 145   multiboot_uint16_t flags;
 146   multiboot_uint32_t size;
 147   multiboot_uint32_t width;
 148   multiboot_uint32_t height;
 149   multiboot_uint32_t depth;
 150 };
 151
 152 struct multiboot_header_tag_module_align
 153 {
 154   multiboot_uint16_t type;
 155   multiboot_uint16_t flags;
 156   multiboot_uint32_t size;
 157   multiboot_uint32_t width;
 158   multiboot_uint32_t height;
 159   multiboot_uint32_t depth;
 160 };
 161
 162 struct multiboot_color
 163 {
 164   multiboot_uint8_t red;
 165   multiboot_uint8_t green;
 166   multiboot_uint8_t blue;
 167 };
 168
 169 struct multiboot_mmap_entry
 170 {
 171   multiboot_uint64_t addr;
 172   multiboot_uint64_t len;
 173 #define MULTIBOOT_MEMORY_AVAILABLE              1
 174 #define MULTIBOOT_MEMORY_RESERVED               2
 175 #define MULTIBOOT_MEMORY_ACPI_RECLAIMABLE       3
 176 #define MULTIBOOT_MEMORY_NVS                    4
 177 #define MULTIBOOT_MEMORY_BADRAM                 5
 178   multiboot_uint32_t type;
 179   multiboot_uint32_t zero;
 180 } __attribute__((packed));
 181 typedef struct multiboot_mmap_entry multiboot_memory_map_t;
 182
 183 struct multiboot_tag
 184 {
 185   multiboot_uint32_t type;
 186   multiboot_uint32_t size;
 187 };
 188
 189 struct multiboot_tag_string
 190 {
 191   multiboot_uint32_t type;
 192   multiboot_uint32_t size;
 193   char string[0];
 194 };
 195
 196 struct multiboot_tag_module
 197 {
 198   multiboot_uint32_t type;
 199   multiboot_uint32_t size;
 200   multiboot_uint32_t mod_start;
 201   multiboot_uint32_t mod_end;
 202   char cmdline[0];
 203 };
 204
 205 struct multiboot_tag_basic_meminfo
 206 {
 207   multiboot_uint32_t type;
 208   multiboot_uint32_t size;
 209   multiboot_uint32_t mem_lower;
 210   multiboot_uint32_t mem_upper;
 211 };
 212
 213 struct multiboot_tag_bootdev
 214 {
 215   multiboot_uint32_t type;
 216   multiboot_uint32_t size;
 217   multiboot_uint32_t biosdev;
 218   multiboot_uint32_t slice;
 219   multiboot_uint32_t part;
 220 };
 221
 222 struct multiboot_tag_mmap
 223 {
 224   multiboot_uint32_t type;
 225   multiboot_uint32_t size;
 226   multiboot_uint32_t entry_size;
 227   multiboot_uint32_t entry_version;
 228   struct multiboot_mmap_entry entries[0];
 229 };
 230
 231 struct multiboot_vbe_info_block
 232 {
 233   multiboot_uint8_t external_specification[512];
 234 };
 235
 236 struct multiboot_vbe_mode_info_block
 237 {
 238   multiboot_uint8_t external_specification[256];
 239 };
 240
 241 struct multiboot_tag_vbe
 242 {
 243   multiboot_uint32_t type;
 244   multiboot_uint32_t size;
 245
 246   multiboot_uint16_t vbe_mode;
 247   multiboot_uint16_t vbe_interface_seg;
 248   multiboot_uint16_t vbe_interface_off;
 249   multiboot_uint16_t vbe_interface_len;
 250
 251   struct multiboot_vbe_info_block vbe_control_info;
 252   struct multiboot_vbe_mode_info_block vbe_mode_info;
 253 };
 254
 255 struct multiboot_tag_framebuffer_common
 256 {
 257   multiboot_uint32_t type;
 258   multiboot_uint32_t size;
 259
 260   multiboot_uint64_t framebuffer_addr;
 261   multiboot_uint32_t framebuffer_pitch;
 262   multiboot_uint32_t framebuffer_width;
 263   multiboot_uint32_t framebuffer_height;
 264   multiboot_uint8_t framebuffer_bpp;
 265 #define MULTIBOOT_FRAMEBUFFER_TYPE_INDEXED 0
 266 #define MULTIBOOT_FRAMEBUFFER_TYPE_RGB     1
 267 #define MULTIBOOT_FRAMEBUFFER_TYPE_EGA_TEXT     2
 268   multiboot_uint8_t framebuffer_type;
 269   multiboot_uint16_t reserved;
 270 };
 271
 272 struct multiboot_tag_framebuffer
 273 {
 274   struct multiboot_tag_framebuffer_common common;
 275
 276   union
 277   {
 278     struct
 279     {
 280       multiboot_uint16_t framebuffer_palette_num_colors;
 281       struct multiboot_color framebuffer_palette[0];
 282     };
 283     struct
 284     {
 285       multiboot_uint8_t framebuffer_red_field_position;
 286       multiboot_uint8_t framebuffer_red_mask_size;
 287       multiboot_uint8_t framebuffer_green_field_position;
 288       multiboot_uint8_t framebuffer_green_mask_size;
 289       multiboot_uint8_t framebuffer_blue_field_position;
 290       multiboot_uint8_t framebuffer_blue_mask_size;
 291     };
 292   };
 293 };
 294
 295 struct multiboot_tag_elf_sections
 296 {
 297   multiboot_uint32_t type;
 298   multiboot_uint32_t size;
 299   multiboot_uint32_t num;
 300   multiboot_uint32_t entsize;
 301   multiboot_uint32_t shndx;
 302   char sections[0];
 303 };
 304
 305 struct multiboot_tag_apm
 306 {
 307   multiboot_uint32_t type;
 308   multiboot_uint32_t size;
 309   multiboot_uint16_t version;
 310   multiboot_uint16_t cseg;
 311   multiboot_uint32_t offset;
 312   multiboot_uint16_t cseg_16;
 313   multiboot_uint16_t dseg;
 314   multiboot_uint16_t flags;
 315   multiboot_uint16_t cseg_len;
 316   multiboot_uint16_t cseg_16_len;
 317   multiboot_uint16_t dseg_len;
 318 };
 319
 320 struct multiboot_tag_efi32
 321 {
 322   multiboot_uint32_t type;
 323   multiboot_uint32_t size;
 324   multiboot_uint32_t pointer;
 325 };
 326
 327 struct multiboot_tag_efi64
 328 {
 329   multiboot_uint32_t type;
 330   multiboot_uint32_t size;
 331   multiboot_uint64_t pointer;
 332 };
 333
 334 struct multiboot_tag_smbios
 335 {
 336   multiboot_uint32_t type;
 337   multiboot_uint32_t size;
 338   multiboot_uint8_t major;
 339   multiboot_uint8_t minor;
 340   multiboot_uint8_t reserved[6];
 341   multiboot_uint8_t tables[0];
 342 };
 343
 344 struct multiboot_tag_old_acpi
 345 {
 346   multiboot_uint32_t type;
 347   multiboot_uint32_t size;
 348   multiboot_uint8_t rsdp[0];
 349 };
 350
 351 struct multiboot_tag_new_acpi
 352 {
 353   multiboot_uint32_t type;
 354   multiboot_uint32_t size;
 355   multiboot_uint8_t rsdp[0];
 356 };
 357
 358 struct multiboot_tag_network
 359 {
 360   multiboot_uint32_t type;
 361   multiboot_uint32_t size;
 362   multiboot_uint8_t dhcpack[0];
 363 };
 364
 365 struct multiboot_tag_efi_mmap
 366 {
 367   multiboot_uint32_t type;
 368   multiboot_uint32_t size;
 369   multiboot_uint32_t descr_size;
 370   multiboot_uint32_t descr_vers;
 371   multiboot_uint8_t efi_mmap[0];
 372 };
 373
 374 #endif /* ! ASM_FILE */
 375
 376 #endif /* ! MULTIBOOT_HEADER */