xref: /freebsd/sys/dev/acpica/acpiio.h (revision ceaec73d406831b1251babb61675df0a1aa54a31)
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)
37 
38 struct acpi_battdesc {
39     int	 type;				/* battery type */
40     int	 phys_unit;			/* physical unit of devclass */
41 };
42 
43 #define ACPI_BATT_TYPE_CMBAT		0x0000
44 #define ACPI_BATT_TYPE_SMBAT		0x0001
45 
46 struct acpi_battinfo {
47     int	 cap;				/* percent */
48     int	 min;				/* remaining time (in minutes) */
49     int	 state;				/* battery state */
50 };
51 
52 #define ACPI_CMBAT_MAXSTRLEN 32
53 struct acpi_bif {
54     u_int32_t units;			/* 0 for mWh, 1 for mAh */
55     u_int32_t dcap;			/* Design Capacity */
56     u_int32_t lfcap;			/* Last Full capacity */
57     u_int32_t btech;			/* Battery Technology */
58     u_int32_t dvol;			/* Design voltage (mV) */
59     u_int32_t wcap;			/* WARN capacity */
60     u_int32_t lcap;			/* Low capacity */
61     u_int32_t gra1;			/* Granularity 1 (Warn to Low) */
62     u_int32_t gra2;			/* Granularity 2 (Full to Warn) */
63     char model[ACPI_CMBAT_MAXSTRLEN];	/* model identifier */
64     char serial[ACPI_CMBAT_MAXSTRLEN];	/* Serial number */
65     char type[ACPI_CMBAT_MAXSTRLEN];	/* Type */
66     char oeminfo[ACPI_CMBAT_MAXSTRLEN];	/* OEM infomation */
67 };
68 
69 struct acpi_bst {
70     u_int32_t state;			/* Battery State */
71     u_int32_t rate;			/* Present Rate */
72     u_int32_t cap;			/* Remaining Capacity */
73     u_int32_t volt;			/* Present Voltage */
74 };
75 
76 #define ACPI_BATT_STAT_DISCHARG		0x0001
77 #define ACPI_BATT_STAT_CHARGING		0x0002
78 #define ACPI_BATT_STAT_CRITICAL		0x0004
79 #define ACPI_BATT_STAT_NOT_PRESENT	0x0007
80 #define ACPI_BATT_STAT_MAX		0x0007
81 
82 union acpi_battery_ioctl_arg {
83     int			 unit;	/* argument: logical unit (-1 = overall) */
84 
85     struct acpi_battdesc battdesc;
86     struct acpi_battinfo battinfo;
87 
88     struct acpi_bif	 bif;
89     struct acpi_bst	 bst;
90 };
91 
92 /* Common battery ioctls */
93 #define ACPIIO_BATT_GET_UNITS	  _IOR('B', 0x01, int)
94 #define ACPIIO_BATT_GET_TYPE	  _IOR('B', 0x02, union acpi_battery_ioctl_arg)
95 #define ACPIIO_BATT_GET_BATTINFO _IOWR('B', 0x03, union acpi_battery_ioctl_arg)
96 #define ACPIIO_BATT_GET_BATTDESC _IOWR('B', 0x04, union acpi_battery_ioctl_arg)
97 #define ACPIIO_BATT_GET_BIF	 _IOWR('B', 0x10, union acpi_battery_ioctl_arg)
98 #define ACPIIO_BATT_GET_BST	 _IOWR('B', 0x11, union acpi_battery_ioctl_arg)
99 
100 /* Control Method battery ioctls (deprecated) */
101 #define ACPIIO_CMBAT_GET_BIF	 ACPIIO_BATT_GET_BIF
102 #define ACPIIO_CMBAT_GET_BST	 ACPIIO_BATT_GET_BST
103 
104 /* Get AC adapter status. */
105 #define ACPIIO_ACAD_GET_STATUS	  _IOR('A', 1, int)
106 
107 #ifdef _KERNEL
108 typedef int	(*acpi_ioctl_fn)(u_long cmd, caddr_t addr, void *arg);
109 extern int	acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg);
110 extern void	acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn);
111 #endif
112 
113 #endif /* !_ACPIIO_H_ */
114