Skip to contentSkip to conversation

Split device spec to its individual files

PATCH Superseded Parav Pandit 4 participants 30 messages Jan 9, 2023 – Jan 10, 2023

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

v2 cover Split device spec to its individual files

Relatively several of the recent device specifications are maintained in their own specification file. Such separate files enables better maintenance of the specification overall.
However, several of the initial virtio device specifications are located in single file.

Hence, split them into their individual files.

Additionally, each device's driver and device conformance is present in one giant conformance file all together.

As Michael suggest's move this device and driver conformance section adjacent to device specification in each device specific directory. This further makes device specification self-contained.

Added patch to fix spelling errors in network device specification which was inherited from its previous file location.

Patches do not change any part of the specification outcome except fixing the spelling errors.
It only changes how the specification is maintained.

patch summary:
-------------
patch 1 to 7 creates new files for moving devices spec out of content and conformance files.
patch 8 to 20 move existing dedicated file spec to new directory and creates per device,driver conformance file for each device.

changelog:
----------
v1->v2:
- removed extra blank lines in network and block device files
- added missing device conformance link for rpmb, sound, i2c and gpio devices
v0->v1:
- move device spec to their own directory
- added split files for conformance and placed them adjacent to device spec
- added patch to fix spelling errors in network device

Parav Pandit (20):
virtio-network: Maintain network device spec in separate directory
virtio-network: Fix spelling errors
virtio-block: Maintain block device spec in separate directory
virtio-console: Maintain console device spec in separate directory
virtio-entropy: Maintain entropy device spec in separate directory
virtio-mem-balloon: Maintain mem balloon device spec in separate
directory
virtio-scsi: Maintain scsi host device spec in separate directory
virtio-gpu: Maintain gpu device spec in separate directory
virtio-input: Maintain input device spec in separate directory
virtio-crypto: Maintain crypto device spec in separate directory
virtio-vsock: Maintain socket device spec in separate directory
virtio-fs: Maintain file system device spec in separate directory
virtio-rpmb: Maintain rpmb device spec in separate directory
virtio-iommu: Maintain iommu device spec in separate directory
virtio-sound: Maintain sound device spec in separate directory
virtio-mem: Maintain memory device spec in separate directory
virtio-i2c: Maintain i2c device spec in separate directory
virtio-scmi: Maintain scmi device spec in separate directory
virtio-gpio: Maintain gpio device spec in separate directory
virtio-pmem: Maintain pmem device spec in separate directory

 conformance.tex                               |  456 +-
 content.tex                                   | 4561 +----------------
 .../virtio-block/device-conformance.tex       |    8 +
 device-types/virtio-block/device.tex          | 1313 +++++
 .../virtio-block/driver-conformance.tex       |    8 +
 .../virtio-console/device-conformance.tex     |    8 +
 device-types/virtio-console/device.tex        |  231 +
 .../virtio-console/driver-conformance.tex     |    8 +
 .../virtio-crypto/device-conformance.tex      |   13 +
 .../virtio-crypto/device.tex                  |    0
 .../virtio-crypto/driver-conformance.tex      |   14 +
 .../virtio-entropy/device-conformance.tex     |    7 +
 device-types/virtio-entropy/device.tex        |   42 +
 .../virtio-entropy/driver-conformance.tex     |    7 +
 device-types/virtio-fs/device-conformance.tex |    9 +
 .../virtio-fs/device.tex                      |    0
 device-types/virtio-fs/driver-conformance.tex |   10 +
 .../virtio-gpio/device-conformance.tex        |    9 +
 .../virtio-gpio/device.tex                    |    0
 .../virtio-gpio/driver-conformance.tex        |    9 +
 .../virtio-gpu/device-conformance.tex         |    8 +
 .../virtio-gpu/device.tex                     |    0
 .../virtio-i2c/device-conformance.tex         |    7 +
 .../virtio-i2c/device.tex                     |    0
 .../virtio-i2c/driver-conformance.tex         |    7 +
 .../virtio-input/device-conformance.tex       |    8 +
 .../virtio-input/device.tex                   |    0
 .../virtio-input/driver-conformance.tex       |    8 +
 .../virtio-iommu/device-conformance.tex       |   16 +
 .../virtio-iommu/device.tex                   |    0
 .../virtio-iommu/driver-conformance.tex       |   17 +
 .../virtio-mem-balloon/device-conformance.tex |   12 +
 device-types/virtio-mem-balloon/device.tex    |  634 +++
 .../virtio-mem-balloon/driver-conformance.tex |   12 +
 .../virtio-mem/device-conformance.tex         |   13 +
 .../virtio-mem/device.tex                     |    0
 .../virtio-mem/driver-conformance.tex         |   13 +
 .../virtio-network/device-conformance.tex     |   16 +
 device-types/virtio-network/device.tex        | 1594 ++++++
 .../virtio-network/driver-conformance.tex     |   17 +
 .../virtio-pmem/device-conformance.tex        |    9 +
 .../virtio-pmem/device.tex                    |    0
 .../virtio-pmem/driver-conformance.tex        |    7 +
 .../virtio-rpmb/device-conformance.tex        |   13 +
 .../virtio-rpmb/device.tex                    |    0
 .../virtio-rpmb/driver-conformance.tex        |    7 +
 .../virtio-scmi/device-conformance.tex        |   10 +
 .../virtio-scmi/device.tex                    |    0
 .../virtio-scmi/driver-conformance.tex        |    8 +
 .../virtio-scsi/device-conformance.tex        |   10 +
 device-types/virtio-scsi/device.tex           |  709 +++
 .../virtio-scsi/driver-conformance.tex        |    9 +
 .../virtio-sound/device-conformance.tex       |   16 +
 .../virtio-sound/device.tex                   |    0
 .../virtio-sound/driver-conformance.tex       |   13 +
 .../virtio-vsock/device-conformance.tex       |    9 +
 .../virtio-vsock/device.tex                   |    0
 .../virtio-vsock/driver-conformance.tex       |   10 +
 virtio.tex                                    |    1 +
 59 files changed, 4965 insertions(+), 4961 deletions(-)
 create mode 100644 device-types/virtio-block/device-conformance.tex
 create mode 100644 device-types/virtio-block/device.tex
 create mode 100644 device-types/virtio-block/driver-conformance.tex
 create mode 100644 device-types/virtio-console/device-conformance.tex
 create mode 100644 device-types/virtio-console/device.tex
 create mode 100644 device-types/virtio-console/driver-conformance.tex
 create mode 100644 device-types/virtio-crypto/device-conformance.tex
 rename virtio-crypto.tex => device-types/virtio-crypto/device.tex (100%)
 create mode 100644 device-types/virtio-crypto/driver-conformance.tex
 create mode 100644 device-types/virtio-entropy/device-conformance.tex
 create mode 100644 device-types/virtio-entropy/device.tex
 create mode 100644 device-types/virtio-entropy/driver-conformance.tex
 create mode 100644 device-types/virtio-fs/device-conformance.tex
 rename virtio-fs.tex => device-types/virtio-fs/device.tex (100%)
 create mode 100644 device-types/virtio-fs/driver-conformance.tex
 create mode 100644 device-types/virtio-gpio/device-conformance.tex
 rename virtio-gpio.tex => device-types/virtio-gpio/device.tex (100%)
 create mode 100644 device-types/virtio-gpio/driver-conformance.tex
 create mode 100644 device-types/virtio-gpu/device-conformance.tex
 rename virtio-gpu.tex => device-types/virtio-gpu/device.tex (100%)
 create mode 100644 device-types/virtio-i2c/device-conformance.tex
 rename virtio-i2c.tex => device-types/virtio-i2c/device.tex (100%)
 create mode 100644 device-types/virtio-i2c/driver-conformance.tex
 create mode 100644 device-types/virtio-input/device-conformance.tex
 rename virtio-input.tex => device-types/virtio-input/device.tex (100%)
 create mode 100644 device-types/virtio-input/driver-conformance.tex
 create mode 100644 device-types/virtio-iommu/device-conformance.tex
 rename virtio-iommu.tex => device-types/virtio-iommu/device.tex (100%)
 create mode 100644 device-types/virtio-iommu/driver-conformance.tex
 create mode 100644 device-types/virtio-mem-balloon/device-conformance.tex
 create mode 100644 device-types/virtio-mem-balloon/device.tex
 create mode 100644 device-types/virtio-mem-balloon/driver-conformance.tex
 create mode 100644 device-types/virtio-mem/device-conformance.tex
 rename virtio-mem.tex => device-types/virtio-mem/device.tex (100%)
 create mode 100644 device-types/virtio-mem/driver-conformance.tex
 create mode 100644 device-types/virtio-network/device-conformance.tex
 create mode 100644 device-types/virtio-network/device.tex
 create mode 100644 device-types/virtio-network/driver-conformance.tex
 create mode 100644 device-types/virtio-pmem/device-conformance.tex
 rename virtio-pmem.tex => device-types/virtio-pmem/device.tex (100%)
 create mode 100644 device-types/virtio-pmem/driver-conformance.tex
 create mode 100644 device-types/virtio-rpmb/device-conformance.tex
 rename virtio-rpmb.tex => device-types/virtio-rpmb/device.tex (100%)
 create mode 100644 device-types/virtio-rpmb/driver-conformance.tex
 create mode 100644 device-types/virtio-scmi/device-conformance.tex
 rename virtio-scmi.tex => device-types/virtio-scmi/device.tex (100%)
 create mode 100644 device-types/virtio-scmi/driver-conformance.tex
 create mode 100644 device-types/virtio-scsi/device-conformance.tex
 create mode 100644 device-types/virtio-scsi/device.tex
 create mode 100644 device-types/virtio-scsi/driver-conformance.tex
 create mode 100644 device-types/virtio-sound/device-conformance.tex
 rename virtio-sound.tex => device-types/virtio-sound/device.tex (100%)
 create mode 100644 device-types/virtio-sound/driver-conformance.tex
 create mode 100644 device-types/virtio-vsock/device-conformance.tex
 rename virtio-vsock.tex => device-types/virtio-vsock/device.tex (100%)
 create mode 100644 device-types/virtio-vsock/driver-conformance.tex
Signature · 1 line
2.26.2
#1 lore raw

PATCH v2 1/20 virtio-network: Maintain network device spec in separate directory

Move virtio network device specification to its own file similar to recent virtio devices.
While at it, place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v1->v2:
- removed extra blank lines at end of file
v0->v1:
- moved to device specific directory

---
 conformance.tex                               |   35 +-
 content.tex                                   | 1595 +----------------
 .../virtio-network/device-conformance.tex     |   16 +
 device-types/virtio-network/device.tex        | 1594 ++++++++++++++++
 .../virtio-network/driver-conformance.tex     |   17 +
 virtio.tex                                    |    1 +
 6 files changed, 1631 insertions(+), 1627 deletions(-)
 create mode 100644 device-types/virtio-network/device-conformance.tex
 create mode 100644 device-types/virtio-network/device.tex
 create mode 100644 device-types/virtio-network/driver-conformance.tex
conformance.tex +2 -33
index c3c1d3e..8cc6408 100644
@@ -134,23 +134,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \item \ref{drivernormative:Virtio Transport Options / Virtio over channel I/O / Device Operation / Resetting Devices}
 \end{itemize}
 
-\conformance{\subsection}{Network Driver Conformance}\label{sec:Conformance / Driver Conformance / Network Driver Conformance}
-
-A network driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / Network Device / Device configuration layout}
-\item \ref{drivernormative:Device Types / Network Device / Device Operation / Packet Transmission}
-\item \ref{drivernormative:Device Types / Network Device / Device Operation / Setting Up Receive Buffers}
-\item \ref{drivernormative:Device Types / Network Device / Device Operation / Processing of Incoming Packets}
-\item \ref{drivernormative:Device Types / Network Device / Device Operation / Control Virtqueue / Packet Receive Filtering}
-\item \ref{drivernormative:Device Types / Network Device / Device Operation / Control Virtqueue / Setting MAC Address Filtering}
-\item \ref{drivernormative:Device Types / Network Device / Device Operation / Control Virtqueue / Gratuitous Packet Sending}
-\item \ref{drivernormative:Device Types / Network Device / Device Operation / Control Virtqueue / Automatic receive steering in multiqueue mode}
-\item \ref{drivernormative:Device Types / Network Device / Device Operation / Control Virtqueue / Offloads State Configuration / Setting Offloads State}
-\item \ref{drivernormative:Device Types / Network Device / Device Operation / Control Virtqueue / Receive-side scaling (RSS) }
-\item \ref{drivernormative:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing}
-\end{itemize}
+\import{device-types/virtio-network/}{driver-conformance}
 
 \conformance{\subsection}{Block Driver Conformance}\label{sec:Conformance / Driver Conformance / Block Driver Conformance}
 
@@ -401,22 +385,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \item \ref{devicenormative:Virtio Transport Options / Virtio over channel I/O / Device Operation / Resetting Devices}
 \end{itemize}
 
-\conformance{\subsection}{Network Device Conformance}\label{sec:Conformance / Device Conformance / Network Device Conformance}
-
-A network device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / Network Device / Device configuration layout}
-\item \ref{devicenormative:Device Types / Network Device / Device Operation / Packet Transmission}
-\item \ref{devicenormative:Device Types / Network Device / Device Operation / Setting Up Receive Buffers}
-\item \ref{devicenormative:Device Types / Network Device / Device Operation / Processing of Incoming Packets}
-\item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Packet Receive Filtering}
-\item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Setting MAC Address Filtering}
-\item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Gratuitous Packet Sending}
-\item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Automatic receive steering in multiqueue mode}
-\item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Receive-side scaling (RSS) / RSS processing}
-\item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing}
-\end{itemize}
+\import{device-types/virtio-network/}{device-conformance}
 
 \conformance{\subsection}{Block Device Conformance}\label{sec:Conformance / Device Conformance / Block Device Conformance}
 
content.tex +1 -1594

1,601 lines not on this page · raw message

device-types/virtio-network/device-conformance.tex new file +16 -0
new file mode 100644
index 0000000..c686377
@@ -0,0 +1,16 @@
+\conformance{\subsection}{Network Device Conformance}\label{sec:Conformance / Device Conformance / Network Device Conformance}
+
+A network device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / Network Device / Device configuration layout}
+\item \ref{devicenormative:Device Types / Network Device / Device Operation / Packet Transmission}
+\item \ref{devicenormative:Device Types / Network Device / Device Operation / Setting Up Receive Buffers}
+\item \ref{devicenormative:Device Types / Network Device / Device Operation / Processing of Incoming Packets}
+\item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Packet Receive Filtering}
+\item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Setting MAC Address Filtering}
+\item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Gratuitous Packet Sending}
+\item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Automatic receive steering in multiqueue mode}
+\item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Receive-side scaling (RSS) / RSS processing}
+\item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Notifications Coalescing}
+\end{itemize}
device-types/virtio-network/device.tex new file +1594 -0

1,336 lines not on this page · raw message

device-types/virtio-network/driver-conformance.tex new file +17 -0
new file mode 100644
index 0000000..97d0cc1

Lines of this file are not shown. View the raw message.

virtio.tex +1 -0
index a99bb3f..ffa96c4 100644

Lines of this file are not shown. View the raw message.

The rest of this diff is not shown. View the raw message.

Signature · 1 line
2.26.2

Part of the diff is not shown here. View the raw message.

#2 lore raw

PATCH v2 2/20 virtio-network: Fix spelling errors

In reply to Parav Pandit

Fix two spelling errors in the virtio network device specification.

---
 device-types/virtio-network/device.tex | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
