494 lines
21 KiB
XML
494 lines
21 KiB
XML
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||
|
||
<article id='intro'>
|
||
<imagedata fileref="figures/yocto-project-transp.png" width="6in" depth="1in" align="right" scale="25" />
|
||
|
||
<section id='fake-title'>
|
||
<title>Yocto Project Quick Start</title>
|
||
</section>
|
||
|
||
<section id='welcome'>
|
||
<title>Welcome!</title>
|
||
<para>
|
||
Welcome to the Yocto Project!
|
||
The Yocto Project (YP) is an open-source collaboration project focused on embedded Linux
|
||
developers.
|
||
Amongst other things, YP uses the Poky build tool to construct complete Linux images.
|
||
</para>
|
||
<para>
|
||
This short document will give you some basic information about the environment as well
|
||
as 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 QEMU emulator.
|
||
</para>
|
||
<para>
|
||
For complete information on the Yocto Project you should check out the
|
||
<ulink url='http://www.yoctoproject.org'>Yocto Project Website</ulink>.
|
||
You can find the latest builds, breaking news, full development documentation, and a
|
||
rich Yocto Project Development Community into which you can tap.
|
||
</para>
|
||
</section>
|
||
|
||
<section id='yp-intro'>
|
||
<title>Introducing the Yocto Project Development Environment</title>
|
||
<para>
|
||
The Yocto Project through the Poky build tool 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 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.
|
||
</para>
|
||
|
||
<para></para>
|
||
<para></para>
|
||
|
||
<mediaobject>
|
||
<imageobject>
|
||
<imagedata fileref="figures/yocto-environment.png"
|
||
format="PNG" align='center' scalefit='1' width="100%"/>
|
||
</imageobject>
|
||
<caption>
|
||
<para>The Yocto Project Development Environment</para>
|
||
</caption>
|
||
</mediaobject>
|
||
|
||
<para>
|
||
Yocto Project:
|
||
</para>
|
||
|
||
<itemizedlist>
|
||
<listitem>
|
||
<para>Provides a recent Linux kernel along with a set of system commands and libraries suitable for the embedded environment.</para>
|
||
</listitem>
|
||
<listitem>
|
||
<para>Makes available system components such as X11, Matchbox, GTK+, Pimlico, Clutter,
|
||
GuPNP and Qt (among others) so you can create a richer user interface experience on
|
||
devices that use displays or have a GUI.
|
||
For devices that don't have a GUI or display you simply would not employ these
|
||
components.</para>
|
||
</listitem>
|
||
<listitem>
|
||
<para>Creates a focused and stable core compatible with the OpenEmbedded
|
||
project with which you can easily and reliably build and develop.</para>
|
||
</listitem>
|
||
<listitem>
|
||
<para>Fully supports a wide range of hardware and device emulation through the QEMU
|
||
Emulator.</para>
|
||
</listitem>
|
||
</itemizedlist>
|
||
|
||
<para>
|
||
Yocto Project can generate images for many kinds of devices.
|
||
However, the standard example machines target QEMU full system emulation for x86, ARM, MIPS,
|
||
and PPC based architectures as well as specific hardware such as the Intel Desktop Board
|
||
DH55TC.
|
||
Because an image developed with Yocto Project can boot inside a QEMU emulator, the
|
||
development environment works nicely as a test platform for developing embedded software.
|
||
</para>
|
||
|
||
<para>
|
||
Another important Yocto Project feature is the Sato reference User Interface.
|
||
This optional GNOME mobile-based UI, which is intended for devices with
|
||
resolution but restricted size screens, sits neatly on top of a device using the
|
||
GNOME Mobile Stack providing a well defined user experience.
|
||
Implemented in its own layer, it makes it clear to developers how they can implement
|
||
their own UIs on top of Yocto Linux.
|
||
</para>
|
||
</section>
|
||
|
||
<section id='resources'>
|
||
<title>What You Need and How You Get It</title>
|
||
|
||
<para>
|
||
You need these things to develop in the Yocto Project environment:
|
||
</para>
|
||
|
||
<itemizedlist>
|
||
<listitem>
|
||
<para>A host system running a supported Linux distribution (i.e. recent releases of
|
||
Fedora, OpenSUSE, Debian, and Ubuntu).</para>
|
||
</listitem>
|
||
<listitem>
|
||
<para>The right packages.</para>
|
||
</listitem>
|
||
<listitem>
|
||
<para>A release of Yocto Project.</para>
|
||
</listitem>
|
||
</itemizedlist>
|
||
|
||
<section id='the-linux-distro'>
|
||
<title>The Linux Distribution</title>
|
||
|
||
<para>
|
||
This document assumes you are running a reasonably current Linux-based host system.
|
||
The examples work for both Debian-based and RPM-based distributions.
|
||
</para>
|
||
</section>
|
||
|
||
<section id='packages'>
|
||
<title>The Packages</title>
|
||
|
||
<para>
|
||
The packages you need for a Debian-based host are shown in the following command:
|
||
</para>
|
||
|
||
<literallayout class='monospaced'>
|
||
$ sudo apt-get install sed wget cvs subversion git-core coreutils \
|
||
unzip texi2html texinfo libsdl1.2-dev docbook-utils gawk \
|
||
python-pysqlite2 diffstat help2man make gcc build-essential \
|
||
g++ desktop-file-utils chrpath libgl1-mesa-dev libglu1-mesa-dev \
|
||
mercurial autoconf automake
|
||
</literallayout>
|
||
|
||
<para>
|
||
The packages you need for an RPM-based host like Fedora are shown in these commands:
|
||
</para>
|
||
|
||
<literallayout class='monospaced'>
|
||
$ sudo yum groupinstall "development tools"
|
||
$ sudo yum install python m4 make wget curl ftp hg tar bzip2 gzip \
|
||
unzip python-psyco perl texinfo texi2html diffstat openjade \
|
||
docbook-style-dsssl sed docbook-style-xsl docbook-dtds \
|
||
docbook-utils sed bc glibc-devel ccache pcre pcre-devel quilt \
|
||
groff linuxdoc-tools patch linuxdoc-tools cmake help2man \
|
||
perl-ExtUtils-MakeMaker tcl-devel gettext chrpath ncurses apr \
|
||
SDL-devel mesa-libGL-devel mesa-libGLU-devel gnome-doc-utils \
|
||
autoconf automake
|
||
</literallayout>
|
||
|
||
<note><para>
|
||
Packages vary in number and name for other Linux distributions.
|
||
The commands here should work. We are interested, though, to learn what works for you.
|
||
You can find more information for package requirements on common Linux distributions
|
||
at <ulink url="http://wiki.openembedded.net/index.php/OEandYourDistro"></ulink>.
|
||
However, you should be careful when using this information as the information applies
|
||
to old Linux distributions that are known to not work with a current Poky install.
|
||
</para></note>
|
||
</section>
|
||
|
||
<section id='releases'>
|
||
<title>Yocto Project Release</title>
|
||
|
||
<para>
|
||
The latest release images for the Yocto Project are kept at
|
||
<ulink url="http://yoctoproject.org/downloads/yocto-0.9/"></ulink>.
|
||
Nightly and developmental builds are also maintained. However, for this
|
||
document a released version of Yocto Project is used.
|
||
</para>
|
||
</section>
|
||
</section>
|
||
|
||
<section id='test-run'>
|
||
<title>A Quick Test Run</title>
|
||
|
||
<para>
|
||
Now that you have your system requirements in order you can give Yocto Project a try.
|
||
This section presents some steps that let you do the following:
|
||
</para>
|
||
|
||
<itemizedlist>
|
||
<listitem>
|
||
<para>Build an image and run it in the emulator</para>
|
||
</listitem>
|
||
<listitem>
|
||
<para>Or, use a pre-built image and run it in the emulator</para>
|
||
</listitem>
|
||
</itemizedlist>
|
||
|
||
<section id='building-image'>
|
||
<title>Building an Image</title>
|
||
|
||
<para>
|
||
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.
|
||
</para>
|
||
|
||
<mediaobject>
|
||
<imageobject>
|
||
<imagedata fileref="figures/building-an-image.png" format="PNG" align='center' scalefit='1'/>
|
||
</imageobject>
|
||
<caption>
|
||
<para>Building an Image</para>
|
||
</caption>
|
||
</mediaobject>
|
||
|
||
<para>
|
||
Use the following commands to build your image.
|
||
The build process creates an entire Linux distribution, including the toolchain, from source.
|
||
</para>
|
||
|
||
<note><para>
|
||
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.
|
||
</para></note>
|
||
|
||
<para>
|
||
<literallayout class='monospaced'>
|
||
$ wget http://www.yoctoproject.org/downloads/poky/poky-laverne-4.0.tar.bz2
|
||
$ tar xjf poky-laverne-4.0.tar.bz2
|
||
$ source poky-laverne-4.0/poky-init-build-env poky-4.0-build
|
||
</literallayout>
|
||
</para>
|
||
<itemizedlist>
|
||
<listitem><para>The first two commands extract the Yocto Project files from the
|
||
release tarball and place them into a subdirectory of your current directory.</para></listitem>
|
||
<listitem><para>The <command>source</command> command creates the
|
||
<filename>poky-4.0-build</filename> directory and executes the <command>cd</command>
|
||
command to make <filename>poky-4.0-build</filename> the working directory.
|
||
The resulting build directory contains all the files created during the build.
|
||
By default the target architecture is qemux86.
|
||
To change this default, edit the value of the MACHINE variable in the
|
||
<filename>conf/local.conf</filename> file.</para></listitem>
|
||
</itemizedlist>
|
||
<para>
|
||
Take some time to examine your <filename>conf/local.conf</filename> file.
|
||
The defaults should work fine.
|
||
However, if you have a multi-core CPU you might want to set the variables
|
||
BB_NUMBER_THREADS and PARALLEL_MAKE to the number of processor cores on your build machine.
|
||
By default, these variables are commented out.
|
||
</para>
|
||
<para>
|
||
Continue with the following command to build an OS image for the target, which is
|
||
<filename>poky-image-sato</filename> in this example.
|
||
<literallayout class='monospaced'>
|
||
$ bitbake poky-image-sato
|
||
</literallayout>
|
||
<note><para>
|
||
If you are running Fedora 14 or another distribution
|
||
that ships with GNU make v3.82 you need to run the following two
|
||
<command>bitbake</command> commands instead:
|
||
<literallayout class='monospaced'>
|
||
$ bitbake make-native
|
||
$ bitbake poky-image-sato
|
||
</literallayout>
|
||
</para></note>
|
||
The final command runs the image:
|
||
<literallayout class='monospaced'>
|
||
$ poky-qemu qemux86
|
||
</literallayout>
|
||
<note><para>
|
||
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.
|
||
</para></note>
|
||
</para>
|
||
</section>
|
||
|
||
<section id='using-pre-built'>
|
||
<title>Using Pre-Built Binaries and QEMU</title>
|
||
<para>
|
||
If hardware, libraries and services are stable you can get started by using a pre-built binary
|
||
of the image, kernel and toolchain and run it using the emulator QEMU.
|
||
This scenario is useful for developing application software.
|
||
</para>
|
||
|
||
<para></para>
|
||
<para></para>
|
||
<para></para>
|
||
|
||
<mediaobject>
|
||
<imageobject>
|
||
<imagedata fileref="figures/using-a-pre-built-image.png" format="PNG" align='center' scalefit='1'/>
|
||
</imageobject>
|
||
<caption>
|
||
<para>Using a Pre-Built Image</para>
|
||
</caption>
|
||
</mediaobject>
|
||
|
||
<para>
|
||
For this scenario you need to do several things:
|
||
</para>
|
||
|
||
<itemizedlist>
|
||
<listitem>
|
||
<para>
|
||
Install the stand-alone Yocto toolchain tarball.
|
||
</para>
|
||
</listitem>
|
||
<listitem>
|
||
<para>
|
||
Download the pre-built kernel 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.).
|
||
</para>
|
||
</listitem>
|
||
<listitem>
|
||
<para>
|
||
Download the filesystem image for your target machine's architecture.
|
||
</para>
|
||
</listitem>
|
||
<listitem>
|
||
<para>
|
||
Set up the environment to emulate the hardware and then start the QEMU emulator.
|
||
</para>
|
||
</listitem>
|
||
|
||
</itemizedlist>
|
||
|
||
<section id='installing-the-toolchain'>
|
||
<title>Installing the Toolchain</title>
|
||
<para>
|
||
You can download the pre-built toolchain, which includes the poky-qemu script and
|
||
support files, from <ulink url='http://yoctoproject.org/downloads/yocto-0.9/toolchain/'></ulink>.
|
||
Toolchains are available for 32-bit and 64-bit development systems from the
|
||
<filename>i586</filename> and <filename>x86_64</filename> folders, respectively.
|
||
Each type of development system supports five target architectures.
|
||
The tarball files are named such that a string representing the host system appears
|
||
first in the filename and then is immediately followed by a string representing
|
||
the target architecture.
|
||
</para>
|
||
|
||
<literallayout class='monospaced'>
|
||
yocto-eglibc<<emphasis>host_system</emphasis>>-<<emphasis>arch</emphasis>>-toolchain-sdk-<<emphasis>release</emphasis>>.tar.bz2
|
||
|
||
Where:
|
||
<<emphasis>host_system</emphasis>> is a string representing your development system:
|
||
i586 or x86_64.
|
||
|
||
<<emphasis>arch</emphasis>> is a string representing the target architecture:
|
||
i585, x86_64, powerpc, mips, or arm.
|
||
|
||
<<emphasis>release</emphasis>> is the version of Yocto Project.
|
||
</literallayout>
|
||
|
||
<para>
|
||
For example, the following toolchain tarball is for a 64-bit development
|
||
host system and a 32-bit target architecture:
|
||
</para>
|
||
|
||
<literallayout class='monospaced'>
|
||
yocto-eglibc-x86_64-i586-toolchain-sdk-0.9.tar.bz2
|
||
</literallayout>
|
||
|
||
<para>
|
||
The toolchain tarballs are self-contained and should be installed into <filename>/opt/poky</filename>.
|
||
The following commands show how you install the toolchain tarball given a 64-bit development host system
|
||
and a 32-bit target architecture.
|
||
</para>
|
||
|
||
<para>
|
||
<literallayout class='monospaced'>
|
||
$ cd /
|
||
$ sudo tar -xvjf yocto-eglibc-x86_64-i586-toolchain-sdk-0.9.tar.bz2
|
||
</literallayout>
|
||
</para>
|
||
</section>
|
||
|
||
<section id='downloading-the-pre-built-linux-kernel'>
|
||
<title>Downloading the Pre-Built Linux Kernel</title>
|
||
<para>
|
||
You can download the pre-built Linux kernel and the filesystem image suitable for
|
||
running in the emulator QEMU from
|
||
<ulink url='http://yoctoproject.org/downloads/yocto-0.9/qemu'></ulink>.
|
||
Be sure to use the kernel and filesystem image that matches the architecture you want
|
||
to simulate.
|
||
</para>
|
||
|
||
<para>
|
||
Most kernel files have the following form:
|
||
</para>
|
||
|
||
<literallayout class='monospaced'>
|
||
*zImage*qemu<<emphasis>arch</emphasis>>*.bin
|
||
|
||
Where:
|
||
<<emphasis>arch</emphasis>> is a string representing the target architecture:
|
||
x86, x86-64, ppc, mips, or arm.
|
||
</literallayout>
|
||
</section>
|
||
|
||
<section id='downloading-the-filesystem'>
|
||
<title>Downloading the Filesystem</title>
|
||
<para>
|
||
The filesystem image has two forms.
|
||
One form is an <filename>ext3</filename> filesystem image.
|
||
The other form is a tarball of the filesystem and is booted using user-space NFS.
|
||
Here are the respective forms:
|
||
</para>
|
||
|
||
<literallayout class='monospaced'>
|
||
yocto-image-<<emphasis>profile</emphasis>>-qemu<<emphasis>arch</emphasis>>.rootfs.ext3
|
||
yocto-image-<<emphasis>profile</emphasis>>-qemu<<emphasis>arch</emphasis>>.rootfs.tar.bz2
|
||
|
||
Where:
|
||
<<emphasis>profile</emphasis>> is the filesystem image's profile:
|
||
sdk, sato, minimal, or lsb.
|
||
|
||
<<emphasis>arch</emphasis>> is a string representing the target architecture:
|
||
x86, x86-64, ppc, mips, or arm.
|
||
</literallayout>
|
||
</section>
|
||
|
||
<section id='setting-up-the-environment-and-starting-the-qemu-emulator'>
|
||
<title>Setting Up the Environment and Starting the QEMU Emulator</title>
|
||
<para>
|
||
Before you start the QEMU emulator you need to set up the emulation environment.
|
||
The following command form sets up the emulation environment.
|
||
</para>
|
||
|
||
<literallayout class='monospaced'>
|
||
$ source /opt/poky/environment-setup-<<emphasis>arch</emphasis>>-poky-linux-<<emphasis>if</emphasis>>
|
||
|
||
Where:
|
||
<<emphasis>arch</emphasis>> is a string representing the target architecture:
|
||
i586, x86_64, ppc603e, mips, or armv5te.
|
||
|
||
<<emphasis>if</emphasis>> is a string representing an embedded application binary interface.
|
||
Not all setup scripts include this string.
|
||
</literallayout>
|
||
|
||
<para>
|
||
Finally, this command form invokes the QEMU emulator
|
||
</para>
|
||
|
||
<literallayout class='monospaced'>
|
||
$ poky-qemu <<emphasis>qemuarch</emphasis>> <<emphasis>kernel</emphasis>> <<emphasis>image</emphasis>> <<emphasis>fstype</emphasis>>
|
||
|
||
Where:
|
||
<<emphasis>qemuarch</emphasis>> is a string representing the target architecture: qemux86, qemux86-64,
|
||
qemuppc, qemumips, or qemuarm.
|
||
|
||
<<emphasis>kernel</emphasis>> is the architecture-specific kernel.
|
||
|
||
<<emphasis>image</emphasis>> is the .ext3 filesystem image.
|
||
|
||
<<emphasis>fstype</emphasis>> is the filesystem type.
|
||
</literallayout>
|
||
|
||
<para>
|
||
Continuing with the example, the following two commands setup the emulation
|
||
environment and launch QEMU.
|
||
The kernel and filesystem are for a 32-bit target architecture.
|
||
</para>
|
||
|
||
<literallayout class='monospaced'>
|
||
$ source /opt/poky/environment-setup-i586-poky-linux
|
||
$ poky-qemu qemui586 zImage-2.6.34-qemux86-0.9 yocto-image-sdk-qemux86-0.9.rootfs.ext3 ext3
|
||
</literallayout>
|
||
|
||
<para>
|
||
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.
|
||
</para>
|
||
|
||
<note><para>
|
||
Booting the PPC image results in QEMU launching in the same shell in command-line mode.
|
||
</para></note>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
|
||
</article>
|
||
<!--
|
||
vim: expandtab tw=80 ts=4
|
||
-->
|