Overview - 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

The bare-metal API for the SD-FEC Integrated Block is described in this appendix. The driver is composed of the following files:

  • API Interface
    • xsdfec.c: The user interface API is implemented in this file.
    • xsdfec.h: The user interface API prototypes are provided in this file. The file provides prototypes of the driver instance structure and all other structures used across the API.
    • xsdfec_sinit.c: Device initialization functions.
  • Hardware register map
    • xsdfec_hw.h: Definitions for the hardware register maps and field masks are provided in this file.
  • Device configuration
    • x<ipinst_name>_turbo_params.h: Header file defining device/IP instance specific turbo decode configuration parameters derived from the hardware build. This file is only generated when an IP instance has been configured for turbo decode.
    • x<ipinst_name>_<code_id>_params.h: Header file defining device/IP instance-specific LDPC configuration parameters derived from the hardware build; one header per specified LDPC code. This file is only generated when an IP instance has been configured for LDPC decode or encode.