Commit 11bf1d14 authored by Bart Van Assche's avatar Bart Van Assche Committed by Martin K. Petersen

scsi: target: core: Document target_cmd_size_check()

Since it is nontrivial to derive the meaning of the size argument from the
code, add a documentation header above target_cmd_size_check().

Cc: Mike Christie <mchristi@redhat.com>
Cc: Christoph Hellwig <hch@lst.de>
Cc: Hannes Reinecke <hare@suse.de>
Cc: Nicholas Bellinger <nab@linux-iscsi.org>
Link: https://lore.kernel.org/r/20191107215458.64242-1-bvanassche@acm.orgSigned-off-by: default avatarBart Van Assche <bvanassche@acm.org>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent 29d28f2b
...@@ -1243,6 +1243,19 @@ target_check_max_data_sg_nents(struct se_cmd *cmd, struct se_device *dev, ...@@ -1243,6 +1243,19 @@ target_check_max_data_sg_nents(struct se_cmd *cmd, struct se_device *dev,
return TCM_NO_SENSE; return TCM_NO_SENSE;
} }
/**
* target_cmd_size_check - Check whether there will be a residual.
* @cmd: SCSI command.
* @size: Data buffer size derived from CDB. The data buffer size provided by
* the SCSI transport driver is available in @cmd->data_length.
*
* Compare the data buffer size from the CDB with the data buffer limit from the transport
* header. Set @cmd->residual_count and SCF_OVERFLOW_BIT or SCF_UNDERFLOW_BIT if necessary.
*
* Note: target drivers set @cmd->data_length by calling transport_init_se_cmd().
*
* Return: TCM_NO_SENSE
*/
sense_reason_t sense_reason_t
target_cmd_size_check(struct se_cmd *cmd, unsigned int size) target_cmd_size_check(struct se_cmd *cmd, unsigned int size)
{ {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment