DOCA SDK Documentation

BF-Bundle Installation and Upgrade

Users have three options for installing or upgrading DOCA on BlueField DPU or SuperNIC:

Method

Option Name

Description

Installation

BF-bundle DOCA image

This option overwrites the entire boot partition with an Ubuntu 22.04 installation and updates BlueField and NIC firmware

Upgrade

Standard Linux Tools

This option upgrades DOCA components without overwriting the boot partition. Use this option to preserve configurations or files on BlueField itself

Installation

ISO DOCA image

This option overwrites the entire boot partition with an Ubuntu 22.04 installation and updates BlueField and NIC firmware

Find the DOCA installation files for BlueField on the NVIDIA DOCA Downloads page.

Installing DOCA-Host

Make sure to update DOCA on the host side before installing the BF-bundle on the BlueField.

Installing Software on BlueField Using BF-Bundle

The ATF will not boot 150W BlueField-3 platforms if the ATX +12V power supply is not connected. This requirement ensures the proper operation of the BlueField device. For detailed instructions on connecting the external power supply connector, refer to the NVIDIA BlueField-3 Networking Platform User Guide.

Users can install DOCA on BlueField DPU or SuperNIC by upgrading the full DOCA image on the BlueField device. This process overwrites the entire boot partition with an Ubuntu 22.04 installation and updates BlueField and NIC firmware. It also sets up the OVS bridge.

Upgrading DOCA components on BlueField networking platforms, such as DPUs or SuperNICs, using standard Linux tools will install the new doca-eula package at /etc/NVIDIA/doca-license/DOCA-EULA.txt. By installing this package, you accept the NVIDIA DOCA SDK end-user license agreement.

Option 1 – No Pre-defined Password

To change the default Ubuntu password during the BFB bundle installation, proceed to BF-Bundle Installation and Upgrade | Option 2.

To install a BFB, use the following command:

Bash
host# sudo bfb-install --rshim rshim<N> --bfb <image_path.bfb>

Where:

  • <N> – the appropriate RShim device identifier. If you have only one BlueField device, use rshim0.

  • <image_path.bfb> – Replace this with the path to the BFB image file.

To list the RShim devices present on your system, run the following command:

Bash
host# ls -la /dev/ | grep rshim

By default, bfb-install will clear the RShim log in /dev/rshim<N>/misc and save it as tmp/bfb-install-rshim[N].log instead. To preserve the RShim log in /dev/rshim<N>/misc, provide the --keep-log argument to the bfb-install command line.

Option 2 – Set Pre-defined Password

Ubuntu users can set a unique password for the ubuntu user in the bf.cfg configuration file, which will be applied automatically at the end of the BlueField BFB bundle installation. 

