[Qemu-devel] [PATCH] qemu-doc: Update to use the new way of attaching USB devices

[Thomas Huth]

The preferred way of adding USB devices is via "-device" and
"device_add" nowadays, so let's get rid of "-usbdevice" and
"usb_add" in the documentation.

Signed-off-by: Thomas Huth <address@hidden>
---
 qemu-doc.texi | 75 ++++++++++++++++++++++++-----------------------------------
 1 file changed, 31 insertions(+), 44 deletions(-)

diff --git a/qemu-doc.texi b/qemu-doc.texi
index 794ab4a..d119e67 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -182,7 +182,7 @@ Gravis Ultrasound GF1 sound card
 @item
 CS4231A compatible sound card
 @item
-PCI UHCI USB controller and a virtual USB hub.
+PCI UHCI, OHCI, EHCI or XHCI USB controller and a virtual USB-1.1 hub.
 @end itemize
 
 SMP is supported with up to 255 CPUs.
@@ -1357,10 +1357,10 @@ monitor (@pxref{pcsys_keys}).
 @node pcsys_usb
 @section USB emulation
 
-QEMU emulates a PCI UHCI USB controller. You can virtually plug
-virtual USB devices or real host USB devices (experimental, works only
-on Linux hosts).  QEMU will automatically create and connect virtual USB hubs
-as necessary to connect multiple USB devices.
+QEMU can emulate a PCI UHCI, OHCI, EHCI or XHCI USB controller. You can
+virtually plug virtual USB devices or real host USB devices (experimental,
+only works with certain host operating systems). QEMU will automatically create
+and connect virtual USB hubs as necessary to connect multiple USB devices.
 
 @menu
 * usb_devices::
@@ -1369,60 +1369,47 @@ as necessary to connect multiple USB devices.
 @node usb_devices
 @subsection Connecting USB devices
 
-USB devices can be connected with the @option{-usbdevice} commandline option
-or the @code{usb_add} monitor command.  Available devices are:
+USB devices can be connected with the @option{-device usb-...} commandline
+option or the @code{device_add} monitor command. Available devices are:
 
 @table @code
address@hidden mouse
address@hidden usb-mouse
 Virtual Mouse.  This will override the PS/2 mouse emulation when activated.
address@hidden tablet
address@hidden usb-tablet
 Pointer device that uses absolute coordinates (like a touchscreen).
 This means QEMU is able to report the mouse position without having
 to grab the mouse.  Also overrides the PS/2 mouse emulation when activated.
address@hidden disk:@var{file}
-Mass storage device based on @var{file} (@pxref{disk_images})
address@hidden host:@var{bus.addr}
-Pass through the host device identified by @var{bus.addr}
address@hidden usb-storage,address@hidden
+Mass storage device (see also @pxref{disk_images})
address@hidden usb-host,address@hidden,address@hidden
+Pass through the host device identified by @var{bus} and @var{addr}
 (Linux only)
address@hidden host:@var{vendor_id:product_id}
-Pass through the host device identified by @var{vendor_id:product_id}
address@hidden usb-host,address@hidden,address@hidden
+Pass through the host device identified by @var{vendor} and @var{product} ID
 (Linux only)
address@hidden wacom-tablet
address@hidden usb-wacom-tablet
 Virtual Wacom PenPartner tablet.  This device is similar to the @code{tablet}
 above but it can be used with the tslib library because in addition to touch
 coordinates it reports touch pressure.
address@hidden keyboard
address@hidden usb-kbd
 Standard USB keyboard.  Will override the PS/2 keyboard (if present).
address@hidden serial:address@hidden,address@hidden:@var{dev}
address@hidden usb-serial,address@hidden
 Serial converter. This emulates an FTDI FT232BM chip connected to host 
character
-device @var{dev}. The available character devices are the same as for the
address@hidden option. The @code{vendorid} and @code{productid} options can be
-used to override the default 0403:6001. For instance,
address@hidden
-usb_add serial:productid=FA00:tcp:192.168.0.2:4444
address@hidden example
-will connect to tcp port 4444 of ip 192.168.0.2, and plug that to the virtual
-serial converter, faking a Matrix Orbital LCD Display (USB ID 0403:FA00).
address@hidden braille
+device @var{dev}.
address@hidden usb-braille
 Braille device.  This will use BrlAPI to display the braille output on a real
 or fake device.
address@hidden net:@var{options}
-Network adapter that supports CDC ethernet and RNDIS protocols.  @var{options}
-specifies NIC options as with @code{-net nic,address@hidden (see description).
address@hidden net[,address@hidden
+Network adapter that supports CDC ethernet and RNDIS protocols.  @var{id}
+specifies a netdev ID as with @code{-netdev xxx,address@hidden
 For instance, user-mode networking can be used with
 @example
-qemu-system-i386 [...OPTIONS...] -net user,vlan=0 -usbdevice net:vlan=0
address@hidden example
-Currently this cannot be used in machines that support PCI NICs.
address@hidden bt[:@var{hci-type}]
-Bluetooth dongle whose type is specified in the same format as with
-the @option{-bt hci} option, @pxref{bt-hcis,,allowed HCI types}.  If
-no type is given, the HCI logic corresponds to @code{-bt hci,vlan=0}.
-This USB device implements the USB Transport Layer of HCI.  Example
-usage:
address@hidden
address@hidden address@hidden @option{-usbdevice} bt:hci,vlan=3 @option{-bt} 
device:keyboard,vlan=3
+qemu-system-i386 [...OPTIONS...] -netdev user,id=id0 -device usb-net,netdev=id0
 @end example
address@hidden usb-bt-dongle
+Bluetooth dongle which implements the USB Transport Layer of HCI.
+It is connected to HCI scatternet 0 by default (corresponds to
address@hidden hci,vlan=0}).
 @end table
 
 @node host_usb_devices
@@ -1460,11 +1447,11 @@ hubs, it won't work).
 
 @item Add the device in QEMU by using:
 @example
-usb_add host:1234:5678
+device_add usb-host,vendorid=0x1234,productid=0x5678
 @end example
 
-Normally the guest OS should report that a new USB device is
-plugged. You can use the option @option{-usbdevice} to do the same.
+Normally the guest OS should report that a new USB device is plugged.
+You can use the option @option{-device usb-host,...} to do the same.
 
 @item Now you can try to use the host USB device in QEMU.
 
-- 
1.8.3.1