lunaix-os/arch/x86/includes/sys/boot/mb2.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 LUNAIX_MULTIBOOT_HEADER
  23 #define LUNAIX_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 /*  This should be in %eax. */
  30 #define MULTIBOOT_BOOTLOADER_MAGIC             0x36d76289
  31
  32 /*  Alignment of multiboot modules. */
  33 #define MULTIBOOT_MOD_ALIGN                     0x00001000
  34
  35 /*  Alignment of the multiboot info structure. */
  36 #define MULTIBOOT_INFO_ALIGN                    0x00000008
  37
  38 /*  Flags set in the ’flags’ member of the multiboot header. */
  39
  40 #define MULTIBOOT_TAG_ALIGN                  8
  41 #define MULTIBOOT_TAG_TYPE_END               0
  42 #define MULTIBOOT_TAG_TYPE_CMDLINE           1
  43 #define MULTIBOOT_TAG_TYPE_BOOT_LOADER_NAME  2
  44 #define MULTIBOOT_TAG_TYPE_MODULE            3
  45 #define MULTIBOOT_TAG_TYPE_BASIC_MEMINFO     4
  46 #define MULTIBOOT_TAG_TYPE_BOOTDEV           5
  47 #define MULTIBOOT_TAG_TYPE_MMAP              6
  48 #define MULTIBOOT_TAG_TYPE_VBE               7
  49 #define MULTIBOOT_TAG_TYPE_FRAMEBUFFER       8
  50 #define MULTIBOOT_TAG_TYPE_ELF_SECTIONS      9
  51 #define MULTIBOOT_TAG_TYPE_APM               10
  52 #define MULTIBOOT_TAG_TYPE_EFI32             11
  53 #define MULTIBOOT_TAG_TYPE_EFI64             12
  54 #define MULTIBOOT_TAG_TYPE_SMBIOS            13
  55 #define MULTIBOOT_TAG_TYPE_ACPI_OLD          14
  56 #define MULTIBOOT_TAG_TYPE_ACPI_NEW          15
  57 #define MULTIBOOT_TAG_TYPE_NETWORK           16
  58 #define MULTIBOOT_TAG_TYPE_EFI_MMAP          17
  59 #define MULTIBOOT_TAG_TYPE_EFI_BS            18
  60 #define MULTIBOOT_TAG_TYPE_EFI32_IH          19
  61 #define MULTIBOOT_TAG_TYPE_EFI64_IH          20
  62 #define MULTIBOOT_TAG_TYPE_LOAD_BASE_ADDR    21
  63
  64 #define MULTIBOOT_HEADER_TAG_END  0
  65 #define MULTIBOOT_HEADER_TAG_INFORMATION_REQUEST  1
  66 #define MULTIBOOT_HEADER_TAG_ADDRESS  2
  67 #define MULTIBOOT_HEADER_TAG_ENTRY_ADDRESS  3
  68 #define MULTIBOOT_HEADER_TAG_CONSOLE_FLAGS  4
  69 #define MULTIBOOT_HEADER_TAG_FRAMEBUFFER  5
  70 #define MULTIBOOT_HEADER_TAG_MODULE_ALIGN  6
  71 #define MULTIBOOT_HEADER_TAG_EFI_BS        7
  72 #define MULTIBOOT_HEADER_TAG_ENTRY_ADDRESS_EFI32  8
  73 #define MULTIBOOT_HEADER_TAG_ENTRY_ADDRESS_EFI64  9
  74 #define MULTIBOOT_HEADER_TAG_RELOCATABLE  10
  75
  76 #define MULTIBOOT_ARCHITECTURE_I386  0
  77 #define MULTIBOOT_ARCHITECTURE_MIPS32  4
  78 #define MULTIBOOT_HEADER_TAG_OPTIONAL 1
  79
  80 #define MULTIBOOT_LOAD_PREFERENCE_NONE 0
  81 #define MULTIBOOT_LOAD_PREFERENCE_LOW 1
  82 #define MULTIBOOT_LOAD_PREFERENCE_HIGH 2
  83
  84 #define MULTIBOOT_CONSOLE_FLAGS_CONSOLE_REQUIRED 1
  85 #define MULTIBOOT_CONSOLE_FLAGS_EGA_TEXT_SUPPORTED 2
  86
  87 #ifndef __ASM__
  88
  89 typedef unsigned char           multiboot_uint8_t;
  90 typedef unsigned short          multiboot_uint16_t;
  91 typedef unsigned int            multiboot_uint32_t;
  92 typedef unsigned long long      multiboot_uint64_t;
  93
  94 struct multiboot_header
  95 {
  96   /*  Must be MULTIBOOT_MAGIC - see above. */
  97   multiboot_uint32_t magic;
  98
  99   /*  ISA */
 100   multiboot_uint32_t architecture;
 101
 102   /*  Total header length. */
 103   multiboot_uint32_t header_length;
 104
 105   /*  The above fields plus this one must equal 0 mod 2^32. */
 106   multiboot_uint32_t checksum;
 107 };
 108
 109 struct multiboot_header_tag
 110 {
 111   multiboot_uint16_t type;
 112   multiboot_uint16_t flags;
 113   multiboot_uint32_t size;
 114 };
 115
 116 struct multiboot_header_tag_information_request
 117 {
 118   multiboot_uint16_t type;
 119   multiboot_uint16_t flags;
 120   multiboot_uint32_t size;
 121   multiboot_uint32_t requests[0];
 122 };
 123
 124 struct multiboot_header_tag_address
 125 {
 126   multiboot_uint16_t type;
 127   multiboot_uint16_t flags;
 128   multiboot_uint32_t size;
 129   multiboot_uint32_t header_addr;
 130   multiboot_uint32_t load_addr;
 131   multiboot_uint32_t load_end_addr;
 132   multiboot_uint32_t bss_end_addr;
 133 };
 134
 135 struct multiboot_header_tag_entry_address
 136 {
 137   multiboot_uint16_t type;
 138   multiboot_uint16_t flags;
 139   multiboot_uint32_t size;
 140   multiboot_uint32_t entry_addr;
 141 };
 142
 143 struct multiboot_header_tag_console_flags
 144 {
 145   multiboot_uint16_t type;
 146   multiboot_uint16_t flags;
 147   multiboot_uint32_t size;
 148   multiboot_uint32_t console_flags;
 149 };
 150
 151 struct multiboot_header_tag_framebuffer
 152 {
 153   multiboot_uint16_t type;
 154   multiboot_uint16_t flags;
 155   multiboot_uint32_t size;
 156   multiboot_uint32_t width;
 157   multiboot_uint32_t height;
 158   multiboot_uint32_t depth;
 159 };
 160
 161 struct multiboot_header_tag_module_align
 162 {
 163   multiboot_uint16_t type;
 164   multiboot_uint16_t flags;
 165   multiboot_uint32_t size;
 166 };
 167
 168 struct multiboot_header_tag_relocatable
 169 {
 170   multiboot_uint16_t type;
 171   multiboot_uint16_t flags;
 172   multiboot_uint32_t size;
 173   multiboot_uint32_t min_addr;
 174   multiboot_uint32_t max_addr;
 175   multiboot_uint32_t align;
 176   multiboot_uint32_t preference;
 177 };
 178
 179 struct multiboot_color
 180 {
 181   multiboot_uint8_t red;
 182   multiboot_uint8_t green;
 183   multiboot_uint8_t blue;
 184 };
 185
 186 struct multiboot_mmap_entry
 187 {
 188   multiboot_uint64_t addr;
 189   multiboot_uint64_t len;
 190 #define MULTIBOOT_MEMORY_AVAILABLE              1
 191 #define MULTIBOOT_MEMORY_RESERVED               2
 192 #define MULTIBOOT_MEMORY_ACPI_RECLAIMABLE       3
 193 #define MULTIBOOT_MEMORY_NVS                    4
 194 #define MULTIBOOT_MEMORY_BADRAM                 5
 195   multiboot_uint32_t type;
 196   multiboot_uint32_t zero;
 197 };
 198 typedef struct multiboot_mmap_entry multiboot_memory_map_t;
 199
 200 struct multiboot_tag
 201 {
 202   multiboot_uint32_t type;
 203   multiboot_uint32_t size;
 204 };
 205
 206 struct multiboot_tag_string
 207 {
 208   multiboot_uint32_t type;
 209   multiboot_uint32_t size;
 210   char string[0];
 211 };
 212
 213 struct multiboot_tag_module
 214 {
 215   multiboot_uint32_t type;
 216   multiboot_uint32_t size;
 217   multiboot_uint32_t mod_start;
 218   multiboot_uint32_t mod_end;
 219   char cmdline[0];
 220 };
 221
 222 struct multiboot_tag_basic_meminfo
 223 {
 224   multiboot_uint32_t type;
 225   multiboot_uint32_t size;
 226   multiboot_uint32_t mem_lower;
 227   multiboot_uint32_t mem_upper;
 228 };
 229
 230 struct multiboot_tag_bootdev
 231 {
 232   multiboot_uint32_t type;
 233   multiboot_uint32_t size;
 234   multiboot_uint32_t biosdev;
 235   multiboot_uint32_t slice;
 236   multiboot_uint32_t part;
 237 };
 238
 239 struct multiboot_tag_mmap
 240 {
 241   multiboot_uint32_t type;
 242   multiboot_uint32_t size;
 243   multiboot_uint32_t entry_size;
 244   multiboot_uint32_t entry_version;
 245   struct multiboot_mmap_entry entries[0];
 246 };
 247
 248 struct multiboot_vbe_info_block
 249 {
 250   multiboot_uint8_t external_specification[512];
 251 };
 252
 253 struct multiboot_vbe_mode_info_block
 254 {
 255   multiboot_uint8_t external_specification[256];
 256 };
 257
 258 struct multiboot_tag_vbe
 259 {
 260   multiboot_uint32_t type;
 261   multiboot_uint32_t size;
 262
 263   multiboot_uint16_t vbe_mode;
 264   multiboot_uint16_t vbe_interface_seg;
 265   multiboot_uint16_t vbe_interface_off;
 266   multiboot_uint16_t vbe_interface_len;
 267
 268   struct multiboot_vbe_info_block vbe_control_info;
 269   struct multiboot_vbe_mode_info_block vbe_mode_info;
 270 };
 271
 272 struct multiboot_tag_framebuffer_common
 273 {
 274   multiboot_uint32_t type;
 275   multiboot_uint32_t size;
 276
 277   multiboot_uint64_t framebuffer_addr;
 278   multiboot_uint32_t framebuffer_pitch;
 279   multiboot_uint32_t framebuffer_width;
 280   multiboot_uint32_t framebuffer_height;
 281   multiboot_uint8_t framebuffer_bpp;
 282 #define MULTIBOOT_FRAMEBUFFER_TYPE_INDEXED 0
 283 #define MULTIBOOT_FRAMEBUFFER_TYPE_RGB     1
 284 #define MULTIBOOT_FRAMEBUFFER_TYPE_EGA_TEXT     2
 285   multiboot_uint8_t framebuffer_type;
 286   multiboot_uint16_t reserved;
 287 };
 288
 289 struct multiboot_tag_framebuffer
 290 {
 291   struct multiboot_tag_framebuffer_common common;
 292
 293   union
 294   {
 295     struct
 296     {
 297       multiboot_uint16_t framebuffer_palette_num_colors;
 298       struct multiboot_color framebuffer_palette[0];
 299     };
 300     struct
 301     {
 302       multiboot_uint8_t framebuffer_red_field_position;
 303       multiboot_uint8_t framebuffer_red_mask_size;
 304       multiboot_uint8_t framebuffer_green_field_position;
 305       multiboot_uint8_t framebuffer_green_mask_size;
 306       multiboot_uint8_t framebuffer_blue_field_position;
 307       multiboot_uint8_t framebuffer_blue_mask_size;
 308     };
 309   };
 310 };
 311
 312 struct multiboot_tag_elf_sections
 313 {
 314   multiboot_uint32_t type;
 315   multiboot_uint32_t size;
 316   multiboot_uint32_t num;
 317   multiboot_uint32_t entsize;
 318   multiboot_uint32_t shndx;
 319   char sections[0];
 320 };
 321
 322 struct multiboot_tag_apm
 323 {
 324   multiboot_uint32_t type;
 325   multiboot_uint32_t size;
 326   multiboot_uint16_t version;
 327   multiboot_uint16_t cseg;
 328   multiboot_uint32_t offset;
 329   multiboot_uint16_t cseg_16;
 330   multiboot_uint16_t dseg;
 331   multiboot_uint16_t flags;
 332   multiboot_uint16_t cseg_len;
 333   multiboot_uint16_t cseg_16_len;
 334   multiboot_uint16_t dseg_len;
 335 };
 336
 337 struct multiboot_tag_efi32
 338 {
 339   multiboot_uint32_t type;
 340   multiboot_uint32_t size;
 341   multiboot_uint32_t pointer;
 342 };
 343
 344 struct multiboot_tag_efi64
 345 {
 346   multiboot_uint32_t type;
 347   multiboot_uint32_t size;
 348   multiboot_uint64_t pointer;
 349 };
 350
 351 struct multiboot_tag_smbios
 352 {
 353   multiboot_uint32_t type;
 354   multiboot_uint32_t size;
 355   multiboot_uint8_t major;
 356   multiboot_uint8_t minor;
 357   multiboot_uint8_t reserved[6];
 358   multiboot_uint8_t tables[0];
 359 };
 360
 361 struct multiboot_tag_old_acpi
 362 {
 363   multiboot_uint32_t type;
 364   multiboot_uint32_t size;
 365   multiboot_uint8_t rsdp[0];
 366 };
 367
 368 struct multiboot_tag_new_acpi
 369 {
 370   multiboot_uint32_t type;
 371   multiboot_uint32_t size;
 372   multiboot_uint8_t rsdp[0];
 373 };
 374
 375 struct multiboot_tag_network
 376 {
 377   multiboot_uint32_t type;
 378   multiboot_uint32_t size;
 379   multiboot_uint8_t dhcpack[0];
 380 };
 381
 382 struct multiboot_tag_efi_mmap
 383 {
 384   multiboot_uint32_t type;
 385   multiboot_uint32_t size;
 386   multiboot_uint32_t descr_size;
 387   multiboot_uint32_t descr_vers;
 388   multiboot_uint8_t efi_mmap[0];
 389 };
 390
 391 struct multiboot_tag_efi32_ih
 392 {
 393   multiboot_uint32_t type;
 394   multiboot_uint32_t size;
 395   multiboot_uint32_t pointer;
 396 };
 397
 398 struct multiboot_tag_efi64_ih
 399 {
 400   multiboot_uint32_t type;
 401   multiboot_uint32_t size;
 402   multiboot_uint64_t pointer;
 403 };
 404
 405 struct multiboot_tag_load_base_addr
 406 {
 407   multiboot_uint32_t type;
 408   multiboot_uint32_t size;
 409   multiboot_uint32_t load_base_addr;
 410 };
 411
 412 #endif /*  ! __ASM__ */
 413
 414 #endif /*  ! MULTIBOOT_HEADER */