Capture Temperature Sensor Data from AMD FPGA Board Using FPGA Data Capture

Requirements and Prerequisites

Prepare Example Resources

Set up the AMD Vivado Design Suite. This example assumes that the AMD Vivado executable is located in the file C:\Xilinx\Vivado\2023.1\bin\vivado.bat. If the location of your executable is different, use your path instead.

hdlsetuptoolpath('ToolName','Xilinx Vivado','ToolPath', ...
                 'C:\Xilinx\Vivado\2023.1\bin\vivado.bat');

Set Up FPGA Development Board

1. Confirm that the power switch is off.

2. Connect the AC power cord to the power plug and plug the power supply adapter cable into the FPGA development board.

3. Use the JTAG download cable to connect the FPGA development board with the host computer.

4. Connect the Ethernet connector on the FPGA development board directly to the Ethernet adapter on your host machine using the crossover Ethernet cable.

5. Turn on the power switch on the FPGA board.

Generate FPGA Data Capture Components

Launch the FPGA Data Capture Component Generator tool by executing this command in MATLAB.

generateFPGADataCaptureIP

This example monitors two signals from the existing HDL code for the temperature sensor system: 16 bit temperature and 8 bit counter. The temperature signal is the reading of register 0x00 from the XADC, which stores the converted raw temperature sensor. It has 16 bits, but only the 12-bit most significant bits (MSBs) are the raw temperature sensor reading. The last signal counter is an 8 bit free-running counter. To configure the data capture components to operate on these two signals over a JTAG or Ethernet connection, follow these steps.

1. Set FPGA vendor to AMD.

2. Set Connection type to one of these options.

3. Set Generated IP language to Verilog.

4. Add one row to the Ports table by clicking the Add button once.

5. Rename the first signal to temperature and the second signal to counter.

6. Change the bit widths of the two signals to 16 and 8, respectively.

7. Set Storage type to one of these options.

*Internal memory - Stores captured data in the BRAM resources of the FPGA.

*External memory (JTAG only) - Stores captured data in external DDR memory. Select this option to capture large datasets of up to two gigasamples. This option available for JTAG connections only.

8. Set Sample depth to 1024 for internal memory storage and 1048576 for external memory storage. This is the number of samples of each signal that the data capture tool returns to MATLAB each time a trigger is detected.

9. Set Max trigger stages to 2. This value is the maximum number of trigger stages that you can add during data capture to provide multiple trigger conditions.

10. Ethernet connection only: Set IP address to 192.168.0.2 and Port address to 50101. Set Interface type to GMII. This is the type of Ethernet interface of your target FPGA development board.

This figure shows these tool settings.

To generate the FPGA data capture component, click Generate. A report shows the results of the generation.

Integrate FPGA Data Capture HDL IP

You must include the generated HDL IP core into the example FPGA design. This example connects the generated HDL IP with the temperature sensor output from XADC IP and an 8-bit free-running counter.

JTAG with Internal Memory

Follow these instructions if you set Connection type to JTAG and Storage type to Internal memory in the FPGA Data Capture Component Generator tool.

To integrate the FPGA data capture HDL IP, you can copy the module instance code from the generated report. If you are using ZedBoard, open the top.v file provided with this example. If you are using VC707, open the top_vc707.v file provided with this example. Uncomment this code.

