MdePkg/Include/IndustryStandard/Acpi1_0.h

   1 /** @file
   2         ACPI 1.0b definitions from the ACPI Specification, revision 1.0b
   3
   4   Copyright (c) 2006 - 2007, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12 **/
  13
  14 #ifndef _ACPI_1_0_H_
  15 #define _ACPI_1_0_H_
  16
  17 //
  18 // Common table header, this prefaces all ACPI tables, including FACS, but
  19 // excluding the RSD PTR structure
  20 //
  21 typedef struct {
  22   UINT32  Signature;
  23   UINT32  Length;
  24 } EFI_ACPI_COMMON_HEADER;
  25
  26 //
  27 // Common ACPI description table header.  This structure prefaces most ACPI tables.
  28 //
  29 #pragma pack(1)
  30
  31 typedef struct {
  32   UINT32  Signature;
  33   UINT32  Length;
  34   UINT8   Revision;
  35   UINT8   Checksum;
  36   UINT8   OemId[6];
  37   UINT64  OemTableId;
  38   UINT32  OemRevision;
  39   UINT32  CreatorId;
  40   UINT32  CreatorRevision;
  41 } EFI_ACPI_DESCRIPTION_HEADER;
  42
  43 #pragma pack()
  44 //
  45 // Define for Pci Host Bridge Resource Allocation
  46 //
  47 #define ACPI_ADDRESS_SPACE_DESCRIPTOR 0x8A
  48 #define ACPI_END_TAG_DESCRIPTOR       0x79
  49
  50 #define ACPI_ADDRESS_SPACE_TYPE_MEM   0x00
  51 #define ACPI_ADDRESS_SPACE_TYPE_IO    0x01
  52 #define ACPI_ADDRESS_SPACE_TYPE_BUS   0x02
  53
  54 //
  55 // Power Management Timer frequency is fixed at 3.579545MHz
  56 //
  57 #define ACPI_TIMER_FREQUENCY       3579545
  58
  59 //
  60 // Make sure structures match spec
  61 //
  62 #pragma pack(1)
  63
  64 typedef struct {
  65   UINT8   Desc;
  66   UINT16  Len;
  67   UINT8   ResType;
  68   UINT8   GenFlag;
  69   UINT8   SpecificFlag;
  70   UINT64  AddrSpaceGranularity;
  71   UINT64  AddrRangeMin;
  72   UINT64  AddrRangeMax;
  73   UINT64  AddrTranslationOffset;
  74   UINT64  AddrLen;
  75 } EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR;
  76
  77 typedef struct {
  78   UINT8 Desc;
  79   UINT8 Checksum;
  80 } EFI_ACPI_END_TAG_DESCRIPTOR;
  81
  82 //
  83 // General use definitions
  84 //
  85 #define EFI_ACPI_RESERVED_BYTE  0x00
  86 #define EFI_ACPI_RESERVED_WORD  0x0000
  87 #define EFI_ACPI_RESERVED_DWORD 0x00000000
  88 #define EFI_ACPI_RESERVED_QWORD 0x0000000000000000
  89
  90 //
  91 // Resource Type Specific Flags
  92 // Ref ACPI specification 6.4.3.5.5
  93 //
  94 // Bit [0]    : Write Status, _RW
  95 //
  96 #define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_READ_WRITE                (1 << 0)
  97 #define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_READ_ONLY                 (0 << 0)
  98 //
  99 // Bit [2:1]  : Memory Attributes, _MEM
 100 //
 101 #define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_NON_CACHEABLE             (0 << 1)
 102 #define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_CACHEABLE                 (1 << 1)
 103 #define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_CACHEABLE_WRITE_COMBINING (2 << 1)
 104 #define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_CACHEABLE_PREFETCHABLE    (3 << 1)
 105 //
 106 // Bit [4:3]  : Memory Attributes, _MTP
 107 //
 108 #define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_ADDRESS_RANGE_MEMORY      (0 << 3)
 109 #define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_ADDRESS_RANGE_RESERVED    (1 << 3)
 110 #define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_ADDRESS_RANGE_ACPI        (2 << 3)
 111 #define EFI_APCI_MEMORY_RESOURCE_SPECIFIC_FLAG_ADDRESS_RANGE_NVS         (3 << 3)
 112 //
 113 // Bit [5]    : Memory to I/O Translation, _TTP
 114 //
 115 #define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_TYPE_TRANSLATION          (1 << 5)
 116 #define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_TYPE_STATIC               (0 << 5)
 117
 118 #pragma pack()
 119
 120
 121 //
 122 // Ensure proper structure formats
 123 //
 124 #pragma pack(1)
 125 //
 126 // ACPI 1.0b table structures
 127 //
 128 //
 129 // Root System Description Pointer Structure
 130 //
 131 typedef struct {
 132   UINT64  Signature;
 133   UINT8   Checksum;
 134   UINT8   OemId[6];
 135   UINT8   Reserved;
 136   UINT32  RsdtAddress;
 137 } EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER;
 138
 139 //
 140 // Root System Description Table
 141 // No definition needed as it is a common description table header followed by a
 142 // variable number of UINT32 table pointers.
 143 //
 144 //
 145 // RSDT Revision (as defined in ACPI 1.0b spec.)
 146 //
 147 #define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
 148
 149 //
 150 // Fixed ACPI Description Table Structure (FADT)
 151 //
 152 typedef struct {
 153   EFI_ACPI_DESCRIPTION_HEADER Header;
 154   UINT32                      FirmwareCtrl;
 155   UINT32                      Dsdt;
 156   UINT8                       IntModel;
 157   UINT8                       Reserved1;
 158   UINT16                      SciInt;
 159   UINT32                      SmiCmd;
 160   UINT8                       AcpiEnable;
 161   UINT8                       AcpiDisable;
 162   UINT8                       S4BiosReq;
 163   UINT8                       Reserved2;
 164   UINT32                      Pm1aEvtBlk;
 165   UINT32                      Pm1bEvtBlk;
 166   UINT32                      Pm1aCntBlk;
 167   UINT32                      Pm1bCntBlk;
 168   UINT32                      Pm2CntBlk;
 169   UINT32                      PmTmrBlk;
 170   UINT32                      Gpe0Blk;
 171   UINT32                      Gpe1Blk;
 172   UINT8                       Pm1EvtLen;
 173   UINT8                       Pm1CntLen;
 174   UINT8                       Pm2CntLen;
 175   UINT8                       PmTmLen;
 176   UINT8                       Gpe0BlkLen;
 177   UINT8                       Gpe1BlkLen;
 178   UINT8                       Gpe1Base;
 179   UINT8                       Reserved3;
 180   UINT16                      PLvl2Lat;
 181   UINT16                      PLvl3Lat;
 182   UINT16                      FlushSize;
 183   UINT16                      FlushStride;
 184   UINT8                       DutyOffset;
 185   UINT8                       DutyWidth;
 186   UINT8                       DayAlrm;
 187   UINT8                       MonAlrm;
 188   UINT8                       Century;
 189   UINT8                       Reserved4;
 190   UINT8                       Reserved5;
 191   UINT8                       Reserved6;
 192   UINT32                      Flags;
 193 } EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE;
 194
 195 //
 196 // FADT Version (as defined in ACPI 1.0b spec.)
 197 //
 198 #define EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION  0x01
 199
 200 //
 201 // Fixed ACPI Description Table Fixed Feature Flags
 202 // All other bits are reserved and must be set to 0.
 203 //
 204 #define EFI_ACPI_1_0_WBINVD       (1 << 0)
 205 #define EFI_ACPI_1_0_WBINVD_FLUSH (1 << 1)
 206 #define EFI_ACPI_1_0_PROC_C1      (1 << 2)
 207 #define EFI_ACPI_1_0_P_LVL2_UP    (1 << 3)
 208 #define EFI_ACPI_1_0_PWR_BUTTON   (1 << 4)
 209 #define EFI_ACPI_1_0_SLP_BUTTON   (1 << 5)
 210 #define EFI_ACPI_1_0_FIX_RTC      (1 << 6)
 211 #define EFI_ACPI_1_0_RTC_S4       (1 << 7)
 212 #define EFI_ACPI_1_0_TMR_VAL_EXT  (1 << 8)
 213 #define EFI_ACPI_1_0_DCK_CAP      (1 << 9)
 214
 215 //
 216 // Firmware ACPI Control Structure
 217 //
 218 typedef struct {
 219   UINT32  Signature;
 220   UINT32  Length;
 221   UINT32  HardwareSignature;
 222   UINT32  FirmwareWakingVector;
 223   UINT32  GlobalLock;
 224   UINT32  Flags;
 225   UINT8   Reserved[40];
 226 } EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;
 227
 228 //
 229 // Firmware Control Structure Feature Flags
 230 // All other bits are reserved and must be set to 0.
 231 //
 232 #define EFI_ACPI_1_0_S4BIOS_F (1 << 0)
 233
 234 //
 235 // Multiple APIC Description Table header definition.  The rest of the table
 236 // must be defined in a platform specific manner.
 237 //
 238 typedef struct {
 239   EFI_ACPI_DESCRIPTION_HEADER Header;
 240   UINT32                      LocalApicAddress;
 241   UINT32                      Flags;
 242 } EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;
 243
 244 //
 245 // MADT Revision (as defined in ACPI 1.0b spec.)
 246 //
 247 #define EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x01
 248
 249 //
 250 // Multiple APIC Flags
 251 // All other bits are reserved and must be set to 0.
 252 //
 253 #define EFI_ACPI_1_0_PCAT_COMPAT  (1 << 0)
 254
 255 //
 256 // Multiple APIC Description Table APIC structure types
 257 // All other values between 0x09 an 0xFF are reserved and
 258 // will be ignored by OSPM.
 259 //
 260 #define EFI_ACPI_1_0_PROCESSOR_LOCAL_APIC           0x00
 261 #define EFI_ACPI_1_0_IO_APIC                        0x01
 262 #define EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE      0x02
 263 #define EFI_ACPI_1_0_NON_MASKABLE_INTERRUPT_SOURCE  0x03
 264 #define EFI_ACPI_1_0_LOCAL_APIC_NMI                 0x04
 265
 266 //
 267 // APIC Structure Definitions
 268 //
 269 //
 270 // Processor Local APIC Structure Definition
 271 //
 272 typedef struct {
 273   UINT8   Type;
 274   UINT8   Length;
 275   UINT8   AcpiProcessorId;
 276   UINT8   ApicId;
 277   UINT32  Flags;
 278 } EFI_ACPI_1_0_PROCESSOR_LOCAL_APIC_STRUCTURE;
 279
 280 //
 281 // Local APIC Flags.  All other bits are reserved and must be 0.
 282 //
 283 #define EFI_ACPI_1_0_LOCAL_APIC_ENABLED (1 << 0)
 284
 285 //
 286 // IO APIC Structure
 287 //
 288 typedef struct {
 289   UINT8   Type;
 290   UINT8   Length;
 291   UINT8   IoApicId;
 292   UINT8   Reserved;
 293   UINT32  IoApicAddress;
 294   UINT32  SystemVectorBase;
 295 } EFI_ACPI_1_0_IO_APIC_STRUCTURE;
 296
 297 //
 298 // Interrupt Source Override Structure
 299 //
 300 typedef struct {
 301   UINT8   Type;
 302   UINT8   Length;
 303   UINT8   Bus;
 304   UINT8   Source;
 305   UINT32  GlobalSystemInterruptVector;
 306   UINT16  Flags;
 307 } EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;
 308
 309 //
 310 // Non-Maskable Interrupt Source Structure
 311 //
 312 typedef struct {
 313   UINT8   Type;
 314   UINT8   Length;
 315   UINT16  Flags;
 316   UINT32  GlobalSystemInterruptVector;
 317 } EFI_ACPI_1_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;
 318
 319 //
 320 // Local APIC NMI Structure
 321 //
 322 typedef struct {
 323   UINT8   Type;
 324   UINT8   Length;
 325   UINT8   AcpiProcessorId;
 326   UINT16  Flags;
 327   UINT8   LocalApicInti;
 328 } EFI_ACPI_1_0_LOCAL_APIC_NMI_STRUCTURE;
 329
 330 //
 331 // Smart Battery Description Table (SBST)
 332 //
 333 typedef struct {
 334   EFI_ACPI_DESCRIPTION_HEADER Header;
 335   UINT32                      WarningEnergyLevel;
 336   UINT32                      LowEnergyLevel;
 337   UINT32                      CriticalEnergyLevel;
 338 } EFI_ACPI_1_0_SMART_BATTERY_DESCRIPTION_TABLE;
 339
 340 //
 341 // Known table signatures
 342 //
 343 //
 344 // "RSD PTR " Root System Description Pointer
 345 //
 346 #define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE  0x2052545020445352ULL
 347
 348 //
 349 // "APIC" Multiple APIC Description Table
 350 //
 351 #define EFI_ACPI_1_0_APIC_SIGNATURE 0x43495041
 352
 353 //
 354 // "DSDT" Differentiated System Description Table
 355 //
 356 #define EFI_ACPI_1_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  0x54445344
 357
 358 //
 359 // "FACS" Firmware ACPI Control Structure
 360 //
 361 #define EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE  0x53434146
 362
 363 //
 364 // "FACP" Fixed ACPI Description Table
 365 //
 366 #define EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE 0x50434146
 367
 368 //
 369 // "PSDT" Persistent System Description Table
 370 //
 371 #define EFI_ACPI_1_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  0x54445350
 372
 373 //
 374 // "RSDT" Root System Description Table
 375 //
 376 #define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE  0x54445352
 377
 378 //
 379 // "SBST" Smart Battery Specification Table
 380 //
 381 #define EFI_ACPI_1_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE  0x54534253
 382
 383 //
 384 // "SSDT" Secondary System Description Table
 385 //
 386 #define EFI_ACPI_1_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE 0x54445353
 387
 388 #pragma pack()
 389
 390 #endif