Hi,
On Fri, Aug 08, 2008 at 10:34:00AM -0400, Daniel Veillard wrote:
[..snip..]
> I think the only thing missing is extending the descrition in the documentation
> would you mind adding a description in formatdomain.html(.in)
> Probably an "USB devices" section added below the elementsDisks part,
> explaining the syntaxes and stating that it was added in versions after 0.4.4
>
> If you don't feel comfortable with that I can do it, but you know better :)
Attached is a short patch for this. This might be a bit terse but we'll
have to change this anyhow once pci passthrough for xen arrives.
Cheers,
-- Guido
>From 3a962e2f7a326e4dc8c27f37d7d206f6a6bf0530 Mon Sep 17 00:00:00 2001
From: Guido Guenther <agx@xxxxxxxxxxx>
Date: Fri, 8 Aug 2008 17:41:17 +0200
Subject: [PATCH] usb doc update
---
docs/formatdomain.html.in | 49 +++++++++++++++++++++++++++++++++++++++++---
1 files changed, 45 insertions(+), 4 deletions(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index d4f650e..1f02727 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 <code>bus</code> 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.
- <span class="since">Since 0.0.3; <code>bus</code> attribute since 0.4.3</span></dd>
+ "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.
+ <span class="since">Since 0.0.3; <code>bus</code> attribute since 0.4.3;
+ "usb" attribute value since after 0.4.4</span></dd>
<dt><code>driver</code></dt>
<dd>If the hypervisor supports multiple backend drivers, then the optional
<code>driver</code> element allows them to be selected. The <code>name</code>
@@ -374,6 +375,46 @@
</dd>
</dl>
+ <h4><a name="elementsUSB">USB devices</a></h4>
+
+ <p>
+ USB devices attached to the host can be passed through to the guest using
+ the <code>hostdev</code> element. <span class="since">since after 0.4.4</span>
+ </p>
+
+ <pre>
+ ...
+ <hostdev mode='subsystem' type='usb'>
+ <source>
+ <vendor id='0x1234'/>
+ <product id='0xbeef'/>
+ </source>
+ </disk>
+ ...</pre>
+
+ <dl>
+ <dt><code>hostdev</code></dt>
+ <dd>The <code>hostdev</code> element is the main container for describing
+ host devices. For usb device passthrough <code>mode</code> is always
+ "subsystem" and <code>type</code> is "usb".
+ <dt><code>source</code></dt>
+ <dd>The source element describes the device as seen from the host.
+ The USB device can either be addressed by vendor / product id using the
+ <code>vendor</code> and <code>product</code> elements or by the device's
+ address on the hosts using the <code>address</code> element.</dd>
+ <dt><code>vendor</code>, <code>product</code></dt>
+ <dd>The <code>vendor</code> and <code>product</code> elements each have an
+ <code>id</code> attribute that specifies the USB vendor and product id.
+ The ids can be given in decimal, hexadecimal (starting with 0x) or
+ ocatal (starting with 0) form.</dd>
+ <dt><code>address</code></dt>
+ <dd>The <code>address</code> element has a <code>bus</code> and
+ <code>device</code> 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 ocatal (starting
+ with 0) form.</dd>
+ </dl>
+
<h4><a name="elementsNICS">Network interfaces</a></h4>
<pre>
--
1.5.6.3
--
Libvir-list mailing list
Libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list