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

Download PDF
ID 683173
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 RTE for OpenCL™ Pro Edition Getting Started Guide 2. Getting Started with the Intel® FPGA RTE for OpenCL™ Pro Edition for 64-Bit Windows 3. Getting Started with the Intel® FPGA RTE for OpenCL™ Pro Edition for x86_64 Linux Systems 4. Getting Started with the Intel® FPGA RTE for OpenCL™ Pro Edition for Intel® ARMv7-A SoC FPGA A. Intel® FPGA RTE for OpenCL™ Pro Edition Getting Started Guide Archives B. Document Revision History of the Intel® FPGA RTE for OpenCL™ Pro Edition Getting Started Guide
1. Intel® FPGA RTE for OpenCL™ Pro Edition Getting Started Guide x
1.1. Prerequisites for the Intel® FPGA RTE for OpenCL™ Pro Edition 1.2. Contents of the Intel® FPGA RTE for OpenCL™ Pro Edition 1.3. RTE Utility 1.4. Overview of the Intel® FPGA RTE for OpenCL™ Pro Edition Setup Process
1.1. Prerequisites for the Intel® FPGA RTE for OpenCL™ Pro Edition x
1.1.1. GCC Requirement
1.3. RTE Utility x
1.3.1. Displaying the Software Version 1.3.2. Listing the Intel® FPGA RTE for OpenCL™ 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™ Pro Edition for 64-Bit Windows x
2.1. Downloading the Intel® FPGA RTE for OpenCL™ Pro Edition 2.2. Installing the Intel® FPGA RTE for OpenCL™ Pro Edition 2.3. Setting the Intel® FPGA RTE for OpenCL™ Pro 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 an 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™ Pro Edition for x86_64 Linux Systems x
3.1. Downloading the Intel® FPGA RTE for OpenCL™ Pro Edition 3.2. Installing the Intel® FPGA RTE for OpenCL™ Pro Edition 3.3. Verifying Software Installation 3.4. Installing an FPGA Board 3.5. Updating the Hardware Image on the FPGA 3.6. Executing an OpenCL Kernel on an FPGA 3.7. Uninstalling the Software 3.8. Uninstalling an FPGA Board
3.2. Installing the Intel® FPGA RTE for OpenCL™ Pro Edition x
3.2.1. Setting the Intel® FPGA RTE for OpenCL™ Pro Edition User Environment Variables
3.5. Updating the Hardware Image on the FPGA x
3.5.1. Querying the Device Name of Your FPGA Board 3.5.2. Programming the Flash Memory of an FPGA
3.6. Executing an OpenCL Kernel on an FPGA x
3.6.1. Building the Host Application 3.6.2. Running the Host Application 3.6.3. Output from Successful Kernel Execution
4. Getting Started with the Intel® FPGA RTE for OpenCL™ Pro Edition for Intel® ARMv7-A SoC FPGA x
4.1. Getting Started with the Intel® FPGA RTE for OpenCL™ Pro Edition for SoC FPGA on Windows 4.2. Getting Started with the Intel® FPGA RTE for OpenCL™ Pro Edition for SoC FPGA on Linux
4.1. Getting Started with the Intel® FPGA RTE for OpenCL™ Pro Edition for SoC FPGA on Windows x
4.1.1. Downloading the Intel® FPGA SDK for OpenCL and the SoC EDS 4.1.2. Installing the Intel® FPGA SDK for OpenCL Pro Edition for SoC FPGA 4.1.3. Installing the Intel® SoC FPGA Embedded Development Suite Pro Edition 4.1.4. Recompiling the Linux Kernel Driver 4.1.5. Installing the Intel FPGA RTE for OpenCL Pro Edition onto the SoC FPGA Board 4.1.6. Installing the Intel® Arria® 10 SoC Development Kit 4.1.7. Executing an OpenCL Kernel on an SoC FPGA 4.1.8. Uninstalling the Intel® FPGA RTE for OpenCL™
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.2. Getting Started with the Intel® FPGA RTE for OpenCL™ Pro Edition for SoC FPGA on Linux x
4.2.1. Downloading the Intel® FPGA SDK for OpenCL™ and the SoC EDS 4.2.2. Installing the Intel® FPGA SDK for OpenCL Pro Edition for SoC FPGA 4.2.3. Installing the Intel® SoC FPGA Embedded Development Suite Pro Edition 4.2.4. Recompiling the Linux Kernel Driver 4.2.5. Installing the Intel FPGA RTE for OpenCL Pro Edition onto the SoC FPGA Board 4.2.6. Installing the Intel® Arria® 10 SoC Development Kit 4.2.7. Executing an OpenCL Kernel on an SoC FPGA 4.2.8. Uninstalling the Intel® FPGA RTE for OpenCL™
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
1. Intel® FPGA RTE for OpenCL™ Pro Edition Getting Started Guide
2. Getting Started with the Intel® FPGA RTE for OpenCL™ Pro Edition for 64-Bit Windows
3. Getting Started with the Intel® FPGA RTE for OpenCL™ Pro Edition for x86_64 Linux Systems
4. Getting Started with the Intel® FPGA RTE for OpenCL™ Pro Edition for Intel® ARMv7-A SoC FPGA
A. Intel® FPGA RTE for OpenCL™ Pro Edition Getting Started Guide Archives
B. Document Revision History of the Intel® FPGA RTE for OpenCL™ Pro Edition Getting Started Guide

