Home | History | Annotate | Line # | Download | only in sysmon
sysmon_envsysvar.h revision 1.20 
      1 /* $NetBSD: sysmon_envsysvar.h,v 1.20 2007/10/07 04:11:16 xtraeme Exp $ */
      2 
      3 /*-
      4  * Copyright (c) 2007 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_STATES
     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 /* convenience macros to avoid writing same code many times */
     63 #define SENSOR_OBJUPDATED(a, b)						\
     64 do {									\
     65 	DPRINTFOBJ(("%s: obj (%s:%d) updated\n", __func__, (a), (b)));	\
     66 } while (/* CONSTCOND */ 0)
     67 
     68 /* struct used by a sysmon envsys event */
     69 typedef struct sme_event {
     70 	/* to add works into our workqueue */
     71 	struct work 		see_wk;
     72 	LIST_ENTRY(sme_event) 	see_list;
     73 	struct penvsys_state	pes;		/* our power envsys */
     74 	int32_t			critval;	/* critical value set */
     75 	int			type;		/* type of the event */
     76 	int			snum;		/* sensor number */
     77 	int			evsent;		/* event already sent */
     78 	int 			see_flags;	/* see above */
     79 #define SME_EVENT_WORKING	0x0001 		/* This event is busy */
     80 } sme_event_t;
     81 
     82 /* struct by a sysmon envsys event set by a driver */
     83 typedef struct sme_event_drv {
     84 	struct sysmon_envsys	*sme;
     85 	prop_dictionary_t	sdict;
     86 	envsys_data_t		*edata;
     87 	int			powertype;
     88 } sme_event_drv_t;
     89 
     90 struct sme_description_table {
     91 	int 		type;
     92 	int 		crittype;
     93 	const char 	*desc;
     94 };
     95 
     96 /* common */
     97 extern	kmutex_t sme_mtx; 		/* mutex for devices/events */
     98 extern 	kmutex_t sme_event_init_mtx;	/* init/destroy the events framework */
     99 extern 	kcondvar_t sme_cv;		/* to wait for devices/events working */
    100 
    101 /* linked list for the sysmon envsys devices */
    102 LIST_HEAD(, sysmon_envsys) sysmon_envsys_list;
    103 
    104 /* linked list for the sysmon envsys events */
    105 LIST_HEAD(, sme_event) sme_events_list;
    106 
    107 /* functions to handle sysmon envsys devices */
    108 sme_event_drv_t *sme_add_sensor_dictionary(struct sysmon_envsys *,
    109 					   prop_array_t,
    110 			    	  	   prop_dictionary_t,
    111 					   envsys_data_t *);
    112 int	sme_update_dictionary(struct sysmon_envsys *);
    113 int	sme_userset_dictionary(struct sysmon_envsys *,
    114 			       prop_dictionary_t, prop_array_t);
    115 prop_dictionary_t sme_sensor_dictionary_get(prop_array_t, const char *);
    116 
    117 /* functions to handle sysmon envsys events */
    118 int	sme_event_register(prop_dictionary_t, envsys_data_t *, const char *,
    119 			   const char *, int32_t, int, int);
    120 int	sme_event_unregister(const char *, int);
    121 void	sme_event_unregister_all(const char *);
    122 void	sme_event_drvadd(void *);
    123 int	sme_events_init(void);
    124 void	sme_events_destroy(void);
    125 void	sme_events_check(void *);
    126 void	sme_events_worker(struct work *, void *);
    127 
    128 /* common functions to create/update objects in a dictionary */
    129 int	sme_sensor_upbool(prop_dictionary_t, const char *, bool);
    130 int	sme_sensor_upint32(prop_dictionary_t, const char *, int32_t);
    131 int	sme_sensor_upuint32(prop_dictionary_t, const char *, uint32_t);
    132 int	sme_sensor_upstring(prop_dictionary_t, const char *, const char *);
    133 
    134 const struct	sme_description_table *sme_get_description_table(int);
    135 
    136 #endif /* _DEV_SYSMON_ENVSYSVAR_H_ */
    137