summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStephan Mueller <smueller@chronox.de>2014-11-14 05:26:21 +0100
committerHerbert Xu <herbert@gondor.apana.org.au>2014-11-17 22:53:48 +0800
commit52744af3af977ccbbf768be34650d7c75cfc1ad6 (patch)
treee3231bb909a2d8b99b481221930942568fae8395
parent4ba2a8b4d80a864a02d5d6898ae54f9d45afbb33 (diff)
crypto: doc - document uncovered member variables
Fix documentation typo for shash_alg->descsize. Add documentation for initially uncovered member variables. Signed-off-by: Stephan Mueller <smueller@chronox.de> Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
-rw-r--r--include/crypto/hash.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/include/crypto/hash.h b/include/crypto/hash.h
index 3d66e8bd0932..98abda9ed3aa 100644
--- a/include/crypto/hash.h
+++ b/include/crypto/hash.h
@@ -38,6 +38,10 @@ struct crypto_ahash;
* will save the partial state of the transformation into it. On the
* other side, the @import function will load the state from a
* buffer of this size as well.
+ * @base: Start of data structure of cipher algorithm. The common data
+ * structure of crypto_alg contains information common to all ciphers.
+ * The hash_alg_common data structure now adds the hash-specific
+ * information.
*/
struct hash_alg_common {
unsigned int digestsize;
@@ -114,6 +118,7 @@ struct ahash_request {
* entire state of the ongoing transformation from a provided block of
* data so the transformation can continue from this point onward. No
* data processing happens at this point.
+ * @halg: see struct hash_alg_common
*/
struct ahash_alg {
int (*init)(struct ahash_request *req);
@@ -153,7 +158,7 @@ struct shash_desc {
* @setkey: see struct ahash_alg
* @digestsize: see struct ahash_alg
* @statesize: see struct ahash_alg
- * @dedcsize: Size of the operational state for the message digest. This state
+ * @descsize: Size of the operational state for the message digest. This state
* size is the memory size that needs to be allocated for
* shash_desc.__ctx
* @base: internally used