1*23274804SToomas Soome /* multiboot.h - Multiboot header file. */ 2*23274804SToomas Soome /* Copyright (C) 1999,2003,2007,2008,2009 Free Software Foundation, Inc. 3*23274804SToomas Soome * 4*23274804SToomas Soome * Permission is hereby granted, free of charge, to any person obtaining a copy 5*23274804SToomas Soome * of this software and associated documentation files (the "Software"), to 6*23274804SToomas Soome * deal in the Software without restriction, including without limitation the 7*23274804SToomas Soome * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 8*23274804SToomas Soome * sell copies of the Software, and to permit persons to whom the Software is 9*23274804SToomas Soome * furnished to do so, subject to the following conditions: 10*23274804SToomas Soome * 11*23274804SToomas Soome * The above copyright notice and this permission notice shall be included in 12*23274804SToomas Soome * all copies or substantial portions of the Software. 13*23274804SToomas Soome * 14*23274804SToomas Soome * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15*23274804SToomas Soome * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16*23274804SToomas Soome * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL ANY 17*23274804SToomas Soome * DEVELOPER OR DISTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 18*23274804SToomas Soome * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 19*23274804SToomas Soome * IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 20*23274804SToomas Soome * 21*23274804SToomas Soome * $FreeBSD$ 22*23274804SToomas Soome */ 23*23274804SToomas Soome 24*23274804SToomas Soome #ifndef MULTIBOOT_HEADER 25*23274804SToomas Soome #define MULTIBOOT_HEADER 1 26*23274804SToomas Soome 27*23274804SToomas Soome /* How many bytes from the start of the file we search for the header. */ 28*23274804SToomas Soome #define MULTIBOOT_SEARCH 8192 29*23274804SToomas Soome 30*23274804SToomas Soome /* The magic field should contain this. */ 31*23274804SToomas Soome #define MULTIBOOT_HEADER_MAGIC 0x1BADB002 32*23274804SToomas Soome 33*23274804SToomas Soome /* This should be in %eax. */ 34*23274804SToomas Soome #define MULTIBOOT_BOOTLOADER_MAGIC 0x2BADB002 35*23274804SToomas Soome 36*23274804SToomas Soome /* The bits in the required part of flags field we don't support. */ 37*23274804SToomas Soome #define MULTIBOOT_UNSUPPORTED 0x0000fffc 38*23274804SToomas Soome 39*23274804SToomas Soome /* Alignment of multiboot modules. */ 40*23274804SToomas Soome #define MULTIBOOT_MOD_ALIGN 0x00001000 41*23274804SToomas Soome 42*23274804SToomas Soome /* Alignment of the multiboot info structure. */ 43*23274804SToomas Soome #define MULTIBOOT_INFO_ALIGN 0x00000004 44*23274804SToomas Soome 45*23274804SToomas Soome /* Flags set in the 'flags' member of the multiboot header. */ 46*23274804SToomas Soome 47*23274804SToomas Soome /* Align all boot modules on i386 page (4KB) boundaries. */ 48*23274804SToomas Soome #define MULTIBOOT_PAGE_ALIGN 0x00000001 49*23274804SToomas Soome 50*23274804SToomas Soome /* Must pass memory information to OS. */ 51*23274804SToomas Soome #define MULTIBOOT_MEMORY_INFO 0x00000002 52*23274804SToomas Soome 53*23274804SToomas Soome /* Must pass video information to OS. */ 54*23274804SToomas Soome #define MULTIBOOT_VIDEO_MODE 0x00000004 55*23274804SToomas Soome 56*23274804SToomas Soome /* This flag indicates the use of the address fields in the header. */ 57*23274804SToomas Soome #define MULTIBOOT_AOUT_KLUDGE 0x00010000 58*23274804SToomas Soome 59*23274804SToomas Soome /* Flags to be set in the 'flags' member of the multiboot info structure. */ 60*23274804SToomas Soome 61*23274804SToomas Soome /* is there basic lower/upper memory information? */ 62*23274804SToomas Soome #define MULTIBOOT_INFO_MEMORY 0x00000001 63*23274804SToomas Soome /* is there a boot device set? */ 64*23274804SToomas Soome #define MULTIBOOT_INFO_BOOTDEV 0x00000002 65*23274804SToomas Soome /* is the command-line defined? */ 66*23274804SToomas Soome #define MULTIBOOT_INFO_CMDLINE 0x00000004 67*23274804SToomas Soome /* are there modules to do something with? */ 68*23274804SToomas Soome #define MULTIBOOT_INFO_MODS 0x00000008 69*23274804SToomas Soome 70*23274804SToomas Soome /* These next two are mutually exclusive */ 71*23274804SToomas Soome 72*23274804SToomas Soome /* is there a symbol table loaded? */ 73*23274804SToomas Soome #define MULTIBOOT_INFO_AOUT_SYMS 0x00000010 74*23274804SToomas Soome /* is there an ELF section header table? */ 75*23274804SToomas Soome #define MULTIBOOT_INFO_ELF_SHDR 0X00000020 76*23274804SToomas Soome 77*23274804SToomas Soome /* is there a full memory map? */ 78*23274804SToomas Soome #define MULTIBOOT_INFO_MEM_MAP 0x00000040 79*23274804SToomas Soome 80*23274804SToomas Soome /* Is there drive info? */ 81*23274804SToomas Soome #define MULTIBOOT_INFO_DRIVE_INFO 0x00000080 82*23274804SToomas Soome 83*23274804SToomas Soome /* Is there a config table? */ 84*23274804SToomas Soome #define MULTIBOOT_INFO_CONFIG_TABLE 0x00000100 85*23274804SToomas Soome 86*23274804SToomas Soome /* Is there a boot loader name? */ 87*23274804SToomas Soome #define MULTIBOOT_INFO_BOOT_LOADER_NAME 0x00000200 88*23274804SToomas Soome 89*23274804SToomas Soome /* Is there a APM table? */ 90*23274804SToomas Soome #define MULTIBOOT_INFO_APM_TABLE 0x00000400 91*23274804SToomas Soome 92*23274804SToomas Soome /* Is there video information? */ 93*23274804SToomas Soome #define MULTIBOOT_INFO_VIDEO_INFO 0x00000800 94*23274804SToomas Soome 95*23274804SToomas Soome #ifndef ASM_FILE 96*23274804SToomas Soome 97*23274804SToomas Soome typedef unsigned short multiboot_uint16_t; 98*23274804SToomas Soome typedef unsigned int multiboot_uint32_t; 99*23274804SToomas Soome typedef unsigned long long multiboot_uint64_t; 100*23274804SToomas Soome 101*23274804SToomas Soome struct multiboot_header 102*23274804SToomas Soome { 103*23274804SToomas Soome /* Must be MULTIBOOT_MAGIC - see above. */ 104*23274804SToomas Soome multiboot_uint32_t magic; 105*23274804SToomas Soome 106*23274804SToomas Soome /* Feature flags. */ 107*23274804SToomas Soome multiboot_uint32_t flags; 108*23274804SToomas Soome 109*23274804SToomas Soome /* The above fields plus this one must equal 0 mod 2^32. */ 110*23274804SToomas Soome multiboot_uint32_t checksum; 111*23274804SToomas Soome 112*23274804SToomas Soome /* These are only valid if MULTIBOOT_AOUT_KLUDGE is set. */ 113*23274804SToomas Soome multiboot_uint32_t header_addr; 114*23274804SToomas Soome multiboot_uint32_t load_addr; 115*23274804SToomas Soome multiboot_uint32_t load_end_addr; 116*23274804SToomas Soome multiboot_uint32_t bss_end_addr; 117*23274804SToomas Soome multiboot_uint32_t entry_addr; 118*23274804SToomas Soome 119*23274804SToomas Soome /* These are only valid if MULTIBOOT_VIDEO_MODE is set. */ 120*23274804SToomas Soome multiboot_uint32_t mode_type; 121*23274804SToomas Soome multiboot_uint32_t width; 122*23274804SToomas Soome multiboot_uint32_t height; 123*23274804SToomas Soome multiboot_uint32_t depth; 124*23274804SToomas Soome }; 125*23274804SToomas Soome 126*23274804SToomas Soome /* The symbol table for a.out. */ 127*23274804SToomas Soome struct multiboot_aout_symbol_table 128*23274804SToomas Soome { 129*23274804SToomas Soome multiboot_uint32_t tabsize; 130*23274804SToomas Soome multiboot_uint32_t strsize; 131*23274804SToomas Soome multiboot_uint32_t addr; 132*23274804SToomas Soome multiboot_uint32_t reserved; 133*23274804SToomas Soome }; 134*23274804SToomas Soome typedef struct multiboot_aout_symbol_table multiboot_aout_symbol_table_t; 135*23274804SToomas Soome 136*23274804SToomas Soome /* The section header table for ELF. */ 137*23274804SToomas Soome struct multiboot_elf_section_header_table 138*23274804SToomas Soome { 139*23274804SToomas Soome multiboot_uint32_t num; 140*23274804SToomas Soome multiboot_uint32_t size; 141*23274804SToomas Soome multiboot_uint32_t addr; 142*23274804SToomas Soome multiboot_uint32_t shndx; 143*23274804SToomas Soome }; 144*23274804SToomas Soome typedef struct multiboot_elf_section_header_table multiboot_elf_section_header_table_t; 145*23274804SToomas Soome 146*23274804SToomas Soome struct multiboot_info 147*23274804SToomas Soome { 148*23274804SToomas Soome /* Multiboot info version number */ 149*23274804SToomas Soome multiboot_uint32_t flags; 150*23274804SToomas Soome 151*23274804SToomas Soome /* Available memory from BIOS */ 152*23274804SToomas Soome multiboot_uint32_t mem_lower; 153*23274804SToomas Soome multiboot_uint32_t mem_upper; 154*23274804SToomas Soome 155*23274804SToomas Soome /* "root" partition */ 156*23274804SToomas Soome multiboot_uint32_t boot_device; 157*23274804SToomas Soome 158*23274804SToomas Soome /* Kernel command line */ 159*23274804SToomas Soome multiboot_uint32_t cmdline; 160*23274804SToomas Soome 161*23274804SToomas Soome /* Boot-Module list */ 162*23274804SToomas Soome multiboot_uint32_t mods_count; 163*23274804SToomas Soome multiboot_uint32_t mods_addr; 164*23274804SToomas Soome 165*23274804SToomas Soome union 166*23274804SToomas Soome { 167*23274804SToomas Soome multiboot_aout_symbol_table_t aout_sym; 168*23274804SToomas Soome multiboot_elf_section_header_table_t elf_sec; 169*23274804SToomas Soome } u; 170*23274804SToomas Soome 171*23274804SToomas Soome /* Memory Mapping buffer */ 172*23274804SToomas Soome multiboot_uint32_t mmap_length; 173*23274804SToomas Soome multiboot_uint32_t mmap_addr; 174*23274804SToomas Soome 175*23274804SToomas Soome /* Drive Info buffer */ 176*23274804SToomas Soome multiboot_uint32_t drives_length; 177*23274804SToomas Soome multiboot_uint32_t drives_addr; 178*23274804SToomas Soome 179*23274804SToomas Soome /* ROM configuration table */ 180*23274804SToomas Soome multiboot_uint32_t config_table; 181*23274804SToomas Soome 182*23274804SToomas Soome /* Boot Loader Name */ 183*23274804SToomas Soome multiboot_uint32_t boot_loader_name; 184*23274804SToomas Soome 185*23274804SToomas Soome /* APM table */ 186*23274804SToomas Soome multiboot_uint32_t apm_table; 187*23274804SToomas Soome 188*23274804SToomas Soome /* Video */ 189*23274804SToomas Soome multiboot_uint32_t vbe_control_info; 190*23274804SToomas Soome multiboot_uint32_t vbe_mode_info; 191*23274804SToomas Soome multiboot_uint16_t vbe_mode; 192*23274804SToomas Soome multiboot_uint16_t vbe_interface_seg; 193*23274804SToomas Soome multiboot_uint16_t vbe_interface_off; 194*23274804SToomas Soome multiboot_uint16_t vbe_interface_len; 195*23274804SToomas Soome }; 196*23274804SToomas Soome typedef struct multiboot_info multiboot_info_t; 197*23274804SToomas Soome 198*23274804SToomas Soome struct multiboot_mmap_entry 199*23274804SToomas Soome { 200*23274804SToomas Soome multiboot_uint32_t size; 201*23274804SToomas Soome multiboot_uint64_t addr; 202*23274804SToomas Soome multiboot_uint64_t len; 203*23274804SToomas Soome #define MULTIBOOT_MEMORY_AVAILABLE 1 204*23274804SToomas Soome #define MULTIBOOT_MEMORY_RESERVED 2 205*23274804SToomas Soome multiboot_uint32_t type; 206*23274804SToomas Soome } __attribute__((packed)); 207*23274804SToomas Soome typedef struct multiboot_mmap_entry multiboot_memory_map_t; 208*23274804SToomas Soome 209*23274804SToomas Soome struct multiboot_mod_list 210*23274804SToomas Soome { 211*23274804SToomas Soome /* the memory used goes from bytes 'mod_start' to 'mod_end-1' inclusive */ 212*23274804SToomas Soome multiboot_uint32_t mod_start; 213*23274804SToomas Soome multiboot_uint32_t mod_end; 214*23274804SToomas Soome 215*23274804SToomas Soome /* Module command line */ 216*23274804SToomas Soome multiboot_uint32_t cmdline; 217*23274804SToomas Soome 218*23274804SToomas Soome /* padding to take it to 16 bytes (must be zero) */ 219*23274804SToomas Soome multiboot_uint32_t pad; 220*23274804SToomas Soome }; 221*23274804SToomas Soome typedef struct multiboot_mod_list multiboot_module_t; 222*23274804SToomas Soome 223*23274804SToomas Soome #endif /* ! ASM_FILE */ 224*23274804SToomas Soome 225*23274804SToomas Soome #endif /* ! MULTIBOOT_HEADER */ 226