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