sysmon_envsysvar.h revision 1.43 1 /* $NetBSD: sysmon_envsysvar.h,v 1.43 2012/08/27 21:42:04 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 SME_DESC_INDICATOR
49 };
50
51 #ifdef ENVSYS_DEBUG
52 #define DPRINTF(x) printf x
53 #else
54 #define DPRINTF(x)
55 #endif
56
57 #ifdef ENVSYS_OBJECTS_DEBUG
58 #define DPRINTFOBJ(x) printf x
59 #else
60 #define DPRINTFOBJ(x)
61 #endif
62
63 /*
64 * Default timeout value for the callouts if no specified.
65 */
66 #define SME_EVENTS_DEFTIMEOUT 30
67
68 /*
69 * struct used by a sysmon envsys event.
70 */
71 typedef struct sme_event {
72 struct work see_wk;
73 LIST_ENTRY(sme_event) see_list;
74 struct sysmon_envsys *see_sme; /* device associated */
75 struct penvsys_state see_pes; /* our power envsys */
76 envsys_data_t *see_edata; /* our sensor data */
77 sysmon_envsys_lim_t see_lims; /* limit values */
78 int see_type; /* type of the event */
79 int see_evstate; /* state of prev event */
80 int see_evvalue; /* value of prev event */
81 int see_flags; /* see above */
82 #define SEE_EVENT_WORKING 0x0001 /* This event is busy */
83 } sme_event_t;
84
85 /*
86 * struct by a sysmon envsys event set by a driver.
87 */
88 typedef struct sme_event_drv {
89 struct sysmon_envsys *sed_sme;
90 prop_dictionary_t sed_sdict;
91 envsys_data_t *sed_edata;
92 int sed_powertype;
93 } sme_event_drv_t;
94
95 struct sme_descr_entry {
96 int type;
97 int crittype;
98 const char *desc;
99 };
100
101 /*
102 * common stuff.
103 */
104 extern kmutex_t sme_global_mtx; /* for the sme linked list and dict */
105 extern prop_dictionary_t sme_propd; /* the global sensor dictionary */
106
107 /*
108 * linked list for the sysmon envsys devices.
109 */
110 LIST_HEAD(sysmon_envsys_lh, sysmon_envsys);
111 extern struct sysmon_envsys_lh sysmon_envsys_list;
112
113 /*
114 * functions to handle sysmon envsys devices.
115 */
116 int sme_update_dictionary(struct sysmon_envsys *);
117 int sme_update_sensor_dictionary(prop_object_t, envsys_data_t *, bool);
118 int sme_userset_dictionary(struct sysmon_envsys *,
119 prop_dictionary_t, prop_array_t);
120 prop_dictionary_t sme_sensor_dictionary_get(prop_array_t, const char *);
121 struct sysmon_envsys *sysmon_envsys_find(const char *);
122 void sysmon_envsys_acquire(struct sysmon_envsys *, bool);
123 void sysmon_envsys_release(struct sysmon_envsys *, bool);
124
125 /*
126 * functions to handle sysmon envsys events.
127 */
128 int sme_event_register(prop_dictionary_t, envsys_data_t *,
129 struct sysmon_envsys *, sysmon_envsys_lim_t *,
130 uint32_t, int, int);
131 int sme_event_unregister(struct sysmon_envsys *, const char *, int);
132 int sme_event_unregister_sensor(struct sysmon_envsys *, envsys_data_t *);
133 void sme_event_unregister_all(struct sysmon_envsys *);
134 void sme_event_drvadd(void *);
135 int sme_events_init(struct sysmon_envsys *);
136 void sme_events_destroy(struct sysmon_envsys *);
137 void sme_events_check(void *);
138 void sme_events_worker(struct work *, void *);
139 void sme_deliver_event(sme_event_t *);
140 int sme_update_limits(struct sysmon_envsys *, envsys_data_t *);
141 void sme_schedule_callout(struct sysmon_envsys *);
142
143 /*
144 * common functions to create/update objects in a dictionary.
145 */
146 int sme_sensor_upbool(prop_dictionary_t, const char *, bool);
147 int sme_sensor_upint32(prop_dictionary_t, const char *, int32_t);
148 int sme_sensor_upuint32(prop_dictionary_t, const char *, uint32_t);
149 int sme_sensor_upstring(prop_dictionary_t, const char *, const char *);
150
151 const struct sme_descr_entry *sme_find_table_entry(enum sme_descr_type, int);
152 const struct sme_descr_entry * sme_find_table_desc(enum sme_descr_type,
153 const char *);
154
155 #endif /* _DEV_SYSMON_ENVSYSVAR_H_ */
156