Changeset 1102eca in mainline for uspace/lib/usbhost/src/ddf_helpers.c

Timestamp:

2018-01-08T17:17:38Z (6 years ago)

Author:

Ondřej Hlavatý <aearsis@…>

Branches:

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

Children:

bdd8842c

Parents:

eb928c4

Message:

usbhost: documentation & cleanup

File:

• uspace/lib/usbhost/src/ddf_helpers.c (modified) (7 diffs)

uspace/lib/usbhost/src/ddf_helpers.c

@@ -31 +31 @@
  */
 /** @file
- *
+ * Helpers to work with the DDF interface.
  */
 
@@ -59 +59 @@
 
 
-/* DDF INTERFACE */
-
-/** Register endpoint interface function.
- * @param fun DDF function.
- * @param endpoint_desc Endpoint description.
+/**
+ * DDF usbhc_iface callback. Passes the endpoint descriptors, fills the pipe
+ * descriptor according to the contents of the endpoint.
+ *
+ * @param[in] fun DDF function of the device in question.
+ * @param[out] pipe_desc The pipe descriptor to be filled.
+ * @param[in] endpoint_desc Endpoint descriptors from the device.
  * @return Error code.
  */
@@ -92 +94 @@
 }
 
- /** Unregister endpoint interface function.
-  * @param fun DDF function.
-  * @param endpoint_desc Endpoint description.
+ /**
+  * DDF usbhc_iface callback. Unregister endpoint that makes the other end of
+  * the pipe described.
+  *
+  * @param fun DDF function of the device in question.
+  * @param pipe_desc Pipe description.
   * @return Error code.
   */
-static int unregister_endpoint(ddf_fun_t *fun, const usb_pipe_desc_t *endpoint_desc)
+static int unregister_endpoint(ddf_fun_t *fun, const usb_pipe_desc_t *pipe_desc)
 {
         assert(fun);
@@ -106 +111 @@
         assert(dev);
 
-        endpoint_t *ep = bus_find_endpoint(dev, endpoint_desc->endpoint_no);
+        endpoint_t *ep = bus_find_endpoint(dev, pipe_desc->endpoint_no);
         if (!ep)
                 return ENOENT;
@@ -113 +118 @@
 }
 
+/**
+ * DDF usbhc_iface callback. Calls the bus operation directly.
+ *
+ * @param fun DDF function of the device (hub) requesting the address.
+ * @param speed An USB speed of the device for which the address is reserved.
+ */
 static int reserve_default_address(ddf_fun_t *fun, usb_speed_t speed)
 {
@@ -127 +138 @@
 }
 
+/**
+ * DDF usbhc_iface callback. Calls the bus operation directly.
+ *
+ * @param fun DDF function of the device (hub) releasing the address.
+ */
 static int release_default_address(ddf_fun_t *fun)
 {
@@ -142 +158 @@
 }
 
+/**
+ * DDF usbhc_iface callback. Calls the bus operation directly.
+ *
+ * @param fun DDF function of the device (hub) requesting the address.
+ */
 static int device_enumerate(ddf_fun_t *fun, unsigned port)
 {