Skip to content

Commit

Permalink
crypto: doc - document uncovered member variables
Browse files Browse the repository at this point in the history
Fix documentation typo for shash_alg->descsize.

Add documentation for initially uncovered member variables.

Signed-off-by: Stephan Mueller <[email protected]>
Signed-off-by: Herbert Xu <[email protected]>
  • Loading branch information
smuellerDD authored and herbertx committed Nov 17, 2014
1 parent 4ba2a8b commit 52744af
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion include/crypto/hash.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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);
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 52744af

Please sign in to comment.