Skip to contentSkip to conversation

Split device spec to its individual files

PATCH Superseded Parav Pandit 4 participants 32 messages Jan 10, 2023 – Jan 11, 2023

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

v3 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:
----------
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file
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 +----------------
 device-types/virtio-block/description.tex     | 1313 +++++
 .../virtio-block/device-conformance.tex       |    8 +
 .../virtio-block/driver-conformance.tex       |    8 +
 device-types/virtio-console/description.tex   |  231 +
 .../virtio-console/device-conformance.tex     |    8 +
 .../virtio-console/driver-conformance.tex     |    8 +
 .../virtio-crypto/description.tex             |    0
 .../virtio-crypto/device-conformance.tex      |   13 +
 .../virtio-crypto/driver-conformance.tex      |   14 +
 device-types/virtio-entropy/description.tex   |   42 +
 .../virtio-entropy/device-conformance.tex     |    7 +
 .../virtio-entropy/driver-conformance.tex     |    7 +
 .../virtio-fs/description.tex                 |    0
 device-types/virtio-fs/device-conformance.tex |    9 +
 device-types/virtio-fs/driver-conformance.tex |   10 +
 .../virtio-gpio/description.tex               |    0
 .../virtio-gpio/device-conformance.tex        |    9 +
 .../virtio-gpio/driver-conformance.tex        |    9 +
 .../virtio-gpu/description.tex                |    0
 .../virtio-gpu/device-conformance.tex         |    8 +
 .../virtio-i2c/description.tex                |    0
 .../virtio-i2c/device-conformance.tex         |    7 +
 .../virtio-i2c/driver-conformance.tex         |    7 +
 .../virtio-input/description.tex              |    0
 .../virtio-input/device-conformance.tex       |    8 +
 .../virtio-input/driver-conformance.tex       |    8 +
 .../virtio-iommu/description.tex              |    0
 .../virtio-iommu/device-conformance.tex       |   16 +
 .../virtio-iommu/driver-conformance.tex       |   17 +
 .../virtio-mem-balloon/description.tex        |  634 +++
 .../virtio-mem-balloon/device-conformance.tex |   12 +
 .../virtio-mem-balloon/driver-conformance.tex |   12 +
 .../virtio-mem/description.tex                |    0
 .../virtio-mem/device-conformance.tex         |   13 +
 .../virtio-mem/driver-conformance.tex         |   13 +
 device-types/virtio-network/description.tex   | 1594 ++++++
 .../virtio-network/device-conformance.tex     |   16 +
 .../virtio-network/driver-conformance.tex     |   17 +
 .../virtio-pmem/description.tex               |    0
 .../virtio-pmem/device-conformance.tex        |    9 +
 .../virtio-pmem/driver-conformance.tex        |    7 +
 .../virtio-rpmb/description.tex               |    0
 .../virtio-rpmb/device-conformance.tex        |   13 +
 .../virtio-rpmb/driver-conformance.tex        |    7 +
 .../virtio-scmi/description.tex               |    0
 .../virtio-scmi/device-conformance.tex        |   10 +
 .../virtio-scmi/driver-conformance.tex        |    8 +
 device-types/virtio-scsi/description.tex      |  709 +++
 .../virtio-scsi/device-conformance.tex        |   10 +
 .../virtio-scsi/driver-conformance.tex        |    9 +
 .../virtio-sound/description.tex              |    0
 .../virtio-sound/device-conformance.tex       |   16 +
 .../virtio-sound/driver-conformance.tex       |   13 +
 .../virtio-vsock/description.tex              |    0
 .../virtio-vsock/device-conformance.tex       |    9 +
 .../virtio-vsock/driver-conformance.tex       |   10 +
 58 files changed, 4964 insertions(+), 4961 deletions(-)
 create mode 100644 device-types/virtio-block/description.tex
 create mode 100644 device-types/virtio-block/device-conformance.tex
 create mode 100644 device-types/virtio-block/driver-conformance.tex
 create mode 100644 device-types/virtio-console/description.tex
 create mode 100644 device-types/virtio-console/device-conformance.tex
 create mode 100644 device-types/virtio-console/driver-conformance.tex
 rename virtio-crypto.tex => device-types/virtio-crypto/description.tex (100%)
 create mode 100644 device-types/virtio-crypto/device-conformance.tex
 create mode 100644 device-types/virtio-crypto/driver-conformance.tex
 create mode 100644 device-types/virtio-entropy/description.tex
 create mode 100644 device-types/virtio-entropy/device-conformance.tex
 create mode 100644 device-types/virtio-entropy/driver-conformance.tex
 rename virtio-fs.tex => device-types/virtio-fs/description.tex (100%)
 create mode 100644 device-types/virtio-fs/device-conformance.tex
 create mode 100644 device-types/virtio-fs/driver-conformance.tex
 rename virtio-gpio.tex => device-types/virtio-gpio/description.tex (100%)
 create mode 100644 device-types/virtio-gpio/device-conformance.tex
 create mode 100644 device-types/virtio-gpio/driver-conformance.tex
 rename virtio-gpu.tex => device-types/virtio-gpu/description.tex (100%)
 create mode 100644 device-types/virtio-gpu/device-conformance.tex
 rename virtio-i2c.tex => device-types/virtio-i2c/description.tex (100%)
 create mode 100644 device-types/virtio-i2c/device-conformance.tex
 create mode 100644 device-types/virtio-i2c/driver-conformance.tex
 rename virtio-input.tex => device-types/virtio-input/description.tex (100%)
 create mode 100644 device-types/virtio-input/device-conformance.tex
 create mode 100644 device-types/virtio-input/driver-conformance.tex
 rename virtio-iommu.tex => device-types/virtio-iommu/description.tex (100%)
 create mode 100644 device-types/virtio-iommu/device-conformance.tex
 create mode 100644 device-types/virtio-iommu/driver-conformance.tex
 create mode 100644 device-types/virtio-mem-balloon/description.tex
 create mode 100644 device-types/virtio-mem-balloon/device-conformance.tex
 create mode 100644 device-types/virtio-mem-balloon/driver-conformance.tex
 rename virtio-mem.tex => device-types/virtio-mem/description.tex (100%)
 create mode 100644 device-types/virtio-mem/device-conformance.tex
 create mode 100644 device-types/virtio-mem/driver-conformance.tex
 create mode 100644 device-types/virtio-network/description.tex
 create mode 100644 device-types/virtio-network/device-conformance.tex
 create mode 100644 device-types/virtio-network/driver-conformance.tex
 rename virtio-pmem.tex => device-types/virtio-pmem/description.tex (100%)
 create mode 100644 device-types/virtio-pmem/device-conformance.tex
 create mode 100644 device-types/virtio-pmem/driver-conformance.tex
 rename virtio-rpmb.tex => device-types/virtio-rpmb/description.tex (100%)
 create mode 100644 device-types/virtio-rpmb/device-conformance.tex
 create mode 100644 device-types/virtio-rpmb/driver-conformance.tex
 rename virtio-scmi.tex => device-types/virtio-scmi/description.tex (100%)
 create mode 100644 device-types/virtio-scmi/device-conformance.tex
 create mode 100644 device-types/virtio-scmi/driver-conformance.tex
 create mode 100644 device-types/virtio-scsi/description.tex
 create mode 100644 device-types/virtio-scsi/device-conformance.tex
 create mode 100644 device-types/virtio-scsi/driver-conformance.tex
 rename virtio-sound.tex => device-types/virtio-sound/description.tex (100%)
 create mode 100644 device-types/virtio-sound/device-conformance.tex
 create mode 100644 device-types/virtio-sound/driver-conformance.tex
 rename virtio-vsock.tex => device-types/virtio-vsock/description.tex (100%)
 create mode 100644 device-types/virtio-vsock/device-conformance.tex
 create mode 100644 device-types/virtio-vsock/driver-conformance.tex
