# Yocto Project Quick Start

&COPYRIGHT_YEAR;
Linux Foundation

Permission is granted to copy, distribute and/or modify this document under the terms of the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales as published by Creative Commons.

For the latest version of this manual associated with this Yocto Project release, see the Yocto Project Quick Start from the Yocto Project website.

## Welcome!

Welcome to the Yocto Project! The Yocto Project is an open-source collaboration project focused on embedded Linux developers. Among other things, the Yocto Project uses a build system based on the Poky project to construct complete Linux images. The Poky project, in turn, draws from and contributes back to the OpenEmbedded project.

If you don't have a system that runs Linux and you want to give the Yocto Project a test run, you might consider using the Yocto Project Build Appliance. The Build Appliance allows you to build and boot a custom embedded Linux image with the Yocto Project using a non-Linux development system. See the Yocto Project Build Appliance for more information.

On the other hand, if you know all about open-source development, Linux development environments, Git source repositories and the like and you just want some quick information that lets you try out the Yocto Project on your Linux system, skip right to the "Super User" section at the end of this quick start.

For the rest of you, this short document will give you some basic information about the environment and let you experience it in its simplest form. After reading this document, you will have a basic understanding of what the Yocto Project is and how to use some of its core components. This document steps you through a simple example showing you how to build a small image and run it using the Quick EMUlator (QEMU emulator).

For more detailed information on the Yocto Project, you should check out these resources:

- Website: The Yocto Project Website provides the latest builds, breaking news, full development documentation, and a rich Yocto Project Development Community into which you can tap.

- FAQs: Lists commonly asked Yocto Project questions and answers. You can find two FAQs: Yocto Project FAQ on a wiki, and the "FAQ" chapter in the Yocto Project Reference Manual.

- Developer Screencast: The Getting Started with the Yocto Project - New Developer Screencast Tutorial provides a 30-minute video for the user new to the Yocto Project but familiar with Linux build systems.

## Introducing the Yocto Project Development Environment

The Yocto Project through the OpenEmbedded build system provides an open source development environment targeting the ARM, MIPS, PowerPC and x86 architectures for a variety of platforms including x86-64 and emulated ones. You can use components from the Yocto Project to design, develop, build, debug, simulate, and test the complete software stack using Linux, the X Window System, GNOME Mobile-based application frameworks, and Qt frameworks.

The Yocto Project Development Environment

Here are some highlights for the Yocto Project:

- Provides a recent Linux kernel along with a set of system commands and libraries suitable for the embedded environment.

- Makes available system components such as X11, GTK+, Qt, Clutter, and SDL (among others) so you can create a rich user experience on devices that have display hardware. For devices that don't have a display or where you wish to use alternative UI frameworks, these components need not be installed.

- Creates a focused and stable core compatible with the OpenEmbedded project with which you can easily and reliably build and develop.

- Fully supports a wide range of hardware and device emulation through the QEMU Emulator.

The Yocto Project can generate images for many kinds of devices. However, the standard example machines target QEMU full-system emulation for x86, x86-64, ARM, MIPS, and PPC-based architectures as well as specific hardware such as the Intel Desktop Board DH55TC. Because an image developed with the Yocto Project can boot inside a QEMU emulator, the development environment works nicely as a test platform for developing embedded software.

Another important Yocto Project feature is the Sato reference User Interface. This optional GNOME mobile-based UI, which is intended for devices with restricted screen sizes, sits neatly on top of a device using the GNOME Mobile Stack and provides a well-defined user experience. Implemented in its own layer, it makes it clear to developers how they can implement their own user interface on top of a Linux image created with the Yocto Project.

## What You Need and How You Get It

You need these things to develop in the Yocto Project environment:

- A host system running a supported Linux distribution (i.e. recent releases of Fedora, openSUSE, CentOS, Debian, and Ubuntu). If the host system supports multiple cores and threads, you can configure the Yocto Project build system to decrease the time needed to build images significantly.

- The right packages.

- A release of the Yocto Project.

### The Linux Distribution

The Yocto Project team is continually verifying more and more Linux distributions with each release. In general, if you have the current release minus one of the following distributions you should have no problems.

