Commit 3a17fefe authored by Bart Van Assche's avatar Bart Van Assche Committed by Martin K. Petersen
Browse files

scsi: ufs: Follow the kernel-doc syntax for documenting return values 



Use 'Return:' to document the return value instead of 'Returns' as required
by the kernel-doc documentation.

Signed-off-by: default avatarBart Van Assche <bvanassche@acm.org>
Link: https://lore.kernel.org/r/20230727194457.3152309-2-bvanassche@acm.org


Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent 2903265e

drivers/ufs/core/ufs-mcq.c

+5 −5
Original line number Diff line number Diff line
@@ -105,7 +105,7 @@ EXPORT_SYMBOL_GPL(ufshcd_mcq_config_mac); 
 * @hba: per adapter instance

 * @req: pointer to the request to be issued

 *

 * Returns the hardware queue instance on which the request would

 * Return: the hardware queue instance on which the request would

 * be queued.

 */

struct ufs_hw_queue *ufshcd_mcq_req_to_hwq(struct ufs_hba *hba,
@@ -121,7 +121,7 @@ struct ufs_hw_queue *ufshcd_mcq_req_to_hwq(struct ufs_hba *hba, 
 * ufshcd_mcq_decide_queue_depth - decide the queue depth

 * @hba: per adapter instance

 *

 * Returns queue-depth on success, non-zero on error

 * Return: queue-depth on success, non-zero on error

 *

 * MAC - Max. Active Command of the Host Controller (HC)

 * HC wouldn't send more than this commands to the device.
@@ -493,7 +493,7 @@ static int ufshcd_mcq_sq_start(struct ufs_hba *hba, struct ufs_hw_queue *hwq) 
 * @hba: per adapter instance.

 * @task_tag: The command's task tag.

 *

 * Returns 0 for success; error code otherwise.

 * Return: 0 for success; error code otherwise.

 */

int ufshcd_mcq_sq_cleanup(struct ufs_hba *hba, int task_tag)

{
@@ -575,7 +575,7 @@ static void ufshcd_mcq_nullify_sqe(struct utp_transfer_req_desc *utrd) 
 * @hwq: Hardware Queue to be searched.

 * @task_tag: The command's task tag.

 *

 * Returns true if the SQE containing the command is present in the SQ

 * Return: true if the SQE containing the command is present in the SQ

 * (not fetched by the controller); returns false if the SQE is not in the SQ.

 */

static bool ufshcd_mcq_sqe_search(struct ufs_hba *hba,
@@ -624,7 +624,7 @@ static bool ufshcd_mcq_sqe_search(struct ufs_hba *hba, 
 * ufshcd_mcq_abort - Abort the command in MCQ.

 * @cmd: The command to be aborted.

 *

 * Returns SUCCESS or FAILED error codes

 * Return: SUCCESS or FAILED error codes

 */

int ufshcd_mcq_abort(struct scsi_cmnd *cmd)

{

drivers/ufs/core/ufshcd-priv.h

+1 −1
Original line number Diff line number Diff line
@@ -294,7 +294,7 @@ extern const struct ufs_pm_lvl_states ufs_pm_lvl_states[]; 
 * ufshcd_scsi_to_upiu_lun - maps scsi LUN to UPIU LUN

 * @scsi_lun: scsi LUN id

 *

 * Returns UPIU LUN id

 * Return: UPIU LUN id

 */

static inline u8 ufshcd_scsi_to_upiu_lun(unsigned int scsi_lun)

{

drivers/ufs/core/ufshcd.c

+95 −91

File changed.

Preview size limit exceeded, changes collapsed.

drivers/ufs/host/cdns-pltfrm.c

+5 −5

File changed.

Preview size limit exceeded, changes collapsed.

drivers/ufs/host/tc-dwc-g210-pci.c

+1 −1
Original line number Diff line number Diff line
@@ -51,7 +51,7 @@ static void tc_dwc_g210_pci_remove(struct pci_dev *pdev) 
 * @pdev: pointer to PCI device handle

 * @id: PCI device id

 *

 * Returns 0 on success, non-zero value on failure

 * Return: 0 on success, non-zero value on failure.

 */

static int

tc_dwc_g210_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)