Signature · 1 line
2.26.2
#1 lore raw

PATCH v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v1->v2:
- removed extra blank lines at end of file v0->v1:
- moved to device specific directory

---
 conformance.tex                               |   35 +-
 content.tex                                   | 1595 +----------------
 device-types/virtio-network/description.tex   | 1594 ++++++++++++++++
 .../virtio-network/device-conformance.tex     |   16 +
 .../virtio-network/driver-conformance.tex     |   17 +
 5 files changed, 1630 insertions(+), 1627 deletions(-)
 create mode 100644 device-types/virtio-network/description.tex
 create mode 100644 device-types/virtio-network/device-conformance.tex
 create mode 100644 device-types/virtio-network/driver-conformance.tex
conformance.tex +2 -33
index c3c1d3e..956c808 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}
+\input{device-types/virtio-network/driver-conformance.tex}
 
 \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}
+\input{device-types/virtio-network/device-conformance.tex}
 
 \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/description.tex new file +1594 -0

1,352 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

Lines of this file are not shown. View the 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.

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 v3 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/description.tex | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
device-types/virtio-network/description.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 v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v1->v2:
- removed extra blank lines at end of file v0->v1:
- moved to device specific directory

---
 conformance.tex                               |   20 +-
 content.tex                                   | 1315 +----------------
 device-types/virtio-block/description.tex     | 1313 ++++++++++++++++
 .../virtio-block/device-conformance.tex       |    8 +
 .../virtio-block/driver-conformance.tex       |    8 +
 5 files changed, 1332 insertions(+), 1332 deletions(-)
 create mode 100644 device-types/virtio-block/description.tex
 create mode 100644 device-types/virtio-block/device-conformance.tex
 create mode 100644 device-types/virtio-block/driver-conformance.tex
conformance.tex +2 -18
index 956c808..096ca3d 100644
@@ -135,15 +135,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \end{itemize}
 
 \input{device-types/virtio-network/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-block/driver-conformance.tex}
 
 \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}
 
 \input{device-types/virtio-network/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-block/device-conformance.tex}
 
 \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/description.tex new file +1313 -0

1,313 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/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 v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v0->v1:
- moved to device specific directory

---
 conformance.tex                               |  20 +-
 content.tex                                   | 233 +-----------------
 device-types/virtio-console/description.tex   | 231 +++++++++++++++++
 .../virtio-console/device-conformance.tex     |   8 +
 .../virtio-console/driver-conformance.tex     |   8 +
 5 files changed, 250 insertions(+), 250 deletions(-)
 create mode 100644 device-types/virtio-console/description.tex
 create mode 100644 device-types/virtio-console/device-conformance.tex
 create mode 100644 device-types/virtio-console/driver-conformance.tex
conformance.tex +2 -18
index 096ca3d..ddc2a8e 100644
@@ -136,15 +136,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 
 \input{device-types/virtio-network/driver-conformance.tex}
 \input{device-types/virtio-block/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-console/driver-conformance.tex}
 
 \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}
 
 \input{device-types/virtio-network/device-conformance.tex}
 \input{device-types/virtio-block/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-console/device-conformance.tex}
 
 \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/description.tex new file +231 -0

231 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/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 v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file

v0->v1:
- moved to device specific directory

---
 conformance.tex                               | 18 +-------
 content.tex                                   | 44 +------------------
 device-types/virtio-entropy/description.tex   | 42 ++++++++++++++++++
 .../virtio-entropy/device-conformance.tex     |  7 +++
 .../virtio-entropy/driver-conformance.tex     |  7 +++
 5 files changed, 59 insertions(+), 59 deletions(-)
 create mode 100644 device-types/virtio-entropy/description.tex
 create mode 100644 device-types/virtio-entropy/device-conformance.tex
 create mode 100644 device-types/virtio-entropy/driver-conformance.tex
conformance.tex +2 -16
index ddc2a8e..758bec7 100644
@@ -137,14 +137,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-network/driver-conformance.tex}
 \input{device-types/virtio-block/driver-conformance.tex}
 \input{device-types/virtio-console/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-entropy/driver-conformance.tex}
 
 \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}
 \input{device-types/virtio-network/device-conformance.tex}
 \input{device-types/virtio-block/device-conformance.tex}
 \input{device-types/virtio-console/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-entropy/device-conformance.tex}
 
 \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/description.tex new file +42 -0

42 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/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 v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v0->v1:
- moved to device specific directory

---
 conformance.tex                               |  28 +-
 content.tex                                   | 636 +-----------------
 .../virtio-mem-balloon/description.tex        | 634 +++++++++++++++++
 .../virtio-mem-balloon/device-conformance.tex |  12 +
 .../virtio-mem-balloon/driver-conformance.tex |  12 +
 5 files changed, 661 insertions(+), 661 deletions(-)
 create mode 100644 device-types/virtio-mem-balloon/description.tex
 create mode 100644 device-types/virtio-mem-balloon/device-conformance.tex
 create mode 100644 device-types/virtio-mem-balloon/driver-conformance.tex
conformance.tex +2 -26
index 758bec7..1ea206d 100644
@@ -138,19 +138,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-block/driver-conformance.tex}
 \input{device-types/virtio-console/driver-conformance.tex}
 \input{device-types/virtio-entropy/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-mem-balloon/driver-conformance.tex}
 
 \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}
 \input{device-types/virtio-block/device-conformance.tex}
 \input{device-types/virtio-console/device-conformance.tex}
 \input{device-types/virtio-entropy/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-mem-balloon/device-conformance.tex}
 
 \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/description.tex new file +634 -0

634 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/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

Re: [virtio-dev] [PATCH v3 06/20] virtio-mem-balloon: Maintain mem balloon device spec in separate directory

Quoted 9 lines · 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.

There is virtio-mem and there is virtio-balloon. Calling virtio-balloon "virtio-mem-balloon" can easily lead to quite some confusion. Any particular reason why not to stick to "virtio-balloon" ?

Signature · 3 lines
Thanks,

David / dhildenb
#8 lore raw

Re: [virtio-dev] [PATCH v3 06/20] virtio-mem-balloon: Maintain mem balloon device spec in separate directory

Quoted 7 lines · David Hildenbrand
Quoted 6 lines · 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.

Quoted 7 lines
Quoted 3 lines

There is virtio-mem and there is virtio-balloon. Calling virtio-balloon "virtio-mem-balloon" can easily lead to quite some confusion. Any particular reason why not to stick to "virtio-balloon" ?

Yea, virtio-balloon scans better.

Quoted 4 lines
Signature · 3 lines
Thanks,

David / dhildenb
#9 lore raw

RE: [virtio-dev] [PATCH v3 06/20] virtio-mem-balloon: Maintain mem balloon device spec in separate directory

In reply to David Hildenbrand

Hi David,

Quoted 15 lines

From: David Hildenbrand <[email protected]>
Sent: Wednesday, January 11, 2023 9:14 AM
To: Parav Pandit <[email protected]>; [email protected]; [email protected] open.org; [email protected]
Cc: [email protected]
Subject: Re: [virtio-dev] [PATCH v3 06/20] virtio-mem-balloon: Maintain mem balloon device spec in separate directory

Quoted 6 lines · 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.

Quoted 8 lines
Quoted 3 lines

There is virtio-mem and there is virtio-balloon. Calling virtio-balloon "virtio- mem-balloon" can easily lead to quite some confusion. Any particular reason why not to stick to "virtio-balloon" ?

Historically Linux memory balloon driver in linux is placed as virtio_balloon.c In virtio spec, in the device type is it named as "Traditional memory balloon device". So, I named the directory name close to actual spec content name.
Adding legacy/traditional was too long. :)
May be virtio-mem-legacy is better to differentiate between legacy and new mem device?

In this patchset, directories are named with "virtio-" prefix such as virtio-pmem, virtio-sound.

