[mirror_edk2.git] / MdePkg / Include / IndustryStandard / Sal.h

/** @file\r
  Main SAL API's defined in SAL 3.0 specification. \r
\r
  Copyright (c) 2006, Intel Corporation                                                         \r
  All rights reserved. This program and the accompanying materials                          \r
  are licensed and made available under the terms and conditions of the BSD License         \r
  which accompanies this distribution.  The full text of the license may be found at        \r
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
#ifndef __SAL_API_H__\r
#define __SAL_API_H__\r
\r
//\r
// FIT Types \r
// Table 2-2 of Intel Itanium Processor Family System Abstraction Layer Specification December 2003\r
//\r
#define EFI_SAL_FIT_FIT_HEADER_TYPE 0x00\r
#define EFI_SAL_FIT_PAL_B_TYPE      0x01\r
//\r
// type from 0x02 to 0x0E is reserved.\r
//\r
#define EFI_SAL_FIT_PAL_A_TYPE  0x0F\r
//\r
// OEM-defined type range is from 0x10 to 0x7E. Here we defined the PEI_CORE type as 0x10\r
//\r
#define EFI_SAL_FIT_PEI_CORE_TYPE 0x10\r
#define EFI_SAL_FIT_UNUSED_TYPE   0x7F\r
\r
//\r
// EFI_SAL_STATUS \r
//\r
typedef UINTN EFI_SAL_STATUS;\r
\r
#define EFI_SAL_SUCCESS               ((EFI_SAL_STATUS) 0)\r
#define EFI_SAL_MORE_RECORDS          ((EFI_SAL_STATUS) 3)\r
#define EFI_SAL_NOT_IMPLEMENTED       ((EFI_SAL_STATUS) - 1)\r
#define EFI_SAL_INVALID_ARGUMENT      ((EFI_SAL_STATUS) - 2)\r
#define EFI_SAL_ERROR                 ((EFI_SAL_STATUS) - 3)\r
#define EFI_SAL_VIRTUAL_ADDRESS_ERROR ((EFI_SAL_STATUS) - 4)\r
#define EFI_SAL_NO_INFORMATION        ((EFI_SAL_STATUS) - 5)\r
#define EFI_SAL_NOT_ENOUGH_SCRATCH    ((EFI_SAL_STATUS) - 9)\r
\r
//\r
//  Return values from SAL\r
//\r
typedef struct {\r
  EFI_SAL_STATUS  Status; // register r8\r
  UINTN           r9;\r
  UINTN           r10;\r
  UINTN           r11;\r
} SAL_RETURN_REGS;\r
\r
//\r
//  Delivery Mode of IPF CPU.\r
//\r
typedef enum {\r
  EFI_DELIVERY_MODE_INT,\r
  EFI_DELIVERY_MODE_MPreserved1,\r
  EFI_DELIVERY_MODE_PMI,\r
  EFI_DELIVERY_MODE_MPreserved2,\r
  EFI_DELIVERY_MODE_NMI,\r
  EFI_DELIVERY_MODE_INIT,\r
  EFI_DELIVERY_MODE_MPreserved3,\r
  EFI_DELIVERY_MODE_ExtINT\r
} EFI_DELIVERY_MODE;\r
\r
typedef SAL_RETURN_REGS (EFIAPI *SAL_PROC)\r
  (\r
    IN UINT64 FunctionId,\r
    IN UINT64 Arg2,\r
    IN UINT64 Arg3,\r
    IN UINT64 Arg4,\r
    IN UINT64 Arg5,\r
    IN UINT64 Arg6,\r
    IN UINT64 Arg7,\r
    IN UINT64 Arg8\r
  );\r
\r
//\r
// SAL Procedure FunctionId definition\r
//\r
#define EFI_SAL_SET_VECTORS             0x01000000\r
#define EFI_SAL_GET_STATE_INFO          0x01000001\r
#define EFI_SAL_GET_STATE_INFO_SIZE     0x01000002\r
#define EFI_SAL_CLEAR_STATE_INFO        0x01000003\r
#define EFI_SAL_MC_RENDEZ               0x01000004\r
#define EFI_SAL_MC_SET_PARAMS           0x01000005\r
#define EFI_SAL_REGISTER_PHYSICAL_ADDR  0x01000006\r
#define EFI_SAL_CACHE_FLUSH             0x01000008\r
#define EFI_SAL_CACHE_INIT              0x01000009\r
#define EFI_SAL_PCI_CONFIG_READ         0x01000010\r
#define EFI_SAL_PCI_CONFIG_WRITE        0x01000011\r
#define EFI_SAL_FREQ_BASE               0x01000012\r
#define EFI_SAL_UPDATE_PAL              0x01000020\r
\r
#define EFI_SAL_FUNCTION_ID_MASK        0x0000ffff\r
#define EFI_SAL_MAX_SAL_FUNCTION_ID     0x00000021\r
\r
//\r
// SAL Procedure parameter definitions\r
// Not much point in using typedefs or enums because all params\r
// are UINT64 and the entry point is common\r
//\r
// EFI_SAL_SET_VECTORS\r
//\r
#define EFI_SAL_SET_MCA_VECTOR          0x0\r
#define EFI_SAL_SET_INIT_VECTOR         0x1\r
#define EFI_SAL_SET_BOOT_RENDEZ_VECTOR  0x2\r
\r
typedef struct {\r
  UINT64  Length : 32;\r
  UINT64  ChecksumValid : 1;\r
  UINT64  Reserved1 : 7;\r
  UINT64  ByteChecksum : 8;\r
  UINT64  Reserved2 : 16;\r
} SAL_SET_VECTORS_CS_N;\r
\r
//\r
// EFI_SAL_GET_STATE_INFO, EFI_SAL_GET_STATE_INFO_SIZE,\r
// EFI_SAL_CLEAR_STATE_INFO\r
//\r
#define EFI_SAL_MCA_STATE_INFO  0x0\r
#define EFI_SAL_INIT_STATE_INFO 0x1\r
#define EFI_SAL_CMC_STATE_INFO  0x2\r
#define EFI_SAL_CP_STATE_INFO   0x3\r
\r
//\r
// EFI_SAL_MC_SET_PARAMS\r
//\r
#define EFI_SAL_MC_SET_RENDEZ_PARAM 0x1\r
#define EFI_SAL_MC_SET_WAKEUP_PARAM 0x2\r
#define EFI_SAL_MC_SET_CPE_PARAM    0x3\r
\r
#define EFI_SAL_MC_SET_INTR_PARAM   0x1\r
#define EFI_SAL_MC_SET_MEM_PARAM    0x2\r
\r
//\r
// EFI_SAL_REGISTER_PAL_PHYSICAL_ADDR\r
//\r
#define EFI_SAL_REGISTER_PAL_ADDR 0x0\r
\r
//\r
// EFI_SAL_CACHE_FLUSH\r
//\r
#define EFI_SAL_FLUSH_I_CACHE       0x01\r
#define EFI_SAL_FLUSH_D_CACHE       0x02\r
#define EFI_SAL_FLUSH_BOTH_CACHE    0x03\r
#define EFI_SAL_FLUSH_MAKE_COHERENT 0x04\r
\r
//\r
// EFI_SAL_PCI_CONFIG_READ, EFI_SAL_PCI_CONFIG_WRITE\r
//\r
#define EFI_SAL_PCI_CONFIG_ONE_BYTE   0x1\r
#define EFI_SAL_PCI_CONFIG_TWO_BYTES  0x2\r
#define EFI_SAL_PCI_CONFIG_FOUR_BYTES 0x4\r
\r
typedef struct {\r
  UINT64  Register : 8;\r
  UINT64  Function : 3;\r
  UINT64  Device : 5;\r
  UINT64  Bus : 8;\r
  UINT64  Segment : 8;\r
  UINT64  Reserved : 32;\r
} SAL_PCI_ADDRESS;\r
\r
//\r
// EFI_SAL_FREQ_BASE\r
//\r
#define EFI_SAL_CPU_INPUT_FREQ_BASE     0x0\r
#define EFI_SAL_PLATFORM_IT_FREQ_BASE   0x1\r
#define EFI_SAL_PLATFORM_RTC_FREQ_BASE  0x2\r
\r
//\r
// EFI_SAL_UPDATE_PAL\r
//\r
#define EFI_SAL_UPDATE_BAD_PAL_VERSION  ((UINT64) -1)\r
#define EFI_SAL_UPDATE_PAL_AUTH_FAIL    ((UINT64) -2)\r
#define EFI_SAL_UPDATE_PAL_BAD_TYPE     ((UINT64) -3)\r
#define EFI_SAL_UPDATE_PAL_READONLY     ((UINT64) -4)\r
#define EFI_SAL_UPDATE_PAL_WRITE_FAIL   ((UINT64) -10)\r
#define EFI_SAL_UPDATE_PAL_ERASE_FAIL   ((UINT64) -11)\r
#define EFI_SAL_UPDATE_PAL_READ_FAIL    ((UINT64) -12)\r
#define EFI_SAL_UPDATE_PAL_CANT_FIT     ((UINT64) -13)\r
\r
typedef struct {\r
  UINT32  Size;\r
  UINT32  MmddyyyyDate;\r
  UINT16  Version;\r
  UINT8   Type;\r
  UINT8   Reserved[5];\r
  UINT64  FwVendorId;\r
} SAL_UPDATE_PAL_DATA_BLOCK;\r
\r
typedef struct _SAL_UPDATE_PAL_INFO_BLOCK {\r
  struct _SAL_UPDATE_PAL_INFO_BLOCK *Next;\r
  struct SAL_UPDATE_PAL_DATA_BLOCK  *DataBlock;\r
  UINT8                             StoreChecksum;\r
  UINT8                             Reserved[15];\r
} SAL_UPDATE_PAL_INFO_BLOCK;\r
\r
//\r
// SAL System Table Definitions\r
//\r
#pragma pack(1)\r
typedef struct {\r
  UINT32  Signature;\r
  UINT32  Length;\r
  UINT16  SalRevision;\r
  UINT16  EntryCount;\r
  UINT8   CheckSum;\r
  UINT8   Reserved[7];\r
  UINT16  SalAVersion;\r
  UINT16  SalBVersion;\r
  UINT8   OemId[32];\r
  UINT8   ProductId[32];\r
  UINT8   Reserved2[8];\r
} SAL_SYSTEM_TABLE_HEADER;\r
#pragma pack()\r
\r
#define EFI_SAL_ST_HEADER_SIGNATURE "SST_"\r
#define EFI_SAL_REVISION            0x0300\r
//\r
// SAL System Types\r
//\r
#define EFI_SAL_ST_ENTRY_POINT        0\r
#define EFI_SAL_ST_MEMORY_DESCRIPTOR  1\r
#define EFI_SAL_ST_PLATFORM_FEATURES  2\r
#define EFI_SAL_ST_TR_USAGE           3\r
#define EFI_SAL_ST_PTC                4\r
#define EFI_SAL_ST_AP_WAKEUP          5\r
\r
#pragma pack(1)\r
typedef struct {\r
  UINT8   Type; //  Type == 0\r
  UINT8   Reserved[7];\r
  UINT64  PalProcEntry;\r
  UINT64  SalProcEntry;\r
  UINT64  SalGlobalDataPointer;\r
  UINT64  Reserved2[2];\r
} SAL_ST_ENTRY_POINT_DESCRIPTOR;\r
\r
//\r
// Not needed for Itanium-based OS boot\r
//\r
typedef struct {\r
  UINT8   Type; //  Type == 1\r
  UINT8   NeedVirtualRegistration;\r
  UINT8   MemoryAttributes;\r
  UINT8   PageAccessRights;\r
  UINT8   SupportedAttributes;\r
  UINT8   Reserved;\r
  UINT8   MemoryType;\r
  UINT8   MemoryUsage;\r
  UINT64  PhysicalMemoryAddress;\r
  UINT32  Length;\r
  UINT32  Reserved1;\r
  UINT64  OemReserved;\r
} SAL_ST_MEMORY_DESCRIPTOR_ENTRY;\r
\r
#pragma pack()\r
//\r
// Memory Attributes\r
//\r
#define SAL_MDT_ATTRIB_WB 0x00\r
//\r
// #define SAL_MDT_ATTRIB_UC   0x02\r
//\r
#define SAL_MDT_ATTRIB_UC   0x04\r
#define SAL_MDT_ATTRIB_UCE  0x05\r
#define SAL_MDT_ATTRIB_WC   0x06\r
\r
//\r
// Supported memory Attributes\r
//\r
#define SAL_MDT_SUPPORT_WB  0x1\r
#define SAL_MDT_SUPPORT_UC  0x2\r
#define SAL_MDT_SUPPORT_UCE 0x4\r
#define SAL_MDT_SUPPORT_WC  0x8\r
\r
//\r
// Virtual address registration\r
//\r
#define SAL_MDT_NO_VA   0x00\r
#define SAL_MDT_NEED_VA 0x01\r
//\r
// MemoryType info\r
//\r
#define SAL_REGULAR_MEMORY  0x0000\r
#define SAL_MMIO_MAPPING    0x0001\r
#define SAL_SAPIC_IPI_BLOCK 0x0002\r
#define SAL_IO_PORT_MAPPING 0x0003\r
#define SAL_FIRMWARE_MEMORY 0x0004\r
#define SAL_BLACK_HOLE      0x000A\r
//\r
// Memory Usage info\r
//\r
#define SAL_MDT_USAGE_UNSPECIFIED 0x00\r
#define SAL_PAL_CODE              0x01\r
#define SAL_BOOTSERVICE_CODE      0x02\r
#define SAL_BOOTSERVICE_DATA      0x03\r
#define SAL_RUNTIMESERVICE_CODE   0x04\r
#define SAL_RUNTIMESERVICE_DATA   0x05\r
#define SAL_IA32_OPTIONROM        0x06\r
#define SAL_IA32_SYSTEMROM        0x07\r
#define SAL_PMI_CODE              0x0a\r
#define SAL_PMI_DATA              0x0b\r
\r
#pragma pack(1)\r
typedef struct {\r
  UINT8 Type;                     // Type == 2\r
  UINT8 PlatformFeatures;\r
  UINT8 Reserved[14];\r
} SAL_ST_PLATFORM_FEATURES;\r
#pragma pack()\r
\r
#define SAL_PLAT_FEAT_BUS_LOCK      0x01\r
#define SAL_PLAT_FEAT_PLAT_IPI_HINT 0x02\r
#define SAL_PLAT_FEAT_PROC_IPI_HINT 0x04\r
\r
#pragma pack(1)\r
typedef struct {\r
  UINT8   Type;                   // Type == 3\r
  UINT8   TRType;\r
  UINT8   TRNumber;\r
  UINT8   Reserved[5];\r
  UINT64  VirtualAddress;\r
  UINT64  EncodedPageSize;\r
  UINT64  Reserved1;\r
} SAL_ST_TR_DECRIPTOR;\r
#pragma pack()\r
\r
#define EFI_SAL_ST_TR_USAGE_INSTRUCTION 00\r
#define EFI_SAL_ST_TR_USAGE_DATA        01\r
\r
#pragma pack(1)\r
typedef struct {\r
  UINT64  NumberOfProcessors;\r
  UINT64  LocalIDRegister;\r
} SAL_COHERENCE_DOMAIN_INFO;\r
#pragma pack()\r
\r
#pragma pack(1)\r
typedef struct {\r
  UINT8                     Type; // Type == 4\r
  UINT8                     Reserved[3];\r
  UINT32                    NumberOfDomains;\r
  SAL_COHERENCE_DOMAIN_INFO *DomainInformation;\r
} SAL_ST_CACHE_COHERENCE_DECRIPTOR;\r
#pragma pack()\r
\r
#pragma pack(1)\r
typedef struct {\r
  UINT8   Type;                   // Type == 5\r
  UINT8   WakeUpType;\r
  UINT8   Reserved[6];\r
  UINT64  ExternalInterruptVector;\r
} SAL_ST_AP_WAKEUP_DECRIPTOR;\r
#pragma pack()\r
//\r
// FIT Entry\r
//\r
#define EFI_SAL_FIT_ENTRY_PTR   (0x100000000 - 32)  // 4GB - 24\r
#define EFI_SAL_FIT_PALA_ENTRY  (0x100000000 - 48)  // 4GB - 32\r
#define EFI_SAL_FIT_PALB_TYPE   01\r
\r
typedef struct {\r
  UINT64  Address;\r
  UINT8   Size[3];\r
  UINT8   Reserved;\r
  UINT16  Revision;\r
  UINT8   Type : 7;\r
  UINT8   CheckSumValid : 1;\r
  UINT8   CheckSum;\r
} EFI_SAL_FIT_ENTRY;\r
\r
//\r
//  SAL Common Record Header\r
//\r
typedef struct {\r
  UINT16  Length;\r
  UINT8   Data[1024];\r
} SAL_OEM_DATA;\r
\r
typedef struct {\r
  UINT8 Seconds;\r
  UINT8 Minutes;\r
  UINT8 Hours;\r
  UINT8 Reserved;\r
  UINT8 Day;\r
  UINT8 Month;\r
  UINT8 Year;\r
  UINT8 Century;\r
} SAL_TIME_STAMP;\r
\r
typedef struct {\r
  UINT64          RecordId;\r
  UINT16          Revision;\r
  UINT8           ErrorSeverity;\r
  UINT8           ValidationBits;\r
  UINT32          RecordLength;\r
  SAL_TIME_STAMP  TimeStamp;\r
  UINT8           OemPlatformId[16];\r
} SAL_RECORD_HEADER;\r
\r
typedef struct {\r
  GUID  		Guid;\r
  UINT16    Revision;\r
  UINT8     ErrorRecoveryInfo;\r
  UINT8     Reserved;\r
  UINT32    SectionLength;\r
} SAL_SEC_HEADER;\r
\r
//\r
// SAL Processor Record\r
//\r
#define SAL_PROCESSOR_ERROR_RECORD_INFO \\r
  { \\r
    0xe429faf1, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
  }\r
\r
#define CHECK_INFO_VALID_BIT_MASK   0x1\r
#define REQUESTOR_ID_VALID_BIT_MASK 0x2\r
#define RESPONDER_ID_VALID_BIT_MASK 0x4\r
#define TARGER_ID_VALID_BIT_MASK    0x8\r
#define PRECISE_IP_VALID_BIT_MASK   0x10\r
\r
typedef struct {\r
  UINT64  InfoValid : 1;\r
  UINT64  ReqValid : 1;\r
  UINT64  RespValid : 1;\r
  UINT64  TargetValid : 1;\r
  UINT64  IpValid : 1;\r
  UINT64  Reserved : 59;\r
  UINT64  Info;\r
  UINT64  Req;\r
  UINT64  Resp;\r
  UINT64  Target;\r
  UINT64  Ip;\r
} MOD_ERROR_INFO;\r
\r
typedef struct {\r
  UINT8 CpuidInfo[40];\r
  UINT8 Reserved;\r
} CPUID_INFO;\r
\r
typedef struct {\r
  UINT64  FrLow;\r
  UINT64  FrHigh;\r
} FR_STRUCT;\r
\r
#define MIN_STATE_VALID_BIT_MASK  0x1\r
#define BR_VALID_BIT_MASK         0x2\r
#define CR_VALID_BIT_MASK         0x4\r
#define AR_VALID_BIT_MASK         0x8\r
#define RR_VALID_BIT_MASK         0x10\r
#define FR_VALID_BIT_MASK         0x20\r
\r
typedef struct {\r
  UINT64    ValidFieldBits;\r
  UINT8     MinStateInfo[1024];\r
  UINT64    Br[8];\r
  UINT64    Cr[128];\r
  UINT64    Ar[128];\r
  UINT64    Rr[8];\r
  FR_STRUCT Fr[128];\r
} PSI_STATIC_STRUCT;\r
\r
#define PROC_ERROR_MAP_VALID_BIT_MASK       0x1\r
#define PROC_STATE_PARAMETER_VALID_BIT_MASK 0x2\r
#define PROC_CR_LID_VALID_BIT_MASK          0x4\r
#define PROC_STATIC_STRUCT_VALID_BIT_MASK   0x8\r
#define CPU_INFO_VALID_BIT_MASK             0x1000000\r
\r
typedef struct {\r
  SAL_SEC_HEADER    SectionHeader;\r
  UINT64            ValidationBits;\r
  UINT64            ProcErrorMap;\r
  UINT64            ProcStateParameter;\r
  UINT64            ProcCrLid;\r
  MOD_ERROR_INFO    CacheError[15];\r
  MOD_ERROR_INFO    TlbError[15];\r
  MOD_ERROR_INFO    BusError[15];\r
  MOD_ERROR_INFO    RegFileCheck[15];\r
  MOD_ERROR_INFO    MsCheck[15];\r
  CPUID_INFO        CpuInfo;\r
  PSI_STATIC_STRUCT PsiValidData;\r
} SAL_PROCESSOR_ERROR_RECORD;\r
\r
//\r
//  Sal Platform memory Error Record\r
//\r
#define SAL_MEMORY_ERROR_RECORD_INFO \\r
  { \\r
    0xe429faf2, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
  }\r
\r
#define MEMORY_ERROR_STATUS_VALID_BIT_MASK                0x1\r
#define MEMORY_PHYSICAL_ADDRESS_VALID_BIT_MASK            0x2\r
#define MEMORY_ADDR_BIT_MASK                              0x4\r
#define MEMORY_NODE_VALID_BIT_MASK                        0x8\r
#define MEMORY_CARD_VALID_BIT_MASK                        0x10\r
#define MEMORY_MODULE_VALID_BIT_MASK                      0x20\r
#define MEMORY_BANK_VALID_BIT_MASK                        0x40\r
#define MEMORY_DEVICE_VALID_BIT_MASK                      0x80\r
#define MEMORY_ROW_VALID_BIT_MASK                         0x100\r
#define MEMORY_COLUMN_VALID_BIT_MASK                      0x200\r
#define MEMORY_BIT_POSITION_VALID_BIT_MASK                0x400\r
#define MEMORY_PLATFORM_REQUESTOR_ID_VALID_BIT_MASK       0x800\r
#define MEMORY_PLATFORM_RESPONDER_ID_VALID_BIT_MASK       0x1000\r
#define MEMORY_PLATFORM_TARGET_VALID_BIT_MASK             0x2000\r
#define MEMORY_PLATFORM_BUS_SPECIFIC_DATA_VALID_BIT_MASK  0x4000\r
#define MEMORY_PLATFORM_OEM_ID_VALID_BIT_MASK             0x8000\r
#define MEMORY_PLATFORM_OEM_DATA_STRUCT_VALID_BIT_MASK    0x10000\r
\r
typedef struct {\r
  SAL_SEC_HEADER  SectionHeader;\r
  UINT64          ValidationBits;\r
  UINT64          MemErrorStatus;\r
  UINT64          MemPhysicalAddress;\r
  UINT64          MemPhysicalAddressMask;\r
  UINT16          MemNode;\r
  UINT16          MemCard;\r
  UINT16          MemModule;\r
  UINT16          MemBank;\r
  UINT16          MemDevice;\r
  UINT16          MemRow;\r
  UINT16          MemColumn;\r
  UINT16          MemBitPosition;\r
  UINT64          ModRequestorId;\r
  UINT64          ModResponderId;\r
  UINT64          ModTargetId;\r
  UINT64          BusSpecificData;\r
  UINT8           MemPlatformOemId[16];\r
} SAL_MEMORY_ERROR_RECORD;\r
\r
//\r
//  PCI BUS Errors\r
//\r
#define SAL_PCI_BUS_ERROR_RECORD_INFO \\r
  { \\r
    0xe429faf4, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
  }\r
\r
#define PCI_BUS_ERROR_STATUS_VALID_BIT_MASK     0x1\r
#define PCI_BUS_ERROR_TYPE_VALID_BIT_MASK       0x2\r
#define PCI_BUS_ID_VALID_BIT_MASK               0x4\r
#define PCI_BUS_ADDRESS_VALID_BIT_MASK          0x8\r
#define PCI_BUS_DATA_VALID_BIT_MASK             0x10\r
#define PCI_BUS_CMD_VALID_BIT_MASK              0x20\r
#define PCI_BUS_REQUESTOR_ID_VALID_BIT_MASK     0x40\r
#define PCI_BUS_RESPONDER_ID_VALID_BIT_MASK     0x80\r
#define PCI_BUS_TARGET_VALID_BIT_MASK           0x100\r
#define PCI_BUS_OEM_ID_VALID_BIT_MASK           0x200\r
#define PCI_BUS_OEM_DATA_STRUCT_VALID_BIT_MASK  0x400\r
\r
typedef struct {\r
  UINT8 BusNumber;\r
  UINT8 SegmentNumber;\r
} PCI_BUS_ID;\r
\r
typedef struct {\r
  SAL_SEC_HEADER  SectionHeader;\r
  UINT64          ValidationBits;\r
  UINT64          PciBusErrorStatus;\r
  UINT16          PciBusErrorType;\r
  PCI_BUS_ID      PciBusId;\r
  UINT32          Reserved;\r
  UINT64          PciBusAddress;\r
  UINT64          PciBusData;\r
  UINT64          PciBusCommand;\r
  UINT64          PciBusRequestorId;\r
  UINT64          PciBusResponderId;\r
  UINT64          PciBusTargetId;\r
  UINT8           PciBusOemId[16];\r
} SAL_PCI_BUS_ERROR_RECORD;\r
\r
//\r
//  PCI Component Errors\r
//\r
#define SAL_PCI_COMP_ERROR_RECORD_INFO \\r
  { \\r
    0xe429faf6, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
  }\r
\r
#define PCI_COMP_ERROR_STATUS_VALID_BIT_MASK    0x1\r
#define PCI_COMP_INFO_VALID_BIT_MASK            0x2\r
#define PCI_COMP_MEM_NUM_VALID_BIT_MASK         0x4\r
#define PCI_COMP_IO_NUM_VALID_BIT_MASK          0x8\r
#define PCI_COMP_REG_DATA_PAIR_VALID_BIT_MASK   0x10\r
#define PCI_COMP_OEM_DATA_STRUCT_VALID_BIT_MASK 0x20\r
\r
typedef struct {\r
  UINT16  VendorId;\r
  UINT16  DeviceId;\r
  UINT8   ClassCode[3];\r
  UINT8   FunctionNumber;\r
  UINT8   DeviceNumber;\r
  UINT8   BusNumber;\r
  UINT8   SegmentNumber;\r
  UINT8   Reserved[5];\r
} PCI_COMP_INFO;\r
\r
typedef struct {\r
  SAL_SEC_HEADER  SectionHeader;\r
  UINT64          ValidationBits;\r
  UINT64          PciComponentErrorStatus;\r
  PCI_COMP_INFO   PciComponentInfo;\r
  UINT32          PciComponentMemNum;\r
  UINT32          PciComponentIoNum;\r
  UINT8           PciBusOemId[16];\r
} SAL_PCI_COMPONENT_ERROR_RECORD;\r
\r
//\r
//  Sal Device Errors Info.\r
//\r
#define SAL_DEVICE_ERROR_RECORD_INFO \\r
  { \\r
    0xe429faf3, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
  }\r
\r
#define SEL_RECORD_ID_VALID_BIT_MASK      0x1;\r
#define SEL_RECORD_TYPE_VALID_BIT_MASK    0x2;\r
#define SEL_GENERATOR_ID_VALID_BIT_MASK   0x4;\r
#define SEL_EVM_REV_VALID_BIT_MASK        0x8;\r
#define SEL_SENSOR_TYPE_VALID_BIT_MASK    0x10;\r
#define SEL_SENSOR_NUM_VALID_BIT_MASK     0x20;\r
#define SEL_EVENT_DIR_TYPE_VALID_BIT_MASK 0x40;\r
#define SEL_EVENT_DATA1_VALID_BIT_MASK    0x80;\r
#define SEL_EVENT_DATA2_VALID_BIT_MASK    0x100;\r
#define SEL_EVENT_DATA3_VALID_BIT_MASK    0x200;\r
\r
typedef struct {\r
  SAL_SEC_HEADER  SectionHeader;\r
  UINT64          ValidationBits;\r
  UINT16          SelRecordId;\r
  UINT8           SelRecordType;\r
  UINT32          TimeStamp;\r
  UINT16          GeneratorId;\r
  UINT8           EvmRevision;\r
  UINT8           SensorType;\r
  UINT8           SensorNum;\r
  UINT8           EventDirType;\r
  UINT8           Data1;\r
  UINT8           Data2;\r
  UINT8           Data3;\r
} SAL_DEVICE_ERROR_RECORD;\r
\r
//\r
//  Sal SMBIOS Device Errors Info.\r
//\r
#define SAL_SMBIOS_ERROR_RECORD_INFO \\r
  { \\r
    0xe429faf5, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
  }\r
\r
#define SMBIOS_EVENT_TYPE_VALID_BIT_MASK  0x1\r
#define SMBIOS_LENGTH_VALID_BIT_MASK      0x2\r
#define SMBIOS_TIME_STAMP_VALID_BIT_MASK  0x4\r
#define SMBIOS_DATA_VALID_BIT_MASK        0x8\r
\r
typedef struct {\r
  SAL_SEC_HEADER  SectionHeader;\r
  UINT64          ValidationBits;\r
  UINT8           SmbiosEventType;\r
  UINT8           SmbiosLength;\r
  UINT8           SmbiosBcdTimeStamp[6];\r
} SAL_SMBIOS_DEVICE_ERROR_RECORD;\r
\r
//\r
//  Sal Platform Specific Errors Info.\r
//\r
#define SAL_PLATFORM_ERROR_RECORD_INFO \\r
  { \\r
    0xe429faf7, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
  }\r
\r
#define PLATFORM_ERROR_STATUS_VALID_BIT_MASK    0x1\r
#define PLATFORM_REQUESTOR_ID_VALID_BIT_MASK    0x2\r
#define PLATFORM_RESPONDER_ID_VALID_BIT_MASK    0x4\r
#define PLATFORM_TARGET_VALID_BIT_MASK          0x8\r
#define PLATFORM_SPECIFIC_DATA_VALID_BIT_MASK   0x10\r
#define PLATFORM_OEM_ID_VALID_BIT_MASK          0x20\r
#define PLATFORM_OEM_DATA_STRUCT_VALID_BIT_MASK 0x40\r
#define PLATFORM_OEM_DEVICE_PATH_VALID_BIT_MASK 0x80\r
\r
typedef struct {\r
  SAL_SEC_HEADER  SectionHeader;\r
  UINT64          ValidationBits;\r
  UINT64          PlatformErrorStatus;\r
  UINT64          PlatformRequestorId;\r
  UINT64          PlatformResponderId;\r
  UINT64          PlatformTargetId;\r
  UINT64          PlatformBusSpecificData;\r
  UINT8           OemComponentId[16];\r
} SAL_PLATFORM_SPECIFIC_ERROR_RECORD;\r
\r
//\r
// Union of all the possible Sal Record Types\r
//\r
typedef union {\r
  SAL_RECORD_HEADER                   *RecordHeader;\r
  SAL_PROCESSOR_ERROR_RECORD          *SalProcessorRecord;\r
  SAL_PCI_BUS_ERROR_RECORD            *SalPciBusRecord;\r
  SAL_PCI_COMPONENT_ERROR_RECORD      *SalPciComponentRecord;\r
  SAL_DEVICE_ERROR_RECORD             *ImpiRecord;\r
  SAL_SMBIOS_DEVICE_ERROR_RECORD      *SmbiosRecord;\r
  SAL_PLATFORM_SPECIFIC_ERROR_RECORD  *PlatformRecord;\r
  SAL_MEMORY_ERROR_RECORD             *MemoryRecord;\r
  UINT8                               *Raw;\r
} SAL_ERROR_RECORDS_POINTERS;\r
\r
#pragma pack()\r
\r
#endif\r
Commit	Line	Data
540dfc26	1	/** @file\r
	2	Main SAL API's defined in SAL 3.0 specification. \r
	3	\r
	4	Copyright (c) 2006, Intel Corporation \r
	5	All rights reserved. This program and the accompanying materials \r
	6	are licensed and made available under the terms and conditions of the BSD License \r
	7	which accompanies this distribution. The full text of the license may be found at \r
	8	http://opensource.org/licenses/bsd-license.php \r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	12	\r
540dfc26	13	**/\r
	14	\r
	15	#ifndef __SAL_API_H__\r
	16	#define __SAL_API_H__\r
	17	\r
	18	//\r
	19	// FIT Types \r
	20	// Table 2-2 of Intel Itanium Processor Family System Abstraction Layer Specification December 2003\r
	21	//\r
	22	#define EFI_SAL_FIT_FIT_HEADER_TYPE 0x00\r
	23	#define EFI_SAL_FIT_PAL_B_TYPE 0x01\r
	24	//\r
	25	// type from 0x02 to 0x0E is reserved.\r
	26	//\r
	27	#define EFI_SAL_FIT_PAL_A_TYPE 0x0F\r
	28	//\r
	29	// OEM-defined type range is from 0x10 to 0x7E. Here we defined the PEI_CORE type as 0x10\r
	30	//\r
	31	#define EFI_SAL_FIT_PEI_CORE_TYPE 0x10\r
	32	#define EFI_SAL_FIT_UNUSED_TYPE 0x7F\r
	33	\r
	34	//\r
	35	// EFI_SAL_STATUS \r
	36	//\r
	37	typedef UINTN EFI_SAL_STATUS;\r
	38	\r
	39	#define EFI_SAL_SUCCESS ((EFI_SAL_STATUS) 0)\r
	40	#define EFI_SAL_MORE_RECORDS ((EFI_SAL_STATUS) 3)\r
	41	#define EFI_SAL_NOT_IMPLEMENTED ((EFI_SAL_STATUS) - 1)\r
	42	#define EFI_SAL_INVALID_ARGUMENT ((EFI_SAL_STATUS) - 2)\r
	43	#define EFI_SAL_ERROR ((EFI_SAL_STATUS) - 3)\r
	44	#define EFI_SAL_VIRTUAL_ADDRESS_ERROR ((EFI_SAL_STATUS) - 4)\r
	45	#define EFI_SAL_NO_INFORMATION ((EFI_SAL_STATUS) - 5)\r
	46	#define EFI_SAL_NOT_ENOUGH_SCRATCH ((EFI_SAL_STATUS) - 9)\r
	47	\r
	48	//\r
	49	// Return values from SAL\r
	50	//\r
	51	typedef struct {\r
	52	EFI_SAL_STATUS Status; // register r8\r
	53	UINTN r9;\r
	54	UINTN r10;\r
	55	UINTN r11;\r
	56	} SAL_RETURN_REGS;\r
	57	\r
	58	//\r
	59	// Delivery Mode of IPF CPU.\r
	60	//\r
	61	typedef enum {\r
	62	EFI_DELIVERY_MODE_INT,\r
	63	EFI_DELIVERY_MODE_MPreserved1,\r
	64	EFI_DELIVERY_MODE_PMI,\r
	65	EFI_DELIVERY_MODE_MPreserved2,\r
	66	EFI_DELIVERY_MODE_NMI,\r
	67	EFI_DELIVERY_MODE_INIT,\r
	68	EFI_DELIVERY_MODE_MPreserved3,\r
	69	EFI_DELIVERY_MODE_ExtINT\r
	70	} EFI_DELIVERY_MODE;\r
	71	\r
	72	typedef SAL_RETURN_REGS (EFIAPI *SAL_PROC)\r
	73	(\r
	74	IN UINT64 FunctionId,\r
	75	IN UINT64 Arg2,\r
	76	IN UINT64 Arg3,\r
77	IN UINT64 Arg4,\r
78	IN UINT64 Arg5,\r
79	IN UINT64 Arg6,\r
80	IN UINT64 Arg7,\r
81	IN UINT64 Arg8\r
82	);\r
83	\r
84	//\r
85	// SAL Procedure FunctionId definition\r
86	//\r
87	#define EFI_SAL_SET_VECTORS 0x01000000\r
88	#define EFI_SAL_GET_STATE_INFO 0x01000001\r
89	#define EFI_SAL_GET_STATE_INFO_SIZE 0x01000002\r
90	#define EFI_SAL_CLEAR_STATE_INFO 0x01000003\r
91	#define EFI_SAL_MC_RENDEZ 0x01000004\r
92	#define EFI_SAL_MC_SET_PARAMS 0x01000005\r
93	#define EFI_SAL_REGISTER_PHYSICAL_ADDR 0x01000006\r
94	#define EFI_SAL_CACHE_FLUSH 0x01000008\r
95	#define EFI_SAL_CACHE_INIT 0x01000009\r
96	#define EFI_SAL_PCI_CONFIG_READ 0x01000010\r
97	#define EFI_SAL_PCI_CONFIG_WRITE 0x01000011\r
98	#define EFI_SAL_FREQ_BASE 0x01000012\r
99	#define EFI_SAL_UPDATE_PAL 0x01000020\r
100	\r
101	#define EFI_SAL_FUNCTION_ID_MASK 0x0000ffff\r
102	#define EFI_SAL_MAX_SAL_FUNCTION_ID 0x00000021\r
103	\r
104	//\r
105	// SAL Procedure parameter definitions\r
106	// Not much point in using typedefs or enums because all params\r
107	// are UINT64 and the entry point is common\r
108	//\r
109	// EFI_SAL_SET_VECTORS\r
110	//\r
111	#define EFI_SAL_SET_MCA_VECTOR 0x0\r
112	#define EFI_SAL_SET_INIT_VECTOR 0x1\r
113	#define EFI_SAL_SET_BOOT_RENDEZ_VECTOR 0x2\r
114	\r
115	typedef struct {\r
116	UINT64 Length : 32;\r
117	UINT64 ChecksumValid : 1;\r
118	UINT64 Reserved1 : 7;\r
119	UINT64 ByteChecksum : 8;\r
120	UINT64 Reserved2 : 16;\r
121	} SAL_SET_VECTORS_CS_N;\r
122	\r
123	//\r
124	// EFI_SAL_GET_STATE_INFO, EFI_SAL_GET_STATE_INFO_SIZE,\r
125	// EFI_SAL_CLEAR_STATE_INFO\r
126	//\r
127	#define EFI_SAL_MCA_STATE_INFO 0x0\r
128	#define EFI_SAL_INIT_STATE_INFO 0x1\r
129	#define EFI_SAL_CMC_STATE_INFO 0x2\r
130	#define EFI_SAL_CP_STATE_INFO 0x3\r
131	\r
132	//\r
133	// EFI_SAL_MC_SET_PARAMS\r
134	//\r
135	#define EFI_SAL_MC_SET_RENDEZ_PARAM 0x1\r
136	#define EFI_SAL_MC_SET_WAKEUP_PARAM 0x2\r
137	#define EFI_SAL_MC_SET_CPE_PARAM 0x3\r
138	\r
139	#define EFI_SAL_MC_SET_INTR_PARAM 0x1\r
140	#define EFI_SAL_MC_SET_MEM_PARAM 0x2\r
141	\r
142	//\r
143	// EFI_SAL_REGISTER_PAL_PHYSICAL_ADDR\r
144	//\r
145	#define EFI_SAL_REGISTER_PAL_ADDR 0x0\r
146	\r
147	//\r
148	// EFI_SAL_CACHE_FLUSH\r
149	//\r
150	#define EFI_SAL_FLUSH_I_CACHE 0x01\r
151	#define EFI_SAL_FLUSH_D_CACHE 0x02\r
152	#define EFI_SAL_FLUSH_BOTH_CACHE 0x03\r
153	#define EFI_SAL_FLUSH_MAKE_COHERENT 0x04\r
154	\r
155	//\r
156	// EFI_SAL_PCI_CONFIG_READ, EFI_SAL_PCI_CONFIG_WRITE\r
157	//\r
158	#define EFI_SAL_PCI_CONFIG_ONE_BYTE 0x1\r
159	#define EFI_SAL_PCI_CONFIG_TWO_BYTES 0x2\r
160	#define EFI_SAL_PCI_CONFIG_FOUR_BYTES 0x4\r
161	\r
162	typedef struct {\r
163	UINT64 Register : 8;\r
164	UINT64 Function : 3;\r
165	UINT64 Device : 5;\r
166	UINT64 Bus : 8;\r
167	UINT64 Segment : 8;\r
168	UINT64 Reserved : 32;\r
169	} SAL_PCI_ADDRESS;\r
170	\r
171	//\r
172	// EFI_SAL_FREQ_BASE\r
173	//\r
174	#define EFI_SAL_CPU_INPUT_FREQ_BASE 0x0\r
175	#define EFI_SAL_PLATFORM_IT_FREQ_BASE 0x1\r
176	#define EFI_SAL_PLATFORM_RTC_FREQ_BASE 0x2\r
177	\r
178	//\r
179	// EFI_SAL_UPDATE_PAL\r
180	//\r
181	#define EFI_SAL_UPDATE_BAD_PAL_VERSION ((UINT64) -1)\r
182	#define EFI_SAL_UPDATE_PAL_AUTH_FAIL ((UINT64) -2)\r
183	#define EFI_SAL_UPDATE_PAL_BAD_TYPE ((UINT64) -3)\r
184	#define EFI_SAL_UPDATE_PAL_READONLY ((UINT64) -4)\r
185	#define EFI_SAL_UPDATE_PAL_WRITE_FAIL ((UINT64) -10)\r
186	#define EFI_SAL_UPDATE_PAL_ERASE_FAIL ((UINT64) -11)\r
187	#define EFI_SAL_UPDATE_PAL_READ_FAIL ((UINT64) -12)\r
188	#define EFI_SAL_UPDATE_PAL_CANT_FIT ((UINT64) -13)\r
189	\r
190	typedef struct {\r
191	UINT32 Size;\r
192	UINT32 MmddyyyyDate;\r
193	UINT16 Version;\r
194	UINT8 Type;\r
195	UINT8 Reserved[5];\r
196	UINT64 FwVendorId;\r
197	} SAL_UPDATE_PAL_DATA_BLOCK;\r
198	\r
199	typedef struct _SAL_UPDATE_PAL_INFO_BLOCK {\r
200	struct _SAL_UPDATE_PAL_INFO_BLOCK *Next;\r
201	struct SAL_UPDATE_PAL_DATA_BLOCK *DataBlock;\r
202	UINT8 StoreChecksum;\r
203	UINT8 Reserved[15];\r
204	} SAL_UPDATE_PAL_INFO_BLOCK;\r
205	\r
206	//\r
207	// SAL System Table Definitions\r
208	//\r
209	#pragma pack(1)\r
210	typedef struct {\r
211	UINT32 Signature;\r
212	UINT32 Length;\r
213	UINT16 SalRevision;\r
214	UINT16 EntryCount;\r
215	UINT8 CheckSum;\r
216	UINT8 Reserved[7];\r
217	UINT16 SalAVersion;\r
218	UINT16 SalBVersion;\r
219	UINT8 OemId[32];\r
220	UINT8 ProductId[32];\r
221	UINT8 Reserved2[8];\r
222	} SAL_SYSTEM_TABLE_HEADER;\r
223	#pragma pack()\r
224	\r
225	#define EFI_SAL_ST_HEADER_SIGNATURE "SST_"\r
226	#define EFI_SAL_REVISION 0x0300\r
227	//\r
228	// SAL System Types\r
229	//\r
230	#define EFI_SAL_ST_ENTRY_POINT 0\r
231	#define EFI_SAL_ST_MEMORY_DESCRIPTOR 1\r
232	#define EFI_SAL_ST_PLATFORM_FEATURES 2\r
233	#define EFI_SAL_ST_TR_USAGE 3\r
234	#define EFI_SAL_ST_PTC 4\r
235	#define EFI_SAL_ST_AP_WAKEUP 5\r
236	\r
237	#pragma pack(1)\r
238	typedef struct {\r
239	UINT8 Type; // Type == 0\r
240	UINT8 Reserved[7];\r
241	UINT64 PalProcEntry;\r
242	UINT64 SalProcEntry;\r
243	UINT64 SalGlobalDataPointer;\r
244	UINT64 Reserved2[2];\r
245	} SAL_ST_ENTRY_POINT_DESCRIPTOR;\r
246	\r
247	//\r
248	// Not needed for Itanium-based OS boot\r
249	//\r
250	typedef struct {\r
251	UINT8 Type; // Type == 1\r
252	UINT8 NeedVirtualRegistration;\r
253	UINT8 MemoryAttributes;\r
254	UINT8 PageAccessRights;\r
255	UINT8 SupportedAttributes;\r
256	UINT8 Reserved;\r
257	UINT8 MemoryType;\r
258	UINT8 MemoryUsage;\r
259	UINT64 PhysicalMemoryAddress;\r
260	UINT32 Length;\r
261	UINT32 Reserved1;\r
262	UINT64 OemReserved;\r
263	} SAL_ST_MEMORY_DESCRIPTOR_ENTRY;\r
264	\r
265	#pragma pack()\r
266	//\r
267	// Memory Attributes\r
268	//\r
269	#define SAL_MDT_ATTRIB_WB 0x00\r
270	//\r
271	// #define SAL_MDT_ATTRIB_UC 0x02\r
272	//\r
273	#define SAL_MDT_ATTRIB_UC 0x04\r
274	#define SAL_MDT_ATTRIB_UCE 0x05\r
275	#define SAL_MDT_ATTRIB_WC 0x06\r
276	\r
277	//\r
278	// Supported memory Attributes\r
279	//\r
280	#define SAL_MDT_SUPPORT_WB 0x1\r
281	#define SAL_MDT_SUPPORT_UC 0x2\r
282	#define SAL_MDT_SUPPORT_UCE 0x4\r
283	#define SAL_MDT_SUPPORT_WC 0x8\r
284	\r
285	//\r
286	// Virtual address registration\r
287	//\r
288	#define SAL_MDT_NO_VA 0x00\r
289	#define SAL_MDT_NEED_VA 0x01\r
290	//\r
291	// MemoryType info\r
292	//\r
293	#define SAL_REGULAR_MEMORY 0x0000\r
294	#define SAL_MMIO_MAPPING 0x0001\r
295	#define SAL_SAPIC_IPI_BLOCK 0x0002\r
296	#define SAL_IO_PORT_MAPPING 0x0003\r
297	#define SAL_FIRMWARE_MEMORY 0x0004\r
298	#define SAL_BLACK_HOLE 0x000A\r
299	//\r
300	// Memory Usage info\r
301	//\r
302	#define SAL_MDT_USAGE_UNSPECIFIED 0x00\r
303	#define SAL_PAL_CODE 0x01\r
304	#define SAL_BOOTSERVICE_CODE 0x02\r
305	#define SAL_BOOTSERVICE_DATA 0x03\r
306	#define SAL_RUNTIMESERVICE_CODE 0x04\r
307	#define SAL_RUNTIMESERVICE_DATA 0x05\r
308	#define SAL_IA32_OPTIONROM 0x06\r
309	#define SAL_IA32_SYSTEMROM 0x07\r
310	#define SAL_PMI_CODE 0x0a\r
311	#define SAL_PMI_DATA 0x0b\r
312	\r
313	#pragma pack(1)\r
314	typedef struct {\r
315	UINT8 Type; // Type == 2\r
316	UINT8 PlatformFeatures;\r
317	UINT8 Reserved[14];\r
318	} SAL_ST_PLATFORM_FEATURES;\r
319	#pragma pack()\r
320	\r
321	#define SAL_PLAT_FEAT_BUS_LOCK 0x01\r
322	#define SAL_PLAT_FEAT_PLAT_IPI_HINT 0x02\r
323	#define SAL_PLAT_FEAT_PROC_IPI_HINT 0x04\r
324	\r
325	#pragma pack(1)\r
326	typedef struct {\r
327	UINT8 Type; // Type == 3\r
328	UINT8 TRType;\r
329	UINT8 TRNumber;\r
330	UINT8 Reserved[5];\r
331	UINT64 VirtualAddress;\r
332	UINT64 EncodedPageSize;\r
333	UINT64 Reserved1;\r
334	} SAL_ST_TR_DECRIPTOR;\r
335	#pragma pack()\r
336	\r
337	#define EFI_SAL_ST_TR_USAGE_INSTRUCTION 00\r
338	#define EFI_SAL_ST_TR_USAGE_DATA 01\r
339	\r
340	#pragma pack(1)\r
341	typedef struct {\r
342	UINT64 NumberOfProcessors;\r
343	UINT64 LocalIDRegister;\r
344	} SAL_COHERENCE_DOMAIN_INFO;\r
345	#pragma pack()\r
346	\r
347	#pragma pack(1)\r
348	typedef struct {\r
349	UINT8 Type; // Type == 4\r
350	UINT8 Reserved[3];\r
351	UINT32 NumberOfDomains;\r
352	SAL_COHERENCE_DOMAIN_INFO *DomainInformation;\r
353	} SAL_ST_CACHE_COHERENCE_DECRIPTOR;\r
354	#pragma pack()\r
355	\r
356	#pragma pack(1)\r
357	typedef struct {\r
358	UINT8 Type; // Type == 5\r
359	UINT8 WakeUpType;\r
360	UINT8 Reserved[6];\r
361	UINT64 ExternalInterruptVector;\r
362	} SAL_ST_AP_WAKEUP_DECRIPTOR;\r
363	#pragma pack()\r
364	//\r
365	// FIT Entry\r
366	//\r
367	#define EFI_SAL_FIT_ENTRY_PTR (0x100000000 - 32) // 4GB - 24\r
368	#define EFI_SAL_FIT_PALA_ENTRY (0x100000000 - 48) // 4GB - 32\r
369	#define EFI_SAL_FIT_PALB_TYPE 01\r
370	\r
371	typedef struct {\r
372	UINT64 Address;\r
373	UINT8 Size[3];\r
374	UINT8 Reserved;\r
375	UINT16 Revision;\r
376	UINT8 Type : 7;\r
377	UINT8 CheckSumValid : 1;\r
378	UINT8 CheckSum;\r
379	} EFI_SAL_FIT_ENTRY;\r
380	\r
381	//\r
382	// SAL Common Record Header\r
383	//\r
384	typedef struct {\r
385	UINT16 Length;\r
386	UINT8 Data[1024];\r
387	} SAL_OEM_DATA;\r
388	\r
389	typedef struct {\r
390	UINT8 Seconds;\r
391	UINT8 Minutes;\r
392	UINT8 Hours;\r
393	UINT8 Reserved;\r
394	UINT8 Day;\r
395	UINT8 Month;\r
396	UINT8 Year;\r
397	UINT8 Century;\r
398	} SAL_TIME_STAMP;\r
399	\r
400	typedef struct {\r
401	UINT64 RecordId;\r
402	UINT16 Revision;\r
403	UINT8 ErrorSeverity;\r
404	UINT8 ValidationBits;\r
405	UINT32 RecordLength;\r
406	SAL_TIME_STAMP TimeStamp;\r
407	UINT8 OemPlatformId[16];\r
408	} SAL_RECORD_HEADER;\r
409	\r
410	typedef struct {\r
411	GUID Guid;\r
412	UINT16 Revision;\r
413	UINT8 ErrorRecoveryInfo;\r
414	UINT8 Reserved;\r
415	UINT32 SectionLength;\r
416	} SAL_SEC_HEADER;\r
417	\r
418	//\r
419	// SAL Processor Record\r
420	//\r
421	#define SAL_PROCESSOR_ERROR_RECORD_INFO \\r
422	{ \\r
423	0xe429faf1, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
424	}\r
425	\r
426	#define CHECK_INFO_VALID_BIT_MASK 0x1\r
427	#define REQUESTOR_ID_VALID_BIT_MASK 0x2\r
428	#define RESPONDER_ID_VALID_BIT_MASK 0x4\r
429	#define TARGER_ID_VALID_BIT_MASK 0x8\r
430	#define PRECISE_IP_VALID_BIT_MASK 0x10\r
431	\r
432	typedef struct {\r
433	UINT64 InfoValid : 1;\r
434	UINT64 ReqValid : 1;\r
435	UINT64 RespValid : 1;\r
436	UINT64 TargetValid : 1;\r
437	UINT64 IpValid : 1;\r
438	UINT64 Reserved : 59;\r
439	UINT64 Info;\r
440	UINT64 Req;\r
441	UINT64 Resp;\r
442	UINT64 Target;\r
443	UINT64 Ip;\r
444	} MOD_ERROR_INFO;\r
445	\r
446	typedef struct {\r
447	UINT8 CpuidInfo[40];\r
448	UINT8 Reserved;\r
449	} CPUID_INFO;\r
450	\r
451	typedef struct {\r
452	UINT64 FrLow;\r
453	UINT64 FrHigh;\r
454	} FR_STRUCT;\r
455	\r
456	#define MIN_STATE_VALID_BIT_MASK 0x1\r
457	#define BR_VALID_BIT_MASK 0x2\r
458	#define CR_VALID_BIT_MASK 0x4\r
459	#define AR_VALID_BIT_MASK 0x8\r
460	#define RR_VALID_BIT_MASK 0x10\r
461	#define FR_VALID_BIT_MASK 0x20\r
462	\r
463	typedef struct {\r
464	UINT64 ValidFieldBits;\r
465	UINT8 MinStateInfo[1024];\r
466	UINT64 Br[8];\r
467	UINT64 Cr[128];\r
468	UINT64 Ar[128];\r
469	UINT64 Rr[8];\r
470	FR_STRUCT Fr[128];\r
471	} PSI_STATIC_STRUCT;\r
472	\r
473	#define PROC_ERROR_MAP_VALID_BIT_MASK 0x1\r
474	#define PROC_STATE_PARAMETER_VALID_BIT_MASK 0x2\r
475	#define PROC_CR_LID_VALID_BIT_MASK 0x4\r
476	#define PROC_STATIC_STRUCT_VALID_BIT_MASK 0x8\r
477	#define CPU_INFO_VALID_BIT_MASK 0x1000000\r
478	\r
479	typedef struct {\r
480	SAL_SEC_HEADER SectionHeader;\r
481	UINT64 ValidationBits;\r
482	UINT64 ProcErrorMap;\r
483	UINT64 ProcStateParameter;\r
484	UINT64 ProcCrLid;\r
485	MOD_ERROR_INFO CacheError[15];\r
486	MOD_ERROR_INFO TlbError[15];\r
487	MOD_ERROR_INFO BusError[15];\r
488	MOD_ERROR_INFO RegFileCheck[15];\r
489	MOD_ERROR_INFO MsCheck[15];\r
490	CPUID_INFO CpuInfo;\r
491	PSI_STATIC_STRUCT PsiValidData;\r
492	} SAL_PROCESSOR_ERROR_RECORD;\r
493	\r
494	//\r
495	// Sal Platform memory Error Record\r
496	//\r
497	#define SAL_MEMORY_ERROR_RECORD_INFO \\r
498	{ \\r
499	0xe429faf2, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
500	}\r
501	\r
502	#define MEMORY_ERROR_STATUS_VALID_BIT_MASK 0x1\r
503	#define MEMORY_PHYSICAL_ADDRESS_VALID_BIT_MASK 0x2\r
504	#define MEMORY_ADDR_BIT_MASK 0x4\r
505	#define MEMORY_NODE_VALID_BIT_MASK 0x8\r
506	#define MEMORY_CARD_VALID_BIT_MASK 0x10\r
507	#define MEMORY_MODULE_VALID_BIT_MASK 0x20\r
508	#define MEMORY_BANK_VALID_BIT_MASK 0x40\r
509	#define MEMORY_DEVICE_VALID_BIT_MASK 0x80\r
510	#define MEMORY_ROW_VALID_BIT_MASK 0x100\r
511	#define MEMORY_COLUMN_VALID_BIT_MASK 0x200\r
512	#define MEMORY_BIT_POSITION_VALID_BIT_MASK 0x400\r
513	#define MEMORY_PLATFORM_REQUESTOR_ID_VALID_BIT_MASK 0x800\r
514	#define MEMORY_PLATFORM_RESPONDER_ID_VALID_BIT_MASK 0x1000\r
515	#define MEMORY_PLATFORM_TARGET_VALID_BIT_MASK 0x2000\r
516	#define MEMORY_PLATFORM_BUS_SPECIFIC_DATA_VALID_BIT_MASK 0x4000\r
517	#define MEMORY_PLATFORM_OEM_ID_VALID_BIT_MASK 0x8000\r
518	#define MEMORY_PLATFORM_OEM_DATA_STRUCT_VALID_BIT_MASK 0x10000\r
519	\r
520	typedef struct {\r
521	SAL_SEC_HEADER SectionHeader;\r
522	UINT64 ValidationBits;\r
523	UINT64 MemErrorStatus;\r
524	UINT64 MemPhysicalAddress;\r
525	UINT64 MemPhysicalAddressMask;\r
526	UINT16 MemNode;\r
527	UINT16 MemCard;\r
528	UINT16 MemModule;\r
529	UINT16 MemBank;\r
530	UINT16 MemDevice;\r
531	UINT16 MemRow;\r
532	UINT16 MemColumn;\r
533	UINT16 MemBitPosition;\r
534	UINT64 ModRequestorId;\r
535	UINT64 ModResponderId;\r
536	UINT64 ModTargetId;\r
537	UINT64 BusSpecificData;\r
538	UINT8 MemPlatformOemId[16];\r
539	} SAL_MEMORY_ERROR_RECORD;\r
540	\r
541	//\r
542	// PCI BUS Errors\r
543	//\r
544	#define SAL_PCI_BUS_ERROR_RECORD_INFO \\r
545	{ \\r
546	0xe429faf4, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
547	}\r
548	\r
549	#define PCI_BUS_ERROR_STATUS_VALID_BIT_MASK 0x1\r
550	#define PCI_BUS_ERROR_TYPE_VALID_BIT_MASK 0x2\r
551	#define PCI_BUS_ID_VALID_BIT_MASK 0x4\r
552	#define PCI_BUS_ADDRESS_VALID_BIT_MASK 0x8\r
553	#define PCI_BUS_DATA_VALID_BIT_MASK 0x10\r
554	#define PCI_BUS_CMD_VALID_BIT_MASK 0x20\r
555	#define PCI_BUS_REQUESTOR_ID_VALID_BIT_MASK 0x40\r
556	#define PCI_BUS_RESPONDER_ID_VALID_BIT_MASK 0x80\r
557	#define PCI_BUS_TARGET_VALID_BIT_MASK 0x100\r
558	#define PCI_BUS_OEM_ID_VALID_BIT_MASK 0x200\r
559	#define PCI_BUS_OEM_DATA_STRUCT_VALID_BIT_MASK 0x400\r
560	\r
561	typedef struct {\r
562	UINT8 BusNumber;\r
563	UINT8 SegmentNumber;\r
564	} PCI_BUS_ID;\r
565	\r
566	typedef struct {\r
567	SAL_SEC_HEADER SectionHeader;\r
568	UINT64 ValidationBits;\r
569	UINT64 PciBusErrorStatus;\r
570	UINT16 PciBusErrorType;\r
571	PCI_BUS_ID PciBusId;\r
572	UINT32 Reserved;\r
573	UINT64 PciBusAddress;\r
574	UINT64 PciBusData;\r
575	UINT64 PciBusCommand;\r
576	UINT64 PciBusRequestorId;\r
577	UINT64 PciBusResponderId;\r
578	UINT64 PciBusTargetId;\r
579	UINT8 PciBusOemId[16];\r
580	} SAL_PCI_BUS_ERROR_RECORD;\r
581	\r
582	//\r
583	// PCI Component Errors\r
584	//\r
585	#define SAL_PCI_COMP_ERROR_RECORD_INFO \\r
586	{ \\r
587	0xe429faf6, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
588	}\r
589	\r
590	#define PCI_COMP_ERROR_STATUS_VALID_BIT_MASK 0x1\r
591	#define PCI_COMP_INFO_VALID_BIT_MASK 0x2\r
592	#define PCI_COMP_MEM_NUM_VALID_BIT_MASK 0x4\r
593	#define PCI_COMP_IO_NUM_VALID_BIT_MASK 0x8\r
594	#define PCI_COMP_REG_DATA_PAIR_VALID_BIT_MASK 0x10\r
595	#define PCI_COMP_OEM_DATA_STRUCT_VALID_BIT_MASK 0x20\r
596	\r
597	typedef struct {\r
598	UINT16 VendorId;\r
599	UINT16 DeviceId;\r
600	UINT8 ClassCode[3];\r
601	UINT8 FunctionNumber;\r
602	UINT8 DeviceNumber;\r
603	UINT8 BusNumber;\r
604	UINT8 SegmentNumber;\r
605	UINT8 Reserved[5];\r
606	} PCI_COMP_INFO;\r
607	\r
608	typedef struct {\r
609	SAL_SEC_HEADER SectionHeader;\r
610	UINT64 ValidationBits;\r
611	UINT64 PciComponentErrorStatus;\r
612	PCI_COMP_INFO PciComponentInfo;\r
613	UINT32 PciComponentMemNum;\r
614	UINT32 PciComponentIoNum;\r
615	UINT8 PciBusOemId[16];\r
616	} SAL_PCI_COMPONENT_ERROR_RECORD;\r
617	\r
618	//\r
619	// Sal Device Errors Info.\r
620	//\r
621	#define SAL_DEVICE_ERROR_RECORD_INFO \\r
622	{ \\r
623	0xe429faf3, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
624	}\r
625	\r
626	#define SEL_RECORD_ID_VALID_BIT_MASK 0x1;\r
627	#define SEL_RECORD_TYPE_VALID_BIT_MASK 0x2;\r
628	#define SEL_GENERATOR_ID_VALID_BIT_MASK 0x4;\r
629	#define SEL_EVM_REV_VALID_BIT_MASK 0x8;\r
630	#define SEL_SENSOR_TYPE_VALID_BIT_MASK 0x10;\r
631	#define SEL_SENSOR_NUM_VALID_BIT_MASK 0x20;\r
632	#define SEL_EVENT_DIR_TYPE_VALID_BIT_MASK 0x40;\r
633	#define SEL_EVENT_DATA1_VALID_BIT_MASK 0x80;\r
634	#define SEL_EVENT_DATA2_VALID_BIT_MASK 0x100;\r
635	#define SEL_EVENT_DATA3_VALID_BIT_MASK 0x200;\r
636	\r
637	typedef struct {\r
638	SAL_SEC_HEADER SectionHeader;\r
639	UINT64 ValidationBits;\r
640	UINT16 SelRecordId;\r
641	UINT8 SelRecordType;\r
642	UINT32 TimeStamp;\r
643	UINT16 GeneratorId;\r
644	UINT8 EvmRevision;\r
645	UINT8 SensorType;\r
646	UINT8 SensorNum;\r
647	UINT8 EventDirType;\r
648	UINT8 Data1;\r
649	UINT8 Data2;\r
650	UINT8 Data3;\r
651	} SAL_DEVICE_ERROR_RECORD;\r
652	\r
653	//\r
654	// Sal SMBIOS Device Errors Info.\r
655	//\r
656	#define SAL_SMBIOS_ERROR_RECORD_INFO \\r
657	{ \\r
658	0xe429faf5, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
659	}\r
660	\r
661	#define SMBIOS_EVENT_TYPE_VALID_BIT_MASK 0x1\r
662	#define SMBIOS_LENGTH_VALID_BIT_MASK 0x2\r
663	#define SMBIOS_TIME_STAMP_VALID_BIT_MASK 0x4\r
664	#define SMBIOS_DATA_VALID_BIT_MASK 0x8\r
665	\r
666	typedef struct {\r
667	SAL_SEC_HEADER SectionHeader;\r
668	UINT64 ValidationBits;\r
669	UINT8 SmbiosEventType;\r
670	UINT8 SmbiosLength;\r
671	UINT8 SmbiosBcdTimeStamp[6];\r
672	} SAL_SMBIOS_DEVICE_ERROR_RECORD;\r
673	\r
674	//\r
675	// Sal Platform Specific Errors Info.\r
676	//\r
677	#define SAL_PLATFORM_ERROR_RECORD_INFO \\r
678	{ \\r
679	0xe429faf7, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
680	}\r
681	\r
682	#define PLATFORM_ERROR_STATUS_VALID_BIT_MASK 0x1\r
683	#define PLATFORM_REQUESTOR_ID_VALID_BIT_MASK 0x2\r
684	#define PLATFORM_RESPONDER_ID_VALID_BIT_MASK 0x4\r
685	#define PLATFORM_TARGET_VALID_BIT_MASK 0x8\r
686	#define PLATFORM_SPECIFIC_DATA_VALID_BIT_MASK 0x10\r
687	#define PLATFORM_OEM_ID_VALID_BIT_MASK 0x20\r
688	#define PLATFORM_OEM_DATA_STRUCT_VALID_BIT_MASK 0x40\r
689	#define PLATFORM_OEM_DEVICE_PATH_VALID_BIT_MASK 0x80\r
690	\r
691	typedef struct {\r
692	SAL_SEC_HEADER SectionHeader;\r
693	UINT64 ValidationBits;\r
694	UINT64 PlatformErrorStatus;\r
695	UINT64 PlatformRequestorId;\r
696	UINT64 PlatformResponderId;\r
697	UINT64 PlatformTargetId;\r
698	UINT64 PlatformBusSpecificData;\r
699	UINT8 OemComponentId[16];\r
700	} SAL_PLATFORM_SPECIFIC_ERROR_RECORD;\r
701	\r
702	//\r
703	// Union of all the possible Sal Record Types\r
704	//\r
705	typedef union {\r
706	SAL_RECORD_HEADER *RecordHeader;\r
707	SAL_PROCESSOR_ERROR_RECORD *SalProcessorRecord;\r
708	SAL_PCI_BUS_ERROR_RECORD *SalPciBusRecord;\r
709	SAL_PCI_COMPONENT_ERROR_RECORD *SalPciComponentRecord;\r
710	SAL_DEVICE_ERROR_RECORD *ImpiRecord;\r
711	SAL_SMBIOS_DEVICE_ERROR_RECORD *SmbiosRecord;\r
712	SAL_PLATFORM_SPECIFIC_ERROR_RECORD *PlatformRecord;\r
713	SAL_MEMORY_ERROR_RECORD *MemoryRecord;\r
714	UINT8 *Raw;\r
715	} SAL_ERROR_RECORDS_POINTERS;\r
716	\r
717	#pragma pack()\r
718	\r
719	#endif\r