Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Lee Jones and committed by
Martin K. Petersen
242e15d7 29faa5ce

+16 -15
+16 -15
drivers/scsi/isci/remote_device.c
··· 288 288 * isci_remote_device_not_ready() - This function is called by the ihost when 289 289 * the remote device is not ready. We mark the isci device as ready (not 290 290 * "ready_for_io") and signal the waiting proccess. 291 - * @isci_host: This parameter specifies the isci host object. 292 - * @isci_device: This parameter specifies the remote device 291 + * @ihost: This parameter specifies the isci host object. 292 + * @idev: This parameter specifies the remote device 293 + * @reason: Reason to switch on 293 294 * 294 295 * sci_lock is held on entrance to this function. 295 296 */ ··· 1001 1000 1002 1001 /** 1003 1002 * sci_remote_device_destruct() - free remote node context and destruct 1004 - * @remote_device: This parameter specifies the remote device to be destructed. 1003 + * @idev: This parameter specifies the remote device to be destructed. 1005 1004 * 1006 1005 * Remote device objects are a limited resource. As such, they must be 1007 1006 * protected. Thus calls to construct and destruct are mutually exclusive and ··· 1237 1236 1238 1237 /** 1239 1238 * sci_remote_device_construct() - common construction 1240 - * @sci_port: SAS/SATA port through which this device is accessed. 1241 - * @sci_dev: remote device to construct 1239 + * @iport: SAS/SATA port through which this device is accessed. 1240 + * @idev: remote device to construct 1242 1241 * 1243 1242 * This routine just performs benign initialization and does not 1244 1243 * allocate the remote_node_context which is left to ··· 1257 1256 SCIC_SDS_REMOTE_NODE_CONTEXT_INVALID_INDEX); 1258 1257 } 1259 1258 1260 - /** 1259 + /* 1261 1260 * sci_remote_device_da_construct() - construct direct attached device. 1262 1261 * 1263 1262 * The information (e.g. IAF, Signature FIS, etc.) necessary to build ··· 1295 1294 return SCI_SUCCESS; 1296 1295 } 1297 1296 1298 - /** 1297 + /* 1299 1298 * sci_remote_device_ea_construct() - construct expander attached device 1300 1299 * 1301 1300 * Remote node context(s) is/are a global resource allocated by this ··· 1440 1439 * sci_remote_device_start() - This method will start the supplied remote 1441 1440 * device. This method enables normal IO requests to flow through to the 1442 1441 * remote device. 1443 - * @remote_device: This parameter specifies the device to be started. 1442 + * @idev: This parameter specifies the device to be started. 1444 1443 * @timeout: This parameter specifies the number of milliseconds in which the 1445 1444 * start operation should complete. 1446 1445 * ··· 1502 1501 } 1503 1502 1504 1503 /** 1504 + * isci_remote_device_alloc() 1505 1505 * This function builds the isci_remote_device when a libsas dev_found message 1506 1506 * is received. 1507 - * @isci_host: This parameter specifies the isci host object. 1508 - * @port: This parameter specifies the isci_port connected to this device. 1507 + * @ihost: This parameter specifies the isci host object. 1508 + * @iport: This parameter specifies the isci_port connected to this device. 1509 1509 * 1510 1510 * pointer to new isci_remote_device. 1511 1511 */ ··· 1551 1549 /** 1552 1550 * isci_remote_device_stop() - This function is called internally to stop the 1553 1551 * remote device. 1554 - * @isci_host: This parameter specifies the isci host object. 1555 - * @isci_device: This parameter specifies the remote device. 1552 + * @ihost: This parameter specifies the isci host object. 1553 + * @idev: This parameter specifies the remote device. 1556 1554 * 1557 1555 * The status of the ihost request to stop. 1558 1556 */ ··· 1587 1585 /** 1588 1586 * isci_remote_device_gone() - This function is called by libsas when a domain 1589 1587 * device is removed. 1590 - * @domain_device: This parameter specifies the libsas domain device. 1591 - * 1588 + * @dev: This parameter specifies the libsas domain device. 1592 1589 */ 1593 1590 void isci_remote_device_gone(struct domain_device *dev) 1594 1591 { ··· 1607 1606 * device is discovered. A remote device object is created and started. the 1608 1607 * function then sleeps until the sci core device started message is 1609 1608 * received. 1610 - * @domain_device: This parameter specifies the libsas domain device. 1609 + * @dev: This parameter specifies the libsas domain device. 1611 1610 * 1612 1611 * status, zero indicates success. 1613 1612 */