l4/pkg/l4sys/include/kip.h

   1 /**
   2  * \file
   3  * \brief Kernel Info Page access functions.
   4  * \ingroup l4_api
   5  */
   6 /*
   7  * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
   8  *               Alexander Warg <warg@os.inf.tu-dresden.de>
   9  *     economic rights: Technische Universität Dresden (Germany)
  10  *
  11  * This file is part of TUD:OS and distributed under the terms of the
  12  * GNU General Public License 2.
  13  * Please see the COPYING-GPL-2 file for details.
  14  *
  15  * As a special exception, you may use this file as part of a free software
  16  * library without restriction.  Specifically, if other files instantiate
  17  * templates or use macros or inline functions from this file, or you compile
  18  * this file and link it with other files to produce an executable, this
  19  * file does not by itself cause the resulting executable to be covered by
  20  * the GNU General Public License.  This exception does not however
  21  * invalidate any other reasons why the executable file might be covered by
  22  * the GNU General Public License.
  23  */
  24 #pragma once
  25
  26 #include <l4/sys/compiler.h>
  27 #include <l4/sys/l4int.h>
  28
  29 struct l4_kip_platform_info
  30 {
  31   char name[16];
  32 };
  33
  34 #if L4_MWORD_BITS == 32
  35 #  include <l4/sys/__kip-32bit.h>
  36 #else
  37 #  include <l4/sys/__kip-64bit.h>
  38 #endif
  39
  40
  41
  42
  43 /**
  44  * \addtogroup l4_kip_api
  45  *
  46  * C interface for the Kernel Interface Page:<br>
  47  * <c>\#include <l4/sys/kip.h></c>
  48  */
  49 /*@{*/
  50
  51 /**
  52  * \internal
  53  */
  54 enum l4_kernel_info_consts_t
  55 {
  56   L4_KIP_VERSION_FIASCO      = 0x87004444,
  57   L4_KIP_VERSION_FIASCO_MASK = 0xff00ffff,
  58 };
  59
  60 /**
  61  * \brief Kernel Info Page identifier ("L4µK").
  62  */
  63 #define L4_KERNEL_INFO_MAGIC (0x4BE6344CL) /* "L4µK" */
  64
  65
  66 /**
  67  * \brief  Get the kernel version.
  68  * \param kip Kernel Interface Page.
  69  * \return Kernel version string. 0 if KIP could not be mapped.
  70  */
  71 L4_INLINE l4_umword_t l4_kip_version(l4_kernel_info_t *kip) L4_NOTHROW;
  72
  73 /**
  74  * \brief  Get the kernel version string.
  75  * \param kip Kernel Interface Page.
  76  * \return Kernel version string.
  77  */
  78 L4_INLINE const char *l4_kip_version_string(l4_kernel_info_t *kip) L4_NOTHROW;
  79
  80 /**
  81  * \brief Return offset in bytes of version_strings relative to the KIP base.
  82  *
  83  * \param kip   Pointer to the kernel into page (KIP).
  84  *
  85  * \return offset of version_strings relative to the KIP base address, in
  86  *         bytes.
  87  */
  88 L4_INLINE int
  89 l4_kernel_info_version_offset(l4_kernel_info_t *kip) L4_NOTHROW;
  90
  91 /*@}*/
  92
  93 /*************************************************************************
  94  * Implementations
  95  *************************************************************************/
  96
  97 L4_INLINE l4_umword_t
  98 l4_kip_version(l4_kernel_info_t *kip) L4_NOTHROW
  99 { return kip->version & L4_KIP_VERSION_FIASCO_MASK; }
 100
 101 L4_INLINE const char*
 102 l4_kip_version_string(l4_kernel_info_t *k) L4_NOTHROW
 103 { return (const char *)k + l4_kernel_info_version_offset(k); }
 104
 105 L4_INLINE int
 106 l4_kernel_info_version_offset(l4_kernel_info_t *kip) L4_NOTHROW
 107 { return kip->offset_version_strings << 4; }