memdesc.h

Go to the documentation of this file.

/*
 * (c) 2007-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
 *               Alexander Warg <warg@os.inf.tu-dresden.de>
 *     economic rights: Technische Universität Dresden (Germany)
 *
 * License: see LICENSE.spdx (in this directory or the directories above)
 */
#ifndef __L4SYS__MEMDESC_H__
#define __L4SYS__MEMDESC_H__
 
#include <l4/sys/kip.h>


enum l4_mem_type_t
{
  l4_mem_type_undefined    = 0x0, 
  l4_mem_type_conventional = 0x1, 
  l4_mem_type_reserved     = 0x2, 
  l4_mem_type_dedicated    = 0x3, 
  l4_mem_type_shared       = 0x4, 
  l4_mem_type_kmem         = 0x5, 
 
  // 0x7 is internally used by the kernel
 
  l4_mem_type_info         = 0xd, 
  l4_mem_type_bootloader   = 0xe, 
  l4_mem_type_archspecific = 0xf, 
};

enum l4_mem_info_sub_type_t
{
  l4_mem_info_acpi_rsdp = 0, 
 
  l4_mem_reserved_kernel = 0, 
  l4_mem_reserved_heap   = 1, 
  l4_mem_reserved_mmio   = 2, 
};

enum l4_mem_archspecific_sub_type_common_t
{
  l4_mem_archspecific_acpi_tables = 3,  
  l4_mem_archspecific_acpi_nvs    = 4,  
  l4_mem_archspecific_cpu_fw      = 5,  
};
 

typedef struct l4_kernel_info_mem_desc_t
{
  l4_umword_t l;
  l4_umword_t h;
} l4_kernel_info_mem_desc_t;
 

L4_INLINE
l4_kernel_info_mem_desc_t *
l4_kernel_info_get_mem_descs(l4_kernel_info_t *kip) L4_NOTHROW;

L4_INLINE
unsigned
l4_kernel_info_get_num_mem_descs(l4_kernel_info_t *kip) L4_NOTHROW;

L4_INLINE
void
l4_kernel_info_set_mem_desc(l4_kernel_info_mem_desc_t *md,
                            l4_addr_t start,
          l4_addr_t end,
          unsigned type,
          unsigned virt,
          unsigned sub_type) L4_NOTHROW;

L4_INLINE
l4_umword_t
l4_kernel_info_get_mem_desc_start(l4_kernel_info_mem_desc_t *md) L4_NOTHROW;

L4_INLINE
l4_umword_t
l4_kernel_info_get_mem_desc_end(l4_kernel_info_mem_desc_t *md) L4_NOTHROW;

L4_INLINE
l4_umword_t
l4_kernel_info_get_mem_desc_type(l4_kernel_info_mem_desc_t *md) L4_NOTHROW;

L4_INLINE
l4_umword_t
l4_kernel_info_get_mem_desc_subtype(l4_kernel_info_mem_desc_t *md) L4_NOTHROW;

L4_INLINE
l4_umword_t
l4_kernel_info_get_mem_desc_is_virtual(l4_kernel_info_mem_desc_t *md) L4_NOTHROW;
 
/*************************************************************************
 * Implementations
 *************************************************************************/
 
L4_INLINE
l4_kernel_info_mem_desc_t *
l4_kernel_info_get_mem_descs(l4_kernel_info_t *kip) L4_NOTHROW
{
  return (l4_kernel_info_mem_desc_t *)((l4_addr_t)kip + kip->mem_descs);
}
 
L4_INLINE
unsigned
l4_kernel_info_get_num_mem_descs(l4_kernel_info_t *kip) L4_NOTHROW
{
  return kip->mem_descs_num;
}
 
L4_INLINE
void
l4_kernel_info_set_mem_desc(l4_kernel_info_mem_desc_t *md,
                            l4_addr_t start,
          l4_addr_t end,
          unsigned type,
          unsigned virt,
          unsigned sub_type) L4_NOTHROW
{
  md->l = (start & ~0x3ffUL) | (type & 0x0f) | ((sub_type << 4) & 0x0f0)
    | (virt ? 0x200 : 0x0);
  md->h = end;
}
 
 
L4_INLINE
l4_umword_t
l4_kernel_info_get_mem_desc_start(l4_kernel_info_mem_desc_t *md) L4_NOTHROW
{
  return md->l & ~0x3ffUL;
}
 
L4_INLINE
l4_umword_t
l4_kernel_info_get_mem_desc_end(l4_kernel_info_mem_desc_t *md) L4_NOTHROW
{
  return md->h | 0x3ffUL;
}
 
L4_INLINE
l4_umword_t
l4_kernel_info_get_mem_desc_type(l4_kernel_info_mem_desc_t *md) L4_NOTHROW
{
  return md->l & 0xf;
}
 
L4_INLINE
l4_umword_t
l4_kernel_info_get_mem_desc_subtype(l4_kernel_info_mem_desc_t *md) L4_NOTHROW
{
  return (md->l & 0xf0) >> 4;
}
 
L4_INLINE
l4_umword_t
l4_kernel_info_get_mem_desc_is_virtual(l4_kernel_info_mem_desc_t *md) L4_NOTHROW
{
  return md->l & 0x200;
}
 
#endif /* ! __L4SYS__MEMDESC_H__ */