To do this, follow these steps:

  1. Generate the hashed password: 

    host# openssl passwd -1
    Password:
    Verifying - Password:
    $1$3B0RIrfX$TlHry93NFUJzg3Nya00rE1
    


  2. Add the password hash to the bf.cfg configuration file: 

    host# echo ubuntu_PASSWORD='$1$3B0RIrfX$TlHry93NFUJzg3Nya00rE1' > bf.cfg
    


  3. Use the --config flag to specify the configuration file when running the installation command: 

    host# sudo bfb-install --rshim rshim<N> --bfb <image_path.bfb> --config bf.cfg
    

    If --config is not used, then upon first login to the BlueField device, users will be prompted to update the default ubuntu password.

    Optionally, to upgrade the BlueField integrated BMC firmware using BFB bundle, please provide the current BMC root credentials in a bf.cfg file, as shown in the following:

    BMC_PASSWORD="<root password>"
    BMC_USER="root"
    BMC_REBOOT="yes"
    

    Unless previously changed, the default BMC root password is 0penBmc.

    The following is an example output of Ubuntu-22.04 BFB bundle installation:

    host# sudo bfb-install --rshim rshim0 --bfb bf-bundle-2.7.0_24.04_ubuntu-22.04_prod.bfb --config bf.cfg
    Pushing bfb 1.41GiB 0:02:02 [11.7MiB/s] [           <=>                                                                                                                                ]
    Collecting BlueField booting status. Press Ctrl+C to stop
     INFO[PSC]: PSC BL1 START
     INFO[BL2]: start
     INFO[BL2]: boot mode (rshim)
     INFO[BL2]: VDDQ: 1120 mV
     INFO[BL2]: DDR POST passed
     INFO[BL2]: UEFI loaded
     INFO[BL31]: start
     INFO[BL31]: lifecycle GA Secured
     INFO[BL31]: VDD: 850 mV
     INFO[BL31]: runtime
     INFO[BL31]: MB ping success
     INFO[UEFI]: eMMC init
     INFO[UEFI]: eMMC probed
     INFO[UEFI]: UPVS valid
     INFO[UEFI]: PMI: updates started
     INFO[UEFI]: PMI: total updates: 1
     INFO[UEFI]: PMI: updates completed, status 0
     INFO[UEFI]: PCIe enum start
     INFO[UEFI]: PCIe enum end
     INFO[UEFI]: UEFI Secure Boot 
     INFO[UEFI]: PK configured
     INFO[UEFI]: Redfish enabled
     INFO[UEFI]: exit Boot Service
     INFO[MISC]: Found bf.cfg
     INFO[MISC]: Ubuntu installation started
     INFO[MISC]: Installing OS image
     INFO[MISC]: Changing the default password for user ubuntu
     INFO[MISC]: Ubuntu installation completed
     INFO[MISC]: Updating NIC firmware...
     INFO[MISC]: NIC firmware update done
     INFO[MISC]: Installation finished 
    
    


  4. To verify that the BlueField device has completed booting, wait 90 seconds after the installation process finishes and run the following command:

    host# sudo cat /dev/rshim<N>/misc
    ...
     INFO[MISC]: Linux up
     INFO[MISC]: DPU is ready
    


  5. Retrieve installed packages and their versions as part of BF-Bundle installation:

    1. Log in to BlueField.

    2. Run the following command: 

      bf# sudo bf-info
      

      Example output: 

      Firmware:
      - ATF: v2.2(release):4.11.0-31-g3cc9f6506
      - UEFI: 4.11.0-44-gb67dfb4a53
      - BSP: 4.11.0.13582
      - NIC Firmware: 32.45.0350
      - BMC Firmware: 25.04-3
      - CEC Firmware: 00.02.0195.0000
      
      Drivers:
      - mlnx-dpdk:  'MLNX_DPDK 22.11.2504.0.2'
      - Kernel: 5.15.0-1064-bluefield
      
      Tools:
      - MFT: 4.32.0-94
      - mstflint: 4.29.0-1
      
      Storage:
      - mlnx-libsnap 1.6.0-1
      - spdk 23.01.5-24
      - virtio-net-controller 24.10.15-1
      
      DOCA:
      - doca-apsh-config 2.9.0064-1
      - libdoca-sdk-urom-dev 2.9.0064-1
      ...
      FlexIO:
      - flexio-samples 24.10.2447
      - flexio-sdk 24.10.2447
      ...
      SoC Platform:
      - mlxbf-gige-modules 1.0-0.kver.6.1.0-11-arm64
      - sdhci-of-dwcmshc-modules 1.0-0.kver.6.1.0-11-arm64
      ...
      OFED:
      rdma-core 2410mlnx54-1.2410051
      ucx 1.18.0-1.2410051
      ...
      


  6. Run the following command to configure the tmfifo_net0 interface over IPv4 for SSH access to the BlueField Arm OS:

    host# ifconfig tmfifo_net0 192.168.100.1/24

    Establish an SSH connection to the BlueField Arm OS with 192.168.100.2 (preconfigured default) using the following command: 

    host# ssh ubuntu@192.168.100.2

Upgrading BlueField Using Standard Linux Tools

This procedure allows for upgrading DOCA components on BlueField networking platforms (DPUs or SuperNICs) using standard Linux tools (e.g., apt update and yum update). This method uses native package manager repositories to update components without requiring a full reinstallation.

Important!

Although this method allows you to update specific DOCA components, the combinations resulting from selective updates are not validated by NVIDIA. NVIDIA only validates the full installation of the BF-Bundle package.

Upgrading DOCA components on BlueField networking platforms using standard Linux tools will install the new doca-eula package located at /etc/NVIDIA/doca-license/DOCA-EULA.txt. By installing this package, you accept the NVIDIA DOCA SDK end-user license agreement.

This process provides the following capabilities and benefits:

  • Selective updates: Only updates components that include modifications.

  • Flexible upgrade paths: You must choose the upgrade option that best fits your deployment needs:

    • DOCA software only: Updates DOCA drivers, libraries, services, and reference applications without upgrading the hardware firmware.

    • DOCA software and firmware: Updates all DOCA software components alongside the BSP (UEFI/ATF), NIC firmware, and BMC components, while maintaining existing configurations. 

      Firmware may also be updated independently through other supported methods, such as via the out-of-band (OOB) DPU-BMC in a deferred flow.

  • Preserves environment: Does not impact user binaries or upgrade non-Ubuntu OS kernels.

  • Post-upgrade activation:

    • If the NIC firmware was not updated, perform a BlueField Arm reset (software reset/reboot).

    • If the NIC firmware was updated, perform a firmware reset (mlxfwreset) or a graceful shutdown and power cycle.

