XSem_CmdCfrReadFrameEcc - 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 Read frame ECC of a particular Frame. Primarily this function sends an IPI request to PLM to invoke SEM CRAM SendFrameEcc, waits for PLM to process the request and reads the response message.

Note:
  • Total number of frames in a row is not same for all rows.
  • XSem_CmdCfrGetTotalFrames API is provided to know the total number of frames in a row for each block. Output param (FrameCntPtr) of XSem_CmdCfrGetTotalFrames API is updated with total number of frames of each block type for the input row. If a particular block in a row has 0 frames, then error injection shall not be performed. Range of Frame number: 0 to (FrameCntPtr[n] - 1) where n is block type with range 0 to 6. ECC bits. The error injection will not change the design behaviour.

Prototype

XStatus XSem_CmdCfrReadFrameEcc(XIpiPsu *IpiInst, u32 CframeAddr, u32 RowLoc, XSemIpiResp *Resp);

Parameters

The following table lists the XSem_CmdCfrReadFrameEcc function arguments.

Table 1. XSem_CmdCfrReadFrameEcc Arguments
Type Member Description
XIpiPsu * IpiInst Pointer to IPI driver instance
u32 CframeAddr Frame Address
  • Frame Number [0:19] (Refer note)
  • Block Type [20:22]
u32 RowLoc Row index(Min: 0 , Max: CFU_ROW_RANGE -1)
XSemIpiResp * Resp Structure Pointer of IPI response
  • Resp->RespMsg1: Acknowledgment ID of CRAM Send Frame ECC(0x3030A)
  • Resp->RespMsg2: Segment 0 ECC value
  • Resp->RespMsg3: Segment 1 ECC value
  • Resp->RespMsg4: Status of CRAM stop scan

Returns

This API returns the success or failure.
  • XST_FAILURE: On CRAM Read Frame ECC failure
  • XST_SUCCESS: On CRAM Read Frame ECC success