Commit 39d2112a authored by Randy Dunlap's avatar Randy Dunlap Committed by Martin K. Petersen
Browse files

scsi: scsi_lib: Add kernel-doc for exported functions 



Add kernel-doc for scsi_failures_reset_retries() and scsi_alloc_request()
since these are exported.  This allows them to be part of the SCSI
driver-api docbook.

Fix kernel-doc comments for scsi_vpd_tpg_id() [add kernel-doc for one
parameter and fix a typo].

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20241212205217.597844-4-rdunlap@infradead.org


CC: James E.J. Bottomley <James.Bottomley@HansenPartnership.com>
CC: Martin K. Petersen <martin.petersen@oracle.com>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent f52a04fc

drivers/scsi/scsi_lib.c

+18 −3
Original line number Diff line number Diff line
@@ -184,6 +184,10 @@ void scsi_queue_insert(struct scsi_cmnd *cmd, int reason) 
	__scsi_queue_insert(cmd, reason, true);

}



/**

 * scsi_failures_reset_retries - reset all failures to zero

 * @failures: &struct scsi_failures with specific failure modes set

 */

void scsi_failures_reset_retries(struct scsi_failures *failures)

{

	struct scsi_failure *failure;
@@ -1214,6 +1218,15 @@ static void scsi_initialize_rq(struct request *rq) 
	cmd->retries = 0;

}



/**

 * scsi_alloc_request - allocate a block request and partially

 *                      initialize its &scsi_cmnd

 * @q: the device's request queue

 * @opf: the request operation code

 * @flags: block layer allocation flags

 *

 * Return: &struct request pointer on success or %NULL on failure

 */

struct request *scsi_alloc_request(struct request_queue *q, blk_opf_t opf,

				   blk_mq_req_flags_t flags)

{
@@ -3365,14 +3378,16 @@ int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len) 
}

EXPORT_SYMBOL(scsi_vpd_lun_id);



/*

/**

 * scsi_vpd_tpg_id - return a target port group identifier

 * @sdev: SCSI device

 * @rel_id: pointer to return relative target port in if not %NULL

 *

 * Returns the Target Port Group identifier from the information

 * froom VPD page 0x83 of the device.

 * from VPD page 0x83 of the device.

 * Optionally sets @rel_id to the relative target port on success.

 *

 * Returns the identifier or error on failure.

 * Return: the identifier or error on failure.

 */

int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)

{