XSem_CmdCfrGetTotalFrames - 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 total frames in a row.

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.
  • The safe location to perform error injection is QWORD 12 which has ECC bits. The error injection will not change the design behaviour.

Prototype

void XSem_CmdCfrGetTotalFrames(u32 RowIndex, u32 *FrameCntPtr);

Parameters

The following table lists the XSem_CmdCfrGetTotalFrames function arguments.

Table 1. XSem_CmdCfrGetTotalFrames Arguments
Type Member Description
u32 RowIndex Row index for which total number of frames is to be read (Min: 0 , Max: CFU_ROW_RANGE -1)
u32 * FrameCntPtr Pointer to store Total frames
  • FrameCntPtr[0] : Type_0 total frames
  • FrameCntPtr[1] : Type_1 total frames
  • FrameCntPtr[2] : Type_2 total frames
  • FrameCntPtr[3] : Type_3 total frames
  • FrameCntPtr[4] : Type_4 total frames
  • FrameCntPtr[5] : Type_5 total frames
  • FrameCntPtr[6] : Type_6 total frames

Returns