Receive Data Chain Api Programming - Analog Devices ADRV9001 User Manual

UG-1828
samples according to the phase parameter configured by user through an API command. Currently, it is only programmable by the
device. More user interaction will be provided in the future.
NB FSK Discrimination
In NB applications, the ADRV9001 device provides the capability of demodulating and detecting FSK/FM signals. This block has 2
operation modes, one is detecting mode and the other is detected mode. The detecting mode is only used when Monitor Mode is
enabled. It is employed to detect the FSK/FM signals. As mentioned earlier, the signal detection could be accomplished by RSSI only.
However, this block could be further utilized in NB mode to achieve more accurate signal detection. After FSK/FM signal is detected, this
block will operate in the detected mode. Some components in the datapath will be reconfigured to operate differently from the detecting
mode. In case no FSK/FM signal is detected, TRx will move to sleep mode.
It is well known that DMR and FM radio has an about 90% idle time, during which, both RF front end and baseband processor are put to
sleep to save power. As a traditional solution, both baseband processor and TRx have to power up to do the carrier detection and TRx
only passes through the data. With the equipped capability of the ADRV9001, it detects the DMR and FM signal independent of the
baseband processor during its idle state, so that the baseband processor could sleep at the whole idle state to extent the battery life. Please
refer to Rx Demodulator section for more details.

RECEIVE DATA CHAIN API PROGRAMMING

A set of Rx data chain APIs are provided for user interaction with the ADRV9001 device receive datapath. Some of them have been
briefly discussed in the previous sections. This set of APIs could be classified into 3 categories: Rx Gain APIs, Interface Gain APIs and
Miscellaneous APIs as shown in Table 39, Table 40, and Table 41 respectively. Each table summarizes the list of API functions with a
brief description for each one. More APIs will be provided to user in the future to allow more programmability of the receiver datapath.
Please refer to the ADRV9001 Device API doxygen document for more details.
Table 39. A List of Rx Gain APIs
Rx Gain API Function Name
adi_adrv9001_Rx_GainTable_Write
adi_adrv9001_Rx_MinMaxGainIndex_Set
adi_adrv9001_Rx_GainTable_Read
adi_adrv9001_Rx_Gain_Set
adi_adrv9001_Rx_Gain_Get
Table 40. A List of Interface Gain APIs
Rx Gain API Function Name
adi_adrv9001_Rx_InterfaceGain_Configure
adi_adrv9001_Rx_InterfaceGain_Set
adi_adrv9001_Rx_InterfaceGain_Inspect
adi_adrv9001_Rx_InterfaceGain_Get
adi_adrv9001_Rx_DecimatedPower_Get
Table 41. A List of Rx Miscellaneous APIs
Rx Miscellaneous API Function Name
adi_adrv9001_Rx_Rssi_Read
adi_adrv9001_Rx_FrequencyCorrection_Set
adi_adrv9001_Rx_AdcSwitchEnable_Set
adi_adrv9001_Rx_AdcSwitchEnable_Get
adi_adrv9001_Rx_AdcSwitch_Configure
adi_adrv9001_Rx_AdcSwitch_Inspect
adi_adrv9001_Rx_AdcType_Get
Description
Programs the gain table settings for Rx channels.
Updates the minimum and maximum gain indices for a requested Rx/ORx Channel in the
device data structure
Reads the gain table entries for Rx channels requested.
Sets the Manual Gain Index for the given Rx channel.
Reads the Rx Gain Index for the requested Rx channel
Description
Sets the Rx interface gain control configuration parameters for the given Rx channel.
Sets the Rx interface gain for the given Rx channel.
Gets the Rx interface gain control configuration parameters for the given Rx channel.
Gets the Rx interface gain for the given Rx channel.
Gets the decimated power at configurable locations for the specified channel.
Description
Reads the received signal power measurement in both linear and dB format.
Corrects for small deviations in Rx LO frequency offset.
Sets the readiness of dynamic switch between Low Power and High Performance ADCs.
Gets the readiness of dynamic switch between Low Power and High Performance ADCs.
Configures ADC dynamic switch settings for the specified channel.
Inspects the current ADC dynamic switch settings for the specified channel.
Gets the current ADC type for the specified channel.
Rev. PrA | Page 106 of 253
Preliminary Technical Data