github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-11-06 21:58:01 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

scsi: core: Fix scsi_done() documentation

Browse Source 
Commit 11b68e36b1 ("scsi: core: Call scsi_done directly") changed
scsi_done from a function pointer member into a regular function.

Replace all references to the scsi_done function pointer member
with references to the scsi_done() function.

Cc: John Garry <john.garry@linux.dev>
Cc: Hannes Reinecke <hare@kernel.org>
Cc: Damien Le Moal <dlemoal@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
Reviewed-by: Damien Le Moal <dlemoal@kernel.org>
Reviewed-by: John Garry <john.garry@linux.dev>
Reviewed-by: Hannes Reinecke <hare@suse.de>
Link: https://patch.msgid.link/9d10e1068d75c1a708b3a56e85782d651411fe06.1790359673.git.bvanassche@acm.org
Signed-off-by: Martin K. Petersen (Oracle) <mkp@kernel.org>
This commit is contained in:
Bart Van Assche 2026-09-25 11:08:59 -07:00 committed by Martin K. Petersen (Oracle)
parent 698577ef1a
commit 931a0649b9
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Documentation/scsi/scsi_mid_low_api.rst
View File

@ -865,7 +865,7 @@ Details::
*
* Other types of errors that are detected immediately may be
* flagged by setting scp->result to an appropriate value,
* invoking the scp->scsi_done callback, and then returning 0
* invoking the scsi_done() function, and then returning 0
* from this function. If the command is not performed
* immediately (and the LLD is starting (or will start) the given
* command) then this function should place 0 in scp->result and
@ -873,11 +873,11 @@ Details::
*
* Command ownership. If the driver returns zero, it owns the
* command and must take responsibility for ensuring the
* scp->scsi_done callback is executed. Note: the driver may
* call scp->scsi_done before returning zero, but after it has
* called scp->scsi_done, it may not return any value other than
* scsi_done() function is called. Note: the driver may
* call scsi_done() before returning zero, but after it has
* called scsi_done(), it may not return any value other than
* zero. If the driver makes a non-zero return, it must not
* execute the command's scsi_done callback at any time.
* call scsi_done(scp) at any time.
*
* Locks: up to and including 2.6.36, struct Scsi_Host::host_lock
* held on entry (with "irqsave") and is expected to be
@ -887,16 +887,16 @@ Details::
* Calling context: in interrupt (soft irq) or process context
*
* Notes: This function should be relatively fast. Normally it
* will not wait for IO to complete. Hence the scp->scsi_done
* callback is invoked (often directly from an interrupt service
* will not wait for IO to complete. Hence the scsi_done()
* function is invoked (often directly from an interrupt service
* routine) some time after this function has returned. In some
* cases (e.g. pseudo adapter drivers that manufacture the
* response to a SCSI INQUIRY) the scp->scsi_done callback may be
* invoked before this function returns. If the scp->scsi_done
* callback is not invoked within a certain period the SCSI mid
* response to a SCSI INQUIRY) the scsi_done() function may be
* invoked before this function returns. If the scsi_done()
* function is not invoked within a certain period the SCSI mid
* level will commence error processing. If a status of CHECK
* CONDITION is placed in "result" when the scp->scsi_done
* callback is invoked, then the LLD driver should perform
* CONDITION is placed in "result" when the scsi_done()
* function is invoked, then the LLD driver should perform
* autosense and fill in the struct scsi_cmnd::sense_buffer
* array. The scsi_cmnd::sense_buffer array is zeroed prior to
* the mid level queuing a command to an LLD.