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