Intel® MEI Commands for Accessing Intel® Platform Service Record (Intel® PSR) Information and State

More details on the usages of this interface can be found in the Platform Service Record sample (in the High-Level API kit) and the Platform Service Record Overview.

Intel® Platform Service Record (Intel®PSR) Intel® MEI Messages

Guid = ED6703FA-D312-4E8B-9DDD-2155BB2DEE65

The messages in this section are supported by the Intel Platform Service Record (Intel PSR) dynamic client.

Intel PSR messages are supported when the Intel PSR feature is supported by Intel CSME.

Information:

TxBufferSize = 0x2000
RxBufferSize = 0x2000
MaxClients = 1
ClientId = 4

PSR_HECI_GET_LOG_STATE

Description

Get Intel PSR log state.

Request

typedef struct
{
    PSR_HECI_HEADER                    Header;
}  PSR_HECI_GET_LOG_STATE_Request;

Response

typedef struct
{
    PSR_HECI_HEADER                    Header;
    PSR_STATUS                         Status;
    PSR_LOG_STATE                      psrLogState;
    PSR_AVAILABILITY                   psrAvailabilityStatus;
}  PSR_HECI_GET_LOG_STATE_Response;

PSR_HECI_PLATFORM_SERVICE_RECORD_GET

Description

Retrieve the signed Intel  PSR with all the logged information.

Request

typedef struct
{
    PSR_HECI_HEADER                    Header;
    UINT8[20]                          userNonce;
}  PSR_HECI_PLATFORM_SERVICE_RECORD_GET_Request;

Response

typedef struct
{
    PSR_HECI_HEADER                    Header;
    PSR_STATUS                         Status;
    PSR_LOG_STATE                      psrLogState;
    PSR_VERSION                        psrVersion;
    PSR_RECORD                         PlatformServiceRecord;
    UINT8[SHA_512_KEY_SIZE]            psrHash;
    UINT8[20]                          userNonce;
    UINT8[20]                          csmeNonce;
    FW_VERSION                         fwVersion;
    SIGNING_MECHANISM                  signingMechanism;
    UINT8[512]                         signature;
    UINT16[4]                          certificateLengths;
    UINT8[3000]                        certificates;
}  PSR_HECI_PLATFORM_SERVICE_RECORD_GET_Response;

PSR_HECI_HEADER

Description

Header for Intel PSR command.

Definition

typedef struct
{
    UINT8                              Command;
    UINT8                              Reserved;
    UINT16                             Length;
}  PSR_HECI_HEADER;

Field Description

PSR_STATUS

Definition

typedef enum
{
      PSR_STATUS_SUCCESS                       = 0,
      PSR_STATUS_FEATURE_NOT_SUPPORTED         = 1,
      PSR_STATUS_UPID_DISABLED                 = 2,
      PSR_STATUS_ACTION_NOT_ALLOWED            = 3,
      PSR_STATUS_INVALID_INPUT_PARAMETER       = 4,
      PSR_STATUS_INTERNAL_ERROR                = 5,
      PSR_STATUS_NOT_ALLOWED_AFTER_EOP         = 6,
}   PSR_STATUS;

Note: sizeof(enum) is sizeof(UINT32) = 4 bytes.

PSR_LOG_STATE

Definition

typedef enum
{
      PSR_LOG_STATE_NOT_STARTED                = 0,
      PSR_LOG_STATE_STARTED                    = 1,
      PSR_LOG_STATE_STOPPED                    = 2,
}   PSR_LOG_STATE;

Please note: sizeof(enum) is sizeof(UINT32) = 4 bytes.

Item Descriptions

PSR_AVAILABILITY

Definition

typedef enum
{
      PSR_IS_AVAILABLE                         = 0,
      UPID_IS_DISABLED                         = 1,
}   PSR_AVAILABILITY;

Please note: sizeof(enum) is sizeof(UINT32) = 4 bytes.

Item Descriptions

PSR_VERSION

Definition

typedef struct
{
    UINT16                             Major;
    UINT16                             Minor;
}  PSR_VERSION;

Description

Intel PSR protocol version

PSR_RECORD (Intel PSR 1.0)

Definition

typedef struct
{
    UINT8[16]                          PSRID;
    UINT8[64]                          UPID;
    UINT8[1284]                        genesisInfo;
    UINT8[64]                          ledgerInfo;
    UINT32                             eventCount;
    UINT8[1200]                        eventsInfo;
}  PSR_RECORD;

Description

Intel PSR log

Field Description

PSR_RECORD (Intel PSR 2.0)

Definition

typedef struct
{
    UINT8[16]                          PSRID;
    UINT8[64]                          UPID;
    UINT8[1284]                        genesisInfo;
    UINT8[32]                          capabilities;
    UINT8[64]                          ledgerInfo;
    UINT32                             eventCount;
    UINT8[1200]                        eventsInfo;
}  PSR_RECORD;

Description

Platform Service Record log

Field Description

genesisInfo

Array containing genesis information: genesis date and OEM information

capabilities

Array containing the PSR capability section

ledgerInfo

Array containing ledger information: counters with power states and power transition information.

32 counters, 4 bytes each

eventsinfo

Array containing critical events logged by the PSR.

Structure of eventsinfo:

Structure of each event:

FW_VERSION

Description

Firmware version.

Definition

typedef struct
{
    UINT16                             Major;
    UINT16                             Minor;
    UINT16                             Hotfix;
    UINT16                             Build;
}  FW_VERSION;

Field Description

SIGNING_MECHANISM

Definition

typedef enum
{
      ECDSA384_WITH_SHA384                     = 0,
}   SIGNING_MECHANISM;

Please note: sizeof(enum) is sizeof(UINT32) = 4 bytes.

Item Descriptions

SHA_512_KEY_SIZE

Definition

#define  SHA_512_KEY_SIZE                        64