From: Parav Pandit <parav@nvidia.com>
To: mst@redhat.com, virtio-dev@lists.oasis-open.org, cohuck@redhat.com
Cc: virtio-comment@lists.oasis-open.org, Parav Pandit <parav@nvidia.com>
Subject: [PATCH v2 05/20] virtio-entropy: Maintain entropy device spec in separate directory
Date: Mon, 9 Jan 2023 18:28:34 +0200 [thread overview]
Message-ID: <20230109162849.463101-6-parav@nvidia.com> (raw)
In-Reply-To: <20230109162849.463101-1-parav@nvidia.com>
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.
Fixes: https://github.com/oasis-tcs/virtio-spec/issues/153
Signed-off-by: Parav Pandit <parav@nvidia.com>
---
changelog:
v0->v1:
- moved to device specific directory
---
conformance.tex | 18 +-------
content.tex | 44 +------------------
.../virtio-entropy/device-conformance.tex | 7 +++
device-types/virtio-entropy/device.tex | 42 ++++++++++++++++++
.../virtio-entropy/driver-conformance.tex | 7 +++
5 files changed, 59 insertions(+), 59 deletions(-)
create mode 100644 device-types/virtio-entropy/device-conformance.tex
create mode 100644 device-types/virtio-entropy/device.tex
create mode 100644 device-types/virtio-entropy/driver-conformance.tex
diff --git a/conformance.tex b/conformance.tex
index e991c2b..e5bb9d9 100644
--- a/conformance.tex
+++ b/conformance.tex
@@ -137,14 +137,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
\import{device-types/virtio-network/}{driver-conformance}
\import{device-types/virtio-block/}{driver-conformance}
\import{device-types/virtio-console/}{driver-conformance}
-
-\conformance{\subsection}{Entropy Driver Conformance}\label{sec:Conformance / Driver Conformance / Entropy Driver Conformance}
-
-An entropy driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / Entropy Device / Device Operation}
-\end{itemize}
+\import{device-types/virtio-entropy/}{driver-conformance}
\conformance{\subsection}{Traditional Memory Balloon Driver Conformance}\label{sec:Conformance / Driver Conformance / Traditional Memory Balloon Driver Conformance}
@@ -372,14 +365,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
\import{device-types/virtio-network/}{device-conformance}
\import{device-types/virtio-block/}{device-conformance}
\import{device-types/virtio-console/}{device-conformance}
-
-\conformance{\subsection}{Entropy Device Conformance}\label{sec:Conformance / Device Conformance / Entropy Device Conformance}
-
-An entropy device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / Entropy Device / Device Operation}
-\end{itemize}
+\import{device-types/virtio-entropy/}{device-conformance}
\conformance{\subsection}{Traditional Memory Balloon Device Conformance}\label{sec:Conformance / Device Conformance / Traditional Memory Balloon Device Conformance}
diff --git a/content.tex b/content.tex
index b835641..953488e 100644
--- a/content.tex
+++ b/content.tex
@@ -3006,49 +3006,7 @@ \chapter{Device Types}\label{sec:Device Types}
\import{device-types/virtio-network/}{device}
\import{device-types/virtio-block/}{device}
\import{device-types/virtio-console/}{device}
-
-\section{Entropy Device}\label{sec:Device Types / Entropy Device}
-
-The virtio entropy device supplies high-quality randomness for
-guest use.
-
-\subsection{Device ID}\label{sec:Device Types / Entropy Device / Device ID}
- 4
-
-\subsection{Virtqueues}\label{sec:Device Types / Entropy Device / Virtqueues}
-\begin{description}
-\item[0] requestq
-\end{description}
-
-\subsection{Feature bits}\label{sec:Device Types / Entropy Device / Feature bits}
- None currently defined
-
-\subsection{Device configuration layout}\label{sec:Device Types / Entropy Device / Device configuration layout}
- None currently defined.
-
-\subsection{Device Initialization}\label{sec:Device Types / Entropy Device / Device Initialization}
-
-\begin{enumerate}
-\item The virtqueue is initialized
-\end{enumerate}
-
-\subsection{Device Operation}\label{sec:Device Types / Entropy Device / Device Operation}
-
-When the driver requires random bytes, it places the descriptor
-of one or more buffers in the queue. It will be completely filled
-by random data by the device.
-
-\drivernormative{\subsubsection}{Device Operation}{Device Types / Entropy Device / Device Operation}
-
-The driver MUST NOT place device-readable buffers into the queue.
-
-The driver MUST examine the length written by the device to determine
-how many random bytes were received.
-
-\devicenormative{\subsubsection}{Device Operation}{Device Types / Entropy Device / Device Operation}
-
-The device MUST place one or more random bytes into the buffer, but it
-MAY use less than the entire buffer length.
+\import{device-types/virtio-entropy/}{device}
\section{Traditional Memory Balloon Device}\label{sec:Device Types / Memory Balloon Device}
diff --git a/device-types/virtio-entropy/device-conformance.tex b/device-types/virtio-entropy/device-conformance.tex
new file mode 100644
index 0000000..2789fda
--- /dev/null
+++ b/device-types/virtio-entropy/device-conformance.tex
@@ -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}
diff --git a/device-types/virtio-entropy/device.tex b/device-types/virtio-entropy/device.tex
new file mode 100644
index 0000000..c26f589
--- /dev/null
+++ b/device-types/virtio-entropy/device.tex
@@ -0,0 +1,42 @@
+\section{Entropy Device}\label{sec:Device Types / Entropy Device}
+
+The virtio entropy device supplies high-quality randomness for
+guest use.
+
+\subsection{Device ID}\label{sec:Device Types / Entropy Device / Device ID}
+ 4
+
+\subsection{Virtqueues}\label{sec:Device Types / Entropy Device / Virtqueues}
+\begin{description}
+\item[0] requestq
+\end{description}
+
+\subsection{Feature bits}\label{sec:Device Types / Entropy Device / Feature bits}
+ None currently defined
+
+\subsection{Device configuration layout}\label{sec:Device Types / Entropy Device / Device configuration layout}
+ None currently defined.
+
+\subsection{Device Initialization}\label{sec:Device Types / Entropy Device / Device Initialization}
+
+\begin{enumerate}
+\item The virtqueue is initialized
+\end{enumerate}
+
+\subsection{Device Operation}\label{sec:Device Types / Entropy Device / Device Operation}
+
+When the driver requires random bytes, it places the descriptor
+of one or more buffers in the queue. It will be completely filled
+by random data by the device.
+
+\drivernormative{\subsubsection}{Device Operation}{Device Types / Entropy Device / Device Operation}
+
+The driver MUST NOT place device-readable buffers into the queue.
+
+The driver MUST examine the length written by the device to determine
+how many random bytes were received.
+
+\devicenormative{\subsubsection}{Device Operation}{Device Types / Entropy Device / Device Operation}
+
+The device MUST place one or more random bytes into the buffer, but it
+MAY use less than the entire buffer length.
diff --git a/device-types/virtio-entropy/driver-conformance.tex b/device-types/virtio-entropy/driver-conformance.tex
new file mode 100644
index 0000000..175c453
--- /dev/null
+++ b/device-types/virtio-entropy/driver-conformance.tex
@@ -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}
--
2.26.2
next prev parent reply other threads:[~2023-01-09 16:28 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-09 16:28 [PATCH v2 00/20] Split device spec to its individual files Parav Pandit
2023-01-09 16:28 ` [PATCH v2 01/20] virtio-network: Maintain network device spec in separate directory Parav Pandit
2023-01-09 16:28 ` [PATCH v2 02/20] virtio-network: Fix spelling errors Parav Pandit
2023-01-09 16:28 ` [PATCH v2 03/20] virtio-block: Maintain block device spec in separate directory Parav Pandit
2023-01-09 16:28 ` [PATCH v2 04/20] virtio-console: Maintain console " Parav Pandit
2023-01-09 16:28 ` Parav Pandit [this message]
2023-01-09 16:28 ` [PATCH v2 06/20] virtio-mem-balloon: Maintain mem balloon " Parav Pandit
2023-01-09 16:28 ` [PATCH v2 07/20] virtio-scsi: Maintain scsi host " Parav Pandit
2023-01-09 16:28 ` [PATCH v2 08/20] virtio-gpu: Maintain gpu " Parav Pandit
2023-01-09 16:28 ` [PATCH v2 09/20] virtio-input: Maintain input " Parav Pandit
2023-01-09 16:28 ` [PATCH v2 10/20] virtio-crypto: Maintain crypto " Parav Pandit
2023-01-09 16:28 ` [PATCH v2 11/20] virtio-vsock: Maintain socket " Parav Pandit
2023-01-09 16:28 ` [PATCH v2 12/20] virtio-fs: Maintain file system " Parav Pandit
2023-01-09 16:28 ` [PATCH v2 13/20] virtio-rpmb: Maintain rpmb " Parav Pandit
2023-01-09 16:28 ` [PATCH v2 14/20] virtio-iommu: Maintain iommu " Parav Pandit
2023-01-09 16:28 ` [PATCH v2 15/20] virtio-sound: Maintain sound " Parav Pandit
2023-01-09 16:28 ` [PATCH v2 16/20] virtio-mem: Maintain memory " Parav Pandit
2023-01-09 16:28 ` [PATCH v2 17/20] virtio-i2c: Maintain i2c " Parav Pandit
2023-01-09 16:28 ` [PATCH v2 18/20] virtio-scmi: Maintain scmi " Parav Pandit
2023-01-09 16:28 ` [PATCH v2 19/20] virtio-gpio: Maintain gpio " Parav Pandit
2023-01-09 16:28 ` [PATCH v2 20/20] virtio-pmem: Maintain pmem " Parav Pandit
2023-01-09 17:25 ` [PATCH v2 00/20] Split device spec to its individual files Michael S. Tsirkin
2023-01-10 11:20 ` [virtio-dev] " Cornelia Huck
2023-01-10 15:05 ` Parav Pandit
2023-01-10 15:21 ` [virtio-comment] " Cornelia Huck
2023-01-10 15:26 ` Parav Pandit
2023-01-10 15:33 ` Cornelia Huck
2023-01-10 15:36 ` Parav Pandit
2023-01-10 17:47 ` Michael S. Tsirkin
2023-01-10 15:46 ` [virtio-comment] " Halil Pasic
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230109162849.463101-6-parav@nvidia.com \
--to=parav@nvidia.com \
--cc=cohuck@redhat.com \
--cc=mst@redhat.com \
--cc=virtio-comment@lists.oasis-open.org \
--cc=virtio-dev@lists.oasis-open.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox