All of lore.kernel.org
 help / color / mirror / Atom feed
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, david@redhat.com,
	Parav Pandit <parav@nvidia.com>
Subject: [PATCH v4 05/20] virtio-entropy: Maintain entropy device spec in separate directory
Date: Thu, 12 Jan 2023 23:22:39 +0200	[thread overview]
Message-ID: <20230112212254.763783-6-parav@nvidia.com> (raw)
In-Reply-To: <20230112212254.763783-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:
v3->v4:
- rename device-types/virtio-entropy/ to device-types/entropy/
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/entropy/description.tex        | 42 ++++++++++++++++++++
 device-types/entropy/device-conformance.tex |  7 ++++
 device-types/entropy/driver-conformance.tex |  7 ++++
 5 files changed, 59 insertions(+), 59 deletions(-)
 create mode 100644 device-types/entropy/description.tex
 create mode 100644 device-types/entropy/device-conformance.tex
 create mode 100644 device-types/entropy/driver-conformance.tex

diff --git a/conformance.tex b/conformance.tex
index cbd559b..d8efa53 100644
--- a/conformance.tex
+++ b/conformance.tex
@@ -137,14 +137,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/net/driver-conformance.tex}
 \input{device-types/blk/driver-conformance.tex}
 \input{device-types/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/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/net/device-conformance.tex}
 \input{device-types/blk/device-conformance.tex}
 \input{device-types/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/entropy/device-conformance.tex}
 
 \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 1b6788d..b77d6a2 100644
--- a/content.tex
+++ b/content.tex
@@ -3006,49 +3006,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/net/description.tex}
 \input{device-types/blk/description.tex}
 \input{device-types/console/description.tex}
-
-\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.
+\input{device-types/entropy/description.tex}
 
 \section{Traditional Memory Balloon Device}\label{sec:Device Types / Memory Balloon Device}
 
diff --git a/device-types/entropy/description.tex b/device-types/entropy/description.tex
new file mode 100644
index 0000000..c26f589
--- /dev/null
+++ b/device-types/entropy/description.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/entropy/device-conformance.tex b/device-types/entropy/device-conformance.tex
new file mode 100644
index 0000000..2789fda
--- /dev/null
+++ b/device-types/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/entropy/driver-conformance.tex b/device-types/entropy/driver-conformance.tex
new file mode 100644
index 0000000..175c453
--- /dev/null
+++ b/device-types/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


  parent reply	other threads:[~2023-01-12 21:22 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-12 21:22 [virtio-comment] [PATCH v4 00/20] Split device spec to its individual files Parav Pandit
2023-01-12 21:22 ` [PATCH v4 01/20] virtio-net: Maintain network device spec in separate directory Parav Pandit
2023-01-12 21:22 ` [virtio-comment] [PATCH v4 02/20] virtio-net: Fix spelling errors Parav Pandit
2023-01-12 21:22 ` [PATCH v4 03/20] virtio-blk: Maintain block device spec in separate directory Parav Pandit
2023-01-12 21:22 ` [PATCH v4 04/20] virtio-console: Maintain console " Parav Pandit
2023-01-12 21:22 ` Parav Pandit [this message]
2023-01-12 21:22 ` [PATCH v4 06/20] virtio-mem-balloon: Maintain mem balloon " Parav Pandit
2023-01-13 10:53   ` David Hildenbrand
2023-01-12 21:22 ` [PATCH v4 07/20] virtio-scsi: Maintain scsi host " Parav Pandit
2023-01-12 21:22 ` [PATCH v4 08/20] virtio-gpu: Maintain gpu " Parav Pandit
2023-01-12 21:22 ` [PATCH v4 09/20] virtio-input: Maintain input " Parav Pandit
2023-01-12 21:22 ` [PATCH v4 10/20] virtio-crypto: Maintain crypto " Parav Pandit
2023-01-12 21:22 ` [PATCH v4 11/20] virtio-vsock: Maintain socket " Parav Pandit
2023-01-13 10:28   ` [virtio-comment] " Stefano Garzarella
2023-01-12 21:22 ` [PATCH v4 12/20] virtio-fs: Maintain file system " Parav Pandit
2023-01-12 21:22 ` [PATCH v4 13/20] virtio-rpmb: Maintain rpmb " Parav Pandit
2023-01-12 21:22 ` [PATCH v4 14/20] virtio-iommu: Maintain iommu " Parav Pandit
2023-01-12 21:22 ` [PATCH v4 15/20] virtio-sound: Maintain sound " Parav Pandit
2023-01-12 21:22 ` [PATCH v4 16/20] virtio-mem: Maintain memory " Parav Pandit
2023-01-12 21:22 ` [PATCH v4 17/20] virtio-i2c: Maintain i2c " Parav Pandit
2023-01-12 21:22 ` [PATCH v4 18/20] virtio-scmi: Maintain scmi " Parav Pandit
2023-01-12 21:22 ` [PATCH v4 19/20] virtio-gpio: Maintain gpio " Parav Pandit
2023-01-12 21:22 ` [PATCH v4 20/20] virtio-pmem: Maintain pmem " Parav Pandit
2023-01-13 10:19 ` [virtio-dev] Re: [virtio-comment] [PATCH v4 00/20] Split device spec to its individual files Cornelia Huck
2023-01-13 11:42   ` Michael S. Tsirkin
2023-01-13 13:42     ` Parav Pandit
2023-01-13 11:44 ` Michael S. Tsirkin
2023-01-13 12:26 ` David Hildenbrand

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=20230112212254.763783-6-parav@nvidia.com \
    --to=parav@nvidia.com \
    --cc=cohuck@redhat.com \
    --cc=david@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.