XSem_Ssit_CmdNpiStartScan - 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 start NPI scan from user application. Primarily this function sends an IPI request to PLM to invoke SEM NPI StartScan on targeted SLR PLM, waits for PLM to process the request and reads the response message.

Prototype

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

Parameters

The following table lists the XSem_Ssit_CmdNpiStartScan function arguments.

Table 1. XSem_Ssit_CmdNpiStartScan Arguments
Type Member Description
XIpiPsu * IpiInst Pointer to IPI driver instance
XSemIpiResp * Resp Structure Pointer of IPI response
  • Resp->RespMsg1: Acknowledgment ID of NPI start scan(0x10305)
  • Resp->RespMsg2:
    • if Broadcast : Status of NpiStartScan in Master
    • else : Status of NpiStartScan in Target SLR
  • RespMsg3, 4 and 5 are updated only in case of broadcast
  • Resp->RespMsg3: Status of NpiStarttScan in Slave 1
  • Resp->RespMsg4: Status of NpiStarttScan in Slave 2
  • Resp->RespMsg5: Status of NpiStarttScan in Slave 3 Status of start scan: 0: Success, 1: Failure
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 for all devices

Returns

This API returns the success or failure.
  • XST_FAILURE: On NPI start scan failure
  • XST_SUCCESS: On NPI start scan success