Upgrading DEB-based Distributions

Follow this procedure to upgrade DOCA components on DEB-based BlueField environments, such as Ubuntu, using the APT package manager.

Repository Setup

  1. Export DOCA_REPO with the relevant URL:

    <bf> $ export DOCA_REPO="<URL>"
    Latest GA: https://linux.mellanox.com/public/repo/doca/latest/ubuntu22.04/dpu-arm64 Latest-3.2-LTS: https://linux.mellanox.com/public/repo/doca/latest-3.2-LTS/ubuntu22.04/dpu-arm64 Latest-2.9-LTS: https://linux.mellanox.com/public/repo/doca/latest-2.9-LTS/ubuntu22.04/dpu-arm64 Latest-2.5-LTS: https://linux.mellanox.com/public/repo/doca/latest-2.5-LTS/ubuntu22.04/dpu-arm64 

  2. Add the GPG key to the APT trusted keyring: 

    <bf> $ curl $DOCA_REPO/nvidia-doca-debian-gpg-public-key.asc | gpg --dearmor > /etc/apt/trusted.gpg.d/nvidia-doca-debian-gpg-public-key.gpg

  3. Add the DOCA online repository and update the index: 

    <bf> $ echo "deb [signed-by=/etc/apt/trusted.gpg.d/nvidia-doca-debian-gpg-public-key.gpg] $DOCA_REPO ./" > /etc/apt/sources.list.d/doca.list

  4. Update the index: 

    <bf> $ apt update

Package Upgrade Selection

Choose one of the following options to upgrade your packages.

Option 1: Upgrade BlueField FW Bundle

This command upgrades the ATF-UEFI, NIC firmware, and BMC firmware only. 

<bf> $ apt install bf-fwbundle
Option 2: Update Specific DOCA Components

To skip the firmware update (e.g., when updating via DPU-BMC or Redfish), remove the old firmware packages:

  • If your DOCA version is <3.4.0:

    <bf> $ apt remove bf2-bmc-fw-signed bf3-bmc-fw-signed bf3-bmc-gi-signed bf3-bmc-nic-fw* bf2-cec-fw-signed bf3-cec-fw-signed

  • If your DOCA version is ≥3.4.0:

    <bf> $ apt remove bf2-bmc-fw-signed bf3-bmc-fw-signed bf3-bmc-gi-signed bf3-bmc-nic-fw* bf2-cec-fw-signed bf3-cec-fw-signed mlxbf-bootimages-signed

  1. Perform the OS upgrade:For non-Ubuntu OS, run the standard upgrade command: <bf> $ apt upgrade For Ubuntu OS, check the current kernel version (uname -r). If it matches the target upgrade version, simply run apt upgrade. If it does not match, you must transition the kernel manually:Install the new kernel: <bf> $ apt install linux-image-<new> linux-modules-<new> linux-modules-extra-<new> linux-headers-<new> Remove the old kernel: <bf> $ apt purge linux-image-<old> linux-modules-<old> linux-modules-extra-<old> linux-headers-<old> Cleanup and refresh GRUB: <bf> $ apt autoremove --purge && update-grub Ensure sshpass is installed (required for component activation): <bf> $ command -v sshpass >/dev/null 2>&1 || { apt-get update && apt-get install -y sshpass; } Perform the final system upgrade: <bf> $ apt upgrade

Firmware Configuration and Activation

Skip this phase if you do not wish to update firmware.

  1. Configure BMC parameters by adding the BMC user and password to /etc/bf-upgrade.conf (format is identical to bf.cfg):

    <bf> $ cat > /etc/bf-upgrade.conf << EOF
    BMC_USER="<username>"
    BMC_PASSWORD="<password>"
    WITH_NIC_FW_UPDATE="yes"
    BMC_REBOOT="yes"
    EOF
    

    BMC_REBOOT="yes" causes a warm boot to the BMC, temporarily losing connectivity.

  2. Activate the components:

    <bf> $ dpu-bmc-upgrade

    The upgrade process takes up to 20 minutes. The script performs an fwreset if supported.

Apply Changes

