linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
	Herbert Xu <herbert@gondor.apana.org.au>,
	"David S. Miller" <davem@davemloft.net>,
	Rob Rice <rob.rice@broadcom.com>,
	linux-crypto@vger.kernel.org
Subject: [PATCH 13/20] crypto: bcm: cipher: Provide description for 'req' and fix formatting issues
Date: Thu,  4 Feb 2021 11:09:53 +0000	[thread overview]
Message-ID: <20210204111000.2800436-14-lee.jones@linaro.org> (raw)
In-Reply-To: <20210204111000.2800436-1-lee.jones@linaro.org>

Fixes the following W=1 kernel build warning(s):

 drivers/crypto/bcm/cipher.c:1048: warning: Function parameter or member 'req' not described in 'spu_aead_rx_sg_create'
 drivers/crypto/bcm/cipher.c:2966: warning: Function parameter or member 'cipher' not described in 'rfc4543_gcm_esp_setkey'
 drivers/crypto/bcm/cipher.c:2966: warning: Function parameter or member 'key' not described in 'rfc4543_gcm_esp_setkey'
 drivers/crypto/bcm/cipher.c:2966: warning: Function parameter or member 'keylen' not described in 'rfc4543_gcm_esp_setkey'

Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Rob Rice <rob.rice@broadcom.com>
Cc: linux-crypto@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/crypto/bcm/cipher.c | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/drivers/crypto/bcm/cipher.c b/drivers/crypto/bcm/cipher.c
index 851b149f71701..053315e260c22 100644
--- a/drivers/crypto/bcm/cipher.c
+++ b/drivers/crypto/bcm/cipher.c
@@ -1019,6 +1019,7 @@ static void handle_ahash_resp(struct iproc_reqctx_s *rctx)
  * a SPU response message for an AEAD request. Includes buffers to catch SPU
  * message headers and the response data.
  * @mssg:	mailbox message containing the receive sg
+ * @req:	Crypto API request
  * @rctx:	crypto request context
  * @rx_frag_num: number of scatterlist elements required to hold the
  *		SPU response message
@@ -2952,9 +2953,9 @@ static int aead_gcm_esp_setkey(struct crypto_aead *cipher,
 
 /**
  * rfc4543_gcm_esp_setkey() - setkey operation for RFC4543 variant of GCM/GMAC.
- * cipher: AEAD structure
- * key:    Key followed by 4 bytes of salt
- * keylen: Length of key plus salt, in bytes
+ * @cipher: AEAD structure
+ * @key:    Key followed by 4 bytes of salt
+ * @keylen: Length of key plus salt, in bytes
  *
  * Extracts salt from key and stores it to be prepended to IV on each request.
  * Digest is always 16 bytes
-- 
2.25.1


  parent reply	other threads:[~2021-02-04 11:18 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-02-04 11:09 [PATCH 00/20] Rid W=1 warnings in Crypto Lee Jones
2021-02-04 11:09 ` [PATCH 01/20] crypto: hisilicon: sec_drv: Supply missing description for 'sec_queue_empty()'s 'queue' param Lee Jones
2021-02-04 11:09 ` [PATCH 02/20] crypto: bcm: util: Repair a couple of documentation formatting issues Lee Jones
2021-02-04 11:09 ` [PATCH 03/20] crypto: chelsio: chcr_core: File headers are not good candidates for kernel-doc Lee Jones
2021-02-04 11:09 ` [PATCH 04/20] crypto: ux500: hash: hash_core: Fix worthy kernel-doc headers and remove others Lee Jones
2021-02-04 11:09 ` [PATCH 05/20] crypto: bcm: spu: Fix formatting and misspelling issues Lee Jones
2021-02-04 11:09 ` [PATCH 06/20] crypto: keembay: ocs-hcu: Fix incorrectly named functions/structs Lee Jones
2021-02-04 17:53   ` Alessandrelli, Daniele
2021-02-04 18:55     ` Lee Jones
2021-02-05 14:35       ` Alessandrelli, Daniele
2021-02-04 11:09 ` [PATCH 07/20] crypto: bcm: spu2: Fix a whole host of kernel-doc misdemeanours Lee Jones
2021-02-04 11:09 ` [PATCH 08/20] crypto: ux500: cryp: Demote some conformant non-kernel headers fix another Lee Jones
2021-02-04 11:09 ` [PATCH 09/20] crypto: ux500: cryp_irq: File headers are not good kernel-doc candidates Lee Jones
2021-02-04 11:09 ` [PATCH 10/20] crypto: chelsio: chcr_algo: Fix a couple of kernel-doc issues caused by doc-rot Lee Jones
2021-02-04 11:09 ` [PATCH 11/20] crypto: ux500: cryp_core: Fix formatting issue and add description for 'session_id' Lee Jones
2021-02-04 11:09 ` [PATCH 12/20] crypto: atmel-ecc: Struct headers need to start with keyword 'struct' Lee Jones
2021-02-04 15:49   ` Tudor.Ambarus
2021-02-04 11:09 ` Lee Jones [this message]
2021-02-04 11:09 ` [PATCH 14/20] crypto: caam: caampkc: Provide the name of the function Lee Jones
2021-02-08 19:44   ` Horia Geantă
2021-02-04 11:09 ` [PATCH 15/20] crypto: caam: caamalg_qi2: Supply a couple of 'fallback' related descriptions Lee Jones
2021-02-08 19:49   ` Horia Geantă
2021-02-04 11:09 ` [PATCH 16/20] crypto: vmx: Source headers are not good kernel-doc candidates Lee Jones
2021-02-04 11:09 ` [PATCH 17/20] crypto: nx: nx-aes-cbc: Headers comments should not be kernel-doc Lee Jones
2021-02-04 11:09 ` [PATCH 18/20] crypto: nx: nx_debugfs: Header " Lee Jones
2021-02-04 11:09 ` [PATCH 19/20] crypto: nx: Demote header comment and add description for 'nbytes' Lee Jones
2021-02-04 11:10 ` [PATCH 20/20] crypto: cavium: nitrox_isr: Demote non-compliant kernel-doc headers Lee Jones
2021-02-10  6:51 ` [PATCH 00/20] Rid W=1 warnings in Crypto Herbert Xu

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=20210204111000.2800436-14-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=davem@davemloft.net \
    --cc=herbert@gondor.apana.org.au \
    --cc=linux-crypto@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rob.rice@broadcom.com \
    /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).