This page provides detailed information related to Design Module 5 - VCU TRD PCIe design.
Table of Contents
The primary goal of this Design is to demonstrate the file-based VCU transcode, encode and decode capabilities over PCIe present in Zynq UltraScale+ EV devices.
This design supports the following interfaces:
Video Encode/Decode capability using VCU hard block in PL
Encoder/decoder parameter configuration.
The table below provides the supported resolution from the command line app only in this design.
√ - Supported NA – Not applicable x – Not supported
This Design uses the PCI Express (PCIe®) Endpoint block in an x4 Gen3 configuration along with DMA/Bridge Subsystem for PCI Express for data transfers between the host system memory and the Endpoint.
The DMA/Bridge Subsystem for PCI Express provides protocol conversion between PCIe TLPs(Transaction Layer Packets) and AXI transactions. The hardware SGL(Scatter-gather List) DMA interface is exercised to handle buffer management at the Endpoint to enable the memory-mapped interface.
The downstream AXI4-Lite slaves include userspace registers, responsible for the handshaking mechanism between host and the endpoint.
In the system to card direction, the DMA block moves data from the host memory to the PL-side through PCIe and then writes the data to PS-DDR via the AXI-MM interface. Then VCU IP reads data from PS-DDR, performs Video encoding/decoding and writes it back to the same memory. Lastly, in card to system direction, DMA reads PS-DDR via the AXI-MM interface and writes to host system memory through PCIe.
Figure 1: VCU PCIe Hardware Block Diagram
Components, Features, and Functions
4-lane integrated PCIe block with a maximum link speed of 8 GT/s (GT/s is Giga Transfers per second)
128-bit at 250 MHz
DMA/Bridge Subsystem for PCIe
AXI Memory-mapped enabled
One of each DMA Read (H2C) & DMA write (C2H) channels
Apart from PCIe related IPs, the design contains VCU IP.
The below figure shows the PCIe software block diagram
The TRD package is released with the source code, Vivado project, Petalinux BSP, host software required for PCIe and SD card image that enables the user to run the demonstration. It also includes the binaries necessary to configure and boot the ZCU106 board. Prior to running the steps mentioned in this wiki page, download the TRD package and extract its contents to a directory referred to as ‘TRD_HOME' which is the home directory.
The PCIe HOST application(pcie_host_app) supports Transcode, Decode and Encode use cases.
The host application will read an input(.mp4 or .ts) file from the HOST machine and sends it to the zcu106 board; which is connected as an endpoint device to the PCIe slot of HOST machine. The data received from the HOST will be decoded, then again encoded with provided encoder type and mpegtsmux using VCU hardware. Transcoded data are written back to the HOST machine in .ts file format.
We support NV12, NV16, XV15 and XV20 formats. Need to mention format as per your choice. For NV12 format and encoder type AVC we support 3 profiles Baseline, High and Main. For NV12 format and encoder type HEVC default profile selected from the application. For NV16, XV15 and XV20 no need to provide profile as an argument, profile selected form the application.
The host application will read an input(.mp4 or .ts) file from the HOST machine and sends it to the zcu106 board which is connected as an endpoint device to the PCIe slot of HOST machine. The data received from the HOST will be decoded using VCU hardware; then writes the decoded data back to the HOST machine in .yuv file format.
We support NV12, NV16, XV15 and XV20 formats. No Need to mention format, decoder will take care for given input file.
The host application will read an input(.yuv) file from the HOST machine and sends it to the zcu106 board which is connected as an endpoint device to the PCIe slot of HOST machine. The data received from the HOST will be encoded with provided encoder type; then mpegtsmux using VCU hardware and writes the encoded data back to the HOST machine in .ts file format.
We support NV12, NV16, XV15 and XV20 formats. Need to mention format as per your choice. For NV12 format and encoder type AVC we support 3 profiles Baseline, High and Main. For NV12 format and encoder type HEVC default profile selected from the application. For NV16, XV15 and XV20 no need to provide profile as an argument, profile selected form the application. The main aim of this design was to show case the VCU capability, that’s the reason we don’t have mux options.
The files in pcie_host_package directory provides Xilinx PCIe DMA drivers, for example, software to be used to exercise file transfer over the Xilinx PCIe DMA IP and run the transcode, encode or decode use case using Xilinx VCU IP on zcu106 board.
Directory and file description:
Contains the Xilinx PCIe DMA kernel module driver files
Contains support files for the kernel driver module, which interfaces directly with the XDMA IP
Contains all include files required for compiling drivers
Contains rules for the Xilinx PCIe DMA kernel module and software. The files in this directory should be copied to the /etc/ directory on your Linux system.
Contains example application software and PCIe host application to exercise the provided kernel module driver and Xilinx PCIe DMA IP
Contains example application software to exercise the provided kernel module driver and Xilinx PCIe DMA IP
Steps to run use cases
The user needs to copy all the files from the $TRD_HOME/images/vcu_pcie/ to FAT32 formatted SD card directory
Insert the ZCU106 board into the PCIe slot of the HOST machine and power on the board; then power on the HOST machine
Make sure, the ZCU106 board is powered on before booting the HOST machine to enumerate ZCU106 board as PCIe endpoint device successfully
Execute "lspci" command on HOST machine's terminal and make sure that "Processing accelerators: Xilinx Corporation Device a883" and "Processing accelerators: Xilinx Corporation Device a884" entries are listed; otherwise XDMA driver will not be able to recognized PCIe endpoint device. It throws an error like "Error: The Kernel module installed correctly, but no devices were recognized"
Copy the hosting package on to UBUNTU-18.04 machine
Run the below commands to Install the XDMA driver and compile the Host application(pcie_host_app)
Root permissions will be required to install xdma driver. xdma driver transfer data up to 512K chunk size.
$ cd $TRD_HOME/pcie_host_package
$ cd xdma
$ make install
$ insmod xdma.ko
$ cd ../tools
The Host software consists of the XDMA module with the following user access devices.
To access XDMA registers
To access userspace registers from HOST
To access AXI-Lite Master interface
To access DMA-Bypass interface
To access each channel
Finally, run the pcie_host_app on HOST machine then run pcie_transcode device application on ZCU106 board target to initiate the transfer.
Run the below command to initiate a file transfer from the HOST machine and transcode, encode or decode it from the ZCU106 device. After running the application on HOST user need to start device application(pcie_transcode) on the zcu106 target to initiate the transfer.
The user was given with the below options for transcoding, encoding or decoding the file :
usage: ./pcie_host_app [OPTIONS]
-i represents input file name.
-o represents output file name.
-c represents encoder's l2 cache. It's a boolean parameter. Range of this value is [0-1].
-w represents encoder's low bandwidth. It's a boolean parameter. Range of this value is [0-1].
-f represents encoder's filler data. It's a boolean parameter. Range of this value is [0-1].
-r represents encoder's bitrate. Range of this value is [1-60000]. Unit is in Kbps.
-g represents encoder's GOP length. Range of this value is [1-1000].
-b represents encoder's b-frames. Range of this value is [0-4].
-s represents encoder's slice value. Range of this value is [4-22].
-q represents encoder's QP mode. Range of this value is [0 or 2]. O stands for uniform and 2 stands for auto.
-m represents encoder's rate control mode. Range of this value is [1-2]. 1 stands for VBR and 2 stands for CBR.
-e represents encoder's encoder type. Range of this value is [0-1]. O stands for AVC and 1 stands for HEVC.
-p represents encoder's GOP mode. Range if this value is [0, 3 or 4]: O stands for basic, 3 stands for low-delay-p and 4 stands for low-delay-b.
-u represents use case type. Range of this value is [0, 1 or 2]: O stands for encode, 1 stands for decode and 2 stands for transcode.
-d represents input resolution. Range of this value is [1920x1080 or 3840x2160]: 1920x1080 represents width x height of input video frame.
-F represents input FPS. Range of this value is [30 or 60]: this parameter is used for encode use case.
-n input profile Range of this value is [0(NV12), 1(NV16), 2(XV15), 3(XV20)]: this parameters used for encode/transcode use case.
-t input profile. Range of this value is [0, 1, or 2]: O is for Base line, 1 is for high and 2 is for main profile.
Default:1 for AVC and 2 for HEVC.
-h represents help.
-v (verbose) print usage help and exit
After booting the ZCU106 board with the SD images, to run the transcode, encode or decode the use case first run the host side application mentioned above and run the device application on the zcu106 device with the mentioned commands below. The host application will send file data to the device for transcoding , encoding or decoding it on the ZCU106 device and receives the transcoded, encoded or decoded data and saves it on to the host machine.