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

Download PDF
ID 683188
Date 9/26/2022
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
Product Discontinuance Notification 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
Product Discontinuance Notification
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

2.5.1. Enabling Backwards Compatibility for an FPGA Board

To enable a board with a downlevel OpenCL BSP, you need a version of Intel® Quartus® Prime Pro Edition with the same version number as the OpenCL BSP version.

For example, you can use Version 20.2 OpenCL BSP with Intel® FPGA SDK for OpenCL™ Version 22.3 and Intel® Acceleration Stack Version 2.0.1 and Version 1.2.1.

After you have installed and configured the required version or versions of Intel® Quartus® Prime Pro Edition, you enable your backwards compatible boards by setting the QUARTUS_ROOTDIR_OVERRIDE environment variable and running the aocl install command so that your Intel® Quartus® Prime Pro Edition version matches your OpenCL BSP version number.

Before you set the QUARTUS_ROOTDIR_OVERRIDE environment variable and run the aocl install command, install and configure the version of Intel® Quartus® Prime Pro Edition that your OpenCL BSP needs.

Also, install your FPGA board or boards following the instructions in Installing an FPGA Board.

To enable a board with a backwards compatible OpenCL BSP:

  1. Set the QUARTUS_ROOTDIR_OVERRIDE to point to the version of Intel® Quartus® Prime Pro Edition that your OpenCL BSP needs.
    For example, if you have Version 20.2 OpenCL BSP, QUARTUS_ROOTDIR_OVERRIDE must point at Intel® Quartus® Prime Pro Edition Version 20.2: 
    set QUARTUS_ROOTDIR_OVERRIDE=<path_to_quartus_install>\quartus
  2. Run the aocl install <path_to_customplatform> command with the path to your backward compatible OpenCL BSP as the value for <path_to_customplatform>.
    For example, to point to a Version 20.2 OpenCL BSP for the Intel® Arria® 10 GX FPGA Development Kit Reference Platform, install the board with the following command: 
    aocl install <YOUR_PATH_TO_V20.2_OpenCL_BSP>\a10_ref
After you complete these steps, Intel® SDK for OpenCL™ commands like aocl diagnose should work correctly with your backlevel OpenCL BSP.
Level Two Title