path: root/include/crypto
diff options
authorStephan Mueller <smueller@chronox.de>2015-05-28 08:52:42 +0200
committerHerbert Xu <herbert@gondor.apana.org.au>2015-06-03 10:48:32 +0800
commitaddfda2fc2ed2fcd7896ef689aa75a7d35a7579b (patch)
tree678043407aa4bd793a49b9283feccc7f2bf3b104 /include/crypto
parentb64a2d95527092ed6d83fd6754ad2e94423d33b8 (diff)
crypto: doc - cover new AEAD interface
The patch updates the DocBook to cover the new AEAD interface implementation. Signed-off-by: Stephan Mueller <smueller@chronox.de> Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
Diffstat (limited to 'include/crypto')
1 files changed, 4 insertions, 1 deletions
diff --git a/include/crypto/aead.h b/include/crypto/aead.h
index 61306ed81b8f..1a273bc5656c 100644
--- a/include/crypto/aead.h
+++ b/include/crypto/aead.h
@@ -50,6 +50,7 @@
* struct aead_request - AEAD request
* @base: Common attributes for async crypto requests
+ * @old: Boolean whether the old or new AEAD API is used
* @assoclen: Length in bytes of associated data for authentication
* @cryptlen: Length of data to be encrypted or decrypted
* @iv: Initialisation vector
@@ -467,7 +468,9 @@ static inline void aead_request_set_callback(struct aead_request *req,
* @iv: IV for the cipher operation which must comply with the IV size defined
* by crypto_aead_ivsize()
- * Setting the source data and destination data scatter / gather lists.
+ * Setting the source data and destination data scatter / gather lists which
+ * hold the associated data concatenated with the plaintext or ciphertext. See
+ * below for the authentication tag.
* For encryption, the source is treated as the plaintext and the
* destination is the ciphertext. For a decryption operation, the use is

Privacy Policy