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

Timestamp:

2011-05-11T19:31:16Z (14 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/mast.c (modified) (3 diffs)

uspace/drv/usbmast/mast.c

@@ -139 +139 @@
 }
 
+/** Perform bulk-only mass storage reset.
+ *
+ * @param dev Device to be reseted.
+ * @return Error code.
+ */
 int usb_massstor_reset(usb_device_t *dev)
 {
@@ -146 +151 @@
 }
 
+/** Perform complete reset recovery of bulk-only mass storage.
+ *
+ * Notice that no error is reported because if this fails, the error
+ * would reappear on next transaction somehow.
+ *
+ * @param dev Device to be reseted.
+ * @param bulk_in_idx Index of bulk in pipe.
+ * @param bulk_out_idx Index of bulk out pipe.
+ */
 void usb_massstor_reset_recovery(usb_device_t *dev,
     size_t bulk_in_idx, size_t bulk_out_idx)
@@ -157 +171 @@
 }
 
+/** Get max LUN of a mass storage device.
+ *
+ * @warning Error from this command does not necessarily indicate malfunction
+ * of the device. Device does not need to support this request.
+ *
+ * @param dev Mass storage device.
+ * @return Error code of maximum LUN (index, not count).
+ */
 int usb_massstor_get_max_lun(usb_device_t *dev)
 {