Another option (which I prefer as I write now) is,
How about we drop "virtio-" prefix in the directory name because this is the virtio spec.

And have names as
device-types/sound
device-types/legacy-mem-balloon
device-types/mem
device-types/pmem

This is short and covers balloon part too?

#10 lore raw

Re: [virtio-dev] [PATCH v3 06/20] virtio-mem-balloon: Maintain mem balloon device spec in separate directory

Quoted 1 line · Parav Pandit

Hi David,

Hi Parav,

Quoted 20 lines
Quoted 20 lines

From: David Hildenbrand <[email protected]>
Sent: Wednesday, January 11, 2023 9:14 AM
To: Parav Pandit <[email protected]>; [email protected]; [email protected] open.org; [email protected]
Cc: [email protected]
Subject: Re: [virtio-dev] [PATCH v3 06/20] virtio-mem-balloon: Maintain mem balloon device spec in separate directory

Quoted 9 lines · 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.

Quoted 5 lines
Quoted 4 lines

There is virtio-mem and there is virtio-balloon. Calling virtio-balloon "virtio- mem-balloon" can easily lead to quite some confusion. Any particular reason why not to stick to "virtio-balloon" ?

Historically Linux memory balloon driver in linux is placed as virtio_balloon.c

See below. id=5 has widespread "virtio-balloon" terminology use. id=13 is what creates confusion.

Quoted 4 lines

In virtio spec, in the device type is it named as "Traditional memory balloon device". So, I named the directory name close to actual spec content name.
Adding legacy/traditional was too long. :)
May be virtio-mem-legacy is better to differentiate between legacy and new mem device?

As it has nothing to do with virtio-mem, that would be confusing. Also, legacy doesn't quite catch the semantics.

Quoted 6 lines

In this patchset, directories are named with "virtio-" prefix such as virtio-pmem, virtio-sound.

Another option (which I prefer as I write now) is,
How about we drop "virtio-" prefix in the directory name because this is the virtio spec.

Quoted 7 lines

And have names as
device-types/sound
device-types/legacy-mem-balloon
device-types/mem
device-types/pmem

This is short and covers balloon part too?

Looking at https://lore.kernel.org/all/[email protected]/

We seem to have virtio-balloon (id=5) and virtio-mem-balloon (if=13).

virtio-balloon is what's actually implemented and used. "Traditional" is a bit misleading here.

IMHO, we could/should

* Name it "balloon" here
* Make "id=13" reserved and remove the notion of "memory balloon" from the spec
* Call "id=5" "Memory Balloon" and remove the notion of "Traditional". It's the one that exists.

@MST?

Signature · 3 lines
Thanks,

David / dhildenb
#11 lore raw

[virtio-comment] Re: [virtio-dev] [PATCH v3 06/20] virtio-mem-balloon: Maintain mem balloon device spec in separate directory

Quoted 34 lines · David Hildenbrand
Quoted 1 line · Parav Pandit

Hi David,

Hi Parav,

Quoted 20 lines
Quoted 20 lines

From: David Hildenbrand <[email protected]>
Sent: Wednesday, January 11, 2023 9:14 AM
To: Parav Pandit <[email protected]>; [email protected]; [email protected] open.org; [email protected]
Cc: [email protected]
Subject: Re: [virtio-dev] [PATCH v3 06/20] virtio-mem-balloon: Maintain mem balloon device spec in separate directory

Quoted 9 lines · 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.

Quoted 5 lines
Quoted 4 lines

There is virtio-mem and there is virtio-balloon. Calling virtio-balloon "virtio- mem-balloon" can easily lead to quite some confusion. Any particular reason why not to stick to "virtio-balloon" ?

Historically Linux memory balloon driver in linux is placed as virtio_balloon.c

See below. id=5 has widespread "virtio-balloon" terminology use. id=13 is what creates confusion.

Quoted 7 lines
Quoted 4 lines

In virtio spec, in the device type is it named as "Traditional memory balloon device". So, I named the directory name close to actual spec content name.
Adding legacy/traditional was too long. :)
May be virtio-mem-legacy is better to differentiate between legacy and new mem device?

As it has nothing to do with virtio-mem, that would be confusing. Also, legacy doesn't quite catch the semantics.

Indeed, "Traditional" != "legacy".

Quoted 23 lines
Quoted 7 lines

In this patchset, directories are named with "virtio-" prefix such as virtio-pmem, virtio-sound.

Another option (which I prefer as I write now) is,
How about we drop "virtio-" prefix in the directory name because this is the virtio spec.

Quoted 7 lines

And have names as
device-types/sound
device-types/legacy-mem-balloon
device-types/mem
device-types/pmem

This is short and covers balloon part too?

Looking at
https://lore.kernel.org/all/[email protected]/

We seem to have virtio-balloon (id=5) and virtio-mem-balloon (if=13).

virtio-balloon is what's actually implemented and used. "Traditional" is a bit misleading here.

Quoted 7 lines

IMHO, we could/should

* Name it "balloon" here
* Make "id=13" reserved and remove the notion of "memory balloon" from the spec
* Call "id=5" "Memory Balloon" and remove the notion of "Traditional". It's the one that exists.

I think the "Traditional" came from the idea that we eventually wanted to come up with a new ballooner that doesn't come with any legacy baggage that the current ballooner might have. AFAIK, that idea has been abandoned in the years since we introduced virtio-1, nobody has proposed something for id 13. Your suggestion makes sense to me, but we probably should do it on top of the patch set here.

For this series, using virtio-balloon for the file name makes the most sense to me.

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/

#12 lore raw

RE: [virtio-dev] [PATCH v3 06/20] virtio-mem-balloon: Maintain mem balloon device spec in separate directory

Quoted 78 lines

From: Cornelia Huck <[email protected]>
Sent: Wednesday, January 11, 2023 10:57 AM

Quoted 29 lines · David Hildenbrand
Quoted 1 line · Parav Pandit

Hi David,

Hi Parav,

Quoted 24 lines
Quoted 24 lines

From: David Hildenbrand <[email protected]>
Sent: Wednesday, January 11, 2023 9:14 AM
To: Parav Pandit <[email protected]>; [email protected]; [email protected] open.org; [email protected]
Cc: [email protected]
Subject: Re: [virtio-dev] [PATCH v3 06/20] virtio-mem-balloon:
Maintain mem balloon device spec in separate directory

Quoted 9 lines · 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.

There is virtio-mem and there is virtio-balloon. Calling virtio-balloon "virtio- mem-balloon" can easily lead to quite some confusion. Any particular reason why not to stick to "virtio-balloon" ?

Quoted 7 lines
Quoted 2 lines

Historically Linux memory balloon driver in linux is placed as virtio_balloon.c

See below. id=5 has widespread "virtio-balloon" terminology use. id=13 is what creates confusion.

Quoted 1 line

In virtio spec, in the device type is it named as "Traditional memory balloon

device".

Quoted 6 lines
Quoted 3 lines

So, I named the directory name close to actual spec content name. Adding legacy/traditional was too long. :) May be virtio-mem-legacy is better to differentiate between legacy and new mem device?

As it has nothing to do with virtio-mem, that would be confusing. Also, legacy doesn't quite catch the semantics.

Indeed, "Traditional" != "legacy".

Quoted 3 lines
Quoted 3 lines

In this patchset, directories are named with "virtio-" prefix such as virtio-

pmem, virtio-sound.

Quoted 22 lines
Quoted 11 lines

Another option (which I prefer as I write now) is, How about we drop "virtio-" prefix in the directory name because this is the virtio spec.

And have names as
device-types/sound
device-types/legacy-mem-balloon
device-types/mem
device-types/pmem

This is short and covers balloon part too?

Looking at
https://lore.kernel.org/all/[email protected]/

We seem to have virtio-balloon (id=5) and virtio-mem-balloon (if=13).

virtio-balloon is what's actually implemented and used. "Traditional" is a bit misleading here.

IMHO, we could/should