device-types/virtio-network/device.tex +2 -2
index 367681d..82d7374 100644
@@ -331,7 +331,7 @@ \subsection{Device Initialization}\label{sec:Device Types / Network Device / Dev
   Otherwise, the driver assumes it's active.
 
 \item A performant driver would indicate that it will generate checksumless
-  packets by negotating the VIRTIO_NET_F_CSUM feature.
+  packets by negotiating the VIRTIO_NET_F_CSUM feature.
 
 \item If that feature is negotiated, a driver can use TCP segmentation or UDP
   segmentation/fragmentation offload by negotiating the VIRTIO_NET_F_HOST_TSO4 (IPv4
@@ -1062,7 +1062,7 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi
 \begin{itemize}
 \item VIRTIO_NET_CTRL_RX_PROMISC turns promiscuous mode on and
 off. The command-specific-data is one byte containing 0 (off) or
-1 (on). If promiscous mode is on, the device SHOULD receive all
+1 (on). If promiscuous mode is on, the device SHOULD receive all
 incoming packets.
 This SHOULD take effect even if one of the other modes set by
 a VIRTIO_NET_CTRL_RX class command is on.
Signature · 1 line
2.26.2
#3 lore raw

PATCH v2 3/20 virtio-block: Maintain block device spec in separate directory

In reply to Parav Pandit

Move virtio block device specification to its own file similar to recent virtio devices.
While at it, place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v1->v2:
- removed extra blank lines at end of file
v0->v1:
- moved to device specific directory

---
 conformance.tex                               |   20 +-
 content.tex                                   | 1315 +----------------
 .../virtio-block/device-conformance.tex       |    8 +
 device-types/virtio-block/device.tex          | 1313 ++++++++++++++++
 .../virtio-block/driver-conformance.tex       |    8 +
 5 files changed, 1332 insertions(+), 1332 deletions(-)
 create mode 100644 device-types/virtio-block/device-conformance.tex
 create mode 100644 device-types/virtio-block/device.tex
 create mode 100644 device-types/virtio-block/driver-conformance.tex
conformance.tex +2 -18
index 8cc6408..c523c8a 100644
@@ -135,15 +135,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \end{itemize}
 
 \import{device-types/virtio-network/}{driver-conformance}
-
-\conformance{\subsection}{Block Driver Conformance}\label{sec:Conformance / Driver Conformance / Block Driver Conformance}
-
-A block driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / Block Device / Device Initialization}
-\item \ref{drivernormative:Device Types / Block Device / Device Operation}
-\end{itemize}
+\import{device-types/virtio-block/}{driver-conformance}
 
 \conformance{\subsection}{Console Driver Conformance}\label{sec:Conformance / Driver Conformance / Console Driver Conformance}
 
@@ -386,15 +378,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \end{itemize}
 
 \import{device-types/virtio-network/}{device-conformance}
-
-\conformance{\subsection}{Block Device Conformance}\label{sec:Conformance / Device Conformance / Block Device Conformance}
-
-A block device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / Block Device / Device Initialization}
-\item \ref{devicenormative:Device Types / Block Device / Device Operation}
-\end{itemize}
+\import{device-types/virtio-block/}{device-conformance}
 
 \conformance{\subsection}{Console Device Conformance}\label{sec:Conformance / Device Conformance / Console Device Conformance}
 
content.tex +1 -1314

1,321 lines not on this page · raw message

device-types/virtio-block/device-conformance.tex new file +8 -0
new file mode 100644
index 0000000..b4fbc8b
@@ -0,0 +1,8 @@
+\conformance{\subsection}{Block Device Conformance}\label{sec:Conformance / Device Conformance / Block Device Conformance}
+
+A block device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / Block Device / Device Initialization}
+\item \ref{devicenormative:Device Types / Block Device / Device Operation}
+\end{itemize}
device-types/virtio-block/device.tex new file +1313 -0

1,313 lines not on this page · raw message

device-types/virtio-block/driver-conformance.tex new file +8 -0
new file mode 100644
index 0000000..0f69866
@@ -0,0 +1,8 @@
+\conformance{\subsection}{Block Driver Conformance}\label{sec:Conformance / Driver Conformance / Block Driver Conformance}
+
+A block driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / Block Device / Device Initialization}
+\item \ref{drivernormative:Device Types / Block Device / Device Operation}
+\end{itemize}
Signature · 1 line
2.26.2
#4 lore raw

PATCH v2 4/20 virtio-console: Maintain console device spec in separate directory

In reply to Parav Pandit

Move virtio console device specification to its own file similar to recent virtio devices.
While at it, place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v0->v1:
- moved to device specific directory

---
 conformance.tex                               |  20 +-
 content.tex                                   | 233 +-----------------
 .../virtio-console/device-conformance.tex     |   8 +
 device-types/virtio-console/device.tex        | 231 +++++++++++++++++
 .../virtio-console/driver-conformance.tex     |   8 +
 5 files changed, 250 insertions(+), 250 deletions(-)
 create mode 100644 device-types/virtio-console/device-conformance.tex
 create mode 100644 device-types/virtio-console/device.tex
 create mode 100644 device-types/virtio-console/driver-conformance.tex
conformance.tex +2 -18
index c523c8a..e991c2b 100644
@@ -136,15 +136,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 
 \import{device-types/virtio-network/}{driver-conformance}
 \import{device-types/virtio-block/}{driver-conformance}
-
-\conformance{\subsection}{Console Driver Conformance}\label{sec:Conformance / Driver Conformance / Console Driver Conformance}
-
-A console driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / Console Device / Device Operation}
-\item \ref{drivernormative:Device Types / Console Device / Device Operation / Multiport Device Operation}
-\end{itemize}
+\import{device-types/virtio-console/}{driver-conformance}
 
 \conformance{\subsection}{Entropy Driver Conformance}\label{sec:Conformance / Driver Conformance / Entropy Driver Conformance}
 
@@ -379,15 +371,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 
 \import{device-types/virtio-network/}{device-conformance}
 \import{device-types/virtio-block/}{device-conformance}
-
-\conformance{\subsection}{Console Device Conformance}\label{sec:Conformance / Device Conformance / Console Device Conformance}
-
-A console device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / Console Device / Device Initialization}
-\item \ref{devicenormative:Device Types / Console Device / Device Operation / Multiport Device Operation}
-\end{itemize}
+\import{device-types/virtio-console/}{device-conformance}
 
 \conformance{\subsection}{Entropy Device Conformance}\label{sec:Conformance / Device Conformance / Entropy Device Conformance}
 
content.tex +1 -232

239 lines not on this page · raw message

device-types/virtio-console/device-conformance.tex new file +8 -0
new file mode 100644
index 0000000..c61c3f7
@@ -0,0 +1,8 @@
+\conformance{\subsection}{Console Device Conformance}\label{sec:Conformance / Device Conformance / Console Device Conformance}
+
+A console device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / Console Device / Device Initialization}
+\item \ref{devicenormative:Device Types / Console Device / Device Operation / Multiport Device Operation}
+\end{itemize}
device-types/virtio-console/device.tex new file +231 -0

231 lines not on this page · raw message

device-types/virtio-console/driver-conformance.tex new file +8 -0
new file mode 100644
index 0000000..1460f4a
@@ -0,0 +1,8 @@
+\conformance{\subsection}{Console Driver Conformance}\label{sec:Conformance / Driver Conformance / Console Driver Conformance}
+
+A console driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / Console Device / Device Operation}
+\item \ref{drivernormative:Device Types / Console Device / Device Operation / Multiport Device Operation}
+\end{itemize}
Signature · 1 line
2.26.2
#5 lore raw

PATCH v2 5/20 virtio-entropy: Maintain entropy device spec in separate directory

In reply to Parav Pandit

Move virtio entropy device specification to its own file similar to recent virtio devices.
While at it, place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v0->v1:
- moved to device specific directory

---
 conformance.tex                               | 18 +-------
 content.tex                                   | 44 +------------------
 .../virtio-entropy/device-conformance.tex     |  7 +++
 device-types/virtio-entropy/device.tex        | 42 ++++++++++++++++++
 .../virtio-entropy/driver-conformance.tex     |  7 +++
 5 files changed, 59 insertions(+), 59 deletions(-)
 create mode 100644 device-types/virtio-entropy/device-conformance.tex
 create mode 100644 device-types/virtio-entropy/device.tex
 create mode 100644 device-types/virtio-entropy/driver-conformance.tex
conformance.tex +2 -16
index e991c2b..e5bb9d9 100644
@@ -137,14 +137,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-network/}{driver-conformance}
 \import{device-types/virtio-block/}{driver-conformance}
 \import{device-types/virtio-console/}{driver-conformance}
-
-\conformance{\subsection}{Entropy Driver Conformance}\label{sec:Conformance / Driver Conformance / Entropy Driver Conformance}
-
-An entropy driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / Entropy Device / Device Operation}
-\end{itemize}
+\import{device-types/virtio-entropy/}{driver-conformance}
 
 \conformance{\subsection}{Traditional Memory Balloon Driver Conformance}\label{sec:Conformance / Driver Conformance / Traditional Memory Balloon Driver Conformance}
 
@@ -372,14 +365,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-network/}{device-conformance}
 \import{device-types/virtio-block/}{device-conformance}
 \import{device-types/virtio-console/}{device-conformance}
-
-\conformance{\subsection}{Entropy Device Conformance}\label{sec:Conformance / Device Conformance / Entropy Device Conformance}
-
-An entropy device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / Entropy Device / Device Operation}
-\end{itemize}
+\import{device-types/virtio-entropy/}{device-conformance}
 
 \conformance{\subsection}{Traditional Memory Balloon Device Conformance}\label{sec:Conformance / Device Conformance / Traditional Memory Balloon Device Conformance}
 
content.tex +1 -43

50 lines not on this page · raw message

device-types/virtio-entropy/device-conformance.tex new file +7 -0
new file mode 100644
index 0000000..2789fda
@@ -0,0 +1,7 @@
+\conformance{\subsection}{Entropy Device Conformance}\label{sec:Conformance / Device Conformance / Entropy Device Conformance}
+
+An entropy device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / Entropy Device / Device Operation}
+\end{itemize}
device-types/virtio-entropy/device.tex new file +42 -0

42 lines not on this page · raw message

device-types/virtio-entropy/driver-conformance.tex new file +7 -0
new file mode 100644
index 0000000..175c453
@@ -0,0 +1,7 @@
+\conformance{\subsection}{Entropy Driver Conformance}\label{sec:Conformance / Driver Conformance / Entropy Driver Conformance}
+
+An entropy driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / Entropy Device / Device Operation}
+\end{itemize}
Signature · 1 line
2.26.2
#6 lore raw

PATCH v2 6/20 virtio-mem-balloon: Maintain mem balloon device spec in separate directory

In reply to Parav Pandit

Move virtio memory balloon device specification to its own file similar to recent virtio devices.
While at it, place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v0->v1:
- moved to device specific directory

---
 conformance.tex                               |  28 +-
 content.tex                                   | 636 +-----------------
 .../virtio-mem-balloon/device-conformance.tex |  12 +
 device-types/virtio-mem-balloon/device.tex    | 634 +++++++++++++++++
 .../virtio-mem-balloon/driver-conformance.tex |  12 +
 5 files changed, 661 insertions(+), 661 deletions(-)
 create mode 100644 device-types/virtio-mem-balloon/device-conformance.tex
 create mode 100644 device-types/virtio-mem-balloon/device.tex
 create mode 100644 device-types/virtio-mem-balloon/driver-conformance.tex
conformance.tex +2 -26
index e5bb9d9..a92ed5f 100644
@@ -138,19 +138,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-block/}{driver-conformance}
 \import{device-types/virtio-console/}{driver-conformance}
 \import{device-types/virtio-entropy/}{driver-conformance}
-
-\conformance{\subsection}{Traditional Memory Balloon Driver Conformance}\label{sec:Conformance / Driver Conformance / Traditional Memory Balloon Driver Conformance}
-
-A traditional memory balloon driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / Memory Balloon Device / Feature bits}
-\item \ref{drivernormative:Device Types / Memory Balloon Device / Device Operation}
-\item \ref{drivernormative:Device Types / Memory Balloon Device / Device Operation / Memory Statistics}
-\item \ref{drivernormative:Device Types / Memory Balloon Device / Device Operation / Free Page Hinting}
-\item \ref{drivernormative:Device Types / Memory Balloon Device / Device Operation / Page Poison}
-\item \ref{drivernormative:Device Types / Memory Balloon Device / Device Operation / Free Page Reporting}
-\end{itemize}
+\import{device-types/virtio-mem-balloon/}{driver-conformance}
 
 \conformance{\subsection}{SCSI Host Driver Conformance}\label{sec:Conformance / Driver Conformance / SCSI Host Driver Conformance}
 
@@ -366,19 +354,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-block/}{device-conformance}
 \import{device-types/virtio-console/}{device-conformance}
 \import{device-types/virtio-entropy/}{device-conformance}
-
-\conformance{\subsection}{Traditional Memory Balloon Device Conformance}\label{sec:Conformance / Device Conformance / Traditional Memory Balloon Device Conformance}
-
-A traditional memory balloon device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / Memory Balloon Device / Feature bits}
-\item \ref{devicenormative:Device Types / Memory Balloon Device / Device Operation}
-\item \ref{devicenormative:Device Types / Memory Balloon Device / Device Operation / Memory Statistics}
-\item \ref{devicenormative:Device Types / Memory Balloon Device / Device Operation / Free Page Hinting}
-\item \ref{devicenormative:Device Types / Memory Balloon Device / Device Operation / Page Poison}
-\item \ref{devicenormative:Device Types / Memory Balloon Device / Device Operation / Free Page Reporting}
-\end{itemize}
+\import{device-types/virtio-mem-balloon/}{device-conformance}
 
 \conformance{\subsection}{SCSI Host Device Conformance}\label{sec:Conformance / Device Conformance / SCSI Host Device Conformance}
 
content.tex +1 -635

642 lines not on this page · raw message

device-types/virtio-mem-balloon/device-conformance.tex new file +12 -0
new file mode 100644
index 0000000..ff9ac4f
@@ -0,0 +1,12 @@
+\conformance{\subsection}{Traditional Memory Balloon Device Conformance}\label{sec:Conformance / Device Conformance / Traditional Memory Balloon Device Conformance}
+
+A traditional memory balloon device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / Memory Balloon Device / Feature bits}
+\item \ref{devicenormative:Device Types / Memory Balloon Device / Device Operation}
+\item \ref{devicenormative:Device Types / Memory Balloon Device / Device Operation / Memory Statistics}
+\item \ref{devicenormative:Device Types / Memory Balloon Device / Device Operation / Free Page Hinting}
+\item \ref{devicenormative:Device Types / Memory Balloon Device / Device Operation / Page Poison}
+\item \ref{devicenormative:Device Types / Memory Balloon Device / Device Operation / Free Page Reporting}
+\end{itemize}
device-types/virtio-mem-balloon/device.tex new file +634 -0

634 lines not on this page · raw message

device-types/virtio-mem-balloon/driver-conformance.tex new file +12 -0
new file mode 100644
index 0000000..f898d74
@@ -0,0 +1,12 @@
+\conformance{\subsection}{Traditional Memory Balloon Driver Conformance}\label{sec:Conformance / Driver Conformance / Traditional Memory Balloon Driver Conformance}
+
+A traditional memory balloon driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / Memory Balloon Device / Feature bits}
+\item \ref{drivernormative:Device Types / Memory Balloon Device / Device Operation}
+\item \ref{drivernormative:Device Types / Memory Balloon Device / Device Operation / Memory Statistics}
+\item \ref{drivernormative:Device Types / Memory Balloon Device / Device Operation / Free Page Hinting}
+\item \ref{drivernormative:Device Types / Memory Balloon Device / Device Operation / Page Poison}
+\item \ref{drivernormative:Device Types / Memory Balloon Device / Device Operation / Free Page Reporting}
+\end{itemize}
Signature · 1 line
2.26.2
#7 lore raw

PATCH v2 7/20 virtio-scsi: Maintain scsi host device spec in separate directory

In reply to Parav Pandit

Move virtio SCSI host device specification to its own file similar to recent virtio devices.
While at it, place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v0->v1:
- moved to device specific directory

---
 conformance.tex                               |  23 +-
 content.tex                                   | 712 +-----------------
 .../virtio-scsi/device-conformance.tex        |  10 +
 device-types/virtio-scsi/device.tex           | 709 +++++++++++++++++
 .../virtio-scsi/driver-conformance.tex        |   9 +
 5 files changed, 731 insertions(+), 732 deletions(-)
 create mode 100644 device-types/virtio-scsi/device-conformance.tex
 create mode 100644 device-types/virtio-scsi/device.tex
 create mode 100644 device-types/virtio-scsi/driver-conformance.tex
