summaryrefslogtreecommitdiffstats
path: root/documentation/yocto-project-qs/yocto-project-qs.xml
blob: 452282f1ce90f84d15684a9d77d33642a87f9cef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
<!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>

         <tip><para>
             To help conserve disk space during builds you can add the following statement
             to your <filename>local.conf</filename> file.  
             Adding this statement deletes the work directory used for building a package
             once the package is built.
             <literallayout class='monospaced'>
     INHERIT += "rm_work"
             </literallayout>
         </para></tip>

         <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>
             <note><para>
                 BitBake requires Python 2.6.  For more information on this requirement, 
                 see the FAQ appendix in the 
                 <ulink url='http://www.yoctoproject.org/docs/poky-ref-manual/poky-ref-manual.html'>
                 Poky Reference Manual</ulink>.
             </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&lt;<emphasis>host_system</emphasis>&gt;-&lt;<emphasis>arch</emphasis>&gt;-toolchain-sdk-&lt;<emphasis>release</emphasis>&gt;.tar.bz2

     Where:
         &lt;<emphasis>host_system</emphasis>&gt; is a string representing your development system: 
                i586 or x86_64.
       
         &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture: 
                i585, x86_64, powerpc, mips, or arm.
       
         &lt;<emphasis>release</emphasis>&gt; 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&lt;<emphasis>arch</emphasis>&gt;*.bin

     Where:
         &lt;<emphasis>arch</emphasis>&gt; 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-&lt;<emphasis>profile</emphasis>&gt;-qemu&lt;<emphasis>arch</emphasis>&gt;.rootfs.ext3
     yocto-image-&lt;<emphasis>profile</emphasis>&gt;-qemu&lt;<emphasis>arch</emphasis>&gt;.rootfs.tar.bz2

     Where:
         &lt;<emphasis>profile</emphasis>&gt; is the filesystem image's profile:
                   sdk, sato, minimal, or lsb.

         &lt;<emphasis>arch</emphasis>&gt; 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-&lt;<emphasis>arch</emphasis>&gt;-poky-linux-&lt;<emphasis>if</emphasis>&gt; 

     Where:
         &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture: 
                i586, x86_64, ppc603e, mips, or armv5te.

         &lt;<emphasis>if</emphasis>&gt; 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 &lt;<emphasis>qemuarch</emphasis>&gt; &lt;<emphasis>kernel</emphasis>&gt; &lt;<emphasis>image</emphasis>&gt; &lt;<emphasis>fstype</emphasis>&gt;

     Where:
         &lt;<emphasis>qemuarch</emphasis>&gt; is a string representing the target architecture: qemux86, qemux86-64, 
                    qemuppc, qemumips, or qemuarm.

         &lt;<emphasis>kernel</emphasis>&gt;    is the architecture-specific kernel.

         &lt;<emphasis>image</emphasis>&gt;     is the .ext3 filesystem image.

         &lt;<emphasis>fstype</emphasis>&gt;    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
-->