rfdc
Xilinx SDK Drivers API Documentation
Xrfdc_v5_0

Functions

u32 XRFdc_CfgInitialize (XRFdc *InstancePtr, XRFdc_Config *ConfigPtr)
 Initializes a specific XRFdc instance such that the driver is ready to use. More...
 
u32 XRFdc_StartUp (XRFdc *InstancePtr, u32 Type, int Tile_Id)
 The API Restarts the requested tile. More...
 
u32 XRFdc_Shutdown (XRFdc *InstancePtr, u32 Type, int Tile_Id)
 The API stops the tile as requested. More...
 
u32 XRFdc_Reset (XRFdc *InstancePtr, u32 Type, int Tile_Id)
 The API resets the requested tile. More...
 
u32 XRFdc_GetIPStatus (XRFdc *InstancePtr, XRFdc_IPStatus *IPStatusPtr)
 The API returns the IP status. More...
 
u32 XRFdc_GetBlockStatus (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u32 Block_Id, XRFdc_BlockStatus *BlockStatusPtr)
 The API returns the requested block status. More...
 
u32 XRFdc_SetQMCSettings (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u32 Block_Id, XRFdc_QMC_Settings *QMCSettingsPtr)
 This API is used to update various QMC settings, eg gain, phase, offset etc. More...
 
u32 XRFdc_GetQMCSettings (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u32 Block_Id, XRFdc_QMC_Settings *QMCSettingsPtr)
 QMC settings are returned back to the caller through this API. More...
 
u32 XRFdc_SetCoarseDelaySettings (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u32 Block_Id, XRFdc_CoarseDelay_Settings *CoarseDelaySettingsPtr)
 Coarse delay settings passed are used to update the corresponding block level registers. More...
 
u32 XRFdc_GetCoarseDelaySettings (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u32 Block_Id, XRFdc_CoarseDelay_Settings *CoarseDelaySettingsPtr)
 Coarse delay settings are returned back to the caller. More...
 
u32 XRFdc_UpdateEvent (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u32 Block_Id, u32 Event)
 This function will trigger the update event for an event. More...
 
u32 XRFdc_SetDecimationFactor (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u32 DecimationFactor)
 This API is to set the decimation factor and also update the FIFO write words w.r.t to decimation factor. More...
 
u32 XRFdc_SetFabClkOutDiv (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u16 FabClkDiv)
 This API is to set the divider for clock fabric out. More...
 
u32 XRFdc_GetFabClkOutDiv (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u16 *FabClkDivPtr)
 This API is to get the divider for clock fabric out. More...
 
u32 XRFdc_SetInterpolationFactor (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u32 InterpolationFactor)
 This API is to set the interpolation factor and also update the FIFO read words w.r.t to interpolation factor. More...
 
u32 XRFdc_GetInterpolationFactor (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u32 *InterpolationFactorPtr)
 Interpolation factor are returned back to the caller. More...
 
u32 XRFdc_GetDecimationFactor (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u32 *DecimationFactorPtr)
 Decimation factor are returned back to the caller. More...
 
u32 XRFdc_SetFabWrVldWords (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u32 FabricWrVldWords)
 Fabric data rate for the requested DAC block is set by writing to the corresponding register. More...
 
u32 XRFdc_SetFabRdVldWords (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u32 FabricRdVldWords)
 Fabric data rate for the requested ADC block is set by writing to the corresponding register. More...
 
u32 XRFdc_GetFabWrVldWords (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u32 Block_Id, u32 *FabricWrVldWordsPtr)
 This API returns the the number of fabric write valid words requested for the block. More...
 
u32 XRFdc_GetFabRdVldWords (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u32 Block_Id, u32 *FabricRdVldWordsPtr)
 This API returns the the number of fabric read valid words requested for the block. More...
 
u32 XRFdc_ThresholdStickyClear (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u32 ThresholdToUpdate)
 This API is to clear the Sticky bit in threshold config registers. More...
 
