Changeset 5400606 in mainline for uspace/lib/usbhost/include/usb/host/usb_endpoint_manager.h

Timestamp:

2011-10-29T13:35:40Z (13 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

4dfc905

Parents:

2fd1f0c6

Message:

libusbhost: Fixes and improvements for usb_endpoint_manager.

Add doxygen comments.
Add asserts and input checks.
Fix bandwidth count (bits vs. bytes).
Refactor usb_endpoint_manager_add_ep to avoid crash/leak in error path.

File:

• uspace/lib/usbhost/include/usb/host/usb_endpoint_manager.h (modified) (2 diffs)

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

@@ -46 +46 @@
 #include <usb/host/endpoint.h>
 
-#define BANDWIDTH_TOTAL_USB11 12000000
+/** Bytes per second in FULL SPEED */
+#define BANDWIDTH_TOTAL_USB11 (12000000 / 8)
+/** 90% of total bandwidth is available for periodic transfers */
 #define BANDWIDTH_AVAILABLE_USB11 ((BANDWIDTH_TOTAL_USB11 / 10) * 9)
+/** 16 addresses per list */
 #define ENDPOINT_LIST_COUNT 8
 
+/** Endpoint management structure */
 typedef struct usb_endpoint_manager {
+        /** Store endpoint_t instances */
         list_t endpoint_lists[ENDPOINT_LIST_COUNT];
+        /** Prevents races accessing lists */
         fibril_mutex_t guard;
+        /** Size of the bandwidth pool */
         size_t free_bw;
+        /** Use this function to count bw required by EP */
         size_t (*bw_count)(usb_speed_t, usb_transfer_type_t, size_t, size_t);
 } usb_endpoint_manager_t;
@@ -64 +72 @@
     size_t (*bw_count)(usb_speed_t, usb_transfer_type_t, size_t, size_t));
 
-void usb_endpoint_manager_reset_eps_if_need(
-    usb_endpoint_manager_t *instance, usb_target_t target, const uint8_t *data);
+void usb_endpoint_manager_reset_eps_if_need(usb_endpoint_manager_t *instance,
+    usb_target_t target, const uint8_t data[8]);
 
 int usb_endpoint_manager_register_ep(