Intel Acceleration Stack Quick Start Guide for Intel® Programmable Acceleration Card with Intel® Arria® 10 GX FPGA

Download PDF
ID 683633
Date 12/04/2020
Public
Document Table of Contents
Document Table of Contents x
1. About This Document 2. Introduction 3. Getting Started 4. Installing the OPAE Software Package 5. Identifying the Flash Image and BMC Firmware 6. Running FPGA Diagnostics 7. Running the OPAE in a Non-Virtualized Environment 8. Running the OPAE in a Virtualized Environment 9. Intel® Acceleration Stack Quick Start Guide for Intel® Programmable Acceleration Card with Intel® Arria® 10 GX FPGA Archives 10. Document Revision History for Intel® Acceleration Stack Quick Start Guide for Intel® Programmable Acceleration Card with Intel® Arria® 10 GX FPGA A. Updating the FIM and BMC Firmware B. Handling Graceful Thermal Shutdown C. FPGA Device Access Permission D. Memlock Limit E. Hugepage Settings F. Troubleshooting Frequently Asked Questions (FAQ) G. Documentation Available for the Intel® Acceleration Stack for Intel® Xeon® CPU with FPGAs 1.2.1 Release
1. About This Document x
1.1. Intended Audience 1.2. Acronym List 1.3. Acceleration Glossary
3. Getting Started x
3.1. Intel Acceleration Stack Hardware Features 3.2. System Requirements 3.3. Installing the Intel® PAC with Intel® Arria® 10 GX FPGA Card In the Host Machine 3.4. Installing the Intel Acceleration Stack
3.4. Installing the Intel Acceleration Stack x
3.4.1. Installing the Intel Acceleration Stack Runtime Package on the Host Machine 3.4.2. Installing the Intel Acceleration Stack Development Package on the Host Machine 3.4.3. Understanding the Extracted Intel® PAC with Intel® Arria® 10 GX FPGA Release Package
4. Installing the OPAE Software Package x
4.1. RHEL 7.6: Installing the OPAE Framework from Prebuilt Binaries (RPM) 4.2. Ubuntu: Installing the OPAE Framework from Prebuilt Binaries (deb) 4.3. (Optional) Building and Installing the OPAE Software from Source Code 4.4. Installing the OPAE PACSign
7. Running the OPAE in a Non-Virtualized Environment x
7.1. Loading an AFU Image into the FPGA 7.2. OPAE Sample Application Programs
7.2. OPAE Sample Application Programs x
7.2.1. Running the Hello FPGA Example
8. Running the OPAE in a Virtualized Environment x
8.1. Updating Settings Required for VFs 8.2. Configuring the VF Port on the Host 8.3. Running the Hello FPGA Example on Virtual Machine
8.3. Running the Hello FPGA Example on Virtual Machine x
8.3.1. Disconnecting the VF from the VM and Reconnecting to the PF
A. Updating the FIM and BMC Firmware x
A.1. Selecting the Correct Update Method
A.1. Selecting the Correct Update Method x
A.1.1. Updating FPGA Flash and BMC Firmware
F. Troubleshooting Frequently Asked Questions (FAQ) x
F.1. Why do I see a 'No Suitable slots found' message when running fpgaconf on my AFU image? F.2. How do I flash the FIM or program the AFU in a multicard system? F.3. Which environment variables are required? F.4. What actions do I take if I see the error message 'Error enumerating resources: no driver available'? F.5. Troubleshooting OPAE Installation on RHEL
1. About This Document
2. Introduction
3. Getting Started
4. Installing the OPAE Software Package
5. Identifying the Flash Image and BMC Firmware
6. Running FPGA Diagnostics
7. Running the OPAE in a Non-Virtualized Environment
8. Running the OPAE in a Virtualized Environment
9. Intel® Acceleration Stack Quick Start Guide for Intel® Programmable Acceleration Card with Intel® Arria® 10 GX FPGA Archives
10. Document Revision History for Intel® Acceleration Stack Quick Start Guide for Intel® Programmable Acceleration Card with Intel® Arria® 10 GX FPGA
A. Updating the FIM and BMC Firmware
B. Handling Graceful Thermal Shutdown
C. FPGA Device Access Permission
D. Memlock Limit
E. Hugepage Settings
F. Troubleshooting Frequently Asked Questions (FAQ)
G. Documentation Available for the Intel® Acceleration Stack for Intel® Xeon® CPU with FPGAs 1.2.1 Release

4.2. Ubuntu: Installing the OPAE Framework from Prebuilt Binaries (deb)

Before you can install and build the OPAE software, you must install the required packages by running the following two commands: 
sudo apt-get -f install cmake dkms libjson-c3 uuid-dev libhwloc-dev\
 python-pip libjson-c-dev libhwloc-dev linux-headers-$(uname -r) libtbb-dev
sudo pip install intelhex
Complete the following steps to install the OPAE framework:
  1. Remove any previous version of the OPAE framework. 
    sudo apt-get remove opae*
sudo apt-get remove python-opae.admin
sudo apt-get remove python3-opae.pac-sign
  2. Change to the OPAE installation software directory. 
    cd $OPAE_PLATFORM_ROOT/sw
  3. Install the latest OPAE driver and framework. 
    sudo dpkg -i *.deb
    Note: If dpkg fails due to missing dependencies, please run the following command to resolve: 
    sudo apt-get install -f
  4. Check the Linux kernel installation. 
    lsmod | grep fpga

    Sample Output:

    intel_fpga_pac_iopll    16384  0
intel_fpga_pac_hssi    24576  0
intel_fpga_fme         90112  0
intel_fpga_afu         36864  0
intel_fpga_pci         28672  2 intel_fpga_fme,intel_fpga_afu
fpga_mgr_mod           16384  1 intel_fpga_fme
ifpga_sec_mgr          16384  2 intel_max10,intel_fpga_fme
  5. After completing the OPAE installation, the binaries and libraries are available in the following directories:
    Directory OPAE Driver Package Content
    /usr/bin

    opae-tools*

    opae-tools-extra*

    		OPAE tool binaries. For a full listing of the tools and their purpose, refer to the OPAE FPGA TOOLS section on the Open Programmable Acceleration Engine web page.
    /usr/include opae-devel* The header files required for linking host applications.
    /usr/lib

    opae-libs*

    opae-ase*

    		The OPAE shared object libraries.
  6. Verify deb packages installation: 
    dpkg -l | grep opae
    Sample Output: 
    opae-a10-gx-pac-fpgaotsu-base              1.2.1              all          Intel PAC one-time-update
opae-a10-gx-pac-super-rsu-base             1.2.1              all          Intel PAC super-rsu
opae-ase                                   1.1.2              amd64        OPAE AFU Simulation Environment
opae-devel                                 1.1.2              amd64        OPAE headers, sample source, and documentation
opae-intel-fpga-driver                     2.0.3              all          DKMS-enabled Intel FPGA driver source code.
opae-libs                                  1.1.2              amd64        OPAE runtime
opae-samplesrasescriptsc                   1.1.2              amd64        Open Programmable Acceleration Engine
opae-tools                                 1.1.2              amd64        OPAE base tool binaries
opae-tools-extra                           1.1.2              amd64        OPAE extra tool binaries
python-opae.admin                          1.0.2              all          OPAE Administration
python3-opae.pac-sign                      1.0.3-1            amd64        opae.pac_sign provides Python classes for interfacing withOP
Level Two Title