blob: d18f0aecd6e67849d695f53f09512a717340dbc8 [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<article id='yocto-project-qs-intro'>
6 <articleinfo>
7 <title>Yocto Project Quick Start</title>
8
9 <copyright>
10 <year>&COPYRIGHT_YEAR;</year>
11 <holder>Linux Foundation</holder>
12 </copyright>
13
14 <legalnotice>
15 <para>
16 Permission is granted to copy, distribute and/or modify this document under
17 the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England &amp; Wales</ulink> as published by Creative Commons.
18 </para>
19 <note>
20 For the latest version of this manual associated with this
21 Yocto Project release, see the
22 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>
23 from the Yocto Project website.
24 </note>
25 </legalnotice>
26
27
28 <abstract>
29 <imagedata fileref="figures/yocto-project-transp.png"
30 width="6in" depth="1in"
31 align="right" scale="25" />
32 </abstract>
33 </articleinfo>
34
35 <section id='welcome'>
36 <title>Welcome!</title>
37 <para>
38 Welcome to the Yocto Project!
39 The Yocto Project is an open-source collaboration project whose
40 focus is developers of embedded Linux systems.
41 Among other things, the Yocto Project uses a build host based
42 on the OpenEmbedded (OE) project, which uses the
43 <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink>
44 tool, to construct complete Linux images.
45 The BitBake and OE components are combined together to form
46 a reference build host, historically known as
47 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink>.
48 </para>
49
50 <para>
51 If you do not have a system that runs Linux and you want to give
52 the Yocto Project a test run, you might consider using the Yocto
53 Project Build Appliance.
54 The Build Appliance allows you to build and boot a custom embedded
55 Linux image with the Yocto Project using a non-Linux development
56 system.
57 See the
58 <ulink url='https://www.yoctoproject.org/tools-resources/projects/build-appliance'>Yocto Project Build Appliance</ulink>
59 for more information.
60 </para>
61
62 <para>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050063 This quick start is written so that you can quickly get a
Patrick Williamsc124f4f2015-09-15 14:41:29 -050064 build host set up to use the Yocto Project and then build some
65 Linux images.
66 Rather than go into great detail about the Yocto Project and its
67 many capabilities, this quick start provides the minimal
68 information you need to try out the Yocto Project using a
69 supported Linux build host.
70 Reading and using the quick start should result in you having a
71 basic understanding of what the Yocto Project is and how to use
72 some of its core components.
73 You will also have worked through steps to produce two images:
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050074 one that is suitable for emulation and one that boots on actual
Patrick Williamsc124f4f2015-09-15 14:41:29 -050075 hardware.
76 The examples highlight the ease with which you can use the
77 Yocto Project to create images for multiple types of hardware.
78 </para>
79
80 <para>
81 For more detailed information on the Yocto Project, you can
82 reference these resources:
83 <itemizedlist>
84 <listitem><para><emphasis>Website:</emphasis>
85 The
86 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>
87 provides the latest builds, breaking news, full development
88 documentation, and access to a rich Yocto Project
89 Development Community into which you can tap.
90 </para></listitem>
91 <listitem><para><emphasis>FAQs:</emphasis>
92 Lists commonly asked Yocto Project questions and answers.
93 You can find two FAQs:
94 <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>Yocto Project FAQ</ulink>
95 on a wiki, and the
96 "<ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink>"
97 chapter in the Yocto Project Reference Manual.
98 </para></listitem>
99 <listitem><para><emphasis>Developer Screencast:</emphasis>
100 The
101 <ulink url='http://vimeo.com/36450321'>Getting Started with the Yocto Project - New Developer Screencast Tutorial</ulink>
102 provides a 30-minute video created for users unfamiliar
103 with the Yocto Project but familiar with Linux build
104 hosts.
105 While this screencast is somewhat dated, the introductory
106 and fundamental concepts are useful for the beginner.
107 </para></listitem>
108 </itemizedlist>
109 </para>
110 </section>
111
112 <section id='yp-intro'>
113 <title>Introducing the Yocto Project Development Environment</title>
114
115 <para>
116 The Yocto Project through the OpenEmbedded build system provides an
117 open source development environment targeting the ARM, MIPS,
118 PowerPC, and x86 architectures for a variety of platforms
119 including x86-64 and emulated ones.
120 You can use components from the Yocto Project to design, develop,
121 build, debug, simulate, and test the complete software stack using
122 Linux, the X Window System, GTK+ frameworks, and Qt frameworks.
123 </para>
124
125 <mediaobject>
126 <imageobject>
127 <imagedata fileref="figures/yocto-environment.png"
128 format="PNG" align='center' scalefit='1' width="100%"/>
129 </imageobject>
130 <caption>
131 <para>The Yocto Project Development Environment</para>
132 </caption>
133 </mediaobject>
134
135 <para>
136 Here are some highlights for the Yocto Project:
137 </para>
138
139 <itemizedlist>
140 <listitem><para>
141 Provides a recent Linux kernel along with a set of system
142 commands and libraries suitable for the embedded
143 environment.
144 </para></listitem>
145 <listitem><para>
146 Makes available system components such as X11, GTK+, Qt,
147 Clutter, and SDL (among others) so you can create a rich user
148 experience on devices that have display hardware.
149 For devices that do not have a display or where you wish to
150 use alternative UI frameworks, these components need not be
151 installed.
152 </para></listitem>
153 <listitem><para>
154 Creates a focused and stable core compatible with the
155 OpenEmbedded project with which you can easily and reliably
156 build and develop.
157 </para></listitem>
158 <listitem><para>
159 Fully supports a wide range of hardware and device emulation
160 through the Quick EMUlator (QEMU).
161 </para></listitem>
162 <listitem><para>
163 Provides a layer mechanism that allows you to easily extend
164 the system, make customizations, and keep them organized.
165 </para></listitem>
166 </itemizedlist>
167
168 <para>
169 You can use the Yocto Project to generate images for many kinds
170 of devices.
171 As mentioned earlier, the Yocto Project supports creation of
172 reference images that you can boot within and emulate using QEMU.
173 The standard example machines target QEMU full-system
174 emulation for 32-bit and 64-bit variants of x86, ARM, MIPS, and
175 PowerPC architectures.
176 Beyond emulation, you can use the layer mechanism to extend
177 support to just about any platform that Linux can run on and that
178 a toolchain can target.
179 </para>
180
181 <para>
182 Another Yocto Project feature is the Sato reference User
183 Interface.
184 This optional UI that is based on GTK+ is intended for devices with
185 restricted screen sizes and is included as part of the
186 OpenEmbedded Core layer so that developers can test parts of the
187 software stack.
188 </para>
189 </section>
190
191 <section id='yp-resources'>
192 <title>Setting Up to Use the Yocto Project</title>
193
194 <para>
195 The following list shows what you need in order to use a
196 Linux-based build host to use the Yocto Project to build images:
197 </para>
198
199 <itemizedlist>
200 <listitem><para><emphasis>Build Host</emphasis>
201 A build host with a minimum of 50 Gbytes of free disk
202 space that is running a supported Linux distribution (i.e.
203 recent releases of Fedora, openSUSE, CentOS, Debian, or
204 Ubuntu).
205 </para></listitem>
206 <listitem><para><emphasis>Build Host Packages</emphasis>
207 Appropriate packages installed on the build host.
208 </para></listitem>
209 <listitem><para><emphasis>The Yocto Project</emphasis>
210 A release of the Yocto Project.
211 </para></listitem>
212 </itemizedlist>
213
214 <section id='the-linux-distro'>
215 <title>The Linux Distribution</title>
216
217 <para>
218 The Yocto Project team verifies each release against recent
219 versions of the most popular Linux distributions that
220 provide stable releases.
221 In general, if you have the current release minus one of the
222 following distributions, you should have no problems.
223 <itemizedlist>
224 <listitem><para>
225 Ubuntu
226 </para></listitem>
227 <listitem><para>
228 Fedora
229 </para></listitem>
230 <listitem><para>
231 openSUSE
232 </para></listitem>
233 <listitem><para>
234 CentOS
235 </para></listitem>
236 <listitem><para>
237 Debian
238 </para></listitem>
239 </itemizedlist>
240 For a more detailed list of distributions that support the
241 Yocto Project, see the
242 "<ulink url='&YOCTO_DOCS_REF_URL;#detailed-supported-distros'>Supported Linux Distributions</ulink>"
243 section in the Yocto Project Reference Manual.
244 </para>
245
246 <para>
247 The OpenEmbedded build system should be able to run on any
248 modern distribution that has the following versions for
249 Git, tar, and Python.
250 <itemizedlist>
251 <listitem><para>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500252 Git 1.8.3.1 or greater
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500253 </para></listitem>
254 <listitem><para>
255 tar 1.24 or greater
256 </para></listitem>
257 <listitem><para>
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600258 Python 3.4.0 or greater.
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500259 </para></listitem>
260 </itemizedlist>
261 If your build host does not meet any of these three listed
262 version requirements, you can take steps to prepare the
263 system so that you can still use the Yocto Project.
264 See the
265 "<ulink url='&YOCTO_DOCS_REF_URL;#required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</ulink>"
266 section in the Yocto Project Reference Manual for information.
267 </para>
268 </section>
269
270 <section id='packages'>
271 <title>The Build Host Packages</title>
272
273 <para>
274 Required build host packages vary depending on your
275 build machine and what you want to do with the Yocto Project.
276 For example, if you want to build an image that can run
277 on QEMU in graphical mode (a minimal, basic build
278 requirement), then the build host package requirements
279 are different than if you want to build an image on a headless
280 system or build out the Yocto Project documentation set.
281 </para>
282
283 <para>
284 Collectively, the number of required packages is large
285 if you want to be able to cover all cases.
286 <note>
287 In general, you need to have root access and then install
288 the required packages.
289 Thus, the commands in the following section may or may
290 not work depending on whether or not your Linux
291 distribution has <filename>sudo</filename> installed.
292 </note>
293 </para>
294
295 <para>
296 The following list shows the required packages needed to build
297 an image that runs on QEMU in graphical mode (e.g. essential
298 plus graphics support).
299 For lists of required packages for other scenarios, see the
300 "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>"
301 section in the Yocto Project Reference Manual.
302 <itemizedlist>
303 <listitem><para><emphasis>Ubuntu and Debian</emphasis>
304 <literallayout class='monospaced'>
305 $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; libsdl1.2-dev xterm
306 </literallayout>
307 </para></listitem>
308 <listitem><para><emphasis>Fedora</emphasis>
309 <literallayout class='monospaced'>
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500310 $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; SDL-devel xterm
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500311 </literallayout>
312 </para></listitem>
313 <listitem><para><emphasis>OpenSUSE</emphasis>
314 <literallayout class='monospaced'>
315 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; libSDL-devel xterm
316 </literallayout>
317 </para></listitem>
318 <listitem><para><emphasis>CentOS</emphasis>
319 <literallayout class='monospaced'>
320 $ sudo yum install &CENTOS_HOST_PACKAGES_ESSENTIAL; SDL-devel xterm
321 </literallayout>
322 <note>
323 CentOS 6.x users need to ensure that the required
324 versions of Git, tar and Python are available.
325 For details, See the
326 "<ulink url='&YOCTO_DOCS_REF_URL;#required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</ulink>"
327 section in the Yocto Project Reference Manual for
328 information.
329 </note>
330 </para></listitem>
331 </itemizedlist>
332 </para>
333 </section>
334
335 <section id='releases'>
336 <title>Yocto Project Release</title>
337
338 <para>
339 The last requirement you need to meet before using the
340 Yocto Project is getting a Yocto Project release.
341 It is recommended that you get the latest Yocto Project release
342 by setting up (cloning in
343 <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> terms) a
344 local copy of the <filename>poky</filename> Git repository on
345 your build host and then checking out the latest release.
346 Doing so allows you to easily update to newer Yocto Project
347 releases as well as contribute back to the Yocto Project.
348 </para>
349
350 <para>
351 Here is an example from an Ubuntu build host that clones the
352 <filename>poky</filename> repository and then checks out the
353 latest Yocto Project Release (i.e. &DISTRO;):
354 <literallayout class='monospaced'>
355 $ git clone git://git.yoctoproject.org/poky
356 Cloning into 'poky'...
357 remote: Counting objects: 226790, done.
358 remote: Compressing objects: 100% (57465/57465), done.
359 remote: Total 226790 (delta 165212), reused 225887 (delta 164327)
360 Receiving objects: 100% (226790/226790), 100.98 MiB | 263 KiB/s, done.
361 Resolving deltas: 100% (165212/165212), done.
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500362 $ git checkout &DISTRO_NAME_NO_CAP;
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500363 </literallayout>
364 You can also get the Yocto Project Files by downloading
365 Yocto Project releases from the
366 <ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink>.
367 </para>
368
369 <para>
370 For more information on getting set up with the Yocto Project
371 release, see the
372 "<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto Project Release</ulink>"
373 item in the Yocto Project Development Manual.
374 </para>
375 </section>
376 </section>
377
378 <section id='qs-building-images'>
379 <title>Building Images</title>
380
381 <para>
382 Now that you have your system requirements in order, you can give
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500383 Yocto Project a try.
384 You can try out Yocto Project using either the command-line
385 interface or using Toaster, which uses a graphical user
386 interface.
387 If you want to try out the Yocto Project using a GUI, see the
388 <ulink url='&YOCTO_DOCS_TOAST_URL;'>Toaster User Manual</ulink>
389 for information on how to install and set up Toaster.
390 </para>
391
392 <para>
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600393 To use the Yocto Project through the command-line interface,
394 finish this quick start, which presents steps that let you
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500395 do the following:
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500396 <itemizedlist>
397 <listitem><para>
398 Build a <filename>qemux86</filename> reference image
399 and run it in the QEMU emulator.
400 </para></listitem>
401 <listitem><para>
402 Easily change configurations so that you can quickly
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600403 create a second image that you can load onto bootable
404 media and actually boot target hardware.
405 This example uses the MinnowBoard
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500406 MAX-compatible boards.
407 </para></listitem>
408 </itemizedlist>
409 <note>
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600410 The steps in the following two sections do not provide detail,
411 but rather provide minimal, working commands and examples
412 designed to just get you started.
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500413 For more details, see the appropriate manuals in the
414 <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project manual set</ulink>.
415 </note>
416 </para>
417
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600418 <section id='building-an-image-for-emulation'>
419 <title>Building an Image for Emulation</title>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500420
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600421 <para>
422 Use the following commands to build your image.
423 The OpenEmbedded build system creates an entire Linux
424 distribution, including the toolchain, from source.
425 <note><title>Note about Network Proxies</title>
426 <para>
427 By default, the build process searches for source code
428 using a pre-determined order through a set of
429 locations.
430 If you are working behind a firewall and your build
431 host is not set up for proxies, you could encounter
432 problems with the build process when fetching source
433 code (e.g. fetcher failures or Git failures).
434 </para>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500435
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600436 <para>
437 If you do not know your proxy settings, consult your
438 local network infrastructure resources and get that
439 information.
440 A good starting point could also be to check your web
441 browser settings.
442 Finally, you can find more information on using the
443 Yocto Project behind a firewall in the Yocto Project
444 Reference Manual
445 <ulink url='&YOCTO_DOCS_REF_URL;#how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>FAQ</ulink>
446 and on the
447 "<ulink url='https://wiki.yoctoproject.org/wiki/Working_Behind_a_Network_Proxy'>Working Behind a Network Proxy</ulink>"
448 wiki page.
449 </para>
450 </note>
451 </para>
452
453 <para>
454 <orderedlist>
455 <listitem><para><emphasis>Be Sure Your Build Host is Set Up:</emphasis>
456 The steps to build an image in this section depend on
457 your build host being properly set up.
458 Be sure you have worked through the requirements
459 described in the
460 "<link linkend='yp-resources'>Setting Up to Use the Yocto Project</link>"
461 section.
462 </para></listitem>
463 <listitem><para><emphasis>Check Out Your Branch:</emphasis>
464 Be sure you are in the
465 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
466 (e.g. <filename>poky</filename>) and then check out
467 the branch associated with the latest Yocto Project
468 Release:
469 <literallayout class='monospaced'>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500470 $ cd ~/poky
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500471 $ git checkout -b &DISTRO_NAME_NO_CAP; origin/&DISTRO_NAME_NO_CAP;
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600472 </literallayout>
473 Git's <filename>checkout</filename> command checks out
474 the current Yocto Project release into a local branch
475 whose name matches the release (i.e.
476 <filename>&DISTRO_NAME_NO_CAP;</filename>).
477 The local branch tracks the upstream branch of the
478 same name.
479 Creating your own branch based on the released
480 branch ensures you are using the latest files for
481 that release.
482 </para></listitem>
483 <listitem><para><emphasis>Initialize the Build Environment:</emphasis>
484 Run the
485 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
486 environment setup script to define the OpenEmbedded
487 build environment on your build host.
488 <literallayout class='monospaced'>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500489 $ source &OE_INIT_FILE;
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600490 </literallayout>
491 Among other things, the script creates the
492 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
493 which is <filename>build</filename> in this case
494 and is located in the
495 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
496 After the script runs, your current working directory
497 is set to the Build Directory.
498 Later, when the build completes, the Build Directory
499 contains all the files created during the build.
500 <note>
501 For information on running a memory-resident
502 <ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>,
503 see the
504 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>
505 setup script.
506 </note>
507 </para></listitem>
508 <listitem><para><emphasis>Examine Your Local Configuration File:</emphasis>
509 When you set up the build environment, a local
510 configuration file named
511 <filename>local.conf</filename> becomes available in
512 a <filename>conf</filename> subdirectory of the
513 Build Directory.
514 Before using BitBake to start the build, you can
515 look at this file and be sure your general
516 configurations are how you want them:
517 <itemizedlist>
518 <listitem><para>
519 To help conserve disk space during builds,
520 you can add the following statement to your
521 project's configuration file, which for this
522 example is
523 <filename>poky/build/conf/local.conf</filename>.
524 Adding this statement deletes the work
525 directory used for building a recipe once the
526 recipe is built.
527 <literallayout class='monospaced'>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500528 INHERIT += "rm_work"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600529 </literallayout>
530 </para></listitem>
531 <listitem><para>
532 By default, the target machine for the build is
533 <filename>qemux86</filename>,
534 which produces an image that can be used in
535 the QEMU emulator and is targeted at an
536 <trademark class='registered'>Intel</trademark>
537 32-bit based architecture.
538 Further on in this example, this default is
539 easily changed through the
540 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
541 variable so that you can quickly
542 build an image for a different machine.
543 </para></listitem>
544 <listitem><para>
545 Another consideration before you build is the
546 package manager used when creating the image.
547 The default <filename>local.conf</filename>
548 file selects the RPM package manager.
549 You can control this configuration by using the
550 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink></filename>
551 variable.</para>
552 <para>Selection of the package manager is separate
553 from whether package management is used at runtime
554 in the target image.</para>
555 <para>For additional package manager selection
556 information, see the
557 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'><filename>package.bbclass</filename></ulink>"
558 section in the Yocto Project Reference Manual.
559 </para></listitem>
560 </itemizedlist>
561 </para></listitem>
562 <listitem><para><emphasis>Start the Build:</emphasis>
563 Continue with the following command to build an OS image
564 for the target, which is
565 <filename>core-image-sato</filename> in this example:
566 <note>
567 Depending on the number of processors and cores, the
568 amount of RAM, the speed of your Internet connection
569 and other factors, the build process could take several
570 hours the first time you run it.
571 Subsequent builds run much faster since parts of the
572 build are cached.
573 </note>
574 <literallayout class='monospaced'>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500575 $ bitbake core-image-sato
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600576 </literallayout>
577 For information on using the
578 <filename>bitbake</filename> command, see the
579 "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>"
580 section in the Yocto Project Reference Manual, or see the
581 "<ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual-command'>BitBake Command</ulink>"
582 section in the BitBake User Manual.
583 For information on other targets, see the
584 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>"
585 chapter in the Yocto Project Reference Manual.
586 </para></listitem>
587 <listitem><para><emphasis>Simulate Your Image Using QEMU:</emphasis>
588 Once this particular image is built, you can start QEMU
589 and run the image:
590 <literallayout class='monospaced'>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500591 $ runqemu qemux86
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600592 </literallayout>
593 If you want to learn more about running QEMU, see the
594 "<ulink url="&YOCTO_DOCS_DEV_URL;#dev-manual-qemu">Using the Quick EMUlator (QEMU)</ulink>"
595 chapter in the Yocto Project Development Manual.
596 </para></listitem>
597 <listitem><para><emphasis>Exit QEMU:</emphasis>
598 Exit QEMU by either clicking on the shutdown icon or by
599 opening a terminal, typing
600 <filename>poweroff</filename>, and then pressing "Enter".
601 </para></listitem>
602 </orderedlist>
603 </para>
604 </section>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500605
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600606 <section id='building-an-image-for-hardware'>
607 <title>Building an Image for Hardware</title>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500608
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600609 <para id='qs-minnowboard-example'>
610 The following steps show how easy it is to set up to build an
611 image for a new machine.
612 These steps build an image for the MinnowBoard MAX, which is
613 supported by the Yocto Project and the
614 <filename>meta-intel</filename> <filename>intel-corei7-64</filename>
615 and <filename>intel-core2-32</filename> Board Support Packages
616 (BSPs).
617 <note>
618 The MinnowBoard MAX ships with 64-bit firmware.
619 If you want to use the board in 32-bit mode, you must
620 download the
621 <ulink url='http://firmware.intel.com/projects/minnowboard-max'>32-bit firmware</ulink>.
622 </note>
623 </para>
624
625 <para>
626 <orderedlist>
627 <listitem><para><emphasis>Create a Local Copy of the
628 <filename>meta-intel</filename> Repository:</emphasis>
629 Building an image for the MinnowBoard MAX requires the
630 <filename>meta-intel</filename> layer.
631 Use the <filename>git clone</filename> command to create
632 a local copy of the repository inside your
633 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
634 which is <filename>poky</filename> in this example:
635 <literallayout class='monospaced'>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500636 $ cd $HOME/poky
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500637 $ git clone git://git.yoctoproject.org/meta-intel
638 Cloning into 'meta-intel'...
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500639 remote: Counting objects: 11988, done.
640 remote: Compressing objects: 100% (3884/3884), done.
641 Receiving objects: 100% (11988/11988), 2.93 MiB | 2.51 MiB/s, done.
642 remote: Total 11988 (delta 6881), reused 11752 (delta 6645)
643 Resolving deltas: 100% (6881/6881), done.
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500644 Checking connectivity... done.
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600645 </literallayout>
646 By default when you clone a Git repository, the
647 "master" branch is checked out.
648 Before you build your image that uses the
649 <filename>meta-intel</filename> layer, you must be
650 sure that both repositories
651 (<filename>meta-intel</filename> and
652 <filename>poky</filename>) are using the same releases.
653 Consequently, you need to checkout out the
654 "<filename>&DISTRO_NAME_NO_CAP;</filename>" release after
655 cloning <filename>meta-intel</filename>:
656 <literallayout class='monospaced'>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500657 $ cd $HOME/poky/meta-intel
658 $ git checkout &DISTRO_NAME_NO_CAP;
659 Branch &DISTRO_NAME_NO_CAP; set up to track remote branch &DISTRO_NAME_NO_CAP; from origin.
660 Switched to a new branch '&DISTRO_NAME_NO_CAP;'
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600661 </literallayout>
662 </para></listitem>
663 <listitem><para><emphasis>Configure the Build:</emphasis>
664 To configure the build, you edit the
665 <filename>bblayers.conf</filename> and
666 <filename>local.conf</filename> files, both of which are
667 located in the <filename>build/conf</filename> directory.
668 </para>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500669
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600670 <para>Here is a quick way to make the edits.
671 The first command uses the
672 <filename>bitbake-layers add-layer</filename> command
673 to add the <filename>meta-intel</filename>
674 layer, which contains the <filename>intel-core*</filename>
675 BSPs to the build.
676 The second command selects the BSP by setting the
677 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
678 variable.
679 <literallayout class='monospaced'>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500680 $ cd $HOME/poky/build
681 $ bitbake-layers add-layer "$HOME/poky/meta-intel"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500682 $ echo 'MACHINE = "intel-corei7-64"' >> conf/local.conf
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600683 </literallayout>
684 <note><title>Notes</title>
685 <para>
686 If you want a 64-bit build, use the following:
687 <literallayout class='monospaced'>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500688 $ echo 'MACHINE = "intel-corei7-64"' >> conf/local.conf
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600689 </literallayout>
690 </para>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500691
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600692 <para>
693 If you want 32-bit images, use the following:
694 <literallayout class='monospaced'>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500695 $ echo 'MACHINE = "intel-core2-32"' >> conf/local.conf
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600696 </literallayout>
697 </para>
698 </note>
699 </para></listitem>
700 <listitem><para><emphasis>Build an Image for MinnowBoard MAX:</emphasis>
701 The type of image you build depends on your goals.
702 For example, the previous build created a
703 <filename>core-image-sato</filename> image, which is an
704 image with Sato support.
705 It is possible to build many image types for the
706 MinnowBoard MAX.
707 Some possibilities are <filename>core-image-base</filename>,
708 which is a console-only image.
709 Another choice could be a
710 <filename>core-image-full-cmdline</filename>, which is
711 another console-only image but has more full-features
712 Linux system functionality installed.
713 For types of images you can build using the Yocto
714 Project, see the
715 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>"
716 chapter in the Yocto Project Reference Manual.</para>
717 <para>Because configuration changes are minimal to set up
718 for this second build, the OpenEmbedded build system can
719 re-use files from previous builds as much as possible.
720 Re-using files means this second build will be much faster
721 than an initial build.
722 For this example, the <filename>core-image-base</filename>
723 image is built:
724 <literallayout class='monospaced'>
725 $ bitbake core-image-base
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500726 </literallayout>
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600727 Once the build completes, the resulting console-only image
728 is located in the Build Directory here:
729 <literallayout class='monospaced'>
730 tmp/deploy/images/intel-corei7-64/core-image-base-intel-corei7-64.hddimg
731 </literallayout>
732 </para></listitem>
733 <listitem><para><emphasis>Write the Image:</emphasis>
734 You can write the image just built to a bootable media
735 (e.g. a USB key, SATA drive, SD card, etc.) using the
736 <filename>dd</filename> utility:
737 <literallayout class='monospaced'>
738 $ sudo dd if=tmp/deploy/images/intel-corei7-64/core-image-minimal-intel-corei7-64.wic of=TARGET_DEVICE
739 </literallayout>
740 In the previous command, the
741 <filename>TARGET_DEVICE</filename> is the device node in
742 the host machine (e.g. <filename>/dev/sdc</filename>, which
743 is most likely a USB stick, or
744 <filename>/dev/mmcblk0</filename>, which is most likely an
745 SD card.
746 </para></listitem>
747 <listitem><para><emphasis>Boot the Hardware:</emphasis>
748 With the boot device provisioned, you can insert the
749 media into the MinnowBoard MAX and boot the hardware.
750 The board should automatically detect the media and boot to
751 the bootloader and subsequently the operating system.
752 </para>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500753
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600754 <para>If the board does not boot automatically, you can
755 boot it manually from the EFI shell as follows:
756 <literallayout class='monospaced'>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500757 Shell> connect -r
758 Shell> map -r
759 Shell> fs0:
760 Shell> bootx64
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500761 </literallayout>
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600762 <note>
763 For a 32-bit image use the following:
764 <literallayout class='monospaced'>
765 Shell> bootia32
766 </literallayout>
767 </note>
768 </para></listitem>
769 </orderedlist>
770 </para>
771 </section>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500772 </section>
773
774 <section id='qs-next-steps'>
775 <title>Next Steps</title>
776
777 <para>
778 If you completed all the steps in the previous section then
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500779 congratulations!
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500780 What now?
781 </para>
782
783 <para>
784 Depending on what you primary interests are with the Yocto Project,
785 you could consider any of the following:
786 <itemizedlist>
787 <listitem><para><emphasis>Visit the Yocto Project Web Site:</emphasis>
788 The official
789 <ulink url='&YOCTO_HOME_URL;'>Yocto Project</ulink>
790 web site contains information on the entire project.
791 Visiting this site is a good way to familiarize yourself
792 with the overall project.
793 </para></listitem>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500794 <listitem><para><emphasis>Look Through the Yocto Project Development Manual:</emphasis>
795 The
796 <ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-intro'>Yocto Project Development Manual</ulink>
797 is a great place to get a feel for how to use the Yocto
798 Project.
799 The manual contains conceptual and procedural information
800 that covers
801 <ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-model'>common development models</ulink>
802 and introduces
803 <ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-newbie'>the Yocto Project open source development environment</ulink>.
804 The manual also contains several targeted sections that
805 cover specific
806 <ulink url='&YOCTO_DOCS_DEV_URL;#extendpoky'>common tasks</ulink>
807 such as understanding and creating layers, customizing
808 images, writing new recipes, working with libraries, and
809 configuring and patching the kernel.
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500810 </para></listitem>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500811 <listitem><para><emphasis>Look Through the Yocto Project Software Development Kit (SDK) Developer's Guide:</emphasis>
812 The
813 <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-intro'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>
814 describes how to use both the
815 <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-using-the-standard-sdk'>standard SDK</ulink>
816 and the
817 <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-extensible'>extensible SDK</ulink>,
818 which are used primarily for application development.
819 This manual also provides an example workflow that uses
820 the popular <trademark class='trade'>Eclipse</trademark>
821 development environment.
822 See the
823 "<ulink url='&YOCTO_DOCS_SDK_URL;#workflow-using-eclipse'>Workflow using Eclipseâ„¢</ulink>"
824 section.
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500825 </para></listitem>
826 <listitem><para><emphasis>Learn About Board Support Packages (BSPs):</emphasis>
827 If you want to learn about BSPs, see the
828 <ulink url='&YOCTO_DOCS_BSP_URL;#bsp'>Yocto Project Board Support Packages (BSP) Developer's Guide</ulink>.
829 </para></listitem>
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500830 <listitem><para><emphasis>Learn About Toaster:</emphasis>
831 Toaster is a web interface to the Yocto Project's
832 OpenEmbedded build system.
833 If you are interested in using this type of interface to
834 create images, see the
835 <ulink url='&YOCTO_DOCS_TOAST_URL;#toaster-manual-intro'>Toaster User Manual</ulink>.
836 </para></listitem>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500837 <listitem><para><emphasis>Have Available the Yocto Project Reference Manual</emphasis>
838 The
839 <ulink url='&YOCTO_DOCS_REF_URL;#ref-manual-intro'>Yocto Project Reference Manual</ulink>,
840 unlike the rest of the Yocto Project manual set, is
841 comprised of material suited for reference rather than
842 procedures.
843 You can get
844 <ulink url='&YOCTO_DOCS_REF_URL;#usingpoky'>build details</ulink>,
845 a
846 <ulink url='&YOCTO_DOCS_REF_URL;#closer-look'>closer look</ulink>
847 at how the pieces of the Yocto Project development
848 environment work together, information on various
849 <ulink url='&YOCTO_DOCS_REF_URL;#technical-details'>technical details</ulink>,
850 guidance on
851 <ulink url='&YOCTO_DOCS_REF_URL;#migration'>migrating to a newer Yocto Project release</ulink>,
852 reference material on the
853 <ulink url='&YOCTO_DOCS_REF_URL;#ref-structure'>directory structure</ulink>,
854 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes'>classes</ulink>,
855 and
856 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks'>tasks</ulink>.
857 The Yocto Project Reference Manual also contains a fairly
858 comprehensive
859 <ulink url='&YOCTO_DOCS_REF_URL;#ref-variables-glossary'>glossary of variables</ulink>
860 used within the Yocto Project.
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500861 </para></listitem>
862 </itemizedlist>
863 </para>
864 </section>
865</article>
866<!--
867vim: expandtab tw=80 ts=4
868-->