u32 XRFdc_SetThresholdClrMode (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u32 ThresholdToUpdate, u32 ClrMode)
 This API sets the threshold clear mode. More...
 
u32 XRFdc_SetThresholdSettings (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, XRFdc_Threshold_Settings *ThresholdSettingsPtr)
 Threshold settings are updated into the relevant registers. More...
 
u32 XRFdc_GetThresholdSettings (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, XRFdc_Threshold_Settings *ThresholdSettingsPtr)
 Threshold settings are read from the corresponding registers and are passed back to the caller. More...
 
u32 XRFdc_SetDecoderMode (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u32 DecoderMode)
 Decoder mode is updated into the relevant registers. More...
 
u32 XRFdc_GetDecoderMode (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u32 *DecoderModePtr)
 Decoder mode is read and returned back. More...
 
u32 XRFdc_ResetNCOPhase (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u32 Block_Id)
 Resets the NCO phase of the current block phase accumulator. More...
 
u32 XRFdc_MultiBand (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u8 DigitalDataPathMask, u32 DataType, u32 DataConverterMask)
 User-level API to setup multiband configuration. More...
 
u32 XRFdc_SetupFIFO (XRFdc *InstancePtr, u32 Type, int Tile_Id, u8 Enable)
 Enable and Disable the ADC/DAC FIFO. More...
 
u32 XRFdc_GetFIFOStatus (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u8 *EnablePtr)
 Current status of ADC/DAC FIFO. More...
 
u32 XRFdc_GetOutputCurr (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u32 *OutputCurrPtr)
 Get Output Current for DAC block. More...
 
u32 XRFdc_SetNyquistZone (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u32 Block_Id, u32 NyquistZone)
 Set the Nyquist zone. More...
 
u32 XRFdc_GetNyquistZone (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u32 Block_Id, u32 *NyquistZonePtr)
 Get the Nyquist zone. More...
 
u32 XRFdc_SetCalibrationMode (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u8 CalibrationMode)
 This API is to set the Calibration mode. More...
 
u32 XRFdc_GetCalibrationMode (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u8 *CalibrationModePtr)
 This API is to get the Calibration mode. More...
 
u32 XRFdc_SetInvSincFIR (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u16 Enable)
 This API is used to set enable/disable the Inverse-Sinc filter. More...
 
u32 XRFdc_GetInvSincFIR (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u16 *EnablePtr)
 This API is used to get the Inverse-Sinc filter status(enable/disable). More...
 
void XRFdc_DumpRegs (XRFdc *InstancePtr, u32 Type, int Tile_Id)
 This Prints the offset of the register along with the content. More...
 
u32 XRFdc_GetClockSource (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u32 *ClockSourcePtr)
 This function gets Clock source. More...
 
u32 XRFdc_GetPLLLockStatus (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u32 *LockStatusPtr)
 This function gets PLL lock status. More...
 
u32 XRFdc_DynamicPLLConfig (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u8 Source, double RefClkFreq, double SamplingRate)
 This function used for dynamically switch between internal PLL and external clcok source and configuring the internal PLL. More...
 
u32 XRFdc_GetLinkCoupling (XRFdc *InstancePtr, u32 Tile_Id, u32 Block_Id, u32 *ModePtr)
 This function is used to get the Link Coupling mode. More...
 
u32 XRFdc_SetMixerSettings (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u32 Block_Id, XRFdc_Mixer_Settings *MixerSettingsPtr)
 The API is used to update various mixer settings, fine, coarse, NCO etc. More...
 
u32 XRFdc_GetMixerSettings (XRFdc *InstancePtr, u32 Type, u32 Tile_Id, u32 Block_Id, XRFdc_Mixer_Settings *MixerSettingsPtr)
 The API returns back Mixer/NCO settings to the caller. More...
 