B. Document Revision History of the Intel® FPGA RTE for OpenCL™ Pro Edition Getting Started Guide

Document Version Intel® Quartus® Prime Version Changes
2022.03.28 22.1
  • Updated the instructions to access memory recommendations in Prerequisites for the Intel FPGA RTE for OpenCL Pro Edition.
  • Updated the instructions to download software in the following Linux and Windows-specific topics:
    • Downloading the Intel FPGA RTE for OpenCL Pro Edition
    • Downloading the Intel FPGA SDK for OpenCL and the SoC EDS
2021.12.13 21.4
  • Maintenance release.
2021.10.04 21.3
  • Maintenance release.
2021.06.21 21.2
  • Maintenance release.
2021.03.29 21.1
  • Maintenance release.
2020.12.14 20.4
  • Updated the RTE versions.
2020.09.28 20.3
  • Added more information to the GCC Requirement page.
  • Updated the RTE versions.
  • Updated a note about the lack of support for Windows and Linux BSPs in Managing an FPGA Board and Installing an FPGA Board.
2020.06.22 20.2
  • Removed all references to Akamai and direct download methods.
  • Added a note about -nodeps option and made minor updates to the output of FCD and ICD setup output in Building the Host Application.
  • Added a note about downloading the BSPs online since they are no longer shipped with SDK in Overview of the Intel® FPGA RTE for OpenCL™ Pro Edition Setup Process and Managing an FPGA board topics.
  • Updated some of the prerequisites in Prerequisites for the Intel® FPGA RTE for OpenCL™ Pro Edition.
  • Updated the init_opencl.bat script output in Setting the Intel® FPGA RTE for OpenCL™ Pro Edition User Environment Variables
  • Removed the board directory from Contents of the Intel® FPGA RTE for OpenCL™ Pro Edition.
  • Updated all references to downloading OpenCL design examples from Intel website and replaced them with instructions to access examples from the Intel FPGA SDK for OpenCL installation.
  • Updated RTE Setup Process for x86-64 Systems and RTE Setup Process for SoC FPGA diagrams.
  • Added a new topic GCC Requirement.
2020.04.15 19.1
  • Changed rpm -e aocl-rte to rpm -e intel-fpga-opencl-pro-rte in Uninstalling the Software.
  • Changed aclrte-arm32.tgz to intel-fpga-opencl-pro-rte-32bit-arm.tgz in Installing the Intel FPGA RTE for OpenCL Pro Edition onto the SoC FPGA Board.
  • Changed mv aclrte-arm32.tgz <rte_destination_directory> to mvintel-fpga-opencl-pro-rte-32bit-arm.tgz <rte_destination_directory> in Installing the Intel FPGA RTE for OpenCL Pro Edition onto the SoC FPGA Board.
  • Changed tar -xvfz aclrte-arm32.tgz to tar -xzvf intel-fpga-opencl-pro-rte-32bit-arm.tgz in Installing the Intel FPGA RTE for OpenCL Pro Edition onto the SoC FPGA Board.
  • Updated the list of variables to be set, in Installing the Intel FPGA RTE for OpenCL Pro Edition onto the SoC FPGA Board.
2019.09.30 19.1 In Installing the Intel® FPGA RTE for OpenCL™ Pro Edition topic, made the following updates:
  • Changed /usr/intelFPGA_pro/<version>/aclrte_linux64 to /usr/intel/<version>/intel-fpga-opencl-pro-rte.
  • Changed aocl-rte-<version>.x86_64.rpm to intel-fpga-opencl-pro-rte-64bit-linux.rpm.
  • Changed opt/intelFPGA_pro/aclrte-linux64 to /opt/intel/intel-fpga-opencl-pro-rte.
