mb_info.h

Go to the documentation of this file.

 
/*
 * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
 *               Frank Mehnert <fm3@os.inf.tu-dresden.de>
 *     economic rights: Technische Universität Dresden (Germany)
 * This file is part of TUD:OS and distributed under the terms of the
 * GNU Lesser General Public License 2.1.
 * Please see the COPYING-LGPL-2.1 file for details.
 */
 
#ifndef L4UTIL_MB_INFO_H
#define L4UTIL_MB_INFO_H
 
/******************************************************************************
 * Multiboot (v1)
 *****************************************************************************/
 
#ifndef __ASSEMBLY__
 
#include <l4/sys/compiler.h>
#include <l4/sys/l4int.h>
 
/*
 * \defgroup l4util_mb_mod Multiboot v1
 * \ingroup l4util_api
 */
 
typedef struct
{
  l4_uint32_t mod_start;  
  l4_uint32_t mod_end;    
  l4_uint32_t cmdline;    
  l4_uint32_t pad;    
} l4util_mb_mod_t;
 
 
typedef struct __attribute__((packed))
{
  l4_uint32_t struct_size;  
  l4_uint64_t addr;   
  l4_uint64_t size;   
  l4_uint32_t type;   
  /* unspecified optional padding... */
} l4util_mb_addr_range_t;
 
#define MB_ARD_MEMORY   1
 
#define MB_ART_MEMORY   1  
#define MB_ART_RESERVED 2  
#define MB_ART_ACPI     3  
#define MB_ART_NVS      4  
#define MB_ART_UNUSABLE 5  
typedef struct
{
  l4_uint32_t size;   
  l4_uint8_t drive_number;  
  l4_uint8_t drive_mode;  
  l4_uint16_t drive_cylinders;  
  l4_uint8_t drive_heads; 
  l4_uint8_t drive_sectors; 
  l4_uint16_t drive_ports[0]; 
} l4util_mb_drive_t;
 
