Commit 749a1122 authored by Randy Dunlap's avatar Randy Dunlap Committed by Martin K. Petersen

scsi: core: doc. fixes to scsi_common.c

Clean up some comment typos and fix some errors in documentation.
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: Nicholas Bellinger <nab@linux-iscsi.org>
Cc: Sagi Grimberg <sagig@mellanox.com>
Cc: Bart Van Assche <bart.vanassche@wdc.com>
Reviewed-by: default avatarBart Van Assche <bart.vanassche@wdc.com>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent 3c62ecda
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
/* NB: These are exposed through /proc/scsi/scsi and form part of the ABI. /* NB: These are exposed through /proc/scsi/scsi and form part of the ABI.
* You may not alter any existing entry (although adding new ones is * You may not alter any existing entry (although adding new ones is
* encouraged once assigned by ANSI/INCITS T10 * encouraged once assigned by ANSI/INCITS T10).
*/ */
static const char *const scsi_device_types[] = { static const char *const scsi_device_types[] = {
"Direct-Access ", "Direct-Access ",
...@@ -39,7 +39,7 @@ static const char *const scsi_device_types[] = { ...@@ -39,7 +39,7 @@ static const char *const scsi_device_types[] = {
}; };
/** /**
* scsi_device_type - Return 17 char string indicating device type. * scsi_device_type - Return 17-char string indicating device type.
* @type: type number to look up * @type: type number to look up
*/ */
const char *scsi_device_type(unsigned type) const char *scsi_device_type(unsigned type)
...@@ -59,7 +59,7 @@ EXPORT_SYMBOL(scsi_device_type); ...@@ -59,7 +59,7 @@ EXPORT_SYMBOL(scsi_device_type);
* @scsilun: struct scsi_lun to be converted. * @scsilun: struct scsi_lun to be converted.
* *
* Description: * Description:
* Convert @scsilun from a struct scsi_lun to a four byte host byte-ordered * Convert @scsilun from a struct scsi_lun to a four-byte host byte-ordered
* integer, and return the result. The caller must check for * integer, and return the result. The caller must check for
* truncation before using this function. * truncation before using this function.
* *
...@@ -98,7 +98,7 @@ EXPORT_SYMBOL(scsilun_to_int); ...@@ -98,7 +98,7 @@ EXPORT_SYMBOL(scsilun_to_int);
* back into the lun value. * back into the lun value.
* *
* Notes: * Notes:
* Given an integer : 0x0b03d204, this function returns a * Given an integer : 0x0b03d204, this function returns a
* struct scsi_lun of: d2 04 0b 03 00 00 00 00 * struct scsi_lun of: d2 04 0b 03 00 00 00 00
* *
*/ */
...@@ -221,7 +221,7 @@ EXPORT_SYMBOL(scsi_sense_desc_find); ...@@ -221,7 +221,7 @@ EXPORT_SYMBOL(scsi_sense_desc_find);
/** /**
* scsi_build_sense_buffer - build sense data in a buffer * scsi_build_sense_buffer - build sense data in a buffer
* @desc: Sense format (non zero == descriptor format, * @desc: Sense format (non-zero == descriptor format,
* 0 == fixed format) * 0 == fixed format)
* @buf: Where to build sense data * @buf: Where to build sense data
* @key: Sense key * @key: Sense key
...@@ -255,7 +255,7 @@ EXPORT_SYMBOL(scsi_build_sense_buffer); ...@@ -255,7 +255,7 @@ EXPORT_SYMBOL(scsi_build_sense_buffer);
* @info: 64-bit information value to be set * @info: 64-bit information value to be set
* *
* Return value: * Return value:
* 0 on success or EINVAL for invalid sense buffer length * 0 on success or -EINVAL for invalid sense buffer length
**/ **/
int scsi_set_sense_information(u8 *buf, int buf_len, u64 info) int scsi_set_sense_information(u8 *buf, int buf_len, u64 info)
{ {
...@@ -305,7 +305,7 @@ EXPORT_SYMBOL(scsi_set_sense_information); ...@@ -305,7 +305,7 @@ EXPORT_SYMBOL(scsi_set_sense_information);
* @cd: command/data bit * @cd: command/data bit
* *
* Return value: * Return value:
* 0 on success or EINVAL for invalid sense buffer length * 0 on success or -EINVAL for invalid sense buffer length
*/ */
int scsi_set_sense_field_pointer(u8 *buf, int buf_len, u16 fp, u8 bp, bool cd) int scsi_set_sense_field_pointer(u8 *buf, int buf_len, u16 fp, u8 bp, bool cd)
{ {
......
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