conformance.tex +2 -21
index a92ed5f..10a5af3 100644
@@ -139,16 +139,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-console/}{driver-conformance}
 \import{device-types/virtio-entropy/}{driver-conformance}
 \import{device-types/virtio-mem-balloon/}{driver-conformance}
-
-\conformance{\subsection}{SCSI Host Driver Conformance}\label{sec:Conformance / Driver Conformance / SCSI Host Driver Conformance}
-
-An SCSI host driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / SCSI Host Device / Device configuration layout}
-\item \ref{drivernormative:Device Types / SCSI Host Device / Device Operation / Device Operation: Request Queues}
-\item \ref{drivernormative:Device Types / SCSI Host Device / Device Operation / Device Operation: eventq}
-\end{itemize}
+\import{device-types/virtio-scsi/}{driver-conformance}
 
 \conformance{\subsection}{Input Driver Conformance}\label{sec:Conformance / Driver Conformance / Input Driver Conformance}
 
@@ -355,17 +346,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-console/}{device-conformance}
 \import{device-types/virtio-entropy/}{device-conformance}
 \import{device-types/virtio-mem-balloon/}{device-conformance}
-
-\conformance{\subsection}{SCSI Host Device Conformance}\label{sec:Conformance / Device Conformance / SCSI Host Device Conformance}
-
-An SCSI host device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / SCSI Host Device / Device configuration layout}
-\item \ref{devicenormative:Device Types / SCSI Host Device / Device Initialization}
-\item \ref{devicenormative:Device Types / SCSI Host Device / Device Operation / Device Operation: Request Queues}
-\item \ref{devicenormative:Device Types / SCSI Host Device / Device Operation / Device Operation: eventq}
-\end{itemize}
+\import{device-types/virtio-scsi/}{device-conformance}
 
 \conformance{\subsection}{GPU Device Conformance}\label{sec:Conformance / Device Conformance / GPU Device Conformance}
 
content.tex +1 -711

718 lines not on this page · raw message

device-types/virtio-scsi/device-conformance.tex new file +10 -0
new file mode 100644
index 0000000..8dc859c
@@ -0,0 +1,10 @@
+\conformance{\subsection}{SCSI Host Device Conformance}\label{sec:Conformance / Device Conformance / SCSI Host Device Conformance}
+
+An SCSI host device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / SCSI Host Device / Device configuration layout}
+\item \ref{devicenormative:Device Types / SCSI Host Device / Device Initialization}
+\item \ref{devicenormative:Device Types / SCSI Host Device / Device Operation / Device Operation: Request Queues}
+\item \ref{devicenormative:Device Types / SCSI Host Device / Device Operation / Device Operation: eventq}
+\end{itemize}
device-types/virtio-scsi/device.tex new file +709 -0

709 lines not on this page · raw message

device-types/virtio-scsi/driver-conformance.tex new file +9 -0
new file mode 100644
index 0000000..746951b
@@ -0,0 +1,9 @@
+\conformance{\subsection}{SCSI Host Driver Conformance}\label{sec:Conformance / Driver Conformance / SCSI Host Driver Conformance}
+
+An SCSI host driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / SCSI Host Device / Device configuration layout}
+\item \ref{drivernormative:Device Types / SCSI Host Device / Device Operation / Device Operation: Request Queues}
+\item \ref{drivernormative:Device Types / SCSI Host Device / Device Operation / Device Operation: eventq}
+\end{itemize}
Signature · 1 line
2.26.2
#8 lore raw

PATCH v2 8/20 virtio-gpu: Maintain gpu device spec in separate directory

In reply to Parav Pandit

Move virtio gpu device specification to its own file similar to recent virtio devices.
While at it, place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v0->v1:
- moved to device specific directory

---
 conformance.tex                                      | 10 +---------
 content.tex                                          |  2 +-
 device-types/virtio-gpu/device-conformance.tex       |  8 ++++++++
 virtio-gpu.tex => device-types/virtio-gpu/device.tex |  0
 4 files changed, 10 insertions(+), 10 deletions(-)
 create mode 100644 device-types/virtio-gpu/device-conformance.tex
 rename virtio-gpu.tex => device-types/virtio-gpu/device.tex (100%)
conformance.tex +1 -9
index 10a5af3..432b03c 100644
@@ -347,15 +347,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-entropy/}{device-conformance}
 \import{device-types/virtio-mem-balloon/}{device-conformance}
 \import{device-types/virtio-scsi/}{device-conformance}
-
-\conformance{\subsection}{GPU Device Conformance}\label{sec:Conformance / Device Conformance / GPU Device Conformance}
-
-A GPU device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / GPU Device / Device Initialization}
-\item \ref{devicenormative:Device Types / GPU Device / Device Operation / Device Operation: Command lifecycle and fencing}
-\end{itemize}
+\import{device-types/virtio-gpu/}{device-conformance}
 
 \conformance{\subsection}{Input Device Conformance}\label{sec:Conformance / Device Conformance / Input Device Conformance}
 
content.tex +1 -1
index 05d2f9c..4f16ad8 100644
@@ -3009,7 +3009,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \import{device-types/virtio-entropy/}{device}
 \import{device-types/virtio-mem-balloon/}{device}
 \import{device-types/virtio-scsi/}{device}
-\input{virtio-gpu.tex}
+\import{device-types/virtio-gpu/}{device}
 \input{virtio-input.tex}
 \input{virtio-crypto.tex}
 \input{virtio-vsock.tex}
device-types/virtio-gpu/device-conformance.tex new file +8 -0
new file mode 100644
index 0000000..782ef81
@@ -0,0 +1,8 @@
+\conformance{\subsection}{GPU Device Conformance}\label{sec:Conformance / Device Conformance / GPU Device Conformance}
+
+A GPU device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / GPU Device / Device Initialization}
+\item \ref{devicenormative:Device Types / GPU Device / Device Operation / Device Operation: Command lifecycle and fencing}
+\end{itemize}
device-types/virtio-gpu/device.tex renamed from virtio-gpu.tex +0 -0
similarity index 100%
rename from virtio-gpu.tex
rename to device-types/virtio-gpu/device.tex
Signature · 1 line
2.26.2
#9 lore raw

PATCH v2 9/20 virtio-input: Maintain input device spec in separate directory

In reply to Parav Pandit

Move virtio input device specification to its own file similar to recent virtio devices.
While at it, place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v0->v1:
- moved to device specific directory

---
 conformance.tex                               | 20 ++-----------------
 content.tex                                   |  2 +-
 .../virtio-input/device-conformance.tex       |  8 ++++++++
 .../virtio-input/device.tex                   |  0
 .../virtio-input/driver-conformance.tex       |  8 ++++++++
 5 files changed, 19 insertions(+), 19 deletions(-)
 create mode 100644 device-types/virtio-input/device-conformance.tex
 rename virtio-input.tex => device-types/virtio-input/device.tex (100%)
 create mode 100644 device-types/virtio-input/driver-conformance.tex
conformance.tex +2 -18
index 432b03c..8470e52 100644
@@ -140,15 +140,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-entropy/}{driver-conformance}
 \import{device-types/virtio-mem-balloon/}{driver-conformance}
 \import{device-types/virtio-scsi/}{driver-conformance}
-
-\conformance{\subsection}{Input Driver Conformance}\label{sec:Conformance / Driver Conformance / Input Driver Conformance}
-
-An input driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / Input Device / Device Initialization}
-\item \ref{drivernormative:Device Types / Input Device / Device Operation}
-\end{itemize}
+\import{device-types/virtio-input/}{driver-conformance}
 
 \conformance{\subsection}{Crypto Driver Conformance}\label{sec:Conformance / Driver Conformance / Crypto Driver Conformance}
 
@@ -348,15 +340,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-mem-balloon/}{device-conformance}
 \import{device-types/virtio-scsi/}{device-conformance}
 \import{device-types/virtio-gpu/}{device-conformance}
-
-\conformance{\subsection}{Input Device Conformance}\label{sec:Conformance / Device Conformance / Input Device Conformance}
-
-An input device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / Input Device / Device Initialization}
-\item \ref{devicenormative:Device Types / Input Device / Device Operation}
-\end{itemize}
+\import{device-types/virtio-input/}{device-conformance}
 
 \conformance{\subsection}{Crypto Device Conformance}\label{sec:Conformance / Device Conformance / Crypto Device Conformance}
 
content.tex +1 -1
index 4f16ad8..b1d8474 100644
@@ -3010,7 +3010,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \import{device-types/virtio-mem-balloon/}{device}
 \import{device-types/virtio-scsi/}{device}
 \import{device-types/virtio-gpu/}{device}
-\input{virtio-input.tex}
+\import{device-types/virtio-input/}{device}
 \input{virtio-crypto.tex}
 \input{virtio-vsock.tex}
 \input{virtio-fs.tex}
device-types/virtio-input/device-conformance.tex new file +8 -0
new file mode 100644
index 0000000..173cdd6
@@ -0,0 +1,8 @@
+\conformance{\subsection}{Input Device Conformance}\label{sec:Conformance / Device Conformance / Input Device Conformance}
+
+An input device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / Input Device / Device Initialization}
+\item \ref{devicenormative:Device Types / Input Device / Device Operation}
+\end{itemize}
device-types/virtio-input/device.tex renamed from virtio-input.tex +0 -0
similarity index 100%
rename from virtio-input.tex
rename to device-types/virtio-input/device.tex
device-types/virtio-input/driver-conformance.tex new file +8 -0
new file mode 100644
index 0000000..5eb9dac
@@ -0,0 +1,8 @@
+\conformance{\subsection}{Input Driver Conformance}\label{sec:Conformance / Driver Conformance / Input Driver Conformance}
+
+An input driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / Input Device / Device Initialization}
+\item \ref{drivernormative:Device Types / Input Device / Device Operation}
+\end{itemize}
Signature · 1 line
2.26.2
#10 lore raw

PATCH v2 10/20 virtio-crypto: Maintain crypto device spec in separate directory

In reply to Parav Pandit

Move virtio crypto device specification to its own file similar to recent virtio devices.
While at it, place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v0->v1:
- moved to device specific directory

---
 conformance.tex                               | 31 ++-----------------
 content.tex                                   |  2 +-
 .../virtio-crypto/device-conformance.tex      | 13 ++++++++
 .../virtio-crypto/device.tex                  |  0
 .../virtio-crypto/driver-conformance.tex      | 14 +++++++++
 5 files changed, 30 insertions(+), 30 deletions(-)
 create mode 100644 device-types/virtio-crypto/device-conformance.tex
 rename virtio-crypto.tex => device-types/virtio-crypto/device.tex (100%)
 create mode 100644 device-types/virtio-crypto/driver-conformance.tex
conformance.tex +2 -29
index 8470e52..67b7523 100644
@@ -141,21 +141,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-mem-balloon/}{driver-conformance}
 \import{device-types/virtio-scsi/}{driver-conformance}
 \import{device-types/virtio-input/}{driver-conformance}
-
-\conformance{\subsection}{Crypto Driver Conformance}\label{sec:Conformance / Driver Conformance / Crypto Driver Conformance}
-
-A Crypto driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / Crypto Device / Device configuration layout}
-\item \ref{drivernormative:Device Types / Crypto Device / Device Initialization}
-\item \ref{drivernormative:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation / Session operation: create session}
-\item \ref{drivernormative:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation / Session operation: destroy session}
-\item \ref{drivernormative:Device Types / Crypto Device / Device Operation / HASH Service Operation}
-\item \ref{drivernormative:Device Types / Crypto Device / Device Operation / MAC Service Operation}
-\item \ref{drivernormative:Device Types / Crypto Device / Device Operation / Symmetric algorithms Operation}
-\item \ref{drivernormative:Device Types / Crypto Device / Device Operation / AEAD Service Operation}
-\end{itemize}
+\import{device-types/virtio-crypto/}{driver-conformance}
 
 \conformance{\subsection}{Socket Driver Conformance}\label{sec:Conformance / Driver Conformance / Socket Driver Conformance}
 
@@ -341,20 +327,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-scsi/}{device-conformance}
 \import{device-types/virtio-gpu/}{device-conformance}
 \import{device-types/virtio-input/}{device-conformance}
-
-\conformance{\subsection}{Crypto Device Conformance}\label{sec:Conformance / Device Conformance / Crypto Device Conformance}
-
-A Crypto device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / Crypto Device / Device configuration layout}
-\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation / Session operation: create session}
-\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation / Session operation: destroy session}
-\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / HASH Service Operation}
-\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / MAC Service Operation}
-\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / Symmetric algorithms Operation}
-\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / AEAD Service Operation}
-\end{itemize}
+\import{device-types/virtio-crypto/}{device-conformance}
 
 \conformance{\subsection}{Socket Device Conformance}\label{sec:Conformance / Device Conformance / Socket Device Conformance}
 
content.tex +1 -1
index b1d8474..3d0cba0 100644
@@ -3011,7 +3011,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \import{device-types/virtio-scsi/}{device}
 \import{device-types/virtio-gpu/}{device}
 \import{device-types/virtio-input/}{device}
-\input{virtio-crypto.tex}
+\import{device-types/virtio-crypto/}{device}
 \input{virtio-vsock.tex}
 \input{virtio-fs.tex}
 \input{virtio-rpmb.tex}
device-types/virtio-crypto/device-conformance.tex new file +13 -0
new file mode 100644
index 0000000..1667120
@@ -0,0 +1,13 @@
+\conformance{\subsection}{Crypto Device Conformance}\label{sec:Conformance / Device Conformance / Crypto Device Conformance}
+
+A Crypto device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / Crypto Device / Device configuration layout}
+\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation / Session operation: create session}
+\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation / Session operation: destroy session}
+\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / HASH Service Operation}
+\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / MAC Service Operation}
+\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / Symmetric algorithms Operation}
+\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / AEAD Service Operation}
+\end{itemize}
device-types/virtio-crypto/device.tex renamed from virtio-crypto.tex +0 -0
similarity index 100%
rename from virtio-crypto.tex
rename to device-types/virtio-crypto/device.tex
device-types/virtio-crypto/driver-conformance.tex new file +14 -0
new file mode 100644
index 0000000..672d0f6
@@ -0,0 +1,14 @@
+\conformance{\subsection}{Crypto Driver Conformance}\label{sec:Conformance / Driver Conformance / Crypto Driver Conformance}
+
+A Crypto driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / Crypto Device / Device configuration layout}
+\item \ref{drivernormative:Device Types / Crypto Device / Device Initialization}
+\item \ref{drivernormative:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation / Session operation: create session}
+\item \ref{drivernormative:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation / Session operation: destroy session}
+\item \ref{drivernormative:Device Types / Crypto Device / Device Operation / HASH Service Operation}
+\item \ref{drivernormative:Device Types / Crypto Device / Device Operation / MAC Service Operation}
+\item \ref{drivernormative:Device Types / Crypto Device / Device Operation / Symmetric algorithms Operation}
+\item \ref{drivernormative:Device Types / Crypto Device / Device Operation / AEAD Service Operation}
+\end{itemize}
Signature · 1 line
2.26.2
#11 lore raw

PATCH v2 11/20 virtio-vsock: Maintain socket device spec in separate directory

In reply to Parav Pandit

Place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v0->v1:
- new patch

---
 conformance.tex                               | 23 ++-----------------
 content.tex                                   |  2 +-
 .../virtio-vsock/device-conformance.tex       |  9 ++++++++
 .../virtio-vsock/device.tex                   |  0
 .../virtio-vsock/driver-conformance.tex       | 10 ++++++++
 5 files changed, 22 insertions(+), 22 deletions(-)
 create mode 100644 device-types/virtio-vsock/device-conformance.tex
 rename virtio-vsock.tex => device-types/virtio-vsock/device.tex (100%)
 create mode 100644 device-types/virtio-vsock/driver-conformance.tex
conformance.tex +2 -21
index 67b7523..5f63bfb 100644
@@ -142,17 +142,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-scsi/}{driver-conformance}
 \import{device-types/virtio-input/}{driver-conformance}
 \import{device-types/virtio-crypto/}{driver-conformance}
