* [virtio-dev] [PATCH v1] device-types/multiple: replace queues with enqueues
@ 2023-04-20 19:55 Parav Pandit
2023-04-20 20:45 ` [virtio-dev] " Michael S. Tsirkin
2023-04-21 13:56 ` Cornelia Huck
0 siblings, 2 replies; 3+ messages in thread
From: Parav Pandit @ 2023-04-20 19:55 UTC (permalink / raw)
To: mst, virtio-dev, cohuck; +Cc: virtio-comment, shahafs, Parav Pandit
Queue is a verb and noun both. Replacing it with enqueue avoids
ambiguity around plural queues noun vs verb; similar to virtio fs device
description.
Acked-by: Michael S. Tsirkin <mst@redhat.com>
Signed-off-by: Parav Pandit <parav@nvidia.com>
---
changelog:
v0->v1:
- replace 'on' to 'to'
---
device-types/blk/description.tex | 2 +-
device-types/gpio/description.tex | 4 ++--
device-types/i2c/description.tex | 2 +-
device-types/scsi/description.tex | 2 +-
device-types/vsock/description.tex | 2 +-
5 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/device-types/blk/description.tex b/device-types/blk/description.tex
index 517b012..f04c932 100644
--- a/device-types/blk/description.tex
+++ b/device-types/blk/description.tex
@@ -427,7 +427,7 @@ \subsubsection{Legacy Interface: Device Initialization}\label{sec:Device Types /
\subsection{Device Operation}\label{sec:Device Types / Block Device / Device Operation}
-The driver queues requests to the virtqueues, and they are used by
+The driver enqueues requests to the virtqueues, and they are used by
the device (not necessarily in order). Each request except
VIRTIO_BLK_T_ZONE_APPEND is of form:
diff --git a/device-types/gpio/description.tex b/device-types/gpio/description.tex
index 8e5c7f0..d51fbe1 100644
--- a/device-types/gpio/description.tex
+++ b/device-types/gpio/description.tex
@@ -358,7 +358,7 @@ \subsubsection{requestq Operation: Set IRQ Type}\label{sec:Device Types / GPIO D
\subsubsection{requestq Operation: Message Flow}\label{sec:Device Types / GPIO Device / requestq Operation / Message Flow}
\begin{itemize}
-\item The driver queues \field{struct virtio_gpio_request} and
+\item The driver enqueues \field{struct virtio_gpio_request} and
\field{virtio_gpio_response} buffers to the \field{requestq} virtqueue,
after filling all fields of the \field{struct virtio_gpio_request} buffer as
defined by the specific message type.
@@ -458,7 +458,7 @@ \subsection{Device Operation: eventq}\label{sec:Device Types / GPIO Device / eve
The \field{eventq} virtqueue is used by the driver to unmask the interrupts and
used by the device to notify the driver of newly sensed interrupts. In order to
-unmask interrupt on a GPIO line, the driver queues a pair of buffers,
+unmask interrupt on a GPIO line, the driver enqueues a pair of buffers,
\field{struct virtio_gpio_irq_request} (filled by driver) and \field{struct
virtio_gpio_irq_response} (to be filled by device later), to the \field{eventq}
virtqueue. A separate pair of buffers must be queued for each GPIO line, the
diff --git a/device-types/i2c/description.tex b/device-types/i2c/description.tex
index 5d407cb..861529a 100644
--- a/device-types/i2c/description.tex
+++ b/device-types/i2c/description.tex
@@ -47,7 +47,7 @@ \subsection{Device Operation}\label{sec:Device Types / I2C Adapter Device / Devi
\subsubsection{Device Operation: Request Queue}\label{sec:Device Types / I2C Adapter Device / Device Operation: Request Queue}
-The driver queues requests to the virtqueue, and they are used by the
+The driver enqueues requests to the virtqueue, and they are used by the
device. The request is the representation of segments of an I2C
transaction. Each request is of the form:
diff --git a/device-types/scsi/description.tex b/device-types/scsi/description.tex
index 904c4a7..478b558 100644
--- a/device-types/scsi/description.tex
+++ b/device-types/scsi/description.tex
@@ -158,7 +158,7 @@ \subsection{Device Operation}\label{sec:Device Types / SCSI Host Device / Device
\subsubsection{Device Operation: Request Queues}\label{sec:Device Types / SCSI Host Device / Device Operation / Device Operation: Request Queues}
-The driver queues requests to an arbitrary request queue, and
+The driver enqueues requests to an arbitrary request queue, and
they are used by the device on that same queue. It is the
responsibility of the driver to ensure strict request ordering
for commands placed on different queues, because they will be
diff --git a/device-types/vsock/description.tex b/device-types/vsock/description.tex
index 105bb30..7d91d15 100644
--- a/device-types/vsock/description.tex
+++ b/device-types/vsock/description.tex
@@ -218,7 +218,7 @@ \subsubsection{Buffer Space Management}\label{sec:Device Types / Socket Device /
\field{buf_alloc} and \field{fwd_cnt} fields.
\subsubsection{Receive and Transmit}\label{sec:Device Types / Socket Device / Device Operation / Receive and Transmit}
-The driver queues outgoing packets on the tx virtqueue and incoming packet
+The driver enqueues outgoing packets to the tx virtqueue and incoming packet
receive buffers on the rx virtqueue. Packets are of the following form:
\begin{lstlisting}
--
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
^ permalink raw reply related [flat|nested] 3+ messages in thread* [virtio-dev] Re: [PATCH v1] device-types/multiple: replace queues with enqueues
2023-04-20 19:55 [virtio-dev] [PATCH v1] device-types/multiple: replace queues with enqueues Parav Pandit
@ 2023-04-20 20:45 ` Michael S. Tsirkin
2023-04-21 13:56 ` Cornelia Huck
1 sibling, 0 replies; 3+ messages in thread
From: Michael S. Tsirkin @ 2023-04-20 20:45 UTC (permalink / raw)
To: Parav Pandit; +Cc: virtio-dev, cohuck, virtio-comment, shahafs
On Thu, Apr 20, 2023 at 10:55:54PM +0300, Parav Pandit wrote:
> Queue is a verb and noun both. Replacing it with enqueue avoids
> ambiguity around plural queues noun vs verb; similar to virtio fs device
> description.
>
> Acked-by: Michael S. Tsirkin <mst@redhat.com>
> Signed-off-by: Parav Pandit <parav@nvidia.com>
ACK stands. Cornelia, editorial change?
> ---
> changelog:
> v0->v1:
> - replace 'on' to 'to'
> ---
> device-types/blk/description.tex | 2 +-
> device-types/gpio/description.tex | 4 ++--
> device-types/i2c/description.tex | 2 +-
> device-types/scsi/description.tex | 2 +-
> device-types/vsock/description.tex | 2 +-
> 5 files changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/device-types/blk/description.tex b/device-types/blk/description.tex
> index 517b012..f04c932 100644
> --- a/device-types/blk/description.tex
> +++ b/device-types/blk/description.tex
> @@ -427,7 +427,7 @@ \subsubsection{Legacy Interface: Device Initialization}\label{sec:Device Types /
>
> \subsection{Device Operation}\label{sec:Device Types / Block Device / Device Operation}
>
> -The driver queues requests to the virtqueues, and they are used by
> +The driver enqueues requests to the virtqueues, and they are used by
> the device (not necessarily in order). Each request except
> VIRTIO_BLK_T_ZONE_APPEND is of form:
>
> diff --git a/device-types/gpio/description.tex b/device-types/gpio/description.tex
> index 8e5c7f0..d51fbe1 100644
> --- a/device-types/gpio/description.tex
> +++ b/device-types/gpio/description.tex
> @@ -358,7 +358,7 @@ \subsubsection{requestq Operation: Set IRQ Type}\label{sec:Device Types / GPIO D
> \subsubsection{requestq Operation: Message Flow}\label{sec:Device Types / GPIO Device / requestq Operation / Message Flow}
>
> \begin{itemize}
> -\item The driver queues \field{struct virtio_gpio_request} and
> +\item The driver enqueues \field{struct virtio_gpio_request} and
> \field{virtio_gpio_response} buffers to the \field{requestq} virtqueue,
> after filling all fields of the \field{struct virtio_gpio_request} buffer as
> defined by the specific message type.
> @@ -458,7 +458,7 @@ \subsection{Device Operation: eventq}\label{sec:Device Types / GPIO Device / eve
>
> The \field{eventq} virtqueue is used by the driver to unmask the interrupts and
> used by the device to notify the driver of newly sensed interrupts. In order to
> -unmask interrupt on a GPIO line, the driver queues a pair of buffers,
> +unmask interrupt on a GPIO line, the driver enqueues a pair of buffers,
> \field{struct virtio_gpio_irq_request} (filled by driver) and \field{struct
> virtio_gpio_irq_response} (to be filled by device later), to the \field{eventq}
> virtqueue. A separate pair of buffers must be queued for each GPIO line, the
> diff --git a/device-types/i2c/description.tex b/device-types/i2c/description.tex
> index 5d407cb..861529a 100644
> --- a/device-types/i2c/description.tex
> +++ b/device-types/i2c/description.tex
> @@ -47,7 +47,7 @@ \subsection{Device Operation}\label{sec:Device Types / I2C Adapter Device / Devi
>
> \subsubsection{Device Operation: Request Queue}\label{sec:Device Types / I2C Adapter Device / Device Operation: Request Queue}
>
> -The driver queues requests to the virtqueue, and they are used by the
> +The driver enqueues requests to the virtqueue, and they are used by the
> device. The request is the representation of segments of an I2C
> transaction. Each request is of the form:
>
> diff --git a/device-types/scsi/description.tex b/device-types/scsi/description.tex
> index 904c4a7..478b558 100644
> --- a/device-types/scsi/description.tex
> +++ b/device-types/scsi/description.tex
> @@ -158,7 +158,7 @@ \subsection{Device Operation}\label{sec:Device Types / SCSI Host Device / Device
>
> \subsubsection{Device Operation: Request Queues}\label{sec:Device Types / SCSI Host Device / Device Operation / Device Operation: Request Queues}
>
> -The driver queues requests to an arbitrary request queue, and
> +The driver enqueues requests to an arbitrary request queue, and
> they are used by the device on that same queue. It is the
> responsibility of the driver to ensure strict request ordering
> for commands placed on different queues, because they will be
> diff --git a/device-types/vsock/description.tex b/device-types/vsock/description.tex
> index 105bb30..7d91d15 100644
> --- a/device-types/vsock/description.tex
> +++ b/device-types/vsock/description.tex
> @@ -218,7 +218,7 @@ \subsubsection{Buffer Space Management}\label{sec:Device Types / Socket Device /
> \field{buf_alloc} and \field{fwd_cnt} fields.
>
> \subsubsection{Receive and Transmit}\label{sec:Device Types / Socket Device / Device Operation / Receive and Transmit}
> -The driver queues outgoing packets on the tx virtqueue and incoming packet
> +The driver enqueues outgoing packets to the tx virtqueue and incoming packet
> receive buffers on the rx virtqueue. Packets are of the following form:
>
> \begin{lstlisting}
> --
> 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
^ permalink raw reply [flat|nested] 3+ messages in thread* [virtio-dev] Re: [PATCH v1] device-types/multiple: replace queues with enqueues
2023-04-20 19:55 [virtio-dev] [PATCH v1] device-types/multiple: replace queues with enqueues Parav Pandit
2023-04-20 20:45 ` [virtio-dev] " Michael S. Tsirkin
@ 2023-04-21 13:56 ` Cornelia Huck
1 sibling, 0 replies; 3+ messages in thread
From: Cornelia Huck @ 2023-04-21 13:56 UTC (permalink / raw)
To: Parav Pandit, mst, virtio-dev; +Cc: virtio-comment, shahafs, Parav Pandit
On Thu, Apr 20 2023, Parav Pandit <parav@nvidia.com> wrote:
> Queue is a verb and noun both. Replacing it with enqueue avoids
> ambiguity around plural queues noun vs verb; similar to virtio fs device
> description.
>
> Acked-by: Michael S. Tsirkin <mst@redhat.com>
> Signed-off-by: Parav Pandit <parav@nvidia.com>
> ---
> changelog:
> v0->v1:
> - replace 'on' to 'to'
> ---
> device-types/blk/description.tex | 2 +-
> device-types/gpio/description.tex | 4 ++--
> device-types/i2c/description.tex | 2 +-
> device-types/scsi/description.tex | 2 +-
> device-types/vsock/description.tex | 2 +-
> 5 files changed, 6 insertions(+), 6 deletions(-)
Thanks, pushed as editorial update.
---------------------------------------------------------------------
To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2023-04-21 13:56 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-04-20 19:55 [virtio-dev] [PATCH v1] device-types/multiple: replace queues with enqueues Parav Pandit
2023-04-20 20:45 ` [virtio-dev] " Michael S. Tsirkin
2023-04-21 13:56 ` Cornelia Huck
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox