From: Parav Pandit <parav@nvidia.com>
To: <mst@redhat.com>, <virtio-dev@lists.oasis-open.org>,
<pasic@linux.ibm.com>, <cohuck@redhat.com>
Cc: <sgarzare@redhat.com>, <virtio-comment@lists.oasis-open.org>,
<shahafs@nvidia.com>, Parav Pandit <parav@nvidia.com>,
Max Gurtovoy <mgurtovoy@nvidia.com>, Jiri Pirko <jiri@nvidia.com>
Subject: [virtio-dev] [PATCH v9 2/8] transport-pci: Refer to the vq by its number
Date: Tue, 28 Mar 2023 23:17:48 +0300 [thread overview]
Message-ID: <20230328201754.440974-3-parav@nvidia.com> (raw)
In-Reply-To: <20230328201754.440974-1-parav@nvidia.com>
Currently specification uses virtqueue index and
number interchangeably to refer to the virtqueue.
Instead refer to it by its number.
This patch is on top of [1].
[1] https://lists.oasis-open.org/archives/virtio-dev/202302/msg00527.html
Fixes: https://github.com/oasis-tcs/virtio-spec/issues/163
Reviewed-by: Max Gurtovoy <mgurtovoy@nvidia.com>
Reviewed-by: Jiri Pirko <jiri@nvidia.com>
Signed-off-by: Parav Pandit <parav@nvidia.com>
---
changelog:
v8->v9:
- reword the sentence to avoid future tense, like rest of the other
fields description
- reword the sentence to avoid multiple verbs use and put -> uses
- use shorter name 'vq number' instead of 'virtqueue number'
v7->v8:
- remove note about first virtqueue number
- skipped Max's comment to put word 'structure' in same line as its
crosses 65 chars limit per line
- reworded queue_notification data set line, as '=' and vq number
wording was odd
v2->v3:
- addressed comments from Michael
- changed vqn to virtqueue number in the Note
- refer to vqn field instead of virtqueue number
---
transport-pci.tex | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/transport-pci.tex b/transport-pci.tex
index b07a822..0f3a48b 100644
--- a/transport-pci.tex
+++ b/transport-pci.tex
@@ -390,13 +390,14 @@ \subsubsection{Common configuration structure layout}\label{sec:Virtio Transport
\item[\field{queue_notify_data}]
This field exists only if VIRTIO_F_NOTIF_CONFIG_DATA has been negotiated.
- The driver will use this value to put it in the 'virtqueue number' field
+ The driver uses this value in the field \field{vqn}
in the available buffer notification structure.
See section \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI-specific Initialization And Device Operation / Available Buffer Notifications}.
\begin{note}
This field provides the device with flexibility to determine how virtqueues
will be referred to in available buffer notifications.
- In a trivial case the device can set \field{queue_notify_data}=vqn. Some devices
+ In a trivial case the device can set
+ \field{queue_notify_data} to the vq number. Some devices
may benefit from providing another value, for example an internal virtqueue
identifier, or an internal offset related to the virtqueue number.
\end{note}
@@ -1005,7 +1006,7 @@ \subsubsection{Device Initialization}\label{sec:Virtio Transport Options / Virti
The driver typically does this as follows, for each virtqueue a device has:
\begin{enumerate}
-\item Write the virtqueue index (first queue is 0) to \field{queue_select}.
+\item Write the vq number to \field{queue_select}.
\item Read the virtqueue size from \field{queue_size}. This controls how big the virtqueue is
(see \ref{sec:Basic Facilities of a Virtio Device / Virtqueues}~\nameref{sec:Basic Facilities of a Virtio Device / Virtqueues}). If this field is 0, the virtqueue does not exist.
@@ -1035,8 +1036,8 @@ \subsubsection{Available Buffer Notifications}\label{sec:Virtio Transport Option
When VIRTIO_F_NOTIFICATION_DATA has not been negotiated,
the driver sends an available buffer notification to the device by writing
-the 16-bit virtqueue index
-of this virtqueue to the Queue Notify address.
+the 16-bit vq number of this virtqueue to the Queue Notify
+address.
When VIRTIO_F_NOTIFICATION_DATA has been negotiated,
the driver sends an available buffer notification to the device by writing
@@ -1053,7 +1054,7 @@ \subsubsection{Available Buffer Notifications}\label{sec:Virtio Transport Option
If VIRTIO_F_NOTIF_CONFIG_DATA has been negotiated:
\begin{itemize}
\item If VIRTIO_F_NOTIFICATION_DATA has not been negotiated, the driver MUST use the
-\field{queue_notify_data} value instead of the virtqueue index.
+\field{queue_notify_data} value instead of the vq number.
\item If VIRTIO_F_NOTIFICATION_DATA has been negotiated, the driver MUST set the
\field{vqn} field to the \field{queue_notify_data} value.
\end{itemize}
--
2.26.2
---------------------------------------------------------------------
To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org
next prev parent reply other threads:[~2023-03-28 20:18 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-28 20:17 [virtio-dev] [PATCH v9 0/8] Rename queue index to queue number Parav Pandit
2023-03-28 20:17 ` [virtio-dev] [PATCH v9 1/8] content: Add vq number text Parav Pandit
2023-03-29 9:01 ` [virtio-dev] " Cornelia Huck
2023-03-28 20:17 ` Parav Pandit [this message]
2023-03-29 9:06 ` [virtio-dev] Re: [PATCH v9 2/8] transport-pci: Refer to the vq by its number Cornelia Huck
2023-03-28 20:17 ` [virtio-dev] [PATCH v9 3/8] transport-mmio: Rename QueueNum register Parav Pandit
2023-03-29 9:15 ` [virtio-dev] " Cornelia Huck
2023-03-29 12:59 ` [virtio-dev] " Parav Pandit
2023-03-29 13:16 ` Cornelia Huck
2023-03-28 20:17 ` [virtio-dev] [PATCH v9 4/8] transport-mmio: Refer to the vq by its number Parav Pandit
2023-03-29 9:18 ` [virtio-dev] " Cornelia Huck
2023-03-28 20:17 ` [virtio-dev] [PATCH v9 5/8] transport-ccw: Rename queue depth/size to other transports Parav Pandit
2023-03-29 9:23 ` [virtio-dev] " Cornelia Huck
2023-03-28 20:17 ` [virtio-dev] [PATCH v9 6/8] transport-ccw: Refer to the vq by its number Parav Pandit
2023-03-29 9:30 ` [virtio-dev] " Cornelia Huck
2023-03-29 13:01 ` [virtio-dev] " Parav Pandit
2023-03-29 13:18 ` Cornelia Huck
2023-03-28 20:17 ` [virtio-dev] [PATCH v9 7/8] virtio-net: Avoid duplicate receive queue example Parav Pandit
2023-03-28 20:17 ` [virtio-dev] [PATCH v9 8/8] virtio-net: Describe RSS using rss rq id Parav Pandit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230328201754.440974-3-parav@nvidia.com \
--to=parav@nvidia.com \
--cc=cohuck@redhat.com \
--cc=jiri@nvidia.com \
--cc=mgurtovoy@nvidia.com \
--cc=mst@redhat.com \
--cc=pasic@linux.ibm.com \
--cc=sgarzare@redhat.com \
--cc=shahafs@nvidia.com \
--cc=virtio-comment@lists.oasis-open.org \
--cc=virtio-dev@lists.oasis-open.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).