MdePkg/Include/IndustryStandard/Sal.h

   1 /** @file
   2   Main SAL API's defined in Intel Itanium Processor Family System Abstraction
   3   Layer Specification Revision 3.2 (December 2003)
   4
   5   Copyright (c) 2006 - 2008, Intel Corporation
   6   All rights reserved. This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __SAL_API_H__
  17 #define __SAL_API_H__
  18
  19 ///
  20 /// SAL return status type
  21 ///
  22 typedef UINTN EFI_SAL_STATUS;
  23
  24 ///
  25 /// Call completed without error.
  26 ///
  27 #define EFI_SAL_SUCCESS               ((EFI_SAL_STATUS) 0)
  28 ///
  29 /// Call completed without error but some information was lost due to overflow.
  30 ///
  31 #define EFI_SAL_OVERFLOW              ((EFI_SAL_STATUS) 1)
  32 ///
  33 /// Call completed without error; effect a warm boot of the system to complete the update.
  34 ///
  35 #define EFI_SAL_WARM_BOOT_NEEDED      ((EFI_SAL_STATUS) 2)
  36 ///
  37 /// More information is available for retrieval.
  38 ///
  39 #define EFI_SAL_MORE_RECORDS          ((EFI_SAL_STATUS) 3)
  40 ///
  41 /// Not implemented.
  42 ///
  43 #define EFI_SAL_NOT_IMPLEMENTED       ((EFI_SAL_STATUS) - 1)
  44 ///
  45 /// Invalid Argument.
  46 ///
  47 #define EFI_SAL_INVALID_ARGUMENT      ((EFI_SAL_STATUS) - 2)
  48 ///
  49 /// Call completed without error.
  50 ///
  51 #define EFI_SAL_ERROR                 ((EFI_SAL_STATUS) - 3)
  52 ///
  53 /// Virtual address not registered.
  54 ///
  55 #define EFI_SAL_VIRTUAL_ADDRESS_ERROR ((EFI_SAL_STATUS) - 4)
  56 ///
  57 /// No information available.
  58 ///
  59 #define EFI_SAL_NO_INFORMATION        ((EFI_SAL_STATUS) - 5)
  60 ///
  61 /// Scratch buffer required.
  62 ///
  63 #define EFI_SAL_NOT_ENOUGH_SCRATCH    ((EFI_SAL_STATUS) - 9)
  64
  65 ///
  66 /// Return registers from SAL
  67 ///
  68 typedef struct {
  69   ///
  70   /// SAL return status value in r8
  71   ///
  72   EFI_SAL_STATUS  Status;
  73   ///
  74   /// SAL returned value in r9
  75   ///
  76   UINTN           r9;
  77   ///
  78   /// SAL returned value in r10
  79   ///
  80   UINTN           r10;
  81   ///
  82   /// SAL returned value in r11
  83   ///
  84   UINTN           r11;
  85 } SAL_RETURN_REGS;
  86
  87 /**
  88   Prototype of SAL procedures.
  89
  90   @param  Arg0               Functional identifier.
  91                              The upper 32 bits are ignored and only the lower 32 bits
  92                              are used. The following functional identifiers are defined:
  93                              0x01XXXXXX - Architected SAL functional group.
  94                              0x02XXXXXX to 0x03XXXXXX - OEM SAL functional group. Each OEM is
  95                              allowed to use the entire range in the 0x02XXXXXX to 0x03XXXXXX range.
  96                              0x04XXXXXX to 0xFFFFFFFF - Reserved.
  97   @param  Arg1               The first parameter of the architected/OEM specific SAL functions.
  98   @param  Arg2               The second parameter of the architected/OEM specific SAL functions.
  99   @param  Arg3               The third parameter passed to the ESAL function based
 100   @param  Arg4               The fourth parameter passed to the ESAL function based
 101   @param  Arg5               The fifth parameter passed to the ESAL function based
 102   @param  Arg6               The sixth parameter passed to the ESAL function
 103   @param  Arg7               The seventh parameter passed to the ESAL function based
 104
 105   @return r8                 Return status: positive number indicates successful,
 106                              negative number indicates failure.
 107           r9                 Other return parameter in r9.
 108           r10                Other return parameter in r10.
 109           r11                Other return parameter in r11.
 110
 111 **/
 112 typedef
 113 SAL_RETURN_REGS
 114 (EFIAPI *SAL_PROC) (
 115   IN UINT64 FunctionId,
 116   IN UINT64 Arg2,
 117   IN UINT64 Arg3,
 118   IN UINT64 Arg4,
 119   IN UINT64 Arg5,
 120   IN UINT64 Arg6,
 121   IN UINT64 Arg7,
 122   IN UINT64 Arg8
 123   );
 124
 125 //
 126 // SAL Procedure FunctionId definition
 127 //
 128
 129 ///
 130 /// Register software code locations with SAL.
 131 ///
 132 #define EFI_SAL_SET_VECTORS             0x01000000
 133 ///
 134 /// Return Machine State information obtained by SAL.
 135 ///
 136 #define EFI_SAL_GET_STATE_INFO          0x01000001
 137 ///
 138 /// Obtain size of Machine State information.
 139 ///
 140 #define EFI_SAL_GET_STATE_INFO_SIZE     0x01000002
 141 ///
 142 /// Clear Machine State information.
 143 ///
 144 #define EFI_SAL_CLEAR_STATE_INFO        0x01000003
 145 ///
 146 /// Cause the processor to go into a spin loop within SAL.
 147 ///
 148 #define EFI_SAL_MC_RENDEZ               0x01000004
 149 ///
 150 /// Register the machine check interface layer with SAL.
 151 ///
 152 #define EFI_SAL_MC_SET_PARAMS           0x01000005
 153 ///
 154 /// Register the physical addresses of locations needed by SAL.
 155 ///
 156 #define EFI_SAL_REGISTER_PHYSICAL_ADDR  0x01000006
 157 ///
 158 /// Flush the instruction or data caches.
 159 ///
 160 #define EFI_SAL_CACHE_FLUSH             0x01000008
 161 ///
 162 /// Initialize the instruction and data caches.
 163 ///
 164 #define EFI_SAL_CACHE_INIT              0x01000009
 165 ///
 166 /// Read from the PCI configuration space.
 167 ///
 168 #define EFI_SAL_PCI_CONFIG_READ         0x01000010
 169 ///
 170 /// Write to the PCI configuration space.
 171 ///
 172 #define EFI_SAL_PCI_CONFIG_WRITE        0x01000011
 173 ///
 174 /// Return the base frequency of the platform.
 175 ///
 176 #define EFI_SAL_FREQ_BASE               0x01000012
 177 ///
 178 /// Returns information on the physical processor mapping within the platform.
 179 ///
 180 #define EFI_SAL_PHYSICAL_ID_INFO        0x01000013
 181 ///
 182 /// Update the contents of firmware blocks.
 183 ///
 184 #define EFI_SAL_UPDATE_PAL              0x01000020
 185
 186 #define EFI_SAL_FUNCTION_ID_MASK        0x0000ffff
 187 #define EFI_SAL_MAX_SAL_FUNCTION_ID     0x00000021
 188
 189 //
 190 // SAL Procedure parameter definitions
 191 // Not much point in using typedefs or enums because all params
 192 // are UINT64 and the entry point is common
 193 //
 194
 195 //
 196 // Parameter of EFI_SAL_SET_VECTORS
 197 //
 198 // Vector type
 199 //
 200 #define EFI_SAL_SET_MCA_VECTOR          0x0
 201 #define EFI_SAL_SET_INIT_VECTOR         0x1
 202 #define EFI_SAL_SET_BOOT_RENDEZ_VECTOR  0x2
 203 ///
 204 /// Format of length_cs_n argument.
 205 ///
 206 typedef struct {
 207   UINT64  Length : 32;
 208   UINT64  ChecksumValid : 1;
 209   UINT64  Reserved1 : 7;
 210   UINT64  ByteChecksum : 8;
 211   UINT64  Reserved2 : 16;
 212 } SAL_SET_VECTORS_CS_N;
 213
 214 //
 215 // Parameter of EFI_SAL_GET_STATE_INFO, EFI_SAL_GET_STATE_INFO_SIZE, and EFI_SAL_CLEAR_STATE_INFO
 216 //
 217 // Type of information
 218 //
 219 #define EFI_SAL_MCA_STATE_INFO  0x0
 220 #define EFI_SAL_INIT_STATE_INFO 0x1
 221 #define EFI_SAL_CMC_STATE_INFO  0x2
 222 #define EFI_SAL_CP_STATE_INFO   0x3
 223
 224 //
 225 // Parameter of EFI_SAL_MC_SET_PARAMS
 226 //
 227 // Unsigned 64-bit integer value for the parameter type of the machine check interface
 228 //
 229 #define EFI_SAL_MC_SET_RENDEZ_PARAM 0x1
 230 #define EFI_SAL_MC_SET_WAKEUP_PARAM 0x2
 231 #define EFI_SAL_MC_SET_CPE_PARAM    0x3
 232 //
 233 // Unsigned 64-bit integer value indicating whether interrupt vector or
 234 // memory address is specified
 235 //
 236 #define EFI_SAL_MC_SET_INTR_PARAM   0x1
 237 #define EFI_SAL_MC_SET_MEM_PARAM    0x2
 238
 239 //
 240 // Parameter of EFI_SAL_REGISTER_PAL_PHYSICAL_ADDR
 241 //
 242 // The encoded value of the entity whose physical address is registered
 243 //
 244 #define EFI_SAL_REGISTER_PAL_ADDR 0x0
 245
 246 //
 247 // Parameter of EFI_SAL_CACHE_FLUSH
 248 //
 249 // Unsigned 64-bit integer denoting type of cache flush operation
 250 //
 251 #define EFI_SAL_FLUSH_I_CACHE       0x01
 252 #define EFI_SAL_FLUSH_D_CACHE       0x02
 253 #define EFI_SAL_FLUSH_BOTH_CACHE    0x03
 254 #define EFI_SAL_FLUSH_MAKE_COHERENT 0x04
 255
 256 //
 257 // Parameter of EFI_SAL_PCI_CONFIG_READ and EFI_SAL_PCI_CONFIG_WRITE
 258 //
 259 // PCI config size
 260 //
 261 #define EFI_SAL_PCI_CONFIG_ONE_BYTE   0x1
 262 #define EFI_SAL_PCI_CONFIG_TWO_BYTES  0x2
 263 #define EFI_SAL_PCI_CONFIG_FOUR_BYTES 0x4
 264 //
 265 // The type of PCI configuration address
 266 //
 267 #define EFI_SAL_PCI_COMPATIBLE_ADDRESS         0x0
 268 #define EFI_SAL_PCI_EXTENDED_REGISTER_ADDRESS  0x1
 269 ///
 270 /// Format of PCI Compatible Address
 271 ///
 272 typedef struct {
 273   UINT64  Register : 8;
 274   UINT64  Function : 3;
 275   UINT64  Device : 5;
 276   UINT64  Bus : 8;
 277   UINT64  Segment : 8;
 278   UINT64  Reserved : 32;
 279 } SAL_PCI_ADDRESS;
 280 ///
 281 /// Format of Extended Register Address
 282 ///
 283 typedef struct {
 284   UINT64  Register : 8;
 285   UINT64  ExtendedRegister : 4;
 286   UINT64  Function : 3;
 287   UINT64  Device : 5;
 288   UINT64  Bus : 8;
 289   UINT64  Segment : 16;
 290   UINT64  Reserved : 20;
 291 } SAL_PCI_EXTENDED_REGISTER_ADDRESS;
 292
 293 //
 294 // Parameter of EFI_SAL_FREQ_BASE
 295 //
 296 // Unsigned 64-bit integer specifying the type of clock source
 297 //
 298 #define EFI_SAL_CPU_INPUT_FREQ_BASE     0x0
 299 #define EFI_SAL_PLATFORM_IT_FREQ_BASE   0x1
 300 #define EFI_SAL_PLATFORM_RTC_FREQ_BASE  0x2
 301
 302 //
 303 // Parameter and return value of EFI_SAL_UPDATE_PAL
 304 //
 305 // Return parameter provides additional information on the
 306 // failure when the status field contains a value of -3,
 307 // returned in r9.
 308 //
 309 #define EFI_SAL_UPDATE_BAD_PAL_VERSION  ((UINT64) -1)
 310 #define EFI_SAL_UPDATE_PAL_AUTH_FAIL    ((UINT64) -2)
 311 #define EFI_SAL_UPDATE_PAL_BAD_TYPE     ((UINT64) -3)
 312 #define EFI_SAL_UPDATE_PAL_READONLY     ((UINT64) -4)
 313 #define EFI_SAL_UPDATE_PAL_WRITE_FAIL   ((UINT64) -10)
 314 #define EFI_SAL_UPDATE_PAL_ERASE_FAIL   ((UINT64) -11)
 315 #define EFI_SAL_UPDATE_PAL_READ_FAIL    ((UINT64) -12)
 316 #define EFI_SAL_UPDATE_PAL_CANT_FIT     ((UINT64) -13)
 317 ///
 318 /// 64-byte header of update data block.
 319 ///
 320 typedef struct {
 321   UINT32  Size;
 322   UINT32  MmddyyyyDate;
 323   UINT16  Version;
 324   UINT8   Type;
 325   UINT8   Reserved[5];
 326   UINT64  FwVendorId;
 327 } SAL_UPDATE_PAL_DATA_BLOCK;
 328 ///
 329 /// Data structure pointed by parameter param_buf.
 330 /// It is a 16-byte aligned data structure in memory with a length of 32 bytes
 331 /// that describes the new firmware. This information is organized in the form
 332 /// of a linked list with each element describing one firmware component.
 333 ///
 334 typedef struct _SAL_UPDATE_PAL_INFO_BLOCK {
 335   struct _SAL_UPDATE_PAL_INFO_BLOCK *Next;
 336   struct SAL_UPDATE_PAL_DATA_BLOCK  *DataBlock;
 337   UINT8                             StoreChecksum;
 338   UINT8                             Reserved[15];
 339 } SAL_UPDATE_PAL_INFO_BLOCK;
 340
 341 ///
 342 /// SAL System Table Definitions
 343 ///
 344 typedef struct {
 345   ///
 346   /// The ASCII string representation of "SST_" which confirms the presence of the table.
 347   ///
 348   UINT32  Signature;
 349   ///
 350   /// The length of the entire table in bytes, starting from offset zero and including the
 351   /// header and all entries indicated by the EntryCount field.
 352   ///
 353   UINT32  Length;
 354   ///
 355   /// The revision number of the Itanium Processor Family System Abstraction Layer
 356   /// Specification supported by the SAL implementation in binary coded decimal (BCD) format.
 357   ///
 358   UINT16  SalRevision;
 359   ///
 360   /// The number of entries in the variable portion of the table.
 361   ///
 362   UINT16  EntryCount;
 363   ///
 364   /// A modulo checksum of the entire table and the entries following this table.
 365   ///
 366   UINT8   CheckSum;
 367   ///
 368   /// Unused, must be zero.
 369   ///
 370   UINT8   Reserved[7];
 371   ///
 372   /// Version Number of the SAL_A firmware implementation in BCD format.
 373   ///
 374   UINT16  SalAVersion;
 375   ///
 376   /// Version Number of the SAL_B firmware implementation in BCD format.
 377   ///
 378   UINT16  SalBVersion;
 379   ///
 380   /// An ASCII identification string which uniquely identifies the manufacturer
 381   /// of the system hardware.
 382   ///
 383   UINT8   OemId[32];
 384   ///
 385   /// An ASCII identification string which uniquely identifies a family of
 386   /// compatible products from the manufacturer.
 387   ///
 388   UINT8   ProductId[32];
 389   ///
 390   /// Unused, must be zero.
 391   ///
 392   UINT8   Reserved2[8];
 393 } SAL_SYSTEM_TABLE_HEADER;
 394
 395 #define EFI_SAL_ST_HEADER_SIGNATURE "SST_"
 396 #define EFI_SAL_REVISION            0x0320
 397 //
 398 // SAL System Types
 399 //
 400 #define EFI_SAL_ST_ENTRY_POINT        0
 401 #define EFI_SAL_ST_MEMORY_DESCRIPTOR  1
 402 #define EFI_SAL_ST_PLATFORM_FEATURES  2
 403 #define EFI_SAL_ST_TR_USAGE           3
 404 #define EFI_SAL_ST_PTC                4
 405 #define EFI_SAL_ST_AP_WAKEUP          5
 406
 407 //
 408 // SAL System Type Sizes
 409 //
 410 #define EFI_SAL_ST_ENTRY_POINT_SIZE        48
 411 #define EFI_SAL_ST_MEMORY_DESCRIPTOR_SIZE  32
 412 #define EFI_SAL_ST_PLATFORM_FEATURES_SIZE  16
 413 #define EFI_SAL_ST_TR_USAGE_SIZE           32
 414 #define EFI_SAL_ST_PTC_SIZE                16
 415 #define EFI_SAL_ST_AP_WAKEUP_SIZE          16
 416
 417 ///
 418 /// Format Entrypoint Descriptor Entry
 419 ///
 420 typedef struct {
 421   UINT8   Type;         ///< Type here should be 0
 422   UINT8   Reserved[7];
 423   UINT64  PalProcEntry;
 424   UINT64  SalProcEntry;
 425   UINT64  SalGlobalDataPointer;
 426   UINT64  Reserved2[2];
 427 } SAL_ST_ENTRY_POINT_DESCRIPTOR;
 428
 429 ///
 430 /// Format Platform Features Descriptor Entry
 431 ///
 432 typedef struct {
 433   UINT8 Type;           ///< Type here should be 2
 434   UINT8 PlatformFeatures;
 435   UINT8 Reserved[14];
 436 } SAL_ST_PLATFORM_FEATURES;
 437
 438 //
 439 // Value of Platform Feature List
 440 //
 441 #define SAL_PLAT_FEAT_BUS_LOCK      0x01
 442 #define SAL_PLAT_FEAT_PLAT_IPI_HINT 0x02
 443 #define SAL_PLAT_FEAT_PROC_IPI_HINT 0x04
 444
 445 ///
 446 /// Format of Translation Register Descriptor Entry
 447 ///
 448 typedef struct {
 449   UINT8   Type;         ///< Type here should be 3
 450   UINT8   TRType;
 451   UINT8   TRNumber;
 452   UINT8   Reserved[5];
 453   UINT64  VirtualAddress;
 454   UINT64  EncodedPageSize;
 455   UINT64  Reserved1;
 456 } SAL_ST_TR_DECRIPTOR;
 457
 458 //
 459 // Type of Translation Register
 460 //
 461 #define EFI_SAL_ST_TR_USAGE_INSTRUCTION 00
 462 #define EFI_SAL_ST_TR_USAGE_DATA        01
 463
 464 ///
 465 /// Definition of Coherence Domain Information
 466 ///
 467 typedef struct {
 468   UINT64  NumberOfProcessors;
 469   UINT64  LocalIDRegister;
 470 } SAL_COHERENCE_DOMAIN_INFO;
 471
 472 ///
 473 /// Format of Purge Translation Cache Coherence Domain Entry
 474 ///
 475 typedef struct {
 476   UINT8                     Type;       ///< Type here should be 4
 477   UINT8                     Reserved[3];
 478   UINT32                    NumberOfDomains;
 479   SAL_COHERENCE_DOMAIN_INFO *DomainInformation;
 480 } SAL_ST_CACHE_COHERENCE_DECRIPTOR;
 481
 482 ///
 483 /// Format of Application Processor Wake-Up Descriptor Entry
 484 ///
 485 typedef struct {
 486   UINT8   Type;                   ///< Type here should be 5
 487   UINT8   WakeUpType;
 488   UINT8   Reserved[6];
 489   UINT64  ExternalInterruptVector;
 490 } SAL_ST_AP_WAKEUP_DECRIPTOR;
 491
 492 ///
 493 /// Format of Firmware Interface Table (FIT) Entry
 494 ///
 495 typedef struct {
 496   UINT64  Address;
 497   UINT8   Size[3];
 498   UINT8   Reserved;
 499   UINT16  Revision;
 500   UINT8   Type : 7;
 501   UINT8   CheckSumValid : 1;
 502   UINT8   CheckSum;
 503 } EFI_SAL_FIT_ENTRY;
 504 //
 505 // FIT Types
 506 //
 507 #define EFI_SAL_FIT_FIT_HEADER_TYPE                0x00
 508 #define EFI_SAL_FIT_PAL_B_TYPE                     0x01
 509 //
 510 // Type from 0x02 to 0x0D is reserved.
 511 //
 512 #define EFI_SAL_FIT_PROCESSOR_SPECIFIC_PAL_A_TYPE  0x0E
 513 #define EFI_SAL_FIT_PAL_A_TYPE                     0x0F
 514 //
 515 // OEM-defined type range is from 0x10 to 0x7E.
 516 // Here we defined the PEI_CORE type as 0x10
 517 //
 518 #define EFI_SAL_FIT_PEI_CORE_TYPE                  0x10
 519 #define EFI_SAL_FIT_UNUSED_TYPE                    0x7F
 520
 521 //
 522 // FIT Entry
 523 //
 524 #define EFI_SAL_FIT_ENTRY_PTR   (0x100000000 - 32)  // 4GB - 24
 525 #define EFI_SAL_FIT_PALA_ENTRY  (0x100000000 - 48)  // 4GB - 32
 526 #define EFI_SAL_FIT_PALB_TYPE   01
 527
 528 //
 529 // Following definitions are for Error Record Structure
 530 //
 531
 532 ///
 533 /// Format of TimeStamp field in Record Header
 534 ///
 535 typedef struct {
 536   UINT8 Seconds;
 537   UINT8 Minutes;
 538   UINT8 Hours;
 539   UINT8 Reserved;
 540   UINT8 Day;
 541   UINT8 Month;
 542   UINT8 Year;
 543   UINT8 Century;
 544 } SAL_TIME_STAMP;
 545 ///
 546 /// Definition of Record Header
 547 ///
 548 typedef struct {
 549   UINT64          RecordId;
 550   UINT16          Revision;
 551   UINT8           ErrorSeverity;
 552   UINT8           ValidationBits;
 553   UINT32          RecordLength;
 554   SAL_TIME_STAMP  TimeStamp;
 555   UINT8           OemPlatformId[16];
 556 } SAL_RECORD_HEADER;
 557 ///
 558 /// Definition of Section Header
 559 ///
 560 typedef struct {
 561   GUID      Guid;
 562   UINT16    Revision;
 563   UINT8     ErrorRecoveryInfo;
 564   UINT8     Reserved;
 565   UINT32    SectionLength;
 566 } SAL_SEC_HEADER;
 567
 568 ///
 569 /// GUID of Processor Machine Check Errors
 570 ///
 571 #define SAL_PROCESSOR_ERROR_RECORD_INFO \
 572   { \
 573     0xe429faf1, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
 574   }
 575 //
 576 // Bit masks for valid bits of MOD_ERROR_INFO
 577 //
 578 #define CHECK_INFO_VALID_BIT_MASK   0x1
 579 #define REQUESTOR_ID_VALID_BIT_MASK 0x2
 580 #define RESPONDER_ID_VALID_BIT_MASK 0x4
 581 #define TARGER_ID_VALID_BIT_MASK    0x8
 582 #define PRECISE_IP_VALID_BIT_MASK   0x10
 583 ///
 584 /// Definition of MOD_ERROR_INFO_STRUCT
 585 ///
 586 typedef struct {
 587   UINT64  InfoValid : 1;
 588   UINT64  ReqValid : 1;
 589   UINT64  RespValid : 1;
 590   UINT64  TargetValid : 1;
 591   UINT64  IpValid : 1;
 592   UINT64  Reserved : 59;
 593   UINT64  Info;
 594   UINT64  Req;
 595   UINT64  Resp;
 596   UINT64  Target;
 597   UINT64  Ip;
 598 } MOD_ERROR_INFO;
 599 ///
 600 /// Definition of CPUID_INFO_STRUCT
 601 ///
 602 typedef struct {
 603   UINT8 CpuidInfo[40];
 604   UINT8 Reserved;
 605 } CPUID_INFO;
 606
 607 typedef struct {
 608   UINT64  FrLow;
 609   UINT64  FrHigh;
 610 } FR_STRUCT;
 611 //
 612 // Bit masks for PSI_STATIC_STRUCT.ValidFieldBits
 613 //
 614 #define MIN_STATE_VALID_BIT_MASK  0x1
 615 #define BR_VALID_BIT_MASK         0x2
 616 #define CR_VALID_BIT_MASK         0x4
 617 #define AR_VALID_BIT_MASK         0x8
 618 #define RR_VALID_BIT_MASK         0x10
 619 #define FR_VALID_BIT_MASK         0x20
 620 ///
 621 /// Definition of PSI_STATIC_STRUCT
 622 ///
 623 typedef struct {
 624   UINT64    ValidFieldBits;
 625   UINT8     MinStateInfo[1024];
 626   UINT64    Br[8];
 627   UINT64    Cr[128];
 628   UINT64    Ar[128];
 629   UINT64    Rr[8];
 630   FR_STRUCT Fr[128];
 631 } PSI_STATIC_STRUCT;
 632 //
 633 // Bit masks for SAL_PROCESSOR_ERROR_RECORD.ValidationBits
 634 //
 635 #define PROC_ERROR_MAP_VALID_BIT_MASK       0x1
 636 #define PROC_STATE_PARAMETER_VALID_BIT_MASK 0x2
 637 #define PROC_CR_LID_VALID_BIT_MASK          0x4
 638 #define PROC_STATIC_STRUCT_VALID_BIT_MASK   0x8
 639 #define CPU_INFO_VALID_BIT_MASK             0x1000000
 640
 641 #pragma pack(1)
 642
 643 ///
 644 /// Definition of Processor Machine Check Error Record
 645 ///
 646 typedef struct {
 647   SAL_SEC_HEADER    SectionHeader;
 648   UINT64            ValidationBits;
 649   UINT64            ProcErrorMap;
 650   UINT64            ProcStateParameter;
 651   UINT64            ProcCrLid;
 652   MOD_ERROR_INFO    CacheError[15];
 653   MOD_ERROR_INFO    TlbError[15];
 654   MOD_ERROR_INFO    BusError[15];
 655   MOD_ERROR_INFO    RegFileCheck[15];
 656   MOD_ERROR_INFO    MsCheck[15];
 657   CPUID_INFO        CpuInfo;
 658   PSI_STATIC_STRUCT PsiValidData;
 659 } SAL_PROCESSOR_ERROR_RECORD;
 660
 661 #pragma pack()
 662
 663 ///
 664 /// GUID of Platform Memory Device Error Info
 665 ///
 666 #define SAL_MEMORY_ERROR_RECORD_INFO \
 667   { \
 668     0xe429faf2, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
 669   }
 670 //
 671 // Bit masks for SAL_MEMORY_ERROR_RECORD.ValidationBits
 672 //
 673 #define MEMORY_ERROR_STATUS_VALID_BIT_MASK                0x1
 674 #define MEMORY_PHYSICAL_ADDRESS_VALID_BIT_MASK            0x2
 675 #define MEMORY_ADDR_BIT_MASK                              0x4
 676 #define MEMORY_NODE_VALID_BIT_MASK                        0x8
 677 #define MEMORY_CARD_VALID_BIT_MASK                        0x10
 678 #define MEMORY_MODULE_VALID_BIT_MASK                      0x20
 679 #define MEMORY_BANK_VALID_BIT_MASK                        0x40
 680 #define MEMORY_DEVICE_VALID_BIT_MASK                      0x80
 681 #define MEMORY_ROW_VALID_BIT_MASK                         0x100
 682 #define MEMORY_COLUMN_VALID_BIT_MASK                      0x200
 683 #define MEMORY_BIT_POSITION_VALID_BIT_MASK                0x400
 684 #define MEMORY_PLATFORM_REQUESTOR_ID_VALID_BIT_MASK       0x800
 685 #define MEMORY_PLATFORM_RESPONDER_ID_VALID_BIT_MASK       0x1000
 686 #define MEMORY_PLATFORM_TARGET_VALID_BIT_MASK             0x2000
 687 #define MEMORY_PLATFORM_BUS_SPECIFIC_DATA_VALID_BIT_MASK  0x4000
 688 #define MEMORY_PLATFORM_OEM_ID_VALID_BIT_MASK             0x8000
 689 #define MEMORY_PLATFORM_OEM_DATA_STRUCT_VALID_BIT_MASK    0x10000
 690 ///
 691 /// Definition of Platform Memory Device Error Info Record
 692 ///
 693 typedef struct {
 694   SAL_SEC_HEADER  SectionHeader;
 695   UINT64          ValidationBits;
 696   UINT64          MemErrorStatus;
 697   UINT64          MemPhysicalAddress;
 698   UINT64          MemPhysicalAddressMask;
 699   UINT16          MemNode;
 700   UINT16          MemCard;
 701   UINT16          MemModule;
 702   UINT16          MemBank;
 703   UINT16          MemDevice;
 704   UINT16          MemRow;
 705   UINT16          MemColumn;
 706   UINT16          MemBitPosition;
 707   UINT64          ModRequestorId;
 708   UINT64          ModResponderId;
 709   UINT64          ModTargetId;
 710   UINT64          BusSpecificData;
 711   UINT8           MemPlatformOemId[16];
 712 } SAL_MEMORY_ERROR_RECORD;
 713
 714 ///
 715 /// GUID of Platform PCI Bus Error Info
 716 ///
 717 #define SAL_PCI_BUS_ERROR_RECORD_INFO \
 718   { \
 719     0xe429faf4, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
 720   }
 721 //
 722 // Bit masks for SAL_PCI_BUS_ERROR_RECORD.ValidationBits
 723 //
 724 #define PCI_BUS_ERROR_STATUS_VALID_BIT_MASK     0x1
 725 #define PCI_BUS_ERROR_TYPE_VALID_BIT_MASK       0x2
 726 #define PCI_BUS_ID_VALID_BIT_MASK               0x4
 727 #define PCI_BUS_ADDRESS_VALID_BIT_MASK          0x8
 728 #define PCI_BUS_DATA_VALID_BIT_MASK             0x10
 729 #define PCI_BUS_CMD_VALID_BIT_MASK              0x20
 730 #define PCI_BUS_REQUESTOR_ID_VALID_BIT_MASK     0x40
 731 #define PCI_BUS_RESPONDER_ID_VALID_BIT_MASK     0x80
 732 #define PCI_BUS_TARGET_VALID_BIT_MASK           0x100
 733 #define PCI_BUS_OEM_ID_VALID_BIT_MASK           0x200
 734 #define PCI_BUS_OEM_DATA_STRUCT_VALID_BIT_MASK  0x400
 735
 736 typedef struct {
 737   UINT8 BusNumber;
 738   UINT8 SegmentNumber;
 739 } PCI_BUS_ID;
 740 ///
 741 /// Definition of Platform PCI Bus Error Info Record
 742 ///
 743 typedef struct {
 744   SAL_SEC_HEADER  SectionHeader;
 745   UINT64          ValidationBits;
 746   UINT64          PciBusErrorStatus;
 747   UINT16          PciBusErrorType;
 748   PCI_BUS_ID      PciBusId;
 749   UINT32          Reserved;
 750   UINT64          PciBusAddress;
 751   UINT64          PciBusData;
 752   UINT64          PciBusCommand;
 753   UINT64          PciBusRequestorId;
 754   UINT64          PciBusResponderId;
 755   UINT64          PciBusTargetId;
 756   UINT8           PciBusOemId[16];
 757 } SAL_PCI_BUS_ERROR_RECORD;
 758
 759 ///
 760 /// GUID of Platform PCI Component Error Info
 761 ///
 762 #define SAL_PCI_COMP_ERROR_RECORD_INFO \
 763   { \
 764     0xe429faf6, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
 765   }
 766 //
 767 // Bit masks for SAL_PCI_COMPONENT_ERROR_RECORD.ValidationBits
 768 //
 769 #define PCI_COMP_ERROR_STATUS_VALID_BIT_MASK    0x1
 770 #define PCI_COMP_INFO_VALID_BIT_MASK            0x2
 771 #define PCI_COMP_MEM_NUM_VALID_BIT_MASK         0x4
 772 #define PCI_COMP_IO_NUM_VALID_BIT_MASK          0x8
 773 #define PCI_COMP_REG_DATA_PAIR_VALID_BIT_MASK   0x10
 774 #define PCI_COMP_OEM_DATA_STRUCT_VALID_BIT_MASK 0x20
 775 ///
 776 /// Format of PCI Component Information to identify the device
 777 ///
 778 typedef struct {
 779   UINT16  VendorId;
 780   UINT16  DeviceId;
 781   UINT8   ClassCode[3];
 782   UINT8   FunctionNumber;
 783   UINT8   DeviceNumber;
 784   UINT8   BusNumber;
 785   UINT8   SegmentNumber;
 786   UINT8   Reserved[5];
 787 } PCI_COMP_INFO;
 788
 789 ///
 790 /// Definition of Platform PCI Component Error Info
 791 ///
 792 typedef struct {
 793   SAL_SEC_HEADER  SectionHeader;
 794   UINT64          ValidationBits;
 795   UINT64          PciComponentErrorStatus;
 796   PCI_COMP_INFO   PciComponentInfo;
 797   UINT32          PciComponentMemNum;
 798   UINT32          PciComponentIoNum;
 799   UINT8           PciBusOemId[16];
 800 } SAL_PCI_COMPONENT_ERROR_RECORD;
 801
 802 ///
 803 /// Platform SEL Device Error Info
 804 ///
 805 #define SAL_SEL_DEVICE_ERROR_RECORD_INFO \
 806   { \
 807     0xe429faf3, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
 808   }
 809 //
 810 // Bit masks for SAL_SEL_DEVICE_ERROR_RECORD.ValidationBits
 811 //
 812 #define SEL_RECORD_ID_VALID_BIT_MASK      0x1;
 813 #define SEL_RECORD_TYPE_VALID_BIT_MASK    0x2;
 814 #define SEL_GENERATOR_ID_VALID_BIT_MASK   0x4;
 815 #define SEL_EVM_REV_VALID_BIT_MASK        0x8;
 816 #define SEL_SENSOR_TYPE_VALID_BIT_MASK    0x10;
 817 #define SEL_SENSOR_NUM_VALID_BIT_MASK     0x20;
 818 #define SEL_EVENT_DIR_TYPE_VALID_BIT_MASK 0x40;
 819 #define SEL_EVENT_DATA1_VALID_BIT_MASK    0x80;
 820 #define SEL_EVENT_DATA2_VALID_BIT_MASK    0x100;
 821 #define SEL_EVENT_DATA3_VALID_BIT_MASK    0x200;
 822
 823 #pragma pack(1)
 824 ///
 825 /// Definition of Platform SEL Device Error Info Record
 826 ///
 827 typedef struct {
 828   SAL_SEC_HEADER  SectionHeader;
 829   UINT64          ValidationBits;
 830   UINT16          SelRecordId;
 831   UINT8           SelRecordType;
 832   UINT32          TimeStamp;
 833   UINT16          GeneratorId;
 834   UINT8           EvmRevision;
 835   UINT8           SensorType;
 836   UINT8           SensorNum;
 837   UINT8           EventDirType;
 838   UINT8           Data1;
 839   UINT8           Data2;
 840   UINT8           Data3;
 841 } SAL_SEL_DEVICE_ERROR_RECORD;
 842 #pragma pack()
 843
 844 ///
 845 /// GUID of Platform SMBIOS Device Error Info
 846 ///
 847 #define SAL_SMBIOS_ERROR_RECORD_INFO \
 848   { \
 849     0xe429faf5, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
 850   }
 851 //
 852 // Bit masks for SAL_SMBIOS_DEVICE_ERROR_RECORD.ValidationBits
 853 //
 854 #define SMBIOS_EVENT_TYPE_VALID_BIT_MASK  0x1
 855 #define SMBIOS_LENGTH_VALID_BIT_MASK      0x2
 856 #define SMBIOS_TIME_STAMP_VALID_BIT_MASK  0x4
 857 #define SMBIOS_DATA_VALID_BIT_MASK        0x8
 858 ///
 859 /// Definition of Platform SMBIOS Device Error Info Record
 860 ///
 861 typedef struct {
 862   SAL_SEC_HEADER  SectionHeader;
 863   UINT64          ValidationBits;
 864   UINT8           SmbiosEventType;
 865   UINT8           SmbiosLength;
 866   UINT8           SmbiosBcdTimeStamp[6];
 867 } SAL_SMBIOS_DEVICE_ERROR_RECORD;
 868
 869 ///
 870 /// GUID of Platform Specific Error Info
 871 ///
 872 #define SAL_PLATFORM_ERROR_RECORD_INFO \
 873   { \
 874     0xe429faf7, 0x3cb7, 0x11d4, {0xbc, 0xa7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
 875   }
 876 //
 877 // Bit masks for SAL_PLATFORM_SPECIFIC_ERROR_RECORD.ValidationBits
 878 //
 879 #define PLATFORM_ERROR_STATUS_VALID_BIT_MASK    0x1
 880 #define PLATFORM_REQUESTOR_ID_VALID_BIT_MASK    0x2
 881 #define PLATFORM_RESPONDER_ID_VALID_BIT_MASK    0x4
 882 #define PLATFORM_TARGET_VALID_BIT_MASK          0x8
 883 #define PLATFORM_SPECIFIC_DATA_VALID_BIT_MASK   0x10
 884 #define PLATFORM_OEM_ID_VALID_BIT_MASK          0x20
 885 #define PLATFORM_OEM_DATA_STRUCT_VALID_BIT_MASK 0x40
 886 #define PLATFORM_OEM_DEVICE_PATH_VALID_BIT_MASK 0x80
 887 ///
 888 /// Definition of Platform Specific Error Info Record
 889 ///
 890 typedef struct {
 891   SAL_SEC_HEADER  SectionHeader;
 892   UINT64          ValidationBits;
 893   UINT64          PlatformErrorStatus;
 894   UINT64          PlatformRequestorId;
 895   UINT64          PlatformResponderId;
 896   UINT64          PlatformTargetId;
 897   UINT64          PlatformBusSpecificData;
 898   UINT8           OemComponentId[16];
 899 } SAL_PLATFORM_SPECIFIC_ERROR_RECORD;
 900
 901 ///
 902 /// Union of all the possible SAL Error Record Types
 903 ///
 904 typedef union {
 905   SAL_RECORD_HEADER                   *RecordHeader;
 906   SAL_PROCESSOR_ERROR_RECORD          *SalProcessorRecord;
 907   SAL_PCI_BUS_ERROR_RECORD            *SalPciBusRecord;
 908   SAL_PCI_COMPONENT_ERROR_RECORD      *SalPciComponentRecord;
 909   SAL_SEL_DEVICE_ERROR_RECORD         *ImpiRecord;
 910   SAL_SMBIOS_DEVICE_ERROR_RECORD      *SmbiosRecord;
 911   SAL_PLATFORM_SPECIFIC_ERROR_RECORD  *PlatformRecord;
 912   SAL_MEMORY_ERROR_RECORD             *MemoryRecord;
 913   UINT8                               *Raw;
 914 } SAL_ERROR_RECORDS_POINTERS;
 915
 916 #endif