System Initialization And Shutdown; Tes Configuration And Initialization - Analog Devices ADRV9001 User Manual

UG-1828

SYSTEM INITIALIZATION AND SHUTDOWN

A graphical user interface (GUI) based transceiver evaluation software (TES) is provided to user to initialize and interact with the
ADRV9001 device. Through this TES, the user could provide high level system configuration parameters such as signal bandwidth,
sample rate and initial gain control settings to initialize the device. The TES utilizes the user provided parameters to set up an
initialization C structure and then makes multiple API calls in a proper order to initialize the device. During the normal operation of the
device, the TES allows further user interaction with the device, such as adjusting the transmit/receive gain on the fly. When the operation
is completed, the user could safely shut down the device through TES. Figure 16 describes the high level flow of the device operation
sequence and the user interaction through TES.
INITIALIZATION
NORMAL OPERATION
As indicated in Figure 16, the purpose of this section is to provide user information about the initialization and shutdown process for the
ADRV9001 device utilizing the APIs developed by ADI. Figure 16 listed all high level APIs used for initialization and shutdown. In the
later sections, the major steps associated with each high level API command is further discussed. Note with Software Development Kit
(SDK) provided to the user, The ADRV9001 device can be initialized through user's own software program independent of TES.
However, the same API calling procedure described in this document should be followed.
Note all the information discussed in this section is subject to change over the time. It is not the intention of this section to explain every
related API function. Detailed information regarding the API functions can be found in the ADRV9001 Device API doxygen document.
In addition, this section does not describe API integration and the hardware abstraction Interface. Details of such can be found in the
Software Integration section and HAL Integration section. To find more details about the TES, refer to the Transceiver Evaluation
Software (TES) section.

TES CONFIGURATION AND INITIALIZATION

The TES provides a Config tab that contains all the setup options for the ADRV9001. Under the Config tab, the user could configure
each channel of the device for a desired profile under the Device Configuration subtab, which sets high level parameters such as duplex
mode, data port sample rates and RF channel bandwidth. Then the user could further initialize the options used by the device during
startup under the Initialization subtab, such as the carrier frequencies, ADC type and initial calibrations. Note GUI design could change
significantly over the time, see the ADRV9001 Evaluation System section for up-to-date information.
Based on the parameters set by user, an initialization structure, adi_adrv9001_Init_t, is formulated by TES to contain all the required
settings to configure the device. This structure contains the system configuration setting, the system clock settings, transmit/receive data
structure settings and Programmable FIR filter settings. Please refer to the doxygen document for more details.
START
USER PROVIDES
INITIALIZATION
PARAMETERS
TO TES.
TES SETS UP THE
C STRUCTURE
AND CALLS
API COMMANDS.
USER ADJUST
PARAMETERS ON
THE FLY THROUGH TES.
USER SAFELY
SHUTDOWN
SHUTS DOWN THE
DEVICE THROUGH TES.
END
Figure 16. High level Flow Chart of the Device Operation and User Interaction through TES
1: adi_adrv9001_InitAnalog
2: adi_adrv9001_Utilities_Resources_Load
3: adi_adrv9001_Utilities_InitRadio_Load
4: adi_adrv9001_cals_InitCals_Run
5: adi_adrv9001_Radio_Channel_Prime
1: adi_adrv9001_Shutdown
Rev. PrA | Page 36 of 253
Preliminary Technical Data
API COMMANDS
...