[Qemu-devel] [PATCH v19 0/2] virtio-crypto: virtio crypto device specification

[Qemu-devel] [PATCH v19 0/2] virtio-crypto: virtio crypto device specification

[Longpeng(Mike)]

Hi guys,

I'll work on the virtio-crypto spec with Gonglei together, Because He is
so busy on the inner production project.

---
v19 -> v18:
 - fix some typos and grammar fixes [Stefan, Halil]
 - rename VIRTIO_CRYPTO_F_STATELESS_MODE to VIRTIO_CRYPTO_F_MUX_MODE
 - describe the VIRTIO_CRYPTO_STATUS in detial. [Halil]
 - refactor and redescribe the controlq/dataq request's format
   of mux mode. [Halil]
 - other small fixes. [Halil]

v18 -> v17:
 - fix many English grammar problems suggested by Stefan, Thanks a lot!

v17 -> v16:
 - Some grammar fixes [Stefan, Halil, Michael]
 - add a section named "Supported crypto services" in order to explain bit
   numbers and valuse clearly. [Halil, Cornelia]
 - avoid word reptition [Halil]
 - rename non-session mode to stateless mode [Halil]
 - change descriptions for all elements in struct virtio_crypto_config [Halil]
 - add Halil as a reviewer in the ackonwledgement part, thanks for his work.
 - other fixes here and there.

Changes since v15:
 - use feature bits for non-session mode in order to keep compatibility with
   pre-existing code. [Halil & Michael]
 - introduce VIRTIO_CRYPTO_F_ NON_SESSION_MODE feature bit to control all other
   non-session mode feature bits.
 - fix some typos. [Stefan]
 - introduce struct virtio_crypto_op_data_req_mux to support both session
   and non-session based crypto operations and keep compatibility with
   pre-existing code.

Changes since v14:
 - drop VIRTIO_CRYPTO_S_STARTED status [Halil & Cornelia]
 - correct a sentence about dataqueue and controlq in the first paragraph. 
[Halil]
 - change a MAY to MUST about max_dataqueues. [Halil]
 - add non-session mode support
   a) add four features for different crypto services to identify wheather 
support session mode.
   b) rewrite some

For pervious versions of virtio crypto spec, Pls see:

[v18]:
https://www.mail-archive.com/qemu-devel@nongnu.org/msg444897.html

[v14]:
https://lists.gnu.org/archive/html/qemu-devel/2016-11/msg02212.html

[v13]:
https://lists.gnu.org/archive/html/qemu-devel/2016-10/msg07348.html

For more information, please see:
 http://qemu-project.org/Features/VirtioCrypto

---
Gonglei (2):
  virtio-crypto: Add virtio crypto device specification
  virtio-crypto: Add conformance clauses

 acknowledgements.tex |    3 +
 conformance.tex      |   29 +
 content.tex          |    2 +
 virtio-crypto.tex    | 1470 ++++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 1504 insertions(+)
 create mode 100644 virtio-crypto.tex

-- 
2.7.4

[Qemu-devel] [PATCH v19 1/2] virtio-crypto: Add virtio crypto device specification

[Longpeng(Mike)]

From: Gonglei <arei.gonglei@huawei.com>

The virtio crypto device is a virtual crypto device (ie. hardware
crypto accelerator card). Currently, the virtio crypto device provides
the following crypto services: CIPHER, MAC, HASH, and AEAD.

In this patch, CIPHER, MAC, HASH, AEAD services are introduced.

VIRTIO-153

Signed-off-by: Gonglei <arei.gonglei@huawei.com>
Signed-off-by: Longpeng(Mike) <longpeng2@huawei.com>
---
 acknowledgements.tex |    3 +
 content.tex          |    2 +
 virtio-crypto.tex    | 1479 ++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 1484 insertions(+)
 create mode 100644 virtio-crypto.tex

diff --git a/acknowledgements.tex b/acknowledgements.tex
index 6c86d12..c4b6844 100644
--- a/acknowledgements.tex
+++ b/acknowledgements.tex
@@ -26,6 +26,8 @@ Sasha Levin,	Oracle	\newline
 Sergey Tverdyshev,	Thales e-Security	\newline
 Stefan Hajnoczi,	Red Hat	\newline
 Tom Lyon,	Samya Systems, Inc.	\newline
+Lei Gong,	Huawei	\newline
+Peng Long,	Huawei	\newline
 \end{oasistitlesection}
 
 The following non-members have provided valuable feedback on this
@@ -43,4 +45,5 @@ Laura Novich, Red Hat	\newline
 Patrick Durusau,	Technical Advisory Board, OASIS	\newline
 Thomas Huth,	IBM	\newline
 Yan Vugenfirer, Red Hat / Daynix	\newline
+Halil Pasic,	IBM	\newline
 \end{oasistitlesection}
diff --git a/content.tex b/content.tex
index d989d98..7710f8c 100644
--- a/content.tex
+++ b/content.tex
@@ -5641,6 +5641,8 @@ descriptor for the \field{sense_len}, \field{residual},
 \field{status_qualifier}, \field{status}, \field{response} and
 \field{sense} fields.
 
+\input{virtio-crypto.tex}
+
 \chapter{Reserved Feature Bits}\label{sec:Reserved Feature Bits}
 
 Currently there are three device-independent feature bits defined:
