1 \input texinfo @c -*- texinfo -*-
3 @setfilename qemu-doc.info
4 @settitle QEMU Emulator User Documentation
12 @center @titlefont{QEMU Emulator}
14 @center @titlefont{User Documentation}
26 * QEMU PC System emulator::
27 * QEMU System emulator for non PC targets::
28 * QEMU User space emulator::
29 * compilation:: Compilation from the sources
40 * intro_features:: Features
46 QEMU is a FAST! processor emulator using dynamic translation to
47 achieve good emulation speed.
49 QEMU has two operating modes:
54 Full system emulation. In this mode, QEMU emulates a full system (for
55 example a PC), including one or several processors and various
56 peripherals. It can be used to launch different Operating Systems
57 without rebooting the PC or to debug system code.
60 User mode emulation. In this mode, QEMU can launch
61 processes compiled for one CPU on another CPU. It can be used to
62 launch the Wine Windows API emulator (@url{http://www.winehq.org}) or
63 to ease cross-compilation and cross-debugging.
67 QEMU can run without an host kernel driver and yet gives acceptable
70 For system emulation, the following hardware targets are supported:
72 @item PC (x86 or x86_64 processor)
73 @item ISA PC (old style PC without PCI bus)
74 @item PREP (PowerPC processor)
75 @item G3 BW PowerMac (PowerPC processor)
76 @item Mac99 PowerMac (PowerPC processor, in progress)
77 @item Sun4m/Sun4c/Sun4d (32-bit Sparc processor)
78 @item Sun4u (64-bit Sparc processor, in progress)
79 @item Malta board (32-bit and 64-bit MIPS processors)
80 @item MIPS Magnum (64-bit MIPS processor)
81 @item ARM Integrator/CP (ARM)
82 @item ARM Versatile baseboard (ARM)
83 @item ARM RealView Emulation baseboard (ARM)
84 @item Spitz, Akita, Borzoi and Terrier PDAs (PXA270 processor)
85 @item Luminary Micro LM3S811EVB (ARM Cortex-M3)
86 @item Luminary Micro LM3S6965EVB (ARM Cortex-M3)
87 @item Freescale MCF5208EVB (ColdFire V2).
88 @item Arnewsh MCF5206 evaluation board (ColdFire V2).
89 @item Palm Tungsten|E PDA (OMAP310 processor)
90 @item N800 and N810 tablets (OMAP2420 processor)
91 @item MusicPal (MV88W8618 ARM processor)
94 For user emulation, x86, PowerPC, ARM, 32-bit MIPS, Sparc32/64 and ColdFire(m68k) CPUs are supported.
99 If you want to compile QEMU yourself, see @ref{compilation}.
102 * install_linux:: Linux
103 * install_windows:: Windows
104 * install_mac:: Macintosh
110 If a precompiled package is available for your distribution - you just
111 have to install it. Otherwise, see @ref{compilation}.
113 @node install_windows
116 Download the experimental binary installer at
117 @url{http://www.free.oszoo.org/@/download.html}.
122 Download the experimental binary installer at
123 @url{http://www.free.oszoo.org/@/download.html}.
125 @node QEMU PC System emulator
126 @chapter QEMU PC System emulator
129 * pcsys_introduction:: Introduction
130 * pcsys_quickstart:: Quick Start
131 * sec_invocation:: Invocation
133 * pcsys_monitor:: QEMU Monitor
134 * disk_images:: Disk Images
135 * pcsys_network:: Network emulation
136 * direct_linux_boot:: Direct Linux Boot
137 * pcsys_usb:: USB emulation
138 * vnc_security:: VNC security
139 * gdb_usage:: GDB usage
140 * pcsys_os_specific:: Target OS specific information
143 @node pcsys_introduction
144 @section Introduction
146 @c man begin DESCRIPTION
148 The QEMU PC System emulator simulates the
149 following peripherals:
153 i440FX host PCI bridge and PIIX3 PCI to ISA bridge
155 Cirrus CLGD 5446 PCI VGA card or dummy VGA card with Bochs VESA
156 extensions (hardware level, including all non standard modes).
158 PS/2 mouse and keyboard
160 2 PCI IDE interfaces with hard disk and CD-ROM support
164 PCI/ISA PCI network adapters
168 Creative SoundBlaster 16 sound card
170 ENSONIQ AudioPCI ES1370 sound card
172 Intel 82801AA AC97 Audio compatible sound card
174 Adlib(OPL2) - Yamaha YM3812 compatible chip
176 Gravis Ultrasound GF1 sound card
178 CS4231A compatible sound card
180 PCI UHCI USB controller and a virtual USB hub.
183 SMP is supported with up to 255 CPUs.
185 Note that adlib, ac97, gus and cs4231a are only available when QEMU
186 was configured with --audio-card-list option containing the name(s) of
189 QEMU uses the PC BIOS from the Bochs project and the Plex86/Bochs LGPL
192 QEMU uses YM3812 emulation by Tatsuyuki Satoh.
194 QEMU uses GUS emulation(GUSEMU32 @url{http://www.deinmeister.de/gusemu/})
195 by Tibor "TS" Schütz.
197 CS4231A is the chip used in Windows Sound System and GUSMAX products
201 @node pcsys_quickstart
204 Download and uncompress the linux image (@file{linux.img}) and type:
210 Linux should boot and give you a prompt.
216 @c man begin SYNOPSIS
217 usage: qemu [options] [@var{disk_image}]
222 @var{disk_image} is a raw hard disk image for IDE hard disk 0.
226 @item -M @var{machine}
227 Select the emulated @var{machine} (@code{-M ?} for list)
229 @item -fda @var{file}
230 @item -fdb @var{file}
231 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
232 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
234 @item -hda @var{file}
235 @item -hdb @var{file}
236 @item -hdc @var{file}
237 @item -hdd @var{file}
238 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
240 @item -cdrom @var{file}
241 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
242 @option{-cdrom} at the same time). You can use the host CD-ROM by
243 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
245 @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
247 Define a new drive. Valid options are:
250 @item file=@var{file}
251 This option defines which disk image (@pxref{disk_images}) to use with
252 this drive. If the filename contains comma, you must double it
253 (for instance, "file=my,,file" to use file "my,file").
254 @item if=@var{interface}
255 This option defines on which type on interface the drive is connected.
256 Available types are: ide, scsi, sd, mtd, floppy, pflash.
257 @item bus=@var{bus},unit=@var{unit}
258 These options define where is connected the drive by defining the bus number and
260 @item index=@var{index}
261 This option defines where is connected the drive by using an index in the list
262 of available connectors of a given interface type.
263 @item media=@var{media}
264 This option defines the type of the media: disk or cdrom.
265 @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
266 These options have the same definition as they have in @option{-hdachs}.
267 @item snapshot=@var{snapshot}
268 @var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
269 @item cache=@var{cache}
270 @var{cache} is "on" or "off" and allows to disable host cache to access data.
271 @item format=@var{format}
272 Specify which disk @var{format} will be used rather than detecting
273 the format. Can be used to specifiy format=raw to avoid interpreting
274 an untrusted format header.
277 Instead of @option{-cdrom} you can use:
279 qemu -drive file=file,index=2,media=cdrom
282 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
285 qemu -drive file=file,index=0,media=disk
286 qemu -drive file=file,index=1,media=disk
287 qemu -drive file=file,index=2,media=disk
288 qemu -drive file=file,index=3,media=disk
291 You can connect a CDROM to the slave of ide0:
293 qemu -drive file=file,if=ide,index=1,media=cdrom
296 If you don't specify the "file=" argument, you define an empty drive:
298 qemu -drive if=ide,index=1,media=cdrom
301 You can connect a SCSI disk with unit ID 6 on the bus #0:
303 qemu -drive file=file,if=scsi,bus=0,unit=6
306 Instead of @option{-fda}, @option{-fdb}, you can use:
308 qemu -drive file=file,index=0,if=floppy
309 qemu -drive file=file,index=1,if=floppy
312 By default, @var{interface} is "ide" and @var{index} is automatically
315 qemu -drive file=a -drive file=b"
322 @item -boot [a|c|d|n]
323 Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
327 Write to temporary files instead of disk image files. In this case,
328 the raw disk image you use is not written back. You can however force
329 the write back by pressing @key{C-a s} (@pxref{disk_images}).
332 Disable boot signature checking for floppy disks in Bochs BIOS. It may
333 be needed to boot from old floppy disks.
336 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
337 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
338 gigabytes respectively.
341 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
342 CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
347 Will show the audio subsystem help: list of drivers, tunable
350 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
352 Enable audio and selected sound hardware. Use ? to print all
353 available sound hardware.
356 qemu -soundhw sb16,adlib hda
357 qemu -soundhw es1370 hda
358 qemu -soundhw ac97 hda
359 qemu -soundhw all hda
363 Note that Linux's i810_audio OSS kernel (for AC97) module might
364 require manually specifying clocking.
367 modprobe i810_audio clocking=48000
371 Set the real time clock to local time (the default is to UTC
372 time). This option is needed to have correct date in MS-DOS or
375 @item -startdate @var{date}
376 Set the initial date of the real time clock. Valid format for
377 @var{date} are: @code{now} or @code{2006-06-17T16:01:21} or
378 @code{2006-06-17}. The default value is @code{now}.
380 @item -pidfile @var{file}
381 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
385 Daemonize the QEMU process after initialization. QEMU will not detach from
386 standard IO until it is ready to receive connections on any of its devices.
387 This option is a useful way for external programs to launch QEMU without having
388 to cope with initialization race conditions.
391 Use it when installing Windows 2000 to avoid a disk full bug. After
392 Windows 2000 is installed, you no longer need this option (this option
393 slows down the IDE transfers).
395 @item -option-rom @var{file}
396 Load the contents of @var{file} as an option ROM.
397 This option is useful to load things like EtherBoot.
399 @item -name @var{name}
400 Sets the @var{name} of the guest.
401 This name will be display in the SDL window caption.
402 The @var{name} will also be used for the VNC server.
411 Normally, QEMU uses SDL to display the VGA output. With this option,
412 you can totally disable graphical output so that QEMU is a simple
413 command line application. The emulated serial port is redirected on
414 the console. Therefore, you can still use QEMU to debug a Linux kernel
415 with a serial console.
419 Normally, QEMU uses SDL to display the VGA output. With this option,
420 QEMU can display the VGA output when in text mode using a
421 curses/ncurses interface. Nothing is displayed in graphical mode.
425 Do not use decorations for SDL windows and start them using the whole
426 available screen space. This makes the using QEMU in a dedicated desktop
427 workspace more convenient.
431 Disable SDL window close capability.
434 Start in full screen.
436 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
438 Normally, QEMU uses SDL to display the VGA output. With this option,
439 you can have QEMU listen on VNC display @var{display} and redirect the VGA
440 display over the VNC session. It is very useful to enable the usb
441 tablet device when using this option (option @option{-usbdevice
442 tablet}). When using the VNC display, you must use the @option{-k}
443 parameter to set the keyboard layout if you are not using en-us. Valid
444 syntax for the @var{display} is
448 @item @var{host}:@var{d}
450 TCP connections will only be allowed from @var{host} on display @var{d}.
451 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
452 be omitted in which case the server will accept connections from any host.
454 @item @code{unix}:@var{path}
456 Connections will be allowed over UNIX domain sockets where @var{path} is the
457 location of a unix socket to listen for connections on.
461 VNC is initialized but not started. The monitor @code{change} command
462 can be used to later start the VNC server.
466 Following the @var{display} value there may be one or more @var{option} flags
467 separated by commas. Valid options are
473 Connect to a listening VNC client via a ``reverse'' connection. The
474 client is specified by the @var{display}. For reverse network
475 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
476 is a TCP port number, not a display number.
480 Require that password based authentication is used for client connections.
481 The password must be set separately using the @code{change} command in the
486 Require that client use TLS when communicating with the VNC server. This
487 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
488 attack. It is recommended that this option be combined with either the
489 @var{x509} or @var{x509verify} options.
491 @item x509=@var{/path/to/certificate/dir}
493 Valid if @option{tls} is specified. Require that x509 credentials are used
494 for negotiating the TLS session. The server will send its x509 certificate
495 to the client. It is recommended that a password be set on the VNC server
496 to provide authentication of the client when this is used. The path following
497 this option specifies where the x509 certificates are to be loaded from.
498 See the @ref{vnc_security} section for details on generating certificates.
500 @item x509verify=@var{/path/to/certificate/dir}
502 Valid if @option{tls} is specified. Require that x509 credentials are used
503 for negotiating the TLS session. The server will send its x509 certificate
504 to the client, and request that the client send its own x509 certificate.
505 The server will validate the client's certificate against the CA certificate,
506 and reject clients when validation fails. If the certificate authority is
507 trusted, this is a sufficient authentication mechanism. You may still wish
508 to set a password on the VNC server as a second authentication layer. The
509 path following this option specifies where the x509 certificates are to
510 be loaded from. See the @ref{vnc_security} section for details on generating
515 @item -k @var{language}
517 Use keyboard layout @var{language} (for example @code{fr} for
518 French). This option is only needed where it is not easy to get raw PC
519 keycodes (e.g. on Macs, with some X11 servers or with a VNC
520 display). You don't normally need to use it on PC/Linux or PC/Windows
523 The available layouts are:
525 ar de-ch es fo fr-ca hu ja mk no pt-br sv
526 da en-gb et fr fr-ch is lt nl pl ru th
527 de en-us fi fr-be hr it lv nl-be pt sl tr
530 The default is @code{en-us}.
538 Enable the USB driver (will be the default soon)
540 @item -usbdevice @var{devname}
541 Add the USB device @var{devname}. @xref{usb_devices}.
546 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
549 Pointer device that uses absolute coordinates (like a touchscreen). This
550 means qemu is able to report the mouse position without having to grab the
551 mouse. Also overrides the PS/2 mouse emulation when activated.
554 Mass storage device based on file
557 Pass through the host device identified by bus.addr (Linux only).
559 @item host:vendor_id:product_id
560 Pass through the host device identified by vendor_id:product_id (Linux only).
562 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
563 Serial converter to host character device @var{dev}, see @code{-serial} for the
567 Braille device. This will use BrlAPI to display the braille output on a real
578 @item -net nic[,vlan=@var{n}][,macaddr=@var{addr}][,model=@var{type}]
579 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
580 = 0 is the default). The NIC is an ne2k_pci by default on the PC
581 target. Optionally, the MAC address can be changed. If no
582 @option{-net} option is specified, a single NIC is created.
583 Qemu can emulate several different models of network card.
584 Valid values for @var{type} are
585 @code{i82551}, @code{i82557b}, @code{i82559er},
586 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
587 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
588 Not all devices are supported on all targets. Use -net nic,model=?
589 for a list of available devices for your target.
591 @item -net user[,vlan=@var{n}][,hostname=@var{name}]
592 Use the user mode network stack which requires no administrator
593 privilege to run. @option{hostname=name} can be used to specify the client
594 hostname reported by the builtin DHCP server.
596 @item -net tap[,vlan=@var{n}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}]
597 Connect the host TAP network interface @var{name} to VLAN @var{n} and
598 use the network script @var{file} to configure it. The default
599 network script is @file{/etc/qemu-ifup}. Use @option{script=no} to
600 disable script execution. If @var{name} is not
601 provided, the OS automatically provides one. @option{fd}=@var{h} can be
602 used to specify the handle of an already opened host TAP interface. Example:
605 qemu linux.img -net nic -net tap
608 More complicated example (two NICs, each one connected to a TAP device)
610 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
611 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
615 @item -net socket[,vlan=@var{n}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
617 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
618 machine using a TCP socket connection. If @option{listen} is
619 specified, QEMU waits for incoming connections on @var{port}
620 (@var{host} is optional). @option{connect} is used to connect to
621 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
622 specifies an already opened TCP socket.
626 # launch a first QEMU instance
627 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
628 -net socket,listen=:1234
629 # connect the VLAN 0 of this instance to the VLAN 0
630 # of the first instance
631 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
632 -net socket,connect=127.0.0.1:1234
635 @item -net socket[,vlan=@var{n}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
637 Create a VLAN @var{n} shared with another QEMU virtual
638 machines using a UDP multicast socket, effectively making a bus for
639 every QEMU with same multicast address @var{maddr} and @var{port}.
643 Several QEMU can be running on different hosts and share same bus (assuming
644 correct multicast setup for these hosts).
646 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
647 @url{http://user-mode-linux.sf.net}.
649 Use @option{fd=h} to specify an already opened UDP multicast socket.
654 # launch one QEMU instance
655 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
656 -net socket,mcast=230.0.0.1:1234
657 # launch another QEMU instance on same "bus"
658 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
659 -net socket,mcast=230.0.0.1:1234
660 # launch yet another QEMU instance on same "bus"
661 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
662 -net socket,mcast=230.0.0.1:1234
665 Example (User Mode Linux compat.):
667 # launch QEMU instance (note mcast address selected
669 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
670 -net socket,mcast=239.192.168.1:1102
672 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
676 Indicate that no network devices should be configured. It is used to
677 override the default configuration (@option{-net nic -net user}) which
678 is activated if no @option{-net} options are provided.
680 @item -tftp @var{dir}
681 When using the user mode network stack, activate a built-in TFTP
682 server. The files in @var{dir} will be exposed as the root of a TFTP server.
683 The TFTP client on the guest must be configured in binary mode (use the command
684 @code{bin} of the Unix TFTP client). The host IP address on the guest is as
687 @item -bootp @var{file}
688 When using the user mode network stack, broadcast @var{file} as the BOOTP
689 filename. In conjunction with @option{-tftp}, this can be used to network boot
690 a guest from a local directory.
692 Example (using pxelinux):
694 qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0
698 When using the user mode network stack, activate a built-in SMB
699 server so that Windows OSes can access to the host files in @file{@var{dir}}
702 In the guest Windows OS, the line:
706 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
707 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
709 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
711 Note that a SAMBA server must be installed on the host OS in
712 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
713 2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
715 @item -redir [tcp|udp]:@var{host-port}:[@var{guest-host}]:@var{guest-port}
717 When using the user mode network stack, redirect incoming TCP or UDP
718 connections to the host port @var{host-port} to the guest
719 @var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
720 is not specified, its value is 10.0.2.15 (default address given by the
721 built-in DHCP server).
723 For example, to redirect host X11 connection from screen 1 to guest
724 screen 0, use the following:
728 qemu -redir tcp:6001::6000 [...]
729 # this host xterm should open in the guest X11 server
733 To redirect telnet connections from host port 5555 to telnet port on
734 the guest, use the following:
738 qemu -redir tcp:5555::23 [...]
739 telnet localhost 5555
742 Then when you use on the host @code{telnet localhost 5555}, you
743 connect to the guest telnet server.
747 Linux boot specific: When using these options, you can use a given
748 Linux kernel without installing it in the disk image. It can be useful
749 for easier testing of various kernels.
753 @item -kernel @var{bzImage}
754 Use @var{bzImage} as kernel image.
756 @item -append @var{cmdline}
757 Use @var{cmdline} as kernel command line
759 @item -initrd @var{file}
760 Use @var{file} as initial ram disk.
764 Debug/Expert options:
767 @item -serial @var{dev}
768 Redirect the virtual serial port to host character device
769 @var{dev}. The default device is @code{vc} in graphical mode and
770 @code{stdio} in non graphical mode.
772 This option can be used several times to simulate up to 4 serials
775 Use @code{-serial none} to disable all serial ports.
777 Available character devices are:
780 Virtual console. Optionally, a width and height can be given in pixel with
784 It is also possible to specify width or height in characters:
789 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
791 No device is allocated.
795 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
796 parameters are set according to the emulated ones.
797 @item /dev/parport@var{N}
798 [Linux only, parallel port only] Use host parallel port
799 @var{N}. Currently SPP and EPP parallel port features can be used.
800 @item file:@var{filename}
801 Write output to @var{filename}. No character can be read.
803 [Unix only] standard input/output
804 @item pipe:@var{filename}
805 name pipe @var{filename}
807 [Windows only] Use host serial port @var{n}
808 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
809 This implements UDP Net Console.
810 When @var{remote_host} or @var{src_ip} are not specified
811 they default to @code{0.0.0.0}.
812 When not using a specified @var{src_port} a random port is automatically chosen.
814 If you just want a simple readonly console you can use @code{netcat} or
815 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
816 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
817 will appear in the netconsole session.
819 If you plan to send characters back via netconsole or you want to stop
820 and start qemu a lot of times, you should have qemu use the same
821 source port each time by using something like @code{-serial
822 udp::4555@@:4556} to qemu. Another approach is to use a patched
823 version of netcat which can listen to a TCP port and send and receive
824 characters via udp. If you have a patched version of netcat which
825 activates telnet remote echo and single char transfer, then you can
826 use the following options to step up a netcat redirector to allow
827 telnet on port 5555 to access the qemu port.
830 -serial udp::4555@@:4556
831 @item netcat options:
832 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
833 @item telnet options:
838 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
839 The TCP Net Console has two modes of operation. It can send the serial
840 I/O to a location or wait for a connection from a location. By default
841 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
842 the @var{server} option QEMU will wait for a client socket application
843 to connect to the port before continuing, unless the @code{nowait}
844 option was specified. The @code{nodelay} option disables the Nagle buffering
845 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
846 one TCP connection at a time is accepted. You can use @code{telnet} to
847 connect to the corresponding character device.
849 @item Example to send tcp console to 192.168.0.2 port 4444
850 -serial tcp:192.168.0.2:4444
851 @item Example to listen and wait on port 4444 for connection
852 -serial tcp::4444,server
853 @item Example to not wait and listen on ip 192.168.0.100 port 4444
854 -serial tcp:192.168.0.100:4444,server,nowait
857 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
858 The telnet protocol is used instead of raw tcp sockets. The options
859 work the same as if you had specified @code{-serial tcp}. The
860 difference is that the port acts like a telnet server or client using
861 telnet option negotiation. This will also allow you to send the
862 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
863 sequence. Typically in unix telnet you do it with Control-] and then
864 type "send break" followed by pressing the enter key.
866 @item unix:@var{path}[,server][,nowait]
867 A unix domain socket is used instead of a tcp socket. The option works the
868 same as if you had specified @code{-serial tcp} except the unix domain socket
869 @var{path} is used for connections.
871 @item mon:@var{dev_string}
872 This is a special option to allow the monitor to be multiplexed onto
873 another serial port. The monitor is accessed with key sequence of
874 @key{Control-a} and then pressing @key{c}. See monitor access
875 @ref{pcsys_keys} in the -nographic section for more keys.
876 @var{dev_string} should be any one of the serial devices specified
877 above. An example to multiplex the monitor onto a telnet server
878 listening on port 4444 would be:
880 @item -serial mon:telnet::4444,server,nowait
884 Braille device. This will use BrlAPI to display the braille output on a real
889 @item -parallel @var{dev}
890 Redirect the virtual parallel port to host device @var{dev} (same
891 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
892 be used to use hardware devices connected on the corresponding host
895 This option can be used several times to simulate up to 3 parallel
898 Use @code{-parallel none} to disable all parallel ports.
900 @item -monitor @var{dev}
901 Redirect the monitor to host device @var{dev} (same devices as the
903 The default device is @code{vc} in graphical mode and @code{stdio} in
906 @item -echr numeric_ascii_value
907 Change the escape character used for switching to the monitor when using
908 monitor and serial sharing. The default is @code{0x01} when using the
909 @code{-nographic} option. @code{0x01} is equal to pressing
910 @code{Control-a}. You can select a different character from the ascii
911 control keys where 1 through 26 map to Control-a through Control-z. For
912 instance you could use the either of the following to change the escape
913 character to Control-t.
920 Wait gdb connection to port 1234 (@pxref{gdb_usage}).
922 Change gdb connection port. @var{port} can be either a decimal number
923 to specify a TCP port, or a host device (same devices as the serial port).
925 Do not start CPU at startup (you must type 'c' in the monitor).
927 Output log in /tmp/qemu.log
928 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
929 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
930 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
931 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
932 all those parameters. This option is useful for old MS-DOS disk
936 Set the directory for the BIOS, VGA BIOS and keymaps.
939 Simulate a standard VGA card with Bochs VBE extensions (default is
940 Cirrus Logic GD5446 PCI VGA). If your guest OS supports the VESA 2.0
941 VBE extensions (e.g. Windows XP) and if you want to use high
942 resolution modes (>= 1280x1024x16) then you should use this option.
945 Disable ACPI (Advanced Configuration and Power Interface) support. Use
946 it if your guest OS complains about ACPI problems (PC target machine
950 Exit instead of rebooting.
953 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
954 This allows for instance switching to monitor to commit changes to the
958 Start right away with a saved state (@code{loadvm} in monitor)
961 Enable semihosting syscall emulation (ARM and M68K target machines only).
963 On ARM this implements the "Angel" interface.
964 On M68K this implements the "ColdFire GDB" interface used by libgloss.
966 Note that this allows guest direct access to the host filesystem,
967 so should only be used with trusted guest OS.
969 @item -icount [N|auto]
970 Enable virtual instruction counter. The virtual cpu will execute one
971 instruction every 2^N ns of virtual time. If @code{auto} is specified
972 then the virtual cpu speed will be automatically adjusted to keep virtual
973 time within a few seconds of real time.
975 Note that while this option can give deterministic behavior, it does not
976 provide cycle accurate emulation. Modern CPUs contain superscalar out of
977 order cores with complex cache heirachies. The number of instructions
978 executed often has little or no correlation with actual performance.
988 During the graphical emulation, you can use the following keys:
994 Switch to virtual console 'n'. Standard console mappings are:
997 Target system display
1005 Toggle mouse and keyboard grab.
1008 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
1009 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
1011 During emulation, if you are using the @option{-nographic} option, use
1012 @key{Ctrl-a h} to get terminal commands:
1020 Save disk data back to file (if -snapshot)
1022 toggle console timestamps
1024 Send break (magic sysrq in Linux)
1026 Switch between console and monitor
1034 @c man begin SEEALSO
1035 The HTML documentation of QEMU for more precise information and Linux
1036 user mode emulator invocation.
1046 @section QEMU Monitor
1048 The QEMU monitor is used to give complex commands to the QEMU
1049 emulator. You can use it to:
1054 Remove or insert removable media images
1055 (such as CD-ROM or floppies).
1058 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
1061 @item Inspect the VM state without an external debugger.
1065 @subsection Commands
1067 The following commands are available:
1071 @item help or ? [@var{cmd}]
1072 Show the help for all commands or just for command @var{cmd}.
1075 Commit changes to the disk images (if -snapshot is used).
1077 @item info @var{subcommand}
1078 Show various information about the system state.
1082 show the various VLANs and the associated devices
1084 show the block devices
1085 @item info registers
1086 show the cpu registers
1088 show the command line history
1090 show emulated PCI device
1092 show USB devices plugged on the virtual USB hub
1094 show all USB host devices
1096 show information about active capturing
1097 @item info snapshots
1098 show list of VM snapshots
1100 show which guest mouse is receiving events
1106 @item eject [-f] @var{device}
1107 Eject a removable medium (use -f to force it).
1109 @item change @var{device} @var{setting}
1111 Change the configuration of a device.
1114 @item change @var{diskdevice} @var{filename}
1115 Change the medium for a removable disk device to point to @var{filename}. eg
1118 (qemu) change ide1-cd0 /path/to/some.iso
1121 @item change vnc @var{display},@var{options}
1122 Change the configuration of the VNC server. The valid syntax for @var{display}
1123 and @var{options} are described at @ref{sec_invocation}. eg
1126 (qemu) change vnc localhost:1
1129 @item change vnc password
1131 Change the password associated with the VNC server. The monitor will prompt for
1132 the new password to be entered. VNC passwords are only significant upto 8 letters.
1136 (qemu) change vnc password
1142 @item screendump @var{filename}
1143 Save screen into PPM image @var{filename}.
1145 @item mouse_move @var{dx} @var{dy} [@var{dz}]
1146 Move the active mouse to the specified coordinates @var{dx} @var{dy}
1147 with optional scroll axis @var{dz}.
1149 @item mouse_button @var{val}
1150 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
1152 @item mouse_set @var{index}
1153 Set which mouse device receives events at given @var{index}, index
1154 can be obtained with
1159 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
1160 Capture audio into @var{filename}. Using sample rate @var{frequency}
1161 bits per sample @var{bits} and number of channels @var{channels}.
1165 @item Sample rate = 44100 Hz - CD quality
1167 @item Number of channels = 2 - Stereo
1170 @item stopcapture @var{index}
1171 Stop capture with a given @var{index}, index can be obtained with
1176 @item log @var{item1}[,...]
1177 Activate logging of the specified items to @file{/tmp/qemu.log}.
1179 @item savevm [@var{tag}|@var{id}]
1180 Create a snapshot of the whole virtual machine. If @var{tag} is
1181 provided, it is used as human readable identifier. If there is already
1182 a snapshot with the same tag or ID, it is replaced. More info at
1185 @item loadvm @var{tag}|@var{id}
1186 Set the whole virtual machine to the snapshot identified by the tag
1187 @var{tag} or the unique snapshot ID @var{id}.
1189 @item delvm @var{tag}|@var{id}
1190 Delete the snapshot identified by @var{tag} or @var{id}.
1198 @item gdbserver [@var{port}]
1199 Start gdbserver session (default @var{port}=1234)
1201 @item x/fmt @var{addr}
1202 Virtual memory dump starting at @var{addr}.
1204 @item xp /@var{fmt} @var{addr}
1205 Physical memory dump starting at @var{addr}.
1207 @var{fmt} is a format which tells the command how to format the
1208 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
1212 is the number of items to be dumped.
1215 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
1216 c (char) or i (asm instruction).
1219 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
1220 @code{h} or @code{w} can be specified with the @code{i} format to
1221 respectively select 16 or 32 bit code instruction size.
1228 Dump 10 instructions at the current instruction pointer:
1233 0x90107065: lea 0x0(%esi,1),%esi
1234 0x90107069: lea 0x0(%edi,1),%edi
1236 0x90107071: jmp 0x90107080
1244 Dump 80 16 bit values at the start of the video memory.
1246 (qemu) xp/80hx 0xb8000
1247 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
1248 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
1249 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
1250 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
1251 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
1252 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
1253 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1254 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1255 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1256 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1260 @item p or print/@var{fmt} @var{expr}
1262 Print expression value. Only the @var{format} part of @var{fmt} is
1265 @item sendkey @var{keys}
1267 Send @var{keys} to the emulator. Use @code{-} to press several keys
1268 simultaneously. Example:
1273 This command is useful to send keys that your graphical user interface
1274 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
1280 @item boot_set @var{bootdevicelist}
1282 Define new values for the boot device list. Those values will override
1283 the values specified on the command line through the @code{-boot} option.
1285 The values that can be specified here depend on the machine type, but are
1286 the same that can be specified in the @code{-boot} command line option.
1288 @item usb_add @var{devname}
1290 Add the USB device @var{devname}. For details of available devices see
1293 @item usb_del @var{devname}
1295 Remove the USB device @var{devname} from the QEMU virtual USB
1296 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
1297 command @code{info usb} to see the devices you can remove.
1301 @subsection Integer expressions
1303 The monitor understands integers expressions for every integer
1304 argument. You can use register names to get the value of specifics
1305 CPU registers by prefixing them with @emph{$}.
1308 @section Disk Images
1310 Since version 0.6.1, QEMU supports many disk image formats, including
1311 growable disk images (their size increase as non empty sectors are
1312 written), compressed and encrypted disk images. Version 0.8.3 added
1313 the new qcow2 disk image format which is essential to support VM
1317 * disk_images_quickstart:: Quick start for disk image creation
1318 * disk_images_snapshot_mode:: Snapshot mode
1319 * vm_snapshots:: VM snapshots
1320 * qemu_img_invocation:: qemu-img Invocation
1321 * host_drives:: Using host drives
1322 * disk_images_fat_images:: Virtual FAT disk images
1325 @node disk_images_quickstart
1326 @subsection Quick start for disk image creation
1328 You can create a disk image with the command:
1330 qemu-img create myimage.img mysize
1332 where @var{myimage.img} is the disk image filename and @var{mysize} is its
1333 size in kilobytes. You can add an @code{M} suffix to give the size in
1334 megabytes and a @code{G} suffix for gigabytes.
1336 See @ref{qemu_img_invocation} for more information.
1338 @node disk_images_snapshot_mode
1339 @subsection Snapshot mode
1341 If you use the option @option{-snapshot}, all disk images are
1342 considered as read only. When sectors in written, they are written in
1343 a temporary file created in @file{/tmp}. You can however force the
1344 write back to the raw disk images by using the @code{commit} monitor
1345 command (or @key{C-a s} in the serial console).
1348 @subsection VM snapshots
1350 VM snapshots are snapshots of the complete virtual machine including
1351 CPU state, RAM, device state and the content of all the writable
1352 disks. In order to use VM snapshots, you must have at least one non
1353 removable and writable block device using the @code{qcow2} disk image
1354 format. Normally this device is the first virtual hard drive.
1356 Use the monitor command @code{savevm} to create a new VM snapshot or
1357 replace an existing one. A human readable name can be assigned to each
1358 snapshot in addition to its numerical ID.
1360 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
1361 a VM snapshot. @code{info snapshots} lists the available snapshots
1362 with their associated information:
1365 (qemu) info snapshots
1366 Snapshot devices: hda
1367 Snapshot list (from hda):
1368 ID TAG VM SIZE DATE VM CLOCK
1369 1 start 41M 2006-08-06 12:38:02 00:00:14.954
1370 2 40M 2006-08-06 12:43:29 00:00:18.633
1371 3 msys 40M 2006-08-06 12:44:04 00:00:23.514
1374 A VM snapshot is made of a VM state info (its size is shown in
1375 @code{info snapshots}) and a snapshot of every writable disk image.
1376 The VM state info is stored in the first @code{qcow2} non removable
1377 and writable block device. The disk image snapshots are stored in
1378 every disk image. The size of a snapshot in a disk image is difficult
1379 to evaluate and is not shown by @code{info snapshots} because the
1380 associated disk sectors are shared among all the snapshots to save
1381 disk space (otherwise each snapshot would need a full copy of all the
1384 When using the (unrelated) @code{-snapshot} option
1385 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
1386 but they are deleted as soon as you exit QEMU.
1388 VM snapshots currently have the following known limitations:
1391 They cannot cope with removable devices if they are removed or
1392 inserted after a snapshot is done.
1394 A few device drivers still have incomplete snapshot support so their
1395 state is not saved or restored properly (in particular USB).
1398 @node qemu_img_invocation
1399 @subsection @code{qemu-img} Invocation
1401 @include qemu-img.texi
1404 @subsection Using host drives
1406 In addition to disk image files, QEMU can directly access host
1407 devices. We describe here the usage for QEMU version >= 0.8.3.
1409 @subsubsection Linux
1411 On Linux, you can directly use the host device filename instead of a
1412 disk image filename provided you have enough privileges to access
1413 it. For example, use @file{/dev/cdrom} to access to the CDROM or
1414 @file{/dev/fd0} for the floppy.
1418 You can specify a CDROM device even if no CDROM is loaded. QEMU has
1419 specific code to detect CDROM insertion or removal. CDROM ejection by
1420 the guest OS is supported. Currently only data CDs are supported.
1422 You can specify a floppy device even if no floppy is loaded. Floppy
1423 removal is currently not detected accurately (if you change floppy
1424 without doing floppy access while the floppy is not loaded, the guest
1425 OS will think that the same floppy is loaded).
1427 Hard disks can be used. Normally you must specify the whole disk
1428 (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
1429 see it as a partitioned disk. WARNING: unless you know what you do, it
1430 is better to only make READ-ONLY accesses to the hard disk otherwise
1431 you may corrupt your host data (use the @option{-snapshot} command
1432 line option or modify the device permissions accordingly).
1435 @subsubsection Windows
1439 The preferred syntax is the drive letter (e.g. @file{d:}). The
1440 alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
1441 supported as an alias to the first CDROM drive.
1443 Currently there is no specific code to handle removable media, so it
1444 is better to use the @code{change} or @code{eject} monitor commands to
1445 change or eject media.
1447 Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
1448 where @var{N} is the drive number (0 is the first hard disk).
1450 WARNING: unless you know what you do, it is better to only make
1451 READ-ONLY accesses to the hard disk otherwise you may corrupt your
1452 host data (use the @option{-snapshot} command line so that the
1453 modifications are written in a temporary file).
1457 @subsubsection Mac OS X
1459 @file{/dev/cdrom} is an alias to the first CDROM.
1461 Currently there is no specific code to handle removable media, so it
1462 is better to use the @code{change} or @code{eject} monitor commands to
1463 change or eject media.
1465 @node disk_images_fat_images
1466 @subsection Virtual FAT disk images
1468 QEMU can automatically create a virtual FAT disk image from a
1469 directory tree. In order to use it, just type:
1472 qemu linux.img -hdb fat:/my_directory
1475 Then you access access to all the files in the @file{/my_directory}
1476 directory without having to copy them in a disk image or to export
1477 them via SAMBA or NFS. The default access is @emph{read-only}.
1479 Floppies can be emulated with the @code{:floppy:} option:
1482 qemu linux.img -fda fat:floppy:/my_directory
1485 A read/write support is available for testing (beta stage) with the
1489 qemu linux.img -fda fat:floppy:rw:/my_directory
1492 What you should @emph{never} do:
1494 @item use non-ASCII filenames ;
1495 @item use "-snapshot" together with ":rw:" ;
1496 @item expect it to work when loadvm'ing ;
1497 @item write to the FAT directory on the host system while accessing it with the guest system.
1501 @section Network emulation
1503 QEMU can simulate several network cards (PCI or ISA cards on the PC
1504 target) and can connect them to an arbitrary number of Virtual Local
1505 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1506 VLAN. VLAN can be connected between separate instances of QEMU to
1507 simulate large networks. For simpler usage, a non privileged user mode
1508 network stack can replace the TAP device to have a basic network
1513 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1514 connection between several network devices. These devices can be for
1515 example QEMU virtual Ethernet cards or virtual Host ethernet devices
1518 @subsection Using TAP network interfaces
1520 This is the standard way to connect QEMU to a real network. QEMU adds
1521 a virtual network device on your host (called @code{tapN}), and you
1522 can then configure it as if it was a real ethernet card.
1524 @subsubsection Linux host
1526 As an example, you can download the @file{linux-test-xxx.tar.gz}
1527 archive and copy the script @file{qemu-ifup} in @file{/etc} and
1528 configure properly @code{sudo} so that the command @code{ifconfig}
1529 contained in @file{qemu-ifup} can be executed as root. You must verify
1530 that your host kernel supports the TAP network interfaces: the
1531 device @file{/dev/net/tun} must be present.
1533 See @ref{sec_invocation} to have examples of command lines using the
1534 TAP network interfaces.
1536 @subsubsection Windows host
1538 There is a virtual ethernet driver for Windows 2000/XP systems, called
1539 TAP-Win32. But it is not included in standard QEMU for Windows,
1540 so you will need to get it separately. It is part of OpenVPN package,
1541 so download OpenVPN from : @url{http://openvpn.net/}.
1543 @subsection Using the user mode network stack
1545 By using the option @option{-net user} (default configuration if no
1546 @option{-net} option is specified), QEMU uses a completely user mode
1547 network stack (you don't need root privilege to use the virtual
1548 network). The virtual network configuration is the following:
1552 QEMU VLAN <------> Firewall/DHCP server <-----> Internet
1555 ----> DNS server (10.0.2.3)
1557 ----> SMB server (10.0.2.4)
1560 The QEMU VM behaves as if it was behind a firewall which blocks all
1561 incoming connections. You can use a DHCP client to automatically
1562 configure the network in the QEMU VM. The DHCP server assign addresses
1563 to the hosts starting from 10.0.2.15.
1565 In order to check that the user mode network is working, you can ping
1566 the address 10.0.2.2 and verify that you got an address in the range
1567 10.0.2.x from the QEMU virtual DHCP server.
1569 Note that @code{ping} is not supported reliably to the internet as it
1570 would require root privileges. It means you can only ping the local
1573 When using the built-in TFTP server, the router is also the TFTP
1576 When using the @option{-redir} option, TCP or UDP connections can be
1577 redirected from the host to the guest. It allows for example to
1578 redirect X11, telnet or SSH connections.
1580 @subsection Connecting VLANs between QEMU instances
1582 Using the @option{-net socket} option, it is possible to make VLANs
1583 that span several QEMU instances. See @ref{sec_invocation} to have a
1586 @node direct_linux_boot
1587 @section Direct Linux Boot
1589 This section explains how to launch a Linux kernel inside QEMU without
1590 having to make a full bootable image. It is very useful for fast Linux
1595 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1598 Use @option{-kernel} to provide the Linux kernel image and
1599 @option{-append} to give the kernel command line arguments. The
1600 @option{-initrd} option can be used to provide an INITRD image.
1602 When using the direct Linux boot, a disk image for the first hard disk
1603 @file{hda} is required because its boot sector is used to launch the
1606 If you do not need graphical output, you can disable it and redirect
1607 the virtual serial port and the QEMU monitor to the console with the
1608 @option{-nographic} option. The typical command line is:
1610 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1611 -append "root=/dev/hda console=ttyS0" -nographic
1614 Use @key{Ctrl-a c} to switch between the serial console and the
1615 monitor (@pxref{pcsys_keys}).
1618 @section USB emulation
1620 QEMU emulates a PCI UHCI USB controller. You can virtually plug
1621 virtual USB devices or real host USB devices (experimental, works only
1622 on Linux hosts). Qemu will automatically create and connect virtual USB hubs
1623 as necessary to connect multiple USB devices.
1627 * host_usb_devices::
1630 @subsection Connecting USB devices
1632 USB devices can be connected with the @option{-usbdevice} commandline option
1633 or the @code{usb_add} monitor command. Available devices are:
1637 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
1639 Pointer device that uses absolute coordinates (like a touchscreen).
1640 This means qemu is able to report the mouse position without having
1641 to grab the mouse. Also overrides the PS/2 mouse emulation when activated.
1642 @item disk:@var{file}
1643 Mass storage device based on @var{file} (@pxref{disk_images})
1644 @item host:@var{bus.addr}
1645 Pass through the host device identified by @var{bus.addr}
1647 @item host:@var{vendor_id:product_id}
1648 Pass through the host device identified by @var{vendor_id:product_id}
1651 Virtual Wacom PenPartner tablet. This device is similar to the @code{tablet}
1652 above but it can be used with the tslib library because in addition to touch
1653 coordinates it reports touch pressure.
1655 Standard USB keyboard. Will override the PS/2 keyboard (if present).
1656 @item serial:[vendorid=@var{vendor_id}][,product_id=@var{product_id}]:@var{dev}
1657 Serial converter. This emulates an FTDI FT232BM chip connected to host character
1658 device @var{dev}. The available character devices are the same as for the
1659 @code{-serial} option. The @code{vendorid} and @code{productid} options can be
1660 used to override the default 0403:6001. For instance,
1662 usb_add serial:productid=FA00:tcp:192.168.0.2:4444
1664 will connect to tcp port 4444 of ip 192.168.0.2, and plug that to the virtual
1665 serial converter, faking a Matrix Orbital LCD Display (USB ID 0403:FA00).
1667 Braille device. This will use BrlAPI to display the braille output on a real
1671 @node host_usb_devices
1672 @subsection Using host USB devices on a Linux host
1674 WARNING: this is an experimental feature. QEMU will slow down when
1675 using it. USB devices requiring real time streaming (i.e. USB Video
1676 Cameras) are not supported yet.
1679 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1680 is actually using the USB device. A simple way to do that is simply to
1681 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1682 to @file{mydriver.o.disabled}.
1684 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1690 @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:
1692 chown -R myuid /proc/bus/usb
1695 @item Launch QEMU and do in the monitor:
1698 Device 1.2, speed 480 Mb/s
1699 Class 00: USB device 1234:5678, USB DISK
1701 You should see the list of the devices you can use (Never try to use
1702 hubs, it won't work).
1704 @item Add the device in QEMU by using:
1706 usb_add host:1234:5678
1709 Normally the guest OS should report that a new USB device is
1710 plugged. You can use the option @option{-usbdevice} to do the same.
1712 @item Now you can try to use the host USB device in QEMU.
1716 When relaunching QEMU, you may have to unplug and plug again the USB
1717 device to make it work again (this is a bug).
1720 @section VNC security
1722 The VNC server capability provides access to the graphical console
1723 of the guest VM across the network. This has a number of security
1724 considerations depending on the deployment scenarios.
1728 * vnc_sec_password::
1729 * vnc_sec_certificate::
1730 * vnc_sec_certificate_verify::
1731 * vnc_sec_certificate_pw::
1732 * vnc_generate_cert::
1735 @subsection Without passwords
1737 The simplest VNC server setup does not include any form of authentication.
1738 For this setup it is recommended to restrict it to listen on a UNIX domain
1739 socket only. For example
1742 qemu [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
1745 This ensures that only users on local box with read/write access to that
1746 path can access the VNC server. To securely access the VNC server from a
1747 remote machine, a combination of netcat+ssh can be used to provide a secure
1750 @node vnc_sec_password
1751 @subsection With passwords
1753 The VNC protocol has limited support for password based authentication. Since
1754 the protocol limits passwords to 8 characters it should not be considered
1755 to provide high security. The password can be fairly easily brute-forced by
1756 a client making repeat connections. For this reason, a VNC server using password
1757 authentication should be restricted to only listen on the loopback interface
1758 or UNIX domain sockets. Password ayuthentication is requested with the @code{password}
1759 option, and then once QEMU is running the password is set with the monitor. Until
1760 the monitor is used to set the password all clients will be rejected.
1763 qemu [...OPTIONS...] -vnc :1,password -monitor stdio
1764 (qemu) change vnc password
1769 @node vnc_sec_certificate
1770 @subsection With x509 certificates
1772 The QEMU VNC server also implements the VeNCrypt extension allowing use of
1773 TLS for encryption of the session, and x509 certificates for authentication.
1774 The use of x509 certificates is strongly recommended, because TLS on its
1775 own is susceptible to man-in-the-middle attacks. Basic x509 certificate
1776 support provides a secure session, but no authentication. This allows any
1777 client to connect, and provides an encrypted session.
1780 qemu [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
1783 In the above example @code{/etc/pki/qemu} should contain at least three files,
1784 @code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
1785 users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
1786 NB the @code{server-key.pem} file should be protected with file mode 0600 to
1787 only be readable by the user owning it.
1789 @node vnc_sec_certificate_verify
1790 @subsection With x509 certificates and client verification
1792 Certificates can also provide a means to authenticate the client connecting.
1793 The server will request that the client provide a certificate, which it will
1794 then validate against the CA certificate. This is a good choice if deploying
1795 in an environment with a private internal certificate authority.
1798 qemu [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
1802 @node vnc_sec_certificate_pw
1803 @subsection With x509 certificates, client verification and passwords
1805 Finally, the previous method can be combined with VNC password authentication
1806 to provide two layers of authentication for clients.
1809 qemu [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
1810 (qemu) change vnc password
1815 @node vnc_generate_cert
1816 @subsection Generating certificates for VNC
1818 The GNU TLS packages provides a command called @code{certtool} which can
1819 be used to generate certificates and keys in PEM format. At a minimum it
1820 is neccessary to setup a certificate authority, and issue certificates to
1821 each server. If using certificates for authentication, then each client
1822 will also need to be issued a certificate. The recommendation is for the
1823 server to keep its certificates in either @code{/etc/pki/qemu} or for
1824 unprivileged users in @code{$HOME/.pki/qemu}.
1828 * vnc_generate_server::
1829 * vnc_generate_client::
1831 @node vnc_generate_ca
1832 @subsubsection Setup the Certificate Authority
1834 This step only needs to be performed once per organization / organizational
1835 unit. First the CA needs a private key. This key must be kept VERY secret
1836 and secure. If this key is compromised the entire trust chain of the certificates
1837 issued with it is lost.
1840 # certtool --generate-privkey > ca-key.pem
1843 A CA needs to have a public certificate. For simplicity it can be a self-signed
1844 certificate, or one issue by a commercial certificate issuing authority. To
1845 generate a self-signed certificate requires one core piece of information, the
1846 name of the organization.
1849 # cat > ca.info <<EOF
1850 cn = Name of your organization
1854 # certtool --generate-self-signed \
1855 --load-privkey ca-key.pem
1856 --template ca.info \
1857 --outfile ca-cert.pem
1860 The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
1861 TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.
1863 @node vnc_generate_server
1864 @subsubsection Issuing server certificates
1866 Each server (or host) needs to be issued with a key and certificate. When connecting
1867 the certificate is sent to the client which validates it against the CA certificate.
1868 The core piece of information for a server certificate is the hostname. This should
1869 be the fully qualified hostname that the client will connect with, since the client
1870 will typically also verify the hostname in the certificate. On the host holding the
1871 secure CA private key:
1874 # cat > server.info <<EOF
1875 organization = Name of your organization
1876 cn = server.foo.example.com
1881 # certtool --generate-privkey > server-key.pem
1882 # certtool --generate-certificate \
1883 --load-ca-certificate ca-cert.pem \
1884 --load-ca-privkey ca-key.pem \
1885 --load-privkey server server-key.pem \
1886 --template server.info \
1887 --outfile server-cert.pem
1890 The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
1891 to the server for which they were generated. The @code{server-key.pem} is security
1892 sensitive and should be kept protected with file mode 0600 to prevent disclosure.
1894 @node vnc_generate_client
1895 @subsubsection Issuing client certificates
1897 If the QEMU VNC server is to use the @code{x509verify} option to validate client
1898 certificates as its authentication mechanism, each client also needs to be issued
1899 a certificate. The client certificate contains enough metadata to uniquely identify
1900 the client, typically organization, state, city, building, etc. On the host holding
1901 the secure CA private key:
1904 # cat > client.info <<EOF
1908 organiazation = Name of your organization
1909 cn = client.foo.example.com
1914 # certtool --generate-privkey > client-key.pem
1915 # certtool --generate-certificate \
1916 --load-ca-certificate ca-cert.pem \
1917 --load-ca-privkey ca-key.pem \
1918 --load-privkey client-key.pem \
1919 --template client.info \
1920 --outfile client-cert.pem
1923 The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
1924 copied to the client for which they were generated.
1929 QEMU has a primitive support to work with gdb, so that you can do
1930 'Ctrl-C' while the virtual machine is running and inspect its state.
1932 In order to use gdb, launch qemu with the '-s' option. It will wait for a
1935 > qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1936 -append "root=/dev/hda"
1937 Connected to host network interface: tun0
1938 Waiting gdb connection on port 1234
1941 Then launch gdb on the 'vmlinux' executable:
1946 In gdb, connect to QEMU:
1948 (gdb) target remote localhost:1234
1951 Then you can use gdb normally. For example, type 'c' to launch the kernel:
1956 Here are some useful tips in order to use gdb on system code:
1960 Use @code{info reg} to display all the CPU registers.
1962 Use @code{x/10i $eip} to display the code at the PC position.
1964 Use @code{set architecture i8086} to dump 16 bit code. Then use
1965 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
1968 Advanced debugging options:
1970 The default single stepping behavior is step with the IRQs and timer service routines off. It is set this way because when gdb executes a single step it expects to advance beyond the current instruction. With the IRQs and and timer service routines on, a single step might jump into the one of the interrupt or exception vectors instead of executing the current instruction. This means you may hit the same breakpoint a number of times before executing the instruction gdb wants to have executed. Because there are rare circumstances where you want to single step into an interrupt vector the behavior can be controlled from GDB. There are three commands you can query and set the single step behavior:
1972 @item maintenance packet qqemu.sstepbits
1974 This will display the MASK bits used to control the single stepping IE:
1976 (gdb) maintenance packet qqemu.sstepbits
1977 sending: "qqemu.sstepbits"
1978 received: "ENABLE=1,NOIRQ=2,NOTIMER=4"
1980 @item maintenance packet qqemu.sstep
1982 This will display the current value of the mask used when single stepping IE:
1984 (gdb) maintenance packet qqemu.sstep
1985 sending: "qqemu.sstep"
1988 @item maintenance packet Qqemu.sstep=HEX_VALUE
1990 This will change the single step mask, so if wanted to enable IRQs on the single step, but not timers, you would use:
1992 (gdb) maintenance packet Qqemu.sstep=0x5
1993 sending: "qemu.sstep=0x5"
1998 @node pcsys_os_specific
1999 @section Target OS specific information
2003 To have access to SVGA graphic modes under X11, use the @code{vesa} or
2004 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
2005 color depth in the guest and the host OS.
2007 When using a 2.6 guest Linux kernel, you should add the option
2008 @code{clock=pit} on the kernel command line because the 2.6 Linux
2009 kernels make very strict real time clock checks by default that QEMU
2010 cannot simulate exactly.
2012 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
2013 not activated because QEMU is slower with this patch. The QEMU
2014 Accelerator Module is also much slower in this case. Earlier Fedora
2015 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
2016 patch by default. Newer kernels don't have it.
2020 If you have a slow host, using Windows 95 is better as it gives the
2021 best speed. Windows 2000 is also a good choice.
2023 @subsubsection SVGA graphic modes support
2025 QEMU emulates a Cirrus Logic GD5446 Video
2026 card. All Windows versions starting from Windows 95 should recognize
2027 and use this graphic card. For optimal performances, use 16 bit color
2028 depth in the guest and the host OS.
2030 If you are using Windows XP as guest OS and if you want to use high
2031 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
2032 1280x1024x16), then you should use the VESA VBE virtual graphic card
2033 (option @option{-std-vga}).
2035 @subsubsection CPU usage reduction
2037 Windows 9x does not correctly use the CPU HLT
2038 instruction. The result is that it takes host CPU cycles even when
2039 idle. You can install the utility from
2040 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
2041 problem. Note that no such tool is needed for NT, 2000 or XP.
2043 @subsubsection Windows 2000 disk full problem
2045 Windows 2000 has a bug which gives a disk full problem during its
2046 installation. When installing it, use the @option{-win2k-hack} QEMU
2047 option to enable a specific workaround. After Windows 2000 is
2048 installed, you no longer need this option (this option slows down the
2051 @subsubsection Windows 2000 shutdown
2053 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
2054 can. It comes from the fact that Windows 2000 does not automatically
2055 use the APM driver provided by the BIOS.
2057 In order to correct that, do the following (thanks to Struan
2058 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
2059 Add/Troubleshoot a device => Add a new device & Next => No, select the
2060 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
2061 (again) a few times. Now the driver is installed and Windows 2000 now
2062 correctly instructs QEMU to shutdown at the appropriate moment.
2064 @subsubsection Share a directory between Unix and Windows
2066 See @ref{sec_invocation} about the help of the option @option{-smb}.
2068 @subsubsection Windows XP security problem
2070 Some releases of Windows XP install correctly but give a security
2073 A problem is preventing Windows from accurately checking the
2074 license for this computer. Error code: 0x800703e6.
2077 The workaround is to install a service pack for XP after a boot in safe
2078 mode. Then reboot, and the problem should go away. Since there is no
2079 network while in safe mode, its recommended to download the full
2080 installation of SP1 or SP2 and transfer that via an ISO or using the
2081 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
2083 @subsection MS-DOS and FreeDOS
2085 @subsubsection CPU usage reduction
2087 DOS does not correctly use the CPU HLT instruction. The result is that
2088 it takes host CPU cycles even when idle. You can install the utility
2089 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
2092 @node QEMU System emulator for non PC targets
2093 @chapter QEMU System emulator for non PC targets
2095 QEMU is a generic emulator and it emulates many non PC
2096 machines. Most of the options are similar to the PC emulator. The
2097 differences are mentioned in the following sections.
2100 * QEMU PowerPC System emulator::
2101 * Sparc32 System emulator::
2102 * Sparc64 System emulator::
2103 * MIPS System emulator::
2104 * ARM System emulator::
2105 * ColdFire System emulator::
2108 @node QEMU PowerPC System emulator
2109 @section QEMU PowerPC System emulator
2111 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
2112 or PowerMac PowerPC system.
2114 QEMU emulates the following PowerMac peripherals:
2120 PCI VGA compatible card with VESA Bochs Extensions
2122 2 PMAC IDE interfaces with hard disk and CD-ROM support
2128 VIA-CUDA with ADB keyboard and mouse.
2131 QEMU emulates the following PREP peripherals:
2137 PCI VGA compatible card with VESA Bochs Extensions
2139 2 IDE interfaces with hard disk and CD-ROM support
2143 NE2000 network adapters
2147 PREP Non Volatile RAM
2149 PC compatible keyboard and mouse.
2152 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
2153 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
2155 @c man begin OPTIONS
2157 The following options are specific to the PowerPC emulation:
2161 @item -g WxH[xDEPTH]
2163 Set the initial VGA graphic mode. The default is 800x600x15.
2170 More information is available at
2171 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
2173 @node Sparc32 System emulator
2174 @section Sparc32 System emulator
2176 Use the executable @file{qemu-system-sparc} to simulate a SPARCstation
2177 5, SPARCstation 10, SPARCstation 20, SPARCserver 600MP (sun4m
2178 architecture), SPARCstation 2 (sun4c architecture), SPARCserver 1000,
2179 or SPARCcenter 2000 (sun4d architecture). The emulation is somewhat
2180 complete. SMP up to 16 CPUs is supported, but Linux limits the number
2181 of usable CPUs to 4.
2183 QEMU emulates the following sun4m/sun4d peripherals:
2191 Lance (Am7990) Ethernet
2193 Non Volatile RAM M48T08
2195 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
2196 and power/reset logic
2198 ESP SCSI controller with hard disk and CD-ROM support
2200 Floppy drive (not on SS-600MP)
2202 CS4231 sound device (only on SS-5, not working yet)
2205 The number of peripherals is fixed in the architecture. Maximum
2206 memory size depends on the machine type, for SS-5 it is 256MB and for
2209 Since version 0.8.2, QEMU uses OpenBIOS
2210 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
2211 firmware implementation. The goal is to implement a 100% IEEE
2212 1275-1994 (referred to as Open Firmware) compliant firmware.
2214 A sample Linux 2.6 series kernel and ram disk image are available on
2215 the QEMU web site. Please note that currently NetBSD, OpenBSD or
2216 Solaris kernels don't work.
2218 @c man begin OPTIONS
2220 The following options are specific to the Sparc32 emulation:
2224 @item -g WxHx[xDEPTH]
2226 Set the initial TCX graphic mode. The default is 1024x768x8, currently
2227 the only other possible mode is 1024x768x24.
2229 @item -prom-env string
2231 Set OpenBIOS variables in NVRAM, for example:
2234 qemu-system-sparc -prom-env 'auto-boot?=false' \
2235 -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
2238 @item -M [SS-5|SS-10|SS-20|SS-600MP|SS-2|SS-1000|SS-2000]
2240 Set the emulated machine type. Default is SS-5.
2246 @node Sparc64 System emulator
2247 @section Sparc64 System emulator
2249 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
2250 The emulator is not usable for anything yet.
2252 QEMU emulates the following sun4u peripherals:
2256 UltraSparc IIi APB PCI Bridge
2258 PCI VGA compatible card with VESA Bochs Extensions
2260 Non Volatile RAM M48T59
2262 PC-compatible serial ports
2265 @node MIPS System emulator
2266 @section MIPS System emulator
2268 Four executables cover simulation of 32 and 64-bit MIPS systems in
2269 both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
2270 @file{qemu-system-mips64} and @file{qemu-system-mips64el}.
2271 Five different machine types are emulated:
2275 A generic ISA PC-like machine "mips"
2277 The MIPS Malta prototype board "malta"
2279 An ACER Pica "pica61". This machine needs the 64-bit emulator.
2281 MIPS emulator pseudo board "mipssim"
2283 A MIPS Magnum R4000 machine "magnum". This machine needs the 64-bit emulator.
2286 The generic emulation is supported by Debian 'Etch' and is able to
2287 install Debian into a virtual disk image. The following devices are
2292 A range of MIPS CPUs, default is the 24Kf
2294 PC style serial port
2301 The Malta emulation supports the following devices:
2305 Core board with MIPS 24Kf CPU and Galileo system controller
2307 PIIX4 PCI/USB/SMbus controller
2309 The Multi-I/O chip's serial device
2311 PCnet32 PCI network card
2313 Malta FPGA serial device
2315 Cirrus VGA graphics card
2318 The ACER Pica emulation supports:
2324 PC-style IRQ and DMA controllers
2331 The mipssim pseudo board emulation provides an environment similiar
2332 to what the proprietary MIPS emulator uses for running Linux.
2337 A range of MIPS CPUs, default is the 24Kf
2339 PC style serial port
2341 MIPSnet network emulation
2344 The MIPS Magnum R4000 emulation supports:
2350 PC-style IRQ controller
2360 @node ARM System emulator
2361 @section ARM System emulator
2363 Use the executable @file{qemu-system-arm} to simulate a ARM
2364 machine. The ARM Integrator/CP board is emulated with the following
2369 ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
2373 SMC 91c111 Ethernet adapter
2375 PL110 LCD controller
2377 PL050 KMI with PS/2 keyboard and mouse.
2379 PL181 MultiMedia Card Interface with SD card.
2382 The ARM Versatile baseboard is emulated with the following devices:
2386 ARM926E, ARM1136 or Cortex-A8 CPU
2388 PL190 Vectored Interrupt Controller
2392 SMC 91c111 Ethernet adapter
2394 PL110 LCD controller
2396 PL050 KMI with PS/2 keyboard and mouse.
2398 PCI host bridge. Note the emulated PCI bridge only provides access to
2399 PCI memory space. It does not provide access to PCI IO space.
2400 This means some devices (eg. ne2k_pci NIC) are not usable, and others
2401 (eg. rtl8139 NIC) are only usable when the guest drivers use the memory
2402 mapped control registers.
2404 PCI OHCI USB controller.
2406 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
2408 PL181 MultiMedia Card Interface with SD card.
2411 The ARM RealView Emulation baseboard is emulated with the following devices:
2415 ARM926E, ARM1136, ARM11MPCORE(x4) or Cortex-A8 CPU
2417 ARM AMBA Generic/Distributed Interrupt Controller
2421 SMC 91c111 Ethernet adapter
2423 PL110 LCD controller
2425 PL050 KMI with PS/2 keyboard and mouse
2429 PCI OHCI USB controller
2431 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
2433 PL181 MultiMedia Card Interface with SD card.
2436 The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
2437 and "Terrier") emulation includes the following peripherals:
2441 Intel PXA270 System-on-chip (ARM V5TE core)
2445 IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
2447 On-chip OHCI USB controller
2449 On-chip LCD controller
2451 On-chip Real Time Clock
2453 TI ADS7846 touchscreen controller on SSP bus
2455 Maxim MAX1111 analog-digital converter on I@math{^2}C bus
2457 GPIO-connected keyboard controller and LEDs
2459 Secure Digital card connected to PXA MMC/SD host
2463 WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
2466 The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
2471 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2473 ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
2475 On-chip LCD controller
2477 On-chip Real Time Clock
2479 TI TSC2102i touchscreen controller / analog-digital converter / Audio
2480 CODEC, connected through MicroWire and I@math{^2}S busses
2482 GPIO-connected matrix keypad
2484 Secure Digital card connected to OMAP MMC/SD host
2489 Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / 48)
2490 emulation supports the following elements:
2494 Texas Instruments OMAP2420 System-on-chip (ARM 1136 core)
2496 RAM and non-volatile OneNAND Flash memories
2498 Display connected to EPSON remote framebuffer chip and OMAP on-chip
2499 display controller and a LS041y3 MIPI DBI-C controller
2501 TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen controllers
2502 driven through SPI bus
2504 National Semiconductor LM8323-controlled qwerty keyboard driven
2505 through I@math{^2}C bus
2507 Secure Digital card connected to OMAP MMC/SD host
2509 Three OMAP on-chip UARTs and on-chip STI debugging console
2511 Mentor Graphics "Inventra" dual-role USB controller embedded in a TI
2512 TUSB6010 chip - only USB host mode is supported
2514 TI TMP105 temperature sensor driven through I@math{^2}C bus
2516 TI TWL92230C power management companion with an RTC on I@math{^2}C bus
2518 Nokia RETU and TAHVO multi-purpose chips with an RTC, connected
2522 The Luminary Micro Stellaris LM3S811EVB emulation includes the following
2529 64k Flash and 8k SRAM.
2531 Timers, UARTs, ADC and I@math{^2}C interface.
2533 OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
2536 The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
2543 256k Flash and 64k SRAM.
2545 Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
2547 OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
2550 The Freecom MusicPal internet radio emulation includes the following
2555 Marvell MV88W8618 ARM core.
2557 32 MB RAM, 256 KB SRAM, 8 MB flash.
2561 MV88W8xx8 Ethernet controller
2563 MV88W8618 audio controller, WM8750 CODEC and mixer
2565 128×64 display with brightness control
2567 2 buttons, 2 navigation wheels with button function
2570 A Linux 2.6 test image is available on the QEMU web site. More
2571 information is available in the QEMU mailing-list archive.
2573 @node ColdFire System emulator
2574 @section ColdFire System emulator
2576 Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
2577 The emulator is able to boot a uClinux kernel.
2579 The M5208EVB emulation includes the following devices:
2583 MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2585 Three Two on-chip UARTs.
2587 Fast Ethernet Controller (FEC)
2590 The AN5206 emulation includes the following devices:
2594 MCF5206 ColdFire V2 Microprocessor.
2599 @node QEMU User space emulator
2600 @chapter QEMU User space emulator
2603 * Supported Operating Systems ::
2604 * Linux User space emulator::
2605 * Mac OS X/Darwin User space emulator ::
2608 @node Supported Operating Systems
2609 @section Supported Operating Systems
2611 The following OS are supported in user space emulation:
2615 Linux (referred as qemu-linux-user)
2617 Mac OS X/Darwin (referred as qemu-darwin-user)
2620 @node Linux User space emulator
2621 @section Linux User space emulator
2626 * Command line options::
2631 @subsection Quick Start
2633 In order to launch a Linux process, QEMU needs the process executable
2634 itself and all the target (x86) dynamic libraries used by it.
2638 @item On x86, you can just try to launch any process by using the native
2642 qemu-i386 -L / /bin/ls
2645 @code{-L /} tells that the x86 dynamic linker must be searched with a
2648 @item Since QEMU is also a linux process, you can launch qemu with
2649 qemu (NOTE: you can only do that if you compiled QEMU from the sources):
2652 qemu-i386 -L / qemu-i386 -L / /bin/ls
2655 @item On non x86 CPUs, you need first to download at least an x86 glibc
2656 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2657 @code{LD_LIBRARY_PATH} is not set:
2660 unset LD_LIBRARY_PATH
2663 Then you can launch the precompiled @file{ls} x86 executable:
2666 qemu-i386 tests/i386/ls
2668 You can look at @file{qemu-binfmt-conf.sh} so that
2669 QEMU is automatically launched by the Linux kernel when you try to
2670 launch x86 executables. It requires the @code{binfmt_misc} module in the
2673 @item The x86 version of QEMU is also included. You can try weird things such as:
2675 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2676 /usr/local/qemu-i386/bin/ls-i386
2682 @subsection Wine launch
2686 @item Ensure that you have a working QEMU with the x86 glibc
2687 distribution (see previous section). In order to verify it, you must be
2691 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2694 @item Download the binary x86 Wine install
2695 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
2697 @item Configure Wine on your account. Look at the provided script
2698 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
2699 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
2701 @item Then you can try the example @file{putty.exe}:
2704 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2705 /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
2710 @node Command line options
2711 @subsection Command line options
2714 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
2721 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
2723 Set the x86 stack size in bytes (default=524288)
2730 Activate log (logfile=/tmp/qemu.log)
2732 Act as if the host page size was 'pagesize' bytes
2735 Environment variables:
2739 Print system calls and arguments similar to the 'strace' program
2740 (NOTE: the actual 'strace' program will not work because the user
2741 space emulator hasn't implemented ptrace). At the moment this is
2742 incomplete. All system calls that don't have a specific argument
2743 format are printed with information for six arguments. Many
2744 flag-style arguments don't have decoders and will show up as numbers.
2747 @node Other binaries
2748 @subsection Other binaries
2750 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2751 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2752 configurations), and arm-uclinux bFLT format binaries.
2754 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
2755 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2756 coldfire uClinux bFLT format binaries.
2758 The binary format is detected automatically.
2760 @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
2761 (Sparc64 CPU, 32 bit ABI).
2763 @command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
2764 SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
2766 @node Mac OS X/Darwin User space emulator
2767 @section Mac OS X/Darwin User space emulator
2770 * Mac OS X/Darwin Status::
2771 * Mac OS X/Darwin Quick Start::
2772 * Mac OS X/Darwin Command line options::
2775 @node Mac OS X/Darwin Status
2776 @subsection Mac OS X/Darwin Status
2780 target x86 on x86: Most apps (Cocoa and Carbon too) works. [1]
2782 target PowerPC on x86: Not working as the ppc commpage can't be mapped (yet!)
2784 target PowerPC on PowerPC: Most apps (Cocoa and Carbon too) works. [1]
2786 target x86 on PowerPC: most utilities work. Cocoa and Carbon apps are not yet supported.
2789 [1] If you're host commpage can be executed by qemu.
2791 @node Mac OS X/Darwin Quick Start
2792 @subsection Quick Start
2794 In order to launch a Mac OS X/Darwin process, QEMU needs the process executable
2795 itself and all the target dynamic libraries used by it. If you don't have the FAT
2796 libraries (you're running Mac OS X/ppc) you'll need to obtain it from a Mac OS X
2797 CD or compile them by hand.
2801 @item On x86, you can just try to launch any process by using the native
2808 or to run the ppc version of the executable:
2814 @item On ppc, you'll have to tell qemu where your x86 libraries (and dynamic linker)
2818 qemu-i386 -L /opt/x86_root/ /bin/ls
2821 @code{-L /opt/x86_root/} tells that the dynamic linker (dyld) path is in
2822 @file{/opt/x86_root/usr/bin/dyld}.
2826 @node Mac OS X/Darwin Command line options
2827 @subsection Command line options
2830 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
2837 Set the library root path (default=/)
2839 Set the stack size in bytes (default=524288)
2846 Activate log (logfile=/tmp/qemu.log)
2848 Act as if the host page size was 'pagesize' bytes
2852 @chapter Compilation from the sources
2857 * Cross compilation for Windows with Linux::
2864 @subsection Compilation
2866 First you must decompress the sources:
2869 tar zxvf qemu-x.y.z.tar.gz
2873 Then you configure QEMU and build it (usually no options are needed):
2879 Then type as root user:
2883 to install QEMU in @file{/usr/local}.
2885 @subsection GCC version
2887 In order to compile QEMU successfully, it is very important that you
2888 have the right tools. The most important one is gcc. On most hosts and
2889 in particular on x86 ones, @emph{gcc 4.x is not supported}. If your
2890 Linux distribution includes a gcc 4.x compiler, you can usually
2891 install an older version (it is invoked by @code{gcc32} or
2892 @code{gcc34}). The QEMU configure script automatically probes for
2893 these older versions so that usually you don't have to do anything.
2899 @item Install the current versions of MSYS and MinGW from
2900 @url{http://www.mingw.org/}. You can find detailed installation
2901 instructions in the download section and the FAQ.
2904 the MinGW development library of SDL 1.2.x
2905 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2906 @url{http://www.libsdl.org}. Unpack it in a temporary place, and
2907 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
2908 directory. Edit the @file{sdl-config} script so that it gives the
2909 correct SDL directory when invoked.
2911 @item Extract the current version of QEMU.
2913 @item Start the MSYS shell (file @file{msys.bat}).
2915 @item Change to the QEMU directory. Launch @file{./configure} and
2916 @file{make}. If you have problems using SDL, verify that
2917 @file{sdl-config} can be launched from the MSYS command line.
2919 @item You can install QEMU in @file{Program Files/Qemu} by typing
2920 @file{make install}. Don't forget to copy @file{SDL.dll} in
2921 @file{Program Files/Qemu}.
2925 @node Cross compilation for Windows with Linux
2926 @section Cross compilation for Windows with Linux
2930 Install the MinGW cross compilation tools available at
2931 @url{http://www.mingw.org/}.
2934 Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
2935 unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
2936 variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
2937 the QEMU configuration script.
2940 Configure QEMU for Windows cross compilation:
2942 ./configure --enable-mingw32
2944 If necessary, you can change the cross-prefix according to the prefix
2945 chosen for the MinGW tools with --cross-prefix. You can also use
2946 --prefix to set the Win32 install path.
2948 @item You can install QEMU in the installation directory by typing
2949 @file{make install}. Don't forget to copy @file{SDL.dll} in the
2950 installation directory.
2954 Note: Currently, Wine does not seem able to launch
2960 The Mac OS X patches are not fully merged in QEMU, so you should look
2961 at the QEMU mailing list archive to have all the necessary