xref: /openbmc/u-boot/include/linux/apm_bios.h (revision ae51b570)
1 #ifndef _LINUX_APM_H
2 #define _LINUX_APM_H
3 
4 /*
5  * Include file for the interface to an APM BIOS
6  * Copyright 1994-2001 Stephen Rothwell (sfr@canb.auug.org.au)
7  *
8   * SPDX-License-Identifier:	GPL-2.0+
9  */
10 
11 #include <linux/types.h>
12 
13 typedef unsigned short	apm_event_t;
14 typedef unsigned short	apm_eventinfo_t;
15 
16 struct apm_bios_info {
17 	__u16	version;
18 	__u16	cseg;
19 	__u32	offset;
20 	__u16	cseg_16;
21 	__u16	dseg;
22 	__u16	flags;
23 	__u16	cseg_len;
24 	__u16	cseg_16_len;
25 	__u16	dseg_len;
26 };
27 
28 #ifdef __KERNEL__
29 
30 #define APM_CS		(GDT_ENTRY_APMBIOS_BASE * 8)
31 #define APM_CS_16	(APM_CS + 8)
32 #define APM_DS		(APM_CS_16 + 8)
33 
34 /* Results of APM Installation Check */
35 #define APM_16_BIT_SUPPORT	0x0001
36 #define APM_32_BIT_SUPPORT	0x0002
37 #define APM_IDLE_SLOWS_CLOCK	0x0004
38 #define APM_BIOS_DISABLED      	0x0008
39 #define APM_BIOS_DISENGAGED     0x0010
40 
41 /*
42  * Data for APM that is persistent across module unload/load
43  */
44 struct apm_info {
45 	struct apm_bios_info	bios;
46 	unsigned short		connection_version;
47 	int			get_power_status_broken;
48 	int			get_power_status_swabinminutes;
49 	int			allow_ints;
50 	int			forbid_idle;
51 	int			realmode_power_off;
52 	int			disabled;
53 };
54 
55 /*
56  * The APM function codes
57  */
58 #define	APM_FUNC_INST_CHECK	0x5300
59 #define	APM_FUNC_REAL_CONN	0x5301
60 #define	APM_FUNC_16BIT_CONN	0x5302
61 #define	APM_FUNC_32BIT_CONN	0x5303
62 #define	APM_FUNC_DISCONN	0x5304
63 #define	APM_FUNC_IDLE		0x5305
64 #define	APM_FUNC_BUSY		0x5306
65 #define	APM_FUNC_SET_STATE	0x5307
66 #define	APM_FUNC_ENABLE_PM	0x5308
67 #define	APM_FUNC_RESTORE_BIOS	0x5309
68 #define	APM_FUNC_GET_STATUS	0x530a
69 #define	APM_FUNC_GET_EVENT	0x530b
70 #define	APM_FUNC_GET_STATE	0x530c
71 #define	APM_FUNC_ENABLE_DEV_PM	0x530d
72 #define	APM_FUNC_VERSION	0x530e
73 #define	APM_FUNC_ENGAGE_PM	0x530f
74 #define	APM_FUNC_GET_CAP	0x5310
75 #define	APM_FUNC_RESUME_TIMER	0x5311
76 #define	APM_FUNC_RESUME_ON_RING	0x5312
77 #define	APM_FUNC_TIMER		0x5313
78 
79 /*
80  * Function code for APM_FUNC_RESUME_TIMER
81  */
82 #define	APM_FUNC_DISABLE_TIMER	0
83 #define	APM_FUNC_GET_TIMER	1
84 #define	APM_FUNC_SET_TIMER	2
85 
86 /*
87  * Function code for APM_FUNC_RESUME_ON_RING
88  */
89 #define	APM_FUNC_DISABLE_RING	0
90 #define	APM_FUNC_ENABLE_RING	1
91 #define	APM_FUNC_GET_RING	2
92 
93 /*
94  * Function code for APM_FUNC_TIMER_STATUS
95  */
96 #define	APM_FUNC_TIMER_DISABLE	0
97 #define	APM_FUNC_TIMER_ENABLE	1
98 #define	APM_FUNC_TIMER_GET	2
99 
100 /*
101  * in arch/i386/kernel/setup.c
102  */
103 extern struct apm_info	apm_info;
104 
105 #endif	/* __KERNEL__ */
106 
107 /*
108  * Power states
109  */
110 #define APM_STATE_READY		0x0000
111 #define APM_STATE_STANDBY	0x0001
112 #define APM_STATE_SUSPEND	0x0002
113 #define APM_STATE_OFF		0x0003
114 #define APM_STATE_BUSY		0x0004
115 #define APM_STATE_REJECT	0x0005
116 #define APM_STATE_OEM_SYS	0x0020
117 #define APM_STATE_OEM_DEV	0x0040
118 
119 #define APM_STATE_DISABLE	0x0000
120 #define APM_STATE_ENABLE	0x0001
121 
122 #define APM_STATE_DISENGAGE	0x0000
123 #define APM_STATE_ENGAGE	0x0001
124 
125 /*
126  * Events (results of Get PM Event)
127  */
128 #define APM_SYS_STANDBY		0x0001
129 #define APM_SYS_SUSPEND		0x0002
130 #define APM_NORMAL_RESUME	0x0003
131 #define APM_CRITICAL_RESUME	0x0004
132 #define APM_LOW_BATTERY		0x0005
133 #define APM_POWER_STATUS_CHANGE	0x0006
134 #define APM_UPDATE_TIME		0x0007
135 #define APM_CRITICAL_SUSPEND	0x0008
136 #define APM_USER_STANDBY	0x0009
137 #define APM_USER_SUSPEND	0x000a
138 #define APM_STANDBY_RESUME	0x000b
139 #define APM_CAPABILITY_CHANGE	0x000c
140 
141 /*
142  * Error codes
143  */
144 #define APM_SUCCESS		0x00
145 #define APM_DISABLED		0x01
146 #define APM_CONNECTED		0x02
147 #define APM_NOT_CONNECTED	0x03
148 #define APM_16_CONNECTED	0x05
149 #define APM_16_UNSUPPORTED	0x06
150 #define APM_32_CONNECTED	0x07
151 #define APM_32_UNSUPPORTED	0x08
152 #define APM_BAD_DEVICE		0x09
153 #define APM_BAD_PARAM		0x0a
154 #define APM_NOT_ENGAGED		0x0b
155 #define APM_BAD_FUNCTION	0x0c
156 #define APM_RESUME_DISABLED	0x0d
157 #define APM_NO_ERROR		0x53
158 #define APM_BAD_STATE		0x60
159 #define APM_NO_EVENTS		0x80
160 #define APM_NOT_PRESENT		0x86
161 
162 /*
163  * APM Device IDs
164  */
165 #define APM_DEVICE_BIOS		0x0000
166 #define APM_DEVICE_ALL		0x0001
167 #define APM_DEVICE_DISPLAY	0x0100
168 #define APM_DEVICE_STORAGE	0x0200
169 #define APM_DEVICE_PARALLEL	0x0300
170 #define APM_DEVICE_SERIAL	0x0400
171 #define APM_DEVICE_NETWORK	0x0500
172 #define APM_DEVICE_PCMCIA	0x0600
173 #define APM_DEVICE_BATTERY	0x8000
174 #define APM_DEVICE_OEM		0xe000
175 #define APM_DEVICE_OLD_ALL	0xffff
176 #define APM_DEVICE_CLASS	0x00ff
177 #define APM_DEVICE_MASK		0xff00
178 
179 #ifdef __KERNEL__
180 /*
181  * This is the "All Devices" ID communicated to the BIOS
182  */
183 #define APM_DEVICE_BALL		((apm_info.connection_version > 0x0100) ? \
184 				 APM_DEVICE_ALL : APM_DEVICE_OLD_ALL)
185 #endif
186 
187 /*
188  * Battery status
189  */
190 #define APM_MAX_BATTERIES	2
191 
192 /*
193  * APM defined capability bit flags
194  */
195 #define APM_CAP_GLOBAL_STANDBY		0x0001
196 #define APM_CAP_GLOBAL_SUSPEND		0x0002
197 #define APM_CAP_RESUME_STANDBY_TIMER	0x0004 /* Timer resume from standby */
198 #define APM_CAP_RESUME_SUSPEND_TIMER	0x0008 /* Timer resume from suspend */
199 #define APM_CAP_RESUME_STANDBY_RING	0x0010 /* Resume on Ring fr standby */
200 #define APM_CAP_RESUME_SUSPEND_RING	0x0020 /* Resume on Ring fr suspend */
201 #define APM_CAP_RESUME_STANDBY_PCMCIA	0x0040 /* Resume on PCMCIA Ring	*/
202 #define APM_CAP_RESUME_SUSPEND_PCMCIA	0x0080 /* Resume on PCMCIA Ring	*/
203 
204 /*
205  * ioctl operations
206  */
207 #include <linux/ioctl.h>
208 
209 #define APM_IOC_STANDBY		_IO('A', 1)
210 #define APM_IOC_SUSPEND		_IO('A', 2)
211 
212 #endif	/* LINUX_APM_H */
213