Skip to contentSkip to conversation

admin: Fix requirements wording inconsistencies

PATCH Superseded Peter Hilber 1 participant 3 messages Feb 8, 2024

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

cover admin: Fix requirements wording inconsistencies

I stumbled over some inconsistencies in the administration virtqueue requirements wording. These patches should fix them.

I think they could be considered editorial fixes.

Peter Hilber (2):
admin: Refer to processing order as "limited" rather than none
admin: Fix driver requirement subject

 admin.tex | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Signature · 18 lines
2.40.1


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

PATCH 1/2 admin: Refer to processing order as "limited" rather than none

The non-normative section says that administration virtqueue commands "will be consumed with no order constraints". But actually, the requirements stipulate a total order for all commands in the same virtqueue:

The device MUST process commands on a given administration virtqueue in the order in which they are queued.

If multiple administration virtqueues have been configured, device MAY process commands on distinct virtqueues with no order constraints.

Rather than "no order constraints", refer to "limited order constraints" to not mislead the reader.

Fixes bf1d6b0d24ae8 ("admin: conformance clauses")
---
 admin.tex | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
admin.tex +1 -1
index 0803c269e5c4..54f18c255fb0 100644
@@ -458,7 +458,7 @@ \section{Administration Virtqueues}\label{sec:Basic Facilities of a Virtio Devic
 virtqueue, and they are used by the device on that same
 virtqueue. It is the responsibility of the driver to ensure
 strict request ordering for commands, because they will be
-consumed with no order constraints.  For example, if consistency
+consumed with limited order constraints.  For example, if consistency
 is required then the driver can wait for the processing of a
 first command by the device to be completed before submitting
 another command depending on the first one.
Signature · 18 lines
2.40.1


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/
#2 lore raw

PATCH 2/2 admin: Fix driver requirement subject

In reply to Peter Hilber

The driver-normative section for Group administration commands contains a requirement on the *device*. This requirement only makes sense as a requirement on the driver.

Fix this by making the driver the requirement subject.

Fixes bf1d6b0d24ae8 ("admin: conformance clauses")
---
 admin.tex | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
admin.tex +1 -1
index 54f18c255fb0..41cc12e4e12b 100644
@@ -582,7 +582,7 @@ \section{Administration Virtqueues}\label{sec:Basic Facilities of a Virtio Devic
 of \field{struct virtio_admin_cmd} that are a multiple of 64 bit
 in length.
 
-The device MUST supply both device-readable or device-writeable parts
+The driver MUST supply both device-readable or device-writeable parts
 of \field{struct virtio_admin_cmd} that are larger than zero in
 length. However, \field{command_specific_data} and
 \field{command_specific_result} MAY be zero in length, unless
Signature · 18 lines
2.40.1


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/