DE10 PRO OpenCL Manual 19.1

Download as pdf or txt
Download as pdf or txt
You are on page 1of 47
At a glance
Powered by AI
The document provides information on using OpenCL with the DE10-Pro FPGA development board on both Windows and Linux operating systems. It covers topics such as system requirements, software installation, environment configuration, and compiling OpenCL programs.

The system requirements specified in section 1.1 are that the host computer must be running 64-bit Windows or Linux and have at least 4GB of RAM.

Section 2.1 covers installing the required software, section 2.2 covers configuring the environment variables, section 2.3 verifies the OpenCL environment, and section 2.4 covers initializing the FPGA for use with OpenCL.

DE10-Pro OpenCL 1 www.terasic.

com
August 6, 2019
CONTENTS

CHAPTER 1 DE10-PRO OPENCL ................................................................................................................... 3

1.1 SYSTEM REQUIREMENT ............................................................................................................................................ 4


1.2 OPENCL ARCHITECTURE .......................................................................................................................................... 5

CHAPTER 2 OPENCL FOR WINDOWS ........................................................................................................... 6

2.1 SOFTWARE INSTALLATION ......................................................................................................................................... 6


2.2 ENVIRONMENT CONFIGURE .................................................................................................................................... 10
2.3 OPENCL ENVIRONMENT VERIFY ............................................................................................................................ 13
2.4 INITIALIZING THE FPGA FOR USING WITH OPENCL ................................................................................................ 15
2.5 OPENCL RUNTIME VERIFY ..................................................................................................................................... 21
2.6 COMPILE AND TEST OPENCL PROJECT.................................................................................................................... 23

CHAPTER 3 OPENCL FOR LINUX ................................................................................................................. 26

3.1 SOFTWARE INSTALLATION ....................................................................................................................................... 26


3.2 ENVIRONMENT CONFIGURE .................................................................................................................................... 30
3.3 OPENCL ENVIRONMENT VERIFY ............................................................................................................................ 31
3.4 INITIALIZING THE FPGA FOR USE WITH OPENCL .................................................................................................... 32
3.5 OPENCL RUNTIME VERIFY ..................................................................................................................................... 37
3.6 COMPILE AND TEST OPENCL PROJECT.................................................................................................................... 39

CHAPTER 4 APPENDIX...................................................................................................................................... 41

REVISION HISTORY ................................................................................................................................................... 47

COPYRIGHT STATEMENT ........................................................................................................................................ 47

DE10-Pro OpenCL 2 www.terasic.com


August 6, 2019
Chapter 1
DE10-Pro OpenCL
DE10-Pro Stratix 10 FPGA Development Kit, an unparalleled and powerful platform for high-speed
computation, is now officially also an Intel certified board for Intel’s Preferred Board Partner
Program for OpenCL. It supports both 64-bit Windows and Linux Operation System. This
document will introduce you how to setup OpenCL development environment, and how to compile
and execute the example projects for DE10-Pro board. Note that OpenCL coding instruction is not
introduced in this document, but the user can refer to Intel FPGA SDK for OpenCL Programming
Guide for more details.

https://www.altera.com/en_US/pdfs/literature/hb/opencl-sdk/aocl_programming_guide.pdf

This OpenCL BSP and manual can support several devices(on DE10-Pro Stratix 10 FPGA Borad)
development. In the BSP, we use different board names to distinguish the board, the correspondence
of the <board name> and the FPGA Device is as follows:

<board name> FPGA Devices DDR4 Support


s10_gh2e2_4Gx2 1SG280HU2F50E2VG 4GBx2(C/D Socket), 2400MT/s
s10_gh2e2_165_4Gx2 1SG165HU2F50E2VG 4GBx2(C/D Socket), 2400MT/s
s10_gh1e1_4Gx2 1SG280HU1F50E1VG 4GBx2(C/D Socket), 2666MT/s
s10_sh2e1_4Gx2 1SX280HU2F50E1VG 4GBx2(C/D Socket), 2666MT/s

DE10-Pro OpenCL 3 www.terasic.com


August 6, 2019
1.1 System Requirement

The following items are required to set up OpenCL for DE10-Pro board:

⚫ DE10-Pro Board with two 4GB DDR4 installed on DDR4-SODIMM-C and


DDR4-SODIMM-D port.
⚫ A Host PC with
◼ USB Host Port
◼ One PCI Express x8/x16 slot with 12V power pin
◼ 64GB memory is recommended, 48GB is minimal
⚫ An USB Cable (type A to mini-B)
⚫ 64-bit Windows 10 or Linux (CentOS 7.2/Ubuntu 16.04) Installed
⚫ Intel Quartus Prime Pro Edition 19.1.0.240 Installed, licensed is required
⚫ Intel Quartus Prime Pro 19.1 Patch 0.03 Installed
⚫ Intel FPGA SDK for OpenCL Pro Edition 19.1.0.240 Installed, license is not required
⚫ DE10-Pro OpenCL BSP 19.1 Installed
⚫ Visual Studio 2015 C/C++ installed for Windows 10
⚫ GNU development tools for Linux