Quoted 8 lines
Quoted 5 lines

* Name it "balloon" here
* Make "id=13" reserved and remove the notion of "memory balloon" from the spec
* Call "id=5" "Memory Balloon" and remove the notion of "Traditional". It's the one that exists.

I think the "Traditional" came from the idea that we eventually wanted to come up with a new ballooner that doesn't come with any legacy baggage that the

You meant "traditional baggage" and not "legacy baggage"?

Quoted 7 lines

current ballooner might have. AFAIK, that idea has been abandoned in the years since we introduced virtio-1, nobody has proposed something for id 13. Your suggestion makes sense to me, but we probably should do it on top of the patch set here.

For this series, using virtio-balloon for the file name makes the most sense to me.

Can you please explain this?
The spec description for this device is " Traditional Memory Balloon Device". So why do you want to drop the "memory" part of it? Can it balloon non memory resources? Or is it to avoid confusion with device id 24?

Also, I want to drop the prefix "virtio_" in the directory names. Any opinion on that?
Dropping and adding back will be too labor intensive. So, want to settle down on that before sending v4.

#13 lore raw

Re: [virtio-dev] [PATCH v3 06/20] virtio-mem-balloon: Maintain mem balloon device spec in separate directory

Quoted 84 lines · Parav Pandit
Quoted 84 lines

From: Cornelia Huck <[email protected]>
Sent: Wednesday, January 11, 2023 10:57 AM

Quoted 29 lines · David Hildenbrand
Quoted 1 line · Parav Pandit

Hi David,

Hi Parav,

Quoted 24 lines
Quoted 24 lines

From: David Hildenbrand <[email protected]>
Sent: Wednesday, January 11, 2023 9:14 AM
To: Parav Pandit <[email protected]>; [email protected]; [email protected] open.org; [email protected]
Cc: [email protected]
Subject: Re: [virtio-dev] [PATCH v3 06/20] virtio-mem-balloon:
Maintain mem balloon device spec in separate directory

Quoted 9 lines · 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.

There is virtio-mem and there is virtio-balloon. Calling virtio-balloon "virtio- mem-balloon" can easily lead to quite some confusion. Any particular reason why not to stick to "virtio-balloon" ?

Quoted 7 lines
Quoted 2 lines

Historically Linux memory balloon driver in linux is placed as virtio_balloon.c

See below. id=5 has widespread "virtio-balloon" terminology use. id=13 is what creates confusion.

Quoted 1 line

In virtio spec, in the device type is it named as "Traditional memory balloon

device".

Quoted 6 lines
Quoted 3 lines

So, I named the directory name close to actual spec content name. Adding legacy/traditional was too long. :) May be virtio-mem-legacy is better to differentiate between legacy and new mem device?

As it has nothing to do with virtio-mem, that would be confusing. Also, legacy doesn't quite catch the semantics.

Indeed, "Traditional" != "legacy".

Quoted 3 lines
Quoted 3 lines

In this patchset, directories are named with "virtio-" prefix such as virtio-

pmem, virtio-sound.

Quoted 27 lines
Quoted 11 lines

Another option (which I prefer as I write now) is, How about we drop "virtio-" prefix in the directory name because this is the virtio spec.

And have names as
device-types/sound
device-types/legacy-mem-balloon
device-types/mem
device-types/pmem

This is short and covers balloon part too?

Looking at
https://lore.kernel.org/all/[email protected]/

We seem to have virtio-balloon (id=5) and virtio-mem-balloon (if=13).

virtio-balloon is what's actually implemented and used. "Traditional" is a bit misleading here.

IMHO, we could/should

* Name it "balloon" here
* Make "id=13" reserved and remove the notion of "memory balloon" from the spec
* Call "id=5" "Memory Balloon" and remove the notion of "Traditional". It's the one that exists.

Quoted 3 lines
Quoted 2 lines

I think the "Traditional" came from the idea that we eventually wanted to come up with a new ballooner that doesn't come with any legacy baggage that the

You meant "traditional baggage" and not "legacy baggage"?

I think the big problem with balloon is it's passing of
PFNs for 4k pages around. I'm not going to pass judgement on whether it's easier to pass 64 bit addresses and huge pages around with a modified traditional balloon or a completely new device until someone
tries. The fact no one fixed this in the traditional device seems to hint that yes, we will need a new device at some point.

Quoted 10 lines
Quoted 7 lines

current ballooner might have. AFAIK, that idea has been abandoned in the years since we introduced virtio-1, nobody has proposed something for id 13. Your suggestion makes sense to me, but we probably should do it on top of the patch set here.

For this series, using virtio-balloon for the file name makes the most sense to me.

Can you please explain this?
The spec description for this device is " Traditional Memory Balloon Device". So why do you want to drop the "memory" part of it? Can it balloon non memory resources?

Because it's not the distinctive part, there are other memory devices. This one is different because it's a balloon.

Quoted 4 lines

Or is it to avoid confusion with device id 24?

Also, I want to drop the prefix "virtio_" in the directory names. Any opinion on that?

I'm fine with this. But I agree mem-balloon is not a good file name, let's just stick with balloon. It's unambigous and short.

Quoted 2 lines

Dropping and adding back will be too labor intensive. So, want to settle down on that before sending v4.

#14 lore raw

RE: [virtio-dev] [PATCH v3 06/20] virtio-mem-balloon: Maintain mem balloon device spec in separate directory

Quoted 10 lines

From: Michael S. Tsirkin <[email protected]>
Sent: Wednesday, January 11, 2023 11:22 AM

Quoted 2 lines

Also, I want to drop the prefix "virtio_" in the directory names. Any opinion on that?

I'm fine with this. But I agree mem-balloon is not a good file name, let's just stick with balloon. It's unambigous and short.

Ok. Will make both changes in v4.

#15 lore raw

PATCH v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v0->v1:
- moved to device specific directory

---
 conformance.tex                               |  23 +-
 content.tex                                   | 712 +-----------------
 device-types/virtio-scsi/description.tex      | 709 +++++++++++++++++
 .../virtio-scsi/device-conformance.tex        |  10 +
 .../virtio-scsi/driver-conformance.tex        |   9 +
 5 files changed, 731 insertions(+), 732 deletions(-)
 create mode 100644 device-types/virtio-scsi/description.tex
 create mode 100644 device-types/virtio-scsi/device-conformance.tex
 create mode 100644 device-types/virtio-scsi/driver-conformance.tex
conformance.tex +2 -21
index 1ea206d..f3439c5 100644
@@ -139,16 +139,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-console/driver-conformance.tex}
 \input{device-types/virtio-entropy/driver-conformance.tex}
 \input{device-types/virtio-mem-balloon/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-scsi/driver-conformance.tex}
 
 \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}
 \input{device-types/virtio-console/device-conformance.tex}
 \input{device-types/virtio-entropy/device-conformance.tex}
 \input{device-types/virtio-mem-balloon/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-scsi/device-conformance.tex}
 
 \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/description.tex new file +709 -0

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

PATCH v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v0->v1:
- moved to device specific directory

---
 conformance.tex                                        | 10 +---------
 content.tex                                            |  2 +-
 .../virtio-gpu/description.tex                         |  0
 device-types/virtio-gpu/device-conformance.tex         |  8 ++++++++
 4 files changed, 10 insertions(+), 10 deletions(-)
 rename virtio-gpu.tex => device-types/virtio-gpu/description.tex (100%)
 create mode 100644 device-types/virtio-gpu/device-conformance.tex
conformance.tex +1 -9
index f3439c5..7a4f63f 100644
@@ -347,15 +347,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-entropy/device-conformance.tex}
 \input{device-types/virtio-mem-balloon/device-conformance.tex}
 \input{device-types/virtio-scsi/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-gpu/device-conformance.tex}
 
 \conformance{\subsection}{Input Device Conformance}\label{sec:Conformance / Device Conformance / Input Device Conformance}
 
