> ## Documentation Index
> Fetch the complete documentation index at: https://dragonwingdocs.qualcomm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Qualcomm Linux Yocto overview

This guide provides information about how Qualcomm Linux uses Yocto to build an embedded system software image for Qualcomm reference hardware.

## **Quick start: do you need a custom build?**

Before diving into the Yocto build workflow, consider which path is right for you:

* **Just want to get started quickly?** Qualcomm provides prebuilt, ready-to-flash images that you can download and flash onto your device without setting up a build environment. See [Flash Prebuilt Images](./flash-prebuilt-images).

* **Need to customize?** If you want to add additional packages, modify default settings, adapt to custom hardware, add or remove applications, or integrate your own software, then this guide — and the full Yocto build workflow — is for you. Continue reading below.

## **What this guide covers**

This guide explains the Yocto-based platform framework for Qualcomm Linux. It covers:

* Yocto concepts and the Qualcomm layer stack
* Metadata layers maintained by Qualcomm
* Machine, distribution, and image configuration
* Build environment setup and the `kas` configuration model
* Kernel integration within Yocto
* Firmware and boot integration
* Secure boot and image signing
* Storage, partitions, and layout
* Containers, virtualization, and OTA updates
* Customization workflows
* Debugging Yocto builds

## **What this guide does not cover**

* Kernel development and debugging — see the [Qualcomm Linux Kernel Guide](https://dragonwingdocs.qualcomm.com/System/Kernel/kernel-overview)
* Device flashing — see the [Qualcomm Linux Boot Guide](https://dragonwingdocs.qualcomm.com/System/Boot/boot-overview)

## **How this guide fits in**

The Qualcomm Linux documentation set is organized around three complementary guides:

| **Guide**                                                                         | **Focus**                                                                |
| --------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| **Yocto Guide** (this guide)                                                      | Platform framework: layers, machines, distros, images, and customization |
| [Kernel Guide](https://dragonwingdocs.qualcomm.com/System/Kernel/kernel-overview) | Kernel development, configuration, device tree, and debugging            |

## **Target personas**

| **Persona**                | **Starting point**                                                                                                                                                                                               |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Beginner / Integrator      | Start with [Yocto Concepts for Qualcomm Linux](./qualcomm-linux-yocto-documentation) and [Build Qualcomm Linux Using Yocto](./build-qualcomm-linux)                                                              |
| BSP Engineer               | Focus on [Qualcomm Linux Metadata Layers](./qualcomm-linux-metadata-layers), [Machines & Hardware Support](./add-custom-machine-configurations), and [Kernel Integration in Yocto](./customizing-kernel)         |
| Advanced Platform Engineer | See [Secure Boot & Image Signing](./configure-and-secure-boot-with-systemd-boot-and-uki), [Containers, Virtualization & OTA](./run-docker-containers), and [Customization Workflows](./customize-qualcomm-linux) |

## **Qualcomm Linux release**

The Qualcomm Linux release and this documentation are built on the principles of the Yocto Project to help you further customize Qualcomm Linux. Qualcomm Linux 2.0 is based on the Yocto master branch.

Qualcomm Linux offers two reference images:

* The `qcom-multimedia-image` includes upstream software components, and the kernel from [https://github.com/qualcomm-linux/kernel](https://github.com/qualcomm-linux/kernel) `qcom-6.18.y`.
* The `qcom-multimedia-proprietary-image` includes Qualcomm value-added software, and the kernel from [https://github.com/qualcomm-linux/kernel](https://github.com/qualcomm-linux/kernel) `qcom-6.18.y`.

## **Next steps**

* The machine configurations defined in [meta-qcom](./meta-qcom) are mapped to the [development kits](https://www.qualcomm.com/developer/software/qualcomm-linux/hardware).
* To find the mapping of machine configurations to a development kit, see Sections of the [Qualcomm Linux Release Notes](https://dragonwingdocs.qualcomm.com/Key-Documents/Software-Release-Notes/introduction).
* See [Hardware SoCs](https://docs.qualcomm.com/bundle/publicresource/topics/80-80021-115/soc.html) that are supported on Qualcomm Linux.
