apmvar.h revision 1.10 1 /* $NetBSD: apmvar.h,v 1.10 2001/01/12 03:36:50 simonb Exp $ */
2 /*-
3 * Copyright (c) 1995 The NetBSD Foundation, Inc.
4 * All rights reserved.
5 *
6 * This code is derived from software contributed to The NetBSD Foundation
7 * by John Kohl.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed by the NetBSD
20 * Foundation, Inc. and its contributors.
21 * 4. Neither the name of The NetBSD Foundation nor the names of its
22 * contributors may be used to endorse or promote products derived
23 * from this software without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
36 */
37 #ifndef __I386_APM_H__
38 #define __I386_APM_H__
39
40 /* Advanced Power Management (v1.0 and v1.1 specification)
41 * functions/defines/etc.
42 */
43 #define APM_BIOS_FNCODE (0x53)
44 #define APM_SYSTEM_BIOS (0x15)
45 #define APM_BIOS_FN(x) ((APM_BIOS_FNCODE<<8)|(x))
46
47 /*
48 * APM info bits from BIOS
49 */
50 #define APM_16BIT_SUPPORT 0x01
51 #define APM_32BIT_SUPPORT 0x02
52 #define APM_CPUIDLE_SLOW 0x04
53 #define APM_DISABLED 0x08
54 #define APM_DISENGAGED 0x10
55
56 #define APM_ERR_CODE(regs) (((regs)->AX & 0xff00) >> 8)
57 #define APM_ERR_PM_DISABLED 0x01
58 #define APM_ERR_REALALREADY 0x02
59 #define APM_ERR_NOTCONN 0x03
60 #define APM_ERR_16ALREADY 0x05
61 #define APM_ERR_16NOTSUPP 0x06
62 #define APM_ERR_32ALREADY 0x07
63 #define APM_ERR_32NOTSUPP 0x08
64 #define APM_ERR_UNRECOG_DEV 0x09
65 #define APM_ERR_ERANGE 0x0A
66 #define APM_ERR_NOTENGAGED 0x0B
67 #define APM_ERR_EOPNOTSUPP 0x0C
68 #define APM_ERR_RTIMER_DISABLED 0x0D
69 #define APM_ERR_UNABLE 0x60
70 #define APM_ERR_NOEVENTS 0x80
71 #define APM_ERR_NOT_PRESENT 0x86
72
73 #define APM_DEV_APM_BIOS 0x0000
74 #define APM_DEV_ALLDEVS 0x0001
75 /* device classes are high byte; device IDs go in low byte */
76 #define APM_DEV_DISPLAY(x) (0x0100|((x)&0xff))
77 #define APM_DEV_DISK(x) (0x0200|((x)&0xff))
78 #define APM_DEV_PARALLEL(x) (0x0300|((x)&0xff))
79 #define APM_DEV_SERIAL(x) (0x0400|((x)&0xff))
80 #define APM_DEV_NETWORK(x) (0x0500|((x)&0xff))
81 #define APM_DEV_PCMCIA(x) (0x0600|((x)&0xff))
82 #define APM_DEV_BATTERY(x) (0x8000|((x)&0xff)) /* V1.2 */
83 #define APM_DEV_ALLUNITS 0xff
84
85 #define APM_INSTALLATION_CHECK 0x00 /* int15 only */
86 #define APM_INSTALL_SIGNATURE 0x504d /* %bh = 'P', %bl = 'M' */
87 #define APM_REALMODE_CONNECT 0x01 /* int15 only */
88 #define APM_16BIT_CONNECT 0x02 /* int15 only */
89 #define APM_32BIT_CONNECT 0x03 /* int15 only */
90 #define APM_DISCONNECT 0x04 /* %bx = APM_DEV_APM_BIOS */
91 #define APM_CPU_IDLE 0x05
92 #define APM_CPU_BUSY 0x06
93 #define APM_SET_PWR_STATE 0x07
94 #define APM_SYS_READY 0x0000 /* %cx */
95 #define APM_SYS_STANDBY 0x0001
96 #define APM_SYS_SUSPEND 0x0002
97 #define APM_SYS_OFF 0x0003
98 #define APM_LASTREQ_INPROG 0x0004
99 #define APM_LASTREQ_REJECTED 0x0005
100
101 /* system standby is device ID (%bx) 0x0001, APM_SYS_STANDBY */
102 /* system suspend is device ID (%bx) 0x0001, APM_SYS_SUSPEND */
103
104 #define APM_PWR_MGT_ENABLE 0x08
105 #define APM_MGT_ALL 0xffff /* %bx */
106 #define APM_MGT_DISABLE 0x0 /* %cx */
107 #define APM_MGT_ENABLE 0x1
108
109 #define APM_SYSTEM_DEFAULTS 0x09
110 #define APM_DEFAULTS_ALL 0xffff /* %bx */
111 #define APM_DEFAULTS_ALL_V12 0x0001 /* %bx */
112
113 #define APM_POWER_STATUS 0x0a
114 #define APM_AC_OFF 0x00
115 #define APM_AC_ON 0x01
116 #define APM_AC_BACKUP 0x02
117 #define APM_AC_UNKNOWN 0xff
118 /* the first set of battery constants is 1.0 style values;
119 the second set is 1.1 style bit definitions */
120 #define APM_BATT_HIGH 0x00
121 #define APM_BATT_LOW 0x01
122 #define APM_BATT_CRITICAL 0x02
123 #define APM_BATT_CHARGING 0x03
124 #define APM_BATT_ABSENT 0x04 /* Software only--not in spec! */
125 #define APM_BATT_UNKNOWN 0xff
126
127 #define APM_BATT_FLAG_HIGH 0x01
128 #define APM_BATT_FLAG_LOW 0x02
129 #define APM_BATT_FLAG_CRITICAL 0x04
130 #define APM_BATT_FLAG_CHARGING 0x08
131 #define APM_BATT_FLAG_NOBATTERY 0x10
132 #define APM_BATT_FLAG_NO_SYSTEM_BATTERY 0x80
133 #define APM_BATT_FLAG_UNKNOWN 0xff
134
135 #define APM_BATT_LIFE_UNKNOWN 0xff
136 #define APM_BATT_STATE(regp) ((regp)->BX & 0xff)
137 #define APM_BATT_FLAGS(regp) (((regp)->CX & 0xff00) >> 8)
138 #define APM_AC_STATE(regp) (((regp)->BX & 0xff00) >> 8)
139 #define APM_BATT_LIFE(regp) ((regp)->CX & 0xff) /* in % */
140 /* BATT_REMAINING returns minutes remaining */
141 #define APM_BATT_REMAINING(regp) (((regp)->DX & 0x8000) ? \
142 ((regp)->DX & 0x7fff) : \
143 ((regp)->DX & 0x7fff)/60)
144 #define APM_BATT_REM_VALID(regp) (((regp)->DX & 0xffff) != 0xffff)
145 #define APM_BATTERY_COUNT(regp) ((regp)->SI)
146
147 #define APM_GET_PM_EVENT 0x0b
148 #define APM_STANDBY_REQ 0x0001 /* %bx on return */
149 #define APM_SUSPEND_REQ 0x0002
150 #define APM_NORMAL_RESUME 0x0003
151 #define APM_CRIT_RESUME 0x0004 /* suspend/resume happened
152 without us */
153 /* If set, the pccard sockets were powered off in the
154 suspend/standby state (V1.2 only) */
155 #define APM_PCCARD_POWEREDOFF(regp) ((regp)->CX & 0x0001)
156
157 #define APM_BATTERY_LOW 0x0005
158 #define APM_POWER_CHANGE 0x0006
159 #define APM_UPDATE_TIME 0x0007
160 #define APM_CRIT_SUSPEND_REQ 0x0008
161 #define APM_USER_STANDBY_REQ 0x0009
162 #define APM_USER_SUSPEND_REQ 0x000A
163 #define APM_SYS_STANDBY_RESUME 0x000B
164 #define APM_CAP_CHANGE 0x000C /* V1.2 */
165
166 #define APM_GET_POWER_STATE 0x0c
167 /* device to query in %bx */
168 /* returns power states in %cx */
169 #define APM_DEVICE_MGMT_ENABLE 0x0d
170 /* device to enable/disable in %bx */
171
172 #define APM_DRIVER_VERSION 0x0e
173 /* %bx should be DEV value (APM_DEV_APM_BIOS)
174 %ch = driver major vno
175 %cl = driver minor vno
176 return: %ah = conn major; %al = conn minor
177 */
178 #define APM_CONN_MINOR(regp) ((regp)->AX & 0xff)
179 #define APM_CONN_MAJOR(regp) (((regp)->AX & 0xff00) >> 8)
180
181 #define APM_PWR_MGT_ENGAGE 0x0F
182 /* device in %bx */
183 #define APM_MGT_DISENGAGE 0x0 /* %cx */
184 #define APM_MGT_ENGAGE 0x1
185
186 #define APM_GET_CAPABILITIES 0x10
187 /* device in %bx (APM_DEV_APM_BIOS) */
188 /* %bl: number of batteries */
189 #define APM_NBATTERIES(regp) ((regp)->BX & 0xff)
190 /* %cx capabilities */
191 #define APM_GLOBAL_STANDBY 0x0001
192 #define APM_GLOBAL_SUSPEND 0x0002
193 #define APM_RTIMER_STANDBY 0x0004 /* resume timer wakes standby */
194 #define APM_RTIMER_SUSPEND 0x0008 /* resume timer wakes suspend */
195 #define APM_IRRING_SUSPEND 0x0010 /* internal ring wakes suspend */
196 #define APM_IRRING_STANDBY 0x0020 /* internal ring wakes standby */
197 #define APM_PCRING_SUSPEND 0x0040 /* pccard ring wakes suspend */
198 #define APM_PCRING_STANDBY 0x0080 /* pccard ring wakes standby */
199
200 #define APM_RESUME_TIMER_CTL 0x11 /* get/set/disable resume timer */
201 /* device in %bx (APM_DEV_APM_BIOS) */
202 /* function code in %cl */
203 #define APM_RTIMER_DISABLE 0x00
204 #define APM_RTIMER_GET 0x01
205 #define APM_RTIMER_SET 0x02
206 /* if %cl = set, or %cl = get, then: */
207 /* %ch: seconds */
208 /* %dh: hours */
209 /* %dl: minutes */
210 /* %sih: month (bcd), %sil: day (bcd) */
211 /* %di: year (bcd, 4 digits) */
212 #define APM_RESUME_RING_CTL 0x12
213 /* device in %bx (APM_DEV_APM_BIOS) */
214 /* %cx: function code */
215 #define APM_RRING_DISABLE 0x0000
216 #define APM_RRING_ENABLE 0x0001
217 #define APM_RRING_GET 0x0002
218 /* returns state in %cx */
219 #define APM_RRING_DISABLED 0x0000
220 #define APM_RRING_ENABLED 0x0001
221
222 #define APM_TIMER_REQS_CTL 0x13
223 /* device in %bx (APM_DEV_APM_BIOS) */
224 /* %cx: function code */
225 #define APM_TIMER_REQS_DISABLE 0x0000
226 #define APM_TIMER_REQS_ENABLE 0x0001
227 #define APM_TIMER_REQS_GET 0x0002
228 /* returns state in %cx */
229 #define APM_TIMER_REQS_DISABLED 0x0000
230 #define APM_TIEMR_REQS_ENABLED 0x0001
231
232 #define APM_OEM 0x80
233
234 /*
235 * APM info word from the real-mode handler is adjusted to put
236 * major/minor version in low half and support bits in upper half.
237 */
238 #define APM_MAJOR_VERS(info) (((info)&0xff00)>>8)
239 #define APM_MINOR_VERS(info) ((info)&0xff)
240
241 #define APM_16BIT_SUPPORTED (APM_16BIT_SUPPORT << 16)
242 #define APM_32BIT_SUPPORTED (APM_32BIT_SUPPORT << 16)
243 #define APM_IDLE_SLOWS (APM_CPUIDLE_SLOW << 16)
244 #define APM_BIOS_PM_DISABLED (APM_DISABLED << 16)
245 #define APM_BIOS_PM_DISENGAGED (APM_DISENGAGED << 16)
246
247 /*
248 * virtual & physical address of the trampoline
249 * that we use: page 1.
250 */
251 #define APM_BIOSTRAMP NBPG
252
253
254 #ifndef _LOCORE
255
256 /* filled in by apmcall */
257
258 struct apm_connect_info {
259 u_int apm_code32_seg_base; /* real-mode style segment selector */
260 u_int apm_code16_seg_base;
261 u_int apm_data_seg_base;
262 u_int apm_entrypt;
263 u_short apm_segsel; /* segment selector for APM */
264 u_short _pad1;
265 u_int apm_code32_seg_len;
266 u_int apm_code16_seg_len;
267 u_int apm_data_seg_len;
268 u_int apm_detail;
269 };
270
271 struct apm_event_info {
272 u_int type;
273 u_int index;
274 u_int spare[8];
275 };
276
277 struct apm_power_info {
278 u_char battery_state;
279 u_char ac_state;
280 u_char battery_life;
281 u_char spare1;
282 u_int minutes_left; /* estimate */
283 u_int spare2[6];
284 };
285
286 struct apm_ctl {
287 u_int dev;
288 u_int mode;
289 };
290
291 #define APM_IOC_REJECT _IOW('A', 0, struct apm_event_info) /* reject request # */
292 #define APM_IOC_STANDBY _IO('A', 1) /* put system into standby */
293 #define APM_IOC_SUSPEND _IO('A', 2) /* put system into suspend */
294 #define APM_IOC_GETPOWER _IOR('A', 3, struct apm_power_info) /* fetch battery state */
295 #define APM_IOC_NEXTEVENT _IOR('A', 4, struct apm_event_info) /* fetch event */
296 #define APM_IOC_DEV_CTL _IOW('A', 5, struct apm_ctl) /* put device into mode */
297
298 struct apm_attach_args {
299 char *aaa_busname;
300 };
301
302 #ifdef _KERNEL
303 extern struct apm_connect_info apminfo; /* in locore */
304 extern int apmpresent;
305 extern int apmcall __P((int function, struct bioscallregs *regs));
306 extern void bioscall __P((int function, struct bioscallregs *regs));
307 extern void apm_cpu_busy __P((void));
308 extern void apm_cpu_idle __P((void));
309 extern void apminit __P((void));
310 int apm_set_powstate __P((u_int devid, u_int powstate));
311 extern int apm_busprobe __P((void));
312 #endif /* _KERNEL */
313 #endif /* _LOCORE */
314 #endif /* __i386_apm_h__ */
315