2019.04.01 19.1
2019.01.14 18.1
2018.12.24 18.1
2018.09.24 18.1
  • Maintenance release
2018.05.04 18.0
  • Removed information related to the Intel® FPGA RTE for OpenCL™ Standard Edition, the Intel FPGA SDK for OpenCL Standard Edition, and the Intel SoC FPGA Embedded Development Suite Standard Edition.
  • Updated the Getting Started with the Intel® FPGA RTE for OpenCL™ Pro Edition for ARMv7-A SoC FPGA chapter to include Intel® Arria® 10 SoC information.
Date Version Changes
November 2017 2017.11.04
May 2017 2017.05.05
  • Rebranded the Altera Client Driver (ACD) to FPGA Client Driver (FCD).
  • Updated the download instructions in Downloading the Intel® FPGA RTE for OpenCL™ for Windows and Linux.
  • Added reminders that folder names where you uncompress downloaded OpenCL design examples must not contain spaces.
October 2016 2016.10.31
  • Rebranded Altera RTE for OpenCL to Intel® FPGA RTE for OpenCL™ .
  • Rebranded Altera SoC Embedded Design Suite to Intel SoC FPGA Embedded Design Suite.
  • Rebranded ARM DS-5 Altera Edition Toolkit to Arm* DS-5* Intel® SoC FPGA Edition Toolkit.
  • Deprecated and removed support for big-endian system, resulting in the following documentation changes:
    • In Prerequisites for the Altera RTE for OpenCL, removed "Red Hat Enterprise Linux 6 on big-endian system" from the list of supported operating systems.
    • In Contents of the Altera RTE for OpenCL, removed the Big-Endian System Directory column from the table of contents in the RTE installation directory.
    • In Downloading the Altera RTE for OpenCL for Linux, removed from Step 6 the choice to select the OpenCL PowerPC RPM installation package.
    • Removed the topics Installing the Altera RTE for OpenCL on Big-Endian Systems and Setting the Environment Variables on Big-Endian Systems.
    • In Installing and FPGA Board for Linux, removed information on running the init_opencl script on big-endian systems, and removed related link to Setting the Environment Variables on Big-Endian Systems.

  • In Installing an FPGA Board for 64-bit Windows and Linux, provided the following updates:

    • Noted that the SDK supports installation of multiple Custom Platforms. To use the SDK utilities on each board in a system with multiple Custom Platforms, the AOCL_BOARD_PACKAGE_ROOT environment variable setting must correspond to the Custom Platform subdirectory of the associated board.
    • Noted that in a system with multiple Custom Platforms, the host program should use ACD to discover the boards instead of directly linking to the MMD libraries.
  • In Building the Host Application for 64-bit Windows, outlined the prerequisite tasks for setting up ACD and ICD for use with Microsoft Visual Studio 2015 prior to building the host application.
  • Updated all RTE output for a successful kernel execution.
May 2016 2016.05.02
  • Replaced the lists of supported Windows and Linux versions to a link to the Operating System Support page on the Altera website.
  • Added the %ALTERAOCLSDKROOT%\windows64\bin setting to the list of Windows environment variables.
November 2015 2015.11.02
  • Added Windows 8.1 to supported Windows versions.
  • Added the following figures to illustrate the RTE setup processes for x86-64, big-endian, and SoC systems:
    • RTE Setup Process for x86-64 and Big-Endian Systems
    • RTE Setup Process for SoC
  • Modified software download and installation instructions for SoC to include the new tar file installation package.
  • Modified instructions for executing the hello_world OpenCL example design onto a device. You must create your own .aocx file from the hello_world.cl file on a separate development machine, and then use the RTE to deploy the .aocx file onto the device.
  • Removed licensing sections because an AOCL license is not necessary to run the RTE.
May 2015 15.0.0
  • Reorganized instructions into the following sections:
    • Introduction to the RTE
    • Getting Started with the RTE for Windows
    • Getting Started with the RTE for Linux and Big-Endian Systems
    • Getting Started with the RTE for Altera ARMv7-A SoC, which is further divided into Windows and Linux instructions
December 2014 14.1.0
  • Reorganized information flow.
  • Updated Red Hat Enterprise Linux (RHEL) version support.
  • Added licensing information in the Licensing the Software section.
  • Included information on the init_opencl script for setting environment variables.
  • Updated the board uninstallation instructions to include the invocation of the aocl uninstall utility command.
June 2014 14.0.0 Initial release.
Level Two Title