u32 XRFdc_MTS_Sysref_Config (XRFdc *InstancePtr, XRFdc_MultiConverter_Sync_Config *DACSyncConfigPtr, XRFdc_MultiConverter_Sync_Config *ADCSyncConfigPtr, u32 SysRefEnable)
 This API is used to enable/disable the sysref. More...
 
void XRFdc_MultiConverter_Init (XRFdc_MultiConverter_Sync_Config *ConfigPtr, int *PLL_CodesPtr, int *T1_CodesPtr)
 This API Initializes the multi-tile sync config structures. More...
 
u32 XRFdc_MultiConverter_Sync (XRFdc *InstancePtr, u32 Type, XRFdc_MultiConverter_Sync_Config *ConfigPtr)
 This is the top level API which will be used for Multi-tile Synchronization. More...
 

Function Documentation

◆ XRFdc_CfgInitialize()

u32 XRFdc_CfgInitialize ( XRFdc InstancePtr,
XRFdc_Config ConfigPtr 
)

#include <xrfdc.c>

Initializes a specific XRFdc instance such that the driver is ready to use.

Parameters
InstancePtris a pointer to the XRfdc instance.
ConfigPtris a reference to a structure containing information about xrfdc. This function initializes an InstancePtr object for a specific device specified by the contents of Config.
Returns
  • XRFDC_SUCCESS if successful.
Note
The user needs to first call the XRFdc_LookupConfig() API which returns the Configuration structure pointer which is passed as a parameter to the XRFdc_CfgInitialize() API.

◆ XRFdc_DumpRegs()

void XRFdc_DumpRegs ( XRFdc InstancePtr,
u32  Type,
int  Tile_Id 
)

#include <xrfdc.c>

This Prints the offset of the register along with the content.

This API is meant to be used for debug purposes. It prints to the console the contents of registers for the passed Tile_Id. If -1 is passed, it prints the contents of the registers for all the tiles for the respective ADC or DAC

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3, and -1.
Returns
None
Note
None

◆ XRFdc_DynamicPLLConfig()

u32 XRFdc_DynamicPLLConfig ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u8  Source,
double  RefClkFreq,
double  SamplingRate 
)

#include <xrfdc.c>

This function used for dynamically switch between internal PLL and external clcok source and configuring the internal PLL.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeindicates ADC/DAC
Tile_Idindicates Tile number (0-3)
SourceClock source internal PLL or external clock source
RefClkFreqReference Clock Frequency in MHz(102.40625MHz - 1.2GHz)
SamplingRateSampling Rate in MHz(0.1- 6.554GHz for DAC and 0.5/1.0 - 2.058/4.116GHz for ADC based on the device package).
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Tile not enabled.
Note
This API enables automatic selection of the VCO which will work in IP version 2.0.1 and above. Using older version of IP this API is not likely to work.

◆ XRFdc_GetBlockStatus()

u32 XRFdc_GetBlockStatus ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u32  Block_Id,
XRFdc_BlockStatus BlockStatusPtr 
)

#include <xrfdc.c>

The API returns the requested block status.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3. XRFdc_BlockStatus.
BlockStatusPtris Pointer to the XRFdc_BlockStatus structure through which the ADC/DAC block status is returned.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Common API for ADC/DAC blocks.

◆ XRFdc_GetCalibrationMode()

u32 XRFdc_GetCalibrationMode ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
u8 *  CalibrationModePtr 
)

#include <xrfdc.c>

This API is to get the Calibration mode.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
CalibrationModePtrpointer to get the calibration mode.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Tile not enabled.
Note
Only for ADC blocks

◆ XRFdc_GetClockSource()

u32 XRFdc_GetClockSource ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u32 *  ClockSourcePtr 
)

#include <xrfdc.c>

This function gets Clock source.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeindicates ADC/DAC.
Tile_Idindicates Tile number (0-3).
ClockSourcePtrPointer to return the clock source
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Tile not enabled.
Note
None.

◆ XRFdc_GetCoarseDelaySettings()