- Ubuntu

- Fedora

- openSUSE

- CentOS

- Debian

For a more detailed list of distributions that support the Yocto Project, see the "Supported Linux Distributions" section in the Yocto Project Reference Manual.

The OpenEmbedded build system should be able to run on any modern distribution that has the following versions for Git, tar, and Python.

- Git 1.7.5 or greater

- tar 1.24 or greater

- Python 2.7.3 or greater excluding Python 3.x, which is not supported.

Earlier releases of Python are known to not work and the system does not support Python 3 at this time. If your system does not meet any of these three listed version requirements, you can take steps to prepare the system so that you can still use the build system. See the "Required Git, tar, and Python Versions" section in the Yocto Project Reference Manual for information.

This document assumes you are running one of the previously noted distributions on your Linux-based host systems.

If you attempt to use a distribution not in the above list, you may or may not have success. Yocto Project releases are tested against the stable Linux distributions listed in the "Supported Linux Distributions" section of the Yocto Project Reference Manual. If you encounter problems, please go to Yocto Project Bugzilla and submit a bug. We are interested in hearing about your experience.

### The Packages

Packages and package installation vary depending on your development system and on your intent. For example, if you want to build an image that can run on QEMU in graphical mode (a minimal, basic build requirement), then the number of packages is different than if you want to build an image on a headless system or build out the Yocto Project documentation set. Collectively, the number of required packages is large if you want to be able to cover all cases.

In general, you need to have root access and then install the required packages. Thus, the commands in the following section may or may not work depending on whether or not your Linux distribution has `sudo` installed.

The next few sections list, by supported Linux Distributions, the required packages needed to build an image that runs on QEMU in graphical mode (e.g. essential plus graphics support).

For lists of required packages for other scenarios, see the "Required Packages for the Host Development System" section in the Yocto Project Reference Manual.

#### Ubuntu and Debian

The essential and graphical support packages you need for a supported Ubuntu or Debian distribution are shown in the following command:

         $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; libsdl1.2-dev xterm

#### Fedora

The essential and graphical packages you need for a supported Fedora distribution are shown in the following command:

         $ sudo yum install &FEDORA_HOST_PACKAGES_ESSENTIAL; SDL-devel xterm

#### OpenSUSE

The essential and graphical packages you need for a supported OpenSUSE distribution are shown in the following command:

         $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; libSDL-devel xterm

#### CentOS

The essential and graphical packages you need for a supported CentOS distribution are shown in the following command:

         $ sudo yum install &CENTOS_HOST_PACKAGES_ESSENTIAL; SDL-devel xterm

Depending on the CentOS version you are using, other requirements and dependencies might exist. For details, you should look at the CentOS sections on the Poky/GettingStarted/Dependencies wiki page.

### Yocto Project Release

You can download the latest Yocto Project release by going to the Yocto Project website clicking "Downloads" in the navigation pane to the left to view all available Yocto Project releases. Current and archived releases are available for download to the right. Nightly and developmental builds are also maintained at . However, for this document a released version of Yocto Project is used.

You can also get the Yocto Project files you need by setting up (cloning in Git terms) a local copy of the `poky` Git repository on your host development system. Doing so allows you to contribute back to the Yocto Project project. For information on how to get set up using this method, see the "Yocto Project Release" item in the Yocto Project Development Manual.

## A Quick Test Run

Now that you have your system requirements in order, you can give the Yocto Project a try. This section presents some steps that let you do the following:

- Build an image and run it in the QEMU emulator

- Use a pre-built image and run it in the QEMU emulator

### Building an Image

In the development environment you will need to build an image whenever you change hardware support, add or change system libraries, or add or change services that have dependencies.

Building an Image

Use the following commands to build your image. The OpenEmbedded build process creates an entire Linux distribution, including the toolchain, from source.

The build process using Sato currently consumes about 50GB of disk space. To allow for variations in the build process and for future package expansion, we recommend having at least 100GB of free disk space.

