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

Download PDF
ID 683188
Date 3/28/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
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

1.3. Contents of the Intel® FPGA SDK for OpenCL™ Pro Edition

The Intel® FPGA SDK for OpenCL™ Pro Edition provides programs and SDK-specific libraries and files.

Logic Components

  • The Intel® FPGA SDK for OpenCL™ Offline Compiler translates your OpenCL* device code into a hardware configuration file that the system loads onto an Intel® FPGA product.
  • The Intel® FPGA SDK for OpenCL™ Pro Edition utility includes a set of commands you can invoke to perform high-level tasks such as running diagnostic tests.
  • The host runtime provides the OpenCL* host and runtime API for your OpenCL* host application.

    The host runtime consists of libraries that provide OpenCL* APIs, hardware abstractions, and helper libraries.

Drivers, Libraries and Files

The software installation process installs the Intel® FPGA SDK for OpenCL™ Pro Edition into a directory that you own. The INTELFPGAOCLSDKROOT environment variable references the path to the SDK's installation directory.

Table 1.  Select Contents of the Intel® FPGA SDK for OpenCL™ Pro Edition Installation Directory
Windows Folder Linux Directory Description
bin bin User commands in the SDK. Include this directory in your PATH environment variable setting.
board \custom_platform_toolkit\tests board /custom_platform_toolkit/tests The path to the Intel® FPGA SDK for OpenCL™ Pro Edition kernel code files to test platforms.
Note: Starting from the 20.3 release, support for Windows and Linux OpenCL BSPs is removed. Use version 20.2 or older OpenCL BSPs available at FPGA Software Download Center 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.
ip ip Intellectual property (IP) cores used to compile device kernels.
host host Files necessary for compiling and running your host application.
host\include host/include OpenCL* Specification version 1.0 header files and software interface files necessary for compiling and linking your host application.

The host/include/CL subdirectory also includes the C++ header file cl.hpp. The file contains an OpenCL* version 1.1 C++ wrapper API. These C++ bindings enable a C++ host program to access the OpenCL* runtime APIs using native C++ classes and methods.

Important: The OpenCL* version 1.1 C++ bindings are compatible with OpenCL* Specification versions 1.0 and 1.1.

Add this path to the include file search path in your development environment.

host\windows64\lib host/linux64/lib OpenCL* host runtime libraries that provide the OpenCL* platform and runtime APIs. These libraries are necessary for linking your host application.

To run an OpenCL* application on Linux, include this directory in the LD_LIBRARY_PATH environment variable setting.

host\windows64\bin host/linux64/bin Runtime commands and libraries necessary for running your host application, wherever applicable. For 64-bit Windows system, include this directory in your PATH environment variable setting.
  • For Windows system, this folder contains runtime libraries.
  • For Linux system, this directory contains platform-specific binary for the aocl utility command.
share share Architecture-independent support files.

Example OpenCL* Applications

You can refer to example OpenCL* applications from the examples_aoc OpenCL* design examples directory under INTELFPGAOCLSDKROOT.

Level Two Title