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>

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>
Stephan Mueller · Herbert Xu
1 parent 4ba2a8b4d8
Showing 1 changed file with 6 additions and 1 deletions Side-by-side Diff
include/crypto/hash.h
@@ -38,6 +38,10 @@
  *	       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 @@
  *	    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 @@
  * @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
...	...	@@ -38,6 +38,10 @@
38	38	* will save the partial state of the transformation into it. On the
39	39	* other side, the @import function will load the state from a
40	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	*/
42	46	struct hash_alg_common {
43	47	unsigned int digestsize;
...	...	@@ -114,6 +118,7 @@
114	118	* entire state of the ongoing transformation from a provided block of
115	119	* data so the transformation can continue from this point onward. No
116	120	* data processing happens at this point.
	121	+ * @halg: see struct hash_alg_common
117	122	*/
118	123	struct ahash_alg {
119	124	int (init)(struct ahash_request req);
...	...	@@ -153,7 +158,7 @@
153	158	* @setkey: see struct ahash_alg
154	159	* @digestsize: see struct ahash_alg
155	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	162	* size is the memory size that needs to be allocated for
158	163	* shash_desc.__ctx
159	164	* @base: internally used