xref: /freebsd/sys/i386/include/apm_bios.h (revision 0640d357f29fb1c0daaaffadd0416c5981413afd)
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  *	$Id: apm_bios.h,v 1.20 1998/07/06 06:29:05 imp Exp $
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 SYSTEM_BIOS		0x1f
30 #else
31 #define APM_BIOS		0x53
32 #define SYSTEM_BIOS		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 /* Error code of APM initializer */
46 #define APMINI_CANTFIND		0xffffffff
47 #define APMINI_NOT32BIT		0xfffffffe
48 #define APMINI_CONNECTERR	0xfffffffd
49 
50 /* APM functions */
51 #define APM_INSTCHECK		0x00
52 #define APM_REALCONNECT		0x01
53 #define APM_PROT16CONNECT	0x02
54 #define APM_PROT32CONNECT	0x03
55 #define APM_DISCONNECT		0x04
56 #define APM_CPUIDLE		0x05
57 #define APM_CPUBUSY		0x06
58 #define APM_SETPWSTATE		0x07
59 #define APM_ENABLEDISABLEPM	0x08
60 #define APM_RESTOREDEFAULT	0x09
61 #ifdef PC98
62 #define	APM_GETPWSTATUS		0x3a
63 #else
64 #define	APM_GETPWSTATUS		0x0a
65 #endif
66 #define APM_GETPMEVENT		0x0b
67 #define APM_GETPWSTATE		0x0c
68 #define APM_ENABLEDISABLEDPM	0x0d
69 #ifdef PC98
70 #define APM_DRVVERSION		0x3e
71 #else
72 #define APM_DRVVERSION		0x0e
73 #endif
74 #define APM_ENGAGEDISENGAGEPM	0x0f
75 #define APM_GETCAPABILITIES	0x10
76 #define APM_RESUMETIMER		0x11
77 #define APM_RESUMEONRING	0x12
78 #define APM_TIMERREQUESTS	0x13
79 #define APM_OEMFUNC		0x80
80 
81 /* error code */
82 #define APME_OK			0x00
83 #define APME_PMDISABLED		0x01
84 #define APME_REALESTABLISHED	0x02
85 #define APME_NOTCONNECTED	0x03
86 #define APME_PROT16ESTABLISHED	0x05
87 #define APME_PROT16NOTSUPPORTED	0x06
88 #define APME_PROT32ESTABLISHED	0x07
89 #define APME_PROT32NOTDUPPORTED	0x08
90 #define APME_UNKNOWNDEVICEID	0x09
91 #define APME_OUTOFRANGE		0x0a
92 #define APME_NOTENGAGED		0x0b
93 #define APME_CANTENTERSTATE	0x60
94 #define APME_NOPMEVENT		0x80
95 #define APME_NOAPMPRESENT	0x86
96 
97 
98 /* device code */
99 #define PMDV_APMBIOS		0x0000
100 #define PMDV_ALLDEV		0x0001
101 #define PMDV_DISP0		0x0100
102 #define PMDV_DISP1		0x0101
103 #define PMDV_2NDSTORAGE0	0x0200
104 #define PMDV_2NDSTORAGE1	0x0201
105 #define PMDV_2NDSTORAGE2	0x0202
106 #define PMDV_2NDSTORAGE3	0x0203
107 #define PMDV_PARALLEL0		0x0300
108 #define PMDV_PARALLEL1		0x0301
109 #define PMDV_SERIAL0		0x0400
110 #define PMDV_SERIAL1		0x0401
111 #define PMDV_SERIAL2		0x0402
112 #define PMDV_SERIAL3		0x0403
113 #define PMDV_SERIAL4		0x0404
114 #define PMDV_SERIAL5		0x0405
115 #define PMDV_SERIAL6		0x0406
116 #define PMDV_SERIAL7		0x0407
117 #define PMDV_NET0		0x0500
118 #define PMDV_NET1		0x0501
119 #define PMDV_NET2		0x0502
120 #define PMDV_NET3		0x0503
121 #define PMDV_PCMCIA0		0x0600
122 #define PMDV_PCMCIA1		0x0601
123 #define PMDV_PCMCIA2		0x0602
124 #define PMDV_PCMCIA3		0x0603
125 /* 0x0700 - 0xdfff	Reserved			*/
126 /* 0xe000 - 0xefff	OEM-defined power device IDs	*/
127 /* 0xf000 - 0xffff	Reserved			*/
128 
129 /* Power state */
130 #define PMST_APMENABLED		0x0000
131 #define PMST_STANDBY		0x0001
132 #define PMST_SUSPEND		0x0002
133 #define PMST_OFF		0x0003
134 #define PMST_LASTREQNOTIFY	0x0004
135 #define PMST_LASTREQREJECT	0x0005
136 /* 0x0006 - 0x001f	Reserved system states		*/
137 /* 0x0020 - 0x003f	OEM-defined system states	*/
138 /* 0x0040 - 0x007f	OEM-defined device states	*/
139 /* 0x0080 - 0xffff	Reserved device states		*/
140 
141 #if !defined(ASSEMBLER) && !defined(INITIALIZER)
142 
143 /* C definitions */
144 struct apmhook {
145 	struct apmhook	*ah_next;
146 	int		(*ah_fun) __P((void *ah_arg));
147 	void		*ah_arg;
148 	const char	*ah_name;
149 	int		ah_order;
150 };
151 #define APM_HOOK_NONE		(-1)
152 #define APM_HOOK_SUSPEND        0
153 #define APM_HOOK_RESUME         1
154 #define NAPM_HOOK               2
155 
156 #ifdef KERNEL
157 
158 void apm_suspend(int state);
159 struct apmhook *apm_hook_establish (int apmh, struct apmhook *);
160 void apm_hook_disestablish (int apmh, struct apmhook *);
161 void apm_cpu_idle(void);
162 void apm_cpu_busy(void);
163 
164 #endif /* KERNEL */
165 
166 #endif /* !ASSEMBLER && !INITIALIZER */
167 
168 #define APM_MIN_ORDER		0x00
169 #define APM_MID_ORDER		0x80
170 #define APM_MAX_ORDER		0xff
171 
172 /* power management event code */
173 #define PMEV_NOEVENT		0x0000
174 #define PMEV_STANDBYREQ		0x0001
175 #define PMEV_SUSPENDREQ		0x0002
176 #define PMEV_NORMRESUME		0x0003
177 #define PMEV_CRITRESUME		0x0004
178 #define PMEV_BATTERYLOW		0x0005
179 #define PMEV_POWERSTATECHANGE	0x0006
180 #define PMEV_UPDATETIME		0x0007
181 #define PMEV_CRITSUSPEND	0x0008
182 #define PMEV_USERSTANDBYREQ	0x0009
183 #define PMEV_USERSUSPENDREQ	0x000a
184 #define PMEV_STANDBYRESUME	0x000b
185 #define PMEV_CAPABILITIESCHANGE 0x000c
186 /* 0x000d - 0x00ff	Reserved system events	*/
187 /* 0x0100 - 0x01ff	Reserved device events	*/
188 /* 0x0200 - 0x02ff	OEM-defined APM events	*/
189 /* 0x0300 - 0xffff	Reserved		*/
190 #define PMEV_DEFAULT		0xffffffff	/* used for customization */
191 
192 #if !defined(ASSEMBLER) && !defined(INITIALIZER)
193 
194 /*
195  * Old apm_info structure, returned by the APMIO_GETINFO_OLD ioctl.  This
196  * is for backward compatibility with old executables.
197  */
198 typedef struct apm_info_old {
199 	u_int	ai_major;	/* APM major version */
200 	u_int	ai_minor;	/* APM minor version */
201 	u_int	ai_acline;	/* AC line status */
202 	u_int	ai_batt_stat;	/* Battery status */
203 	u_int	ai_batt_life;	/* Remaining battery life */
204 	u_int	ai_status;	/* Status of APM support (enabled/disabled) */
205 } *apm_info_old_t;
206 
207 /*
208  * Structure returned by the APMIO_GETINFO ioctl.
209  *
210  * In the comments below, the parenthesized numbers indicate the minimum
211  * value of ai_infoversion for which each field is valid.
212  */
213 typedef struct apm_info {
214 	u_int	ai_infoversion;	/* Indicates which fields are valid */
215 	u_int	ai_major;	/* APM major version (0) */
216 	u_int	ai_minor;	/* APM minor version (0) */
217 	u_int	ai_acline;	/* AC line status (0) */
218 	u_int	ai_batt_stat;	/* Battery status (0) */
219 	u_int	ai_batt_life;	/* Remaining battery life in percent (0) */
220 	int	ai_batt_time;	/* Remaining battery time in seconds (0) */
221 	u_int	ai_status;	/* True if enabled (0) */
222 	u_int	ai_batteries;	/* Number of batteries (1) */
223 	u_int	ai_capabilities;/* APM Capabilities (1) */
224 	u_int	ai_spare[6];	/* For future expansion */
225 } *apm_info_t;
226 
227 struct apm_bios_arg {
228 	u_long eax;
229 	u_long ebx;
230 	u_long ecx;
231 	u_long edx;
232 	u_long esi;
233 	u_long edi;
234 };
235 
236 #define APMIO_SUSPEND		_IO('P', 1)
237 #define APMIO_GETINFO_OLD	_IOR('P', 2, struct apm_info_old)
238 #define APMIO_ENABLE		_IO('P', 5)
239 #define APMIO_DISABLE		_IO('P', 6)
240 #define APMIO_HALTCPU		_IO('P', 7)
241 #define APMIO_NOTHALTCPU	_IO('P', 8)
242 #define APMIO_DISPLAY		_IOW('P', 9, int)
243 #define APMIO_BIOS		_IOWR('P', 10, struct apm_bios_arg)
244 #define APMIO_GETINFO		_IOR('P', 11, struct apm_info)
245 #define APMIO_STANDBY		_IO('P', 12)
246 
247 #endif /* !ASSEMBLER && !INITIALIZER */
248 
249 #endif /* !_MACHINE_APM_BIOS_H_ */
250