Skip to contentSkip to conversation

packed-ring.tex: link conformance statements

PATCH In review Michael S. Tsirkin 3 participants 7 messages Apr 19, 2022 – Apr 21, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 packed-ring.tex: link conformance statements

Link conformance statements into conformance chapter.

---
 conformance.tex |  9 +++++++++
 packed-ring.tex | 16 +++++-----------
 2 files changed, 14 insertions(+), 11 deletions(-)
conformance.tex +9 -0
index 9807c30..663e7c3 100644
@@ -85,6 +85,12 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
 \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Updating idx}
 \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Notifying The Device}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / PAcked Virtqueues / The Virtqueue Descriptor Table}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table / Indirect Descriptors}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Updating flags}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Sending Available Buffer Notifications}
 \item \ref{drivernormative:General Initialization And Device Operation / Device Initialization}
 \item \ref{drivernormative:General Initialization And Device Operation / Device Cleanup}
 \item \ref{drivernormative:Reserved Feature Bits}
@@ -340,6 +346,9 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / The Virtqueue Used Ring}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
+\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
+\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table}
+\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Shared Memory Regions}
 \item \ref{devicenormative:Reserved Feature Bits}
 \end{itemize}
packed-ring.tex +5 -11
index 2accc23..47f58a8 100644
@@ -407,14 +407,12 @@ \subsubsection{Structure Size and Alignment}
 can be queued at any given time.}.  The Queue Size value does not
 have to be a power of 2.
 
-\drivernormative{\subsection}{Virtqueues}{Basic Facilities of a
-Virtio Device / Packed Virtqueues}
+\drivernormative{\subsection}{Virtqueues}{Basic Facilities of a Virtio Device / Packed Virtqueues}
 The driver MUST ensure that the physical address of the first byte
 of each virtqueue part is a multiple of the specified alignment value
 in the above table.
 
-\devicenormative{\subsection}{Virtqueues}{Basic Facilities of a
-Virtio Device / Packed Virtqueues}
+\devicenormative{\subsection}{Virtqueues}{Basic Facilities of a Virtio Device / Packed Virtqueues}
 The device MUST start processing driver descriptors in the order
 in which they appear in the ring.
 The device MUST start writing device descriptors into the ring in
@@ -485,8 +483,7 @@ \subsection{Event Suppression Structure Format}\label{sec:Basic
 A driver MAY send multiple available buffer notifications without making
 any new descriptors available to the device.
 
-\drivernormative{\subsection}{Scatter-Gather Support}{Basic Facilities of a
-Virtio Device / Packed Virtqueues / Scatter-Gather Support}
+\drivernormative{\subsection}{Scatter-Gather Support}{Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
 A driver MUST NOT create a descriptor list longer than allowed
 by the device.
 
@@ -508,8 +505,7 @@ \subsection{Event Suppression Structure Format}\label{sec:Basic
 before all subsequent descriptors comprising the list are made
 available.
 
-\devicenormative{\subsection}{Scatter-Gather Support}{Basic Facilities of a
-Virtio Device / Packed Virtqueues / Scatter-Gather Support}
+\devicenormative{\subsection}{Scatter-Gather Support}{Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
 The device MUST use descriptors in a list chained by the
 VIRTQ_DESC_F_NEXT flag in the same order that they
 were made available by the driver.
@@ -591,9 +587,7 @@ \subsubsection{Placing Available Buffers Into The Descriptor Ring}\label{sec:Bas
 access the descriptor and any following descriptors the driver created and the
 memory they refer to immediately.
 
-\drivernormative{\paragraph}{Updating flags}{Basic Facilities of
-a Virtio Device / Packed Virtqueues / Supplying Buffers to The
-Device / Updating flags}
+\drivernormative{\paragraph}{Updating flags}{Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Updating flags}
 The driver MUST perform a suitable memory barrier before the
 \field{flags} update, to ensure the
 device sees the most up-to-date copy.
Signature · 18 lines
MST


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/
#1 lore raw
Quoted 13 lines · Michael S. Tsirkin

Link conformance statements into conformance chapter.

---
 conformance.tex |  9 +++++++++
 packed-ring.tex | 16 +++++-----------
 2 files changed, 14 insertions(+), 11 deletions(-)
conformance.tex +0 -0
index 9807c30..663e7c3 100644

conformance.tex \section{Conformance Targets}\label{sec:Conformance / Conformance Targets} · line 89

Quoted 5 lines
conformance.tex +2 -0
@@ -85,6 +85,12 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
 \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Updating idx}
 \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Notifying The Device}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / PAcked Virtqueues / The Virtqueue Descriptor Table}

I wonder whether we could use the opportunity to fix that "PAcked" typo here as well.

Quoted 8 lines
conformance.tex +4 -0
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table / Indirect Descriptors}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Updating flags}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Sending Available Buffer Notifications}
 \item \ref{drivernormative:General Initialization And Device Operation / Device Initialization}
 \item \ref{drivernormative:General Initialization And Device Operation / Device Cleanup}
 \item \ref{drivernormative:Reserved Feature Bits}

conformance.tex \section{Conformance Targets}\label{sec:Conformance / Conformance Targets} · line 354

Quoted 9 lines
conformance.tex +3 -0
@@ -340,6 +346,9 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / The Virtqueue Used Ring}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
+\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
+\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table}
+\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Shared Memory Regions}
 \item \ref{devicenormative:Reserved Feature Bits}
 \end{itemize}

