kernel/genarch/include/genarch/multiboot/multiboot.h

   1 /*
   2  * Copyright (c) 2009 Jiri Svoboda
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup genarch
  30  * @{
  31  */
  32 /** @file
  33  */
  34
  35 #ifndef KERN_MULTIBOOT_H_
  36 #define KERN_MULTIBOOT_H_
  37
  38 #include <genarch/multiboot/multiboot_memmap_struct.h>
  39 #include <genarch/multiboot/multiboot_info_struct.h>
  40
  41 #define MULTIBOOT_HEADER_MAGIC  0x1badb002
  42 #define MULTIBOOT_HEADER_FLAGS  0x00010003
  43
  44 #define MULTIBOOT_LOADER_MAGIC  0x2badb002
  45
  46 #define MULTIBOOT_INFO_FLAGS_MEM        0x01
  47 #define MULTIBOOT_INFO_FLAGS_BOOT       0x02
  48 #define MULTIBOOT_INFO_FLAGS_CMDLINE    0x04
  49 #define MULTIBOOT_INFO_FLAGS_MODS       0x08
  50 #define MULTIBOOT_INFO_FLAGS_SYMS1      0x10
  51 #define MULTIBOOT_INFO_FLAGS_SYMS2      0x20
  52 #define MULTIBOOT_INFO_FLAGS_MMAP       0x40
  53
  54 #ifndef __ASM__
  55
  56 #include <typedefs.h>
  57 #include <arch/boot/memmap.h>
  58
  59 /** Convert 32-bit multiboot address to a pointer. */
  60 #define MULTIBOOT_PTR(mba)  ((void *) (uintptr_t) (mba))
  61
  62 /** Multiboot 32-bit address. */
  63 typedef uint32_t mbaddr_t;
  64
  65 /** Multiboot module structure */
  66 typedef struct {
  67         mbaddr_t start;
  68         mbaddr_t end;
  69         mbaddr_t string;
  70         uint32_t reserved;
  71 } __attribute__((packed)) multiboot_module_t;
  72
  73 extern void multiboot_extract_command(char *, size_t, const char *);
  74 extern void multiboot_extract_argument(char *, size_t, const char *);
  75 extern void multiboot_info_parse(uint32_t, const multiboot_info_t *);
  76
  77 #endif /* __ASM__ */
  78
  79 #endif
  80
  81 /** @}
  82  */