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

ID 683678
Date 9/24/2018
Public
Document Table of Contents

A. Document Revision History for Intel® FPGA SDK for OpenCL™ Standard Edition Getting Started Guide

Document Version Intel® Quartus® Prime Version Changes
2018.09.24 18.1
2018.05.04 18.0
  • Removed Intel® FPGA SDK for OpenCL™ Pro Edition and Intel® Quartus® Prime Pro Edition software-related information.
Date Version Changes
December 2017 2017.12.08
  • Updated the following sections to include the availability of Intel® FPGA SDK for OpenCL™ installation packages that include Intel Code Builder:
    • Downloading the Intel® FPGA SDK for OpenCL™ (Windows)
    • Downloading the Intel® FPGA SDK for OpenCL™ (Linux)
  • Updated the following sections to include the Java SE version prerequisite required to run Intel Code Builder:
    • Prerequisites for the Intel® FPGA SDK for OpenCL™
    • Installing the Intel® FPGA SDK for OpenCL™ (Linux)
November 2017 2017.11.06
  • Rebranded the following:
    • ALTERAOCLSDKROOT to INTELFPGAOCLSDKROOT
    • CL_CONTEXT_EMULATOR_DEVICE_ALTERA to CL_CONTEXT_EMULATOR_DEVICE_INTELFPGA
    • Quartus Prime to Intel® Quartus® Prime
    • Arria 10 to Intel® Arria® 10
    • USB Blaster to Intel® FPGA Download Cable
  • In Intel® FPGA SDK for OpenCL™ Getting Started Guide, changed OpenCL Reference Pages as OpenCL 1.0 reference pages to improve clarity and added reference to Intel Arria 10 GX Application Note.
  • In Prerequisites for the Intel® FPGA SDK for OpenCL™ :
    • Changed Intel preferred accelerator board to Intel FPGA Preferred Board for OpenCL.
    • Changed Microsoft Visual Studio version 2010 Professional as Microsoft Visual Studio Professional version 2010 or later.
  • In Contents of the Intel® FPGA SDK for OpenCL™ :
    • In the sentence "The Intel FPGA SDK for OpenCL provides logic components, drivers, and SDK-specific libraries and files.", changed logical components to programs.
    • Under the Logic Components section, changed "host platform API and runtime API" as "host and runtime API".
  • In Building the Host Application (Windows), updated references to Microsoft Visual Studio 2015 as Microsoft Visual Studio.
  • In Executing an OpenCL Kernel on an FPGA (Windows), updated reference to Microsoft Visual Studio version 2010 Professional as Microsoft Visual Studio.
  • Removed topics on Licensing the Intel FPGA SDK for OpenCL in both OpenCL for Linux and Windows sections.
  • Added support for Intel® Stratix® 10 devices in the following topics:
    • Downloading the Intel FPGA SDK for OpenCL (Windows)
    • Installing an FPGA Board (Windows)
    • Verifying Host Runtime Functionality via Emulation (Windows)
    • Creating the FPGA Hardware Configuration File of an OpenCL Kernel (Windows)
    • Downloading the Intel FPGA SDK for OpenCL (Linux)
    • Installing an FPGA Board (Linux)
    • Verifying Host Runtime Functionality via Emulation (Linux)
    • Creating the FPGA Hardware Configuration File of an OpenCL Kernel (Linux)
  • Implemented single dash and -option=<value> conventions in the following topics:
    • Overview of the Intel FPGA SDK for OpenCL Setup Process
    • Creating the FPGA Hardware Configuration File of an OpenCL Kernel (Windows)
    • Compiling a Kernel for Emulation
  • Removed references to AOCL_BOARD_PACKAGE_ROOT throughout the guide since it is deprecated.
  • Updated instances of aocl install to aocl install <path_to_customplatform>.
  • Updated instances of aocl uninstall to aocl uninstall <path_to_customplatform>.
  • In Overview of the Intel FPGA SDK for OpenCL Setup Process, added a note after the Installation Process Overview diagram about possible errors after implementing aocl diagnose.
  • In Updating the Hardware Image on the FPGA, added a note and related links to Configuring the Intel Arria 10 GX FPGA Development Kit for the Intel FPGA SDK for OpenCL application note.
May 2017 2017.05.05
  • Rebranded the Altera Client Driver (ACD) to the FPGA Client Driver (FCD).
  • Updated the download instructions in Downloading the Intel® FPGA SDK 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 the Altera SDK for OpenCL to Intel® FPGA SDK for OpenCL™ .
  • Rebranded the Altera Offline Compiler to Intel® FPGA SDK for OpenCL™ Offline Compiler.
  • In Installing an FPGA Board for Windows and Linux, provided the following updates:
    • Noted that the SDK supports multi-Custom Platform installation. To use the SDK utilities on each board in a multi-Custom Platform installation, the AOCL_BOARD_PACKAGE_ROOT environment variable setting must correspond to the Custom Platform subdirectory of the associated board.

    • Noted that in a multi-Custom Platform system, the host program should use ACD to discover the boards instead of directly linking to the MMD libraries.

  • In Building the Host Application for Windows, outlined the prerequisite tasks for setting up ACD and ICD for use with Microsoft Visual Studio 2015 prior to building the host application.
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.
  • Corrected the Windows instructions for setting the CL_CONTEXT_EMULATOR_DEVICE_ALTERA variable for emulating multiple devices.