u32 XRFdc_GetCoarseDelaySettings ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u32  Block_Id,
XRFdc_CoarseDelay_Settings CoarseDelaySettingsPtr 
)

#include <xrfdc.c>

Coarse delay settings are returned back to the caller.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
CoarseDelaySettingsPtrPointer to the XRFdc_CoarseDelay_Settings structure in which the Coarse Delay settings are passed.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
None.

◆ XRFdc_GetDecimationFactor()

u32 XRFdc_GetDecimationFactor ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
u32 *  DecimationFactorPtr 
)

#include <xrfdc.c>

Decimation factor are returned back to the caller.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
DecimationFactorPtrPointer to return the Decimation factor for DAC blocks.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Only for ADC blocks

◆ XRFdc_GetDecoderMode()

u32 XRFdc_GetDecoderMode ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
u32 *  DecoderModePtr 
)

#include <xrfdc.c>

Decoder mode is read and returned back.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis DAC block number inside the tile. Valid values are 0-3.
DecoderModePtrValid values are 1 (Maximum SNR, for non-randomized decoder), 2 (Maximum Linearity, for randomized decoder)
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Only for DAC blocks

◆ XRFdc_GetFabClkOutDiv()

u32 XRFdc_GetFabClkOutDiv ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u16 *  FabClkDivPtr 
)

#include <xrfdc.c>

This API is to get the divider for clock fabric out.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
FabClkDivPtris a pointer to get fabric clock for a tile. XRFDC_FAB_CLK_* defines the valid divider values.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Tile not enabled.
Note
API is applicable for both ADC and DAC Tiles

◆ XRFdc_GetFabRdVldWords()

u32 XRFdc_GetFabRdVldWords ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u32  Block_Id,
u32 *  FabricRdVldWordsPtr 
)

#include <xrfdc.c>

This API returns the the number of fabric read valid words requested for the block.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
FabricRdVldWordsPtrPointer to return the fabric data rate for ADC/DAC block
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
ADC/DAC blocks

◆ XRFdc_GetFabWrVldWords()

u32 XRFdc_GetFabWrVldWords ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u32  Block_Id,
u32 *  FabricWrVldWordsPtr 
)

#include <xrfdc.c>

This API returns the the number of fabric write valid words requested for the block.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
FabricWrVldWordsPtrPointer to return the fabric data rate for DAC block
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
ADC/DAC blocks

◆ XRFdc_GetFIFOStatus()

u32 XRFdc_GetFIFOStatus ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u8 *  EnablePtr 
)

#include <xrfdc.c>

Current status of ADC/DAC FIFO.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
EnablePtrvalid values are 1 (FIFO enable) and 0 (FIFO Disable)
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Tile not enabled.
Note
Common API for ADC/DAC blocks

◆ XRFdc_GetInterpolationFactor()

u32 XRFdc_GetInterpolationFactor ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
u32 *  InterpolationFactorPtr 
)

#include <xrfdc.c>

Interpolation factor are returned back to the caller.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
InterpolationFactorPtrPointer to return the interpolation factor for DAC blocks.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Only for DAC blocks

◆ XRFdc_GetInvSincFIR()

u32 XRFdc_GetInvSincFIR ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
u16 *  EnablePtr 
)

#include <xrfdc.c>

This API is used to get the Inverse-Sinc filter status(enable/disable).

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis DAC block number inside the tile. Valid values are 0-3.
EnablePtris a pointer to get the inv-sinc status. valid values are 0(disable) and 1(enable).
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Only DAC blocks

◆ XRFdc_GetIPStatus()

u32 XRFdc_GetIPStatus ( XRFdc InstancePtr,
XRFdc_IPStatus IPStatusPtr 
)

#include <xrfdc.c>

The API returns the IP status.

Parameters
InstancePtris a pointer to the XRfdc instance.
IPStatusPtrPointer to the XRFdc_IPStatus structure through which the status is returned.
Returns
  • XRFDC_SUCCESS if successful.