Note:
1. Intel FPGA OpenCL only supports 64-bit OS and x86 architecture.
2. We strongly recommend setting the PCIe speed to Gen3x8 in your PC BIOS for good
performance.

DE10-Pro OpenCL 4 www.terasic.com


August 6, 2019
1.2 OpenCL Architecture

An OpenCL project is composed of both OpenCL Kernel and Host Program as shown in Figure
1-1. OpenCL kernel is compiled with Intel FPGA OpenCL compiler provided by the Altera OpenCL
SDK. The Host Program is compiled by Visual Studio C/C++ in Windows or GCC on Linux.

Figure 1-1 Intel FPGA OpenCL Architecture

DE10-Pro OpenCL 5 www.terasic.com


August 6, 2019
Chapter 2
OpenCL for Windows

This chapter describes how to set up OpenCL development environment on 64-bit Windows, and
how to compile and test the OpenCL examples for DE10-Pro. For more details about Intel FPGA
OpenCL started guide, please refer to:

https://www.altera.com/en_US/pdfs/literature/hb/opencl-sdk/aocl_getting_started.pdf

2.1 Software Installation

This section describes where to get the required software for OpenCL.

◼ Quartus Prime Pro and OpenCL SDK

Intel Quartus Prime Pro Edition 19.1.0.240 and Intel FPGA SDK for OpenCL Pro Edition
19.1.0.240 can be download from the web site:

http://dl.altera.com/opencl/19.1/?edition=pro

For Quartus II installation, please make sure that the Stratix10 device is included.

Open the link and select the Windows SDK table as Figure 2-1 shows.

DE10-Pro OpenCL 6 www.terasic.com


August 6, 2019
Figure 2-1 OpenCL Windows SDK Files

◼ Quartus Prime 19.1 Patch

When using the Intel® Quartus® Prime Pro Edition software version 19.1 with the Intel® FPGA
Download Cable II (formerly referred to as USB Blaster II download cable) or an on-board
implementation of the Intel® FPGA Download Cable II IP solution (formerly referred to as
on-board USB Blaster II solution), a USB device enumeration error may occur when plugging in
the Intel® FPGA Download Cable II to the computer hosting the Intel® Quartus® Prime Pro
Edition software.
To workaround this problem, use the Intel® Quartus® Prime Pro Edition software version 19.1 and
download and install patch 0.03 from the links below.
For windows, You must install the patch after installing Intel® Quartus® Prime Pro Edition
software version 19.1 software:
Quartus® Prime Pro 19.1 Patch 0.03 For Windows(.exe)

◼ Visual Studio 2015

If developers don’t have Visual Studio C/C++ 2015, they can use the trial version of Visual Studio
2015 Express. The software can be downloaded from the web site:

https://www.visualstudio.com/vs/older-downloads/

DE10-Pro OpenCL 7 www.terasic.com


August 6, 2019
◼ DE10-Pro OpenCL BSP (Board Support Package)

After Quartus II and OpenCL SDK are installed, download the DE10_Pro_OpenCL_BSP_19.
1.zip DE10-Pro windows BSP from the web site:

http://de10-pro.terasic.com/cd

Then, decompress DE10_Pro_OpenCL_BSP_19.1.zip to the “de10_pro” folder under the folder


“D:\intelFPGA_pro\19.1\hld\board”, as shown in Figure 2-2, where assumed Quartus II is installed
on the folder “D:\ intelFPGA_pro\19.1”.

Figure 2-2 DE10-Pro OpenCL BSP Content

For more details about DE10-Pro OpenCL BSP, please refer to the Table 1.
Table 1 Windows BSP File
File or Folder Description
board_env.xml eXtensible Markup Language (XML) file that describes the Reference
Platform to the Intel FPGA SDK for OpenCL.
hardware Contains the Intel Quartus Prime project templates for the DE10-Pro
board variant.
windows64 Contains the MMD library, kernel mode driver, and executable files of
the SDK utilities (that is, install, uninstall, flash, program, diagnose) for
your 64-bit operating system
tests Contains some OpenCL Design Examples. The following examples
demonstrate how to describe various applications in OpenCL along with
their respective host applications, which you can compile and execute on
a host with an FPGA board that supports the Intel FPGA SDK for
OpenCL.

DE10-Pro OpenCL 8 www.terasic.com


August 6, 2019
scripts When the FPGA is being programmed via the Intel FPGA Download
Cable, the MMD invokes quartus_stp to execute the find_jtag_cable.tcl
script. The script identifies the cable and index number which is then
used to program the FPGA through the quartus_pgm command
bringup The demo batch files of initializing the DE10-Pro Development Kit for
OpenCL User

DE10-Pro OpenCL 9 www.terasic.com


August 6, 2019
2.2 Environment Configure

Developers need to create and edit some environment variable that Intel FPGA OpenCL SDK
can find the kit location of DE10-Pro correctly
Now, here are the procedures to create the required environment variable on Windows 10:
1. Open the Start menu and right click on Computer. Select Properties.
2. Select Advanced system settings.
3. In the Advanced tab, select Environment Variables.
4. Select New.
5. In the popup dialog, edit New User Variable, type the name in the Variable name edit
box and type the value in the Variable value edit box.
First, make sure the environment variable QUARTUS_ROOTDIR vaules in both User variables f
or Adimistrator and System variables are ‘<Quartus Installation Drive>\intelFPGA_pro\19.1\quar
tus’, as shown in Figure 2-3.

