Commit 63ff962c authored by Ovidiu Panait's avatar Ovidiu Panait Committed by Herbert Xu
Browse files

crypto: rng - fix documentation for crypto_rng_alg() 



Current documentation states that crypto_rng_alg() returns the cra_name of
the rng algorithm, but it actually returns a 'struct rng_alg' pointer from
a RNG handle.

Update documentation to reflect this.

Signed-off-by: default avatarOvidiu Panait <ovidiu.panait.oss@gmail.com>
Signed-off-by: default avatarHerbert Xu <herbert@gondor.apana.org.au>
parent 17fd7514

include/crypto/rng.h

+3 −5
Original line number Diff line number Diff line
@@ -102,12 +102,10 @@ static inline struct rng_alg *__crypto_rng_alg(struct crypto_alg *alg) 
}



/**

 * crypto_rng_alg - obtain name of RNG

 * @tfm: cipher handle

 *

 * Return the generic name (cra_name) of the initialized random number generator

 * crypto_rng_alg() - obtain 'struct rng_alg' pointer from RNG handle

 * @tfm: RNG handle

 *

 * Return: generic name string

 * Return: Pointer to 'struct rng_alg', derived from @tfm RNG handle

 */

static inline struct rng_alg *crypto_rng_alg(struct crypto_rng *tfm)

{