xref: /freebsd/sys/i386/include/apm_bios.h (revision 4cf49a43559ed9fdad601bdcccd2c55963008675)
1 /*
2  * APM (Advanced Power Management) BIOS Device Driver
3  *
4  * Copyright (c) 1994-1995 by HOSOKAWA, Tatsumi <hosokawa@mt.cs.keio.ac.jp>
5  *
6  * This software may be used, modified, copied, and distributed, in
7  * both source and binary form provided that the above copyright and
8  * these terms are retained. Under no circumstances is the author
9  * responsible for the proper functioning of this software, nor does
10  * the author assume any responsibility for damages incurred with its
11  * use.
12  *
13  * Aug, 1994	Implemented on FreeBSD 1.1.5.1R (Toshiba AVS001WD)
14  *
15  * $FreeBSD$
16  */
17 
18 #ifndef	_MACHINE_APM_BIOS_H_
19 #define	_MACHINE_APM_BIOS_H_
20 
21 #ifndef KERNEL
22 #include <sys/types.h>
23 #endif
24 #include <sys/ioccom.h>
25 
26 /* BIOS id */
27 #ifdef PC98
28 #define APM_BIOS		0x9a
29 #define APM_INT			0x1f
30 #else
31 #define APM_BIOS		0x53
32 #define APM_INT			0x15
33 #endif
34 
35 /* APM flags */
36 #define APM_16BIT_SUPPORT	0x01
37 #define APM_32BIT_SUPPORT	0x02
38 #define APM_CPUIDLE_SLOW	0x04
39 #define APM_DISABLED		0x08
40 #define APM_DISENGAGED		0x10
41 
42 /* APM initializer physical address */
43 #define APM_OURADDR		0x00080000
44 
45 /* APM functions */
46 #define APM_INSTCHECK		0x00
47 #define APM_REALCONNECT		0x01
48 #define APM_PROT16CONNECT	0x02
49 #define APM_PROT32CONNECT	0x03
50 #define APM_DISCONNECT		0x04
51 #define APM_CPUIDLE		0x05
52 #define APM_CPUBUSY		0x06
53 #define APM_SETPWSTATE		0x07
54 #define APM_ENABLEDISABLEPM	0x08
55 #define APM_RESTOREDEFAULT	0x09
56 #ifdef PC98
57 #define	APM_GETPWSTATUS		0x3a
58 #else
59 #define	APM_GETPWSTATUS		0x0a
60 #endif
61 #define APM_GETPMEVENT		0x0b
62 #define APM_GETPWSTATE		0x0c
63 #define APM_ENABLEDISABLEDPM	0x0d
64 #ifdef PC98
65 #define APM_DRVVERSION		0x3e
66 #else
67 #define APM_DRVVERSION		0x0e
68 #endif
69 #define APM_ENGAGEDISENGAGEPM	0x0f
70 #define APM_GETCAPABILITIES	0x10
71 #define APM_RESUMETIMER		0x11
72 #define APM_RESUMEONRING	0x12
73 #define APM_TIMERREQUESTS	0x13
74 #define APM_OEMFUNC		0x80
75 
76 /* error code */
77 #define APME_OK			0x00
78 #define APME_PMDISABLED		0x01
79 #define APME_REALESTABLISHED	0x02
80 #define APME_NOTCONNECTED	0x03
81 #define APME_PROT16ESTABLISHED	0x05
82 #define APME_PROT16NOTSUPPORTED	0x06
83 #define APME_PROT32ESTABLISHED	0x07
84 #define APME_PROT32NOTDUPPORTED	0x08
85 #define APME_UNKNOWNDEVICEID	0x09
86 #define APME_OUTOFRANGE		0x0a
87 #define APME_NOTENGAGED		0x0b
88 #define APME_CANTENTERSTATE	0x60
89 #define APME_NOPMEVENT		0x80
90 #define APME_NOAPMPRESENT	0x86
91 
92 
93 /* device code */
94 #define PMDV_APMBIOS		0x0000
95 #define PMDV_ALLDEV		0x0001
96 #define PMDV_DISP0		0x0100
97 #define PMDV_DISP1		0x0101
98 #define PMDV_2NDSTORAGE0	0x0200
99 #define PMDV_2NDSTORAGE1	0x0201
100 #define PMDV_2NDSTORAGE2	0x0202
101 #define PMDV_2NDSTORAGE3	0x0203
102 #define PMDV_PARALLEL0		0x0300
103 #define PMDV_PARALLEL1		0x0301
104 #define PMDV_SERIAL0		0x0400
105 #define PMDV_SERIAL1		0x0401
106 #define PMDV_SERIAL2		0x0402
107 #define PMDV_SERIAL3		0x0403
108 #define PMDV_SERIAL4		0x0404
109 #define PMDV_SERIAL5		0x0405
110 #define PMDV_SERIAL6		0x0406
111 #define PMDV_SERIAL7		0x0407
112 #define PMDV_NET0		0x0500
113 #define PMDV_NET1		0x0501
114 #define PMDV_NET2		0x0502
115 #define PMDV_NET3		0x0503
116 #define PMDV_PCMCIA0		0x0600
117 #define PMDV_PCMCIA1		0x0601
118 #define PMDV_PCMCIA2		0x0602
119 #define PMDV_PCMCIA3		0x0603
120 /* 0x0700 - 0xdfff	Reserved			*/
121 /* 0xe000 - 0xefff	OEM-defined power device IDs	*/
122 /* 0xf000 - 0xffff	Reserved			*/
123 
124 /* Power state */
125 #define PMST_APMENABLED		0x0000
126 #define PMST_STANDBY		0x0001
127 #define PMST_SUSPEND		0x0002
128 #define PMST_OFF		0x0003
129 #define PMST_LASTREQNOTIFY	0x0004
130 #define PMST_LASTREQREJECT	0x0005
131 /* 0x0006 - 0x001f	Reserved system states		*/
132 /* 0x0020 - 0x003f	OEM-defined system states	*/
133 /* 0x0040 - 0x007f	OEM-defined device states	*/
134 /* 0x0080 - 0xffff	Reserved device states		*/
135 
136 #if !defined(ASSEMBLER) && !defined(INITIALIZER)
137 
138 /* C definitions */
139 struct apmhook {
140 	struct apmhook	*ah_next;
141 	int		(*ah_fun) __P((void *ah_arg));
142 	void		*ah_arg;
143 	const char	*ah_name;
144 	int		ah_order;
145 };
146 #define APM_HOOK_NONE		(-1)
147 #define APM_HOOK_SUSPEND        0
148 #define APM_HOOK_RESUME         1
149 #define NAPM_HOOK               2
150 
151 #ifdef KERNEL
152 
153 void apm_suspend(int state);
154 struct apmhook *apm_hook_establish (int apmh, struct apmhook *);
155 void apm_hook_disestablish (int apmh, struct apmhook *);
156 void apm_cpu_idle(void);
157 void apm_cpu_busy(void);
158 
159 #endif /* KERNEL */
160 
161 #endif /* !ASSEMBLER && !INITIALIZER */
162 
163 #define APM_MIN_ORDER		0x00
164 #define APM_MID_ORDER		0x80
165 #define APM_MAX_ORDER		0xff
166 
167 /* power management event code */
168 #define PMEV_NOEVENT		0x0000
169 #define PMEV_STANDBYREQ		0x0001
170 #define PMEV_SUSPENDREQ		0x0002
171 #define PMEV_NORMRESUME		0x0003
172 #define PMEV_CRITRESUME		0x0004
173 #define PMEV_BATTERYLOW		0x0005
174 #define PMEV_POWERSTATECHANGE	0x0006
175 #define PMEV_UPDATETIME		0x0007
176 #define PMEV_CRITSUSPEND	0x0008
177 #define PMEV_USERSTANDBYREQ	0x0009
178 #define PMEV_USERSUSPENDREQ	0x000a
179 #define PMEV_STANDBYRESUME	0x000b
180 #define PMEV_CAPABILITIESCHANGE 0x000c
181 /* 0x000d - 0x00ff	Reserved system events	*/
182 /* 0x0100 - 0x01ff	Reserved device events	*/
183 /* 0x0200 - 0x02ff	OEM-defined APM events	*/
184 /* 0x0300 - 0xffff	Reserved		*/
185 #define PMEV_DEFAULT		0xffffffff	/* used for customization */
186 
187 #if !defined(ASSEMBLER) && !defined(INITIALIZER)
188 
189 /*
190  * Old apm_info structure, returned by the APMIO_GETINFO_OLD ioctl.  This
191  * is for backward compatibility with old executables.
192  */
193 typedef struct apm_info_old {
194 	u_int	ai_major;	/* APM major version */
195 	u_int	ai_minor;	/* APM minor version */
196 	u_int	ai_acline;	/* AC line status */
197 	u_int	ai_batt_stat;	/* Battery status */
198 	u_int	ai_batt_life;	/* Remaining battery life */
199 	u_int	ai_status;	/* Status of APM support (enabled/disabled) */
200 } *apm_info_old_t;
201 
202 /*
203  * Structure returned by the APMIO_GETINFO ioctl.
204  *
205  * In the comments below, the parenthesized numbers indicate the minimum
206  * value of ai_infoversion for which each field is valid.
207  */
208 typedef struct apm_info {
209 	u_int	ai_infoversion;	/* Indicates which fields are valid */
210 	u_int	ai_major;	/* APM major version (0) */
211 	u_int	ai_minor;	/* APM minor version (0) */
212 	u_int	ai_acline;	/* AC line status (0) */
213 	u_int	ai_batt_stat;	/* Battery status (0) */
214 	u_int	ai_batt_life;	/* Remaining battery life in percent (0) */
215 	int	ai_batt_time;	/* Remaining battery time in seconds (0) */
216 	u_int	ai_status;	/* True if enabled (0) */
217 	u_int	ai_batteries;	/* Number of batteries (1) */
218 	u_int	ai_capabilities;/* APM Capabilities (1) */
219 	u_int	ai_spare[6];	/* For future expansion */
220 } *apm_info_t;
221 
222 struct apm_bios_arg {
223         u_long eax;
224         u_long ebx;
225         u_long ecx;
226         u_long edx;
227         u_long esi;
228         u_long edi;
229 };
230 
231 struct apm_event_info {
232 	u_int type;
233 	u_int index;
234 	u_int spare[8];
235 };
236 
237 #define APMIO_SUSPEND		_IO('P', 1)
238 #define APMIO_GETINFO_OLD	_IOR('P', 2, struct apm_info_old)
239 #define APMIO_ENABLE		_IO('P', 5)
240 #define APMIO_DISABLE		_IO('P', 6)
241 #define APMIO_HALTCPU		_IO('P', 7)
242 #define APMIO_NOTHALTCPU	_IO('P', 8)
243 #define APMIO_DISPLAY		_IOW('P', 9, int)
244 #define APMIO_BIOS		_IOWR('P', 10, struct apm_bios_arg)
245 #define APMIO_GETINFO		_IOR('P', 11, struct apm_info)
246 #define APMIO_STANDBY		_IO('P', 12)
247 /* for /dev/apmctl */
248 #define APMIO_NEXTEVENT		_IOR('A', 100, struct apm_event_info)
249 #define APMIO_REJECTLASTREQ	_IO('P', 101)
250 
251 #endif /* !ASSEMBLER && !INITIALIZER */
252 
253 #endif /* !_MACHINE_APM_BIOS_H_ */
254