diff --git a/virtio-crypto.tex b/virtio-crypto.tex
new file mode 100644
index 0000000..1e75cbc
--- /dev/null
+++ b/virtio-crypto.tex
@@ -0,0 +1,1479 @@
+\section{Crypto Device}\label{sec:Device Types / Crypto Device}
+
+The virtio crypto device is a virtual cryptography device as well as a
+virtual cryptographic accelerator. The virtio crypto device provides the
+following crypto services: CIPHER, MAC, HASH, and AEAD. Virtio crypto
+devices have a single control queue and at least one data queue. Crypto
+operation requests are placed into a data queue, and serviced by the
+device. Some crypto operation requests are only valid in the context of a
+session. The role of the control queue is facilitating control operation
+requests. Sessions management is realized with control operation
+requests.
+
+\subsection{Device ID}\label{sec:Device Types / Crypto Device / Device ID}
+
+20
+
+\subsection{Virtqueues}\label{sec:Device Types / Crypto Device / Virtqueues}
+
+\begin{description}
+\item[0] dataq1
+\item[\ldots]
+\item[N-1] dataqN
+\item[N] controlq
+\end{description}
+
+N is set by \field{max_dataqueues}.
+
+\subsection{Feature bits}\label{sec:Device Types / Crypto Device / Feature bits}
+
+\begin{description}
+\item VIRTIO_CRYPTO_F_MUX_MODE (0) multiplexing mode is available.
+\item VIRTIO_CRYPTO_F_CIPHER_STATELESS_MODE (1) stateless mode is available for CIPHER service.
+\item VIRTIO_CRYPTO_F_HASH_STATELESS_MODE (2) stateless mode is available for HASH service.
+\item VIRTIO_CRYPTO_F_MAC_STATELESS_MODE (3) stateless mode is available for MAC service.
+\item VIRTIO_CRYPTO_F_AEAD_STATELESS_MODE (4) stateless mode is available for AEAD service.
+\end{description}
+
+\subsubsection{Feature bit requirements}\label{sec:Device Types / Crypto Device / Feature bits}
+
+Some crypto feature bits require other crypto feature bits
+(see \ref{drivernormative:Basic Facilities of a Virtio Device / Feature Bits}):
+
+\begin{description}
+\item[VIRTIO_CRYPTO_F_CIPHER_STATELESS_MODE] Requires VIRTIO_CRYPTO_F_MUX_MODE.
+\item[VIRTIO_CRYPTO_F_HASH_STATELESS_MODE] Requires VIRTIO_CRYPTO_F_MUX_MODE.
+\item[VIRTIO_CRYPTO_F_MAC_STATELESS_MODE] Requires VIRTIO_CRYPTO_F_MUX_MODE.
+\item[VIRTIO_CRYPTO_F_AEAD_STATELESS_MODE] Requires VIRTIO_CRYPTO_F_MUX_MODE.
+\end{description}
+
+\subsection{Supported crypto services}\label{sec:Device Types / Crypto Device / Supported crypto services}
+
+The following crypto services are defined:
+
+\begin{lstlisting}
+/* CIPHER service */
+#define VIRTIO_CRYPTO_SERVICE_CIPHER 0
+/* HASH service */
+#define VIRTIO_CRYPTO_SERVICE_HASH   1
+/* MAC (Message Authentication Codes) service */
+#define VIRTIO_CRYPTO_SERVICE_MAC    2
+/* AEAD (Authenticated Encryption with Associated Data) service */
+#define VIRTIO_CRYPTO_SERVICE_AEAD   3
+\end{lstlisting}
+
+The above constants designate bits used to indicate the which of crypto services are
+offered by the device as described in, see \ref{sec:Device Types / Crypto Device / Device configuration layout}.
+
+\subsubsection{CIPHER services}\label{sec:Device Types / Crypto Device / Supported crypto services / CIPHER services}
+
+The following CIPHER algorithms are defined:
+
+\begin{lstlisting}
+#define VIRTIO_CRYPTO_NO_CIPHER                 0
+#define VIRTIO_CRYPTO_CIPHER_ARC4               1
+#define VIRTIO_CRYPTO_CIPHER_AES_ECB            2
+#define VIRTIO_CRYPTO_CIPHER_AES_CBC            3
+#define VIRTIO_CRYPTO_CIPHER_AES_CTR            4
+#define VIRTIO_CRYPTO_CIPHER_DES_ECB            5
+#define VIRTIO_CRYPTO_CIPHER_DES_CBC            6
+#define VIRTIO_CRYPTO_CIPHER_3DES_ECB           7
+#define VIRTIO_CRYPTO_CIPHER_3DES_CBC           8
+#define VIRTIO_CRYPTO_CIPHER_3DES_CTR           9
+#define VIRTIO_CRYPTO_CIPHER_KASUMI_F8          10
+#define VIRTIO_CRYPTO_CIPHER_SNOW3G_UEA2        11
+#define VIRTIO_CRYPTO_CIPHER_AES_F8             12
+#define VIRTIO_CRYPTO_CIPHER_AES_XTS            13
+#define VIRTIO_CRYPTO_CIPHER_ZUC_EEA3           14
+\end{lstlisting}
+
+The above constants have two usages:
+\begin{enumerate}
+\item As bit numbers, used to tell the driver which CIPHER algorithms
+are supported by the device, see \ref{sec:Device Types / Crypto Device / Device configuration layout}.
+\item As values, used to tell the device which CIPHER algorithm
+a crypto request from the driver requires, see \ref{sec:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation}.
+\end{enumerate}
+
+\subsubsection{HASH services}\label{sec:Device Types / Crypto Device / Supported crypto services / HASH services}
+
+The following HASH algorithms are defined:
+
+\begin{lstlisting}
+#define VIRTIO_CRYPTO_NO_HASH            0
+#define VIRTIO_CRYPTO_HASH_MD5           1
+#define VIRTIO_CRYPTO_HASH_SHA1          2
+#define VIRTIO_CRYPTO_HASH_SHA_224       3
+#define VIRTIO_CRYPTO_HASH_SHA_256       4
+#define VIRTIO_CRYPTO_HASH_SHA_384       5
+#define VIRTIO_CRYPTO_HASH_SHA_512       6
+#define VIRTIO_CRYPTO_HASH_SHA3_224      7
+#define VIRTIO_CRYPTO_HASH_SHA3_256      8
+#define VIRTIO_CRYPTO_HASH_SHA3_384      9
+#define VIRTIO_CRYPTO_HASH_SHA3_512      10
+#define VIRTIO_CRYPTO_HASH_SHA3_SHAKE128      11
+#define VIRTIO_CRYPTO_HASH_SHA3_SHAKE256      12
+\end{lstlisting}
+
+The above constants have two usages:
+\begin{enumerate}
+\item As bit numbers, used to tell the driver which HASH algorithms
+are supported by the device, see \ref{sec:Device Types / Crypto Device / Device configuration layout}.
+\item As values, used to tell the device which HASH algorithm
+a crypto request from the driver requires, see \ref{sec:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation}.
+\end{enumerate}
+
+\subsubsection{MAC services}\label{sec:Device Types / Crypto Device / Supported crypto services / MAC services}
+
+The following MAC algorithms are defined:
+
+\begin{lstlisting}
+#define VIRTIO_CRYPTO_NO_MAC                       0
+#define VIRTIO_CRYPTO_MAC_HMAC_MD5                 1
+#define VIRTIO_CRYPTO_MAC_HMAC_SHA1                2
+#define VIRTIO_CRYPTO_MAC_HMAC_SHA_224             3
+#define VIRTIO_CRYPTO_MAC_HMAC_SHA_256             4
+#define VIRTIO_CRYPTO_MAC_HMAC_SHA_384             5
+#define VIRTIO_CRYPTO_MAC_HMAC_SHA_512             6
+#define VIRTIO_CRYPTO_MAC_CMAC_3DES                25
+#define VIRTIO_CRYPTO_MAC_CMAC_AES                 26
+#define VIRTIO_CRYPTO_MAC_KASUMI_F9                27
+#define VIRTIO_CRYPTO_MAC_SNOW3G_UIA2              28
+#define VIRTIO_CRYPTO_MAC_GMAC_AES                 41
+#define VIRTIO_CRYPTO_MAC_GMAC_TWOFISH             42
+#define VIRTIO_CRYPTO_MAC_CBCMAC_AES               49
+#define VIRTIO_CRYPTO_MAC_CBCMAC_KASUMI_F9         50
+#define VIRTIO_CRYPTO_MAC_XCBC_AES                 53
+#define VIRTIO_CRYPTO_MAC_ZUC_EIA3                 54
+\end{lstlisting}
+
+The above constants have two usages:
+\begin{enumerate}
+\item As bit numbers, used to tell the driver which MAC algorithms
+are supported by the device, see \ref{sec:Device Types / Crypto Device / Device configuration layout}.
+\item As values, used to tell the device which MAC algorithm
+a crypto request from the driver requires, see \ref{sec:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation}.
+\end{enumerate}
+
+\subsubsection{AEAD services}\label{sec:Device Types / Crypto Device / Supported crypto services / AEAD services}
+
+The following AEAD algorithms are defined:
+
+\begin{lstlisting}
+#define VIRTIO_CRYPTO_NO_AEAD     0
+#define VIRTIO_CRYPTO_AEAD_GCM    1
+#define VIRTIO_CRYPTO_AEAD_CCM    2
+#define VIRTIO_CRYPTO_AEAD_CHACHA20_POLY1305  3
+\end{lstlisting}
+
+The above constants have two usages:
+\begin{enumerate}
+\item As bit numbers, used to tell the driver which AEAD algorithms
+are supported by the device, see \ref{sec:Device Types / Crypto Device / Device configuration layout}.
+\item As values, used to tell the device what AEAD algorithm
+a crypto request from the driver requires, see \ref{sec:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation}.
+\end{enumerate}
+
+\subsection{Device configuration layout}\label{sec:Device Types / Crypto Device / Device configuration layout}
+
+\begin{lstlisting}
+struct virtio_crypto_config {
+    le32 status;
+    le32 max_dataqueues;
+    le32 crypto_services;
+    /* Detailed algorithms mask */
+    le32 cipher_algo_l;
+    le32 cipher_algo_h;
+    le32 hash_algo;
+    le32 mac_algo_l;
+    le32 mac_algo_h;
+    le32 aead_algo;
+    /* Maximum length of cipher key in bytes */
+    le32 max_cipher_key_len;
+    /* Maximum length of authenticated key in bytes */
+    le32 max_auth_key_len;
+    le32 reserved;
+    /* Maximum size of each crypto request's content in bytes */
+    le64 max_size;
+};
+\end{lstlisting}
+
+\begin{description}
+\item[\field{status}] is used to show whether the device is ready to work or
+    not, it can be either zero or have one or more flags. Only one read-only
+	bit (for the driver) is currently defined for the \field{status} field: VIRTIO_CRYPTO_S_HW_READY:
+\begin{lstlisting}
+#define VIRTIO_CRYPTO_S_HW_READY  (1 << 0)
+\end{lstlisting}
+
+\item[\field{max_dataqueues}] is the maximum number of data virtqueues exposed by
+    the device. The driver MAY use only one data queue,
+    or it can use more to achieve better performance.
+
+\item[\field{crypto_services}] crypto service offered, see \ref{sec:Device Types / Crypto Device / Supported crypto services}.
+
+\item[\field{cipher_algo_l}] CIPHER algorithms bits 0-31, see \ref{sec:Device Types / Crypto Device / Supported crypto services  / CIPHER services}.
+
+\item[\field{cipher_algo_h}] CIPHER algorithms bits 32-63, see \ref{sec:Device Types / Crypto Device / Supported crypto services  / CIPHER services}.
+
+\item[\field{hash_algo}] HASH algorithms bits, see \ref{sec:Device Types / Crypto Device / Supported crypto services  / HASH services}.
+
+\item[\field{mac_algo_l}] MAC algorithms bits 0-31, see \ref{sec:Device Types / Crypto Device / Supported crypto services  / MAC services}.
+
+\item[\field{mac_algo_h}] MAC algorithms bits 32-63, see \ref{sec:Device Types / Crypto Device / Supported crypto services  / MAC services}.
+
+\item[\field{aead_algo}] AEAD algorithms bits, see \ref{sec:Device Types / Crypto Device / Supported crypto services  / AEAD services}.
+
+\item[\field{max_cipher_key_len}] is the maximum length of cipher key supported by the device.
+
+\item[\field{max_auth_key_len}] is the maximum length of authenticated key supported by the device.
+
+\item[\field{reserved}] is reserved for future use.
+
+\item[\field{max_size}] is the maximum size of each crypto request's content supported by the device
+\end{description}
+
+\begin{note}
+Unless explicitly stated otherwise all lengths and sizes are in bytes.
+\end{note}
+
+\devicenormative{\subsubsection}{Device configuration layout}{Device Types / Crypto Device / Device configuration layout}
+
+\begin{itemize*}
+\item The device MUST set \field{max_dataqueues} to between 1 and 65535 inclusive.
+\item The device MUST set the \field{status} flag based on the status of the crypto
+    accelerator, Non-valid flags MUST NOT be set.
+\item The device MUST accept and handle requests after \field{status} is set to VIRTIO_CRYPTO_S_HW_READY.
+\item The device MUST set \field{crypto_services} based on the crypto services the device offers.
+\item The device MUST set detailed algorithms masks for each service advertised by \field{crypto_services}.
+    The device MUST NOT set the not defined algorithms bits.
+\item The device MUST set \field{max_size} to show the maximum size of crypto request the device supports.
+\item The device MUST set \field{max_cipher_key_len} to show the maximum length of cipher key if the
+    device supports CIPHER service.
+\item The device MUST set \field{max_auth_key_len} to show the maximum length of authenticated key if
+    the device supports MAC service.
+\end{itemize*}
+
+\drivernormative{\subsubsection}{Device configuration layout}{Device Types / Crypto Device / Device configuration layout}
+
+\begin{itemize*}
+\item The driver MUST read the ready \field{status} from the bottom bit of status to check whether the
+    crypto accelerator is ready or not, and the driver MUST reread it after device reset.
+\item The driver MUST NOT transmit any requests to the device if the ready \field{status} is not set.
+\item The driver MUST read \field{max_dataqueues} field to discover the number of data queues the device supports.
+\item The driver MUST read \field{crypto_services} field to discover which services the device is able to offer.
+\item The driver SHOULD ignore the not defined algorithms bits.
+\item The driver MUST read the detailed algorithms fields based on \field{crypto_services} field.
+\item The driver SHOULD read \field{max_size} to discover the maximum size of crypto request the device supports.
+\item The driver SHOULD read \field{max_cipher_key_len} to discover the maximum length of cipher key
+    the device supports.
+\item The driver SHOULD read \field{max_auth_key_len} to discover the maximum length of authenticated
+    key the device supports.
+\end{itemize*}
+
+\subsection{Device Initialization}\label{sec:Device Types / Crypto Device / Device Initialization}
+
+\drivernormative{\subsubsection}{Device Initialization}{Device Types / Crypto Device / Device Initialization}
+
+\begin{itemize*}
+\item The driver MUST identify and initialize all virtqueues.
+\item The driver MUST read the supported crypto services from bits of \field{crypto_services}.
+\item The driver MUST read the supported algorithms based on \field{crypto_services} field.
+\end{itemize*}
+
+\subsection{Device Operation}\label{sec:Device Types / Crypto Device / Device Operation}
+
+Requests can be transmitted by placing them in the controlq or dataq.
+Requests consist of a queue-type specific header specifying among
+others the operation, and an operation specific payload.
+The payload is generally composed of operation parameters, output data, and input data.
+Operation parameters are algorithm-specific parameters, output data is the
+data that should be utilized in operations, and input data is equal to
+"operation result + result data".
+
+The device can support both session mode (See \ref{sec:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation}) and stateless mode.
+In stateless mode all operation parameters are supplied as a part
+of each request, while in session mode, some or all operation parameters
+are managed within the session. Stateless mode is guarded by
+feature bits 0-4 on a service level. If stateless mode is negotiated
+for a service, the service is available both in session and
+stateless mode; otherwise it's only available in session mode.
+
+The device can set the operation status as follows:
+
+\begin{lstlisting}
+enum VIRTIO_CRYPTO_STATUS {
+    VIRTIO_CRYPTO_OK = 0,
+    VIRTIO_CRYPTO_ERR = 1,
+    VIRTIO_CRYPTO_BADMSG = 2,
+    VIRTIO_CRYPTO_NOTSUPP = 3,
+    VIRTIO_CRYPTO_INVSESS = 4,
+    VIRTIO_CRYPTO_NOSPC = 5,
+    VIRTIO_CRYPTO_MAX
+};
+\end{lstlisting}
+
+\begin{itemize*}
+\item VIRTIO_CRYPTO_OK: success.
+\item VIRTIO_CRYPTO_BADMSG: authentication failed (only when AEAD decryption).
+\item VIRTIO_CRYPTO_NOTSUPP: operation or algorithm is unsupported.
+\item VIRTIO_CRYPTO_INVSESS: invalid session ID when executing crypto operations.
+\item VIRTIO_CRYPTO_NOSPC: no free session ID (only when the VIRTIO_CRYPTO_F_MUX_MODE
+    feature bit is negotiated).
+\item VIRTIO_CRYPTO_ERR: any failure not mentioned above occurs.
+\end{itemize*}
+
+\subsubsection{Control Virtqueue}\label{sec:Device Types / Crypto Device / Device Operation / Control Virtqueue}
+
+The driver uses the control virtqueue to send control commands to the
+device, such as session operations (See \ref{sec:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation}).
+
+The header for controlq is of the following form:
+\begin{lstlisting}
+#define VIRTIO_CRYPTO_OPCODE(service, op)   (((service) << 8) | (op))
+
+struct virtio_crypto_ctrl_header {
+#define VIRTIO_CRYPTO_CIPHER_CREATE_SESSION \
+       VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_CIPHER, 0x02)
+#define VIRTIO_CRYPTO_CIPHER_DESTROY_SESSION \
+       VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_CIPHER, 0x03)
+#define VIRTIO_CRYPTO_HASH_CREATE_SESSION \
+       VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_HASH, 0x02)
+#define VIRTIO_CRYPTO_HASH_DESTROY_SESSION \
+       VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_HASH, 0x03)
+#define VIRTIO_CRYPTO_MAC_CREATE_SESSION \
+       VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_MAC, 0x02)
+#define VIRTIO_CRYPTO_MAC_DESTROY_SESSION \
+       VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_MAC, 0x03)
+#define VIRTIO_CRYPTO_AEAD_CREATE_SESSION \
+       VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_AEAD, 0x02)
+#define VIRTIO_CRYPTO_AEAD_DESTROY_SESSION \
+       VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_AEAD, 0x03)
+    le32 opcode;
+    /* algo should be service-specific algorithms */
+    le32 algo;
+    le32 flag;
+    /* data virtqueue id */
+    le32 queue_id;
+};
+\end{lstlisting}
+
+The format of the controlq request depends on the VIRTIO_CRYPTO_F_MUX_MODE feature bit:
+
+\begin{itemize*}
+\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is NOT negotiated the controlq request is
+    a fixed-size structure of form:
+\begin{lstlisting}
+struct virtio_crypto_op_ctrl_req {
+    struct virtio_crypto_ctrl_header header;
+
+    union {
+        struct virtio_crypto_sym_create_session_req   sym_create_session;
+        struct virtio_crypto_hash_create_session_req  hash_create_session;
+        struct virtio_crypto_mac_create_session_req   mac_create_session;
+        struct virtio_crypto_aead_create_session_req  aead_create_session;
+        struct virtio_crypto_destroy_session_req      destroy_session;
+    } u;
+};
+\end{lstlisting}
+The header is the general header, and the union is of the algorithm-specific type or the
+virtio_crypto_destroy_session_req structure, which is set by the driver. All the properties
+in the union are shown as follows.
+
+\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated the controlq request is composed
+    of two parts, the additional paramenters are preceded by the general header.
+
+\begin{lstlisting}
+struct virtio_crypto_op_ctrl_req_mux {
+    struct virtio_crypto_ctrl_header header;
+
+    /* additional paramenter */
+    u8 additional_para[addl_para_len];
+};
+\end{lstlisting}
+
+The additional paramenters are stored in a virtio_crypto_destroy_session_req structure or
+in a algorithm-specific structure:
+\begin{itemize*}
+\item struct virtio_crypto_sym_create_session_req
+\item struct virtio_crypto_hash_create_session_req
+\item struct virtio_crypto_mac_create_session_req
+\item struct virtio_crypto_aead_create_session_req
+\end{itemize*}
+All of the structures above are shown as follows.
+\end{itemize*}
+
+\paragraph{Session operation}\label{sec:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation}
+
+The session is a
+handle which describes the cryptographic parameters to be applied to
+a number of buffers.
+
+The following structure stores the result of session creation set by the device:
+
+\begin{lstlisting}
+struct virtio_crypto_session_input {
+    /* Device-writable part */
+    le64 session_id;
+    le32 status;
+    le32 padding;
+};
+\end{lstlisting}
+
+A request to destroy a session includes the following information:
+
+\begin{lstlisting}
+struct virtio_crypto_destroy_session_req {
+    /* Device-readable part */
+    le64  session_id;
+    /* Device-writable part */
+    le32  status;
+    le32  padding;
+};
+\end{lstlisting}
+
+\subparagraph{Session operation: HASH session}\label{sec:Device Types / Crypto Device / Device
+Operation / Control Virtqueue / Session operation / Session operation: HASH session}
+
+HASH session requests are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_hash_session_para {
+    /* See VIRTIO_CRYPTO_HASH_* above */
+    le32 algo;
+    /* hash result length */
+    le32 hash_result_len;
+};
+struct virtio_crypto_hash_create_session_req {
+    /* Device-readable part */
+    struct virtio_crypto_hash_session_para para;
+    /* Device-writable part */
+    struct virtio_crypto_session_input input;
+};
+\end{lstlisting}
+
+The information required by HASH session creation is stored in the virtio_crypto_hash_create_session_req
+structure, including the hash parameters stored in \field{para}. \field{input} stores the result of this operation.
+
+\subparagraph{Session operation: MAC session}\label{sec:Device Types / Crypto Device / Device
+Operation / Control Virtqueue / Session operation / Session operation: MAC session}
+
+MAC session requests are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_mac_session_para {
+    /* See VIRTIO_CRYPTO_MAC_* above */
+    le32 algo;
+    /* hash result length */
+    le32 hash_result_len;
+    /* length of authenticated key */
+    le32 auth_key_len;
+    le32 padding;
+};
+
+struct virtio_crypto_mac_create_session_req {
+    /* Device-readable part */
+    struct virtio_crypto_mac_session_para para;
+    /* The authenticated key */
+    u8 auth_key[auth_key_len];
+
+    /* Device-writable part */
+    struct virtio_crypto_session_input input;
+};
+\end{lstlisting}
+
+The information required by MAC session creation is stored in the virtio_crypto_mac_create_session_req
+structure, including the mac parameters stored in \field{para} and the authenticated key in \field{auth_key}.
+\field{input} stores the result of this operation.
+
+\subparagraph{Session operation: Symmetric algorithms session}\label{sec:Device Types / Crypto Device / Device
+Operation / Control Virtqueue / Session operation / Session operation: Symmetric algorithms session}
+
+The request of symmetric session includes two parts, CIPHER algorithms and chain
+algorithms (chaining CIPHER and HASH/MAC).
+
+CIPHER session requests are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_cipher_session_para {
+    /* See VIRTIO_CRYPTO_CIPHER* above */
+    le32 algo;
+    /* length of key */
+    le32 keylen;
+#define VIRTIO_CRYPTO_OP_ENCRYPT  1
+#define VIRTIO_CRYPTO_OP_DECRYPT  2
+    /* encryption or decryption */
+    le32 op;
+    le32 padding;
+};
+
+struct virtio_crypto_cipher_session_req {
+    /* Device-readable part */
+    struct virtio_crypto_cipher_session_para para;
+    /* The cipher key */
+    u8 cipher_key[keylen];
+
+    /* Device-writable part */
+    struct virtio_crypto_session_input input;
+};
+\end{lstlisting}
+
+Algorithm chaining requests are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_alg_chain_session_para {
+#define VIRTIO_CRYPTO_SYM_ALG_CHAIN_ORDER_HASH_THEN_CIPHER  1
+#define VIRTIO_CRYPTO_SYM_ALG_CHAIN_ORDER_CIPHER_THEN_HASH  2
+    le32 alg_chain_order;
+/* Plain hash */
+#define VIRTIO_CRYPTO_SYM_HASH_MODE_PLAIN    1
+/* Authenticated hash (mac) */
+#define VIRTIO_CRYPTO_SYM_HASH_MODE_AUTH     2
+/* Nested hash */
+#define VIRTIO_CRYPTO_SYM_HASH_MODE_NESTED   3
+    le32 hash_mode;
+    struct virtio_crypto_cipher_session_para cipher_param;
+    union {
+        struct virtio_crypto_hash_session_para hash_param;
+        struct virtio_crypto_mac_session_para mac_param;
+    } u;
+    /* length of the additional authenticated data (AAD) in bytes */
+    le32 aad_len;
+    le32 padding;
+};
+
+struct virtio_crypto_alg_chain_session_req {
+    /* Device-readable part */
+    struct virtio_crypto_alg_chain_session_para para;
+    /* The cipher key */
+    u8 cipher_key[keylen];
+    /* The authenticated key */
+    u8 auth_key[auth_key_len];
+
+    /* Device-writable part */
+    struct virtio_crypto_session_input input;
+};
+\end{lstlisting}
+
+Symmetric algorithm requests are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_sym_create_session_req {
+    union {
+        struct virtio_crypto_cipher_session_req cipher;
+        struct virtio_crypto_alg_chain_session_req chain;
+    } u;
+
+    /* Device-readable part */
+
+/* No operation */
+#define VIRTIO_CRYPTO_SYM_OP_NONE  0
+/* Cipher only operation on the data */
+#define VIRTIO_CRYPTO_SYM_OP_CIPHER  1
+/* Chain any cipher with any hash or mac operation. The order
+   depends on the value of alg_chain_order param */
+#define VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING  2
+    le32 op_type;
+    le32 padding;
+};
+\end{lstlisting}
+
+The information required by symmetric algorithms session creation is stored in the
+virtio_crypto_sym_create_session_req structure, including the symmetric operation
+type in \field{op_type} and the cipher parameters stored in \field{cipher} or the
+algorithm chaining paramenters in \field{chain}.
+
+The driver can set the \field{op_type} field in struct virtio_crypto_sym_create_session_req
+as follows: VIRTIO_CRYPTO_SYM_OP_NONE: no operation; VIRTIO_CRYPTO_SYM_OP_CIPHER: Cipher only
+operation on the data; VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING: Chain any cipher with any hash
+or mac operation.
+
+\subparagraph{Session operation: AEAD session}\label{sec:Device Types / Crypto Device / Device
+Operation / Control Virtqueue / Session operation / Session operation: AEAD session}
+
+AEAD session requests are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_aead_session_para {
+    /* See VIRTIO_CRYPTO_AEAD_* above */
+    le32 algo;
+    /* length of key */
+    le32 key_len;
+    /* Authentication tag length */
+    le32 tag_len;
+    /* The length of the additional authenticated data (AAD) in bytes */
+    le32 aad_len;
+    /* encryption or decryption, See above VIRTIO_CRYPTO_OP_* */
+    le32 op;
+    le32 padding;
+};
+
+struct virtio_crypto_aead_create_session_req {
+    /* Device-readable part */
+    struct virtio_crypto_aead_session_para para;
+    u8 key[key_len];
+
+    /* Device-writeable part */
+    struct virtio_crypto_session_input input;
+};
+\end{lstlisting}
+
+The information required by AEAD session creation is stored in the virtio_crypto_aead_create_session_req
+structure, including the aead parameters stored in \field{para} and the cipher key in \field{key}.
+\field{input} stores the result of this operation.
+
+\drivernormative{\subparagraph}{Session operation: create session}{Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation / Session operation: create session}
+
+\begin{itemize*}
+\item The driver MUST set the control general header and the corresponding algorithm-specific structure.
+    See \ref{sec:Device Types / Crypto Device / Device Operation / Control Virtqueue}.
+\item The driver MUST set the \field{opcode} field based on service type: CIPHER, HASH, MAC, or AEAD.
+\item The driver MUST set the \field{queue_id} field to show used dataq.
+\end{itemize*}
+
+\devicenormative{\subparagraph}{Session operation: create session}{Device Types / Crypto Device / Device
+Operation / Control Virtqueue / Session operation / Session operation: create session}
+
+\begin{itemize*}
+\item The device MUST use the corresponding algorithm-specific structure according to the
+    \field{opcode} in the control general header.
+\item The device MUST set the \field{status} field to one of the following values of enum
+    VIRTIO_CRYPTO_STATUS after finish a session creation:
+\begin{itemize*}
+\item VIRTIO_CRYPTO_OK if a session is created successfully.
+\item VIRTIO_CRYPTO_NOTSUPP if the requested algorithm or operation is unsupported.
+\item VIRTIO_CRYPTO_NOSPC if no free session ID (only when the VIRTIO_CRYPTO_F_MUX_MODE
+    feature bit is negotiated).
+\item VIRTIO_CRYPTO_ERR if failure not mentioned above occurs.
+\end{itemize*}
+\item The device MUST set the \field{session_id} field to a unique session identifieronly
+    if the status is set to VIRTIO_CRYPTO_OK.
+\end{itemize*}
+
+\drivernormative{\subparagraph}{Session operation: destroy session}{Device Types / Crypto Device / Device
+Operation / Control Virtqueue / Session operation / Session operation: destroy session}
+
+\begin{itemize*}
+\item The driver MUST set the \field{opcode} field based on service type: CIPHER, HASH, MAC, or AEAD.
+\item The driver MUST set the \field{session_id} to a valid value assigned by the device
+    when the session was created.
+\end{itemize*}
+
+\devicenormative{\subparagraph}{Session operation: destroy session}{Device Types / Crypto Device / Device
+Operation / Control Virtqueue / Session operation / Session operation: destroy session}
+
+\begin{itemize*}
+\item The device MUST set the \field{status} field to one of the following values of enum VIRTIO_CRYPTO_STATUS.
+\begin{itemize*}
+\item VIRTIO_CRYPTO_OK if a session is created successfully.
+\item VIRTIO_CRYPTO_ERR if any failure occurs.
+\end{itemize*}
+\end{itemize*}
+
+\subsubsection{Data Virtqueue}\label{sec:Device Types / Crypto Device / Device Operation / Data Virtqueue}
+
+The driver uses the data virtqueues to transmit crypto operation requests to the device,
+and completes the crypto operations.
+
+The header for dataq is as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_op_header {
+#define VIRTIO_CRYPTO_CIPHER_ENCRYPT \
+    VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_CIPHER, 0x00)
+#define VIRTIO_CRYPTO_CIPHER_DECRYPT \
+    VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_CIPHER, 0x01)
+#define VIRTIO_CRYPTO_HASH \
+    VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_HASH, 0x00)
+#define VIRTIO_CRYPTO_MAC \
+    VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_MAC, 0x00)
+#define VIRTIO_CRYPTO_AEAD_ENCRYPT \
+    VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_AEAD, 0x00)
+#define VIRTIO_CRYPTO_AEAD_DECRYPT \
+    VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_AEAD, 0x01)
+    le32 opcode;
+    /* algo should be service-specific algorithms */
+    le32 algo;
+    le64 session_id;
+#define VIRTIO_CRYPTO_FLAG_SESSION_MODE 1
+    /* control flag to control the request */
+    le32 flag;
+    le32 padding;
+};
+\end{lstlisting}
+
+The format of the dataq request depends on the VIRTIO_CRYPTO_F_MUX_MODE feature bit:
+
+\begin{itemize*}
+\item If VIRTIO_CRYPTO_F_MUX_MODE feature bit is NOT negotiated the dataq request is
+    a fixed-size structure of form:
+
+\begin{lstlisting}
+struct virtio_crypto_op_data_req {
+    struct virtio_crypto_op_header header;
+
+    union {
+        struct virtio_crypto_sym_data_req   sym_req;
+        struct virtio_crypto_hash_data_req  hash_req;
+        struct virtio_crypto_mac_data_req   mac_req;
+        struct virtio_crypto_aead_data_req  aead_req;
+    } u;
+};
+\end{lstlisting}
+
+The header is the general header, and the union is of the algorithm-specific type,
+which is set by the driver. All the properties in the union are shown as follows.
+
+\item If VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated the dataq requests is
+    composed of two parts, the additional paramenters are preceded by the general header:
+
+\begin{lstlisting}
+struct virtio_crypto_op_data_req_mux {
+    struct virtio_crypto_op_header header;
+
+    /* additional paramenter of the operation */
+    u8 additional_para[addl_para_len];
+};
+\end{lstlisting}
+
+The additional paramenters are stored in a algorithm-specific structure:
+\begin{itemize*}
+\item struct virtio_crypto_sym_data_req
+\item struct virtio_crypto_hash_data_req
+\item struct virtio_crypto_mac_data_req
+\item struct virtio_crypto_aead_data_req
+\item struct virtio_crypto_sym_data_req_stateless
+\item struct virtio_crypto_hash_data_req_stateless
+\item struct virtio_crypto_mac_data_req_stateless
+\item struct virtio_crypto_aead_data_req_stateless
+\end{itemize*}
+All of the structures above are shown as follows.
+\end{itemize*}
+
+There is a unified input header for all crypto services, is defined as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_inhdr {
+    u8 status;
+};
+\end{lstlisting}
+
+\subsubsection{HASH Service Operation}\label{sec:Device Types / Crypto Device / Device Operation / HASH Service Operation}
+
+Session mode HASH service requests are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_hash_para {
+    /* length of source data */
+    le32 src_data_len;
+    /* hash result length */
+    le32 hash_result_len;
+};
+
+struct virtio_crypto_hash_data_req {
+    /* Device-readable part */
+    struct virtio_crypto_hash_para para;
+    /* Source data */
+    u8 src_data[src_data_len];
+
+    /* Device-writable part */
+    /* Hash result data */
+    u8 hash_result[hash_result_len];
+    struct virtio_crypto_inhdr inhdr;
+};
+\end{lstlisting}
+
+Each data request uses virtio_crypto_hash_data_req structure to store information
+used to run the HASH operations.
+
+The information includes the hash parameters stored in \field{para}, output data
+and input data. The output data here includes the source data and the input data
+includes the hash result data used to save the results of the HASH operations.
+\field{inhdr} stores the status of executing the HASH operations.
+
+Stateless mode HASH service requests are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_hash_para_statelesss {
+    struct {
+        /* See VIRTIO_CRYPTO_HASH_* above */
+        le32 algo;
+    } sess_para;
+
+    /* length of source data */
+    le32 src_data_len;
+    /* hash result length */
+    le32 hash_result_len;
+    le32 reserved;
+};
+struct virtio_crypto_hash_data_req_stateless {
+    /* Device-readable part */
+    struct virtio_crypto_hash_para_stateless para;
+    /* Source data */
+    u8 src_data[src_data_len];
+
+    /* Device-writable part */
+    /* Hash result data */
+    u8 hash_result[hash_result_len];
+    struct virtio_crypto_inhdr inhdr;
+};
+\end{lstlisting}
+
+\drivernormative{\paragraph}{HASH Service Operation}{Device Types / Crypto Device / Device Operation / HASH Service Operation}
+
+\begin{itemize*}
+\item If the driver uses the session mode, then the driver MUST set \field{session_id}
+    in struct virtio_crypto_op_header to a valid value assigned by the device when the
+	session was created.
+\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the driver MUST use
+    struct virtio_crypto_op_data_req_mux to wrap crypto requests. Otherwise, the driver
+	MUST use struct virtio_crypto_op_data_req.
+\item If the VIRTIO_CRYPTO_F_HASH_STATELESS_MODE feature bit is negotiated, 1) if the
+    driver uses the stateless mode, then the driver MUST set the \field{flag} field in
+	struct virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_STATELESS_MODE and MUST set the
+	fields in struct virtio_crypto_hash_para_stateless.sess_para, 2) if the driver uses
+	the session mode, then the driver MUST set the \field{flag} field in struct
+	virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_SESSION_MODE.
+\item The driver MUST set \field{opcode} in struct virtio_crypto_op_header to VIRTIO_CRYPTO_HASH.
+\end{itemize*}
+
+\devicenormative{\paragraph}{HASH Service Operation}{Device Types / Crypto Device / Device Operation / HASH Service Operation}
+
+\begin{itemize*}
+\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the device MUST parse
+    the struct virtio_crypto_op_data_req_mux for crypto requests. Otherwise, the device
+	MUST parse the struct virtio_crypto_op_data_req.
+\item The device MUST use the corresponding algorithm-specific structure according to
+    the \field{opcode} in the data general header.
+\item If the VIRTIO_CRYPTO_F_HASH_STATELESS_MODE feature bit is negotiated, the device
+    MUST parse \field{flag} field in struct virtio_crypto_op_header in order to decide
+	which mode the driver uses.
+\item The device MUST copy the results of HASH operations in the hash_result[] if HASH
+    operations success.
+\item The device MUST set \field{status} in struct virtio_crypto_inhdr to one of the
+    following values of enum VIRTIO_CRYPTO_STATUS:
+\begin{itemize*}
+\item VIRTIO_CRYPTO_OK if the operation success.
+\item VIRTIO_CRYPTO_NOTSUPP if the requested algorithm or operation is unsupported.
+\item VIRTIO_CRYPTO_INVSESS if the session ID invalid when in session mode.
+\item VIRTIO_CRYPTO_ERR if any failure not mentioned above occurs.
+\end{itemize*}
+\end{itemize*}
+
+\subsubsection{MAC Service Operation}\label{sec:Device Types / Crypto Device / Device Operation / MAC Service Operation}
+
+Session mode MAC service requests are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_mac_para {
+    struct virtio_crypto_hash_para hash;
+};
+
+struct virtio_crypto_mac_data_req {
+    /* Device-readable part */
+    struct virtio_crypto_mac_para para;
+    /* Source data */
+    u8 src_data[src_data_len];
+
+    /* Device-writable part */
+    /* Hash result data */
+    u8 hash_result[hash_result_len];
+    struct virtio_crypto_inhdr inhdr;
+};
+\end{lstlisting}
+
+Each request uses the virtio_crypto_mac_data_req structure to store information
+used to run the MAC operations.
+
+The information includes the hash parameters stored in \field{para}, output data
+and input data. The output data here includes the source data and the input data
+includes the hash result data used to save the results of the MAC operations.
+\field{inhdr} stores the status of executing the MAC operations.
+
+Stateless mode MAC service requests are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_mac_para_stateless {
+    struct {
+        /* See VIRTIO_CRYPTO_MAC_* above */
+        le32 algo;
+        /* length of authenticated key */
+        le32 auth_key_len;
+    } sess_para;
+
+    /* length of source data */
+    le32 src_data_len;
+    /* hash result length */
+    le32 hash_result_len;
+};
+
+struct virtio_crypto_mac_data_req_stateless {
+    /* Device-readable part */
+    struct virtio_crypto_mac_para_stateless para;
+    /* The authenticated key */
+    u8 auth_key[auth_key_len];
+    /* Source data */
+    u8 src_data[src_data_len];
+
+    /* Device-writable part */
+    /* Hash result data */
+    u8 hash_result[hash_result_len];
+    struct virtio_crypto_inhdr inhdr;
+};
+\end{lstlisting}
+
+\drivernormative{\paragraph}{MAC Service Operation}{Device Types / Crypto Device / Device Operation / MAC Service Operation}
+
+\begin{itemize*}
+\item If the driver uses the session mode, then the driver MUST set \field{session_id}
+    in struct virtio_crypto_op_header to a valid value assigned by the device when the
+	session was created.
+\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the driver MUST use
+    struct virtio_crypto_op_data_req_mux to wrap crypto requests. Otherwise, the
+	driver MUST use struct virtio_crypto_op_data_req.
+\item If the VIRTIO_CRYPTO_F_MAC_STATELESS_MODE feature bit is negotiated, 1) if the
+    driver uses the stateless mode, then the driver MUST set the \field{flag} field
+	in struct virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_STATELESS_MODE and MUST
+	set the fields in struct virtio_crypto_mac_para_stateless.sess_para, 2) if the
+	driver uses the session mode, then the driver MUST set the \field{flag} field in
+	struct virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_SESSION_MODE.
+\item The driver MUST set \field{opcode} in struct virtio_crypto_op_header to VIRTIO_CRYPTO_MAC.
+\end{itemize*}
+
+\devicenormative{\paragraph}{MAC Service Operation}{Device Types / Crypto Device / Device Operation / MAC Service Operation}
+
+\begin{itemize*}
+\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the device MUST parse
+    the struct virtio_crypto_op_data_req_mux for crypto requests. Otherwise, the device
+	MUST parse the struct virtio_crypto_op_data_req.
+\item If the VIRTIO_CRYPTO_F_MAC_STATELESS_MODE feature bit is negotiated, the device
+    MUST parse \field{flag} field in struct virtio_crypto_op_header in order to decide
+	which mode the driver uses.
+\item The device MUST copy the results of MAC operations in the hash_result[] if HASH
+    operations success.
+\item The device MUST set \field{status} in struct virtio_crypto_inhdr to one of the
+    following values of enum VIRTIO_CRYPTO_STATUS:
+\begin{itemize*}
+\item VIRTIO_CRYPTO_OK if the operation success.
+\item VIRTIO_CRYPTO_NOTSUPP if the requested algorithm or operation is unsupported.
+\item VIRTIO_CRYPTO_INVSESS if the session ID invalid when in session mode.
+\item VIRTIO_CRYPTO_ERR if any failure not mentioned above occurs.
+\end{itemize*}
+\end{itemize*}
+
+\subsubsection{Symmetric algorithms Operation}\label{sec:Device Types / Crypto Device / Device Operation / Symmetric algorithms Operation}
+
+Session mode CIPHER service requests are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_cipher_para {
+    /*
+     * Byte Length of valid IV/Counter data pointed to by the below iv data.
+     *
+     * For block ciphers in CBC or F8 mode, or for Kasumi in F8 mode, or for
+     *   SNOW3G in UEA2 mode, this is the length of the IV (which
+     *   must be the same as the block length of the cipher).
+     * For block ciphers in CTR mode, this is the length of the counter
+     *   (which must be the same as the block length of the cipher).
+     */
+    le32 iv_len;
+    /* length of source data */
+    le32 src_data_len;
+    /* length of destination data */
+    le32 dst_data_len;
+    le32 padding;
+};
+
+struct virtio_crypto_cipher_data_req {
+    /* Device-readable part */
+    struct virtio_crypto_cipher_para para;
+    /*
+     * Initialization Vector or Counter data.
+     *
+     * For block ciphers in CBC or F8 mode, or for Kasumi in F8 mode, or for
+     *   SNOW3G in UEA2 mode, this is the Initialization Vector (IV)
+     *   value.
+     * For block ciphers in CTR mode, this is the counter.
+     * For AES-XTS, this is the 128bit tweak, i, from IEEE Std 1619-2007.
+     *
+     * The IV/Counter will be updated after every partial cryptographic
+     * operation.
+     */
+    u8 iv[iv_len];
+    /* Source data */
+    u8 src_data[src_data_len];
+
+    /* Device-writable part */
+    /* Destination data */
+    u8 dst_data[dst_data_len];
+    struct virtio_crypto_inhdr inhdr;
+};
+\end{lstlisting}
+
+Session mode requests of algorithm chaining are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_alg_chain_data_para {
+    le32 iv_len;
+    /* Length of source data */
+    le32 src_data_len;
+    /* Length of destination data */
+    le32 dst_data_len;
+    /* Starting point for cipher processing in source data */
+    le32 cipher_start_src_offset;
+    /* Length of the source data that the cipher will be computed on */
+    le32 len_to_cipher;
+    /* Starting point for hash processing in source data */
+    le32 hash_start_src_offset;
+    /* Length of the source data that the hash will be computed on */
+    le32 len_to_hash;
+    /* Length of the additional auth data */
+    le32 aad_len;
+    /* Length of the hash result */
+    le32 hash_result_len;
+    le32 reserved;
+};
+
+struct virtio_crypto_alg_chain_data_req {
+    /* Device-readable part */
+    struct virtio_crypto_alg_chain_data_para para;
+    /* Initialization Vector or Counter data */
+    u8 iv[iv_len];
+    /* Source data */
+    u8 src_data[src_data_len];
+    /* Additional authenticated data if exists */
+    u8 aad[aad_len];
+
+    /* Device-writable part */
+    /* Destination data */
+    u8 dst_data[dst_data_len];
+    /* Hash result data */
+    u8 hash_result[hash_result_len];
+    struct virtio_crypto_inhdr inhdr;
+};
+\end{lstlisting}
+
+Session mode requests of symmetric algorithm are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_sym_data_req {
+    union {
+        struct virtio_crypto_cipher_data_req cipher;
+        struct virtio_crypto_alg_chain_data_req chain;
+    } u;
+
+    /* Device-readable part */
+
+    /* See above VIRTIO_CRYPTO_SYM_OP_* */
+    le32 op_type;
+    le32 padding;
+};
+\end{lstlisting}
+
+Each request uses the virtio_crypto_sym_data_req structure to store information
+used to run the CIPHER operations.
+
+The information includes the cipher parameters stored in \field{para}, output data
+and input data. In the first virtio_crypto_cipher_para structure, \field{iv_len}
+specifies the length of the initialization vector or counter, \field{src_data_len}
+specifies the length of the source data, and \field{dst_data_len} specifies the length
+of the destination data. For plain CIPHER operations, the output data here includes
+the IV/Counter data and source data, and the input data includes the destination data
+used to save the results of the CIPHER operations.
+
+For algorithms chain, the output data here includes the IV/Counter data, source data
+and additional authenticated data if exists. The input data includes both destination
+data and hash result data used to store the results of the HASH/MAC operations.
+\field{inhdr} stores the status of executing the crypto operations.
+
+Stateless mode CIPHER service requests are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_cipher_para_stateless {
+    struct {
+        /* See VIRTIO_CRYPTO_CIPHER* above */
+        le32 algo;
+        /* length of key */
+        le32 keylen;
+
+        /* See VIRTIO_CRYPTO_OP_* above */
+        le32 op;
+    } sess_para;
+
+    /*
+     * Byte Length of valid IV/Counter data pointed to by the below iv data.
+     */
+    le32 iv_len;
+    /* length of source data */
+    le32 src_data_len;
+    /* length of destination data */
+    le32 dst_data_len;
+};
+
+struct virtio_crypto_cipher_data_req_stateless {
+    /* Device-readable part */
+    struct virtio_crypto_cipher_para_stateless para;
+    /* The cipher key */
+    u8 cipher_key[keylen];
+
+    /* Initialization Vector or Counter data. */
+    u8 iv[iv_len];
+    /* Source data */
+    u8 src_data[src_data_len];
+
+    /* Device-writable part */
+    /* Destination data */
+    u8 dst_data[dst_data_len];
+    struct virtio_crypto_inhdr inhdr;
+};
+\end{lstlisting}
+
+Stateless mode requests of algorithm chaining are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_alg_chain_data_para_stateless {
+    struct {
+        /* See VIRTIO_CRYPTO_SYM_ALG_CHAIN_ORDER_* above */
+        le32 alg_chain_order;
+        /* length of the additional authenticated data in bytes */
+        le32 aad_len;
+
+        struct {
+            /* See VIRTIO_CRYPTO_CIPHER* above */
+            le32 algo;
+            /* length of key */
+            le32 keylen;
+            /* See VIRTIO_CRYPTO_OP_* above */
+            le32 op;
+        } cipher;
+
+        struct {
+            /* See VIRTIO_CRYPTO_HASH_* or VIRTIO_CRYPTO_MAC_* above */
+            le32 algo;
+            /* length of authenticated key */
+            le32 auth_key_len;
+            /* See VIRTIO_CRYPTO_SYM_HASH_MODE_* above */
+            le32 hash_mode;
+        } hash;
+    } sess_para;
+
+    le32 iv_len;
+    /* Length of source data */
+    le32 src_data_len;
+    /* Length of destination data */
+    le32 dst_data_len;
+    /* Starting point for cipher processing in source data */
+    le32 cipher_start_src_offset;
+    /* Length of the source data that the cipher will be computed on */
+    le32 len_to_cipher;
+    /* Starting point for hash processing in source data */
+    le32 hash_start_src_offset;
+    /* Length of the source data that the hash will be computed on */
+    le32 len_to_hash;
+    /* Length of the additional auth data */
+    le32 aad_len;
+    /* Length of the hash result */
+    le32 hash_result_len;
+    le32 reserved;
+};
+
+struct virtio_crypto_alg_chain_data_req_stateless {
+    /* Device-readable part */
+    struct virtio_crypto_alg_chain_data_para_stateless para;
+    /* The cipher key */
+    u8 cipher_key[keylen];
+    /* The auth key */
+    u8 auth_key[auth_key_len];
+    /* Initialization Vector or Counter data */
+    u8 iv[iv_len];
+    /* Additional authenticated data if exists */
+    u8 aad[aad_len];
+    /* Source data */
+    u8 src_data[src_data_len];
+
+    /* Device-writable part */
+    /* Destination data */
+    u8 dst_data[dst_data_len];
+    /* Hash result data */
+    u8 hash_result[hash_result_len];
+    struct virtio_crypto_inhdr inhdr;
+};
+\end{lstlisting}
+     *    header + key + auth_key + iv + srd_data + aad + dst_data + hash_result
+Stateless mode requests of symmetric algorithm are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_sym_data_req_stateless {
+    union {
+        struct virtio_crypto_cipher_data_req_stateless cipher;
+        struct virtio_crypto_alg_chain_data_req_stateless chain;
+    } u;
+
+    /* Device-readable part */
+
+    /* See above VIRTIO_CRYPTO_SYM_OP_* */
+    le32 op_type;
+    /* Data virtqueue id */
+    uint32_t queue_id;
+};
+\end{lstlisting}
+
+\drivernormative{\paragraph}{Symmetric algorithms Operation}{Device Types / Crypto Device / Device Operation / Symmetric algorithms Operation}
+
+\begin{itemize*}
+\item If the driver uses the session mode, then the driver MUST set \field{session_id}
+    in struct virtio_crypto_op_header to a valid value assigned by the device when the
+	session was created.
+\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the driver MUST use
+    struct virtio_crypto_op_data_req_mux to wrap crypto requests. Otherwise, the driver
+	MUST use struct virtio_crypto_op_data_req.
+\item If the VIRTIO_CRYPTO_F_CIPHER_STATELESS_MODE feature bit is negotiated, 1) if the
+    driver uses the stateless mode, then the driver MUST set the \field{flag} field in
+	struct virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_STATELESS_MODE and MUST set the
+	fields in struct virtio_crypto_cipher_para_stateless.sess_para or struct
+	virtio_crypto_alg_chain_data_para_stateless.sess_para, 2) if the driver uses the
+	session mode, then the driver MUST set the \field{flag} field in struct
+	virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_SESSION_MODE.
+\item The driver MUST set the \field{opcode} field in struct virtio_crypto_op_header
+    to VIRTIO_CRYPTO_CIPHER_ENCRYPT or VIRTIO_CRYPTO_CIPHER_DECRYPT.
+\item The driver MUST specify the fields of struct virtio_crypto_cipher_data_req in
+    struct virtio_crypto_sym_data_req if the request is based on VIRTIO_CRYPTO_SYM_OP_CIPHER.
+\item The driver MUST specify the fields of both struct virtio_crypto_cipher_data_req
+    and struct virtio_crypto_mac_data_req in struct virtio_crypto_sym_data_req if the request
+	is of the VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING type and in the VIRTIO_CRYPTO_SYM_HASH_MODE_AUTH mode.
+\end{itemize*}
+
+\devicenormative{\paragraph}{Symmetric algorithms Operation}{Device Types / Crypto Device / Device Operation / Symmetric algorithms Operation}
+
+\begin{itemize*}
+\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the device MUST parse
+    the struct virtio_crypto_op_data_req_mux for crypto requests. Otherwise, the device
+	MUST parse the struct virtio_crypto_op_data_req.
+\item If the VIRTIO_CRYPTO_F_CIPHER_STATELESS_MODE feature bit is negotiated, the device
+    MUST parse \field{flag} field in struct virtio_crypto_op_header in order to decide
+	which mode the driver uses.
+\item The device MUST parse the virtio_crypto_sym_data_req based on the \field{opcode}
+    field in general header.
+\item The device SHOULD only parse fields of struct virtio_crypto_cipher_data_req in
+    struct virtio_crypto_sym_data_req if the request is VIRTIO_CRYPTO_SYM_OP_CIPHER type.
+\item The device MUST parse fields of both struct virtio_crypto_cipher_data_req and
+    struct virtio_crypto_mac_data_req in struct virtio_crypto_sym_data_req if the request
+	is of the VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING operation type and in the
+	VIRTIO_CRYPTO_SYM_HASH_MODE_AUTH mode.
+\item The device MUST copy the result of cryptographic operation in the dst_data[] in
+    both plain CIPHER mode and algorithms chain mode.
+\item The device MUST check the \field{para}.\field{add_len} is bigger than 0 before
+    parse the additional authenticated data in plain algorithms chain mode.
+\item The device MUST copy the result of HASH/MAC operation in the hash_result[] is
+    of the VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING type.
+\item The device MUST set the \field{status} field in struct virtio_crypto_inhdr to
+    one of the following values of enum VIRTIO_CRYPTO_STATUS:
+\begin{itemize*}
+\item VIRTIO_CRYPTO_OK if the operation success.
+\item VIRTIO_CRYPTO_NOTSUPP if the requested algorithm or operation is unsupported.
+\item VIRTIO_CRYPTO_INVSESS if the session ID invalid when in session mode.
+\item VIRTIO_CRYPTO_ERR if failure not mentioned above occurs.
+\end{itemize*}
+\end{itemize*}
+
+\paragraph{Steps of Operation}\label{sec:Device Types / Crypto Device / Device Operation / Symmetric algorithms Operation / Steps of Operation}
+
+The following is a example of the flow of work between the driver and the device if the VIRTIO_CRYPTO_F_MUX_MODE feature bit is NOT negotiated.
+
+\subparagraph{Step1: Create session}\label{sec:Device Types / Crypto Device / Device Operation / Symmetric algorithms Operation / Steps of Operation / Step1: Create session on session mode}
+
+\begin{enumerate}
+\item The driver specifies information in struct virtio_crypto_op_ctrl_req, including
+    the algorithm name, key, keylen etc;
+\item The driver adds the request of session creation into the controlq's Vring Descriptor Table;
+\item The driver kicks the device;
+\item The device receives the request from controlq;
+\item The device parses information about the request, and determines the information
+    concerning the crypto accelerator;
+\item The device packs information based on the APIs of the crypto accelerator;
+\item The device invokes the session creation APIs of the crypto accelerator to create a session;
+\item The device returns the session id to the driver.
+\end{enumerate}
+
+\subparagraph{Step2: Execute cryptographic operation}\label{sec:Device Types / Crypto Device / Device Operation / Symmetric algorithms Operation / Steps of Operation / Step2: Execute cryptographic operation}
+
+\begin{enumerate}
+\item The driver specifies information in struct virtio_crypto_op_data_req, including
+    struct virtio_crypto_op_header and struct virtio_crypto_sym_data_req,
+	see \ref{sec:Device Types / Crypto Device / Device Operation / Symmetric algorithms Operation};
+\item The driver adds the request for cryptographic operation into the dataq's Vring Descriptor Table;
+\item The driver kicks the device (Or the device actively polls the dataq's Vring Descriptor Table);
+\item The device receives the request from dataq;
+\item The device parses information about the request, and determines the identification
+    information for the crypto accelerator. For example, converting guest physical
+	addresses to host physical addresses;
+\item The device packs identification information based on the API of the crypto accelerator;
+\item The device invokes the cryptographic APIs of the crypto accelerator;
+\item The crypto accelerator executes the cryptographic operation implicitly;
+\item The device receives the cryptographic results from the crypto accelerator (synchronous or asynchronous);
+\item The device sets the \field{status} in struct virtio_crypto_inhdr;
+\item The device updates and flushes the Used Ring to return the cryptographic results to the driver;
+\item The device notifies the driver (Or the driver actively polls the dataq's Used Ring);
+\item The driver saves the cryptographic results.
+\end{enumerate}
+
+\subsubsection{AEAD Service Operation}\label{sec:Device Types / Crypto Device / Device Operation / AEAD Service Operation}
+
+Session mode requests of symmetric algorithm are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_aead_para {
+    /*
+     * Byte Length of valid IV data.
+     *
+     * For GCM mode, this is either 12 (for 96-bit IVs) or 16, in which
+     *   case iv points to J0.
+     * For CCM mode, this is the length of the nonce, which can be in the
+     *   range 7 to 13 inclusive.
+     */
+    le32 iv_len;
+    /* length of additional auth data */
+    le32 aad_len;
+    /* length of source data */
+    le32 src_data_len;
+    /* length of dst data, this should be at least src_data_len + tag_len */
+    le32 dst_data_len;
+    /* Authentication tag length */
+    le32 tag_len;
+    le32 reserved;
+};
+
+struct virtio_crypto_aead_data_req {
+    /* Device-readable part */
+    struct virtio_crypto_aead_para para;
+    /*
+     * Initialization Vector data.
+     *
+     * For GCM mode, this is either the IV (if the length is 96 bits) or J0
+     *   (for other sizes), where J0 is as defined by NIST SP800-38D.
+     *   Regardless of the IV length, a full 16 bytes needs to be allocated.
+     * For CCM mode, the first byte is reserved, and the nonce should be
+     *   written starting at &iv[1] (to allow space for the implementation
+     *   to write in the flags in the first byte).  Note that a full 16 bytes
+     *   should be allocated, even though the iv_len field will have
+     *   a value less than this.
+     *
+     * The IV will be updated after every partial cryptographic operation.
+     */
+    u8 iv[iv_len];
+    /* Source data */
+    u8 src_data[src_data_len];
+    /* Additional authenticated data if exists */
+    u8 aad[aad_len];
+
+    /* Device-writable part */
+    /* Pointer to output data */
+    u8 dst_data[dst_data_len];
+
+    struct virtio_crypto_inhdr inhdr;
+};
+\end{lstlisting}
+
+Each data request uses virtio_crypto_aead_data_req structure to store information
+used to run the AEAD operations.
+
+The information includes the hash parameters stored in \field{para}, output data
+and input data. In the first virtio_crypto_aead_para structure, \field{iv_len}
+specifies the length of the initialization vector. \field{tag_len} specifies the
+length of the authentication tag; \field{aad_len} specifies the length of additional
+authentication data, \field{src_data_len} specifies the length of the source data;
+\field{dst_data_len} specifies the length of the destination data, which is at least
+\field{src_data_len} + \field{tag_len}.
+
+The output data here includes the IV/Counter data, source data and additional
+authenticated data if exists. The input data includes both destination data used
+to save the results of the AEAD operations. \field{inhdr} stores the status of
+executing the AEAD operations.
+
+Stateless mode AEAD service requests are as follows:
+
+\begin{lstlisting}
+struct virtio_crypto_aead_para_stateless {
+    struct {
+        /* See VIRTIO_CRYPTO_AEAD_* above */
+        le32 algo;
+        /* length of key */
+        le32 key_len;
+        /* encrypt or decrypt, See above VIRTIO_CRYPTO_OP_* */
+        le32 op;
+    } sess_para;
+
+    /* Byte Length of valid IV data. */
+    le32 iv_len;
+    /* Authentication tag length */
+    le32 tag_len;
+    /* length of additional auth data */
+    le32 aad_len;
+    /* length of source data */
+    le32 src_data_len;
+    /* length of dst data, this should be at least src_data_len + tag_len */
+    le32 dst_data_len;
+};
+
+struct virtio_crypto_aead_data_req_stateless {
+    /* Device-readable part */
+    struct virtio_crypto_aead_para_stateless para;
+    /* The cipher key */
+    u8 key[key_len];
+    /* Initialization Vector data. */
+    u8 iv[iv_len];
+    /* Source data */
+    u8 src_data[src_data_len];
+    /* Additional authenticated data if exists */
+    u8 aad[aad_len];
+
+    /* Device-writable part */
+    /* Pointer to output data */
+    u8 dst_data[dst_data_len];
+
+    struct virtio_crypto_inhdr inhdr;
+};
+\end{lstlisting}
+
+\drivernormative{\paragraph}{AEAD Service Operation}{Device Types / Crypto Device / Device Operation / AEAD Service Operation}
+
+\begin{itemize*}
+\item If the driver uses the session mode, then the driver MUST set
+    \field{session_id} in struct virtio_crypto_op_header to a valid value assigned
+	by the device when the session was created.
+\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the driver MUST
+    use struct virtio_crypto_op_data_req_mux to wrap crypto requests. Otherwise,
+	the driver MUST use struct virtio_crypto_op_data_req.
+\item If the VIRTIO_CRYPTO_F_AEAD_STATELESS_MODE feature bit is negotiated, 1) if
+    the driver uses the stateless mode, then the driver MUST set the \field{flag}
+	field in struct virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_STATELESS_MODE
+	and MUST set the fields in struct virtio_crypto_aead_para_stateless.sess_para,
+	2) if the driver uses the session mode, then the driver MUST set the \field{flag}
+	field in struct virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_SESSION_MODE.
+\item The driver MUST set the \field{opcode} field in struct virtio_crypto_op_header
+    to VIRTIO_CRYPTO_AEAD_ENCRYPT or VIRTIO_CRYPTO_AEAD_DECRYPT.
+\end{itemize*}
+
+\devicenormative{\paragraph}{AEAD Service Operation}{Device Types / Crypto Device / Device Operation / AEAD Service Operation}
+
+\begin{itemize*}
+\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the device MUST
+    parse the struct virtio_crypto_op_data_req_mux for crypto requests. Otherwise,
+	the device MUST parse the struct virtio_crypto_op_data_req.
+\item If the VIRTIO_CRYPTO_F_AEAD_STATELESS_MODE feature bit is negotiated, the
+    device MUST parse the virtio_crypto_aead_data_req based on the \field{opcode}
+	field in general header.
+\item The device MUST copy the result of cryptographic operation in the dst_data[].
+\item The device MUST copy the authentication tag in the dst_data[] offset the cipher result.
+\item The device MUST set the \field{status} field in struct virtio_crypto_inhdr to
+    one of the following values of enum VIRTIO_CRYPTO_STATUS:
+\item When the \field{opcode} field is VIRTIO_CRYPTO_AEAD_DECRYPT, the device MUST
+    verify and return the verification result to the driver.
+\begin{itemize*}
+\item VIRTIO_CRYPTO_OK if the operation success.
+\item VIRTIO_CRYPTO_NOTSUPP if the requested algorithm or operation is unsupported.
+\item VIRTIO_CRYPTO_BADMSG if the verification result is incorrect.
+\item VIRTIO_CRYPTO_INVSESS if the session ID invalid when in session mode.
+\item VIRTIO_CRYPTO_ERR if any failure not mentioned above occurs.
+\end{itemize*}
+\end{itemize*}
-- 
2.7.4