/* Drive Mode.  */
#define MB_DI_CHS_MODE    0
#define MB_DI_LBA_MODE    1
 
 
typedef struct
{
  l4_uint16_t version;
  l4_uint16_t cseg;
  l4_uint32_t offset;
  l4_uint16_t cseg_16;
  l4_uint16_t dseg_16;
  l4_uint16_t flags;
  l4_uint16_t cseg_len;
  l4_uint16_t cseg_16_len;
  l4_uint16_t dseg_16_len;
} __attribute__((packed)) l4util_mb_apm_t;
static_assert(sizeof(l4util_mb_apm_t) == 20, "Check l4util_mb_apm_t");
 
 
typedef struct
{
  l4_uint8_t signature[4];
  l4_uint16_t version;
  l4_uint32_t oem_string;
  l4_uint32_t capabilities;
  l4_uint32_t video_mode;
  l4_uint16_t total_memory;
  l4_uint16_t oem_software_rev;
  l4_uint32_t oem_vendor_name;
  l4_uint32_t oem_product_name;
  l4_uint32_t oem_product_rev;
  l4_uint8_t reserved[222];
  l4_uint8_t oem_data[256];
} __attribute__((packed)) l4util_mb_vbe_ctrl_t;
static_assert(sizeof(l4util_mb_vbe_ctrl_t) == 512, "Check l4util_mb_vbe_ctrl_t");
 
 
typedef struct
{
  l4_uint16_t mode_attributes;
  l4_uint8_t win_a_attributes;
  l4_uint8_t win_b_attributes;
  l4_uint16_t win_granularity;
  l4_uint16_t win_size;
  l4_uint16_t win_a_segment;
  l4_uint16_t win_b_segment;
  l4_uint32_t win_func;
  l4_uint16_t bytes_per_scanline;
  l4_uint16_t x_resolution;
  l4_uint16_t y_resolution;
  l4_uint8_t x_char_size;
  l4_uint8_t y_char_size;
  l4_uint8_t number_of_planes;
  l4_uint8_t bits_per_pixel;
  l4_uint8_t number_of_banks;
  l4_uint8_t memory_model;
  l4_uint8_t bank_size;
  l4_uint8_t number_of_image_pages;
  l4_uint8_t reserved0;
  l4_uint8_t red_mask_size;
  l4_uint8_t red_field_position;
  l4_uint8_t green_mask_size;
  l4_uint8_t green_field_position;
  l4_uint8_t blue_mask_size;
  l4_uint8_t blue_field_position;
  l4_uint8_t reserved_mask_size;
  l4_uint8_t reserved_field_position;
  l4_uint8_t direct_color_mode_info;
  l4_uint32_t phys_base;
  l4_uint32_t reserved1;
  l4_uint16_t reversed2;
  l4_uint16_t linear_bytes_per_scanline;
  l4_uint8_t banked_number_of_image_pages;
  l4_uint8_t linear_number_of_image_pages;
  l4_uint8_t linear_red_mask_size;
  l4_uint8_t linear_red_field_position;
  l4_uint8_t linear_green_mask_size;
  l4_uint8_t linear_green_field_position;
  l4_uint8_t linear_blue_mask_size;
  l4_uint8_t linear_blue_field_position;
  l4_uint8_t linear_reserved_mask_size;
  l4_uint8_t linear_reserved_field_position;
  l4_uint32_t max_pixel_clock;
  l4_uint8_t reserved3[190];
} __attribute__ ((packed)) l4util_mb_vbe_mode_t;
static_assert(sizeof(l4util_mb_vbe_mode_t) == 256, "Check l4util_mb_vbe_mode_t");
 
 
typedef struct
{
  l4_uint32_t flags;    
  l4_uint32_t mem_lower;  
  l4_uint32_t mem_upper;  
  l4_uint32_t boot_device;  
  l4_uint32_t cmdline;    
  l4_uint32_t mods_count; 
  l4_uint32_t mods_addr;  
  union
  {
    struct
    {
      l4_uint32_t tabsize;
      l4_uint32_t strsize;
      l4_uint32_t addr;
      l4_uint32_t pad;
    }
    a;
 
    struct
    {
      l4_uint32_t num;
      l4_uint32_t size;
      l4_uint32_t addr;
      l4_uint32_t shndx;
    }
    e;
  }
  syms;
 
  l4_uint32_t mmap_length;  
  l4_uint32_t mmap_addr;  
  l4_uint32_t drives_length;  
  l4_uint32_t drives_addr;  
  l4_uint32_t config_table; 
  l4_uint32_t boot_loader_name; 
  l4_uint32_t apm_table;  
  l4_uint32_t vbe_ctrl_info;  
  l4_uint32_t vbe_mode_info;  
  l4_uint16_t vbe_mode;   
  l4_uint16_t vbe_interface_seg; 
  l4_uint16_t vbe_interface_off; 
  l4_uint16_t vbe_interface_len; 
} l4util_mb_info_t;
static_assert(sizeof(l4util_mb_info_t) == 88, "Check l4util_mb_info_t");
 
static inline l4util_mb_addr_range_t *
l4util_mb_first_mmap_entry(l4util_mb_info_t *mbi)
{
  return (l4util_mb_addr_range_t *)(l4_addr_t)mbi->mmap_addr;
}
 
static inline l4util_mb_addr_range_t *
l4util_mb_next_mmap_entry(l4util_mb_addr_range_t *e)
{
  return (l4util_mb_addr_range_t *)((l4_addr_t)e + e->struct_size
                                    + sizeof(e->struct_size));
}
 
#define l4util_mb_for_each_mmap_entry(i, mbi)                                  \
  for (i = l4util_mb_first_mmap_entry(mbi);                                    \
       (unsigned long)i < (unsigned long)mbi->mmap_addr + mbi->mmap_length;    \
       i = l4util_mb_next_mmap_entry(i))
 
#endif /* ! __ASSEMBLY__ */
 
#define L4UTIL_MB_MEMORY    0x00000001
 
#define L4UTIL_MB_BOOTDEV   0x00000002
 
#define L4UTIL_MB_CMDLINE   0x00000004
 
