1/* XXX - DSR */
2/* $OpenBSD: apmvar.h,v 1.8 2019/01/22 02:36:30 phessler Exp $ */
3
4/*
5 * Copyright (c) 1995 John T. Kohl
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. The name of the author may not be used to endorse or promote products
17 * derived from this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
23 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 *
31 */
32#ifndef _MACHINE_APMVAR_H_
33#define _MACHINE_APMVAR_H_
34
35#include <sys/ioccom.h>
36
37/* Advanced Power Management (v1.0 and v1.1 specification)
38 * functions/defines/etc.
39 */
40
41#define APM_VERSION 0x0102
42
43/*
44 * APM info word from boot loader
45 */
46#define APM_16BIT_SUPPORTED 0x00010000
47#define APM_32BIT_SUPPORTED 0x00020000
48#define APM_IDLE_SLOWS 0x00040000
49#define APM_BIOS_PM_DISABLED 0x00080000
50#define APM_BIOS_PM_DISENGAGED 0x00100000
51#define APM_MAJOR(f) (((f) >> 8) & 0xff)
52#define APM_MINOR(f) ((f) & 0xff)
53#define APM_VERMASK 0x0000ffff
54#define APM_NOCLI 0x00010000
55#define APM_BEBATT 0x00020000
56
57/* APM error codes */
58#define APM_ERR_CODE(regs) (((regs)->ax & 0xff00) >> 8)
59#define APM_ERR_PM_DISABLED 0x01
60#define APM_ERR_REALALREADY 0x02
61#define APM_ERR_NOTCONN 0x03
62#define APM_ERR_16ALREADY 0x05
63#define APM_ERR_16NOTSUPP 0x06
64#define APM_ERR_32ALREADY 0x07
65#define APM_ERR_32NOTSUPP 0x08
66#define APM_ERR_UNRECOG_DEV 0x09
67#define APM_ERR_ERANGE 0x0A
68#define APM_ERR_NOTENGAGED 0x0B
69#define APM_ERR_EOPNOSUPP 0x0C
70#define APM_ERR_RTIMER_DISABLED 0x0D
71#define APM_ERR_UNABLE 0x60
72#define APM_ERR_NOEVENTS 0x80
73#define APM_ERR_NOT_PRESENT 0x86
74
75#define APM_DEV_APM_BIOS 0x0000
76#define APM_DEV_ALLDEVS 0x0001
77/* device classes are high byte; device IDs go in low byte */
78#define APM_DEV_DISPLAY(x) (0x0100|((x)&0xff))
79#define APM_DEV_DISK(x) (0x0200|((x)&0xff))
80#define APM_DEV_PARALLEL(x) (0x0300|((x)&0xff))
81#define APM_DEV_SERIAL(x) (0x0400|((x)&0xff))
82#define APM_DEV_NETWORK(x) (0x0500|((x)&0xff))
83#define APM_DEV_PCMCIA(x) (0x0600|((x)&0xff))
84#define APM_DEV_BATTERIES(x) (0x8000|((x)&0xff))
85#define APM_DEV_ALLUNITS 0xff
86/* 0x8100-0xDFFF - reserved */
87/* 0xE000-0xEFFF - OEM-defined */
88/* 0xF000-0xFFFF - reserved */
89
90#define APM_INSTCHECK 0x5300 /* int15 only */
91#define APM_16BIT_SUPPORT 0x01
92#define APM_32BIT_SUPPORT 0x02
93#define APM_CPUIDLE_SLOW 0x04
94#define APM_DISABLED 0x08
95#define APM_DISENGAGED 0x10
96
97#define APM_REAL_CONNECT 0x5301 /* int15 only */
98#define APM_PROT16_CONNECT 0x5302 /* int15 only */
99#define APM_PROT32_CONNECT 0x5303 /* int15 only */
100#define APM_DISCONNECT 0x5304 /* %bx = APM_DEV_APM_BIOS */
101
102#define APM_CPU_IDLE 0x5305
103#define APM_CPU_BUSY 0x5306
104
105#define APM_SET_PWR_STATE 0x5307
106#define APM_SYS_READY 0x0000 /* %cx */
107#define APM_SYS_STANDBY 0x0001
108#define APM_SYS_SUSPEND 0x0002
109#define APM_SYS_OFF 0x0003
110#define APM_LASTREQ_INPROG 0x0004
111#define APM_LASTREQ_REJECTED 0x0005
112/* 0x0006 - 0x001f Reserved system states */
113/* 0x0020 - 0x003f OEM-defined system states */
114/* 0x0040 - 0x007f OEM-defined device states */
115/* 0x0080 - 0xffff Reserved device states */
116
117/* system standby is device ID (%bx) 0x0001, APM_SYS_STANDBY */
118/* system suspend is device ID (%bx) 0x0001, APM_SYS_SUSPEND */
119
120#define APM_PWR_MGT_ENABLE 0x5308
121#define APM_MGT_ALL 0xffff /* %bx */
122#define APM_MGT_DISABLE 0x0 /* %cx */
123#define APM_MGT_ENABLE 0x1
124
125#define APM_SYSTEM_DEFAULTS 0x5309
126#define APM_DEFAULTS_ALL 0xffff /* %bx */
127
128#define APM_POWER_STATUS 0x530a
129#define APM_AC_OFF 0x00
130#define APM_AC_ON 0x01
131#define APM_AC_BACKUP 0x02
132#define APM_AC_UNKNOWN 0xff
133#define APM_BATT_HIGH 0x00
134#define APM_BATT_LOW 0x01
135#define APM_BATT_CRITICAL 0x02
136#define APM_BATT_CHARGING 0x03
137#define APM_BATT_UNKNOWN 0xff
138#define APM_BATT_FLAG_HIGH 0x01
139#define APM_BATT_FLAG_LOW 0x02
140#define APM_BATT_FLAG_CRITICAL 0x04
141#define APM_BATT_FLAG_CHARGING 0x08
142#define APM_BATT_FLAG_NOBATTERY 0x10
143#define APM_BATT_FLAG_NOSYSBATT 0x80
144#define APM_BATT_LIFE_UNKNOWN 0xff
145#define BATT_STATE(regp) ((regp)->bx & 0xff)
146#define BATT_FLAGS(regp) (((regp)->cx & 0xff00) >> 8)
147#define AC_STATE(regp) (((regp)->bx & 0xff00) >> 8)
148#define BATT_LIFE(regp) ((regp)->cx & 0xff) /* in % */
149/* Return time in minutes. According to the APM 1.2 spec:
150 DX = Remaining battery life -- time units
151 Bit 15 = 0 Time units are seconds
152 = 1 Time units are minutes
153 Bits 14-0 = Number of seconds or minutes */
154#define BATT_REMAINING(regp) (((regp)->dx & 0x8000) ? \
155 ((regp)->dx & 0x7fff) : \
156 ((regp)->dx & 0x7fff)/60)
157#define BATT_REM_VALID(regp) (((regp)->dx & 0xffff) != 0xffff)
158#define BATT_COUNT(regp) ((regp)->si)
159
160#define APM_GET_PM_EVENT 0x530b
161#define APM_NOEVENT 0x0000
162#define APM_STANDBY_REQ 0x0001 /* %bx on return */
163#define APM_SUSPEND_REQ 0x0002
164#define APM_NORMAL_RESUME 0x0003
165#define APM_CRIT_RESUME 0x0004 /* suspend/resume happened
166 without us */
167#define APM_BATTERY_LOW 0x0005
168#define APM_POWER_CHANGE 0x0006
169#define APM_UPDATE_TIME 0x0007
170#define APM_CRIT_SUSPEND_REQ 0x0008
171#define APM_USER_STANDBY_REQ 0x0009
172#define APM_USER_SUSPEND_REQ 0x000A
173#define APM_SYS_STANDBY_RESUME 0x000B
174#define APM_CAPABILITY_CHANGE 0x000C /* apm v1.2 */
175/* 0x000d - 0x00ff Reserved system events */
176#define APM_USER_HIBERNATE_REQ 0x000D
177/* 0x0100 - 0x01ff Reserved device events */
178/* 0x0200 - 0x02ff OEM-defined APM events */
179/* 0x0300 - 0xffff Reserved */
180#define APM_EVENT_MASK 0xffff
181
182#define APM_EVENT_COMPOSE(t,i) ((((i) & 0x7fff) << 16)|((t) & APM_EVENT_MASK))
183#define APM_EVENT_TYPE(e) ((e) & APM_EVENT_MASK)
184#define APM_EVENT_INDEX(e) ((e) >> 16)
185
186#define APM_GET_POWER_STATE 0x530c
187#define APM_DEVICE_MGMT_ENABLE 0x530d
188
189#define APM_DRIVER_VERSION 0x530e
190/* %bx should be DEV value (APM_DEV_APM_BIOS)
191 %ch = driver major vno
192 %cl = driver minor vno
193 return: %ah = conn major; %al = conn minor
194 */
195#define APM_CONN_MINOR(regp) ((regp)->ax & 0xff)
196#define APM_CONN_MAJOR(regp) (((regp)->ax & 0xff00) >> 8)
197
198#define APM_PWR_MGT_ENGAGE 0x530F
199#define APM_MGT_DISENGAGE 0x0 /* %cx */
200#define APM_MGT_ENGAGE 0x1
201
202/* %bx - APM_DEV_APM_BIOS
203 * %bl - number of batteries
204 * %cx - capabilities
205 */
206#define APM_GET_CAPABILITIES 0x5310
207#define APM_NBATTERIES(regp) ((regp)->bx)
208#define APM_GLOBAL_STANDBY 0x0001
209#define APM_GLOBAL_SUSPEND 0x0002
210#define APM_RTIMER_STANDBY 0x0004 /* resume time wakes up */
211#define APM_RTIMER_SUSPEND 0x0008
212#define APM_IRRING_STANDBY 0x0010 /* internal ring wakes up */
213#define APM_IRRING_SUSPEND 0x0020
214#define APM_PCCARD_STANDBY 0x0040 /* pccard wakes up */
215#define APM_PCCARD_SUSPEND 0x0080
216
217/* %bx - APM_DEV_APM_BIOS
218 * %cl - function
219 * for %cl=2 (set resume timer)
220 * %ch - seconds in BCD
221 * %dh - hours in BCD
222 * %dl - minutes in BCD
223 * %si - month in BCD (high), day in BCD (low)
224 * %di - year in BCD
225 */
226#define APM_RESUME_TIMER 0x5311
227#define APM_RT_DISABLE 0x0
228#define APM_RT_GET 0x1
229#define APM_RT_SET 0x2
230
231/* %bx - APM_DEV_APM_BIOS
232 * %cx - function
233 */
234#define APM_RESUME_ON_RING 0x5312
235#define APM_ROR_DISABLE 0x0
236#define APM_ROR_ENABLE 0x1
237#define APM_ROR_STATUS 0x2
238
239/* %bx - APM_EDV_APM_BIOS
240 * %cx - function
241 */
242#define APM_INACTIVITY_TIMER 0x5313
243#define APM_IT_DISABLE 0x0
244#define APM_IT_ENABLE 0x1
245#define APM_IT_STATUS 0x2
246
247/* %bh - function */
248#define APM_OEM 0x5380
249#define APM_OEM_INSTCHECK 0x7f /* %bx - OEM ID */
250
251/*
252 * LP (Laptop Package)
253 *
254 * Copyright (C) 1994 by HOSOKAWA Tatsumi <hosokawa@mt.cs.keio.ac.jp>
255 *
256 * This software may be used, modified, copied, and distributed, in
257 * both source and binary form provided that the above copyright and
258 * these terms are retained. Under no circumstances is the author
259 * responsible for the proper functioning of this software, nor does
260 * the author assume any responsibility for damages incurred with its
261 * use.
262 *
263 * Sep., 1994 Implemented on FreeBSD 1.1.5.1R (Toshiba AVS001WD)
264 */
265
266#define APM_BATTERY_ABSENT 4
267
268struct apm_power_info {
269 u_char battery_state;
270 u_char ac_state;
271 u_char battery_life;
272 u_char spare1;
273 u_int minutes_left; /* estimate */
274 u_int spare2[6];
275};
276
277struct apm_ctl {
278 u_int dev;
279 u_int mode;
280};
281
282#define APM_IOC_REJECT _IOW('A', 0, struct apm_event_info) /* reject request # */
283#define APM_IOC_STANDBY _IO('A', 1) /* put system into standby */
284#define APM_IOC_SUSPEND _IO('A', 2) /* put system into suspend */
285#define APM_IOC_GETPOWER _IOR('A', 3, struct apm_power_info) /* fetch battery state */
286#define APM_IOC_DEV_CTL _IOW('A', 5, struct apm_ctl) /* put device into mode */
287#define APM_IOC_PRN_CTL _IOW('A', 6, int ) /* driver power status msg */
288#define APM_PRINT_ON 0 /* driver power status displayed */
289#define APM_PRINT_OFF 1 /* driver power status not displayed */
290#define APM_PRINT_PCT 2 /* driver power status only displayed
291 if the percentage changes */
292#define APM_IOC_STANDBY_REQ _IO('A', 7) /* request standby */
293#define APM_IOC_SUSPEND_REQ _IO('A', 8) /* request suspend */
294#define APM_IOC_HIBERNATE _IO('A', 9) /* put system into hibernate */
295
296#ifdef _KERNEL
297extern void apm_cpu_busy(void);
298extern void apm_cpu_idle(void);
299extern void apminit(void);
300int apm_set_powstate(u_int devid, u_int powstate);
301#endif /* _KERNEL */
302
303#endif /* _MACHINE_APMVAR_H_ */