| Message ID | 1474386430-80014-1-git-send-email-xin.zeng@intel.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
> -----Original Message----- > From: virtio-dev@lists.oasis-open.org [mailto:virtio-dev@lists.oasis-open.org] > On Behalf Of Xin Zeng > Sent: Tuesday, September 20, 2016 11:47 PM > Subject: [virtio-dev] [PATCH] virtio crypto device specification > > Fix spelling mistakes of keywords to make xelatex happy: > filed--->field > Oops, my typos, thank you. :) Regards, -Gonglei > Signed-off-by: Xin Zeng <xin.zeng@intel.com> > --- > virtio-crypto.tex | 18 +++++++++--------- > 1 file changed, 9 insertions(+), 9 deletions(-) > > diff --git a/virtio-crypto.tex b/virtio-crypto.tex > index ac1fc0a..c3554e3 100644 > --- a/virtio-crypto.tex > +++ b/virtio-crypto.tex > @@ -159,7 +159,7 @@ More algorithms will be defined in the future. > \begin{itemize*} > \item The driver MUST read the ready \field{status} from the bottom bit of > status to check whether the hardware-backed > implementation is ready or not, and the driver MUST reread it after > the device reset. > -\item The driver MUST NOT transmit any packets to the device if the ready > \filed{status} is not set. > +\item The driver MUST NOT transmit any packets to the device if the ready > \field{status} is not set. > \item The driver MAY 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 MUST read the detailed algorithms fields based on > \field{crypto_services} field. > @@ -634,7 +634,7 @@ The driver MUST set \field{src_data}.\field{flag} to > ~VIRTIO_CRYPTO_IOVEC_F_NEXT > > \devicenormative{\subparagraph}{HASH Service Operation}{Device Types / > Crypto Device / Device Operation / Data Virtqueue / HASH Service Operation} > > -The device MUST copy the results of HASH operations to the guest memory > recorded by \field{digest_result_addr} filed in struct virtio_crypto_hash_input. > +The device MUST copy the results of HASH operations to the guest memory > recorded by \field{digest_result_addr} field in struct virtio_crypto_hash_input. > The device MUST set \field{status} in strut virtio_crypto_hash_input: > VIRTIO_CRYPTO_OP_OK: success; VIRTIO_CRYPTO_OP_ERR: creation failed or > device error; VIRTIO_CRYPTO_OP_NOTSUPP: not support. > > \paragraph{MAC Service Operation}\label{sec:Device Types / Crypto Device / > Device Operation / Data Virtqueue / MAC Service Operation} > @@ -685,7 +685,7 @@ The driver MUST set > \field{hash_output}.\field{src_data}.\field{flag} to ~VIRTIO > > \devicenormative{\subparagraph}{MAC Service Operation}{Device Types / > Crypto Device / Device Operation / Data Virtqueue / MAC Service Operation} > > -The device MUST copy the results of MAC operations to the guest memory > recorded by \field{digest_result_addr} filed in struct virtio_crypto_mac_input. > +The device MUST copy the results of MAC operations to the guest memory > recorded by \field{digest_result_addr} field in struct virtio_crypto_mac_input. > The device MUST set \field{status} in strut virtio_crypto_mac_input: > VIRTIO_CRYPTO_OP_OK: success; VIRTIO_CRYPTO_OP_ERR: creation failed or > device error; VIRTIO_CRYPTO_OP_NOTSUPP: not support. > > \paragraph{Symmetric algorithms Operation}\label{sec:Device Types / Crypto > Device / Device Operation / Data Virtqueue / Symmetric algorithms Operation} > @@ -813,9 +813,9 @@ The device MUST parse the > virtio_crypto_sym_data_req based on the \field{op_code > The device SHOULD only parse fields of struct virtio_crypto_cipher_data_req > in struct virtio_crypto_sym_data_req if the created session is > VIRTIO_CRYPTO_SYM_OP_CIPHER type. > 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 created > session is of the VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING > operation type and in the VIRTIO_CRYPTO_SYM_HASH_MODE_AUTH mode. > -The device MUST copy the result of cryptographic operation to the guest > memory recorded by \filed{dst_data}.\field{addr} filed in struct > virtio_crypto_cipher_input in plain CIPHER mode. > -The device MUST copy the result of HASH/MAC operation to the guest > memory recorded by \filed{digest_result_addr} filed in struct > virtio_crypto_alg_chain_data_input is of the > VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING type. > -The device MUST set the \filed{status} field in strut virtio_crypto_cipher_input > or virtio_crypto_alg_chain_data_input structure: > +The device MUST copy the result of cryptographic operation to the guest > memory recorded by \field{dst_data}.\field{addr} field in struct > virtio_crypto_cipher_input in plain CIPHER mode. > +The device MUST copy the result of HASH/MAC operation to the guest > memory recorded by \field{digest_result_addr} field in struct > virtio_crypto_alg_chain_data_input is of the > VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING type. > +The device MUST set the \field{status} field in strut virtio_crypto_cipher_input > or virtio_crypto_alg_chain_data_input structure: > VIRTIO_CRYPTO_OP_OK: success; VIRTIO_CRYPTO_OP_ERR: creation failed > or device error; VIRTIO_CRYPTO_OP_NOTSUPP: not supported. > > \subparagraph{Steps of Operation}\label{sec:Device Types / Crypto Device / > Device Operation / Data Virtqueue / Symmetric algorithms Operation / Steps of > Operation} > @@ -936,7 +936,7 @@ The driver MUST set \field{src_data}.\field{flag} to > ~VIRTIO_CRYPTO_IOVEC_F_NEXT > \devicenormative{\subparagraph}{AEAD Service Operation}{Device Types / > Crypto Device / Device Operation / Data Virtqueue / AEAD Service Operation} > > The device MUST parse the virtio_crypto_aead_data_req based on the > \field{op_code} in general header. > -The device MUST copy the result of cryptographic operation to the guest > memory recorded by \filed{dst_data}.\field{addr} filed in struct > virtio_crypto_aead_input. > -The device MUST copy the digest result to the guest memory recorded by > \filed{digest_result_addr} filed in struct virtio_crypto_aead_input. > -The device MUST set the \filed{status} field in strut virtio_crypto_aead_input: > VIRTIO_CRYPTO_OP_OK: success; VIRTIO_CRYPTO_OP_ERR: creation failed or > device error; VIRTIO_CRYPTO_OP_NOTSUPP: not supported. > +The device MUST copy the result of cryptographic operation to the guest > memory recorded by \field{dst_data}.\field{addr} field in struct > virtio_crypto_aead_input. > +The device MUST copy the digest result to the guest memory recorded by > \field{digest_result_addr} field in struct virtio_crypto_aead_input. > +The device MUST set the \field{status} field in strut virtio_crypto_aead_input: > VIRTIO_CRYPTO_OP_OK: success; VIRTIO_CRYPTO_OP_ERR: creation failed or > device error; VIRTIO_CRYPTO_OP_NOTSUPP: not supported. > When the \field{op_code} is VIRTIO_CRYPTO_AEAD_DECRYPT, the device > MUST verify and return the verification result to the driver, and if the > verification result is incorrect, VIRTIO_CRYPTO_OP_BADMSG (bad message) > MUST be returned to the driver. > \ No newline at end of file > -- > 1.9.3 > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org > For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org
diff --git a/virtio-crypto.tex b/virtio-crypto.tex index ac1fc0a..c3554e3 100644 --- a/virtio-crypto.tex +++ b/virtio-crypto.tex @@ -159,7 +159,7 @@ More algorithms will be defined in the future. \begin{itemize*} \item The driver MUST read the ready \field{status} from the bottom bit of status to check whether the hardware-backed implementation is ready or not, and the driver MUST reread it after the device reset. -\item The driver MUST NOT transmit any packets to the device if the ready \filed{status} is not set. +\item The driver MUST NOT transmit any packets to the device if the ready \field{status} is not set. \item The driver MAY 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 MUST read the detailed algorithms fields based on \field{crypto_services} field. @@ -634,7 +634,7 @@ The driver MUST set \field{src_data}.\field{flag} to ~VIRTIO_CRYPTO_IOVEC_F_NEXT \devicenormative{\subparagraph}{HASH Service Operation}{Device Types / Crypto Device / Device Operation / Data Virtqueue / HASH Service Operation} -The device MUST copy the results of HASH operations to the guest memory recorded by \field{digest_result_addr} filed in struct virtio_crypto_hash_input. +The device MUST copy the results of HASH operations to the guest memory recorded by \field{digest_result_addr} field in struct virtio_crypto_hash_input. The device MUST set \field{status} in strut virtio_crypto_hash_input: VIRTIO_CRYPTO_OP_OK: success; VIRTIO_CRYPTO_OP_ERR: creation failed or device error; VIRTIO_CRYPTO_OP_NOTSUPP: not support. \paragraph{MAC Service Operation}\label{sec:Device Types / Crypto Device / Device Operation / Data Virtqueue / MAC Service Operation} @@ -685,7 +685,7 @@ The driver MUST set \field{hash_output}.\field{src_data}.\field{flag} to ~VIRTIO \devicenormative{\subparagraph}{MAC Service Operation}{Device Types / Crypto Device / Device Operation / Data Virtqueue / MAC Service Operation} -The device MUST copy the results of MAC operations to the guest memory recorded by \field{digest_result_addr} filed in struct virtio_crypto_mac_input. +The device MUST copy the results of MAC operations to the guest memory recorded by \field{digest_result_addr} field in struct virtio_crypto_mac_input. The device MUST set \field{status} in strut virtio_crypto_mac_input: VIRTIO_CRYPTO_OP_OK: success; VIRTIO_CRYPTO_OP_ERR: creation failed or device error; VIRTIO_CRYPTO_OP_NOTSUPP: not support. \paragraph{Symmetric algorithms Operation}\label{sec:Device Types / Crypto Device / Device Operation / Data Virtqueue / Symmetric algorithms Operation} @@ -813,9 +813,9 @@ The device MUST parse the virtio_crypto_sym_data_req based on the \field{op_code The device SHOULD only parse fields of struct virtio_crypto_cipher_data_req in struct virtio_crypto_sym_data_req if the created session is VIRTIO_CRYPTO_SYM_OP_CIPHER type. 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 created session is of the VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING operation type and in the VIRTIO_CRYPTO_SYM_HASH_MODE_AUTH mode. -The device MUST copy the result of cryptographic operation to the guest memory recorded by \filed{dst_data}.\field{addr} filed in struct virtio_crypto_cipher_input in plain CIPHER mode. -The device MUST copy the result of HASH/MAC operation to the guest memory recorded by \filed{digest_result_addr} filed in struct virtio_crypto_alg_chain_data_input is of the VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING type. -The device MUST set the \filed{status} field in strut virtio_crypto_cipher_input or virtio_crypto_alg_chain_data_input structure: +The device MUST copy the result of cryptographic operation to the guest memory recorded by \field{dst_data}.\field{addr} field in struct virtio_crypto_cipher_input in plain CIPHER mode. +The device MUST copy the result of HASH/MAC operation to the guest memory recorded by \field{digest_result_addr} field in struct virtio_crypto_alg_chain_data_input is of the VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING type. +The device MUST set the \field{status} field in strut virtio_crypto_cipher_input or virtio_crypto_alg_chain_data_input structure: VIRTIO_CRYPTO_OP_OK: success; VIRTIO_CRYPTO_OP_ERR: creation failed or device error; VIRTIO_CRYPTO_OP_NOTSUPP: not supported. \subparagraph{Steps of Operation}\label{sec:Device Types / Crypto Device / Device Operation / Data Virtqueue / Symmetric algorithms Operation / Steps of Operation} @@ -936,7 +936,7 @@ The driver MUST set \field{src_data}.\field{flag} to ~VIRTIO_CRYPTO_IOVEC_F_NEXT \devicenormative{\subparagraph}{AEAD Service Operation}{Device Types / Crypto Device / Device Operation / Data Virtqueue / AEAD Service Operation} The device MUST parse the virtio_crypto_aead_data_req based on the \field{op_code} in general header. -The device MUST copy the result of cryptographic operation to the guest memory recorded by \filed{dst_data}.\field{addr} filed in struct virtio_crypto_aead_input. -The device MUST copy the digest result to the guest memory recorded by \filed{digest_result_addr} filed in struct virtio_crypto_aead_input. -The device MUST set the \filed{status} field in strut virtio_crypto_aead_input: VIRTIO_CRYPTO_OP_OK: success; VIRTIO_CRYPTO_OP_ERR: creation failed or device error; VIRTIO_CRYPTO_OP_NOTSUPP: not supported. +The device MUST copy the result of cryptographic operation to the guest memory recorded by \field{dst_data}.\field{addr} field in struct virtio_crypto_aead_input. +The device MUST copy the digest result to the guest memory recorded by \field{digest_result_addr} field in struct virtio_crypto_aead_input. +The device MUST set the \field{status} field in strut virtio_crypto_aead_input: VIRTIO_CRYPTO_OP_OK: success; VIRTIO_CRYPTO_OP_ERR: creation failed or device error; VIRTIO_CRYPTO_OP_NOTSUPP: not supported. When the \field{op_code} is VIRTIO_CRYPTO_AEAD_DECRYPT, the device MUST verify and return the verification result to the driver, and if the verification result is incorrect, VIRTIO_CRYPTO_OP_BADMSG (bad message) MUST be returned to the driver. \ No newline at end of file
Fix spelling mistakes of keywords to make xelatex happy: filed--->field Signed-off-by: Xin Zeng <xin.zeng@intel.com> --- virtio-crypto.tex | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-)