Changeset c83a55c in mainline for uspace/lib/usbhost/include/usb/host/endpoint.h

Timestamp:

2011-10-31T06:52:54Z (13 years ago)

Author:

Frantisek Princ <frantisek.princ@…>

Branches:

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

Children:

c25e39b

Parents:

e8ab32f (diff), 3ce78580 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge with mainline

File:

• uspace/lib/usbhost/include/usb/host/endpoint.h (modified) (1 diff)

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

@@ -36 +36 @@
 #define LIBUSBHOST_HOST_ENDPOINT_H
 
-#include <assert.h>
 #include <bool.h>
 #include <adt/list.h>
 #include <fibril_synch.h>
-
 #include <usb/usb.h>
 
+/** Host controller side endpoint structure. */
 typedef struct endpoint {
+        /** Part of linked list. */
+        link_t link;
+        /** USB address. */
         usb_address_t address;
+        /** USB endpoint number. */
         usb_endpoint_t endpoint;
+        /** Communication direction. */
         usb_direction_t direction;
+        /** USB transfer type. */
         usb_transfer_type_t transfer_type;
+        /** Communication speed. */
         usb_speed_t speed;
+        /** Maximum size of data packets. */
         size_t max_packet_size;
+        /** Necessary bandwidth. */
+        size_t bandwidth;
+        /** Value of the toggle bit. */
         unsigned toggle:1;
+        /** True if there is a batch using this scheduled for this endpoint. */
+        volatile bool active;
+        /** Protects resources and active status changes. */
         fibril_mutex_t guard;
+        /** Signals change of active status. */
         fibril_condvar_t avail;
-        volatile bool active;
-        void (*destroy_hook)(struct endpoint *);
+        /** Optional device specific data. */
         struct {
+                /** Device specific data. */
                 void *data;
+                /** Callback to get the value of toggle bit. */
                 int (*toggle_get)(void *);
+                /** Callback to set the value of toggle bit. */
                 void (*toggle_set)(void *, int);
         } hc_data;
 } endpoint_t;
 
-endpoint_t * endpoint_get(usb_address_t address, usb_endpoint_t endpoint,
+endpoint_t * endpoint_create(usb_address_t address, usb_endpoint_t endpoint,
     usb_direction_t direction, usb_transfer_type_t type, usb_speed_t speed,
-    size_t max_packet_size);
-
+    size_t max_packet_size, size_t bw);
 void endpoint_destroy(endpoint_t *instance);
 
 void endpoint_set_hc_data(endpoint_t *instance,
-    void *data, void (*destroy_hook)(endpoint_t *),
-    int (*toggle_get)(void *), void (*toggle_set)(void *, int));
-
+    void *data, int (*toggle_get)(void *), void (*toggle_set)(void *, int));
 void endpoint_clear_hc_data(endpoint_t *instance);
 
 void endpoint_use(endpoint_t *instance);
-
 void endpoint_release(endpoint_t *instance);
 
 int endpoint_toggle_get(endpoint_t *instance);
-
 void endpoint_toggle_set(endpoint_t *instance, int toggle);
 
-void endpoint_toggle_reset_filtered(endpoint_t *instance, usb_target_t target);
+/** list_get_instance wrapper.
+ * @param item Pointer to link member.
+ * @return Pointer to enpoint_t structure.
+ */
+static inline endpoint_t * endpoint_get_instance(link_t *item)
+{
+        return list_get_instance(item, endpoint_t, link);
+}
 #endif
 /**