AR# 71757

|

Alveo Data Center Accelerator Card - Reverting Card to Factory image

Description

Xilinx Alveo cards might need to be reverted to their factory (or golden) image. This is recommended when:

  • Preparing to flash a different shell onto the card
  • Preparing to upgrade or change the version of XRT installed on the host
  • The card no longer appears on lspci after programming a custom image onto the card

Please note, the Satellite Controller (SC) firmware will not be affected; its version will not change, but it might be reported as 'INACTIVE' via the following command when the card is running the golden image.

xbmgmt flash --scan

The Alveo card can be reverted to the factory image using two methods:

  • Method 1: Vitis/XRT flow
  • Method 2: Vivado flow

Use the following steps to determine the appropriate method.

  1. Install 2019.2 XRT or greater on the system with the Alveo card installed.
  2. Run the following command. Please note the new syntax when using XRT 2021.1 and later.
    XRT version 2020.2 or earlier
    $ sudo xbmgmt flash --scan --verbose
    XRT version 2021.1 or later
    $ sudo xbmgmt examine --device <card_bdf>
  3. If XRT is able to detect the card then Method 1 can be used to revert the card to golden.
  4. If the following message is displayed, XRT was unable to detect a card, and Method 2 must be used.

No card is found!

Solution

Method 1: Revert Card via Vitis/XRT

For the Vitis/XRT flow, use the following steps to revert the card to golden.

It requires XRT 2019.2 or later installed on the host system containing the Alveo accelerator card.

Please note the new syntax when using XRT 2021.1 and later.

  1. Open a terminal window.
  2. Run the following command, where card_bdf is the BDF of the card to revert to golden.
XRT version 2020.2 or earlier
$ sudo xbmgmt flash --factory_reset --device <card_bdf>
XRT version 2021.1 or later
$ sudo xbmgmt program --revert-to-golden --device <card_bdf>

3. Enter 'y' to continue. The following message is displayed on completion.

XRT version 2020.2 or earlier
Shell is reset successfully
Cold reboot machine to load new shell on card
XRT version 2021.1 or later

INFO : Shell on [ 0000:65:00.0 ] is reset successfully.
****************************************************
Cold reboot machine to load the new image on device(s).
****************************************************

4. Cold boot the system so that the card FPGA uses the new image.
5. Confirm that the card has been reverted to the factory image by running the following command.

XRT version 2020.2 or earlier
$ sudo xbmgmt flash --scan
XRT version 2021.1 or later
$ sudo xbmgmt examine --device <card_bdf>

An output similar to the following is displayed:

XRT version 2020.2 or earlier
Card [0000:65:00.0]
Card type: uxx
Flash type: SPI
Flashable partition running on FPGA:
xilinx_uxx_GOLDEN_x,[SC=INACTIVE]
Flashable partitions installed in system: (None)
XRT version 2021.1 or later
----------------------------------------
1/1 [0000:65:00.0] : xilinx_uxx_GOLDEN
----------------------------------------
Flash properties
Type : spi
Serial Number : N/A

Device properties
Type : uxx
Name : N/A
Config Mode : 0
Max Power : N/A

Flashable partitions running on FPGA
Platform : xilinx_uxx_GOLDEN_x
SC Version : INACTIVE
Platform ID : N/A

Flashable partitions installed in system
<none found>

In this output, under Flashable partitions running on FPGA, note GOLDEN in the name. This indicates that the card has successfully been reverted to the factory image.

 

IMPORTANT! If GOLDEN_2 is displayed under Flashable partition running on FPGA, carefully review the design advisory for Alveo data center Accelerator card golden corruption, found in (Xilinx Answer 71915).

Complete the repair instructions associated with the Xilinx Answer prior to proceeding.

 

Method 2: Revert Card via Vivado Hardware Manager

This is for the more advanced user comfortable with manually programming FPGAs.

It requires the following programming cable, depending on the card to be programmed. These can be obtained through the Alveo Accessories.

U200/U250/U280U50



Required Tool: Xilinx Vivado Hardware Manager (Version 2019.2 or later) installed on an x86 debug system with USB connectivity to the Alveo Data Center Accelerator Card.

Ideally the x86 debug system is a separate machine to the one the Alveo card is installed in, such as a laptop.


Additional guidance is available in (UG908) - Vivado Programming and Debugging.

 

The steps for connecting the U50 and U200/250/280 cards are below.

U200/250/280
  1. Download the MCS file attached to this Answer Record to the host running Vivado Hardware Manager
  2. Connect the USB cable between the U200/U250/U280 card and x86 debug machine.

  3. Open Vivado Hardware Manager

  4. Select Tools → Auto connect. The card will automatically be displayed. The xcu200 is shown as an example below.


U50
  1. Download the MCS file attached to this Answer Record to the host running Vivado Hardware Manager

  2. Follow the directions in UG1377 V1.1, pages 1-13, to connect the Alveo Programming Cable between the U50 and x86 debug machine.

  3. Open Vivado Hardware Manager

  4. Select Tools → Auto connect. The card will automatically be displayed. The XCU50 is shown as an example below.


The following steps are then performed, and are the same for all cards mentioned above.

  1. Select "Add a Configuration Memory Device" on the Card Hardware Target
  2. Select the mt25qu01g-spi-x1_x2_x4 part
  3. Select "Program the Configuration Memory Device" on the target.
    1. Select the revert_to_golden.mcs file provided in this Answer for the "Configuration File"
    2. Select the Address Range of "Configuration File Only"
    3. Select OK
  4. After this operation has completed, disconnect the card in Hardware Manager, and disconnect the programming cable from the Alveo Data Center Acceleration Card.
  5. Perform a cold reboot on the host machine.
  6. On the host machine, confirm that the card has been reverted to the factory image by running the following command:

    XRT version 2020.2 or earlier
    $ sudo xbmgmt flash --scan
    XRT version 2021.1 or later
    $ sudo xbmgmt examine --device <card_bdf>

    An output similar to the following is displayed.

    XRT version 2020.2 or earlier

    Card [0000:65:00.0]
    Card type: uxx
    Flash type: SPI
    Flashable partition running on FPGA:
    xilinx_uxx_GOLDEN_x,[SC=INACTIVE]
    Flashable partitions installed in system: (None)
    XRT version 2021.1 or later
    ----------------------------------------
    1/1 [0000:65:00.0] : xilinx_uxx_GOLDEN
    ----------------------------------------
    Flash properties
    Type : spi
    Serial Number : N/A

    Device properties
    Type : uxx
    Name : N/A
    Config Mode : 0
    Max Power : N/A

    Flashable partitions running on FPGA
    Platform : xilinx_uxx_GOLDEN_x
    SC Version : INACTIVE
    Platform ID : N/A

    Flashable partitions installed in system
    <none found>

    In this output, under Flashable partition running on FPGA, note GOLDEN in the name.

    This indicates that the card has successfully been reverted to the factory image.

 

 

For other Design Guidelines, General Information, and Known Issues related to the Alveo Data Center Accelerator Cards see (Xilinx Answer 71752).

For other Design Guidelines, General Information, and Known Issues related to the Alveo Data Center Accelerator Cards - Custom Flow see (Xilinx Answer 71754).

Attachments

Associated Attachments

Name File Size File Type
revert_to_golden.mcs 33 KB MCS

Linked Answer Records

Master Answer Records

Associated Answer Records

AR# 71757
Date 07/14/2021
Status Active
Type General Article
Boards & Kits More Less
People Also Viewed