content.tex +1 -1
index 3d05cc0..3675aca 100644
@@ -3009,7 +3009,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/virtio-entropy/description.tex}
 \input{device-types/virtio-mem-balloon/description.tex}
 \input{device-types/virtio-scsi/description.tex}
-\input{virtio-gpu.tex}
+\input{device-types/virtio-gpu/description.tex}
 \input{virtio-input.tex}
 \input{virtio-crypto.tex}
 \input{virtio-vsock.tex}
device-types/virtio-gpu/description.tex renamed from virtio-gpu.tex +0 -0
similarity index 100%
rename from virtio-gpu.tex
rename to device-types/virtio-gpu/description.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}
Signature · 1 line
2.26.2
#17 lore raw

PATCH v3 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:
v2->v3:
- use input instead of import to insert a file
v0->v1:
- moved to device specific directory

---
 conformance.tex                               | 20 ++-----------------
 content.tex                                   |  2 +-
 .../virtio-input/description.tex              |  0
 .../virtio-input/device-conformance.tex       |  8 ++++++++
 .../virtio-input/driver-conformance.tex       |  8 ++++++++
 5 files changed, 19 insertions(+), 19 deletions(-)
 rename virtio-input.tex => device-types/virtio-input/description.tex (100%)
 create mode 100644 device-types/virtio-input/device-conformance.tex
 create mode 100644 device-types/virtio-input/driver-conformance.tex
conformance.tex +2 -18
index 7a4f63f..48ee3d1 100644
@@ -140,15 +140,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-entropy/driver-conformance.tex}
 \input{device-types/virtio-mem-balloon/driver-conformance.tex}
 \input{device-types/virtio-scsi/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-input/driver-conformance.tex}
 
 \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}
 \input{device-types/virtio-mem-balloon/device-conformance.tex}
 \input{device-types/virtio-scsi/device-conformance.tex}
 \input{device-types/virtio-gpu/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-input/device-conformance.tex}
 
 \conformance{\subsection}{Crypto Device Conformance}\label{sec:Conformance / Device Conformance / Crypto Device Conformance}
 
content.tex +1 -1
index 3675aca..f5954ea 100644
@@ -3010,7 +3010,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/virtio-mem-balloon/description.tex}
 \input{device-types/virtio-scsi/description.tex}
 \input{device-types/virtio-gpu/description.tex}
-\input{virtio-input.tex}
+\input{device-types/virtio-input/description.tex}
 \input{virtio-crypto.tex}
 \input{virtio-vsock.tex}
 \input{virtio-fs.tex}
device-types/virtio-input/description.tex renamed from virtio-input.tex +0 -0
similarity index 100%
rename from virtio-input.tex
rename to device-types/virtio-input/description.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/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
#18 lore raw

PATCH v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v0->v1:
- moved to device specific directory

---
 conformance.tex                               | 28 +++++++++----------
 content.tex                                   |  2 +-
 .../virtio-crypto/description.tex             |  0
 .../virtio-crypto/device-conformance.tex      | 13 +++++++++
 .../virtio-crypto/driver-conformance.tex      | 14 ++++++++++
 5 files changed, 41 insertions(+), 16 deletions(-)
 rename virtio-crypto.tex => device-types/virtio-crypto/description.tex (100%)
 create mode 100644 device-types/virtio-crypto/device-conformance.tex
 create mode 100644 device-types/virtio-crypto/driver-conformance.tex
conformance.tex +13 -15
index 48ee3d1..662a5a1 100644
@@ -141,21 +141,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-mem-balloon/driver-conformance.tex}
 \input{device-types/virtio-scsi/driver-conformance.tex}
 \input{device-types/virtio-input/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-crypto/driver-conformance.tex}
 
 \conformance{\subsection}{Socket Driver Conformance}\label{sec:Conformance / Driver Conformance / Socket Driver Conformance}
 
@@ -341,6 +327,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-scsi/device-conformance.tex}
 \input{device-types/virtio-gpu/device-conformance.tex}
 \input{device-types/virtio-input/device-conformance.tex}
+\input{device-types/virtio-crypto/device-conformance.tex}
 
 \conformance{\subsection}{Crypto Device Conformance}\label{sec:Conformance / Device Conformance / Crypto Device Conformance}
 
@@ -355,6 +342,17 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \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-network/}{device-conformance}
+\import{device-types/virtio-block/}{device-conformance}
+\import{device-types/virtio-console/}{device-conformance}
+\import{device-types/virtio-entropy/}{device-conformance}
+\import{device-types/virtio-mem-balloon/}{device-conformance}
+\import{device-types/virtio-scsi/}{device-conformance}
+\import{device-types/virtio-gpu/}{device-conformance}
+\import{device-types/virtio-input/}{device-conformance}
+\import{device-types/virtio-crypto/}{device-conformance}
+>>>>>>> a695ea2... virtio-crypto: Maintain crypto device spec in separate directory
 
 \conformance{\subsection}{Socket Device Conformance}\label{sec:Conformance / Device Conformance / Socket Device Conformance}
 
content.tex +1 -1
index f5954ea..f7cbecb 100644
@@ -3011,7 +3011,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/virtio-scsi/description.tex}
 \input{device-types/virtio-gpu/description.tex}
 \input{device-types/virtio-input/description.tex}
-\input{virtio-crypto.tex}
+\input{device-types/virtio-crypto/description.tex}
 \input{virtio-vsock.tex}
 \input{virtio-fs.tex}
 \input{virtio-rpmb.tex}
device-types/virtio-crypto/description.tex renamed from virtio-crypto.tex +0 -0
similarity index 100%
rename from virtio-crypto.tex
rename to device-types/virtio-crypto/description.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/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
#19 lore raw

PATCH v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v0->v1:
- new patch

---
 conformance.tex                               | 48 +------------------
 content.tex                                   |  2 +-
 .../virtio-vsock/description.tex              |  0
 .../virtio-vsock/device-conformance.tex       |  9 ++++
 .../virtio-vsock/driver-conformance.tex       | 10 ++++
 5 files changed, 22 insertions(+), 47 deletions(-)
 rename virtio-vsock.tex => device-types/virtio-vsock/description.tex (100%)
 create mode 100644 device-types/virtio-vsock/device-conformance.tex
 create mode 100644 device-types/virtio-vsock/driver-conformance.tex
conformance.tex +2 -46
index 662a5a1..40cbbfa 100644
@@ -142,17 +142,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-scsi/driver-conformance.tex}
 \input{device-types/virtio-input/driver-conformance.tex}
 \input{device-types/virtio-crypto/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-vsock/driver-conformance.tex}
 
 \conformance{\subsection}{File System Driver Conformance}\label{sec:Conformance / Driver Conformance / File System Driver Conformance}
 
@@ -328,41 +318,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-gpu/device-conformance.tex}
 \input{device-types/virtio-input/device-conformance.tex}
 \input{device-types/virtio-crypto/device-conformance.tex}
-
-\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-network/}{device-conformance}
-\import{device-types/virtio-block/}{device-conformance}
-\import{device-types/virtio-console/}{device-conformance}
-\import{device-types/virtio-entropy/}{device-conformance}
-\import{device-types/virtio-mem-balloon/}{device-conformance}
-\import{device-types/virtio-scsi/}{device-conformance}
-\import{device-types/virtio-gpu/}{device-conformance}
-\import{device-types/virtio-input/}{device-conformance}
-\import{device-types/virtio-crypto/}{device-conformance}
->>>>>>> a695ea2... virtio-crypto: Maintain crypto device spec in separate directory
-
-\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}
+\input{device-types/virtio-vsock/device-conformance.tex}
 
 \conformance{\subsection}{File System Device Conformance}\label{sec:Conformance / Device Conformance / File System Device Conformance}
 