[Qemu-devel] [PATCH v19 2/2] virtio-crypto: Add conformance clauses

[Longpeng(Mike)]

From: Gonglei <arei.gonglei@huawei.com>

Add the conformance targets and clauses for
virtio-crypto device.

Signed-off-by: Gonglei <arei.gonglei@huawei.com>
Signed-off-by: Longpeng(Mike) <longpeng2@huawei.com>
---
 conformance.tex | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/conformance.tex b/conformance.tex
index 7b7df32..266a22f 100644
--- a/conformance.tex
+++ b/conformance.tex
@@ -145,6 +145,21 @@ An SCSI host driver MUST conform to the following normative statements:
 \item \ref{drivernormative:Device Types / SCSI Host Device / Device Operation / Device Operation: eventq}
 \end{itemize}
 
+\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}
+
 \section{Device Conformance}\label{sec:Conformance / Device Conformance}
 
 A device MUST conform to the following normative statements:
@@ -265,6 +280,20 @@ An SCSI host device MUST conform to the following normative statements:
 \item \ref{devicenormative:Device Types / SCSI Host Device / Device Operation / Device Operation: eventq}
 \end{itemize}
 
+\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}
+
 \section{Legacy Interface: Transitional Device and
 Transitional Driver Conformance}\label{sec:Conformance / Legacy
 Interface: Transitional Device and 
-- 
2.7.4

Re: [Qemu-devel] [PATCH v19 0/2] virtio-crypto: virtio crypto device specification

[Longpeng (Mike)]

Ping...

Stefan, Halil, do you have any suggestion ?

-- 
Regards,
Longpeng(Mike)

On 2017/8/26 15:53, Longpeng(Mike) wrote:

> Hi guys,
> 
> I'll work on the virtio-crypto spec with Gonglei together, Because He is
> so busy on the inner production project.
> 
> ---
> v19 -> v18:
>  - fix some typos and grammar fixes [Stefan, Halil]
>  - rename VIRTIO_CRYPTO_F_STATELESS_MODE to VIRTIO_CRYPTO_F_MUX_MODE
>  - describe the VIRTIO_CRYPTO_STATUS in detial. [Halil]
>  - refactor and redescribe the controlq/dataq request's format
>    of mux mode. [Halil]
>  - other small fixes. [Halil]
> 
> v18 -> v17:
>  - fix many English grammar problems suggested by Stefan, Thanks a lot!
> 
> v17 -> v16:
>  - Some grammar fixes [Stefan, Halil, Michael]
>  - add a section named "Supported crypto services" in order to explain bit
>    numbers and valuse clearly. [Halil, Cornelia]
>  - avoid word reptition [Halil]
>  - rename non-session mode to stateless mode [Halil]
>  - change descriptions for all elements in struct virtio_crypto_config [Halil]
>  - add Halil as a reviewer in the ackonwledgement part, thanks for his work.
>  - other fixes here and there.
> 
> Changes since v15:
>  - use feature bits for non-session mode in order to keep compatibility with
>    pre-existing code. [Halil & Michael]
>  - introduce VIRTIO_CRYPTO_F_ NON_SESSION_MODE feature bit to control all other
>    non-session mode feature bits.
>  - fix some typos. [Stefan]
>  - introduce struct virtio_crypto_op_data_req_mux to support both session
>    and non-session based crypto operations and keep compatibility with
>    pre-existing code.
> 
> Changes since v14:
>  - drop VIRTIO_CRYPTO_S_STARTED status [Halil & Cornelia]
>  - correct a sentence about dataqueue and controlq in the first paragraph. 
> [Halil]
>  - change a MAY to MUST about max_dataqueues. [Halil]
>  - add non-session mode support
>    a) add four features for different crypto services to identify wheather 
> support session mode.
>    b) rewrite some
> 
> For pervious versions of virtio crypto spec, Pls see:
> 
> [v18]:
> https://www.mail-archive.com/qemu-devel@nongnu.org/msg444897.html
> 
> [v14]:
> https://lists.gnu.org/archive/html/qemu-devel/2016-11/msg02212.html
> 
> [v13]:
> https://lists.gnu.org/archive/html/qemu-devel/2016-10/msg07348.html
> 
> For more information, please see:
>  http://qemu-project.org/Features/VirtioCrypto
> 
> ---
> Gonglei (2):
>   virtio-crypto: Add virtio crypto device specification
>   virtio-crypto: Add conformance clauses
> 
>  acknowledgements.tex |    3 +
>  conformance.tex      |   29 +
>  content.tex          |    2 +
>  virtio-crypto.tex    | 1470 ++++++++++++++++++++++++++++++++++++++++++++++++++
>  4 files changed, 1504 insertions(+)
>  create mode 100644 virtio-crypto.tex
> 


