[PATCH 6/6] transport-mmio: Add administration virtqueue requirements

[Parav Pandit <parav@nvidia.com>]

Add device and driver normative statements for administration
virtqueues over the MMIO transport, and reference them from the MMIO
device and driver conformance clauses.

Device requirements:
- AdminQueueIndex is beyond all other virtqueues.

Driver requirements:
- AdminQueueIndex and AdminQueueNum are only accessed when
  VIRTIO_F_ADMIN_VQ has been negotiated, so that drivers never read
  these registers on devices which do not implement them.
- Administration virtqueues are configured only within the reported
  range; the driver may use fewer than supported, same as for PCI.

Signed-off-by: Parav Pandit <parav@nvidia.com>
---
 conformance.tex    |  2 ++
 transport-mmio.tex | 20 ++++++++++++++++++++
 2 files changed, 22 insertions(+)

diff --git a/conformance.tex b/conformance.tex
index 9af31e2..b1dd83a 100644
--- a/conformance.tex
+++ b/conformance.tex
@@ -132,6 +132,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \item \ref{drivernormative:Virtio Transport Options / Virtio Over MMIO / MMIO Device Register Layout}
 \item \ref{drivernormative:Virtio Transport Options / Virtio Over MMIO / MMIO-specific Initialization And Device Operation / Device Initialization}
 \item \ref{drivernormative:Virtio Transport Options / Virtio Over MMIO / MMIO-specific Initialization And Device Operation / Notifications From The Device}
+\item \ref{drivernormative:Virtio Transport Options / Virtio Over MMIO / MMIO-specific Initialization And Device Operation / Administration Virtqueues}
 \end{itemize}
 
 \conformance{\subsection}{Channel I/O Driver Conformance}\label{sec:Conformance / Driver Conformance / Channel I/O Driver Conformance}
@@ -224,6 +225,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 
 \begin{itemize}
 \item \ref{devicenormative:Virtio Transport Options / Virtio Over MMIO / MMIO Device Register Layout}
+\item \ref{devicenormative:Virtio Transport Options / Virtio Over MMIO / MMIO-specific Initialization And Device Operation / Administration Virtqueues}
 \end{itemize}
 
 \conformance{\subsection}{Channel I/O Device Conformance}\label{sec:Conformance / Device Conformance / Channel I/O Device Conformance}
diff --git a/transport-mmio.tex b/transport-mmio.tex
index c537e85..40fda97 100644
--- a/transport-mmio.tex
+++ b/transport-mmio.tex
@@ -510,6 +510,26 @@ \subsubsection{Administration Virtqueues}\label{sec:Virtio Transport Options / V
    \ref{sec:Virtio Transport Options / Virtio Over MMIO / MMIO-specific Initialization And Device Operation / Virtqueue Configuration}~\nameref{sec:Virtio Transport Options / Virtio Over MMIO / MMIO-specific Initialization And Device Operation / Virtqueue Configuration}.
 \end{enumerate}
 
+\devicenormative{\paragraph}{Administration Virtqueues}{Virtio Transport Options / Virtio Over MMIO / MMIO-specific Initialization And Device Operation / Administration Virtqueues}
+
+If VIRTIO_F_ADMIN_VQ has been negotiated, the device MUST present
+in \field{AdminQueueIndex} a value which is bigger than the index of
+any virtqueue of the device that is not an administration virtqueue.
+
+\drivernormative{\paragraph}{Administration Virtqueues}{Virtio Transport Options / Virtio Over MMIO / MMIO-specific Initialization And Device Operation / Administration Virtqueues}
+
+The driver MUST NOT access \field{AdminQueueIndex} and
+\field{AdminQueueNum} unless VIRTIO_F_ADMIN_VQ has been negotiated.
+
+If VIRTIO_F_ADMIN_VQ has been negotiated, and if the driver
+configures any administration virtqueues, the driver MUST
+configure the administration virtqueues using the index
+in the range \field{AdminQueueIndex} to
+\field{AdminQueueIndex} + \field{AdminQueueNum} - 1 inclusive.
+
+The driver MAY configure fewer administration virtqueues than
+supported by the device.
+
 \subsection{Legacy interface}\label{sec:Virtio Transport Options / Virtio Over MMIO / Legacy interface}
 
 The legacy MMIO transport used page-based addressing, resulting
-- 
2.43.0