From: Parav Pandit <parav@nvidia.com>
To: mst@redhat.com, virtio-dev@lists.oasis-open.org, cohuck@redhat.com
Cc: virtio-comment@lists.oasis-open.org, shahafs@nvidia.com,
Parav Pandit <parav@nvidia.com>
Subject: [PATCH 2/3] transport-mmio: Rename QueueNum register
Date: Thu, 23 Feb 2023 07:46:23 +0200 [thread overview]
Message-ID: <20230223054624.168042-3-parav@nvidia.com> (raw)
In-Reply-To: <20230223054624.168042-1-parav@nvidia.com>
Currently, the specification uses virtqueue index and number
interchangeably to refer to the virtqueue.
It is better to identify it using one terminology.
Two registers QueueNumMax and QueueNum actually reflect the queue size
or queue depth indicating max and actual number of entries in the queue.
Equivalent register in PCI transport is named differently as queue_size.
To bring consistency between pci and mmio transport, and to avoid
confusion between number and index, rename the QueueNumMax and QueueNum
registers to QueueSizeMax and QueueSize respectively.
[1] https://lists.oasis-open.org/archives/virtio-dev/202302/msg00527.html
Fixes: https://github.com/oasis-tcs/virtio-spec/issues/163
Signed-off-by: Parav Pandit <parav@nvidia.com>
---
transport-mmio.tex | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/transport-mmio.tex b/transport-mmio.tex
index 65bae54..c59975e 100644
--- a/transport-mmio.tex
+++ b/transport-mmio.tex
@@ -104,14 +104,14 @@ \subsection{MMIO Device Register Layout}\label{sec:Virtio Transport Options / Vi
number of the first queue is zero (0x0).
}
\hline
- \mmioreg{QueueNumMax}{Maximum virtual queue size}{0x034}{R}{%
+ \mmioreg{QueueSizeMax}{Maximum virtual queue size}{0x034}{R}{%
Reading from the register returns the maximum size (number of
elements) of the queue the device is ready to process or
zero (0x0) if the queue is not available. This applies to the
queue selected by writing to \field{QueueSel}.
}
\hline
- \mmioreg{QueueNum}{Virtual queue size}{0x038}{W}{%
+ \mmioreg{QueueSize}{Virtual queue size}{0x038}{W}{%
Queue size is the number of elements in the queue.
Writing to this register notifies the device what size of the
queue the driver will use. This applies to the queue selected by
@@ -459,7 +459,7 @@ \subsection{Legacy interface}\label{sec:Virtio Transport Options / Virtio Over M
.
}
\hline
- \mmioreg{QueueNumMax}{Maximum virtual queue size}{0x034}{R}{%
+ \mmioreg{QueueSizeMax}{Maximum virtual queue size}{0x034}{R}{%
Reading from the register returns the maximum size of the queue
the device is ready to process or zero (0x0) if the queue is not
available. This applies to the queue selected by writing to
@@ -467,7 +467,7 @@ \subsection{Legacy interface}\label{sec:Virtio Transport Options / Virtio Over M
(0x0), so when the queue is not actively used.
}
\hline
- \mmioreg{QueueNum}{Virtual queue size}{0x038}{W}{%
+ \mmioreg{QueueSize}{Virtual queue size}{0x038}{W}{%
Queue size is the number of elements in the queue.
Writing to this register notifies the device what size of the
queue the driver will use. This applies to the queue selected by
--
2.26.2
next prev parent reply other threads:[~2023-02-23 5:46 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-23 5:46 [PATCH 0/3] Rename queue index to queue number Parav Pandit
2023-02-23 5:46 ` [PATCH 1/3] transport-pci: Refer to the vq by its number Parav Pandit
2023-02-24 10:05 ` [virtio-dev] " Jiri Pirko
2023-02-23 5:46 ` Parav Pandit [this message]
2023-02-24 10:06 ` [virtio-dev] [PATCH 2/3] transport-mmio: Rename QueueNum register Jiri Pirko
2023-02-27 17:36 ` Michael S. Tsirkin
2023-02-27 17:36 ` [virtio-dev] " Michael S. Tsirkin
2023-02-23 5:46 ` [PATCH 3/3] transport-mmio: Refer to the vq by its number Parav Pandit
2023-02-24 10:06 ` [virtio-dev] " Jiri Pirko
2023-02-27 8:45 ` [virtio-comment] Re: [PATCH 0/3] Rename queue index to queue number Cornelia Huck
2023-02-27 8:45 ` [virtio-dev] " Cornelia Huck
2023-02-27 16:00 ` Parav Pandit
2023-02-27 16:00 ` [virtio-dev] " Parav Pandit
2023-02-27 17:33 ` [virtio-dev] " Michael S. Tsirkin
2023-03-01 17:22 ` [virtio-dev] Re: [virtio-comment] " Halil Pasic
2023-03-01 17:37 ` Michael S. Tsirkin
2023-03-02 13:42 ` [virtio-dev] " Parav Pandit
2023-03-02 15:06 ` [virtio-dev] " Cornelia Huck
2023-03-02 15:58 ` Halil Pasic
2023-03-03 7:42 ` Michael S. Tsirkin
2023-03-03 21:49 ` Halil Pasic
2023-03-05 9:51 ` Michael S. Tsirkin
2023-03-09 16:46 ` Halil Pasic
2023-03-09 16:53 ` Michael S. Tsirkin
2023-03-10 14:05 ` Halil Pasic
2023-02-27 17:39 ` Michael S. Tsirkin
2023-02-27 17:39 ` [virtio-dev] " Michael S. Tsirkin
2023-03-02 15:52 ` [virtio-dev] Re: [virtio-comment] " Halil Pasic
2023-03-02 16:12 ` [virtio-dev] " Parav Pandit
2023-03-02 23:38 ` [virtio-dev] " Michael S. Tsirkin
2023-03-07 15:20 ` [virtio-dev] " Parav Pandit
2023-03-03 15:38 ` [virtio-dev] " Halil Pasic
2023-03-05 9:29 ` Michael S. Tsirkin
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=20230223054624.168042-3-parav@nvidia.com \
--to=parav@nvidia.com \
--cc=cohuck@redhat.com \
--cc=mst@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