sys/dev/sysmon/sysmon_envsysvar.h

   1 /* $NetBSD: sysmon_envsysvar.h,v 1.29 2009/06/08 00:55:35 pgoyette Exp $ */
   2
   3 /*-
   4  * Copyright (c) 2007, 2008 Juan Romero Pardines.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef _DEV_SYSMON_ENVSYSVAR_H_
  29 #define _DEV_SYSMON_ENVSYSVAR_H_
  30
  31 #include <sys/param.h>
  32 #include <sys/types.h>
  33 #include <sys/conf.h>
  34 #include <sys/kernel.h>
  35 #include <sys/systm.h>
  36 #include <sys/mutex.h>
  37 #include <sys/workqueue.h>
  38 #include <sys/condvar.h>
  39
  40 #include <dev/sysmon/sysmonvar.h>
  41 #include <prop/proplib.h>
  42
  43 enum sme_description_types {
  44         SME_DESC_UNITS = 1,
  45         SME_DESC_STATES,
  46         SME_DESC_DRIVE_STATES,
  47         SME_DESC_BATTERY_CAPACITY
  48 };
  49
  50 #ifdef ENVSYS_DEBUG
  51 #define DPRINTF(x)      printf x
  52 #else
  53 #define DPRINTF(x)
  54 #endif
  55
  56 #ifdef ENVSYS_OBJECTS_DEBUG
  57 #define DPRINTFOBJ(x)   printf x
  58 #else
  59 #define DPRINTFOBJ(x)
  60 #endif
  61
  62 /*
  63  * Default timeout value for the callouts if no specified.
  64  */
  65 #define SME_EVENTS_DEFTIMEOUT   30
  66
  67 /*
  68  * struct used by a sysmon envsys event.
  69  */
  70 typedef struct sme_event {
  71         struct work             see_wk;
  72         LIST_ENTRY(sme_event)   see_list;
  73         struct sysmon_envsys    *see_sme;       /* device associated */
  74         struct penvsys_state    see_pes;        /* our power envsys */
  75         envsys_data_t           *see_edata;     /* our sensor data */
  76         sysmon_envsys_lim_t     see_lims;       /* limit values */
  77         int                     see_type;       /* type of the event */
  78         int                     see_evsent;     /* event already sent */
  79         int                     see_flags;      /* see above */
  80 #define SEE_EVENT_WORKING       0x0001          /* This event is busy */
  81 } sme_event_t;
  82
  83 /*
  84  * struct by a sysmon envsys event set by a driver.
  85  */
  86 typedef struct sme_event_drv {
  87         struct sysmon_envsys    *sed_sme;
  88         prop_dictionary_t       sed_sdict;
  89         envsys_data_t           *sed_edata;
  90         int                     sed_powertype;
  91 } sme_event_drv_t;
  92
  93 struct sme_description_table {
  94         int             type;
  95         int             crittype;
  96         const char      *desc;
  97 };
  98
  99 /*
 100  * common stuff.
 101  */
 102 extern  kmutex_t sme_global_mtx;        /* for the sme linked list and dict */
 103
 104 /*
 105  * linked list for the sysmon envsys devices.
 106  */
 107 LIST_HEAD(, sysmon_envsys) sysmon_envsys_list;
 108
 109 /*
 110  * functions to handle sysmon envsys devices.
 111  */
 112 sme_event_drv_t *sme_add_sensor_dictionary(struct sysmon_envsys *,
 113                                            prop_array_t,
 114                                            prop_dictionary_t,
 115                                            envsys_data_t *);
 116 int     sme_update_dictionary(struct sysmon_envsys *);
 117 int     sme_userset_dictionary(struct sysmon_envsys *,
 118                                prop_dictionary_t, prop_array_t);
 119 prop_dictionary_t sme_sensor_dictionary_get(prop_array_t, const char *);
 120 struct  sysmon_envsys *sysmon_envsys_find(const char *);
 121 void    sysmon_envsys_acquire(struct sysmon_envsys *, bool);
 122 void    sysmon_envsys_release(struct sysmon_envsys *, bool);
 123
 124 /*
 125  * functions to handle sysmon envsys events.
 126  */
 127 int     sme_event_register(prop_dictionary_t, envsys_data_t *,
 128                            struct sysmon_envsys *, sysmon_envsys_lim_t *,
 129                            int, int);
 130 int     sme_event_unregister(struct sysmon_envsys *, const char *, int);
 131 void    sme_event_unregister_all(struct sysmon_envsys *);
 132 void    sme_event_drvadd(void *);
 133 int     sme_events_init(struct sysmon_envsys *);
 134 void    sme_events_destroy(struct sysmon_envsys *);
 135 void    sme_events_check(void *);
 136 void    sme_events_worker(struct work *, void *);
 137
 138 /*
 139  * common functions to create/update objects in a dictionary.
 140  */
 141 int     sme_sensor_upbool(prop_dictionary_t, const char *, bool);
 142 int     sme_sensor_upint32(prop_dictionary_t, const char *, int32_t);
 143 int     sme_sensor_upuint32(prop_dictionary_t, const char *, uint32_t);
 144 int     sme_sensor_upstring(prop_dictionary_t, const char *, const char *);
 145
 146 const struct    sme_description_table *sme_get_description_table(int);
 147
 148 #endif /* _DEV_SYSMON_ENVSYSVAR_H_ */