Question 1

Using Warmboot Via API

Accepted Answer

Warmboot can be used in TES but can't be used to generate C99 code for warmboot due to the evaluation system limitations. In this document, a code sample of how you might use warmboot via APIs. Warmboot is detailed in greater detail in our User Guide. 
 There are two types of warmboot APIs: memory optimised and non-memory optimised. The &lsquo;Max Array&rsquo; functions are the non-memory optimised version and the &lsquo;Unique Array&rsquo; is the memory optimised version. In this document we will use the memory optimised functions. 
 The warmboot APIs are shown below and detailed more extensively in the doxygen file that comes with our SDK. 
 
 To use these, the general steps are: 
 
 Use the adi_adrv9001_cals_InitCals_WarmBoot_UniqueEnabledCals_Get() function to calculate the memory requirements 
 Assign the correct amount of memory as calculated 
 Use the adi_adrv9001_cals_InitCals_WarmBoot_Coefficients_UniqueArray_Get/Set() functions to set and get wb coefficients to/from the assigned memory location 
 
 This should have much lower memory requirements than the non-memory optimised version. 
 A code snippet is shown below. This code snippet is an edited version of the auto-generated 'main.c' C99 code from TES. This file was used to replace the 'main.c' file and compiled and run in a similar fashion to as described here . An example method of reading and writing the coefficients to a binary file is also included. This may be useful if you intend to load calibrations that were stored previously.

/* This file contains code automatically generated by a machine. */ /* It has not been independently verified by any human. */ /* The generation process is deterministic and tested (not generative AI), */ /* but not every scenario or risk has been captured in unit tests. */ /* All code is provided as-is for example purposes only. */ /* The customer assumes all risks related to the use of this code. */

/* Transceiver Name: ADRV9002*/ /* Silicon Revision: C0*/ /* Evaluation Board Revision: 2A*/ /* Tx / Rx optimal carrier frequencies: 30 MHz to 3 GHz*/ /* External LO optimal frequencies: 60 MHz to 6 GHz*/ /* */ /* FPGA: v8.3.7*/ /* Device Driver API: v68.13.12*/ /* Device Driver Client: v68.13.12*/ /* Firmware: v0.22.33*/ /* Profile Generator: v0.53.7.0*/ /* Stream Generator Assembly: v0.7.12.0*/ /* Transceiver Evaluation Software: v0.26.1*/ /* ADRV9001 Plugin: v0.26.1*/ 
 
 #include "initialize.h" #include "calibrate.h" #include "configure.h" #include "prime.h" #include "beginReceiving.h" #include "dataCapture.h" #include "stopReceiving.h" #include "beginTransmitting.h" #include "stopTransmitting.h" #include <stdlib.h> #include "linux_uio_init.h" //extern adi_adrv9001_Init_t initialize_init_8;

