UefiCpuPkg/Include/AcpiCpuData.h

   1 /** @file
   2 Definitions for CPU S3 data.
   3
   4 Copyright (c) 2013 - 2017, Intel Corporation. All rights reserved.<BR>
   5 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
  15 #ifndef _ACPI_CPU_DATA_H_
  16 #define _ACPI_CPU_DATA_H_
  17
  18 //
  19 // Register types in register table
  20 //
  21 typedef enum {
  22   Msr,
  23   ControlRegister,
  24   MemoryMapped,
  25   CacheControl
  26 } REGISTER_TYPE;
  27
  28 //
  29 // Element of register table entry
  30 //
  31 typedef struct {
  32   REGISTER_TYPE  RegisterType;          // offset 0 - 3
  33   UINT32         Index;                 // offset 4 - 7
  34   UINT8          ValidBitStart;         // offset 8
  35   UINT8          ValidBitLength;        // offset 9
  36   UINT16         Reserved;              // offset 10 - 11
  37   UINT32         HighIndex;             // offset 12-15, only valid for MemoryMapped
  38   UINT64         Value;                 // offset 16-23
  39 } CPU_REGISTER_TABLE_ENTRY;
  40
  41 //
  42 // Register table definition, including current table length,
  43 // allocated size of this table, and pointer to the list of table entries.
  44 //
  45 typedef struct {
  46   //
  47   // The number of valid entries in the RegisterTableEntry buffer
  48   //
  49   UINT32                    TableLength;
  50   UINT32                    NumberBeforeReset;
  51   //
  52   // The size, in bytes, of the RegisterTableEntry buffer
  53   //
  54   UINT32                    AllocatedSize;
  55   //
  56   // The initial APIC ID of the CPU this register table applies to
  57   //
  58   UINT32                    InitialApicId;
  59   //
  60   // Physical address of CPU_REGISTER_TABLE_ENTRY structures.  This buffer must be
  61   // allocated below 4GB from memory of type EfiACPIMemoryNVS.
  62   //
  63   EFI_PHYSICAL_ADDRESS      RegisterTableEntry;
  64 } CPU_REGISTER_TABLE;
  65
  66 //
  67 // Data structure that is required for ACPI S3 resume.  This structure must be
  68 // allocated below 4GB from memory of type EfiACPIMemoryNVS.  The PCD
  69 // PcdCpuS3DataAddress must be set to the physical address where this structure
  70 // is allocated
  71 //
  72 typedef struct {
  73   //
  74   // Physical address of 4KB buffer allocated below 1MB from memory of type
  75   // EfiReservedMemoryType.  The buffer is not required to be initialized, but
  76   // it is recommended that the buffer be zero-filled.  This buffer is used to
  77   // wake APs during an ACPI S3 resume.
  78   //
  79   EFI_PHYSICAL_ADDRESS  StartupVector;
  80   //
  81   // Physical address of structure of type IA32_DESCRIPTOR.  This structure must
  82   // be allocated below 4GB from memory of type EfiACPIMemoryNVS.  The
  83   // IA32_DESCRIPTOR structure provides the base address and length of a GDT
  84   // The buffer for GDT must also be allocated below 4GB from memory of type
  85   // EfiACPIMemoryNVS.  The GDT must be filled in with the GDT contents that are
  86   // used during an ACPI S3 resume.  This is typically the contents of the GDT
  87   // used by the boot processor when the platform is booted.
  88   //
  89   EFI_PHYSICAL_ADDRESS  GdtrProfile;
  90   //
  91   // Physical address of structure of type IA32_DESCRIPTOR.  This structure must
  92   // be allocated below 4GB from memory of type EfiACPIMemoryNVS.  The
  93   // IA32_DESCRIPTOR structure provides the base address and length of an IDT.
  94   // The buffer for IDT must also be allocated below 4GB from memory of type
  95   // EfiACPIMemoryNVS.  The IDT must be filled in with the IDT contents that are
  96   // used during an ACPI S3 resume.  This is typically the contents of the IDT
  97   // used by the boot processor when the platform is booted.
  98   //
  99   EFI_PHYSICAL_ADDRESS  IdtrProfile;
 100   //
 101   // Physical address of a buffer that is used as stacks during ACPI S3 resume.
 102   // The total size of this buffer, in bytes, is NumberOfCpus * StackSize.  This
 103   // structure must be allocated below 4GB from memory of type EfiACPIMemoryNVS.
 104   //
 105   EFI_PHYSICAL_ADDRESS  StackAddress;
 106   //
 107   // The size, in bytes, of the stack provided to each CPU during ACPI S3 resume.
 108   //
 109   UINT32                StackSize;
 110   //
 111   // The number of CPUs.  If a platform does not support hot plug CPUs, then
 112   // this is the number of CPUs detected when the platform is booted, regardless
 113   // of being enabled or disabled.  If a platform does support hot plug CPUs,
 114   // then this is the maximum number of CPUs that the platform supports.
 115   //
 116   UINT32                NumberOfCpus;
 117   //
 118   // Physical address of structure of type MTRR_SETTINGS that contains a copy
 119   // of the MTRR settings that are compatible with the MTRR settings used by
 120   // the boot processor when the platform was booted.  These MTRR settings are
 121   // used during an ACPI S3 resume.  This structure must be allocated below 4GB
 122   // from memory of type EfiACPIMemoryNVS.
 123   //
 124   EFI_PHYSICAL_ADDRESS  MtrrTable;
 125   //
 126   // Physical address of an array of CPU_REGISTER_TABLE structures, with
 127   // NumberOfCpus entries.  This array must be allocated below 4GB from memory
 128   // of type EfiACPIMemoryNVS.  If a register table is not required, then the
 129   // TableLength and AllocatedSize fields of CPU_REGISTER_TABLE are set to 0.
 130   // If TableLength is > 0, then elements of RegisterTableEntry are used to
 131   // initialize the CPU that matches InitialApicId, during an ACPI S3 resume,
 132   // before SMBASE relocation is performed.
 133   //
 134   EFI_PHYSICAL_ADDRESS  PreSmmInitRegisterTable;
 135   //
 136   // Physical address of an array of CPU_REGISTER_TABLE structures, with
 137   // NumberOfCpus entries.  This array must be allocated below 4GB from memory
 138   // of type EfiACPIMemoryNVS.  If a register table is not required, then the
 139   // TableLength and AllocatedSize fields of CPU_REGISTER_TABLE are set to 0.
 140   // If TableLength is > 0, then elements of RegisterTableEntry are used to
 141   // initialize the CPU that matches InitialApicId, during an ACPI S3 resume,
 142   // after SMBASE relocation is performed.
 143   //
 144   EFI_PHYSICAL_ADDRESS  RegisterTable;
 145   //
 146   // Physical address of a buffer that contains the machine check handler that
 147   // is used during an ACPI S3 Resume.  This buffer must be allocated below 4GB
 148   // from memory of type EfiACPIMemoryNVS.  In order for this machine check
 149   // handler to be active on an AP during an ACPI S3 resume, the machine check
 150   // vector in the IDT provided by IdtrProfile must be initialized to transfer
 151   // control to this physical address.
 152   //
 153   EFI_PHYSICAL_ADDRESS  ApMachineCheckHandlerBase;
 154   //
 155   // The size, in bytes, of the machine check handler that is used during an
 156   // ACPI S3 Resume.  If this field is 0, then a machine check handler is not
 157   // provided.
 158   //
 159   UINT32                ApMachineCheckHandlerSize;
 160 } ACPI_CPU_DATA;
 161
 162 #endif