By default, the build process searches for source code using a pre-determined order through a set of locations. If you encounter problems with the build process finding and downloading source code, see the "How does the OpenEmbedded build system obtain source code and will it work behind my firewall or proxy server?" in the Yocto Project Reference Manual.

         $ wget &YOCTO_POKY_DL_URL;
         $ tar xjf &YOCTO_POKY;.tar.bz2
         $ cd &YOCTO_POKY;
         $ source &OE_INIT_FILE;

To help conserve disk space during builds, you can add the following statement to your project's configuration file, which for this example is `&YOCTO_POKY;/build/conf/local.conf`. Adding this statement deletes the work directory used for building a package once the package is built.

         INHERIT += "rm_work"

- In the previous example, the first command retrieves the Yocto Project release tarball from the source repositories using the `wget` command. Alternatively, you can go to the Yocto Project website's "Downloads" page to retrieve the tarball.

- The second command extracts the files from the tarball and places them into a directory named `&YOCTO_POKY;` in the current directory.

- The third and fourth commands change the working directory to the Source Directory and run the Yocto Project `&OE_INIT_FILE;` environment setup script. Running this script defines OpenEmbedded build environment settings needed to complete the build. The script also creates the Build Directory, which is `build` in this case and is located in the Source Directory. After the script runs, your current working directory is set to the Build Directory. Later, when the build completes, the Build Directory contains all the files created during the build.

  For information on running a memory-resident BitBake, see the `oe-init-build-env-memres` setup script.

Take some time to examine your `local.conf` file in your project's configuration directory, which is found in the Build Directory. The defaults in that file should work fine. However, there are some variables of interest at which you might look.

By default, the target architecture for the build is `qemux86`, which produces an image that can be used in the QEMU emulator and is targeted at an Intel 32-bit based architecture. To change this default, edit the value of the `MACHINE` variable in the configuration file before launching the build.

Another couple of variables of interest are the `BB_NUMBER_THREADS` and the `PARALLEL_MAKE` variables. By default, these variables are commented out. However, if you have a multi-core CPU you might want to uncomment the lines and set both variables equal to twice the number of your host's processor cores. Setting these variables can significantly shorten your build time.

Another consideration before you build is the package manager used when creating the image. By default, the OpenEmbedded build system uses the RPM package manager. You can control this configuration by using the ``PACKAGE_CLASSES`` variable. For additional package manager selection information, see the "Packaging - `package*.bbclass`" section in the Yocto Project Reference Manual.

Continue with the following command to build an OS image for the target, which is `core-image-sato` in this example. For information on the `-k` option use the `bitbake --help` command or see the "BitBake" section in the Yocto Project Reference Manual.

         $ bitbake -k core-image-sato

BitBake requires Python 2.6 or 2.7. For more information on this requirement, see the FAQ in the Yocto Project Reference Manual.

The final command runs the image:

         $ runqemu qemux86

Depending on the number of processors and cores, the amount or RAM, the speed of your Internet connection and other factors, the build process could take several hours the first time you run it. Subsequent builds run much faster since parts of the build are cached.

### Using Pre-Built Binaries and QEMU

If hardware, libraries and services are stable, you can get started by using a pre-built binary of the filesystem image, kernel, and toolchain and run it using the QEMU emulator. This scenario is useful for developing application software.

Using a Pre-Built Image

For this scenario, you need to do several things:

- Install the appropriate stand-alone toolchain tarball.

- Download the pre-built image that will boot with QEMU. You need to be sure to get the QEMU image that matches your target machine’s architecture (e.g. x86, ARM, etc.).

- Download the filesystem image for your target machine's architecture.

- Set up the environment to emulate the hardware and then start the QEMU emulator.

#### Installing the Toolchain

You can download a tarball installer, which includes the pre-built toolchain, the `runqemu` script, and support files from the appropriate directory under . Toolchains are available for 32-bit and 64-bit x86 development systems from the `i686` and `x86_64` directories, respectively. The toolchains the Yocto Project provides are based off the `core-image-sato` image and contain libraries appropriate for developing against that image. Each type of development system supports five or more target architectures.

