XRFdc_GetSignalDetector (Gen 3/DFE) - 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_GetSignalDetector(XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, XRFdc_Signal_Detector_Settings *SettingsPtr);

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 block number inside the tile. Valid values are 0-3.
XRFdc_Signal_Detector_Settings *SettingsPtr
Pointer to the XRFdc_Signal_Detector_Settings structure that is populated with the signal detector settings.
Table 1. Valid Macros for SettingsPtr->Mode Argument
Macro Description
XRFDC_SIGDET_MODE_AVG Average mode of operation
XRFDC_SIGDET_MODE_RNDM Randomized mode of operation
Table 2. Valid Macros for SettingsPtr->TimeConstant Argument
Macro Description
XRFDC_SIGDET_TC_2_0 2^0 Cycles
XRFDC_SIGDET_TC_2_2 2^2 Cycles
XRFDC_SIGDET_TC_2_4 2^4 Cycles
XRFDC_SIGDET_TC_2_8 2^8 Cycles
XRFDC_SIGDET_TC_2_12 2^12 Cycles
XRFDC_SIGDET_TC_2_14 2^14 Cycles
XRFDC_SIGDET_TC_2_16 2^16 Cycles
XRFDC_SIGDET_TC_2_18 2^18 Cycles

Description

The signal detector settings are read to from the registers and the XRFdc_Signal_Detector_Settings structure is populated.
Note: This is an API function for RF-ADCs only. Only available for Gen 3/DFE devices.

Return Value

XRFDC_SUCCESS

XRFDC_FAILURE