Note
None.

◆ XRFdc_GetLinkCoupling()

u32 XRFdc_GetLinkCoupling ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
u32 *  ModePtr 
)

#include <xrfdc.c>

This function is used to get the Link Coupling mode.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_Idindicates Tile number (0-3).
Block_Idindicates Block number(0-3 for 2G, 0-1 for 4G).
ModePtrpointer to get link coupling mode.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Tile not enabled.
Note
Only for ADC blocks

◆ XRFdc_GetMixerSettings()

u32 XRFdc_GetMixerSettings ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u32  Block_Id,
XRFdc_Mixer_Settings MixerSettingsPtr 
)

#include <xrfdc_mixer.c>

The API returns back Mixer/NCO settings to the caller.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
MixerSettingsPtrPointer to the XRFdc_Mixer_Settings structure in which the Mixer/NCO settings are passed.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
FineMixerScale in Mixer_Settings structure can have 3 values. XRFDC_MIXER_SCALE_* represents the valid values. XRFDC_MIXER_SCALE_AUTO - If mixer mode is R2C, Mixer Scale is set to 1 and for other modes mixer scale is set to 0.7 XRFDC_MIXER_SCALE_1P0 - To set fine mixer scale to 1. XRFDC_MIXER_SCALE_0P7 - To set fine mixer scale to 0.7.

◆ XRFdc_GetNyquistZone()

u32 XRFdc_GetNyquistZone ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u32  Block_Id,
u32 *  NyquistZonePtr 
)

#include <xrfdc.c>

Get the Nyquist zone.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
NyquistZonePtrPointer to return the Nyquist zone.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Tile not enabled.
Note
Common API for ADC/DAC blocks

◆ XRFdc_GetOutputCurr()

u32 XRFdc_GetOutputCurr ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
u32 *  OutputCurrPtr 
)

#include <xrfdc.c>

Get Output Current for DAC block.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
OutputCurrPtrpointer to return the output current.
Returns
  • Return Output Current for DAC block

◆ XRFdc_GetPLLLockStatus()

u32 XRFdc_GetPLLLockStatus ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u32 *  LockStatusPtr 
)

#include <xrfdc.c>

This function gets PLL lock status.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeindicates ADC/DAC.
Tile_Idindicates Tile number (0-3).
LockStatusPtrPointer to return the PLL lock status
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Tile not enabled.
Note
None.

◆ XRFdc_GetQMCSettings()

u32 XRFdc_GetQMCSettings ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u32  Block_Id,
XRFdc_QMC_Settings QMCSettingsPtr 
)

#include <xrfdc.c>

QMC settings are returned back to the caller through this API.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
QMCSettingsPtrPointer to the XRFdc_QMC_Settings structure in which the QMC settings are passed.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
None

◆ XRFdc_GetThresholdSettings()

u32 XRFdc_GetThresholdSettings ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
XRFdc_Threshold_Settings ThresholdSettingsPtr 
)

#include <xrfdc.c>

Threshold settings are read from the corresponding registers and are passed back to the caller.

There can be two threshold settings: threshold0 and threshold1. Both of them are independent of each other. The function returns the requested threshold (which can be threshold0, threshold1, or both.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
ThresholdSettingsPtrPointer through which the register settings for thresholds are passed back..
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Only for ADC blocks

◆ XRFdc_MTS_Sysref_Config()

u32 XRFdc_MTS_Sysref_Config ( XRFdc InstancePtr,
XRFdc_MultiConverter_Sync_Config *  DACSyncConfigPtr,
XRFdc_MultiConverter_Sync_Config *  ADCSyncConfigPtr,
u32  SysRefEnable 
)

#include <xrfdc_mts.c>

This API is used to enable/disable the sysref.

Parameters
InstancePtris a pointer to the XRfdc instance.
DACSyncConfigPtris pointer to DAC Multi-Tile Sync config structure.
ADCSyncConfigPtris pointer to ADC Multi-Tile Sync config structure.
SysRefEnablevalid values are 0(disable) and 1(enable).
Returns
  • XRFDC_MTS_OK if successful.
Note
None

◆ XRFdc_MultiBand()

u32 XRFdc_MultiBand ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u8  DigitalDataPathMask,
u32  DataType,
u32  DataConverterMask 
)

