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.3. (Optional) Building and Installing the OPAE Software from Source Code

  1. Complete the following steps to install Intel FPGA Driver:
    1. Remove any previous version:
      RHEL: 
      sudo yum remove opae*
      Ubuntu: 
      sudo apt-get remove opae*
sudo apt-get remove python-opae.admin
sudo apt-get remove python3-opae.pac-sign
    2. Install the Extra Packages for Enterprise Linux (EPEL):
      RHEL: 
      sudo yum install https://dl.fedoraproject.org/pub/epel/\
epel-release-latest-7.noarch.rpm
    3. Change to the OPAE installation software directory: 
      cd $OPAE_PLATFORM_ROOT/sw
    4. Install the driver:
      RHEL: 
      sudo yum install opae-intel-fpga*.rpm
      Ubuntu: 
      sudo dpkg -i opae-intel-fpga-driver_*.deb
  2. Build and install the OPAE SDK from source:
    1. Change to the OPAE software directory and extract the .tar file: 
      cd $OPAE_PLATFORM_ROOT/sw
tar xf opae*.tar.gz
    2. Complete the following steps to build the OPAE software: 
      cd opae*
mkdir build && cd build
cmake .. -DBUILD_ASE=OFF -DCMAKE_INSTALL_PREFIX=<path to install directory> -DCMAKE_BUILD_TYPE=Release

      For example:

      cmake .. -DBUILD_ASE=ON -DCMAKE_INSTALL_PREFIX=/home/john/\
opaeinstall -DCMAKE_BUILD_TYPE=Release
      Note: You may get an error because the cmake command cannot find the git repository. You can safely ignore this error message. You do not need the git repository to successfully build the OPAE software.
    3. Run the following command to build the executables and libraries: 
      make install
      Note: By default, if you choose the RPM installation flow, the binaries, libraries and include files are under /usr/. If you build and install the OPAE from the source flow, the binaries, libraries, and include files are under <path to install directory>.
    4. Set the appropriate environment variable to ensure tools, libraries, and include files are in your search path. To avoid rerunning this command whenever you restart or open a new terminal, add these directory environment variables to your shell configuration file, /etc/bashrc. 
      export PATH=<path to OPAE install directory>/bin:$PATH 
      export C_INCLUDE_PATH=<path to OPAE install directory>/include:\
$C_INCLUDE_PATH
      To check for static libraries use the following paths:
      • RHEL:
        export LIBRARY_PATH=<path to OPAE install directory>\
/lib64:$LIBRARY_PATH
      • Ubuntu:
        export LIBRARY_PATH=<path to OPAE install directory>\
/lib:$LIBRARY_PATH
      To check for shared libraries use the following paths:
      • RHEL:
        export LD_LIBRARY_PATH=<path to OPAE install directory>/\
lib64:$LD_LIBRARY_PATH
      • Ubuntu:
        export LD_LIBRARY_PATH=<path to OPAE install directory>/\
lib:$LD_LIBRARY_PATH
Level Two Title