content.tex +1 -1
index f7cbecb..5a4e70a 100644
@@ -3012,7 +3012,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/virtio-gpu/description.tex}
 \input{device-types/virtio-input/description.tex}
 \input{device-types/virtio-crypto/description.tex}
-\input{virtio-vsock.tex}
+\input{device-types/virtio-vsock/description.tex}
 \input{virtio-fs.tex}
 \input{virtio-rpmb.tex}
 \input{virtio-iommu.tex}
device-types/virtio-vsock/description.tex renamed from virtio-vsock.tex +0 -0
similarity index 100%
rename from virtio-vsock.tex
rename to device-types/virtio-vsock/description.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/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
#20 lore raw

[virtio-comment] Re: [PATCH v3 11/20] virtio-vsock: Maintain socket device spec in separate directory

Quoted 23 lines · Parav Pandit

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

---
changelog:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v0->v1:
- new patch

---
 conformance.tex                               | 48 +------------------
 content.tex                                   |  2 +-
 .../virtio-vsock/description.tex              |  0
 .../virtio-vsock/device-conformance.tex       |  9 ++++
 .../virtio-vsock/driver-conformance.tex       | 10 ++++
 5 files changed, 22 insertions(+), 47 deletions(-)
 rename virtio-vsock.tex => device-types/virtio-vsock/description.tex (100%)
 create mode 100644 device-types/virtio-vsock/device-conformance.tex
 create mode 100644 device-types/virtio-vsock/driver-conformance.tex

(...)

Quoted 19 lines
conformance.tex +0 -15
@@ -328,41 +318,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-gpu/device-conformance.tex}
 \input{device-types/virtio-input/device-conformance.tex}
 \input{device-types/virtio-crypto/device-conformance.tex}
-
-\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}
-=======

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

Quoted 10 lines
conformance.tex +0 -10
-\import{device-types/virtio-network/}{device-conformance}
-\import{device-types/virtio-block/}{device-conformance}
-\import{device-types/virtio-console/}{device-conformance}
-\import{device-types/virtio-entropy/}{device-conformance}
-\import{device-types/virtio-mem-balloon/}{device-conformance}
-\import{device-types/virtio-scsi/}{device-conformance}
-\import{device-types/virtio-gpu/}{device-conformance}
-\import{device-types/virtio-input/}{device-conformance}
-\import{device-types/virtio-crypto/}{device-conformance}
->>>>>>> a695ea2... virtio-crypto: Maintain crypto device spec in separate directory

Instead of removing it here, better don't even add it in the virtio-crypto patch :)

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/

#21 lore raw

PATCH v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v0->v1:
- new patch

---
 conformance.tex                               | 23 ++-----------------
 content.tex                                   |  2 +-
 .../virtio-fs/description.tex                 |  0
 device-types/virtio-fs/device-conformance.tex |  9 ++++++++
 device-types/virtio-fs/driver-conformance.tex | 10 ++++++++
 5 files changed, 22 insertions(+), 22 deletions(-)
 rename virtio-fs.tex => device-types/virtio-fs/description.tex (100%)
 create mode 100644 device-types/virtio-fs/device-conformance.tex
 create mode 100644 device-types/virtio-fs/driver-conformance.tex
conformance.tex +2 -21
index 40cbbfa..c9b6783 100644
@@ -143,17 +143,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-input/driver-conformance.tex}
 \input{device-types/virtio-crypto/driver-conformance.tex}
 \input{device-types/virtio-vsock/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-fs/driver-conformance.tex}
 
 \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}
 \input{device-types/virtio-input/device-conformance.tex}
 \input{device-types/virtio-crypto/device-conformance.tex}
 \input{device-types/virtio-vsock/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-fs/device-conformance.tex}
 
 \conformance{\subsection}{RPMB Device Conformance}\label{sec:Conformance / Device Conformance / RPMB Device Conformance}
 
content.tex +1 -1
index 5a4e70a..3e8bfeb 100644
@@ -3013,7 +3013,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/virtio-input/description.tex}
 \input{device-types/virtio-crypto/description.tex}
 \input{device-types/virtio-vsock/description.tex}
-\input{virtio-fs.tex}
+\input{device-types/virtio-fs/description.tex}
 \input{virtio-rpmb.tex}
 \input{virtio-iommu.tex}
 \input{virtio-sound.tex}
device-types/virtio-fs/description.tex renamed from virtio-fs.tex +0 -0
similarity index 100%
rename from virtio-fs.tex
rename to device-types/virtio-fs/description.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/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
#22 lore raw

PATCH v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v1->v2:
- added missing device conformance reference entry v0->v1:
- new patch

---
 conformance.tex                               | 23 ++-----------------
 content.tex                                   |  2 +-
 .../virtio-rpmb/description.tex               |  0
 .../virtio-rpmb/device-conformance.tex        | 13 +++++++++++
 .../virtio-rpmb/driver-conformance.tex        |  7 ++++++
 5 files changed, 23 insertions(+), 22 deletions(-)
 rename virtio-rpmb.tex => device-types/virtio-rpmb/description.tex (100%)
 create mode 100644 device-types/virtio-rpmb/device-conformance.tex
 create mode 100644 device-types/virtio-rpmb/driver-conformance.tex
conformance.tex +2 -21
index c9b6783..fb95c4a 100644
@@ -144,14 +144,8 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-crypto/driver-conformance.tex}
 \input{device-types/virtio-vsock/driver-conformance.tex}
 \input{device-types/virtio-fs/driver-conformance.tex}
+\input{device-types/virtio-rpmb/driver-conformance.tex}
 
-\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}
 \input{device-types/virtio-crypto/device-conformance.tex}
 \input{device-types/virtio-vsock/device-conformance.tex}
 \input{device-types/virtio-fs/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-rpmb/device-conformance.tex}
 
 \conformance{\subsection}{IOMMU Device Conformance}\label{sec:Conformance / Device Conformance / IOMMU Device Conformance}
 
content.tex +1 -1
index 3e8bfeb..434d131 100644
@@ -3014,7 +3014,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/virtio-crypto/description.tex}
 \input{device-types/virtio-vsock/description.tex}
 \input{device-types/virtio-fs/description.tex}
-\input{virtio-rpmb.tex}
+\input{device-types/virtio-rpmb/description.tex}
 \input{virtio-iommu.tex}
 \input{virtio-sound.tex}
 \input{virtio-mem.tex}
device-types/virtio-rpmb/description.tex renamed from virtio-rpmb.tex +0 -0
similarity index 100%
rename from virtio-rpmb.tex
rename to device-types/virtio-rpmb/description.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/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
#23 lore raw

PATCH v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v1->v2:
- rebased
v0->v1:
- new patch

---
 conformance.tex                               | 37 +------------------
 content.tex                                   |  2 +-
 .../virtio-iommu/description.tex              |  0
 .../virtio-iommu/device-conformance.tex       | 16 ++++++++
 .../virtio-iommu/driver-conformance.tex       | 17 +++++++++
 5 files changed, 36 insertions(+), 36 deletions(-)
 rename virtio-iommu.tex => device-types/virtio-iommu/description.tex (100%)
 create mode 100644 device-types/virtio-iommu/device-conformance.tex
 create mode 100644 device-types/virtio-iommu/driver-conformance.tex
conformance.tex +2 -35
index fb95c4a..7a64606 100644
@@ -145,24 +145,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-vsock/driver-conformance.tex}
 \input{device-types/virtio-fs/driver-conformance.tex}
 \input{device-types/virtio-rpmb/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-iommu/driver-conformance.tex}
 
 \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}
 \input{device-types/virtio-vsock/device-conformance.tex}
 \input{device-types/virtio-fs/device-conformance.tex}
 \input{device-types/virtio-rpmb/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-iommu/device-conformance.tex}
 
 \conformance{\subsection}{Sound Device Conformance}\label{sec:Conformance / Device Conformance / Sound Device Conformance}
 