For the upgrade to take effect, perform a BlueField system reboot to apply the new changes, NIC firmware, and UEFI/ATF.

This step triggers immediate reboot of the BlueField Arm cores.

Upgrading RPM-based Distributions

Follow this procedure to upgrade DOCA components on RPM-based BlueField environments using the DNF or YUM package managers.

Repository Setup

  1. Export DOCA_REPO with the relevant URL:

    <bf> $ export DOCA_REPO="<URL>"
    
    • Latest GA: https://linux.mellanox.com/public/repo/doca/latest/openeuler22.03sp3/dpu-arm64/

    • Latest-3.2-LTS: https://linux.mellanox.com/public/repo/doca/latest-3.2-LTS/openeuler22.03sp3/dpu-arm64/

    • Latest-2.9-LTS: https://linux.mellanox.com/public/repo/doca/latest-2.9-LTS/openeuler22.03sp3/dpu-arm64/

    • Latest-2.5-LTS: https://linux.mellanox.com/public/repo/doca/latest-2.5-LTS/anolis8.6/dpu-arm64/

  2. Add the DOCA online repository:

    <bf> $ echo "[doca]
    name=DOCA Online Repo
    baseurl=$DOCA_REPO
    enabled=1
    gpgcheck=0
    repo_gpgcheck=1
    gpgkey=$DOCA_REPO/nvidia-doca-rpm-gpg-public-key.asc 
    priority=10
    cost=10" > /etc/yum.repos.d/doca.repo
    
  3. Update the index: 

    <bf> $ yum makecache

Package Upgrade Selection

Choose one of the following options to upgrade your packages.

Option 1: Upgrade BlueField FW Bundle

This command upgrades the ATF-UEFI, NIC firmware, and BMC firmware only.

<bf> $ dnf install bf-fwbundle
Option 2: Update Specific DOCA Components

To skip the firmware update (e.g., when updating via DPU-BMC or Redfish), remove the old firmware packages:

  • If your DOCA version is <3.4.0:

    <bf> $ dnf remove bf2-bmc-fw-signed bf3-bmc-fw-signed bf3-bmc-gi-signed bf3-bmc-nic-fw* bf2-cec-fw-signed bf3-cec-fw-signed

  • If your DOCA version is ≥3.4.0:

    <bf> $ dnf remove bf2-bmc-fw-signed bf3-bmc-fw-signed bf3-bmc-gi-signed bf3-bmc-nic-fw* bf2-cec-fw-signed bf3-cec-fw-signed mlxbf-bootimages-signed

  1. Remove the deprecated hcoll package:

    <bf> $ rpm -e --nodeps hcoll

  2. Manage kernel version locks: Ensure the correct kernel is applied.For non-Anolis OS:Install the version lock plugin:  <bf> $ dnf install -y 'dnf-command(versionlock)' Clear existing kernel locks:  <bf> $ dnf versionlock delete kernel* For Anolis OS:Install the version lock plugin:  <bf> $ dnf install -y 'dnf-command(versionlock)' Add specific kernel locks: <bf> $ dnf versionlock add \ > kernel-5.10.134-13.1.an8.aarch64 \ > kernel-core-5.10.134-13.1.an8.aarch64 \ > kernel-rpm-macros-129-1.0.2.an8.noarch \ > kernel-headers-5.10.134-13.1.an8.aarch64 \ > kernel-modules-5.10.134-13.1.an8.aarch64 \ > kernel-modules-extra-5.10.134-13.1.an8.aarch64 \ > kernel-devel-5.10.134-13.1.an8.aarch64 \ > anolis-release-8.6-4.an8.aarch64 \ > anolis-repos-8.6-4.an8.aarch64 \ > anolis-gpg-keys-8.6-4.an8.noarch

  3. Install firmware packages:

    <bf> $ dnf install -y bf2-bmc-fw-signed bf3-bmc-fw-signed bf3-bmc-gi-signed bf3-bmc-nic-fw* bf2-cec-fw-signed bf3-cec-fw-signed

  4. Ensure sshpass is installed (required for component activation): 

    <bf> $ command -v sshpass >/dev/null 2>&1 || { dnf install -y sshpass || yum install -y sshpass; }

  5. Perform the OS upgrade:For non-Anolis OS:Run the standard upgrade command:  <bf> $ dnf upgrade --nobest Lock the kernel packages to the current version: <bf> $ dnf versionlock kernel* Update the GRUB configuration to ensure the correct default boot entry: <bf> $ sed -i 's/^GRUB_DEFAULT=.*/GRUB_DEFAULT=0/' /etc/default/grub Rebuild the GRUB configuration file (replace <OS_NAME> with your OS directory name, e.g., rocky, openEuler): <bf> $ grub2-mkconfig -o /boot/efi/EFI/<OS_NAME>/grub.cfg For Anolis OS:Remove the deprecated gRPC package:  <bf> $ dnf -y remove doca-grpc Remove OpenMPI and OpenSM dependencies:  <bf> $ rpm -e --nodeps openmpi opensm opensm-devel opensm-static opensm-libs Upgrade while excluding specific trace and daemon packages:  <bf> $ dnf --exclude='libtraceevent*,rasdaemon*' upgrade Verify if an .rpmsave GRUB backup exists:  <bf> $ ls /boot/efi/EFI/anolis/grub.cfg.rpmsave If the file exists, rename it to restore the correct configuration:  <bf> $ mv /boot/efi/EFI/anolis/grub.cfg.rpmsave /boot/efi/EFI/anolis/grub.cfg

