Installing Hypervisor Tools Package

Follow the steps below to install the FW package and the Hypervisor tools package on Ubuntu 22.04 and RHEL 9.4 operating systems.

  1. Download the FW and Hypervisor package files. Based on your operating system, run one of the following commands to download the packages:

    wget https://vault.habana.ai/artifactory/debian/jammy/pool/main/h/habanalabs-firmware/habanalabs-firmware-1.19.2-32.amd64.deb

wget https://vault.habana.ai/artifactory/debian/jammy/pool/main/h/habanalabs-firmware-odm/habanalabs-firmware-odm-1.19.2-32.amd64.deb

wget https://vault.habana.ai/artifactory/debian/jammy/pool/main/h/habanalabs-hypervisor-utils/habanalabs-hypervisor-utils_1.19.2-32_amd64.deb

    wget https://vault.habana.ai/artifactory/rhel/9/9.4/habanalabs-firmware-1.19.2-32.el9.x86_64.rpm

wget https://vault.habana.ai/artifactory/rhel/9/9.4/habanalabs-firmware-odm-1.19.2-32.el9.x86_64.rpm

wget https://vault.habana.ai/artifactory/rhel/9/9.4/habanalabs-hypervisor-utils_1.19.2-32_el9.x86_64.rpm

  2. Install the FW packages files:

    sudo apt install ./habanalabs-firmware-1.19.2-32.amd64.deb -y

sudo apt install ./habanalabs-firmware-odm-1.19.2-32.amd64.deb -y

    sudo dnf install ./habanalabs-firmware-1.19.2-32.el9.x86_64.rpm -y

sudo dnf install ./habanalabs-firmware-odm-1.19.2-32.el9.x86_64.rpm -y

  3. Update the FW as described in Firmware Upgrade section.

  4. Install the Hypervisor tools package files. This installs both the hl-smi-async tool and the MSV tool. If you prefer to install MSV tool only, skip Step 4 and Step 5 and follow the steps detailed in MSV Source Package Installation section:

    sudo apt install ./habanalabs-hypervisor-utils_1.19.2-32_amd64.deb -y

    sudo dnf install ./habanalabs-hypervisor-utils_1.19.2-32_el9.x86_64.rpm -y

  5. Once the packages installation is complete, the new executables will be available on your system to run the Hypervisor tools:

    Run the following command. For further information on the available hl-smi-async options, refer to Options and Usage:

    sudo /usr/sbin/hl-smi-async -D <device_pci_address> -O <console/logfile> -L <debug/info/error>

    Run the following command. For further information on the available MSV options, refer to Options and Usage:

    sudo /usr/bin/hbm_scrubbing_validator -busId <busId> [options]

(Optional) MSV Source Package Installation

The MSV is provided as a source package that includes the C++ source files and a Makefile to build a custom version of MSV tool.

  1. Download the Hypervisor source package file of the Memory Scrub Verification Reference Code:

    wget https://vault.habana.ai/artifactory/debian/jammy/pool/main/h/habanalabs-hypervisor-msv/habanalabs-hypervisor-msv_1.19.2-32_all.deb

    wget https://vault.habana.ai/artifactory/rhel/9/9.4/habanalabs-hypervisor-msv-1.19.2-32.el9.noarch.rpm

  2. Install MSV package file. The source code files will be automatically located in: /opt/habanalabs/hypervisor-msv/src:

    apt install ./habanalabs-hypervisor-msv_1.19.2-32_all.deb

    dnf install ./habanalabs-hypervisor-msv-1.19.2-32.el9.noarch.rpm

  3. Build and install the tool:

    cd /opt/habanalabs/hypervisor-msv/src
make
make install