Commit 44b7ca96 authored by Lee Jones's avatar Lee Jones Committed by Martin K. Petersen

scsi: isci: host: Fix bunch of kernel-doc related issues

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'

Link: https://lore.kernel.org/r/20210317091230.2912389-22-lee.jones@linaro.org
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: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent db35a083
...@@ -89,16 +89,14 @@ ...@@ -89,16 +89,14 @@
#define SCIC_SDS_CONTROLLER_PHY_START_TIMEOUT 100 #define SCIC_SDS_CONTROLLER_PHY_START_TIMEOUT 100
/** /*
*
*
* The number of milliseconds to wait while a given phy is consuming power * 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 * before allowing another set of phys to consume power. Ultimately, this will
* be specified by OEM parameter. * be specified by OEM parameter.
*/ */
#define SCIC_SDS_CONTROLLER_POWER_CONTROL_INTERVAL 500 #define SCIC_SDS_CONTROLLER_POWER_CONTROL_INTERVAL 500
/** /*
* NORMALIZE_PUT_POINTER() - * NORMALIZE_PUT_POINTER() -
* *
* This macro will normalize the completion queue put pointer so its value can * This macro will normalize the completion queue put pointer so its value can
...@@ -108,7 +106,7 @@ ...@@ -108,7 +106,7 @@
((x) & SMU_COMPLETION_QUEUE_PUT_POINTER_MASK) ((x) & SMU_COMPLETION_QUEUE_PUT_POINTER_MASK)
/** /*
* NORMALIZE_EVENT_POINTER() - * NORMALIZE_EVENT_POINTER() -
* *
* This macro will normalize the completion queue event entry so its value can * This macro will normalize the completion queue event entry so its value can
...@@ -120,7 +118,7 @@ ...@@ -120,7 +118,7 @@
>> SMU_COMPLETION_QUEUE_GET_EVENT_POINTER_SHIFT \ >> SMU_COMPLETION_QUEUE_GET_EVENT_POINTER_SHIFT \
) )
/** /*
* NORMALIZE_GET_POINTER() - * NORMALIZE_GET_POINTER() -
* *
* This macro will normalize the completion queue get pointer so its value can * This macro will normalize the completion queue get pointer so its value can
...@@ -129,7 +127,7 @@ ...@@ -129,7 +127,7 @@
#define NORMALIZE_GET_POINTER(x) \ #define NORMALIZE_GET_POINTER(x) \
((x) & SMU_COMPLETION_QUEUE_GET_POINTER_MASK) ((x) & SMU_COMPLETION_QUEUE_GET_POINTER_MASK)
/** /*
* NORMALIZE_GET_POINTER_CYCLE_BIT() - * NORMALIZE_GET_POINTER_CYCLE_BIT() -
* *
* This macro will normalize the completion queue cycle pointer so it matches * This macro will normalize the completion queue cycle pointer so it matches
...@@ -138,7 +136,7 @@ ...@@ -138,7 +136,7 @@
#define NORMALIZE_GET_POINTER_CYCLE_BIT(x) \ #define NORMALIZE_GET_POINTER_CYCLE_BIT(x) \
((SMU_CQGR_CYCLE_BIT & (x)) << (31 - SMU_COMPLETION_QUEUE_GET_CYCLE_BIT_SHIFT)) ((SMU_CQGR_CYCLE_BIT & (x)) << (31 - SMU_COMPLETION_QUEUE_GET_CYCLE_BIT_SHIFT))
/** /*
* COMPLETION_QUEUE_CYCLE_BIT() - * COMPLETION_QUEUE_CYCLE_BIT() -
* *
* This macro will return the cycle bit of the completion queue entry * 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) ...@@ -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, * isci_host_start_complete() - This function is called by the core library,
* through the ISCI Module, to indicate controller start status. * 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 * @completion_status: This parameter specifies the completion status from the
* core library. * core library.
* *
...@@ -670,7 +668,7 @@ int isci_host_scan_finished(struct Scsi_Host *shost, unsigned long time) ...@@ -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 * use any timeout value, but this method provides the suggested minimum
* start timeout value. The returned value is based upon empirical * start timeout value. The returned value is based upon empirical
* information determined as a result of interoperability testing. * 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. * suggested start timeout.
* *
* This method returns the number of milliseconds for the suggested start * This method returns the number of milliseconds for the suggested start
...@@ -893,7 +891,7 @@ bool is_controller_start_complete(struct isci_host *ihost) ...@@ -893,7 +891,7 @@ bool is_controller_start_complete(struct isci_host *ihost)
/** /**
* sci_controller_start_next_phy - start phy * sci_controller_start_next_phy - start phy
* @scic: controller * @ihost: controller
* *
* If all the phys have been started, then attempt to transition the * If all the phys have been started, then attempt to transition the
* controller to the READY state and inform the user * controller to the READY state and inform the user
...@@ -1145,7 +1143,7 @@ void isci_host_completion_routine(unsigned long data) ...@@ -1145,7 +1143,7 @@ void isci_host_completion_routine(unsigned long data)
* controller has been quiesced. This method will ensure that all IO * controller has been quiesced. This method will ensure that all IO
* requests are quiesced, phys are stopped, and all additional operation by * requests are quiesced, phys are stopped, and all additional operation by
* the hardware is halted. * 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 * @timeout: This parameter specifies the number of milliseconds in which the
* stop operation should complete. * stop operation should complete.
* *
...@@ -1174,7 +1172,7 @@ static enum sci_status sci_controller_stop(struct isci_host *ihost, u32 timeout) ...@@ -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 * considered destructive. In other words, all current operations are wiped
* out. No IO completions for outstanding devices occur. Outstanding IO * out. No IO completions for outstanding devices occur. Outstanding IO
* requests are not aborted or completed at the actual remote device. * 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. * Indicate if the controller reset method succeeded or failed in some way.
* SCI_SUCCESS if the reset operation successfully started. SCI_FATAL_ERROR if * 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 ...@@ -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 * sci_controller_set_interrupt_coalescence() - This method allows the user to
* configure the interrupt coalescence. * 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. * for which its interrupt coalesce register is overridden.
* @coalesce_number: Used to control the number of entries in the Completion * @coalesce_number: Used to control the number of entries in the Completion
* Queue before an interrupt is generated. If the number of entries exceed * 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) ...@@ -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 * 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 * context space for use. This method can fail if there are no more remote
* node index available. * 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 * 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 * id
* @node_id: This is the remote node id that is assinged to the device if one * @node_id: This is the remote node id that is assinged to the device if one
* is available * is available
...@@ -2709,11 +2708,11 @@ enum sci_status sci_controller_continue_io(struct isci_request *ireq) ...@@ -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 * sci_controller_start_task() - This method is called by the SCIC user to
* send/start a framework task management request. * 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. * 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. * 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, enum sci_status sci_controller_start_task(struct isci_host *ihost,
struct isci_remote_device *idev, struct isci_remote_device *idev,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment