Home | History | Annotate | Line # | Download | only in sysmon
sysmon_envsysvar.h revision 1.37 
      1 /* $NetBSD: sysmon_envsysvar.h,v 1.37 2010/12/15 17:17:17 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_descr_type {
     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_descr_entry {
     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 extern	prop_dictionary_t sme_propd;	/* the global sensor dictionary */
    104 
    105 /*
    106  * linked list for the sysmon envsys devices.
    107  */
    108 LIST_HEAD(, sysmon_envsys) sysmon_envsys_list;
    109 
    110 /*
    111  * functions to handle sysmon envsys devices.
    112  */
    113 int	sme_update_dictionary(struct sysmon_envsys *);
    114 int	sme_userset_dictionary(struct sysmon_envsys *,
    115 			       prop_dictionary_t, prop_array_t);
    116 prop_dictionary_t sme_sensor_dictionary_get(prop_array_t, const char *);
    117 struct	sysmon_envsys *sysmon_envsys_find(const char *);
    118 void	sysmon_envsys_acquire(struct sysmon_envsys *, bool);
    119 void	sysmon_envsys_release(struct sysmon_envsys *, bool);
    120 
    121 /*
    122  * functions to handle sysmon envsys events.
    123  */
    124 int	sme_event_register(prop_dictionary_t, envsys_data_t *,
    125 			   struct sysmon_envsys *, sysmon_envsys_lim_t *,
    126 			   uint32_t, int, int);
    127 int	sme_event_unregister(struct sysmon_envsys *, const char *, int);
    128 void	sme_event_unregister_all(struct sysmon_envsys *);
    129 void	sme_event_drvadd(void *);
    130 int	sme_events_init(struct sysmon_envsys *);
    131 void	sme_events_destroy(struct sysmon_envsys *);
    132 void	sme_events_check(void *);
    133 void	sme_events_worker(struct work *, void *);
    134 void	sme_deliver_event(sme_event_t *);
    135 int	sme_update_limits(struct sysmon_envsys *, envsys_data_t *);
    136 
    137 /*
    138  * common functions to create/update objects in a dictionary.
    139  */
    140 int	sme_sensor_upbool(prop_dictionary_t, const char *, bool);
    141 int	sme_sensor_upint32(prop_dictionary_t, const char *, int32_t);
    142 int	sme_sensor_upuint32(prop_dictionary_t, const char *, uint32_t);
    143 int	sme_sensor_upstring(prop_dictionary_t, const char *, const char *);
    144 
    145 const struct sme_descr_entry *sme_find_table_entry(enum sme_descr_type, int);
    146 
    147 #endif /* _DEV_SYSMON_ENVSYSVAR_H_ */
    148