partition - 2021.2 English

Vitis Unified Software Platform Documentation: Application Acceleration Development (UG1393)

Document ID
UG1393
ft:locale
English (United States)
Release Date
2021-12-15
Version
2021.2 English

The xbmgmt partition command lets you display and program shell partitions to the Alveo card.

The partition command is intended to be used with DFX-2RP platforms. Prior to running an application, including the validation application, it is necessary to first program the shell partition to the card using the following command:
sudo /opt/xilinx/xrt/bin/xbmgmt partition --program --name <shell_name> --
card <card_bdf>

After the shell partition is programmed, you do not need to reprogram the accelerator card unless the system is warm or cold rebooted, or to load a different shell.

Tip: The platform base remains loaded even when the power is cycled on the accelerator card.

The xbmgmt partition --scan command reports if a platform shell has been loaded.

Table 1. xbmgmt partition Sub-commands
Sub-command Description
--scan Scan and displays base and shell partitions running on the FPGA and installed in the system.
--program This command is used to program the shell partition by providing the name of the shell partition. The command also supports the option to program the shell from a given interface-uuid.

Scan

The --scan sub-command returns details of the flashable partition installed on each card along with the flashable partitions installed on the host system. In addition, it also returns additional information including SC version, BDF, Serial number, and MAC addresses.

It has the following command line format.

xbmgmt partition -–scan

The following is an example of the command output:

Card [0000:d8:00.0]
    Partitions running on FPGA:
        xilinx_u200_gen3x16_base_1
            logic-uuid:
            8892e9a0478feaa2699f5df1f696470d
            interface-uuid:
            1641962866f4b5e579cec90a6bdabcbf
    Partitions installed in system:
        xilinx_u200_gen3x16_xdma_shell_1_1
            logic-uuid:
            a21db155d2fbd60ccc95eea0ea8144e1
            interface-uuid:
            9437e0f859a4d9bd9e226d7edf5e6be8

If the partition is programmed, the output will look like the following example output below.

alveo@alveo:~$ sudo /opt/xilinx/xrt/bin/xbmgmt partition --scan
Card [0000:65:00.0]
    Partitions running on FPGA:
        xilinx_u200_gen3x16_base_1
            logic-uuid:
            3d40702f37777396cc82e0df89bafde2
            interface-uuid:
            19f21ba41b9c38dffefc1ee68910b8bb
        xilinx_u200_gen3x16_xdma_shell_1_1
            logic-uuid:
            fd19b2fde5a10b8cb89e35b0be02f274
            interface-uuid:
            995b41d8c729d658d6700a027f412f78
    Partitions installed in system:
        xilinx_u200_gen3x16_xdma_shell_1_1
            logic-uuid:
            fd19b2fde5a10b8cb89e35b0be02f274
            interface-uuid:
            995b41d8c729d658d6700a027f412f78

Program

The --program sub-command lets you program the specified shell partition.

It has the following command line format.

xbmgmt partition --program --name name [--id interface-uuid] [--card bdf]
Table 2. xbmgmt --program Sub-Command Options
Option Description Required
--name <name> Specify the name of the shell partition to program.

Use the xbmgmt partition --scan to display the names of the programmable partitions.

Y
--id The --id sub-option specifies the partition interface-uuid.

Use the xbmgmt partition --scan to obtain the ID of the flashable partition.

N
--card <bdf> Specifies the accelerator card to be programmed as identified by its Bus:Device:Function (BDF) tag.

Use the xbmgmt partition --scan to obtain the card BDF.

If the BDF is not found, you will receive the following message where <bdf> is the BDF value entered:
ERROR: No mgmt PF found for <bdf>
N