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 /**
  30  * \internal
  31  */
  32 struct l4_kip_platform_info
  33 {
  34   l4_umword_t cpuid;     ///< reserved \internal
  35   l4_umword_t mp;        ///< reserved \internal
  36   char        name[16];
  37 };
  38
  39 #if L4_MWORD_BITS == 32
  40 #  include <l4/sys/__kip-32bit.h>
  41 #else
  42 #  include <l4/sys/__kip-64bit.h>
  43 #endif
  44
  45
  46
  47
  48 /**
  49  * \addtogroup l4_kip_api
  50  *
  51  * C interface for the Kernel Interface Page:<br>
  52  * <c>\#include <l4/sys/kip.h></c>
  53  */
  54 /*@{*/
  55
  56 /**
  57  * \internal
  58  */
  59 enum l4_kernel_info_consts_t
  60 {
  61   L4_KIP_VERSION_FIASCO      = 0x87004444,
  62   L4_KIP_VERSION_FIASCO_MASK = 0xff00ffff,
  63 };
  64
  65 /**
  66  * \brief Kernel Info Page identifier ("L4µK").
  67  */
  68 #define L4_KERNEL_INFO_MAGIC (0x4BE6344CL) /* "L4µK" */
  69
  70
  71 /**
  72  * \brief  Get the kernel version.
  73  * \param kip Kernel Interface Page.
  74  * \return Kernel version string. 0 if KIP could not be mapped.
  75  */
  76 L4_INLINE l4_umword_t l4_kip_version(l4_kernel_info_t *kip) L4_NOTHROW;
  77
  78 /**
  79  * \brief  Get the kernel version string.
  80  * \param kip Kernel Interface Page.
  81  * \return Kernel version string.
  82  */
  83 L4_INLINE const char *l4_kip_version_string(l4_kernel_info_t *kip) L4_NOTHROW;
  84
  85 /**
  86  * \brief Return offset in bytes of version_strings relative to the KIP base.
  87  *
  88  * \param kip   Pointer to the kernel into page (KIP).
  89  *
  90  * \return offset of version_strings relative to the KIP base address, in
  91  *         bytes.
  92  */
  93 L4_INLINE int
  94 l4_kernel_info_version_offset(l4_kernel_info_t *kip) L4_NOTHROW;
  95
  96 /*@}*/
  97
  98 /*************************************************************************
  99  * Implementations
 100  *************************************************************************/
 101
 102 L4_INLINE l4_umword_t
 103 l4_kip_version(l4_kernel_info_t *kip) L4_NOTHROW
 104 { return kip->version & L4_KIP_VERSION_FIASCO_MASK; }
 105
 106 L4_INLINE const char*
 107 l4_kip_version_string(l4_kernel_info_t *k) L4_NOTHROW
 108 { return (const char *)k + l4_kernel_info_version_offset(k); }
 109
 110 L4_INLINE int
 111 l4_kernel_info_version_offset(l4_kernel_info_t *kip) L4_NOTHROW
 112 { return kip->offset_version_strings << 4; }