Received-SPF: pass (google.com: best guess record for domain of linux-crypto-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
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
Thread-Topic: [PATCH 1/3] crypto: doc - Add parameter documentation
Thread-Index: AQHVKsAZ2iu41GA1mUC92fRE2Scqqw==
Date:   Mon, 24 Jun 2019 19:07:42 +0000
Message-ID: <156140326035.29777.7460831085991852791.stgit@taos>
References: <156140322426.29777.8610751479936722967.stgit@taos>
In-Reply-To: <156140322426.29777.8610751479936722967.stgit@taos>
Accept-Language: en-US
Content-Language: en-US
x-ms-exchange-messagesentrepresentingtype: 1
x-originating-ip: [165.204.78.1]
x-ms-publictraffictype: Email
x-ms-office365-filtering-correlation-id: 87702f17-bbc5-43e2-863d-08d6f8d73b76
x-ms-office365-filtering-ht: Tenant
x-microsoft-antispam: BCL:0;PCL:0;RULEID:(2390118)(7020095)(4652040)(8989299)(4534185)(4627221)(201703031133081)(201702281549075)(8990200)(5600148)(711020)(4605104)(1401327)(4618075)(2017052603328)(7193020);SRVR:DM5PR12MB2584;
x-ms-traffictypediagnostic: DM5PR12MB2584:
x-microsoft-antispam-prvs: <DM5PR12MB258431C121CE6ED64C6EB789FDE00@DM5PR12MB2584.namprd12.prod.outlook.com>
x-ms-oob-tlc-oobclassifiers: OLM:5516;
x-forefront-prvs: 007814487B
x-forefront-antispam-report: SFV:NSPM;SFS:(10009020)(7916004)(376002)(136003)(366004)(39860400002)(396003)(346002)(199004)(189003)(99286004)(6436002)(25786009)(76176011)(52116002)(72206003)(33716001)(9686003)(6512007)(14444005)(256004)(68736007)(110136005)(6116002)(3846002)(446003)(476003)(11346002)(316002)(2906002)(26005)(186003)(102836004)(6486002)(386003)(14454004)(5660300002)(486006)(81156014)(86362001)(103116003)(305945005)(81166006)(478600001)(8676002)(66946007)(73956011)(8936002)(66066001)(66446008)(64756008)(66556008)(66476007)(2501003)(71190400001)(71200400001)(6506007)(53936002)(7736002)(2201001);DIR:OUT;SFP:1101;SCL:1;SRVR:DM5PR12MB2584;H:DM5PR12MB1449.namprd12.prod.outlook.com;FPR:;SPF:None;LANG:en;PTR:InfoNoRecords;A:1;MX:1;
received-spf: None (protection.outlook.com: amd.com does not designate
 permitted sender hosts)
x-ms-exchange-senderadcheck: 1
x-microsoft-antispam-message-info: IJfZ3Gv8tbFmiw08mirh2Uukbyl5CK76BsD9lrzEno8dysZEhe6mutHm+ZtpCeJJOEaChHDuBkCKT0OjKTTIlJv0FS1VTTfb4SiVE0G2hiXoMSBsY7iQTc+/jvNOOCfZmBwAJrtN72qMRk63iXjhZYxp/z/oAqqB6oAshhf0ylx3iMp9Lv38/+3v3lypjrarl7UjTWBYPIKzRJD4hDC4YViiG+8n5WCZCI7wMGMJJ6q8/haD0x9plLS/PezcgFUUeeivqBFCkgC6ahjh1oIQCVSC2hiFzVp6EJIRcKomK0tWQU+xl8+KLy/HrfTTIO9POp3QzChCBzOlDMQoLYDj5kCsk1G+XJu+IT/ohWcM+9VbAguWuK1X4lJ7cSnjXySNjg54dcZ0XUnFw6kf4z5/qP4t+9hfDWhVqDhD6+KVqxs=
Content-Type: text/plain; charset="us-ascii"
Content-ID: <A77FBD29D268F94BA9C39A58A20F79B3@namprd12.prod.outlook.com>
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 87702f17-bbc5-43e2-863d-08d6f8d73b76
X-MS-Exchange-CrossTenant-originalarrivaltime: 24 Jun 2019 19:07:42.1696
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: ghook@amd.com
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR12MB2584
Sender: linux-crypto-owner@vger.kernel.org
Precedence: bulk
List-ID: <linux-crypto.vger.kernel.org>
X-Mailing-List: linux-crypto@vger.kernel.org

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/a=
pi-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
=20
 .. 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
=20
 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);
 };
=20
+/**
+ * struct compress_alg - compression/decompression algorithm
+ * @coa_compress: Compress a buffer of specified length, storing the resul=
ting
+ *		  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);