2011-07-15 14:29:18 +00:00
|
|
|
|
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
|
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
|
|
|
|
|
|
|
|
|
<chapter id='dev-manual-start'>
|
|
|
|
|
|
|
|
|
|
<title>Getting Started with the Yocto Project</title>
|
|
|
|
|
|
2011-07-15 16:23:55 +00:00
|
|
|
|
<para>
|
|
|
|
|
This chapter introduces the Yocto Project and gives you an idea of what you need to get started.
|
|
|
|
|
You can find enough information to set your development host up and build or use images for
|
|
|
|
|
hardware supported by the Yocto Project by reading the
|
|
|
|
|
<ulink url='http://www.yoctoproject.org/docs/yocto-quick-start/yocto-project-qs.html'>
|
|
|
|
|
Yocto Project Quick Start</ulink> located on the <ulink url='http://www.yoctoproject.org'>
|
|
|
|
|
Yocto Project website</ulink>.
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
The remainder of this chapter summarizes what is in the Yocto Project Quick Start and provides
|
|
|
|
|
some higher level concepts you might want to consider.
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<section id='introducing-the-yocto-project'>
|
|
|
|
|
<title>Introducing the Yocto Project</title>
|
|
|
|
|
|
2011-07-15 14:29:18 +00:00
|
|
|
|
<para>
|
2011-08-11 20:55:07 +00:00
|
|
|
|
The Yocto Project is an open-source collaboration project focused on embedded Linux development.
|
2011-08-16 16:17:55 +00:00
|
|
|
|
The project currently provides a build system and various ancillary tools suitable for the
|
|
|
|
|
embedded developer.
|
|
|
|
|
The Yocto Project also features the Sato reference User Interface, which is optimized for
|
|
|
|
|
stylus driven, low-resolution screens.
|
2011-07-15 14:29:18 +00:00
|
|
|
|
</para>
|
2011-07-15 16:23:55 +00:00
|
|
|
|
|
2011-07-15 14:29:18 +00:00
|
|
|
|
<para>
|
2011-07-15 16:23:55 +00:00
|
|
|
|
You can use the Yocto Project, which uses the BitBake build tool, to develop complete Linux
|
2011-08-16 16:17:55 +00:00
|
|
|
|
images and associated user-space applications for architectures based on ARM, MIPS, PowerPC,
|
|
|
|
|
x86 and x86-64.
|
2011-07-15 16:23:55 +00:00
|
|
|
|
You can perform target-level testing and debugging as well as test in a hardware emulated environment.
|
|
|
|
|
And, if you are an Eclipse user, you can install an Eclipse Yocto Plug-in to allow you to
|
|
|
|
|
develop within that familiar environment.
|
2011-07-15 14:29:18 +00:00
|
|
|
|
</para>
|
2011-07-15 16:23:55 +00:00
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
<section id='getting-setup'>
|
|
|
|
|
<title>Getting Setup</title>
|
|
|
|
|
|
2011-07-15 14:29:18 +00:00
|
|
|
|
<para>
|
2011-07-15 16:23:55 +00:00
|
|
|
|
Here is what you need to get set up to use the Yocto Project:
|
2011-07-15 14:29:18 +00:00
|
|
|
|
<itemizedlist>
|
2011-08-16 16:17:55 +00:00
|
|
|
|
<listitem><para><emphasis>Host System:</emphasis> You should have a reasonably current
|
|
|
|
|
Linux-based host system.
|
|
|
|
|
You will have the best results with a recent release of Fedora,
|
|
|
|
|
OpenSUSE, or Ubuntu as these releases are frequently tested and officially supported
|
|
|
|
|
host systems.
|
2011-08-11 20:55:07 +00:00
|
|
|
|
You should also have about 100 gigabytes of free disk space for building images.
|
|
|
|
|
</para></listitem>
|
|
|
|
|
<listitem><para><emphasis>Packages:</emphasis> The Yocto Project requires certain packages
|
2011-08-16 16:17:55 +00:00
|
|
|
|
exist on your development system (e.g. Python 2.6 or 2.7).
|
|
|
|
|
See <ulink url='http://www.yoctoproject.org/docs/yocto-quick-start/yocto-project-qs.html#packages'>
|
2011-07-18 16:09:54 +00:00
|
|
|
|
The Packages</ulink> section in the Yocto Project Quick start for the exact package
|
2011-08-16 16:17:55 +00:00
|
|
|
|
requirements and the installation commands for the supported distributions.</para></listitem>
|
2011-08-02 19:58:44 +00:00
|
|
|
|
<listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis>
|
|
|
|
|
You need a release of the Yocto Project.
|
2011-07-27 15:07:37 +00:00
|
|
|
|
You can get set up with local Yocto Project files one of two ways depending on whether you
|
|
|
|
|
are going to be contributing back into the Yocto Project source repository or not.
|
2011-07-27 15:16:16 +00:00
|
|
|
|
<note>
|
|
|
|
|
Regardless of the method you use, this manual will refer to the resulting
|
|
|
|
|
hierarchical set of files as "the local Yocto Project files."
|
|
|
|
|
</note>
|
2011-07-15 16:23:55 +00:00
|
|
|
|
<itemizedlist>
|
|
|
|
|
<listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute
|
|
|
|
|
back into the Yocto Project you can simply download the Yocto Project release you want
|
|
|
|
|
from the website’s <ulink url='http://yoctoproject.org/download'>download page</ulink>.
|
2011-07-27 15:07:37 +00:00
|
|
|
|
Once you have the tarball, just extract it into a directory of your choice.</para>
|
|
|
|
|
|
|
|
|
|
<para>For example, the following command extracts the Yocto Project 1.1 release tarball
|
|
|
|
|
into the current working directory and sets up a file structure whose top-level
|
|
|
|
|
directory is named <filename>poky-1.1</filename>:
|
|
|
|
|
<literallayout class='monospaced'>
|
|
|
|
|
$ tar xfj poky-1.1.tar.bz2
|
|
|
|
|
</literallayout></para>
|
|
|
|
|
<para>This method does not produce a <filename>poky</filename> Git repository.
|
|
|
|
|
You end up simply with a local snapshot of Yocto Project files that are based on the
|
|
|
|
|
particular release in the tarball.</para></listitem>
|
2011-07-22 15:40:12 +00:00
|
|
|
|
<listitem><para><emphasis>Git Repository Method:</emphasis> If you are going to be contributing
|
2011-08-02 17:29:05 +00:00
|
|
|
|
back into the Yocto Project you should use Git commands to set up a local
|
2011-07-27 15:07:37 +00:00
|
|
|
|
<filename>poky</filename> Git repository of the Yocto Project.
|
2011-07-22 15:40:12 +00:00
|
|
|
|
Doing so creates a Git repository with a complete history of changes and allows
|
2011-07-27 15:07:37 +00:00
|
|
|
|
you to easily submit your changes upstream to the project.</para>
|
|
|
|
|
|
|
|
|
|
<para>The following transcript shows how to clone the <filename>poky</filename>
|
|
|
|
|
Git repository into the current working directory.
|
2011-07-27 19:01:43 +00:00
|
|
|
|
The command creates the repository in a directory named <filename>poky</filename>.
|
|
|
|
|
For information on the Yocto Project and Git, see
|
|
|
|
|
<xref linkend='git'>Git</xref> in
|
|
|
|
|
<xref linkend='dev-manual-newbie'>Working with Open Source Code</xref>.
|
2011-07-27 15:07:37 +00:00
|
|
|
|
<literallayout class='monospaced'>
|
|
|
|
|
$ git clone git://git.yoctoproject.org/poky
|
|
|
|
|
Initialized empty Git repository in /home/scottrif/poky/.git/
|
|
|
|
|
remote: Counting objects: 107624, done.
|
|
|
|
|
remote: Compressing objects: 100% (37128/37128), done.
|
|
|
|
|
remote: Total 107624 (delta 73393), reused 99851 (delta 67287)
|
|
|
|
|
Receiving objects: 100% (107624/107624), 69.74 MiB | 483 KiB/s, done.
|
|
|
|
|
Resolving deltas: 100% (73393/73393), done.
|
|
|
|
|
</literallayout></para>
|
|
|
|
|
|
|
|
|
|
<para>For another example of how to set up your own local Git repositories see this
|
2011-07-15 16:23:55 +00:00
|
|
|
|
<ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>
|
2011-07-22 15:40:12 +00:00
|
|
|
|
wiki page</ulink>, which describes how to create both <filename>poky</filename>
|
|
|
|
|
and <filename>meta-intel</filename> Git repositories.</para></listitem>
|
2011-07-15 16:23:55 +00:00
|
|
|
|
</itemizedlist></para></listitem>
|
2011-08-02 19:58:44 +00:00
|
|
|
|
<listitem id='local-kernel-files'><para><emphasis>Linux Yocto Kernel:</emphasis>
|
|
|
|
|
If you are going to be making modifications to a supported Linux Yocto kernel you
|
2011-08-08 19:57:11 +00:00
|
|
|
|
need to get set up so that you can edit local copies of the source.
|
|
|
|
|
This setup involves creating a bare clone of the Linux Yocto kernel and then cloning
|
2011-08-10 21:19:31 +00:00
|
|
|
|
that repository.
|
|
|
|
|
You can create the bare clone and the copy of the bare clone anywhere you like.
|
|
|
|
|
For simplicity, it is recommended that you create these structures outside of the
|
|
|
|
|
Yocto Project files Git repository.</para>
|
2011-08-08 19:57:11 +00:00
|
|
|
|
<para>As an example, the following transcript shows how to create the bare clone
|
2011-08-11 17:29:20 +00:00
|
|
|
|
of the <filename>linux-yocto-3.0</filename> kernel and then create a copy of
|
2011-08-10 21:19:31 +00:00
|
|
|
|
that clone.
|
2011-08-11 19:50:00 +00:00
|
|
|
|
<note>If you currently have a local Linux Yocto kernel Git repository, you can
|
|
|
|
|
reference this local repository rather than the upstream Git repository as
|
|
|
|
|
part of the <filename>clone</filename> command.
|
|
|
|
|
Doing so can speed up the process.</note>
|
2011-08-11 17:29:20 +00:00
|
|
|
|
The bare clone is named <filename>linux-yocto-3.0.git</filename>, while the
|
|
|
|
|
copy is named <filename>linux-yocto-3.0</filename>:
|
2011-08-02 19:58:44 +00:00
|
|
|
|
<literallayout class='monospaced'>
|
2011-08-11 17:29:20 +00:00
|
|
|
|
$ git clone --bare git://git.yoctoproject.org/linux-yocto-3.0 linux-yocto-3.0.git
|
|
|
|
|
Initialized empty Git repository in /home/scottrif/poky/linux-yocto-3.0.git/
|
2011-08-02 19:58:44 +00:00
|
|
|
|
remote: Counting objects: 1886034, done.
|
|
|
|
|
remote: Compressing objects: 100% (314326/314326), done.
|
|
|
|
|
remote: Total 1886034 (delta 1570200), reused 1870337 (delta 1554798)
|
2011-08-08 19:57:11 +00:00
|
|
|
|
Receiving objects: 100% (1886034/1886034), 401.51 MiB | 3.27 MiB/s, done.
|
2011-08-02 19:58:44 +00:00
|
|
|
|
Resolving deltas: 100% (1570200/1570200), done.
|
2011-08-08 19:57:11 +00:00
|
|
|
|
</literallayout></para>
|
|
|
|
|
<para>Now create a clone of the bare clone just created:
|
|
|
|
|
<literallayout class='monospaced'>
|
2011-08-11 17:29:20 +00:00
|
|
|
|
$ git clone linux-yocto-3.0.git linux-yocto-3.0
|
|
|
|
|
Initialized empty Git repository in /home/scottrif/poky/linux-yocto-3.0/.git/
|
2011-08-02 19:58:44 +00:00
|
|
|
|
Checking out files: 100% (35188/35188), done.
|
2011-08-10 21:19:31 +00:00
|
|
|
|
</literallayout></para></listitem>
|
|
|
|
|
<listitem id='poky-extras-repo'><para><emphasis>
|
|
|
|
|
The <filename>poky-extras</filename> Git Repository</emphasis>:
|
|
|
|
|
The <filename>poky-extras</filename> Git repository contains metadata needed to
|
|
|
|
|
build the kernel image.
|
|
|
|
|
In particular, it contains the kernel <filename>.bbappend</filename> files that you
|
|
|
|
|
edit to point to your locally modified kernel source files and to build kernel
|
|
|
|
|
image.
|
|
|
|
|
Pointing to these local files is much more efficient than requiring a download of the
|
|
|
|
|
source files from upstream each time you make changes to the kernel.</para>
|
|
|
|
|
<para>It is good practice to create this Git repository inside the Yocto Project
|
|
|
|
|
files Git repository.
|
|
|
|
|
Following is an example that creates the <filename>poky-extras</filename> Git
|
|
|
|
|
repository inside the Yocto Project files Git repository, which is named
|
|
|
|
|
<filename>poky</filename> in this case:
|
2011-08-08 19:57:11 +00:00
|
|
|
|
<literallayout class='monospaced'>
|
2011-08-10 21:19:31 +00:00
|
|
|
|
$ cd ~/poky
|
2011-08-08 19:57:11 +00:00
|
|
|
|
$ git clone git://git.yoctoproject.org/poky-extras poky-extras
|
|
|
|
|
Initialized empty Git repository in /home/scottrif/poky/poky-extras/.git/
|
|
|
|
|
remote: Counting objects: 531, done.
|
|
|
|
|
remote: Compressing objects: 100% (471/471), done.
|
|
|
|
|
remote: Total 531 (delta 138), reused 307 (delta 39)
|
|
|
|
|
Receiving objects: 100% (531/531), 517.86 KiB, done.
|
|
|
|
|
Resolving deltas: 100% (138/138), done.
|
2011-08-02 19:58:44 +00:00
|
|
|
|
</literallayout></para></listitem>
|
|
|
|
|
<listitem><para><emphasis>Supported Board Support Packages (BSPs):</emphasis> The same considerations
|
2011-07-15 16:23:55 +00:00
|
|
|
|
exist for BSPs.
|
2011-07-27 16:00:46 +00:00
|
|
|
|
You can get set up for BSP development one of two ways: tarball extraction or
|
|
|
|
|
with a local Git repository.
|
|
|
|
|
Regardless of the method you use, the Yocto Project uses the following BSP layer
|
|
|
|
|
naming scheme:
|
|
|
|
|
<literallayout class='monospaced'>
|
|
|
|
|
meta-<BSP_name>
|
|
|
|
|
</literallayout>
|
|
|
|
|
where <BSP_name> is the recognized BSP name.
|
|
|
|
|
Here are some examples:
|
|
|
|
|
<literallayout class='monospaced'>
|
2011-07-28 20:24:18 +00:00
|
|
|
|
meta-crownbay
|
|
|
|
|
meta-emenlow
|
|
|
|
|
meta-n450
|
2011-07-27 16:00:46 +00:00
|
|
|
|
</literallayout>
|
2011-07-15 16:23:55 +00:00
|
|
|
|
<itemizedlist>
|
|
|
|
|
<listitem><para><emphasis>Tarball Extraction:</emphasis> You can download any released
|
|
|
|
|
BSP tarball from the same
|
|
|
|
|
<ulink url='http://yoctoproject.org/download'>download site</ulink>.
|
2011-07-22 15:40:12 +00:00
|
|
|
|
Once you have the tarball just extract it into a directory of your choice.
|
|
|
|
|
Again, this method just produces a snapshot of the BSP layer in the form
|
|
|
|
|
of a hierarchical directory structure.</para></listitem>
|
|
|
|
|
<listitem><para><emphasis>Git Repository Method:</emphasis> If you are working
|
|
|
|
|
with a <filename>poky</filename> Git repository you should also set up a
|
|
|
|
|
<filename>meta-intel</filename> Git repository.
|
|
|
|
|
Typically, you set up the <filename>meta-intel</filename> Git repository inside
|
2011-07-27 15:41:28 +00:00
|
|
|
|
the <filename>poky</filename> Git repository.</para>
|
|
|
|
|
|
2011-07-27 16:00:46 +00:00
|
|
|
|
<para>For example, the following transcript shows the steps to clone the
|
|
|
|
|
<filename>meta-intel</filename>
|
|
|
|
|
Git repository inside the <filename>poky</filename>
|
|
|
|
|
<filename>poky</filename> Git repository.
|
|
|
|
|
<literallayout class='monospaced'>
|
2011-07-27 15:41:28 +00:00
|
|
|
|
$cd poky
|
|
|
|
|
$ git clone git://git.yoctoproject.org/meta-intel.git
|
|
|
|
|
Initialized empty Git repository in /home/scottrif/poky/meta-intel/.git/
|
|
|
|
|
remote: Counting objects: 1325, done.
|
|
|
|
|
remote: Compressing objects: 100% (1078/1078), done.
|
|
|
|
|
remote: Total 1325 (delta 546), reused 85 (delta 27)
|
|
|
|
|
Receiving objects: 100% (1325/1325), 1.56 MiB | 330 KiB/s, done.
|
|
|
|
|
Resolving deltas: 100% (546/546), done.
|
2011-07-27 16:00:46 +00:00
|
|
|
|
</literallayout></para>
|
2011-07-27 15:41:28 +00:00
|
|
|
|
|
|
|
|
|
<para>The same
|
2011-07-15 16:23:55 +00:00
|
|
|
|
<ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>
|
2011-07-22 15:40:12 +00:00
|
|
|
|
wiki page</ulink> referenced earlier covers how to
|
|
|
|
|
set up the <filename>meta-intel</filename> Git repository.</para></listitem>
|
2011-07-15 16:23:55 +00:00
|
|
|
|
</itemizedlist></para></listitem>
|
2011-08-16 16:17:55 +00:00
|
|
|
|
<listitem><para><emphasis>Eclipse Yocto Plug-in:</emphasis> If you are developing
|
|
|
|
|
applications using the
|
2011-07-15 16:23:55 +00:00
|
|
|
|
Eclipse Integrated Development Environment (IDE) you will need this plug-in.
|
|
|
|
|
See the
|
|
|
|
|
<ulink url='http://www.yoctoproject.org/docs/adt-manual/adt-manual.html#setting-up-the-eclipse-ide'>
|
2011-07-18 16:09:54 +00:00
|
|
|
|
Setting up the Eclipse IDE</ulink> section in the Yocto Application Development Toolkit (ADT)
|
2011-07-15 16:23:55 +00:00
|
|
|
|
User’s Guide for more information.</para></listitem>
|
2011-07-15 14:29:18 +00:00
|
|
|
|
</itemizedlist>
|
|
|
|
|
</para>
|
|
|
|
|
</section>
|
|
|
|
|
|
2011-07-15 16:23:55 +00:00
|
|
|
|
<section id='building-images'>
|
|
|
|
|
<title>Building Images</title>
|
2011-07-15 14:29:18 +00:00
|
|
|
|
|
2011-07-15 16:23:55 +00:00
|
|
|
|
<para>
|
|
|
|
|
The build process creates an entire Linux distribution, including the toolchain, from source.
|
|
|
|
|
For more information on this topic, see the
|
|
|
|
|
<ulink url='http://www.yoctoproject.org/docs/yocto-quick-start/yocto-project-qs.html#building-image'>
|
2011-07-18 16:09:54 +00:00
|
|
|
|
Building an Image</ulink> section in the Yocto Project Quick Start.
|
2011-07-15 16:23:55 +00:00
|
|
|
|
</para>
|
2011-07-15 14:29:18 +00:00
|
|
|
|
|
2011-07-15 16:23:55 +00:00
|
|
|
|
<para>
|
|
|
|
|
The build process is as follows:
|
|
|
|
|
<orderedlist>
|
|
|
|
|
<listitem><para>Make sure you have the Yocto Project files as described in the
|
|
|
|
|
previous section.</para></listitem>
|
|
|
|
|
<listitem><para>Initialize the build environment by sourcing a build environment
|
|
|
|
|
script.</para></listitem>
|
2011-08-16 16:17:55 +00:00
|
|
|
|
<listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file is set
|
2011-07-15 16:23:55 +00:00
|
|
|
|
up how you want it.
|
2011-08-11 20:55:07 +00:00
|
|
|
|
This file defines the target machine architecture and and other build options.</para></listitem>
|
2011-07-15 16:23:55 +00:00
|
|
|
|
<listitem><para>Build the image using the BitBake command.
|
|
|
|
|
If you want information on Bitbake, see the user manual at
|
|
|
|
|
<ulink url='http://docs.openembedded.org/bitbake/html'></ulink>.</para></listitem>
|
2011-08-01 22:03:59 +00:00
|
|
|
|
<listitem><para>Run the image either on the actual hardware or using the QEMU
|
|
|
|
|
emulator.</para></listitem>
|
2011-07-15 16:23:55 +00:00
|
|
|
|
</orderedlist>
|
|
|
|
|
</para>
|
|
|
|
|
</section>
|
2011-07-15 14:29:18 +00:00
|
|
|
|
|
2011-07-15 16:23:55 +00:00
|
|
|
|
<section id='using-pre-built-binaries-and-qemu'>
|
|
|
|
|
<title>Using Pre-Built Binaries and QEMU</title>
|
2011-07-15 14:29:18 +00:00
|
|
|
|
|
2011-07-15 16:23:55 +00:00
|
|
|
|
<para>
|
2011-08-11 20:55:07 +00:00
|
|
|
|
Another option you have to get started is to use pre-built binaries.
|
2011-07-15 16:23:55 +00:00
|
|
|
|
This scenario is ideal for developing software applications to run on your target hardware.
|
|
|
|
|
To do this you need to install the stand-alone Yocto toolchain tarball and then download the
|
|
|
|
|
pre-built kernel that you will boot using the QEMU emulator.
|
|
|
|
|
Next, you must download the filesystem for your target machine’s architecture.
|
|
|
|
|
Finally, you set up the environment to emulate the hardware then start the emulator.
|
|
|
|
|
</para>
|
2011-07-15 14:29:18 +00:00
|
|
|
|
|
2011-07-15 16:23:55 +00:00
|
|
|
|
<para>
|
|
|
|
|
You can find details on all these steps in the
|
|
|
|
|
<ulink url='http://www.yoctoproject.org/docs/yocto-quick-start/yocto-project-qs.html#using-pre-built'>
|
2011-07-18 16:09:54 +00:00
|
|
|
|
Using Pre-Built Binaries and QEMU</ulink> section in the Yocto Project Quick Start.
|
2011-07-15 16:23:55 +00:00
|
|
|
|
</para>
|
|
|
|
|
</section>
|
2011-07-15 14:29:18 +00:00
|
|
|
|
</chapter>
|
|
|
|
|
<!--
|
|
|
|
|
vim: expandtab tw=80 ts=4
|
|
|
|
|
-->
|