-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
virtio-entropy: Maintain entropy device spec in separate directory
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: #153 Acked-by: Michael S. Tsirkin <mst@redhat.com> Signed-off-by: Parav Pandit <parav@nvidia.com> Signed-off-by: Cornelia Huck <cohuck@redhat.com>
- Loading branch information
1 parent
d3d0618
commit c71e88e
Showing
5 changed files
with
59 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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} |