xref: /netbsd-src/sys/dev/sysmon/sysmonvar.h (revision 466a16a118933bd295a8a104f095714fadf9cf68)
1 /*	$NetBSD: sysmonvar.h,v 1.27 2008/06/03 15:00:57 jmcneill Exp $	*/
2 
3 /*-
4  * Copyright (c) 2000 Zembu Labs, Inc.
5  * All rights reserved.
6  *
7  * Author: Jason R. Thorpe <thorpej@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 
48 struct lwp;
49 struct proc;
50 struct knote;
51 struct uio;
52 struct workqueue;
53 
54 #define	SYSMON_MINOR_ENVSYS	0
55 #define	SYSMON_MINOR_WDOG	1
56 #define	SYSMON_MINOR_POWER	2
57 
58 /*****************************************************************************
59  * Environmental sensor support
60  *****************************************************************************/
61 
62 struct sme_event;
63 struct sme_sensor_names;
64 
65 struct sysmon_envsys {
66 	const char *sme_name;		/* envsys device name */
67 	u_int sme_nsensors;		/* sensors count, from driver */
68 	u_int sme_fsensor;		/* sensor index base, from sysmon */
69 #define SME_SENSOR_IDX(sme, idx) 	((idx) - (sme)->sme_fsensor)
70 	int sme_class;			/* class of device */
71 #define SME_CLASS_BATTERY	1		/* device is a battery */
72 #define SME_CLASS_ACADAPTER	2		/* device is an AC adapter */
73 	int sme_flags;			/* additional flags */
74 #define SME_FLAG_BUSY 		0x00000001 	/* device busy */
75 #define SME_DISABLE_REFRESH	0x00000002	/* disable sme_refresh */
76 #define SME_CALLOUT_INITIALIZED	0x00000004	/* callout was initialized */
77 #define SME_INIT_REFRESH        0x00000008      /* call sme_refresh() after
78 						   interrupts are enabled in
79 						   the autoconf(9) process. */
80 #define SME_POLL_ONLY           0x00000010      /* only poll sme_refresh */
81 
82 	void *sme_cookie;		/* for ENVSYS back-end */
83 
84 	/*
85 	 * Function callback to receive data from device.
86 	 */
87 	void (*sme_refresh)(struct sysmon_envsys *, envsys_data_t *);
88 
89 	struct workqueue *sme_wq;	/* the workqueue for the events */
90 	struct callout sme_callout;	/* for the events */
91 	uint64_t sme_events_timeout;	/* the timeout used in the callout */
92 
93 	/*
94 	 * linked list for the sysmon envsys devices.
95 	 */
96 	LIST_ENTRY(sysmon_envsys) sme_list;
97 
98 	/*
99 	 * linked list for the events that a device maintains.
100 	 */
101 	LIST_HEAD(, sme_event) sme_events_list;
102 
103 	/*
104 	 * tailq for the sensors that a device maintains.
105 	 */
106 	TAILQ_HEAD(, envsys_data) sme_sensors_list;
107 
108 	/*
109 	 * Locking/synchronization.
110 	 */
111 	kmutex_t sme_mtx;
112 	kmutex_t sme_callout_mtx;
113 	kcondvar_t sme_condvar;
114 };
115 
116 int	sysmonopen_envsys(dev_t, int, int, struct lwp *);
117 int	sysmonclose_envsys(dev_t, int, int, struct lwp *);
118 int	sysmonioctl_envsys(dev_t, u_long, void *, int, struct lwp *);
119 
120 struct sysmon_envsys 	*sysmon_envsys_create(void);
121 void 			sysmon_envsys_destroy(struct sysmon_envsys *);
122 
123 int	sysmon_envsys_register(struct sysmon_envsys *);
124 void	sysmon_envsys_unregister(struct sysmon_envsys *);
125 
126 int	sysmon_envsys_sensor_attach(struct sysmon_envsys *, envsys_data_t *);
127 int	sysmon_envsys_sensor_detach(struct sysmon_envsys *, envsys_data_t *);
128 
129 void	sysmon_envsys_init(void);
130 
131 /*****************************************************************************
132  * Watchdog timer support
133  *****************************************************************************/
134 
135 struct sysmon_wdog {
136 	const char *smw_name;		/* watchdog device name */
137 
138 	LIST_ENTRY(sysmon_wdog) smw_list;
139 
140 	void *smw_cookie;		/* for watchdog back-end */
141 	int (*smw_setmode)(struct sysmon_wdog *);
142 	int (*smw_tickle)(struct sysmon_wdog *);
143 	u_int smw_period;		/* timer period (in seconds) */
144 	int smw_mode;			/* timer mode */
145 	u_int smw_refcnt;		/* references */
146 	pid_t smw_tickler;		/* last process to tickle */
147 };
148 
149 int	sysmonopen_wdog(dev_t, int, int, struct lwp *);
150 int	sysmonclose_wdog(dev_t, int, int, struct lwp *);
151 int	sysmonioctl_wdog(dev_t, u_long, void *, int, struct lwp *);
152 
153 int     sysmon_wdog_register(struct sysmon_wdog *);
154 int     sysmon_wdog_unregister(struct sysmon_wdog *);
155 
156 void	sysmon_wdog_init(void);
157 
158 /*****************************************************************************
159  * Power management support
160  *****************************************************************************/
161 
162 struct sysmon_pswitch {
163 	const char *smpsw_name;		/* power switch name */
164 	int smpsw_type;			/* power switch type */
165 
166 	LIST_ENTRY(sysmon_pswitch) smpsw_list;
167 };
168 
169 int	sysmonopen_power(dev_t, int, int, struct lwp *);
170 int	sysmonclose_power(dev_t, int, int, struct lwp *);
171 int	sysmonread_power(dev_t, struct uio *, int);
172 int	sysmonpoll_power(dev_t, int, struct lwp *);
173 int	sysmonkqfilter_power(dev_t, struct knote *);
174 int	sysmonioctl_power(dev_t, u_long, void *, int, struct lwp *);
175 
176 void	sysmon_power_settype(const char *);
177 
178 int	sysmon_pswitch_register(struct sysmon_pswitch *);
179 void	sysmon_pswitch_unregister(struct sysmon_pswitch *);
180 
181 void	sysmon_pswitch_event(struct sysmon_pswitch *, int);
182 void	sysmon_penvsys_event(struct penvsys_state *, int);
183 
184 void	sysmon_power_init(void);
185 
186 #endif /* _DEV_SYSMON_SYSMONVAR_H_ */
187