Statistics
| Branch: | Revision:

root / qemu-doc.texi @ 8e71621f

History | View | Annotate | Download (58 kB)

1 386405f7 bellard
\input texinfo @c -*- texinfo -*-
2 debc7065 bellard
@c %**start of header
3 debc7065 bellard
@setfilename qemu-doc.info
4 8f40c388 bellard
@settitle QEMU Emulator User Documentation
5 debc7065 bellard
@exampleindent 0
6 debc7065 bellard
@paragraphindent 0
7 debc7065 bellard
@c %**end of header
8 386405f7 bellard
9 0806e3f6 bellard
@iftex
10 386405f7 bellard
@titlepage
11 386405f7 bellard
@sp 7
12 8f40c388 bellard
@center @titlefont{QEMU Emulator}
13 debc7065 bellard
@sp 1
14 debc7065 bellard
@center @titlefont{User Documentation}
15 386405f7 bellard
@sp 3
16 386405f7 bellard
@end titlepage
17 0806e3f6 bellard
@end iftex
18 386405f7 bellard
19 debc7065 bellard
@ifnottex
20 debc7065 bellard
@node Top
21 debc7065 bellard
@top
22 debc7065 bellard
23 debc7065 bellard
@menu
24 debc7065 bellard
* Introduction::
25 debc7065 bellard
* Installation::
26 debc7065 bellard
* QEMU PC System emulator::
27 debc7065 bellard
* QEMU System emulator for non PC targets::
28 debc7065 bellard
* QEMU Linux User space emulator::
29 debc7065 bellard
* compilation:: Compilation from the sources
30 debc7065 bellard
* Index::
31 debc7065 bellard
@end menu
32 debc7065 bellard
@end ifnottex
33 debc7065 bellard
34 debc7065 bellard
@contents
35 debc7065 bellard
36 debc7065 bellard
@node Introduction
37 386405f7 bellard
@chapter Introduction
38 386405f7 bellard
39 debc7065 bellard
@menu
40 debc7065 bellard
* intro_features:: Features
41 debc7065 bellard
@end menu
42 debc7065 bellard
43 debc7065 bellard
@node intro_features
44 322d0c66 bellard
@section Features
45 386405f7 bellard
46 1f673135 bellard
QEMU is a FAST! processor emulator using dynamic translation to
47 1f673135 bellard
achieve good emulation speed.
48 1eb20527 bellard
49 1eb20527 bellard
QEMU has two operating modes:
50 0806e3f6 bellard
51 0806e3f6 bellard
@itemize @minus
52 0806e3f6 bellard
53 0806e3f6 bellard
@item 
54 1f673135 bellard
Full system emulation. In this mode, QEMU emulates a full system (for
55 3f9f3aa1 bellard
example a PC), including one or several processors and various
56 3f9f3aa1 bellard
peripherals. It can be used to launch different Operating Systems
57 3f9f3aa1 bellard
without rebooting the PC or to debug system code.
58 1eb20527 bellard
59 0806e3f6 bellard
@item 
60 1f673135 bellard
User mode emulation (Linux host only). In this mode, QEMU can launch
61 1f673135 bellard
Linux processes compiled for one CPU on another CPU. It can be used to
62 1f673135 bellard
launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
63 1f673135 bellard
to ease cross-compilation and cross-debugging.
64 1eb20527 bellard
65 1eb20527 bellard
@end itemize
66 1eb20527 bellard
67 7c3fc84d bellard
QEMU can run without an host kernel driver and yet gives acceptable
68 6f2f2b24 bellard
performance. 
69 322d0c66 bellard
70 52c00a5f bellard
For system emulation, the following hardware targets are supported:
71 52c00a5f bellard
@itemize
72 9d0a8e6f bellard
@item PC (x86 or x86_64 processor)
73 3f9f3aa1 bellard
@item ISA PC (old style PC without PCI bus)
74 52c00a5f bellard
@item PREP (PowerPC processor)
75 9d0a8e6f bellard
@item G3 BW PowerMac (PowerPC processor)
76 9d0a8e6f bellard
@item Mac99 PowerMac (PowerPC processor, in progress)
77 3475187d bellard
@item Sun4m (32-bit Sparc processor)
78 3475187d bellard
@item Sun4u (64-bit Sparc processor, in progress)
79 3f9f3aa1 bellard
@item Malta board (32-bit MIPS processor)
80 ed96ca35 pbrook
@item ARM Integrator/CP (ARM926E or 1026E processor)
81 00a9bf19 pbrook
@item ARM Versatile baseboard (ARM926E)
82 52c00a5f bellard
@end itemize
83 386405f7 bellard
84 e6e5906b pbrook
For user emulation, x86, PowerPC, ARM, MIPS, Sparc32/64 and ColdFire(m68k) CPUs are supported.
85 0806e3f6 bellard
86 debc7065 bellard
@node Installation
87 5b9f457a bellard
@chapter Installation
88 5b9f457a bellard
89 15a34c63 bellard
If you want to compile QEMU yourself, see @ref{compilation}.
90 15a34c63 bellard
91 debc7065 bellard
@menu
92 debc7065 bellard
* install_linux::   Linux
93 debc7065 bellard
* install_windows:: Windows
94 debc7065 bellard
* install_mac::     Macintosh
95 debc7065 bellard
@end menu
96 debc7065 bellard
97 debc7065 bellard
@node install_linux
98 1f673135 bellard
@section Linux
99 1f673135 bellard
100 7c3fc84d bellard
If a precompiled package is available for your distribution - you just
101 7c3fc84d bellard
have to install it. Otherwise, see @ref{compilation}.
102 5b9f457a bellard
103 debc7065 bellard
@node install_windows
104 1f673135 bellard
@section Windows
105 8cd0ac2f bellard
106 15a34c63 bellard
Download the experimental binary installer at
107 debc7065 bellard
@url{http://www.free.oszoo.org/@/download.html}.
108 d691f669 bellard
109 debc7065 bellard
@node install_mac
110 1f673135 bellard
@section Mac OS X
111 d691f669 bellard
112 15a34c63 bellard
Download the experimental binary installer at
113 debc7065 bellard
@url{http://www.free.oszoo.org/@/download.html}.
114 df0f11a0 bellard
115 debc7065 bellard
@node QEMU PC System emulator
116 3f9f3aa1 bellard
@chapter QEMU PC System emulator
117 1eb20527 bellard
118 debc7065 bellard
@menu
119 debc7065 bellard
* pcsys_introduction:: Introduction
120 debc7065 bellard
* pcsys_quickstart::   Quick Start
121 debc7065 bellard
* sec_invocation::     Invocation
122 debc7065 bellard
* pcsys_keys::         Keys
123 debc7065 bellard
* pcsys_monitor::      QEMU Monitor
124 debc7065 bellard
* disk_images::        Disk Images
125 debc7065 bellard
* pcsys_network::      Network emulation
126 debc7065 bellard
* direct_linux_boot::  Direct Linux Boot
127 debc7065 bellard
* pcsys_usb::          USB emulation
128 debc7065 bellard
* gdb_usage::          GDB usage
129 debc7065 bellard
* pcsys_os_specific::  Target OS specific information
130 debc7065 bellard
@end menu
131 debc7065 bellard
132 debc7065 bellard
@node pcsys_introduction
133 0806e3f6 bellard
@section Introduction
134 0806e3f6 bellard
135 0806e3f6 bellard
@c man begin DESCRIPTION
136 0806e3f6 bellard
137 3f9f3aa1 bellard
The QEMU PC System emulator simulates the
138 3f9f3aa1 bellard
following peripherals:
139 0806e3f6 bellard
140 0806e3f6 bellard
@itemize @minus
141 15a34c63 bellard
@item 
142 15a34c63 bellard
i440FX host PCI bridge and PIIX3 PCI to ISA bridge
143 0806e3f6 bellard
@item
144 15a34c63 bellard
Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
145 15a34c63 bellard
extensions (hardware level, including all non standard modes).
146 0806e3f6 bellard
@item
147 0806e3f6 bellard
PS/2 mouse and keyboard
148 0806e3f6 bellard
@item 
149 15a34c63 bellard
2 PCI IDE interfaces with hard disk and CD-ROM support
150 1f673135 bellard
@item
151 1f673135 bellard
Floppy disk
152 0806e3f6 bellard
@item 
153 15a34c63 bellard
NE2000 PCI network adapters
154 0806e3f6 bellard
@item
155 05d5818c bellard
Serial ports
156 05d5818c bellard
@item
157 c0fe3827 bellard
Creative SoundBlaster 16 sound card
158 c0fe3827 bellard
@item
159 c0fe3827 bellard
ENSONIQ AudioPCI ES1370 sound card
160 c0fe3827 bellard
@item
161 c0fe3827 bellard
Adlib(OPL2) - Yamaha YM3812 compatible chip
162 b389dbfb bellard
@item
163 b389dbfb bellard
PCI UHCI USB controller and a virtual USB hub.
164 0806e3f6 bellard
@end itemize
165 0806e3f6 bellard
166 3f9f3aa1 bellard
SMP is supported with up to 255 CPUs.
167 3f9f3aa1 bellard
168 c0fe3827 bellard
Note that adlib is only available when QEMU was configured with
169 c0fe3827 bellard
-enable-adlib
170 c0fe3827 bellard
171 15a34c63 bellard
QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
172 15a34c63 bellard
VGA BIOS.
173 15a34c63 bellard
174 c0fe3827 bellard
QEMU uses YM3812 emulation by Tatsuyuki Satoh.
175 c0fe3827 bellard
176 0806e3f6 bellard
@c man end
177 0806e3f6 bellard
178 debc7065 bellard
@node pcsys_quickstart
179 1eb20527 bellard
@section Quick Start
180 1eb20527 bellard
181 285dc330 bellard
Download and uncompress the linux image (@file{linux.img}) and type:
182 0806e3f6 bellard
183 0806e3f6 bellard
@example
184 285dc330 bellard
qemu linux.img
185 0806e3f6 bellard
@end example
186 0806e3f6 bellard
187 0806e3f6 bellard
Linux should boot and give you a prompt.
188 0806e3f6 bellard
189 6cc721cf bellard
@node sec_invocation
190 ec410fc9 bellard
@section Invocation
191 ec410fc9 bellard
192 ec410fc9 bellard
@example
193 0806e3f6 bellard
@c man begin SYNOPSIS
194 0806e3f6 bellard
usage: qemu [options] [disk_image]
195 0806e3f6 bellard
@c man end
196 ec410fc9 bellard
@end example
197 ec410fc9 bellard
198 0806e3f6 bellard
@c man begin OPTIONS
199 9d4520d0 bellard
@var{disk_image} is a raw hard disk image for IDE hard disk 0.
200 ec410fc9 bellard
201 ec410fc9 bellard
General options:
202 ec410fc9 bellard
@table @option
203 3dbbdc25 bellard
@item -M machine
204 3dbbdc25 bellard
Select the emulated machine (@code{-M ?} for list)
205 3dbbdc25 bellard
206 2be3bc02 bellard
@item -fda file
207 2be3bc02 bellard
@item -fdb file
208 debc7065 bellard
Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
209 19cb3738 bellard
use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
210 2be3bc02 bellard
211 ec410fc9 bellard
@item -hda file
212 ec410fc9 bellard
@item -hdb file
213 181f1558 bellard
@item -hdc file
214 181f1558 bellard
@item -hdd file
215 debc7065 bellard
Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
216 1f47a922 bellard
217 181f1558 bellard
@item -cdrom file
218 181f1558 bellard
Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and and
219 be3edd95 bellard
@option{-cdrom} at the same time). You can use the host CD-ROM by
220 19cb3738 bellard
using @file{/dev/cdrom} as filename (@pxref{host_drives}).
221 181f1558 bellard
222 eec85c2a ths
@item -boot [a|c|d|n]
223 eec85c2a ths
Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
224 eec85c2a ths
is the default.
225 1f47a922 bellard
226 181f1558 bellard
@item -snapshot
227 1f47a922 bellard
Write to temporary files instead of disk image files. In this case,
228 1f47a922 bellard
the raw disk image you use is not written back. You can however force
229 42550fde ths
the write back by pressing @key{C-a s} (@pxref{disk_images}).
230 ec410fc9 bellard
231 52ca8d6a bellard
@item -no-fd-bootchk
232 52ca8d6a bellard
Disable boot signature checking for floppy disks in Bochs BIOS. It may
233 52ca8d6a bellard
be needed to boot from old floppy disks.
234 52ca8d6a bellard
235 ec410fc9 bellard
@item -m megs
236 15a34c63 bellard
Set virtual RAM size to @var{megs} megabytes. Default is 128 MB.
237 ec410fc9 bellard
238 3f9f3aa1 bellard
@item -smp n
239 3f9f3aa1 bellard
Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
240 3f9f3aa1 bellard
CPUs are supported.
241 3f9f3aa1 bellard
242 0806e3f6 bellard
@item -nographic
243 0806e3f6 bellard
244 0806e3f6 bellard
Normally, QEMU uses SDL to display the VGA output. With this option,
245 0806e3f6 bellard
you can totally disable graphical output so that QEMU is a simple
246 0806e3f6 bellard
command line application. The emulated serial port is redirected on
247 0806e3f6 bellard
the console. Therefore, you can still use QEMU to debug a Linux kernel
248 0806e3f6 bellard
with a serial console.
249 0806e3f6 bellard
250 73fc9742 ths
@item -vnc display
251 24236869 bellard
252 24236869 bellard
Normally, QEMU uses SDL to display the VGA output.  With this option,
253 73fc9742 ths
you can have QEMU listen on VNC display @var{display} and redirect the VGA
254 3c656346 bellard
display over the VNC session.  It is very useful to enable the usb
255 3c656346 bellard
tablet device when using this option (option @option{-usbdevice
256 3c656346 bellard
tablet}). When using the VNC display, you must use the @option{-k}
257 73fc9742 ths
option to set the keyboard layout if you are not using en-us.
258 73fc9742 ths
259 73fc9742 ths
@var{display} may be in the form @var{interface:d}, in which case connections
260 73fc9742 ths
will only be allowed from @var{interface} on display @var{d}. Optionally,
261 73fc9742 ths
@var{interface} can be omitted.  @var{display} can also be in the form
262 73fc9742 ths
@var{unix:path} where @var{path} is the location of a unix socket to listen for
263 73fc9742 ths
connections on.
264 73fc9742 ths
265 24236869 bellard
266 3d11d0eb bellard
@item -k language
267 3d11d0eb bellard
268 3d11d0eb bellard
Use keyboard layout @var{language} (for example @code{fr} for
269 3d11d0eb bellard
French). This option is only needed where it is not easy to get raw PC
270 3c656346 bellard
keycodes (e.g. on Macs, with some X11 servers or with a VNC
271 3c656346 bellard
display). You don't normally need to use it on PC/Linux or PC/Windows
272 3c656346 bellard
hosts.
273 3d11d0eb bellard
274 3d11d0eb bellard
The available layouts are:
275 3d11d0eb bellard
@example
276 3d11d0eb bellard
ar  de-ch  es  fo     fr-ca  hu  ja  mk     no  pt-br  sv
277 3d11d0eb bellard
da  en-gb  et  fr     fr-ch  is  lt  nl     pl  ru     th
278 3d11d0eb bellard
de  en-us  fi  fr-be  hr     it  lv  nl-be  pt  sl     tr
279 3d11d0eb bellard
@end example
280 3d11d0eb bellard
281 3d11d0eb bellard
The default is @code{en-us}.
282 3d11d0eb bellard
283 1d14ffa9 bellard
@item -audio-help
284 1d14ffa9 bellard
285 1d14ffa9 bellard
Will show the audio subsystem help: list of drivers, tunable
286 1d14ffa9 bellard
parameters.
287 1d14ffa9 bellard
288 6a36d84e bellard
@item -soundhw card1,card2,... or -soundhw all
289 1d14ffa9 bellard
290 1d14ffa9 bellard
Enable audio and selected sound hardware. Use ? to print all
291 1d14ffa9 bellard
available sound hardware.
292 1d14ffa9 bellard
293 1d14ffa9 bellard
@example
294 1d14ffa9 bellard
qemu -soundhw sb16,adlib hda
295 1d14ffa9 bellard
qemu -soundhw es1370 hda
296 6a36d84e bellard
qemu -soundhw all hda
297 1d14ffa9 bellard
qemu -soundhw ?
298 1d14ffa9 bellard
@end example
299 a8c490cd bellard
300 15a34c63 bellard
@item -localtime
301 15a34c63 bellard
Set the real time clock to local time (the default is to UTC
302 15a34c63 bellard
time). This option is needed to have correct date in MS-DOS or
303 15a34c63 bellard
Windows.
304 15a34c63 bellard
305 d63d307f bellard
@item -full-screen
306 d63d307f bellard
Start in full screen.
307 d63d307f bellard
308 f7cce898 bellard
@item -pidfile file
309 f7cce898 bellard
Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
310 f7cce898 bellard
from a script.
311 f7cce898 bellard
312 71e3ceb8 ths
@item -daemonize
313 71e3ceb8 ths
Daemonize the QEMU process after initialization.  QEMU will not detach from
314 71e3ceb8 ths
standard IO until it is ready to receive connections on any of its devices.
315 71e3ceb8 ths
This option is a useful way for external programs to launch QEMU without having
316 71e3ceb8 ths
to cope with initialization race conditions.
317 71e3ceb8 ths
318 9d0a8e6f bellard
@item -win2k-hack
319 9d0a8e6f bellard
Use it when installing Windows 2000 to avoid a disk full bug. After
320 9d0a8e6f bellard
Windows 2000 is installed, you no longer need this option (this option
321 9d0a8e6f bellard
slows down the IDE transfers).
322 9d0a8e6f bellard
323 9ae02555 ths
@item -option-rom file
324 9ae02555 ths
Load the contents of file as an option ROM.  This option is useful to load
325 9ae02555 ths
things like EtherBoot.
326 9ae02555 ths
327 0806e3f6 bellard
@end table
328 0806e3f6 bellard
329 b389dbfb bellard
USB options:
330 b389dbfb bellard
@table @option
331 b389dbfb bellard
332 b389dbfb bellard
@item -usb
333 b389dbfb bellard
Enable the USB driver (will be the default soon)
334 b389dbfb bellard
335 b389dbfb bellard
@item -usbdevice devname
336 0aff66b5 pbrook
Add the USB device @var{devname}. @xref{usb_devices}.
337 b389dbfb bellard
@end table
338 b389dbfb bellard
339 1f673135 bellard
Network options:
340 1f673135 bellard
341 1f673135 bellard
@table @option
342 1f673135 bellard
343 a41b2ff2 pbrook
@item -net nic[,vlan=n][,macaddr=addr][,model=type]
344 41d03949 bellard
Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
345 41d03949 bellard
= 0 is the default). The NIC is currently an NE2000 on the PC
346 41d03949 bellard
target. Optionally, the MAC address can be changed. If no
347 41d03949 bellard
@option{-net} option is specified, a single NIC is created.
348 a41b2ff2 pbrook
Qemu can emulate several different models of network card.  Valid values for
349 a41b2ff2 pbrook
@var{type} are @code{ne2k_pci}, @code{ne2k_isa}, @code{rtl8139},
350 a41b2ff2 pbrook
@code{smc91c111} and @code{lance}.  Not all devices are supported on all
351 a41b2ff2 pbrook
targets.
352 41d03949 bellard
353 115defd1 pbrook
@item -net user[,vlan=n][,hostname=name]
354 7e89463d bellard
Use the user mode network stack which requires no administrator
355 a03a6053 pbrook
priviledge to run.  @option{hostname=name} can be used to specify the client
356 115defd1 pbrook
hostname reported by the builtin DHCP server.
357 41d03949 bellard
358 41d03949 bellard
@item -net tap[,vlan=n][,fd=h][,ifname=name][,script=file]
359 41d03949 bellard
Connect the host TAP network interface @var{name} to VLAN @var{n} and
360 41d03949 bellard
use the network script @var{file} to configure it. The default
361 41d03949 bellard
network script is @file{/etc/qemu-ifup}. If @var{name} is not
362 41d03949 bellard
provided, the OS automatically provides one.  @option{fd=h} can be
363 41d03949 bellard
used to specify the handle of an already opened host TAP interface. Example:
364 1f673135 bellard
365 41d03949 bellard
@example
366 41d03949 bellard
qemu linux.img -net nic -net tap
367 41d03949 bellard
@end example
368 41d03949 bellard
369 41d03949 bellard
More complicated example (two NICs, each one connected to a TAP device)
370 41d03949 bellard
@example
371 41d03949 bellard
qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
372 41d03949 bellard
               -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
