Firmware Upgrade

Platform Level Components

Before upgrading the firmware, make sure the following platform level components are upgraded:

  • CPLD - To upgrade the CPLD, refer to the Intel Gaudi vault.

  • Platform BIOS, and BMC FW - Refer to your system vendor documentation for details.

  • (HLS-2 only) PCIe switch version - Refer to your system vendor documentation for details.

Note

Contact your local Intel Gaudi support representative if you do not have access to the Intel Gaudi vault.

Firmware Upgrade

The habanalabs-firmware-odm package must be installed before firmware upgrade. See Driver and Software Installation.

  1. Check the existing Gaudi SPI FW version by running the following command:

    hl-smi -L | grep SPI
    

    Only the SPI FW needs to be updated at the system level. Refer to the Support Matrix for the exact version. The below shows an example output for the 1.17.1-40 release:

     Firmware [SPI] Version          : Preboot version hl-gaudi2-1.17.0-fw-50.1.2-sec-8 (Jul 20 2023 - 17:57:23)
    
  2. To start the firmware upgrade, run the following command:

    sudo hl-fw-loader
    

    Note

    Upgrading the firmware may take a while to complete. Make sure no network problems or power failure occurs during upgrade.

  3. Re-check the SPI FW version by running the hl-smi command below and verify it matches the supported versions listed in the Support Matrix according to the Gaudi device you are using. The below shows an example output of Gaudi 2:

         $ hl-smi -L | grep SPI
         Firmware [SPI] Version: Preboot version hl-gaudi2-1.18.0-fw-53.1.1-sec-9 (Jul 20 2023 - 17:57:23)
         Firmware [SPI] Version: Preboot version hl-gaudi2-1.18.0-fw-53.1.1-sec-9 (Jul 20 2023 - 17:57:23)
         Firmware [SPI] Version: Preboot version hl-gaudi2-1.18.0-fw-53.1.1-sec-9 (Jul 20 2023 - 17:57:23)
         Firmware [SPI] Version: Preboot version hl-gaudi2-1.18.0-fw-53.1.1-sec-9 (Jul 20 2023 - 17:57:23)
         Firmware [SPI] Version: Preboot version hl-gaudi2-1.18.0-fw-53.1.1-sec-9 (Jul 20 2023 - 17:57:23)
         Firmware [SPI] Version: Preboot version hl-gaudi2-1.18.0-fw-53.1.1-sec-9 (Jul 20 2023 - 17:57:23)
         Firmware [SPI] Version: Preboot version hl-gaudi2-1.18.0-fw-53.1.1-sec-9 (Jul 20 2023 - 17:57:23)
         Firmware [SPI] Version: Preboot version hl-gaudi2-1.18.0-fw-53.1.1-sec-9 (Jul 20 2023 - 17:57:23)
    

eROM Upgrade

Note

Upgrading the eROM is required if you are not using the latest eROM version. Refer to Support Matrix for the latest eROM version. To verify the installed eROM version, run sudo hl-smi --fw-version.

When upgrading the FW, the eROM should also be upgraded. Before running the procedure, make sure you have the following:

  • Root privileges

  • BMC access

  • “gaudi2-agent-fw_loader-fit_erom.itb” file

To upgrade the eROM, perform the following:

  1. Unload the drivers. If the habanalabs-dkms driver is already installed, the drivers must be unloaded before eROM update:

    sudo modprobe -r habanalabs && sudo modprobe -r habanalabs_cn
    sudo modprobe -r habanalabs_ib && sudo modprobe -r habanalabs_en
    
  2. Disable the eROM write protection by writing the value of 0x2e to address 8 of each one of the OAM CPLDs.

  3. Upgrade the eROM by running the following command. Point to the location of the .itb file:

    hl-fw-loader -f ./path_to_file/gaudi2-agent-fw_loader-fit_erom.itb
    
  4. Enable the eROM write protection by writing the value of 0x26 to address 8 of each of the OAM CPLDs.