Base API - 1.1 English

Soft-Decision FEC Integrated Block LogiCORE IP Product Guide (PG256)

Document ID
PG256
Release Date
2022-10-19
Version
1.1 English

Set and get functions are provided for all the individual registers and fields defined for the SD-FEC IP. The XSdFecAddLdpcParams abstract the configuration of an SD-FEC device but the main device control is done using the base API, for example, interface enablement and interrupt configuration. See links below for full details.

Note that the field level set functions use read-modify-write.

The base API functions take the following form.

Function Prototype

void XSdFecSet_<register_name>(UINTPTR BaseAddress, u32 Data);
void XSdFecSet_<register_name>_<field_name>(UINTPTR BaseAddress, u32 Data);
u32 XSdFecGet_<register_name>(UINTPTR BaseAddress);
u32 XSdFecGet_<register_name>_<field_name>(UINTPTR BaseAddress);

Arguments

  • XSdFec *InstancePtr: Pointer to device instance state structure.
  • u32 data: Data to write to register or field.

Return Value

Value read from register or field.