XSem_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 PLM to invoke SEM NPI StopScan, waits for PLM to process the request and reads the response message.

Prototype

XStatus XSem_CmdNpiStopScan(XIpiPsu *IpiInst, XSemIpiResp *Resp);

Parameters

The following table lists the XSem_CmdNpiStopScan function arguments.

Table 1. XSem_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: Status of NPI stop scan (0: Success, 1: Failure)

Returns

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