Skip to content

Commit c25b9bd

Browse files
bertrand-marquisbertrand-marquis
committed
virtio-msg: Remove compressed chapter lable/normative
Replace compressed forms of labels or normative with long forms (for example FeatureBlocks to Feature Blocks). While there update conformance chapter. Signed-off-by: Bertrand Marquis <bertrand.marquis@arm.com>
1 parent 1f2e4d9 commit c25b9bd

2 files changed

Lines changed: 28 additions & 23 deletions

File tree

‎conformance.tex‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,8 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
149149

150150
\begin{itemize}
151151
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Revisions / Driver Limits}
152-
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / ConfigGen / Driver}
152+
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Versioning and Forward Compatibility / Driver}
153+
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Configuration Generation Count / Driver}
153154
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Endianness / Driver}
154155
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Common Message Format / Driver}
155156
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Device Initialization / Overview / Driver}
@@ -161,8 +162,8 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
161162
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Device Initialization / Finalizing Initialization / Driver}
162163
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Device Operation / Driver Notifications / Driver}
163164
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Device Operation / Device Notifications / Driver}
164-
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Device Operation / ConfigUpdates / Driver}
165-
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Device Operation / VQueueUpdates / Driver}
165+
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Device Operation / Configuration Changes During Operation / Driver}
166+
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Device Operation / Virtqueue Changes During Operation / Driver}
166167
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Device Operation / Reset / Driver}
167168
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Transport Messages / Mandatory / Driver}
168169
\item \ref{drivernormative:Virtio Transport Options / Virtio Over Messages / Transport Messages / VIRTIO_MSG_GET_DEVICE_INFO / Driver}
@@ -275,9 +276,10 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
275276

276277
\begin{itemize}
277278
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Revisions / Device Limits}
278-
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / ConfigGen / Device}
279-
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / FeatureBlocks / Device}
280-
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / ErrorSignaling / Device}
279+
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Versioning and Forward Compatibility / Device}
280+
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Configuration Generation Count / Device}
281+
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Feature Blocks / Device}
282+
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Error Signaling / Device}
281283
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Endianness / Device}
282284
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Common Message Format / Device}
283285
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Device Initialization / Device Features / Device}
@@ -286,8 +288,8 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
286288
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Device Initialization / Status Information / Device}
287289
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Device Initialization / Finalizing Initialization / Device}
288290
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Device Operation / Device Notifications / Device}
289-
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Device Operation / ConfigUpdates / Device}
290-
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Device Operation / VQueueUpdates / Device}
291+
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Device Operation / Configuration Changes During Operation / Device}
292+
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Device Operation / Virtqueue Changes During Operation / Device}
291293
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Device Operation / Reset / Device}
292294
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Transport Messages / Mandatory / Device}
293295
\item \ref{devicenormative:Virtio Transport Options / Virtio Over Messages / Transport Messages / VIRTIO_MSG_GET_DEVICE_INFO / Device}
@@ -336,10 +338,13 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
336338
A Virtio Over Messages bus implementation MUST conform to the following normative statements:
337339

338340
\begin{itemize}
341+
\item \ref{busnormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Relationship between bus and transport / Bus Messages}
339342
\item \ref{busnormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Relationship between bus and transport / Transport Message Forwarding}
340343
\item \ref{busnormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Revisions / Advertising Transport Parameters}
344+
\item \ref{busnormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Revisions / Message Size}
345+
\item \ref{busnormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Versioning and Forward Compatibility / Bus}
341346
\item \ref{busnormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Device Numbers / Assignment}
342-
\item \ref{busnormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / ErrorSignaling / Bus}
347+
\item \ref{busnormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Error Signaling / Bus}
343348
\item \ref{busnormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Common Message Format / Bus}
344349
\item \ref{busnormative:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Ordering / Bus}
345350
\item \ref{busnormative:Virtio Transport Options / Virtio Over Messages / Device Discovery / Bus}

‎transport-msg.tex‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ \subsubsection{Device Numbers and Enumeration}
297297
\end{itemize}
298298

299299
\subsubsection{Configuration Generation Count}
300-
\label{sec:Virtio Transport Options / Virtio Over Messages / Basic Concepts / ConfigGen}
300+
\label{sec:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Configuration Generation Count}
301301