#include <xrfdc.c>

User-level API to setup multiband configuration.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
DigitalDataPathMaskis the DataPath mask. First 4 bits represent 4 data paths, 1 means enabled and 0 means disabled.
DataTypeis mixer data type, valid values are XRFDC_MB_DATATYPE_*
DataConverterMaskis block enabled mask (input/output driving blocks). 1 means enabled and 0 means disabled.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Common API for ADC/DAC blocks

◆ XRFdc_MultiConverter_Init()

void XRFdc_MultiConverter_Init ( XRFdc_MultiConverter_Sync_Config *  ConfigPtr,
int *  PLL_CodesPtr,
int *  T1_CodesPtr 
)

#include <xrfdc_mts.c>

This API Initializes the multi-tile sync config structures.

Optionally allows target codes to be provided for the Pll/T1 analog sysref capture

Parameters
ConfigPtrpointer to Multi-tile sync config structure.
PLL_CodesPtrpointer to PLL analog sysref capture.
T1_CodesPtrpointer to T1 analog sysref capture.
Returns
None
Note
None

◆ XRFdc_MultiConverter_Sync()

u32 XRFdc_MultiConverter_Sync ( XRFdc InstancePtr,
u32  Type,
XRFdc_MultiConverter_Sync_Config *  ConfigPtr 
)

#include <xrfdc_mts.c>

This is the top level API which will be used for Multi-tile Synchronization.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
ConfigPtrMulti-tile sync config structure.
Returns
  • XRFDC_MTS_OK if successful.
  • XRFDC_MTS_TIMEOUT if timeout occurs.
    • XRFDC_MTS_MARKER_RUN
    • XRFDC_MTS_MARKER_MISM
    • XRFDC_MTS_NOT_SUPPORTED if MTS is not supported.
Note
None

◆ XRFdc_Reset()

u32 XRFdc_Reset ( XRFdc InstancePtr,
u32  Type,
int  Tile_Id 
)

#include <xrfdc.c>

The API resets the requested tile.

It can reset all the tiles as well. In the process, all existing register settings are cleared and are replaced with the settings initially configured (through the GUI).

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3, and -1.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if tile is not enabled or available
Note
None

◆ XRFdc_ResetNCOPhase()

u32 XRFdc_ResetNCOPhase ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u32  Block_Id 
)

#include <xrfdc.c>

Resets the NCO phase of the current block phase accumulator.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
None

◆ XRFdc_SetCalibrationMode()

u32 XRFdc_SetCalibrationMode ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
u8  CalibrationMode 
)

#include <xrfdc.c>

This API is to set the Calibration mode.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
CalibrationModevalid values are 1 and 2.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Tile not enabled.
Note
Only for ADC blocks

◆ XRFdc_SetCoarseDelaySettings()

u32 XRFdc_SetCoarseDelaySettings ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u32  Block_Id,
XRFdc_CoarseDelay_Settings CoarseDelaySettingsPtr 
)

#include <xrfdc.c>

Coarse delay settings passed are used to update the corresponding block level registers.

Driver structure is updated with the new values.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
CoarseDelaySettingsPtris Pointer to the XRFdc_CoarseDelay_Settings structure in which the CoarseDelay settings are passed.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
None

◆ XRFdc_SetDecimationFactor()

u32 XRFdc_SetDecimationFactor ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
u32  DecimationFactor 
)

#include <xrfdc.c>

This API is to set the decimation factor and also update the FIFO write words w.r.t to decimation factor.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
DecimationFactorto be set for DAC block. XRFDC_INTERP_DECIM_* defines the valid values.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Only ADC blocks

