AN 780: Compiling and Customizing an Intel® Arria® 10 Custom Platform for OpenCL*

Download PDF
ID 683045
Date 10/30/2018
Public
Document Table of Contents
Document Table of Contents x
1. Compiling and Customizing an Intel® Arria® 10 Custom Platform for OpenCL
1. Compiling and Customizing an Intel® Arria® 10 Custom Platform for OpenCL x
1.1. Introduction to Custom Platforms 1.2. OpenCL System Architecture 1.3. Hierarchical Structure of the Intel® Arria® 10 GX FPGA Development Kit Reference Platform's Hardware 1.4. Intel® Quartus® Prime Software Revisions Describing the Custom Platform 1.5. Intel® FPGA SDK for OpenCL™ and User Environment Setup 1.6. Intel® Arria® 10 Custom Platform Project Setup and Customization Procedure 1.7. Intel® Arria® 10 Custom Platform Customization Example 1.8. Updating Your Custom Platform to Target a Different Device 1.9. Migrating the Custom Platform between Different Intel® Quartus® Prime Software Versions 1.10. Document Revision History for Compiling and Customizing an Intel® Arria® 10 Custom Platform for OpenCL*
1.4. Intel® Quartus® Prime Software Revisions Describing the Custom Platform x
1.4.1. Descriptions of the Intel® Arria® 10 GX FPGA Development Kit Reference Platform Files
1.4.1. Descriptions of the Intel® Arria® 10 GX FPGA Development Kit Reference Platform Files x
1.4.1.1. Location of the Intel® Arria® 10 GX FPGA Development Kit Reference Platform
1.5. Intel® FPGA SDK for OpenCL™ and User Environment Setup x
1.5.1. Specifying the Intel® FPGA SDK for OpenCL™ User Environment Variable Settings 1.5.2. Specifying the Intel® FPGA SDK for OpenCL™ User Environment Variables on Linux
1.5.1. Specifying the Intel® FPGA SDK for OpenCL™ User Environment Variable Settings x
1.5.1.1. Verifying the Windows Intel® FPGA SDK for OpenCL™ User Environment Variable Settings
1.5.2. Specifying the Intel® FPGA SDK for OpenCL™ User Environment Variables on Linux x
1.5.2.1. Verifying the Linux Intel® FPGA SDK for OpenCL™ User Environment Variable Settings
1.6. Intel® Arria® 10 Custom Platform Project Setup and Customization Procedure x
1.6.1. Custom Platform Versioning 1.6.2. Board XML Files 1.6.3. Customization Flow
1.6.2. Board XML Files x
1.6.2.1. The board_env.xml File 1.6.2.2. The board_spec.xml File
1.6.2.1. The board_env.xml File x
1.6.2.1.1. Creating the board_env.xml File
1.6.2.2. The board_spec.xml File x
1.6.2.2.1. Creating the board_spec.xml File
1.6.3. Customization Flow x
1.6.3.1. Compiling a Kernel without Regenerating the Custom Platform 1.6.3.2. Preparing an Existing Custom Platform for Customization
1.7. Intel® Arria® 10 Custom Platform Customization Example x
1.7.1. Modifying the board.qsys File in the Custom Platform 1.7.2. Modifying the Kernel (freeze_wrapper.v and board_spec.xml) 1.7.3. Updating the Top-Level I/O Ring with the Modified board.qsys and freeze_wrapper.v Files 1.7.4. Updating the Original Custom Platform Directory with the New Custom Platform Modifications 1.7.5. Compilation Log Files 1.7.6. Analyzing the Results from Compilation
1.7.1. Modifying the board.qsys File in the Custom Platform x
1.7.1.1. Opening an Existing Intel® Quartus® Prime Project and the board.qsys Platform Designer System Design 1.7.1.2. Adding the Avalon® -ST Single Clock FIFO Component into the Platform Designer System 1.7.1.3. Connecting the Avalon® -ST Single Clock FIFO Component's Exported Signals in the Top-Level Platform Designer System
1.7.2. Modifying the Kernel (freeze_wrapper.v and board_spec.xml) x
1.7.2.1. Opening an Existing Intel® Quartus® Prime Project and the kernel_system.qsys Platform Designer System Design 1.7.2.2. Adding an Avalon® -ST Adapter Component into the Platform Designer System 1.7.2.3. Connecting the Avalon® -ST Adapter Component's Exported Signals in the Top-Level Platform Designer System 1.7.2.4. Modifying the board_spec.xml File 1.7.2.5. Modifying the freeze_wrapper.v File
1.8. Updating Your Custom Platform to Target a Different Device x
1.8.1. Targeting a Device that Has a Migration Path in the Intel® Quartus® Prime Software 1.8.2. Targeting a Device that Has a Different Package Size
1.9. Migrating the Custom Platform between Different Intel® Quartus® Prime Software Versions x
1.9.1. Custom Platform Automigration for Forward Compatibility 1.9.2. Customizing Automigration 1.9.3. Overall Summary
1. Compiling and Customizing an Intel® Arria® 10 Custom Platform for OpenCL

1.4.1. Descriptions of the Intel® Arria® 10 GX FPGA Development Kit Reference Platform Files