#define L4UTIL_MB_MODS      0x00000008
 
/* These next two are mutually exclusive */
#define L4UTIL_MB_AOUT_SYMS   0x00000010
 
#define L4UTIL_MB_ELF_SHDR    0x00000020
 
#define L4UTIL_MB_MEM_MAP   0x00000040
 
#define L4UTIL_MB_DRIVE_INFO    0x00000080
 
#define L4UTIL_MB_CONFIG_TABLE    0x00000100
 
#define L4UTIL_MB_BOOT_LOADER_NAME  0x00000200
 
#define L4UTIL_MB_APM_TABLE   0x00000400
 
#define L4UTIL_MB_VIDEO_INFO    0x00000800
 
 
#define L4UTIL_MB_VALID     0x2BADB002UL
#define L4UTIL_MB_VALID_ASM   0x2BADB002
 
 
/******************************************************************************
 * Multiboot2
 *****************************************************************************/
 
#ifndef __ASSEMBLY__
 
typedef struct
{
  l4_uint32_t total_size;
  l4_uint32_t reserved;
}  __attribute__((packed)) l4util_mb2_info_t;
 
typedef struct
{
  char string[0];
}  __attribute__((packed)) l4util_mb2_cmdline_tag_t;
 
typedef struct
{
  l4_uint32_t mod_start;
  l4_uint32_t mod_end;
  char string[];
}  __attribute__((packed)) l4util_mb2_module_tag_t;
 
typedef struct
{
  l4_uint64_t base_addr;
  l4_uint64_t length;
  l4_uint32_t type;
  l4_uint32_t reserved;
}  __attribute__((packed)) l4util_mb2_memmap_entry_t;
 
typedef struct
{
  l4_uint32_t entry_size;
  l4_uint32_t entry_version;
  l4util_mb2_memmap_entry_t entries[];
}  __attribute__((packed)) l4util_mb2_memmap_tag_t;
 
typedef struct
{
  char data[0];
} __attribute__((packed)) l4util_mb2_rsdp_tag_t;
 
typedef struct
{
  l4_uint32_t type;
  l4_uint32_t size;
 
  union
  {
    l4util_mb2_cmdline_tag_t cmdline;
    l4util_mb2_module_tag_t module;
    l4util_mb2_memmap_tag_t memmap;
    l4util_mb2_rsdp_tag_t rsdp;
  };
}  __attribute__((packed)) l4util_mb2_tag_t;
 
#endif  /* ! __ASSEMBLY__ */
 
 
#define L4UTIL_MB2_MAGIC    0xE85250D6
#define L4UTIL_MB2_ARCH_I386    0x0
 
#define L4UTIL_MB2_TERMINATOR_HEADER_TAG  0
#define L4UTIL_MB2_INFO_REQUEST_HEADER_TAG  1
#define L4UTIL_MB2_ENTRY_ADDRESS_HEADER_TAG 3
#define L4UTIL_MB2_RELOCATABLE_HEADER_TAG 10
 
#define L4UTIL_MB2_TAG_FLAG_REQUIRED    0
 
#define L4UTIL_MB2_TAG_ALIGN_SHIFT    3
#define L4UTIL_MB2_TAG_ALIGN      8
 
#define L4UTIL_MB2_TERMINATOR_INFO_TAG            0
#define L4UTIL_MB2_BOOT_CMDLINE_INFO_TAG          1
#define L4UTIL_MB2_MODULE_INFO_TAG                3
#define L4UTIL_MB2_MEMORY_MAP_INFO_TAG            6
#define L4UTIL_MB2_RSDP_OLD_INFO_TAG             14
#define L4UTIL_MB2_RSDP_NEW_INFO_TAG             15
#define L4UTIL_MB2_IMAGE_LOAD_BASE_PHYS_INFO_TAG 21
 
#define L4UTIL_MB2_RELO_PREFERED_NONE 0
#define L4UTIL_MB2_RELO_PREFERED_MIN  1
#define L4UTIL_MB2_RELO_PREFERED_MAX  2
 
#endif