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>

diff --git a/Documentation/crypto/api-skcipher.rst b/Documentation/crypto/api-skcipher.rst
index 4eec4a93f7e3be20429de8154988d13aa73dde27..20ba08dddf2ecfafeb8073c9e9d8b223846ba0be 100644 (file)
--- a/Documentation/crypto/api-skcipher.rst
+++ b/Documentation/crypto/api-skcipher.rst
@@ -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
 ------------------------

diff --git a/include/linux/crypto.h b/include/linux/crypto.h
index 311237b1dab026e2a14973aa131d85e6fb44a4f3..4b4e2ffbee74a9550afd17fa6badca16c3fdac77 100644 (file)
--- a/include/linux/crypto.h
+++ b/include/linux/crypto.h
@@ -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);