Analog Devices ADRV9001 User Manual page 129

Reference Manual
FREQUENCY HOPPING
Table 55. Data Structures and Enums Related to Frequency Hopping (Continued)
Data Structure/Enum
adi_adrv9001_FhhopTableSelectCfg_t
adi_adrv9001_FhCfg_t
adi_adrv9001_FhFrameIndex_e
adi_adrv9001_FhHopSignal
adi_adrv9001_FhHopTable_e
adi_adrv9001_FhHopTableSelectMode_e
adi_adrv9001_FhMode_e
adi_adrv9001_TableIndexCtrl_e
Table 56. API Commands Related to Frequency Hopping
Function Name
adi_adrv9001_fh_Configure()
adi_adrv9001_fh_Configuration_Inspect()
adi_adrv9001_fh_FrameInfo_Inspect()
adi_adrv9001_fh_Hop()
adi_adrv9001_fh_HopTable_BytesPerTable_Get()
adi_adrv9001_fh_HopTable_Dynamic_Configure()
adi_adrv9001_fh_HopTable_Get()
adi_adrv9001_fh_HopTable_Inspect()
adi_adrv9001_fh_HopTable_Set()
adi_adrv9001_fh_HopTable_Static_Configure()
adi_adrv9001_fh_RxOffsetFrequency_Set()
Note: The preceding table shows that the API adi_adrv9001_fh_HopTable_Dynamic_Configure() is only used to dynamically load the
hopping table in the ADRV9001 evaluation system due to the limitation of the FPGA. In the user systems adi_adrv9001_fh_HopTable_Stat-
ic_Configure() is the correct API to load the hopping table either statically at the initialization time or dynamically during hopping. To learn the
API use in the different modes of FH operations, use the TES "Driver Debugger" feature or auto generated code.
analog.com
Description
Load any valid receiver gain index or transmitter attenuation level in the tables.
Hop Table Select configurations
Contains ADRV9001 Frequency Hopping data types
Enumeration of hop frame indices.
Enumeration of hop signals.
Enumeration of frequency hopping table IDs.
Enumeration of frequency hopping table select modes.
Enumeration of frequency hopping modes.
Enumeration of frequency hopping table indexing control mode
Description
Configures Frequency Hopping settings.
Inspects/reads the parameters in the frequency hopping configuration data structure..
Gets hop frame information for specified index. The ADRV9001 maintains the state for two frequency hopping
frames: current frame and upcoming frame (frame at next hop edge). This command fetches the hop frame
information, as specified by adi_adrv9001_FhHopFrame_t, from any of these states. Receiver Offset frequency
information is only valid for receiver Channel(s) in the RF_ENABLED state.
Triggers the hop signal by either SPI or mailbox.
This API has no effect if it is called before any channel, enabled for frequency hopping, is in the PRIMED state.
Gets number of SPI packed bytes per dynamic FH table load.
This API is only used for ADRV9001 evaluation system. Do not use in own system.
Gets the hop table currently in use.
Inspects frequency hopping table in ARM memory.
This function reads back a frequency hopping table from the ARM memory and loads it into hopTable. The
frequency hopping table to read back is specified by a tableId.
Sets which hop table to use.
Invokes the selection of FH_HOP_TABLE_A or FH_HOP_TABLE_B.
Loads a frequency hopping table into the ARM memory. A frequency hopping table is made up by an array of
hop frame information defined by adi_adrv9001_FhHopFrame_t. Use this API for both static and dynamic table
loading in own system.
Writes the receiver offset frequency to update NCO with subsequent GPIO Pulse.
ADRV9001
Rev. 0 | 129 of 351