Parav Pandit <[email protected]> writes:
> max_num field reflects the maximum queue size/depth. Hence align name of
> this field with similar field in PCI and MMIO transport to
> max_queue_size.
> Similarly rename 'num' to 'size'.
>
> Fixes: https://github.com/oasis-tcs/virtio-spec/issues/163
> Signed-off-by: Parav Pandit <[email protected]>
>
> ---
> v3->v4:
> - moved note to comment
> ---
> transport-ccw.tex | 14 ++++++++------
> 1 file changed, 8 insertions(+), 6 deletions(-)
>
> diff --git a/transport-ccw.tex b/transport-ccw.tex
> index c492cb9..b4bc83b 100644
> --- a/transport-ccw.tex
> +++ b/transport-ccw.tex
> @@ -237,12 +237,12 @@ \subsubsection{Configuring a
> Virtqueue}\label{sec:Virtio Transport Options / Vir
> \begin{lstlisting}
> struct vq_config_block {
> be16 index;
> - be16 max_num;
> + be16 max_queue_size; /* Previously named as max_num */
"named as" doesn't feel like typical language use - you can remove "as",
though I'd be inclined to use some kind of decoration for the name:
/* Previously named 'max_num'. */
> };
> \end{lstlisting}
>
> The requested number of buffers for queue \field{index} is returned in
> -\field{max_num}.
> +\field{max_queue_size}.
>
> Afterwards, CCW_CMD_SET_VQ is issued by the driver to inform the
> device about the location used for its queue. The transmitted
> @@ -253,7 +253,7 @@ \subsubsection{Configuring a Virtqueue}\label{sec:Virtio
> Transport Options / Vir
> be64 desc;
> be32 res0;
> be16 index;
> - be16 num;
> + be16 size; /* Previously named as num */
> be64 driver;
> be64 device;
> };
> @@ -262,7 +262,8 @@ \subsubsection{Configuring a Virtqueue}\label{sec:Virtio
> Transport Options / Vir
> \field{desc}, \field{driver} and \field{device} contain the guest
> addresses for the descriptor area,
> available area and used area for queue \field{index}, respectively. The
> actual
> -virtqueue size (number of allocated buffers) is transmitted in \field{num}.
> +virtqueue size (number of allocated buffers) is transmitted in
> +\field{size}.
>
> \devicenormative{\paragraph}{Configuring a Virtqueue}{Virtio Transport
> Options / Virtio over channel I/O / Device Initialization / Configuring a
> Virtqueue}
>
> @@ -278,11 +279,12 @@ \subsubsection{Configuring a
> Virtqueue}\label{sec:Virtio Transport Options / Vir
> be64 queue;
> be32 align;
> be16 index;
> - be16 num;
> + be16 size; /* Previously named as num */
> };
> \end{lstlisting}
>
> -\field{queue} contains the guest address for queue \field{index},
> \field{num} the number of buffers
> +\field{queue} contains the guest address for queue \field{index},
> +\field{size} the number of buffers
> and \field{align} the alignment. The queue layout follows \ref{sec:Basic
> Facilities of a Virtio Device / Virtqueues / Legacy Interfaces: A Note on
> Virtqueue Layout}~\nameref{sec:Basic Facilities of a Virtio Device /
> Virtqueues / Legacy Interfaces: A Note on Virtqueue Layout}.
>
> \subsubsection{Communicating Status Information}\label{sec:Virtio Transport
> Options / Virtio over channel I/O / Device Initialization / Communicating
> Status Information}
> --
> 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: [email protected]
> Unsubscribe: [email protected]
> List help: [email protected]
> 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/
--
Slow me down, it's getting away from me.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
