AN 780: Compiling and Customizing an Intel® Arria® 10 Custom Platform for OpenCL*

ID 683045
Date 10/30/2018
Public
Document Table of Contents

1.5. Intel® FPGA SDK for OpenCL™ and User Environment Setup

Install the Intel® FPGA SDK for OpenCL™ before compiling an OpenCL application. SDK installation instructions are available in the Intel® FPGA SDK for OpenCL™ Getting Started Guide.

The software installation process installs the SDK application into a directory that you own. The INTELFPGAOCLSDKROOT environment variable references the path to the SDK installation directory.

Table 2.  Structure of the SDK Installation Directory
Windows Folder Linux Directory Description
bin bin User commands in the SDK. Include this directory in your PATH environment variable setting.
board board

The SDK Custom Platform Toolkit and Reference Platforms available with the software.

The path to the Custom Platform Toolkit is INTELFPGAOCLSDKROOT/board/custom_platform_toolkit.

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 SDK utility command.
share share Architecture-independent support files.

After you install the SDK on your machine and you are familiar with the directory structure, set up the environment to run the Intel® FPGA SDK for OpenCL™ Offline Compiler and emulate the design. The following sections describe how to set the user environment for either the Windows or Linux operating systems.

You have the option to set the SDK user environment variables permanently or transiently. The environment variable settings describe the FPGA board and the host runtime to the software.