int main() { &emsp;&emsp;int32_t error_code = 0; 
 
 &emsp;&emsp;adi_adrv9001_Device_t * adrv9001Device_0 = (adi_adrv9001_Device_t *) calloc(1, sizeof(adi_adrv9001_Device_t)); 
 
 &emsp;&emsp;adi_fpga9001_Device_t * fpga9001Device_0 = (adi_fpga9001_Device_t *) calloc(1, sizeof(adi_fpga9001_Device_t)); 
 
 &emsp;&emsp;error_code = linux_uio_initialize(adrv9001Device_0, fpga9001Device_0, NULL, NULL, NULL, NULL, NULL); &emsp;&emsp;ADI_HANDLE_ERROR(error_code);

&emsp;&emsp;error_code = initialize(adrv9001Device_0, fpga9001Device_0); &emsp;&emsp;ADI_HANDLE_ERROR(error_code); 
 
 &emsp;&emsp;error_code = calibrate(adrv9001Device_0); &emsp;&emsp;ADI_HANDLE_ERROR(error_code); printf("\033[0;32m"); printf("%s", "
Calibration is done and coefficients are stored for warm boot up. Press enter
"); &emsp;&emsp;getchar(); &emsp;&emsp;ADI_HANDLE_ERROR(error_code); printf("\033[0;37m"); //3. Get wb coefficients 
 
 &emsp;&emsp;adi_adrv9001_InitCals_t initCals = { &emsp;&emsp;&emsp;&emsp;.sysInitCalMask = (adi_adrv9001_InitCalibrations_e) 0, &emsp;&emsp;&emsp;&emsp;.chanInitCalMask = { ADI_ADRV9001_INIT_CAL_TX_QEC | ADI_ADRV9001_INIT_CAL_TX_LO_LEAKAGE | ADI_ADRV9001_INIT_CAL_TX_LB_PD | ADI_ADRV9001_INIT_CAL_TX_BBAF | ADI_ADRV9001_INIT_CAL_TX_BBAF_GD | ADI_ADRV9001_INIT_CAL_TX_ATTEN_DELAY | ADI_ADRV9001_INIT_CAL_TX_DAC | ADI_ADRV9001_INIT_CAL_TX_PATH_DELAY | ADI_ADRV9001_INIT_CAL_RX_HPADC_FLASH | ADI_ADRV9001_INIT_CAL_RX_LPADC | ADI_ADRV9001_INIT_CAL_RX_TIA_CUTOFF | ADI_ADRV9001_INIT_CAL_RX_GROUP_DELAY | ADI_ADRV9001_INIT_CAL_RX_QEC_TCAL | ADI_ADRV9001_INIT_CAL_RX_QEC_FIC | ADI_ADRV9001_INIT_CAL_RX_RF_DC_OFFSET | ADI_ADRV9001_INIT_CAL_RX_GAIN_PATH_DELAY, (adi_adrv9001_InitCalibrations_e) 0 }, &emsp;&emsp;&emsp;&emsp;.calMode = ADI_ADRV9001_INIT_CAL_MODE_ALL, &emsp;&emsp;&emsp;&emsp;.force = false}; 
 
 &emsp;&emsp;adi_adrv9001_Warmboot_CalNumbers_t calNumbers = {}; // 3.a Find wb memory requirements &emsp;&emsp;error_code = adi_adrv9001_cals_InitCals_WarmBoot_UniqueEnabledCals_Get(adrv9001Device_0, &calNumbers, initCals.chanInitCalMask[0], initCals.chanInitCalMask[1]); ADI_HANDLE_ERROR(error_code); printf("Num Cals: %d, Num Bytes: %d 
", calNumbers.numberUniqueEnabledCals, calNumbers.warmbootMemoryNumBytes); // 3.b Allocate some memory for wb coeff &emsp;&emsp;char * wb_memStartAddress_get = (char *)calloc(1, calNumbers.warmbootMemoryNumBytes); &emsp;&emsp;// 3.c Get wb coeff &emsp;&emsp;error_code = adi_adrv9001_cals_InitCals_WarmBoot_Coefficients_UniqueArray_Get(adrv9001Device_0, wb_memStartAddress_get, initCals.chanInitCalMask[0], initCals.chanInitCalMask[1]); ADI_HANDLE_ERROR(error_code); //optionally save to file &emsp;&emsp;FILE* f_write = fopen("warmboot_coeff.bin", "wb"); &emsp;&emsp;fwrite(wb_memStartAddress_get, calNumbers.warmbootMemoryNumBytes, 1, f_write); &emsp;&emsp;fclose(f_write); 
 
 &emsp;&emsp;free(wb_memStartAddress_get); //4. Reset printf("\033[0;32m"); printf("%s", "
Hardware reset for initializing warm bootup. Press enter.
"); getchar(); &emsp;&emsp; ADI_HANDLE_ERROR(error_code); printf("\033[0;37m"); 
 
 &emsp;&emsp;error_code = adi_adrv9001_HwReset(adrv9001Device_0); ADI_HANDLE_ERROR(error_code); // 5. WB Init &emsp;&emsp;// 5.a set wb flag &emsp;&emsp;initialize_init_8.sysConfig.warmBootEnable = true; &emsp;&emsp;// 5.b init &emsp;&emsp;error_code = initialize(adrv9001Device_0, fpga9001Device_0); ADI_HANDLE_ERROR(error_code); //6. Set wb coefficients &emsp;&emsp;char * wb_memStartAddress_set = (char *)calloc(1, calNumbers.warmbootMemoryNumBytes); &emsp;&emsp;//optionally read from file &emsp;&emsp;FILE* f_read = fopen("warmboot_coeff.bin", "rb"); &emsp;&emsp;fread(wb_memStartAddress_set, calNumbers.warmbootMemoryNumBytes, 1, f_read); &emsp;&emsp;fclose(f_read); &emsp;&emsp;error_code = adi_adrv9001_cals_InitCals_WarmBoot_Coefficients_UniqueArray_Set(adrv9001Device_0, wb_memStartAddress_set, initCals.chanInitCalMask[0], initCals.chanInitCalMask[1]); ADI_HANDLE_ERROR(error_code); free(wb_memStartAddress_set); 
 
 &emsp;&emsp;//7. Wb cal printf("\033[0;32m"); printf("%s", "
Using warm bootup coefficients. Press enter.
"); getchar(); &emsp;&emsp; ADI_HANDLE_ERROR(error_code); printf("\033[0;37m"); 
 
 &emsp;&emsp;error_code = calibrate(adrv9001Device_0); ADI_HANDLE_ERROR(error_code);

&emsp;&emsp; //8. Rest of Program &emsp;&emsp;error_code = configure(adrv9001Device_0); &emsp;&emsp;ADI_HANDLE_ERROR(error_code); 
 
 &emsp;&emsp;error_code = prime(adrv9001Device_0); &emsp;&emsp;ADI_HANDLE_ERROR(error_code); 
 
 &emsp;&emsp;error_code = beginReceiving(adrv9001Device_0, fpga9001Device_0); &emsp;&emsp;ADI_HANDLE_ERROR(error_code); 
 
 &emsp;&emsp;error_code = dataCapture(fpga9001Device_0); &emsp;&emsp;ADI_HANDLE_ERROR(error_code); 
 
 &emsp;&emsp;error_code = stopReceiving(fpga9001Device_0); &emsp;&emsp;ADI_HANDLE_ERROR(error_code); 
 
 &emsp;&emsp;error_code = beginTransmitting(adrv9001Device_0, fpga9001Device_0); &emsp;&emsp;ADI_HANDLE_ERROR(error_code); 
 
 &emsp;&emsp;error_code = stopTransmitting(fpga9001Device_0); &emsp;&emsp;ADI_HANDLE_ERROR(error_code);

&emsp;&emsp;return error_code; }

Question 2

Enhanced SSI In TES

Accepted Answer

22-bit signal type (also known as Enhanced SSI) can be used on the receiver (Configure -> Device Configuration -> Rx1) to carry extra information like gain index or interface gain. 
 
 To display the gain on your IQ data graph, first enable 22-bit mode as described above, then go to &ldquo;Gain Control -> Gain Bits&rdquo; and select what you want those extra bits to show. 
 
 Now when in the &ldquo;Receive&rdquo; tab, you can now observe the extra trace added on the IQ data graph which denominates the selected setting: Gain Index or Interface Gain. Examples of each setting are below; the pink line is the new trace added to the Waveform graph. 
 Gain Index 
 
 Interface Gain

Question 3

Loading Rx PFIR Coefficients

Accepted Answer

In this guide we&rsquo;ll outline the step-by-step procedure for generating PFIR coefficients and loading them into an ADRV9001 product using TES, as well as highlighting any key considerations to keep in mind at each step. 
 
 Step 1: Device Config and Setup 
 The first thing to do is consider your application, what type of filter best suits you and the carrier frequencies of interest. Note that the Tx frequency doesn&rsquo;t overly matter for the PFIR design. The value listed under RF Channel Bandwidth, however, is very important for you PFIR design. The initial calibration &ldquo;RX Gain Delay&rdquo; sets it calibration tone at the RF Bandwidth divided by 5, so your filter must accommodate a bandwidth of at least this size. 
 For this example, we&rsquo;ll be using an LTE setup in TDD mode with a Sampling Frequency of 61.44MHz and an Rx LO of 900MHz. For the first part we&rsquo;ll only use one channel, however we&rsquo;ll show at the end of the guide how you can program the Rx1 and Rx2 PFIR filters separately.

Step 2: Design Your Filter 
 Once satisfied with the setup, we can turn our attention to the PFIR. When TES is first opened it will have a &ldquo;Default Filter&rdquo; loaded, as shown here: 
 
 Before going to your design tool of choice we have a few things to keep in mind. The maximum number of coefficients this filter can accept is 128. If we provide it with fewer coefficients that 128, TES will append 0&rsquo;s to our filter. If we provide more, TES will only accept the first 128 coefficients. The sampling frequency of your system will have an impact your filter&rsquo;s maximum acceptable frequency, as well as the number of coefficients required to create a given filter response. This point will be illustrated soon. 
 For this example, we&rsquo;ll use the MATLAB filter design tool. To view the documentation on this tool visit: https://uk.mathworks.com/help/signal/ref/designfilt.html We&rsquo;ll generate 3 Lowpass Filters with varying cutoff (stopband) frequencies. Remembering the initial constraint imposed by the RX Gain Delay calibration, the minimum frequency we can accommodate is ~8MHz, so we&rsquo;ll design one filter with its cutoff at 8MHz, one at 10MHz and one at 20MHz, while maintaining the same stopband attenuation. 
 Firstly, let&rsquo;s design a simple lowpass filter with a cutoff frequency of 8MHz, a Passband ripple of 0.5dB and a Stopband attenuation of 50dB: 
 
 Notice we comfortably sit at 123 coefficients, which TES will accept no problem. If we now require 60dB stopband attenuation, notice that the number of coefficients increases: 
 
 At 141 coefficients, this filter is now too long to fit in the ADRV9001 PFIR. Attempting to use this filter will not throw any errors, however it will yield unpredictable responses. Increasing the desired performance in other ways, such as requiring a steeper roll-off, will also increase the filter length. Let&rsquo;s return to using the 123-coefficient filter from before. Our next task is to extract the coefficients from the Filter object: 
 
 Each coefficient is currently stored as a 32-bit floating point value. ADRV9001 devices accept signed 24-bit integer coefficients, so our next step is to convert these coefficients to values that the device will accept. The last thing to do is write the coefficients to a file. Using either a &lsquo;.txt&rsquo; or a &lsquo;.csv&rsquo; will work fine, TES expects the values to be stored in a single row. In MATLAB, just using the &lsquo;writematrix(&hellip;)&rsquo; command with default settings will work fine. For more information on this step go to: 
 https://uk.mathworks.com/help/fixedpoint/ref/num2int.html 
 https://uk.mathworks.com/help/fixedpoint/ref/quantizer.html 
 https://uk.mathworks.com/help/matlab/ref/writematrix.html

Step 3: Upload your Filter 
 With the coefficients now saved to a .csv file, we&rsquo;re at a stage now where we&rsquo;re ready to load this filter into the TES. Returning to the Filter tab, press the &lsquo;Source&rsquo; drop-down menu and select &ldquo;Upload custom filter&rdquo;. Then simply navigate to your .csv file and select it. This will upload your FIR coefficients into TES:

*Note: The slight change is Stopband performance of the filter is caused by rounding the coefficients to signed 24-bit integers. By and large this won&rsquo;t cause issues, but these discrepancies do not indicate anything has gone wrong in the process. 
 
 Step 4: Test and Verify your Filter 
 Finally, we&rsquo;ll verify the performance of this filter by receiving signals at increasingly high offsets from the LO frequency (900MHz) while maintaining the same -10dBm signal power in every test. We&rsquo;ll use 5MHz, 10MHz, and 25MHz on each of our 3 filters. 
 5MHz: 
 
 10MHz: 
 
 25MHz:

Extra Filters: 
 Now we&rsquo;ll make a 10MHz LPF and write its coefficients to a .csv file:

5MHz: 
 
 10MHz:

25MHz:

Now our final filter, with a passband of 20MHz:

5MHz: 
 
 10MHz:

25MHz:

Programming each Rx PFIR Individually: 
 Certain applications require that Rx1 and Rx2 operate on different frequency ranges. To demonstrate how the PFIR design can be accommodated for these setups, we&rsquo;ll modify our LTE setup to use both Rx1 and Rx2 by changing &ldquo;Channels&rdquo; to &ldquo;Custom&rdquo; on the Device Configuration tab. The carrier frequency tab can remain the same for this example.

Into the Rx1 PFIR we&rsquo;ll load the coefficients for the 8MHz filter design (or the Narrowband design). Rx2 will be given the 20MHz filter (or the Wideband design). To demonstrate that these filters do indeed operate independently we&rsquo;ll inject RF signals into both Rx1A and Rx2A with the same signal power (-10dBm) while increasing the offset from the carrier as we did before. 
 
 Rx1 will be colored Black. 
 Rx2 will be colored Blue. 
 
 5MHz: 
 
 10MHz:

25MHz:

Dynamically Switching PFIR Profiles: 
 The ADRV9001 product family supports dynamic switching of the PFIR profiles. Up to 4 different profiles can be stored in device memory, and any of these profiles can be loaded into any of the PFIRs on the device on demand under the control of the BBIC. More information on this functionality can be found in the RX DEMODULATOR - Rx Programmable FIR Filter section of the User Guide. 
 For more information on the API needed to call for a profile switch, read the documentation provided on the adi_adrv9001_arm.c file in the doxygen file provided in the SDK. The function of interest is called adi_adrv9001_arm_Profile_Switch(), as shown below:

Question 4

Dual Frequency Hopping as Two TDD Transceivers

Accepted Answer

The typical use of dual-hop is shown below. In this diagram, there are independent Rx1/Tx1 and Rx2/Tx2 frames. There is a dedicated hop signal to control each channel. 
 
 In this example, we will use dual hop mode to have one channel independently hopping and the second channel consistently receiving. 
 In this mode, the two channels could be viewed as two independent TDD transceivers. This allows for a great amount of flexibility. In this case, we can have channel 1 frequency hoping in a LO-retune setup and channel 2 constantly receiving data. 
 
 Dual Hop LO-Retune Example in TES 
 TES is somewhat limited for a setup like this, but more flexibility is provided in the APIs. We have included a TES session file and hopping table to simulate the system as intended above. 
 See this note in TES about dual hopping. This is only valid in TES. 
 
 For this reason, we set up the hop table with the first half of the table as values to be used in FH for channel 1 and the second half of the table to be a constant value (1.495 GHz). 
 
 You can see from the executed hop sequence that the channel 2 frequency is constant. 
 
 In the Rx tab, playing through Rx frames, it can be seen that channel 1 is frequency hopping and channel 2 is staying at a set frequency.

Recreate in TES: 
 
 Load the provided TES session file: Dual Hop Example.zip 
 Load the provided frequency hopping table 
 Program the part 
 Apply an in-band tone to Rx1/Rx2 
 In the Rx tab, play Rx and then play through the FH sequence using the popup

Question 5

RaspberryPi Example Project/HAL

Accepted Answer

To aid in understanding of the software integration, we put together an example to show how this could be achieved. We decided to use the RaspberryPi in this example as it is a well recognised device and is quite simple to understand and use. This example is intended to show how the integration with a custom controller can be achieved relatively simply and that an expensive FPGA is not necessarily needed for an end application. 
 All project files are included in the source code for the project: 2860.RPi_SDK22_Project.zip

Question 6

FDD Repeater / RF Converter Setup

Accepted Answer

ADRV9001 has internal loopbacks that can be used in a FDD repeater / RF converter application. This guide will demonstrate how to set this up in TES. 
 1) Set up the device to your desired configuration. Here, we have it set to LTE with channel 1 only enabled. 
 
 2) In the Advanced Features tab, select "Enable Rx1 Datapath to Tx1 Datapath loopback in ADRV9002". 
 
 3) In the Carriers tab, set your carriers to your desired configuration as normal. Here, we are setting Rx1 to 500 MHz and Tx1 to 1500MHz 
 
 4) Program the device and start Transmitting and Receiving. Insert an inband tone to the Rx1 port. 
 
 5) Observe the Tx1 output on a spectrum analyzer 
 
 As shown, the received signal at 510MHz has been repeated out at 1510 MHz. 
 All the usual Rx and Tx signal chain features should work in this configuration.

Question 7

Matlab Functions

Accepted Answer

Band Power This function calculates the integrated band power given a certain sample rate, frequency and bandwidth. 
 
 Inputs:
 
 x - Input data, scaled based on 16 bit signed integer, complex format 
 fs - Sample rate in Hz 
 freq - Center frequency of signal of interest, in baseband, in Hz 
 bw - Integrated bandwidth of signal of interest, in Hz

Outputs:
 
 integrated_band_power_db - integrated band power in dBFS

4540.band_power.zip

Partner Forums

Partner Libraries

Software Functions: FAQ