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