Intel® FPGA RTE for OpenCL™ Standard Edition: Getting Started Guide

Download PDF
ID 683550
Date 9/24/2018
Public
Document Table of Contents
Document Table of Contents x
1. Intel® FPGA RTE for OpenCL™ Standard Edition Getting Started Guide 2. Getting Started with the Intel® FPGA RTE for OpenCL™ Standard Edition for 64-Bit Windows 3. Getting Started with the Intel® FPGA RTE for OpenCL™ Standard Edition for x86_64 Linux Systems 4. Getting Started with the Intel® FPGA RTE for OpenCL™ Standard Edition for Intel® ARMv7-A SoC FPGA A. Document Revision History of the Intel® FPGA RTE for OpenCL™ Standard Edition Getting Started Guide
1. Intel® FPGA RTE for OpenCL™ Standard Edition Getting Started Guide x
1.1. Prerequisites for the Intel® FPGA RTE for OpenCL™ Standard Edition 1.2. Contents of the Intel® FPGA RTE for OpenCL™ Standard Edition 1.3. RTE Utility 1.4. Overview of the Intel® FPGA RTE for OpenCL™ Standard Edition Setup Process
1.3. RTE Utility x
1.3.1. Displaying the Software Version 1.3.2. Listing the Intel® FPGA RTE for OpenCL™ Standard Edition Utility Command Options 1.3.3. Managing an FPGA Board 1.3.4. Managing Host Application
2. Getting Started with the Intel® FPGA RTE for OpenCL™ Standard Edition for 64-Bit Windows x
2.1. Downloading the Intel® FPGA RTE for OpenCL™ Standard Edition 2.2. Installing the Intel® FPGA RTE for OpenCL™ 2.3. Setting the Intel® FPGA RTE for OpenCL™ Standard Edition User Environment Variables 2.4. Verifying Software Installation 2.5. Installing an FPGA Board 2.6. Updating the Hardware Image on the FPGA 2.7. Executing an OpenCL Kernel on an FPGA 2.8. Uninstalling the Software 2.9. Uninstalling the FPGA Board
2.6. Updating the Hardware Image on the FPGA x
2.6.1. Querying the Device Name of Your FPGA Board 2.6.2. Programming the Flash Memory of an FPGA
2.7. Executing an OpenCL Kernel on an FPGA x
2.7.1. Building the Host Application 2.7.2. Running the Host Application 2.7.3. Output from Successful Kernel Execution
3. Getting Started with the Intel® FPGA RTE for OpenCL™ Standard Edition for x86_64 Linux Systems x
3.1. Downloading the Intel® FPGA RTE for OpenCL™ Standard Edition 3.2. Installing the Intel® FPGA RTE for OpenCL™ 3.3. Setting the Intel® FPGA RTE for OpenCL™ Standard Edition User Environment Variables 3.4. Verifying Software Installation 3.5. Installing an FPGA Board 3.6. Updating the Hardware Image on the FPGA 3.7. Executing an OpenCL Kernel on an FPGA 3.8. Uninstalling the Software 3.9. Uninstalling the FPGA Board
3.6. Updating the Hardware Image on the FPGA x
3.6.1. Querying the Device Name of Your FPGA Board 3.6.2. Programming the Flash Memory of an FPGA
3.7. Executing an OpenCL Kernel on an FPGA x
3.7.1. Building the Host Application 3.7.2. Running the Host Application 3.7.3. Output from Successful Kernel Execution
4. Getting Started with the Intel® FPGA RTE for OpenCL™ Standard Edition for Intel® ARMv7-A SoC FPGA x
4.1. Getting Started with the Intel® FPGA RTE for OpenCL™ Standard Edition for SoC FPGA on Windows 4.2. Getting Started with the Intel® FPGA RTE for OpenCL™ Standard Edition for SoC FPGA on Linux
4.1. Getting Started with the Intel® FPGA RTE for OpenCL™ Standard Edition for SoC FPGA on Windows x
4.1.1. Downloading the Intel® FPGA SDK for OpenCL Standard Edition and the SoC EDS Standard Edition 4.1.2. Installing the Intel® FPGA SDK for OpenCL Standard Edition for SoC FPGA 4.1.3. Installing the Intel® SoC FPGA Embedded Development Suite Standard Edition 4.1.4. Recompiling the Linux Kernel Driver 4.1.5. Installing the Intel FPGA RTE for OpenCL Standard Edition onto the SoC FPGA Board 4.1.6. Installing the Cyclone V SoC Development Kit 4.1.7. Executing an OpenCL Kernel on an SoC FPGA 4.1.8. Uninstalling the Intel® FPGA RTE for OpenCL™ Standard Edition
4.1.6. Installing the Cyclone V SoC Development Kit x
4.1.6.1. Writing an SD Card Image onto the Micro SD Flash Card 4.1.6.2. Configuring the SW3 Switches 4.1.6.3. Setting Up Terminal Connection 4.1.6.4. Setting Environment Variables and Loading OpenCL Linux Kernel Driver 4.1.6.5. Connecting the Board to Network via Ethernet
4.1.6.5. Connecting the Board to Network via Ethernet x
4.1.6.5.1. Ensuring IP Address Acquisition 4.1.6.5.2. Using SSH and SCP
4.1.7. Executing an OpenCL Kernel on an SoC FPGA x
4.1.7.1. Building the Host Application 4.1.7.2. Running the Host Application 4.1.7.3. Output from Successful Kernel Execution on the Cyclone V SoC Development Kit
4.2. Getting Started with the Intel® FPGA RTE for OpenCL™ Standard Edition for SoC FPGA on Linux x
4.2.1. Downloading the Intel® FPGA SDK for OpenCL™ Standard Edition and the SoC EDS Standard Edition 4.2.2. Installing the Intel® FPGA SDK for OpenCL Standard Edition for SoC FPGA 4.2.3. Installing the Intel® SoC FPGA Embedded Development Suite Standard Edition 4.2.4. Recompiling the Linux Kernel Driver 4.2.5. Installing the Intel FPGA RTE for OpenCL Standard Edition onto the SoC FPGA Board 4.2.6. Installing the Cyclone V SoC Development Kit 4.2.7. Executing an OpenCL Kernel on an SoC FPGA 4.2.8. Uninstalling the Intel® FPGA RTE for OpenCL™ Standard Edition
4.2.6. Installing the Cyclone V SoC Development Kit x
4.2.6.1. Writing an SD Card Image onto the Micro SD Flash Card 4.2.6.2. Configuring the SW3 Switches 4.2.6.3. Setting Up Terminal Connection 4.2.6.4. Setting Environment Variables and Loading OpenCL Linux Kernel Driver 4.2.6.5. Connecting the Board to Network via Ethernet
4.2.6.5. Connecting the Board to Network via Ethernet x
4.2.6.5.1. Ensuring IP Address Acquisition 4.2.6.5.2. Mounting a Shared Drive 4.2.6.5.3. Using SSH and SCP
4.2.7. Executing an OpenCL Kernel on an SoC FPGA x
4.2.7.1. Building the Host Application 4.2.7.2. Running the Host Application 4.2.7.3. Output from Successful Kernel Execution on the Cyclone V SoC Development Kit
1. Intel® FPGA RTE for OpenCL™ Standard Edition Getting Started Guide
2. Getting Started with the Intel® FPGA RTE for OpenCL™ Standard Edition for 64-Bit Windows
3. Getting Started with the Intel® FPGA RTE for OpenCL™ Standard Edition for x86_64 Linux Systems
4. Getting Started with the Intel® FPGA RTE for OpenCL™ Standard Edition for Intel® ARMv7-A SoC FPGA
A. Document Revision History of the Intel® FPGA RTE for OpenCL™ Standard Edition Getting Started Guide

