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