-
-\conformance{\subsection}{Socket Driver Conformance}\label{sec:Conformance / Driver Conformance / Socket Driver Conformance}
-
-A socket driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / Socket Device / Feature bits}
-\item \ref{drivernormative:Device Types / Socket Device / Device Operation / Buffer Space Management}
-\item \ref{drivernormative:Device Types / Socket Device / Device Operation / Receive and Transmit}
-\item \ref{drivernormative:Device Types / Socket Device / Device Operation / Device Events}
-\end{itemize}
+\import{device-types/virtio-vsock/}{driver-conformance}
 
 \conformance{\subsection}{File System Driver Conformance}\label{sec:Conformance / Driver Conformance / File System Driver Conformance}
 
@@ -328,16 +318,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-gpu/}{device-conformance}
 \import{device-types/virtio-input/}{device-conformance}
 \import{device-types/virtio-crypto/}{device-conformance}
-
-\conformance{\subsection}{Socket Device Conformance}\label{sec:Conformance / Device Conformance / Socket Device Conformance}
-
-A socket device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / Socket Device / Feature bits}
-\item \ref{devicenormative:Device Types / Socket Device / Device Operation / Buffer Space Management}
-\item \ref{devicenormative:Device Types / Socket Device / Device Operation / Receive and Transmit}
-\end{itemize}
+\import{device-types/virtio-vsock/}{device-conformance}
 
 \conformance{\subsection}{File System Device Conformance}\label{sec:Conformance / Device Conformance / File System Device Conformance}
 
content.tex +1 -1
index 3d0cba0..1cee4c4 100644
@@ -3012,7 +3012,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \import{device-types/virtio-gpu/}{device}
 \import{device-types/virtio-input/}{device}
 \import{device-types/virtio-crypto/}{device}
-\input{virtio-vsock.tex}
+\import{device-types/virtio-vsock/}{device}
 \input{virtio-fs.tex}
 \input{virtio-rpmb.tex}
 \input{virtio-iommu.tex}
device-types/virtio-vsock/device-conformance.tex new file +9 -0
new file mode 100644
index 0000000..93b0c4d
@@ -0,0 +1,9 @@
+\conformance{\subsection}{Socket Device Conformance}\label{sec:Conformance / Device Conformance / Socket Device Conformance}
+
+A socket device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / Socket Device / Feature bits}
+\item \ref{devicenormative:Device Types / Socket Device / Device Operation / Buffer Space Management}
+\item \ref{devicenormative:Device Types / Socket Device / Device Operation / Receive and Transmit}
+\end{itemize}
device-types/virtio-vsock/device.tex renamed from virtio-vsock.tex +0 -0
similarity index 100%
rename from virtio-vsock.tex
rename to device-types/virtio-vsock/device.tex
device-types/virtio-vsock/driver-conformance.tex new file +10 -0
new file mode 100644
index 0000000..988b0c3
@@ -0,0 +1,10 @@
+\conformance{\subsection}{Socket Driver Conformance}\label{sec:Conformance / Driver Conformance / Socket Driver Conformance}
+
+A socket driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / Socket Device / Feature bits}
+\item \ref{drivernormative:Device Types / Socket Device / Device Operation / Buffer Space Management}
+\item \ref{drivernormative:Device Types / Socket Device / Device Operation / Receive and Transmit}
+\item \ref{drivernormative:Device Types / Socket Device / Device Operation / Device Events}
+\end{itemize}
Signature · 1 line
2.26.2
#12 lore raw

PATCH v2 12/20 virtio-fs: Maintain file system device spec in separate directory

In reply to Parav Pandit

Place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v0->v1:
- new patch

---
 conformance.tex                               | 23 ++-----------------
 content.tex                                   |  2 +-
 device-types/virtio-fs/device-conformance.tex |  9 ++++++++
 .../virtio-fs/device.tex                      |  0
 device-types/virtio-fs/driver-conformance.tex | 10 ++++++++
 5 files changed, 22 insertions(+), 22 deletions(-)
 create mode 100644 device-types/virtio-fs/device-conformance.tex
 rename virtio-fs.tex => device-types/virtio-fs/device.tex (100%)
 create mode 100644 device-types/virtio-fs/driver-conformance.tex
conformance.tex +2 -21
index 5f63bfb..56a2c16 100644
@@ -143,17 +143,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-input/}{driver-conformance}
 \import{device-types/virtio-crypto/}{driver-conformance}
 \import{device-types/virtio-vsock/}{driver-conformance}
-
-\conformance{\subsection}{File System Driver Conformance}\label{sec:Conformance / Driver Conformance / File System Driver Conformance}
-
-A file system driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / File System Device / Device configuration layout}
-\item \ref{drivernormative:Device Types / File System Device / Device Operation / Device Operation: High Priority Queue}
-\item \ref{drivernormative:Device Types / File System Device / Device Operation / Device Operation: Notification Queue}
-\item \ref{drivernormative:Device Types / File System Device / Device Operation / Device Operation: DAX Window}
-\end{itemize}
+\import{device-types/virtio-fs/}{driver-conformance}
 
 \conformance{\subsection}{RPMB Driver Conformance}\label{sec:Conformance / Driver Conformance / RPMB Driver Conformance}
 
@@ -319,16 +309,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-input/}{device-conformance}
 \import{device-types/virtio-crypto/}{device-conformance}
 \import{device-types/virtio-vsock/}{device-conformance}
-
-\conformance{\subsection}{File System Device Conformance}\label{sec:Conformance / Device Conformance / File System Device Conformance}
-
-A file system device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / File System Device / Device configuration layout}
-\item \ref{devicenormative:Device Types / File System Device / Device Operation / Device Operation: High Priority Queue}
-\item \ref{devicenormative:Device Types / File System Device / Device Operation / Device Operation: DAX Window}
-\end{itemize}
+\import{device-types/virtio-fs/}{device-conformance}
 
 \conformance{\subsection}{RPMB Device Conformance}\label{sec:Conformance / Device Conformance / RPMB Device Conformance}
 
content.tex +1 -1
index 1cee4c4..a486e36 100644
@@ -3013,7 +3013,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \import{device-types/virtio-input/}{device}
 \import{device-types/virtio-crypto/}{device}
 \import{device-types/virtio-vsock/}{device}
-\input{virtio-fs.tex}
+\import{device-types/virtio-fs/}{device}
 \input{virtio-rpmb.tex}
 \input{virtio-iommu.tex}
 \input{virtio-sound.tex}
device-types/virtio-fs/device-conformance.tex new file +9 -0
new file mode 100644
index 0000000..a86245e
@@ -0,0 +1,9 @@
+\conformance{\subsection}{File System Device Conformance}\label{sec:Conformance / Device Conformance / File System Device Conformance}
+
+A file system device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / File System Device / Device configuration layout}
+\item \ref{devicenormative:Device Types / File System Device / Device Operation / Device Operation: High Priority Queue}
+\item \ref{devicenormative:Device Types / File System Device / Device Operation / Device Operation: DAX Window}
+\end{itemize}
device-types/virtio-fs/device.tex renamed from virtio-fs.tex +0 -0
similarity index 100%
rename from virtio-fs.tex
rename to device-types/virtio-fs/device.tex
device-types/virtio-fs/driver-conformance.tex new file +10 -0
new file mode 100644
index 0000000..5a762ec
@@ -0,0 +1,10 @@
+\conformance{\subsection}{File System Driver Conformance}\label{sec:Conformance / Driver Conformance / File System Driver Conformance}
+
+A file system driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / File System Device / Device configuration layout}
+\item \ref{drivernormative:Device Types / File System Device / Device Operation / Device Operation: High Priority Queue}
+\item \ref{drivernormative:Device Types / File System Device / Device Operation / Device Operation: Notification Queue}
+\item \ref{drivernormative:Device Types / File System Device / Device Operation / Device Operation: DAX Window}
+\end{itemize}
Signature · 1 line
2.26.2
#13 lore raw

PATCH v2 13/20 virtio-rpmb: Maintain rpmb device spec in separate directory

In reply to Parav Pandit

Place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v1->v2:
- added missing device conformance reference entry v0->v1:
- new patch

---
 conformance.tex                               | 23 ++-----------------
 content.tex                                   |  2 +-
 .../virtio-rpmb/device-conformance.tex        | 13 +++++++++++
 .../virtio-rpmb/device.tex                    |  0
 .../virtio-rpmb/driver-conformance.tex        |  7 ++++++
 5 files changed, 23 insertions(+), 22 deletions(-)
 create mode 100644 device-types/virtio-rpmb/device-conformance.tex
 rename virtio-rpmb.tex => device-types/virtio-rpmb/device.tex (100%)
 create mode 100644 device-types/virtio-rpmb/driver-conformance.tex
conformance.tex +2 -21
index 56a2c16..c109fbd 100644
@@ -144,14 +144,8 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-crypto/}{driver-conformance}
 \import{device-types/virtio-vsock/}{driver-conformance}
 \import{device-types/virtio-fs/}{driver-conformance}
+\import{device-types/virtio-rpmb/}{driver-conformance}
 
-\conformance{\subsection}{RPMB Driver Conformance}\label{sec:Conformance / Driver Conformance / RPMB Driver Conformance}
-
-A RPMB driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / RPMB Device / Device Operation}
-\end{itemize}
 \conformance{\subsection}{IOMMU Driver Conformance}\label{sec:Conformance / Driver Conformance / IOMMU Driver Conformance}
 
 An IOMMU driver MUST conform to the following normative statements:
@@ -310,20 +304,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-crypto/}{device-conformance}
 \import{device-types/virtio-vsock/}{device-conformance}
 \import{device-types/virtio-fs/}{device-conformance}
-
-\conformance{\subsection}{RPMB Device Conformance}\label{sec:Conformance / Device Conformance / RPMB Device Conformance}
-
-An RPMB device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / RPMB Device / Device Initialization}
-\item \ref{devicenormative:Device Types / RPMB Device / Device Operation / Device Operation: Program Key}
-\item \ref{devicenormative:Device Types / RPMB Device / Device Operation / Device Operation: Get Write Counter}
-\item \ref{devicenormative:Device Types / RPMB Device / Device Operation / Device Operation: Data Write}
-\item \ref{devicenormative:Device Types / RPMB Device / Device Operation / Device Operation: Data Read}
-\item \ref{devicenormative:Device Types / RPMB Device / Device Operation / Device Operation: Result Read}
-\item \ref{devicenormative:Device Types / RPMB Device / Device Operation}
-\end{itemize}
+\import{device-types/virtio-rpmb/}{device-conformance}
 
 \conformance{\subsection}{IOMMU Device Conformance}\label{sec:Conformance / Device Conformance / IOMMU Device Conformance}
 
content.tex +1 -1
index a486e36..0150e3f 100644
@@ -3014,7 +3014,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \import{device-types/virtio-crypto/}{device}
 \import{device-types/virtio-vsock/}{device}
 \import{device-types/virtio-fs/}{device}
-\input{virtio-rpmb.tex}
+\import{device-types/virtio-rpmb/}{device}
 \input{virtio-iommu.tex}
 \input{virtio-sound.tex}
 \input{virtio-mem.tex}
device-types/virtio-rpmb/device-conformance.tex new file +13 -0
new file mode 100644
index 0000000..4a01e5a
@@ -0,0 +1,13 @@
+\conformance{\subsection}{RPMB Device Conformance}\label{sec:Conformance / Device Conformance / RPMB Device Conformance}
+
+An RPMB device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / RPMB Device / Device Initialization}
+\item \ref{devicenormative:Device Types / RPMB Device / Device Operation / Device Operation: Program Key}
+\item \ref{devicenormative:Device Types / RPMB Device / Device Operation / Device Operation: Get Write Counter}
+\item \ref{devicenormative:Device Types / RPMB Device / Device Operation / Device Operation: Data Write}
+\item \ref{devicenormative:Device Types / RPMB Device / Device Operation / Device Operation: Data Read}
+\item \ref{devicenormative:Device Types / RPMB Device / Device Operation / Device Operation: Result Read}
+\item \ref{devicenormative:Device Types / RPMB Device / Device Operation}
+\end{itemize}
device-types/virtio-rpmb/device.tex renamed from virtio-rpmb.tex +0 -0
similarity index 100%
rename from virtio-rpmb.tex
rename to device-types/virtio-rpmb/device.tex
device-types/virtio-rpmb/driver-conformance.tex new file +7 -0
new file mode 100644
index 0000000..0cdddac
@@ -0,0 +1,7 @@
+\conformance{\subsection}{RPMB Driver Conformance}\label{sec:Conformance / Driver Conformance / RPMB Driver Conformance}
+
+A RPMB driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / RPMB Device / Device Operation}
+\end{itemize}
Signature · 1 line
2.26.2
#14 lore raw

PATCH v2 14/20 virtio-iommu: Maintain iommu device spec in separate directory

In reply to Parav Pandit

Place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v1->v2:
- rebased
v0->v1:
- new patch

---
 conformance.tex                               | 37 +------------------
 content.tex                                   |  2 +-
 .../virtio-iommu/device-conformance.tex       | 16 ++++++++
 .../virtio-iommu/device.tex                   |  0
 .../virtio-iommu/driver-conformance.tex       | 17 +++++++++
 5 files changed, 36 insertions(+), 36 deletions(-)
 create mode 100644 device-types/virtio-iommu/device-conformance.tex
 rename virtio-iommu.tex => device-types/virtio-iommu/device.tex (100%)
 create mode 100644 device-types/virtio-iommu/driver-conformance.tex
conformance.tex +2 -35
index c109fbd..88ae166 100644
@@ -145,24 +145,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-vsock/}{driver-conformance}
 \import{device-types/virtio-fs/}{driver-conformance}
 \import{device-types/virtio-rpmb/}{driver-conformance}
-
-\conformance{\subsection}{IOMMU Driver Conformance}\label{sec:Conformance / Driver Conformance / IOMMU Driver Conformance}
-
-An IOMMU driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / IOMMU Device / Feature bits}
-\item \ref{drivernormative:Device Types / IOMMU Device / Device configuration layout}
-\item \ref{drivernormative:Device Types / IOMMU Device / Device Initialization}
-\item \ref{drivernormative:Device Types / IOMMU Device / Device operations}
-\item \ref{drivernormative:Device Types / IOMMU Device / Device operations / ATTACH request}
-\item \ref{drivernormative:Device Types / IOMMU Device / Device operations / DETACH request}
-\item \ref{drivernormative:Device Types / IOMMU Device / Device operations / MAP request}
-\item \ref{drivernormative:Device Types / IOMMU Device / Device operations / UNMAP request}
-\item \ref{drivernormative:Device Types / IOMMU Device / Device operations / PROBE request}
-\item \ref{drivernormative:Device Types / IOMMU Device / Device operations / PROBE properties / RESVMEM}
-\item \ref{drivernormative:Device Types / IOMMU Device / Device operations / Fault reporting}
-\end{itemize}
+\import{device-types/virtio-iommu/}{driver-conformance}
 
 \conformance{\subsection}{Sound Driver Conformance}\label{sec:Conformance / Driver Conformance / Sound Driver Conformance}
 
@@ -305,23 +288,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-vsock/}{device-conformance}
 \import{device-types/virtio-fs/}{device-conformance}
 \import{device-types/virtio-rpmb/}{device-conformance}
-
-\conformance{\subsection}{IOMMU Device Conformance}\label{sec:Conformance / Device Conformance / IOMMU Device Conformance}
-
-An IOMMU device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / IOMMU Device / Feature bits}
-\item \ref{devicenormative:Device Types / IOMMU Device / Device configuration layout}
-\item \ref{devicenormative:Device Types / IOMMU Device / Device operations}
-\item \ref{devicenormative:Device Types / IOMMU Device / Device operations / ATTACH request}
-\item \ref{devicenormative:Device Types / IOMMU Device / Device operations / DETACH request}
-\item \ref{devicenormative:Device Types / IOMMU Device / Device operations / MAP request}
-\item \ref{devicenormative:Device Types / IOMMU Device / Device operations / UNMAP request}
-\item \ref{devicenormative:Device Types / IOMMU Device / Device operations / PROBE request}
-\item \ref{devicenormative:Device Types / IOMMU Device / Device operations / PROBE properties / RESVMEM}
-\item \ref{devicenormative:Device Types / IOMMU Device / Device operations / Fault reporting}
-\end{itemize}
+\import{device-types/virtio-iommu/}{device-conformance}
 
 \conformance{\subsection}{Sound Device Conformance}\label{sec:Conformance / Device Conformance / Sound Device Conformance}
 
