mirror of
https://git.yoctoproject.org/poky
synced 2026-04-30 03:32:12 +02:00
347424e558
Changes throughout the manual that either eliminate or change many of the "Yocto Project" strings. The file structure for the meta data is now called "source directory." The build directory is referred as just that - "build directory." Any where the build system is referred to it is called the "OpenEmbedded build system." (From yocto-docs rev: 1210c19f90d4a52042fec12657212ae3e58e13d6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
469 lines
26 KiB
XML
469 lines
26 KiB
XML
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
|
|
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
|
|
|
|
<chapter id='adt-prepare'>
|
|
|
|
<title>Preparing to Use the Application Development Toolkit (ADT)</title>
|
|
|
|
<para>
|
|
In order to use the ADT, you must install it, <filename>source</filename> a script to set up the
|
|
environment, and be sure both the kernel and filesystem image specific to the target architecture
|
|
exist.
|
|
This chapter describes how to be sure you meet the ADT requirements.
|
|
</para>
|
|
|
|
<section id='installing-the-adt'>
|
|
<title>Installing the ADT</title>
|
|
|
|
<para>
|
|
The following list describes how you can install the ADT, which includes the cross-toolchain.
|
|
Regardless of the installation you choose, you must <filename>source</filename> the cross-toolchain
|
|
environment setup script before you use the toolchain.
|
|
See the "<link linkend='setting-up-the-cross-development-environment'>Setting Up the
|
|
Cross-Development Environment</link>"
|
|
section for more information.
|
|
</para>
|
|
|
|
<note>
|
|
<para>Avoid mixing installation methods when installing the ADT for different architectures.
|
|
For example, avoid using the ADT Installer to install some toolchains and then hand-installing
|
|
cross-development toolchains from downloaded tarballs to install toolchains
|
|
for different architectures.
|
|
Mixing installation methods can result in situations where the ADT Installer becomes
|
|
unreliable and might not install the toolchain.</para>
|
|
<para>If you must mix installation methods, you might avoid problems by deleting
|
|
<filename>/var/lib/opkg</filename>, thus purging the <filename>opkg</filename> package
|
|
metadata</para>
|
|
</note>
|
|
|
|
<para>
|
|
<itemizedlist>
|
|
<listitem><para><emphasis>Use the ADT Installer Script:</emphasis>
|
|
This method is the recommended way to install the ADT because it
|
|
automates much of the process for you.
|
|
For example, you can configure the installation to install the QEMU emulator
|
|
and the user-space NFS, specify which root filesystem profiles to download,
|
|
and define the target sysroot location.</para></listitem>
|
|
<listitem><para><emphasis>Use an Existing Toolchain Tarball:</emphasis>
|
|
Using this method, you select and download an architecture-specific
|
|
toolchain tarball and then hand-install the toolchain.
|
|
If you use this method, you just get the cross-toolchain and QEMU - you do not
|
|
get any of the other mentioned benefits had you run the ADT Installer script.</para></listitem>
|
|
<listitem><para><emphasis>Use the Toolchain from within a Yocto Project Build Tree:</emphasis>
|
|
If you already have a build directory, you can build the cross-toolchain
|
|
within that structure.
|
|
However, like the previous method mentioned, you only get the cross-toolchain and QEMU - you
|
|
do not get any of the other benefits without taking separate steps.</para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
|
|
<section id='using-the-adt-installer'>
|
|
<title>Using the ADT Installer</title>
|
|
|
|
<para>
|
|
To run the ADT Installer, you need to first get the ADT Installer tarball and then run the ADT
|
|
Installer Script.
|
|
</para>
|
|
|
|
<section id='getting-the-adt-installer-tarball'>
|
|
<title>Getting the ADT Installer Tarball</title>
|
|
|
|
<para>
|
|
The ADT Installer is contained in the ADT Installer tarball.
|
|
You can download the tarball into any directory from the
|
|
<ulink url='&YOCTO_DL_URL;/releases'>Index of Releases</ulink>, specifically
|
|
at
|
|
<ulink url='&YOCTO_ADTINSTALLER_DL_URL;'></ulink>.
|
|
Or, you can use BitBake to generate the tarball inside the existing build directory.
|
|
</para>
|
|
|
|
<para>
|
|
If you use BitBake to generate the ADT Installer tarball, you must
|
|
<filename>source</filename> the environment setup script
|
|
(<filename>oe-init-build-env</filename>) located
|
|
in the source directory before running the <filename>bitbake</filename>
|
|
command that creates the tarball.
|
|
</para>
|
|
|
|
<para>
|
|
The following example commands download the Yocto Project release tarball, set up the
|
|
source directory, set up the environment while also creating the
|
|
default build directory,
|
|
and run the <filename>bitbake</filename> command that results in the tarball
|
|
<filename>~/yocto-project/build/tmp/deploy/sdk/adt_installer.tar.bz2</filename>:
|
|
<literallayout class='monospaced'>
|
|
$ cd ~
|
|
$ mkdir yocto-project
|
|
$ cd yocto-project
|
|
$ wget &YOCTO_RELEASE_DL_URL;/&YOCTO_POKY_TARBALL;
|
|
$ tar xjf &YOCTO_POKY_TARBALL;
|
|
$ source &OE_INIT_PATH;
|
|
$ bitbake adt-installer
|
|
</literallayout>
|
|
</para>
|
|
</section>
|
|
|
|
<section id='configuring-and-running-the-adt-installer-script'>
|
|
<title>Configuring and Running the ADT Installer Script</title>
|
|
|
|
<para>
|
|
Before running the ADT Installer script, you need to unpack the tarball.
|
|
You can unpack the tarball in any directory you wish.
|
|
For example, this command copies the ADT Installer tarball from where
|
|
it was built into the home directory and then unpacks the tarball into
|
|
a top-level directory named <filename>adt-installer</filename>:
|
|
<literallayout class='monospaced'>
|
|
$ cd ~
|
|
$ cp ~/poky/build/tmp/deploy/sdk/adt_installer.tar.bz2 $HOME
|
|
$ tar -xjf adt_installer.tar.bz2
|
|
</literallayout>
|
|
Unpacking it creates the directory <filename>adt-installer</filename>,
|
|
which contains the ADT Installer script (<filename>adt_installer</filename>)
|
|
and its configuration file (<filename>adt_installer.conf</filename>).
|
|
</para>
|
|
|
|
<para>
|
|
Before you run the script, however, you should examine the ADT Installer configuration
|
|
file and be sure you are going to get what you want.
|
|
Your configurations determine which kernel and filesystem image are downloaded.
|
|
</para>
|
|
|
|
<para>
|
|
The following list describes the configurations you can define for the ADT Installer.
|
|
For configuration values and restrictions, see the comments in
|
|
the <filename>adt-installer.conf</filename> file:
|
|
|
|
<itemizedlist>
|
|
<listitem><para><filename>YOCTOADT_REPO</filename>: This area
|
|
includes the IPKG-based packages and the root filesystem upon which
|
|
the installation is based.
|
|
If you want to set up your own IPKG repository pointed to by
|
|
<filename>YOCTOADT_REPO</filename>, you need to be sure that the
|
|
directory structure follows the same layout as the reference directory
|
|
set up at <ulink url='http://adtrepo.yoctoproject.org'></ulink>.
|
|
Also, your repository needs to be accessible through HTTP.</para></listitem>
|
|
<listitem><para><filename>YOCTOADT_TARGETS</filename>: The machine
|
|
target architectures for which you want to set up cross-development
|
|
environments.</para></listitem>
|
|
<listitem><para><filename>YOCTOADT_QEMU</filename>: Indicates whether
|
|
or not to install the emulator QEMU.</para></listitem>
|
|
<listitem><para><filename>YOCTOADT_NFS_UTIL</filename>: Indicates whether
|
|
or not to install user-mode NFS.
|
|
If you plan to use the Eclipse IDE Yocto plug-in against QEMU,
|
|
you should install NFS.
|
|
<note>To boot QEMU images using our userspace NFS server, you need
|
|
to be running <filename>portmap</filename> or <filename>rpcbind</filename>.
|
|
If you are running <filename>rpcbind</filename>, you will also need to add the
|
|
<filename>-i</filename> option when <filename>rpcbind</filename> starts up.
|
|
Please make sure you understand the security implications of doing this.
|
|
You might also have to modify your firewall settings to allow
|
|
NFS booting to work.</note></para></listitem>
|
|
<listitem><para><filename>YOCTOADT_ROOTFS_<arch></filename>: The root
|
|
filesystem images you want to download from the
|
|
<filename>YOCTOADT_IPKG_REPO</filename> repository.</para></listitem>
|
|
<listitem><para><filename>YOCTOADT_TARGET_SYSROOT_IMAGE_<arch></filename>: The
|
|
particular root filesystem used to extract and create the target sysroot.
|
|
The value of this variable must have been specified with
|
|
<filename>YOCTOADT_ROOTFS_<arch></filename>.
|
|
For example, if you downloaded both <filename>minimal</filename> and
|
|
<filename>sato-sdk</filename> images by setting
|
|
<filename>YOCTOADT_ROOTFS_<arch></filename>
|
|
to "minimal sato-sdk", then <filename>YOCTOADT_ROOTFS_<arch></filename>
|
|
must be set to either <filename>minimal</filename> or
|
|
<filename>sato-sdk</filename>.</para></listitem>
|
|
<listitem><para><filename>YOCTOADT_TARGET_SYSROOT_LOC_<arch></filename>: The
|
|
location on the development host where the target sysroot is created.
|
|
</para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
|
|
<para>
|
|
After you have configured the <filename>adt_installer.conf</filename> file,
|
|
run the installer using the following command.
|
|
Be sure that you are not trying to use cross-compilation tools.
|
|
When you run the installer, the environment must use a
|
|
host <filename>gcc</filename>:
|
|
<literallayout class='monospaced'>
|
|
$ ./adt_installer
|
|
</literallayout>
|
|
</para>
|
|
|
|
<note>
|
|
The ADT Installer requires the <filename>libtool</filename> package to complete.
|
|
If you install the recommended packages as described in
|
|
"<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>"
|
|
section of The Yocto Project Quick Start, then you will have libtool installed.
|
|
</note>
|
|
|
|
<para>
|
|
Once the installer begins to run, you are asked whether you want to run in
|
|
interactive or silent mode.
|
|
If you want to closely monitor the installation, choose “I” for interactive
|
|
mode rather than “S” for silent mode.
|
|
Follow the prompts from the script to complete the installation.
|
|
</para>
|
|
|
|
<para>
|
|
Once the installation completes, the ADT, which includes the cross-toolchain, is installed.
|
|
You will notice environment setup files for the cross-toolchain in
|
|
<filename>&YOCTO_ADTPATH_DIR;</filename>,
|
|
and image tarballs in the <filename>adt-installer</filename>
|
|
directory according to your installer configurations, and the target sysroot located
|
|
according to the <filename>YOCTOADT_TARGET_SYSROOT_LOC_<arch></filename> variable
|
|
also in your configuration file.
|
|
</para>
|
|
</section>
|
|
</section>
|
|
|
|
<section id='using-an-existing-toolchain-tarball'>
|
|
<title>Using a Cross-Toolchain Tarball</title>
|
|
|
|
<para>
|
|
If you want to simply install the cross-toolchain by hand, you can do so by using an existing
|
|
cross-toolchain tarball.
|
|
If you use this method to install the cross-toolchain and you still need to install the target
|
|
sysroot, you will have to install sysroot separately.
|
|
</para>
|
|
|
|
<para>
|
|
Follow these steps:
|
|
<orderedlist>
|
|
<listitem><para>Go to
|
|
<ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>
|
|
and find the folder that matches your host development system
|
|
(i.e. <filename>i686</filename> for 32-bit machines or
|
|
<filename>x86-64</filename> for 64-bit machines).</para></listitem>
|
|
<listitem><para>Go into that folder and download the toolchain tarball whose name
|
|
includes the appropriate target architecture.
|
|
For example, if your host development system is an Intel-based 64-bit system and
|
|
you are going to use your cross-toolchain for an Intel-based 32-bit target, go into the
|
|
<filename>x86_64</filename> folder and download the following tarball:
|
|
<literallayout class='monospaced'>
|
|
poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2
|
|
</literallayout>
|
|
<note><para>As an alternative to steps one and two, you can build the toolchain tarball
|
|
if you have a build directory.
|
|
If you need GMAE, you should use the <filename>bitbake meta-toolchain-gmae</filename>
|
|
command.
|
|
The resulting tarball will support such development.
|
|
However, if you are not concerned with GMAE,
|
|
you can generate the tarball using <filename>bitbake meta-toolchain</filename>.</para>
|
|
<para>Use the appropriate <filename>bitbake</filename> command only after you have
|
|
sourced the <filename>oe-build-init-env</filename> script located in the source
|
|
directory.
|
|
When the <filename>bitbake</filename> command completes, the tarball will
|
|
be in <filename>tmp/deploy/sdk</filename> in the build directory.
|
|
</para></note></para></listitem>
|
|
<listitem><para>Make sure you are in the root directory with root privileges and then expand
|
|
the tarball.
|
|
The tarball expands into <filename>&YOCTO_ADTPATH_DIR;</filename>.
|
|
Once the tarball is expanded, the cross-toolchain is installed.
|
|
You will notice environment setup files for the cross-toolchain in the directory.
|
|
</para></listitem>
|
|
</orderedlist>
|
|
</para>
|
|
</section>
|
|
|
|
<section id='using-the-toolchain-from-within-the-build-tree'>
|
|
<title>Using BitBake and the Build Directory</title>
|
|
|
|
<para>
|
|
A final way of making the cross-toolchain available is to use BitBake
|
|
to generate the toolchain within an existing build directory.
|
|
This method does not install the toolchain into the
|
|
<filename>/opt</filename> directory.
|
|
As with the previous method, if you need to install the target sysroot, you must
|
|
do this separately.
|
|
</para>
|
|
|
|
<para>
|
|
Follow these steps to generate the toolchain into the build tree:
|
|
<orderedlist>
|
|
<listitem><para>Source the environment setup script
|
|
<filename>oe-init-build-env</filename> located in the source directory.
|
|
</para></listitem>
|
|
<listitem><para>At this point, you should be sure that the
|
|
<filename>MACHINE</filename> variable
|
|
in the <filename>local.conf</filename> file found in the
|
|
<filename>conf</filename> directory of the build directory
|
|
is set for the target architecture.
|
|
Comments within the <filename>local.conf</filename> file list the values you
|
|
can use for the <filename>MACHINE</filename> variable.
|
|
<note>You can populate the build tree with the cross-toolchains for more
|
|
than a single architecture.
|
|
You just need to edit the <filename>MACHINE</filename> variable in the
|
|
<filename>local.conf</filename> file and re-run the BitBake
|
|
command.</note></para></listitem>
|
|
<listitem><para>Run <filename>bitbake meta-ide-support</filename> to complete the
|
|
cross-toolchain generation.
|
|
<note>If you change out of your working directory after you
|
|
<filename>source</filename> the environment setup script and before you run
|
|
the <filename>bitbake</filename> command, the command might not work.
|
|
Be sure to run the <filename>bitbake</filename> command immediately
|
|
after checking or editing the <filename>local.conf</filename> but without
|
|
changing out of your working directory.</note>
|
|
Once the <filename>bitbake</filename> command finishes,
|
|
the cross-toolchain is generated and populated within the build directory.
|
|
You will notice environment setup files for the cross-toolchain in the
|
|
build directory in the <filename>tmp</filename> directory.
|
|
Setup script filenames contain the strings <filename>environment-setup</filename>.
|
|
</para></listitem>
|
|
</orderedlist>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
|
|
<section id='setting-up-the-cross-development-environment'>
|
|
<title>Setting Up the Cross-Development Environment</title>
|
|
|
|
<para>
|
|
Before you can develop using the cross-toolchain, you need to set up the
|
|
cross-development environment by sourcing the toolchain's environment setup script.
|
|
If you used the ADT Installer or used an existing ADT tarball to install the ADT,
|
|
then you can find this script in the <filename>&YOCTO_ADTPATH_DIR;</filename>
|
|
directory.
|
|
If you installed the toolchain in the build tree, you can find the environment setup
|
|
script for the toolchain in the build directory's <filename>tmp</filename> directory.
|
|
</para>
|
|
|
|
<para>
|
|
Be sure to run the environment setup script that matches the architecture for
|
|
which you are developing.
|
|
Environment setup scripts begin with the string “<filename>environment-setup</filename>”
|
|
and include as part of their name the architecture.
|
|
For example, the toolchain environment setup script for a 64-bit IA-based architecture would
|
|
be the following:
|
|
<literallayout class='monospaced'>
|
|
&YOCTO_ADTPATH_DIR;/environment-setup-x86_64-poky-linux
|
|
</literallayout>
|
|
</para>
|
|
</section>
|
|
|
|
<section id='securing-kernel-and-filesystem-images'>
|
|
<title>Securing Kernel and Filesystem Images</title>
|
|
|
|
<para>
|
|
You will need to have a kernel and filesystem image to boot using your
|
|
hardware or the QEMU emulator.
|
|
Furthermore, if you plan on booting your image using NFS or you want to use the root filesystem
|
|
as the target sysroot, you need to extract the root filesystem.
|
|
</para>
|
|
|
|
<section id='getting-the-images'>
|
|
<title>Getting the Images</title>
|
|
|
|
<para>
|
|
To get the kernel and filesystem images, you either have to build them or download
|
|
pre-built versions.
|
|
You can find examples for both these situations in the
|
|
"<ulink url='&YOCTO_DOCS_QS_URL;#test-run'>A Quick Test Run</ulink>" section of
|
|
The Yocto Project Quick Start.
|
|
</para>
|
|
|
|
<para>
|
|
The Yocto Project ships basic kernel and filesystem images for several
|
|
architectures (<filename>x86</filename>, <filename>x86-64</filename>,
|
|
<filename>mips</filename>, <filename>powerpc</filename>, and <filename>arm</filename>)
|
|
that you can use unaltered in the QEMU emulator.
|
|
These kernel images reside in the release
|
|
area - <ulink url='&YOCTO_MACHINES_DL_URL;'></ulink>
|
|
and are ideal for experimentation using Yocto Project.
|
|
For information on the image types you can build using the OpenEmbedded build system,
|
|
see the
|
|
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix in
|
|
The Yocto Project Reference Manual.
|
|
</para>
|
|
|
|
<para>
|
|
If you plan on remotely deploying and debugging your application from within the
|
|
Eclipse IDE, you must have an image that contains the Yocto Target Communication
|
|
Framework (TCF) agent (<filename>tcf-agent</filename>).
|
|
By default, the Yocto Project provides only one type pre-built image that contains the
|
|
<filename>tcf-agent</filename>.
|
|
And, those images are SDK (e.g.<filename>core-image-sato-sdk</filename>).
|
|
</para>
|
|
|
|
<para>
|
|
If you want to use a different image type that contains the <filename>tcf-agent</filename>,
|
|
you can do so one of two ways:
|
|
<itemizedlist>
|
|
<listitem><para>Modify the <filename>conf/local.conf</filename> configuration in
|
|
the build directory and then rebuild the image.
|
|
With this method, you need to modify the <filename>EXTRA_IMAGE_FEATURES</filename>
|
|
variable to have the value of "tools-debug" before rebuilding the image.
|
|
Once the image is rebuilt, the <filename>tcf-agent</filename> will be included
|
|
in the image and is launched automatically after the boot.</para></listitem>
|
|
<listitem><para>Manually build the <filename>tcf-agent</filename>.
|
|
To build the agent, follow these steps:
|
|
<orderedlist>
|
|
<listitem><para>Be sure the ADT is installed as described in the
|
|
"<link linkend='installing-the-adt'>Installing the ADT</link>" section.
|
|
</para></listitem>
|
|
<listitem><para>Set up the cross-development environment as described in the
|
|
"<link linkend='setting-up-the-cross-development-environment'>Setting
|
|
Up the Cross-Development Environment</link>" section.</para></listitem>
|
|
<listitem><para>Get the <filename>tcf-agent</filename> source code using
|
|
the following commands:
|
|
<literallayout class='monospaced'>
|
|
$ git clone http://git.eclipse.org/gitroot/tcf/org.eclipse.tcf.agent.git
|
|
$ cd agent
|
|
</literallayout></para></listitem>
|
|
<listitem><para>Modify the <filename>Makefile.inc</filename> file
|
|
for the cross-compilation environment by setting the
|
|
<filename>OPSYS</filename> and <filename>MACHINE</filename>
|
|
variables according to your target.</para></listitem>
|
|
<listitem><para>Use the cross-development tools to build the
|
|
<filename>tcf-agent</filename>.
|
|
Before you "Make" the file, be sure your cross-tools are set up first.
|
|
See the "<link linkend='makefile-based-projects'>Makefile-Based Projects</link>"
|
|
section for information on how to make sure the cross-tools are set up
|
|
correctly.</para>
|
|
<para>If the build is successful, the <filename>tcf-agent</filename> output will
|
|
be <filename>obj/$(OPSYS)/$(MACHINE)/Debug/agent</filename>.</para></listitem>
|
|
<listitem><para>Deploy the agent into the image's root filesystem.</para></listitem>
|
|
</orderedlist>
|
|
</para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
|
|
<section id='extracting-the-root-filesystem'>
|
|
<title>Extracting the Root Filesystem</title>
|
|
|
|
<para>
|
|
You must extract the root filesystem if you want to boot the image using NFS
|
|
or you want to use the root filesystem as the target sysroot.
|
|
For example, the Eclipse IDE environment with the Eclipse Yocto Plug-in installed allows you
|
|
to use QEMU to boot under NFS.
|
|
Another example is if you want to develop your target application using the
|
|
root filesystem as the target sysroot.
|
|
</para>
|
|
|
|
<para>
|
|
To extract the root filesystem, first <filename>source</filename>
|
|
the cross-development environment setup script and then
|
|
use the <filename>runqemu-extract-sdk</filename> command on the
|
|
filesystem image.
|
|
For example, the following commands set up the environment and then extract
|
|
the root filesystem from a previously built filesystem image tarball named
|
|
<filename>core-image-sato-sdk-qemux86-2011091411831.rootfs.tar.bz2</filename>.
|
|
The example extracts the root filesystem into the <filename>$HOME/qemux86-sato</filename>
|
|
directory:
|
|
<literallayout class='monospaced'>
|
|
$ source $HOME/poky/build/tmp/environment-setup-i586-poky-linux
|
|
$ runqemu-extract-sdk \
|
|
tmp/deploy/images/core-image-sato-sdk-qemux86-2011091411831.rootfs.tar.bz2 \
|
|
$HOME/qemux86-sato
|
|
</literallayout>
|
|
In this case, you could now point to the target sysroot at
|
|
<filename>$HOME/qemux86-sato</filename>.
|
|
</para>
|
|
</section>
|
|
</section>
|
|
|
|
</chapter>
|
|
<!--
|
|
vim: expandtab tw=80 ts=4
|
|
-->
|