initial commit with v2.6.9
[linux-2.6.9-moxart.git] / include / linux / apm_bios.h
blob290aef326812024ff361164b13605365b1772626
1 #ifndef _LINUX_APM_H
2 #define _LINUX_APM_H
4 /*
5 * Include file for the interface to an APM BIOS
6 * Copyright 1994-2001 Stephen Rothwell (sfr@canb.auug.org.au)
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2, or (at your option) any
11 * later version.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
19 typedef unsigned short apm_event_t;
20 typedef unsigned short apm_eventinfo_t;
22 #ifdef __KERNEL__
24 #define APM_CS (GDT_ENTRY_APMBIOS_BASE * 8)
25 #define APM_CS_16 (APM_CS + 8)
26 #define APM_DS (APM_CS_16 + 8)
28 struct apm_bios_info {
29 unsigned short version;
30 unsigned short cseg;
31 unsigned long offset;
32 unsigned short cseg_16;
33 unsigned short dseg;
34 unsigned short flags;
35 unsigned short cseg_len;
36 unsigned short cseg_16_len;
37 unsigned short dseg_len;
40 /* Results of APM Installation Check */
41 #define APM_16_BIT_SUPPORT 0x0001
42 #define APM_32_BIT_SUPPORT 0x0002
43 #define APM_IDLE_SLOWS_CLOCK 0x0004
44 #define APM_BIOS_DISABLED 0x0008
45 #define APM_BIOS_DISENGAGED 0x0010
48 * Data for APM that is persistent across module unload/load
50 struct apm_info {
51 struct apm_bios_info bios;
52 unsigned short connection_version;
53 int get_power_status_broken;
54 int get_power_status_swabinminutes;
55 int allow_ints;
56 int forbid_idle;
57 int realmode_power_off;
58 int disabled;
62 * The APM function codes
64 #define APM_FUNC_INST_CHECK 0x5300
65 #define APM_FUNC_REAL_CONN 0x5301
66 #define APM_FUNC_16BIT_CONN 0x5302
67 #define APM_FUNC_32BIT_CONN 0x5303
68 #define APM_FUNC_DISCONN 0x5304
69 #define APM_FUNC_IDLE 0x5305
70 #define APM_FUNC_BUSY 0x5306
71 #define APM_FUNC_SET_STATE 0x5307
72 #define APM_FUNC_ENABLE_PM 0x5308
73 #define APM_FUNC_RESTORE_BIOS 0x5309
74 #define APM_FUNC_GET_STATUS 0x530a
75 #define APM_FUNC_GET_EVENT 0x530b
76 #define APM_FUNC_GET_STATE 0x530c
77 #define APM_FUNC_ENABLE_DEV_PM 0x530d
78 #define APM_FUNC_VERSION 0x530e
79 #define APM_FUNC_ENGAGE_PM 0x530f
80 #define APM_FUNC_GET_CAP 0x5310
81 #define APM_FUNC_RESUME_TIMER 0x5311
82 #define APM_FUNC_RESUME_ON_RING 0x5312
83 #define APM_FUNC_TIMER 0x5313
86 * Function code for APM_FUNC_RESUME_TIMER
88 #define APM_FUNC_DISABLE_TIMER 0
89 #define APM_FUNC_GET_TIMER 1
90 #define APM_FUNC_SET_TIMER 2
93 * Function code for APM_FUNC_RESUME_ON_RING
95 #define APM_FUNC_DISABLE_RING 0
96 #define APM_FUNC_ENABLE_RING 1
97 #define APM_FUNC_GET_RING 2
100 * Function code for APM_FUNC_TIMER_STATUS
102 #define APM_FUNC_TIMER_DISABLE 0
103 #define APM_FUNC_TIMER_ENABLE 1
104 #define APM_FUNC_TIMER_GET 2
107 * in arch/i386/kernel/setup.c
109 extern struct apm_info apm_info;
111 #endif /* __KERNEL__ */
114 * Power states
116 #define APM_STATE_READY 0x0000
117 #define APM_STATE_STANDBY 0x0001
118 #define APM_STATE_SUSPEND 0x0002
119 #define APM_STATE_OFF 0x0003
120 #define APM_STATE_BUSY 0x0004
121 #define APM_STATE_REJECT 0x0005
122 #define APM_STATE_OEM_SYS 0x0020
123 #define APM_STATE_OEM_DEV 0x0040
125 #define APM_STATE_DISABLE 0x0000
126 #define APM_STATE_ENABLE 0x0001
128 #define APM_STATE_DISENGAGE 0x0000
129 #define APM_STATE_ENGAGE 0x0001
132 * Events (results of Get PM Event)
134 #define APM_SYS_STANDBY 0x0001
135 #define APM_SYS_SUSPEND 0x0002
136 #define APM_NORMAL_RESUME 0x0003
137 #define APM_CRITICAL_RESUME 0x0004
138 #define APM_LOW_BATTERY 0x0005
139 #define APM_POWER_STATUS_CHANGE 0x0006
140 #define APM_UPDATE_TIME 0x0007
141 #define APM_CRITICAL_SUSPEND 0x0008
142 #define APM_USER_STANDBY 0x0009
143 #define APM_USER_SUSPEND 0x000a
144 #define APM_STANDBY_RESUME 0x000b
145 #define APM_CAPABILITY_CHANGE 0x000c
148 * Error codes
150 #define APM_SUCCESS 0x00
151 #define APM_DISABLED 0x01
152 #define APM_CONNECTED 0x02
153 #define APM_NOT_CONNECTED 0x03
154 #define APM_16_CONNECTED 0x05
155 #define APM_16_UNSUPPORTED 0x06
156 #define APM_32_CONNECTED 0x07
157 #define APM_32_UNSUPPORTED 0x08
158 #define APM_BAD_DEVICE 0x09
159 #define APM_BAD_PARAM 0x0a
160 #define APM_NOT_ENGAGED 0x0b
161 #define APM_BAD_FUNCTION 0x0c
162 #define APM_RESUME_DISABLED 0x0d
163 #define APM_NO_ERROR 0x53
164 #define APM_BAD_STATE 0x60
165 #define APM_NO_EVENTS 0x80
166 #define APM_NOT_PRESENT 0x86
169 * APM Device IDs
171 #define APM_DEVICE_BIOS 0x0000
172 #define APM_DEVICE_ALL 0x0001
173 #define APM_DEVICE_DISPLAY 0x0100
174 #define APM_DEVICE_STORAGE 0x0200
175 #define APM_DEVICE_PARALLEL 0x0300
176 #define APM_DEVICE_SERIAL 0x0400
177 #define APM_DEVICE_NETWORK 0x0500
178 #define APM_DEVICE_PCMCIA 0x0600
179 #define APM_DEVICE_BATTERY 0x8000
180 #define APM_DEVICE_OEM 0xe000
181 #define APM_DEVICE_OLD_ALL 0xffff
182 #define APM_DEVICE_CLASS 0x00ff
183 #define APM_DEVICE_MASK 0xff00
185 #ifdef __KERNEL__
187 * This is the "All Devices" ID communicated to the BIOS
189 #define APM_DEVICE_BALL ((apm_info.connection_version > 0x0100) ? \
190 APM_DEVICE_ALL : APM_DEVICE_OLD_ALL)
191 #endif
194 * Battery status
196 #define APM_MAX_BATTERIES 2
199 * APM defined capability bit flags
201 #define APM_CAP_GLOBAL_STANDBY 0x0001
202 #define APM_CAP_GLOBAL_SUSPEND 0x0002
203 #define APM_CAP_RESUME_STANDBY_TIMER 0x0004 /* Timer resume from standby */
204 #define APM_CAP_RESUME_SUSPEND_TIMER 0x0008 /* Timer resume from suspend */
205 #define APM_CAP_RESUME_STANDBY_RING 0x0010 /* Resume on Ring fr standby */
206 #define APM_CAP_RESUME_SUSPEND_RING 0x0020 /* Resume on Ring fr suspend */
207 #define APM_CAP_RESUME_STANDBY_PCMCIA 0x0040 /* Resume on PCMCIA Ring */
208 #define APM_CAP_RESUME_SUSPEND_PCMCIA 0x0080 /* Resume on PCMCIA Ring */
211 * ioctl operations
213 #include <linux/ioctl.h>
215 #define APM_IOC_STANDBY _IO('A', 1)
216 #define APM_IOC_SUSPEND _IO('A', 2)
218 #endif /* LINUX_APM_H */