Patchwork [v4,4/4] docs: Document virtio PCI -device ioeventfd=on|off

login
register
mail settings
Submitter Stefan Hajnoczi
Date Nov. 17, 2010, 4:19 p.m.
Message ID <1290010769-11217-5-git-send-email-stefanha@linux.vnet.ibm.com>
Download mbox | patch
Permalink /patch/71584/
State New
Headers show

Comments

Stefan Hajnoczi - Nov. 17, 2010, 4:19 p.m.
Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
---
 docs/qdev-device-use.txt |    9 +++++++--
 1 files changed, 7 insertions(+), 2 deletions(-)
Michael S. Tsirkin - Dec. 12, 2010, 11:24 a.m.
On Wed, Nov 17, 2010 at 04:19:29PM +0000, Stefan Hajnoczi wrote:
> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
> ---
>  docs/qdev-device-use.txt |    9 +++++++--
>  1 files changed, 7 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/qdev-device-use.txt b/docs/qdev-device-use.txt
> index f252c8e..85feda7 100644
> --- a/docs/qdev-device-use.txt
> +++ b/docs/qdev-device-use.txt
> @@ -97,15 +97,17 @@ The -device argument differs in detail for each kind of drive:
>  
>  * if=virtio
>  
> -  -device virtio-blk-pci,drive=DRIVE-ID,class=C,vectors=V
> +  -device virtio-blk-pci,drive=DRIVE-ID,class=C,vectors=V,ioeventfd=IOEVENTFD
>  
>    This lets you control PCI device class and MSI-X vectors.
>  
> +  IOEVENTFD controls whether or not ioeventfd is used for virtqueue notify.  It
> +  can be set to on (default) or off.
> +
>    As for all PCI devices, you can add bus=PCI-BUS,addr=DEVFN to
>    control the PCI device address.
>  
>  * if=pflash, if=mtd, if=sd, if=xen are not yet available with -device
> -

Intentional?

>  For USB devices, the old way is actually different:
>  
>      -usbdevice disk:format=FMT:FILENAME
> @@ -240,6 +242,9 @@ For PCI devices, you can add bus=PCI-BUS,addr=DEVFN to control the PCI
>  device address, as usual.  The old -net nic provides parameter addr
>  for that, it is silently ignored when the NIC is not a PCI device.
>  
> +For virtio-net-pci, you can control whether or not ioeventfd is used for
> +virtqueue notify by setting ioeventfd= to on (default) or off.
> +
>  -net nic accepts vectors=V for all models, but it's silently ignored
>  except for virtio-net-pci (model=virtio).  With -device, only devices
>  that support it accept it.
> -- 
> 1.7.2.3
Stefan Hajnoczi - Dec. 12, 2010, 3:07 p.m.
On Sun, Dec 12, 2010 at 11:24 AM, Michael S. Tsirkin <mst@redhat.com> wrote:
> On Wed, Nov 17, 2010 at 04:19:29PM +0000, Stefan Hajnoczi wrote:
>> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
>> ---
>>  docs/qdev-device-use.txt |    9 +++++++--
>>  1 files changed, 7 insertions(+), 2 deletions(-)
>>
>> diff --git a/docs/qdev-device-use.txt b/docs/qdev-device-use.txt
>> index f252c8e..85feda7 100644
>> --- a/docs/qdev-device-use.txt
>> +++ b/docs/qdev-device-use.txt
>> @@ -97,15 +97,17 @@ The -device argument differs in detail for each kind of drive:
>>
>>  * if=virtio
>>
>> -  -device virtio-blk-pci,drive=DRIVE-ID,class=C,vectors=V
>> +  -device virtio-blk-pci,drive=DRIVE-ID,class=C,vectors=V,ioeventfd=IOEVENTFD
>>
>>    This lets you control PCI device class and MSI-X vectors.
>>
>> +  IOEVENTFD controls whether or not ioeventfd is used for virtqueue notify.  It
>> +  can be set to on (default) or off.
>> +
>>    As for all PCI devices, you can add bus=PCI-BUS,addr=DEVFN to
>>    control the PCI device address.
>>
>>  * if=pflash, if=mtd, if=sd, if=xen are not yet available with -device
>> -
>
> Intentional?

Fixed in v5.

Stefan

Patch

diff --git a/docs/qdev-device-use.txt b/docs/qdev-device-use.txt
index f252c8e..85feda7 100644
--- a/docs/qdev-device-use.txt
+++ b/docs/qdev-device-use.txt
@@ -97,15 +97,17 @@  The -device argument differs in detail for each kind of drive:
 
 * if=virtio
 
-  -device virtio-blk-pci,drive=DRIVE-ID,class=C,vectors=V
+  -device virtio-blk-pci,drive=DRIVE-ID,class=C,vectors=V,ioeventfd=IOEVENTFD
 
   This lets you control PCI device class and MSI-X vectors.
 
+  IOEVENTFD controls whether or not ioeventfd is used for virtqueue notify.  It
+  can be set to on (default) or off.
+
   As for all PCI devices, you can add bus=PCI-BUS,addr=DEVFN to
   control the PCI device address.
 
 * if=pflash, if=mtd, if=sd, if=xen are not yet available with -device
-
 For USB devices, the old way is actually different:
 
     -usbdevice disk:format=FMT:FILENAME
@@ -240,6 +242,9 @@  For PCI devices, you can add bus=PCI-BUS,addr=DEVFN to control the PCI
 device address, as usual.  The old -net nic provides parameter addr
 for that, it is silently ignored when the NIC is not a PCI device.
 
+For virtio-net-pci, you can control whether or not ioeventfd is used for
+virtqueue notify by setting ioeventfd= to on (default) or off.
+
 -net nic accepts vectors=V for all models, but it's silently ignored
 except for virtio-net-pci (model=virtio).  With -device, only devices
 that support it accept it.