content.tex +1 -1
index 434d131..b9a4ce7 100644
@@ -3015,7 +3015,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/virtio-vsock/description.tex}
 \input{device-types/virtio-fs/description.tex}
 \input{device-types/virtio-rpmb/description.tex}
-\input{virtio-iommu.tex}
+\input{device-types/virtio-iommu/description.tex}
 \input{virtio-sound.tex}
 \input{virtio-mem.tex}
 \input{virtio-i2c.tex}
device-types/virtio-iommu/description.tex renamed from virtio-iommu.tex +0 -0
similarity index 100%
rename from virtio-iommu.tex
rename to device-types/virtio-iommu/description.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/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
#24 lore raw

PATCH v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v1->v2:
- added missing device conformance reference v0->v1:
- new patch

---
 conformance.tex                               | 33 ++-----------------
 content.tex                                   |  2 +-
 .../virtio-sound/description.tex              |  0
 .../virtio-sound/device-conformance.tex       | 16 +++++++++
 .../virtio-sound/driver-conformance.tex       | 13 ++++++++
 5 files changed, 32 insertions(+), 32 deletions(-)
 rename virtio-sound.tex => device-types/virtio-sound/description.tex (100%)
 create mode 100644 device-types/virtio-sound/device-conformance.tex
 create mode 100644 device-types/virtio-sound/driver-conformance.tex
conformance.tex +2 -31
index 7a64606..c7057b1 100644
@@ -146,20 +146,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-fs/driver-conformance.tex}
 \input{device-types/virtio-rpmb/driver-conformance.tex}
 \input{device-types/virtio-iommu/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-sound/driver-conformance.tex}
 
 \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}
 \input{device-types/virtio-fs/device-conformance.tex}
 \input{device-types/virtio-rpmb/device-conformance.tex}
 \input{device-types/virtio-iommu/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-sound/device-conformance.tex}
 
 \conformance{\subsection}{Memory Device Conformance}\label{sec:Conformance / Device Conformance / Memory Device Conformance}
 
content.tex +1 -1
index b9a4ce7..d2c825f 100644
@@ -3016,7 +3016,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/virtio-fs/description.tex}
 \input{device-types/virtio-rpmb/description.tex}
 \input{device-types/virtio-iommu/description.tex}
-\input{virtio-sound.tex}
+\input{device-types/virtio-sound/description.tex}
 \input{virtio-mem.tex}
 \input{virtio-i2c.tex}
 \input{virtio-scmi.tex}
device-types/virtio-sound/description.tex renamed from virtio-sound.tex +0 -0
similarity index 100%
rename from virtio-sound.tex
rename to device-types/virtio-sound/description.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/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
#25 lore raw

PATCH v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v1->v2:
- rebased
v0->v1:
- new patch

---
 conformance.tex                               | 30 ++-----------------
 content.tex                                   |  2 +-
 .../virtio-mem/description.tex                |  0
 .../virtio-mem/device-conformance.tex         | 13 ++++++++
 .../virtio-mem/driver-conformance.tex         | 13 ++++++++
 5 files changed, 29 insertions(+), 29 deletions(-)
 rename virtio-mem.tex => device-types/virtio-mem/description.tex (100%)
 create mode 100644 device-types/virtio-mem/device-conformance.tex
 create mode 100644 device-types/virtio-mem/driver-conformance.tex
conformance.tex +2 -28
index c7057b1..8185cc3 100644
@@ -147,20 +147,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-rpmb/driver-conformance.tex}
 \input{device-types/virtio-iommu/driver-conformance.tex}
 \input{device-types/virtio-sound/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-mem/driver-conformance.tex}
 
 \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}
 \input{device-types/virtio-rpmb/device-conformance.tex}
 \input{device-types/virtio-iommu/device-conformance.tex}
 \input{device-types/virtio-sound/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-mem/device-conformance.tex}
 
 \conformance{\subsection}{I2C Adapter Device Conformance}\label{sec:Conformance / Device Conformance / I2C Adapter Device Conformance}
 
content.tex +1 -1
index d2c825f..3082b80 100644
@@ -3017,7 +3017,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/virtio-rpmb/description.tex}
 \input{device-types/virtio-iommu/description.tex}
 \input{device-types/virtio-sound/description.tex}
-\input{virtio-mem.tex}
+\input{device-types/virtio-mem/description.tex}
 \input{virtio-i2c.tex}
 \input{virtio-scmi.tex}
 \input{virtio-gpio.tex}
device-types/virtio-mem/description.tex renamed from virtio-mem.tex +0 -0
similarity index 100%
rename from virtio-mem.tex
rename to device-types/virtio-mem/description.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/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
#26 lore raw

PATCH v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v1->v2:
- added missing device conformance reference v0->v1:
- new patch

---
 conformance.tex                                | 18 ++----------------
 content.tex                                    |  2 +-
 .../virtio-i2c/description.tex                 |  0
 device-types/virtio-i2c/device-conformance.tex |  7 +++++++
 device-types/virtio-i2c/driver-conformance.tex |  7 +++++++
 5 files changed, 17 insertions(+), 17 deletions(-)
 rename virtio-i2c.tex => device-types/virtio-i2c/description.tex (100%)
 create mode 100644 device-types/virtio-i2c/device-conformance.tex
 create mode 100644 device-types/virtio-i2c/driver-conformance.tex
conformance.tex +2 -16
index 8185cc3..a420249 100644
@@ -148,14 +148,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-iommu/driver-conformance.tex}
 \input{device-types/virtio-sound/driver-conformance.tex}
 \input{device-types/virtio-mem/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-i2c/driver-conformance.tex}
 
 \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}
 \input{device-types/virtio-iommu/device-conformance.tex}
 \input{device-types/virtio-sound/device-conformance.tex}
 \input{device-types/virtio-mem/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-i2c/device-conformance.tex}
 
 \conformance{\subsection}{SCMI Device Conformance}\label{sec:Conformance / Device Conformance / SCMI Device Conformance}
 
content.tex +1 -1
index 3082b80..db3946a 100644
@@ -3018,7 +3018,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/virtio-iommu/description.tex}
 \input{device-types/virtio-sound/description.tex}
 \input{device-types/virtio-mem/description.tex}
-\input{virtio-i2c.tex}
+\input{device-types/virtio-i2c/description.tex}
 \input{virtio-scmi.tex}
 \input{virtio-gpio.tex}
 \input{virtio-pmem.tex}
device-types/virtio-i2c/description.tex renamed from virtio-i2c.tex +0 -0
similarity index 100%
rename from virtio-i2c.tex
rename to device-types/virtio-i2c/description.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/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
#27 lore raw

PATCH v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v1->v2:
- rebased
v0->v1:
- new patch

---
 conformance.tex                               | 22 ++-----------------
 content.tex                                   |  2 +-
 .../virtio-scmi/description.tex               |  0
 .../virtio-scmi/device-conformance.tex        | 10 +++++++++
 .../virtio-scmi/driver-conformance.tex        |  8 +++++++
 5 files changed, 21 insertions(+), 21 deletions(-)
 rename virtio-scmi.tex => device-types/virtio-scmi/description.tex (100%)
 create mode 100644 device-types/virtio-scmi/device-conformance.tex
 create mode 100644 device-types/virtio-scmi/driver-conformance.tex
conformance.tex +2 -20
index a420249..ac8981c 100644
@@ -149,15 +149,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-sound/driver-conformance.tex}
 \input{device-types/virtio-mem/driver-conformance.tex}
 \input{device-types/virtio-i2c/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-scmi/driver-conformance.tex}
 
 \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}
 \input{device-types/virtio-sound/device-conformance.tex}
 \input{device-types/virtio-mem/device-conformance.tex}
 \input{device-types/virtio-i2c/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-scmi/device-conformance.tex}
 
 \conformance{\subsection}{GPIO Device Conformance}\label{sec:Conformance / Device Conformance / GPIO Device Conformance}
 