-- 
Regards,
Longpeng(Mike)

Re: [Qemu-devel] [PATCH v19 0/2] virtio-crypto: virtio crypto device specification

[Halil Pasic]

On 09/01/2017 02:47 AM, Longpeng (Mike) wrote:
> Ping...
> 
> Stefan, Halil, do you have any suggestion ?
> 

Hi Longpeng,

I've ran trough your patch, and it reads much better that
what I recall v18 used to read like. Because it's been a while
since v18 doing a conscious review on this will take a considerable
amount of time (my memories of the issues identified back then
are very sketchy/vague now). It's on my todo list, but it ain't the
only item there.

Btw. I like to have a reference implementation at hand when reviewing
a spec. What is the status of the (reference) implementation (I mean
the new stuff like stateless/mux)? I think it would be nice to provide
this info in the cover letter (e.g. next time, should we need another
iteration).

Regards,
Halil

Re: [Qemu-devel] [PATCH v19 0/2] virtio-crypto: virtio crypto device specification

[Longpeng (Mike)]

Hi Halil,

On 2017/9/1 19:45, Halil Pasic wrote:

> 
> 
> On 09/01/2017 02:47 AM, Longpeng (Mike) wrote:
>> Ping...
>>
>> Stefan, Halil, do you have any suggestion ?
>>
> 
> Hi Longpeng,
> 
> I've ran trough your patch, and it reads much better that
> what I recall v18 used to read like. Because it's been a while
> since v18 doing a conscious review on this will take a considerable
> amount of time (my memories of the issues identified back then
> are very sketchy/vague now). It's on my todo list, but it ain't the
> only item there.
> 


That's great, thanks :)

> Btw. I like to have a reference implementation at hand when reviewing
> a spec. What is the status of the (reference) implementation (I mean
> the new stuff like stateless/mux)? I think it would be nice to provide
> this info in the cover letter (e.g. next time, should we need another
> iteration).
> 


OK, I'll send a reference implementation based on the v19 spec next week.

> Regards,
> Halil
> 
> 
> .
> 


-- 
Regards,
Longpeng(Mike)

Re: [Qemu-devel] [virtio-dev] Re: [PATCH v19 0/2] virtio-crypto: virtio crypto device specification

[Michael S. Tsirkin]

On Fri, Sep 01, 2017 at 01:45:45PM +0200, Halil Pasic wrote:
> 
> 
> On 09/01/2017 02:47 AM, Longpeng (Mike) wrote:
> > Ping...
> > 
> > Stefan, Halil, do you have any suggestion ?
> > 
> 
> Hi Longpeng,
> 
> I've ran trough your patch, and it reads much better that
> what I recall v18 used to read like. Because it's been a while
> since v18 doing a conscious review on this will take a considerable
> amount of time (my memories of the issues identified back then
> are very sketchy/vague now). It's on my todo list, but it ain't the
> only item there.

I don't think it's a fair reason to delay the merging though.
No comments in a while says time to merge to me.
There's always a public review period during which more comments
can be addressed.

