Intel® FPGA SDK for OpenCL™ Pro Edition: Getting Started Guide

Download PDF
ID 683188
Date 10/04/2021
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
Document Table of Contents x
1. Intel® FPGA SDK for OpenCL™ Pro Edition Getting Started Guide 2. Getting Started with the Intel® FPGA SDK for OpenCL™ Pro Edition for Windows 3. Getting Started with the Intel® FPGA SDK for OpenCL™ Pro Edition for Linux A. Intel® FPGA SDK for OpenCL™ Pro Edition Getting Started Guide Archives B. Document Revision History of the Intel® FPGA SDK for OpenCL™ Pro Edition Getting Started Guide
1. Intel® FPGA SDK for OpenCL™ Pro Edition Getting Started Guide x
1.1. Prerequisites for the Intel® FPGA SDK for OpenCL™ Pro Edition 1.2. Intel® FPGA SDK for OpenCL™ Pro Edition and OpenCL BSP Backwards Compatibility 1.3. Contents of the Intel® FPGA SDK for OpenCL™ Pro Edition 1.4. Overview of the Intel® FPGA SDK for OpenCL™ Pro Edition Setup Process
1.1. Prerequisites for the Intel® FPGA SDK for OpenCL™ Pro Edition x
1.1.1. GCC Requirement
2. Getting Started with the Intel® FPGA SDK for OpenCL™ Pro Edition for Windows x
2.1. Downloading the Intel® FPGA SDK for OpenCL™ Pro Edition 2.2. Installing the Intel® FPGA SDK for OpenCL™ Pro Edition 2.3. Setting the Intel® FPGA SDK for OpenCL™ Pro Edition User Environment Variables 2.4. Verifying Software Installation 2.5. Installing an FPGA Board 2.6. Verifying Host Runtime Functionality via Emulation 2.7. Creating the FPGA Hardware Configuration File of an OpenCL Kernel 2.8. Updating the Hardware Image on the FPGA 2.9. Executing an OpenCL Kernel on an FPGA 2.10. Uninstalling an FPGA Board 2.11. Uninstalling the Software
2.5. Installing an FPGA Board x
2.5.1. Enabling Backwards Compatibility for an FPGA Board
2.6. Verifying Host Runtime Functionality via Emulation x
2.6.1. Accessing an OpenCL Design Example 2.6.2. Compiling a Kernel for Emulation 2.6.3. Building the Host Application 2.6.4. Emulating Your OpenCL Kernel
2.8. Updating the Hardware Image on the FPGA x
2.8.1. Querying the Device Name of Your FPGA Board 2.8.2. Programming the Flash Memory of an FPGA
2.9. Executing an OpenCL Kernel on an FPGA x
2.9.1. Running the Host Application 2.9.2. Output from Successful Kernel Execution
3. Getting Started with the Intel® FPGA SDK for OpenCL™ Pro Edition for Linux x
3.1. Downloading the Intel® FPGA SDK for OpenCL™ Pro Edition 3.2. Installing the Intel® FPGA SDK for OpenCL™ Pro Edition 3.3. Setting the Intel® FPGA SDK for OpenCL™ Pro Edition User Environment Variables 3.4. Verifying Software Installation 3.5. Installing an FPGA Board 3.6. Verifying Host Runtime Functionality via Emulation 3.7. Creating the FPGA Hardware Configuration File of an OpenCL Kernel 3.8. Updating the Hardware Image on the FPGA 3.9. Executing an OpenCL Kernel on an FPGA 3.10. Uninstalling an FPGA Board 3.11. Uninstalling the Software
3.5. Installing an FPGA Board x
3.5.1. Enabling Backwards Compatibility for an FPGA Board
3.6. Verifying Host Runtime Functionality via Emulation x
3.6.1. Accessing an OpenCL Design Example 3.6.2. Compiling a Kernel for Emulation 3.6.3. Building the Host Application 3.6.4. Emulating Your OpenCL Kernel
3.8. Updating the Hardware Image on the FPGA x
3.8.1. Querying the Device Name of Your FPGA Board 3.8.2. Programming the Flash Memory of an FPGA
3.9. Executing an OpenCL Kernel on an FPGA x
3.9.1. Running the Host Application 3.9.2. Output from Successful Kernel Execution
1. Intel® FPGA SDK for OpenCL™ Pro Edition Getting Started Guide
2. Getting Started with the Intel® FPGA SDK for OpenCL™ Pro Edition for Windows
3. Getting Started with the Intel® FPGA SDK for OpenCL™ Pro Edition for Linux
A. Intel® FPGA SDK for OpenCL™ Pro Edition Getting Started Guide Archives
B. Document Revision History of the Intel® FPGA SDK for OpenCL™ Pro Edition Getting Started Guide