November 2015 2015.11.02
  • Changed instances of Quartus II to Quartus Prime.
  • Added Windows 8.1 to supported Windows versions.
  • Modified download and installation instructions for the tar file that includes the AOCL, Quartus Prime software, and device support.
  • Deprecated and removed AOCL-only installation instructions because they are invalid for the current version.
  • Added instructions to verify host runtime functionality by emulating the hello_world example design.
  • Modified the figure FPGA Programming Overview to include emulation in the programming flow.
  • Updated uninstallation instructions.
May 2015 15.0.0
  • Reorganized instructions into the following sections:
    • Getting Started with the AOCL on Windows
    • Getting Started with the AOCL on Linux
December 2014 14.1.0
  • Reorganized information flow.
  • Updated Red Hat Enterprise Linux (RHEL) version support.
  • Included the Contents of the AOCL section.
  • Updated licensing instructions for the new Altera Software Development Kit (SDK) for OpenCL (AOCL) single license.
  • Updated board uninstallation instructions to include the aocl uninstall utility command.
  • Included information on the init_opencl script for setting environment variables.
  • Grouped software and board uninstallation instructions under Uninstalling the Software and the FPGA Board.
June 2014 14.0.0
  • Updated the Prerequisites section.
  • Updated the figure AOCL Installation Process Overview.
  • Updated software download instructions.
  • Updated AOCL installation and uninstallation instructions for Windows.
  • For Linux systems:
    • Added the sections Installing the AOCL on Linux Using RPM and Uninstalling the AOCL on Linux Using RPM.
    • Updated the section Installing the AOCL on Linux Using the GUI Installer.
  • Added the section Licensing the Software.
  • Updated the section Installing an FPGA Board with updated instructions on querying your devices and running diagnostic tests.
  • Updated the section Creating the FPGA Hardware Configuration File of an OpenCL Kernel:
    • Updated path that you have to set for AOCL_BOARD_PACKAGE_ROOT.
    • Updated example AOC output for compiling hello_world.cl with the -v option.
    • Updated AOC output.
  • Added the section Identifying the Device Name of Your FPGA Board.
  • Modified instructions for building and running the host application with updated hello_world directory and file names.
  • Added the section Uninstalling an FPGA Board.
December 2013 13.1.1
  • Updated the Prerequisites section to include a reminder to install Linux kernel source, headers, and GCC.
November 2013 13.1.0
  • Reorganized information flow.
  • Updated the Prerequisites section.
  • Updated board installation instructions.
  • Updated software download instructions.
  • Inserted the section Installing the AOCL and the Quartus II Software Together.
  • Updated software installation and uninstallation instructions.
  • Inserted the following figures:
    • AOCL Installation Process Overview
    • FPGA Programming Overview
  • Removed the Licensing section.
  • Removed all board-specific installation and configuration instructions.
  • Changed example OpenCL application used to demonstrate kernel configuration and FPGA programming from moving_average to hello_world.
  • Inserted the section Updating the Hardware Image on the FPGA, which contained the updated flash programming instructions.
  • Removed the section Installing the USB-Blaster Driver on Windows.
  • Updated output from successful execution of hello_world kernel on FPGA for Windows and Linux systems.
  • Removed the figure Contents of the Moving Average Example.
  • Removed the figure Opening host.sln in Visual Studio.
June 2013 13.0 SP1.0
  • Updated requisite Quartus II and AOCL software versions from 13.0 to 13.0 SP1.
  • Inserted the figure A Correct Windows Device Manager After Complete Board Driver Installation for a BittWare Board.
  • Updated the vendor and device IDs in the Verifying the Functionality of the BittWare Board section for Windows.
  • Updated the AOCL installation instructions for Linux systems that do not contain a .cshrc or a .bashrc file in the directory.
  • Updated path to the AOCL design examples.
  • Updated the figure Contents of the Moving Average Example.
  • Updated flash programming instructions.
May 2013 13.0.1
  • Renamed the OpenCL_SDK folder or directory to AOCL.
  • Inserted warning about the AOCL installation dependency on .cshrc and .bashrc files for Linux systems.
  • Included reminder to BittWare board users about installing the BittWare development software.
  • Inserted warning about potential Jungo WinDriver installation failure for systems running on Windows 7. Included reinstallation instructions.
  • Inserted warnings about error messages displayed for aocl commands that have not been implemented for the BittWare FPGA board.
  • Inserted caution message about setting the environment variable AOCL_BOARD_PACKAGE_ROOT .
  • Updated board driver installation procedures for Windows and Linux systems.
  • Modified the path to the default location of the AOCL for Windows and Linux systems.
  • Modified the path name added to the PATH environment variable when installing the AOCL on Linux systems. The path name should be $QUARTUS_ROOTDIR/bin instead of $QUARTUS_ROOTDIR/bin64 .
May 2013 13.0.0
  • Updated installation and compilation procedures.
  • Incorporated licensing procedure.
  • Updated flash programming procedure and moved it to Appendix A.
  • Updated links to software and documentation download pages.
November 2012 12.1.0 Initial release.