?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
cpu.resource(pc-i386) Get this compile again, with acpica.library
[AROS.git] / compiler / include / resources / acpi.h
blobad1cd7951b5deb352511bc94e65741d3cd1eafbb
1 /*
2 Copyright © 1995-2012, The AROS Development Team. All rights reserved.
3 $Id$
4
5 Desc: AROS Generic ACPI Definitions.
6 Lang: english
7 */
8 #ifndef __AROS_ACPI_H__
9 #define __AROS_ACPI_H__
10
11 #include <exec/libraries.h>
12 #include <exec/lists.h>
13 #include <exec/semaphores.h>
14 #include <exec/interrupts.h>
15 #include <utility/hooks.h>
16
17 /********** ACPI DEFINITIONS ****************/
18
19 /*
20 * Actually a reverse of AROS_MAKE_ID().
21 * Reverse because ACPI signatures appear to be stored in bigendian format.
22 */
23 #define ACPI_MAKE_ID(a, b, c, d) (((ULONG) (d)<<24) | ((ULONG) (c)<<16) | \
24 ((ULONG) (b)<<8) | ((ULONG) (a)))
25
26 #define ACPI_ID_ALL 0xFFFFFFFF
27
28 /* ACPI 2.0 Generic Address Structure (GAS) */
29
30 struct GENERIC_ACPI_ADDR
31 {
32 unsigned char address_space_id; /* Address space where struct or register exists. */
33 unsigned char register_bit_width; /* Size in bits of given register */
34 unsigned char register_bit_offset; /* Bit offset within the register */
35 unsigned char size; /* Acces size (see below) */
36 UQUAD address; /* 64-bit address of struct or register */
37 } __attribute__ ((packed));
38
39 /* Address spaces */
40 #define ACPI_SPACE_MEM 0
41 #define ACPI_SPACE_IO 1
42 #define ACPI_SPACE_PCI 2
43 #define ACPI_SPACE_EMBEDDED 3
44 #define ACPI_SPACE_SMBUS 4
45 #define ACPI_SPACE_FIXED 0x7F
46 #define ACPI_SPACE_OEM 0xC0
47
48 /* Access sizes */
49 #define ACPI_SIZE_UNDEFINED 0 /* Specified by bit offset and width */
50 #define ACPI_SIZE_BYTE 1
51 #define ACPI_SIZE_WORD 2
52 #define ACPI_SIZE_DWORD 3
53 #define ACPI_SIZE_QUAD 4
54
55 #define ACPI_PCI_OFFSET(addr) (unsigned short)((addr) & 0x0FFFF)
56 #define ACPI_PCI_FUNC(addr) (unsigned short)(((addr) >> 16) & 0x0FFFF)
57 #define ACPI_PCI_DEV(addr) (unsigned short)(((addr) >> 32) & 0x0FFFF)
58
59 struct ACPI_TABLE_DEF_HEADER /* ACPI common table header */
60 {
61 unsigned int signature; /* ACPI signature (4 ASCII characters) */
62 unsigned int length; /* Length of table, in bytes, including header */
63 unsigned char revision; /* ACPI Specification minor version # */
64 unsigned char checksum; /* To make sum of entire table == 0 */
65 char oem_id [6]; /* OEM identification */
66 char oem_table_id [8]; /* OEM table identification */
67 unsigned int oem_revision; /* OEM revision number */
68 char asl_compiler_id [4]; /* ASL compiler vendor ID */
69 unsigned int asl_compiler_revision; /* ASL compiler revision number */
70 };
71
72 /* Table Handlers */
73
74 enum ACPI_IRQ_PICS
75 {
76 ACPI_IRQ_PIC_8259 = 0,
77 ACPI_IRQ_PIC_IOAPIC,
78 ACPI_IRQ_PIC_IOSAPIC,
79 ACPI_IRQ_PIC_COUNT
80 };
81
82 /* Root System Description Pointer "RSDP" structure */
83 struct ACPI_TABLE_TYPE_RSDP
84 {
85 char signature[8];
86 unsigned char checksum;
87 char oem_id[6];
88 unsigned char revision;
89 unsigned int rsdt_address;
90 /* The following fields are present only if revision >= 2 */
91 unsigned int length;
92 UQUAD xsdt_address;
93 unsigned char ext_checksum;
94 unsigned char reserved[3];
95 };
96
97 struct ACPI_TABLE_DEF_ENTRY_HEADER
98 {
99 unsigned char type;
100 unsigned char length;
101 };
102
103 #define ACPI_ENTRY_TYPE_ALL -1
104
105 struct ACPI_TABLE_TYPE_RSDT /* Root System Description Table "RSDT" structures */
106 {
107 struct ACPI_TABLE_DEF_HEADER header;
108 unsigned int entry[8];
109 };
110
111 struct ACPI_TABLE_TYPE_XSDT /* Extended System Description Table "XSDT" structures */
112 {
113 struct ACPI_TABLE_DEF_HEADER header;
114 UQUAD entry[1];
115 } __attribute__ ((packed));
116
117 struct ACPI_TABLE_TYPE_FADT /* Fixed ACPI Description Table "FADT" structures */
118 {
119 struct ACPI_TABLE_DEF_HEADER header;
120 unsigned int facs_addr;
121 unsigned int dsdt_addr;
122 unsigned char reserved0; /* ACPI 1.0: interrupt model. Actually never used. */
123 unsigned char pm_profile; /* ACPI >= 2.0: preferred system profile, see below */
124 unsigned short sci_int;
125 unsigned int smi_cmd;
126 unsigned char acpi_enable;
127 unsigned char acpi_disable;
128 unsigned char s4bios_req;
129 unsigned char pstate_cnt;
130 unsigned int pm1a_evt_blk;
131 unsigned int pm1b_evt_blk;
132 unsigned int pm1a_cnt_blk;
133 unsigned int pm1b_cnt_blk;
134 unsigned int pm2_cnt_blk;
135 unsigned int pm_tmr_blk;
136 unsigned int gpe0_blk;
137 unsigned int gpe1_blk;
138 unsigned char pm1_evt_len;
139 unsigned char pm1_cnt_len;
140 unsigned char pm2_cnt_len;
141 unsigned char pm_tmr_len;
142 unsigned char gpe0_blk_len;
143 unsigned char gpe1_blk_len;
144 unsigned char gpe1_base;
145 unsigned char cst_cnt;
146 unsigned short p_lvl2_lat;
147 unsigned short p_lvl3_lat;
148 unsigned short flush_size; /* Obsolete leftover from ACPI v1.0 */
149 unsigned short flush_stride; /* Obsolete leftover from ACPI v1.0 */
150 unsigned char duty_offset;
151 unsigned char duty_width;
152 unsigned char day_alarm;
153 unsigned char mon_alarm;
154 unsigned char century;
155 unsigned short pc_arch; /* ACPI >= 2.0: IA-PC architecture flags, see below */
156 unsigned char reserved1;
157 unsigned int flags; /* Fixed feature flags, see below */
158 /* The following is present in ACPI >= 2.0 */
159 struct GENERIC_ACPI_ADDR reset_reg;
160 unsigned char reset_value;
161 unsigned char reserved2[3];
162 unsigned long long x_firmware_ctrl;
163 unsigned long long x_dsdt;
164 struct GENERIC_ACPI_ADDR x_pm1a_evt_blk;
165 struct GENERIC_ACPI_ADDR x_pm1b_evt_blk;
166 struct GENERIC_ACPI_ADDR x_pm1a_cnt_blk;
167 struct GENERIC_ACPI_ADDR x_pm1b_cnt_blk;
168 struct GENERIC_ACPI_ADDR x_pm2_cnt_blk;
169 struct GENERIC_ACPI_ADDR x_pm_tmr_blk;
170 struct GENERIC_ACPI_ADDR x_gpe0_blk;
171 struct GENERIC_ACPI_ADDR x_gpe1_blk;
172 } __attribute__ ((packed));
173
174 /* Preferred system profiles */
175 #define FACP_PROFILE_UNSPECIFIED 0
176 #define FACP_PROFILE_DESKTOP 1
177 #define FACP_PROFILE_MOBILE 2
178 #define FACP_PROFILE_WORKSTATION 3
179 #define FACP_PROFILE_ENTERPRIZE 4
180 #define FACP_PROFILE_SOHO 5
181 #define FACP_PROFILE_APPLIANCE 6
182 #define FACP_PROFILE_PERFORMANCE 7
183
184 /* IA-PC architecture flags */
185 #define FACP_PC_LEGACY (1 << 0)
186 #define FACP_PC_8042 (1 << 1)
187 #define FACP_PC_NO_VGA (1 << 2)
188 #define FACP_PC_NO_MSI (1 << 3)
189 #define FACP_PCIE_ASPM (1 << 4)
190
191 /* Fixed feature flags */
192 #define FACP_FF_WBINVD (1 << 0)
193 #define FACP_FF_WBINVD_FLUSH (1 << 1)
194 #define FACP_FF_PROC_C1 (1 << 2)
195 #define FACP_FF_P_LVL2_UP (1 << 3)
196 #define FACP_FF_PWR_BUTTON (1 << 4)
197 #define FACP_FF_SLP_BUTTON (1 << 5)
198 #define FACP_FF_FIX_RTC (1 << 6)
199 #define FACP_FF_RTC_S4 (1 << 7)
200 #define FACP_FF_TMR_VAL_EXT (1 << 8)
201 #define FACP_FF_DCK_CAP (1 << 9)
202 #define FACP_FF_RESET_REG_SUP (1 << 10)
203 #define FACP_FF_SEALED_CASE (1 << 11)
204 #define FACP_FF_HEADLESS (1 << 12)
205 #define FACP_FF_CPU_SW_SLP (1 << 13)
206 #define FACP_FF_PCI_EXP_WAK (1 << 14)
207 #define FACP_FF_PLATFORM_CLOCK (1 << 15)
208 #define FACP_FF_S4_RTC_STS_VALID (1 << 16)
209 #define FACP_FF_REMOTE_PWRON (1 << 17)
210 #define FACP_FF_APIC_CLUSTER (1 << 18)
211 #define FACP_FF_APIC_PHYS_DEST (1 << 19)
212
213 struct ACPI_TABLE_TYPE_MADT /* Multiple APIC Description Table "MADT" structures */
214 {
215 struct ACPI_TABLE_DEF_HEADER header;
216 unsigned int lapic_address;
217 struct
218 {
219 unsigned int pcat_compat:1;
220 unsigned int reserved:31;
221 } flags;
222 struct ACPI_TABLE_DEF_ENTRY_HEADER entries[0];
223 };
224
225 enum ACPI_MADT_TYPES
226 {
227 ACPI_MADT_LAPIC = 0,
228 ACPI_MADT_IOAPIC,
229 ACPI_MADT_INT_SRC_OVR,
230 ACPI_MADT_NMI_SRC,
231 ACPI_MADT_LAPIC_NMI,
232 ACPI_MADT_LAPIC_ADDR_OVR,
233 ACPI_MADT_IOSAPIC,
234 ACPI_MADT_LSAPIC,
235 ACPI_MADT_PLAT_INT_SRC,
236 ACPI_MADT_X2APIC,
237 ACPI_MADT_X2APIC_NMI,
238 ACPI_MADT_ENTRY_COUNT
239 };
240
241 typedef struct
242 {
243 UWORD polarity:2; /* See below */
244 UWORD trigger:2; /* See below */
245 UWORD reserved:12;
246 } ACPI_INT_FLAGS;
247
248 /* Polarity and trigger mode values */
249 #define INTF_POLARITY_BUS 0 /* Bus default */
250 #define INTF_POLARITY_HIGH 1 /* Active high */
251 #define INTF_POLARITY_LOW 3 /* Active low */
252 #define INTF_TRIGGER_BUS 0 /* Bus default */
253 #define INTF_TRIGGER_EDGE 1
254 #define INTF_TRIGGER_LEVEL 3
255
256 struct ACPI_TABLE_TYPE_LAPIC
257 {
258 struct ACPI_TABLE_DEF_ENTRY_HEADER header;
259 unsigned char acpi_id;
260 unsigned char id;
261 struct
262 {
263 unsigned int enabled:1;
264 unsigned int reserved:31;
265 } flags;
266 };
267
268 struct ACPI_TABLE_TYPE_IOAPIC
269 {
270 struct ACPI_TABLE_DEF_ENTRY_HEADER header;
271 unsigned char id;
272 unsigned char reserved;
273 unsigned int address;
274 unsigned int global_irq_base;
275 };
276
277 struct ACPI_TABLE_TYPE_INT_SRCOVR
278 {
279 struct ACPI_TABLE_DEF_ENTRY_HEADER header;
280 unsigned char bus;
281 unsigned char bus_irq;
282 unsigned int global_irq;
283 ACPI_INT_FLAGS flags;
284 };
285
286 struct ACPI_TABLE_TYPE_LAPIC_NMI_SRC
287 {
288 struct ACPI_TABLE_DEF_ENTRY_HEADER header;
289 ACPI_INT_FLAGS flags;
290 unsigned int global_irq;
291 };
292
293 struct ACPI_TABLE_TYPE_LAPIC_NMI
294 {
295 struct ACPI_TABLE_DEF_ENTRY_HEADER header;
296 unsigned char acpi_id;
297 ACPI_INT_FLAGS flags;
298 unsigned char lint;
299 } __attribute__ ((packed));
300
301 #define ACPI_ID_BROADCAST 0xFF
302
303 struct ACPI_TABLE_TYPE_LAPIC_ADDROVR
304 {
305 struct ACPI_TABLE_DEF_ENTRY_HEADER header;
306 unsigned char reserved[2];
307 UQUAD address;
308 } __attribute__ ((packed));
309
310 struct ACPI_TABLE_TYPE_IOSAPIC
311 {
312 struct ACPI_TABLE_DEF_ENTRY_HEADER header;
313 unsigned char id;
314 unsigned char reserved;
315 unsigned int global_irq_base;
316 UQUAD address;
317 };
318
319 struct ACPI_TABLE_TYPE_LSAPIC
320 {
321 struct ACPI_TABLE_DEF_ENTRY_HEADER header;
322 unsigned char acpi_id;
323 unsigned char id;
324 unsigned char eid;
325 unsigned char reserved[3];
326 struct {
327 unsigned int enabled:1;
328 unsigned int reserved:31;
329 } flags;
330 };
331
332 struct ACPI_TABLE_TYPE_PLAT_INTSRC
333 {
334 struct ACPI_TABLE_DEF_ENTRY_HEADER header;
335 ACPI_INT_FLAGS flags;
336 unsigned char type; /* See acpi_interrupt_type */
337 unsigned char id;
338 unsigned char eid;
339 unsigned char iosapic_vector;
340 unsigned int global_irq;
341 unsigned int srcflags; /* See below */
342 };
343
344 /* Interrupt types */
345 enum ACPI_INT_IDS
346 {
347 ACPI_INTERRUPT_PMI = 1,
348 ACPI_INTERRUPT_INIT,
349 ACPI_INTERRUPT_CPEI,
350 ACPI_INTERRUPT_COUNT
351 };
352
353 /* Interrupt source flags */
354 #define ACPI_CPEI_PROC_OVERRIDE (1 << 0)
355
356 struct ACPI_TABLE_TYPE_X2APIC
357 {
358 struct ACPI_TABLE_DEF_ENTRY_HEADER header;
359 /* 2 bytes of padding here */
360 unsigned int id;
361 unsigned int flags;
362 unsigned int acpi_uid;
363 };
364
365 #define ACPI_X2APIC_ENABLED (1 << 0)
366
367 struct ACPI_TABLE_TYPE_X2APIC_NMI
368 {
369 struct ACPI_TABLE_DEF_ENTRY_HEADER header;
370 ACPI_INT_FLAGS flags;
371 unsigned int acpi_uid;
372 unsigned char lint;
373 };
374
375 #define ACPI_UID_BROADCAST 0xFFFFFFFF
376
377 struct ACPI_TABLE_TYPE_HPET
378 {
379 struct ACPI_TABLE_DEF_HEADER header;
380 unsigned int id;
381 struct GENERIC_ACPI_ADDR addr;
382 unsigned char number;
383 UWORD min_tick;
384 unsigned char page_protect;
385 } __attribute__ ((packed));
386
387 /* ID components */
388 #define HPET_HW_REV_MASK 0x000000FF
389 #define HPET_NUM_COMPARATORS_MASK 0x00001F00
390 #define HPET_NUM_COMPARATORS_SHIFT 8
391 #define HPET_COUNTER_SIZE 0x00002000
392 #define HPET_LEGACY_REPLACEMENT 0x00008000
393 #define HPET_PCI_VENDOR_MASK 0xFFFF0000
394 #define HPET_PCI_VENDOR_SHIFT 16
395
396 /* page_protect components */
397 #define HPET_PAGE_PROTECT_MASK 0x0F
398 #define HPET_OEM_ATTR_MASK 0xF0
399 #define HPET_OEM_ATTR_SHIFT 4
400
401 #define HPET_PAGE_NONE 0
402 #define HPET_PAGE_4K 1
403 #define HPET_PAGE_64K 2
404
405 /*
406 System Resource Affinity Table (SRAT) [ see http://www.microsoft.com/hwdev/design/srat.htm ]
407 */
408
409 struct ACPI_TABLE_TYPE_SRAT
410 {
411 struct ACPI_TABLE_DEF_HEADER header;
412 unsigned int table_revision;
413 UQUAD reserved;
414 };
415
416 enum ACPI_SRAT_ENTRY_IDS
417 {
418 ACPI_SRAT_PROCESSOR_AFFINITY = 0,
419 ACPI_SRAT_MEMORY_AFFINITY,
420 ACPI_SRAT_ENTRY_COUNT
421 };
422
423 struct ACPI_TABLE_AFFIN_PROCESSOR
424 {
425 struct ACPI_TABLE_DEF_ENTRY_HEADER header;
426 unsigned char proximity_domain;
427 unsigned char apic_id;
428 struct
429 {
430 unsigned int enabled:1;
431 unsigned int reserved:31;
432 } flags;
433 unsigned char lsapic_eid;
434 unsigned char reserved[7];
435 };
436
437 struct ACPI_TABLE_AFFIN_MEMORY
438 {
439 struct ACPI_TABLE_DEF_ENTRY_HEADER header;
440 unsigned char proximity_domain;
441 unsigned char reserved1[5];
442 unsigned int base_addr_lo;
443 unsigned int base_addr_hi;
444 unsigned int length_lo;
445 unsigned int length_hi;
446 unsigned int memory_type; /* See acpi_address_range_id */
447 struct
448 {
449 unsigned int enabled:1;
450 unsigned int hot_pluggable:1;
451 unsigned int reserved:30;
452 } flags;
453 UQUAD reserved2;
454 };
455
456 enum acpi_address_range_id
457 {
458 ACPI_ADDRESS_RANGE_MEMORY = 1,
459 ACPI_ADDRESS_RANGE_RESERVED = 2,
460 ACPI_ADDRESS_RANGE_ACPI = 3,
461 ACPI_ADDRESS_RANGE_NVS = 4,
462 ACPI_ADDRESS_RANGE_COUNT
463 };
464
465 /*
466 System Locality Information Table (SLIT) [ see http://devresource.hp.com/devresource/docs/techpapers/ia64/slit.pdf ]
467 */
468
469 struct ACPI_TABLE_TYPE_SLIT
470 {
471 struct ACPI_TABLE_DEF_HEADER header;
472 UQUAD localities;
473 unsigned char entry[1]; /* real size = localities^2 */
474 };
475
476 struct ACPI_TABLE_TYPE_SBST /* Smart Battery Description Table (SBST) */
477 {
478 struct ACPI_TABLE_DEF_HEADER header;
479 unsigned int warning; /* Warn user */
480 unsigned int low; /* Critical sleep */
481 unsigned int critical; /* Critical shutdown */
482 };
483
484 struct ACPI_TABLE_TYPE_ECDT /* Embedded Controller Boot Resources Table (ECDT) */
485 {
486 struct ACPI_TABLE_DEF_HEADER header;
487 struct GENERIC_ACPI_ADDR ec_control;
488 struct GENERIC_ACPI_ADDR ec_data;
489 unsigned int uid;
490 unsigned char gpe_bit;
491 char ec_id[0];
492 };
493
494 /*
495 * acpi.resource base.
496 * For a casual user it's actually black box. Use API to access the data.
497 * These pointers are provided for diagnostics purposes only.
498 */
499 struct ACPIBase
500 {
501 struct Library ACPIB_LibNode;
502
503 struct Interrupt ACPIB_ResetHandler;
504
505 struct ACPI_TABLE_TYPE_RSDP *ACPIB_RSDP_Addr; /* Supervisor-only!!! */
506 struct ACPI_TABLE_DEF_HEADER *ACPIB_SDT_Addr; /* Raw XSDT or RSDT pointer */
507 int ACPIB_SDT_Count; /* These two are private. Do not use! */
508 struct ACPI_TABLE_DEF_HEADER **ACPIB_SDT_Entry;
509 char ACPI_OEM_ID[6]; /* Cached from RSDP */
510 unsigned char ACPI_Revision;
511 /*..*/
512 APTR ACPIB_ACPI_Data; /* Base address of acpi data block */
513 APTR ACPIB_ACPI_Data_End;
514 APTR ACPIB_ACPI_NVM; /* Base address of acpi data block */
515
516 int ACPIB_ACPI_IRQ;
517
518 int ACPIB_ACPI_HT;
519 };
520
521 #endif /* __AROS_ACPI_H__ */
Mirror of AROS' svn.