apmvar.h revision 1.1 1 /* $NetBSD: apmvar.h,v 1.1 2000/07/02 09:48:12 takemura 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 /*
38 * from: sys/arch/i386/include/apmvar.h,v 1.9 1999/08/17
39 */
40 #ifndef __I386_APM_H__
41 #define __I386_APM_H__
42
43 /* Advanced Power Management (v1.0 and v1.1 specification)
44 * functions/defines/etc.
45 */
46 #define APM_BIOS_FNCODE (0x53)
47 #define APM_SYSTEM_BIOS (0x15)
48 #define APM_BIOS_FN(x) ((APM_BIOS_FNCODE<<8)|(x))
49
50 /*
51 * APM info bits from BIOS
52 */
53 #define APM_16BIT_SUPPORT 0x01
54 #define APM_32BIT_SUPPORT 0x02
55 #define APM_CPUIDLE_SLOW 0x04
56 #define APM_DISABLED 0x08
57 #define APM_DISENGAGED 0x10
58
59 #define APM_ERR_CODE(regs) (((regs)->AX & 0xff00) >> 8)
60 #define APM_ERR_PM_DISABLED 0x01
61 #define APM_ERR_REALALREADY 0x02
62 #define APM_ERR_NOTCONN 0x03
63 #define APM_ERR_16ALREADY 0x05
64 #define APM_ERR_16NOTSUPP 0x06
65 #define APM_ERR_32ALREADY 0x07
66 #define APM_ERR_32NOTSUPP 0x08
67 #define APM_ERR_UNRECOG_DEV 0x09
68 #define APM_ERR_ERANGE 0x0A
69 #define APM_ERR_NOTENGAGED 0x0B
70 #define APM_ERR_EOPNOTSUPP 0x0C
71 #define APM_ERR_RTIMER_DISABLED 0x0D
72 #define APM_ERR_UNABLE 0x60
73 #define APM_ERR_NOEVENTS 0x80
74 #define APM_ERR_NOT_PRESENT 0x86
75
76 #define APM_DEV_APM_BIOS 0x0000
77 #define APM_DEV_ALLDEVS 0x0001
78 /* device classes are high byte; device IDs go in low byte */
79 #define APM_DEV_DISPLAY(x) (0x0100|((x)&0xff))
80 #define APM_DEV_DISK(x) (0x0200|((x)&0xff))
81 #define APM_DEV_PARALLEL(x) (0x0300|((x)&0xff))
82 #define APM_DEV_SERIAL(x) (0x0400|((x)&0xff))
83 #define APM_DEV_NETWORK(x) (0x0500|((x)&0xff))
84 #define APM_DEV_PCMCIA(x) (0x0600|((x)&0xff))
85 #define APM_DEV_BATTERY(x) (0x8000|((x)&0xff)) /* V1.2 */
86 #define APM_DEV_ALLUNITS 0xff
87
88 #define APM_INSTALLATION_CHECK 0x00 /* int15 only */
89 #define APM_INSTALL_SIGNATURE 0x504d /* %bh = 'P', %bl = 'M' */
90 #define APM_REALMODE_CONNECT 0x01 /* int15 only */
91 #define APM_16BIT_CONNECT 0x02 /* int15 only */
92 #define APM_32BIT_CONNECT 0x03 /* int15 only */
93 #define APM_DISCONNECT 0x04 /* %bx = APM_DEV_APM_BIOS */
94 #define APM_CPU_IDLE 0x05
95 #define APM_CPU_BUSY 0x06
96 #define APM_SET_PWR_STATE 0x07
97 #define APM_SYS_READY 0x0000 /* %cx */
98 #define APM_SYS_STANDBY 0x0001
99 #define APM_SYS_SUSPEND 0x0002
100 #define APM_SYS_OFF 0x0003
101 #define APM_LASTREQ_INPROG 0x0004
102 #define APM_LASTREQ_REJECTED 0x0005
103
104 /* system standby is device ID (%bx) 0x0001, APM_SYS_STANDBY */
105 /* system suspend is device ID (%bx) 0x0001, APM_SYS_SUSPEND */
106
107 #define APM_PWR_MGT_ENABLE 0x08
108 #define APM_MGT_ALL 0xffff /* %bx */
109 #define APM_MGT_DISABLE 0x0 /* %cx */
110 #define APM_MGT_ENABLE 0x1
111
112 #define APM_SYSTEM_DEFAULTS 0x09
113 #define APM_DEFAULTS_ALL 0xffff /* %bx */
114 #define APM_DEFAULTS_ALL_V12 0x0001 /* %bx */
115
116 #define APM_POWER_STATUS 0x0a
117 #define APM_AC_OFF 0x00
118 #define APM_AC_ON 0x01
119 #define APM_AC_BACKUP 0x02
120 #define APM_AC_UNKNOWN 0xff
121 /* the first set of battery constants is 1.0 style values;
122 the second set is 1.1 style bit definitions */
123 #define APM_BATT_HIGH 0x00
124 #define APM_BATT_LOW 0x01
125 #define APM_BATT_CRITICAL 0x02
126 #define APM_BATT_CHARGING 0x03
127 #define APM_BATT_ABSENT 0x04 /* Software only--not in spec! */
128 #define APM_BATT_UNKNOWN 0xff
129
130 #define APM_BATT_FLAG_HIGH 0x01
131 #define APM_BATT_FLAG_LOW 0x02
132 #define APM_BATT_FLAG_CRITICAL 0x04
133 #define APM_BATT_FLAG_CHARGING 0x08
134 #define APM_BATT_FLAG_NOBATTERY 0x10
135 #define APM_BATT_FLAG_NO_SYSTEM_BATTERY 0x80
136 #define APM_BATT_FLAG_UNKNOWN 0xff
137
138 #define APM_BATT_LIFE_UNKNOWN 0xff
139 #define APM_BATT_STATE(regp) ((regp)->BX & 0xff)
140 #define APM_BATT_FLAGS(regp) (((regp)->CX & 0xff00) >> 8)
141 #define APM_AC_STATE(regp) (((regp)->BX & 0xff00) >> 8)
142 #define APM_BATT_LIFE(regp) ((regp)->CX & 0xff) /* in % */
143 /* BATT_REMAINING returns minutes remaining */
144 #define APM_BATT_REMAINING(regp) (((regp)->DX & 0x8000) ? \
145 ((regp)->DX & 0x7fff) : \
146 ((regp)->DX & 0x7fff)/60)
147 #define APM_BATT_REM_VALID(regp) (((regp)->DX & 0xffff) != 0xffff)
148 #define APM_BATTERY_COUNT(regp) ((regp)->SI)
149
150 #define APM_GET_PM_EVENT 0x0b
151 #define APM_STANDBY_REQ 0x0001 /* %bx on return */
152 #define APM_SUSPEND_REQ 0x0002
153 #define APM_NORMAL_RESUME 0x0003
154 #define APM_CRIT_RESUME 0x0004 /* suspend/resume happened
155 without us */
156 /* If set, the pccard sockets were powered off in the
157 suspend/standby state (V1.2 only) */
158 #define APM_PCCARD_POWEREDOFF(regp) ((regp)->CX & 0x0001)
159
160 #define APM_BATTERY_LOW 0x0005
161 #define APM_POWER_CHANGE 0x0006
162 #define APM_UPDATE_TIME 0x0007
163 #define APM_CRIT_SUSPEND_REQ 0x0008
164 #define APM_USER_STANDBY_REQ 0x0009
165 #define APM_USER_SUSPEND_REQ 0x000A
166 #define APM_SYS_STANDBY_RESUME 0x000B
167 #define APM_CAP_CHANGE 0x000C /* V1.2 */
168
169 #define APM_GET_POWER_STATE 0x0c
170 /* device to query in %bx */
171 /* returns power states in %cx */
172 #define APM_DEVICE_MGMT_ENABLE 0x0d
173 /* device to enable/disable in %bx */
174
175 #define APM_DRIVER_VERSION 0x0e
176 /* %bx should be DEV value (APM_DEV_APM_BIOS)
177 %ch = driver major vno
178 %cl = driver minor vno
179 return: %ah = conn major; %al = conn minor
180 */
181 #define APM_CONN_MINOR(regp) ((regp)->AX & 0xff)
182 #define APM_CONN_MAJOR(regp) (((regp)->AX & 0xff00) >> 8)
183
184 #define APM_PWR_MGT_ENGAGE 0x0F
185 /* device in %bx */
186 #define APM_MGT_DISENGAGE 0x0 /* %cx */
187 #define APM_MGT_ENGAGE 0x1
188
189 #define APM_GET_CAPABILITIES 0x10
190 /* device in %bx (APM_DEV_APM_BIOS) */
191 /* %bl: number of batteries */
192 #define APM_NBATTERIES(regp) ((regp)->BX & 0xff)
193 /* %cx capabilities */
194 #define APM_GLOBAL_STANDBY 0x0001
195 #define APM_GLOBAL_SUSPEND 0x0002
196 #define APM_RTIMER_STANDBY 0x0004 /* resume timer wakes standby */
197 #define APM_RTIMER_SUSPEND 0x0008 /* resume timer wakes suspend */
198 #define APM_IRRING_SUSPEND 0x0010 /* internal ring wakes suspend */
199 #define APM_IRRING_STANDBY 0x0020 /* internal ring wakes standby */
200 #define APM_PCRING_SUSPEND 0x0040 /* pccard ring wakes suspend */
201 #define APM_PCRING_STANDBY 0x0080 /* pccard ring wakes standby */
202
203 #define APM_RESUME_TIMER_CTL 0x11 /* get/set/disable resume timer */
204 /* device in %bx (APM_DEV_APM_BIOS) */
205 /* function code in %cl */
206 #define APM_RTIMER_DISABLE 0x00
207 #define APM_RTIMER_GET 0x01
208 #define APM_RTIMER_SET 0x02
209 /* if %cl = set, or %cl = get, then: */
210 /* %ch: seconds */
211 /* %dh: hours */
212 /* %dl: minutes */
213 /* %sih: month (bcd), %sil: day (bcd) */
214 /* %di: year (bcd, 4 digits) */
215 #define APM_RESUME_RING_CTL 0x12
216 /* device in %bx (APM_DEV_APM_BIOS) */
217 /* %cx: function code */
218 #define APM_RRING_DISABLE 0x0000
219 #define APM_RRING_ENABLE 0x0001
220 #define APM_RRING_GET 0x0002
221 /* returns state in %cx */
222 #define APM_RRING_DISABLED 0x0000
223 #define APM_RRING_ENABLED 0x0001
224
225 #define APM_TIMER_REQS_CTL 0x13
226 /* device in %bx (APM_DEV_APM_BIOS) */
227 /* %cx: function code */
228 #define APM_TIMER_REQS_DISABLE 0x0000
229 #define APM_TIMER_REQS_ENABLE 0x0001
230 #define APM_TIMER_REQS_GET 0x0002
231 /* returns state in %cx */
232 #define APM_TIMER_REQS_DISABLED 0x0000
233 #define APM_TIEMR_REQS_ENABLED 0x0001
234
235 #define APM_OEM 0x80
236
237 /*
238 * APM info word from the real-mode handler is adjusted to put
239 * major/minor version in low half and support bits in upper half.
240 */
241 #define APM_MAJOR_VERS(info) (((info)&0xff00)>>8)
242 #define APM_MINOR_VERS(info) ((info)&0xff)
243
244 #define APM_16BIT_SUPPORTED (APM_16BIT_SUPPORT << 16)
245 #define APM_32BIT_SUPPORTED (APM_32BIT_SUPPORT << 16)
246 #define APM_IDLE_SLOWS (APM_CPUIDLE_SLOW << 16)
247 #define APM_BIOS_PM_DISABLED (APM_DISABLED << 16)
248 #define APM_BIOS_PM_DISENGAGED (APM_DISENGAGED << 16)
249
250 /*
251 * virtual & physical address of the trampoline
252 * that we use: page 1.
253 */
254 #define APM_BIOSTRAMP NBPG
255
256
257 #ifndef _LOCORE
258
259 /* filled in by apmcall */
260
261 struct apm_connect_info {
262 u_int apm_code32_seg_base; /* real-mode style segment selector */
263 u_int apm_code16_seg_base;
264 u_int apm_data_seg_base;
265 u_int apm_entrypt;
266 u_short apm_segsel; /* segment selector for APM */
267 u_short _pad1;
268 u_int apm_code32_seg_len;
269 u_int apm_code16_seg_len;
270 u_int apm_data_seg_len;
271 u_int apm_detail;
272 };
273
274 struct apm_event_info {
275 u_int type;
276 u_int index;
277 u_int spare[8];
278 };
279
280 struct apm_power_info {
281 u_char battery_state;
282 u_char ac_state;
283 u_char battery_life;
284 u_char spare1;
285 u_int minutes_left; /* estimate */
286 u_int spare2[6];
287 };
288
289 struct apm_ctl {
290 u_int dev;
291 u_int mode;
292 };
293
294 #define APM_IOC_REJECT _IOW('A', 0, struct apm_event_info) /* reject request # */
295 #define APM_IOC_STANDBY _IO('A', 1) /* put system into standby */
296 #define APM_IOC_SUSPEND _IO('A', 2) /* put system into suspend */
297 #define APM_IOC_GETPOWER _IOR('A', 3, struct apm_power_info) /* fetch battery state */
298 #define APM_IOC_NEXTEVENT _IOR('A', 4, struct apm_event_info) /* fetch event */
299 #if 0
300 #define APM_IOC_DEV_CTL _IOW('A', 5, struct apm_ctl) /* put device into mode */
301 #endif
302
303 #ifdef _KERNEL
304 struct apm_attach_args {
305 char *aaa_busname;
306 };
307
308 struct bioscallregs;
309
310 extern struct apm_connect_info apminfo; /* in locore */
311 extern int apmpresent;
312 extern int apmcall __P((int function, struct bioscallregs *regs));
313 extern void bioscall __P((int function, struct bioscallregs *regs));
314 extern void apm_cpu_busy __P((void));
315 extern void apm_cpu_idle __P((void));
316 extern void apminit __P((void));
317 int apm_set_powstate __P((u_int devid, u_int powstate));
318 extern int apm_busprobe __P((void));
319 extern int apmprint __P((void *, const char *));
320
321 struct apm_accessops {
322 void (*disconnect) __P((void *));
323 void (*enable) __P((void *, int));
324 int (*set_powstate) __P((void *, u_int, u_int));
325 int (*get_powstat) __P((void *, struct apm_power_info *));
326 int (*get_event) __P((void *, u_int *, u_int *));
327 void (*cpu_busy) __P((void *));
328 void (*cpu_idle) __P((void *));
329 void (*get_capabilities) __P((void *, u_int *, u_int *));
330 };
331
332 struct apmdev_attach_args {
333 struct apm_accessops *accessops;
334 void *accesscookie;
335 u_int apm_detail;
336 };
337 #endif /* _KERNEL */
338 #endif /* _LOCORE */
339 #endif /* __i386_apm_h__ */
340