Linux-SCSI Archive on lore.kernel.org
 help / color / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: jejb@linux.ibm.com, martin.petersen@oracle.com
Cc: linux-kernel@vger.kernel.org, linux-scsi@vger.kernel.org,
	Lee Jones <lee.jones@linaro.org>,
	James Smart <james.smart@broadcom.com>,
	Dick Kennedy <dick.kennedy@broadcom.com>
Subject: [PATCH 18/40] scsi: lpfc: lpfc_mbox: Fix a bunch of kerneldoc misdemeanours
Date: Thu, 23 Jul 2020 13:24:24 +0100
Message-ID: <20200723122446.1329773-19-lee.jones@linaro.org> (raw)
In-Reply-To: <20200723122446.1329773-1-lee.jones@linaro.org>

Adding, removing and correcting function parameter descriptions.

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

 drivers/scsi/lpfc/lpfc_mbox.c:886: warning: Function parameter or member 'vport' not described in 'lpfc_reg_vpi'
 drivers/scsi/lpfc/lpfc_mbox.c:886: warning: Excess function parameter 'phba' description in 'lpfc_reg_vpi'
 drivers/scsi/lpfc/lpfc_mbox.c:886: warning: Excess function parameter 'vpi' description in 'lpfc_reg_vpi'
 drivers/scsi/lpfc/lpfc_mbox.c:886: warning: Excess function parameter 'sid' description in 'lpfc_reg_vpi'
 drivers/scsi/lpfc/lpfc_mbox.c:1218: warning: Function parameter or member 'ring' not described in 'lpfc_config_ring'
 drivers/scsi/lpfc/lpfc_mbox.c:1626: warning: Function parameter or member 'mboxq' not described in 'lpfc_mbox_tmo_val'
 drivers/scsi/lpfc/lpfc_mbox.c:1626: warning: Excess function parameter 'cmd' description in 'lpfc_mbox_tmo_val'
 drivers/scsi/lpfc/lpfc_mbox.c:1710: warning: Function parameter or member 'sge' not described in 'lpfc_sli4_mbx_sge_get'
 drivers/scsi/lpfc/lpfc_mbox.c:1780: warning: Function parameter or member 'emb' not described in 'lpfc_sli4_config'
 drivers/scsi/lpfc/lpfc_mbox.c:2027: warning: Function parameter or member 'mboxq' not described in 'lpfc_sli4_mbx_read_fcf_rec'
 drivers/scsi/lpfc/lpfc_mbox.c:2078: warning: Function parameter or member 'phba' not described in 'lpfc_request_features'