datacapture1 u0 (
     .clk(clk),
     .clk_enable(1'b1),
     .ready_to_capture(),
     .temperature(do_out),
     .counter(counter[7:0]));

Save the file you modified, compile the modified FPGA design, and create an FPGA programming file.

If you are using ZedBoard, execute this command in MATLAB.

system('vivado -mode batch -source data_capture_xadc_zedboard.tcl &')

If you are using VC707, execute this command in MATLAB.

system('vivado -mode batch -source data_capture_xadc_vc707.tcl &')

The above mentioned Tcl scripts that are included in this example perform these steps.

1. Create a new Vivado project.

2. Add example HDL files and the generated FPGA data capture HDL files to the project.

3. Compile the design.

4. Program the FPGA.

Wait until the Vivado process successfully finishes before going to the next step. This process takes approximately 5 to 10 minutes.

JTAG with External Memory

Follow these instructions if you set Connection type to JTAG and Storage type to External memory in the FPGA Data Capture Component Generator tool.

To integrate the generated FPGA data capture HDL IP core, follow the steps below:

1. Create a Vivado project for KC705 board by executing this command in MATLAB. This command takes about one minute to run. When the execution completes, a Vivado project named data_capture_xadc_kc705.xpr appears in your current directory.

system('vivado -mode batch -source create_project_kc705.tcl &');

2. Add data capture IP to Vivado project by executing this command in MATLAB. This command adds the datacapture1 and JTAG Debug Hub IPs to Vivado user repository.

addFPGADataCaptureToVivado('data_capture_xadc_kc705.xpr','DataCaptureIPFolder','hdlsrc');

3. Open the generated Vivado project in GUI mode by double-clicking the project in a file browser or executing this command in MATLAB.

system('vivado data_capture_xadc_kc705.xpr &');

4. Create the Vivado block design with XADC IP and MIG to capture the debug data to external DDR by executing this command in Vivado Tcl console.

source ./external_data_capture_xadc_kc705.tcl

For more information about how to add the MIG IP to a Vivado block design, see Memory Interface Solutions from the AMD website.

The figure below shows the Vivado block design.

5. Add datacapture1 IP and JTAG Debug Hub to Vivado block design and complete the connections by executing this command in Vivado Tcl console.

source ./insertJTAGdatacapture.tcl

This figure shows the Vivado block design.

Wait until the Vivado process successfully finishes before going to the next step. This process takes approximately 5 to 10 minutes.

6. Remember to set the base address of the DDR memory by using the MemoryBaseAddress property before capturing the data.

Ethernet

Follow these instructions if you set Connection type to PL Ethernet in the FPGA Data Capture Component Generator tool.

To integrate FPGA data capture IP for a PL Ethernet connection, follow the below steps:

1. Create a Vivado project for KC705 board by executing this command in MATLAB. This command takes about one minute to run. When the execution completes, a Vivado project named data_capture_xadc_kc705.xpr appears in your current directory.

system('vivado -mode batch -source create_project_kc705.tcl &')

2. Open the generated Vivado project in GUI mode by double-clicking the project in a file browser or executing this command in MATLAB.

system('vivado data_capture_xadc_kc705.xpr &')

3. Navigate to the hdlsrc folder by executing this command in the Vivado Tcl console.

cd ./hdlsrc

4. Insert the Ethernet MAC Hub IP and FPGA data capture IP into Vivado project by executing this command in the Vivado Tcl console. The FPGA Data Capture Component Generator tool generates the insertEthernet.tcl script.

source ./insertEthernet.tcl

5. Complete the design by connecting IPs in the Vivado project, compile the design, and program the FPGA by executing this command in the Vivado Tcl console.

source ../ethernet_data_capture_xadc_kc705.tcl

This figure shows the block diagram in Vivado.

Wait until the Vivado process successfully finishes before going to the next step. This process takes approximately 5 to 10 minutes.

Capture Data

Navigate to the directory where the FPGA data capture component is generated in MATLAB.

cd hdlsrc

Launch the FPGA Data Capture tool. This tool is customized for your data capture signals.

launchDataCaptureApp

To start data capture click Capture Data. This action requests one buffer of captured data from the FPGA. The default trigger setting is to capture immediately, without waiting for a trigger condition.

The captured data is saved into a structure, dataCapture1Out, in the MATLAB workspace. The captured data is also displayed as signal waveforms in the Logic Analyzer tool.

The captured temperature sensor data is in raw format. The sensor data sheet gives the formula for converting raw format data to Celsius units. Calculate and report the average temperature over all of the samples returned.

CelsiusTemp = (double(dataCapture1Out.temperature))/(2^4)*503.975/4096 - 273.15;
sprintf('The FPGA Temperature is %fC\n',mean(CelsiusTemp))

Narrow Scope of Data Capture Using Triggers

To capture data from the FPGA around a particular event, you can configure trigger conditions in the FPGA Data Capture tool. For example, capture the temperature data only after a counter reaches a certain value.

Set Number of trigger stages to 1. In the Trigger Stage 1 section, set Signal to counter. Enable this trigger signal by clicking the + button. Select the corresponding trigger condition value (Value) to 10. The trigger mode automatically changes to On trigger. This change tells the FPGA to wait for the trigger condition before capturing and returning data. This figure shows these tool settings.

Click Capture Data again. This time, the data capture IP returns 1024 samples, captured when it detects that the counter equals 10.

To capture data from the FPGA for specific bits in the trigger value, irrespective of other bits, you can configure the trigger condition with a bit-masked value.

For example, to capture the temperature data only when the seventh bit of the counter is 1, set the trigger condition value (Value) to 0bX1XXXXXX as this figure shows.

Click Capture Data again. The data capture IP triggers to capture the temperature data for counter values in the range [64, 127] and [192, 255].

Capture Multiple Occurrences of Event

To capture a recurring event from the FPGA, configure Number of capture windows in the FPGA Data Capture tool. This option is disabled for external memory storage.

For example, to capture the temperature data at eight different time slots, set Number of capture windows to 8. This figure shows the updated tool settings.

Click Capture Data. The data capture IP returns eight windows of 128 samples each, which amounts to a total sample depth of 1024.

Window depth = Sample depth/Number of capture windows;

The Logic Analyzer tool shows this result as eight occurrences of the trigger, with the temperature logged for 128 samples each.

The signals Capture Window and Trigger Position indicate the corresponding window number and trigger position, respectively.

Capture Data in Multiple Trigger Stages

This scenario explains how to capture data by providing a sequence of trigger conditions in multiple trigger stages. For this action, you must set Number of trigger stages to a value greater than 1 in the FPGA Data Capture tool.

For example, to capture an temperature data when the counter value reaches from 0 to 5 in 5 clock cycles:

1. Set Number of trigger stages to 2.

2. In the Trigger Stage 1 section, set Signal to counter. Enable this trigger signal by clicking the + button. Set the corresponding trigger condition value (Value) to 0.

3. In Trigger Stage 2 section, set Signal to counter. Enable this trigger signal by clicking the + button. Set the corresponding trigger condition value (Value) to 5. Select Trigger time out and set it to 5.

This figure shows the updated tool settings.

Click Capture Data. The data capture IP captures 1024 samples when it detects the trigger condition in trigger stage 2 within 5 clock cycles, preceded by the trigger condition detected in trigger stage 1.

Capture Large Data to External DDR

To capture a large amount of data from the FPGA to external DDR, first set the memory base address according to the address mapping in the Vivado block design.

Set the memory base address to '80000000' by executing this command in MATLAB.

fpgadc_obj.MemoryBaseAddress = '80000000';

Set Number of trigger stages to 1. In the Trigger Stage 1 section, set Signal to counter. Enable this trigger signal by clicking the + button. Select the corresponding trigger condition value (Value) to 10. The trigger mode automatically changes to On trigger. This change tells the FPGA to wait for the trigger condition before capturing and returning data. This figure shows these tool settings.

Click Capture Data again. This time, the data capture IP returns 1048576 samples, captured when it detects that the counter equals 10.

Conclusion

This example demonstrates how to generate a data capture IP core, integrate it into an FPGA design, and capture temperature sensor data into MATLAB. It serves as a beginner's guide to FPGA data capture, helping you learn how to create and use FPGA data capture IP in various configurations.