aboutsummaryrefslogtreecommitdiffstats
path: root/include/crypto
diff options
context:
space:
mode:
authorStephan Mueller <smueller@chronox.de>2014-11-13 23:26:21 -0500
committerHerbert Xu <herbert@gondor.apana.org.au>2014-11-17 09:53:48 -0500
commit52744af3af977ccbbf768be34650d7c75cfc1ad6 (patch)
treee3231bb909a2d8b99b481221930942568fae8395 /include/crypto
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>
Diffstat (limited to 'include/crypto')
-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;
38 * will save the partial state of the transformation into it. On the 38 * will save the partial state of the transformation into it. On the
39 * other side, the @import function will load the state from a 39 * other side, the @import function will load the state from a
40 * buffer of this size as well. 40 * buffer of this size as well.
41 * @base: Start of data structure of cipher algorithm. The common data
42 * structure of crypto_alg contains information common to all ciphers.
43 * The hash_alg_common data structure now adds the hash-specific
44 * information.
41 */ 45 */
42struct hash_alg_common { 46struct hash_alg_common {
43 unsigned int digestsize; 47 unsigned int digestsize;
@@ -114,6 +118,7 @@ struct ahash_request {
114 * entire state of the ongoing transformation from a provided block of 118 * entire state of the ongoing transformation from a provided block of
115 * data so the transformation can continue from this point onward. No 119 * data so the transformation can continue from this point onward. No
116 * data processing happens at this point. 120 * data processing happens at this point.
121 * @halg: see struct hash_alg_common
117 */ 122 */
118struct ahash_alg { 123struct ahash_alg {
119 int (*init)(struct ahash_request *req); 124 int (*init)(struct ahash_request *req);
@@ -153,7 +158,7 @@ struct shash_desc {
153 * @setkey: see struct ahash_alg 158 * @setkey: see struct ahash_alg
154 * @digestsize: see struct ahash_alg 159 * @digestsize: see struct ahash_alg
155 * @statesize: see struct ahash_alg 160 * @statesize: see struct ahash_alg
156 * @dedcsize: Size of the operational state for the message digest. This state 161 * @descsize: Size of the operational state for the message digest. This state
157 * size is the memory size that needs to be allocated for 162 * size is the memory size that needs to be allocated for
158 * shash_desc.__ctx 163 * shash_desc.__ctx
159 * @base: internally used 164 * @base: internally used