Changeset c59dbdd5 in mainline

Timestamp:

2011-12-14T11:49:09Z (12 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

cbd568b

Parents:

30ec5ea

Message:

libusbhost: Doxygen. Return NULL on NULL link in endpoint_get_instance.

Location:

uspace/lib/usbhost/include/usb/host

Files:

• endpoint.h (modified) (1 diff)
• usb_device_manager.h (modified) (1 diff)
• usb_transfer_batch.h (modified) (2 diffs)

uspace/lib/usbhost/include/usb/host/endpoint.h

@@ -95 +95 @@
 /** list_get_instance wrapper.
  * @param item Pointer to link member.
- * @return Pointer to enpoint_t structure.
+ * @return Pointer to endpoint_t structure.
  */
 static inline endpoint_t * endpoint_get_instance(link_t *item)
 {
-        return list_get_instance(item, endpoint_t, link);
+        return item ? list_get_instance(item, endpoint_t, link) : NULL;
 }
 #endif

uspace/lib/usbhost/include/usb/host/usb_device_manager.h

@@ -59 +59 @@
                 devman_handle_t handle; /**< Devman handle of the device. */
         } devices[USB_ADDRESS_COUNT];
+        /** Maximum speed allowed. */
         usb_speed_t max_speed;
+        /** Protect access to members. */
         fibril_mutex_t guard;
         /** The last reserved address */

uspace/lib/usbhost/include/usb/host/usb_transfer_batch.h

@@ -65 +65 @@
          */
         size_t setup_size;
-        /** Actually used portion of the buffer */
-        size_t transfered_size;
-        /** Indicates success/failure of the communication */
-        int error;
         /** Host controller function, passed to callback function */
         ddf_fun_t *fun;
+
+        /** Actually used portion of the buffer
+         * This member is never accessed by functions provided in this header,
+         * with the exception of usb_transfer_batch_finish. For external use.
+         */
+        size_t transfered_size;
+        /** Indicates success/failure of the communication
+         * This member is never accessed by functions provided in this header,
+         * with the exception of usb_transfer_batch_finish. For external use.
+         */
+        int error;
 
         /** Driver specific data */
@@ -109 +116 @@
     const void* data, size_t size, int error);
 /*----------------------------------------------------------------------------*/
-/** Finish batch using stored error value.
+/** Finish batch using stored error value and transferred size.
  *
  * @param[in] instance Batch structure to use.
  * @param[in] data Data to copy to the output buffer.
- * @param[in] size Size of @p data.
  */
 static inline void usb_transfer_batch_finish(