So I think we should start a ballot on this one.
Mike - if you agree please open an issue in TC issue
tracker.  As a reminder here are the guidelines:


--

When you open an issue (can be fixed afterwards as well):

1. Fill in the reporter in the Environment: field.
2. Shortly describe the issue in the description field
   Preferably add a URL to discussion here or
   in the comments.
   If the mail was copied to virtio-comment or virtio-dev, you can use
        mid.gmane.org/<message-id>
   to quickly locate a mail in the archives.
2. Preferably, fill in all affected versions: in
   "Affects Version/s:".
   This might not apply to e.g. improvement requests.

---

When you propose the issue before the TC meeting:

1. Mark issue as Open
2. Fill in a summary of the final proposed change and
   link to full proposal in "Proposal"
   field.
   [any historical abandoned proposals and extra info can go
    into comments field]
---

Then mail me and the TC and I will start a ballot.

Thanks!

> Btw. I like to have a reference implementation at hand when reviewing
> a spec. What is the status of the (reference) implementation (I mean
> the new stuff like stateless/mux)? I think it would be nice to provide
> this info in the cover letter (e.g. next time, should we need another
> iteration).
> 
> Regards,
> Halil
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
> For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org

Re: [Qemu-devel] [virtio-dev] Re: [PATCH v19 0/2] virtio-crypto: virtio crypto device specification