302302
Each device maintains a \textbf{Configuration Generation Count} to prevent
303303
inconsistent updates. This count is incremented at least once by the device for
@@ -307,7 +307,7 @@ \subsubsection{Configuration Generation Count}
307307
count does not necessarily start at zero and is not automatically reset when
308308
the device resets.
309309

310-
\devicenormative{\paragraph}{Configuration Generation Count}{Virtio Transport Options / Virtio Over Messages / Basic Concepts / ConfigGen / Device}
310+
\devicenormative{\paragraph}{Configuration Generation Count}{Virtio Transport Options / Virtio Over Messages / Basic Concepts / Configuration Generation Count / Device}
311311
\begin{itemize}
312312
\item A device MUST increment the generation count before it makes a change
313313
that is visible to the driver and MUST ensure that each
@@ -322,7 +322,7 @@ \subsubsection{Configuration Generation Count}
322322
request.
323323
\end{itemize}
324324

325-
\drivernormative{\paragraph}{Configuration Generation Count}{Virtio Transport Options / Virtio Over Messages / Basic Concepts / ConfigGen / Driver}
325+
\drivernormative{\paragraph}{Configuration Generation Count}{Virtio Transport Options / Virtio Over Messages / Basic Concepts / Configuration Generation Count / Driver}
326326
\begin{itemize}
327327
\item A driver MUST track the most recent generation count observed (via
328328
\msgref{EVENT_CONFIG} or \msgref{GET_CONFIG}) and include it in every
@@ -336,7 +336,7 @@ \subsubsection{Configuration Generation Count}
336336
information.
337337

338338
\subsubsection{Feature Negotiation Blocks}
339-
\label{sec:Virtio Transport Options / Virtio Over Messages / Basic Concepts / FeatureBlocks}
339+
\label{sec:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Feature Blocks}
340340

341341
The virtio-msg transport organizes feature bits into 32-bit blocks accessed by
342342
\msgref{GET_DEVICE_FEATURES} and \msgref{SET_DRIVER_FEATURES}. Each block
@@ -351,23 +351,23 @@ \subsubsection{Feature Negotiation Blocks}
351351
driver-requested) feature bits in the selected blocks.
352352
\end{itemize}
353353

354-
\devicenormative{\paragraph}{Feature Blocks}{Virtio Transport Options / Virtio Over Messages / Basic Concepts / FeatureBlocks / Device}
354+
\devicenormative{\paragraph}{Feature Blocks}{Virtio Transport Options / Virtio Over Messages / Basic Concepts / Feature Blocks / Device}
355355
\begin{itemize}
356356
\item When \msgref{GET_DEVICE_FEATURES} covers blocks that extend beyond the
357357
features a device implements, the device MUST return zero for the
358358
feature data in those positions.
359359
\end{itemize}
360360

361361
\subsubsection{Error Signaling}
362-
\label{sec:Virtio Transport Options / Virtio Over Messages / Basic Concepts / ErrorSignaling}
362+
\label{sec:Virtio Transport Options / Virtio Over Messages / Basic Concepts / Error Signaling}
363363

364364
Transport errors can arise from malformed messages, routing failures inside a
365365
bus implementation, or device-side faults while processing a valid request.
366366
Implementations should handle such faults locally where possible, but a bus may
367367
surface an error to the virtio-msg transport if it cannot deliver a request or
368368
obtain a response within its policy.
369369

370-
\busnormative{\paragraph}{Error Handling}{Virtio Transport Options / Virtio Over Messages / Basic Concepts / ErrorSignaling / Bus}
370+
\busnormative{\paragraph}{Error Handling}{Virtio Transport Options / Virtio Over Messages / Basic Concepts / Error Signaling / Bus}
371371
\begin{itemize}
372372
\item A bus implementation MAY report a transport-visible failure (for
373373
example, after exhausting a bounded retry policy) when it cannot deliver
@@ -379,7 +379,7 @@ \subsubsection{Error Signaling}
379379
(one-way) messages.
380380
\end{itemize}
381381

