Types and Structures - 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
Table 1. C Model Types and Structures
Name Description
General Types
typedef double xip_real Scalar type alias
typedef unsigned integer xip_uint Integer type alias
typedef unsigned char xip_bit Bit type alias
Handler Function Signatures
typedef void (*xip_msg_handler)(void* handle, int error, const char* msg) Interface to a message handler function
Structures
typedef struct xip_sd_fec_v1_1_config
Model configuration structure, includes:
name
String identifier for model instance.
fec
FEC code to be used, see model constants.
standard
Specifies standard to implement, see model constants.
ip_quant_mode
Specifies input quantization;
  • 0 = Quantize and saturate to recommended decoder LLR limits
  • 1 = Quantize and wrap at input width limits as per hardware
typedef struct xip_sd_fec_v1_1_imp xip_sd_fec_v1_1 Handle type to refer to an instance of the model
typedef xip_uint xip_sd_fec_v1_1_ldpc_sc_table See SC_TABLE register (link below) for field details.
typedef struct xip_sd_fec_v1_1_ldpc_la_table See LA_TABLE register (link below) for field details.
typedef struct xip_sd_fec_v1_1_ldpc_qc_table See QC_TABLE register (link below) for field details.
typedef struct xip_sd_fec_v1_1_ldpc_parameters See LDPC Code Parameters (link below).
typedef struct xip_sd_fec_v1_1_td_parameters See Turbo Code Parameters (link below) for field details.
typedef struct xip_sd_fec_v1_1_ctrl_packet See CTRL bus port bit definitions (link below) for field details
typedef struct xip_sd_fec_v1_1_stat_packet See STATUS bus port bit definitions (link below) for field details
Array Types
typedef struct xip_array_real Dynamic array, used for soft value input/output
typedef struct xip_array_bit Dynamic array, used for hard output