373 41d03949 bellard
@end example
374 3f1a88f4 bellard
375 3f1a88f4 bellard
376 41d03949 bellard
@item -net socket[,vlan=n][,fd=h][,listen=[host]:port][,connect=host:port]
377 1f673135 bellard
378 41d03949 bellard
Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
379 41d03949 bellard
machine using a TCP socket connection. If @option{listen} is
380 41d03949 bellard
specified, QEMU waits for incoming connections on @var{port}
381 41d03949 bellard
(@var{host} is optional). @option{connect} is used to connect to
382 3d830459 bellard
another QEMU instance using the @option{listen} option. @option{fd=h}
383 3d830459 bellard
specifies an already opened TCP socket.
384 1f673135 bellard
385 41d03949 bellard
Example:
386 41d03949 bellard
@example
387 41d03949 bellard
# launch a first QEMU instance
388 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
389 debc7065 bellard
               -net socket,listen=:1234
390 debc7065 bellard
# connect the VLAN 0 of this instance to the VLAN 0
391 debc7065 bellard
# of the first instance
392 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
393 debc7065 bellard
               -net socket,connect=127.0.0.1:1234
394 41d03949 bellard
@end example
395 52c00a5f bellard
396 3d830459 bellard
@item -net socket[,vlan=n][,fd=h][,mcast=maddr:port]
397 3d830459 bellard
398 3d830459 bellard
Create a VLAN @var{n} shared with another QEMU virtual
399 3d830459 bellard
machines using a UDP multicast socket, effectively making a bus for 
400 3d830459 bellard
every QEMU with same multicast address @var{maddr} and @var{port}.
401 3d830459 bellard
NOTES:
402 3d830459 bellard
@enumerate
403 3d830459 bellard
@item 
404 3d830459 bellard
Several QEMU can be running on different hosts and share same bus (assuming 
405 3d830459 bellard
correct multicast setup for these hosts).
406 3d830459 bellard
@item
407 3d830459 bellard
mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
408 3d830459 bellard
@url{http://user-mode-linux.sf.net}.
409 3d830459 bellard
@item Use @option{fd=h} to specify an already opened UDP multicast socket.
410 3d830459 bellard
@end enumerate
411 3d830459 bellard
412 3d830459 bellard
Example:
413 3d830459 bellard
@example
414 3d830459 bellard
# launch one QEMU instance
415 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
416 debc7065 bellard
               -net socket,mcast=230.0.0.1:1234
417 3d830459 bellard
# launch another QEMU instance on same "bus"
418 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
419 debc7065 bellard
               -net socket,mcast=230.0.0.1:1234
420 3d830459 bellard
# launch yet another QEMU instance on same "bus"
421 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
422 debc7065 bellard
               -net socket,mcast=230.0.0.1:1234
423 3d830459 bellard
@end example
424 3d830459 bellard
425 3d830459 bellard
Example (User Mode Linux compat.):
426 3d830459 bellard
@example
427 debc7065 bellard
# launch QEMU instance (note mcast address selected
428 debc7065 bellard
# is UML's default)
429 debc7065 bellard
qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
430 debc7065 bellard
               -net socket,mcast=239.192.168.1:1102
431 3d830459 bellard
# launch UML
432 3d830459 bellard
/path/to/linux ubd0=/path/to/root_fs eth0=mcast
433 3d830459 bellard
@end example
434 3d830459 bellard
435 41d03949 bellard
@item -net none
436 41d03949 bellard
Indicate that no network devices should be configured. It is used to
437 039af320 bellard
override the default configuration (@option{-net nic -net user}) which
438 039af320 bellard
is activated if no @option{-net} options are provided.
439 52c00a5f bellard
440 9bf05444 bellard
@item -tftp prefix
441 9bf05444 bellard
When using the user mode network stack, activate a built-in TFTP
442 9bf05444 bellard
server. All filenames beginning with @var{prefix} can be downloaded
443 9bf05444 bellard
from the host to the guest using a TFTP client. The TFTP client on the
444 9bf05444 bellard
guest must be configured in binary mode (use the command @code{bin} of
445 9bf05444 bellard
the Unix TFTP client). The host IP address on the guest is as usual
446 9bf05444 bellard
10.0.2.2.
447 9bf05444 bellard
448 2518bd0d bellard
@item -smb dir
449 2518bd0d bellard
When using the user mode network stack, activate a built-in SMB
450 2518bd0d bellard
server so that Windows OSes can access to the host files in @file{dir}
451 2518bd0d bellard
transparently.
452 2518bd0d bellard
453 2518bd0d bellard
In the guest Windows OS, the line:
454 2518bd0d bellard
@example
455 2518bd0d bellard
10.0.2.4 smbserver
456 2518bd0d bellard
@end example
457 2518bd0d bellard
must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
458 2518bd0d bellard
or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
459 2518bd0d bellard
460 2518bd0d bellard
Then @file{dir} can be accessed in @file{\\smbserver\qemu}.
461 2518bd0d bellard
462 2518bd0d bellard
Note that a SAMBA server must be installed on the host OS in
463 366dfc52 ths
@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
464 6cc721cf bellard
2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
465 2518bd0d bellard
466 9bf05444 bellard
@item -redir [tcp|udp]:host-port:[guest-host]:guest-port
467 9bf05444 bellard
468 9bf05444 bellard
When using the user mode network stack, redirect incoming TCP or UDP
469 9bf05444 bellard
connections to the host port @var{host-port} to the guest
470 9bf05444 bellard
@var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
471 9bf05444 bellard
is not specified, its value is 10.0.2.15 (default address given by the
472 9bf05444 bellard
built-in DHCP server).
473 9bf05444 bellard
474 9bf05444 bellard
For example, to redirect host X11 connection from screen 1 to guest
475 9bf05444 bellard
screen 0, use the following:
476 9bf05444 bellard
477 9bf05444 bellard
@example
478 9bf05444 bellard
# on the host
479 9bf05444 bellard
qemu -redir tcp:6001::6000 [...]
480 9bf05444 bellard
# this host xterm should open in the guest X11 server
481 9bf05444 bellard
xterm -display :1
482 9bf05444 bellard
@end example
483 9bf05444 bellard
484 9bf05444 bellard
To redirect telnet connections from host port 5555 to telnet port on
485 9bf05444 bellard
the guest, use the following:
486 9bf05444 bellard
487 9bf05444 bellard
@example
488 9bf05444 bellard
# on the host
489 9bf05444 bellard
qemu -redir tcp:5555::23 [...]
490 9bf05444 bellard
telnet localhost 5555
491 9bf05444 bellard
@end example
492 9bf05444 bellard
493 9bf05444 bellard
Then when you use on the host @code{telnet localhost 5555}, you
494 9bf05444 bellard
connect to the guest telnet server.
495 9bf05444 bellard
496 1f673135 bellard
@end table
497 1f673135 bellard
498 41d03949 bellard
Linux boot specific: When using these options, you can use a given
499 1f673135 bellard
Linux kernel without installing it in the disk image. It can be useful
500 1f673135 bellard
for easier testing of various kernels.
501 1f673135 bellard
502 0806e3f6 bellard
@table @option
503 0806e3f6 bellard
504 0806e3f6 bellard
@item -kernel bzImage 
505 0806e3f6 bellard
Use @var{bzImage} as kernel image.
506 0806e3f6 bellard
507 0806e3f6 bellard
@item -append cmdline 
508 0806e3f6 bellard
Use @var{cmdline} as kernel command line
509 0806e3f6 bellard
510 0806e3f6 bellard
@item -initrd file
511 0806e3f6 bellard
Use @var{file} as initial ram disk.
512 0806e3f6 bellard
513 ec410fc9 bellard
@end table
514 ec410fc9 bellard
515 15a34c63 bellard
Debug/Expert options:
516 ec410fc9 bellard
@table @option
517 a0a821a4 bellard
518 a0a821a4 bellard
@item -serial dev
519 0bab00f3 bellard
Redirect the virtual serial port to host character device
520 0bab00f3 bellard
@var{dev}. The default device is @code{vc} in graphical mode and
521 0bab00f3 bellard
@code{stdio} in non graphical mode.
522 0bab00f3 bellard
523 0bab00f3 bellard
This option can be used several times to simulate up to 4 serials
524 0bab00f3 bellard
ports.
525 0bab00f3 bellard
526 c03b0f0f bellard
Use @code{-serial none} to disable all serial ports.
527 c03b0f0f bellard
528 0bab00f3 bellard
Available character devices are:
529 a0a821a4 bellard
@table @code
530 a0a821a4 bellard
@item vc
531 a0a821a4 bellard
Virtual console
532 a0a821a4 bellard
@item pty
533 a0a821a4 bellard
[Linux only] Pseudo TTY (a new PTY is automatically allocated)
534 c03b0f0f bellard
@item none
535 c03b0f0f bellard
No device is allocated.
536 a0a821a4 bellard
@item null
537 a0a821a4 bellard
void device
538 f8d179e3 bellard
@item /dev/XXX
539 e57a8c0e bellard
[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
540 f8d179e3 bellard
parameters are set according to the emulated ones.
541 e57a8c0e bellard
@item /dev/parportN
542 e57a8c0e bellard
[Linux only, parallel port only] Use host parallel port
543 e57a8c0e bellard
@var{N}. Currently only SPP parallel port features can be used.
544 f8d179e3 bellard
@item file:filename
545 f8d179e3 bellard
Write output to filename. No character can be read.
546 a0a821a4 bellard
@item stdio
547 a0a821a4 bellard
[Unix only] standard input/output
548 f8d179e3 bellard
@item pipe:filename
549 0bab00f3 bellard
name pipe @var{filename}
550 0bab00f3 bellard
@item COMn
551 0bab00f3 bellard
[Windows only] Use host serial port @var{n}
552 951f1351 bellard
@item udp:[remote_host]:remote_port[@@[src_ip]:src_port]
553 951f1351 bellard
This implements UDP Net Console.  When @var{remote_host} or @var{src_ip} are not specified they default to @code{0.0.0.0}.  When not using a specifed @var{src_port} a random port is automatically chosen.
554 951f1351 bellard
555 951f1351 bellard
If you just want a simple readonly console you can use @code{netcat} or
556 951f1351 bellard
@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
557 951f1351 bellard
@code{nc -u -l -p 4555}. Any time qemu writes something to that port it
558 951f1351 bellard
will appear in the netconsole session.
559 0bab00f3 bellard
560 0bab00f3 bellard
If you plan to send characters back via netconsole or you want to stop
561 0bab00f3 bellard
and start qemu a lot of times, you should have qemu use the same
562 0bab00f3 bellard
source port each time by using something like @code{-serial
563 951f1351 bellard
udp::4555@@:4556} to qemu. Another approach is to use a patched
564 0bab00f3 bellard
version of netcat which can listen to a TCP port and send and receive
565 0bab00f3 bellard
characters via udp.  If you have a patched version of netcat which
566 0bab00f3 bellard
activates telnet remote echo and single char transfer, then you can
567 0bab00f3 bellard
use the following options to step up a netcat redirector to allow
568 0bab00f3 bellard
telnet on port 5555 to access the qemu port.
569 0bab00f3 bellard
@table @code
570 951f1351 bellard
@item Qemu Options:
571 951f1351 bellard
-serial udp::4555@@:4556
572 951f1351 bellard
@item netcat options:
573 951f1351 bellard
-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
574 951f1351 bellard
@item telnet options:
575 951f1351 bellard
localhost 5555
576 951f1351 bellard
@end table
577 951f1351 bellard
578 951f1351 bellard
579 951f1351 bellard
@item tcp:[host]:port[,server][,nowait]
580 951f1351 bellard
The TCP Net Console has two modes of operation.  It can send the serial
581 951f1351 bellard
I/O to a location or wait for a connection from a location.  By default
582 951f1351 bellard
the TCP Net Console is sent to @var{host} at the @var{port}.  If you use
583 f542086d bellard
the @var{server} option QEMU will wait for a client socket application
584 f542086d bellard
to connect to the port before continuing, unless the @code{nowait}
585 951f1351 bellard
option was specified. If @var{host} is omitted, 0.0.0.0 is assumed. Only
586 951f1351 bellard
one TCP connection at a time is accepted. You can use @code{telnet} to
587 951f1351 bellard
connect to the corresponding character device.
588 951f1351 bellard
@table @code
589 951f1351 bellard
@item Example to send tcp console to 192.168.0.2 port 4444
590 951f1351 bellard
-serial tcp:192.168.0.2:4444
591 951f1351 bellard
@item Example to listen and wait on port 4444 for connection
592 951f1351 bellard
-serial tcp::4444,server
593 951f1351 bellard
@item Example to not wait and listen on ip 192.168.0.100 port 4444
594 951f1351 bellard
-serial tcp:192.168.0.100:4444,server,nowait
595 a0a821a4 bellard
@end table
596 a0a821a4 bellard
597 951f1351 bellard
@item telnet:host:port[,server][,nowait]
598 951f1351 bellard
The telnet protocol is used instead of raw tcp sockets.  The options
599 951f1351 bellard
work the same as if you had specified @code{-serial tcp}.  The
600 951f1351 bellard
difference is that the port acts like a telnet server or client using
601 951f1351 bellard
telnet option negotiation.  This will also allow you to send the
602 951f1351 bellard
MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
603 951f1351 bellard
sequence.  Typically in unix telnet you do it with Control-] and then
604 951f1351 bellard
type "send break" followed by pressing the enter key.
605 0bab00f3 bellard
606 ffd843bc ths
@item unix:path[,server][,nowait]
607 ffd843bc ths
A unix domain socket is used instead of a tcp socket.  The option works the
608 ffd843bc ths
same as if you had specified @code{-serial tcp} except the unix domain socket
609 ffd843bc ths
@var{path} is used for connections.
610 ffd843bc ths
611 0bab00f3 bellard
@end table
612 05d5818c bellard
613 e57a8c0e bellard
@item -parallel dev
614 e57a8c0e bellard
Redirect the virtual parallel port to host device @var{dev} (same
615 e57a8c0e bellard
devices as the serial port). On Linux hosts, @file{/dev/parportN} can
616 e57a8c0e bellard
be used to use hardware devices connected on the corresponding host
617 e57a8c0e bellard
parallel port.
618 e57a8c0e bellard
619 e57a8c0e bellard
This option can be used several times to simulate up to 3 parallel
620 e57a8c0e bellard
ports.
621 e57a8c0e bellard
622 c03b0f0f bellard
Use @code{-parallel none} to disable all parallel ports.
623 c03b0f0f bellard
624 a0a821a4 bellard
@item -monitor dev
625 a0a821a4 bellard
Redirect the monitor to host device @var{dev} (same devices as the
626 a0a821a4 bellard
serial port).
627 a0a821a4 bellard
The default device is @code{vc} in graphical mode and @code{stdio} in
628 a0a821a4 bellard
non graphical mode.
629 a0a821a4 bellard
630 ec410fc9 bellard
@item -s
631 debc7065 bellard
Wait gdb connection to port 1234 (@pxref{gdb_usage}). 
632 ec410fc9 bellard
@item -p port
633 ec410fc9 bellard
Change gdb connection port.
634 52c00a5f bellard
@item -S
635 52c00a5f bellard
Do not start CPU at startup (you must type 'c' in the monitor).
636 ec410fc9 bellard
@item -d             
637 9d4520d0 bellard
Output log in /tmp/qemu.log
638 46d4767d bellard
@item -hdachs c,h,s,[,t]
639 46d4767d bellard
Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
640 46d4767d bellard
@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
641 46d4767d bellard
translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
642 46d4767d bellard
all thoses parameters. This option is useful for old MS-DOS disk
643 46d4767d bellard
images.
644 7c3fc84d bellard
645 87b47350 bellard
@item -L path
646 87b47350 bellard
Set the directory for the BIOS, VGA BIOS and keymaps.
647 87b47350 bellard
648 15a34c63 bellard
@item -std-vga
649 15a34c63 bellard
Simulate a standard VGA card with Bochs VBE extensions (default is
650 3cb0853a bellard
Cirrus Logic GD5446 PCI VGA). If your guest OS supports the VESA 2.0
651 3cb0853a bellard
VBE extensions (e.g. Windows XP) and if you want to use high
652 3cb0853a bellard
resolution modes (>= 1280x1024x16) then you should use this option.
653 3cb0853a bellard
654 3c656346 bellard
@item -no-acpi
655 3c656346 bellard
Disable ACPI (Advanced Configuration and Power Interface) support. Use
656 3c656346 bellard
it if your guest OS complains about ACPI problems (PC target machine
657 3c656346 bellard
only).
658 3c656346 bellard
659 d1beab82 bellard
@item -no-reboot
660 d1beab82 bellard
Exit instead of rebooting.
661 d1beab82 bellard
662 d63d307f bellard
@item -loadvm file
663 d63d307f bellard
Start right away with a saved state (@code{loadvm} in monitor)
664 8e71621f pbrook
665 8e71621f pbrook
@item -semihosting
666 8e71621f pbrook
Enable "Angel" semihosting interface (ARM target machines only).
667 8e71621f pbrook
Note that this allows guest direct access to the host filesystem,
668 8e71621f pbrook
so should only be used with trusted guest OS.
669 ec410fc9 bellard
@end table
670 ec410fc9 bellard
671 3e11db9a bellard
@c man end
672 3e11db9a bellard
673 debc7065 bellard
@node pcsys_keys
674 3e11db9a bellard
@section Keys
675 3e11db9a bellard
676 3e11db9a bellard
@c man begin OPTIONS
677 3e11db9a bellard
678 a1b74fe8 bellard
During the graphical emulation, you can use the following keys:
679 a1b74fe8 bellard
@table @key
680 f9859310 bellard
@item Ctrl-Alt-f
681 a1b74fe8 bellard
Toggle full screen
682 a0a821a4 bellard
683 f9859310 bellard
@item Ctrl-Alt-n
684 a0a821a4 bellard
Switch to virtual console 'n'. Standard console mappings are:
685 a0a821a4 bellard
@table @emph
686 a0a821a4 bellard
@item 1
687 a0a821a4 bellard
Target system display
688 a0a821a4 bellard
@item 2
689 a0a821a4 bellard
Monitor
690 a0a821a4 bellard
@item 3
691 a0a821a4 bellard
Serial port
692 a1b74fe8 bellard
@end table
693 a1b74fe8 bellard
694 f9859310 bellard
@item Ctrl-Alt
695 a0a821a4 bellard
Toggle mouse and keyboard grab.
696 a0a821a4 bellard
@end table
697 a0a821a4 bellard
698 3e11db9a bellard
In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
699 3e11db9a bellard
@key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
700 3e11db9a bellard
701 a0a821a4 bellard
During emulation, if you are using the @option{-nographic} option, use
702 a0a821a4 bellard
@key{Ctrl-a h} to get terminal commands:
703 ec410fc9 bellard
704 ec410fc9 bellard
@table @key
705 a1b74fe8 bellard
@item Ctrl-a h
706 ec410fc9 bellard
Print this help
707 a1b74fe8 bellard
@item Ctrl-a x    
708 366dfc52 ths
Exit emulator
709 a1b74fe8 bellard
@item Ctrl-a s    
710 1f47a922 bellard
Save disk data back to file (if -snapshot)
711 a1b74fe8 bellard
@item Ctrl-a b
712 1f673135 bellard
Send break (magic sysrq in Linux)
713 a1b74fe8 bellard
@item Ctrl-a c
714 1f673135 bellard
Switch between console and monitor
715 a1b74fe8 bellard
@item Ctrl-a Ctrl-a
716 a1b74fe8 bellard
Send Ctrl-a
717 ec410fc9 bellard
@end table
718 0806e3f6 bellard
@c man end
719 0806e3f6 bellard
720 0806e3f6 bellard
@ignore
721 0806e3f6 bellard
722 1f673135 bellard
@c man begin SEEALSO
723 1f673135 bellard
The HTML documentation of QEMU for more precise information and Linux
724 1f673135 bellard
user mode emulator invocation.
725 1f673135 bellard
@c man end
726 1f673135 bellard
727 1f673135 bellard
@c man begin AUTHOR
728 1f673135 bellard
Fabrice Bellard
729 1f673135 bellard
@c man end
730 1f673135 bellard
731 1f673135 bellard
@end ignore
732 1f673135 bellard
733 debc7065 bellard
@node pcsys_monitor
734 1f673135 bellard
@section QEMU Monitor
735 1f673135 bellard
736 1f673135 bellard
The QEMU monitor is used to give complex commands to the QEMU
737 1f673135 bellard
emulator. You can use it to:
738 1f673135 bellard
739 1f673135 bellard
@itemize @minus
740 1f673135 bellard
741 1f673135 bellard
@item
742 1f673135 bellard
Remove or insert removable medias images
743 1f673135 bellard
(such as CD-ROM or floppies)
744 1f673135 bellard
745 1f673135 bellard
@item 
746 1f673135 bellard
Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
747 1f673135 bellard
from a disk file.
748 1f673135 bellard
749 1f673135 bellard
@item Inspect the VM state without an external debugger.
750 1f673135 bellard
751 1f673135 bellard
@end itemize
752 1f673135 bellard
753 1f673135 bellard
@subsection Commands
754 1f673135 bellard
755 1f673135 bellard
The following commands are available:
756 1f673135 bellard
757 1f673135 bellard
@table @option
758 1f673135 bellard
759 1f673135 bellard
@item help or ? [cmd]
760 1f673135 bellard
Show the help for all commands or just for command @var{cmd}.
761 1f673135 bellard
762 1f673135 bellard
@item commit  
763 1f673135 bellard
Commit changes to the disk images (if -snapshot is used)
764 1f673135 bellard
765 1f673135 bellard
@item info subcommand 
766 1f673135 bellard
show various information about the system state
767 1f673135 bellard
768 1f673135 bellard
@table @option
769 1f673135 bellard
@item info network
770 41d03949 bellard
show the various VLANs and the associated devices
771 1f673135 bellard
@item info block
772 1f673135 bellard
show the block devices
773 1f673135 bellard
@item info registers
774 1f673135 bellard
show the cpu registers
775 1f673135 bellard
@item info history
776 1f673135 bellard
show the command line history
777 b389dbfb bellard
@item info pci
778 b389dbfb bellard
show emulated PCI device
779 b389dbfb bellard
@item info usb
780 b389dbfb bellard
show USB devices plugged on the virtual USB hub
781 b389dbfb bellard
@item info usbhost
782 b389dbfb bellard
show all USB host devices
783 a3c25997 bellard
@item info capture
784 a3c25997 bellard
show information about active capturing
785 13a2e80f bellard
@item info snapshots
786 13a2e80f bellard
show list of VM snapshots
787 455204eb ths
@item info mice
788 455204eb ths
show which guest mouse is receiving events
789 1f673135 bellard
@end table
790 1f673135 bellard
791 1f673135 bellard
@item q or quit
792 1f673135 bellard
Quit the emulator.
793 1f673135 bellard
794 1f673135 bellard
@item eject [-f] device
795 1f673135 bellard
Eject a removable media (use -f to force it).
796 1f673135 bellard
797 1f673135 bellard
@item change device filename
798 1f673135 bellard
Change a removable media.
799 1f673135 bellard
800 1f673135 bellard
@item screendump filename
801 1f673135 bellard
Save screen into PPM image @var{filename}.
802 1f673135 bellard
803 455204eb ths
@item mouse_move dx dy [dz]
804 455204eb ths
Move the active mouse to the specified coordinates @var{dx} @var{dy}
805 455204eb ths
with optional scroll axis @var{dz}.
806 455204eb ths
807 455204eb ths
@item mouse_button val
808 455204eb ths
Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
809 455204eb ths
810 455204eb ths
@item mouse_set index
811 455204eb ths
Set which mouse device receives events at given @var{index}, index
812 455204eb ths
can be obtained with
813 455204eb ths
@example
814 455204eb ths
info mice
815 455204eb ths
@end example
816 455204eb ths
817 a3c25997 bellard
@item wavcapture filename [frequency [bits [channels]]]
818 a3c25997 bellard
Capture audio into @var{filename}. Using sample rate @var{frequency}
819 a3c25997 bellard
bits per sample @var{bits} and number of channels @var{channels}.
820 a3c25997 bellard
821 a3c25997 bellard
Defaults:
822 a3c25997 bellard
@itemize @minus
823 a3c25997 bellard
@item Sample rate = 44100 Hz - CD quality
824 a3c25997 bellard
@item Bits = 16
825 a3c25997 bellard
@item Number of channels = 2 - Stereo
826 a3c25997 bellard
@end itemize
827 a3c25997 bellard
828 a3c25997 bellard
@item stopcapture index
829 a3c25997 bellard
Stop capture with a given @var{index}, index can be obtained with
830 a3c25997 bellard
@example
831 a3c25997 bellard
info capture
832 a3c25997 bellard
@end example
833 a3c25997 bellard
834 1f673135 bellard
@item log item1[,...]
835 1f673135 bellard
Activate logging of the specified items to @file{/tmp/qemu.log}.
836 1f673135 bellard
837 13a2e80f bellard
@item savevm [tag|id]
838 13a2e80f bellard
Create a snapshot of the whole virtual machine. If @var{tag} is
839 13a2e80f bellard
provided, it is used as human readable identifier. If there is already
840 13a2e80f bellard
a snapshot with the same tag or ID, it is replaced. More info at
841 13a2e80f bellard
@ref{vm_snapshots}.
842 1f673135 bellard
843 13a2e80f bellard
@item loadvm tag|id
844 13a2e80f bellard
Set the whole virtual machine to the snapshot identified by the tag
845 13a2e80f bellard
@var{tag} or the unique snapshot ID @var{id}.
846 13a2e80f bellard
847 13a2e80f bellard
@item delvm tag|id
848 13a2e80f bellard
Delete the snapshot identified by @var{tag} or @var{id}.
849 1f673135 bellard
850 1f673135 bellard
@item stop
851 1f673135 bellard
Stop emulation.
852 1f673135 bellard
853 1f673135 bellard
@item c or cont
854 1f673135 bellard
Resume emulation.
855 1f673135 bellard
856 1f673135 bellard
@item gdbserver [port]
857 1f673135 bellard
Start gdbserver session (default port=1234)
858 1f673135 bellard
859 1f673135 bellard
@item x/fmt addr
860 1f673135 bellard
Virtual memory dump starting at @var{addr}.
861 1f673135 bellard
862 1f673135 bellard
@item xp /fmt addr
863 1f673135 bellard
Physical memory dump starting at @var{addr}.
864 1f673135 bellard
865 1f673135 bellard
@var{fmt} is a format which tells the command how to format the
866 1f673135 bellard
data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
867 1f673135 bellard
868 1f673135 bellard
@table @var
869 1f673135 bellard
@item count 
870 1f673135 bellard
is the number of items to be dumped.
871 1f673135 bellard
872 1f673135 bellard
@item format
873 1f673135 bellard
can be x (hexa), d (signed decimal), u (unsigned decimal), o (octal),
874 1f673135 bellard
c (char) or i (asm instruction).
875 1f673135 bellard
876 1f673135 bellard
@item size
877 52c00a5f bellard
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
878 52c00a5f bellard
@code{h} or @code{w} can be specified with the @code{i} format to
879 52c00a5f bellard
respectively select 16 or 32 bit code instruction size.
880 1f673135 bellard
881 1f673135 bellard
@end table
882 1f673135 bellard
883 1f673135 bellard
Examples: 
884 1f673135 bellard
@itemize
885 1f673135 bellard
@item
886 1f673135 bellard
Dump 10 instructions at the current instruction pointer:
887 1f673135 bellard
@example 
888 1f673135 bellard
(qemu) x/10i $eip
889 1f673135 bellard
0x90107063:  ret
890 1f673135 bellard
0x90107064:  sti
891 1f673135 bellard
0x90107065:  lea    0x0(%esi,1),%esi
892 1f673135 bellard
0x90107069:  lea    0x0(%edi,1),%edi
893 1f673135 bellard
0x90107070:  ret
894 1f673135 bellard
0x90107071:  jmp    0x90107080
895 1f673135 bellard
0x90107073:  nop
896 1f673135 bellard
0x90107074:  nop
897 1f673135 bellard
0x90107075:  nop
898 1f673135 bellard
0x90107076:  nop
899 1f673135 bellard
@end example
900 1f673135 bellard
901 1f673135 bellard
@item
902 1f673135 bellard
Dump 80 16 bit values at the start of the video memory.
903 debc7065 bellard
@smallexample 
904 1f673135 bellard
(qemu) xp/80hx 0xb8000
905 1f673135 bellard
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
906 1f673135 bellard
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
907 1f673135 bellard
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
908 1f673135 bellard
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
909 1f673135 bellard
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
910 1f673135 bellard
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
911 1f673135 bellard
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
912 1f673135 bellard
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
913 1f673135 bellard
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
914 1f673135 bellard
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
915 debc7065 bellard
@end smallexample
916 1f673135 bellard
@end itemize
917 1f673135 bellard
918 1f673135 bellard
@item p or print/fmt expr
919 1f673135 bellard
920 1f673135 bellard
Print expression value. Only the @var{format} part of @var{fmt} is
921 1f673135 bellard
used.
922 0806e3f6 bellard
923 a3a91a35 bellard
@item sendkey keys
924 a3a91a35 bellard
925 a3a91a35 bellard
Send @var{keys} to the emulator. Use @code{-} to press several keys
926 a3a91a35 bellard
simultaneously. Example:
927 a3a91a35 bellard
@example
928 a3a91a35 bellard
sendkey ctrl-alt-f1
929 a3a91a35 bellard
@end example
930 a3a91a35 bellard
931 a3a91a35 bellard
This command is useful to send keys that your graphical user interface
932 a3a91a35 bellard
intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
933 a3a91a35 bellard
934 15a34c63 bellard
@item system_reset
935 15a34c63 bellard
936 15a34c63 bellard
Reset the system.
937 15a34c63 bellard
938 b389dbfb bellard
@item usb_add devname
939 b389dbfb bellard
940 0aff66b5 pbrook
Add the USB device @var{devname}.  For details of available devices see
941 0aff66b5 pbrook
@ref{usb_devices}
942 b389dbfb bellard
943 b389dbfb bellard
@item usb_del devname
944 b389dbfb bellard
945 b389dbfb bellard
Remove the USB device @var{devname} from the QEMU virtual USB
946 b389dbfb bellard
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
947 b389dbfb bellard
command @code{info usb} to see the devices you can remove.
948 b389dbfb bellard
949 1f673135 bellard
@end table
950 0806e3f6 bellard
951 1f673135 bellard
@subsection Integer expressions
952 1f673135 bellard
953 1f673135 bellard
The monitor understands integers expressions for every integer
954 1f673135 bellard
argument. You can use register names to get the value of specifics
955 1f673135 bellard
CPU registers by prefixing them with @emph{$}.
956 ec410fc9 bellard
957 1f47a922 bellard
@node disk_images
958 1f47a922 bellard
@section Disk Images
959 1f47a922 bellard
960 acd935ef bellard
Since version 0.6.1, QEMU supports many disk image formats, including
961 acd935ef bellard
growable disk images (their size increase as non empty sectors are
962 13a2e80f bellard
written), compressed and encrypted disk images. Version 0.8.3 added
963 13a2e80f bellard
the new qcow2 disk image format which is essential to support VM
964 13a2e80f bellard
snapshots.
965 1f47a922 bellard
966 debc7065 bellard
@menu
967 debc7065 bellard
* disk_images_quickstart::    Quick start for disk image creation
968 debc7065 bellard
* disk_images_snapshot_mode:: Snapshot mode
969 13a2e80f bellard
* vm_snapshots::              VM snapshots
970 debc7065 bellard
* qemu_img_invocation::       qemu-img Invocation
971 19cb3738 bellard
* host_drives::               Using host drives
972 debc7065 bellard
* disk_images_fat_images::    Virtual FAT disk images
973 debc7065 bellard
@end menu
974 debc7065 bellard
975 debc7065 bellard
@node disk_images_quickstart
976 acd935ef bellard
@subsection Quick start for disk image creation
977 acd935ef bellard
978 acd935ef bellard
You can create a disk image with the command:
979 1f47a922 bellard
@example
980 acd935ef bellard
qemu-img create myimage.img mysize
981 1f47a922 bellard
@end example
982 acd935ef bellard
where @var{myimage.img} is the disk image filename and @var{mysize} is its
983 acd935ef bellard
size in kilobytes. You can add an @code{M} suffix to give the size in
984 acd935ef bellard
megabytes and a @code{G} suffix for gigabytes.
985 acd935ef bellard
986 debc7065 bellard
See @ref{qemu_img_invocation} for more information.
987 1f47a922 bellard
988 debc7065 bellard
@node disk_images_snapshot_mode
989 1f47a922 bellard
@subsection Snapshot mode
990 1f47a922 bellard
991 1f47a922 bellard
If you use the option @option{-snapshot}, all disk images are
992 1f47a922 bellard
considered as read only. When sectors in written, they are written in
993 1f47a922 bellard
a temporary file created in @file{/tmp}. You can however force the
994 acd935ef bellard
write back to the raw disk images by using the @code{commit} monitor
995 acd935ef bellard
command (or @key{C-a s} in the serial console).
996 1f47a922 bellard
997 13a2e80f bellard
@node vm_snapshots
998 13a2e80f bellard
@subsection VM snapshots
999 13a2e80f bellard
1000 13a2e80f bellard
VM snapshots are snapshots of the complete virtual machine including
1001 13a2e80f bellard
CPU state, RAM, device state and the content of all the writable
1002 13a2e80f bellard
disks. In order to use VM snapshots, you must have at least one non
1003 13a2e80f bellard
removable and writable block device using the @code{qcow2} disk image
1004 13a2e80f bellard
format. Normally this device is the first virtual hard drive.
1005 13a2e80f bellard
1006 13a2e80f bellard
Use the monitor command @code{savevm} to create a new VM snapshot or
1007 13a2e80f bellard
replace an existing one. A human readable name can be assigned to each
1008 19d36792 bellard
snapshot in addition to its numerical ID.
1009 13a2e80f bellard
1010 13a2e80f bellard
Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
1011 13a2e80f bellard
a VM snapshot. @code{info snapshots} lists the available snapshots
1012 13a2e80f bellard
with their associated information:
1013 13a2e80f bellard
1014 13a2e80f bellard
@example
1015 13a2e80f bellard
(qemu) info snapshots
1016 13a2e80f bellard
Snapshot devices: hda
1017 13a2e80f bellard
Snapshot list (from hda):
1018 13a2e80f bellard
ID        TAG                 VM SIZE                DATE       VM CLOCK
1019 13a2e80f bellard
1         start                   41M 2006-08-06 12:38:02   00:00:14.954
1020 13a2e80f bellard
2                                 40M 2006-08-06 12:43:29   00:00:18.633
1021 13a2e80f bellard
3         msys                    40M 2006-08-06 12:44:04   00:00:23.514
1022 13a2e80f bellard
@end example
1023 13a2e80f bellard
1024 13a2e80f bellard
A VM snapshot is made of a VM state info (its size is shown in
1025 13a2e80f bellard
@code{info snapshots}) and a snapshot of every writable disk image.
1026 13a2e80f bellard
The VM state info is stored in the first @code{qcow2} non removable
1027 13a2e80f bellard
and writable block device. The disk image snapshots are stored in
1028 13a2e80f bellard
every disk image. The size of a snapshot in a disk image is difficult
1029 13a2e80f bellard
to evaluate and is not shown by @code{info snapshots} because the
1030 13a2e80f bellard
associated disk sectors are shared among all the snapshots to save
1031 19d36792 bellard
disk space (otherwise each snapshot would need a full copy of all the
1032 19d36792 bellard
disk images).
1033 13a2e80f bellard
1034 13a2e80f bellard
When using the (unrelated) @code{-snapshot} option
1035 13a2e80f bellard
(@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
1036 13a2e80f bellard
but they are deleted as soon as you exit QEMU.
1037 13a2e80f bellard
1038 13a2e80f bellard
VM snapshots currently have the following known limitations:
1039 13a2e80f bellard
@itemize
1040 13a2e80f bellard
@item 
1041 13a2e80f bellard
They cannot cope with removable devices if they are removed or
1042 13a2e80f bellard
inserted after a snapshot is done.
1043 13a2e80f bellard
@item 
1044 13a2e80f bellard
A few device drivers still have incomplete snapshot support so their
1045 13a2e80f bellard
state is not saved or restored properly (in particular USB).
1046 13a2e80f bellard
@end itemize
1047 13a2e80f bellard
1048 acd935ef bellard
@node qemu_img_invocation
1049 acd935ef bellard
@subsection @code{qemu-img} Invocation
1050 1f47a922 bellard
1051 acd935ef bellard
@include qemu-img.texi
1052 05efe46e bellard
1053 19cb3738 bellard
@node host_drives
1054 19cb3738 bellard
@subsection Using host drives
1055 19cb3738 bellard
1056 19cb3738 bellard
In addition to disk image files, QEMU can directly access host
1057 19cb3738 bellard
devices. We describe here the usage for QEMU version >= 0.8.3.
1058 19cb3738 bellard
1059 19cb3738 bellard
@subsubsection Linux
1060 19cb3738 bellard
1061 19cb3738 bellard
On Linux, you can directly use the host device filename instead of a
1062 19cb3738 bellard
disk image filename provided you have enough proviledge to access
1063 19cb3738 bellard
it. For example, use @file{/dev/cdrom} to access to the CDROM or
1064 19cb3738 bellard
@file{/dev/fd0} for the floppy.
1065 19cb3738 bellard
1066 f542086d bellard
@table @code
1067 19cb3738 bellard
@item CD
1068 19cb3738 bellard
You can specify a CDROM device even if no CDROM is loaded. QEMU has
1069 19cb3738 bellard
specific code to detect CDROM insertion or removal. CDROM ejection by
1070 19cb3738 bellard
the guest OS is supported. Currently only data CDs are supported.
1071 19cb3738 bellard
@item Floppy
1072 19cb3738 bellard
You can specify a floppy device even if no floppy is loaded. Floppy
1073 19cb3738 bellard
removal is currently not detected accurately (if you change floppy
1074 19cb3738 bellard
without doing floppy access while the floppy is not loaded, the guest
1075 19cb3738 bellard
OS will think that the same floppy is loaded).
1076 19cb3738 bellard
@item Hard disks
1077 19cb3738 bellard
Hard disks can be used. Normally you must specify the whole disk
1078 19cb3738 bellard
(@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
1079 19cb3738 bellard
see it as a partitioned disk. WARNING: unless you know what you do, it
1080 19cb3738 bellard
is better to only make READ-ONLY accesses to the hard disk otherwise
1081 19cb3738 bellard
you may corrupt your host data (use the @option{-snapshot} command
1082 19cb3738 bellard
line option or modify the device permissions accordingly).
1083 19cb3738 bellard
@end table
1084 19cb3738 bellard
1085 19cb3738 bellard
@subsubsection Windows
1086 19cb3738 bellard
1087 01781963 bellard
@table @code
1088 01781963 bellard
@item CD
1089 01781963 bellard
The prefered syntax is the drive letter (e.g. @file{d:}). The
1090 01781963 bellard
alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
1091 01781963 bellard
supported as an alias to the first CDROM drive.
1092 19cb3738 bellard
1093 19cb3738 bellard
Currently there is no specific code to handle removable medias, so it
1094 19cb3738 bellard
is better to use the @code{change} or @code{eject} monitor commands to
1095 19cb3738 bellard
change or eject media.
1096 01781963 bellard
@item Hard disks
1097 01781963 bellard
Hard disks can be used with the syntax: @file{\\.\PhysicalDriveN}
1098 01781963 bellard
where @var{N} is the drive number (0 is the first hard disk).
1099 01781963 bellard
1100 01781963 bellard
WARNING: unless you know what you do, it is better to only make
1101 01781963 bellard
READ-ONLY accesses to the hard disk otherwise you may corrupt your
1102 01781963 bellard
host data (use the @option{-snapshot} command line so that the
1103 01781963 bellard
modifications are written in a temporary file).
1104 01781963 bellard
@end table
1105 01781963 bellard
1106 19cb3738 bellard
1107 19cb3738 bellard
@subsubsection Mac OS X
1108 19cb3738 bellard
1109 19cb3738 bellard
@file{/dev/cdrom} is an alias to the first CDROM. 
1110 19cb3738 bellard
1111 19cb3738 bellard
Currently there is no specific code to handle removable medias, so it
1112 19cb3738 bellard
is better to use the @code{change} or @code{eject} monitor commands to
1113 19cb3738 bellard
change or eject media.
1114 19cb3738 bellard
1115 debc7065 bellard
@node disk_images_fat_images
1116 2c6cadd4 bellard
@subsection Virtual FAT disk images
1117 2c6cadd4 bellard
1118 2c6cadd4 bellard
QEMU can automatically create a virtual FAT disk image from a
1119 2c6cadd4 bellard
directory tree. In order to use it, just type:
1120 2c6cadd4 bellard
1121 2c6cadd4 bellard
@example 
1122 2c6cadd4 bellard
qemu linux.img -hdb fat:/my_directory
1123 2c6cadd4 bellard
@end example
1124 2c6cadd4 bellard
1125 2c6cadd4 bellard
Then you access access to all the files in the @file{/my_directory}
1126 2c6cadd4 bellard
directory without having to copy them in a disk image or to export
1127 2c6cadd4 bellard
them via SAMBA or NFS. The default access is @emph{read-only}.
1128 2c6cadd4 bellard
1129 2c6cadd4 bellard
Floppies can be emulated with the @code{:floppy:} option:
1130 2c6cadd4 bellard
1131 2c6cadd4 bellard
@example 
1132 2c6cadd4 bellard
qemu linux.img -fda fat:floppy:/my_directory
1133 2c6cadd4 bellard
@end example
1134 2c6cadd4 bellard
1135 2c6cadd4 bellard
A read/write support is available for testing (beta stage) with the
1136 2c6cadd4 bellard
@code{:rw:} option:
1137 2c6cadd4 bellard
1138 2c6cadd4 bellard
@example 
1139 2c6cadd4 bellard
qemu linux.img -fda fat:floppy:rw:/my_directory
1140 2c6cadd4 bellard
@end example
1141 2c6cadd4 bellard
1142 2c6cadd4 bellard
What you should @emph{never} do:
1143 2c6cadd4 bellard
@itemize
1144 2c6cadd4 bellard
@item use non-ASCII filenames ;
1145 2c6cadd4 bellard
@item use "-snapshot" together with ":rw:" ;
1146 85b2c688 bellard
@item expect it to work when loadvm'ing ;
1147 85b2c688 bellard
@item write to the FAT directory on the host system while accessing it with the guest system.
1148 2c6cadd4 bellard
@end itemize
1149 2c6cadd4 bellard
1150 debc7065 bellard
@node pcsys_network
1151 9d4fb82e bellard
@section Network emulation
1152 9d4fb82e bellard
1153 41d03949 bellard
QEMU can simulate several networks cards (NE2000 boards on the PC
1154 41d03949 bellard
target) and can connect them to an arbitrary number of Virtual Local
1155 41d03949 bellard
Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1156 41d03949 bellard
VLAN. VLAN can be connected between separate instances of QEMU to
1157 41d03949 bellard
simulate large networks. For simpler usage, a non priviledged user mode
1158 41d03949 bellard
network stack can replace the TAP device to have a basic network
1159 41d03949 bellard
connection.
1160 41d03949 bellard
1161 41d03949 bellard
@subsection VLANs
1162 9d4fb82e bellard
1163 41d03949 bellard
QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1164 41d03949 bellard
connection between several network devices. These devices can be for
1165 41d03949 bellard
example QEMU virtual Ethernet cards or virtual Host ethernet devices
1166 41d03949 bellard
(TAP devices).
1167 9d4fb82e bellard
1168 41d03949 bellard
@subsection Using TAP network interfaces
1169 41d03949 bellard
1170 41d03949 bellard
This is the standard way to connect QEMU to a real network. QEMU adds
1171 41d03949 bellard
a virtual network device on your host (called @code{tapN}), and you
1172 41d03949 bellard
can then configure it as if it was a real ethernet card.
1173 9d4fb82e bellard
1174 8f40c388 bellard
@subsubsection Linux host
1175 8f40c388 bellard
1176 9d4fb82e bellard
As an example, you can download the @file{linux-test-xxx.tar.gz}
1177 9d4fb82e bellard
archive and copy the script @file{qemu-ifup} in @file{/etc} and
1178 9d4fb82e bellard
configure properly @code{sudo} so that the command @code{ifconfig}
1179 9d4fb82e bellard
contained in @file{qemu-ifup} can be executed as root. You must verify
1180 41d03949 bellard
that your host kernel supports the TAP network interfaces: the
1181 9d4fb82e bellard
device @file{/dev/net/tun} must be present.
1182 9d4fb82e bellard
1183 ee0f4751 bellard
See @ref{sec_invocation} to have examples of command lines using the
1184 ee0f4751 bellard
TAP network interfaces.
1185 9d4fb82e bellard
1186 8f40c388 bellard
@subsubsection Windows host
1187 8f40c388 bellard
1188 8f40c388 bellard
There is a virtual ethernet driver for Windows 2000/XP systems, called
1189 8f40c388 bellard
TAP-Win32. But it is not included in standard QEMU for Windows,
1190 8f40c388 bellard
so you will need to get it separately. It is part of OpenVPN package,
1191 8f40c388 bellard
so download OpenVPN from : @url{http://openvpn.net/}.
1192 8f40c388 bellard
1193 9d4fb82e bellard
@subsection Using the user mode network stack
1194 9d4fb82e bellard
1195 41d03949 bellard
By using the option @option{-net user} (default configuration if no
1196 41d03949 bellard
@option{-net} option is specified), QEMU uses a completely user mode
1197 41d03949 bellard
network stack (you don't need root priviledge to use the virtual
1198 41d03949 bellard
network). The virtual network configuration is the following:
1199 9d4fb82e bellard
1200 9d4fb82e bellard
@example
1201 9d4fb82e bellard
1202 41d03949 bellard
         QEMU VLAN      <------>  Firewall/DHCP server <-----> Internet
1203 41d03949 bellard
                           |          (10.0.2.2)
1204 9d4fb82e bellard
                           |
1205 2518bd0d bellard
                           ---->  DNS server (10.0.2.3)
1206 2518bd0d bellard
                           |     
1207 2518bd0d bellard
                           ---->  SMB server (10.0.2.4)
1208 9d4fb82e bellard
@end example
1209 9d4fb82e bellard
1210 9d4fb82e bellard
The QEMU VM behaves as if it was behind a firewall which blocks all
1211 9d4fb82e bellard
incoming connections. You can use a DHCP client to automatically
1212 41d03949 bellard
configure the network in the QEMU VM. The DHCP server assign addresses
1213 41d03949 bellard
to the hosts starting from 10.0.2.15.
1214 9d4fb82e bellard
1215 9d4fb82e bellard
In order to check that the user mode network is working, you can ping
1216 9d4fb82e bellard
the address 10.0.2.2 and verify that you got an address in the range
1217 9d4fb82e bellard
10.0.2.x from the QEMU virtual DHCP server.
1218 9d4fb82e bellard
1219 b415a407 bellard
Note that @code{ping} is not supported reliably to the internet as it
1220 b415a407 bellard
would require root priviledges. It means you can only ping the local
1221 b415a407 bellard
router (10.0.2.2).
1222 b415a407 bellard
1223 9bf05444 bellard
When using the built-in TFTP server, the router is also the TFTP
1224 9bf05444 bellard
server.
1225 9bf05444 bellard
1226 9bf05444 bellard
When using the @option{-redir} option, TCP or UDP connections can be
1227 9bf05444 bellard
redirected from the host to the guest. It allows for example to
1228 9bf05444 bellard
redirect X11, telnet or SSH connections.
1229 443f1376 bellard
1230 41d03949 bellard
@subsection Connecting VLANs between QEMU instances
1231 41d03949 bellard
1232 41d03949 bellard
Using the @option{-net socket} option, it is possible to make VLANs
1233 41d03949 bellard
that span several QEMU instances. See @ref{sec_invocation} to have a
1234 41d03949 bellard
basic example.
1235 41d03949 bellard
1236 9d4fb82e bellard
@node direct_linux_boot
1237 9d4fb82e bellard
@section Direct Linux Boot
1238 1f673135 bellard
1239 1f673135 bellard
This section explains how to launch a Linux kernel inside QEMU without
1240 1f673135 bellard
having to make a full bootable image. It is very useful for fast Linux
1241 ee0f4751 bellard
kernel testing.
1242 1f673135 bellard
1243 ee0f4751 bellard
The syntax is:
1244 1f673135 bellard
@example
1245 ee0f4751 bellard
qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1246 1f673135 bellard
@end example
1247 1f673135 bellard
1248 ee0f4751 bellard
Use @option{-kernel} to provide the Linux kernel image and
1249 ee0f4751 bellard
@option{-append} to give the kernel command line arguments. The
1250 ee0f4751 bellard
@option{-initrd} option can be used to provide an INITRD image.
1251 1f673135 bellard
1252 ee0f4751 bellard
When using the direct Linux boot, a disk image for the first hard disk
1253 ee0f4751 bellard
@file{hda} is required because its boot sector is used to launch the
1254 ee0f4751 bellard
Linux kernel.
1255 1f673135 bellard
1256 ee0f4751 bellard
If you do not need graphical output, you can disable it and redirect
1257 ee0f4751 bellard
the virtual serial port and the QEMU monitor to the console with the
1258 ee0f4751 bellard
@option{-nographic} option. The typical command line is:
1259 1f673135 bellard
@example
1260 ee0f4751 bellard
qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1261 ee0f4751 bellard
     -append "root=/dev/hda console=ttyS0" -nographic
1262 1f673135 bellard
@end example
1263 1f673135 bellard
1264 ee0f4751 bellard
Use @key{Ctrl-a c} to switch between the serial console and the
1265 ee0f4751 bellard
monitor (@pxref{pcsys_keys}).
1266 1f673135 bellard
1267 debc7065 bellard
@node pcsys_usb
1268 b389dbfb bellard
@section USB emulation
1269 b389dbfb bellard
1270 0aff66b5 pbrook
QEMU emulates a PCI UHCI USB controller. You can virtually plug
1271 0aff66b5 pbrook
virtual USB devices or real host USB devices (experimental, works only
1272 0aff66b5 pbrook
on Linux hosts).  Qemu will automatically create and connect virtual USB hubs
1273 f542086d bellard
as necessary to connect multiple USB devices.
1274 b389dbfb bellard
1275 0aff66b5 pbrook
@menu
1276 0aff66b5 pbrook
* usb_devices::
1277 0aff66b5 pbrook
* host_usb_devices::
1278 0aff66b5 pbrook
@end menu
1279 0aff66b5 pbrook
@node usb_devices
1280 0aff66b5 pbrook
@subsection Connecting USB devices
1281 b389dbfb bellard
1282 0aff66b5 pbrook
USB devices can be connected with the @option{-usbdevice} commandline option
1283 0aff66b5 pbrook
or the @code{usb_add} monitor command.  Available devices are:
1284 b389dbfb bellard
1285 0aff66b5 pbrook
@table @var
1286 0aff66b5 pbrook
@item @code{mouse}
1287 0aff66b5 pbrook
Virtual Mouse.  This will override the PS/2 mouse emulation when activated.
1288 0aff66b5 pbrook
@item @code{tablet}
1289 c6d46c20 bellard
Pointer device that uses absolute coordinates (like a touchscreen).
1290 0aff66b5 pbrook
This means qemu is able to report the mouse position without having
1291 0aff66b5 pbrook
to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
1292 0aff66b5 pbrook
@item @code{disk:file}
1293 0aff66b5 pbrook
Mass storage device based on @var{file} (@pxref{disk_images})
1294 0aff66b5 pbrook
@item @code{host:bus.addr}
1295 0aff66b5 pbrook
Pass through the host device identified by @var{bus.addr}
1296 0aff66b5 pbrook
(Linux only)
1297 0aff66b5 pbrook
@item @code{host:vendor_id:product_id}
1298 0aff66b5 pbrook
Pass through the host device identified by @var{vendor_id:product_id}
1299 0aff66b5 pbrook
(Linux only)
1300 0aff66b5 pbrook
@end table
1301 b389dbfb bellard
1302 0aff66b5 pbrook
@node host_usb_devices
1303 b389dbfb bellard
@subsection Using host USB devices on a Linux host
1304 b389dbfb bellard
1305 b389dbfb bellard
WARNING: this is an experimental feature. QEMU will slow down when
1306 b389dbfb bellard
using it. USB devices requiring real time streaming (i.e. USB Video
1307 b389dbfb bellard
Cameras) are not supported yet.
1308 b389dbfb bellard
1309 b389dbfb bellard
@enumerate
1310 b389dbfb bellard
@item If you use an early Linux 2.4 kernel, verify that no Linux driver 
1311 b389dbfb bellard
is actually using the USB device. A simple way to do that is simply to
1312 b389dbfb bellard
disable the corresponding kernel module by renaming it from @file{mydriver.o}
1313 b389dbfb bellard
to @file{mydriver.o.disabled}.
1314 b389dbfb bellard
1315 b389dbfb bellard
@item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1316 b389dbfb bellard
@example
1317 b389dbfb bellard
ls /proc/bus/usb
1318 b389dbfb bellard
001  devices  drivers
1319 b389dbfb bellard
@end example
1320 b389dbfb bellard
1321 b389dbfb bellard
@item Since only root can access to the USB devices directly, you can either launch QEMU as root or change the permissions of the USB devices you want to use. For testing, the following suffices:
1322 b389dbfb bellard
@example
1323 b389dbfb bellard
chown -R myuid /proc/bus/usb
1324 b389dbfb bellard
@end example
1325 b389dbfb bellard
1326 b389dbfb bellard
@item Launch QEMU and do in the monitor:
1327 b389dbfb bellard
@example 
1328 b389dbfb bellard
info usbhost
1329 b389dbfb bellard
  Device 1.2, speed 480 Mb/s
1330 b389dbfb bellard
    Class 00: USB device 1234:5678, USB DISK
1331 b389dbfb bellard
@end example
1332 b389dbfb bellard
You should see the list of the devices you can use (Never try to use
1333 b389dbfb bellard
hubs, it won't work).
1334 b389dbfb bellard
1335 b389dbfb bellard
@item Add the device in QEMU by using:
1336 b389dbfb bellard
@example 
1337 b389dbfb bellard
usb_add host:1234:5678
1338 b389dbfb bellard
@end example
1339 b389dbfb bellard
1340 b389dbfb bellard
Normally the guest OS should report that a new USB device is
1341 b389dbfb bellard
plugged. You can use the option @option{-usbdevice} to do the same.
1342 b389dbfb bellard
1343 b389dbfb bellard
@item Now you can try to use the host USB device in QEMU.
1344 b389dbfb bellard
1345 b389dbfb bellard
@end enumerate
1346 b389dbfb bellard
1347 b389dbfb bellard
When relaunching QEMU, you may have to unplug and plug again the USB
1348 b389dbfb bellard
device to make it work again (this is a bug).
1349 b389dbfb bellard
1350 0806e3f6 bellard
@node gdb_usage
1351 da415d54 bellard
@section GDB usage
1352 da415d54 bellard
1353 da415d54 bellard
QEMU has a primitive support to work with gdb, so that you can do
1354 0806e3f6 bellard
'Ctrl-C' while the virtual machine is running and inspect its state.
1355 da415d54 bellard
1356 9d4520d0 bellard
In order to use gdb, launch qemu with the '-s' option. It will wait for a
1357 da415d54 bellard
gdb connection:
1358 da415d54 bellard
@example
1359 debc7065 bellard
> qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1360 debc7065 bellard
       -append "root=/dev/hda"
1361 da415d54 bellard
Connected to host network interface: tun0
1362 da415d54 bellard
Waiting gdb connection on port 1234
1363 da415d54 bellard
@end example
1364 da415d54 bellard
1365 da415d54 bellard
Then launch gdb on the 'vmlinux' executable:
1366 da415d54 bellard
@example
1367 da415d54 bellard
> gdb vmlinux
1368 da415d54 bellard
@end example
1369 da415d54 bellard
1370 da415d54 bellard
In gdb, connect to QEMU:
1371 da415d54 bellard
@example
1372 6c9bf893 bellard
(gdb) target remote localhost:1234
1373 da415d54 bellard
@end example
1374 da415d54 bellard
1375 da415d54 bellard
Then you can use gdb normally. For example, type 'c' to launch the kernel:
1376 da415d54 bellard
@example
1377 da415d54 bellard
(gdb) c
1378 da415d54 bellard
@end example
1379 da415d54 bellard
1380 0806e3f6 bellard
Here are some useful tips in order to use gdb on system code:
1381 0806e3f6 bellard
1382 0806e3f6 bellard
@enumerate
1383 0806e3f6 bellard
@item
1384 0806e3f6 bellard
Use @code{info reg} to display all the CPU registers.
1385 0806e3f6 bellard
@item
1386 0806e3f6 bellard
Use @code{x/10i $eip} to display the code at the PC position.
1387 0806e3f6 bellard
@item
1388 0806e3f6 bellard
Use @code{set architecture i8086} to dump 16 bit code. Then use
1389 294e8637 bellard
@code{x/10i $cs*16+$eip} to dump the code at the PC position.
1390 0806e3f6 bellard
@end enumerate
1391 0806e3f6 bellard
1392 debc7065 bellard
@node pcsys_os_specific
1393 1a084f3d bellard
@section Target OS specific information
1394 1a084f3d bellard
1395 1a084f3d bellard
@subsection Linux
1396 1a084f3d bellard
1397 15a34c63 bellard
To have access to SVGA graphic modes under X11, use the @code{vesa} or
1398 15a34c63 bellard
the @code{cirrus} X11 driver. For optimal performances, use 16 bit
1399 15a34c63 bellard
color depth in the guest and the host OS.
1400 1a084f3d bellard
1401 e3371e62 bellard
When using a 2.6 guest Linux kernel, you should add the option
1402 e3371e62 bellard
@code{clock=pit} on the kernel command line because the 2.6 Linux
1403 e3371e62 bellard
kernels make very strict real time clock checks by default that QEMU
1404 e3371e62 bellard
cannot simulate exactly.
1405 e3371e62 bellard
1406 7c3fc84d bellard
When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
1407 7c3fc84d bellard
not activated because QEMU is slower with this patch. The QEMU
1408 7c3fc84d bellard
Accelerator Module is also much slower in this case. Earlier Fedora
1409 7c3fc84d bellard
Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporte this
1410 7c3fc84d bellard
patch by default. Newer kernels don't have it.
1411 7c3fc84d bellard
1412 1a084f3d bellard
@subsection Windows
1413 1a084f3d bellard
1414 1a084f3d bellard
If you have a slow host, using Windows 95 is better as it gives the
1415 1a084f3d bellard
best speed. Windows 2000 is also a good choice.
1416 1a084f3d bellard
1417 e3371e62 bellard
@subsubsection SVGA graphic modes support
1418 e3371e62 bellard
1419 e3371e62 bellard
QEMU emulates a Cirrus Logic GD5446 Video
1420 15a34c63 bellard
card. All Windows versions starting from Windows 95 should recognize
1421 15a34c63 bellard
and use this graphic card. For optimal performances, use 16 bit color
1422 15a34c63 bellard
depth in the guest and the host OS.
1423 1a084f3d bellard
1424 3cb0853a bellard
If you are using Windows XP as guest OS and if you want to use high
1425 3cb0853a bellard
resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
1426 3cb0853a bellard
1280x1024x16), then you should use the VESA VBE virtual graphic card
1427 3cb0853a bellard
(option @option{-std-vga}).
1428 3cb0853a bellard
1429 e3371e62 bellard
@subsubsection CPU usage reduction
1430 e3371e62 bellard
1431 e3371e62 bellard
Windows 9x does not correctly use the CPU HLT
1432 15a34c63 bellard
instruction. The result is that it takes host CPU cycles even when
1433 15a34c63 bellard
idle. You can install the utility from
1434 15a34c63 bellard
@url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
1435 15a34c63 bellard
problem. Note that no such tool is needed for NT, 2000 or XP.
1436 1a084f3d bellard
1437 9d0a8e6f bellard
@subsubsection Windows 2000 disk full problem
1438 e3371e62 bellard
1439 9d0a8e6f bellard
Windows 2000 has a bug which gives a disk full problem during its
1440 9d0a8e6f bellard
installation. When installing it, use the @option{-win2k-hack} QEMU
1441 9d0a8e6f bellard
option to enable a specific workaround. After Windows 2000 is
1442 9d0a8e6f bellard
installed, you no longer need this option (this option slows down the
1443 9d0a8e6f bellard
IDE transfers).
1444 e3371e62 bellard
1445 6cc721cf bellard
@subsubsection Windows 2000 shutdown
1446 6cc721cf bellard
1447 6cc721cf bellard
Windows 2000 cannot automatically shutdown in QEMU although Windows 98
1448 6cc721cf bellard
can. It comes from the fact that Windows 2000 does not automatically
1449 6cc721cf bellard
use the APM driver provided by the BIOS.
1450 6cc721cf bellard
1451 6cc721cf bellard
In order to correct that, do the following (thanks to Struan
1452 6cc721cf bellard
Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
1453 6cc721cf bellard
Add/Troubleshoot a device => Add a new device & Next => No, select the
1454 6cc721cf bellard
hardware from a list & Next => NT Apm/Legacy Support & Next => Next
1455 6cc721cf bellard
(again) a few times. Now the driver is installed and Windows 2000 now
1456 6cc721cf bellard
correctly instructs QEMU to shutdown at the appropriate moment. 
1457 6cc721cf bellard
1458 6cc721cf bellard
@subsubsection Share a directory between Unix and Windows
1459 6cc721cf bellard
1460 6cc721cf bellard
See @ref{sec_invocation} about the help of the option @option{-smb}.
1461 6cc721cf bellard
1462 2192c332 bellard
@subsubsection Windows XP security problem
1463 e3371e62 bellard
1464 e3371e62 bellard
Some releases of Windows XP install correctly but give a security
1465 e3371e62 bellard
error when booting:
1466 e3371e62 bellard
@example
1467 e3371e62 bellard
A problem is preventing Windows from accurately checking the
1468 e3371e62 bellard
license for this computer. Error code: 0x800703e6.
1469 e3371e62 bellard
@end example
1470 e3371e62 bellard
1471 2192c332 bellard
The workaround is to install a service pack for XP after a boot in safe
1472 2192c332 bellard
mode. Then reboot, and the problem should go away. Since there is no
1473 2192c332 bellard
network while in safe mode, its recommended to download the full
1474 2192c332 bellard
installation of SP1 or SP2 and transfer that via an ISO or using the
1475 2192c332 bellard
vvfat block device ("-hdb fat:directory_which_holds_the_SP").
1476 e3371e62 bellard
1477 a0a821a4 bellard
@subsection MS-DOS and FreeDOS
1478 a0a821a4 bellard
1479 a0a821a4 bellard
@subsubsection CPU usage reduction
1480 a0a821a4 bellard
1481 a0a821a4 bellard
DOS does not correctly use the CPU HLT instruction. The result is that
1482 a0a821a4 bellard
it takes host CPU cycles even when idle. You can install the utility
1483 a0a821a4 bellard
from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
1484 a0a821a4 bellard
problem.
1485 a0a821a4 bellard
1486 debc7065 bellard
@node QEMU System emulator for non PC targets
1487 3f9f3aa1 bellard
@chapter QEMU System emulator for non PC targets
1488 3f9f3aa1 bellard
1489 3f9f3aa1 bellard
QEMU is a generic emulator and it emulates many non PC
1490 3f9f3aa1 bellard
machines. Most of the options are similar to the PC emulator. The
1491 3f9f3aa1 bellard
differences are mentionned in the following sections.
1492 3f9f3aa1 bellard
1493 debc7065 bellard
@menu
1494 debc7065 bellard
* QEMU PowerPC System emulator::
1495 debc7065 bellard
* Sparc32 System emulator invocation::
1496 debc7065 bellard
* Sparc64 System emulator invocation::
1497 debc7065 bellard
* MIPS System emulator invocation::
1498 debc7065 bellard
* ARM System emulator invocation::
1499 debc7065 bellard
@end menu
1500 debc7065 bellard
1501 debc7065 bellard
@node QEMU PowerPC System emulator
1502 3f9f3aa1 bellard
@section QEMU PowerPC System emulator
1503 1a084f3d bellard
1504 15a34c63 bellard
Use the executable @file{qemu-system-ppc} to simulate a complete PREP
1505 15a34c63 bellard
or PowerMac PowerPC system.
1506 1a084f3d bellard
1507 b671f9ed bellard
QEMU emulates the following PowerMac peripherals:
1508 1a084f3d bellard
1509 15a34c63 bellard
@itemize @minus
1510 15a34c63 bellard
@item 
1511 15a34c63 bellard
UniNorth PCI Bridge 
1512 15a34c63 bellard
@item
1513 15a34c63 bellard
PCI VGA compatible card with VESA Bochs Extensions
1514 15a34c63 bellard
@item 
1515 15a34c63 bellard
2 PMAC IDE interfaces with hard disk and CD-ROM support
1516 15a34c63 bellard
@item 
1517 15a34c63 bellard
NE2000 PCI adapters
1518 15a34c63 bellard
@item
1519 15a34c63 bellard
Non Volatile RAM
1520 15a34c63 bellard
@item
1521 15a34c63 bellard
VIA-CUDA with ADB keyboard and mouse.
1522 1a084f3d bellard
@end itemize
1523 1a084f3d bellard
1524 b671f9ed bellard
QEMU emulates the following PREP peripherals:
1525 52c00a5f bellard
1526 52c00a5f bellard
@itemize @minus
1527 52c00a5f bellard
@item 
1528 15a34c63 bellard
PCI Bridge
1529 15a34c63 bellard
@item
1530 15a34c63 bellard
PCI VGA compatible card with VESA Bochs Extensions
1531 15a34c63 bellard
@item 
1532 52c00a5f bellard
2 IDE interfaces with hard disk and CD-ROM support
1533 52c00a5f bellard
@item
1534 52c00a5f bellard
Floppy disk
1535 52c00a5f bellard
@item 
1536 15a34c63 bellard
NE2000 network adapters
1537 52c00a5f bellard
@item
1538 52c00a5f bellard
Serial port
1539 52c00a5f bellard
@item
1540 52c00a5f bellard
PREP Non Volatile RAM
1541 15a34c63 bellard
@item
1542 15a34c63 bellard
PC compatible keyboard and mouse.
1543 52c00a5f bellard
@end itemize
1544 52c00a5f bellard
1545 15a34c63 bellard
QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
1546 3f9f3aa1 bellard
@url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
1547 52c00a5f bellard
1548 15a34c63 bellard
@c man begin OPTIONS
1549 15a34c63 bellard
1550 15a34c63 bellard
The following options are specific to the PowerPC emulation:
1551 15a34c63 bellard
1552 15a34c63 bellard
@table @option
1553 15a34c63 bellard
1554 15a34c63 bellard
@item -g WxH[xDEPTH]  
1555 15a34c63 bellard
1556 15a34c63 bellard
Set the initial VGA graphic mode. The default is 800x600x15.
1557 15a34c63 bellard
1558 15a34c63 bellard
@end table
1559 15a34c63 bellard
1560 15a34c63 bellard
@c man end 
1561 15a34c63 bellard
1562 15a34c63 bellard
1563 52c00a5f bellard
More information is available at
1564 3f9f3aa1 bellard
@url{http://perso.magic.fr/l_indien/qemu-ppc/}.
1565 52c00a5f bellard
1566 debc7065 bellard
@node Sparc32 System emulator invocation
1567 3f9f3aa1 bellard
@section Sparc32 System emulator invocation
1568 e80cfcfc bellard
1569 0986ac3b bellard
Use the executable @file{qemu-system-sparc} to simulate a SparcStation 5
1570 3475187d bellard
(sun4m architecture). The emulation is somewhat complete.
1571 e80cfcfc bellard
1572 b671f9ed bellard
QEMU emulates the following sun4m peripherals:
1573 e80cfcfc bellard
1574 e80cfcfc bellard
@itemize @minus
1575 3475187d bellard
@item
1576 e80cfcfc bellard
IOMMU
1577 e80cfcfc bellard
@item
1578 e80cfcfc bellard
TCX Frame buffer
1579 e80cfcfc bellard
@item 
1580 e80cfcfc bellard
Lance (Am7990) Ethernet
1581 e80cfcfc bellard
@item
1582 e80cfcfc bellard
Non Volatile RAM M48T08
1583 e80cfcfc bellard
@item
1584 3475187d bellard
Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
1585 3475187d bellard
and power/reset logic
1586 3475187d bellard
@item
1587 3475187d bellard
ESP SCSI controller with hard disk and CD-ROM support
1588 3475187d bellard
@item
1589 3475187d bellard
Floppy drive
1590 e80cfcfc bellard
@end itemize
1591 e80cfcfc bellard
1592 3475187d bellard
The number of peripherals is fixed in the architecture.
1593 3475187d bellard
1594 30a604f3 bellard
Since version 0.8.2, QEMU uses OpenBIOS
1595 0986ac3b bellard
@url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
1596 0986ac3b bellard
firmware implementation. The goal is to implement a 100% IEEE
1597 0986ac3b bellard
1275-1994 (referred to as Open Firmware) compliant firmware.
1598 3475187d bellard
1599 3475187d bellard
A sample Linux 2.6 series kernel and ram disk image are available on
1600 0986ac3b bellard
the QEMU web site. Please note that currently NetBSD, OpenBSD or
1601 0986ac3b bellard
Solaris kernels don't work.
1602 3475187d bellard
1603 3475187d bellard
@c man begin OPTIONS
1604 3475187d bellard
1605 3475187d bellard
The following options are specific to the Sparc emulation:
1606 3475187d bellard
1607 3475187d bellard
@table @option
1608 3475187d bellard
1609 3475187d bellard
@item -g WxH
1610 3475187d bellard
1611 3475187d bellard
Set the initial TCX graphic mode. The default is 1024x768.
1612 3475187d bellard
1613 3475187d bellard
@end table
1614 3475187d bellard
1615 3475187d bellard
@c man end 
1616 3475187d bellard
1617 debc7065 bellard
@node Sparc64 System emulator invocation
1618 3f9f3aa1 bellard
@section Sparc64 System emulator invocation
1619 e80cfcfc bellard
1620 3475187d bellard
Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
1621 3475187d bellard
The emulator is not usable for anything yet.
1622 b756921a bellard
1623 83469015 bellard
QEMU emulates the following sun4u peripherals:
1624 83469015 bellard
1625 83469015 bellard
@itemize @minus
1626 83469015 bellard
@item
1627 83469015 bellard
UltraSparc IIi APB PCI Bridge 
1628 83469015 bellard
@item
1629 83469015 bellard
PCI VGA compatible card with VESA Bochs Extensions
1630 83469015 bellard
@item
1631 83469015 bellard
Non Volatile RAM M48T59
1632 83469015 bellard
@item
1633 83469015 bellard
PC-compatible serial ports
1634 83469015 bellard
@end itemize
1635 83469015 bellard
1636 debc7065 bellard
@node MIPS System emulator invocation
1637 3f9f3aa1 bellard
@section MIPS System emulator invocation
1638 9d0a8e6f bellard
1639 9d0a8e6f bellard
Use the executable @file{qemu-system-mips} to simulate a MIPS machine.
1640 3f9f3aa1 bellard
The emulator is able to boot a Linux kernel and to run a Linux Debian
1641 3f9f3aa1 bellard
installation from NFS. The following devices are emulated:
1642 3f9f3aa1 bellard
1643 3f9f3aa1 bellard
@itemize @minus
1644 3f9f3aa1 bellard
@item 
1645 3f9f3aa1 bellard
MIPS R4K CPU
1646 3f9f3aa1 bellard
@item
1647 3f9f3aa1 bellard
PC style serial port
1648 3f9f3aa1 bellard
@item
1649 3f9f3aa1 bellard
NE2000 network card
1650 3f9f3aa1 bellard
@end itemize
1651 3f9f3aa1 bellard
1652 3f9f3aa1 bellard
More information is available in the QEMU mailing-list archive.
1653 3f9f3aa1 bellard
1654 debc7065 bellard
@node ARM System emulator invocation
1655 3f9f3aa1 bellard
@section ARM System emulator invocation
1656 3f9f3aa1 bellard
1657 3f9f3aa1 bellard
Use the executable @file{qemu-system-arm} to simulate a ARM
1658 3f9f3aa1 bellard
machine. The ARM Integrator/CP board is emulated with the following
1659 3f9f3aa1 bellard
devices:
1660 3f9f3aa1 bellard
1661 3f9f3aa1 bellard
@itemize @minus
1662 3f9f3aa1 bellard
@item
1663 ed96ca35 pbrook
ARM926E or ARM1026E CPU
1664 3f9f3aa1 bellard
@item
1665 3f9f3aa1 bellard
Two PL011 UARTs
1666 3f9f3aa1 bellard
@item 
1667 3f9f3aa1 bellard
SMC 91c111 Ethernet adapter
1668 00a9bf19 pbrook
@item
1669 00a9bf19 pbrook
PL110 LCD controller
1670 00a9bf19 pbrook
@item
1671 00a9bf19 pbrook
PL050 KMI with PS/2 keyboard and mouse.
1672 00a9bf19 pbrook
@end itemize
1673 00a9bf19 pbrook
1674 00a9bf19 pbrook
The ARM Versatile baseboard is emulated with the following devices:
1675 00a9bf19 pbrook
1676 00a9bf19 pbrook
@itemize @minus
1677 00a9bf19 pbrook
@item
1678 00a9bf19 pbrook
ARM926E CPU
1679 00a9bf19 pbrook
@item
1680 00a9bf19 pbrook
PL190 Vectored Interrupt Controller
1681 00a9bf19 pbrook
@item
1682 00a9bf19 pbrook
Four PL011 UARTs
1683 00a9bf19 pbrook
@item 
1684 00a9bf19 pbrook
SMC 91c111 Ethernet adapter
1685 00a9bf19 pbrook
@item
1686 00a9bf19 pbrook
PL110 LCD controller
1687 00a9bf19 pbrook
@item
1688 00a9bf19 pbrook
PL050 KMI with PS/2 keyboard and mouse.
1689 00a9bf19 pbrook
@item
1690 00a9bf19 pbrook
PCI host bridge.  Note the emulated PCI bridge only provides access to
1691 00a9bf19 pbrook
PCI memory space.  It does not provide access to PCI IO space.
1692 00a9bf19 pbrook
This means some devices (eg. ne2k_pci NIC) are not useable, and others
1693 00a9bf19 pbrook
(eg. rtl8139 NIC) are only useable when the guest drivers use the memory
1694 00a9bf19 pbrook
mapped control registers.
1695 e6de1bad pbrook
@item
1696 e6de1bad pbrook
PCI OHCI USB controller.
1697 e6de1bad pbrook
@item
1698 e6de1bad pbrook
LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
1699 3f9f3aa1 bellard
@end itemize
1700 3f9f3aa1 bellard
1701 3f9f3aa1 bellard
A Linux 2.6 test image is available on the QEMU web site. More
1702 3f9f3aa1 bellard
information is available in the QEMU mailing-list archive.
1703 9d0a8e6f bellard
1704 debc7065 bellard
@node QEMU Linux User space emulator 
1705 3f9f3aa1 bellard
@chapter QEMU Linux User space emulator 
1706 386405f7 bellard
1707 debc7065 bellard
@menu
1708 debc7065 bellard
* Quick Start::
1709 debc7065 bellard
* Wine launch::
1710 debc7065 bellard
* Command line options::
1711 79737e4a pbrook
* Other binaries::
1712 debc7065 bellard
@end menu
1713 debc7065 bellard
1714 debc7065 bellard
@node Quick Start
1715 1f673135 bellard
@section Quick Start
1716 df0f11a0 bellard
1717 1f673135 bellard
In order to launch a Linux process, QEMU needs the process executable
1718 1f673135 bellard
itself and all the target (x86) dynamic libraries used by it. 
1719 386405f7 bellard
1720 1f673135 bellard
@itemize
1721 386405f7 bellard
1722 1f673135 bellard
@item On x86, you can just try to launch any process by using the native
1723 1f673135 bellard
libraries:
1724 386405f7 bellard
1725 1f673135 bellard
@example 
1726 1f673135 bellard
qemu-i386 -L / /bin/ls
1727 1f673135 bellard
@end example
1728 386405f7 bellard
1729 1f673135 bellard
@code{-L /} tells that the x86 dynamic linker must be searched with a
1730 1f673135 bellard
@file{/} prefix.
1731 386405f7 bellard
1732 1f673135 bellard
@item Since QEMU is also a linux process, you can launch qemu with qemu (NOTE: you can only do that if you compiled QEMU from the sources):
1733 386405f7 bellard
1734 1f673135 bellard
@example 
1735 1f673135 bellard
qemu-i386 -L / qemu-i386 -L / /bin/ls
1736 1f673135 bellard
@end example
1737 386405f7 bellard
1738 1f673135 bellard
@item On non x86 CPUs, you need first to download at least an x86 glibc
1739 1f673135 bellard
(@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
1740 1f673135 bellard
@code{LD_LIBRARY_PATH} is not set:
1741 df0f11a0 bellard
1742 1f673135 bellard
@example
1743 1f673135 bellard
unset LD_LIBRARY_PATH 
1744 1f673135 bellard
@end example
1745 1eb87257 bellard
1746 1f673135 bellard
Then you can launch the precompiled @file{ls} x86 executable:
1747 1eb87257 bellard
1748 1f673135 bellard
@example
1749 1f673135 bellard
qemu-i386 tests/i386/ls
1750 1f673135 bellard
@end example
1751 1f673135 bellard
You can look at @file{qemu-binfmt-conf.sh} so that
1752 1f673135 bellard
QEMU is automatically launched by the Linux kernel when you try to
1753 1f673135 bellard
launch x86 executables. It requires the @code{binfmt_misc} module in the
1754 1f673135 bellard
Linux kernel.
1755 1eb87257 bellard
1756 1f673135 bellard
@item The x86 version of QEMU is also included. You can try weird things such as:
1757 1f673135 bellard
@example
1758 debc7065 bellard
qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
1759 debc7065 bellard
          /usr/local/qemu-i386/bin/ls-i386
1760 1f673135 bellard
@end example
1761 1eb20527 bellard
1762 1f673135 bellard
@end itemize
1763 1eb20527 bellard
1764 debc7065 bellard
@node Wine launch
1765 1f673135 bellard
@section Wine launch
1766 1eb20527 bellard
1767 1f673135 bellard
@itemize
1768 386405f7 bellard
1769 1f673135 bellard
@item Ensure that you have a working QEMU with the x86 glibc
1770 1f673135 bellard
distribution (see previous section). In order to verify it, you must be
1771 1f673135 bellard
able to do:
1772 386405f7 bellard
1773 1f673135 bellard
@example
1774 1f673135 bellard
qemu-i386 /usr/local/qemu-i386/bin/ls-i386
1775 1f673135 bellard
@end example
1776 386405f7 bellard
1777 1f673135 bellard
@item Download the binary x86 Wine install
1778 1f673135 bellard
(@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page). 
1779 386405f7 bellard
1780 1f673135 bellard
@item Configure Wine on your account. Look at the provided script
1781 debc7065 bellard
@file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
1782 1f673135 bellard
@code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
1783 386405f7 bellard
1784 1f673135 bellard
@item Then you can try the example @file{putty.exe}:
1785 386405f7 bellard
1786 1f673135 bellard
@example
1787 debc7065 bellard
qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
1788 debc7065 bellard
          /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
1789 1f673135 bellard
@end example
1790 386405f7 bellard
1791 1f673135 bellard
@end itemize
1792 fd429f2f bellard
1793 debc7065 bellard
@node Command line options
1794 1f673135 bellard
@section Command line options
1795 1eb20527 bellard
1796 1f673135 bellard
@example
1797 1f673135 bellard
usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
1798 1f673135 bellard
@end example
1799 1eb20527 bellard
1800 1f673135 bellard
@table @option
1801 1f673135 bellard
@item -h
1802 1f673135 bellard
Print the help
1803 1f673135 bellard
@item -L path   
1804 1f673135 bellard
Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
1805 1f673135 bellard
@item -s size
1806 1f673135 bellard
Set the x86 stack size in bytes (default=524288)
1807 386405f7 bellard
@end table
1808 386405f7 bellard
1809 1f673135 bellard
Debug options:
1810 386405f7 bellard
1811 1f673135 bellard
@table @option
1812 1f673135 bellard
@item -d
1813 1f673135 bellard
Activate log (logfile=/tmp/qemu.log)
1814 1f673135 bellard
@item -p pagesize
1815 1f673135 bellard
Act as if the host page size was 'pagesize' bytes
1816 1f673135 bellard
@end table
1817 386405f7 bellard
1818 79737e4a pbrook
@node Other binaries
1819 79737e4a pbrook
@section Other binaries
1820 79737e4a pbrook
1821 79737e4a pbrook
@command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
1822 79737e4a pbrook
binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
1823 79737e4a pbrook
configurations), and arm-uclinux bFLT format binaries.
1824 79737e4a pbrook
1825 e6e5906b pbrook
@command{qemu-m68k} is capable of running semihosted binaries using the BDM
1826 e6e5906b pbrook
(m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
1827 e6e5906b pbrook
coldfire uClinux bFLT format binaries.
1828 e6e5906b pbrook
1829 79737e4a pbrook
The binary format is detected automatically.
1830 79737e4a pbrook
1831 15a34c63 bellard
@node compilation
1832 15a34c63 bellard
@chapter Compilation from the sources
1833 15a34c63 bellard
1834 debc7065 bellard
@menu
1835 debc7065 bellard
* Linux/Unix::
1836 debc7065 bellard
* Windows::
1837 debc7065 bellard
* Cross compilation for Windows with Linux::
1838 debc7065 bellard
* Mac OS X::
1839 debc7065 bellard
@end menu
1840 debc7065 bellard
1841 debc7065 bellard
@node Linux/Unix
1842 7c3fc84d bellard
@section Linux/Unix
1843 7c3fc84d bellard
1844 7c3fc84d bellard
@subsection Compilation
1845 7c3fc84d bellard
1846 7c3fc84d bellard
First you must decompress the sources:
1847 7c3fc84d bellard
@example
1848 7c3fc84d bellard
cd /tmp
1849 7c3fc84d bellard
tar zxvf qemu-x.y.z.tar.gz
1850 7c3fc84d bellard
cd qemu-x.y.z
1851 7c3fc84d bellard
@end example
1852 7c3fc84d bellard
1853 7c3fc84d bellard
Then you configure QEMU and build it (usually no options are needed):
1854 7c3fc84d bellard
@example
1855 7c3fc84d bellard
./configure
1856 7c3fc84d bellard
make
1857 7c3fc84d bellard
@end example
1858 7c3fc84d bellard
1859 7c3fc84d bellard
Then type as root user:
1860 7c3fc84d bellard
@example
1861 7c3fc84d bellard
make install
1862 7c3fc84d bellard
@end example
1863 7c3fc84d bellard
to install QEMU in @file{/usr/local}.
1864 7c3fc84d bellard
1865 7c3fc84d bellard
@subsection Tested tool versions
1866 7c3fc84d bellard
1867 366dfc52 ths
In order to compile QEMU successfully, it is very important that you
1868 7c3fc84d bellard
have the right tools. The most important one is gcc. I cannot guaranty
1869 7c3fc84d bellard
that QEMU works if you do not use a tested gcc version. Look at
1870 7c3fc84d bellard
'configure' and 'Makefile' if you want to make a different gcc
1871 7c3fc84d bellard
version work.
1872 7c3fc84d bellard
1873 7c3fc84d bellard
@example
1874 7c3fc84d bellard
host      gcc      binutils      glibc    linux       distribution
1875 7c3fc84d bellard
----------------------------------------------------------------------
1876 7c3fc84d bellard
x86       3.2      2.13.2        2.1.3    2.4.18
1877 7c3fc84d bellard
          2.96     2.11.93.0.2   2.2.5    2.4.18      Red Hat 7.3
1878 7c3fc84d bellard
          3.2.2    2.13.90.0.18  2.3.2    2.4.20      Red Hat 9
1879 7c3fc84d bellard
1880 7c3fc84d bellard
PowerPC   3.3 [4]  2.13.90.0.18  2.3.1    2.4.20briq
1881 7c3fc84d bellard
          3.2
1882 7c3fc84d bellard
1883 7c3fc84d bellard
Alpha     3.3 [1]  2.14.90.0.4   2.2.5    2.2.20 [2]  Debian 3.0
1884 7c3fc84d bellard
1885 7c3fc84d bellard
Sparc32   2.95.4   2.12.90.0.1   2.2.5    2.4.18      Debian 3.0
1886 7c3fc84d bellard
1887 7c3fc84d bellard
ARM       2.95.4   2.12.90.0.1   2.2.5    2.4.9 [3]   Debian 3.0
1888 7c3fc84d bellard
1889 7c3fc84d bellard
[1] On Alpha, QEMU needs the gcc 'visibility' attribute only available
1890 7c3fc84d bellard
    for gcc version >= 3.3.
1891 7c3fc84d bellard
[2] Linux >= 2.4.20 is necessary for precise exception support
1892 7c3fc84d bellard
    (untested).
1893 7c3fc84d bellard
[3] 2.4.9-ac10-rmk2-np1-cerf2
1894 7c3fc84d bellard
1895 7c3fc84d bellard
[4] gcc 2.95.x generates invalid code when using too many register
1896 7c3fc84d bellard
variables. You must use gcc 3.x on PowerPC.
1897 7c3fc84d bellard
@end example
1898 15a34c63 bellard
1899 debc7065 bellard
@node Windows
1900 15a34c63 bellard
@section Windows
1901 15a34c63 bellard
1902 15a34c63 bellard
@itemize
1903 15a34c63 bellard
@item Install the current versions of MSYS and MinGW from
1904 15a34c63 bellard
@url{http://www.mingw.org/}. You can find detailed installation
1905 15a34c63 bellard
instructions in the download section and the FAQ.
1906 15a34c63 bellard
1907 15a34c63 bellard
@item Download 
1908 15a34c63 bellard
the MinGW development library of SDL 1.2.x
1909 debc7065 bellard
(@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
1910 15a34c63 bellard
@url{http://www.libsdl.org}. Unpack it in a temporary place, and
1911 15a34c63 bellard
unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
1912 15a34c63 bellard
directory. Edit the @file{sdl-config} script so that it gives the
1913 15a34c63 bellard
correct SDL directory when invoked.
1914 15a34c63 bellard
1915 15a34c63 bellard
@item Extract the current version of QEMU.
1916 15a34c63 bellard
 
1917 15a34c63 bellard
@item Start the MSYS shell (file @file{msys.bat}).
1918 15a34c63 bellard
1919 15a34c63 bellard
@item Change to the QEMU directory. Launch @file{./configure} and 
1920 15a34c63 bellard
@file{make}.  If you have problems using SDL, verify that
1921 15a34c63 bellard
@file{sdl-config} can be launched from the MSYS command line.
1922 15a34c63 bellard
1923 15a34c63 bellard
@item You can install QEMU in @file{Program Files/Qemu} by typing 
1924 15a34c63 bellard
@file{make install}. Don't forget to copy @file{SDL.dll} in
1925 15a34c63 bellard
@file{Program Files/Qemu}.
1926 15a34c63 bellard
1927 15a34c63 bellard
@end itemize
1928 15a34c63 bellard
1929 debc7065 bellard
@node Cross compilation for Windows with Linux
1930 15a34c63 bellard
@section Cross compilation for Windows with Linux
1931 15a34c63 bellard
1932 15a34c63 bellard
@itemize
1933 15a34c63 bellard
@item
1934 15a34c63 bellard
Install the MinGW cross compilation tools available at
1935 15a34c63 bellard
@url{http://www.mingw.org/}.
1936 15a34c63 bellard
1937 15a34c63 bellard
@item 
1938 15a34c63 bellard
Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
1939 15a34c63 bellard
unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
1940 15a34c63 bellard
variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
1941 15a34c63 bellard
the QEMU configuration script.
1942 15a34c63 bellard
1943 15a34c63 bellard
@item 
1944 15a34c63 bellard
Configure QEMU for Windows cross compilation:
1945 15a34c63 bellard
@example
1946 15a34c63 bellard
./configure --enable-mingw32
1947 15a34c63 bellard
@end example
1948 15a34c63 bellard
If necessary, you can change the cross-prefix according to the prefix
1949 15a34c63 bellard
choosen for the MinGW tools with --cross-prefix. You can also use
1950 15a34c63 bellard
--prefix to set the Win32 install path.
1951 15a34c63 bellard
1952 15a34c63 bellard
@item You can install QEMU in the installation directory by typing 
1953 15a34c63 bellard
@file{make install}. Don't forget to copy @file{SDL.dll} in the
1954 15a34c63 bellard
installation directory. 
1955 15a34c63 bellard
1956 15a34c63 bellard
@end itemize
1957 15a34c63 bellard
1958 15a34c63 bellard
Note: Currently, Wine does not seem able to launch
1959 15a34c63 bellard
QEMU for Win32.
1960 15a34c63 bellard
1961 debc7065 bellard
@node Mac OS X
1962 15a34c63 bellard
@section Mac OS X
1963 15a34c63 bellard
1964 15a34c63 bellard
The Mac OS X patches are not fully merged in QEMU, so you should look
1965 15a34c63 bellard
at the QEMU mailing list archive to have all the necessary
1966 15a34c63 bellard
information.
1967 15a34c63 bellard
1968 debc7065 bellard
@node Index
1969 debc7065 bellard
@chapter Index
1970 debc7065 bellard
@printindex cp
1971 debc7065 bellard
1972 debc7065 bellard
@bye