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

Download PDF
ID 683188
Date 12/13/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

2.5. Installing an FPGA Board

Before creating an OpenCL™ application for an FPGA accelerator board or SoC device, you must first download and install the Intel Reference Platform or the Custom Platform from your board vendor. Most Custom Platform installers require administrator privileges.

To install your board into a Windows host system, invoke the aocl install <path_to_customplatform> utility command.

The steps below outline the board installation procedure. Some Custom Platforms require additional installation tasks. Consult your board vendor's documentation for further information on board installation.

  1. Follow your board vendor's instructions to connect the FPGA board to your system.
  2. Download the Custom Platform for your FPGA board from your board vendor's website.
    Note: Starting from 20.3 release, support for Windows OpenCL BSPs is removed. Use 20.2 or older OpenCL BSPs available at Download Center for FPGAs as a reference. If you want to migrate your OpenCL BSP to a newer version, follow the recommended steps provided in the Reference Platform Porting Guides available under Intel FPGA SDK for OpenCL documentation.
  3. Install the Custom Platform in a folder that you own (that is, not a system folder).

    You can install multiple Custom Platforms simultaneously on the same system using the SDK utilities, such as aocl diagnose with multiple Custom Platforms. The Custom Platform subdirectory contains the board_env.xml file.

    In a system with multiple Custom Platforms, ensure that the host program uses the FPGA Client Driver (FCD) to discover the boards rather than linking to the Custom Platforms' memory-mapped device (MMD) libraries directly. If FCD is correctly set up for Custom Platform, FCD finds all the installed boards at runtime.

  4. Set the QUARTUS_ROOTDIR_OVERRIDE user environment variable to point to the Intel® Quartus® Prime Pro Edition software installation directory.
  5. Add the paths to the Custom Platform libraries (for example, path to the MMD library of the board support package resembles <path_to_customplatform>/windows64/bin) to the PATH environment variable setting.

    For information on setting user environment variables and running the init_opencl script, refer to the Setting the Intel® FPGA SDK for OpenCL™ Pro Edition User Environment Variables section.

  6. Invoke the command aocl install <path_to_customplatform> at a command prompt.
    Invoking aocl install <path_to_customplatform> installs both the FCD and a board driver that allows communication between host applications and hardware kernel programs.
    Remember:
  7. Query a list of FPGA devices installed in your machine by invoking the aocl diagnose command.
    The software generates an output that includes the <device_name>, which is an acl number that ranges from acl0 to acl127.
    Attention: For possible errors after implementing the aocl diagnose utility, refer to Possible Errors After Running the diagnose Utility section in the Intel® Arria® 10 GX FPGA Development Kit Reference Platform Porting Guide. For more information on querying the <device_name> of your accelerator board, refer to the Querying the Device Name of Your FPGA Board section.
  8. Verify the successful installation of the FPGA board by invoking the command aocl diagnose <device_name> to run any board vendor-recommended diagnostic test.
Related Information
Level Two Title