Cc: James Smart <james.smart@broadcom.com>
Cc: Dick Kennedy <dick.kennedy@broadcom.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/scsi/lpfc/lpfc_mbox.c | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/drivers/scsi/lpfc/lpfc_mbox.c b/drivers/scsi/lpfc/lpfc_mbox.c
index e34e0f11bfdd5..3414ffcb26fed 100644
--- a/drivers/scsi/lpfc/lpfc_mbox.c
+++ b/drivers/scsi/lpfc/lpfc_mbox.c
@@ -868,9 +868,7 @@ lpfc_sli4_unreg_all_rpis(struct lpfc_vport *vport)
 
 /**
  * lpfc_reg_vpi - Prepare a mailbox command for registering vport identifier
- * @phba: pointer to lpfc hba data structure.
- * @vpi: virtual N_Port identifier.
- * @sid: Fibre Channel S_ID (N_Port_ID assigned to a virtual N_Port).
+ * @vport: pointer to a vport object.
  * @pmb: pointer to the driver internal queue element for mailbox command.
  *
  * The registration vport identifier mailbox command is used to activate a
@@ -1199,7 +1197,7 @@ lpfc_config_hbq(struct lpfc_hba *phba, uint32_t id,
 /**
  * lpfc_config_ring - Prepare a mailbox command for configuring an IOCB ring
  * @phba: pointer to lpfc hba data structure.
- * @ring:
+ * @ring: ring number/index
  * @pmb: pointer to the driver internal queue element for mailbox command.
  *
  * The configure ring mailbox command is used to configure an IOCB ring. This
@@ -1613,7 +1611,7 @@ lpfc_mbox_dev_check(struct lpfc_hba *phba)
 /**
  * lpfc_mbox_tmo_val - Retrieve mailbox command timeout value
  * @phba: pointer to lpfc hba data structure.
- * @cmd: mailbox command code.
+ * @mboxq: pointer to the driver internal queue element for mailbox command.
  *
  * This routine retrieves the proper timeout value according to the mailbox
  * command code.
@@ -1700,6 +1698,7 @@ lpfc_sli4_mbx_sge_set(struct lpfcMboxq *mbox, uint32_t sgentry,
  * lpfc_sli4_mbx_sge_get - Get a sge entry from non-embedded mailbox command
  * @mbox: pointer to lpfc mbox command.
  * @sgentry: sge entry index.
+ * @sge: pointer to lpfc mailbox sge to load into.
  *
  * This routine gets an entry from the non-embedded mailbox command at the sge
  * index location.
@@ -1767,6 +1766,7 @@ lpfc_sli4_mbox_cmd_free(struct lpfc_hba *phba, struct lpfcMboxq *mbox)
  * @subsystem: The sli4 config sub mailbox subsystem.
  * @opcode: The sli4 config sub mailbox command opcode.
  * @length: Length of the sli4 config mailbox command (including sub-header).
+ * @emb: True if embedded mbox command should be setup.
  *
  * This routine sets up the header fields of SLI4 specific mailbox command
  * for sending IOCTL command.
@@ -2012,6 +2012,7 @@ lpfc_sli_config_mbox_opcode_get(struct lpfc_hba *phba, LPFC_MBOXQ_t *mbox)
 /**
  * lpfc_sli4_mbx_read_fcf_rec - Allocate and construct read fcf mbox cmd
  * @phba: pointer to lpfc hba data structure.
+ * @mboxq: pointer to lpfc mbox command.
  * @fcf_index: index to fcf table.
  *
  * This routine routine allocates and constructs non-embedded mailbox command
@@ -2068,6 +2069,7 @@ lpfc_sli4_mbx_read_fcf_rec(struct lpfc_hba *phba,
 
 /**
  * lpfc_request_features: Configure SLI4 REQUEST_FEATURES mailbox
+ * @phba: pointer to lpfc hba data structure.
  * @mboxq: pointer to lpfc mbox command.
  *
  * This routine sets up the mailbox for an SLI4 REQUEST_FEATURES
-- 
2.25.1


  parent reply index

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-23 12:24 [PATCH 00/40] Set 5: Penultimate set of SCSI related W=1 warnings Lee Jones
2020-07-23 12:24 ` [PATCH 01/40] scsi: lpfc: lpfc_els: Fix some function parameter descriptions Lee Jones
2020-07-23 12:24 ` [PATCH 02/40] scsi: lpfc: lpfc_hbadisc: Fix kerneldoc parameter formatting/misnaming/missing issues Lee Jones
2020-07-23 12:24 ` [PATCH 03/40] scsi: ufs: ufs-qcom: Demote nonconformant kerneldoc headers Lee Jones
2020-07-23 12:24 ` [PATCH 04/40] scsi: bnx2i: bnx2i_init: Fix parameter misnaming in function header Lee Jones
2020-07-23 12:24 ` [PATCH 05/40] scsi: ufs: ufs-exynos: Make stubs 'static inline' Lee Jones
2020-07-23 12:24 ` [PATCH 06/40] scsi: ufs: ufs-exynos: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-23 12:24 ` [PATCH 07/40] scsi: bfa: bfa_port: Staticify local functions Lee Jones
2020-07-23 12:24 ` [PATCH 08/40] scsi: bnx2i: bnx2i_sysfs: Add missing descriptions for 'attr' parameter Lee Jones
2020-07-23 12:24 ` [PATCH 09/40] scsi: bfa: bfa_fcpim: Remove set but unused variable 'rp' Lee Jones
2020-07-23 12:24 ` [PATCH 10/40] scsi: bfa: bfa_fcpim: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-23 12:24 ` [PATCH 11/40] scsi: qedi: qedi_main: Remove 2 set but unused variables Lee Jones
2020-07-23 12:24 ` [PATCH 12/40] scsi: ips: Remove some " Lee Jones
2020-07-23 12:24 ` [PATCH 13/40] scsi: ips: Convert strnlen() to memcpy() since result should not be NUL terminated Lee Jones
2020-07-23 12:24 ` [PATCH 14/40] scsi: qla4xxx: ql4_83xx: Remove set but unused variable 'status' Lee Jones
2020-07-23 12:24 ` [PATCH 15/40] scsi: lpfc: lpfc_init: Use __printf() format notation Lee Jones
2020-07-23 12:24 ` [PATCH 16/40] scsi: lpfc: lpfc_init: Add and rename a whole bunch of function parameter descriptions Lee Jones
2020-07-23 12:24 ` [PATCH 17/40] scsi: qla4xxx: ql4_bsg: Rename " Lee Jones
2020-07-23 12:24 ` Lee Jones [this message]
2020-07-23 12:24 ` [PATCH 19/40] scsi: lpfc: lpfc_nportdisc: Add description for lpfc_release_rpi()'s 'ndlpl param Lee Jones
2020-07-23 12:24 ` [PATCH 20/40] scsi: bfa: bfa_ioc: Remove a few unused variables 'pgoff' and 't' Lee Jones
2020-07-23 12:24 ` [PATCH 21/40] scsi: csiostor: csio_hw: Mark known unused variable as __always_unused Lee Jones
2020-07-23 12:24 ` [PATCH 22/40] scsi: csiostor: csio_hw_t5: Remove 2 unused variables {mc,edc}_bist_status_rdata_reg Lee Jones
2020-07-23 12:24 ` [PATCH 23/40] scsi: bfa: bfa_ioc: Staticify non-external functions Lee Jones
2020-07-23 12:24 ` [PATCH 24/40] scsi: csiostor: csio_rnode: Add missing description for csio_rnode_fwevt_handler()'s 'fwevt' param Lee Jones
2020-07-23 12:24 ` [PATCH 25/40] scsi: bfa: bfa_ioc_ct: Demote non-compliant kerneldoc headers to standard comments Lee Jones
2020-07-23 12:24 ` [PATCH 26/40] scsi: mvsas: mv_init: Place 'core_nr' inside correct clause Lee Jones
2020-07-23 12:24 ` [PATCH 27/40] scsi: bfa: bfa_fcs_rport: Remove unused variable 'adisc' Lee Jones
2020-07-23 12:24 ` [PATCH 28/40] scsi: bnx2i: bnx2i_hwi: Fix a whole host of kerneldoc issues Lee Jones
2020-07-23 12:24 ` [PATCH 29/40] scsi: bnx2i: bnx2i_iscsi: Add, remove and edit some function parameter descriptions Lee Jones
2020-07-23 12:24 ` [PATCH 30/40] scsi: be2iscsi: be_iscsi: Correct misdocumentation of function param 'ep' Lee Jones
2020-07-23 12:24 ` [PATCH 31/40] scsi: qedi: qedi_fw: Remove set but unused variable 'tmp' Lee Jones
2020-07-23 12:24 ` [PATCH 32/40] scsi: esas2r: esas2r: Add braces around the one-line if() Lee Jones
2020-07-23 12:24 ` [PATCH 33/40] scsi: bfa: bfa_ioc: Demote non-kerneldoc headers down to standard comment blocks Lee Jones
2020-07-23 12:24 ` [PATCH 34/40] scsi: bfa: bfa_core: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-23 12:24 ` [PATCH 35/40] scsi: bfa: bfa_svc: " Lee Jones
2020-07-23 12:24 ` [PATCH 36/40] scsi: qedi: qedi_main: " Lee Jones
2020-07-23 12:24 ` [PATCH 37/40] scsi: qedi: qedi_iscsi: Staticify non-external function 'qedi_get_iscsi_error' Lee Jones
2020-07-23 12:24 ` [PATCH 38/40] scsi: bfa: bfa_ioc: Ensure a blank line precedes next function/header Lee Jones
2020-07-23 12:24 ` [PATCH 39/40] scsi: bnx2i: bnx2i_iscsi: Add parameter description and rename another Lee Jones
2020-07-23 12:24 ` [PATCH 40/40] scsi: esas2r: esas2r_log: Demote a few non-conformant kerneldoc headers Lee Jones
2020-07-25  2:58 ` [PATCH 00/40] Set 5: Penultimate set of SCSI related W=1 warnings Martin K. Petersen

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=20200723122446.1329773-19-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=dick.kennedy@broadcom.com \
    --cc=james.smart@broadcom.com \
    --cc=jejb@linux.ibm.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-scsi@vger.kernel.org \
    --cc=martin.petersen@oracle.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

Linux-SCSI Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-scsi/0 linux-scsi/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-scsi linux-scsi/ https://lore.kernel.org/linux-scsi \
		linux-scsi@vger.kernel.org
	public-inbox-index linux-scsi

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-scsi


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git