kernel/generic/include/sysinfo/sysinfo.h

   1 /*
   2  * Copyright (c) 2006 Jakub Vana
   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 generic
  30  * @{
  31  */
  32 /** @file
  33  */
  34
  35 #ifndef KERN_SYSINFO_H_
  36 #define KERN_SYSINFO_H_
  37
  38 #include <arch/types.h>
  39
  40 typedef union sysinfo_item_val {
  41         unative_t val;
  42         void *fn;
  43 } sysinfo_item_val_t;
  44
  45 typedef struct sysinfo_item {
  46         char *name;
  47         union {
  48                 unative_t val;
  49                 void *fn;
  50         } val;
  51
  52         union {
  53                 struct sysinfo_item *table;
  54                 void *fn;
  55         } subinfo;
  56
  57         struct sysinfo_item *next;
  58         int val_type;
  59         int subinfo_type;
  60 } sysinfo_item_t;
  61
  62 #define SYSINFO_VAL_VAL 0
  63 #define SYSINFO_VAL_FUNCTION 1
  64 #define SYSINFO_VAL_UNDEFINED '?'
  65
  66 #define SYSINFO_SUBINFO_NONE 0
  67 #define SYSINFO_SUBINFO_TABLE 1
  68 #define SYSINFO_SUBINFO_FUNCTION 2
  69
  70 typedef unative_t (*sysinfo_val_fn_t)(sysinfo_item_t *root);
  71 typedef unative_t (*sysinfo_subinfo_fn_t)(const char *subname);
  72
  73 typedef struct sysinfo_rettype {
  74         unative_t val;
  75         unative_t valid;
  76 } sysinfo_rettype_t;
  77
  78 void sysinfo_set_item_val(const char *name, sysinfo_item_t **root, unative_t val);
  79 void sysinfo_dump(sysinfo_item_t **root, int depth);
  80 void sysinfo_set_item_function(const char *name, sysinfo_item_t **root, sysinfo_val_fn_t fn);
  81 void sysinfo_set_item_undefined(const char *name, sysinfo_item_t **root);
  82
  83 sysinfo_rettype_t sysinfo_get_val(const char *name, sysinfo_item_t **root);
  84
  85 unative_t sys_sysinfo_valid(unative_t ptr, unative_t len);
  86 unative_t sys_sysinfo_value(unative_t ptr, unative_t len);
  87
  88 #endif
  89
  90 /** @}
  91  */