Firmware Configuration and Activation

Skip this phase if you do not wish to update firmware.

  1. Configure BMC parameters by adding the BMC user and password to /etc/bf-upgrade.conf (format is identical to bf.cfg):

    <bf> $ cat > /etc/bf-upgrade.conf << EOF
    BMC_USER="<username>"
    BMC_PASSWORD="<password>"
    WITH_NIC_FW_UPDATE="yes"
    BMC_REBOOT="yes"
    EOF

    BMC_REBOOT="yes" causes a warm boot to the BMC, temporarily losing connectivity.

  2. Activate the components:

    <bf> $ dpu-bmc-upgrade

    The upgrade process takes up to 20 minutes. The script performs an fwreset if supported.

Apply Changes

For the upgrade to take effect, perform a BlueField system reboot to apply the new changes, NIC firmware, and UEFI/ATF. 

This step triggers an immediate reboot of the BlueField Arm cores.

Installing Multiple BlueField Devices with DOCA Installer Tool

The DOCA Installer is a utility for installing or upgrading one or more BlueField DPUs in parallel. It supports both bf-bundle and bf-fw-bundle image types and is compatible with multiple BlueField operation modes, including NIC mode, DPU mode, or both on the same host. Customization is supported through INI or YAML configuration files.

Prerequisites

Make sure to update DOCA on the host side before installing doca-installer.

DEB-based

  1. Download and install the DOCA host repo from the NVIDIA DOCA Downloads page.

  2. Install doca-installer using the following command: 

    host# apt-get install doca-installer

RPM-based

  1. Download the DOCA host repo from the NVIDIA DOCA Downloads page.

  2. Install doca-installer using the following command: 

    host# sudo yum install doca-installer
    

DOCA Installer Operation Modes

The installer supports the following execution modes:

  • Global run (applies to all devices):

    host# doca-installer -b <image_path.bfb> -c <path-to-config>
    
  • Per PSID group (targets devices sharing the same PSID):

    host# doca-installer -b <image_path.bfb> --psid <PSID> -c <path-to-config>

    To exclude devices when using global or per-PSID runs, use --exclude rshim<X>.

  • Per RShim device (targets a specific RShim interface):

    host# doca-installer -b <image_path.bfb> --rshim rshim<N> -c <path-to-config>

Where:

  • -c or --config-file – defines a configuration via INI or YAML files

    To upgrade BMC, CEC, or Golden Image firmware, include BMC_USER and BMC_PASSWORD in the bf.cfg or bf.yaml file.

  • <path-to-config> – Path to the INI or YAML configuration file

  • <image_path.bfb> – Path to the BFB image file

  • <PSID> – Shared PSID value for the target group 

    Devices that do not match the provided PSID will not be upgraded.

  • <N> – RShim device index (e.g., 0 for a single-device setup)

The doca-installer script attempts to load the new NIC firmware automatically, but if that fails, it will print out the following message: 

INFO: At least one device requires a host power cycle for new NIC Firmware to be loaded.

If the script discovers that one or more of the devices did not have BMC_REBOOT set to 'yes' as part of the configuration file, it will print out the following message:

WARNING: BMC_REBOOT is not configured for all devices or is not set to 'yes'.
BMC firmware updates will only take effect after a BMC reboot.

Configuration File Options

YAML Configuration File

