Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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: Ovidiu Panait <ovidiu.panait.oss@gmail.com>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
authored by
Ovidiu Panait
and committed by
Herbert Xu
63ff962c
17fd7514
+3
-5
+3
-5
include/crypto/rng.h
+3
-5
include/crypto/rng.h
···
102
102
}
103
103
104
104
/**
105
-
* crypto_rng_alg - obtain name of RNG
106
-
* @tfm: cipher handle
105
+
* crypto_rng_alg() - obtain 'struct rng_alg' pointer from RNG handle
106
+
* @tfm: RNG handle
107
107
*
108
-
* Return the generic name (cra_name) of the initialized random number generator
109
-
*
110
-
* Return: generic name string
108
+
* Return: Pointer to 'struct rng_alg', derived from @tfm RNG handle
111
109
*/
112
110
static inline struct rng_alg *crypto_rng_alg(struct crypto_rng *tfm)
113
111
{