Re: [PATCH v14 02/11] content.tex Replace virtqueue number with index

[Halil Pasic <pasic@linux.ibm.com>]

On Wed, 19 Apr 2023 04:46:30 +0300
Parav Pandit <parav@nvidia.com> wrote:

> Replace virtqueue number with index to align to rest of the
> specification.
> 
> Fixes: https://github.com/oasis-tcs/virtio-spec/issues/163
> Signed-off-by: Parav Pandit <parav@nvidia.com>
> 
> ---
> changelog:
> v11->v12:
> - new patch
> ---
>  content.tex | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/content.tex b/content.tex
> index 43be58b..e79d722 100644
> --- a/content.tex
> +++ b/content.tex
> @@ -405,7 +405,7 @@ \section{Driver Notifications} \label{sec:Basic Facilities of a Virtio Device /
>  
>  When VIRTIO_F_NOTIFICATION_DATA has not been negotiated,
>  this notification involves sending the
> -virtqueue number to the device (method depending on the transport).
> +virtqueue index to the device (method depending on the transport).

This is not entirely accurate. If VIRTIO_F_NOTIF_CONFIG_DATA was
negotiated it is not the virtqueue index that is sent but the
vq_notif_config_data.

>  
>  However, some devices benefit from the ability to find out the
>  amount of available data in the queue without accessing the virtqueue in memory:
> @@ -789,13 +789,13 @@ \chapter{Reserved Feature Bits}\label{sec:Reserved Feature Bits}
>    buffer notifications.
>    As mentioned in section \ref{sec:Basic Facilities of a Virtio Device / Driver notifications}, when the
>    driver is required to send an available buffer notification to the device, it
> -  sends the virtqueue number to be notified. The method of delivering
> +  sends the virtqueue index to be notified. The method of delivering
>    notifications is transport specific.
>    With the PCI transport, the device can optionally provide a per-virtqueue value
> -  for the driver to use in driver notifications, instead of the virtqueue number.
> +  for the driver to use in driver notifications, instead of the virtqueue index.
>    Some devices may benefit from this flexibility by providing, for example,
>    an internal virtqueue identifier, or an internal offset related to the
> -  virtqueue number.
> +  virtqueue index.
>  

And the above paragraph is supposed to make that point. 

I guess this is in some sense an improvement over the current state.
Thus:
Acked-by: Halil Pasic <pasic@linux.ibm.com>

But to get this really clean, we need to do some rewording here. Which
can be done on top of this series.


>    This feature indicates the availability of such value. The definition of the
>    data to be provided in driver notification and the delivery method is