Figure 2-3 QUARTUS_ROOTDIR Environment Variable

DE10-Pro OpenCL 10 www.terasic.com


August 6, 2019
Second, create an environment variable INTELFPGAOCLSDKROOT, as shown in Figure 2-4.

Figure 2-4 Setup INTELFPGAOCLSDKROOT Environment Variable

Third, create an environment variable AOCL_BOARD_PACKAGE_ROOT, and set its value as:
“%INTELFPGAOCLSDKROOT%\board\de10_pro”
as shown in Figure 2-5.

Figure 2-5 Setup AOCL_BOARD_PACKAGE_ROOT Environment Variable

Then, create an environment variable CL_OVERRIDE_NUM_DEVICES_INTELFPGA, and set


its value as “1”, as shown in Figure 2-6.

Figure 2-6 Setup CL_OVERRIDE_NUM_DEVICES_INTELFPGA Environment Variable

Also, append
"%QUARTUS_ROOTDIR%\bin64 " and
"%QUARTUS_ROOTDIR%\qsys\bin" and
"%INTELFPGAOCLSDKROOT%\bin" and
"%INTELFPGAOCLSDKROOT%\windows64\bin" and
%INTELFPGAOCLSDKROOT%\host\windows64\bin" and
DE10-Pro OpenCL 11 www.terasic.com
August 6, 2019
"%AOCL_BOARD_PACKAGE_ROOT%\windows64\bin"
into the PATH environment variable as shown in Figure 2-7 and Figure 2-8, so the OpenCL SDK
can find the binary file provided by OpenCL BSP.

Figure 2-7 Select “Path” and click “Edit” bottom

Figure 2-8 Edit PATH environment variable

DE10-Pro OpenCL 12 www.terasic.com


August 6, 2019
2.3 OpenCL Environment Verify

This section will show how to make sure the OpenCL environment is setup correctly. Firstly, please
open Command Prompt windows by click Windows Start button, clicking All Programs, clicking
Windows System, and Right-click Command Prompt to select Run as administrator.

◼ Target AOCL

In Command Prompt (Run as administrator) window, type “where aoc” command, and make
sure the path of the “aoc.exe” is listed as shown in Figure 2-9.

Figure 2-9 where aoc

◼ Target SDK Version

In Command Prompt (Run as administrator) window, type “aocl version” command, and make
sure the version 19.1.0 Bulid 240 Pro Edition of the OpenCL SDK is listed as shown in Figure
2-10.

Figure 2-10 Version of OpenCL SDK

DE10-Pro OpenCL 13 www.terasic.com


August 6, 2019
◼ Target Board

In Command Prompt (Run as administrator) window, type “aoc -list-boards” command, and
make sure “de10_pro” is listed in Board list as shown in Figure 2-11.

Figure 2-11 ‘de10_pro is listed in Board list


If the “de10_pro” is not listed in Board list, please refer to the Chapter 4.2 Appendix to check the
settings of OpenCL in the registry editor.

For more information about the aoc and aocl, refer to the ‘aoc -h’ and ‘aocl help’ command.

DE10-Pro OpenCL 14 www.terasic.com


August 6, 2019
2.4 Initializing the FPGA for using with OpenCL

◼ Board Setup

To use the DE10-Pro FPGA Development Kit with the Intel FPGA SDK for OpenCL, you must
follow the below procedures to set up DE10-Pro board on your PC as shown in Figure 2-12.

1. Make sure your PC is powered off.


2. Insert DE10-Pro board into PCI Express x8 or x16 slot.
3. Connect PC’s 12V PCI Express 8-pin power source to the DE10-Pro (recommended).
4. Connect PC’s USB port to DE10-Pro micro USB II port(J8) using an USB cable.

Figure 2-12 Setup DE10-Pro board on PC

◼ Bring up the FPGA Board

Before you can use the DE10-Pro FPGA Development Kit with OpenCL, you must initialize the
board with an OpenCL image. Without this image, the board host operating system does not
recognize the PCIe card and the Intel FPGA OpenCL compiler cannot find the device. There are
two ways for you to choose:
1. Program the image into FPGA
Program the FPGA with the top.sof file by running the bringup_fpga.bat file in bringup/<board
name> folder as shown in Figure 2-13.

DE10-Pro OpenCL 15 www.terasic.com


August 6, 2019
Figure 2-13 Program the FPGA board

Because the windows 10 enforces driver signatures by default and the OpenCL drivers for our
development kits are not "signed" for Windows 10.
So, for windows10, please refer to the Chapter 4.1 Appendix to disable driver signature enforcement
and reboot system.

2. Program the image into FLASH


