qemu/docs/qdev-device-use.txt

1 = How to convert to -device & friends =
5 In qdev, each device has a parent bus.  Some devices provide one or
6 more buses for children.  You can specify a device's parent bus with
7 -device parameter bus.
9 A device typically has a device address on its parent bus.  For buses
23 Example: device i440FX-pcihost is on the root bus, and provides a PCI
24 bus named pci.0.  To put a FOO device into its slot 4, use -device
30 A QEMU block device (drive) has a host and a guest part.
32 In the general case, the guest device is connected to a controller
33 device.  For instance, the IDE controller provides two IDE buses, each
34 of which can have up to two devices, and each device is a guest part,
37 Except we sometimes lump controller, bus(es) and drive device(s) all
38 together into a single device.  For instance, the ISA floppy
42 together.  Sometimes, they can even define a controller device in
43 addition to the block device.
46 -drive, and guest device(s) with -device.
52 TYPE, BUS and UNIT identify the controller device, which of its buses
60    -device DEVNAME,drive=DRIVE-ID,DEV-OPTS...
79 The -device argument differs in detail for each type of drive:
83   -device DEVNAME,drive=DRIVE-ID,bus=IDE-BUS,unit=UNIT
93   -device lsi53c895a,id=ID
96   control the PCI device address.
101   -device DEVNAME,drive=DRIVE-ID,bus=ID.0,scsi-id=UNIT
107   -device floppy,unit=UNIT,drive=DRIVE-ID
109   Without any -device floppy,... you get an empty unit 0 and no unit
115   -device virtio-blk-pci,drive=DRIVE-ID,class=C,vectors=V,ioeventfd=IOEVENTFD
117   This lets you control PCI device class and MSI-X vectors.
123   control the PCI device address.  This replaces option addr available
126 * if=pflash, if=mtd, if=sd, if=xen are not yet available with -device
137     -device usb-storage,drive=DRIVE-ID,removable=RMB
143 Bug: usb-storage pretends to be a block device, but it's really a SCSI
144 controller that can serve only a single device, which it creates
151 A QEMU character device has a host and a guest part.
157 -chardev, and the guest device with -device.
159 The various old ways to define a character device are all of the
170     -device DEVNAME,chardev=CHR-ID,DEV-OPTS...
174 * -serial becomes -device isa-serial,iobase=IOADDR,irq=IRQ,index=IDX
178 * -parallel becomes -device isa-parallel,iobase=IOADDR,irq=IRQ,index=IDX
183   uses "braille".  With -device, this useful default is gone, so you
186   -device usb-braille,chardev=braille -chardev braille,id=braille
189   -device usb-serial,chardev=dev.
226   character device defined by LEGACY-CHARDEV.  -chardev provides more
250 The new way is -device:
252     -device DEVNAME,netdev=NET-ID,mac=MACADDR,DEV-OPTS...
255 device appropriate for the bus (virtio-net-pci for PCI), and for USB
258 The old name=ID parameter becomes the usual id=ID with -device.
261 device address, as usual.  The old -net nic provides parameter addr
262 for that, which is silently ignored when the NIC is not a PCI device.
268 except for virtio-net-pci (model=virtio).  With -device, only devices
271 Not all devices are available with -device at this time.  All PCI
280 The old way to define the guest graphics device is -vga VGA.  Not all
283 The new way is -device.  The mapping from -vga argument to -device
286     std         -device VGA
287     cirrus      -device cirrus-vga
288     vmware      -device vmware-svga
289     qxl         -device qxl-vga
294 the PCI device address.
296 -device VGA supports properties bios-offset and bios-size, but they
301     std         -device isa-vga
302     cirrus      not yet available with -device
307 because it violates obscure device initialization ordering
316 The new way is to define each guest audio device separately with
317 -device.
319 Map from -soundhw sound card name to -device:
321     ac97        -device AC97
322     cs4231a     -device cs4231a,iobase=IOADDR,irq=IRQ,dma=DMA
323     es1370      -device ES1370
324     gus         -device gus,iobase=IOADDR,irq=IRQ,dma=DMA,freq=F
325     hda         -device intel-hda,msi=MSI -device hda-duplex
326     sb16        -device sb16,iobase=IOADDR,irq=IRQ,dma=DMA,dma16=DMA16,version=V
327     adlib       not yet available with -device
328     pcspk       not yet available with -device
331 device address, as usual.
335 The old way to define a virtual USB device is -usbdevice DRIVER:OPTS...
337 The new way is -device DEVNAME,DEV-OPTS...  Details depend on DRIVER:
339 * ccid            -device usb-ccid
340 * keyboard        -device usb-kbd
341 * mouse           -device usb-mouse
342 * tablet          -device usb-tablet
343 * wacom-tablet    -device usb-wacom-tablet
344 * u2f             -device u2f-{emulated,passthru}
349 * host:...        See "Host Device Assignment"
358 The old way to define a guest watchdog device is -watchdog DEVNAME.
359 The new way is -device DEVNAME.  For PCI devices, you can add
360 bus=PCI-BUS,addr=DEVFN to control the PCI device address, as usual.
362 === Host Device Assignment ===
365 and host USB devices.  PCI devices can only be assigned with -device:
367     -device vfio-pci,host=ADDR,id=ID
369 The old way to assign a USB host device
378     -device usb-host,hostbus=BUS,hostaddr=ADDR,vendorid=VID,productid=PRID
387 -device DEVNAME... and global DEVNAME... suppress default devices for
390     default device      suppressing DEVNAMEs
400 It is *not* suppressed by configuring a NIC with -device (you may call