The YAML format supports global and per-device customization using structured keys:

  • global_configs – Shared parameters for all devices (e.g., credentials)

  • rshim – Device-specific configurations

    • Each key under rshim (e.g., rshim1, rshim2) defines variables and methods for that device

  • variables – Parameters that control the installation process (e.g., WITH_NIC_FW_UPDATE, BMC_REBOOT)

  • methods – Custom shell commands run during installation. You can use YAML anchors (&, *) to reuse methods across devices.

When a value is defined both globally and per-device, the per-device value takes precedence.

Per-Device Configuration Only Example
rshim:
  rshim1:
    variables:
      BMC_USER: 'root'
      BMC_PASSWORD: '<root password>'
    methods:
      bfb_modify_os:
        command: |
          sed -i -e "s@192.168.100.2@192.168.101.2@" /mnt/var/lib/cloud/seed/nocloud-net/network-config
          sed -i -e "s@192.168.100.1@192.168.101.1@" /mnt/var/lib/cloud/seed/nocloud-net/network-config
Global Configuration Only Example
global_configs:
  variables:
    BMC_USER: 'root'
    BMC_PASSWORD: '<root password>'
Global and Per-Device Configuration Example
global_configs:
  variables:
    BMC_USER: 'root'
    BMC_PASSWORD: '<root password>'

rshim:
  rshim1:
    variables:
      WITH_NIC_FW_UPDATE: 'no'
  rshim2:
    variables:
      BMC_PASSWORD: '<rshim2 password>'
Reusing Methods with Anchors Example
global_configs:
  variables:
    BMC_USER: 'root'
    BMC_PASSWORD: '<root password>'

rshim:
  rshim1:
    variables:
      BMC_REBOOT: 'yes'
    methods:
      bfb_post_install: &default_post_install
        command: |
          echo "Running post-install on rshim1"

  rshim2:
    methods:
      bfb_post_install: *default_post_install

INI Configuration File

Per-Device Configuration ini Copy Edit Example
RSHIM0_BMC_USER="root"
RSHIM0_BMC_PASSWORD="<password>"

RSHIM1_BMC_USER="root"
RSHIM1_BMC_PASSWORD="<password>"
Shared and Per-Device Parameters Example
# Shared across all devices
BMC_USER="root"
BMC_PASSWORD="<password>"
NEW_BMC_PASSWORD="<new password>"

# Device-specific (optional)
RSHIM0_NET_RSHIM_MAC=00:1a:ca:ff:ff:01
RSHIM1_NET_RSHIM_MAC=00:1a:ca:ff:ff:03

Logs and Debuggability

The DOCA Installer tool provides extended logging and improved debuggability compared to the legacy bfb-install tool.

For each execution of the doca-installer, a unique log directory is created under:

/var/log/doca_installer_logs/doca_installer_<timestamp>

Each device will have its own directory with logs related only to that device. These directories contain detailed diagnostic files, such as:

  • rshim diagnostics

  • lspci

  • bfb-install output

  • rshim misc installation record output

  • mlxconfig output

  • mlxprivhost output

  • mstdump output (if applicable)

  • flint

  • Register reads

The main directory itself holds key summary logs, including:

  • Full execution log of the doca-installer tool

  • System services

  • bfb-install output

  • Run result file saved in YAML

DOCA Installer Standalone Flags

The doca-installer tool introduces enhanced capabilities for comparing target image firmware versions with those currently running on devices. This allows for safer, more controlled upgrade decisions.

Fetch Firmware Versions from Image

Use the --show-target-fw flag to display firmware versions embedded in the provided BFB image:

host# doca-installer -b <image_path.bfb> --show-target-fw

Example output:

|======================|
| Tool version | 1.3.3 |
|======================|

Extracting firmware versions from /root/bf-bundle-3.2.0-87_25.10_ubuntu-24.04_prod.bfb

Target Firmware Versions of the provided image:
==========================================================
| Component   | BlueField-2        | BlueField-3         |
|=============|====================|=====================|
| DOCA        | 3.2.0104           | 3.2.0104            |
|-------------|--------------------|---------------------|
| BSP         | 4.13.0.13792       | 4.13.0.13792        |
|-------------|--------------------|---------------------|
| ATF         | 4.13.0-19-g5fcb... | 4.13.0-19-g5fcb...  |
|-------------|--------------------|---------------------|
| UEFI        | 4.13.0-25-g6cc8... | 4.13.0-25-g6cc8...  |
|-------------|--------------------|---------------------|
| NIC_FW      | 24.47.0412         | 32.47.0412          |
|-------------|--------------------|---------------------|
| BMC_FW      | BF-25.10-7         | BF-25.10-7          |
|-------------|--------------------|---------------------|
| CEC_FW      | 4.15               | 00.02.0195.0000_n02 |
|-------------|--------------------|---------------------|
| DPU_GI      | Not Supported      | 4.13.0.13792        |
|-------------|--------------------|---------------------|
| NIC_FW_GI   | Not Supported      | 32_45_1020          |
==========================================================