Also,you can program the startup configuration flash of DE10-Pro board with the flash.pof file.
In Command Prompt (Run as administrator) window, type “cd D:\intelFPGA_pro\19.1\hld
\board\de10_pro\bringup\<board name>”, then type “bringup_flash.bat”.
Before flash programming, the programmer will ask users which startup configuration image area
will be used as shown in Figure 2-14. This is because DE10-Pro provides two startup configuration
image areas, called as Factory Image and User Image. We recommend users to key in ‘1’ to select
User Image area.
DE10-Pro OpenCL 16 www.terasic.com
August 6, 2019
Figure 2-14 Select Flash Page
After users select desired flash area, it will take about 6 minutes for flash programming. Figure
2-15 is the screen shot when flash programming is done successfully.

Figure 2-15 Program Flash Successfully


To make sure a correct image is used when FPGA boots up, please make sure the dip switch SW4.1
on DE10-Pro is changed to the correct location. If a User Image area is selected, the dip switch
SW4.1 on the DE10-Pro should be moved to Up position as shown in Figure 2-16.

DE10-Pro OpenCL 17 www.terasic.com


August 6, 2019
Figure 2-16 Set SW4.1 to Up Position (User Image Page)
After flash programming is done successfully and SW4.1 is set to correct position, developers
must power off DE10-Pro board and PC, then restart the PC, and refer to the Chapter 4.1
Appendix to disable driver signature enforcement and reboot system.

Note, the USB cable can be removed later if OpenCL code had been programmed to the startup
configuration flash by ‘bringup_flash.bat’.

◼ Driver Installation

Your system must recognize the card so that the Intel FPGA SDK for OpenCL driver can be loaded.
The install utility is used install the kernel driver on the host computer. Users of the Intel FPGA
SDK for OpenCL only need to install the driver once, after that the driver should be automatically
loaded each time the machine reboots.
Open Command Prompt (Run as administrator) window, type ‘aocl install’ to install the driver
as shown in Figure 2-17. Note that users need to have administrator privileges to install the driver.

DE10-Pro OpenCL 18 www.terasic.com


August 6, 2019
Figure 2-17 driver installation
In Device Driver Installation Wizard window, click Next to continue as shown in Figure 2-18.

Figure 2-18 To Continue


If it pops dialog“Windows Security”during the installation process,please choose “Install this
driver software anyway” as shown in Figure 2-19 and go on.

Figure 2-19 Windows Security


When the installation is successful, FPGA Accelerator board can be found in the PC Device
DE10-Pro OpenCL 19 www.terasic.com
August 6, 2019
Manage as shown in Figure 2-20.

Figure 2-20 Driver Installation Success

DE10-Pro OpenCL 20 www.terasic.com


August 6, 2019
2.5 OpenCL Runtime Verify

◼ Test ‘aocl diagnose’ Command

The diagnose utility reports device information and identifies issues. The diagnose utility first
verifies the installation of the kernel driver and returns the overall information of all the devices
installed in a host machine.
In Command Prompt (Run as administrator) window, type “aocl diagnose” to check if the
initialization completed successfully. If successful, the programming message displays
“DIAGNOSTIC_PASSED” as shown in Figure 2-21.

Figure 2-21 “aocl diagnose” Messages


DE10-Pro OpenCL 21 www.terasic.com
August 6, 2019
Note: It is strongly recommended that users set the PCIe speed at Gen 3 in the BIOS on the host
PC, so that the DE10-Pro negotiates with the host PC at Gen3 as the link speed. If your PC supports
PCIe Gen3x8, but it gets incorrect detected information, you can modify the PCIe settings in the
BIOS, and reboot.

◼ Test ‘aocl program’ Command

The program utility programs the board with the specified aocx file. Check whether the
hello_world OpenCL image configures the FPGA successfully. In Command Prompt (Run as
administrator) window, type “cd D:\intelFPGA_pro\19.1\hld\board\de10_pro\bringup\<board
name>”, then type “aocl program acl0 hello_world.aocx” to configure the FPGA with
hello_world.aocx OpenCL image. If the programming message displays “Program succeed” as
shown in Figure 2-22, it means the hello_world OpenCL image is programmed into the FPGA
successfully.

Figure 2-22 Aocl Program Successfully

DE10-Pro OpenCL 22 www.terasic.com


August 6, 2019
2.6 Compile and Test OpenCL Project

This section will show how to compile and run the OpenCL kernel and OpenCL Host Program for
the Vector add example project. Developers can use the same procedures to compile and test other
OpenCL examples (included in the kit) for DE10-Pro.
You can get more example OpenCL applications from the OpenCL Design Examples page or
%INTELFPGAOCLSDKROOT%\examples_aoc

◼ Compile OpenCL Kernel

The utility aoc (Altera SDK for OpenCL Kernel Compiler) is used to compile the OpenCL
kernel. In Command Prompt (Run as administrator) window, type “cd D:\intelFPGA_pro\
19.1\hld\board\de10_pro\tests\vector_add” to go to vector_add project folder.
then type “aoc device\vector_add.cl -o bin\vector_add.aocx -board=<board name> -v” to
compile the OpenCL kernel, this process may take several hours. When the compilation process is
finished, OpenCL image file vector_add.aocx is generated. Figure 2-23 is the screenshot when
OpenCL kernel is compiling with s10_gh2e2_4Gx2 board.
For required parameters to compile vector_add.cl, please refer to the README.html in the
vector_add folder. For detailed usage of aoc, please refer to the Intel FPGA SDK for OpenCL
Programming Guide:
https://www.altera.com/en_US/pdfs/literature/hb/opencl-sdk/aocl_programming_guide.pdf

