sysmonvar.h revision 1.42
1 /* $NetBSD: sysmonvar.h,v 1.42 2012/07/15 18:33:07 pgoyette Exp $ */ 2 3 /*- 4 * Copyright (c) 2000 Zembu Labs, Inc. 5 * All rights reserved. 6 * 7 * Author: Jason R. Thorpe <thorpej (at) zembu.com> 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 3. All advertising materials mentioning features or use of this software 18 * must display the following acknowledgement: 19 * This product includes software developed by Zembu Labs, Inc. 20 * 4. Neither the name of Zembu Labs nor the names of its employees may 21 * be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY ZEMBU LABS, INC. ``AS IS'' AND ANY EXPRESS 25 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WAR- 26 * RANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DIS- 27 * CLAIMED. IN NO EVENT SHALL ZEMBU LABS BE LIABLE FOR ANY DIRECT, INDIRECT, 28 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 29 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 33 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34 */ 35 36 #ifndef _DEV_SYSMON_SYSMONVAR_H_ 37 #define _DEV_SYSMON_SYSMONVAR_H_ 38 39 #include <sys/param.h> 40 #include <sys/envsys.h> 41 #include <sys/wdog.h> 42 #include <sys/power.h> 43 #include <sys/queue.h> 44 #include <sys/callout.h> 45 #include <sys/mutex.h> 46 #include <sys/condvar.h> 47 #include <sys/rnd.h> 48 49 struct lwp; 50 struct proc; 51 struct knote; 52 struct uio; 53 struct workqueue; 54 55 #define SYSMON_MINOR_ENVSYS 0 56 #define SYSMON_MINOR_WDOG 1 57 #define SYSMON_MINOR_POWER 2 58 59 /***************************************************************************** 60 * Environmental sensor support 61 *****************************************************************************/ 62 63 /* 64 * Thresholds/limits that are being monitored 65 */ 66 struct sysmon_envsys_lim { 67 int32_t sel_critmax; 68 int32_t sel_warnmax; 69 int32_t sel_warnmin; 70 int32_t sel_critmin; 71 }; 72 73 typedef struct sysmon_envsys_lim sysmon_envsys_lim_t; 74 75 /* struct used by a sensor */ 76 struct envsys_data { 77 TAILQ_ENTRY(envsys_data) sensors_head; 78 uint32_t sensor; /* sensor number */ 79 uint32_t units; /* type of sensor */ 80 uint32_t state; /* sensor state */ 81 uint32_t flags; /* sensor flags */ 82 uint32_t rpms; /* for fans, nominal RPMs */ 83 int32_t rfact; /* for volts, factor x 10^4 */ 84 int32_t value_cur; /* current value */ 85 int32_t value_max; /* max value */ 86 int32_t value_min; /* min value */ 87 int32_t private; /* private data for drivers */ 88 sysmon_envsys_lim_t limits; /* thresholds for monitoring */ 89 int upropset; /* userland property set? */ 90 krndsource_t rnd_src; /* source element for rnd(4) */ 91 char desc[ENVSYS_DESCLEN]; /* sensor description */ 92 }; 93 94 typedef struct envsys_data envsys_data_t; 95 96 /* sensor flags */ 97 #define ENVSYS_FPERCENT 0x00000001 /* sensor wants a percentage */ 98 #define ENVSYS_FVALID_MAX 0x00000002 /* max value is ok */ 99 #define ENVSYS_FVALID_MIN 0x00000004 /* min value is ok */ 100 #define ENVSYS_F_OBSOLETE 0x00000008 101 #define ENVSYS_FCHANGERFACT 0x00000010 /* sensor can change rfact */ 102 103 /* monitoring flags */ 104 #define ENVSYS_FMONCRITICAL 0x00000020 /* monitor a critical state */ 105 #define ENVSYS_FMONLIMITS 0x00000040 /* monitor limits/thresholds */ 106 #define ENVSYS_FMONSTCHANGED 0x00000400 /* monitor a battery/drive state */ 107 #define ENVSYS_FMONANY \ 108 (ENVSYS_FMONCRITICAL | ENVSYS_FMONLIMITS | ENVSYS_FMONSTCHANGED) 109 #define ENVSYS_FMONNOTSUPP 0x00000800 /* monitoring not supported */ 110 #define ENVSYS_FNEED_REFRESH 0x00001000 /* sensor needs refreshing */ 111 #define ENVSYS_FHAS_ENTROPY 0x00002000 /* sensor provides entropy 112 for rnd(4) */ 113 114 /* 115 * Properties that can be set in upropset (and in the event_limit's 116 * flags field) 117 */ 118 #define PROP_CRITMAX 0x0001 119 #define PROP_CRITMIN 0x0002 120 #define PROP_WARNMAX 0x0004 121 #define PROP_WARNMIN 0x0008 122 #define PROP_BATTCAP 0x0010 123 #define PROP_BATTWARN 0x0020 124 #define PROP_BATTHIGH 0x0040 125 #define PROP_BATTMAX 0x0080 126 #define PROP_DESC 0x0100 127 #define PROP_RFACT 0x0200 128 129 #define PROP_DRIVER_LIMITS 0x8000 130 #define PROP_CAP_LIMITS (PROP_BATTCAP | PROP_BATTWARN | \ 131 PROP_BATTHIGH | PROP_BATTMAX) 132 #define PROP_VAL_LIMITS (PROP_CRITMAX | PROP_CRITMIN | \ 133 PROP_WARNMAX | PROP_WARNMIN) 134 #define PROP_LIMITS (PROP_CAP_LIMITS | PROP_VAL_LIMITS) 135 struct sme_event; 136 137 struct sysmon_envsys { 138 const char *sme_name; /* envsys device name */ 139 u_int sme_nsensors; /* sensors count, from driver */ 140 u_int sme_fsensor; /* sensor index base, from sysmon */ 141 #define SME_SENSOR_IDX(sme, idx) ((idx) - (sme)->sme_fsensor) 142 int sme_class; /* class of device */ 143 #define SME_CLASS_BATTERY 1 /* device is a battery */ 144 #define SME_CLASS_ACADAPTER 2 /* device is an AC adapter */ 145 int sme_flags; /* additional flags */ 146 #define SME_FLAG_BUSY 0x00000001 /* device busy */ 147 #define SME_DISABLE_REFRESH 0x00000002 /* disable sme_refresh */ 148 #define SME_CALLOUT_INITIALIZED 0x00000004 /* callout was initialized */ 149 #define SME_INIT_REFRESH 0x00000008 /* call sme_refresh() after 150 interrupts are enabled in 151 the autoconf(9) process. */ 152 #define SME_POLL_ONLY 0x00000010 /* only poll sme_refresh */ 153 154 void *sme_cookie; /* for ENVSYS back-end */ 155 156 /* 157 * Function callback to receive data from device. 158 */ 159 void (*sme_refresh)(struct sysmon_envsys *, envsys_data_t *); 160 161 /* 162 * Function callbacks to exchange limit/threshold values 163 * with device 164 */ 165 void (*sme_set_limits)(struct sysmon_envsys *, envsys_data_t *, 166 sysmon_envsys_lim_t *, uint32_t *); 167 void (*sme_get_limits)(struct sysmon_envsys *, envsys_data_t *, 168 sysmon_envsys_lim_t *, uint32_t *); 169 170 struct workqueue *sme_wq; /* the workqueue for the events */ 171 struct callout sme_callout; /* for the events */ 172 uint64_t sme_events_timeout; /* the timeout used in the callout */ 173 174 /* 175 * linked list for the sysmon envsys devices. 176 */ 177 LIST_ENTRY(sysmon_envsys) sme_list; 178 179 /* 180 * linked list for the events that a device maintains. 181 */ 182 LIST_HEAD(, sme_event) sme_events_list; 183 184 /* 185 * tailq for the sensors that a device maintains. 186 */ 187 TAILQ_HEAD(, envsys_data) sme_sensors_list; 188 189 /* 190 * Locking/synchronization. 191 */ 192 kmutex_t sme_mtx; 193 kmutex_t sme_callout_mtx; 194 kcondvar_t sme_condvar; 195 }; 196 197 int sysmonopen_envsys(dev_t, int, int, struct lwp *); 198 int sysmonclose_envsys(dev_t, int, int, struct lwp *); 199 int sysmonioctl_envsys(dev_t, u_long, void *, int, struct lwp *); 200 201 struct sysmon_envsys *sysmon_envsys_create(void); 202 void sysmon_envsys_destroy(struct sysmon_envsys *); 203 204 int sysmon_envsys_register(struct sysmon_envsys *); 205 void sysmon_envsys_unregister(struct sysmon_envsys *); 206 207 int sysmon_envsys_sensor_attach(struct sysmon_envsys *, envsys_data_t *); 208 int sysmon_envsys_sensor_detach(struct sysmon_envsys *, envsys_data_t *); 209 210 uint32_t sysmon_envsys_get_max_value(bool (*)(const envsys_data_t*), bool); 211 212 void sysmon_envsys_sensor_event(struct sysmon_envsys *, envsys_data_t *, 213 int); 214 215 void sysmon_envsys_refresh_sensor(struct sysmon_envsys *, envsys_data_t *); 216 217 typedef bool (*sysmon_envsys_callback_t)(const struct sysmon_envsys *, 218 const envsys_data_t *, void*); 219 220 void sysmon_envsys_foreach_sensor(sysmon_envsys_callback_t, void *, bool); 221 222 int sysmon_envsys_update_limits(struct sysmon_envsys *, envsys_data_t *); 223 224 void sysmon_envsys_init(void); 225 226 /***************************************************************************** 227 * Watchdog timer support 228 *****************************************************************************/ 229 230 struct sysmon_wdog { 231 const char *smw_name; /* watchdog device name */ 232 233 LIST_ENTRY(sysmon_wdog) smw_list; 234 235 void *smw_cookie; /* for watchdog back-end */ 236 int (*smw_setmode)(struct sysmon_wdog *); 237 int (*smw_tickle)(struct sysmon_wdog *); 238 u_int smw_period; /* timer period (in seconds) */ 239 int smw_mode; /* timer mode */ 240 u_int smw_refcnt; /* references */ 241 pid_t smw_tickler; /* last process to tickle */ 242 }; 243 244 int sysmonopen_wdog(dev_t, int, int, struct lwp *); 245 int sysmonclose_wdog(dev_t, int, int, struct lwp *); 246 int sysmonioctl_wdog(dev_t, u_long, void *, int, struct lwp *); 247 248 int sysmon_wdog_setmode(struct sysmon_wdog *, int, u_int); 249 int sysmon_wdog_register(struct sysmon_wdog *); 250 int sysmon_wdog_unregister(struct sysmon_wdog *); 251 252 void sysmon_wdog_init(void); 253 254 /***************************************************************************** 255 * Power management support 256 *****************************************************************************/ 257 258 struct sysmon_pswitch { 259 const char *smpsw_name; /* power switch name */ 260 int smpsw_type; /* power switch type */ 261 262 LIST_ENTRY(sysmon_pswitch) smpsw_list; 263 }; 264 265 int sysmonopen_power(dev_t, int, int, struct lwp *); 266 int sysmonclose_power(dev_t, int, int, struct lwp *); 267 int sysmonread_power(dev_t, struct uio *, int); 268 int sysmonpoll_power(dev_t, int, struct lwp *); 269 int sysmonkqfilter_power(dev_t, struct knote *); 270 int sysmonioctl_power(dev_t, u_long, void *, int, struct lwp *); 271 272 void sysmon_power_settype(const char *); 273 274 int sysmon_pswitch_register(struct sysmon_pswitch *); 275 void sysmon_pswitch_unregister(struct sysmon_pswitch *); 276 277 void sysmon_pswitch_event(struct sysmon_pswitch *, int); 278 void sysmon_penvsys_event(struct penvsys_state *, int); 279 280 void sysmon_power_init(void); 281 282 #endif /* _DEV_SYSMON_SYSMONVAR_H_ */ 283
Indexes created Thu Sep 25 02:09:54 GMT 2025