From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
Artur Paszkiewicz <artur.paszkiewicz@intel.com>,
"James E.J. Bottomley" <jejb@linux.ibm.com>,
"Martin K. Petersen" <martin.petersen@oracle.com>,
linux-scsi@vger.kernel.org
Subject: [PATCH 21/36] scsi: isci: host: Fix bunch of kernel-doc related issues
Date: Wed, 17 Mar 2021 09:12:15 +0000 [thread overview]
Message-ID: <20210317091230.2912389-22-lee.jones@linaro.org> (raw)
In-Reply-To: <20210317091230.2912389-1-lee.jones@linaro.org>
Fixes the following W=1 kernel build warning(s):
drivers/scsi/isci/host.c:93: warning: Cannot understand *
drivers/scsi/isci/host.c:108: warning: Function parameter or member 'x' not described in 'NORMALIZE_PUT_POINTER'
drivers/scsi/isci/host.c:121: warning: Function parameter or member 'x' not described in 'NORMALIZE_EVENT_POINTER'
drivers/scsi/isci/host.c:130: warning: Function parameter or member 'x' not described in 'NORMALIZE_GET_POINTER'
drivers/scsi/isci/host.c:139: warning: Function parameter or member 'x' not described in 'NORMALIZE_GET_POINTER_CYCLE_BIT'
drivers/scsi/isci/host.c:146: warning: Function parameter or member 'x' not described in 'COMPLETION_QUEUE_CYCLE_BIT'
drivers/scsi/isci/host.c:646: warning: Function parameter or member 'ihost' not described in 'isci_host_start_complete'
drivers/scsi/isci/host.c:646: warning: Excess function parameter 'isci_host' description in 'isci_host_start_complete'
drivers/scsi/isci/host.c:680: warning: Function parameter or member 'ihost' not described in 'sci_controller_get_suggested_start_timeout'
drivers/scsi/isci/host.c:680: warning: Excess function parameter 'controller' description in 'sci_controller_get_suggested_start_timeout'
drivers/scsi/isci/host.c:903: warning: Function parameter or member 'ihost' not described in 'sci_controller_start_next_phy'
drivers/scsi/isci/host.c:903: warning: Excess function parameter 'scic' description in 'sci_controller_start_next_phy'
drivers/scsi/isci/host.c:1159: warning: Function parameter or member 'ihost' not described in 'sci_controller_stop'
drivers/scsi/isci/host.c:1159: warning: Excess function parameter 'controller' description in 'sci_controller_stop'
drivers/scsi/isci/host.c:1184: warning: Function parameter or member 'ihost' not described in 'sci_controller_reset'
drivers/scsi/isci/host.c:1184: warning: Excess function parameter 'controller' description in 'sci_controller_reset'
drivers/scsi/isci/host.c:1352: warning: Function parameter or member 'ihost' not described in 'sci_controller_set_interrupt_coalescence'
drivers/scsi/isci/host.c:1352: warning: Excess function parameter 'controller' description in 'sci_controller_set_interrupt_coalescence'
drivers/scsi/isci/host.c:2498: warning: Function parameter or member 'ihost' not described in 'sci_controller_allocate_remote_node_context'
drivers/scsi/isci/host.c:2498: warning: Function parameter or member 'idev' not described in 'sci_controller_allocate_remote_node_context'
drivers/scsi/isci/host.c:2498: warning: expecting prototype for This method allocates remote node index and the reserves the remote node(). Prototype was for sci_controller_allocate_remote_node_context() instead
drivers/scsi/isci/host.c:2721: warning: Function parameter or member 'ihost' not described in 'sci_controller_start_task'
drivers/scsi/isci/host.c:2721: warning: Function parameter or member 'idev' not described in 'sci_controller_start_task'
drivers/scsi/isci/host.c:2721: warning: Function parameter or member 'ireq' not described in 'sci_controller_start_task'
drivers/scsi/isci/host.c:2721: warning: Excess function parameter 'controller' description in 'sci_controller_start_task'
drivers/scsi/isci/host.c:2721: warning: Excess function parameter 'remote_device' description in 'sci_controller_start_task'
drivers/scsi/isci/host.c:2721: warning: Excess function parameter 'task_request' description in 'sci_controller_start_task'
Cc: Artur Paszkiewicz <artur.paszkiewicz@intel.com>
Cc: "James E.J. Bottomley" <jejb@linux.ibm.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Cc: linux-scsi@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/scsi/isci/host.c | 37 ++++++++++++++++++-------------------
1 file changed, 18 insertions(+), 19 deletions(-)
diff --git a/drivers/scsi/isci/host.c b/drivers/scsi/isci/host.c
index 7ebfa3c8cdc78..d690d9cf7eb15 100644
--- a/drivers/scsi/isci/host.c
+++ b/drivers/scsi/isci/host.c
@@ -89,16 +89,14 @@
#define SCIC_SDS_CONTROLLER_PHY_START_TIMEOUT 100
-/**
- *
- *
+/*
* The number of milliseconds to wait while a given phy is consuming power
* before allowing another set of phys to consume power. Ultimately, this will
* be specified by OEM parameter.
*/
#define SCIC_SDS_CONTROLLER_POWER_CONTROL_INTERVAL 500
-/**
+/*
* NORMALIZE_PUT_POINTER() -
*
* This macro will normalize the completion queue put pointer so its value can
@@ -108,7 +106,7 @@
((x) & SMU_COMPLETION_QUEUE_PUT_POINTER_MASK)
-/**
+/*
* NORMALIZE_EVENT_POINTER() -
*
* This macro will normalize the completion queue event entry so its value can
@@ -120,7 +118,7 @@
>> SMU_COMPLETION_QUEUE_GET_EVENT_POINTER_SHIFT \
)
-/**
+/*
* NORMALIZE_GET_POINTER() -
*
* This macro will normalize the completion queue get pointer so its value can
@@ -129,7 +127,7 @@
#define NORMALIZE_GET_POINTER(x) \
((x) & SMU_COMPLETION_QUEUE_GET_POINTER_MASK)
-/**
+/*
* NORMALIZE_GET_POINTER_CYCLE_BIT() -
*
* This macro will normalize the completion queue cycle pointer so it matches
@@ -138,7 +136,7 @@
#define NORMALIZE_GET_POINTER_CYCLE_BIT(x) \
((SMU_CQGR_CYCLE_BIT & (x)) << (31 - SMU_COMPLETION_QUEUE_GET_CYCLE_BIT_SHIFT))
-/**
+/*
* COMPLETION_QUEUE_CYCLE_BIT() -
*
* This macro will return the cycle bit of the completion queue entry
@@ -637,7 +635,7 @@ irqreturn_t isci_error_isr(int vec, void *data)
/**
* isci_host_start_complete() - This function is called by the core library,
* through the ISCI Module, to indicate controller start status.
- * @isci_host: This parameter specifies the ISCI host object
+ * @ihost: This parameter specifies the ISCI host object
* @completion_status: This parameter specifies the completion status from the
* core library.
*
@@ -670,7 +668,7 @@ int isci_host_scan_finished(struct Scsi_Host *shost, unsigned long time)
* use any timeout value, but this method provides the suggested minimum
* start timeout value. The returned value is based upon empirical
* information determined as a result of interoperability testing.
- * @controller: the handle to the controller object for which to return the
+ * @ihost: the handle to the controller object for which to return the
* suggested start timeout.
*
* This method returns the number of milliseconds for the suggested start
@@ -893,7 +891,7 @@ bool is_controller_start_complete(struct isci_host *ihost)
/**
* sci_controller_start_next_phy - start phy
- * @scic: controller
+ * @ihost: controller
*
* If all the phys have been started, then attempt to transition the
* controller to the READY state and inform the user
@@ -1145,7 +1143,7 @@ void isci_host_completion_routine(unsigned long data)
* controller has been quiesced. This method will ensure that all IO
* requests are quiesced, phys are stopped, and all additional operation by
* the hardware is halted.
- * @controller: the handle to the controller object to stop.
+ * @ihost: the handle to the controller object to stop.
* @timeout: This parameter specifies the number of milliseconds in which the
* stop operation should complete.
*
@@ -1174,7 +1172,7 @@ static enum sci_status sci_controller_stop(struct isci_host *ihost, u32 timeout)
* considered destructive. In other words, all current operations are wiped
* out. No IO completions for outstanding devices occur. Outstanding IO
* requests are not aborted or completed at the actual remote device.
- * @controller: the handle to the controller object to reset.
+ * @ihost: the handle to the controller object to reset.
*
* Indicate if the controller reset method succeeded or failed in some way.
* SCI_SUCCESS if the reset operation successfully started. SCI_FATAL_ERROR if
@@ -1331,7 +1329,7 @@ static inline void sci_controller_starting_state_exit(struct sci_base_state_mach
/**
* sci_controller_set_interrupt_coalescence() - This method allows the user to
* configure the interrupt coalescence.
- * @controller: This parameter represents the handle to the controller object
+ * @ihost: This parameter represents the handle to the controller object
* for which its interrupt coalesce register is overridden.
* @coalesce_number: Used to control the number of entries in the Completion
* Queue before an interrupt is generated. If the number of entries exceed
@@ -2479,12 +2477,13 @@ struct isci_request *sci_request_by_tag(struct isci_host *ihost, u16 io_tag)
}
/**
+ * sci_controller_allocate_remote_node_context()
* This method allocates remote node index and the reserves the remote node
* context space for use. This method can fail if there are no more remote
* node index available.
- * @scic: This is the controller object which contains the set of
+ * @ihost: This is the controller object which contains the set of
* free remote node ids
- * @sci_dev: This is the device object which is requesting the a remote node
+ * @idev: This is the device object which is requesting the a remote node
* id
* @node_id: This is the remote node id that is assinged to the device if one
* is available
@@ -2709,11 +2708,11 @@ enum sci_status sci_controller_continue_io(struct isci_request *ireq)
/**
* sci_controller_start_task() - This method is called by the SCIC user to
* send/start a framework task management request.
- * @controller: the handle to the controller object for which to start the task
+ * @ihost: the handle to the controller object for which to start the task
* management request.
- * @remote_device: the handle to the remote device object for which to start
+ * @idev: the handle to the remote device object for which to start
* the task management request.
- * @task_request: the handle to the task request object to start.
+ * @ireq: the handle to the task request object to start.
*/
enum sci_status sci_controller_start_task(struct isci_host *ihost,
struct isci_remote_device *idev,
--
2.27.0
next prev parent reply other threads:[~2021-03-17 9:14 UTC|newest]
Thread overview: 40+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-17 9:11 [PATCH 00/36] [Set 4] Rid W=1 warnings in SCSI Lee Jones
2021-03-17 9:11 ` [PATCH 01/36] scsi: myrb: Demote non-conformant kernel-doc headers and fix others Lee Jones
2021-03-17 9:11 ` [PATCH 02/36] scsi: ipr: Fix incorrect function names in their headers Lee Jones
2021-03-17 9:11 ` [PATCH 03/36] scsi: mvumi: Fix formatting and doc-rot issues Lee Jones
2021-03-17 9:11 ` [PATCH 04/36] scsi: sd_zbc: Place function name into header Lee Jones
2021-03-17 9:11 ` [PATCH 05/36] scsi: pmcraid: Fix a whole host of kernel-doc issues Lee Jones
2021-03-17 9:12 ` [PATCH 06/36] scsi: sd: Fix function name in header Lee Jones
2021-03-17 9:12 ` [PATCH 07/36] scsi: aic94xx: aic94xx_dump: Correct misspelling of function asd_dump_seq_state() Lee Jones
2021-03-17 9:12 ` [PATCH 08/36] scsi: be2iscsi: be_main: Ensure function follows directly after its header Lee Jones
2021-03-17 9:12 ` [PATCH 09/36] scsi: dc395x: Fix some function param descriptions Lee Jones
2021-03-17 9:12 ` [PATCH 10/36] scsi: initio: Fix a few kernel-doc misdemeanours Lee Jones
2021-03-17 9:12 ` [PATCH 11/36] scsi: a100u2w: Fix some misnaming and formatting issues Lee Jones
2021-03-17 9:12 ` [PATCH 12/36] scsi: myrs: Add missing ':' to make the kernel-doc checker happy Lee Jones
2021-03-17 9:12 ` [PATCH 13/36] scsi: pmcraid: Correct function name pmcraid_show_adapter_id() in header Lee Jones
2021-03-17 9:12 ` [PATCH 14/36] scsi: mpt3sas: mpt3sas_scs: Fix a few kernel-doc issues Lee Jones
2021-03-17 9:12 ` [PATCH 15/36] scsi: be2iscsi: be_main: Demote incomplete/non-conformant kernel-doc header Lee Jones
2021-03-17 9:12 ` [PATCH 16/36] scsi: isci: phy: Fix a few different kernel-doc related issues Lee Jones
2021-03-17 9:12 ` [PATCH 17/36] scsi: fnic: fnic_scsi: Demote non-conformant kernel-doc headers Lee Jones
2021-03-17 9:12 ` [PATCH 18/36] scsi: fnic: fnic_fcs: Kernel-doc headers must contain the function name Lee Jones
2021-03-17 9:12 ` [PATCH 19/36] scsi: isci: phy: Provide function name and demote non-conforming header Lee Jones
2021-03-17 9:12 ` [PATCH 20/36] scsi: isci: request: Fix a myriad of kernel-doc issues Lee Jones
2021-03-17 9:12 ` Lee Jones [this message]
2021-03-17 9:12 ` [PATCH 22/36] scsi: isci: task: Demote non-conformant header and remove superfluous param Lee Jones
2021-03-17 9:12 ` [PATCH 23/36] scsi: isci: remote_node_table: Fix a bunch of kernel-doc misdemeanours Lee Jones
2021-03-17 9:12 ` [PATCH 24/36] scsi: isci: remote_node_context: Fix one function header and demote a couple more Lee Jones
2021-03-17 9:12 ` [PATCH 25/36] scsi: isci: port_config: Fix a bunch of doc-rot and demote abuses Lee Jones
2021-03-17 9:12 ` [PATCH 26/36] scsi: isci: remote_device: Fix a bunch of doc-rot issues Lee Jones
2021-03-17 9:12 ` [PATCH 27/36] scsi: isci: request: Fix doc-rot issue relating to 'ireq' param Lee Jones
2021-03-17 9:12 ` [PATCH 28/36] scsi: isci: port: Fix a bunch of kernel-doc issues Lee Jones
2021-03-17 9:12 ` [PATCH 29/36] scsi: isci: remote_node_context: Demote kernel-doc abuse Lee Jones
2021-03-17 9:12 ` [PATCH 30/36] scsi: isci: remote_node_table: Provide some missing params and remove others Lee Jones
2021-03-17 9:12 ` [PATCH 31/36] scsi: cxlflash: main: Fix a little do-rot Lee Jones
2021-03-17 9:12 ` [PATCH 32/36] scsi: cxlflash: superpipe: Fix a few misnaming issues Lee Jones
2021-03-17 9:12 ` [PATCH 33/36] scsi: ibmvscsi: Fix a bunch of kernel-doc related issues Lee Jones
2021-03-17 9:12 ` [PATCH 34/36] scsi: ibmvscsi: ibmvfc: Fix a bunch of misdocumentation Lee Jones
2021-03-17 9:12 ` [PATCH 35/36] scsi: ibmvscsi_tgt: ibmvscsi_tgt: Remove duplicate section 'NOTE' Lee Jones
2021-03-17 9:12 ` [PATCH 36/36] scsi: cxlflash: vlun: Fix some misnaming related doc-rot Lee Jones
2021-03-19 3:41 ` [PATCH 00/36] [Set 4] Rid W=1 warnings in SCSI Martin K. Petersen
2021-03-19 8:10 ` Lee Jones
2021-03-25 3:53 ` 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=20210317091230.2912389-22-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=artur.paszkiewicz@intel.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
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).