Figure 2-23 OpenCL Kernel Compile

DE10-Pro OpenCL 23 www.terasic.com


August 6, 2019
◼ Compile Host Program

Visual Studio C/C++ 2015 is used to compile the Host Program. Launch Visual Studio (Run as
administrator),and select menu item “FILE→Open Project/Solution…”. In the Open Project
dialog, go to the folder “D:\intelFPGA_pro\19.1\hld\board\de10_pro\tests\vector_add”, and select
vector_add.sln as shown Figure 2-24.

Figure 2-24 Open Host Program


After vector_add Host Program project is opened successfully, in Visual Studio IDE select menu
item “BUILD→Build Solution” to build host program. When build process is successful, you will
see successful message as show in Figure 2-25. The execute file is generate in:
“D:\intelFPGA_pro\19.1\hld\board\de10_pro\tests\vector_add\bin\host.exe”

Figure 2-25 Host Program Build Successfully

◼ Test vector_add project

Firstly, In Command Prompt window, type “cd D:\intelFPGA_pro\19.1\hld\board\de10_pro\t


ests\vector_add\bin” to go to vector_add\bin project folder.
Then, execute “host.exe”. Figure 2-26 is the screen shot when the test is successful.

DE10-Pro OpenCL 24 www.terasic.com


August 6, 2019
Figure 2-26 Host App Running successfully

DE10-Pro OpenCL 25 www.terasic.com


August 6, 2019
Chapter 3
OpenCL for Linux

This chapter describe how to setup DE10-Pro OpenCL development environment on 64-bit Linux
(CentOS 7.2/Ubuntu 16.04 are recommended), how to compile and test the OpenCL examples for
DE10-Pro. For more details about Altera OpenCL, please refer to Intel FPGA SDK for OpenCL
Getting Started document:

https://www.altera.com/en_US/pdfs/literature/hb/opencl-sdk/aocl_getting_started.pdf

Note: Follow below steps to install the software on root path, and it will invoke the kernel header,
If you are reinstalling Linux system, it is recommended to set the root size to at least 100GB and
choose to install the Development Tools.

3.1 Software Installation

This section describes how to download and install the required software for OpenCL.Please make
sure that the root size of filesystem is at least 100GB

◼ Intel Quartus II and OpenCL

Intel Quartus Prime Pro Edition 19.1.0.240 and Intel FPGA SDK for OpenCL Pro Edition
19.1.0.240 can be download from the web site:

http://dl.altera.com/opencl/19.1/?edition=pro

For Quartus II installation, please make sure that the Stratix10 device is included.

Open the link and select the Linux SDK as Figure 3-1 shows.

DE10-Pro OpenCL 26 www.terasic.com


August 6, 2019
Figure 3-1 Linux SDK table

Quartus II software uses the built-in USB-Blaster II drivers on Linux to access USB-Blaster II
download cable on DE10-Pro but after installing the Quartus II software with built-in drivers, user
need to change the port permission for USB-Blaster II via issuing

‘gedit /etc/udev/rules.d/51-usbblaster.rules’

to create and add the following lines to the /etc/udev/rules.d/51-usbblaster.rules file.

# USB-Blaster

ENV{ID_BUS}=="usb" ENV{ID_VENDOR_ID}=="09fb", ENV{ID_MODEL_ID}=="6001", MODE="0666"

ENV{ID_BUS}=="usb" ENV{ID_VENDOR_ID}=="09fb", ENV{ID_MODEL_ID}=="6002", MODE="0666"

ENV{ID_BUS}=="usb" ENV{ID_VENDOR_ID}=="09fb", ENV{ID_MODEL_ID}=="6003", MODE="0666"

# USB-Blaster II

ENV{ID_BUS}=="usb" ENV{ID_VENDOR_ID}=="09fb", ENV{ID_MODEL_ID}=="6010", MODE="0666"

ENV{ID_BUS}=="usb" ENV{ID_VENDOR_ID}=="09fb", ENV{ID_MODEL_ID}=="6810", MODE="0666"

Note: You must have system administration (root) privileges to configure the USB-Blaster
download cable drivers.

◼ Quartus Prime 19.1 Patch

When using the Intel® Quartus® Prime Pro Edition software version 19.1 with the Intel® FPGA
Download Cable II (formerly referred to as USB Blaster II download cable) or an on-board
implementation of the Intel® FPGA Download Cable II IP solution (formerly referred to as
on-board USB Blaster II solution), a USB device enumeration error may occur when plugging in

DE10-Pro OpenCL 27 www.terasic.com


