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.6. Intel® Arria® 10 Custom Platform Project Setup and Customization Procedure

This section provides an overview of the Intel® Arria® 10 GX FPGA Development Kit Reference Platform’s directory structure and files. It also outlines the procedures for acquiring the Reference Platform, checking the default Reference Platform compilations, and modifying the Reference Platform name.

To acquire the Intel® Arria® 10 GX FPGA Development Kit Reference Platform, please contact your Intel representative.

Table 5.  Directory Structure of the Intel® Arria® 10 GX FPGA Development Kit Reference Platform
Windows Folder Linux Directory Description
board_env.xml board_env.xml eXtensible Markup Language (XML) file that describes the Reference Platform to the Intel® FPGA SDK for OpenCL™ .
hardware hardware

Contains the Intel® Quartus® Prime project templates for the supported board variants. Each Reference Platform board variant implements the entire OpenCL hardware system on a given Intel® Arria® 10 GX FPGA Development Kit.

Specify the name of this directory in the board_env.xml file. Within this directory, the SDK assumes that any subdirectory containing a board_spec.xml file is a board.
windows64 linux64 Contains the MMD library, kernel mode driver, and executable files of the SDK utilities (that is, install, uninstall, flash, program, diagnose) for your 64-bit operating system.
source_windows64 source

source_windows64: contains source codes for the MMD library and SDK utilities. The MMD library and the SDK utilities are in the windows64 folder.

source: contains source codes for the MMD library and SDK utilities. The MMD library and the SDK utilities are in the linux64 directory.

After developing your Intel® Arria® 10 Custom Platform, store it in the INTELFPGAOCLSDKROOT/board directory. The SDK user will then set the AOCL_BOARD_PACKAGE_ROOT environment variable to point to the location of the Custom Platform's board_env.xml file in order to target an OpenCL kernel compilation to the Intel® Arria® 10 Custom Platform.

At a minimum, the Custom Platform that you design must include all of the following components:

  • The board_env.xml file, which contains information about the custom platform.
  • The hardware directory, which contains all of the hardware design information required for the Intel® FPGA SDK for OpenCL™ Offline Compiler to generate a custom FPGA. The board_spec.xml file resides in this directory.
  • The OS platform directory (for example, windows64 or linux64).

The OS Platform directory contains the board-specific libraries that must link to the host program, and the executables that run when the SDK user invokes an SDK utility. You must include an OS platform directory in your Custom Platform for each supported host operating system (for example, 64-bit Windows and Linux support).

Each board variant in the Custom Platform consists of a Intel® Quartus® Prime project and a board_spec.xml file that describes the system to the Intel® FPGA SDK for OpenCL™ Offline Compiler. The board_spec.xml file also describes the interfaces necessary to connect to the kernel. The Intel® FPGA SDK for OpenCL™ Offline Compiler generates a custom circuit based on the data from the board_spec.xml file. Then it incorporates the OpenCL kernel into the Platform Designer system that you create for all non-kernel logic.


Section Content
Custom Platform Versioning
Board XML Files
Customization Flow

Level Two Title