XSem_Ssit_CmdGetConfig - 2023.2 English

Standalone Library Documentation: BSP and Libraries Document Collection (UG643)

Document ID
UG643
Release Date
2023-12-13
Version
2023.2 English

This function is used to read CRAM & NPI configuration. Primarily this function sends an IPI request to PLM to invoke SEM Get configuration command on targeted SLR , waits for PLM to process the request and reads the response message for a given SLR.

  • Resp->RespMsg2: CRAM Attribute register details
    • Bit [31:16]: Not Implemented
    • Bit [15:9]: Reserved
    • Bit [8]: Reserved
    • Bit [7]: Reserved
    • Bit [6:5]: Indicates when to start CRAM scan
      • 00: Do not automatically start scan
      • 01: Enable scan automatically after device configuration.
      • 10: Reserved
      • 11: Reserved
    • Bit [4]: Reserved
    • Bit [3]: Indicates HwECC/SwECC
      • 0: Uses hardware calculated ECC.
      • 1: Uses software calculated ECC that comes from tools and part of CDO
    • Bit [2]: Indicates Correctable error is to be corrected/not
      • 0: Disables error correction capability
      • 1: Enables error correction capability
    • Bit [1:0]: Define the mode of the scan (Enable/Disable scan)
      • 00: Disable Configuration RAM scan
      • 01: RESERVED
      • 10: Enable Configuration RAM scan
      • 11: RESERVED
  • Resp->RespMsg3: NPI Attribute register details
    • Bit [31:24]: Not implemented
    • Bit [23:18]: Reserved
    • Bit [17:8]: The scheduled time in milliseconds that the NPI scan will be periodically performed. Default Setting: 0x064 = 100ms
    • Bit [7:6]: Reserved
    • Bit [5:4]: Indicates when to start NPI scan
      • 00: Do not automatically start scan
      • 01: Enable scan automatically after device configuration.
      • 10: Reserved
      • 11: Reserved
    • Bit [3]: Reserved
    • Bit [2]: Indicates HwSHA/SwSHA 0: Use hardware calculated SHA. 1: Use software calculated SHA.
    • Bit [1:0]: Reserved
  • Resp->RespMsg4: Status of Get Configuration command

Prototype

XStatus XSem_Ssit_CmdGetConfig(XIpiPsu *IpiInst, XSemIpiResp *Resp, u32 TargetSlr);

Parameters

The following table lists the XSem_Ssit_CmdGetConfig function arguments.

Table 1. XSem_Ssit_CmdGetConfig Arguments
Type Member Description
XIpiPsu * IpiInst Pointer to IPI driver instance
XSemIpiResp * Resp Structure Pointer of IPI response
  • Resp->RespMsg1: Acknowledgment ID of Get Configuration(0x30309)
u32 TargetSlr Target SLR index on which command is to be executed
  • 0x0 : Target is master only
  • 0x1 : Target is slave 0 only
  • 0x2 : Target is slave 1 only
  • 0x3 : Target is slave 2 only
  • 0xF : Broadcast not supported for this API

Returns

This API returns the success or failure.
  • XST_FAILURE: On Get Configuration failure
  • XST_SUCCESS: On Get Configuration success