I guess it is ok to link this up as an editorial update; the statements are pre-existing, and an implementation that does not know the feature bit remains compliant.

---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that generates this mail. Follow this link to all your TCs in OASIS at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php

#2 lore raw
Quoted 10 lines · Cornelia Huck
Quoted 8 lines · Michael S. Tsirkin

Link conformance statements into conformance chapter.

---
 conformance.tex |  9 +++++++++
 packed-ring.tex | 16 +++++-----------
 2 files changed, 14 insertions(+), 11 deletions(-)
Quoted 13 lines

conformance.tex \section{Conformance Targets}\label{sec:Conformance / Conformance Targets} · line 89

Quoted 10 lines
conformance.tex +2 -0
index 9807c30..663e7c3 100644
@@ -85,6 +85,12 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
 \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Updating idx}
 \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Notifying The Device}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / PAcked Virtqueues / The Virtqueue Descriptor Table}

I wonder whether we could use the opportunity to fix that "PAcked" typo here as well.

It's just a ref but if you like it, sure, make it a patch on top.

Quoted 13 lines
Quoted 13 lines
conformance.tex +6 -0
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table / Indirect Descriptors}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Updating flags}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Sending Available Buffer Notifications}
 \item \ref{drivernormative:General Initialization And Device Operation / Device Initialization}
 \item \ref{drivernormative:General Initialization And Device Operation / Device Cleanup}
 \item \ref{drivernormative:Reserved Feature Bits}
@@ -340,6 +346,9 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / The Virtqueue Used Ring}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
+\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
+\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table}
Quoted 8 lines

conformance.tex \section{Conformance Targets}\label{sec:Conformance / Conformance Targets} · line 354

Quoted 4 lines
conformance.tex +1 -0
+\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Shared Memory Regions}
 \item \ref{devicenormative:Reserved Feature Bits}
 \end{itemize}

I guess it is ok to link this up as an editorial update; the statements are pre-existing, and an implementation that does not know the feature bit remains compliant.

I agree.

Signature · 1 line
MST
#3 lore raw
In reply to Cornelia Huck
Quoted 37 lines · On Tue, 19 Apr 2022 17:11:47 +0200 Cornelia Huck <[email protected]> wrote:
Quoted 13 lines · Michael S. Tsirkin

Link conformance statements into conformance chapter.

---
 conformance.tex |  9 +++++++++
 packed-ring.tex | 16 +++++-----------
 2 files changed, 14 insertions(+), 11 deletions(-)
conformance.tex +0 -0
index 9807c30..663e7c3 100644

conformance.tex \section{Conformance Targets}\label{sec:Conformance / Conformance Targets} · line 89

Quoted 5 lines
conformance.tex +2 -0
@@ -85,6 +85,12 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
 \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Updating idx}
 \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Notifying The Device}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / PAcked Virtqueues / The Virtqueue Descriptor Table}  

I wonder whether we could use the opportunity to fix that "PAcked" typo here as well.

Quoted 13 lines
conformance.tex +6 -0
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table / Indirect Descriptors}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Updating flags}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Sending Available Buffer Notifications}
 \item \ref{drivernormative:General Initialization And Device Operation / Device Initialization}
 \item \ref{drivernormative:General Initialization And Device Operation / Device Cleanup}
 \item \ref{drivernormative:Reserved Feature Bits}
@@ -340,6 +346,9 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / The Virtqueue Used Ring}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
+\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
+\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table}
Quoted 9 lines

conformance.tex \section{Conformance Targets}\label{sec:Conformance / Conformance Targets} · line 354

Quoted 4 lines
conformance.tex +1 -0
+\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Shared Memory Regions}
 \item \ref{devicenormative:Reserved Feature Bits}
 \end{itemize}  

I guess it is ok to link this up as an editorial update; the statements are pre-existing, and an implementation that does not know the feature bit remains compliant.

I tend to agree

Quoted 5 lines

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]

#4 lore raw
In reply to Michael S. Tsirkin
Quoted 7 lines · Michael S. Tsirkin

Link conformance statements into conformance chapter.

---
 conformance.tex |  9 +++++++++
 packed-ring.tex | 16 +++++-----------
 2 files changed, 14 insertions(+), 11 deletions(-)

Thanks, pushed as an editorial update.

---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that generates this mail. Follow this link to all your TCs in OASIS at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php

#5 lore raw
Quoted 11 lines · Cornelia Huck
Quoted 7 lines · Michael S. Tsirkin

Link conformance statements into conformance chapter.

---
 conformance.tex |  9 +++++++++
 packed-ring.tex | 16 +++++-----------
 2 files changed, 14 insertions(+), 11 deletions(-)

Thanks, pushed as an editorial update.

I guess we need to now update cl-os.tex with these editorial changes, right?

Signature · 1 line
MST
#6 lore raw
Quoted 11 lines · Michael S. Tsirkin
Quoted 10 lines · Cornelia Huck
Quoted 7 lines · Michael S. Tsirkin

Link conformance statements into conformance chapter.

---
 conformance.tex |  9 +++++++++
 packed-ring.tex | 16 +++++-----------
 2 files changed, 14 insertions(+), 11 deletions(-)
Quoted 3 lines
Quoted 1 line

Thanks, pushed as an editorial update.

I guess we need to now update cl-os.tex with these editorial changes, right?

I already did (well, I hope I didn't miss any.)

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/