Fetch Firmware Versions from Running Devices

Use the --show-running-fw flag to display firmware versions currently installed on each detected BlueField device:

host# doca-installer --show-running-fw

Example output: 

Current firmware versions:

4 BF DPUs:
=======================================================================================================================================================================================================================
| PSID          | Part Num            | Serial Num   | PCI Addr     | RSHIM Dev | Mode | Privileged | Pre Upgrade ATF       | Pre Upgrade UEFI       | Pre Upgrade NIC-FW | Pre Upgrade BMC | Pre Upgrade CEC         |
|---------------|---------------------|--------------|--------------|-----------|------|------------|-----------------------|------------------------|--------------------|-----------------|-------------------------|
| MT_0000000884 | 900-9D3B6-00CV-AA0  | MT2421601NTJ | 0000:17:00.0 | rshim0    | NIC  | ENABLED    | 4.13.0-18-g210482eb2  | 4.13.0-24-g31a2ae28c5  | 32.47.0412         | BF-25.10-6      | 00.02.0195.0000_n02     |
| MT_0000000884 | 900-9D3B6-00CV-AA0  | MT2421601NJM | 0000:65:00.0 | rshim1    | DPU  | ENABLED    | 4.13.0-18-g210482eb2  | 4.13.0-24-g31a2ae28c5  | 32.47.0412         | BF-25.10-6      | 00.02.0195.0000_n02     |
| MT_0000000884 | 900-9D3B6-00CV-AA0  | MT2421901NJM | 0000:72:00.0 | rshim2    | DPU  | ENABLED    | 4.13.0-18-g210482eb2  | 4.13.0-24-g31a2ae28c5  | 32.47.0412         | BF-25.10-6      | 00.02.0195.0000_n02     |
| MT_0000000884 | 900-9D3B6-00CV-AA0  | MT2423600ALQ | 0000:ca:00.0 | rshim3    | NIC  | ENABLED    | 4.13.0-18-g210482eb2  | 4.13.0-24-g31a2ae28c5  | 32.47.0412         | BF-25.10-6      | 00.02.0195.0000_n02     |
=======================================================================================================================================================================================================================

Compare Image vs. Running Firmware Versions

Use the --compare option to compare current firmware versions on each device with those contained in the image:

host# doca-installer -b <image_path.bfb> --compare

Example output:

Firmware Version Comparison:
==================================================================================================
Device: 0000:17:00.0 (PSID: MT_0000000884, Type: BF3)
==========================================================================
| Component   | Current Version (Running) | Image Version (Offline)      |
|=============|===========================|==============================|
| ATF         | 4.13.0-18-g210482         | 4.13.0-18-g210482eb2         |
|-------------|---------------------------|------------------------------|
| UEFI        | 4.13.0-24-g31a2ae         | 4.13.0-24-g31a2ae28c5        |
|-------------|---------------------------|------------------------------|
| NIC_FW      | 32.47.0412                | 32.47.0412                   |
|-------------|---------------------------|------------------------------|
| BMC_FW      | BF-25.10-6                | BF-25.10-6                   |
|-------------|---------------------------|------------------------------|
| CEC_FW      | 00.02.0195.0000_n02       | 00.02.0195.0000_n02          |
==========================================================================

...

Device: 0000:ca:00.0 (PSID: MT_0000000884, Type: BF3)
==========================================================================
| Component   | Current Version (Running) | Image Version (Offline)      |
|=============|===========================|==============================|
| ATF         | 4.13.0-18-g210482         | 4.13.0-18-g210482eb2         |
|-------------|---------------------------|------------------------------|
| UEFI        | 4.13.0-24-g31a2ae         | 4.13.0-24-g31a2ae28c5        |
|-------------|---------------------------|------------------------------|
| NIC_FW      | 32.47.0412                | 32.47.0412                   |
|-------------|---------------------------|------------------------------|
| BMC_FW      | BF-25.10-6                | BF-25.10-6                   |
|-------------|---------------------------|------------------------------|
| CEC_FW      | 00.02.0195.0000_n02       | 00.02.0195.0000_n02          |
==========================================================================

Fetch DPU Information

Use the --show-doca-info option to fetch bf-info content from the running DPUs. This feature is supported for devices running in DPU mode only.

