XSem_CmdCfrStopScan - 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 stop CRAM scan from user application. Primarily this function sends an IPI request to PLM to invoke SEM CRAM StopScan, waits for PLM to process the request and reads the response message.

Prototype

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

Parameters

The following table lists the XSem_CmdCfrStopScan function arguments.

Table 1. XSem_CmdCfrStopScan Arguments
Type Member Description
XIpiPsu * IpiInst Pointer to IPI driver instance
XSemIpiResp * Resp Structure Pointer of IPI response
  • Resp->RespMsg1: Acknowledgment ID of CRAM stop scan(0x10303)
  • Resp->RespMsg2: Status of CRAM stop scan 0x00500000 – CRAM init not done 0x00700000 – Stop scan failed

Returns

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