[PATCH 33/40] scsi: bfa: bfa_ioc: Demote non-kerneldoc headers down to standard comment blocks

From: Lee Jones
Date: Thu Jul 23 2020 - 08:26:06 EST


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@xxxxxxxxxx>
Cc: Sudarsana Kalluru <sudarsana.kalluru@xxxxxxxxxx>
Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
---
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