XSem_CmdNpiGetStatus - 2021.1 English

Xilinx Standalone Library Documentation OS and Libraries Document Collection (UG643)
Document ID
UG643
Release Date
2021-06-16
Version
2021.1 English

This function is used to read all NPI Status registers from PMC RAM and send to user application.

Prototype

XStatus XSem_CmdNpiGetStatus(XSemNpiStatus *NpiStatusInfo);

Parameters

The following table lists the XSem_CmdNpiGetStatus function arguments.

Table 1. XSem_CmdNpiGetStatus Arguments
Type Name Description
XSemNpiStatus * NpiStatusInfo Structure Pointer with NPI Status details
  • NpiStatusInfo->Status: Provides details about NPI scan
    • Bit [31]: Cryptographic acceleration blocks are is disabled for export compliance
    • Bit [30-26]: Reserved
    • Bit [25]: NPI GPIO write failure
    • Bit [24]: NPI SHA engine failure
    • Bit [23]: NPI Safety register write failure
    • Bit [22]: NPI GT slave arbitration failure
    • Bit [21]: NPI DDRMC Main slave arbitration failure
    • Bit [20]: NPI Slave Address is not valid
    • Bit [19]: NPI Descriptor SHA header is not valid
    • Bit [18]: NPI Descriptor header is not valid
    • Bit [17]: NPI SHA mismatch error is detected during scan
    • Bit [16]: NPI SHA mismatch error is detected in first scan
    • Bit [15-12]: Reserved
    • Bit [11]: NPI periodic scan is enabled
    • Bit [10]: NPI scan is suspended
    • Bit [09]: NPI completed the first scan
    • Bit [08]: NPI Scan is included in design
    • Bit [07-06]: Reserved
    • Bit [05]: NPI Internal Error State
    • Bit [04]: NPI SHA mismatch Error State
    • Bit [03]: NPI SHA Error Injection State
    • Bit [02]: NPI Scan State
    • Bit [01]: NPI Initialization State
    • Bit [00]: NPI Idle State
  • NpiStatusInfo->SlvSkipCnt: Provides NPI descriptor slave skip counter value if arbitration failure. This is 8 words result to accommodate 32 1-Byte skip counters for individual slaves arbitration failures. Slaves can be DDRMC Main, GT for which arbitration is required before performing scanning.
  • NpiStatusInfo->ScanCnt: NPI scan counter value. This counter represents number of periodic scan cycle completion.
  • NpiStatusInfo->HbCnt: NPI heartbeat counter value. This counter represents number of scanned descriptor slaves.
  • NpiStatusInfo->ErrInfo: NPI scan error information if SHA mismatch is detected. This is 2 word information.
    • Word 0: Node ID of descriptor for which SHA mismatch is detected
    • Word 1 Bit [15-8]: NPI descriptor index number
    • Word 1 Bit [7-0]: NPI Slave Skip count Index

Returns

This API returns the success or failure.
  • XST_FAILURE: If NULL pointer reference of NpiStatusInfo
  • XST_SUCCESS: On successful read from PMC RAM