[Halil Pasic]

On 09/06/2017 03:52 PM, Michael S. Tsirkin wrote:
> On Fri, Sep 01, 2017 at 01:45:45PM +0200, Halil Pasic wrote:
>>
>>
>> On 09/01/2017 02:47 AM, Longpeng (Mike) wrote:
>>> Ping...
>>>
>>> Stefan, Halil, do you have any suggestion ?
>>>
>>
>> Hi Longpeng,
>>
>> I've ran trough your patch, and it reads much better that
>> what I recall v18 used to read like. Because it's been a while
>> since v18 doing a conscious review on this will take a considerable
>> amount of time (my memories of the issues identified back then
>> are very sketchy/vague now). It's on my todo list, but it ain't the
>> only item there.
> 
> I don't think it's a fair reason to delay the merging though.
> No comments in a while says time to merge to me.
> There's always a public review period during which more comments
> can be addressed.
> 

Well, the problem is that there was no new version for a couple
of months. That's why there were no comments.

> So I think we should start a ballot on this one.
> Mike - if you agree please open an issue in TC issue
> tracker.  As a reminder here are the guidelines:
> 

I think, starting a now ballot is a bit rushed: this version is out for
less than two weeks, and there was no substantial feedback. That could be
OK if we had only minor changes in this version, but I don't think that's
the case.

Nevertheless, I'm fine with balloting. Will just have to re-prioritize
myself, have a thorough look, and if in doubt abstain.

Regards,
Halil

> 
> --
> 
> When you open an issue (can be fixed afterwards as well):
> 
> 1. Fill in the reporter in the Environment: field.
> 2. Shortly describe the issue in the description field
>    Preferably add a URL to discussion here or
>    in the comments.
>    If the mail was copied to virtio-comment or virtio-dev, you can use
>         mid.gmane.org/<message-id>
>    to quickly locate a mail in the archives.
> 2. Preferably, fill in all affected versions: in
>    "Affects Version/s:".
>    This might not apply to e.g. improvement requests.
> 
> ---
> 
> When you propose the issue before the TC meeting:
> 
> 1. Mark issue as Open
> 2. Fill in a summary of the final proposed change and
>    link to full proposal in "Proposal"
>    field.
>    [any historical abandoned proposals and extra info can go
>     into comments field]
> ---
> 
> Then mail me and the TC and I will start a ballot.
> 
> Thanks!
> 
>> Btw. I like to have a reference implementation at hand when reviewing
>> a spec. What is the status of the (reference) implementation (I mean
>> the new stuff like stateless/mux)? I think it would be nice to provide
>> this info in the cover letter (e.g. next time, should we need another
>> iteration).
>>
>> Regards,
>> Halil
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
>> For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
> For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org
> 

Re: [Qemu-devel] [virtio-dev] Re: [PATCH v19 0/2] virtio-crypto: virtio crypto device specification

[Longpeng (Mike)]

On 2017/9/6 21:52, Michael S. Tsirkin wrote:

> On Fri, Sep 01, 2017 at 01:45:45PM +0200, Halil Pasic wrote:
>>
>>
>> On 09/01/2017 02:47 AM, Longpeng (Mike) wrote:
>>> Ping...
>>>
>>> Stefan, Halil, do you have any suggestion ?
>>>
>>
>> Hi Longpeng,
>>
>> I've ran trough your patch, and it reads much better that
>> what I recall v18 used to read like. Because it's been a while
>> since v18 doing a conscious review on this will take a considerable
>> amount of time (my memories of the issues identified back then
>> are very sketchy/vague now). It's on my todo list, but it ain't the
>> only item there.

> 
> I don't think it's a fair reason to delay the merging though.
> No comments in a while says time to merge to me.
> There's always a public review period during which more comments
> can be addressed.
> 
> So I think we should start a ballot on this one.
> Mike - if you agree please open an issue in TC issue
> tracker.  As a reminder here are the guidelines:
> 


Hi Michael,

I've promised Halil to send an implementation based on the v19 this week and I
can complete it in this two days, OTOH, Halil had give some very useful
suggestions on the v18 and we also hope him could closely review the v19 spec.

So I suggest to give Halil enough time(one more week?) to review the v19 if he will.

If everything is ok, we could start a ballot on this one(if no other
suggestions) or the v20(update according with the new suggestions).

-- 
Regards,
Longpeng(Mike)

> 
> --
> 
> When you open an issue (can be fixed afterwards as well):
> 
> 1. Fill in the reporter in the Environment: field.
> 2. Shortly describe the issue in the description field
>    Preferably add a URL to discussion here or
>    in the comments.
>    If the mail was copied to virtio-comment or virtio-dev, you can use
>         mid.gmane.org/<message-id>
>    to quickly locate a mail in the archives.
> 2. Preferably, fill in all affected versions: in
>    "Affects Version/s:".
>    This might not apply to e.g. improvement requests.
> 
> ---
> 
> When you propose the issue before the TC meeting:
> 
> 1. Mark issue as Open
> 2. Fill in a summary of the final proposed change and
>    link to full proposal in "Proposal"
>    field.
>    [any historical abandoned proposals and extra info can go
>     into comments field]
> ---
> 
> Then mail me and the TC and I will start a ballot.
> 
> Thanks!
> 
>> Btw. I like to have a reference implementation at hand when reviewing
>> a spec. What is the status of the (reference) implementation (I mean
>> the new stuff like stateless/mux)? I think it would be nice to provide
>> this info in the cover letter (e.g. next time, should we need another
>> iteration).
>>
>> Regards,
>> Halil
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
>> For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org
> 
> .
> 


-- 
Regards,
Longpeng(Mike)

Re: [Qemu-devel] [PATCH v19 0/2] virtio-crypto: virtio crypto device specification

[Michael S. Tsirkin]

On Fri, Sep 01, 2017 at 08:47:28AM +0800, Longpeng (Mike) wrote:
> Ping...
> 
> Stefan, Halil, do you have any suggestion ?

I do not see this patchset in the virtio list archives.
It could be that youa re posting from an email that is
not a subscriber.

Please subscribe and repost.

We'll then have to allow up to 2 weeks for comments.

Halil, I hope this timing works for you.

> -- 
> Regards,
> Longpeng(Mike)
> 
> On 2017/8/26 15:53, Longpeng(Mike) wrote:
> 
> > Hi guys,
> > 
> > I'll work on the virtio-crypto spec with Gonglei together, Because He is
> > so busy on the inner production project.
> > 
> > ---
> > v19 -> v18:
> >  - fix some typos and grammar fixes [Stefan, Halil]
> >  - rename VIRTIO_CRYPTO_F_STATELESS_MODE to VIRTIO_CRYPTO_F_MUX_MODE
> >  - describe the VIRTIO_CRYPTO_STATUS in detial. [Halil]
> >  - refactor and redescribe the controlq/dataq request's format
> >    of mux mode. [Halil]
> >  - other small fixes. [Halil]
> > 
> > v18 -> v17:
> >  - fix many English grammar problems suggested by Stefan, Thanks a lot!
> > 
> > v17 -> v16:
> >  - Some grammar fixes [Stefan, Halil, Michael]
> >  - add a section named "Supported crypto services" in order to explain bit
> >    numbers and valuse clearly. [Halil, Cornelia]
> >  - avoid word reptition [Halil]
> >  - rename non-session mode to stateless mode [Halil]
> >  - change descriptions for all elements in struct virtio_crypto_config [Halil]
> >  - add Halil as a reviewer in the ackonwledgement part, thanks for his work.
> >  - other fixes here and there.
> > 
> > Changes since v15:
> >  - use feature bits for non-session mode in order to keep compatibility with
> >    pre-existing code. [Halil & Michael]
> >  - introduce VIRTIO_CRYPTO_F_ NON_SESSION_MODE feature bit to control all other
> >    non-session mode feature bits.
> >  - fix some typos. [Stefan]
> >  - introduce struct virtio_crypto_op_data_req_mux to support both session
> >    and non-session based crypto operations and keep compatibility with
> >    pre-existing code.
> > 
> > Changes since v14:
> >  - drop VIRTIO_CRYPTO_S_STARTED status [Halil & Cornelia]
> >  - correct a sentence about dataqueue and controlq in the first paragraph. 
> > [Halil]
> >  - change a MAY to MUST about max_dataqueues. [Halil]
> >  - add non-session mode support
> >    a) add four features for different crypto services to identify wheather 
> > support session mode.
> >    b) rewrite some
> > 
> > For pervious versions of virtio crypto spec, Pls see:
> > 
> > [v18]:
> > https://www.mail-archive.com/qemu-devel@nongnu.org/msg444897.html
> > 
> > [v14]:
> > https://lists.gnu.org/archive/html/qemu-devel/2016-11/msg02212.html
> > 
> > [v13]:
> > https://lists.gnu.org/archive/html/qemu-devel/2016-10/msg07348.html
> > 
> > For more information, please see:
> >  http://qemu-project.org/Features/VirtioCrypto
> > 
> > ---
> > Gonglei (2):
> >   virtio-crypto: Add virtio crypto device specification
> >   virtio-crypto: Add conformance clauses
> > 
> >  acknowledgements.tex |    3 +
> >  conformance.tex      |   29 +
> >  content.tex          |    2 +
> >  virtio-crypto.tex    | 1470 ++++++++++++++++++++++++++++++++++++++++++++++++++
> >  4 files changed, 1504 insertions(+)
> >  create mode 100644 virtio-crypto.tex
> > 
> 
> 
> -- 
> Regards,
> Longpeng(Mike)

Re: [Qemu-devel] [PATCH v19 0/2] virtio-crypto: virtio crypto device specification

[Longpeng (Mike)]

On 2017/9/8 11:49, Michael S. Tsirkin wrote:

> On Fri, Sep 01, 2017 at 08:47:28AM +0800, Longpeng (Mike) wrote:
>> Ping...
>>
>> Stefan, Halil, do you have any suggestion ?
> 
> I do not see this patchset in the virtio list archives.
> It could be that youa re posting from an email that is
> not a subscriber.
> 
> Please subscribe and repost.
> 


OK, I'll subscribe and repost after I complete the implementation based on the
v19 :)

