XSem_Ssit_CmdNpiStopScan - 2023.1 English

Standalone Library Documentation: BSP and Libraries Document Collection (UG643)
Document ID
UG643
Release Date
2023-05-16
Version
2023.1 English

This function is used to stop NPI scan from user application. Primarily this function sends an IPI request to master PLM to invoke SEM NPI StopScan on targeted SLR PLM and waits for master PLM to process the request and reads the response message.

Prototype

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

Parameters

The following table lists the XSem_Ssit_CmdNpiStopScan function arguments.

Table 1. XSem_Ssit_CmdNpiStopScan Arguments
Type Member Description
XIpiPsu * IpiInst Pointer to IPI driver instance
XSemIpiResp * Resp Structure Pointer of IPI response
  • Resp->RespMsg1: Acknowledgment ID of NPI stop scan(0x10306)
  • Resp->RespMsg2:
    • if Broadcast : Status of NpiStoptScan in Master
    • else : Status of NpiStoptScan in Target SLR
  • RespMsg3, 4 and 5 are updated only in case of broadcast
  • Resp->RespMsg3: Status of NpiStoptScan in Slave 1
  • Resp->RespMsg4: Status of NpiStoptScan in Slave 2
  • Resp->RespMsg5: Status of NpiStoptScan in Slave 3 Status of stop 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 stop scan failure
  • XST_SUCCESS: On NPI stop scan success