◆ XRFdc_SetDecoderMode()

u32 XRFdc_SetDecoderMode ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
u32  DecoderMode 
)

#include <xrfdc.c>

Decoder mode is updated into the relevant registers.

Driver structure is updated with the new values.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis DAC block number inside the tile. Valid values are 0-3.
DecoderModeValid values are 1 (Maximum SNR, for non- randomized decoder), 2 (Maximum Linearity, for randomized decoder)
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Only DAC blocks

◆ XRFdc_SetFabClkOutDiv()

u32 XRFdc_SetFabClkOutDiv ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u16  FabClkDiv 
)

#include <xrfdc.c>

This API is to set the divider for clock fabric out.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
FabClkDivto be set for a tile. XRFDC_FAB_CLK_* defines the valid divider values.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
ADC and DAC Tiles

◆ XRFdc_SetFabRdVldWords()

u32 XRFdc_SetFabRdVldWords ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
u32  FabricRdVldWords 
)

#include <xrfdc.c>

Fabric data rate for the requested ADC block is set by writing to the corresponding register.

The function writes the number of valid read words for the requested ADC block.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis ADC block number inside the tile. Valid values are 0-3.
FabricRdVldWordsis Read fabric rate to be set for ADC block.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Only for ADC blocks

◆ XRFdc_SetFabWrVldWords()

u32 XRFdc_SetFabWrVldWords ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
u32  FabricWrVldWords 
)

#include <xrfdc.c>

Fabric data rate for the requested DAC block is set by writing to the corresponding register.

The function writes the number of valid write words for the requested DAC block.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
FabricWrVldWordsis write fabric rate to be set for DAC block.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Only for DAC blocks

◆ XRFdc_SetInterpolationFactor()

u32 XRFdc_SetInterpolationFactor ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
u32  InterpolationFactor 
)

#include <xrfdc.c>

This API is to set the interpolation factor and also update the FIFO read words w.r.t to interpolation factor.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
InterpolationFactorto be set for DAC block. XRFDC_INTERP_DECIM_* defines the valid values.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Only DAC blocks

◆ XRFdc_SetInvSincFIR()

u32 XRFdc_SetInvSincFIR ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
u16  Enable 
)

#include <xrfdc.c>

This API is used to set enable/disable the Inverse-Sinc filter.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis DAC block number inside the tile. Valid values are 0-3.
Enablevalid values are 0(disable) and 1(enable).
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Only DAC blocks

◆ XRFdc_SetMixerSettings()

u32 XRFdc_SetMixerSettings ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u32  Block_Id,
XRFdc_Mixer_Settings MixerSettingsPtr 
)

#include <xrfdc_mixer.c>

The API is used to update various mixer settings, fine, coarse, NCO etc.

Mixer/NCO settings passed are used to update the corresponding block level registers. Driver structure is updated with the new values.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
MixerSettingsPtrPointer to the XRFdc_Mixer_Settings structure in which the Mixer/NCO settings are passed.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
FineMixerScale in Mixer_Settings structure can have 3 values. XRFDC_MIXER_SCALE_* represents the valid values. XRFDC_MIXER_SCALE_AUTO - If mixer mode is R2C, Mixer Scale is set to 1 and for other modes mixer scale is set to 0.7 XRFDC_MIXER_SCALE_1P0 - To set fine mixer scale to 1. XRFDC_MIXER_SCALE_0P7 - To set fine mixer scale to 0.7.

◆ XRFdc_SetNyquistZone()

u32 XRFdc_SetNyquistZone ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u32  Block_Id,
u32  NyquistZone 
)

#include <xrfdc.c>

Set the Nyquist zone.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
NyquistZonevalid values are 1 (Odd),2 (Even).
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Tile not enabled.
Note
Common API for ADC/DAC blocks

◆ XRFdc_SetQMCSettings()

u32 XRFdc_SetQMCSettings ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u32  Block_Id,
XRFdc_QMC_Settings QMCSettingsPtr 
)