> We'll then have to allow up to 2 weeks for comments.
> 
> Halil, I hope this timing works for you.
> 
>> -- 
>> Regards,
>> Longpeng(Mike)
>>
>> On 2017/8/26 15:53, Longpeng(Mike) wrote:
>>
>>> Hi guys,
>>>
>>> I'll work on the virtio-crypto spec with Gonglei together, Because He is
>>> so busy on the inner production project.
>>>
>>> ---
>>> v19 -> v18:
>>>  - fix some typos and grammar fixes [Stefan, Halil]
>>>  - rename VIRTIO_CRYPTO_F_STATELESS_MODE to VIRTIO_CRYPTO_F_MUX_MODE
>>>  - describe the VIRTIO_CRYPTO_STATUS in detial. [Halil]
>>>  - refactor and redescribe the controlq/dataq request's format
>>>    of mux mode. [Halil]
>>>  - other small fixes. [Halil]
>>>
>>> v18 -> v17:
>>>  - fix many English grammar problems suggested by Stefan, Thanks a lot!
>>>
>>> v17 -> v16:
>>>  - Some grammar fixes [Stefan, Halil, Michael]
>>>  - add a section named "Supported crypto services" in order to explain bit
>>>    numbers and valuse clearly. [Halil, Cornelia]
>>>  - avoid word reptition [Halil]
>>>  - rename non-session mode to stateless mode [Halil]
>>>  - change descriptions for all elements in struct virtio_crypto_config [Halil]
>>>  - add Halil as a reviewer in the ackonwledgement part, thanks for his work.
>>>  - other fixes here and there.
>>>
>>> Changes since v15:
>>>  - use feature bits for non-session mode in order to keep compatibility with
>>>    pre-existing code. [Halil & Michael]
>>>  - introduce VIRTIO_CRYPTO_F_ NON_SESSION_MODE feature bit to control all other
>>>    non-session mode feature bits.
>>>  - fix some typos. [Stefan]
>>>  - introduce struct virtio_crypto_op_data_req_mux to support both session
>>>    and non-session based crypto operations and keep compatibility with
>>>    pre-existing code.
>>>
>>> Changes since v14:
>>>  - drop VIRTIO_CRYPTO_S_STARTED status [Halil & Cornelia]
>>>  - correct a sentence about dataqueue and controlq in the first paragraph. 
>>> [Halil]
>>>  - change a MAY to MUST about max_dataqueues. [Halil]
>>>  - add non-session mode support
>>>    a) add four features for different crypto services to identify wheather 
>>> support session mode.
>>>    b) rewrite some
>>>
>>> For pervious versions of virtio crypto spec, Pls see:
>>>
>>> [v18]:
>>> https://www.mail-archive.com/qemu-devel@nongnu.org/msg444897.html
>>>
>>> [v14]:
>>> https://lists.gnu.org/archive/html/qemu-devel/2016-11/msg02212.html
>>>
>>> [v13]:
>>> https://lists.gnu.org/archive/html/qemu-devel/2016-10/msg07348.html
>>>
>>> For more information, please see:
>>>  http://qemu-project.org/Features/VirtioCrypto
>>>
>>> ---
>>> Gonglei (2):
>>>   virtio-crypto: Add virtio crypto device specification
>>>   virtio-crypto: Add conformance clauses
>>>
>>>  acknowledgements.tex |    3 +
>>>  conformance.tex      |   29 +
>>>  content.tex          |    2 +
>>>  virtio-crypto.tex    | 1470 ++++++++++++++++++++++++++++++++++++++++++++++++++
>>>  4 files changed, 1504 insertions(+)
>>>  create mode 100644 virtio-crypto.tex
>>>
>>
>>
>> -- 
>> Regards,
>> Longpeng(Mike)
> 
> .
> 


-- 
Regards,
Longpeng(Mike)

Re: [Qemu-devel] [PATCH v19 0/2] virtio-crypto: virtio crypto device specification

[Michael S. Tsirkin]

On Fri, Sep 08, 2017 at 12:22:01PM +0800, Longpeng (Mike) wrote:
> 
> 
> On 2017/9/8 11:49, Michael S. Tsirkin wrote:
> 
> > On Fri, Sep 01, 2017 at 08:47:28AM +0800, Longpeng (Mike) wrote:
> >> Ping...
> >>
> >> Stefan, Halil, do you have any suggestion ?
> > 
> > I do not see this patchset in the virtio list archives.
> > It could be that youa re posting from an email that is
> > not a subscriber.
> > 
> > Please subscribe and repost.
> > 
> 
> 
> OK, I'll subscribe and repost after I complete the implementation based on the
> v19 :)

To clarify does not existing device in qemu work according to
this spec? We need to make the spec compatible with what's
out there in the field somehow (feature bit?).

> > We'll then have to allow up to 2 weeks for comments.
> > 
> > Halil, I hope this timing works for you.
> > 
> >> -- 
> >> Regards,
> >> Longpeng(Mike)
> >>
> >> On 2017/8/26 15:53, Longpeng(Mike) wrote:
> >>
> >>> Hi guys,
> >>>
> >>> I'll work on the virtio-crypto spec with Gonglei together, Because He is
> >>> so busy on the inner production project.
> >>>
> >>> ---
> >>> v19 -> v18:
> >>>  - fix some typos and grammar fixes [Stefan, Halil]
> >>>  - rename VIRTIO_CRYPTO_F_STATELESS_MODE to VIRTIO_CRYPTO_F_MUX_MODE
> >>>  - describe the VIRTIO_CRYPTO_STATUS in detial. [Halil]
> >>>  - refactor and redescribe the controlq/dataq request's format
> >>>    of mux mode. [Halil]
> >>>  - other small fixes. [Halil]
> >>>
> >>> v18 -> v17:
> >>>  - fix many English grammar problems suggested by Stefan, Thanks a lot!
> >>>
> >>> v17 -> v16:
> >>>  - Some grammar fixes [Stefan, Halil, Michael]
> >>>  - add a section named "Supported crypto services" in order to explain bit
> >>>    numbers and valuse clearly. [Halil, Cornelia]
> >>>  - avoid word reptition [Halil]
> >>>  - rename non-session mode to stateless mode [Halil]
> >>>  - change descriptions for all elements in struct virtio_crypto_config [Halil]
> >>>  - add Halil as a reviewer in the ackonwledgement part, thanks for his work.
> >>>  - other fixes here and there.
> >>>
> >>> Changes since v15:
> >>>  - use feature bits for non-session mode in order to keep compatibility with
> >>>    pre-existing code. [Halil & Michael]
> >>>  - introduce VIRTIO_CRYPTO_F_ NON_SESSION_MODE feature bit to control all other
> >>>    non-session mode feature bits.
> >>>  - fix some typos. [Stefan]
> >>>  - introduce struct virtio_crypto_op_data_req_mux to support both session
> >>>    and non-session based crypto operations and keep compatibility with
> >>>    pre-existing code.
> >>>
> >>> Changes since v14:
> >>>  - drop VIRTIO_CRYPTO_S_STARTED status [Halil & Cornelia]
> >>>  - correct a sentence about dataqueue and controlq in the first paragraph. 
> >>> [Halil]
> >>>  - change a MAY to MUST about max_dataqueues. [Halil]
> >>>  - add non-session mode support
> >>>    a) add four features for different crypto services to identify wheather 
> >>> support session mode.
> >>>    b) rewrite some
> >>>
> >>> For pervious versions of virtio crypto spec, Pls see:
> >>>
> >>> [v18]:
> >>> https://www.mail-archive.com/qemu-devel@nongnu.org/msg444897.html
> >>>
> >>> [v14]:
> >>> https://lists.gnu.org/archive/html/qemu-devel/2016-11/msg02212.html
> >>>
> >>> [v13]:
> >>> https://lists.gnu.org/archive/html/qemu-devel/2016-10/msg07348.html
> >>>
> >>> For more information, please see:
> >>>  http://qemu-project.org/Features/VirtioCrypto
> >>>
> >>> ---
> >>> Gonglei (2):
> >>>   virtio-crypto: Add virtio crypto device specification
> >>>   virtio-crypto: Add conformance clauses
> >>>
> >>>  acknowledgements.tex |    3 +
> >>>  conformance.tex      |   29 +
> >>>  content.tex          |    2 +
> >>>  virtio-crypto.tex    | 1470 ++++++++++++++++++++++++++++++++++++++++++++++++++
> >>>  4 files changed, 1504 insertions(+)
> >>>  create mode 100644 virtio-crypto.tex
> >>>
> >>
> >>
> >> -- 
> >> Regards,
> >> Longpeng(Mike)
> > 
> > .
> > 
> 
> 
> -- 
> Regards,
> Longpeng(Mike)

Re: [Qemu-devel] [PATCH v19 0/2] virtio-crypto: virtio crypto device specification

[Longpeng (Mike)]

On 2017/9/8 12:31, Michael S. Tsirkin wrote:

> On Fri, Sep 08, 2017 at 12:22:01PM +0800, Longpeng (Mike) wrote:
>>
>>
>> On 2017/9/8 11:49, Michael S. Tsirkin wrote:
>>
>>> On Fri, Sep 01, 2017 at 08:47:28AM +0800, Longpeng (Mike) wrote:
>>>> Ping...
>>>>
>>>> Stefan, Halil, do you have any suggestion ?
>>>
>>> I do not see this patchset in the virtio list archives.
>>> It could be that youa re posting from an email that is
>>> not a subscriber.
>>>
>>> Please subscribe and repost.
>>>
>>
>>
>> OK, I'll subscribe and repost after I complete the implementation based on the
>> v19 :)
> 
> To clarify does not existing device in qemu work according to
> this spec? We need to make the spec compatible with what's
> out there in the field somehow (feature bit?).


Yep, the spec is compatible with the existing device in QEMU by a feature
bit(VIRTIO_CRYPTO_F_MUX_MODE).

> 
>>> We'll then have to allow up to 2 weeks for comments.
>>>
>>> Halil, I hope this timing works for you.
>>>
>>>> -- 
>>>> Regards,
>>>> Longpeng(Mike)
>>>>
>>>> On 2017/8/26 15:53, Longpeng(Mike) wrote:
>>>>
>>>>> Hi guys,
>>>>>
>>>>> I'll work on the virtio-crypto spec with Gonglei together, Because He is
>>>>> so busy on the inner production project.
>>>>>
>>>>> ---
>>>>> v19 -> v18:
>>>>>  - fix some typos and grammar fixes [Stefan, Halil]
>>>>>  - rename VIRTIO_CRYPTO_F_STATELESS_MODE to VIRTIO_CRYPTO_F_MUX_MODE
>>>>>  - describe the VIRTIO_CRYPTO_STATUS in detial. [Halil]
>>>>>  - refactor and redescribe the controlq/dataq request's format
>>>>>    of mux mode. [Halil]
>>>>>  - other small fixes. [Halil]
>>>>>
>>>>> v18 -> v17:
>>>>>  - fix many English grammar problems suggested by Stefan, Thanks a lot!
>>>>>
>>>>> v17 -> v16:
>>>>>  - Some grammar fixes [Stefan, Halil, Michael]
>>>>>  - add a section named "Supported crypto services" in order to explain bit
>>>>>    numbers and valuse clearly. [Halil, Cornelia]
>>>>>  - avoid word reptition [Halil]
>>>>>  - rename non-session mode to stateless mode [Halil]
>>>>>  - change descriptions for all elements in struct virtio_crypto_config [Halil]
>>>>>  - add Halil as a reviewer in the ackonwledgement part, thanks for his work.
>>>>>  - other fixes here and there.
>>>>>
>>>>> Changes since v15:
>>>>>  - use feature bits for non-session mode in order to keep compatibility with
>>>>>    pre-existing code. [Halil & Michael]
>>>>>  - introduce VIRTIO_CRYPTO_F_ NON_SESSION_MODE feature bit to control all other
>>>>>    non-session mode feature bits.
>>>>>  - fix some typos. [Stefan]
>>>>>  - introduce struct virtio_crypto_op_data_req_mux to support both session
>>>>>    and non-session based crypto operations and keep compatibility with
>>>>>    pre-existing code.
>>>>>
>>>>> Changes since v14:
>>>>>  - drop VIRTIO_CRYPTO_S_STARTED status [Halil & Cornelia]
>>>>>  - correct a sentence about dataqueue and controlq in the first paragraph. 
>>>>> [Halil]
>>>>>  - change a MAY to MUST about max_dataqueues. [Halil]
>>>>>  - add non-session mode support
>>>>>    a) add four features for different crypto services to identify wheather 
>>>>> support session mode.
>>>>>    b) rewrite some
>>>>>
>>>>> For pervious versions of virtio crypto spec, Pls see:
>>>>>
>>>>> [v18]:
>>>>> https://www.mail-archive.com/qemu-devel@nongnu.org/msg444897.html
>>>>>
>>>>> [v14]:
>>>>> https://lists.gnu.org/archive/html/qemu-devel/2016-11/msg02212.html
>>>>>
>>>>> [v13]:
>>>>> https://lists.gnu.org/archive/html/qemu-devel/2016-10/msg07348.html
>>>>>
>>>>> For more information, please see:
>>>>>  http://qemu-project.org/Features/VirtioCrypto
>>>>>
>>>>> ---
>>>>> Gonglei (2):
>>>>>   virtio-crypto: Add virtio crypto device specification
>>>>>   virtio-crypto: Add conformance clauses
>>>>>
>>>>>  acknowledgements.tex |    3 +
>>>>>  conformance.tex      |   29 +
>>>>>  content.tex          |    2 +
>>>>>  virtio-crypto.tex    | 1470 ++++++++++++++++++++++++++++++++++++++++++++++++++
>>>>>  4 files changed, 1504 insertions(+)
>>>>>  create mode 100644 virtio-crypto.tex
>>>>>
>>>>
>>>>
>>>> -- 
>>>> Regards,
>>>> Longpeng(Mike)
>>>
>>> .
>>>
>>
>>
>> -- 
>> Regards,
>> Longpeng(Mike)
> 
> .
> 


-- 
Regards,
Longpeng(Mike)