Intel® Agilex™ Device Configuration via Protocol (CvP) Implementation User Guide

Download PDF
ID 683763
Date 10/04/2021
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. Overview 2. CvP Description 3. CvP Topologies 4. Design Considerations 5. CvP Driver and Registers 6. Understanding the Design Steps for CvP Initialization using the Supported PCIe Tile in Intel® Agilex™ Devices 7. Intel® Agilex™ Device Configuration via Protocol (CvP) Implementation User Guide Archives 8. Document Revision History for the Intel® Agilex™ Device Configuration via Protocol (CvP) Implementation User Guide
1. Overview x
1.1. Benefits of Using CvP 1.2. CvP System 1.3. CvP Modes
1.3. CvP Modes x
1.3.1. CvP Limitations
1.3.1. CvP Limitations x
1.3.1.1. CvP Error Recovery
2. CvP Description x
2.1. Configuration Images 2.2. CvP Modes Compression Features 2.4. Pin Description
2.2. CvP Modes x
2.2.1. CvP Initialization Mode 2.2.2. CvP Update Mode
3. CvP Topologies x
3.1. Single Endpoint 3.2. Multiple Endpoints
4. Design Considerations x
4.1. Designing CvP for an Open System 4.2. Designing CvP for a Closed System
4.1. Designing CvP for an Open System x
4.1.1. FPGA Power Supplies Ramp Time Requirement 4.1.2. PCIe Wake-Up Time Requirement
4.1.2. PCIe Wake-Up Time Requirement x
4.1.2.1. For CvP Initialization Mode 4.1.2.2. For CvP Update Mode
5. CvP Driver and Registers x
5.1. CvP Driver Support 5.2. CvP Driver Flow 5.3. VSEC Registers for CvP
5.3. VSEC Registers for CvP x
5.3.1. Vendor Specific Capability Header Register 5.3.2. Vendor Specific Header Register 5.3.3. Intel® Marker Register 5.3.4. User Configurable Device/Board ID Register 5.3.5. CvP Status Register 5.3.6. CvP Mode Control Register 5.3.7. CvP Data Registers 5.3.8. CvP Programming Control Register 5.3.9. CvP Credit Register
6. Understanding the Design Steps for CvP Initialization using the Supported PCIe Tile in Intel® Agilex™ Devices x
6.1. Implementation of CvP Initialization Mode 6.2. Implementation of CvP Update Mode
6.1. Implementation of CvP Initialization Mode x
6.1.1. Generating the Synthesis HDL files for Intel® FPGA P-Tile Avalon Streaming (Avalon-ST) for PCIe* Express 6.1.2. Setting up the CvP Parameters in Device and Pin Options 6.1.3. Compiling the Design 6.1.4. Converting the SOF File 6.1.5. Bringing up the Hardware
6.1.5. Bringing up the Hardware x
6.1.5.1. Installing Open Source CvP Driver in Linux Systems 6.1.5.2. Setting Up the Correct MSEL Switch State 6.1.5.3. Programming CvP Images
6.1.5.1. Installing Open Source CvP Driver in Linux Systems x
6.1.5.1.1. Downstream open source CvP Driver 6.1.5.1.2. Upstream open source CvP Driver
6.2. Implementation of CvP Update Mode x
6.2.1. Instantiating the PCIe Hard IP 6.2.2. Setting Up the CvP Parameters 6.2.3. Setting Up the Base Revision 6.2.4. Setting Up and Compile the Updated Revision 6.2.5. Converting the SOF File 6.2.6. Programming the Core RBF file from the Updated Revision via PCIe Link
6.2.3. Setting Up the Base Revision x
6.2.3.1. Creating a Reserved Core Partition 6.2.3.2. Defining a Logic Lock Region 6.2.3.3. Compiling and Exporting the Root Partition
1. Overview
2. CvP Description
3. CvP Topologies
4. Design Considerations
5. CvP Driver and Registers
6. Understanding the Design Steps for CvP Initialization using the Supported PCIe Tile in Intel® Agilex™ Devices
7. Intel® Agilex™ Device Configuration via Protocol (CvP) Implementation User Guide Archives
8. Document Revision History for the Intel® Agilex™ Device Configuration via Protocol (CvP) Implementation User Guide

6.1.5.1.2. Upstream open source CvP Driver

  1. The tools that you may need to install for building the kernel if you are using Ubuntu. 
    sudo apt-get install bison
sudo apt-get install libncurses5-dev 
sudo apt-get install libssl-dev
sudo apt-get install libncursesw5-dev
sudo apt-get install -y libelf-dev
sudo apt install git
sudo apt install flex
sudo apt-get install -y xz-utils
  2. Download the kernel source. The upstream CvP driver is available starting from v4.14 onwards, v5.9 is the version tested on Intel hardware. Example below is the command to download the kernel source v5.09.
    Example Command: 
    wget https://mirrors.edge.kernel.org/pub/linux/kernel/v5.x/linux-5.9.tar.xz
  3. Extract the kernel code files in /usr/src.
    1. Run: 
      unxz -v linux-5.9.tar.xz
    2. Run: 
      tar -xvf linux-5.9.tar
  4. Save as the kernel source folder into another name like linux-5.9-tt
    Run: 
    sudo cp -rf linux-5.9 linux-5.9-tt
  5. For v5.12 or below, you must install the following patches.
    1. Download Patch1 and Patch2 and save them into Kernel source folder
    2. In the kernel source directory(For example: /usr/src/linux-5.9-tt), install the patches by using the command below.
      • Run: 
        patch -p1 < 2-2-fpga-add-FPGA-manager-debugfs.patch
      • Run: 
        patch -p1 < 1-2-fpga-doc-documentation-for-FPGA-debugfs.patch
  6. Build and Install the kernel modules.
    1. Go into the kernel source folder. Run: cd /usr/src/linux-5.9-tt.
    2. Optional step: Copy the existing config over to new kernel. Run: cp -v /boot/config-$(uname -r) .config
    3. Enable Altera CvP FPGA Manager as kernel module with the command and steps below.
      • Run: make menuconfig
      • In the GUI, navigate to Device Drivers > FPGA Configuration Framework. Set Intel CvP FPGA Manager to “M”. Save the config setting to .config file.
      • You may check the .config file, the 3 lines items below should be enabled.
        • CONFIG_FPGA=y
        • CONFIG_FPGA_MGR_DEBUG_FS=y
        • CONFIG_FPGA_MGR_ALTERA_CVP=y
    4. Compile the kernel. Run: Make.
    5. Install the kernel modules.
      • Run: export INSTALL_MOD_PATH=/usr/src/linux-5.9-tt
      • Run: MODPATH="INSTALL_MOD_PATH=/usr/src/linux-5.9-tt"
      • Run: ARGS="$MODPATH"
      • Run: make $ARGS modules
      • Run: sudo make modules_install. Check the module version at the last line printed in the Console window. Please note that the name might be different based on Kernel build version and .config file.
      • Run "sudo make install". Ensure the linux image and initrd image are created according to the module version.
    6. Reboot the system and ensure the system reboot to the installed kernel:
      • Run : reboot
      • After the PC is reboot successfully
      • Run : uname -mrs. The system should be rebooted with the installed kernel version as shown picture below.
Level Two Title