The names of the tarball installer scripts are such that a string representing the host system appears first in the filename and then is immediately followed by a string that represents the target architecture.

         poky-eglibc-<host_system>-<image_type>-<arch>-toolchain-<release_version>.sh

         Where:
             <host_system> is a string representing your development system:

                        i686 or x86_64.

             <image_type> is a string representing the image you wish to
                    develop a Software Development Toolkit (SDK) for use against.
                    The Yocto Project builds toolchain installers using the
                    following BitBake command:

                        bitbake core-image-sato -c do_populatesdk core-image-sato

             <arch> is a string representing the tuned target architecture:

                        i586, x86_64, powerpc, mips, armv7a or armv5te

             <release_version> is a string representing the release number of the
                    Yocto Project:

                        &DISTRO;, &DISTRO;+snapshot

For example, the following toolchain installer is for a 64-bit development host system and a i586-tuned target architecture based off the SDK for `core-image-sato`:

         poky-eglibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh

Toolchains are self-contained and by default are installed into `/opt/poky`. However, when you run the toolchain installer, you can choose an installation directory.

The following command shows how to run the installer given a toolchain tarball for a 64-bit x86 development host system and a 32-bit x86 target architecture. You must change the permissions on the toolchain installer script so that it is executable.

The example assumes the toolchain installer is located in `~/Downloads/`.

If you do not have write permissions for the directory into which you are installing the toolchain, the toolchain installer notifies you and exits. Be sure you have write permissions in the directory and run the installer again.

         $ ~/Downloads/poky-eglibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh

For more information on how to install tarballs, see the "Using a Cross-Toolchain Tarball" and "Using BitBake and the Build Directory" sections in the Yocto Project Application Developer's Guide.

#### Downloading the Pre-Built Linux Kernel

You can download the pre-built Linux kernel suitable for running in the QEMU emulator from . Be sure to use the kernel that matches the architecture you want to simulate. Download areas exist for the five supported machine architectures: `qemuarm`, `qemumips`, `qemuppc`, `qemux86`, and `qemux86-64`.

Most kernel files have one of the following forms:

         *zImage-qemu<arch>.bin
         vmlinux-qemu<arch>.bin

         Where:
             <arch> is a string representing the target architecture:
                    x86, x86-64, ppc, mips, or arm.

You can learn more about downloading a Yocto Project kernel in the "Yocto Project Kernel" bulleted item in the Yocto Project Development Manual.

#### Downloading the Filesystem

You can also download the filesystem image suitable for your target architecture from . Again, be sure to use the filesystem that matches the architecture you want to simulate.

The filesystem image has two tarball forms: `ext3` and `tar`. You must use the `ext3` form when booting an image using the QEMU emulator. The `tar` form can be flattened out in your host development system and used for build purposes with the Yocto Project.

         core-image-<profile>-qemu<arch>.ext3
         core-image-<profile>-qemu<arch>.tar.bz2

         Where:
             <profile> is the filesystem image's profile:
                       lsb, lsb-dev, lsb-sdk, lsb-qt3, minimal, minimal-dev, sato,
                       sato-dev, or sato-sdk. For information on these types of image
                       profiles, see the "Images" chapter in the Yocto Project
                       Reference Manual.

             <arch> is a string representing the target architecture:
                    x86, x86-64, ppc, mips, or arm.

#### Setting Up the Environment and Starting the QEMU Emulator

Before you start the QEMU emulator, you need to set up the emulation environment. The following command form sets up the emulation environment.

         $ source &YOCTO_ADTPATH_DIR;/environment-setup-<arch>-poky-linux-<if>

         Where:
             <arch> is a string representing the target architecture:
                    i586, x86_64, ppc603e, mips, or armv5te.

             <if> is a string representing an embedded application binary interface.
                  Not all setup scripts include this string.

Finally, this command form invokes the QEMU emulator

         $ runqemu <qemuarch> <kernel-image> <filesystem-image>

         Where:
             <qemuarch> is a string representing the target architecture: qemux86, qemux86-64,
                        qemuppc, qemumips, or qemuarm.

             <kernel-image> is the architecture-specific kernel image.

             <filesystem-image> is the .ext3 filesystem image.

