# Build with GitHub using firmware and extras

Use this information to build various Qualcomm Linux Yocto layers including the `meta-qcom-hwe`, `meta-qcom-extras`, `meta-qcom-qim-product-sdk`,
and `meta-qcom-robotics-sdk` using selective proprietary sources and binaries/libraries.

Note

This information is applicable only for authorized users. To upgrade your access, go to [Qualcomm support page](https://www.qualcomm.com/support/working-with-qualcomm).

## Host computer requirements

- Configuration

    - x86 machine
    - Quad-core CPU, for example, Intel i7-2600 at 3.4 GHz (equivalent or better)
    - 300 GB free disk space (swap partition > 32 GB)
    - 16 GB RAM
    - Ubuntu 22.04
- Tools

    - Git 1.8.3.1 or later versions
    - Tar 1.28 or later versions
    - Python 3.10.2 or later versions
    - GCC 8.0 or later versions
    - GNU Make 4.0 or later versions
- Permissions

    - A `sudo` permission is required to run a few commands

Note

Code compilation on a VM is a slow process and can take a few hours. Qualcomm recommends using an Ubuntu host computer for compilation. To set up a virtual machine (VM) running Ubuntu 22.04 on Microsoft^®^ Windows^®^ or Apple^®^ macOS^®^, see [Qualcomm Linux Virtual Machine Setup Guide](https://docs.qualcomm.com/bundle/publicresource/topics/80-70030-41/).

## Install QSC CLI

To register your Qualcomm email ID, go to [Qualcomm support page](https://www.qualcomm.com/support/working-with-qualcomm).

1. Install curl (if not installed already):

sudo apt install curl
        Copy to clipboard
2. Download the Debian package for `qsc-cli`:

cd <workspace_path>
        # For x86
        curl -L https://softwarecenter.qualcomm.com/api/download/software/tools/Qualcomm_Software_Center/Linux/Debian/latest.deb -o qsc_installer.deb
        # For ARM64
        curl -L https://softwarecenter.qualcomm.com/api/download/software/tools/Qualcomm_Software_Center/Linux/ARM64/Debian/latest.deb -o qsc_installer.deb
        Copy to clipboard
3. Install the `qsc-cli` Debian package:

sudo apt update
        sudo apt install ./qsc_installer.deb
        Copy to clipboard
4. Sign in to `qsc-cli` using your registered email ID:

qsc-cli login -u <username>
        Copy to clipboard

For more information about `qsc-cli`, see [How to Sync](https://docs.qualcomm.com/doc/80-70030-254/topic/how_to.html#howto-sync).

## Set up the Ubuntu host computer

Install and configure the software tools on the Ubuntu host computer.

1. Install the following packages:

sudo apt update
        sudo apt install repo gawk wget git diffstat unzip texinfo gcc build-essential chrpath socat cpio python3 python3-pip python3-pexpect xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev pylint xterm python3-subunit mesa-common-dev zstd liblz4-tool locales tar python-is-python3 file libxml-opml-simplegen-perl vim whiptail g++ libacl1
        sudo apt-get install lib32stdc++6 libncurses5 checkinstall libreadline-dev libncursesw5-dev libssl-dev libsqlite3-dev tk-dev libgdbm-dev libc6-dev libbz2-dev libffi-dev curl libgtest-dev
        Copy to clipboard
2. Add your Qualcomm login ID with PAT to the `~/.netrc` file in your home directory:

# Log in to qsc-cli to generate PAT
        qsc-cli login -u <username>
        # Run the following command to generate PAT
        qsc-cli show-access-token
        # This command gives output as shown in the following note
        # The last line in this output is the token, which can be used to access
        # Qualcomm Proprietary repositories. This token expires in two weeks.
        Copy to clipboard

Note

user@hostname:/local/mnt/workspace$ qsc-cli show-access-token

[Info]: Starting qsc-cli version 0.0.0.9

**5LThNlklb55mMVLB5C2KqUGU2jCF**
3. Use your preferred text editor to edit the `~/.netrc` file and add the following entries. Create the `~/.netrc` file if it doesn’t exist.

machine chipmaster2.qti.qualcomm.com
        login <your Qualcomm login id>
        password <your PAT token>
        
        machine qpm-git.qualcomm.com
        login <your Qualcomm login id>
        password <your PAT token>
        Copy to clipboard
4. Set up the locales (if not set up already):

sudo locale-gen en_US.UTF-8
        sudo update-locale LC_ALL=en_US.UTF-8 LANG=en_US.UTF-8
        export LC_ALL=en_US.UTF-8
        export LANG=en_US.UTF-8
        Copy to clipboard
5. Update git configurations:

# Check if your identity is configured in .gitconfig
        git config --get user.email
        git config --get user.name
        
        # Run the following commands if you don't have your account identity set in .gitconfig
        git config --global user.email <Your email ID>
        git config --global user.name <"Your Name">
        
        # Add the following UI color option for output of console (optional)
        git config --global color.ui auto
        
        # Add the following git configurations to fetch large size repositories and to avoid unreliable connections
        git config --global http.postBuffer 1048576000
        git config --global http.maxRequestBuffer 1048576000
        git config --global http.lowSpeedLimit 0
        git config --global http.lowSpeedTime 999999
        
        # Add the following git configurations to follow remote redirects from http-alternates files or alternates
        git config --global http.https://chipmaster2.qti.qualcomm.com.followRedirects true
        git config --global http.https://qpm-git.qualcomm.com.followRedirects true
        Copy to clipboard
6. Set up Python 3.10.2:

Note

Skip the following instructions if you already have Python 3.10.2 or later versions.

python --version
        # Download it in a directory of your choice
        wget https://www.python.org/ftp/python/3.10.2/Python-3.10.2.tgz
        tar -xvf Python-3.10.2.tgz
        cd Python-3.10.2
        # Use sudo if you need to access /opt
        ./configure --prefix=/opt/python3 --enable-optimizations
        make
        make install
        ln -s /opt/python3/bin/python3  /opt/python3/bin/python
        export PATH=/opt/python3/bin:$PATH
        export PYTHONPATH=/opt/python3/lib:$PYTHONPATH
        Copy to clipboard

## Build with firmware sources

### Sync firmware

Commands in the following sections are based on the binary and source for firmware images without modem and GPS (see the command in [Mapping firmware distributions to git repositories](https://docs.qualcomm.com/doc/80-70030-254/topic/build_addn_info.html#mapping-firmware-table)). Hence, `qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk` is used. If you use any other distribution, then update the directory accordingly.

The following table describes the Qualcomm Yocto layers and release tags:

| Access level | Yocto layer | Release tag | Example |
| --- | --- | --- | --- |
| Public developers (unregistered) | `meta-qcom-hwe` | manifest release tag | qcom-6.6.136-QLI.1.9-Ver.1.1.xml |
| Public developers (unregistered) | `meta-qcom-qim-product-sdk` | manifest release tag | qcom-6.6.136-QLI.1.9-Ver.1.1\_qim-product-sdk-2.4.1.xml |
| Public developers (unregistered) | `meta-qcom-robotics-sdk` | manifest release tag | qcom-6.6.136-QLI.1.9-Ver.1.1\_robotics-sdk-1.1.xml |
| Licensed developers with authorized access | `meta-qcom-extras` | meta-qcom-extras release tag | r1.0\_00130.0 |
| See [Mapping access levels to firmware distributions](https://docs.qualcomm.com/doc/80-70030-254/topic/build_addn_info.html#build-mapping-access-levels) | NA | firmware release tag | r1.0\_00129.0 |
|  |  |  |  |
|  |  |  |  |

The following tables describe the firmware distributions that you can download. For more information about the Yocto layers, see [Qualcomm Linux metadata layers](https://docs.qualcomm.com/bundle/publicresource/topics/80-70030-27/qualcomm_linux_metadata_layers.html).

| **Access level** | **Distribution** | Yocto layers |
| --- | --- | --- |
| Licensed developers with authorized access | BSP build: High-level OS and firmware source (GPS only)<br><br><br>`Qualcomm_Linux.SPF.1.0|AP|Standard|OEM|NoModem` | `meta-qcom`<br><br><br>`meta-qcom-hwe`<br><br><br>`meta-qcom-distro`<br><br><br>`meta-qcom-extras` |
| Licensed developers with authorized access | BSP build + Qualcomm IM SDK<br><br><br><br>> <br>> <br>> `Qualcomm_Linux.SPF.1.0|AP|Standard|OEM|NM_QIMPSDK` | `meta-qcom`<br><br><br>`meta-qcom-hwe`<br><br><br>`meta-qcom-distro`<br><br><br>`meta-qcom-extras`<br><br><br>`meta-qcom-qim-product-sdk` |
| Licensed developers with authorized access | BSP build + Qualcomm IM SDK + QIR SDK<br><br><br><br>> <br>> <br>> `Qualcomm_Linux.SPF.1.0|AP|Standard|OEM|NM_QIRPSDK` | `meta-qcom`<br><br><br>`meta-qcom-hwe`<br><br><br>`meta-qcom-distro`<br><br><br>`meta-qcom-extras`<br><br><br>`meta-qcom-robotics-extras`<br><br><br>`meta-ros`<br><br><br>`meta-qcom-robotics`<br><br><br>`meta-qcom-robotics-distro`<br><br><br>`meta-qcom-robotics-sdk`<br><br><br>`meta-qcom-qim-product-sdk` |
| Licensed developers (contact Qualcomm for access) | BSP build: High-level OS and firmware (GPS only) source<br><br><br>`Qualcomm_Linux.SPF.1.0|AP|Standard|OEM|` | `meta-qcom`<br><br><br>`meta-qcom-hwe`<br><br><br>`meta-qcom-distro`<br><br><br>`meta-qcom-extras` |
| Licensed developers (contact Qualcomm for access) | BSP build + Qualcomm IM SDK (GPS only)<br><br><br><br>> <br>> <br>> `Qualcomm_Linux.SPF.1.0|AP|Standard|OEM|QIMPSDK` | `meta-qcom`<br><br><br>`meta-qcom-hwe`<br><br><br>`meta-qcom-distro`<br><br><br>`meta-qcom-extras`<br><br><br>`meta-qcom-robotics-extras`<br><br><br>`meta-qcom-qim-product-sdk` |
| Licensed developers (contact Qualcomm for access) | BSP build: High-level OS and firmware (GPS and modem) source<br><br><br><br>> <br>> <br>> `Qualcomm_Linux.SPF.1.0|AMSS|Standard|OEM|` | `meta-qcom`<br><br><br>`meta-qcom-hwe`<br><br><br>`meta-qcom-distro`<br><br><br>`meta-qcom-extras` |
| Licensed developers (contact Qualcomm for access) | BSP build + Qualcomm IM SDK (GPS and modem)<br><br><br><br>> <br>> <br>> `Qualcomm_Linux.SPF.1.0|AMSS|Standard|OEM|QIMPSDK` | `meta-qcom`<br><br><br>`meta-qcom-hwe`<br><br><br>`meta-qcom-distro`<br><br><br>`meta-qcom-extras`<br><br><br>`meta-qcom-qim-product-sdk` |
|  |  |  |
|  |  |  |
|  |  |  |

The following table maps the firmware distributions to git repositories:

Mapping firmware distributions to git repositories

| Firmware distribution | Git command | Directory into which firmware gets synced on git clone |
| --- | --- | --- |
| Qualcomm\_Linux.SPF.1.0|AP|Standard|OEM|NoModem | `git clone -b <firmware release tag> --depth 1 https://qpm-git.qualcomm.com/home2/git/qualcomm/qualcomm-linux-spf-1-0_ap_standard_oem_nomodem.git` | `qualcomm-linux-spf-1-0_ap_standard_oem_nomodem` |
| Qualcomm\_Linux.SPF.1.0|AP|Standard|OEM|NM\_QIMPSDK | `git clone -b <firmware release tag> --depth 1 https://qpm-git.qualcomm.com/home2/git/qualcomm/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk.git` | `qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk` |
| Qualcomm\_Linux.SPF.1.0|AP|Standard|OEM|NM\_QIRPSDK | `git clone -b <firmware release tag> --depth 1 https://qpm-git.qualcomm.com/home2/git/qualcomm/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qirpsdk.git` | `qualcomm-linux-spf-1-0_ap_standard_oem_nm-qirpsdk` |
| Qualcomm\_Linux.SPF.1.0|AP|Standard|OEM| | `git clone -b <firmware release tag> --depth 1 https://qpm-git.qualcomm.com/home2/git/qualcomm/qualcomm-linux-spf-1-0_ap_standard_oem.git` | `qualcomm-linux-spf-1-0_ap_standard_oem` |
| Qualcomm\_Linux.SPF.1.0|AP|Standard|OEM|QIMPSDK | `git clone -b <firmware release tag> --depth 1 https://qpm-git.qualcomm.com/home2/git/qualcomm/qualcomm-linux-spf-1-0_ap_standard_oem_qimpsdk.git` | `qualcomm-linux-spf-1-0_ap_standard_oem_qimpsdk` |
| Qualcomm\_Linux.SPF.1.0|AMSS|Standard|OEM| | `git clone -b <firmware release tag> --depth 1 https://qpm-git.qualcomm.com/home2/git/qualcomm/qualcomm-linux-spf-1-0_amss_standard_oem.git` | `qualcomm-linux-spf-1-0_amss_standard_oem` |
| Qualcomm\_Linux.SPF.1.0|AMSS|Standard|OEM|QIMPSDK | `git clone -b <firmware release tag> --depth 1 https://qpm-git.qualcomm.com/home2/git/qualcomm/qualcomm-linux-spf-1-0_amss_standard_oem_qimpsdk.git` | `qualcomm-linux-spf-1-0_amss_standard_oem_qimpsdk` |

The **Git command** column (in the [Mapping firmware distributions to git repositories](https://docs.qualcomm.com/doc/80-70030-254/topic/build_addn_info.html#mapping-firmware-table) table) provides information about the git repositories that contain the firmware sources. Qualcomm servers host these repositories. Clone the appropriate repositories based on your access profile and use case.

The following `git clone` command downloads the selected firmware components in source, except the modem:

mkdir -p <FIRMWARE_ROOT>
    cd <FIRMWARE_ROOT>
    git clone -b <firmware release tag> --depth 1 https://qpm-git.qualcomm.com/home2/git/qualcomm/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk.git
    # Example, <firmware release tag> is r1.0_00129.0
    Copy to clipboard

The `git clone` command clones the content into the `<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk` directory. For the latest `<firmware release tag>`, see the section *Build-critical release tags* in the [Release Notes](https://docs.qualcomm.com/doc/80-70030-300/).

### Build firmware

Tab QCS6490/QCS5430
Tab IQ-9075
Tab IQ-8275

Prerequisites

- Ensure that the working shell is `bash`.

echo $0
        Copy to clipboard

    The expected output of the command should be `bash`. If not, enter the bash shell:

bash
        Copy to clipboard
- Install the libffi6 package using the following commands. This is required for the QAIC compiler, which generates the header and the source files from the IDL files:

curl -LO http://archive.ubuntu.com/ubuntu/pool/main/libf/libffi/libffi6_3.2.1-8_amd64.deb
        sudo dpkg -i libffi6_3.2.1-8_amd64.deb
        Copy to clipboard
- Install LLVM for AOP, Qualcomm^®^ Trusted Execution Environment (TEE), and boot compilation:

cd <FIRMWARE_ROOT>
        mkdir llvm
        
        # Log in to qsc-cli and activate the license
        qsc-cli login
        qsc-cli tool activate-license --name sdllvm_arm
        
        # LLVM requirement for boot compilation is 14.0.4
        qsc-cli tool install --name sdllvm_arm --required-version 14.0.4 --path <FIRMWARE_ROOT>/llvm/14.0.4
        chmod -R 777 <FIRMWARE_ROOT>/llvm/14.0.4
        
        # LLVM requirement for the Qualcomm TEE compilation is 16.0.7
        qsc-cli tool install --name sdllvm_arm --required-version 16.0.7 --path <FIRMWARE_ROOT>/llvm/16.0.7
        chmod -R 777 <FIRMWARE_ROOT>/llvm/16.0.7
        Copy to clipboard
- Export the `SECTOOLS` variable and compile the firmware builds (`<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk` is the top-level directory):

export SECTOOLS=<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/QCM6490.LE.1.0/common/sectoolsv2/ext/Linux/sectools
        export SECTOOLS_DIR=<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/QCM6490.LE.1.0/common/sectoolsv2/ext/Linux
        Copy to clipboard
- Install and set up Qualcomm^®^ Hexagon^™^ Processor. Set the environment variable HEXAGON\_ROOT to the path where the Hexagon SDK is installed. To change the install path when using `qsc-cli`, see [Change the Hexagon tool install path](https://docs.qualcomm.com/doc/80-70030-254/topic/how_to.html#change-hex-tool-install-path).

qsc-cli tool extract --name hexagon8.4 --required-version 8.4.07
        qsc-cli tool extract --name hexagon8.4 --required-version 8.4.10
        export HEXAGON_ROOT=$HOME/Qualcomm/HEXAGON_Tools
        echo $HEXAGON_ROOT
        Copy to clipboard

Build cDSP

**Tools required**

- Compiler version: Hexagon 8.4.07
- Python version: Python 3.10.2
- libffi6 package

**Build steps**

1. Go to the following directory:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/CDSP.HT.2.5.c3/cdsp_proc/build/ms
        Copy to clipboard
2. Clean the build:

python ./build_variant.py kodiak.cdsp.prod --clean
        Copy to clipboard
3. Build the image:

python ./build_variant.py kodiak.cdsp.prod
        Copy to clipboard

Build aDSP

**Tools required**

- Compiler version: Hexagon 8.4.07
- Python version: Python 3.10.2
- libffi6 package

**Build steps**

1. Nanopb integration (one-time setup):

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/ADSP.HT.5.5.c8/adsp_proc/qsh_api
        curl https://jpa.kapsi.fi/nanopb/download/nanopb-0.3.9.5-linux-x86.tar.gz -o nanopb-0.3.9.5-linux-x86.tar.gz
        cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/ADSP.HT.5.5.c8/adsp_proc/
        python qsh_api/build/config_nanopb_dependency.py -f nanopb-0.3.9.5-linux-x86
        Copy to clipboard
2. Go to the following directory:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/ADSP.HT.5.5.c8/adsp_proc/build/ms
        Copy to clipboard
3. Clean the build:

python ./build_variant.py kodiak.adsp.prod --clean
        Copy to clipboard
4. Build the image:

python ./build_variant.py kodiak.adsp.prod
        Copy to clipboard

Build Boot

**Tools required**

- Compiler version: LLVM version must be updated to 14.0.4

export LLVM=<FIRMWARE_ROOT>/llvm/14.0.4/
        Copy to clipboard
- Python version: Python 3.10
- libffi6 package

**Build steps**

1. Install the device tree compiler:

sudo apt-get install device-tree-compiler
        export DTC=/usr/bin
        Copy to clipboard
2. Go to the following directory:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/BOOT.MXF.1.0.c1/
        Copy to clipboard
3. Install the dependencies:

python -m pip install -r boot_images/boot_tools/dtschema_tools/oss/requirements.txt
        pip install json-schema-for-humans
        Copy to clipboard
4. Clean the build:

python -u boot_images/boot_tools/buildex.py -t kodiak,QcomToolsPkg -v LAA -r RELEASE --build_flags=cleanall
        Copy to clipboard
5. Build the image:

python -u boot_images/boot_tools/buildex.py -t kodiak,QcomToolsPkg -v LAA -r RELEASE
        Copy to clipboard

Note

For debug variant builds, replace `RELEASE` with `DEBUG`.

Build Qualcomm TEE firmware

**Tools required**

- Compiler version: LLVM 16.0.7
- Python version: Python 3.10

**Build steps**

1. Install LLVM:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/TZ.XF.5.29.1/trustzone_images/build/ms/
        vi build_config_deploy_kodiak.xml
        # Edit all the occurrences of /pkg/qct/software/llvm/release/arm/16.0.7/ to <FIRMWARE_ROOT>/llvm/16.0.7/
        Copy to clipboard
2. Clean the build:

python build_all.py -b TZ.XF.5.0 CHIPSET=kodiak --cfg=build_config_deploy_kodiak.xml --clean
        Copy to clipboard
3. Build the image:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/TZ.XF.5.29.1/trustzone_images/build/ms/
        python build_all.py -b TZ.XF.5.0 CHIPSET=kodiak --cfg=build_config_deploy_kodiak.xml
        Copy to clipboard

Build AOP firmware

**Tools required**

- Compiler version: LLVM 14.0.4
- Python version: Python 3.10

**Build steps**

1. Go to the following directory:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/AOP.HO.3.6/aop_proc/build/
        Copy to clipboard
2. Clean the build:

./build_kodiak.sh -c -l <FIRMWARE_ROOT>/llvm/14.0.4/
        Copy to clipboard
3. Build the image:

./build_kodiak.sh -l <FIRMWARE_ROOT>/llvm/14.0.4/
        Copy to clipboard

Build MPSS

Note

This build is applicable only for `Qualcomm_Linux.SPF.1.0|AMSS|Standard|OEM|` and `Qualcomm_Linux.SPF.1.0|AMSS|Standard|OEM|QIMPSDK`.

**Tools required**

- Compiler version: Hexagon 8.4.10
- Python version: Python 3.8.2

**Build steps**

1. Nanopb integration (one-time setup):

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_amss_standard_oem_qimpsdk/MPSS.HI.4.3.3.c6.2/modem_proc/ssc_api
                  curl https://jpa.kapsi.fi/nanopb/download/nanopb-0.3.9.5-linux-x86.tar.gz -o nanopb-0.3.9.5-linux-x86.tar.gz
                  cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_amss_standard_oem_qimpsdk/MPSS.HI.4.3.3.c6.2/modem_proc
                  python ssc_api/build/config_nanopb_dependency.py -f  nanopb-0.3.9.5-linux-x86
        Copy to clipboard
2. Go to the following directory:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_amss_standard_oem_qimpsdk/MPSS.HI.4.3.3.c6.2/modem_proc/build/ms
        Copy to clipboard
3. Clean the build:

python build_variant.py kodiak.gen.prod --clean
        Copy to clipboard
4. Build the image:

python build_variant.py kodiak.gen.prod bparams=-k
        Copy to clipboard

CPUCP firmware

The CPUCP firmware is released as a binary and build compilation isn’t required.

CPUSYS.VM firmware

The CPUSYS.VM firmware is released as a binary and build compilation isn’t required.

BTFM firmware

The BTFM firmware is released as a binary and build compilation isn’t required.

WLAN firmware

The WLAN firmware is released as a binary and build compilation isn’t required.

Generate firmware prebuilds (boot-critical and split-firmware binaries)

- Create an integrated firmware binary from the individual components that you compiled:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/QCM6490.LE.1.0/common/build
        python build.py --imf
        Copy to clipboard
- Firmware prebuild is successful if the following zip files are generated in the `<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/QCM6490.LE.1.0/common/build/ufs/bin` directory:

> 
> 
> - `QCM6490_bootbinaries.zip`
>     - `QCM6490_dspso.zip`
>     - `QCM6490_fw.zip`

Prerequisites

- Ensure that the working shell is `bash`.

echo $0
        Copy to clipboard

    The expected output of the command should be `bash`. If not, enter the bash shell:

bash
        Copy to clipboard
- Install the libffi6 package using the following commands. This is required for the QAIC compiler, which generates the header and the source files from the IDL files:

curl -LO http://archive.ubuntu.com/ubuntu/pool/main/libf/libffi/libffi6_3.2.1-8_amd64.deb
        sudo dpkg -i libffi6_3.2.1-8_amd64.deb
        Copy to clipboard
- Install LLVM for AOP, Qualcomm TEE, and boot compilation:

cd <FIRMWARE_ROOT>
        mkdir llvm
        
        # Log in to qsc-cli and activate the license
        qsc-cli login
        qsc-cli tool activate-license --name sdllvm_arm
        
        # LLVM requirement for boot compilation is 14.0.4
        qsc-cli tool install --name sdllvm_arm --required-version 14.0.4 --path <FIRMWARE_ROOT>/llvm/14.0.4
        chmod -R 777 <FIRMWARE_ROOT>/llvm/14.0.4
        
        # LLVM requirement for the Qualcomm TEE compilation is 16.0.7
        qsc-cli tool install --name sdllvm_arm --required-version 16.0.7 --path <FIRMWARE_ROOT>/llvm/16.0.7
        chmod -R 777 <FIRMWARE_ROOT>/llvm/16.0.7
        Copy to clipboard
- Export the `SECTOOLS` variable and compile the firmware builds (`<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk` is the top-level directory):

export SECTOOLS=<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/QCS9100.LE.1.0/common/sectoolsv2/ext/Linux/sectools
        export SECTOOLS_DIR=<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/QCS9100.LE.1.0/common/sectoolsv2/ext/Linux
        Copy to clipboard
- Install and set up Hexagon. Set the environment variable HEXAGON\_ROOT to the path where the Hexagon SDK is installed. To change the install path when using `qsc-cli`, see [Change the Hexagon tool install path](https://docs.qualcomm.com/doc/80-70030-254/topic/how_to.html#change-hex-tool-install-path).

qsc-cli tool extract --name hexagon8.6 --required-version 8.6.05.2
        export HEXAGON_ROOT=$HOME/Qualcomm/HEXAGON_Tools
        echo $HEXAGON_ROOT
        Copy to clipboard

Build DSP

**Tools required**

- Compiler version: Hexagon 8.6.05.2
- Python version: Python 3.8.2

**Build steps**

1. Install the device tree compiler:

sudo apt-get install device-tree-compiler
        export DTC_PATH=/usr/bin
        Copy to clipboard
2. Install the dependencies:

pip install ruamel.yaml==0.17.17
        pip install dtschema==2021.10
        pip install jsonschema==4.0.0
        Copy to clipboard
3. Go to the following directory:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/DSP.AT.1.0.1/dsp_proc/build/ms
        Copy to clipboard
4. Clean the build:

python ./build_variant.py lemans.adsp.prod --clean
        python ./build_variant.py lemans.cdsp0.prod --clean
        python ./build_variant.py lemans.cdsp1.prod --clean
        python ./build_variant.py lemans.gpdsp0.prod --clean
        python ./build_variant.py lemans.gpdsp1.prod --clean
        Copy to clipboard
5. Build the image:

python ./build_variant.py lemans.adsp.prod && python ./build_variant.py lemans.cdsp0.prod && python ./build_variant.py lemans.cdsp1.prod && python ./build_variant.py lemans.gpdsp0.prod && python ./build_variant.py lemans.gpdsp1.prod
        Copy to clipboard

Build Boot

**Tools required**

- Compiler version: LLVM version must be updated to 14.0.4

export LLVM=<FIRMWARE_ROOT>/llvm/14.0.4/
        Copy to clipboard
- Python version: Python 3.10
- libffi6 package

**Build steps**

1. Install the device tree compiler:

sudo apt-get install device-tree-compiler
        export DTC=/usr/bin
        Copy to clipboard
2. Go to the following directory:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/BOOT.MXF.1.0.c1/
        Copy to clipboard
3. Install the dependencies:

python -m pip install -r boot_images/boot_tools/dtschema_tools/oss/requirements.txt
        pip install json-schema-for-humans
        Copy to clipboard
4. Clean the build:

python -u boot_images/boot_tools/buildex.py -t lemans,QcomToolsPkg -v LAA -r RELEASE --build_flags=cleanall
        Copy to clipboard
5. Build the image:

python -u boot_images/boot_tools/buildex.py -t lemans,QcomToolsPkg -v LAA -r RELEASE
        Copy to clipboard

Note

For debug variant builds, replace `RELEASE` with `DEBUG`.

Build Qualcomm TEE firmware

**Tools required**

- Compiler version: LLVM 16.0.7
- Python version: Python 3.10

**Build steps**

1. Install LLVM:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/TZ.XF.5.29.1/trustzone_images/build/ms/
        vi build_config_deploy_lemans.xml
        # Edit all the occurrences of /pkg/qct/software/llvm/release/arm/16.0.7/ to <FIRMWARE_ROOT>/llvm/16.0.7/
        Copy to clipboard
2. Clean the build:

python build_all.py -b TZ.XF.5.0 CHIPSET=lemans --cfg=build_config_deploy_lemans.xml --clean
        Copy to clipboard
3. Build the image:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/TZ.XF.5.29.1/trustzone_images/build/ms/
        python build_all.py -b TZ.XF.5.0 CHIPSET=lemans --cfg=build_config_deploy_lemans.xml
        Copy to clipboard

Build AOP firmware

**Tools required**

- Compiler version: LLVM 14.0.4
- Python version: Python 3.10

**Build steps**

1. Go to the following directory:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/AOP.HO.3.6.1/aop_proc/build/
        Copy to clipboard
2. Clean the build:

./build_lemansau.sh -c -l <FIRMWARE_ROOT>/llvm/14.0.4/
        Copy to clipboard
3. Build the image:

./build_lemansau.sh -l <FIRMWARE_ROOT>/llvm/14.0.4/
        Copy to clipboard

CPUCP firmware

The CPUCP firmware is released as a binary and build compilation isn’t required.

CPUSYS.VM firmware

The CPUSYS.VM firmware is released as a binary and build compilation isn’t required.

BTFM firmware

The BTFM firmware is released as a binary and build compilation isn’t required.

WLAN firmware

The WLAN firmware is released as a binary and build compilation isn’t required.

Generate firmware prebuilds (boot-critical and split-firmware binaries)

- Create an integrated firmware binary from the individual components that you compiled:

Note

Apply all the changes from the section *Additional information* in the [Release Notes](https://docs.qualcomm.com/doc/80-70030-300/topic/additional_information.html).

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/QCS9100.LE.1.0/common/build
        python build.py --imf
        Copy to clipboard
- Firmware prebuild is successful if the following zip files are generated in the `<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/QCM6490.LE.1.0/common/build/ufs/bin` directory:

> 
> 
> - `QCS9100_bootbinaries.zip`
>     - `QCS9100_dspso.zip`
>     - `QCS9100_fw.zip`

Prerequisites

- Ensure that the working shell is `bash`.

echo $0
        Copy to clipboard

    The expected output of the command should be `bash`. If not, enter the bash shell:

bash
        Copy to clipboard
- Install the libffi6 package using the following commands. This is required for the QAIC compiler, which generates the header and the source files from the IDL files:

curl -LO http://archive.ubuntu.com/ubuntu/pool/main/libf/libffi/libffi6_3.2.1-8_amd64.deb
        sudo dpkg -i libffi6_3.2.1-8_amd64.deb
        Copy to clipboard
- Install LLVM for AOP, Qualcomm TEE, and boot compilation:

cd <FIRMWARE_ROOT>
        mkdir llvm
        
        # Log in to qsc-cli and activate the license
        qsc-cli login
        qsc-cli tool activate-license --name sdllvm_arm
        
        # LLVM requirement for boot compilation is 14.0.4
        qsc-cli tool install --name sdllvm_arm --required-version 14.0.4 --path <FIRMWARE_ROOT>/llvm/14.0.4
        chmod -R 777 <FIRMWARE_ROOT>/llvm/14.0.4
        
        # LLVM requirement for the Qualcomm TEE compilation is 16.0.7
        qsc-cli tool install --name sdllvm_arm --required-version 16.0.7 --path <FIRMWARE_ROOT>/llvm/16.0.7
        chmod -R 777 <FIRMWARE_ROOT>/llvm/16.0.7
        Copy to clipboard
- Export the `SECTOOLS` variable and compile the firmware builds (`<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk` is the top-level directory):

export SECTOOLS=<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/QCS8300.LE.1.0/common/sectoolsv2/ext/Linux/sectools
        export SECTOOLS_DIR=<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/QCS8300.LE.1.0/common/sectoolsv2/ext/Linux
        Copy to clipboard
- Install and set up Hexagon. Set the environment variable HEXAGON\_ROOT to the path where the Hexagon SDK is installed. To change the install path when using `qsc-cli`, see [Change the Hexagon tool install path](https://docs.qualcomm.com/doc/80-70030-254/topic/how_to.html#change-hex-tool-install-path).
.. container:: nohighlight

> 
> 
> qsc-cli tool extract --name hexagon8.6 --required-version 8.6.05.2
>         qsc-cli tool extract --name hexagon8.7 --required-version 8.7.02.1
>         export HEXAGON_ROOT=$HOME/Qualcomm/HEXAGON_Tools
>         echo $HEXAGON_ROOT
>         Copy to clipboard

Build DSP

**Tools required**

- Compiler version: Hexagon 8.6.05.2 and 8.7.02.1
- Python version: Python 3.8.2

**Build steps**

1. Install the device tree compiler:

sudo apt-get install device-tree-compiler
        export DTC_PATH=/usr/bin
        Copy to clipboard
2. Install the dependencies:

pip install ruamel.yaml==0.17.17
        pip install dtschema==2021.10
        pip install jsonschema==4.0.0
        Copy to clipboard
3. Go to the following directory:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/DSP.AT.1.0.1/dsp_proc/build/ms
        Copy to clipboard
4. Clean the build:

python ./build_variant.py lemans.adsp.prod --clean
        python ./build_variant.py monaco.cdsp0.prod --clean
        python ./build_variant.py lemans.gpdsp0.prod --clean
        Copy to clipboard
5. Build the image:

python ./build_variant.py lemans.adsp.prod && python ./build_variant.py monaco.cdsp0.prod && python ./build_variant.py lemans.gpdsp0.prod
        Copy to clipboard

Build Boot

**Tools required**

- Compiler version: LLVM version must be updated to 14.0.4

export LLVM=<FIRMWARE_ROOT>/llvm/14.0.4/
        Copy to clipboard
- Python version: Python 3.10
- libffi6 package

**Build steps**

1. Install the device tree compiler:

sudo apt-get install device-tree-compiler
        export DTC=/usr/bin
        Copy to clipboard
2. Go to the following directory:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/BOOT.MXF.1.0.c1/
        Copy to clipboard
3. Install the dependencies:

python -m pip install -r boot_images/boot_tools/dtschema_tools/oss/requirements.txt
        pip install json-schema-for-humans
        Copy to clipboard
4. Clean the build:

python -u boot_images/boot_tools/buildex.py -t monaco,QcomToolsPkg -v LAA -r RELEASE --build_flags=cleanall
        Copy to clipboard
5. Build the image:

python -u boot_images/boot_tools/buildex.py -t monaco,QcomToolsPkg -v LAA -r RELEASE
        Copy to clipboard

Note

For debug variant builds, replace `RELEASE` with `DEBUG`.

Build Qualcomm TEE firmware

**Tools required**

- Compiler version: LLVM 16.0.7
- Python version: Python 3.10

**Build steps**

1. Install LLVM:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/TZ.XF.5.29.1/trustzone_images/build/ms/
        vi build_config_deploy_monaco.xml
        # Edit all the occurrences of /pkg/qct/software/llvm/release/arm/16.0.7/ to <FIRMWARE_ROOT>/llvm/16.0.7/
        Copy to clipboard
2. Clean the build:

python build_all.py -b TZ.XF.5.0 CHIPSET=monaco --cfg=build_config_deploy_monaco.xml --clean
        Copy to clipboard
3. Build the image:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/TZ.XF.5.29.1/trustzone_images/build/ms/
        python build_all.py -b TZ.XF.5.0 CHIPSET=monaco --cfg=build_config_deploy_monaco.xml
        Copy to clipboard

Build AOP firmware

**Tools required**

- Compiler version: LLVM 14.0.4
- Python version: Python 3.10

**Build steps**

1. Go to the following directory:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/AOP.HO.3.6.1/aop_proc/build/
        Copy to clipboard
2. Clean the build:

./build_monaco.sh -c -l <FIRMWARE_ROOT>/llvm/14.0.4/
        Copy to clipboard
3. Build the image:

./build_monaco.sh -l <FIRMWARE_ROOT>/llvm/14.0.4/
        Copy to clipboard

CPUCP firmware

The CPUCP firmware is released as a binary and build compilation isn’t required.

CPUSYS.VM firmware

The CPUSYS.VM firmware is released as a binary and build compilation isn’t required.

BTFM firmware

The BTFM firmware is released as a binary and build compilation isn’t required.

WLAN firmware

The WLAN firmware is released as a binary and build compilation isn’t required.

Generate firmware prebuilds (boot-critical and split-firmware binaries)

- Create an integrated firmware binary from the individual components that you compiled:

cd <FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/QCS8300.LE.1.0/common/build
        python build.py --imf
        Copy to clipboard
- Firmware prebuild is successful if the following zip files are generated in the `<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/QCS8300.LE.1.0/common/build/ufs/bin` directory:

    - `QCS8300_bootbinaries.zip`
    - `QCS8300_dspso.zip`
    - `QCS8300_fw.zip`

### Build a BSP image with extras

The BSP image build has software components for the Qualcomm device support and software features applicable to the Qualcomm SoCs. This build includes a reference distribution configuration for the Qualcomm development kits. The `meta-qcom-extras` layer enables source compilation of select components, which are otherwise present as binary. For more details, see [Qualcomm Linux metadata layers](https://docs.qualcomm.com/bundle/publicresource/topics/80-70030-27/qualcomm_linux_metadata_layers.html).

1. Download Qualcomm Yocto and the supporting layers with extras. For the `<manifest release tag>` and `<meta-qcom-extras release tag>` information, see the section *Build-critical release tags* in the [Release Notes](https://docs.qualcomm.com/doc/80-70030-300/).

# cd to directory where you have 300 GB of free storage space to create your workspaces
        mkdir <WORKSPACE_DIR>
        cd <WORKSPACE_DIR>
        repo init -u https://github.com/quic-yocto/qcom-manifest -b qcom-linux-scarthgap -m <manifest release tag>
        # Example, <manifest release tag> is qcom-6.6.136-QLI.1.9-Ver.1.1.xml
        repo sync
        git clone https://qpm-git.qualcomm.com/home2/git/qualcomm/qualcomm-linux-spf-1-0_hlos_oem_metadata.git -b <meta-qcom-extras release tag> --depth 1
        # Example, <meta-qcom-extras release tag> is r1.0_00130.0
        mkdir -p layers/meta-qcom-extras
        cp -rf qualcomm-linux-spf-1-0_hlos_oem_metadata/<product>/common/config/meta-qcom-extras/* layers/meta-qcom-extras/
        # An example <product> is QCM6490.LE.1.0. For more information about <product>, see the latest Release Notes (https://docs.qualcomm.com/doc/80-70030-300/).
        Copy to clipboard
2. Set up the Yocto build:

# Export additional meta layers to EXTRALAYERS. Location is assumed under <WORKSPACE DIR>/layers.
        export EXTRALAYERS="meta-qcom-extras"
        
        # CUST_ID is used to clone the proprietary source repositories downloaded by meta-qcom-extras.
        # It allows source compilation for the corresponding binaries present in meta-qcom-hwe.
        # CUST_ID must be set to "213195" for no-modem based distributions ("qualcomm-linux-spf-1-0_ap_standard_oem_nomodem",
        # "qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk", "qualcomm-linux-spf-1-0_ap_standard_oem_nm-qirpsdk").
        # For other modem based distributions, CUST_ID must be set based on the "Customer ID".
        # To find "Customer ID", sign in to your account at qualcomm.com.
        # Click the Profile icon, select Account Settings, and then scroll down to the Company Information section.
        # export CUST_ID using the following command.
        export CUST_ID=<Customer ID>
        
        # The firmware recipe is compiled when the Yocto build is initiated. Firmware recipe expects the
        # path of firmware. You have generated firmware prebuilts (boot-critical and split-firmware binaries)
        # using the steps described in the previous section.
        # Example, for QCM6490, the directory path must contain QCM6490_bootbinaries.zip, QCM6490_dspso.zip, and QCM6490_fw.zip.
        # Set the environment variable to pick up the prebuilts:
        export FWZIP_PATH="<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/<product>/common/build/ufs/bin"
        # An example <product> is QCM6490.LE.1.0. For more information about <product>, see the latest Release Notes (https://docs.qualcomm.com/doc/80-70030-300/).
        Copy to clipboard
3. Set up the build environment:

MACHINE=<machine> DISTRO=qcom-wayland QCOM_SELECTED_BSP=custom source setup-environment
        # Example, MACHINE=qcs6490-rb3gen2-vision-kit DISTRO=qcom-wayland QCOM_SELECTED_BSP=custom source setup-environment
        # source setup-environment: Sets the environment, creates the build directory build-qcom-wayland,
        # and enters into build-qcom-wayland directory.
        Copy to clipboard

    To know the `MACHINE` parameter values, see [Release Notes](https://docs.qualcomm.com/doc/80-70030-300/).
4. Compile the Yocto build:

bitbake qcom-multimedia-image
        Copy to clipboard

Note

Clean the Yocto build:

bitbake -fc cleansstate qcom-multimedia-image
        bitbake -fc cleanall qcom-multimedia-image
        Copy to clipboard
5. After a successful build, check that the `system.img` file is in the `<workspace_path>/build-qcom-wayland/tmp-glibc/deploy/images/qcs6490-rb3gen2-vision-kit/qcom-multimedia-image` directory:

cd <workspace_path>/build-qcom-wayland/tmp-glibc/deploy/images/qcs6490-rb3gen2-vision-kit/qcom-multimedia-image
        ls -al system.img
        Copy to clipboard
6. Flash the generated build using [Flash software images](https://docs.qualcomm.com/doc/80-70030-254/topic/flash_images.html).

### Build Qualcomm IM SDK image with extras

The Qualcomm IM SDK is a collection of four standalone function SDKs: Qualcomm IM SDK, Qualcomm Neural Processing SDK, Qualcomm AI Engine direct SDK, and LiteRT. This SDK also includes reference applications that you can use to develop use cases. The `meta-qcom-extras` layer enables source compilation of select components, which are otherwise present as binary. For more details, see [Qualcomm IM SDK quickstart](https://docs.qualcomm.com/bundle/publicresource/topics/80-70030-51).

1. Download the Qualcomm IM SDK layers, Qualcomm Yocto layer, and the supporting layers with extras. For the `<manifest release tag>` and `<meta-qcom-extras release tag>` information, see the section *Build-critical release tags* in the [Release Notes](https://docs.qualcomm.com/doc/80-70030-300/).

# cd to directory where you have 300 GB of free storage space to create your workspaces
        mkdir <WORKSPACE_DIR>
        cd <WORKSPACE_DIR>
        repo init -u https://github.com/quic-yocto/qcom-manifest -b qcom-linux-scarthgap -m <manifest release tag>
        # Example, <manifest release tag> is qcom-6.6.136-QLI.1.9-Ver.1.1.xml
        repo sync
        git clone https://qpm-git.qualcomm.com/home2/git/qualcomm/qualcomm-linux-spf-1-0_hlos_oem_metadata.git -b <meta-qcom-extras release tag> --depth 1
        # Example, <meta-qcom-extras release tag> is r1.0_00130.0
        mkdir -p layers/meta-qcom-extras
        cp -rf qualcomm-linux-spf-1-0_hlos_oem_metadata/<product>/common/config/meta-qcom-extras/* layers/meta-qcom-extras/
        # An example <product> is QCM6490.LE.1.0. For more information about <product>, see the latest Release Notes (https://docs.qualcomm.com/doc/80-70030-300/).
        git clone https://github.com/quic-yocto/meta-qcom-qim-product-sdk -b qcom-6.6.136-QLI.1.9-Ver.1.1_qim-product-sdk-2.4.1 layers/meta-qcom-qim-product-sdk
        Copy to clipboard
2. Set up the Yocto build:

# Export additional meta layers to EXTRALAYERS. Location is assumed under <WORKSPACE DIR>/layers.
        export EXTRALAYERS="meta-qcom-extras meta-qcom-qim-product-sdk"
        
        # CUST_ID is used to clone the proprietary source repositories downloaded by meta-qcom-extras.
        # It allows source compilation for the corresponding binaries present in meta-qcom-hwe.
        # CUST_ID must be set to "213195" for no-modem based distributions ("qualcomm-linux-spf-1-0_ap_standard_oem_nomodem",
        # "qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk", "qualcomm-linux-spf-1-0_ap_standard_oem_nm-qirpsdk").
        # For other modem based distributions, CUST_ID must be set based on the "Customer ID".
        # To find "Customer ID", sign in to your account at qualcomm.com.
        # Click the Profile icon, select Account Settings, and then scroll down to the Company Information section.
        # export CUST_ID using the following command.
        export CUST_ID=<Customer ID>
        
        # The firmware recipe is compiled when the Yocto build is initiated. Firmware recipe expects the
        # path of firmware. You have generated firmware prebuilts (boot-critical and split-firmware binaries)
        # using the steps described in the previous section.
        # Example, for QCM6490, the directory path must contain QCM6490_bootbinaries.zip, QCM6490_dspso.zip, and QCM6490_fw.zip.
        # Set the environment variable to pick up the prebuilts:
        export FWZIP_PATH="<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk/<product>/common/build/ufs/bin"
        # An example <product> is QCM6490.LE.1.0. For more information about <product>, see the latest Release Notes (https://docs.qualcomm.com/doc/80-70030-300/).
        Copy to clipboard
3. Set up the build environment:

MACHINE=<machine> DISTRO=qcom-wayland QCOM_SELECTED_BSP=custom source setup-environment
        # Example, MACHINE=qcs6490-rb3gen2-vision-kit DISTRO=qcom-wayland QCOM_SELECTED_BSP=custom source setup-environment
        # source setup-environment: Sets the environment, creates the build directory build-qcom-wayland,
        # and enters into build-qcom-wayland directory.
        Copy to clipboard

    To know the `MACHINE` parameter values, see [Release Notes](https://docs.qualcomm.com/doc/80-70030-300/).
4. Compile the Qualcomm IM SDK build:

bitbake qcom-multimedia-image
        # Build SDK image
        bitbake qcom-qim-product-sdk
        Copy to clipboard
5. Clean the Qualcomm IM SDK build:

bitbake -fc cleansstate qcom-multimedia-image
        bitbake -fc cleanall qcom-multimedia-image
        bitbake -fc cleansstate qcom-qim-product-sdk
        bitbake -fc cleanall qcom-qim-product-sdk
        Copy to clipboard
6. After a successful build, check that the `system.img` file is in the `<workspace_path>/build-qcom-wayland/tmp-glibc/deploy/images/qcs6490-rb3gen2-vision-kit/qcom-multimedia-image` directory:

cd <workspace_path>/build-qcom-wayland/tmp-glibc/deploy/images/qcs6490-rb3gen2-vision-kit/qcom-multimedia-image
        ls -al system.img
        Copy to clipboard
7. Flash the generated build using [Flash software images](https://docs.qualcomm.com/doc/80-70030-254/topic/flash_images.html).

### Build QIR SDK image with extras

The QIR SDK 2.0 is a collection of components that let you develop robotic features on Qualcomm Linux releases. The `meta-qcom-extras` layer enables source compilation of select components, which are otherwise available as binaries. For more details, see [QIR SDK 2.0 User Guide](https://docs.qualcomm.com/bundle/publicresource/topics/80-70030-265).

Note

Before you begin, clone the respective firmware for QIR SDK, for example, `qualcomm-linux-spf-1-0_ap_standard_oem_nm-qirpsdk`.

1. Download QIR SDK layers, Qualcomm Yocto, and supporting layers with extras. For the `<manifest release tag>`, `<meta-qcom-extras release tag>`, and `<meta-qcom-qim-product-sdk release tag>` information, see the section *Build-critical release tags* in the [Release Notes](https://docs.qualcomm.com/doc/80-70030-300/).

# cd to directory where you have 300 GB of free storage space to create your workspaces
        mkdir <WORKSPACE_DIR>
        cd <WORKSPACE_DIR>
        repo init -u https://github.com/quic-yocto/qcom-manifest -b qcom-linux-scarthgap -m <manifest release tag>
        # Example, <manifest release tag> is qcom-6.6.136-QLI.1.9-Ver.1.1.xml
        repo sync
        git clone https://qpm-git.qualcomm.com/home2/git/qualcomm/qualcomm-linux-spf-1-0_hlos_oem_metadata.git -b <meta-qcom-extras release tag> --depth 1
        # Example, <meta-qcom-extras release tag> is r1.0_00130.0
        mkdir -p layers/meta-qcom-extras
        mkdir -p layers/meta-qcom-robotics-extras
        cp -rf qualcomm-linux-spf-1-0_hlos_oem_metadata/<product>/common/config/meta-qcom-extras/* layers/meta-qcom-extras/
        cp -rf qualcomm-linux-spf-1-0_hlos_oem_metadata/<product>/common/config/meta-qcom-robotics-extras/* layers/meta-qcom-robotics-extras/
        # An example <product> is QCM6490.LE.1.0. For more information about <product>, see the latest Release Notes (https://docs.qualcomm.com/doc/80-70030-300/).
        
        git clone https://github.com/ros/meta-ros -b scarthgap layers/meta-ros && cd layers/meta-ros && git checkout c560699e810e60a9526f4226c2c23f8d877280c8 && cd ../../
        git clone https://github.com/quic-yocto/meta-qcom-robotics.git -b qcom-6.6.136-QLI.1.9-Ver.1.1_robotics-sdk-1.1 layers/meta-qcom-robotics
        git clone https://github.com/quic-yocto/meta-qcom-robotics-distro.git -b qcom-6.6.136-QLI.1.9-Ver.1.1_robotics-sdk-1.1 layers/meta-qcom-robotics-distro
        git clone https://github.com/quic-yocto/meta-qcom-robotics-sdk.git -b qcom-6.6.136-QLI.1.9-Ver.1.1_robotics-sdk-1.1 layers/meta-qcom-robotics-sdk
        git clone https://github.com/quic-yocto/meta-qcom-qim-product-sdk -b qcom-6.6.136-QLI.1.9-Ver.1.1_qim-product-sdk-2.4.1 layers/meta-qcom-qim-product-sdk
        # Example, <meta-qcom-qim-product-sdk release tag> is qcom-6.6.136-QLI.1.9-Ver.1.1_qim-product-sdk-2.4.1
        Copy to clipboard
2. Set up the Yocto build:

# Export additional meta layers to EXTRALAYERS. Location is assumed under <WORKSPACE DIR>/layers.
        export EXTRALAYERS="meta-qcom-extras meta-qcom-robotics-extras"
        
        # CUST_ID is used to clone the proprietary source repositories downloaded by meta-qcom-extras.
        # It allows source compilation for the corresponding binaries present in meta-qcom-hwe.
        # CUST_ID must be set to "213195" for no-modem based distributions ("qualcomm-linux-spf-1-0_ap_standard_oem_nomodem",
        # "qualcomm-linux-spf-1-0_ap_standard_oem_nm-qimpsdk", "qualcomm-linux-spf-1-0_ap_standard_oem_nm-qirpsdk").
        # For other modem based distributions, CUST_ID must be set based on the "Customer ID".
        # To find "Customer ID", sign in to your account at qualcomm.com.
        # Click the Profile icon, select Account Settings, and then scroll down to the Company Information section.
        # export CUST_ID using the following command.
        export CUST_ID=<Customer ID>
        
        # The firmware recipe is compiled when the Yocto build is initiated. Firmware recipe expects the
        # path of firmware. You have generated firmware prebuilts (boot-critical and split-firmware binaries)
        # using the steps described in the previous section.
        # Example, for QCM6490, the directory path must contain QCM6490_bootbinaries.zip, QCM6490_dspso.zip, and QCM6490_fw.zip.
        # Set the environment variable to pick up the prebuilts:
        export FWZIP_PATH="<FIRMWARE_ROOT>/qualcomm-linux-spf-1-0_ap_standard_oem_nm-qirpsdk/<product>/common/build/ufs/bin"
        # An example <product> is QCM6490.LE.1.0. For more information about <product>, see the latest Release Notes (https://docs.qualcomm.com/doc/80-70030-300/).
        Copy to clipboard
3. Compile the QIR SDK build:

ln -s layers/meta-qcom-robotics-distro/set_bb_env.sh ./setup-robotics-environment
        ln -s layers/meta-qcom-robotics-sdk/scripts/qirp-build ./qirp-build
        MACHINE=<machine> DISTRO=qcom-robotics-ros2-jazzy QCOM_SELECTED_BSP=custom source setup-robotics-environment
        # Example, MACHINE=qcs6490-rb3gen2-vision-kit DISTRO=qcom-robotics-ros2-jazzy QCOM_SELECTED_BSP=custom source setup-robotics-environment
        # source setup-robotics-environment: Sets the environment, creates the build directory build-qcom-robotics-ros2-jazzy,
        # and enters into build-qcom-robotics-ros2-jazzy directory.
        ../qirp-build qcom-robotics-full-image
        Copy to clipboard

    To know the `MACHINE` parameter values, see [Release Notes](https://docs.qualcomm.com/doc/80-70030-300/).
4. After a successful build, check that the QIR SDK build artifacts are at the following paths:

QIR SDK artifacts: <workspace_path>/build-qcom-robotics-ros2-jazzy/tmp-glibc/deploy/qirpsdk_artifacts/qirp-sdk_<version>.tar.gz
        # system.img is present in the following path
        Robotics image: <workspace_path>/build-qcom-robotics-ros2-jazzy/tmp-glibc/deploy/images/qcs6490-rb3gen2-vision-kit/qcom-robotics-full-image
        Copy to clipboard
5. Flash the generated build using [Flash software images](https://docs.qualcomm.com/doc/80-70030-254/topic/flash_images.html).

## Next steps

- [Connect to UART shell](https://docs.qualcomm.com/doc/80-70030-254/topic/how_to.html#connect-uart)
- [Connect to network](https://docs.qualcomm.com/doc/80-70030-254/topic/how_to.html#connect-to-network)
- [Sign in using SSH](https://docs.qualcomm.com/doc/80-70030-254/topic/how_to.html#use-ssh)
- [Troubleshoot sync, build, and flash issues](https://docs.qualcomm.com/doc/80-70030-254/topic/troubleshoot_sync_build_and_flash.html#troubleshoot-sync-build-and-flash)

Last Published: Jul 23, 2026

[Previous Topic
Build with GitHub for registered users](https://docs.qualcomm.com/bundle/publicresource/80-70030-254/topics/build_from_source_github_intro.md) [Next Topic
Flash software images](https://docs.qualcomm.com/bundle/publicresource/80-70030-254/topics/flash_images.md)

Source: [https://docs.qualcomm.com/doc/80-70030-254/topic/build_addn_info.html](https://docs.qualcomm.com/doc/80-70030-254/topic/build_addn_info.html)