content.tex +1 -1
index 0150e3f..dfc8967 100644
@@ -3015,7 +3015,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \import{device-types/virtio-vsock/}{device}
 \import{device-types/virtio-fs/}{device}
 \import{device-types/virtio-rpmb/}{device}
-\input{virtio-iommu.tex}
+\import{device-types/virtio-iommu/}{device}
 \input{virtio-sound.tex}
 \input{virtio-mem.tex}
 \input{virtio-i2c.tex}
device-types/virtio-iommu/device-conformance.tex new file +16 -0
new file mode 100644
index 0000000..bc5b3b8
@@ -0,0 +1,16 @@
+\conformance{\subsection}{IOMMU Device Conformance}\label{sec:Conformance / Device Conformance / IOMMU Device Conformance}
+
+An IOMMU device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / IOMMU Device / Feature bits}
+\item \ref{devicenormative:Device Types / IOMMU Device / Device configuration layout}
+\item \ref{devicenormative:Device Types / IOMMU Device / Device operations}
+\item \ref{devicenormative:Device Types / IOMMU Device / Device operations / ATTACH request}
+\item \ref{devicenormative:Device Types / IOMMU Device / Device operations / DETACH request}
+\item \ref{devicenormative:Device Types / IOMMU Device / Device operations / MAP request}
+\item \ref{devicenormative:Device Types / IOMMU Device / Device operations / UNMAP request}
+\item \ref{devicenormative:Device Types / IOMMU Device / Device operations / PROBE request}
+\item \ref{devicenormative:Device Types / IOMMU Device / Device operations / PROBE properties / RESVMEM}
+\item \ref{devicenormative:Device Types / IOMMU Device / Device operations / Fault reporting}
+\end{itemize}
device-types/virtio-iommu/device.tex renamed from virtio-iommu.tex +0 -0
similarity index 100%
rename from virtio-iommu.tex
rename to device-types/virtio-iommu/device.tex
device-types/virtio-iommu/driver-conformance.tex new file +17 -0
new file mode 100644
index 0000000..0c7bf91
@@ -0,0 +1,17 @@
+\conformance{\subsection}{IOMMU Driver Conformance}\label{sec:Conformance / Driver Conformance / IOMMU Driver Conformance}
+
+An IOMMU driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / IOMMU Device / Feature bits}
+\item \ref{drivernormative:Device Types / IOMMU Device / Device configuration layout}
+\item \ref{drivernormative:Device Types / IOMMU Device / Device Initialization}
+\item \ref{drivernormative:Device Types / IOMMU Device / Device operations}
+\item \ref{drivernormative:Device Types / IOMMU Device / Device operations / ATTACH request}
+\item \ref{drivernormative:Device Types / IOMMU Device / Device operations / DETACH request}
+\item \ref{drivernormative:Device Types / IOMMU Device / Device operations / MAP request}
+\item \ref{drivernormative:Device Types / IOMMU Device / Device operations / UNMAP request}
+\item \ref{drivernormative:Device Types / IOMMU Device / Device operations / PROBE request}
+\item \ref{drivernormative:Device Types / IOMMU Device / Device operations / PROBE properties / RESVMEM}
+\item \ref{drivernormative:Device Types / IOMMU Device / Device operations / Fault reporting}
+\end{itemize}
Signature · 1 line
2.26.2
#15 lore raw

PATCH v2 15/20 virtio-sound: Maintain sound device spec in separate directory

In reply to Parav Pandit

Place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v1->v2:
- added missing device conformance reference
v0->v1:
- new patch

---
 conformance.tex                               | 33 ++-----------------
 content.tex                                   |  2 +-
 .../virtio-sound/device-conformance.tex       | 16 +++++++++
 .../virtio-sound/device.tex                   |  0
 .../virtio-sound/driver-conformance.tex       | 13 ++++++++
 5 files changed, 32 insertions(+), 32 deletions(-)
 create mode 100644 device-types/virtio-sound/device-conformance.tex
 rename virtio-sound.tex => device-types/virtio-sound/device.tex (100%)
 create mode 100644 device-types/virtio-sound/driver-conformance.tex
conformance.tex +2 -31
index 88ae166..6f465a3 100644
@@ -146,20 +146,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-fs/}{driver-conformance}
 \import{device-types/virtio-rpmb/}{driver-conformance}
 \import{device-types/virtio-iommu/}{driver-conformance}
-
-\conformance{\subsection}{Sound Driver Conformance}\label{sec:Conformance / Driver Conformance / Sound Driver Conformance}
-
-A sound driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / Sound Device / Device Initialization}
-\item \ref{drivernormative:Device Types / Sound Device / Item Information Request}
-\item \ref{drivernormative:Device Types / Sound Device / Device Operation / PCM Stream Parameters}
-\item \ref{drivernormative:Device Types / Sound Device / Device Operation / PCM Output Stream}
-\item \ref{drivernormative:Device Types / Sound Device / Device Operation / PCM Input Stream}
-\item \ref{drivernormative:Device Types / Sound Device / Device Operation / Control Element Value}
-\item \ref{drivernormative:Device Types / Sound Device / Device Operation / Control Element Metadata}
-\end{itemize}
+\import{device-types/virtio-sound/}{driver-conformance}
 
 \conformance{\subsection}{Memory Driver Conformance}\label{sec:Conformance / Driver Conformance / Memory Driver Conformance}
 
@@ -289,23 +276,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-fs/}{device-conformance}
 \import{device-types/virtio-rpmb/}{device-conformance}
 \import{device-types/virtio-iommu/}{device-conformance}
-
-\conformance{\subsection}{Sound Device Conformance}\label{sec:Conformance / Device Conformance / Sound Device Conformance}
-
-A sound device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / Sound Device / Device Operation / Jack Information}
-\item \ref{devicenormative:Device Types / Sound Device / Device Operation / PCM Stream Information}
-\item \ref{devicenormative:Device Types / Sound Device / Device Operation / PCM Stream Parameters}
-\item \ref{devicenormative:Device Types / Sound Device / Device Operation / PCM Stream Release}
-\item \ref{devicenormative:Device Types / Sound Device / Device Operation / PCM Output Stream}
-\item \ref{devicenormative:Device Types / Sound Device / Device Operation / PCM Input Stream}
-\item \ref{devicenormative:Device Types / Sound Device / Device Operation / Channel Map Information}
-\item \ref{devicenormative:Device Types / Sound Device / Device Operation / Control Element Information}
-\item \ref{devicenormative:Device Types / Sound Device / Device Operation / Control Element Metadata}
-\item \ref{devicenormative:Device Types / Sound Device / Device Operation / Control Element Notifications}
-\end{itemize}
+\import{device-types/virtio-sound/}{device-conformance}
 
 \conformance{\subsection}{Memory Device Conformance}\label{sec:Conformance / Device Conformance / Memory Device Conformance}
 
content.tex +1 -1
index dfc8967..65d8532 100644
@@ -3016,7 +3016,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \import{device-types/virtio-fs/}{device}
 \import{device-types/virtio-rpmb/}{device}
 \import{device-types/virtio-iommu/}{device}
-\input{virtio-sound.tex}
+\import{device-types/virtio-sound/}{device}
 \input{virtio-mem.tex}
 \input{virtio-i2c.tex}
 \input{virtio-scmi.tex}
device-types/virtio-sound/device-conformance.tex new file +16 -0
new file mode 100644
index 0000000..7b900c2
@@ -0,0 +1,16 @@
+\conformance{\subsection}{Sound Device Conformance}\label{sec:Conformance / Device Conformance / Sound Device Conformance}
+
+A sound device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / Sound Device / Device Operation / Jack Information}
+\item \ref{devicenormative:Device Types / Sound Device / Device Operation / PCM Stream Information}
+\item \ref{devicenormative:Device Types / Sound Device / Device Operation / PCM Stream Parameters}
+\item \ref{devicenormative:Device Types / Sound Device / Device Operation / PCM Stream Release}
+\item \ref{devicenormative:Device Types / Sound Device / Device Operation / PCM Output Stream}
+\item \ref{devicenormative:Device Types / Sound Device / Device Operation / PCM Input Stream}
+\item \ref{devicenormative:Device Types / Sound Device / Device Operation / Channel Map Information}
+\item \ref{devicenormative:Device Types / Sound Device / Device Operation / Control Element Information}
+\item \ref{devicenormative:Device Types / Sound Device / Device Operation / Control Element Metadata}
+\item \ref{devicenormative:Device Types / Sound Device / Device Operation / Control Element Notifications}
+\end{itemize}
device-types/virtio-sound/device.tex renamed from virtio-sound.tex +0 -0
similarity index 100%
rename from virtio-sound.tex
rename to device-types/virtio-sound/device.tex
device-types/virtio-sound/driver-conformance.tex new file +13 -0
new file mode 100644
index 0000000..9a910cd
@@ -0,0 +1,13 @@
+\conformance{\subsection}{Sound Driver Conformance}\label{sec:Conformance / Driver Conformance / Sound Driver Conformance}
+
+A sound driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / Sound Device / Device Initialization}
+\item \ref{drivernormative:Device Types / Sound Device / Item Information Request}
+\item \ref{drivernormative:Device Types / Sound Device / Device Operation / PCM Stream Parameters}
+\item \ref{drivernormative:Device Types / Sound Device / Device Operation / PCM Output Stream}
+\item \ref{drivernormative:Device Types / Sound Device / Device Operation / PCM Input Stream}
+\item \ref{drivernormative:Device Types / Sound Device / Device Operation / Control Element Value}
+\item \ref{drivernormative:Device Types / Sound Device / Device Operation / Control Element Metadata}
+\end{itemize}
Signature · 1 line
2.26.2
#16 lore raw

PATCH v2 16/20 virtio-mem: Maintain memory device spec in separate directory

In reply to Parav Pandit

Place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v1->v2:
- rebased
v0->v1:
- new patch

---
 conformance.tex                               | 30 ++-----------------
 content.tex                                   |  2 +-
 .../virtio-mem/device-conformance.tex         | 13 ++++++++
 .../virtio-mem/device.tex                     |  0
 .../virtio-mem/driver-conformance.tex         | 13 ++++++++
 5 files changed, 29 insertions(+), 29 deletions(-)
 create mode 100644 device-types/virtio-mem/device-conformance.tex
 rename virtio-mem.tex => device-types/virtio-mem/device.tex (100%)
 create mode 100644 device-types/virtio-mem/driver-conformance.tex
conformance.tex +2 -28
index 6f465a3..c43e8db 100644
@@ -147,20 +147,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-rpmb/}{driver-conformance}
 \import{device-types/virtio-iommu/}{driver-conformance}
 \import{device-types/virtio-sound/}{driver-conformance}
-
-\conformance{\subsection}{Memory Driver Conformance}\label{sec:Conformance / Driver Conformance / Memory Driver Conformance}
-
-A memory driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / Memory Device / Device configuration layout}
-\item \ref{drivernormative:Device Types / Memory Device / Device Initialization}
-\item \ref{drivernormative:Device Types / Memory Device / Device Operation}
-\item \ref{drivernormative:Device Types / Memory Device / Device Operation / PLUG request}
-\item \ref{drivernormative:Device Types / Memory Device / Device Operation / UNPLUG request}
-\item \ref{drivernormative:Device Types / Memory Device / Device Operation / UNPLUG ALL request}
-\item \ref{drivernormative:Device Types / Memory Device / Device Operation / STATE request}
-\end{itemize}
+\import{device-types/virtio-mem/}{driver-conformance}
 
 \conformance{\subsection}{I2C Adapter Driver Conformance}\label{sec:Conformance / Driver Conformance / I2C Adapter Driver Conformance}
 
@@ -277,20 +264,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-rpmb/}{device-conformance}
 \import{device-types/virtio-iommu/}{device-conformance}
 \import{device-types/virtio-sound/}{device-conformance}
-
-\conformance{\subsection}{Memory Device Conformance}\label{sec:Conformance / Device Conformance / Memory Device Conformance}
-
-A memory device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / Memory Device / Device configuration layout}
-\item \ref{devicenormative:Device Types / Memory Device / Device Initialization}
-\item \ref{devicenormative:Device Types / Memory Device / Device Operation}
-\item \ref{devicenormative:Device Types / Memory Device / Device Operation / PLUG request}
-\item \ref{devicenormative:Device Types / Memory Device / Device Operation / UNPLUG request}
-\item \ref{devicenormative:Device Types / Memory Device / Device Operation / UNPLUG ALL request}
-\item \ref{devicenormative:Device Types / Memory Device / Device Operation / STATE request}
-\end{itemize}
+\import{device-types/virtio-mem/}{device-conformance}
 
 \conformance{\subsection}{I2C Adapter Device Conformance}\label{sec:Conformance / Device Conformance / I2C Adapter Device Conformance}
 
content.tex +1 -1
index 65d8532..6466209 100644
@@ -3017,7 +3017,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \import{device-types/virtio-rpmb/}{device}
 \import{device-types/virtio-iommu/}{device}
 \import{device-types/virtio-sound/}{device}
-\input{virtio-mem.tex}
+\import{device-types/virtio-mem/}{device}
 \input{virtio-i2c.tex}
 \input{virtio-scmi.tex}
 \input{virtio-gpio.tex}
device-types/virtio-mem/device-conformance.tex new file +13 -0
new file mode 100644
index 0000000..562d00b
@@ -0,0 +1,13 @@
+\conformance{\subsection}{Memory Device Conformance}\label{sec:Conformance / Device Conformance / Memory Device Conformance}
+
+A memory device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / Memory Device / Device configuration layout}
+\item \ref{devicenormative:Device Types / Memory Device / Device Initialization}
+\item \ref{devicenormative:Device Types / Memory Device / Device Operation}
+\item \ref{devicenormative:Device Types / Memory Device / Device Operation / PLUG request}
+\item \ref{devicenormative:Device Types / Memory Device / Device Operation / UNPLUG request}
+\item \ref{devicenormative:Device Types / Memory Device / Device Operation / UNPLUG ALL request}
+\item \ref{devicenormative:Device Types / Memory Device / Device Operation / STATE request}
+\end{itemize}
device-types/virtio-mem/device.tex renamed from virtio-mem.tex +0 -0
similarity index 100%
rename from virtio-mem.tex
rename to device-types/virtio-mem/device.tex
device-types/virtio-mem/driver-conformance.tex new file +13 -0
new file mode 100644
index 0000000..553dd57
@@ -0,0 +1,13 @@
+\conformance{\subsection}{Memory Driver Conformance}\label{sec:Conformance / Driver Conformance / Memory Driver Conformance}
+
+A memory driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / Memory Device / Device configuration layout}
+\item \ref{drivernormative:Device Types / Memory Device / Device Initialization}
+\item \ref{drivernormative:Device Types / Memory Device / Device Operation}
+\item \ref{drivernormative:Device Types / Memory Device / Device Operation / PLUG request}
+\item \ref{drivernormative:Device Types / Memory Device / Device Operation / UNPLUG request}
+\item \ref{drivernormative:Device Types / Memory Device / Device Operation / UNPLUG ALL request}
+\item \ref{drivernormative:Device Types / Memory Device / Device Operation / STATE request}
+\end{itemize}
Signature · 1 line
2.26.2
#17 lore raw

PATCH v2 17/20 virtio-i2c: Maintain i2c device spec in separate directory

In reply to Parav Pandit

Place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v1->v2:
- added missing device conformance reference
v0->v1:
- new patch

---
 conformance.tex                                | 18 ++----------------
 content.tex                                    |  2 +-
 device-types/virtio-i2c/device-conformance.tex |  7 +++++++
 .../virtio-i2c/device.tex                      |  0
 device-types/virtio-i2c/driver-conformance.tex |  7 +++++++
 5 files changed, 17 insertions(+), 17 deletions(-)
 create mode 100644 device-types/virtio-i2c/device-conformance.tex
 rename virtio-i2c.tex => device-types/virtio-i2c/device.tex (100%)
 create mode 100644 device-types/virtio-i2c/driver-conformance.tex
