External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-03 11:35:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Document the new hostdev type 'mdev'

Browse Source 
Signed-off-by: Erik Skultety <eskultet@redhat.com>
This commit is contained in:
Erik Skultety 2017-02-03 11:02:07 +01:00
parent 1696806ff1
commit 229dcc73e8
1 changed files with 40 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/formatdomain.html.in
View File

@ -3884,6 +3884,19 @@
&lt;source protocol='vhost' wwpn='naa.50014057667280d8'/&gt; &lt;source protocol='vhost' wwpn='naa.50014057667280d8'/&gt;
&lt;/hostdev&gt; &lt;/hostdev&gt;
&lt;/devices&gt; &lt;/devices&gt;
...</pre>
<p>or:</p>
<pre>
...
&lt;devices&gt;
&lt;hostdev mode='subsystem' type='mdev' model='vfio-pci'&gt;
&lt;source&gt;
&lt;address uuid='c2177883-f1bb-47f0-914d-32a22e3a8804'&gt;
&lt;/source&gt;
&lt;/hostdev&gt;
&lt;/devices&gt;
...</pre> ...</pre>
<dl> <dl>
@ -3930,12 +3943,22 @@
<code>type</code> passes all LUNs presented by a single HBA to <code>type</code> passes all LUNs presented by a single HBA to
the guest. the guest.
</dd> </dd>
<dt><code>mdev</code></dt>
<dd>For mediated devices (<span class="since">Since 3.2.0</span>)
the <code>model</code> attribute specifies the device API which
determines how the host's vfio driver will expose the device to the
guest. Currently, only <code>model='vfio-pci'</code> is supported.
There are also some implications on the usage of guest's address type
depending on the <code>model</code> attribute, see the
<code>address</code> element below.</dd>
</dl> </dl>
<p> <p>
Note: The <code>managed</code> attribute is only used with PCI devices Note: The <code>managed</code> attribute is only used with
and is ignored by all the other device types, thus setting <code>type='pci'</code> and is ignored by all the other device types,
<code>managed</code> explicitly with other than PCI device has the same thus setting <code>managed</code> explicitly with other than a PCI
effect as omitting it. device has the same effect as omitting it. Similarly,
<code>model</code> attribute is only supported by mediated devices and
ignored by all other device types.
</p> </p>
</dd> </dd>
<dt><code>source</code></dt> <dt><code>source</code></dt>
@ -4000,6 +4023,12 @@
is the vhost_scsi wwpn (16 hexadecimal digits with a prefix of is the vhost_scsi wwpn (16 hexadecimal digits with a prefix of
"naa.") established in the host configfs. "naa.") established in the host configfs.
</dd> </dd>
<dt><code>mdev</code></dt>
<dd>Mediated devices (<span class="since">Since 3.2.0</span>) are
described by the <code>address</code> element. The
<code>address</code> element contains a single mandatory attribute
<code>uuid</code>.
</dd>
</dl> </dl>
</dd> </dd>
<dt><code>vendor</code>, <code>product</code></dt> <dt><code>vendor</code>, <code>product</code></dt>
@ -4043,8 +4072,13 @@
For PCI devices the element carries 4 attributes allowing to designate For PCI devices the element carries 4 attributes allowing to designate
the device as can be found with the <code>lspci</code> or the device as can be found with the <code>lspci</code> or
with <code>virsh nodedev-list</code>. For SCSI devices a 'drive' with <code>virsh nodedev-list</code>. For SCSI devices a 'drive'
address type must be used. <a href="#elementsAddress">See above</a> for address type must be used. For mediated devices, which are software-only
more details on the address element.</dd> devices defining an allocation of resources on the physical parent device,
the address type used must conform to the <code>model</code> attribute
of element <code>hostdev</code>, e.g. any address type other than PCI for
<code>vfio-pci</code> device API will result in an error.
<a href="#elementsAddress">See above</a> for more details on the address
element.</dd>
<dt><code>driver</code></dt> <dt><code>driver</code></dt>
<dd> <dd>
PCI devices can have an optional <code>driver</code> PCI devices can have an optional <code>driver</code>