August 6, 2019
the Intel® FPGA Download Cable II to the computer hosting the Intel® Quartus® Prime Pro
Edition software.
To workaround this problem, use the Intel® Quartus® Prime Pro Edition software version 19.1 and
download and install patch 0.03 from the links below.
For linux, You must install the patch after installing Intel® Quartus® Prime Pro Edition software
version 19.1 software:
Quartus® Prime Pro 19.1 Patch 0.03 For Linux(.run)

◼ GNU development tools

GNU development tools such as gcc (include g++) and make are required to build the driver and
application under Linux. User can issue ‘yum -y install gcc gcc-c++’ command to download and
install them and their dependencies via internet.

Note: To install the SDK on Linux, you must install it in a directory that you own (that is, a
directory that is not a system directory). You must also have sudo or root privileges.

◼ DE10-Pro OpenCL BSP (Board Support Package)

After Quartus II and OpenCL SDK are installed, please download the
DE10_Pro_OpenCL_BSP_19.1.tar.gz DE10-Pro linux BSP from the web site:
http://de10-pro.terasic.com/cd

Then, decompress DE10_Pro_OpenCL_BSP_19.1.tar.gz to the “de10_pro” folder under the folder


"/root/intelFPGA_pro/19.1/hld/board", where assumed Quartus II is installed on the folder “/root/
intelFPGA_pro/19.1”, as shown in Figure 3-2.

Figure 3-2 DE10-Pro OpenCL BSP Content

DE10-Pro OpenCL 28 www.terasic.com


August 6, 2019
For more details about DE10-Pro OpenCL BSP, please refer to the Table 2.
Table 2 Linux BSP File
File or Folder Description
board_env.xml eXtensible Markup Language (XML) file that describes the
Reference Platform to the Intel FPGA SDK for OpenCL.
Hardware Contains the Intel Quartus Prime project templates for the
DE10-Pro board variant.
Linux64 Contains the MMD library, kernel mode driver, and executable
files of the SDK utilities (that is, install, uninstall, flash, program,
diagnose) for your 64-bit operating system
Tests Contains some OpenCL Design Examples. The following
examples demonstrate how to describe various applications in
OpenCL along with their respective host applications, which you
can compile and execute on a host with an FPGA board that
supports the Intel FPGA SDK for OpenCL.
Scripts When the FPGA is being programmed via the Intel FPGA
Download Cable, the MMD invokes quartus_stp to execute the
find_jtag_cable.tcl script. The script identifies the cable and
index number which is then used to program the FPGA through
the quartus_pgm command
Bringup The demo batch files of initializing the DE10-Pro Development
Kit for OpenCL Use

DE10-Pro OpenCL 29 www.terasic.com


August 6, 2019
3.2 Environment Configure

If you install the Intel FPGA development software and OpenCL SDK on a system that does not
contain any .cshrc or Bash Resource file (.bashrc) in your directory, you must set the
INTELFPGAOCLSDKROOT and PATH environment variables manually. And the developers
need to create an environment variable for the DE10-Pro board
AOCL_BOARD_PACKAGE_ROOT so that the Intel FPGA OpenCL SDK is able to find the kit
location of DE10-Pro correctly, and set its value as:

"$ INTELFPGAOCLSDKROOT "/board/de10_pro”

Alternatively, you can edit the “/etc/profile” profile file,and append the environment variables to it.
To do this type “gedit /etc/profile” command on Linux Terminal to open the profile file by the
gedit editor tool,and append the following setting to the profile file. Then, save the file and type
“source /etc/profile” command in Linux Terminal to make the settings make effect.

export QUARTUS_ROOTDIR=/root/intelFPGA_pro/19.1/quartus
export INTELFPGAOCLSDKROOT=/root/intelFPGA_pro/19.1/hld
export AOCL_BOARD_PACKAGE_ROOT=$INTELFPGAOCLSDKROOT/board/de10_pro
export PATH=$PATH:$QUARTUS_ROOTDIR/bin:$INTELFPGAOCLSDKROOT/linux64/bin:$INTELFPGAOC
LSDKROOT/bin:$INTELFPGAOCLSDKROOT/host/linux64/bin:/root/intelFPGA_pro/19.1/qsys/bin
export LD_LIBRARY_PATH=$AOCL_BOARD_PACKAGE_ROOT/linux64/lib:$INTELFPGAOCLSDKROOT
/host/linux64/lib:$AOCL_BOARD_PACKAGE_ROOT/tests/extlibs/lib
export QUARTUS_64BIT=1
export LM_LICENSE_FILE=/root/intelFPGA_pro/19.1/license.dat

DE10-Pro OpenCL 30 www.terasic.com


August 6, 2019
3.3 OpenCL Environment Verify

This section will show how to make sure the OpenCL environment is setup correctly. Firstly, please
open the Linux system terminal window by right click the Mouse on system desktop, then clicking
on Open Terminal.

◼ Target SDK Version

In the Linux terminal, type “aocl version” command, and make sure the version of the OpenCL
SDK is listed as shown in Figure 3-3.

Figure 3-3 Version of OpenCL SDK

◼ Target Board

In the Linux terminal, type “aoc -list-boards” command, and make sure “de10_pro” is listed in
Board list as shown in Figure 3-4.

