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

Timestamp:

2018-01-08T17:17:38Z (7 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/usb_transfer_batch.c (modified) (6 diffs)

uspace/lib/usbhost/src/usb_transfer_batch.c

@@ -44 +44 @@
 #include "usb_transfer_batch.h"
 
-/** Create a batch on given endpoint.
+/**
+ * Create a batch on a given endpoint.
+ *
+ * If the bus callback is not defined, it just creates a default batch.
  */
 usb_transfer_batch_t *usb_transfer_batch_create(endpoint_t *ep)
@@ -55 +58 @@
         if (!ops) {
                 usb_transfer_batch_t *batch = calloc(1, sizeof(usb_transfer_batch_t));
+                if (!batch)
+                        return NULL;
                 usb_transfer_batch_init(batch, ep);
                 return batch;
@@ -62 +67 @@
 }
 
-/** Initialize given batch structure.
+/**
+ * Initialize given batch structure.
  */
 void usb_transfer_batch_init(usb_transfer_batch_t *batch, endpoint_t *ep)
 {
         assert(ep);
+        /* Batch reference */
         endpoint_add_ref(ep);
         batch->ep = ep;
 }
 
-/** Destroy the batch.
- *
- * @param[in] batch Batch structure to use.
+/**
+ * Destroy the batch. If there's no bus callback, just free it.
  */
 void usb_transfer_batch_destroy(usb_transfer_batch_t *batch)
@@ -83 +89 @@
         const bus_ops_t *ops = BUS_OPS_LOOKUP(bus->ops, batch_destroy);
 
+        /* Batch reference */
         endpoint_del_ref(batch->ep);
 
@@ -97 +104 @@
 }
 
-/** Finish a transfer batch: call handler, destroy batch, release endpoint.
+/**
+ * Finish a transfer batch: call handler, destroy batch, release endpoint.
  *
  * Call only after the batch have been scheduled && completed!
- *
- * @param[in] batch Batch structure to use.
  */
 void usb_transfer_batch_finish(usb_transfer_batch_t *batch)
@@ -121 +127 @@
 }
 
-/** Finish a transfer batch as an aborted one.
- *
- * @param[in] batch Batch structure to use.
+/**
+ * Finish a transfer batch as an aborted one.
  */
 void usb_transfer_batch_abort(usb_transfer_batch_t *batch)