From 9b4b4af716be89cfa0b47e0dde935a0b57ef80b4 Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Tue, 12 Aug 2008 07:28:28 +0000 Subject: [PATCH] =?UTF-8?q?documentation=20for=20USB=20passthrough=20*=20d?= =?UTF-8?q?ocs/formatdomain.html=20docs/formatdomain.html.in:=20documentat?= =?UTF-8?q?ion=20=20=20for=20the=20USB=20format=20option=20by=20Guido=20G?= =?UTF-8?q?=C3=BCnther=20daniel?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ChangeLog | 5 ++++ docs/formatdomain.html | 41 ++++++++++++++++++++++++++++---- docs/formatdomain.html.in | 49 +++++++++++++++++++++++++++++++++++---- 3 files changed, 87 insertions(+), 8 deletions(-) diff --git a/ChangeLog b/ChangeLog index 6df3bff3a6..a3c88ed51b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Tue Aug 12 09:27:03 CEST 2008 Daniel Veillard + + * docs/formatdomain.html docs/formatdomain.html.in: documentation + for the USB format option by Guido Günther + Fri Aug 11 14:29:02 CEST 2008 Jim Meyering tests: append a newline to expected-output files lacking NL-at-EOF diff --git a/docs/formatdomain.html b/docs/formatdomain.html index 346f96085f..7b39c8fe56 100644 --- a/docs/formatdomain.html +++ b/docs/formatdomain.html @@ -139,6 +139,8 @@ Devices
  • Hard drives, floppy disks, CDROMs +
  • + USB devices
  • Network interfaces
    • @@ -450,14 +452,45 @@ the device name in the guest OS. Treat it as a device ordering hint. The optional bus attribute specifies the type of disk device to emulate; possible values are driver specific, with typical values being - "ide", "scsi", "virtio", "xen". If omitted, the bus type is inferred from - the style of the device name. eg, a device named 'sda' will typically be - exported using a SCSI bus. - Since 0.0.3; bus attribute since 0.4.3
      driver
      If the hypervisor supports multiple backend drivers, then the optional + "ide", "scsi", "virtio", "xen" or "usb". If omitted, the bus type is + inferred from the style of the device name. eg, a device named 'sda' + will typically be exported using a SCSI bus. + Since 0.0.3; bus attribute since 0.4.3; + "usb" attribute value since after 0.4.4
      driver
      If the hypervisor supports multiple backend drivers, then the optional driver element allows them to be selected. The name attribute is the primary backend driver name, while the optional type attribute provides the sub-type. Since 0.1.8
      +

      + USB devices +

      +

      + USB devices attached to the host can be passed through to the guest using + the hostdev element. since after 0.4.4 +

      + 
      +          ...
+	  <hostdev mode='subsystem' type='usb'>
+	    <source>
+	      <vendor id='0x1234'/>
+	      <product id='0xbeef'/>
+	    </source>
+	  </disk>
+	  ...
      +
      hostdev
      The hostdev element is the main container for describing + host devices. For usb device passthrough mode is always + "subsystem" and type is "usb". +
      source
      The source element describes the device as seen from the host. + The USB device can either be addressed by vendor / product id using the + vendor and product elements or by the device's + address on the hosts using the address element.
      vendor, product
      The vendor and product elements each have an + id attribute that specifies the USB vendor and product id. + The ids can be given in decimal, hexadecimal (starting with 0x) or + octal (starting with 0) form.
      address
      The address element has a bus and + device attribute to specify the USB bus and device number + the device appears at on the host. The values of these attributes can + be given in decimal, hexadecimal (starting with 0x) or octal (starting + with 0) form.

      Network interfaces

      diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index d4f650e6e1..28b432f394 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -362,10 +362,11 @@ the device name in the guest OS. Treat it as a device ordering hint. The optional bus attribute specifies the type of disk device to emulate; possible values are driver specific, with typical values being - "ide", "scsi", "virtio", "xen". If omitted, the bus type is inferred from - the style of the device name. eg, a device named 'sda' will typically be - exported using a SCSI bus. - Since 0.0.3; bus attribute since 0.4.3 + "ide", "scsi", "virtio", "xen" or "usb". If omitted, the bus type is + inferred from the style of the device name. eg, a device named 'sda' + will typically be exported using a SCSI bus. + Since 0.0.3; bus attribute since 0.4.3; + "usb" attribute value since after 0.4.4
      driver
      If the hypervisor supports multiple backend drivers, then the optional driver element allows them to be selected. The name @@ -374,6 +375,46 @@
      +

      USB devices

      + +

      + USB devices attached to the host can be passed through to the guest using + the hostdev element. since after 0.4.4 +

      + + 
      +          ...
+	  <hostdev mode='subsystem' type='usb'>
+	    <source>
+	      <vendor id='0x1234'/>
+	      <product id='0xbeef'/>
+	    </source>
+	  </disk>
+	  ...
      + +
      +
      hostdev
      +
      The hostdev element is the main container for describing + host devices. For usb device passthrough mode is always + "subsystem" and type is "usb". +
      source
      +
      The source element describes the device as seen from the host. + The USB device can either be addressed by vendor / product id using the + vendor and product elements or by the device's + address on the hosts using the address element.
      +
      vendor, product
      +
      The vendor and product elements each have an + id attribute that specifies the USB vendor and product id. + The ids can be given in decimal, hexadecimal (starting with 0x) or + octal (starting with 0) form.
      +
      address
      +
      The address element has a bus and + device attribute to specify the USB bus and device number + the device appears at on the host. The values of these attributes can + be given in decimal, hexadecimal (starting with 0x) or octal (starting + with 0) form.
      +
      +

      Network interfaces