1.2. Contents of the Intel® FPGA RTE for OpenCL™ Standard Edition

The Intel® FPGA RTE for OpenCL™ Standard Edition provides utilities, host runtime libraries, drivers, and RTE-specific libraries and files.

Utilities and Host Runtime Libraries

  • The RTE Utility includes commands you can invoke to perform high-level tasks. The RTE utilities are a subset of of the Intel® FPGA SDK for OpenCL Standard Edition utilities.
  • The host runtime provides the OpenCL host platform API and runtime API for your OpenCL host application.

    The host runtime consists of the following libraries:

    • Statically-linked libraries provide OpenCL host APIs, hardware abstractions and helper libraries.
    • Dynamic link libraries (DLLs) provide hardware abstractions and helper libraries.

Drivers, Libraries and Files

The RTE installation process installs the RTE into a directory that you own. The path to the software installation directory is referenced by the INTELFPGAOCLSDKROOT environment variable.

Table 1.  Contents of the RTE Installation Directory
Windows Folder Linux Directory ARM Directory Description
bin bin bin High-level utilities. Include this directory in your PATH environment variable setting.
board board board The Reference Platform available with the RTE.
Important: The Reference Platform for the RTE does not include the hardware subdirectory.
host host host Files necessary for compiling your host program.
host\include 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 host/arm32/lib OpenCL host runtime libraries for the given target platform that provide the OpenCL platform and runtime APIs. These libraries are necessary for linking and running your host application.

Prior to running your host application, include this directory in the library search path.

  • For Linux and ARM®, add the path to the LD_LIBRARY_PATH environment variable setting.
  • For Windows, add the path to the PATH environment variable setting.
host\windows64\bin host/linux64/bin host/arm32/bin Platform-specific binary for the RTE Utility, runtime commands, and DLLs (for Windows) necessary for running your host application, wherever applicable. Include this directory in your PATH environment variable setting.
share\lib\perl share/lib/perl share/lib/perl Perl scripts and support libraries for the RTE Utility.

Example OpenCL Applications

You can download example OpenCL applications from the OpenCL Design Examples page.

Related Information
Level Two Title