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

Timestamp:

2011-10-29T20:17:51Z (14 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

c44a5f1

Parents:

549ff23

Message:

libusbhost: endpoint_t: extend mutex protection, add doxygen comments.

File:

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

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

@@ -41 +41 @@
 #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;
+        /** 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;
@@ -76 +93 @@
 void endpoint_toggle_set(endpoint_t *instance, int toggle);
 
+/** 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)
 {