documentation/dev-manual/qemu.rst

4 Using the Quick EMUlator (QEMU)
7 The Yocto Project uses an implementation of the Quick EMUlator (QEMU)
10 EMUlator (QEMU) and other QEMU information helpful for development
16 Within the context of the Yocto Project, QEMU is an emulator and
19 QEMU is useful for running and testing images and applications on
21 Among other things, the Yocto Project uses QEMU to run automated Quality
26    This implementation is not the same as QEMU in general.
29 implementation of QEMU.
31 For official information and documentation on QEMU in general, see the
34 -  `QEMU Website <https://wiki.qemu.org/Main_Page>`__\ *:* The official
35    website for the QEMU Open Source project.
37 -  `Documentation <https://wiki.qemu.org/Manual>`__\ *:* The QEMU user
40 Running QEMU
43 To use QEMU, you need to have QEMU installed and initialized as well as
45 available. Follow these general steps to run QEMU:
47 1. *Install QEMU:* QEMU is made available with the Yocto Project a
51    Development Kit (eSDK) manual for information on how to install QEMU.
53 2. *Setting Up the Environment:* How you set up the QEMU environment
54    depends on how you installed QEMU:
70    pre-built kernel that will boot in QEMU. You also need the target
73    -  If you have previously built an image for QEMU (e.g. ``qemux86``,
80       QEMU.
87 4. *Run QEMU:* The basic ``runqemu`` command syntax is as follows::
93    to do. For example, by default, QEMU looks for the most recently
99    Here are some additional examples to help illustrate further QEMU:
101    -  This example starts QEMU with MACHINE set to "qemux86-64".
111          When more than one image with the same name exists, QEMU finds
127       enable audio in QEMU. For this case, ``runqemu`` set the internal
135    -  This example does not provide enough information for QEMU to
144       determines the QEMU architecture (`MACHINE`) to be "qemux86-64" and
153 When booting or running QEMU, you can switch between supported consoles
156 consoles is helpful, for example, if the main QEMU console breaks for
167 You can remove the splash screen when QEMU is booting by using Alt+left.
174 The default QEMU integration captures the cursor within the main window.
178 integration of QEMU enables the wacom USB touch pad driver by default to
186 One method for running QEMU is to run it on an NFS server. This is
190 NFS server to avoid that. Follow these steps to set up for running QEMU
193 1. *Extract a Root Filesystem:* Once you are able to run QEMU in your
207 2. *Start QEMU:* Once you have extracted the file system, you can run
234 QEMU CPU Compatibility Under KVM
237 By default, the QEMU build compiles for and targets 64-bit and x86 Intel
238 Core2 Duo processors and 32-bit x86 Intel Pentium II processors. QEMU
244 not a problem when QEMU uses software emulation of the feature, it can
245 be a problem when QEMU is running with KVM enabled. Specifically,
248 problem, you can override QEMU's runtime CPU setting by changing the
251 directory. This setting specifies a ``-cpu`` option passed into QEMU in
255 QEMU Performance
258 Using QEMU to emulate your hardware can result in speed issues depending
266 To speed things up, the QEMU images support using ``distcc`` to call a
268 start QEMU, and the ``distccd`` application is present on the host
270 system is automatically used from within QEMU simply by calling
279    on the QEMU emulator:
281    -  QEMU provides a framebuffer interface that makes standard consoles
289    -  SSH servers are available in some QEMU images. The ``core-image-sato``
290       QEMU image has a Dropbear secure shell (SSH) server that runs with
292       ``core-image-lsb`` QEMU images have OpenSSH instead of Dropbear.
294       ``scp`` commands. The ``core-image-minimal`` QEMU image, however,
297    -  You can use a provided, user-space NFS server to boot the QEMU
307 QEMU Command-Line Syntax
316 default, QEMU looks for the most recently built image according to the
330      Simplified QEMU command-line options can be passed with:
342      qemuparams=<xyz> - specify custom parameters to QEMU
372 -  `QEMUARCH`: The QEMU machine architecture, which must be "qemuarm",
391 -  `MACHINE`: The architecture of the QEMU machine, which must be one of
415 -  ``qemuparams=\"xyz\"``: Specifies custom QEMU parameters. Use this
422 -  ``audio``: Enables audio in QEMU. The MACHINE option must be either
431 -  ``kvm``: Enables KVM when running "qemux86" or "qemux86-64" QEMU
444    or "qemux86-64" QEMU architectures. For KVM with VHOST to work, the