Figure 3-4 ‘de10_pro’ is Listed in Board List


If the “de10_pro” is not listed in the Board list and you has verified the OpenCL environment
setting is correctly, maybe you can try “ sudo rm /opt/Intel -rf ” to workaround this problem.
For more information about the aoc and aocl, refer to the ‘aoc -h’ and ‘aocl help’ command.

DE10-Pro OpenCL 31 www.terasic.com


August 6, 2019
3.4 Initializing the FPGA for use with OpenCL

◼ Board Setup

To use the DE10-Pro FPGA Development Kit with the Intel FPGA SDK for OpenCL, you must
follow the below procedures to set up DE10-Pro board on your PC as shown in Figure 3-5.

3. Make sure your PC is powered off.


4. Insert DE10-Pro board into PCI Express x8 or x16 slot.
5. Connect PC’s 12V PCI Express 8-pin power source to the DE10-Pro (recommended).
6. Connect PC’s USB port to DE10-Pro UB II port (J8) using an USB cable.

Figure 3-5 Setup DE10-Pro board on PC

◼ Bring up the FPGA Board

Before using the DE10-Pro FPGA Development Kit with OpenCL, you must initialize the board
with an OpenCL image. Without this image, the board host operating system does not recognize the
PCIe card and the Intel FPGA OpenCL compiler cannot find the device. There are two ways for you
to choose:
1. Program the image into FPGA
Program the FPGA with the top.sof file by running the ./bringup_board.sh fpga in bringup/
<board name> folder as shown in Figure 3-6.

DE10-Pro OpenCL 32 www.terasic.com


August 6, 2019
Figure 3-6 Program the FPGA Borad
Use the /sbin/reboot command to perform a soft reboot of your host system causes your host system
to recognize the DE10-Pro FPGA Development Kit PCIe card.

2. Program the image into FLASH


Also,you can program the startup configuration flash of DE10-Pro board with the top.sof file by
running the ./bringup_board.sh flash in bringup/<board name> folder
Before flash programming, the programmer will ask users which startup configuration image area
will be used as shown in Figure 3-7. This is because DE10-Pro provides two startup configuration
image areas, called as Factory Image and User Image. We recommend users to key in ‘1’ to select
User Image area.

DE10-Pro OpenCL 33 www.terasic.com


August 6, 2019
Figure 3-7 Select Flash Page
After users select desired flash area, it will take about 8 minutes for flash programming. Figure 3-8
is the screen shot when flash programming is done successfully.

Figure 3-8 Program Flash Successfully


DE10-Pro OpenCL 34 www.terasic.com
August 6, 2019
To make sure a correct image is used when FPGA boots up, please make sure the dip switch SW4.1
on DE10-Pro is changed to the correct location. If a User Image area is selected, the dip switch
SW4.1 on the DE10-Pro should be moved to Up position as shown in Figure 3-9.

Figure 3-9 Set SW4.1 to Up Position (User Image Page)


After flash programming is done successfully and SW4.1 is set to correct position, developers
must power off DE10-Pro board, then turn it back on, and restart the PC.

Note, the USB cable can be removed later if OpenCL code had been programmed to the startup
configuration flash of DE10-Pro by ‘./bringup_board.sh flash’ command.

◼ Driver Installation

Your system must recognize the card so that the Intel FPGA SDK for OpenCL driver can be loaded.
The install utility is used install the kernel driver on the host computer. Users of the Intel FPGA
SDK for OpenCL only need to install the driver once, after that the driver should be automatically
loaded each time the machine reboots.
First, in the Linux terminal, type ‘lspci |grep Altera’ to make sure the system recognizes the PCIe
card as shown in Figure 3-10.

Figure 3-10 PCIE Message

DE10-Pro OpenCL 35 www.terasic.com


August 6, 2019
Type ‘aocl install’ to install the driver as shown in Figure 3-11. Note that users need to have root
privileges to install the driver.

Figure 3-11 Driver Installation


Note: if user don’t use the recommended Linux system or different version, recompiling the driver
is needed. You can compile it by typing “cd /root/intelFPGA_pro/19.1/hld/board/de10_pro/
linux64/driver” (there are source code, Makefile and README.txt) to locate at the driver source
code directory and type “sh make_all.sh” to compile and generate the new driver. Before that, user
need to install the kernel related development package matched the current kernel (kernel-devel
package) via issuing ‘yum install kernel-devel’ command.

DE10-Pro OpenCL 36 www.terasic.com


August 6, 2019
3.5 OpenCL Runtime Verify

◼ Test ‘aocl diagnose’ Command

The diagnose utility reports device information and identifies issues. The diagnose utility first
verifies the installation of the kernel driver and returns the overall information of all the devices
installed in a host machine.
In the Linux terminal, type “aocl diagnose” to check if the initialization completed successfully. If
successful, the programming message displays “DIAGNOSTIC_PASSED” as shown in Figure
3-12.

Figure 3-12 “aocl diagnose” Messages


