![]() |
rfdc
Xilinx SDK Drivers API Documentation
|
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... | |
u32 XRFdc_CfgInitialize | ( | XRFdc * | InstancePtr, |
XRFdc_Config * | ConfigPtr | ||
) |
#include <xrfdc.c>
Initializes a specific XRFdc instance such that the driver is ready to use.
InstancePtr | is a pointer to the XRfdc instance. |
ConfigPtr | is 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. |
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
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3, and -1. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | indicates ADC/DAC |
Tile_Id | indicates Tile number (0-3) |
Source | Clock source internal PLL or external clock source |
RefClkFreq | Reference Clock Frequency in MHz(102.40625MHz - 1.2GHz) |
SamplingRate | Sampling 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). |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. XRFdc_BlockStatus. |
BlockStatusPtr | is Pointer to the XRFdc_BlockStatus structure through which the ADC/DAC block status is returned. |
u32 XRFdc_GetCalibrationMode | ( | XRFdc * | InstancePtr, |
u32 | Tile_Id, | ||
u32 | Block_Id, | ||
u8 * | CalibrationModePtr | ||
) |
#include <xrfdc.c>
This API is to get the Calibration mode.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
CalibrationModePtr | pointer to get the calibration mode. |
u32 XRFdc_GetClockSource | ( | XRFdc * | InstancePtr, |
u32 | Type, | ||
u32 | Tile_Id, | ||
u32 * | ClockSourcePtr | ||
) |
#include <xrfdc.c>
This function gets Clock source.
InstancePtr | is a pointer to the XRfdc instance. |
Type | indicates ADC/DAC. |
Tile_Id | indicates Tile number (0-3). |
ClockSourcePtr | Pointer to return the clock source |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
CoarseDelaySettingsPtr | Pointer to the XRFdc_CoarseDelay_Settings structure in which the Coarse Delay settings are passed. |
u32 XRFdc_GetDecimationFactor | ( | XRFdc * | InstancePtr, |
u32 | Tile_Id, | ||
u32 | Block_Id, | ||
u32 * | DecimationFactorPtr | ||
) |
#include <xrfdc.c>
Decimation factor are returned back to the caller.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
DecimationFactorPtr | Pointer to return the Decimation factor for DAC blocks. |
u32 XRFdc_GetDecoderMode | ( | XRFdc * | InstancePtr, |
u32 | Tile_Id, | ||
u32 | Block_Id, | ||
u32 * | DecoderModePtr | ||
) |
#include <xrfdc.c>
Decoder mode is read and returned back.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is DAC block number inside the tile. Valid values are 0-3. |
DecoderModePtr | Valid values are 1 (Maximum SNR, for non-randomized decoder), 2 (Maximum Linearity, for randomized decoder) |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
FabClkDivPtr | is a pointer to get fabric clock for a tile. XRFDC_FAB_CLK_* defines the valid divider values. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
FabricRdVldWordsPtr | Pointer to return the fabric data rate for ADC/DAC block |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
FabricWrVldWordsPtr | Pointer to return the fabric data rate for DAC block |
u32 XRFdc_GetFIFOStatus | ( | XRFdc * | InstancePtr, |
u32 | Type, | ||
u32 | Tile_Id, | ||
u8 * | EnablePtr | ||
) |
#include <xrfdc.c>
Current status of ADC/DAC FIFO.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
EnablePtr | valid values are 1 (FIFO enable) and 0 (FIFO Disable) |
u32 XRFdc_GetInterpolationFactor | ( | XRFdc * | InstancePtr, |
u32 | Tile_Id, | ||
u32 | Block_Id, | ||
u32 * | InterpolationFactorPtr | ||
) |
#include <xrfdc.c>
Interpolation factor are returned back to the caller.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
InterpolationFactorPtr | Pointer to return the interpolation factor for DAC blocks. |
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).
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is DAC block number inside the tile. Valid values are 0-3. |
EnablePtr | is a pointer to get the inv-sinc status. valid values are 0(disable) and 1(enable). |
u32 XRFdc_GetIPStatus | ( | XRFdc * | InstancePtr, |
XRFdc_IPStatus * | IPStatusPtr | ||
) |
#include <xrfdc.c>
The API returns the IP status.
InstancePtr | is a pointer to the XRfdc instance. |
IPStatusPtr | Pointer to the XRFdc_IPStatus structure through which the status is returned. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | indicates Tile number (0-3). |
Block_Id | indicates Block number(0-3 for 2G, 0-1 for 4G). |
ModePtr | pointer to get link coupling mode. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
MixerSettingsPtr | Pointer to the XRFdc_Mixer_Settings structure in which the Mixer/NCO settings are passed. |
u32 XRFdc_GetNyquistZone | ( | XRFdc * | InstancePtr, |
u32 | Type, | ||
u32 | Tile_Id, | ||
u32 | Block_Id, | ||
u32 * | NyquistZonePtr | ||
) |
#include <xrfdc.c>
Get the Nyquist zone.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
NyquistZonePtr | Pointer to return the Nyquist zone. |
u32 XRFdc_GetOutputCurr | ( | XRFdc * | InstancePtr, |
u32 | Tile_Id, | ||
u32 | Block_Id, | ||
u32 * | OutputCurrPtr | ||
) |
#include <xrfdc.c>
Get Output Current for DAC block.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
OutputCurrPtr | pointer to return the output current. |
u32 XRFdc_GetPLLLockStatus | ( | XRFdc * | InstancePtr, |
u32 | Type, | ||
u32 | Tile_Id, | ||
u32 * | LockStatusPtr | ||
) |
#include <xrfdc.c>
This function gets PLL lock status.
InstancePtr | is a pointer to the XRfdc instance. |
Type | indicates ADC/DAC. |
Tile_Id | indicates Tile number (0-3). |
LockStatusPtr | Pointer to return the PLL lock status |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
QMCSettingsPtr | Pointer to the XRFdc_QMC_Settings structure in which the QMC settings are passed. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
ThresholdSettingsPtr | Pointer through which the register settings for thresholds are passed back.. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
DACSyncConfigPtr | is pointer to DAC Multi-Tile Sync config structure. |
ADCSyncConfigPtr | is pointer to ADC Multi-Tile Sync config structure. |
SysRefEnable | valid values are 0(disable) and 1(enable). |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
DigitalDataPathMask | is the DataPath mask. First 4 bits represent 4 data paths, 1 means enabled and 0 means disabled. |
DataType | is mixer data type, valid values are XRFDC_MB_DATATYPE_* |
DataConverterMask | is block enabled mask (input/output driving blocks). 1 means enabled and 0 means disabled. |
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
ConfigPtr | pointer to Multi-tile sync config structure. |
PLL_CodesPtr | pointer to PLL analog sysref capture. |
T1_CodesPtr | pointer to T1 analog sysref capture. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
ConfigPtr | Multi-tile sync config structure. |
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).
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3, and -1. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
u32 XRFdc_SetCalibrationMode | ( | XRFdc * | InstancePtr, |
u32 | Tile_Id, | ||
u32 | Block_Id, | ||
u8 | CalibrationMode | ||
) |
#include <xrfdc.c>
This API is to set the Calibration mode.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
CalibrationMode | valid values are 1 and 2. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
CoarseDelaySettingsPtr | is Pointer to the XRFdc_CoarseDelay_Settings structure in which the CoarseDelay settings are passed. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
DecimationFactor | to be set for DAC block. XRFDC_INTERP_DECIM_* defines the valid values. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is DAC block number inside the tile. Valid values are 0-3. |
DecoderMode | Valid values are 1 (Maximum SNR, for non- randomized decoder), 2 (Maximum Linearity, for randomized decoder) |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
FabClkDiv | to be set for a tile. XRFDC_FAB_CLK_* defines the valid divider values. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC block number inside the tile. Valid values are 0-3. |
FabricRdVldWords | is Read fabric rate to be set for ADC block. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
FabricWrVldWords | is write fabric rate to be set for DAC block. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
InterpolationFactor | to be set for DAC block. XRFDC_INTERP_DECIM_* defines the valid values. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is DAC block number inside the tile. Valid values are 0-3. |
Enable | valid values are 0(disable) and 1(enable). |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
MixerSettingsPtr | Pointer to the XRFdc_Mixer_Settings structure in which the Mixer/NCO settings are passed. |
u32 XRFdc_SetNyquistZone | ( | XRFdc * | InstancePtr, |
u32 | Type, | ||
u32 | Tile_Id, | ||
u32 | Block_Id, | ||
u32 | NyquistZone | ||
) |
#include <xrfdc.c>
Set the Nyquist zone.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
NyquistZone | valid values are 1 (Odd),2 (Even). |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
QMCSettingsPtr | is Pointer to the XRFdc_QMC_Settings structure in which the QMC settings are passed. |
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).
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADCC block number inside the tile. Valid values are 0-3. |
ThresholdToUpdate | Select which Threshold (Threshold0 or Threshold1 or both) to update. |
ClrMode | can be DRP access (manual) or auto clear (QMC gain update event). |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
ThresholdSettingsPtr | Pointer through which the register settings for thresholds are passed to the API. |
u32 XRFdc_SetupFIFO | ( | XRFdc * | InstancePtr, |
u32 | Type, | ||
int | Tile_Id, | ||
u8 | Enable | ||
) |
#include <xrfdc.c>
Enable and Disable the ADC/DAC FIFO.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
Enable | valid values are 1 (FIFO enable) and 0 (FIFO Disable) |
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).
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3, and -1. |
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).
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3, and -1. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
ThresholdToUpdate | Select which Threshold (Threshold0 or Threshold1 or both) to update. |
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.
InstancePtr | is a pointer to the XRfdc instance. |
Type | is ADC or DAC. 0 for ADC and 1 for DAC |
Tile_Id | Valid values are 0-3. |
Block_Id | is ADC/DAC block number inside the tile. Valid values are 0-3. |
Event | is for which dynamic update event will trigger. XRFDC_EVENT_* defines the different events. |