Skip to content

Latest commit

 

History

History
116 lines (78 loc) · 4.77 KB

HowToRunTutorial.md

File metadata and controls

116 lines (78 loc) · 4.77 KB

2019.1 SDAccel™ Development Environment Tutorials

See other versions

Applying Methodology for Creating an Optimized Accelerated FPGA Application

Understanding the Makefile

The source files required for this lab are all under the design folder. The design folder contains three sub-directories: cpu_src with the original application code, src with the accelerated application code, and makefile.

Under the src folder, there are six sub-folders, which contain the source files for each step. The following directories correspond to each step of the tutorial.

Tutorial Step Associated Directory
Creating an SDAccel application from C application src/baseline
Optimizing memory transfers src/localbuf
Optimizing by using fixed point data types: src/fixedpoint
Optimizing with dataflow src/dataflow
Using Out-of-order queues and multiple kernels src/multicu

Makefile targets can be used to run software emulation, hardware emulation, as well as hardware on the Alveo accelerator card.

Makefile Targets for Building Designs

To build the design, use the following command.

make build TARGET=<sw_emu/hw_emu/hw> STEP=<baseline/localbuf/fixedpoint/dataflow/multicu/> SOLUTION=1

Along with the src directory, that can be used to update the code based on tutorials, the reference-files directory is also provided. You can directly use files in the reference-files directory by setting SOLUTION=1 for the makefile targets.

For example, to build the hardware emulation xclbin for the baseline lab, use the following command.

make build TARGET=hw_emu STEP=baseline SOLUTION=1

Makefile Targets for Running Designs

To run the design in emulation or hardware, use the following command.

make run TARGET=<sw_emu/hw_emu/hw> STEP=<baseline/localbuf/fixedpoint/dataflow/multicu> SOLUTION=1 [NUM_FRAMES=1]

The NUM_FRAMES option defines the input video frame number used for the host application execution. For software and hardware emulation, it is recommended to set NUM_FRAMES to 1 to reduce emulation time. For hardware run, do not use this option; a full video file will be used.

For example, to run hardware emulation for baseline step, use the following command.

make run TARGET=hw_emu STEP=baseline SOLUTION=1 NUM_FRAMES=1

Makefile Targets for Generating Profile and Timeline Trace Reports

To analyze the performance of the design, you need to look at the reports. For details about the reports, refer to the Generate Profile and Trace Reports lab in the Essential Concepts for Building and Running the Accelerated Application tutorial.

Use the following command to generate the Profile Summary report and Timeline Trace report.

make gen_report TARGET=hw_emu STEP=multicu

This command will generate the Profile Summary and Timeline Trace reports. The following reports will be generated for above command.

  • sdaccel_profile_summary_hw_emu.html
  • sdaccel_timeline_trace_hw_emu.wdb

Makefile Targets for Viewing Profile and Timeline Trace

  1. Use the following command to view the Profile Summary report.

    make view_prof_report TARGET=hw_emu STEP=multicu

    The makefile uses the following command to open the Profile Summary report.

    firefox sdaccel_profile_summary_hw_emu.html

  2. Use the following command to view the Timeline Trace report.

    make view_timeline_trace TARGET=hw STEP=multicu

    The makefile uses the following command to launch the SDx IDE, and display the Timeline Trace report.

    sdx -report sdaccel_timeline_trace_multicu.wdb

Makefile Targets for Clean Up

To clean the previously generated build, use the following command.

make clean TARGET=hw_emu STEP=baseline

This will clean the hardware emulation-generated files for the baseline version design.


Return to Getting Started Pathway — Return to Start of Tutorial

Copyright© 2019 Xilinx