Fixed compatibility of output.
[AROS.git] / arch / all-pc / acpica / source / include / actbl3.h
blobacf2e13560d0e17721626ac05b9fa8595d8cf779
1 /******************************************************************************
3 * Name: actbl3.h - ACPI Table Definitions
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2013, Intel Corp.
9 * All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #ifndef __ACTBL3_H__
45 #define __ACTBL3_H__
48 /*******************************************************************************
50 * Additional ACPI Tables (3)
52 * These tables are not consumed directly by the ACPICA subsystem, but are
53 * included here to support device drivers and the AML disassembler.
55 * The tables in this file are fully defined within the ACPI specification.
57 ******************************************************************************/
61 * Values for description table header signatures for tables defined in this
62 * file. Useful because they make it more difficult to inadvertently type in
63 * the wrong signature.
65 #define ACPI_SIG_BGRT "BGRT" /* Boot Graphics Resource Table */
66 #define ACPI_SIG_DRTM "DRTM" /* Dynamic Root of Trust for Measurement table */
67 #define ACPI_SIG_FPDT "FPDT" /* Firmware Performance Data Table */
68 #define ACPI_SIG_GTDT "GTDT" /* Generic Timer Description Table */
69 #define ACPI_SIG_MPST "MPST" /* Memory Power State Table */
70 #define ACPI_SIG_PCCT "PCCT" /* Platform Communications Channel Table */
71 #define ACPI_SIG_PMTT "PMTT" /* Platform Memory Topology Table */
72 #define ACPI_SIG_RASF "RASF" /* RAS Feature table */
73 #define ACPI_SIG_TPM2 "TPM2" /* Trusted Platform Module 2.0 H/W interface table */
75 #define ACPI_SIG_S3PT "S3PT" /* S3 Performance (sub)Table */
76 #define ACPI_SIG_PCCS "PCC" /* PCC Shared Memory Region */
78 /* Reserved table signatures */
80 #define ACPI_SIG_MATR "MATR" /* Memory Address Translation Table */
81 #define ACPI_SIG_MSDM "MSDM" /* Microsoft Data Management Table */
82 #define ACPI_SIG_WPBT "WPBT" /* Windows Platform Binary Table */
85 * All tables must be byte-packed to match the ACPI specification, since
86 * the tables are provided by the system BIOS.
88 #pragma pack(1)
91 * Note: C bitfields are not used for this reason:
93 * "Bitfields are great and easy to read, but unfortunately the C language
94 * does not specify the layout of bitfields in memory, which means they are
95 * essentially useless for dealing with packed data in on-disk formats or
96 * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
97 * this decision was a design error in C. Ritchie could have picked an order
98 * and stuck with it." Norman Ramsey.
99 * See http://stackoverflow.com/a/1053662/41661
103 /*******************************************************************************
105 * BGRT - Boot Graphics Resource Table (ACPI 5.0)
106 * Version 1
108 ******************************************************************************/
110 typedef struct acpi_table_bgrt
112 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
113 UINT16 Version;
114 UINT8 Status;
115 UINT8 ImageType;
116 UINT64 ImageAddress;
117 UINT32 ImageOffsetX;
118 UINT32 ImageOffsetY;
120 } ACPI_TABLE_BGRT;
123 /*******************************************************************************
125 * DRTM - Dynamic Root of Trust for Measurement table
127 ******************************************************************************/
129 typedef struct acpi_table_drtm
131 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
132 UINT64 EntryBaseAddress;
133 UINT64 EntryLength;
134 UINT32 EntryAddress32;
135 UINT64 EntryAddress64;
136 UINT64 ExitAddress;
137 UINT64 LogAreaAddress;
138 UINT32 LogAreaLength;
139 UINT64 ArchDependentAddress;
140 UINT32 Flags;
142 } ACPI_TABLE_DRTM;
144 /* 1) Validated Tables List */
146 typedef struct acpi_drtm_vtl_list
148 UINT32 ValidatedTableListCount;
150 } ACPI_DRTM_VTL_LIST;
152 /* 2) Resources List */
154 typedef struct acpi_drtm_resource_list
156 UINT32 ResourceListCount;
158 } ACPI_DRTM_RESOURCE_LIST;
160 /* 3) Platform-specific Identifiers List */
162 typedef struct acpi_drtm_id_list
164 UINT32 IdListCount;
166 } ACPI_DRTM_ID_LIST;
169 /*******************************************************************************
171 * FPDT - Firmware Performance Data Table (ACPI 5.0)
172 * Version 1
174 ******************************************************************************/
176 typedef struct acpi_table_fpdt
178 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
180 } ACPI_TABLE_FPDT;
183 /* FPDT subtable header */
185 typedef struct acpi_fpdt_header
187 UINT16 Type;
188 UINT8 Length;
189 UINT8 Revision;
191 } ACPI_FPDT_HEADER;
193 /* Values for Type field above */
195 enum AcpiFpdtType
197 ACPI_FPDT_TYPE_BOOT = 0,
198 ACPI_FPDT_TYPE_S3PERF = 1
203 * FPDT subtables
206 /* 0: Firmware Basic Boot Performance Record */
208 typedef struct acpi_fpdt_boot
210 ACPI_FPDT_HEADER Header;
211 UINT8 Reserved[4];
212 UINT64 ResetEnd;
213 UINT64 LoadStart;
214 UINT64 StartupStart;
215 UINT64 ExitServicesEntry;
216 UINT64 ExitServicesExit;
218 } ACPI_FPDT_BOOT;
221 /* 1: S3 Performance Table Pointer Record */
223 typedef struct acpi_fpdt_s3pt_ptr
225 ACPI_FPDT_HEADER Header;
226 UINT8 Reserved[4];
227 UINT64 Address;
229 } ACPI_FPDT_S3PT_PTR;
233 * S3PT - S3 Performance Table. This table is pointed to by the
234 * FPDT S3 Pointer Record above.
236 typedef struct acpi_table_s3pt
238 UINT8 Signature[4]; /* "S3PT" */
239 UINT32 Length;
241 } ACPI_TABLE_S3PT;
245 * S3PT Subtables
247 typedef struct acpi_s3pt_header
249 UINT16 Type;
250 UINT8 Length;
251 UINT8 Revision;
253 } ACPI_S3PT_HEADER;
255 /* Values for Type field above */
257 enum AcpiS3ptType
259 ACPI_S3PT_TYPE_RESUME = 0,
260 ACPI_S3PT_TYPE_SUSPEND = 1
263 typedef struct acpi_s3pt_resume
265 ACPI_S3PT_HEADER Header;
266 UINT32 ResumeCount;
267 UINT64 FullResume;
268 UINT64 AverageResume;
270 } ACPI_S3PT_RESUME;
272 typedef struct acpi_s3pt_suspend
274 ACPI_S3PT_HEADER Header;
275 UINT64 SuspendStart;
276 UINT64 SuspendEnd;
278 } ACPI_S3PT_SUSPEND;
281 /*******************************************************************************
283 * GTDT - Generic Timer Description Table (ACPI 5.0)
284 * Version 1
286 ******************************************************************************/
288 typedef struct acpi_table_gtdt
290 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
291 UINT64 Address;
292 UINT32 Flags;
293 UINT32 SecurePl1Interrupt;
294 UINT32 SecurePl1Flags;
295 UINT32 NonSecurePl1Interrupt;
296 UINT32 NonSecurePl1Flags;
297 UINT32 VirtualTimerInterrupt;
298 UINT32 VirtualTimerFlags;
299 UINT32 NonSecurePl2Interrupt;
300 UINT32 NonSecurePl2Flags;
302 } ACPI_TABLE_GTDT;
304 /* Values for Flags field above */
306 #define ACPI_GTDT_MAPPED_BLOCK_PRESENT 1
308 /* Values for all "TimerFlags" fields above */
310 #define ACPI_GTDT_INTERRUPT_MODE 1
311 #define ACPI_GTDT_INTERRUPT_POLARITY 2
314 /*******************************************************************************
316 * MPST - Memory Power State Table (ACPI 5.0)
317 * Version 1
319 ******************************************************************************/
321 #define ACPI_MPST_CHANNEL_INFO \
322 UINT8 ChannelId; \
323 UINT8 Reserved1[3]; \
324 UINT16 PowerNodeCount; \
325 UINT16 Reserved2;
327 /* Main table */
329 typedef struct acpi_table_mpst
331 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
332 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
334 } ACPI_TABLE_MPST;
337 /* Memory Platform Communication Channel Info */
339 typedef struct acpi_mpst_channel
341 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
343 } ACPI_MPST_CHANNEL;
346 /* Memory Power Node Structure */
348 typedef struct acpi_mpst_power_node
350 UINT8 Flags;
351 UINT8 Reserved1;
352 UINT16 NodeId;
353 UINT32 Length;
354 UINT64 RangeAddress;
355 UINT64 RangeLength;
356 UINT32 NumPowerStates;
357 UINT32 NumPhysicalComponents;
359 } ACPI_MPST_POWER_NODE;
361 /* Values for Flags field above */
363 #define ACPI_MPST_ENABLED 1
364 #define ACPI_MPST_POWER_MANAGED 2
365 #define ACPI_MPST_HOT_PLUG_CAPABLE 4
368 /* Memory Power State Structure (follows POWER_NODE above) */
370 typedef struct acpi_mpst_power_state
372 UINT8 PowerState;
373 UINT8 InfoIndex;
375 } ACPI_MPST_POWER_STATE;
378 /* Physical Component ID Structure (follows POWER_STATE above) */
380 typedef struct acpi_mpst_component
382 UINT16 ComponentId;
384 } ACPI_MPST_COMPONENT;
387 /* Memory Power State Characteristics Structure (follows all POWER_NODEs) */
389 typedef struct acpi_mpst_data_hdr
391 UINT16 CharacteristicsCount;
392 UINT16 Reserved;
394 } ACPI_MPST_DATA_HDR;
396 typedef struct acpi_mpst_power_data
398 UINT8 StructureId;
399 UINT8 Flags;
400 UINT16 Reserved1;
401 UINT32 AveragePower;
402 UINT32 PowerSaving;
403 UINT64 ExitLatency;
404 UINT64 Reserved2;
406 } ACPI_MPST_POWER_DATA;
408 /* Values for Flags field above */
410 #define ACPI_MPST_PRESERVE 1
411 #define ACPI_MPST_AUTOENTRY 2
412 #define ACPI_MPST_AUTOEXIT 4
415 /* Shared Memory Region (not part of an ACPI table) */
417 typedef struct acpi_mpst_shared
419 UINT32 Signature;
420 UINT16 PccCommand;
421 UINT16 PccStatus;
422 UINT32 CommandRegister;
423 UINT32 StatusRegister;
424 UINT32 PowerStateId;
425 UINT32 PowerNodeId;
426 UINT64 EnergyConsumed;
427 UINT64 AveragePower;
429 } ACPI_MPST_SHARED;
432 /*******************************************************************************
434 * PCCT - Platform Communications Channel Table (ACPI 5.0)
435 * Version 1
437 ******************************************************************************/
439 typedef struct acpi_table_pcct
441 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
442 UINT32 Flags;
443 UINT32 Latency;
444 UINT32 Reserved;
446 } ACPI_TABLE_PCCT;
448 /* Values for Flags field above */
450 #define ACPI_PCCT_DOORBELL 1
453 * PCCT subtables
456 /* 0: Generic Communications Subspace */
458 typedef struct acpi_pcct_subspace
460 ACPI_SUBTABLE_HEADER Header;
461 UINT8 Reserved[6];
462 UINT64 BaseAddress;
463 UINT64 Length;
464 ACPI_GENERIC_ADDRESS DoorbellRegister;
465 UINT64 PreserveMask;
466 UINT64 WriteMask;
468 } ACPI_PCCT_SUBSPACE;
472 * PCC memory structures (not part of the ACPI table)
475 /* Shared Memory Region */
477 typedef struct acpi_pcct_shared_memory
479 UINT32 Signature;
480 UINT16 Command;
481 UINT16 Status;
483 } ACPI_PCCT_SHARED_MEMORY;
486 /*******************************************************************************
488 * PMTT - Platform Memory Topology Table (ACPI 5.0)
489 * Version 1
491 ******************************************************************************/
493 typedef struct acpi_table_pmtt
495 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
496 UINT32 Reserved;
498 } ACPI_TABLE_PMTT;
501 /* Common header for PMTT subtables that follow main table */
503 typedef struct acpi_pmtt_header
505 UINT8 Type;
506 UINT8 Reserved1;
507 UINT16 Length;
508 UINT16 Flags;
509 UINT16 Reserved2;
511 } ACPI_PMTT_HEADER;
513 /* Values for Type field above */
515 #define ACPI_PMTT_TYPE_SOCKET 0
516 #define ACPI_PMTT_TYPE_CONTROLLER 1
517 #define ACPI_PMTT_TYPE_DIMM 2
518 #define ACPI_PMTT_TYPE_RESERVED 3 /* 0x03-0xFF are reserved */
520 /* Values for Flags field above */
522 #define ACPI_PMTT_TOP_LEVEL 0x0001
523 #define ACPI_PMTT_PHYSICAL 0x0002
524 #define ACPI_PMTT_MEMORY_TYPE 0x000C
528 * PMTT subtables, correspond to Type in acpi_pmtt_header
532 /* 0: Socket Structure */
534 typedef struct acpi_pmtt_socket
536 ACPI_PMTT_HEADER Header;
537 UINT16 SocketId;
538 UINT16 Reserved;
540 } ACPI_PMTT_SOCKET;
543 /* 1: Memory Controller subtable */
545 typedef struct acpi_pmtt_controller
547 ACPI_PMTT_HEADER Header;
548 UINT32 ReadLatency;
549 UINT32 WriteLatency;
550 UINT32 ReadBandwidth;
551 UINT32 WriteBandwidth;
552 UINT16 AccessWidth;
553 UINT16 Alignment;
554 UINT16 Reserved;
555 UINT16 DomainCount;
557 } ACPI_PMTT_CONTROLLER;
559 /* 1a: Proximity Domain substructure */
561 typedef struct acpi_pmtt_domain
563 UINT32 ProximityDomain;
565 } ACPI_PMTT_DOMAIN;
568 /* 2: Physical Component Identifier (DIMM) */
570 typedef struct acpi_pmtt_physical_component
572 ACPI_PMTT_HEADER Header;
573 UINT16 ComponentId;
574 UINT16 Reserved;
575 UINT32 MemorySize;
576 UINT32 BiosHandle;
578 } ACPI_PMTT_PHYSICAL_COMPONENT;
581 /*******************************************************************************
583 * RASF - RAS Feature Table (ACPI 5.0)
584 * Version 1
586 ******************************************************************************/
588 typedef struct acpi_table_rasf
590 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
591 UINT8 ChannelId[12];
593 } ACPI_TABLE_RASF;
595 /* RASF Platform Communication Channel Shared Memory Region */
597 typedef struct acpi_rasf_shared_memory
599 UINT32 Signature;
600 UINT16 Command;
601 UINT16 Status;
602 UINT16 Version;
603 UINT8 Capabilities[16];
604 UINT8 SetCapabilities[16];
605 UINT16 NumParameterBlocks;
606 UINT32 SetCapabilitiesStatus;
608 } ACPI_RASF_SHARED_MEMORY;
610 /* RASF Parameter Block Structure Header */
612 typedef struct acpi_rasf_parameter_block
614 UINT16 Type;
615 UINT16 Version;
616 UINT16 Length;
618 } ACPI_RASF_PARAMETER_BLOCK;
620 /* RASF Parameter Block Structure for PATROL_SCRUB */
622 typedef struct acpi_rasf_patrol_scrub_parameter
624 ACPI_RASF_PARAMETER_BLOCK Header;
625 UINT16 PatrolScrubCommand;
626 UINT64 RequestedAddressRange[2];
627 UINT64 ActualAddressRange[2];
628 UINT16 Flags;
629 UINT8 RequestedSpeed;
631 } ACPI_RASF_PATROL_SCRUB_PARAMETER;
633 /* Masks for Flags and Speed fields above */
635 #define ACPI_RASF_SCRUBBER_RUNNING 1
636 #define ACPI_RASF_SPEED (7<<1)
637 #define ACPI_RASF_SPEED_SLOW (0<<1)
638 #define ACPI_RASF_SPEED_MEDIUM (4<<1)
639 #define ACPI_RASF_SPEED_FAST (7<<1)
641 /* Channel Commands */
643 enum AcpiRasfCommands
645 ACPI_RASF_EXECUTE_RASF_COMMAND = 1
648 /* Platform RAS Capabilities */
650 enum AcpiRasfCapabiliities
652 ACPI_HW_PATROL_SCRUB_SUPPORTED = 0,
653 ACPI_SW_PATROL_SCRUB_EXPOSED = 1
656 /* Patrol Scrub Commands */
658 enum AcpiRasfPatrolScrubCommands
660 ACPI_RASF_GET_PATROL_PARAMETERS = 1,
661 ACPI_RASF_START_PATROL_SCRUBBER = 2,
662 ACPI_RASF_STOP_PATROL_SCRUBBER = 3
665 /* Channel Command flags */
667 #define ACPI_RASF_GENERATE_SCI (1<<15)
669 /* Status values */
671 enum AcpiRasfStatus
673 ACPI_RASF_SUCCESS = 0,
674 ACPI_RASF_NOT_VALID = 1,
675 ACPI_RASF_NOT_SUPPORTED = 2,
676 ACPI_RASF_BUSY = 3,
677 ACPI_RASF_FAILED = 4,
678 ACPI_RASF_ABORTED = 5,
679 ACPI_RASF_INVALID_DATA = 6
682 /* Status flags */
684 #define ACPI_RASF_COMMAND_COMPLETE (1)
685 #define ACPI_RASF_SCI_DOORBELL (1<<1)
686 #define ACPI_RASF_ERROR (1<<2)
687 #define ACPI_RASF_STATUS (0x1F<<3)
690 /*******************************************************************************
692 * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
693 * Version 3
695 * Conforms to "TPM 2.0 Hardware Interface Table (TPM2)" 29 November 2011
697 ******************************************************************************/
699 typedef struct acpi_table_tpm2
701 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
702 UINT32 Flags;
703 UINT64 ControlAddress;
704 UINT32 StartMethod;
706 } ACPI_TABLE_TPM2;
708 /* Control area structure (not part of table, pointed to by ControlAddress) */
710 typedef struct acpi_tpm2_control
712 UINT32 Reserved;
713 UINT32 Error;
714 UINT32 Cancel;
715 UINT32 Start;
716 UINT64 InterruptControl;
717 UINT32 CommandSize;
718 UINT64 CommandAddress;
719 UINT32 ResponseSize;
720 UINT64 ResponseAddress;
722 } ACPI_TPM2_CONTROL;
725 /* Reset to default packing */
727 #pragma pack()
729 #endif /* __ACTBL3_H__ */