scsi: target: core: Document target_cmd_size_check() (11bf1d14) · Commits · 戴 / test

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.org Signed-off-by:

Bart Van Assche <bvanassche@acm.org> Signed-off-by:

Martin K. Petersen <martin.petersen@oracle.com>

drivers/target/target_core_transport.c

+13 −0

Original line number	Original line	Diff line number	Diff line
	@@ -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)
	{		{

Admin message