382-
\devicenormative{\paragraph}{Error Handling}{Virtio Transport Options / Virtio Over Messages / Basic Concepts / ErrorSignaling / Device}
382+
\devicenormative{\paragraph}{Error Handling}{Virtio Transport Options / Virtio Over Messages / Basic Concepts / Error Signaling / Device}
383383
\begin{itemize}
384384
\item A device receiving a malformed or unsupported transport message MUST
385385
discard it without producing further protocol traffic.
@@ -843,14 +843,14 @@ \subsubsection{Device Notifications}
843843
\end{itemize}
844844

845845
\subsubsection{Configuration Changes During Operation}
846-
\label{sec:Virtio Transport Options / Virtio Over Messages / Device Operation / ConfigUpdates}
846+
\label{sec:Virtio Transport Options / Virtio Over Messages / Device Operation / Configuration Changes During Operation}
847847

848848
Drivers may update configuration fields at runtime using \msgref{SET_CONFIG}
849849
when features such as device modes or limits need to change. Devices can also
850850
update configuration data autonomously but must signal those changes via
851851
\msgref{EVENT_CONFIG}.
852852

853-
\drivernormative{\paragraph}{Runtime Configuration}{Virtio Transport Options / Virtio Over Messages / Device Operation / ConfigUpdates / Driver}
853+
\drivernormative{\paragraph}{Runtime Configuration}{Virtio Transport Options / Virtio Over Messages / Device Operation / Configuration Changes During Operation / Driver}
854854
\begin{itemize}
855855
\item A driver MAY issue \msgref{SET_CONFIG} after initialization, provided it
856856
includes the current configuration generation count and follows the same
@@ -860,21 +860,21 @@ \subsubsection{Configuration Changes During Operation}
860860
\msgref{GET_CONFIG}) before relying on the updated values.
861861
\end{itemize}
862862

863-
\devicenormative{\paragraph}{Runtime Configuration}{Virtio Transport Options / Virtio Over Messages / Device Operation / ConfigUpdates / Device}
863+
\devicenormative{\paragraph}{Runtime Configuration}{Virtio Transport Options / Virtio Over Messages / Device Operation / Configuration Changes During Operation / Device}
864864
\begin{itemize}
865865
\item If a device updates its configuration after initialization, it MUST send
866866
\msgref{EVENT_CONFIG} to inform the driver of the change and provide the
867867
new configuration generation count.
868868
\end{itemize}
869869

870870
\subsubsection{Virtqueue Changes During Operation}
871-
\label{sec:Virtio Transport Options / Virtio Over Messages / Device Operation / VQueueUpdates}
871+
\label{sec:Virtio Transport Options / Virtio Over Messages / Device Operation / Virtqueue Changes During Operation}
872872

873873
Drivers may provision unused virtqueues later in the device lifetime by issuing
874874
\msgref{SET_VQUEUE}, and they may reconfigure existing queues if the
875875
VIRTIO\_F\_RING\_RESET feature has been negotiated.
876876

877-
\drivernormative{\paragraph}{Runtime Virtqueue Changes}{Virtio Transport Options / Virtio Over Messages / Device Operation / VQueueUpdates / Driver}
877+
\drivernormative{\paragraph}{Runtime Virtqueue Changes}{Virtio Transport Options / Virtio Over Messages / Device Operation / Virtqueue Changes During Operation / Driver}
878878
\begin{itemize}
879879
\item A driver MAY configure additional virtqueues after initialization using
880880
\msgref{SET_VQUEUE}, provided it follows the same validation steps
@@ -884,7 +884,7 @@ \subsubsection{Virtqueue Changes During Operation}
884884
the device.
885885
\end{itemize}
886886

887-
\devicenormative{\paragraph}{Runtime Virtqueue Changes}{Virtio Transport Options / Virtio Over Messages / Device Operation / VQueueUpdates / Device}
887+
\devicenormative{\paragraph}{Runtime Virtqueue Changes}{Virtio Transport Options / Virtio Over Messages / Device Operation / Virtqueue Changes During Operation / Device}
888888
\begin{itemize}
889889
\item A device MUST honor \msgref{SET_VQUEUE} requests issued after
890890
initialization and update the queue parameters accordingly.

0 commit comments

Comments
 (0)