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