XRFdc_SetThresholdClrMode - 2.6 English

Zynq UltraScale+ RFSoC RF Data Converter v2.6 Gen 1/2/3/DFE LogiCORE IP Product Guide (PG269)

Document ID
PG269
Release Date
2023-10-18
Version
2.6 English

Function Prototype

u32 XRFdc_SetThresholdClrMode(XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u32 ThresholdToUpdate, u32 ClrMode);

Arguments

XRFdc *InstancePtr
Pointer to the driver instance
u32 Tile_Id
RF-ADC tile number. Valid values are 0-3.
u32 Block_Id
RF-ADC number inside the tile. Valid values are 0-3.
u32 ThresholdToUpdate
Select which Threshold (Threshold0 or Threshold1 or both) to update.
Note: See Threshold_Settings structure for valid macros.
u32 ClrMode
Clear mode can be manual (register write) or auto clear (QMC gain update event).
Table 1. Valid Macros for ClrMode Argument
Macro Description
XRFDC_THRESHOLD_CLRMD_MANUAL_CLR Manual clear
XRFDC_THRESHOLD_CLRMD_AUTO_CLR Auto clear

Description

This API function sets the threshold clear mode.
Note: This API function is only applicable for RF-ADCs.

Return Value

XRFDC_SUCCESS

XRFDC_FAILURE