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.
275 @item boot=@var{boot}
276 @var{boot} if "on" enables extboot for a given drive so it can be used as a boot drive.
279 Instead of @option{-cdrom} you can use:
281 qemu -drive file=file,index=2,media=cdrom
284 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
287 qemu -drive file=file,index=0,media=disk
288 qemu -drive file=file,index=1,media=disk
289 qemu -drive file=file,index=2,media=disk
290 qemu -drive file=file,index=3,media=disk
293 You can connect a CDROM to the slave of ide0:
295 qemu -drive file=file,if=ide,index=1,media=cdrom
298 If you don't specify the "file=" argument, you define an empty drive:
300 qemu -drive if=ide,index=1,media=cdrom
303 You can connect a SCSI disk with unit ID 6 on the bus #0:
305 qemu -drive file=file,if=scsi,bus=0,unit=6
308 To boot from a SCSI disk, one would use:
311 qemu -drive file=file,if=scsi,boot=on
314 Instead of @option{-fda}, @option{-fdb}, you can use:
316 qemu -drive file=file,index=0,if=floppy
317 qemu -drive file=file,index=1,if=floppy
320 By default, @var{interface} is "ide" and @var{index} is automatically
323 qemu -drive file=a -drive file=b"
330 @item -boot [a|c|d|n]
331 Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
335 Write to temporary files instead of disk image files. In this case,
336 the raw disk image you use is not written back. You can however force
337 the write back by pressing @key{C-a s} (@pxref{disk_images}).
340 Disable boot signature checking for floppy disks in Bochs BIOS. It may
341 be needed to boot from old floppy disks.
344 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
345 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
346 gigabytes respectively.
349 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
350 CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
355 Will show the audio subsystem help: list of drivers, tunable
358 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
360 Enable audio and selected sound hardware. Use ? to print all
361 available sound hardware.
364 qemu -soundhw sb16,adlib hda
365 qemu -soundhw es1370 hda
366 qemu -soundhw ac97 hda
367 qemu -soundhw all hda
371 Note that Linux's i810_audio OSS kernel (for AC97) module might
372 require manually specifying clocking.
375 modprobe i810_audio clocking=48000
379 Set the real time clock to local time (the default is to UTC
380 time). This option is needed to have correct date in MS-DOS or
383 @item -startdate @var{date}
384 Set the initial date of the real time clock. Valid format for
385 @var{date} are: @code{now} or @code{2006-06-17T16:01:21} or
386 @code{2006-06-17}. The default value is @code{now}.
388 @item -pidfile @var{file}
389 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
393 Daemonize the QEMU process after initialization. QEMU will not detach from
394 standard IO until it is ready to receive connections on any of its devices.
395 This option is a useful way for external programs to launch QEMU without having
396 to cope with initialization race conditions.
399 Use it when installing Windows 2000 to avoid a disk full bug. After
400 Windows 2000 is installed, you no longer need this option (this option
401 slows down the IDE transfers).
403 @item -option-rom @var{file}
404 Load the contents of @var{file} as an option ROM.
405 This option is useful to load things like EtherBoot.
407 @item -name @var{name}
408 Sets the @var{name} of the guest.
409 This name will be display in the SDL window caption.
410 The @var{name} will also be used for the VNC server.
419 Normally, QEMU uses SDL to display the VGA output. With this option,
420 you can totally disable graphical output so that QEMU is a simple
421 command line application. The emulated serial port is redirected on
422 the console. Therefore, you can still use QEMU to debug a Linux kernel
423 with a serial console.
427 Normally, QEMU uses SDL to display the VGA output. With this option,
428 QEMU can display the VGA output when in text mode using a
429 curses/ncurses interface. Nothing is displayed in graphical mode.
433 Do not use decorations for SDL windows and start them using the whole
434 available screen space. This makes the using QEMU in a dedicated desktop
435 workspace more convenient.
439 Disable SDL window close capability.
442 Start in full screen.
444 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
446 Normally, QEMU uses SDL to display the VGA output. With this option,
447 you can have QEMU listen on VNC display @var{display} and redirect the VGA
448 display over the VNC session. It is very useful to enable the usb
449 tablet device when using this option (option @option{-usbdevice
450 tablet}). When using the VNC display, you must use the @option{-k}
451 parameter to set the keyboard layout if you are not using en-us. Valid
452 syntax for the @var{display} is
456 @item @var{host}:@var{d}
458 TCP connections will only be allowed from @var{host} on display @var{d}.
459 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
460 be omitted in which case the server will accept connections from any host.
462 @item @code{unix}:@var{path}
464 Connections will be allowed over UNIX domain sockets where @var{path} is the
465 location of a unix socket to listen for connections on.
469 VNC is initialized but not started. The monitor @code{change} command
470 can be used to later start the VNC server.
474 Following the @var{display} value there may be one or more @var{option} flags
475 separated by commas. Valid options are
481 Connect to a listening VNC client via a ``reverse'' connection. The
482 client is specified by the @var{display}. For reverse network
483 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
484 is a TCP port number, not a display number.
488 Require that password based authentication is used for client connections.
489 The password must be set separately using the @code{change} command in the
494 Require that client use TLS when communicating with the VNC server. This
495 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
496 attack. It is recommended that this option be combined with either the
497 @var{x509} or @var{x509verify} options.
499 @item x509=@var{/path/to/certificate/dir}
501 Valid if @option{tls} is specified. Require that x509 credentials are used
502 for negotiating the TLS session. The server will send its x509 certificate
503 to the client. It is recommended that a password be set on the VNC server
504 to provide authentication of the client when this is used. The path following
505 this option specifies where the x509 certificates are to be loaded from.
506 See the @ref{vnc_security} section for details on generating certificates.
508 @item x509verify=@var{/path/to/certificate/dir}
510 Valid if @option{tls} is specified. Require that x509 credentials are used
511 for negotiating the TLS session. The server will send its x509 certificate
512 to the client, and request that the client send its own x509 certificate.
513 The server will validate the client's certificate against the CA certificate,
514 and reject clients when validation fails. If the certificate authority is
515 trusted, this is a sufficient authentication mechanism. You may still wish
516 to set a password on the VNC server as a second authentication layer. The
517 path following this option specifies where the x509 certificates are to
518 be loaded from. See the @ref{vnc_security} section for details on generating
523 @item -k @var{language}
525 Use keyboard layout @var{language} (for example @code{fr} for
526 French). This option is only needed where it is not easy to get raw PC
527 keycodes (e.g. on Macs, with some X11 servers or with a VNC
528 display). You don't normally need to use it on PC/Linux or PC/Windows
531 The available layouts are:
533 ar de-ch es fo fr-ca hu ja mk no pt-br sv
534 da en-gb et fr fr-ch is lt nl pl ru th
535 de en-us fi fr-be hr it lv nl-be pt sl tr
538 The default is @code{en-us}.
546 Enable the USB driver (will be the default soon)
548 @item -usbdevice @var{devname}
549 Add the USB device @var{devname}. @xref{usb_devices}.
554 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
557 Pointer device that uses absolute coordinates (like a touchscreen). This
558 means qemu is able to report the mouse position without having to grab the
559 mouse. Also overrides the PS/2 mouse emulation when activated.
562 Mass storage device based on file
565 Pass through the host device identified by bus.addr (Linux only).
567 @item host:vendor_id:product_id
568 Pass through the host device identified by vendor_id:product_id (Linux only).
570 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
571 Serial converter to host character device @var{dev}, see @code{-serial} for the
575 Braille device. This will use BrlAPI to display the braille output on a real
586 @item -net nic[,vlan=@var{n}][,macaddr=@var{addr}][,model=@var{type}]
587 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
588 = 0 is the default). The NIC is an rtl8139 by default on the PC
589 target. Optionally, the MAC address can be changed. If no
590 @option{-net} option is specified, a single NIC is created.
591 Qemu can emulate several different models of network card.
592 Valid values for @var{type} are
593 @code{i82551}, @code{i82557b}, @code{i82559er},
594 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
595 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
596 Not all devices are supported on all targets. Use -net nic,model=?
597 for a list of available devices for your target.
599 @item -net user[,vlan=@var{n}][,hostname=@var{name}]
600 Use the user mode network stack which requires no administrator
601 privilege to run. @option{hostname=name} can be used to specify the client
602 hostname reported by the builtin DHCP server.
604 @item -net tap[,vlan=@var{n}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}]
605 Connect the host TAP network interface @var{name} to VLAN @var{n} and
606 use the network script @var{file} to configure it. The default
607 network script is @file{/etc/qemu-ifup}. Use @option{script=no} to
608 disable script execution. If @var{name} is not
609 provided, the OS automatically provides one. @option{fd}=@var{h} can be
610 used to specify the handle of an already opened host TAP interface. Example:
613 qemu linux.img -net nic -net tap
616 More complicated example (two NICs, each one connected to a TAP device)
618 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
619 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
623 @item -net socket[,vlan=@var{n}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
625 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
626 machine using a TCP socket connection. If @option{listen} is
627 specified, QEMU waits for incoming connections on @var{port}
628 (@var{host} is optional). @option{connect} is used to connect to
629 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
630 specifies an already opened TCP socket.
634 # launch a first QEMU instance
635 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
636 -net socket,listen=:1234
637 # connect the VLAN 0 of this instance to the VLAN 0
638 # of the first instance
639 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
640 -net socket,connect=127.0.0.1:1234
643 @item -net socket[,vlan=@var{n}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
645 Create a VLAN @var{n} shared with another QEMU virtual
646 machines using a UDP multicast socket, effectively making a bus for
647 every QEMU with same multicast address @var{maddr} and @var{port}.
651 Several QEMU can be running on different hosts and share same bus (assuming
652 correct multicast setup for these hosts).
654 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
655 @url{http://user-mode-linux.sf.net}.
657 Use @option{fd=h} to specify an already opened UDP multicast socket.
662 # launch one QEMU instance
663 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
664 -net socket,mcast=230.0.0.1:1234
665 # launch another QEMU instance on same "bus"
666 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
667 -net socket,mcast=230.0.0.1:1234
668 # launch yet another QEMU instance on same "bus"
669 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
670 -net socket,mcast=230.0.0.1:1234
673 Example (User Mode Linux compat.):
675 # launch QEMU instance (note mcast address selected
677 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
678 -net socket,mcast=239.192.168.1:1102
680 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
684 Indicate that no network devices should be configured. It is used to
685 override the default configuration (@option{-net nic -net user}) which
686 is activated if no @option{-net} options are provided.
688 @item -tftp @var{dir}
689 When using the user mode network stack, activate a built-in TFTP
690 server. The files in @var{dir} will be exposed as the root of a TFTP server.
691 The TFTP client on the guest must be configured in binary mode (use the command
692 @code{bin} of the Unix TFTP client). The host IP address on the guest is as
695 @item -bootp @var{file}
696 When using the user mode network stack, broadcast @var{file} as the BOOTP
697 filename. In conjunction with @option{-tftp}, this can be used to network boot
698 a guest from a local directory.
700 Example (using pxelinux):
702 qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0
706 When using the user mode network stack, activate a built-in SMB
707 server so that Windows OSes can access to the host files in @file{@var{dir}}
710 In the guest Windows OS, the line:
714 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
715 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
717 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
719 Note that a SAMBA server must be installed on the host OS in
720 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
721 2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
723 @item -redir [tcp|udp]:@var{host-port}:[@var{guest-host}]:@var{guest-port}
725 When using the user mode network stack, redirect incoming TCP or UDP
726 connections to the host port @var{host-port} to the guest
727 @var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
728 is not specified, its value is 10.0.2.15 (default address given by the
729 built-in DHCP server).
731 For example, to redirect host X11 connection from screen 1 to guest
732 screen 0, use the following:
736 qemu -redir tcp:6001::6000 [...]
737 # this host xterm should open in the guest X11 server
741 To redirect telnet connections from host port 5555 to telnet port on
742 the guest, use the following:
746 qemu -redir tcp:5555::23 [...]
747 telnet localhost 5555
750 Then when you use on the host @code{telnet localhost 5555}, you
751 connect to the guest telnet server.
755 Linux boot specific: When using these options, you can use a given
756 Linux kernel without installing it in the disk image. It can be useful
757 for easier testing of various kernels.
761 @item -kernel @var{bzImage}
762 Use @var{bzImage} as kernel image.
764 @item -append @var{cmdline}
765 Use @var{cmdline} as kernel command line
767 @item -initrd @var{file}
768 Use @var{file} as initial ram disk.
772 Debug/Expert options:
775 @item -serial @var{dev}
776 Redirect the virtual serial port to host character device
777 @var{dev}. The default device is @code{vc} in graphical mode and
778 @code{stdio} in non graphical mode.
780 This option can be used several times to simulate up to 4 serials
783 Use @code{-serial none} to disable all serial ports.
785 Available character devices are:
788 Virtual console. Optionally, a width and height can be given in pixel with
792 It is also possible to specify width or height in characters:
797 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
799 No device is allocated.
803 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
804 parameters are set according to the emulated ones.
805 @item /dev/parport@var{N}
806 [Linux only, parallel port only] Use host parallel port
807 @var{N}. Currently SPP and EPP parallel port features can be used.
808 @item file:@var{filename}
809 Write output to @var{filename}. No character can be read.
811 [Unix only] standard input/output
812 @item pipe:@var{filename}
813 name pipe @var{filename}
815 [Windows only] Use host serial port @var{n}
816 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
817 This implements UDP Net Console.
818 When @var{remote_host} or @var{src_ip} are not specified
819 they default to @code{0.0.0.0}.
820 When not using a specified @var{src_port} a random port is automatically chosen.
822 If you just want a simple readonly console you can use @code{netcat} or
823 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
824 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
825 will appear in the netconsole session.
827 If you plan to send characters back via netconsole or you want to stop
828 and start qemu a lot of times, you should have qemu use the same
829 source port each time by using something like @code{-serial
830 udp::4555@@:4556} to qemu. Another approach is to use a patched
831 version of netcat which can listen to a TCP port and send and receive
832 characters via udp. If you have a patched version of netcat which
833 activates telnet remote echo and single char transfer, then you can
834 use the following options to step up a netcat redirector to allow
835 telnet on port 5555 to access the qemu port.
838 -serial udp::4555@@:4556
839 @item netcat options:
840 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
841 @item telnet options:
846 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
847 The TCP Net Console has two modes of operation. It can send the serial
848 I/O to a location or wait for a connection from a location. By default
849 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
850 the @var{server} option QEMU will wait for a client socket application
851 to connect to the port before continuing, unless the @code{nowait}
852 option was specified. The @code{nodelay} option disables the Nagle buffering
853 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
854 one TCP connection at a time is accepted. You can use @code{telnet} to
855 connect to the corresponding character device.
857 @item Example to send tcp console to 192.168.0.2 port 4444
858 -serial tcp:192.168.0.2:4444
859 @item Example to listen and wait on port 4444 for connection
860 -serial tcp::4444,server
861 @item Example to not wait and listen on ip 192.168.0.100 port 4444
862 -serial tcp:192.168.0.100:4444,server,nowait
865 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
866 The telnet protocol is used instead of raw tcp sockets. The options
867 work the same as if you had specified @code{-serial tcp}. The
868 difference is that the port acts like a telnet server or client using
869 telnet option negotiation. This will also allow you to send the
870 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
871 sequence. Typically in unix telnet you do it with Control-] and then
872 type "send break" followed by pressing the enter key.
874 @item unix:@var{path}[,server][,nowait]
875 A unix domain socket is used instead of a tcp socket. The option works the
876 same as if you had specified @code{-serial tcp} except the unix domain socket
877 @var{path} is used for connections.
879 @item mon:@var{dev_string}
880 This is a special option to allow the monitor to be multiplexed onto
881 another serial port. The monitor is accessed with key sequence of
882 @key{Control-a} and then pressing @key{c}. See monitor access
883 @ref{pcsys_keys} in the -nographic section for more keys.
884 @var{dev_string} should be any one of the serial devices specified
885 above. An example to multiplex the monitor onto a telnet server
886 listening on port 4444 would be:
888 @item -serial mon:telnet::4444,server,nowait
892 Braille device. This will use BrlAPI to display the braille output on a real
897 @item -parallel @var{dev}
898 Redirect the virtual parallel port to host device @var{dev} (same
899 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
900 be used to use hardware devices connected on the corresponding host
903 This option can be used several times to simulate up to 3 parallel
906 Use @code{-parallel none} to disable all parallel ports.
908 @item -monitor @var{dev}
909 Redirect the monitor to host device @var{dev} (same devices as the
911 The default device is @code{vc} in graphical mode and @code{stdio} in
914 @item -echr numeric_ascii_value
915 Change the escape character used for switching to the monitor when using
916 monitor and serial sharing. The default is @code{0x01} when using the
917 @code{-nographic} option. @code{0x01} is equal to pressing
918 @code{Control-a}. You can select a different character from the ascii
919 control keys where 1 through 26 map to Control-a through Control-z. For
920 instance you could use the either of the following to change the escape
921 character to Control-t.
928 Wait gdb connection to port 1234 (@pxref{gdb_usage}).
930 Change gdb connection port. @var{port} can be either a decimal number
931 to specify a TCP port, or a host device (same devices as the serial port).
933 Do not start CPU at startup (you must type 'c' in the monitor).
935 Output log in /tmp/qemu.log
936 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
937 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
938 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
939 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
940 all those parameters. This option is useful for old MS-DOS disk
944 Set the directory for the BIOS, VGA BIOS and keymaps.
947 Simulate a standard VGA card with Bochs VBE extensions (default is
948 Cirrus Logic GD5446 PCI VGA). If your guest OS supports the VESA 2.0
949 VBE extensions (e.g. Windows XP) and if you want to use high
950 resolution modes (>= 1280x1024x16) then you should use this option.
953 Disable ACPI (Advanced Configuration and Power Interface) support. Use
954 it if your guest OS complains about ACPI problems (PC target machine
958 Exit instead of rebooting.
961 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
962 This allows for instance switching to monitor to commit changes to the
966 Start right away with a saved state (@code{loadvm} in monitor)
969 Enable semihosting syscall emulation (ARM and M68K target machines only).
971 On ARM this implements the "Angel" interface.
972 On M68K this implements the "ColdFire GDB" interface used by libgloss.
974 Note that this allows guest direct access to the host filesystem,
975 so should only be used with trusted guest OS.
977 @item -icount [N|auto]
978 Enable virtual instruction counter. The virtual cpu will execute one
979 instruction every 2^N ns of virtual time. If @code{auto} is specified
980 then the virtual cpu speed will be automatically adjusted to keep virtual
981 time within a few seconds of real time.
983 Note that while this option can give deterministic behavior, it does not
984 provide cycle accurate emulation. Modern CPUs contain superscalar out of
985 order cores with complex cache hierarchies. The number of instructions
986 executed often has little or no correlation with actual performance.
996 During the graphical emulation, you can use the following keys:
1002 Switch to virtual console 'n'. Standard console mappings are:
1005 Target system display
1013 Toggle mouse and keyboard grab.
1016 In the virtual consoles, you can use @key{Ctrl-Up}, @key{Ctrl-Down},
1017 @key{Ctrl-PageUp} and @key{Ctrl-PageDown} to move in the back log.
1019 During emulation, if you are using the @option{-nographic} option, use
1020 @key{Ctrl-a h} to get terminal commands:
1028 Save disk data back to file (if -snapshot)
1030 toggle console timestamps
1032 Send break (magic sysrq in Linux)
1034 Switch between console and monitor
1042 @c man begin SEEALSO
1043 The HTML documentation of QEMU for more precise information and Linux
1044 user mode emulator invocation.
1054 @section QEMU Monitor
1056 The QEMU monitor is used to give complex commands to the QEMU
1057 emulator. You can use it to:
1062 Remove or insert removable media images
1063 (such as CD-ROM or floppies).
1066 Freeze/unfreeze the Virtual Machine (VM) and save or restore its state
1069 @item Inspect the VM state without an external debugger.
1073 @subsection Commands
1075 The following commands are available:
1079 @item help or ? [@var{cmd}]
1080 Show the help for all commands or just for command @var{cmd}.
1083 Commit changes to the disk images (if -snapshot is used).
1085 @item info @var{subcommand}
1086 Show various information about the system state.
1090 show the various VLANs and the associated devices
1092 show the block devices
1093 @item info registers
1094 show the cpu registers
1096 show the command line history
1098 show emulated PCI device
1100 show USB devices plugged on the virtual USB hub
1102 show all USB host devices
1104 show information about active capturing
1105 @item info snapshots
1106 show list of VM snapshots
1108 show which guest mouse is receiving events
1114 @item eject [-f] @var{device}
1115 Eject a removable medium (use -f to force it).
1117 @item change @var{device} @var{setting}
1119 Change the configuration of a device.
1122 @item change @var{diskdevice} @var{filename}
1123 Change the medium for a removable disk device to point to @var{filename}. eg
1126 (qemu) change ide1-cd0 /path/to/some.iso
1129 @item change vnc @var{display},@var{options}
1130 Change the configuration of the VNC server. The valid syntax for @var{display}
1131 and @var{options} are described at @ref{sec_invocation}. eg
1134 (qemu) change vnc localhost:1
1137 @item change vnc password
1139 Change the password associated with the VNC server. The monitor will prompt for
1140 the new password to be entered. VNC passwords are only significant upto 8 letters.
1144 (qemu) change vnc password
1150 @item screendump @var{filename}
1151 Save screen into PPM image @var{filename}.
1153 @item mouse_move @var{dx} @var{dy} [@var{dz}]
1154 Move the active mouse to the specified coordinates @var{dx} @var{dy}
1155 with optional scroll axis @var{dz}.
1157 @item mouse_button @var{val}
1158 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
1160 @item mouse_set @var{index}
1161 Set which mouse device receives events at given @var{index}, index
1162 can be obtained with
1167 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
1168 Capture audio into @var{filename}. Using sample rate @var{frequency}
1169 bits per sample @var{bits} and number of channels @var{channels}.
1173 @item Sample rate = 44100 Hz - CD quality
1175 @item Number of channels = 2 - Stereo
1178 @item stopcapture @var{index}
1179 Stop capture with a given @var{index}, index can be obtained with
1184 @item log @var{item1}[,...]
1185 Activate logging of the specified items to @file{/tmp/qemu.log}.
1187 @item savevm [@var{tag}|@var{id}]
1188 Create a snapshot of the whole virtual machine. If @var{tag} is
1189 provided, it is used as human readable identifier. If there is already
1190 a snapshot with the same tag or ID, it is replaced. More info at
1193 @item loadvm @var{tag}|@var{id}
1194 Set the whole virtual machine to the snapshot identified by the tag
1195 @var{tag} or the unique snapshot ID @var{id}.
1197 @item delvm @var{tag}|@var{id}
1198 Delete the snapshot identified by @var{tag} or @var{id}.
1206 @item gdbserver [@var{port}]
1207 Start gdbserver session (default @var{port}=1234)
1209 @item x/fmt @var{addr}
1210 Virtual memory dump starting at @var{addr}.
1212 @item xp /@var{fmt} @var{addr}
1213 Physical memory dump starting at @var{addr}.
1215 @var{fmt} is a format which tells the command how to format the
1216 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
1220 is the number of items to be dumped.
1223 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
1224 c (char) or i (asm instruction).
1227 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
1228 @code{h} or @code{w} can be specified with the @code{i} format to
1229 respectively select 16 or 32 bit code instruction size.
1236 Dump 10 instructions at the current instruction pointer:
1241 0x90107065: lea 0x0(%esi,1),%esi
1242 0x90107069: lea 0x0(%edi,1),%edi
1244 0x90107071: jmp 0x90107080
1252 Dump 80 16 bit values at the start of the video memory.
1254 (qemu) xp/80hx 0xb8000
1255 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
1256 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
1257 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
1258 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
1259 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
1260 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
1261 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1262 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1263 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1264 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
1268 @item p or print/@var{fmt} @var{expr}
1270 Print expression value. Only the @var{format} part of @var{fmt} is
1273 @item sendkey @var{keys}
1275 Send @var{keys} to the emulator. Use @code{-} to press several keys
1276 simultaneously. Example:
1281 This command is useful to send keys that your graphical user interface
1282 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
1288 @item boot_set @var{bootdevicelist}
1290 Define new values for the boot device list. Those values will override
1291 the values specified on the command line through the @code{-boot} option.
1293 The values that can be specified here depend on the machine type, but are
1294 the same that can be specified in the @code{-boot} command line option.
1296 @item usb_add @var{devname}
1298 Add the USB device @var{devname}. For details of available devices see
1301 @item usb_del @var{devname}
1303 Remove the USB device @var{devname} from the QEMU virtual USB
1304 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
1305 command @code{info usb} to see the devices you can remove.
1309 @subsection Integer expressions
1311 The monitor understands integers expressions for every integer
1312 argument. You can use register names to get the value of specifics
1313 CPU registers by prefixing them with @emph{$}.
1316 @section Disk Images
1318 Since version 0.6.1, QEMU supports many disk image formats, including
1319 growable disk images (their size increase as non empty sectors are
1320 written), compressed and encrypted disk images. Version 0.8.3 added
1321 the new qcow2 disk image format which is essential to support VM
1325 * disk_images_quickstart:: Quick start for disk image creation
1326 * disk_images_snapshot_mode:: Snapshot mode
1327 * vm_snapshots:: VM snapshots
1328 * qemu_img_invocation:: qemu-img Invocation
1329 * qemu_nbd_invocation:: qemu-nbd Invocation
1330 * host_drives:: Using host drives
1331 * disk_images_fat_images:: Virtual FAT disk images
1332 * disk_images_nbd:: NBD access
1335 @node disk_images_quickstart
1336 @subsection Quick start for disk image creation
1338 You can create a disk image with the command:
1340 qemu-img create myimage.img mysize
1342 where @var{myimage.img} is the disk image filename and @var{mysize} is its
1343 size in kilobytes. You can add an @code{M} suffix to give the size in
1344 megabytes and a @code{G} suffix for gigabytes.
1346 See @ref{qemu_img_invocation} for more information.
1348 @node disk_images_snapshot_mode
1349 @subsection Snapshot mode
1351 If you use the option @option{-snapshot}, all disk images are
1352 considered as read only. When sectors in written, they are written in
1353 a temporary file created in @file{/tmp}. You can however force the
1354 write back to the raw disk images by using the @code{commit} monitor
1355 command (or @key{C-a s} in the serial console).
1358 @subsection VM snapshots
1360 VM snapshots are snapshots of the complete virtual machine including
1361 CPU state, RAM, device state and the content of all the writable
1362 disks. In order to use VM snapshots, you must have at least one non
1363 removable and writable block device using the @code{qcow2} disk image
1364 format. Normally this device is the first virtual hard drive.
1366 Use the monitor command @code{savevm} to create a new VM snapshot or
1367 replace an existing one. A human readable name can be assigned to each
1368 snapshot in addition to its numerical ID.
1370 Use @code{loadvm} to restore a VM snapshot and @code{delvm} to remove
1371 a VM snapshot. @code{info snapshots} lists the available snapshots
1372 with their associated information:
1375 (qemu) info snapshots
1376 Snapshot devices: hda
1377 Snapshot list (from hda):
1378 ID TAG VM SIZE DATE VM CLOCK
1379 1 start 41M 2006-08-06 12:38:02 00:00:14.954
1380 2 40M 2006-08-06 12:43:29 00:00:18.633
1381 3 msys 40M 2006-08-06 12:44:04 00:00:23.514
1384 A VM snapshot is made of a VM state info (its size is shown in
1385 @code{info snapshots}) and a snapshot of every writable disk image.
1386 The VM state info is stored in the first @code{qcow2} non removable
1387 and writable block device. The disk image snapshots are stored in
1388 every disk image. The size of a snapshot in a disk image is difficult
1389 to evaluate and is not shown by @code{info snapshots} because the
1390 associated disk sectors are shared among all the snapshots to save
1391 disk space (otherwise each snapshot would need a full copy of all the
1394 When using the (unrelated) @code{-snapshot} option
1395 (@ref{disk_images_snapshot_mode}), you can always make VM snapshots,
1396 but they are deleted as soon as you exit QEMU.
1398 VM snapshots currently have the following known limitations:
1401 They cannot cope with removable devices if they are removed or
1402 inserted after a snapshot is done.
1404 A few device drivers still have incomplete snapshot support so their
1405 state is not saved or restored properly (in particular USB).
1408 @node qemu_img_invocation
1409 @subsection @code{qemu-img} Invocation
1411 @include qemu-img.texi
1413 @node qemu_nbd_invocation
1414 @subsection @code{qemu-nbd} Invocation
1416 @include qemu-nbd.texi
1419 @subsection Using host drives
1421 In addition to disk image files, QEMU can directly access host
1422 devices. We describe here the usage for QEMU version >= 0.8.3.
1424 @subsubsection Linux
1426 On Linux, you can directly use the host device filename instead of a
1427 disk image filename provided you have enough privileges to access
1428 it. For example, use @file{/dev/cdrom} to access to the CDROM or
1429 @file{/dev/fd0} for the floppy.
1433 You can specify a CDROM device even if no CDROM is loaded. QEMU has
1434 specific code to detect CDROM insertion or removal. CDROM ejection by
1435 the guest OS is supported. Currently only data CDs are supported.
1437 You can specify a floppy device even if no floppy is loaded. Floppy
1438 removal is currently not detected accurately (if you change floppy
1439 without doing floppy access while the floppy is not loaded, the guest
1440 OS will think that the same floppy is loaded).
1442 Hard disks can be used. Normally you must specify the whole disk
1443 (@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
1444 see it as a partitioned disk. WARNING: unless you know what you do, it
1445 is better to only make READ-ONLY accesses to the hard disk otherwise
1446 you may corrupt your host data (use the @option{-snapshot} command
1447 line option or modify the device permissions accordingly).
1450 @subsubsection Windows
1454 The preferred syntax is the drive letter (e.g. @file{d:}). The
1455 alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
1456 supported as an alias to the first CDROM drive.
1458 Currently there is no specific code to handle removable media, so it
1459 is better to use the @code{change} or @code{eject} monitor commands to
1460 change or eject media.
1462 Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
1463 where @var{N} is the drive number (0 is the first hard disk).
1465 WARNING: unless you know what you do, it is better to only make
1466 READ-ONLY accesses to the hard disk otherwise you may corrupt your
1467 host data (use the @option{-snapshot} command line so that the
1468 modifications are written in a temporary file).
1472 @subsubsection Mac OS X
1474 @file{/dev/cdrom} is an alias to the first CDROM.
1476 Currently there is no specific code to handle removable media, so it
1477 is better to use the @code{change} or @code{eject} monitor commands to
1478 change or eject media.
1480 @node disk_images_fat_images
1481 @subsection Virtual FAT disk images
1483 QEMU can automatically create a virtual FAT disk image from a
1484 directory tree. In order to use it, just type:
1487 qemu linux.img -hdb fat:/my_directory
1490 Then you access access to all the files in the @file{/my_directory}
1491 directory without having to copy them in a disk image or to export
1492 them via SAMBA or NFS. The default access is @emph{read-only}.
1494 Floppies can be emulated with the @code{:floppy:} option:
1497 qemu linux.img -fda fat:floppy:/my_directory
1500 A read/write support is available for testing (beta stage) with the
1504 qemu linux.img -fda fat:floppy:rw:/my_directory
1507 What you should @emph{never} do:
1509 @item use non-ASCII filenames ;
1510 @item use "-snapshot" together with ":rw:" ;
1511 @item expect it to work when loadvm'ing ;
1512 @item write to the FAT directory on the host system while accessing it with the guest system.
1515 @node disk_images_nbd
1516 @subsection NBD access
1518 QEMU can access directly to block device exported using the Network Block Device
1522 qemu linux.img -hdb nbd:my_nbd_server.mydomain.org:1024
1525 If the NBD server is located on the same host, you can use an unix socket instead
1529 qemu linux.img -hdb nbd:unix:/tmp/my_socket
1532 In this case, the block device must be exported using qemu-nbd:
1535 qemu-nbd --socket=/tmp/my_socket my_disk.qcow2
1538 The use of qemu-nbd allows to share a disk between several guests:
1540 qemu-nbd --socket=/tmp/my_socket --share=2 my_disk.qcow2
1543 and then you can use it with two guests:
1545 qemu linux1.img -hdb nbd:unix:/tmp/my_socket
1546 qemu linux2.img -hdb nbd:unix:/tmp/my_socket
1550 @section Network emulation
1552 QEMU can simulate several network cards (PCI or ISA cards on the PC
1553 target) and can connect them to an arbitrary number of Virtual Local
1554 Area Networks (VLANs). Host TAP devices can be connected to any QEMU
1555 VLAN. VLAN can be connected between separate instances of QEMU to
1556 simulate large networks. For simpler usage, a non privileged user mode
1557 network stack can replace the TAP device to have a basic network
1562 QEMU simulates several VLANs. A VLAN can be symbolised as a virtual
1563 connection between several network devices. These devices can be for
1564 example QEMU virtual Ethernet cards or virtual Host ethernet devices
1567 @subsection Using TAP network interfaces
1569 This is the standard way to connect QEMU to a real network. QEMU adds
1570 a virtual network device on your host (called @code{tapN}), and you
1571 can then configure it as if it was a real ethernet card.
1573 @subsubsection Linux host
1575 As an example, you can download the @file{linux-test-xxx.tar.gz}
1576 archive and copy the script @file{qemu-ifup} in @file{/etc} and
1577 configure properly @code{sudo} so that the command @code{ifconfig}
1578 contained in @file{qemu-ifup} can be executed as root. You must verify
1579 that your host kernel supports the TAP network interfaces: the
1580 device @file{/dev/net/tun} must be present.
1582 See @ref{sec_invocation} to have examples of command lines using the
1583 TAP network interfaces.
1585 @subsubsection Windows host
1587 There is a virtual ethernet driver for Windows 2000/XP systems, called
1588 TAP-Win32. But it is not included in standard QEMU for Windows,
1589 so you will need to get it separately. It is part of OpenVPN package,
1590 so download OpenVPN from : @url{http://openvpn.net/}.
1592 @subsection Using the user mode network stack
1594 By using the option @option{-net user} (default configuration if no
1595 @option{-net} option is specified), QEMU uses a completely user mode
1596 network stack (you don't need root privilege to use the virtual
1597 network). The virtual network configuration is the following:
1601 QEMU VLAN <------> Firewall/DHCP server <-----> Internet
1604 ----> DNS server (10.0.2.3)
1606 ----> SMB server (10.0.2.4)
1609 The QEMU VM behaves as if it was behind a firewall which blocks all
1610 incoming connections. You can use a DHCP client to automatically
1611 configure the network in the QEMU VM. The DHCP server assign addresses
1612 to the hosts starting from 10.0.2.15.
1614 In order to check that the user mode network is working, you can ping
1615 the address 10.0.2.2 and verify that you got an address in the range
1616 10.0.2.x from the QEMU virtual DHCP server.
1618 Note that @code{ping} is not supported reliably to the internet as it
1619 would require root privileges. It means you can only ping the local
1622 When using the built-in TFTP server, the router is also the TFTP
1625 When using the @option{-redir} option, TCP or UDP connections can be
1626 redirected from the host to the guest. It allows for example to
1627 redirect X11, telnet or SSH connections.
1629 @subsection Connecting VLANs between QEMU instances
1631 Using the @option{-net socket} option, it is possible to make VLANs
1632 that span several QEMU instances. See @ref{sec_invocation} to have a
1635 @node direct_linux_boot
1636 @section Direct Linux Boot
1638 This section explains how to launch a Linux kernel inside QEMU without
1639 having to make a full bootable image. It is very useful for fast Linux
1644 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img -append "root=/dev/hda"
1647 Use @option{-kernel} to provide the Linux kernel image and
1648 @option{-append} to give the kernel command line arguments. The
1649 @option{-initrd} option can be used to provide an INITRD image.
1651 When using the direct Linux boot, a disk image for the first hard disk
1652 @file{hda} is required because its boot sector is used to launch the
1655 If you do not need graphical output, you can disable it and redirect
1656 the virtual serial port and the QEMU monitor to the console with the
1657 @option{-nographic} option. The typical command line is:
1659 qemu -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1660 -append "root=/dev/hda console=ttyS0" -nographic
1663 Use @key{Ctrl-a c} to switch between the serial console and the
1664 monitor (@pxref{pcsys_keys}).
1667 @section USB emulation
1669 QEMU emulates a PCI UHCI USB controller. You can virtually plug
1670 virtual USB devices or real host USB devices (experimental, works only
1671 on Linux hosts). Qemu will automatically create and connect virtual USB hubs
1672 as necessary to connect multiple USB devices.
1676 * host_usb_devices::
1679 @subsection Connecting USB devices
1681 USB devices can be connected with the @option{-usbdevice} commandline option
1682 or the @code{usb_add} monitor command. Available devices are:
1686 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
1688 Pointer device that uses absolute coordinates (like a touchscreen).
1689 This means qemu is able to report the mouse position without having
1690 to grab the mouse. Also overrides the PS/2 mouse emulation when activated.
1691 @item disk:@var{file}
1692 Mass storage device based on @var{file} (@pxref{disk_images})
1693 @item host:@var{bus.addr}
1694 Pass through the host device identified by @var{bus.addr}
1696 @item host:@var{vendor_id:product_id}
1697 Pass through the host device identified by @var{vendor_id:product_id}
1700 Virtual Wacom PenPartner tablet. This device is similar to the @code{tablet}
1701 above but it can be used with the tslib library because in addition to touch
1702 coordinates it reports touch pressure.
1704 Standard USB keyboard. Will override the PS/2 keyboard (if present).
1705 @item serial:[vendorid=@var{vendor_id}][,product_id=@var{product_id}]:@var{dev}
1706 Serial converter. This emulates an FTDI FT232BM chip connected to host character
1707 device @var{dev}. The available character devices are the same as for the
1708 @code{-serial} option. The @code{vendorid} and @code{productid} options can be
1709 used to override the default 0403:6001. For instance,
1711 usb_add serial:productid=FA00:tcp:192.168.0.2:4444
1713 will connect to tcp port 4444 of ip 192.168.0.2, and plug that to the virtual
1714 serial converter, faking a Matrix Orbital LCD Display (USB ID 0403:FA00).
1716 Braille device. This will use BrlAPI to display the braille output on a real
1720 @node host_usb_devices
1721 @subsection Using host USB devices on a Linux host
1723 WARNING: this is an experimental feature. QEMU will slow down when
1724 using it. USB devices requiring real time streaming (i.e. USB Video
1725 Cameras) are not supported yet.
1728 @item If you use an early Linux 2.4 kernel, verify that no Linux driver
1729 is actually using the USB device. A simple way to do that is simply to
1730 disable the corresponding kernel module by renaming it from @file{mydriver.o}
1731 to @file{mydriver.o.disabled}.
1733 @item Verify that @file{/proc/bus/usb} is working (most Linux distributions should enable it by default). You should see something like that:
1739 @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:
1741 chown -R myuid /proc/bus/usb
1744 @item Launch QEMU and do in the monitor:
1747 Device 1.2, speed 480 Mb/s
1748 Class 00: USB device 1234:5678, USB DISK
1750 You should see the list of the devices you can use (Never try to use
1751 hubs, it won't work).
1753 @item Add the device in QEMU by using:
1755 usb_add host:1234:5678
1758 Normally the guest OS should report that a new USB device is
1759 plugged. You can use the option @option{-usbdevice} to do the same.
1761 @item Now you can try to use the host USB device in QEMU.
1765 When relaunching QEMU, you may have to unplug and plug again the USB
1766 device to make it work again (this is a bug).
1769 @section VNC security
1771 The VNC server capability provides access to the graphical console
1772 of the guest VM across the network. This has a number of security
1773 considerations depending on the deployment scenarios.
1777 * vnc_sec_password::
1778 * vnc_sec_certificate::
1779 * vnc_sec_certificate_verify::
1780 * vnc_sec_certificate_pw::
1781 * vnc_generate_cert::
1784 @subsection Without passwords
1786 The simplest VNC server setup does not include any form of authentication.
1787 For this setup it is recommended to restrict it to listen on a UNIX domain
1788 socket only. For example
1791 qemu [...OPTIONS...] -vnc unix:/home/joebloggs/.qemu-myvm-vnc
1794 This ensures that only users on local box with read/write access to that
1795 path can access the VNC server. To securely access the VNC server from a
1796 remote machine, a combination of netcat+ssh can be used to provide a secure
1799 @node vnc_sec_password
1800 @subsection With passwords
1802 The VNC protocol has limited support for password based authentication. Since
1803 the protocol limits passwords to 8 characters it should not be considered
1804 to provide high security. The password can be fairly easily brute-forced by
1805 a client making repeat connections. For this reason, a VNC server using password
1806 authentication should be restricted to only listen on the loopback interface
1807 or UNIX domain sockets. Password ayuthentication is requested with the @code{password}
1808 option, and then once QEMU is running the password is set with the monitor. Until
1809 the monitor is used to set the password all clients will be rejected.
1812 qemu [...OPTIONS...] -vnc :1,password -monitor stdio
1813 (qemu) change vnc password
1818 @node vnc_sec_certificate
1819 @subsection With x509 certificates
1821 The QEMU VNC server also implements the VeNCrypt extension allowing use of
1822 TLS for encryption of the session, and x509 certificates for authentication.
1823 The use of x509 certificates is strongly recommended, because TLS on its
1824 own is susceptible to man-in-the-middle attacks. Basic x509 certificate
1825 support provides a secure session, but no authentication. This allows any
1826 client to connect, and provides an encrypted session.
1829 qemu [...OPTIONS...] -vnc :1,tls,x509=/etc/pki/qemu -monitor stdio
1832 In the above example @code{/etc/pki/qemu} should contain at least three files,
1833 @code{ca-cert.pem}, @code{server-cert.pem} and @code{server-key.pem}. Unprivileged
1834 users will want to use a private directory, for example @code{$HOME/.pki/qemu}.
1835 NB the @code{server-key.pem} file should be protected with file mode 0600 to
1836 only be readable by the user owning it.
1838 @node vnc_sec_certificate_verify
1839 @subsection With x509 certificates and client verification
1841 Certificates can also provide a means to authenticate the client connecting.
1842 The server will request that the client provide a certificate, which it will
1843 then validate against the CA certificate. This is a good choice if deploying
1844 in an environment with a private internal certificate authority.
1847 qemu [...OPTIONS...] -vnc :1,tls,x509verify=/etc/pki/qemu -monitor stdio
1851 @node vnc_sec_certificate_pw
1852 @subsection With x509 certificates, client verification and passwords
1854 Finally, the previous method can be combined with VNC password authentication
1855 to provide two layers of authentication for clients.
1858 qemu [...OPTIONS...] -vnc :1,password,tls,x509verify=/etc/pki/qemu -monitor stdio
1859 (qemu) change vnc password
1864 @node vnc_generate_cert
1865 @subsection Generating certificates for VNC
1867 The GNU TLS packages provides a command called @code{certtool} which can
1868 be used to generate certificates and keys in PEM format. At a minimum it
1869 is neccessary to setup a certificate authority, and issue certificates to
1870 each server. If using certificates for authentication, then each client
1871 will also need to be issued a certificate. The recommendation is for the
1872 server to keep its certificates in either @code{/etc/pki/qemu} or for
1873 unprivileged users in @code{$HOME/.pki/qemu}.
1877 * vnc_generate_server::
1878 * vnc_generate_client::
1880 @node vnc_generate_ca
1881 @subsubsection Setup the Certificate Authority
1883 This step only needs to be performed once per organization / organizational
1884 unit. First the CA needs a private key. This key must be kept VERY secret
1885 and secure. If this key is compromised the entire trust chain of the certificates
1886 issued with it is lost.
1889 # certtool --generate-privkey > ca-key.pem
1892 A CA needs to have a public certificate. For simplicity it can be a self-signed
1893 certificate, or one issue by a commercial certificate issuing authority. To
1894 generate a self-signed certificate requires one core piece of information, the
1895 name of the organization.
1898 # cat > ca.info <<EOF
1899 cn = Name of your organization
1903 # certtool --generate-self-signed \
1904 --load-privkey ca-key.pem
1905 --template ca.info \
1906 --outfile ca-cert.pem
1909 The @code{ca-cert.pem} file should be copied to all servers and clients wishing to utilize
1910 TLS support in the VNC server. The @code{ca-key.pem} must not be disclosed/copied at all.
1912 @node vnc_generate_server
1913 @subsubsection Issuing server certificates
1915 Each server (or host) needs to be issued with a key and certificate. When connecting
1916 the certificate is sent to the client which validates it against the CA certificate.
1917 The core piece of information for a server certificate is the hostname. This should
1918 be the fully qualified hostname that the client will connect with, since the client
1919 will typically also verify the hostname in the certificate. On the host holding the
1920 secure CA private key:
1923 # cat > server.info <<EOF
1924 organization = Name of your organization
1925 cn = server.foo.example.com
1930 # certtool --generate-privkey > server-key.pem
1931 # certtool --generate-certificate \
1932 --load-ca-certificate ca-cert.pem \
1933 --load-ca-privkey ca-key.pem \
1934 --load-privkey server server-key.pem \
1935 --template server.info \
1936 --outfile server-cert.pem
1939 The @code{server-key.pem} and @code{server-cert.pem} files should now be securely copied
1940 to the server for which they were generated. The @code{server-key.pem} is security
1941 sensitive and should be kept protected with file mode 0600 to prevent disclosure.
1943 @node vnc_generate_client
1944 @subsubsection Issuing client certificates
1946 If the QEMU VNC server is to use the @code{x509verify} option to validate client
1947 certificates as its authentication mechanism, each client also needs to be issued
1948 a certificate. The client certificate contains enough metadata to uniquely identify
1949 the client, typically organization, state, city, building, etc. On the host holding
1950 the secure CA private key:
1953 # cat > client.info <<EOF
1957 organiazation = Name of your organization
1958 cn = client.foo.example.com
1963 # certtool --generate-privkey > client-key.pem
1964 # certtool --generate-certificate \
1965 --load-ca-certificate ca-cert.pem \
1966 --load-ca-privkey ca-key.pem \
1967 --load-privkey client-key.pem \
1968 --template client.info \
1969 --outfile client-cert.pem
1972 The @code{client-key.pem} and @code{client-cert.pem} files should now be securely
1973 copied to the client for which they were generated.
1978 QEMU has a primitive support to work with gdb, so that you can do
1979 'Ctrl-C' while the virtual machine is running and inspect its state.
1981 In order to use gdb, launch qemu with the '-s' option. It will wait for a
1984 > qemu -s -kernel arch/i386/boot/bzImage -hda root-2.4.20.img \
1985 -append "root=/dev/hda"
1986 Connected to host network interface: tun0
1987 Waiting gdb connection on port 1234
1990 Then launch gdb on the 'vmlinux' executable:
1995 In gdb, connect to QEMU:
1997 (gdb) target remote localhost:1234
2000 Then you can use gdb normally. For example, type 'c' to launch the kernel:
2005 Here are some useful tips in order to use gdb on system code:
2009 Use @code{info reg} to display all the CPU registers.
2011 Use @code{x/10i $eip} to display the code at the PC position.
2013 Use @code{set architecture i8086} to dump 16 bit code. Then use
2014 @code{x/10i $cs*16+$eip} to dump the code at the PC position.
2017 Advanced debugging options:
2019 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:
2021 @item maintenance packet qqemu.sstepbits
2023 This will display the MASK bits used to control the single stepping IE:
2025 (gdb) maintenance packet qqemu.sstepbits
2026 sending: "qqemu.sstepbits"
2027 received: "ENABLE=1,NOIRQ=2,NOTIMER=4"
2029 @item maintenance packet qqemu.sstep
2031 This will display the current value of the mask used when single stepping IE:
2033 (gdb) maintenance packet qqemu.sstep
2034 sending: "qqemu.sstep"
2037 @item maintenance packet Qqemu.sstep=HEX_VALUE
2039 This will change the single step mask, so if wanted to enable IRQs on the single step, but not timers, you would use:
2041 (gdb) maintenance packet Qqemu.sstep=0x5
2042 sending: "qemu.sstep=0x5"
2047 @node pcsys_os_specific
2048 @section Target OS specific information
2052 To have access to SVGA graphic modes under X11, use the @code{vesa} or
2053 the @code{cirrus} X11 driver. For optimal performances, use 16 bit
2054 color depth in the guest and the host OS.
2056 When using a 2.6 guest Linux kernel, you should add the option
2057 @code{clock=pit} on the kernel command line because the 2.6 Linux
2058 kernels make very strict real time clock checks by default that QEMU
2059 cannot simulate exactly.
2061 When using a 2.6 guest Linux kernel, verify that the 4G/4G patch is
2062 not activated because QEMU is slower with this patch. The QEMU
2063 Accelerator Module is also much slower in this case. Earlier Fedora
2064 Core 3 Linux kernel (< 2.6.9-1.724_FC3) were known to incorporate this
2065 patch by default. Newer kernels don't have it.
2069 If you have a slow host, using Windows 95 is better as it gives the
2070 best speed. Windows 2000 is also a good choice.
2072 @subsubsection SVGA graphic modes support
2074 QEMU emulates a Cirrus Logic GD5446 Video
2075 card. All Windows versions starting from Windows 95 should recognize
2076 and use this graphic card. For optimal performances, use 16 bit color
2077 depth in the guest and the host OS.
2079 If you are using Windows XP as guest OS and if you want to use high
2080 resolution modes which the Cirrus Logic BIOS does not support (i.e. >=
2081 1280x1024x16), then you should use the VESA VBE virtual graphic card
2082 (option @option{-std-vga}).
2084 @subsubsection CPU usage reduction
2086 Windows 9x does not correctly use the CPU HLT
2087 instruction. The result is that it takes host CPU cycles even when
2088 idle. You can install the utility from
2089 @url{http://www.user.cityline.ru/~maxamn/amnhltm.zip} to solve this
2090 problem. Note that no such tool is needed for NT, 2000 or XP.
2092 @subsubsection Windows 2000 disk full problem
2094 Windows 2000 has a bug which gives a disk full problem during its
2095 installation. When installing it, use the @option{-win2k-hack} QEMU
2096 option to enable a specific workaround. After Windows 2000 is
2097 installed, you no longer need this option (this option slows down the
2100 @subsubsection Windows 2000 shutdown
2102 Windows 2000 cannot automatically shutdown in QEMU although Windows 98
2103 can. It comes from the fact that Windows 2000 does not automatically
2104 use the APM driver provided by the BIOS.
2106 In order to correct that, do the following (thanks to Struan
2107 Bartlett): go to the Control Panel => Add/Remove Hardware & Next =>
2108 Add/Troubleshoot a device => Add a new device & Next => No, select the
2109 hardware from a list & Next => NT Apm/Legacy Support & Next => Next
2110 (again) a few times. Now the driver is installed and Windows 2000 now
2111 correctly instructs QEMU to shutdown at the appropriate moment.
2113 @subsubsection Share a directory between Unix and Windows
2115 See @ref{sec_invocation} about the help of the option @option{-smb}.
2117 @subsubsection Windows XP security problem
2119 Some releases of Windows XP install correctly but give a security
2122 A problem is preventing Windows from accurately checking the
2123 license for this computer. Error code: 0x800703e6.
2126 The workaround is to install a service pack for XP after a boot in safe
2127 mode. Then reboot, and the problem should go away. Since there is no
2128 network while in safe mode, its recommended to download the full
2129 installation of SP1 or SP2 and transfer that via an ISO or using the
2130 vvfat block device ("-hdb fat:directory_which_holds_the_SP").
2132 @subsection MS-DOS and FreeDOS
2134 @subsubsection CPU usage reduction
2136 DOS does not correctly use the CPU HLT instruction. The result is that
2137 it takes host CPU cycles even when idle. You can install the utility
2138 from @url{http://www.vmware.com/software/dosidle210.zip} to solve this
2141 @node QEMU System emulator for non PC targets
2142 @chapter QEMU System emulator for non PC targets
2144 QEMU is a generic emulator and it emulates many non PC
2145 machines. Most of the options are similar to the PC emulator. The
2146 differences are mentioned in the following sections.
2149 * QEMU PowerPC System emulator::
2150 * Sparc32 System emulator::
2151 * Sparc64 System emulator::
2152 * MIPS System emulator::
2153 * ARM System emulator::
2154 * ColdFire System emulator::
2157 @node QEMU PowerPC System emulator
2158 @section QEMU PowerPC System emulator
2160 Use the executable @file{qemu-system-ppc} to simulate a complete PREP
2161 or PowerMac PowerPC system.
2163 QEMU emulates the following PowerMac peripherals:
2169 PCI VGA compatible card with VESA Bochs Extensions
2171 2 PMAC IDE interfaces with hard disk and CD-ROM support
2177 VIA-CUDA with ADB keyboard and mouse.
2180 QEMU emulates the following PREP peripherals:
2186 PCI VGA compatible card with VESA Bochs Extensions
2188 2 IDE interfaces with hard disk and CD-ROM support
2192 NE2000 network adapters
2196 PREP Non Volatile RAM
2198 PC compatible keyboard and mouse.
2201 QEMU uses the Open Hack'Ware Open Firmware Compatible BIOS available at
2202 @url{http://perso.magic.fr/l_indien/OpenHackWare/index.htm}.
2204 @c man begin OPTIONS
2206 The following options are specific to the PowerPC emulation:
2210 @item -g WxH[xDEPTH]
2212 Set the initial VGA graphic mode. The default is 800x600x15.
2219 More information is available at
2220 @url{http://perso.magic.fr/l_indien/qemu-ppc/}.
2222 @node Sparc32 System emulator
2223 @section Sparc32 System emulator
2225 Use the executable @file{qemu-system-sparc} to simulate a SPARCstation
2226 5, SPARCstation 10, SPARCstation 20, SPARCserver 600MP (sun4m
2227 architecture), SPARCstation 2 (sun4c architecture), SPARCserver 1000,
2228 or SPARCcenter 2000 (sun4d architecture). The emulation is somewhat
2229 complete. SMP up to 16 CPUs is supported, but Linux limits the number
2230 of usable CPUs to 4.
2232 QEMU emulates the following sun4m/sun4d peripherals:
2240 Lance (Am7990) Ethernet
2242 Non Volatile RAM M48T08
2244 Slave I/O: timers, interrupt controllers, Zilog serial ports, keyboard
2245 and power/reset logic
2247 ESP SCSI controller with hard disk and CD-ROM support
2249 Floppy drive (not on SS-600MP)
2251 CS4231 sound device (only on SS-5, not working yet)
2254 The number of peripherals is fixed in the architecture. Maximum
2255 memory size depends on the machine type, for SS-5 it is 256MB and for
2258 Since version 0.8.2, QEMU uses OpenBIOS
2259 @url{http://www.openbios.org/}. OpenBIOS is a free (GPL v2) portable
2260 firmware implementation. The goal is to implement a 100% IEEE
2261 1275-1994 (referred to as Open Firmware) compliant firmware.
2263 A sample Linux 2.6 series kernel and ram disk image are available on
2264 the QEMU web site. Please note that currently NetBSD, OpenBSD or
2265 Solaris kernels don't work.
2267 @c man begin OPTIONS
2269 The following options are specific to the Sparc32 emulation:
2273 @item -g WxHx[xDEPTH]
2275 Set the initial TCX graphic mode. The default is 1024x768x8, currently
2276 the only other possible mode is 1024x768x24.
2278 @item -prom-env string
2280 Set OpenBIOS variables in NVRAM, for example:
2283 qemu-system-sparc -prom-env 'auto-boot?=false' \
2284 -prom-env 'boot-device=sd(0,2,0):d' -prom-env 'boot-args=linux single'
2287 @item -M [SS-5|SS-10|SS-20|SS-600MP|SS-2|SS-1000|SS-2000]
2289 Set the emulated machine type. Default is SS-5.
2295 @node Sparc64 System emulator
2296 @section Sparc64 System emulator
2298 Use the executable @file{qemu-system-sparc64} to simulate a Sun4u machine.
2299 The emulator is not usable for anything yet.
2301 QEMU emulates the following sun4u peripherals:
2305 UltraSparc IIi APB PCI Bridge
2307 PCI VGA compatible card with VESA Bochs Extensions
2309 Non Volatile RAM M48T59
2311 PC-compatible serial ports
2314 @node MIPS System emulator
2315 @section MIPS System emulator
2317 Four executables cover simulation of 32 and 64-bit MIPS systems in
2318 both endian options, @file{qemu-system-mips}, @file{qemu-system-mipsel}
2319 @file{qemu-system-mips64} and @file{qemu-system-mips64el}.
2320 Five different machine types are emulated:
2324 A generic ISA PC-like machine "mips"
2326 The MIPS Malta prototype board "malta"
2328 An ACER Pica "pica61". This machine needs the 64-bit emulator.
2330 MIPS emulator pseudo board "mipssim"
2332 A MIPS Magnum R4000 machine "magnum". This machine needs the 64-bit emulator.
2335 The generic emulation is supported by Debian 'Etch' and is able to
2336 install Debian into a virtual disk image. The following devices are
2341 A range of MIPS CPUs, default is the 24Kf
2343 PC style serial port
2350 The Malta emulation supports the following devices:
2354 Core board with MIPS 24Kf CPU and Galileo system controller
2356 PIIX4 PCI/USB/SMbus controller
2358 The Multi-I/O chip's serial device
2360 PCnet32 PCI network card
2362 Malta FPGA serial device
2364 Cirrus VGA graphics card
2367 The ACER Pica emulation supports:
2373 PC-style IRQ and DMA controllers
2380 The mipssim pseudo board emulation provides an environment similiar
2381 to what the proprietary MIPS emulator uses for running Linux.
2386 A range of MIPS CPUs, default is the 24Kf
2388 PC style serial port
2390 MIPSnet network emulation
2393 The MIPS Magnum R4000 emulation supports:
2399 PC-style IRQ controller
2409 @node ARM System emulator
2410 @section ARM System emulator
2412 Use the executable @file{qemu-system-arm} to simulate a ARM
2413 machine. The ARM Integrator/CP board is emulated with the following
2418 ARM926E, ARM1026E, ARM946E, ARM1136 or Cortex-A8 CPU
2422 SMC 91c111 Ethernet adapter
2424 PL110 LCD controller
2426 PL050 KMI with PS/2 keyboard and mouse.
2428 PL181 MultiMedia Card Interface with SD card.
2431 The ARM Versatile baseboard is emulated with the following devices:
2435 ARM926E, ARM1136 or Cortex-A8 CPU
2437 PL190 Vectored Interrupt Controller
2441 SMC 91c111 Ethernet adapter
2443 PL110 LCD controller
2445 PL050 KMI with PS/2 keyboard and mouse.
2447 PCI host bridge. Note the emulated PCI bridge only provides access to
2448 PCI memory space. It does not provide access to PCI IO space.
2449 This means some devices (eg. ne2k_pci NIC) are not usable, and others
2450 (eg. rtl8139 NIC) are only usable when the guest drivers use the memory
2451 mapped control registers.
2453 PCI OHCI USB controller.
2455 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices.
2457 PL181 MultiMedia Card Interface with SD card.
2460 The ARM RealView Emulation baseboard is emulated with the following devices:
2464 ARM926E, ARM1136, ARM11MPCORE(x4) or Cortex-A8 CPU
2466 ARM AMBA Generic/Distributed Interrupt Controller
2470 SMC 91c111 Ethernet adapter
2472 PL110 LCD controller
2474 PL050 KMI with PS/2 keyboard and mouse
2478 PCI OHCI USB controller
2480 LSI53C895A PCI SCSI Host Bus Adapter with hard disk and CD-ROM devices
2482 PL181 MultiMedia Card Interface with SD card.
2485 The XScale-based clamshell PDA models ("Spitz", "Akita", "Borzoi"
2486 and "Terrier") emulation includes the following peripherals:
2490 Intel PXA270 System-on-chip (ARM V5TE core)
2494 IBM/Hitachi DSCM microdrive in a PXA PCMCIA slot - not in "Akita"
2496 On-chip OHCI USB controller
2498 On-chip LCD controller
2500 On-chip Real Time Clock
2502 TI ADS7846 touchscreen controller on SSP bus
2504 Maxim MAX1111 analog-digital converter on I@math{^2}C bus
2506 GPIO-connected keyboard controller and LEDs
2508 Secure Digital card connected to PXA MMC/SD host
2512 WM8750 audio CODEC on I@math{^2}C and I@math{^2}S busses
2515 The Palm Tungsten|E PDA (codename "Cheetah") emulation includes the
2520 Texas Instruments OMAP310 System-on-chip (ARM 925T core)
2522 ROM and RAM memories (ROM firmware image can be loaded with -option-rom)
2524 On-chip LCD controller
2526 On-chip Real Time Clock
2528 TI TSC2102i touchscreen controller / analog-digital converter / Audio
2529 CODEC, connected through MicroWire and I@math{^2}S busses
2531 GPIO-connected matrix keypad
2533 Secure Digital card connected to OMAP MMC/SD host
2538 Nokia N800 and N810 internet tablets (known also as RX-34 and RX-44 / 48)
2539 emulation supports the following elements:
2543 Texas Instruments OMAP2420 System-on-chip (ARM 1136 core)
2545 RAM and non-volatile OneNAND Flash memories
2547 Display connected to EPSON remote framebuffer chip and OMAP on-chip
2548 display controller and a LS041y3 MIPI DBI-C controller
2550 TI TSC2301 (in N800) and TI TSC2005 (in N810) touchscreen controllers
2551 driven through SPI bus
2553 National Semiconductor LM8323-controlled qwerty keyboard driven
2554 through I@math{^2}C bus
2556 Secure Digital card connected to OMAP MMC/SD host
2558 Three OMAP on-chip UARTs and on-chip STI debugging console
2560 Mentor Graphics "Inventra" dual-role USB controller embedded in a TI
2561 TUSB6010 chip - only USB host mode is supported
2563 TI TMP105 temperature sensor driven through I@math{^2}C bus
2565 TI TWL92230C power management companion with an RTC on I@math{^2}C bus
2567 Nokia RETU and TAHVO multi-purpose chips with an RTC, connected
2571 The Luminary Micro Stellaris LM3S811EVB emulation includes the following
2578 64k Flash and 8k SRAM.
2580 Timers, UARTs, ADC and I@math{^2}C interface.
2582 OSRAM Pictiva 96x16 OLED with SSD0303 controller on I@math{^2}C bus.
2585 The Luminary Micro Stellaris LM3S6965EVB emulation includes the following
2592 256k Flash and 64k SRAM.
2594 Timers, UARTs, ADC, I@math{^2}C and SSI interfaces.
2596 OSRAM Pictiva 128x64 OLED with SSD0323 controller connected via SSI.
2599 The Freecom MusicPal internet radio emulation includes the following
2604 Marvell MV88W8618 ARM core.
2606 32 MB RAM, 256 KB SRAM, 8 MB flash.
2610 MV88W8xx8 Ethernet controller
2612 MV88W8618 audio controller, WM8750 CODEC and mixer
2614 128×64 display with brightness control
2616 2 buttons, 2 navigation wheels with button function
2619 A Linux 2.6 test image is available on the QEMU web site. More
2620 information is available in the QEMU mailing-list archive.
2622 @node ColdFire System emulator
2623 @section ColdFire System emulator
2625 Use the executable @file{qemu-system-m68k} to simulate a ColdFire machine.
2626 The emulator is able to boot a uClinux kernel.
2628 The M5208EVB emulation includes the following devices:
2632 MCF5208 ColdFire V2 Microprocessor (ISA A+ with EMAC).
2634 Three Two on-chip UARTs.
2636 Fast Ethernet Controller (FEC)
2639 The AN5206 emulation includes the following devices:
2643 MCF5206 ColdFire V2 Microprocessor.
2648 @node QEMU User space emulator
2649 @chapter QEMU User space emulator
2652 * Supported Operating Systems ::
2653 * Linux User space emulator::
2654 * Mac OS X/Darwin User space emulator ::
2657 @node Supported Operating Systems
2658 @section Supported Operating Systems
2660 The following OS are supported in user space emulation:
2664 Linux (referred as qemu-linux-user)
2666 Mac OS X/Darwin (referred as qemu-darwin-user)
2669 @node Linux User space emulator
2670 @section Linux User space emulator
2675 * Command line options::
2680 @subsection Quick Start
2682 In order to launch a Linux process, QEMU needs the process executable
2683 itself and all the target (x86) dynamic libraries used by it.
2687 @item On x86, you can just try to launch any process by using the native
2691 qemu-i386 -L / /bin/ls
2694 @code{-L /} tells that the x86 dynamic linker must be searched with a
2697 @item Since QEMU is also a linux process, you can launch qemu with
2698 qemu (NOTE: you can only do that if you compiled QEMU from the sources):
2701 qemu-i386 -L / qemu-i386 -L / /bin/ls
2704 @item On non x86 CPUs, you need first to download at least an x86 glibc
2705 (@file{qemu-runtime-i386-XXX-.tar.gz} on the QEMU web page). Ensure that
2706 @code{LD_LIBRARY_PATH} is not set:
2709 unset LD_LIBRARY_PATH
2712 Then you can launch the precompiled @file{ls} x86 executable:
2715 qemu-i386 tests/i386/ls
2717 You can look at @file{qemu-binfmt-conf.sh} so that
2718 QEMU is automatically launched by the Linux kernel when you try to
2719 launch x86 executables. It requires the @code{binfmt_misc} module in the
2722 @item The x86 version of QEMU is also included. You can try weird things such as:
2724 qemu-i386 /usr/local/qemu-i386/bin/qemu-i386 \
2725 /usr/local/qemu-i386/bin/ls-i386
2731 @subsection Wine launch
2735 @item Ensure that you have a working QEMU with the x86 glibc
2736 distribution (see previous section). In order to verify it, you must be
2740 qemu-i386 /usr/local/qemu-i386/bin/ls-i386
2743 @item Download the binary x86 Wine install
2744 (@file{qemu-XXX-i386-wine.tar.gz} on the QEMU web page).
2746 @item Configure Wine on your account. Look at the provided script
2747 @file{/usr/local/qemu-i386/@/bin/wine-conf.sh}. Your previous
2748 @code{$@{HOME@}/.wine} directory is saved to @code{$@{HOME@}/.wine.org}.
2750 @item Then you can try the example @file{putty.exe}:
2753 qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
2754 /usr/local/qemu-i386/wine/c/Program\ Files/putty.exe
2759 @node Command line options
2760 @subsection Command line options
2763 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
2770 Set the x86 elf interpreter prefix (default=/usr/local/qemu-i386)
2772 Set the x86 stack size in bytes (default=524288)
2779 Activate log (logfile=/tmp/qemu.log)
2781 Act as if the host page size was 'pagesize' bytes
2784 Environment variables:
2788 Print system calls and arguments similar to the 'strace' program
2789 (NOTE: the actual 'strace' program will not work because the user
2790 space emulator hasn't implemented ptrace). At the moment this is
2791 incomplete. All system calls that don't have a specific argument
2792 format are printed with information for six arguments. Many
2793 flag-style arguments don't have decoders and will show up as numbers.
2796 @node Other binaries
2797 @subsection Other binaries
2799 @command{qemu-arm} is also capable of running ARM "Angel" semihosted ELF
2800 binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
2801 configurations), and arm-uclinux bFLT format binaries.
2803 @command{qemu-m68k} is capable of running semihosted binaries using the BDM
2804 (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
2805 coldfire uClinux bFLT format binaries.
2807 The binary format is detected automatically.
2809 @command{qemu-sparc32plus} can execute Sparc32 and SPARC32PLUS binaries
2810 (Sparc64 CPU, 32 bit ABI).
2812 @command{qemu-sparc64} can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
2813 SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
2815 @node Mac OS X/Darwin User space emulator
2816 @section Mac OS X/Darwin User space emulator
2819 * Mac OS X/Darwin Status::
2820 * Mac OS X/Darwin Quick Start::
2821 * Mac OS X/Darwin Command line options::
2824 @node Mac OS X/Darwin Status
2825 @subsection Mac OS X/Darwin Status
2829 target x86 on x86: Most apps (Cocoa and Carbon too) works. [1]
2831 target PowerPC on x86: Not working as the ppc commpage can't be mapped (yet!)
2833 target PowerPC on PowerPC: Most apps (Cocoa and Carbon too) works. [1]
2835 target x86 on PowerPC: most utilities work. Cocoa and Carbon apps are not yet supported.
2838 [1] If you're host commpage can be executed by qemu.
2840 @node Mac OS X/Darwin Quick Start
2841 @subsection Quick Start
2843 In order to launch a Mac OS X/Darwin process, QEMU needs the process executable
2844 itself and all the target dynamic libraries used by it. If you don't have the FAT
2845 libraries (you're running Mac OS X/ppc) you'll need to obtain it from a Mac OS X
2846 CD or compile them by hand.
2850 @item On x86, you can just try to launch any process by using the native
2857 or to run the ppc version of the executable:
2863 @item On ppc, you'll have to tell qemu where your x86 libraries (and dynamic linker)
2867 qemu-i386 -L /opt/x86_root/ /bin/ls
2870 @code{-L /opt/x86_root/} tells that the dynamic linker (dyld) path is in
2871 @file{/opt/x86_root/usr/bin/dyld}.
2875 @node Mac OS X/Darwin Command line options
2876 @subsection Command line options
2879 usage: qemu-i386 [-h] [-d] [-L path] [-s size] program [arguments...]
2886 Set the library root path (default=/)
2888 Set the stack size in bytes (default=524288)
2895 Activate log (logfile=/tmp/qemu.log)
2897 Act as if the host page size was 'pagesize' bytes
2901 @chapter Compilation from the sources
2906 * Cross compilation for Windows with Linux::
2913 @subsection Compilation
2915 First you must decompress the sources:
2918 tar zxvf qemu-x.y.z.tar.gz
2922 Then you configure QEMU and build it (usually no options are needed):
2928 Then type as root user:
2932 to install QEMU in @file{/usr/local}.
2934 @subsection GCC version
2936 In order to compile QEMU successfully, it is very important that you
2937 have the right tools. The most important one is gcc. On most hosts and
2938 in particular on x86 ones, @emph{gcc 4.x is not supported}. If your
2939 Linux distribution includes a gcc 4.x compiler, you can usually
2940 install an older version (it is invoked by @code{gcc32} or
2941 @code{gcc34}). The QEMU configure script automatically probes for
2942 these older versions so that usually you don't have to do anything.
2948 @item Install the current versions of MSYS and MinGW from
2949 @url{http://www.mingw.org/}. You can find detailed installation
2950 instructions in the download section and the FAQ.
2953 the MinGW development library of SDL 1.2.x
2954 (@file{SDL-devel-1.2.x-@/mingw32.tar.gz}) from
2955 @url{http://www.libsdl.org}. Unpack it in a temporary place, and
2956 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
2957 directory. Edit the @file{sdl-config} script so that it gives the
2958 correct SDL directory when invoked.
2960 @item Extract the current version of QEMU.
2962 @item Start the MSYS shell (file @file{msys.bat}).
2964 @item Change to the QEMU directory. Launch @file{./configure} and
2965 @file{make}. If you have problems using SDL, verify that
2966 @file{sdl-config} can be launched from the MSYS command line.
2968 @item You can install QEMU in @file{Program Files/Qemu} by typing
2969 @file{make install}. Don't forget to copy @file{SDL.dll} in
2970 @file{Program Files/Qemu}.
2974 @node Cross compilation for Windows with Linux
2975 @section Cross compilation for Windows with Linux
2979 Install the MinGW cross compilation tools available at
2980 @url{http://www.mingw.org/}.
2983 Install the Win32 version of SDL (@url{http://www.libsdl.org}) by
2984 unpacking @file{i386-mingw32msvc.tar.gz}. Set up the PATH environment
2985 variable so that @file{i386-mingw32msvc-sdl-config} can be launched by
2986 the QEMU configuration script.
2989 Configure QEMU for Windows cross compilation:
2991 ./configure --enable-mingw32
2993 If necessary, you can change the cross-prefix according to the prefix
2994 chosen for the MinGW tools with --cross-prefix. You can also use
2995 --prefix to set the Win32 install path.
2997 @item You can install QEMU in the installation directory by typing
2998 @file{make install}. Don't forget to copy @file{SDL.dll} in the
2999 installation directory.
3003 Note: Currently, Wine does not seem able to launch
3009 The Mac OS X patches are not fully merged in QEMU, so you should look
3010 at the QEMU mailing list archive to have all the necessary