conformance.tex +2 -16
index c43e8db..eb656f6 100644
@@ -148,14 +148,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-iommu/}{driver-conformance}
 \import{device-types/virtio-sound/}{driver-conformance}
 \import{device-types/virtio-mem/}{driver-conformance}
-
-\conformance{\subsection}{I2C Adapter Driver Conformance}\label{sec:Conformance / Driver Conformance / I2C Adapter Driver Conformance}
-
-An I2C Adapter driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / I2C Adapter Device / Device Operation}
-\end{itemize}
+\import{device-types/virtio-i2c/}{driver-conformance}
 
 \conformance{\subsection}{SCMI Driver Conformance}\label{sec:Conformance / Driver Conformance / SCMI Driver Conformance}
 
@@ -265,14 +258,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-iommu/}{device-conformance}
 \import{device-types/virtio-sound/}{device-conformance}
 \import{device-types/virtio-mem/}{device-conformance}
-
-\conformance{\subsection}{I2C Adapter Device Conformance}\label{sec:Conformance / Device Conformance / I2C Adapter Device Conformance}
-
-An I2C Adapter device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / I2C Adapter Device / Device Operation}
-\end{itemize}
+\import{device-types/virtio-i2c/}{device-conformance}
 
 \conformance{\subsection}{SCMI Device Conformance}\label{sec:Conformance / Device Conformance / SCMI Device Conformance}
 
content.tex +1 -1
index 6466209..e2ede6c 100644
@@ -3018,7 +3018,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \import{device-types/virtio-iommu/}{device}
 \import{device-types/virtio-sound/}{device}
 \import{device-types/virtio-mem/}{device}
-\input{virtio-i2c.tex}
+\import{device-types/virtio-i2c/}{device}
 \input{virtio-scmi.tex}
 \input{virtio-gpio.tex}
 \input{virtio-pmem.tex}
device-types/virtio-i2c/device-conformance.tex new file +7 -0
new file mode 100644
index 0000000..a060b2f
@@ -0,0 +1,7 @@
+\conformance{\subsection}{I2C Adapter Device Conformance}\label{sec:Conformance / Device Conformance / I2C Adapter Device Conformance}
+
+An I2C Adapter device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / I2C Adapter Device / Device Operation}
+\end{itemize}
device-types/virtio-i2c/device.tex renamed from virtio-i2c.tex +0 -0
similarity index 100%
rename from virtio-i2c.tex
rename to device-types/virtio-i2c/device.tex
device-types/virtio-i2c/driver-conformance.tex new file +7 -0
new file mode 100644
index 0000000..405714c
@@ -0,0 +1,7 @@
+\conformance{\subsection}{I2C Adapter Driver Conformance}\label{sec:Conformance / Driver Conformance / I2C Adapter Driver Conformance}
+
+An I2C Adapter driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / I2C Adapter Device / Device Operation}
+\end{itemize}
Signature · 1 line
2.26.2
#18 lore raw

PATCH v2 18/20 virtio-scmi: Maintain scmi device spec in separate directory

In reply to Parav Pandit

Place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v1->v2:
- rebased
v0->v1:
- new patch

---
 conformance.tex                               | 22 ++-----------------
 content.tex                                   |  2 +-
 .../virtio-scmi/device-conformance.tex        | 10 +++++++++
 .../virtio-scmi/device.tex                    |  0
 .../virtio-scmi/driver-conformance.tex        |  8 +++++++
 5 files changed, 21 insertions(+), 21 deletions(-)
 create mode 100644 device-types/virtio-scmi/device-conformance.tex
 rename virtio-scmi.tex => device-types/virtio-scmi/device.tex (100%)
 create mode 100644 device-types/virtio-scmi/driver-conformance.tex
conformance.tex +2 -20
index eb656f6..70fdcc0 100644
@@ -149,15 +149,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-sound/}{driver-conformance}
 \import{device-types/virtio-mem/}{driver-conformance}
 \import{device-types/virtio-i2c/}{driver-conformance}
-
-\conformance{\subsection}{SCMI Driver Conformance}\label{sec:Conformance / Driver Conformance / SCMI Driver Conformance}
-
-An SCMI driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / SCMI Device / Device Operation / cmdq Operation}
-\item \ref{drivernormative:Device Types / SCMI Device / Device Operation / Setting Up eventq Buffers}
-\end{itemize}
+\import{device-types/virtio-scmi/}{driver-conformance}
 
 \conformance{\subsection}{GPIO Driver Conformance}\label{sec:Conformance / Driver Conformance / GPIO Driver Conformance}
 
@@ -259,17 +251,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-sound/}{device-conformance}
 \import{device-types/virtio-mem/}{device-conformance}
 \import{device-types/virtio-i2c/}{device-conformance}
-
-\conformance{\subsection}{SCMI Device Conformance}\label{sec:Conformance / Device Conformance / SCMI Device Conformance}
-
-An SCMI device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / SCMI Device / Feature bits}
-\item \ref{devicenormative:Device Types / SCMI Device / Device Operation / cmdq Operation}
-\item \ref{devicenormative:Device Types / SCMI Device / Device Operation / eventq Operation}
-\item \ref{devicenormative:Device Types / SCMI Device / Device Operation / Shared Memory Operation}
-\end{itemize}
+\import{device-types/virtio-scmi/}{device-conformance}
 
 \conformance{\subsection}{GPIO Device Conformance}\label{sec:Conformance / Device Conformance / GPIO Device Conformance}
 
content.tex +1 -1
index e2ede6c..5bddc9e 100644
@@ -3019,7 +3019,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \import{device-types/virtio-sound/}{device}
 \import{device-types/virtio-mem/}{device}
 \import{device-types/virtio-i2c/}{device}
-\input{virtio-scmi.tex}
+\import{device-types/virtio-scmi/}{device}
 \input{virtio-gpio.tex}
 \input{virtio-pmem.tex}
 
device-types/virtio-scmi/device-conformance.tex new file +10 -0
new file mode 100644
index 0000000..570438f
@@ -0,0 +1,10 @@
+\conformance{\subsection}{SCMI Device Conformance}\label{sec:Conformance / Device Conformance / SCMI Device Conformance}
+
+An SCMI device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / SCMI Device / Feature bits}
+\item \ref{devicenormative:Device Types / SCMI Device / Device Operation / cmdq Operation}
+\item \ref{devicenormative:Device Types / SCMI Device / Device Operation / eventq Operation}
+\item \ref{devicenormative:Device Types / SCMI Device / Device Operation / Shared Memory Operation}
+\end{itemize}
device-types/virtio-scmi/device.tex renamed from virtio-scmi.tex +0 -0
similarity index 100%
rename from virtio-scmi.tex
rename to device-types/virtio-scmi/device.tex
device-types/virtio-scmi/driver-conformance.tex new file +8 -0
new file mode 100644
index 0000000..ef163bd
@@ -0,0 +1,8 @@
+\conformance{\subsection}{SCMI Driver Conformance}\label{sec:Conformance / Driver Conformance / SCMI Driver Conformance}
+
+An SCMI driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / SCMI Device / Device Operation / cmdq Operation}
+\item \ref{drivernormative:Device Types / SCMI Device / Device Operation / Setting Up eventq Buffers}
+\end{itemize}
Signature · 1 line
2.26.2
#19 lore raw

PATCH v2 19/20 virtio-gpio: Maintain gpio device spec in separate directory

In reply to Parav Pandit

Place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v1->v2:
- added missing device conformance reference
v0->v1:
- new patch

---
 conformance.tex                               | 22 ++-----------------
 content.tex                                   |  2 +-
 .../virtio-gpio/device-conformance.tex        |  9 ++++++++
 .../virtio-gpio/device.tex                    |  0
 .../virtio-gpio/driver-conformance.tex        |  9 ++++++++
 5 files changed, 21 insertions(+), 21 deletions(-)
 create mode 100644 device-types/virtio-gpio/device-conformance.tex
 rename virtio-gpio.tex => device-types/virtio-gpio/device.tex (100%)
 create mode 100644 device-types/virtio-gpio/driver-conformance.tex
conformance.tex +2 -20
index 70fdcc0..34d72e5 100644
@@ -150,16 +150,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-mem/}{driver-conformance}
 \import{device-types/virtio-i2c/}{driver-conformance}
 \import{device-types/virtio-scmi/}{driver-conformance}
-
-\conformance{\subsection}{GPIO Driver Conformance}\label{sec:Conformance / Driver Conformance / GPIO Driver Conformance}
-
-A General Purpose Input/Output (GPIO) driver MUST conform to the following
-normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / GPIO Device / requestq Operation}
-\item \ref{drivernormative:Device Types / GPIO Device / eventq Operation}
-\end{itemize}
+\import{device-types/virtio-gpio/}{driver-conformance}
 
 \conformance{\subsection}{PMEM Driver Conformance}\label{sec:Conformance / Driver Conformance / PMEM Driver Conformance}
 
@@ -252,16 +243,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-mem/}{device-conformance}
 \import{device-types/virtio-i2c/}{device-conformance}
 \import{device-types/virtio-scmi/}{device-conformance}
-
-\conformance{\subsection}{GPIO Device Conformance}\label{sec:Conformance / Device Conformance / GPIO Device Conformance}
-
-A General Purpose Input/Output (GPIO) device MUST conform to the following
-normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / GPIO Device / requestq Operation}
-\item \ref{devicenormative:Device Types / GPIO Device / eventq Operation}
-\end{itemize}
+\import{device-types/virtio-gpio/}{device-conformance}
 
 \conformance{\subsection}{PMEM Device Conformance}\label{sec:Conformance / Device Conformance / PMEM Device Conformance}
 
content.tex +1 -1
index 5bddc9e..dc0943c 100644
@@ -3020,7 +3020,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \import{device-types/virtio-mem/}{device}
 \import{device-types/virtio-i2c/}{device}
 \import{device-types/virtio-scmi/}{device}
-\input{virtio-gpio.tex}
+\import{device-types/virtio-gpio/}{device}
 \input{virtio-pmem.tex}
 
 \chapter{Reserved Feature Bits}\label{sec:Reserved Feature Bits}
device-types/virtio-gpio/device-conformance.tex new file +9 -0
new file mode 100644
index 0000000..87806d0
@@ -0,0 +1,9 @@
+\conformance{\subsection}{GPIO Device Conformance}\label{sec:Conformance / Device Conformance / GPIO Device Conformance}
+
+A General Purpose Input/Output (GPIO) device MUST conform to the following
+normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / GPIO Device / requestq Operation}
+\item \ref{devicenormative:Device Types / GPIO Device / eventq Operation}
+\end{itemize}
device-types/virtio-gpio/device.tex renamed from virtio-gpio.tex +0 -0
similarity index 100%
rename from virtio-gpio.tex
rename to device-types/virtio-gpio/device.tex
device-types/virtio-gpio/driver-conformance.tex new file +9 -0
new file mode 100644
index 0000000..b778c2b
@@ -0,0 +1,9 @@
+\conformance{\subsection}{GPIO Driver Conformance}\label{sec:Conformance / Driver Conformance / GPIO Driver Conformance}
+
+A General Purpose Input/Output (GPIO) driver MUST conform to the following
+normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / GPIO Device / requestq Operation}
+\item \ref{drivernormative:Device Types / GPIO Device / eventq Operation}
+\end{itemize}
Signature · 1 line
2.26.2
#20 lore raw

PATCH v2 20/20 virtio-pmem: Maintain pmem device spec in separate directory

In reply to Parav Pandit

Place device specification, its driver and device conformance into its own directory to have self contained device specification.

---
changelog:
v1->v2:
- rebased
v0->v1:
- new patch

---
 conformance.tex                               | 20 ++-----------------
 content.tex                                   |  2 +-
 .../virtio-pmem/device-conformance.tex        |  9 +++++++++
 .../virtio-pmem/device.tex                    |  0
 .../virtio-pmem/driver-conformance.tex        |  7 +++++++
 5 files changed, 19 insertions(+), 19 deletions(-)
 create mode 100644 device-types/virtio-pmem/device-conformance.tex
 rename virtio-pmem.tex => device-types/virtio-pmem/device.tex (100%)
 create mode 100644 device-types/virtio-pmem/driver-conformance.tex
conformance.tex +2 -18
index 34d72e5..57194b2 100644
@@ -151,14 +151,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-i2c/}{driver-conformance}
 \import{device-types/virtio-scmi/}{driver-conformance}
 \import{device-types/virtio-gpio/}{driver-conformance}
-
-\conformance{\subsection}{PMEM Driver Conformance}\label{sec:Conformance / Driver Conformance / PMEM Driver Conformance}
-
-A PMEM driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / PMEM Device / Device Initialization}
-\end{itemize}
+\import{device-types/virtio-pmem/}{driver-conformance}
 
 \conformance{\section}{Device Conformance}\label{sec:Conformance / Device Conformance}
 
@@ -244,16 +237,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \import{device-types/virtio-i2c/}{device-conformance}
 \import{device-types/virtio-scmi/}{device-conformance}
 \import{device-types/virtio-gpio/}{device-conformance}
-
-\conformance{\subsection}{PMEM Device Conformance}\label{sec:Conformance / Device Conformance / PMEM Device Conformance}
-
-A PMEM device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / PMEM Device / Device Initialization}
-\item \ref{devicenormative:Device Types / PMEM Device / Device Operation / Virtqueue flush}
-\item \ref{devicenormative:Device Types / PMEM Device / Device Operation / Virtqueue return}
-\end{itemize}
+\import{device-types/virtio-pmem/}{device-conformance}
 
 \conformance{\section}{Legacy Interface: Transitional Device and Transitional Driver Conformance}\label{sec:Conformance / Legacy Interface: Transitional Device and Transitional Driver Conformance}
 A conformant implementation MUST be either transitional or
content.tex +1 -1
index dc0943c..e1f8450 100644
@@ -3021,7 +3021,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \import{device-types/virtio-i2c/}{device}
 \import{device-types/virtio-scmi/}{device}
 \import{device-types/virtio-gpio/}{device}
-\input{virtio-pmem.tex}
+\import{device-types/virtio-pmem/}{device}
 
 \chapter{Reserved Feature Bits}\label{sec:Reserved Feature Bits}
 
device-types/virtio-pmem/device-conformance.tex new file +9 -0
new file mode 100644
index 0000000..e06862c
@@ -0,0 +1,9 @@
+\conformance{\subsection}{PMEM Device Conformance}\label{sec:Conformance / Device Conformance / PMEM Device Conformance}
+
+A PMEM device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / PMEM Device / Device Initialization}
+\item \ref{devicenormative:Device Types / PMEM Device / Device Operation / Virtqueue flush}
+\item \ref{devicenormative:Device Types / PMEM Device / Device Operation / Virtqueue return}
+\end{itemize}
device-types/virtio-pmem/device.tex renamed from virtio-pmem.tex +0 -0
similarity index 100%
rename from virtio-pmem.tex
rename to device-types/virtio-pmem/device.tex
device-types/virtio-pmem/driver-conformance.tex new file +7 -0
new file mode 100644
index 0000000..620804c
@@ -0,0 +1,7 @@
+\conformance{\subsection}{PMEM Driver Conformance}\label{sec:Conformance / Driver Conformance / PMEM Driver Conformance}
+
+A PMEM driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / PMEM Device / Device Initialization}
+\end{itemize}
Signature · 1 line
2.26.2
#21 lore raw
In reply to Parav Pandit
Quoted 117 lines · Parav Pandit

Relatively several of the recent device specifications are maintained in their own specification file. Such separate files enables better maintenance of the specification overall.
However, several of the initial virtio device specifications are located in single file.

Hence, split them into their individual files.

Additionally, each device's driver and device conformance is present in one giant conformance file all together.

As Michael suggest's move this device and driver conformance section adjacent to device specification in each device specific directory. This further makes device specification self-contained.

Added patch to fix spelling errors in network device specification which was inherited from its previous file location.

Patches do not change any part of the specification outcome except fixing the spelling errors.
It only changes how the specification is maintained.

patch summary:
-------------
patch 1 to 7 creates new files for moving devices spec out of content and conformance files.
patch 8 to 20 move existing dedicated file spec to new directory and creates per device,driver conformance file for each device.