Continuing with the example, the following two commands setup the emulation environment and launch QEMU. This example assumes the root filesystem (`.ext3` file) and the pre-built kernel image file both reside in your home directory. The kernel and filesystem are for a 32-bit target architecture.

         $ cd $HOME
         $ source &YOCTO_ADTPATH_DIR;/environment-setup-i586-poky-linux
         $ runqemu qemux86 bzImage-qemux86.bin \
         core-image-sato-qemux86.ext3

The environment in which QEMU launches varies depending on the filesystem image and on the target architecture. For example, if you source the environment for the ARM target architecture and then boot the minimal QEMU image, the emulator comes up in a new shell in command-line mode. However, if you boot the SDK image, QEMU comes up with a GUI.

Booting the PPC image results in QEMU launching in the same shell in command-line mode.

## Super User

This section Kudos and thanks to Robert P. J. Day of CrashCourse for providing the basis for this "expert" section with information from one of his wiki pages. gives you a minimal description of how to use the Yocto Project to build images for a BeagleBoard xM starting from scratch. The steps were performed on a 64-bit Ubuntu 10.04 system.

### Getting the Yocto Project

Set up your Source Directory one of two ways:

- Tarball: Use if you want the latest stable release:

           $ wget &YOCTO_RELEASE_DL_URL;/&YOCTO_POKY_TARBALL;
           $ tar xvjf &YOCTO_POKY_TARBALL;

- Git Repository: Use if you want to work with cutting edge development content:

           $ git clone git://git.yoctoproject.org/poky

The remainder of the section assumes the Git repository method.

### Setting Up Your Host

You need some packages for everything to work. Rather than duplicate them here, look at the "The Packages" section earlier in this quick start.

### Initializing the Build Environment

From the parent directory your Source Directory, initialize your environment and provide a meaningful Build Directory name:

         $ source poky/&OE_INIT_FILE; mybuilds

At this point, the `mybuilds` directory has been created for you and it is now your current working directory. If you don't provide your own directory name it defaults to `build`, which is inside the Source Directory.

### Configuring the local.conf File

Initializing the build environment creates a `conf/local.conf` configuration file in the Build Directory. You need to manually edit this file to specify the machine you are building and to optimize your build time. Here are the minimal changes to make:

         BB_NUMBER_THREADS = "8"
         PARALLEL_MAKE = "-j 8"
         MACHINE ?= "beagleboard"

Briefly, set `BB_NUMBER_THREADS` and `PARALLEL_MAKE` to twice your host processor's number of cores.

A good deal that goes into a Yocto Project build is simply downloading all of the source tarballs. Maybe you have been working with another build system (OpenEmbedded or Angstrom) for which you have built up a sizable directory of source tarballs. Or, perhaps someone else has such a directory for which you have read access. If so, you can save time by adding statements to your configuration file so that the build process checks local directories first for existing tarballs before checking the Internet. Here is an efficient way to set it up in your `local.conf` file:

         SOURCE_MIRROR_URL ?= "file:///home/you/your-download-dir/"
         INHERIT += "own-mirrors"
         BB_GENERATE_MIRROR_TARBALLS = "1"
         # BB_NO_NETWORK = "1"

In the previous example, the `BB_GENERATE_MIRROR_TARBALLS` variable causes the OpenEmbedded build system to generate tarballs of the Git repositories and store them in the `DL_DIR` directory. Due to performance reasons, generating and storing these tarballs is not the build system's default behavior.

You can also use the `PREMIRRORS` variable. For an example, see the variable's glossary entry in the Yocto Project Reference Manual.

### Building the Image

At this point, you need to select an image to build for the BeagleBoard xM. If this is your first build using the Yocto Project, you should try the smallest and simplest image:

         $ bitbake core-image-minimal

Now you just wait for the build to finish.

Here are some variations on the build process that could be helpful:

- Fetch all the necessary sources without starting the build:

           $ bitbake -c fetchall core-image-minimal

  This variation guarantees that you have all the sources for that BitBake target should you disconnect from the net and want to do the build later offline.

- Specify to continue the build even if BitBake encounters an error. By default, BitBake aborts the build when it encounters an error. This command keeps a faulty build going:

           $ bitbake -k core-image-minimal

Once you have your image, you can take steps to load and boot it on the target hardware.