linux-scsi.vger.kernel.org archive mirror
 help / color / mirror / 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>,
	Anil Gurumurthy <anil.gurumurthy@qlogic.com>,
	Sudarsana Kalluru <sudarsana.kalluru@qlogic.com>
Subject: [PATCH 33/40] scsi: bfa: bfa_ioc: Demote non-kerneldoc headers down to standard comment blocks
Date: Thu, 23 Jul 2020 13:24:39 +0100	[thread overview]
Message-ID: <20200723122446.1329773-34-lee.jones@linaro.org> (raw)
In-Reply-To: <20200723122446.1329773-1-lee.jones@linaro.org>

This is probably historical (Doxygen?).

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

 drivers/scsi/bfa/bfa_ioc.c:6646: warning: Cannot understand  * @brief hardware error definition
 drivers/scsi/bfa/bfa_ioc.c:6661: warning: Cannot understand  * @brief flash command register data structure
 drivers/scsi/bfa/bfa_ioc.c:6685: warning: Cannot understand  * @brief flash device status register data structure
 drivers/scsi/bfa/bfa_ioc.c:6711: warning: Cannot understand  * @brief flash address register data structure
 drivers/scsi/bfa/bfa_ioc.c:6732: warning: Function parameter or member 'pci_bar' not described in 'bfa_flash_set_cmd'
 drivers/scsi/bfa/bfa_ioc.c:6732: warning: Function parameter or member 'wr_cnt' not described in 'bfa_flash_set_cmd'
 drivers/scsi/bfa/bfa_ioc.c:6732: warning: Function parameter or member 'rd_cnt' not described in 'bfa_flash_set_cmd'
 drivers/scsi/bfa/bfa_ioc.c:6732: warning: Function parameter or member 'ad_cnt' not described in 'bfa_flash_set_cmd'
 drivers/scsi/bfa/bfa_ioc.c:6732: warning: Function parameter or member 'op' not described in 'bfa_flash_set_cmd'
 drivers/scsi/bfa/bfa_ioc.c:6768: warning: Cannot understand  * @brief
 drivers/scsi/bfa/bfa_ioc.c:6807: warning: Cannot understand  * @brief
 drivers/scsi/bfa/bfa_ioc.c:6852: warning: Cannot understand  * @brief
 drivers/scsi/bfa/bfa_ioc.c:6898: warning: Cannot understand  * @brief
 drivers/scsi/bfa/bfa_ioc.c:6914: warning: Cannot understand  * @brief
 drivers/scsi/bfa/bfa_ioc.c:6940: warning: Cannot understand  * @brief

Cc: Anil Gurumurthy <anil.gurumurthy@qlogic.com>
Cc: Sudarsana Kalluru <sudarsana.kalluru@qlogic.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/scsi/bfa/bfa_ioc.c | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/drivers/scsi/bfa/bfa_ioc.c b/drivers/scsi/bfa/bfa_ioc.c
index 10c12b5a36b84..be48a7e31e803 100644
--- a/drivers/scsi/bfa/bfa_ioc.c
+++ b/drivers/scsi/bfa/bfa_ioc.c
@@ -6642,8 +6642,8 @@ enum bfa_flash_cmd {
 	BFA_FLASH_READ_STATUS	= 0x05,	/* read status */
 };
 
-/**
- * @brief hardware error definition
+/*
+ * Hardware error definition
  */
 enum bfa_flash_err {
 	BFA_FLASH_NOT_PRESENT	= -1,	/*!< flash not present */
@@ -6657,8 +6657,8 @@ enum bfa_flash_err {
 	BFA_FLASH_ERR_LEN	= -9,	/*!< invalid length */
 };
 
-/**
- * @brief flash command register data structure
+/*
+ * Flash command register data structure
  */
 union bfa_flash_cmd_reg_u {
 	struct {
@@ -6681,8 +6681,8 @@ union bfa_flash_cmd_reg_u {
 	u32	i;
 };
 
-/**
- * @brief flash device status register data structure
+/*
+ * Flash device status register data structure
  */
 union bfa_flash_dev_status_reg_u {
 	struct {
@@ -6707,8 +6707,8 @@ union bfa_flash_dev_status_reg_u {
 	u32	i;
 };
 
-/**
- * @brief flash address register data structure
+/*
+ * Flash address register data structure
  */
 union bfa_flash_addr_reg_u {
 	struct {
@@ -6723,7 +6723,7 @@ union bfa_flash_addr_reg_u {
 	u32	i;
 };
 
-/**
+/*
  * dg flash_raw_private Flash raw private functions
  */
 static void
@@ -6764,7 +6764,7 @@ bfa_flash_cmd_act_check(void __iomem *pci_bar)
 	return 0;
 }
 
-/**
+/*
  * @brief
  * Flush FLI data fifo.
  *
@@ -6803,7 +6803,7 @@ bfa_flash_fifo_flush(void __iomem *pci_bar)
 	return 0;
 }
 
-/**
+/*
  * @brief
  * Read flash status.
  *
@@ -6848,7 +6848,7 @@ bfa_flash_status_read(void __iomem *pci_bar)
 	return ret_status;
 }
 
-/**
+/*
  * @brief
  * Start flash read operation.
  *
@@ -6894,7 +6894,7 @@ bfa_flash_read_start(void __iomem *pci_bar, u32 offset, u32 len,
 	return 0;
 }
 
-/**
+/*
  * @brief
  * Check flash read operation.
  *
@@ -6910,7 +6910,7 @@ bfa_flash_read_check(void __iomem *pci_bar)
 
 	return 0;
 }
-/**
+/*
  * @brief
  * End flash read operation.
  *
@@ -6936,7 +6936,7 @@ bfa_flash_read_end(void __iomem *pci_bar, u32 len, char *buf)
 	bfa_flash_fifo_flush(pci_bar);
 }
 
-/**
+/*
  * @brief
  * Perform flash raw read.
  *
-- 
2.25.1


  parent reply	other threads:[~2020-07-23 12:26 UTC|newest]

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 ` [PATCH 18/40] scsi: lpfc: lpfc_mbox: Fix a bunch of kerneldoc misdemeanours Lee Jones
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 ` Lee Jones [this message]
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-34-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=anil.gurumurthy@qlogic.com \
    --cc=jejb@linux.ibm.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-scsi@vger.kernel.org \
    --cc=martin.petersen@oracle.com \
    --cc=sudarsana.kalluru@qlogic.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).