XSem_Ssit_CmdCfrStopScan - 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 CRAM scan on targeted SLR 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_Ssit_CmdCfrStopScan(XIpiPsu *IpiInst, XSemIpiResp *Resp, u32 TargetSlr);

Parameters

The following table lists the XSem_Ssit_CmdCfrStopScan function arguments.

Table 1. XSem_Ssit_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:
    • if Broadcast : Status of CfrStoptScan in Master
    • else : Status of CfrStoptScan in Target SLR
  • RespMsg3, 4 and 5 are updated only in case of broadcast
  • Resp->RespMsg3: Status of CfrStoptScan in Slave 1
  • Resp->RespMsg4: Status of CfrStoptScan in Slave 2
  • Resp->RespMsg5: Status of CfrStoptScan in Slave 3 Status of CRAM stop scan: 0x00500000 – CRAM init not done 0x00700000 – Stop scan failed
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 CRAM stop scan failure
  • XST_SUCCESS: On CRAM stop scan success