#include <xrfdc.c>

This API is used to update various QMC settings, eg gain, phase, offset etc.

QMC settings passed are used to update the corresponding block level registers. Driver structure is updated with the new values.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
QMCSettingsPtris Pointer to the XRFdc_QMC_Settings structure in which the QMC settings are passed.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
None

◆ XRFdc_SetThresholdClrMode()

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

#include <xrfdc.c>

This API sets the threshold clear mode.

The clear mode can be through explicit DRP access (manual) or auto clear (QMC gain update event).

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis ADCC block number inside the tile. Valid values are 0-3.
ThresholdToUpdateSelect which Threshold (Threshold0 or Threshold1 or both) to update.
ClrModecan be DRP access (manual) or auto clear (QMC gain update event).
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Only ADC blocks

◆ XRFdc_SetThresholdSettings()

u32 XRFdc_SetThresholdSettings ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
XRFdc_Threshold_Settings ThresholdSettingsPtr 
)

#include <xrfdc.c>

Threshold settings are updated into the relevant registers.

Driver structure is updated with the new values. There can be two threshold settings: threshold0 and threshold1. Both of them are independent of each other. The function returns the requested threshold (which can be threshold0, threshold1, or both.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
ThresholdSettingsPtrPointer through which the register settings for thresholds are passed to the API.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Only ADC blocks

◆ XRFdc_SetupFIFO()

u32 XRFdc_SetupFIFO ( XRFdc InstancePtr,
u32  Type,
int  Tile_Id,
u8  Enable 
)

#include <xrfdc.c>

Enable and Disable the ADC/DAC FIFO.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
Enablevalid values are 1 (FIFO enable) and 0 (FIFO Disable)
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Tile not enabled.
Note
Common API for ADC/DAC blocks

◆ XRFdc_Shutdown()

u32 XRFdc_Shutdown ( XRFdc InstancePtr,
u32  Type,
int  Tile_Id 
)

#include <xrfdc.c>

The API stops the tile as requested.

It can also stop all the tiles if asked for. It does not clear any of the existing register settings. It just stops the requested tile(s).

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3, and -1.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if tile is not enabled or available
Note
None

◆ XRFdc_StartUp()

u32 XRFdc_StartUp ( XRFdc InstancePtr,
u32  Type,
int  Tile_Id 
)

#include <xrfdc.c>

The API Restarts the requested tile.

It can restart a single tile and alternatively can restart all the tiles. Existing register settings are not lost or altered in the process. It just starts the requested tile(s).

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3, and -1.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if tile is not enabled or available
Note
None

◆ XRFdc_ThresholdStickyClear()

u32 XRFdc_ThresholdStickyClear ( XRFdc InstancePtr,
u32  Tile_Id,
u32  Block_Id,
u32  ThresholdToUpdate 
)

#include <xrfdc.c>

This API is to clear the Sticky bit in threshold config registers.

Parameters
InstancePtris a pointer to the XRfdc instance.
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
ThresholdToUpdateSelect which Threshold (Threshold0 or Threshold1 or both) to update.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Only ADC blocks

◆ XRFdc_UpdateEvent()

u32 XRFdc_UpdateEvent ( XRFdc InstancePtr,
u32  Type,
u32  Tile_Id,
u32  Block_Id,
u32  Event 
)

#include <xrfdc.c>

This function will trigger the update event for an event.

Parameters
InstancePtris a pointer to the XRfdc instance.
Typeis ADC or DAC. 0 for ADC and 1 for DAC
Tile_IdValid values are 0-3.
Block_Idis ADC/DAC block number inside the tile. Valid values are 0-3.
Eventis for which dynamic update event will trigger. XRFDC_EVENT_* defines the different events.
Returns
  • XRFDC_SUCCESS if successful.
  • XRFDC_FAILURE if Block not enabled.
Note
Common API for ADC/DAC blocks