qiurui
/
Centos-kernel-stream-9
mirror of https://gitlab.com/redhat/centos-stream/src/kernel/centos-stream-9.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

scsi: scsi_lib: Add kernel-doc for exported functions 

JIRA: https://issues.redhat.com/browse/RHEL-86156
Upstream Status: From upstream linux mainline

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: Randy 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: Martin K. Petersen <martin.petersen@oracle.com>
(cherry picked from commit 39d2112ab7c8050642fdc2830a0a3edc5337827f)
Signed-off-by: Ewan D. Milne <emilne@redhat.com>
This commit is contained in:
Ewan D. Milne 2025-04-11 15:52:18 -04:00
parent 0a65f58087
commit 18b31dff93
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
drivers/scsi/scsi_lib.c
View File

@ -184,6 +184,10 @@ void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
__scsi_queue_insert(cmd, reason, true); __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) void scsi_failures_reset_retries(struct scsi_failures *failures)
{ {
struct scsi_failure *failure; struct scsi_failure *failure;
@ -1232,6 +1236,15 @@ static void scsi_initialize_rq(struct request *rq)
cmd->retries = 0; 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, struct request *scsi_alloc_request(struct request_queue *q, blk_opf_t opf,
blk_mq_req_flags_t flags) blk_mq_req_flags_t flags)
{ {
@ -3410,14 +3423,16 @@ int scsi_vpd_lun_id(struct scsi_device *sdev, char *id, size_t id_len)
} }
EXPORT_SYMBOL(scsi_vpd_lun_id); EXPORT_SYMBOL(scsi_vpd_lun_id);
/* /**
* scsi_vpd_tpg_id - return a target port group identifier * scsi_vpd_tpg_id - return a target port group identifier
* @sdev: SCSI device * @sdev: SCSI device
* @rel_id: pointer to return relative target port in if not %NULL
* *
* Returns the Target Port Group identifier from the information * 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) int scsi_vpd_tpg_id(struct scsi_device *sdev, int *rel_id)
{ {