changelog:
----------
v1->v2:
- removed extra blank lines in network and block device files
- added missing device conformance link for rpmb, sound, i2c and gpio devices
v0->v1:
- move device spec to their own directory
- added split files for conformance and placed them adjacent to device spec
- added patch to fix spelling errors in network device

Parav Pandit (20):
virtio-network: Maintain network device spec in separate directory
virtio-network: Fix spelling errors
virtio-block: Maintain block device spec in separate directory
virtio-console: Maintain console device spec in separate directory
virtio-entropy: Maintain entropy device spec in separate directory
virtio-mem-balloon: Maintain mem balloon device spec in separate
directory
virtio-scsi: Maintain scsi host device spec in separate directory
virtio-gpu: Maintain gpu device spec in separate directory
virtio-input: Maintain input device spec in separate directory
virtio-crypto: Maintain crypto device spec in separate directory
virtio-vsock: Maintain socket device spec in separate directory
virtio-fs: Maintain file system device spec in separate directory
virtio-rpmb: Maintain rpmb device spec in separate directory
virtio-iommu: Maintain iommu device spec in separate directory
virtio-sound: Maintain sound device spec in separate directory
virtio-mem: Maintain memory device spec in separate directory
virtio-i2c: Maintain i2c device spec in separate directory
virtio-scmi: Maintain scmi device spec in separate directory
virtio-gpio: Maintain gpio device spec in separate directory
virtio-pmem: Maintain pmem device spec in separate directory

 conformance.tex                               |  456 +-
 content.tex                                   | 4561 +----------------
 .../virtio-block/device-conformance.tex       |    8 +
 device-types/virtio-block/device.tex          | 1313 +++++
 .../virtio-block/driver-conformance.tex       |    8 +
 .../virtio-console/device-conformance.tex     |    8 +
 device-types/virtio-console/device.tex        |  231 +
 .../virtio-console/driver-conformance.tex     |    8 +
 .../virtio-crypto/device-conformance.tex      |   13 +
 .../virtio-crypto/device.tex                  |    0
 .../virtio-crypto/driver-conformance.tex      |   14 +
 .../virtio-entropy/device-conformance.tex     |    7 +
 device-types/virtio-entropy/device.tex        |   42 +
 .../virtio-entropy/driver-conformance.tex     |    7 +
 device-types/virtio-fs/device-conformance.tex |    9 +
 .../virtio-fs/device.tex                      |    0
 device-types/virtio-fs/driver-conformance.tex |   10 +
 .../virtio-gpio/device-conformance.tex        |    9 +
 .../virtio-gpio/device.tex                    |    0
 .../virtio-gpio/driver-conformance.tex        |    9 +
 .../virtio-gpu/device-conformance.tex         |    8 +
 .../virtio-gpu/device.tex                     |    0
 .../virtio-i2c/device-conformance.tex         |    7 +
 .../virtio-i2c/device.tex                     |    0
 .../virtio-i2c/driver-conformance.tex         |    7 +
 .../virtio-input/device-conformance.tex       |    8 +
 .../virtio-input/device.tex                   |    0
 .../virtio-input/driver-conformance.tex       |    8 +
 .../virtio-iommu/device-conformance.tex       |   16 +
 .../virtio-iommu/device.tex                   |    0
 .../virtio-iommu/driver-conformance.tex       |   17 +
 .../virtio-mem-balloon/device-conformance.tex |   12 +
 device-types/virtio-mem-balloon/device.tex    |  634 +++
 .../virtio-mem-balloon/driver-conformance.tex |   12 +
 .../virtio-mem/device-conformance.tex         |   13 +
 .../virtio-mem/device.tex                     |    0
 .../virtio-mem/driver-conformance.tex         |   13 +
 .../virtio-network/device-conformance.tex     |   16 +
 device-types/virtio-network/device.tex        | 1594 ++++++
 .../virtio-network/driver-conformance.tex     |   17 +
 .../virtio-pmem/device-conformance.tex        |    9 +
 .../virtio-pmem/device.tex                    |    0
 .../virtio-pmem/driver-conformance.tex        |    7 +
 .../virtio-rpmb/device-conformance.tex        |   13 +
 .../virtio-rpmb/device.tex                    |    0
 .../virtio-rpmb/driver-conformance.tex        |    7 +
 .../virtio-scmi/device-conformance.tex        |   10 +
 .../virtio-scmi/device.tex                    |    0
 .../virtio-scmi/driver-conformance.tex        |    8 +
 .../virtio-scsi/device-conformance.tex        |   10 +
 device-types/virtio-scsi/device.tex           |  709 +++
 .../virtio-scsi/driver-conformance.tex        |    9 +
Quoted 8 lines
 .../virtio-sound/device-conformance.tex       |   16 +
 .../virtio-sound/device.tex                   |    0
 .../virtio-sound/driver-conformance.tex       |   13 +
 .../virtio-vsock/device-conformance.tex       |    9 +
 .../virtio-vsock/device.tex                   |    0
 .../virtio-vsock/driver-conformance.tex       |   10 +
 virtio.tex                                    |    1 +
 59 files changed, 4965 insertions(+), 4961 deletions(-)

Does makediff still work? Documentation says latexpand does not support import. without latexdiff generating redlined versions would be very difficult.

I am also worried about consistency since we
already use \\input.
If using \\input means putting everything in a single directory, that's a small price to pay:

virtio-sound.tex + virtio-sound-conformance.tex

is not fundamentally worse than device-types/virtio-sound/device.tex and device-types/virtio-sound/device-conformance.tex

and it avoids the duplicated "device" in the name.

Previously it looked like a cosmetic issue, but now it looks like it's important.

Quoted 59 lines
 create mode 100644 device-types/virtio-block/device-conformance.tex
 create mode 100644 device-types/virtio-block/device.tex
 create mode 100644 device-types/virtio-block/driver-conformance.tex
 create mode 100644 device-types/virtio-console/device-conformance.tex
 create mode 100644 device-types/virtio-console/device.tex
 create mode 100644 device-types/virtio-console/driver-conformance.tex
 create mode 100644 device-types/virtio-crypto/device-conformance.tex
 rename virtio-crypto.tex => device-types/virtio-crypto/device.tex (100%)
 create mode 100644 device-types/virtio-crypto/driver-conformance.tex
 create mode 100644 device-types/virtio-entropy/device-conformance.tex
 create mode 100644 device-types/virtio-entropy/device.tex
 create mode 100644 device-types/virtio-entropy/driver-conformance.tex
 create mode 100644 device-types/virtio-fs/device-conformance.tex
 rename virtio-fs.tex => device-types/virtio-fs/device.tex (100%)
 create mode 100644 device-types/virtio-fs/driver-conformance.tex
 create mode 100644 device-types/virtio-gpio/device-conformance.tex
 rename virtio-gpio.tex => device-types/virtio-gpio/device.tex (100%)
 create mode 100644 device-types/virtio-gpio/driver-conformance.tex
 create mode 100644 device-types/virtio-gpu/device-conformance.tex
 rename virtio-gpu.tex => device-types/virtio-gpu/device.tex (100%)
 create mode 100644 device-types/virtio-i2c/device-conformance.tex
 rename virtio-i2c.tex => device-types/virtio-i2c/device.tex (100%)
 create mode 100644 device-types/virtio-i2c/driver-conformance.tex
 create mode 100644 device-types/virtio-input/device-conformance.tex
 rename virtio-input.tex => device-types/virtio-input/device.tex (100%)
 create mode 100644 device-types/virtio-input/driver-conformance.tex
 create mode 100644 device-types/virtio-iommu/device-conformance.tex
 rename virtio-iommu.tex => device-types/virtio-iommu/device.tex (100%)
 create mode 100644 device-types/virtio-iommu/driver-conformance.tex
 create mode 100644 device-types/virtio-mem-balloon/device-conformance.tex
 create mode 100644 device-types/virtio-mem-balloon/device.tex
 create mode 100644 device-types/virtio-mem-balloon/driver-conformance.tex
 create mode 100644 device-types/virtio-mem/device-conformance.tex
 rename virtio-mem.tex => device-types/virtio-mem/device.tex (100%)
 create mode 100644 device-types/virtio-mem/driver-conformance.tex
 create mode 100644 device-types/virtio-network/device-conformance.tex
 create mode 100644 device-types/virtio-network/device.tex
 create mode 100644 device-types/virtio-network/driver-conformance.tex
 create mode 100644 device-types/virtio-pmem/device-conformance.tex
 rename virtio-pmem.tex => device-types/virtio-pmem/device.tex (100%)
 create mode 100644 device-types/virtio-pmem/driver-conformance.tex
 create mode 100644 device-types/virtio-rpmb/device-conformance.tex
 rename virtio-rpmb.tex => device-types/virtio-rpmb/device.tex (100%)
 create mode 100644 device-types/virtio-rpmb/driver-conformance.tex
 create mode 100644 device-types/virtio-scmi/device-conformance.tex
 rename virtio-scmi.tex => device-types/virtio-scmi/device.tex (100%)
 create mode 100644 device-types/virtio-scmi/driver-conformance.tex
 create mode 100644 device-types/virtio-scsi/device-conformance.tex
 create mode 100644 device-types/virtio-scsi/device.tex
 create mode 100644 device-types/virtio-scsi/driver-conformance.tex
 create mode 100644 device-types/virtio-sound/device-conformance.tex
 rename virtio-sound.tex => device-types/virtio-sound/device.tex (100%)
 create mode 100644 device-types/virtio-sound/driver-conformance.tex
 create mode 100644 device-types/virtio-vsock/device-conformance.tex
 rename virtio-vsock.tex => device-types/virtio-vsock/device.tex (100%)
 create mode 100644 device-types/virtio-vsock/driver-conformance.tex
Signature · 1 line
2.26.2
#22 lore raw
Quoted 139 lines · Michael S. Tsirkin
Quoted 117 lines · Parav Pandit

Relatively several of the recent device specifications are maintained in their own specification file. Such separate files enables better maintenance of the specification overall.
However, several of the initial virtio device specifications are located in single file.

Hence, split them into their individual files.

Additionally, each device's driver and device conformance is present in one giant conformance file all together.

As Michael suggest's move this device and driver conformance section adjacent to device specification in each device specific directory. This further makes device specification self-contained.

Added patch to fix spelling errors in network device specification which was inherited from its previous file location.

Patches do not change any part of the specification outcome except fixing the spelling errors.
It only changes how the specification is maintained.

patch summary:
-------------
patch 1 to 7 creates new files for moving devices spec out of content and conformance files.
patch 8 to 20 move existing dedicated file spec to new directory and creates per device,driver conformance file for each device.

changelog:
----------
v1->v2:
- removed extra blank lines in network and block device files
- added missing device conformance link for rpmb, sound, i2c and gpio devices
v0->v1:
- move device spec to their own directory
- added split files for conformance and placed them adjacent to device spec
- added patch to fix spelling errors in network device

Parav Pandit (20):
virtio-network: Maintain network device spec in separate directory
virtio-network: Fix spelling errors
virtio-block: Maintain block device spec in separate directory
virtio-console: Maintain console device spec in separate directory
virtio-entropy: Maintain entropy device spec in separate directory
virtio-mem-balloon: Maintain mem balloon device spec in separate
directory
virtio-scsi: Maintain scsi host device spec in separate directory
virtio-gpu: Maintain gpu device spec in separate directory
virtio-input: Maintain input device spec in separate directory
virtio-crypto: Maintain crypto device spec in separate directory
virtio-vsock: Maintain socket device spec in separate directory
virtio-fs: Maintain file system device spec in separate directory
virtio-rpmb: Maintain rpmb device spec in separate directory
virtio-iommu: Maintain iommu device spec in separate directory
virtio-sound: Maintain sound device spec in separate directory
virtio-mem: Maintain memory device spec in separate directory
virtio-i2c: Maintain i2c device spec in separate directory
virtio-scmi: Maintain scmi device spec in separate directory
virtio-gpio: Maintain gpio device spec in separate directory
virtio-pmem: Maintain pmem device spec in separate directory

 conformance.tex                               |  456 +-
 content.tex                                   | 4561 +----------------
 .../virtio-block/device-conformance.tex       |    8 +
 device-types/virtio-block/device.tex          | 1313 +++++
 .../virtio-block/driver-conformance.tex       |    8 +
 .../virtio-console/device-conformance.tex     |    8 +
 device-types/virtio-console/device.tex        |  231 +
 .../virtio-console/driver-conformance.tex     |    8 +
 .../virtio-crypto/device-conformance.tex      |   13 +
 .../virtio-crypto/device.tex                  |    0
 .../virtio-crypto/driver-conformance.tex      |   14 +
 .../virtio-entropy/device-conformance.tex     |    7 +
 device-types/virtio-entropy/device.tex        |   42 +
 .../virtio-entropy/driver-conformance.tex     |    7 +
 device-types/virtio-fs/device-conformance.tex |    9 +
 .../virtio-fs/device.tex                      |    0
 device-types/virtio-fs/driver-conformance.tex |   10 +
 .../virtio-gpio/device-conformance.tex        |    9 +
 .../virtio-gpio/device.tex                    |    0
 .../virtio-gpio/driver-conformance.tex        |    9 +
 .../virtio-gpu/device-conformance.tex         |    8 +
 .../virtio-gpu/device.tex                     |    0
 .../virtio-i2c/device-conformance.tex         |    7 +
 .../virtio-i2c/device.tex                     |    0
 .../virtio-i2c/driver-conformance.tex         |    7 +
 .../virtio-input/device-conformance.tex       |    8 +
 .../virtio-input/device.tex                   |    0
 .../virtio-input/driver-conformance.tex       |    8 +
 .../virtio-iommu/device-conformance.tex       |   16 +
 .../virtio-iommu/device.tex                   |    0
 .../virtio-iommu/driver-conformance.tex       |   17 +
 .../virtio-mem-balloon/device-conformance.tex |   12 +
 device-types/virtio-mem-balloon/device.tex    |  634 +++
 .../virtio-mem-balloon/driver-conformance.tex |   12 +
 .../virtio-mem/device-conformance.tex         |   13 +
 .../virtio-mem/device.tex                     |    0
 .../virtio-mem/driver-conformance.tex         |   13 +
 .../virtio-network/device-conformance.tex     |   16 +
 device-types/virtio-network/device.tex        | 1594 ++++++
 .../virtio-network/driver-conformance.tex     |   17 +
 .../virtio-pmem/device-conformance.tex        |    9 +
 .../virtio-pmem/device.tex                    |    0
 .../virtio-pmem/driver-conformance.tex        |    7 +
 .../virtio-rpmb/device-conformance.tex        |   13 +
 .../virtio-rpmb/device.tex                    |    0
 .../virtio-rpmb/driver-conformance.tex        |    7 +
 .../virtio-scmi/device-conformance.tex        |   10 +
 .../virtio-scmi/device.tex                    |    0
 .../virtio-scmi/driver-conformance.tex        |    8 +
 .../virtio-scsi/device-conformance.tex        |   10 +
 device-types/virtio-scsi/device.tex           |  709 +++
 .../virtio-scsi/driver-conformance.tex        |    9 +
Quoted 8 lines
 .../virtio-sound/device-conformance.tex       |   16 +
 .../virtio-sound/device.tex                   |    0
 .../virtio-sound/driver-conformance.tex       |   13 +
 .../virtio-vsock/device-conformance.tex       |    9 +
 .../virtio-vsock/device.tex                   |    0
 .../virtio-vsock/driver-conformance.tex       |   10 +
 virtio.tex                                    |    1 +
 59 files changed, 4965 insertions(+), 4961 deletions(-)

Does makediff still work? Documentation says latexpand does not support import. without latexdiff generating redlined versions would be very difficult.

I am also worried about consistency since we
already use \\input.
If using \\input means putting everything in a single directory, that's a small price to pay:

virtio-sound.tex + virtio-sound-conformance.tex

Quoted 7 lines

is not fundamentally worse than device-types/virtio-sound/device.tex and device-types/virtio-sound/device-conformance.tex

and it avoids the duplicated "device" in the name.

Previously it looked like a cosmetic issue, but now it looks like it's important.

I agree, and we need to decide quickly what to do with the ballot. We don't want to merge v1, but the current votes still have a majority of 'yes'. My preference would be to withdraw the ballot, which needs to be done before 22:00 UTC today, if I'm not confused.

