From: "Hook, Gary" <Gary.Hook@amd.com>
To: "herbert@gondor.apana.org.au" <herbert@gondor.apana.org.au>,
"corbet@lwn.net" <corbet@lwn.net>,
"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
"linux-crypto@vger.kernel.org" <linux-crypto@vger.kernel.org>,
"davem@davemloft.net" <davem@davemloft.net>
Subject: [PATCH 1/3] crypto: doc - Add parameter documentation
Date: Mon, 24 Jun 2019 19:07:42 +0000 [thread overview]
Message-ID: <156140326035.29777.7460831085991852791.stgit@taos> (raw)
In-Reply-To: <156140322426.29777.8610751479936722967.stgit@taos>
Fill in missing parameter descriptions for the ompression algorithm,
then pick them up to document for the compression_alg structure.
Signed-off-by: Gary R Hook <gary.hook@amd.com>
---
Documentation/crypto/api-skcipher.rst | 2 +-
include/linux/crypto.h | 11 +++++++++++
2 files changed, 12 insertions(+), 1 deletion(-)
diff --git a/Documentation/crypto/api-skcipher.rst b/Documentation/crypto/api-skcipher.rst
index 4eec4a93f7e3..20ba08dddf2e 100644
--- 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 311237b1dab0..4b4e2ffbee74 100644
--- 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);
next prev parent reply other threads:[~2019-06-24 19:07 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-24 19:07 [PATCH 0/3] Clean up crypto documentation Hook, Gary
2019-06-24 19:07 ` Hook, Gary [this message]
2019-06-24 19:07 ` [PATCH 2/3] crypto: doc - Describe the crypto engine Hook, Gary
2019-06-24 22:03 ` Eric Biggers
2019-06-25 13:05 ` Gary R Hook
2019-06-24 19:07 ` [PATCH 3/3] crypto: doc - Fix formatting of new crypto engine content Hook, Gary
2019-06-24 19:30 ` [PATCH 0/3] Clean up crypto documentation Joe Perches
2019-06-24 20:06 ` Gary R Hook
2019-06-24 20:29 ` Joe Perches
2019-06-24 20:37 ` Jonathan Corbet
2019-06-24 22:37 ` Joe Perches
2019-06-25 13:33 ` Gary R Hook
2019-06-25 13:52 ` Jonathan Corbet
2019-06-25 15:29 ` Gary R Hook
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=156140326035.29777.7460831085991852791.stgit@taos \
--to=gary.hook@amd.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=herbert@gondor.apana.org.au \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).