apmvar.h revision 1.5 1 /* $NetBSD: apmvar.h,v 1.5 1996/11/22 00:19:09 jtk Exp $ */
2 /*
3 * Copyright (c) 1995 John T. Kohl
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 * 3. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
21 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
28 *
29 */
30 #ifndef __I386_APM_H__
31 #define __I386_APM_H__
32
33 /* Advanced Power Management (v1.0 and v1.1 specification)
34 * functions/defines/etc.
35 */
36 #define APM_BIOS_FNCODE (0x53)
37 #define APM_SYSTEM_BIOS (0x15)
38 #define APM_BIOS_FN(x) ((APM_BIOS_FNCODE<<8)|(x))
39
40 /*
41 * APM info bits from BIOS
42 */
43 #define APM_16BIT_SUPPORT 0x01
44 #define APM_32BIT_SUPPORT 0x02
45 #define APM_CPUIDLE_SLOW 0x04
46 #define APM_DISABLED 0x08
47 #define APM_DISENGAGED 0x10
48
49 #define APM_ERR_CODE(regs) (((regs)->ax & 0xff00) >> 8)
50 #define APM_ERR_PM_DISABLED 0x01
51 #define APM_ERR_REALALREADY 0x02
52 #define APM_ERR_NOTCONN 0x03
53 #define APM_ERR_16ALREADY 0x05
54 #define APM_ERR_16NOTSUPP 0x06
55 #define APM_ERR_32ALREADY 0x07
56 #define APM_ERR_32NOTSUPP 0x08
57 #define APM_ERR_UNRECOG_DEV 0x09
58 #define APM_ERR_ERANGE 0x0A
59 #define APM_ERR_NOTENGAGED 0x0B
60 #define APM_ERR_UNABLE 0x60
61 #define APM_ERR_NOEVENTS 0x80
62 #define APM_ERR_NOT_PRESENT 0x86
63
64 #define APM_DEV_APM_BIOS 0x0000
65 #define APM_DEV_ALLDEVS 0x0001
66 /* device classes are high byte; device IDs go in low byte */
67 #define APM_DEV_DISPLAY(x) (0x0100|((x)&0xff))
68 #define APM_DEV_DISK(x) (0x0200|((x)&0xff))
69 #define APM_DEV_PARALLEL(x) (0x0300|((x)&0xff))
70 #define APM_DEV_SERIAL(x) (0x0400|((x)&0xff))
71 #define APM_DEV_NETWORK(x) (0x0500|((x)&0xff))
72 #define APM_DEV_PCMCIA(x) (0x0600|((x)&0xff))
73 #define APM_DEV_ALLUNITS 0xff
74
75 #define APM_INSTALLATION_CHECK 0x00 /* int15 only */
76 #define APM_INSTALL_SIGNATURE 0x504d /* %bh = 'P', %bl = 'M' */
77 #define APM_REALMODE_CONNECT 0x01 /* int15 only */
78 #define APM_16BIT_CONNECT 0x02 /* int15 only */
79 #define APM_32BIT_CONNECT 0x03 /* int15 only */
80 #define APM_DISCONNECT 0x04 /* %bx = APM_DEV_APM_BIOS */
81 #define APM_CPU_IDLE 0x05
82 #define APM_CPU_BUSY 0x06
83 #define APM_SET_PWR_STATE 0x07
84 #define APM_SYS_READY 0x0000 /* %cx */
85 #define APM_SYS_STANDBY 0x0001
86 #define APM_SYS_SUSPEND 0x0002
87 #define APM_SYS_OFF 0x0003
88 #define APM_LASTREQ_INPROG 0x0004
89 #define APM_LASTREQ_REJECTED 0x0005
90
91 /* system standby is device ID (%bx) 0x0001, APM_SYS_STANDBY */
92 /* system suspend is device ID (%bx) 0x0001, APM_SYS_SUSPEND */
93
94 #define APM_PWR_MGT_ENABLE 0x08
95 #define APM_MGT_ALL 0xffff /* %bx */
96 #define APM_MGT_DISABLE 0x0 /* %cx */
97 #define APM_MGT_ENABLE 0x1
98
99 #define APM_SYSTEM_DEFAULTS 0x09
100 #define APM_DEFAULTS_ALL 0xffff /* %bx */
101
102 #define APM_POWER_STATUS 0x0a
103 #define APM_AC_OFF 0x00
104 #define APM_AC_ON 0x01
105 #define APM_AC_BACKUP 0x02
106 #define APM_AC_UNKNOWN 0xff
107 /* the first set of battery constants is 1.0 style values;
108 the second set is 1.1 style bit definitions */
109 #define APM_BATT_HIGH 0x00
110 #define APM_BATT_LOW 0x01
111 #define APM_BATT_CRITICAL 0x02
112 #define APM_BATT_CHARGING 0x03
113 #define APM_BATT_ABSENT 0x04 /* Software only--not in spec! */
114 #define APM_BATT_UNKNOWN 0xff
115
116 #define APM_BATT_FLAG_HIGH 0x01
117 #define APM_BATT_FLAG_LOW 0x02
118 #define APM_BATT_FLAG_CRITICAL 0x04
119 #define APM_BATT_FLAG_CHARGING 0x08
120 #define APM_BATT_FLAG_NOBATTERY 0x80
121
122 #define APM_BATT_LIFE_UNKNOWN 0xff
123 #define APM_BATT_STATE(regp) ((regp)->bx & 0xff)
124 #define APM_BATT_FLAGS(regp) (((regp)->cx & 0xff00) >> 8)
125 #define APM_AC_STATE(regp) (((regp)->bx & 0xff00) >> 8)
126 #define APM_BATT_LIFE(regp) ((regp)->cx & 0xff) /* in % */
127 /* BATT_REMAINING returns minutes remaining */
128 #define APM_BATT_REMAINING(regp) (((regp)->dx & 0x8000) ? \
129 ((regp)->dx & 0x7fff) : \
130 ((regp)->dx & 0x7fff)/60)
131 #define APM_BATT_REM_VALID(regp) (((regp)->dx & 0xffff) != 0xffff)
132 #define APM_GET_PM_EVENT 0x0b
133 #define APM_STANDBY_REQ 0x0001 /* %bx on return */
134 #define APM_SUSPEND_REQ 0x0002
135 #define APM_NORMAL_RESUME 0x0003
136 #define APM_CRIT_RESUME 0x0004 /* suspend/resume happened
137 without us */
138 #define APM_BATTERY_LOW 0x0005
139 #define APM_POWER_CHANGE 0x0006
140 #define APM_UPDATE_TIME 0x0007
141 #define APM_CRIT_SUSPEND_REQ 0x0008
142 #define APM_USER_STANDBY_REQ 0x0009
143 #define APM_USER_SUSPEND_REQ 0x000A
144 #define APM_SYS_STANDBY_RESUME 0x000B
145
146 #define APM_GET_POWER_STATE 0x0c
147 #define APM_DEVICE_MGMT_ENABLE 0x0d
148
149 #define APM_DRIVER_VERSION 0x0e
150 /* %bx should be DEV value (APM_DEV_APM_BIOS)
151 %ch = driver major vno
152 %cl = driver minor vno
153 return: %ah = conn major; %al = conn minor
154 */
155 #define APM_CONN_MINOR(regp) ((regp)->ax & 0xff)
156 #define APM_CONN_MAJOR(regp) (((regp)->ax & 0xff00) >> 8)
157
158 #define APM_PWR_MGT_ENGAGE 0x0F
159 #define APM_MGT_DISENGAGE 0x0 /* %cx */
160 #define APM_MGT_ENGAGE 0x1
161
162 #define APM_OEM 0x80
163
164 /*
165 * APM info word from the real-mode handler is adjusted to put
166 * major/minor version in low half and support bits in upper half.
167 */
168 #define APM_MAJOR_VERS(info) (((info)&0xff00)>>8)
169 #define APM_MINOR_VERS(info) ((info)&0xff)
170
171 #define APM_16BIT_SUPPORTED (APM_16BIT_SUPPORT << 16)
172 #define APM_32BIT_SUPPORTED (APM_32BIT_SUPPORT << 16)
173 #define APM_IDLE_SLOWS (APM_CPUIDLE_SLOW << 16)
174 #define APM_BIOS_PM_DISABLED (APM_DISABLED << 16)
175 #define APM_BIOS_PM_DISENGAGED (APM_DISENGAGED << 16)
176
177 /*
178 * virtual & physical address of the trampoline
179 * that we use: page 1.
180 */
181 #define APM_BIOSTRAMP NBPG
182
183
184 #ifndef _LOCORE
185
186 /* filled in by apmcall */
187 struct apmregs {
188 u_short ax;
189 u_short bx;
190 u_short cx;
191 u_short dx;
192 u_short si;
193 u_short di;
194 u_short flags;
195 };
196
197 struct apm_connect_info {
198 u_int apm_code32_seg_base; /* real-mode style segment selector */
199 u_int apm_code16_seg_base;
200 u_int apm_data_seg_base;
201 u_int apm_entrypt;
202 u_short apm_segsel; /* segment selector for APM */
203 u_short _pad1;
204 u_int apm_code32_seg_len;
205 u_int apm_data_seg_len;
206 u_int apm_detail;
207 };
208
209 struct apm_event_info {
210 u_int type;
211 u_int index;
212 u_int spare[8];
213 };
214
215 struct apm_power_info {
216 u_char battery_state;
217 u_char ac_state;
218 u_char battery_life;
219 u_char spare1;
220 u_int minutes_left; /* estimate */
221 u_int spare2[6];
222 };
223
224 struct apm_ctl {
225 u_int dev;
226 u_int mode;
227 };
228
229 #define APM_IOC_REJECT _IOW('A', 0, struct apm_event_info) /* reject request # */
230 #define APM_IOC_STANDBY _IO('A', 1) /* put system into standby */
231 #define APM_IOC_SUSPEND _IO('A', 2) /* put system into suspend */
232 #define APM_IOC_GETPOWER _IOR('A', 3, struct apm_power_info) /* fetch battery state */
233 #define APM_IOC_NEXTEVENT _IOR('A', 4, struct apm_event_info) /* fetch event */
234 #define APM_IOC_DEV_CTL _IOW('A', 5, struct apm_ctl) /* put device into mode */
235
236 struct apm_attach_args {
237 char *aaa_busname;
238 };
239
240 #ifdef _KERNEL
241 extern struct apm_connect_info apminfo; /* in locore */
242 extern int apmpresent;
243 extern int apmcall __P((int function, struct apmregs *regs));
244 extern void bioscall __P((int function, struct apmregs *regs));
245 extern void apm_cpu_busy __P((void));
246 extern void apm_cpu_idle __P((void));
247 extern void apminit __P((void));
248 int apm_set_powstate __P((u_int devid, u_int powstate));
249 extern int apm_busprobe __P((void));
250 #endif /* _KERNEL */
251 #endif /* _LOCORE */
252 #endif /* __i386_apm_h__ */
253