3.7. Creating the FPGA Hardware Configuration File of an OpenCL Kernel

Copy the hello_world OpenCL™ design example from the $INTELFPGAOCLSDKROOT/examples_aoc directory. Compile the hello_world kernel program using the Intel® FPGA SDK for OpenCL™ Offline Compiler to create the hello_world.aocx executable file. The .aocx file is the FPGA hardware configuration file.
After you successfully install your FPGA board and emulate your kernel, you can create a .aocx file that executes on the device. The steps below describe the process of creating a .aocx file from the hello_world example design.
Note: The Intel® FPGA SDK for OpenCL™ Offline Compiler compiles an OpenCL kernel for a target FPGA board. The Intel® FPGA SDK for OpenCL™ compiles for the installed board package. If you have not installed the FPGA board, refer to Installing an FPGA Board for more instructions. If you do not install the board package, use the -board-package=<board_package_path> option to point to the OpenCL BSP, otherwise the Intel® FPGA SDK for OpenCL™ throws an error. Refer to the following steps for more details.
  1. Verify that the QUARTUS_ROOTDIR_OVERRIDE environment variable points to your Intel® Quartus® Prime software. Open a shell and then type echo $QUARTUS_ROOTDIR_OVERRIDE at the command prompt.

    If the path to the installation directory of the Intel® Quartus® Prime software is not returned, add it to the QUARTUS_ROOTDIR_OVERRIDE setting.

  2. Select your target FPGA board. To list the FPGA boards available in your Custom Platform, invoke the command aoc -list-boards at a command prompt. If no OpenCL BSP is installed, No board support packages installed message is displayed. Use the -board-package=<board_package_path> option to point to the OpenCL BSP.

    If you have multiple OpenCL BSPs installed, you can compile your kernel with the board variant from a specific Custom Platform by including -board-package=<custom_platform_path> option with -board=<board_name> . At the command prompt, invoke the following command: 

    aoc -board-package=<board_package_path> -board=<board_name> kernel.cl

    The Intel® FPGA SDK for OpenCL™ Offline Compiler compiles the kernel with the board specified in the <board_package_path>. To list Custom Platforms available in the system, include the -list-board-packages option in the aoc command.

    For more information about -list-boards, -board-package, and -list-board-packages options of the aoc command, refer to the Listing the Available FPGA Boards in Your Custom Platform (-list-boards and -list-board-packages) section of the Intel® FPGA SDK for OpenCL™ Pro Edition Programming Guide.

  3. At a command prompt, navigate to the hello_world design directory containing the hello_world.cl file that you used for emulation.
  4. To compile the kernel for your target FPGA board, invoke the following command:
    aoc -v -board-package=<board_package_path> -board=<board_name> device/hello_world.cl -o bin/hello_world.aocx

    This command performs the following tasks:

    • Generates the Intel® Quartus® Prime design project files from the OpenCL source code.
    • Checks for initial syntax errors.
    • Performs basic optimizations.
    • Creates a hello_world directory containing necessary intermediate files.
    • Creates the .aocx file.
    Tip:
    • If you have only one FPGA board installed, -board=<board_name> is optional.
    • If you have only one OpenCL BSP installed, -board-package=<board_package_path> is optional.
    Attention:

    The .aocx file might take hours to build, depending on the complexity of the kernel. To view the progress of the compilation on-screen, include the -v flag in your aoc command. An example output is shown below. 

    aoc: Environment checks are completed successfully.
You are now compiling the full flow!!
aoc: Selected target board <board_name>
aoc: Running OpenCL parser....
aoc: OpenCL parser completed successfully.
aoc: Compiling....
aoc: Linking with IP library ...
aoc: First stage compilation completed successfully.
aoc: Setting up project for CvP revision flow....
aoc: Hardware generation completed successfully.

    The offline compiler displays the line aoc: Hardware generation completed successfully. to signify the completion of the compilation process.

For more information about the -board=<board_name> option of the aoc command, refer to the Compiling a Kernel for a Specific FPGA Board and Custom Platform (-board=<board_name>) and (-board-package=<board_package_path>) section of the Intel® FPGA SDK for OpenCL™ Pro Edition Programming Guide.

For more information about the -v option of the aoc command, refer to the Generating Compilation Progress Report (-v) section of the Intel® FPGA SDK for OpenCL™ Pro Edition Programming Guide.

For more information about the -o <filename> option of the aoc command, refer to the Specifying the Name of an Intel® FPGA SDK for OpenCL™ Offline Compiler Output File (-o <filename>) section of the Intel® FPGA SDK for OpenCL™ Pro Edition Programming Guide.

Related Information
Level Two Title