Analog Devices ADRV9005 Reference Manual page 51

Reference Manual
SYSTEM INITIALIZATION AND SHUTDOWN
Table 15. Warm Boot APIs
API
adi_adrv9001_cals_InitCals_WarmBoot_Coefficients_MaxArray_Get()
adi_adrv9001_cals_InitCals_WarmBoot_Coefficients_MaxArray_Set()
adi_adrv9001_cals_InitCals_WarmBoot_Coefficients_UniqueArray_Get()
adi_adrv9001_cals_InitCals_WarmBoot_Coefficients_UniqueArray_Set()
adi_adrv9001_cals_InitCals_WarmBoot_UniqueEnabledCals_Get()
adi_adrv9001_Utilities_InitCals_WarmBoot_Coefficients_MaxArrayChunk_Get()
adi_adrv9001_Utilities_InitCals_WarmBoot_Coefficients_MaxArrayChunk_Set()
adi_adrv9001_Utilities_InitCals_WarmBoot_Coefficients_VectTblChunkRead()
After the first initial calibration of the device, follow the below procedure for the desired warm boot method.
Procedure for non-memory-optimized APIs is as follows:
Allocate memory for the warm boot coefficients by using the adi_adrv9001_Warmboot_Coeff data structure.
►
Call adi_adrv9001_cals_InitCals_WarmBoot_Coefficients_UniqueArray_Get() after the first initialization at "Calibrated," "Primed", or
►
"RF_enabled" channel state. Also provide the channel 1 and 2 initial calibration masks when calling the 'get' API.
When performing reinitialization with the same profile after resetting the system, set the warm boot flag in the profile.
►
Perform all the initialization steps without running initial calibration.
►
Call adi_adrv9001_cals_InitCals_WarmBoot_Coefficients_MaxArray_Set() to load the pre-saved initial calibration coefficients to the
►
device.
Call the initial calibration API. Note that based on the warm boot flag, this API only applies the loaded coefficients without actually performing
►
the initial calibration.
Procedure for memory-optimized APIs is as follows:
Retrieve the memory requirements for the warm boot coefficients using adi_adrv9001_cals_InitCals_WarmBoot_UniqueEnabled-
►
Cals_Get(), and then allocate this memory.
Call the get API after the first initialization at "Calibrated," "Primed", or "RF_enabled" channel state. Also provide the channel 1 and 2 initial
►
calibration masks when calling the 'get' API.
When performing reinitialization with the same profile after resetting the system, set the warm boot flag in the profile.
►
Perform all the initialization steps without running initial calibration.
►
Call the adi_adrv9001_cals_InitCals_WarmBoot_Coefficients_UniqueArray_Set() API to load the pre-saved initial calibration coefficients
►
to the device.
Call the initial calibration API. Note that based on the warm boot flag, this API only applies the loaded coefficients without actually performing
►
the initial calibration.
Procedure for chunk-loading APIs is as follows:
Use adi_adrv9001_cals_InitCals_WarmBoot_UniqueEnabledCals_Get(), to retrieve the number of cals enabled.
►
For getting warm boot coeffients:
►
Iterate through each cal.
►
Read the vector table data for that cal using adi_adrv9001_Utilities_InitCals_WarmBoot_Coefficients_VectTblChunkRead().
►
Using vector table information, retrieve the warm boot coefficient for that cal using adi_adrv9001_Utilities_InitCals_WarmBoot_Coeffi-
►
cients_MaxArrayChunk_Get(). Either retrieve the cal in one chunk or optionally split it into smaller chunks.
When performing reinitialization with the same profile after resetting the system, set the warm boot flag in the profile.
►
Perform all the initialization steps without running initial calibration.
►
For setting warm boot coeffients:
►
Iterate through each cal.
►
analog.com
Description
Read the InitCal coefficients needed for warm boot (Non-memory-optimized).
Write the InitCal coefficients needed for warm boot (Non-memory-optimized).
Read the InitCal coefficients needed for warm boot and place in allocated memo-
ry. (Memoy-optimized).
Write the InitCal coefficients needed for warm boot from allocated memory. (Memoy-
optimized).
Return the unique initCals enabled and the required memory size for this device
configuration. (Memoy-optimized).
Read the InitCal coefficients needed for Warmboot in chunks.
Write the InitCal coefficients needed for Warmboot in chunks.
Read the InitCal cal coefficient table.
ADRV9001
Rev. A | 51 of 377