Changes in uspace/lib/usbhost/src/usb_endpoint_manager.c [46f2808:cbd568b] in mainline

File:

• uspace/lib/usbhost/src/usb_endpoint_manager.c (modified) (8 diffs)

uspace/lib/usbhost/src/usb_endpoint_manager.c

@@ -26 +26 @@
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
+/**  @addtogroup libusbhost
+ * @{
+ */
+/** @file
+ * HC Endpoint management.
+ */
 
 #include <bool.h>
@@ -56 +62 @@
 }
 /*----------------------------------------------------------------------------*/
-/** Get list that holds endpints for given address.
+/** Get list that holds endpoints for given address.
  * @param instance usb_endpoint_manager structure, non-null.
  * @param addr USB address, must be >= 0.
@@ -75 +81 @@
  * @return Pointer to endpoint_t structure representing given communication
  * target, NULL if there is no such endpoint registered.
+ * @note Assumes that the internal mutex is locked.
  */
 static endpoint_t * find_locked(usb_endpoint_manager_t *instance,
@@ -169 +176 @@
  *
  * Really ugly one. Resets toggle bit on all endpoints that need it.
+ * @TODO Use tools from libusbdev requests.h
  */
 void usb_endpoint_manager_reset_eps_if_need(usb_endpoint_manager_t *instance,
@@ -184 +192 @@
         case 0x01: /* Clear Feature -- resets only cleared ep */
                 /* Recipient is endpoint, value is zero (ENDPOINT_STALL) */
+                // TODO Use macros in libusbdev requests.h
                 if (((data[0] & 0xf) == 1) && ((data[2] | data[3]) == 0)) {
                         fibril_mutex_lock(&instance->guard);
@@ -202 +211 @@
                 /* Recipient must be device, this resets all endpoints,
                  * In fact there should be no endpoints but EP 0 registered
-                 * as different interfaces use different endpoints. */
+                 * as different interfaces use different endpoints,
+                 * unless you're changing configuration or alternative
+                 * interface of an already setup device. */
                 if ((data[0] & 0xf) == 0) {
                         fibril_mutex_lock(&instance->guard);
@@ -385 +396 @@
 }
 /*----------------------------------------------------------------------------*/
+/** Unregister and destroy all endpoints using given address.
+ * @param instance usb_endpoint_manager structure, non-null.
+ * @param address USB address.
+ * @param endpoint USB endpoint number.
+ * @param direction Communication direction.
+ * @param callback Function to call after unregister, before destruction.
+ * @arg Argument to pass to the callback function.
+ * @return Error code.
+ */
 void usb_endpoint_manager_remove_address(usb_endpoint_manager_t *instance,
     usb_address_t address, void (*callback)(endpoint_t *, void *), void *arg)
@@ -403 +423 @@
         fibril_mutex_unlock(&instance->guard);
 }
+/**
+ * @}
+ */