Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6eae29e7 authored by Eric Biggers's avatar Eric Biggers Committed by Herbert Xu
Browse files

crypto: doc - document correct return value for request allocation 



Signed-off-by: default avatarEric Biggers <ebiggers3@gmail.com>
Signed-off-by: default avatarHerbert Xu <herbert@gondor.apana.org.au>
parent 043809d8

Documentation/DocBook/crypto-API.tmpl

+3 −3
Original line number Diff line number Diff line
@@ -1936,9 +1936,9 @@ static int test_skcipher(void) 
	}



	req = skcipher_request_alloc(skcipher, GFP_KERNEL);

	if (IS_ERR(req)) {

		pr_info("could not allocate request queue\n");

		ret = PTR_ERR(req);

	if (!req) {

		pr_info("could not allocate skcipher request\n");

		ret = -ENOMEM;

		goto out;

	}

include/crypto/aead.h

+1 −2
Original line number Diff line number Diff line
@@ -405,8 +405,7 @@ static inline void aead_request_set_tfm(struct aead_request *req, 
 * encrypt and decrypt API calls. During the allocation, the provided aead

 * handle is registered in the request data structure.

 *

 * Return: allocated request handle in case of success; IS_ERR() is true in case

 *	   of an error, PTR_ERR() returns the error code.

 * Return: allocated request handle in case of success, or NULL if out of memory

 */

static inline struct aead_request *aead_request_alloc(struct crypto_aead *tfm,

						      gfp_t gfp)

include/crypto/hash.h

+1 −2
Original line number Diff line number Diff line
@@ -547,8 +547,7 @@ static inline void ahash_request_set_tfm(struct ahash_request *req, 
 * the allocation, the provided ahash handle

 * is registered in the request data structure.

 *

 * Return: allocated request handle in case of success; IS_ERR() is true in case

 *	   of an error, PTR_ERR() returns the error code.

 * Return: allocated request handle in case of success, or NULL if out of memory

 */

static inline struct ahash_request *ahash_request_alloc(

	struct crypto_ahash *tfm, gfp_t gfp)

include/crypto/skcipher.h

+1 −2
Original line number Diff line number Diff line
@@ -425,8 +425,7 @@ static inline struct skcipher_request *skcipher_request_cast( 
 * encrypt and decrypt API calls. During the allocation, the provided skcipher

 * handle is registered in the request data structure.

 *

 * Return: allocated request handle in case of success; IS_ERR() is true in case

 *	   of an error, PTR_ERR() returns the error code.

 * Return: allocated request handle in case of success, or NULL if out of memory

 */

static inline struct skcipher_request *skcipher_request_alloc(

	struct crypto_skcipher *tfm, gfp_t gfp)

include/linux/crypto.h

+1 −2
Original line number Diff line number Diff line
@@ -948,8 +948,7 @@ static inline struct ablkcipher_request *ablkcipher_request_cast( 
 * encrypt and decrypt API calls. During the allocation, the provided ablkcipher

 * handle is registered in the request data structure.

 *

 * Return: allocated request handle in case of success; IS_ERR() is true in case

 *	   of an error, PTR_ERR() returns the error code.

 * Return: allocated request handle in case of success, or NULL if out of memory

 */

static inline struct ablkcipher_request *ablkcipher_request_alloc(

	struct crypto_ablkcipher *tfm, gfp_t gfp)