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>,
Jiri Pirko <jiri@nvidia.com>
Subject: [virtio-comment] [PATCH v9 4/8] transport-mmio: Refer to the vq by its number
Date: Tue, 28 Mar 2023 23:17:50 +0300 [thread overview]
Message-ID: <20230328201754.440974-5-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.
Fixes: https://github.com/oasis-tcs/virtio-spec/issues/163
Reviewed-by: Jiri Pirko <jiri@nvidia.com>
Signed-off-by: Parav Pandit <parav@nvidia.com>
---
changelog:
v8->v9:
- added 'by' at two places
- replaced 'queue number' with 'vq number'
v6->v7:
- remove text around first vq as it is already covered in the basic
virtqueues facility section
---
transport-mmio.tex | 23 +++++++++--------------
1 file changed, 9 insertions(+), 14 deletions(-)
diff --git a/transport-mmio.tex b/transport-mmio.tex
index 9b450b8..acc72f1 100644
--- a/transport-mmio.tex
+++ b/transport-mmio.tex
@@ -108,13 +108,12 @@ \subsection{MMIO Device Register Layout}\label{sec:Virtio Transport Options / Vi
bits accessible by writing to \field{DriverFeatures}.
}
\hline
- \mmioreg{QueueSel}{Virtual queue index}{0x030}{W}{%
+ \mmioreg{QueueSel}{Virtual queue number}{0x030}{W}{%
Writing to this register selects the virtual queue that the
following operations on \field{QueueSizeMax},
\field{QueueSize}, \field{QueueReady},
\field{QueueDescLow}, \field{QueueDescHigh}, \field{QueueDriverlLow}, \field{QueueDriverHigh},
- \field{QueueDeviceLow}, \field{QueueDeviceHigh} and \field{QueueReset} apply to. The index
- number of the first queue is zero (0x0).
+ \field{QueueDeviceLow}, \field{QueueDeviceHigh} and \field{QueueReset} apply to.
}
\hline
\mmioreg{QueueSizeMax}{Maximum virtual queue size}{0x034}{R}{%
@@ -150,7 +149,7 @@ \subsection{MMIO Device Register Layout}\label{sec:Virtio Transport Options / Vi
there are new buffers to process in a queue.
When VIRTIO_F_NOTIFICATION_DATA has not been negotiated,
- the value written is the queue index.
+ the value written is the vq number.
When VIRTIO_F_NOTIFICATION_DATA has been negotiated,
the \field{Notification data} value has the following format:
@@ -364,8 +363,7 @@ \subsubsection{Virtqueue Configuration}\label{sec:Virtio Transport Options / Vir
The driver will typically initialize the virtual queue in the following way:
\begin{enumerate}
-\item Select the queue writing its index (first queue is 0) to
- \field{QueueSel}.
+\item Select the queue by writing its number to \field{QueueSel}.
\item Check if the queue is not already in use: read \field{QueueReady},
and expect a returned value of zero (0x0).
@@ -393,8 +391,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 the queue to be notified to \field{QueueNotify}.
+the 16-bit vq number of the queue to be notified to
+\field{QueueNotify}.
When VIRTIO_F_NOTIFICATION_DATA has been negotiated,
the driver sends an available buffer notification to the device by writing
@@ -471,13 +469,11 @@ \subsection{Legacy interface}\label{sec:Virtio Transport Options / Virtio Over M
(see QueuePFN).
}
\hline
- \mmioreg{QueueSel}{Virtual queue index}{0x030}{W}{%
+ \mmioreg{QueueSel}{Virtual queue number}{0x030}{W}{%
Writing to this register selects the virtual queue that the
following operations on the \field{QueueSizeMax},
\field{QueueSize}, \field{QueueAlign}
- and \field{QueuePFN} registers apply to. The index
- number of the first queue is zero (0x0).
-.
+ and \field{QueuePFN} registers apply to.
}
\hline
\mmioreg{QueueSizeMax}{Maximum virtual queue size}{0x034}{R}{%
@@ -552,8 +548,7 @@ \subsection{Legacy interface}\label{sec:Virtio Transport Options / Virtio Over M
The virtual queue is configured as follows:
\begin{enumerate}
-\item Select the queue writing its index (first queue is 0) to
- \field{QueueSel}.
+\item Select the queue by writing its number to \field{QueueSel}.
\item Check if the queue is not already in use: read \field{QueuePFN},
expecting a returned value of zero (0x0).
--
2.26.2
This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.
In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.
Subscribe: virtio-comment-subscribe@lists.oasis-open.org
Unsubscribe: virtio-comment-unsubscribe@lists.oasis-open.org
List help: virtio-comment-help@lists.oasis-open.org
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/
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-comment] [PATCH v9 0/8] Rename queue index to queue number Parav Pandit
2023-03-28 20:17 ` [virtio-comment] [PATCH v9 1/8] content: Add vq number text Parav Pandit
2023-03-29 9:01 ` [virtio-comment] " Cornelia Huck
2023-03-28 20:17 ` [virtio-comment] [PATCH v9 2/8] transport-pci: Refer to the vq by its number Parav Pandit
2023-03-29 9:06 ` [virtio-comment] " Cornelia Huck
2023-03-28 20:17 ` [virtio-comment] [PATCH v9 3/8] transport-mmio: Rename QueueNum register Parav Pandit
2023-03-29 9:15 ` [virtio-comment] " Cornelia Huck
2023-03-29 12:59 ` [virtio-comment] " Parav Pandit
2023-03-29 13:16 ` Cornelia Huck
2023-03-28 20:17 ` Parav Pandit [this message]
2023-03-29 9:18 ` [virtio-comment] Re: [PATCH v9 4/8] transport-mmio: Refer to the vq by its number Cornelia Huck
2023-03-28 20:17 ` [virtio-comment] [PATCH v9 5/8] transport-ccw: Rename queue depth/size to other transports Parav Pandit
2023-03-29 9:23 ` [virtio-comment] " Cornelia Huck
2023-03-28 20:17 ` [virtio-comment] [PATCH v9 6/8] transport-ccw: Refer to the vq by its number Parav Pandit
2023-03-29 9:30 ` [virtio-comment] " Cornelia Huck
2023-03-29 13:01 ` [virtio-comment] " Parav Pandit
2023-03-29 13:18 ` Cornelia Huck
2023-03-28 20:17 ` [virtio-comment] [PATCH v9 7/8] virtio-net: Avoid duplicate receive queue example Parav Pandit
2023-03-28 20:17 ` [virtio-comment] [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-5-parav@nvidia.com \
--to=parav@nvidia.com \
--cc=cohuck@redhat.com \
--cc=jiri@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).