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