sys/dev/sysmon/sysmonvar.h

   1 /*      $NetBSD: sysmonvar.h,v 1.28 2009/06/13 16:08:25 pgoyette 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
  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 #define SME_POLL_ONLY           0x00000010      /* only poll sme_refresh */
  80
  81         void *sme_cookie;               /* for ENVSYS back-end */
  82
  83         /*
  84          * Function callback to receive data from device.
  85          */
  86         void (*sme_refresh)(struct sysmon_envsys *, envsys_data_t *);
  87
  88         /*
  89          * Function callbacks to exchange limit/threshold values
  90          * with device
  91          */
  92         void (*sme_set_limits)(struct sysmon_envsys *, envsys_data_t *,
  93                                sysmon_envsys_lim_t *);
  94         void (*sme_get_limits)(struct sysmon_envsys *, envsys_data_t *,
  95                                sysmon_envsys_lim_t *);
  96
  97         struct workqueue *sme_wq;       /* the workqueue for the events */
  98         struct callout sme_callout;     /* for the events */
  99         uint64_t sme_events_timeout;    /* the timeout used in the callout */
 100
 101         /*
 102          * linked list for the sysmon envsys devices.
 103          */
 104         LIST_ENTRY(sysmon_envsys) sme_list;
 105
 106         /*
 107          * linked list for the events that a device maintains.
 108          */
 109         LIST_HEAD(, sme_event) sme_events_list;
 110
 111         /*
 112          * tailq for the sensors that a device maintains.
 113          */
 114         TAILQ_HEAD(, envsys_data) sme_sensors_list;
 115
 116         /*
 117          * Locking/synchronization.
 118          */
 119         kmutex_t sme_mtx;
 120         kmutex_t sme_callout_mtx;
 121         kcondvar_t sme_condvar;
 122 };
 123
 124 int     sysmonopen_envsys(dev_t, int, int, struct lwp *);
 125 int     sysmonclose_envsys(dev_t, int, int, struct lwp *);
 126 int     sysmonioctl_envsys(dev_t, u_long, void *, int, struct lwp *);
 127
 128 struct sysmon_envsys    *sysmon_envsys_create(void);
 129 void                    sysmon_envsys_destroy(struct sysmon_envsys *);
 130
 131 int     sysmon_envsys_register(struct sysmon_envsys *);
 132 void    sysmon_envsys_unregister(struct sysmon_envsys *);
 133
 134 int     sysmon_envsys_sensor_attach(struct sysmon_envsys *, envsys_data_t *);
 135 int     sysmon_envsys_sensor_detach(struct sysmon_envsys *, envsys_data_t *);
 136
 137 void    sysmon_envsys_init(void);
 138
 139 /*****************************************************************************
 140  * Watchdog timer support
 141  *****************************************************************************/
 142
 143 struct sysmon_wdog {
 144         const char *smw_name;           /* watchdog device name */
 145
 146         LIST_ENTRY(sysmon_wdog) smw_list;
 147
 148         void *smw_cookie;               /* for watchdog back-end */
 149         int (*smw_setmode)(struct sysmon_wdog *);
 150         int (*smw_tickle)(struct sysmon_wdog *);
 151         u_int smw_period;               /* timer period (in seconds) */
 152         int smw_mode;                   /* timer mode */
 153         u_int smw_refcnt;               /* references */
 154         pid_t smw_tickler;              /* last process to tickle */
 155 };
 156
 157 int     sysmonopen_wdog(dev_t, int, int, struct lwp *);
 158 int     sysmonclose_wdog(dev_t, int, int, struct lwp *);
 159 int     sysmonioctl_wdog(dev_t, u_long, void *, int, struct lwp *);
 160
 161 int     sysmon_wdog_register(struct sysmon_wdog *);
 162 int     sysmon_wdog_unregister(struct sysmon_wdog *);
 163
 164 void    sysmon_wdog_init(void);
 165
 166 /*****************************************************************************
 167  * Power management support
 168  *****************************************************************************/
 169
 170 struct sysmon_pswitch {
 171         const char *smpsw_name;         /* power switch name */
 172         int smpsw_type;                 /* power switch type */
 173
 174         LIST_ENTRY(sysmon_pswitch) smpsw_list;
 175 };
 176
 177 int     sysmonopen_power(dev_t, int, int, struct lwp *);
 178 int     sysmonclose_power(dev_t, int, int, struct lwp *);
 179 int     sysmonread_power(dev_t, struct uio *, int);
 180 int     sysmonpoll_power(dev_t, int, struct lwp *);
 181 int     sysmonkqfilter_power(dev_t, struct knote *);
 182 int     sysmonioctl_power(dev_t, u_long, void *, int, struct lwp *);
 183
 184 void    sysmon_power_settype(const char *);
 185
 186 int     sysmon_pswitch_register(struct sysmon_pswitch *);
 187 void    sysmon_pswitch_unregister(struct sysmon_pswitch *);
 188
 189 void    sysmon_pswitch_event(struct sysmon_pswitch *, int);
 190 void    sysmon_penvsys_event(struct penvsys_state *, int);
 191
 192 void    sysmon_power_init(void);
 193
 194 #endif /* _DEV_SYSMON_SYSMONVAR_H_ */