Parav, what do you think? If you request to withdraw the ballot, that's easy to do; we'll just open a new one once we've agreed on a version.

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

#23 lore raw
Quoted 151 lines

From: [email protected] <[email protected]> On Behalf Of Cornelia Huck

Quoted 137 lines · Michael S. Tsirkin
Quoted 116 lines · Parav Pandit

Relatively several of the recent device specifications are maintained in their own specification file. Such separate files enables better maintenance of the specification overall.
However, several of the initial virtio device specifications are located in single file.

Hence, split them into their individual files.

Additionally, each device's driver and device conformance is present in one giant conformance file all together.

As Michael suggest's move this device and driver conformance section adjacent to device specification in each device specific directory. This further makes device specification self-contained.

Added patch to fix spelling errors in network device specification which was inherited from its previous file location.

Patches do not change any part of the specification outcome except fixing the spelling errors.
It only changes how the specification is maintained.

patch summary:
-------------
patch 1 to 7 creates new files for moving devices spec out of content and conformance files.
patch 8 to 20 move existing dedicated file spec to new directory and creates per device,driver conformance file for each device.

changelog:
----------
v1->v2:
- removed extra blank lines in network and block device files
- added missing device conformance link for rpmb, sound, i2c and gpio devices
v0->v1:
- move device spec to their own directory
- added split files for conformance and placed them adjacent to device spec
- added patch to fix spelling errors in network device

Parav Pandit (20):
virtio-network: Maintain network device spec in separate directory
virtio-network: Fix spelling errors
virtio-block: Maintain block device spec in separate directory
virtio-console: Maintain console device spec in separate directory
virtio-entropy: Maintain entropy device spec in separate directory
virtio-mem-balloon: Maintain mem balloon device spec in separate
directory
virtio-scsi: Maintain scsi host device spec in separate directory
virtio-gpu: Maintain gpu device spec in separate directory
virtio-input: Maintain input device spec in separate directory
virtio-crypto: Maintain crypto device spec in separate directory
virtio-vsock: Maintain socket device spec in separate directory
virtio-fs: Maintain file system device spec in separate directory
virtio-rpmb: Maintain rpmb device spec in separate directory
virtio-iommu: Maintain iommu device spec in separate directory
virtio-sound: Maintain sound device spec in separate directory
virtio-mem: Maintain memory device spec in separate directory
virtio-i2c: Maintain i2c device spec in separate directory
virtio-scmi: Maintain scmi device spec in separate directory
virtio-gpio: Maintain gpio device spec in separate directory
virtio-pmem: Maintain pmem device spec in separate directory

 conformance.tex                               |  456 +-
 content.tex                                   | 4561 +----------------
 .../virtio-block/device-conformance.tex       |    8 +
 device-types/virtio-block/device.tex          | 1313 +++++
 .../virtio-block/driver-conformance.tex       |    8 +
 .../virtio-console/device-conformance.tex     |    8 +
 device-types/virtio-console/device.tex        |  231 +
 .../virtio-console/driver-conformance.tex     |    8 +
 .../virtio-crypto/device-conformance.tex      |   13 +
 .../virtio-crypto/device.tex                  |    0
 .../virtio-crypto/driver-conformance.tex      |   14 +
 .../virtio-entropy/device-conformance.tex     |    7 +
 device-types/virtio-entropy/device.tex        |   42 +
 .../virtio-entropy/driver-conformance.tex     |    7 +
 device-types/virtio-fs/device-conformance.tex |    9 +
 .../virtio-fs/device.tex                      |    0
 device-types/virtio-fs/driver-conformance.tex |   10 +
 .../virtio-gpio/device-conformance.tex        |    9 +
 .../virtio-gpio/device.tex                    |    0
 .../virtio-gpio/driver-conformance.tex        |    9 +
 .../virtio-gpu/device-conformance.tex         |    8 +
 .../virtio-gpu/device.tex                     |    0
 .../virtio-i2c/device-conformance.tex         |    7 +
 .../virtio-i2c/device.tex                     |    0
 .../virtio-i2c/driver-conformance.tex         |    7 +
 .../virtio-input/device-conformance.tex       |    8 +
 .../virtio-input/device.tex                   |    0
 .../virtio-input/driver-conformance.tex       |    8 +
 .../virtio-iommu/device-conformance.tex       |   16 +
 .../virtio-iommu/device.tex                   |    0
 .../virtio-iommu/driver-conformance.tex       |   17 +
 .../virtio-mem-balloon/device-conformance.tex |   12 +
 device-types/virtio-mem-balloon/device.tex    |  634 +++
 .../virtio-mem-balloon/driver-conformance.tex |   12 +
 .../virtio-mem/device-conformance.tex         |   13 +
 .../virtio-mem/device.tex                     |    0
 .../virtio-mem/driver-conformance.tex         |   13 +
 .../virtio-network/device-conformance.tex     |   16 +
 device-types/virtio-network/device.tex        | 1594 ++++++
 .../virtio-network/driver-conformance.tex     |   17 +
 .../virtio-pmem/device-conformance.tex        |    9 +
 .../virtio-pmem/device.tex                    |    0
 .../virtio-pmem/driver-conformance.tex        |    7 +
 .../virtio-rpmb/device-conformance.tex        |   13 +
 .../virtio-rpmb/device.tex                    |    0
 .../virtio-rpmb/driver-conformance.tex        |    7 +
 .../virtio-scmi/device-conformance.tex        |   10 +
 .../virtio-scmi/device.tex                    |    0
 .../virtio-scmi/driver-conformance.tex        |    8 +
 .../virtio-scsi/device-conformance.tex        |   10 +
 device-types/virtio-scsi/device.tex           |  709 +++
 .../virtio-scsi/driver-conformance.tex        |    9 +
Quoted 8 lines
 .../virtio-sound/device-conformance.tex       |   16 +
 .../virtio-sound/device.tex                   |    0
 .../virtio-sound/driver-conformance.tex       |   13 +
 .../virtio-vsock/device-conformance.tex       |    9 +
 .../virtio-vsock/device.tex                   |    0
 .../virtio-vsock/driver-conformance.tex       |   10 +
 virtio.tex                                    |    1 +
 59 files changed, 4965 insertions(+), 4961 deletions(-)

Does makediff still work? Documentation says latexpand does not support import. without latexdiff generating redlined versions would be very difficult.

I am also worried about consistency since we already use \\input. If using \\input means putting everything in a single directory, that's a small price to pay:

virtio-sound.tex + virtio-sound-conformance.tex

Quoted 7 lines

is not fundamentally worse than device-types/virtio-sound/device.tex and device-types/virtio-sound/device-conformance.tex

and it avoids the duplicated "device" in the name.

Previously it looked like a cosmetic issue, but now it looks like it's important.

Quoted 7 lines

I agree, and we need to decide quickly what to do with the ballot. We don't want to merge v1, but the current votes still have a majority of 'yes'. My preference would be to withdraw the ballot, which needs to be done before 22:00 UTC today, if I'm not confused.

Parav, what do you think? If you request to withdraw the ballot, that's easy to do; we'll just open a new one once we've agreed on a version.

I am revising the v2 and should be available in 7 pm UTC time. This will include,
a. white space removal at end of the net and blk files
b. fix missing device conformance links for 4 devices
c. import to input
d. continue with directories
e. rename device-types/<name>/device.tex to device-types/<name>/description.tex

#24 lore raw
Quoted 31 lines · Parav Pandit
Quoted 23 lines

From: [email protected] <[email protected]> On Behalf Of Cornelia Huck

Quoted 11 lines · Michael S. Tsirkin

Does makediff still work? Documentation says latexpand does not support import. without latexdiff generating redlined versions would be very difficult.

I am also worried about consistency since we already use \\input. If using \\input means putting everything in a single directory, that's a small price to pay:

virtio-sound.tex + virtio-sound-conformance.tex

Quoted 7 lines

is not fundamentally worse than device-types/virtio-sound/device.tex and device-types/virtio-sound/device-conformance.tex

and it avoids the duplicated "device" in the name.

Previously it looked like a cosmetic issue, but now it looks like it's important.

Quoted 7 lines

I agree, and we need to decide quickly what to do with the ballot. We don't want to merge v1, but the current votes still have a majority of 'yes'. My preference would be to withdraw the ballot, which needs to be done before 22:00 UTC today, if I'm not confused.

Parav, what do you think? If you request to withdraw the ballot, that's easy to do; we'll just open a new one once we've agreed on a version.

Quoted 7 lines

I am revising the v2 and should be available in 7 pm UTC time. This will include,
a. white space removal at end of the net and blk files
b. fix missing device conformance links for 4 devices
c. import to input
d. continue with directories
e. rename device-types/<name>/device.tex to device-types/<name>/description.tex

Apologies if I sound like a process stickler, but the main problem is that the ballot is currently about v1 of the patches (and we obviously can't change that while it is open, as that would invalidate the votes that already have been cast.) If your v3 looks good, we need a new ballot to vote on that. As it stands now, the TC would have voted to include v1 with its known problems... that's why I think a withdrawal would be best.

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/

#25 lore raw
Quoted 45 lines

From: Cornelia Huck <[email protected]>
Sent: Tuesday, January 10, 2023 10:21 AM

Quoted 33 lines · Parav Pandit
Quoted 24 lines

From: [email protected] <[email protected]> On Behalf Of Cornelia Huck

Quoted 11 lines · Michael S. Tsirkin

Does makediff still work? Documentation says latexpand does not support import. without latexdiff generating redlined versions would be very difficult.

I am also worried about consistency since we already use \\input. If using \\input means putting everything in a single directory, that's a small price to pay:

virtio-sound.tex + virtio-sound-conformance.tex

Quoted 8 lines

is not fundamentally worse than device-types/virtio-sound/device.tex
and device-types/virtio-sound/device-conformance.tex

and it avoids the duplicated "device" in the name.

Previously it looked like a cosmetic issue, but now it looks like it's important.

Quoted 8 lines

I agree, and we need to decide quickly what to do with the ballot. We don't want to merge v1, but the current votes still have a majority of 'yes'. My preference would be to withdraw the ballot, which needs to be done before
22:00 UTC today, if I'm not confused.

Parav, what do you think? If you request to withdraw the ballot, that's easy to do; we'll just open a new one once we've agreed on a version.

Quoted 6 lines

I am revising the v2 and should be available in 7 pm UTC time. This will include,
a. white space removal at end of the net and blk files b. fix missing device conformance links for 4 devices c. import to input d. continue with directories e. rename device-types/<name>/device.tex to device-types/<name>/description.tex

Quoted 3 lines

Apologies if I sound like a process stickler, but the main problem is that the ballot is currently about v1 of the patches (and we obviously can't change that while it is open, as that would invalidate the votes that already have been cast.)

If it auto invalidates, is there any withdrawal process needed? If no, lets withdraw an re-vote on v3.

Quoted 3 lines

If your v3 looks good, we need a new ballot to vote on that. As it stands now, the TC would have voted to include v1 with its known problems... that's why I think a withdrawal would be best.

We will use the same github issue for v3, and new ballot yes?

#26 lore raw
Quoted 45 lines · Parav Pandit
Quoted 45 lines

From: Cornelia Huck <[email protected]>
Sent: Tuesday, January 10, 2023 10:21 AM

Quoted 39 lines · Parav Pandit
Quoted 24 lines

From: [email protected] <[email protected]> On Behalf Of Cornelia Huck

Quoted 11 lines · Michael S. Tsirkin

Does makediff still work? Documentation says latexpand does not support import. without latexdiff generating redlined versions would be very difficult.

I am also worried about consistency since we already use \\input. If using \\input means putting everything in a single directory, that's a small price to pay:

virtio-sound.tex + virtio-sound-conformance.tex

Quoted 8 lines

is not fundamentally worse than device-types/virtio-sound/device.tex
and device-types/virtio-sound/device-conformance.tex

and it avoids the duplicated "device" in the name.

Previously it looked like a cosmetic issue, but now it looks like it's important.

Quoted 8 lines

I agree, and we need to decide quickly what to do with the ballot. We don't want to merge v1, but the current votes still have a majority of 'yes'. My preference would be to withdraw the ballot, which needs to be done before
22:00 UTC today, if I'm not confused.

Parav, what do you think? If you request to withdraw the ballot, that's easy to do; we'll just open a new one once we've agreed on a version.

I am revising the v2 and should be available in 7 pm UTC time. This will include,
a. white space removal at end of the net and blk files b. fix missing device conformance links for 4 devices c. import to input d. continue with directories e. rename device-types/<name>/device.tex to device-types/<name>/description.tex

Quoted 5 lines
Quoted 3 lines

Apologies if I sound like a process stickler, but the main problem is that the ballot is currently about v1 of the patches (and we obviously can't change that while it is open, as that would invalidate the votes that already have been cast.)

If it auto invalidates, is there any withdrawal process needed? If no, lets withdraw an re-vote on v3.

No, there's no such thing as auto-invalidation, as we cannot modify the ballot (sorry if I was unclear.) Let's just withdraw the ballot.

Quoted 6 lines
Quoted 4 lines

If your v3 looks good, we need a new ballot to vote on that. As it stands now, the TC would have voted to include v1 with its known problems... that's why I think a withdrawal would be best.

We will use the same github issue for v3, and new ballot yes?

Yes, exactly. (This is not the first time this has happened.)

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

#27 lore raw
Quoted 3 lines

From: Cornelia Huck <[email protected]>
Sent: Tuesday, January 10, 2023 10:34 AM

[..]

Quoted 10 lines
Quoted 6 lines
Quoted 4 lines

Apologies if I sound like a process stickler, but the main problem is that the ballot is currently about v1 of the patches (and we obviously can't change that while it is open, as that would invalidate the votes that already have been cast.)

If it auto invalidates, is there any withdrawal process needed? If no, lets withdraw an re-vote on v3.

No, there's no such thing as auto-invalidation, as we cannot modify the ballot (sorry if I was unclear.) Let's just withdraw the ballot.

No problem. Its clear to me now.

Quoted 8 lines
Quoted 6 lines
Quoted 4 lines

If your v3 looks good, we need a new ballot to vote on that. As it stands now, the TC would have voted to include v1 with its known problems... that's why I think a withdrawal would be best.

We will use the same github issue for v3, and new ballot yes?

Yes, exactly. (This is not the first time this has happened.)

Ok. Please proceed to withdraw.

#28 lore raw
Quoted 22 lines · Parav Pandit
Quoted 3 lines

From: Cornelia Huck <[email protected]>
Sent: Tuesday, January 10, 2023 10:34 AM

[..]

Quoted 10 lines
Quoted 6 lines
Quoted 4 lines

Apologies if I sound like a process stickler, but the main problem is that the ballot is currently about v1 of the patches (and we obviously can't change that while it is open, as that would invalidate the votes that already have been cast.)

If it auto invalidates, is there any withdrawal process needed? If no, lets withdraw an re-vote on v3.

No, there's no such thing as auto-invalidation, as we cannot modify the ballot (sorry if I was unclear.) Let's just withdraw the ballot.

No problem. Its clear to me now.

Quoted 5 lines
Quoted 5 lines
Quoted 4 lines

If your v3 looks good, we need a new ballot to vote on that. As it stands now, the TC would have voted to include v1 with its known problems... that's why I think a withdrawal would be best.

Quoted 5 lines
Quoted 3 lines
Quoted 1 line

We will use the same github issue for v3, and new ballot yes?

Yes, exactly. (This is not the first time this has happened.)

Ok. Please proceed to withdraw.

Cornelia will you do this? Parav just a note pls update the link in the description (not in comments - these are ignored) before requesting a new ballot.
Thanks!

Signature · 1 line
MST
#29 lore raw
In reply to Cornelia Huck
Quoted 7 lines · On Tue, 10 Jan 2023 12:20:31 +0100 Cornelia Huck <[email protected]> wrote:
Quoted 2 lines

Previously it looked like a cosmetic issue, but now it looks like it's important.

I agree, and we need to decide quickly what to do with the ballot. We don't want to merge v1, but the current votes still have a majority of 'yes'. My preference would be to withdraw the ballot, which needs to be done before 22:00 UTC today, if I'm not confused.

FYI: I've changed form Yes to No as well, so currently it is 4:4. Nevertheless I agree withdrawing the current ballot is the best way to go about this.

Regards,
Halil

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/