/* $OpenBSD: sensors.h,v 1.23 2007/03/22 16:55:31 deraadt Exp $ */

/*
 * Copyright (c) 2003, 2004 Alexander Yurchenko <grange@openbsd.org>
 * Copyright (c) 2006 Constantine A. Murenin <cnst+openbsd@bugmail.mojo.ru>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _SYS_SENSORS_H_
#define _SYS_SENSORS_H_

#include <sys/types.h>

/* Sensor types */
enum sensor_type {
        SENSOR_TEMP,                    /* temperature (muK) */
        SENSOR_FANRPM,                  /* fan revolution speed */
        SENSOR_VOLTS_DC,                /* voltage (muV DC) */
        SENSOR_VOLTS_AC,                /* voltage (muV AC) */
        SENSOR_OHMS,                    /* resistance */
        SENSOR_WATTS,                   /* power */
        SENSOR_AMPS,                    /* current (muA) */
        SENSOR_WATTHOUR,                /* power capacity */
        SENSOR_AMPHOUR,                 /* power capacity */
        SENSOR_INDICATOR,               /* boolean indicator */
        SENSOR_INTEGER,                 /* generic integer value */
        SENSOR_PERCENT,                 /* percent */
        SENSOR_LUX,                     /* illuminance (mulx) */
        SENSOR_DRIVE,                   /* disk */
        SENSOR_TIMEDELTA,               /* system time error (nSec) */
        SENSOR_ECC,                     /* memory ecc */
        SENSOR_FREQ,                    /* frequency */
        SENSOR_RESERVED_B,              /* reserved */
        SENSOR_RESERVED_C,              /* reserved */
        SENSOR_RESERVED_D,              /* reserved */
        SENSOR_RESERVED_E,              /* reserved */
        SENSOR_RESERVED_F,              /* reserved */
        SENSOR_MAX_TYPES
};

static const char * const sensor_type_s[SENSOR_MAX_TYPES + 1] = {
        "temp",
        "fan",
        "volt",
        "acvolt",
        "resistance",
        "power",
        "current",
        "watthour",
        "amphour",
        "indicator",
        "raw",
        "percent",
        "illuminance",
        "drive",
        "timedelta",
        "ecc",
        "freq",
        "reserved_b",
        "reserved_c",
        "reserved_d",
        "reserved_e",
        "reserved_f",
        "undefined"
};

#define SENSOR_DRIVE_EMPTY      1
#define SENSOR_DRIVE_READY      2
#define SENSOR_DRIVE_POWERUP    3
#define SENSOR_DRIVE_ONLINE     4
#define SENSOR_DRIVE_IDLE       5
#define SENSOR_DRIVE_ACTIVE     6
#define SENSOR_DRIVE_REBUILD    7
#define SENSOR_DRIVE_POWERDOWN  8
#define SENSOR_DRIVE_FAIL       9
#define SENSOR_DRIVE_PFAIL      10

/* Sensor states */
enum sensor_status {
        SENSOR_S_UNSPEC,                /* status is unspecified */
        SENSOR_S_OK,                    /* status is ok */
        SENSOR_S_WARN,                  /* status is warning */
        SENSOR_S_CRIT,                  /* status is critical */
        SENSOR_S_UNKNOWN                /* status is unknown */
};

/*
 * Sensor data:
 * New fields should be added at the end to encourage backwards compat
 */
struct sensor {
        char desc[32];                  /* sensor description, may be empty */
        struct timeval tv;              /* sensor value last change time */
        int64_t value;                  /* current value */
        enum sensor_type type;          /* sensor type */
        enum sensor_status status;      /* sensor status */
        int numt;                       /* sensor number of .type type */
        int flags;                      /* sensor flags */
#define SENSOR_FINVALID         0x0001  /* sensor is invalid */
#define SENSOR_FUNKNOWN         0x0002  /* sensor value is unknown */
};

/*
 * Sensor device data:
 * New fields should be added at the end to encourage backwards compat
 */
struct sensordev {
        int num;                        /* sensordev number */
        char xname[16];                 /* unix device name */
        int maxnumt[SENSOR_MAX_TYPES];
        int sensors_count;
};

#define MAXSENSORDEVICES 32

#ifdef _KERNEL

#include <sys/queue.h>
#include <sys/sysctl.h>

/* Sensor data */
struct ksensor {
        SLIST_ENTRY(ksensor) list;      /* device-scope list */
        char desc[32];                  /* sensor description, may be empty */
        struct timeval tv;              /* sensor value last change time */
        int64_t value;                  /* current value */
        enum sensor_type type;          /* sensor type */
        enum sensor_status status;      /* sensor status */
        int numt;                       /* sensor number of .type type */
        int flags;                      /* sensor flags, ie. SENSOR_FINVALID */
        struct sysctl_oid *oid;
};
SLIST_HEAD(ksensors_head, ksensor);

/* Sensor device data */
struct ksensordev {
        TAILQ_ENTRY(ksensordev) list;
        int num;                        /* sensordev number */
        char xname[16];                 /* unix device name */
        int maxnumt[SENSOR_MAX_TYPES];
        int sensors_count;
        struct ksensors_head sensors_list;
        struct sysctl_oid *oid;
        struct sysctl_ctx_list clist;
};

/* struct ksensordev */
void            sensordev_install(struct ksensordev *);
void            sensordev_deinstall(struct ksensordev *);

/* struct ksensor */
void            sensor_attach(struct ksensordev *, struct ksensor *);
void            sensor_detach(struct ksensordev *, struct ksensor *);

/*
 * Task scheduling
 * Deprecated; use sensor_task_{register,unregiser}2() instead.
 */
void            sensor_task_register(void *, void (*)(void *), int);
void            sensor_task_unregister(void *);

/*
 * Task scheduling
 */
struct sensor_task;
struct sensor_task *
                sensor_task_register2(void *, void (*)(void *),
                    int period, int cpu);
void            sensor_task_unregister2(struct sensor_task *);

static __inline void
sensor_set_invalid(struct ksensor *sens)
{
        sens->status = SENSOR_S_UNSPEC;
        sens->flags &= ~(SENSOR_FUNKNOWN | SENSOR_FINVALID);
        sens->flags |= SENSOR_FINVALID;
        sens->value = 0;
}

static __inline void
sensor_set_unknown(struct ksensor *sens)
{
        sens->status = SENSOR_S_UNKNOWN;
        sens->flags &= ~(SENSOR_FUNKNOWN | SENSOR_FINVALID);
        sens->flags |= SENSOR_FUNKNOWN;
        sens->value = 0;
}

static __inline void
sensor_set(struct ksensor *sens, int64_t val, enum sensor_status status)
{
        sens->status = status;
        sens->flags &= ~(SENSOR_FUNKNOWN | SENSOR_FINVALID);
        sens->value = val;
}

static __inline void
sensor_set_temp_degc(struct ksensor *sens, int degc, enum sensor_status status)
{
        sensor_set(sens, (degc * 1000000) + 273150000, status);
}

#endif  /* _KERNEL */

#endif  /* !_SYS_SENSORS_H_ */