Ensure that your Intel® Arria® 10 Custom Platform includes similar files as those in the Intel® Arria® 10 GX FPGA Development Kit Reference Platform.
Table 1.  Main Files Associated with the Intel® Arria® 10 GX FPGA Development Kit Reference PlatformThis table is organized based on the hierarchical structure depicted in Figure 2.
File Description
XML FILES
board_env.xml XML file that describes the Reference Platform to the Intel® FPGA SDK for OpenCL™ .
board_spec.xml XML file that provides the definition of the board hardware interfaces to the SDK.
ROOT PARTITION
top.v Top-level Verilog Design File for the OpenCL hardware system.
top.qpf Intel® Quartus® Prime Project File for the OpenCL hardware system.
top.qsf Intel® Quartus® Prime Settings File for the SDK-user compilation flow. This .qsf file is used when a pre-placed and pre-routed Reference Platform is imported into the project.
top.sdc Synopsys* Design Constraints File that contains board-specific timing constraints.
top_post.sdc Platform Designer and SDK IP-specific timing constraints.
flat.qsf

Intel® Quartus® Prime Settings File for the flat project revision. This file includes all the common settings, such as pin location assignments, that are used in the other revisions of the project (that is, base, top, and top_synth). The base.qsf and top.qsf files include, by reference, all the settings in the flat.qsf file.

The Intel® Quartus® Prime software compiles the flat revision with minimal location constraints. The flat revision compilation does not generate a base.qar file that you can use for future import compilations and does not implement the guaranteed timing flow.
board.qsys Platform Designer system that implements the board interfaces (that is, the static region) of the OpenCL hardware system
base.qsf

Intel® Quartus® Prime Settings File for the base project revision. This file includes, by reference, all the settings in the flat.qsf file.

Use this revision when porting the Reference Platform to your own Custom Platform. The Intel® Quartus® Prime Pro Edition software compiles this base project revision from source code.
base.qar Intel® Quartus® Prime Database Export File that contains the precompiled netlist of the static region of the design. This file is generated by the scripts/post_flow_pr.tcl file during base revision compilations and is used during import revision compilations.
base_compile.tcl Tcl script for the base revision compilation flow.
import_compile.tcl Tcl script for the SDK-user compilation flow (that is, import revision compilation).
KERNEL FILES
ip/acl_kernel_clk_a10/acl_kernel_clk_a10.qsys Platform Designer component that defines the clock generation logic for the kernel clock.
FREEZE WRAPPER FILES
ip/freeze_wrapper.v Verilog Design File that implements the freeze logic placed at inputs and outputs of the PR region.
IP FILES USED FOR COMPILATION
ip/acl_ddr4_a10/<file_name> Directory containing Platform Designer files that implement the DDR4 memory interface. These Platform Designer files are instantiated in board.qsys.
ip/irq_controller/<file_name>

IP that receives interrupts from the OpenCL kernel system and sends message signaled interrupts (MSI) to the host.

Refer to the Message Signaled Interrupts section of the Intel® Arria® 10 GX FPGA Development Kit Reference Platform Porting Guide for more information.
SCRIPTS FOR COMPILATION
scripts/call_script_as_function.tcl Tcl wrapper function for a stand-alone Tcl script to allow the script to be called as a Tcl function.
scripts/create_fpga_bin_pr.tcl

Tcl script that generates the fpga.bin file. The fpga.bin file contains all the necessary files for configuring the FPGA.

For more information on the fpga.bin file, refer to the Define the Contents of the fpga.bin File for the Intel® Arria® 10 GX FPGA Development Kit Reference Platform section of the Intel® Arria® 10 GX FPGA Development Kit Reference Platform Porting Guide.

scripts/post_flow_pr.tcl Tcl script that implements the guaranteed timing closure flow, as described in the Guaranteed Timing Closure of the Intel® Arria® 10 GX FPGA Development Kit Reference Platform Design section of the Intel® Arria® 10 GX FPGA Development Kit Reference Platform Porting Guide.
scripts/pre_flow_pr.tcl Tcl script that executes before the invocation of the Intel® Quartus® Prime software compilation. Running the script generates the Platform Designer HDL for board.qsys and kernel_system.qsys.
PROJECT FILES
quartus.ini Contains any special Intel® Quartus® Prime software options that you need when compiling OpenCL kernels for the Reference Platform.
DEVELOPMENT BOARD FILES
max5_150.pof

Programming file for the MAX® V device on the Intel® Arria® 10 GX FPGA Development Kit that sets the memory reference clock to 150 MHz by default at power-up.

You must program the max5_150.pof file onto your a10gx or a10gx_es3 board based on the speed at which the DDR4 interface will run.
PARTIAL RECONFIGURATION
pr_base_id.txt

Text file containing a unique number for a given base compilation that the runtime uses to determine whether it is safe to use PR programming.

The pr_base_id.txt file is generated each time you perform a base compilation. The unique number in this file is included in the Intel® FPGA SDK for OpenCL™ Offline Compiler Executable File (.aocx) that each import compilation generates.

Section Content
Location of the Intel Arria 10 GX FPGA Development Kit Reference Platform

Level Two Title