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

Download PDF
ID 683678
Date 9/24/2018
Public
Document Table of Contents
Document Table of Contents x
1. Intel® FPGA SDK for OpenCL™ Standard Edition Getting Started Guide 2. Getting Started with the Intel® FPGA SDK for OpenCL™ Standard Edition for Windows 3. Getting Started with the Intel® FPGA SDK for OpenCL™ Standard Edition for Linux A. Document Revision History for Intel® FPGA SDK for OpenCL™ Standard Edition Getting Started Guide
1. Intel® FPGA SDK for OpenCL™ Standard Edition Getting Started Guide x
1.1. Prerequisites for the Intel® FPGA SDK for OpenCL™ Standard Edition 1.2. Contents of the Intel® FPGA SDK for OpenCL™ Standard Edition 1.3. Overview of the Intel® FPGA SDK for OpenCL™ Standard Edition Setup Process
2. Getting Started with the Intel® FPGA SDK for OpenCL™ Standard Edition for Windows x
2.1. Downloading the Intel® FPGA SDK for OpenCL™ Standard Edition 2.2. Installing the Intel® FPGA SDK for OpenCL™ 2.3. Setting the Intel® FPGA SDK for OpenCL™ Standard 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 the Software 2.11. Uninstalling the FPGA Board
2.6. Verifying Host Runtime Functionality via Emulation x
2.6.1. Downloading 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™ Standard Edition for Linux x
3.1. Downloading the Intel® FPGA SDK for OpenCL™ Standard Edition 3.2. Installing the Intel® FPGA SDK for OpenCL™ 3.3. Setting the Intel® FPGA SDK for OpenCL™ Standard 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 the Software 3.11. Uninstalling the FPGA Board
3.6. Verifying Host Runtime Functionality via Emulation x
3.6.1. Downloading 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™ Standard Edition Getting Started Guide
2. Getting Started with the Intel® FPGA SDK for OpenCL™ Standard Edition for Windows
3. Getting Started with the Intel® FPGA SDK for OpenCL™ Standard Edition for Linux
A. Document Revision History for Intel® FPGA SDK for OpenCL™ Standard Edition Getting Started Guide

3.3. Setting the Intel® FPGA SDK for OpenCL™ Standard Edition User Environment Variables

You have the option to set the Intel® FPGA SDK for OpenCL™ Standard Edition Linux user environment variables permanently or transiently. The environment variable settings describe the FPGA board and the host runtime to the software.
Attention: If you set the environment variables permanently, you apply the settings once during installation. If you set the environment variables transiently, you must apply the settings during installation and during every subsequent session you run.
Table 3.   Intel® FPGA SDK for OpenCL™ Linux User Environment Variable Settings
Environment Variable Path to Include
PATH $INTELFPGAOCLSDKROOT/bin

where INTELFPGAOCLSDKROOT points to the path of the software installation

LD_LIBRARY_PATH $INTELFPGAOCLSDKROOT/host/linux64/lib
  • To apply permanent environment variable settings, open a shell and then type the export <variable_name>="<variable_setting>":$<variable_name> command.
    For example, the command export PATH="$INTELFPGAOCLSDKROOT/bin":$PATH adds $INTELFPGAOCLSDKROOT/bin to the list of PATH settings.
  • To apply transient environment variable settings, open a bash-shell command-line terminal and run the source $INTELFPGAOCLSDKROOT/init_opencl.sh command. This command does not work in other shells.

    Example script output:

    Adding $INTELFPGAOCLSDKROOT/bin to PATH
Adding $INTELFPGAOCLSDKROOT/host/linux64/lib to LD_LIBRARY_PATH

    where AOCL_BOARD_PACKAGE_ROOT points to the path of the Custom or Reference Platform.

Level Two Title