sys/dev/acpica/acpiio.h

   1 /*-
   2  * Copyright (c) 1999 Takanori Watanabe <takawata@jp.freebsd.org>
   3  * Copyright (c) 1999 Mitsuru IWASAKI <iwasaki@FreeBSD.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 #ifndef _ACPIIO_H_
  31 #define _ACPIIO_H_
  32
  33 /*
  34  * Core ACPI subsystem ioctls
  35  */
  36 #define ACPIIO_SETSLPSTATE      _IOW('P', 3, int) /* DEPRECATED */
  37
  38 /* Request S1-5 sleep state. User is notified and then sleep proceeds. */
  39 #define ACPIIO_REQSLPSTATE      _IOW('P', 4, int)
  40
  41 /* Allow suspend to continue (0) or abort it (errno). */
  42 #define ACPIIO_ACKSLPSTATE      _IOW('P', 5, int)
  43
  44 struct acpi_battinfo {
  45     int  cap;                           /* percent */
  46     int  min;                           /* remaining time (in minutes) */
  47     int  state;                         /* battery state */
  48     int  rate;                          /* emptying rate */
  49 };
  50
  51 #define ACPI_CMBAT_MAXSTRLEN 32
  52 struct acpi_bif {
  53     uint32_t units;                     /* Units (mW or mA). */
  54 #define ACPI_BIF_UNITS_MW       0       /* Capacity in mWh, rate in mW. */
  55 #define ACPI_BIF_UNITS_MA       1       /* Capacity in mAh, rate in mA. */
  56     uint32_t dcap;                      /* Design Capacity */
  57     uint32_t lfcap;                     /* Last Full capacity */
  58     uint32_t btech;                     /* Battery Technology */
  59     uint32_t dvol;                      /* Design voltage (mV) */
  60     uint32_t wcap;                      /* WARN capacity */
  61     uint32_t lcap;                      /* Low capacity */
  62     uint32_t gra1;                      /* Granularity 1 (Warn to Low) */
  63     uint32_t gra2;                      /* Granularity 2 (Full to Warn) */
  64     char model[ACPI_CMBAT_MAXSTRLEN];   /* model identifier */
  65     char serial[ACPI_CMBAT_MAXSTRLEN];  /* Serial number */
  66     char type[ACPI_CMBAT_MAXSTRLEN];    /* Type */
  67     char oeminfo[ACPI_CMBAT_MAXSTRLEN]; /* OEM infomation */
  68 };
  69
  70 struct acpi_bst {
  71     uint32_t state;                     /* Battery State */
  72     uint32_t rate;                      /* Present Rate */
  73     uint32_t cap;                       /* Remaining Capacity */
  74     uint32_t volt;                      /* Present Voltage */
  75 };
  76
  77 /*
  78  * Note that the following definitions represent status bits for internal
  79  * driver state.  The first three of them (charging, discharging and critical)
  80  * conveninetly conform to ACPI specification of status returned by _BST
  81  * method.  Other definitions (not present, etc) are synthetic.
  82  * Also note that according to the specification the charging and discharging
  83  * status bits must not be set at the same time.
  84  */
  85 #define ACPI_BATT_STAT_DISCHARG         0x0001
  86 #define ACPI_BATT_STAT_CHARGING         0x0002
  87 #define ACPI_BATT_STAT_CRITICAL         0x0004
  88 #define ACPI_BATT_STAT_INVALID                                  \
  89     (ACPI_BATT_STAT_DISCHARG | ACPI_BATT_STAT_CHARGING)
  90 #define ACPI_BATT_STAT_BST_MASK                                 \
  91     (ACPI_BATT_STAT_INVALID | ACPI_BATT_STAT_CRITICAL)
  92 #define ACPI_BATT_STAT_NOT_PRESENT      ACPI_BATT_STAT_BST_MASK
  93
  94 union acpi_battery_ioctl_arg {
  95     int                  unit;  /* Device unit or ACPI_BATTERY_ALL_UNITS. */
  96
  97     struct acpi_battinfo battinfo;
  98
  99     struct acpi_bif      bif;
 100     struct acpi_bst      bst;
 101 };
 102
 103 #define ACPI_BATTERY_ALL_UNITS  (-1)
 104 #define ACPI_BATT_UNKNOWN       0xffffffff /* _BST or _BIF value unknown. */
 105
 106 /* Common battery ioctls */
 107 #define ACPIIO_BATT_GET_UNITS     _IOR('B', 0x01, int)
 108 #define ACPIIO_BATT_GET_BATTINFO _IOWR('B', 0x03, union acpi_battery_ioctl_arg)
 109 #define ACPIIO_BATT_GET_BIF      _IOWR('B', 0x10, union acpi_battery_ioctl_arg)
 110 #define ACPIIO_BATT_GET_BST      _IOWR('B', 0x11, union acpi_battery_ioctl_arg)
 111
 112 /* Control Method battery ioctls (deprecated) */
 113 #define ACPIIO_CMBAT_GET_BIF     ACPIIO_BATT_GET_BIF
 114 #define ACPIIO_CMBAT_GET_BST     ACPIIO_BATT_GET_BST
 115
 116 /* Get AC adapter status. */
 117 #define ACPIIO_ACAD_GET_STATUS    _IOR('A', 1, int)
 118
 119 #ifdef _KERNEL
 120 typedef int     (*acpi_ioctl_fn)(u_long cmd, caddr_t addr, void *arg);
 121 extern int      acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg);
 122 extern void     acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn);
 123 #endif
 124
 125 #endif /* !_ACPIIO_H_ */