Commit 5a35316d authored Jun 25, 2019 by Hook, Gary Committed by Herbert Xu Jul 03, 2019

crypto: doc - Add parameter documentation



Fill in missing parameter descriptions for the compression algorithm,
then pick them up to document for the compression_alg structure.

Signed-off-by: Gary R Hook <gary.hook@amd.com>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>

parent 7367bfeb

Documentation/crypto/api-skcipher.rst

+1 −1

Original line number	Diff line number	Diff line
		@@ -5,7 +5,7 @@ Block Cipher Algorithm Definitions
		:doc: Block Cipher Algorithm Definitions

		.. kernel-doc:: include/linux/crypto.h
		:functions: crypto_alg ablkcipher_alg blkcipher_alg cipher_alg
		:functions: crypto_alg ablkcipher_alg blkcipher_alg cipher_alg compress_alg

		Symmetric Key Cipher API
		------------------------

include/linux/crypto.h

+11 −0

Original line number	Diff line number	Diff line
		@@ -327,6 +327,17 @@ struct cipher_alg {
		void (cia_decrypt)(struct crypto_tfm tfm, u8 dst, const u8 src);
		};

		/**
		* struct compress_alg - compression/decompression algorithm
		* @coa_compress: Compress a buffer of specified length, storing the resulting
		* data in the specified buffer. Return the length of the
		* compressed data in dlen.
		* @coa_decompress: Decompress the source buffer, storing the uncompressed
		* data in the specified buffer. The length of the data is
		* returned in dlen.
		*
		* All fields are mandatory.
		*/
		struct compress_alg {
		int (coa_compress)(struct crypto_tfm tfm, const u8 *src,
		unsigned int slen, u8 dst, unsigned int dlen);