Changeset 02cacce in mainline for uspace/drv/ohci/hcd_endpoint.h

Timestamp:

2011-05-18T18:24:22Z (13 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

030937e

Parents:

45e0e07

Message:

Doxygen and some minor code-style changes

File:

• uspace/drv/ohci/hcd_endpoint.h (modified) (1 diff)

uspace/drv/ohci/hcd_endpoint.h

@@ -42 +42 @@
 #include "hw_struct/transfer_descriptor.h"
 
-typedef struct hcd_endpoint
-{
+/** Connector structure linking ED to to prepared TD. */
+typedef struct hcd_endpoint {
+        /** OHCI endpoint descriptor */
         ed_t *ed;
+        /** Currently enqueued transfer descriptor */
         td_t *td;
+        /** Linked list used by driver software */
         link_t link;
 } hcd_endpoint_t;
 
 hcd_endpoint_t * hcd_endpoint_assign(endpoint_t *ep);
+void hcd_endpoint_clear(endpoint_t *ep);
 
-hcd_endpoint_t * hcd_endpoint_get(endpoint_t *ep);
+/** Get and convert assigned hcd_endpoint_t structure
+ * @param[in] ep USBD endpoint structure.
+ * @return Pointer to assigned hcd endpoint structure
+ */
+static inline hcd_endpoint_t * hcd_endpoint_get(endpoint_t *ep)
+{
+        assert(ep);
+        return ep->hc_data.data;
+}
 
-void hcd_endpoint_clear(endpoint_t *ep);
 #endif
 /**