summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-07-09 21:13:02 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-08-02 10:00:25 +0100
commit5f31e281ec28a48e2bb91ec34a729242a9c601a1 (patch)
treeac1785e49b9cb609e7bf817dceae1aaddc3b949a /documentation
parent25d7b0df2a2d0a7ee46b93df1d92735aa04a7b44 (diff)
downloadpoky-5f31e281ec28a48e2bb91ec34a729242a9c601a1.tar.gz
dev-manual: Added support for new QEMU chapter.
(From yocto-docs rev: d8a852e244f1c0f4d5ef33f50844bb1cb479cb92) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-qemu.xml129
1 files changed, 129 insertions, 0 deletions
diff --git a/documentation/dev-manual/dev-manual-qemu.xml b/documentation/dev-manual/dev-manual-qemu.xml
new file mode 100644
index 0000000000..17bbc2774a
--- /dev/null
+++ b/documentation/dev-manual/dev-manual-qemu.xml
@@ -0,0 +1,129 @@
1<!DOCTYPE chapter 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<chapter id='dev-manual-qemu'>
6
7<title>Using the Quick EMUlator</title>
8
9<para>
10 Quick EMUlator (QEMU) is an Open Source project the Yocto Project uses
11 as part of its development "toolset".
12 As such, the information in this chapter is limited to the
13 Yocto Project instatiation of QEMU and not QEMU in general.
14 For official information and documentation on QEMU, see the
15 following references:
16 <itemizedlist>
17 <listitem><para><emphasis><ulink url='http://wiki.qemu.org/Main_Page'>QEMU Website</ulink>:</emphasis>
18 The official website for the QEMU Open Source project.
19 </para></listitem>
20 <listitem><para><emphasis><ulink url='http://wiki.qemu.org/Manual'>Documentation</ulink>:</emphasis>
21 The QEMU user manual.
22 </para></listitem>
23 </itemizedlist>
24</para>
25
26<para>
27 This chapter provides an overview of the Yocto Project instantiation of
28 QEMU, a description of how you use QEMU and its various options and modes,
29 and a few tips and tricks you might find helpful when using QEMU.
30</para>
31
32<section id='qemu-overview'>
33 <title>Overview</title>
34
35 <para>
36 Within the context of the Yocto Project, QEMU is an
37 emulator and virtualization machine that allows you to run a complete
38 image you have built using the Yocto Project as just another task
39 on your build system.
40 QEMU is useful for running and testing images and applications on
41 supported Yocto Project architectures without having actual hardware.
42 </para>
43
44 <para>
45 QEMU is made available with the Yocto Project a number of ways.
46 The easiest and recommended method for getting QEMU is to run the
47 ADT installer. For more information on how to make sure you have
48 QEMU available, see the
49 "<ulink url='&YOCTO_DOCS_ADT_URL;#the-qemu-emulator'>The QEMU Emulator</ulink>"
50 section in the Yocto Project Application Developer's Guide.
51 </para>
52</section>
53
54<section id='qemu-running-qemu'>
55 <title>Running QEMU</title>
56
57 <para>
58 Running QEMU involves having your build environment set up, having the
59 right artifacts available, and understanding how to use the many
60 options that are available to you when you start QEMU using the
61 <filename>runqemu</filename> command.
62 </para>
63
64 <section id='qemu-setting-up-the-environment'>
65 <title>Setting Up the Environment</title>
66
67 <para>
68 You run QEMU in the same environment from which you run BitBake.
69 This means you need to source a build environment script (i.e.
70 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
71 or
72 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>).
73 </para>
74 </section>
75
76 <section id='qemu-using-the-runqemu-command'>
77 <title>Using the <filename>runqemu</filename> Command</title>
78
79 <para>
80 The basic <filename>runqemu</filename> command syntax is as
81 follows:
82 <literallayout class='monospaced'>
83 $ runqemu [<replaceable>option</replaceable> ] [<replaceable>option</replaceable> ] [...]
84 </literallayout>
85 <filename>runqemu</filename> does a good job based on what you
86 provide with the command at figuring out what you are trying
87 to do.
88 Minimally, through the use of options, you must provide either
89 a machine name, a virtual machine image
90 (<filename>*.vmdk</filename>), or a kernel image
91 (<filename>*.bin</filename>).
92 </para>
93
94 <para>
95 If you do provide some "illegal" combination or options or perhaps
96 do not provide enough in the way of options,
97 <filename>runqemu</filename> provides appropriate error messaging
98 to help you figure it out.
99 </para>
100
101 <para>
102 Following is a description of <filename>runqemu</filename>
103 options you can provide on the command line:
104 <itemizedlist>
105 <listitem><para><emphasis><replaceable>QEMUARCH</replaceable>:</emphasis>
106 The QEMU machine architecture, which can be "qemux86",
107 "qemux86-64", "qemuarm", "qemumips", "qemumipsel",
108 “qemumips64", "qemush4", "qemuppc", "qemumicroblaze",
109 or "qemuzynq".
110 </para></listitem>
111 </itemizedlist>
112 </para>
113 </section>
114</section>
115
116<section id='qemu-modes'>
117 <title>Modes</title>
118
119</section>
120
121<section id='qemu-tips-and-tricks'>
122 <title>Tips and Tricks</title>
123
124</section>
125
126</chapter>
127<!--
128vim: expandtab tw=80 ts=4
129-->