This feature requires DOCA 3.2.0 or newer.

host# doca-installer --show-doca-info

Example output:

Device 1: 0000:ca:00.0
----------------------------------------------
PSID: MT_0000000884
Device Type: BF3
MST Address: /dev/mst/mt41692_pciconf2


Firmware Components:
  ATF             : v2.2(release):4.13.0-19-g5fcb148df
  UEFI            : 4.13.0-25-g6cc8b2a0fa
  BSP             : 4.13.0.13792
  NIC_Firmware    : 32.47.0412
  BMC_Firmware    : 25.10-7
  CEC_Firmware    : 00.02.0195.0000

DOCA Components:
  doca-apsh-config 3.2.0104-1
  doca-bench 3.2.0104-1
  doca-caps 3.2.0104-1
  doca-comm-channel-admin 3.2.0104-1
  doca-dms 3.2.0104-1
  doca-eula 1.0.0-1
  doca-flow-tune 3.2.0104-1
  doca-openvswitch-common 3.2.0041-1
  doca-openvswitch-dev 3.2.0041-1
  doca-openvswitch-ipsec 3.2.0041-1
  doca-openvswitch-switch 3.2.0041-1
  doca-pcc-counters 3.2.0104-1
  .
  .
  .

FlexIO Components:
  flexio-samples 25.10.3034
  flexio-sdk 25.10.3034
  .
  .
  .

SoC Platform:
  mmc-utils 0+git20220624.d7b343fd-1ubuntu1

OFED Components:
  ibutils2 2.1.1-0.22300.MLNX20251015.g12cc06356.2510102
  ibverbs-providers:arm64 2510.0.9-1
  ibverbs-utils 2510.0.9-1
  infiniband-diags 2510.0.9-1
  libibmad-dev:arm64 2510.0.9-1
  libibmad5:arm64 2510.0.9-1
  libibnetdisc5:arm64 2510.0.9-1
  libibumad-dev:arm64 2510.0.9-1
  rdma-core 2510.0.9-1
  .
  .
  .

System Drivers:
  mlnx_dpdk       : 'MLNX_DPDK 22.11.2510.1.0'
  Kernel          : 6.8.0-1012-bluefield

System Tools:
  MFT             : 4.34.0-140
  mstflint        : 4.32.0-1

Storage Information:
  virtio-net-controller 25.10.4-1

BlueField-2 Limitation

BlueField-2 is supported with the following features only:

  • Parallel installation (single, global, per-PSID, exclude)

  • Show target firmware

  • Debuggability  (extensive logs collection)

Due to firmware limitation, doca-installer will not be able to present the versions of ATF, UEFI, BMC and CEC: 

3 BF DPUs:
===============================================================================================================================================================================================
| PSID          | Part Num        | Serial Num   | PCI Addr     | RSHIM Dev | Mode | Privileged | Pre Upgrade ATF | Pre Upgrade UEFI | Pre Upgrade NIC-FW | Pre Upgrade BMC | Pre Upgrade CEC |
|---------------|-----------------|--------------|--------------|-----------|------|------------|-----------------|------------------|--------------------|-----------------|-----------------|
| MT_0000000375 | MBF2M516A-CECOT | MT2128X10584 | 0000:17:00.0 | rshim1    | DPU  | ENABLED    | N/A             | N/A              | 24.47.0412         | N/A             | N/A             |
| MT_0000000733 | MBF2M516C-CECOT | MT2231X19273 | 0000:65:00.0 | rshim2    | DPU  | ENABLED    | N/A             | N/A              | 24.47.0412         | N/A             | N/A             |
| MT_0000000733 | MBF2M516C-CECOT | MT2231X19257 | 0000:83:00.0 | rshim3    | DPU  | ENABLED    | N/A             | N/A              | 24.47.0412         | N/A             | N/A             |
===============================================================================================================================================================================================

Building Custom BFB Installation Image

To build a customized BlueField OS image, use the BFB build environment. For more details, refer to the bfb-build project in in GitHub

To boot a customized BlueField OS image on a UEFI secure-boot-enabled BlueField (the default secure boot setting), the following conditions must be met:

  • The OS image must be signed with a key already present in the UEFI DB (e.g., the Microsoft key)

  • If the above is not possible, UEFI secure boot must be disabled to allow booting of an unsigned or differently signed image

For detailed instructions on managing UEFI secure boot, refer to the "Secure Boot" page in the BlueField Platform SW Documentation.

Last updated: