Api Initialization Sequence - Analog Devices ADRV9001 User Manual

Reference Manual ADRV9001
SYSTEM INITIALIZATION AND SHUTDOWN
The TES also generates MATLAB, Python (.py), C# or C code, which includes all high level API initialization calls. Store these automatically
generated codes in a location of choice for future use.

API INITIALIZATION SEQUENCE

As previously mentioned, the initialization sequence consists of a serial of API calls intermixed with user-defined function calls specific to the
hardware platform. The API functions perform all the necessary tasks for device configuration, calibration, and control. Figure 21 shows the
state machine of the device from power-up to RF enabled.
Figure 21. Device State Machine
As shown in Figure 21, after power-up, the device automatically enters the standby state. Then, the device initialization and calibration begin. If
it is successful, the device moves to the calibrated state, or else, it remains in the standby state. Note that when TES completes programming,
the device is in the calibrated state. After the device is calibrated, move it to the primed state, which indicates the device is ready for operation.
Then, through SPI or PIN mode, move the device to the RF-enabled state by enabling the transmit/receive channels so transmission and
reception can start. In TES, after programming, playing the receiver or transmitter moves the device from the calibrated state to the primed
state and then to the RF-enabled state.
This section mainly discusses the device initialization procedure from the standby state to the RF_ENABLED state. The following subsections
discuss the related high-level API functions briefly. For details of each API function, refer to the Doxygen document.
Note for MIMO systems with multiple input and output channels, multiple ADRV9001 devices might be involved. To synchronize among all the
devices, it requires a common device clock (DEV_CLOCK) and an MCS signal so that all the internally generated analog and digital clocks are
aligned among all the devices. In addition, the MCS is used to synchronize the device and baseband processor data interface for all devices.
For simplicity, in the following descriptions, MCS operations are excluded from the initialization steps. For more details, see the Multichip
Synchronization section.
Analog Initialization
Analog initialization API adi_adrv9001_InitAnalog() is the very first API call to configure the device after all dependent data structures are
initialized. It mainly sets the controller bias, enables the reference clock, and validates the profile settings.
analog.com Rev. 0 | 43 of 351