DE10-Pro OpenCL 37 www.terasic.com
August 6, 2019
Note: It is strongly recommended that users set the PCIe speed at Gen 3 in the BIOS on the host
PC, so that DE10-Pro negotiates with the host PC at Gen3 as the link speed. If your PC support
PCIe Gen3x8, but it gets incorrect detected information, you can modify the PCIe settings in the
BIOS, and reboot.
If aocl diagnose fail on Ubuntu 16.04 (kernel 4.14 or newer), maybe you can refer to:
Why does aocl diagnose fail on Ubuntu 16.04 (kernel 4.14 or newer)?

◼ Test ‘aocl program’ Command

The program utility programs the board with the specified aocx file. Check whether the
hello_world OpenCL image configures the FPGA successfully. In the Linux terminal, type “cd
/root/intelFPGA_pro/19.1/hld/board/de10_pro/bringup/<board name>”, then type “aocl program
acl0 hello_world.aocx” to configure the FPGA with hello_world.aocx OpenCL image. If the
programming message displays “Program succeed” as shown in Figure 3-13, it means the
hello_world OpenCL image is programmed into the FPGA correctly.

Figure 3-13 Aocl Program Successfully

DE10-Pro OpenCL 38 www.terasic.com


August 6, 2019
3.6 Compile and Test OpenCL Project

This section will show how to compile and run the OpenCL kernel and OpenCL Host Program for
the Vector add example project. Developers can use the same procedures to compile and test other
OpenCL examples (included in the kit) for DE10-Pro.
You can get more example OpenCL applications from the OpenCL Design Examples page or
/root/intelFPGA_pro/19.1/hld/examples_aoc

◼ Compile OpenCL Kernel

In the terminal, type “cd /root/intelFPGA_pro/19.1/hld/board/de10_pro/tests/vector_add” to go to


vector_add project folder, then type “aoc device/vector_add.cl -o bin/vector_add.aocx -board=
<board name> -v” to compile the OpenCL kernel. It will take about one hour for compiling. After
that, the OpenCL image file vector_add.aocx is generated. Figure 3-14 is the screen shot when
OpenCL kernel is compiled successfully with s10_gh2e2_4Gx2 board. For required parameters to
compile vector_add.cl, please refer to the README.html that is in the same directory.

The utility aoc (Altera SDK for OpenCL Kernel Compiler) is used to compile OpenCL kernel. For
detailed usage of aoc, please refer to the Intel FPGA SDK for OpenCL Programming Guide:

http://www.altera.com/literature/hb/opencl-sdk/aocl_programming_guide.pdf

Figure 3-14 OpenCL Kernel is Compiling


DE10-Pro OpenCL 39 www.terasic.com
August 6, 2019
◼ Compile Host Program

In the terminal, type “cd /root/intelFPGA_pro/19.1/hld/board/de10_pro/tests/vector_add” and then


type “make” to compile the host program.
When build is successfully, you will see successful message as show in Figure 3-15. The execute
file is generate in the same directory which named bin.

Figure 3-15 Host Program Build Successful

◼ Test vector_add project

Firstly, In the terminal, type “cd /root/intelFPGA_pro/19.1/hld/board/de10_pro/tests/vector_ad


d/bin” to go to the vector_add project folder.
Then, launch the compiled Host Program to start vector_add execute file for test. In the terminal
type “./host”. Figure 3-16 shows the execution is successful.

Figure 3-16 Host App Running successfully

DE10-Pro OpenCL 40 www.terasic.com


August 6, 2019
Chapter 4
Appendix
4.1 Disable Driver Signature Enforcement in Windows10 x64
Because the win10 system requires the signature of the .inf file, sometimes, the driver of the PCIE
(without signature) fails to be installed after running aocl install.
As a solution, disable Windows 10 signed driver enforcement as shown below:
1. Click Home,enter “All settings”.

2. Access “Update & Security”.

DE10-Pro OpenCL 41 www.terasic.com


August 6, 2019
3. Find Recovery. Click “Restart now” below “Advanced start-up”,restart the PC.

4. After restarting, choose “Troubleshoot”.

DE10-Pro OpenCL 42 www.terasic.com


August 6, 2019
5. Choose “Advanced options”.

6. Choose "Start-up Settings".

DE10-Pro OpenCL 43 www.terasic.com


August 6, 2019
7. Click “Restart”.

8. Enter "F7" to disable driver signature.

DE10-Pro OpenCL 44 www.terasic.com


August 6, 2019
4.2 Check the settings of OpenCL in the registry editor
1. Use “Win+R” to open the “Run” window, and type “regedit” to open “Registry Editor”
window

2. Check the keys of path HKEY_LOCAL_MACHINE\SOFTWARE\Intel\OpenCL\Boards


and HKEY_LOCAL_MACHINE\SOFTWARE\Intel\OpenCL\Boards\installed_packages,
make sure are NULL or as show below:

DE10-Pro OpenCL 45 www.terasic.com


August 6, 2019
DE10-Pro OpenCL 46 www.terasic.com
August 6, 2019
Revision History
Version Change Log
V1.0 Initial Version

Copyright Statement

Copyright © 2019 Terasic Inc. All Rights Reserved.

DE10-Pro OpenCL 47 www.terasic.com


August 6, 2019

You might also like