Embedded Platform BootFW Update Tool

NOTE: Stable version of this utility with corresponding readme and bin file are in the release area.

This repository provides a utility to update AMD ACAP's (Adaptive Compute Acceleration Platform aka Adaptive SoC) flash device (OSPI or QSPI) with boot firmware in supported platforms. The current supported platforms are:

• Embedded+ products
  • Edge+ VPR-4616 Versal OSPI update
• Rhino Versal OSPI update
• Kria production SOM QSPI update (K26, K24c, K24i)

External Components and one time setup Required

On Embedded+ based platforms

Current Embedded+ platforms have a Versal and a Ryzen device. Versal firmware update expects that Ryzen is already running Ubuntu, as the firmware update would be performed from Ryzen. Therefore, all the components required to either log onto Ryzen Ubuntu via keyboard+mouse+monitor, network access and ssh, is required and not listed below.

On Kria platforms

Kria platforms only has a Versal device, thus a Linux host connected to the Kria platform via USB cable is required.

On all platforms

Ryzen or host OS Ubuntu must have HW_server (download 2024.1 here or 2024.2 here) or Vivado_lab installed to provide XSDB tool. HW_server has smaller footprint than Vivado_lab, so if neither are already installed, choose HW_server. To check to see if Vivado_Lab or HWSRVR has been installed, see if they can be found on the system:

sudo find / -iname Vivado_Lab
sudo find / -iname HWSRVR

These are the steps to install HW_server if none of them are installed:

1. uncompress downloaded installation file
2. Make installation files executable:

   chmod +x installLibs.sh && chmod +x xsetup
   

3. Run the installation scripts with superuser permissions:

   sudo ./installLibs.sh
   sudo ./xsetup
   

4. Click through menus
5. Run driver installation:

   sudo <HWSERVERInstall Dir>/data/xicom/cable_drivers/lin64/install_script/install_drivers/install_drivers
   

6. reboot the system, this is required because we cannot physically unplug the cable as instructed by the installation process

   sudo reboot
   

Lastly, clone this repo on Ryzen's Ubuntu. Find prog_spi.sh in the cloned folder. Then look in the "tag" area of this repo, choose the latest release, download the bin.zip files from the release, unzip and place the bin/ folder in the same folder as prog_spi.sh. (You may also download source code from the tagged release instead of cloning it).

Make prog_spi.sh executable:

  ```
  sudo chmod +x prog_spi.sh
  ```

Programming Flash Device

Move <boot.bin> that you want to program into OSPI onto filesystem on Ryzen/host OS Ubuntu.

prog_spi.sh is used to program OSPI:

Usage: ./prog_spi.sh -i <path_to_boot.bin> -d <board_type>
    -i <file>      : File to write to OSPI/QSPI
    -d <board>     : Board type.  Supported values
                     embplus, rhino, kria_k26, kria_k24c,
                     kria_k24i, versal_eval
    -p <port>      : Optional argument to override serial port
    -b <boot_file> : Optional argument to override programming boot.bin
    -h             : help

execute this command to program OSPI:

for Embedded+:

sudo ./prog_ospi.sh -i <boot.bin> -d embplus

for RHINO:

sudo ./prog_ospi.sh -i <boot.bin> -d rhino

for Kria Production SOM:

#k26c or k26i:
sudo ./prog_spi.sh -i <boot.bin> -d kria_k26
#k24c:
sudo ./prog_spi.sh -i <boot.bin> -d kria_k24c
#k24i:
sudo ./prog_spi.sh -i <boot.bin> -d kria_k24i

When the script finishes (in about 4 minutes), the flash will have been updated with <boot.bin>.

Known issues and Debug Tips

• Current version of script depends on physical uart to interact with u-boot. the UART may not always enumerate to the same /dev/ttyUSB*. to overwrite it in the case that it enumerates to a different device than what the script assumed, use -p flag to overwrite uart device location, such as:

sudo ./prog_ospi.sh -i <boot.bin> -d rhino -p /dev/ttyUSB0

• If the script is stopped during execution, Versal may get in an indeterminate state. If you have issues running the script subsequently, power cycle the platform (not just a Ryzen reboot) and try the script again.

• Uncluttered uart output from Versal is also captured in uart_output.log in the same folder. You may read it for debugging purposes.

• You may ignore the "rlwrap" warnings.

License

(C) Copyright 2024, Advanced Micro Devices Inc.
SPDX-License-Identifier: MIT