content.tex +1 -1
index db3946a..977a2cd 100644
@@ -3019,7 +3019,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/virtio-sound/description.tex}
 \input{device-types/virtio-mem/description.tex}
 \input{device-types/virtio-i2c/description.tex}
-\input{virtio-scmi.tex}
+\input{device-types/virtio-scmi/description.tex}
 \input{virtio-gpio.tex}
 \input{virtio-pmem.tex}
 
device-types/virtio-scmi/description.tex renamed from virtio-scmi.tex +0 -0
similarity index 100%
rename from virtio-scmi.tex
rename to device-types/virtio-scmi/description.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/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
#28 lore raw

PATCH v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v1->v2:
- added missing device conformance reference v0->v1:
- new patch

---
 conformance.tex                               | 22 ++-----------------
 content.tex                                   |  4 ++--
 .../virtio-gpio/description.tex               |  0
 .../virtio-gpio/device-conformance.tex        |  9 ++++++++
 .../virtio-gpio/driver-conformance.tex        |  9 ++++++++
 5 files changed, 22 insertions(+), 22 deletions(-)
 rename virtio-gpio.tex => device-types/virtio-gpio/description.tex (100%)
 create mode 100644 device-types/virtio-gpio/device-conformance.tex
 create mode 100644 device-types/virtio-gpio/driver-conformance.tex
conformance.tex +2 -20
index ac8981c..1cf2d81 100644
@@ -150,16 +150,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-mem/driver-conformance.tex}
 \input{device-types/virtio-i2c/driver-conformance.tex}
 \input{device-types/virtio-scmi/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-gpio/driver-conformance.tex}
 
 \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}
 \input{device-types/virtio-mem/device-conformance.tex}
 \input{device-types/virtio-i2c/device-conformance.tex}
 \input{device-types/virtio-scmi/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-gpio/device-conformance.tex}
 
 \conformance{\subsection}{PMEM Device Conformance}\label{sec:Conformance / Device Conformance / PMEM Device Conformance}
 
content.tex +2 -2
index 977a2cd..bc67e63 100644
@@ -3020,8 +3020,8 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/virtio-mem/description.tex}
 \input{device-types/virtio-i2c/description.tex}
 \input{device-types/virtio-scmi/description.tex}
-\input{virtio-gpio.tex}
-\input{virtio-pmem.tex}
+\input{device-types/virtio-gpio/description.tex}
+\input{device-types/virtio-pmem/description.tex}
 
 \chapter{Reserved Feature Bits}\label{sec:Reserved Feature Bits}
 
device-types/virtio-gpio/description.tex renamed from virtio-gpio.tex +0 -0
similarity index 100%
rename from virtio-gpio.tex
rename to device-types/virtio-gpio/description.tex
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/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
#29 lore raw

[virtio-dev] Re: [PATCH v3 19/20] virtio-gpio: Maintain gpio device spec in separate directory

Quoted 25 lines · Parav Pandit

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

---
changelog:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v1->v2:
- added missing device conformance reference v0->v1:
- new patch

---
 conformance.tex                               | 22 ++-----------------
 content.tex                                   |  4 ++--
 .../virtio-gpio/description.tex               |  0
 .../virtio-gpio/device-conformance.tex        |  9 ++++++++
 .../virtio-gpio/driver-conformance.tex        |  9 ++++++++
 5 files changed, 22 insertions(+), 22 deletions(-)
 rename virtio-gpio.tex => device-types/virtio-gpio/description.tex (100%)
 create mode 100644 device-types/virtio-gpio/device-conformance.tex
 create mode 100644 device-types/virtio-gpio/driver-conformance.tex

(...)

content.tex \chapter{Device Types}\label{sec:Device Types} · line 3024

Quoted 12 lines
content.tex +2 -2
index 977a2cd..bc67e63 100644
@@ -3020,8 +3020,8 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/virtio-mem/description.tex}
 \input{device-types/virtio-i2c/description.tex}
 \input{device-types/virtio-scmi/description.tex}
-\input{virtio-gpio.tex}
-\input{virtio-pmem.tex}
+\input{device-types/virtio-gpio/description.tex}
+\input{device-types/virtio-pmem/description.tex}

The virtio-pmem change should have gone into the following patch?

(We don't really care about bisectability, so not a big deal; but something that should be fixed if a respin is needed.)

content.tex \chapter{Device Types}\label{sec:Device Types} · line 3027

Quoted 3 lines
content.tex +0 -0
 \chapter{Reserved Feature Bits}\label{sec:Reserved Feature Bits}
 

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

#30 lore raw

[virtio-comment] RE: [PATCH v3 19/20] virtio-gpio: Maintain gpio device spec in separate directory

Quoted 33 lines

From: Cornelia Huck <[email protected]>
Sent: Wednesday, January 11, 2023 5:52 AM

Quoted 24 lines · Parav Pandit

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

---
changelog:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v1->v2:
- added missing device conformance reference v0->v1:
- new patch

---
 conformance.tex                               | 22 ++-----------------
 content.tex                                   |  4 ++--
 .../virtio-gpio/description.tex               |  0
 .../virtio-gpio/device-conformance.tex        |  9 ++++++++
 .../virtio-gpio/driver-conformance.tex        |  9 ++++++++
 5 files changed, 22 insertions(+), 22 deletions(-)  rename
virtio-gpio.tex => device-types/virtio-gpio/description.tex (100%)
create mode 100644 device-types/virtio-gpio/device-conformance.tex
 create mode 100644 device-types/virtio-gpio/driver-conformance.tex

(...)

Quoted 14 lines

content.tex \chapter{Device Types}\label{sec:Device Types} · line 3024

Quoted 11 lines
content.tex +2 -2
@@ -3020,8 +3020,8 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/virtio-mem/description.tex}
 \input{device-types/virtio-i2c/description.tex}
 \input{device-types/virtio-scmi/description.tex}
-\input{virtio-gpio.tex}
-\input{virtio-pmem.tex}
+\input{device-types/virtio-gpio/description.tex}
+\input{device-types/virtio-pmem/description.tex}

The virtio-pmem change should have gone into the following patch?

It should be in next patch.
The rebasing messed this up.
Bisection is important. Let me fix it.

Quoted 2 lines

(We don't really care about bisectability, so not a big deal; but something that should be fixed if a respin is needed.)

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/

#31 lore raw

PATCH v3 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:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file v1->v2:
- rebased
v0->v1:
- new patch

---
 conformance.tex                               | 20 ++-----------------
 .../virtio-pmem/description.tex               |  0
 .../virtio-pmem/device-conformance.tex        |  9 +++++++++
 .../virtio-pmem/driver-conformance.tex        |  7 +++++++
 4 files changed, 18 insertions(+), 18 deletions(-)
 rename virtio-pmem.tex => device-types/virtio-pmem/description.tex (100%)
 create mode 100644 device-types/virtio-pmem/device-conformance.tex
 create mode 100644 device-types/virtio-pmem/driver-conformance.tex
conformance.tex +2 -18
index 1cf2d81..6418b2a 100644
@@ -151,14 +151,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-i2c/driver-conformance.tex}
 \input{device-types/virtio-scmi/driver-conformance.tex}
 \input{device-types/virtio-gpio/driver-conformance.tex}
-
-\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}
+\input{device-types/virtio-pmem/driver-conformance.tex}
 
 \conformance{\section}{Device Conformance}\label{sec:Conformance / Device Conformance}
 
@@ -244,16 +237,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-i2c/device-conformance.tex}
 \input{device-types/virtio-scmi/device-conformance.tex}
 \input{device-types/virtio-gpio/device-conformance.tex}
-
-\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}
+\input{device-types/virtio-pmem/device-conformance.tex}
 
 \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
device-types/virtio-pmem/description.tex renamed from virtio-pmem.tex +0 -0
similarity index 100%
rename from virtio-pmem.tex
rename to device-types/virtio-pmem/description.tex
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/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