Changeset cf002dbf in mainline for uspace/drv/usbmast/inquiry.c

Timestamp:

2011-05-11T19:31:16Z (13 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

5f0fe4e9

Parents:

70c12d6

Message:

Add comments to mass storage driver

File:

• uspace/drv/usbmast/inquiry.c (modified) (4 diffs)

uspace/drv/usbmast/inquiry.c

@@ -55 +55 @@
 
 #define STR_UNKNOWN "<unknown>"
+
+/** String constants for SCSI peripheral device types. */
 static const char *str_peripheral_device_types[] = {
         "direct-access device",
@@ -92 +94 @@
         (sizeof(str_peripheral_device_types)/sizeof(str_peripheral_device_types[0]))
 
+/** Get string representation for SCSI peripheral device type.
+ *
+ * See for example here for a list
+ * http://en.wikipedia.org/wiki/SCSI_Peripheral_Device_Type.
+ *
+ * @param type SCSI peripheral device type code.
+ * @return String representation.
+ */
 const char *usb_str_masstor_scsi_peripheral_device_type(int type)
 {
@@ -101 +111 @@
 }
 
+/** Trim trailing spaces from a string (rewrite with string terminator).
+ *
+ * @param name String to be trimmed (in-out parameter).
+ */
 static void trim_trailing_spaces(char *name)
 {
@@ -110 +124 @@
 }
 
+/** Perform SCSI INQUIRY command on USB mass storage device.
+ *
+ * @param dev USB device.
+ * @param bulk_in_idx Index (in dev->pipes) of bulk in pipe.
+ * @param bulk_out_idx Index of bulk out pipe.
+ * @param inquiry_result Where to store parsed inquiry result.
+ * @return Error code.
+ */
 int usb_massstor_inquiry(usb_device_t *dev,
     size_t bulk_in_idx, size_t bulk_out_idx,