scsi: isci: remote_device: Fix a bunch of doc-rot issues
Fixes the following W=1 kernel build warning(s): drivers/scsi/isci/remote_device.c:299: warning: Function parameter or member 'ihost' not described in 'isci_remote_device_not_ready' drivers/scsi/isci/remote_device.c:299: warning: Function parameter or member 'idev' not described in 'isci_remote_device_not_ready' drivers/scsi/isci/remote_device.c:299: warning: Function parameter or member 'reason' not described in 'isci_remote_device_not_ready' drivers/scsi/isci/remote_device.c:299: warning: Excess function parameter 'isci_host' description in 'isci_remote_device_not_ready' drivers/scsi/isci/remote_device.c:299: warning: Excess function parameter 'isci_device' description in 'isci_remote_device_not_ready' drivers/scsi/isci/remote_device.c:1015: warning: Function parameter or member 'idev' not described in 'sci_remote_device_destruct' drivers/scsi/isci/remote_device.c:1015: warning: Excess function parameter 'remote_device' description in 'sci_remote_device_destruct' drivers/scsi/isci/remote_device.c:1249: warning: Function parameter or member 'iport' not described in 'sci_remote_device_construct' drivers/scsi/isci/remote_device.c:1249: warning: Function parameter or member 'idev' not described in 'sci_remote_device_construct' drivers/scsi/isci/remote_device.c:1249: warning: Excess function parameter 'sci_port' description in 'sci_remote_device_construct' drivers/scsi/isci/remote_device.c:1249: warning: Excess function parameter 'sci_dev' description in 'sci_remote_device_construct' drivers/scsi/isci/remote_device.c:1275: warning: Function parameter or member 'iport' not described in 'sci_remote_device_da_construct' drivers/scsi/isci/remote_device.c:1275: warning: Function parameter or member 'idev' not described in 'sci_remote_device_da_construct' drivers/scsi/isci/remote_device.c:1311: warning: Function parameter or member 'iport' not described in 'sci_remote_device_ea_construct' drivers/scsi/isci/remote_device.c:1311: warning: Function parameter or member 'idev' not described in 'sci_remote_device_ea_construct' drivers/scsi/isci/remote_device.c:1453: warning: Function parameter or member 'idev' not described in 'sci_remote_device_start' drivers/scsi/isci/remote_device.c:1453: warning: Excess function parameter 'remote_device' description in 'sci_remote_device_start' drivers/scsi/isci/remote_device.c:1513: warning: Function parameter or member 'ihost' not described in 'isci_remote_device_alloc' drivers/scsi/isci/remote_device.c:1513: warning: Function parameter or member 'iport' not described in 'isci_remote_device_alloc' drivers/scsi/isci/remote_device.c:1513: warning: expecting prototype for This function builds the isci_remote_device when a libsas dev_found message(). Prototype was for isci_remote_device_alloc() instead drivers/scsi/isci/remote_device.c:1558: warning: Function parameter or member 'ihost' not described in 'isci_remote_device_stop' drivers/scsi/isci/remote_device.c:1558: warning: Function parameter or member 'idev' not described in 'isci_remote_device_stop' drivers/scsi/isci/remote_device.c:1558: warning: Excess function parameter 'isci_host' description in 'isci_remote_device_stop' drivers/scsi/isci/remote_device.c:1558: warning: Excess function parameter 'isci_device' description in 'isci_remote_device_stop' drivers/scsi/isci/remote_device.c:1592: warning: Function parameter or member 'dev' not described in 'isci_remote_device_gone' drivers/scsi/isci/remote_device.c:1592: warning: Excess function parameter 'domain_device' description in 'isci_remote_device_gone' drivers/scsi/isci/remote_device.c:1614: warning: Function parameter or member 'dev' not described in 'isci_remote_device_found' drivers/scsi/isci/remote_device.c:1614: warning: Excess function parameter 'domain_device' description in 'isci_remote_device_found' Link: https://lore.kernel.org/r/20210317091230.2912389-27-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: Lee Jones <lee.jones@linaro.org> Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
This commit is contained in:
Lee Jones
Martin K. Petersen
parent
29faa5ce26
commit
242e15d7a4
|
|
@ -288,8 +288,9 @@ enum sci_status isci_remote_device_terminate_requests(
|
|||
* isci_remote_device_not_ready() - This function is called by the ihost when
|
||||
* the remote device is not ready. We mark the isci device as ready (not
|
||||
* "ready_for_io") and signal the waiting proccess.
|
||||
* @isci_host: This parameter specifies the isci host object.
|
||||
* @isci_device: This parameter specifies the remote device
|
||||
* @ihost: This parameter specifies the isci host object.
|
||||
* @idev: This parameter specifies the remote device
|
||||
* @reason: Reason to switch on
|
||||
*
|
||||
* sci_lock is held on entrance to this function.
|
||||
*/
|
||||
|
|
@ -1000,7 +1001,7 @@ static void sci_remote_device_initial_state_enter(struct sci_base_state_machine
|
|||
|
||||
/**
|
||||
* sci_remote_device_destruct() - free remote node context and destruct
|
||||
* @remote_device: This parameter specifies the remote device to be destructed.
|
||||
* @idev: This parameter specifies the remote device to be destructed.
|
||||
*
|
||||
* Remote device objects are a limited resource. As such, they must be
|
||||
* protected. Thus calls to construct and destruct are mutually exclusive and
|
||||
|
|
@ -1236,8 +1237,8 @@ static const struct sci_base_state sci_remote_device_state_table[] = {
|
|||
|
||||
/**
|
||||
* sci_remote_device_construct() - common construction
|
||||
* @sci_port: SAS/SATA port through which this device is accessed.
|
||||
* @sci_dev: remote device to construct
|
||||
* @iport: SAS/SATA port through which this device is accessed.
|
||||
* @idev: remote device to construct
|
||||
*
|
||||
* This routine just performs benign initialization and does not
|
||||
* allocate the remote_node_context which is left to
|
||||
|
|
@ -1256,7 +1257,7 @@ static void sci_remote_device_construct(struct isci_port *iport,
|
|||
SCIC_SDS_REMOTE_NODE_CONTEXT_INVALID_INDEX);
|
||||
}
|
||||
|
||||
/**
|
||||
/*
|
||||
* sci_remote_device_da_construct() - construct direct attached device.
|
||||
*
|
||||
* The information (e.g. IAF, Signature FIS, etc.) necessary to build
|
||||
|
|
@ -1294,7 +1295,7 @@ static enum sci_status sci_remote_device_da_construct(struct isci_port *iport,
|
|||
return SCI_SUCCESS;
|
||||
}
|
||||
|
||||
/**
|
||||
/*
|
||||
* sci_remote_device_ea_construct() - construct expander attached device
|
||||
*
|
||||
* Remote node context(s) is/are a global resource allocated by this
|
||||
|
|
@ -1439,7 +1440,7 @@ enum sci_status isci_remote_device_resume_from_abort(
|
|||
* sci_remote_device_start() - This method will start the supplied remote
|
||||
* device. This method enables normal IO requests to flow through to the
|
||||
* remote device.
|
||||
* @remote_device: This parameter specifies the device to be started.
|
||||
* @idev: This parameter specifies the device to be started.
|
||||
* @timeout: This parameter specifies the number of milliseconds in which the
|
||||
* start operation should complete.
|
||||
*
|
||||
|
|
@ -1501,10 +1502,11 @@ static enum sci_status isci_remote_device_construct(struct isci_port *iport,
|
|||
}
|
||||
|
||||
/**
|
||||
* isci_remote_device_alloc()
|
||||
* This function builds the isci_remote_device when a libsas dev_found message
|
||||
* is received.
|
||||
* @isci_host: This parameter specifies the isci host object.
|
||||
* @port: This parameter specifies the isci_port connected to this device.
|
||||
* @ihost: This parameter specifies the isci host object.
|
||||
* @iport: This parameter specifies the isci_port connected to this device.
|
||||
*
|
||||
* pointer to new isci_remote_device.
|
||||
*/
|
||||
|
|
@ -1549,8 +1551,8 @@ void isci_remote_device_release(struct kref *kref)
|
|||
/**
|
||||
* isci_remote_device_stop() - This function is called internally to stop the
|
||||
* remote device.
|
||||
* @isci_host: This parameter specifies the isci host object.
|
||||
* @isci_device: This parameter specifies the remote device.
|
||||
* @ihost: This parameter specifies the isci host object.
|
||||
* @idev: This parameter specifies the remote device.
|
||||
*
|
||||
* The status of the ihost request to stop.
|
||||
*/
|
||||
|
|
@ -1585,8 +1587,7 @@ enum sci_status isci_remote_device_stop(struct isci_host *ihost, struct isci_rem
|
|||
/**
|
||||
* isci_remote_device_gone() - This function is called by libsas when a domain
|
||||
* device is removed.
|
||||
* @domain_device: This parameter specifies the libsas domain device.
|
||||
*
|
||||
* @dev: This parameter specifies the libsas domain device.
|
||||
*/
|
||||
void isci_remote_device_gone(struct domain_device *dev)
|
||||
{
|
||||
|
|
@ -1606,7 +1607,7 @@ void isci_remote_device_gone(struct domain_device *dev)
|
|||
* device is discovered. A remote device object is created and started. the
|
||||
* function then sleeps until the sci core device started message is
|
||||
* received.
|
||||
* @domain_device: This parameter specifies the libsas domain device.
|
||||
* @dev: This parameter specifies the libsas domain device.
|
||||
*
|
||||
* status, zero indicates success.
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue