Changeset eb928c4 in mainline for uspace/drv/bus/usb/xhci/trb_ring.c

Timestamp:

2018-01-08T00:07:00Z (6 years ago)

Author:

Ondřej Hlavatý <aearsis@…>

Branches:

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

Children:

1102eca

Parents:

ecbad17

git-author:

Ondřej Hlavatý <aearsis@…> (2018-01-08 00:05:39)

git-committer:

Ondřej Hlavatý <aearsis@…> (2018-01-08 00:07:00)

Message:

xhci: documentation & cleanup

Also, a simple refactoring to remove functions that only wraps another
functions unused anywhere else.

File:

• uspace/drv/bus/usb/xhci/trb_ring.c (modified) (10 diffs)

uspace/drv/bus/usb/xhci/trb_ring.c

@@ -52 +52 @@
 
 
+/**
+ * Get the first TRB of a segment.
+ */
 static inline xhci_trb_t *segment_begin(trb_segment_t *segment)
 {
@@ -57 +60 @@
 }
 
+/**
+ * Get the one-past-end TRB of a segment.
+ */
 static inline xhci_trb_t *segment_end(trb_segment_t *segment)
 {
@@ -91 +97 @@
 /**
  * Initializes the ring with one segment.
- * Event when it fails, the structure needs to be finalized.
  */
 int xhci_trb_ring_init(xhci_trb_ring_t *ring)
@@ -117 +122 @@
         fibril_mutex_initialize(&ring->guard);
 
-        usb_log_debug2("Initialized new TRB ring.");
-
-        return EOK;
-}
-
+        return EOK;
+}
+
+/**
+ * Free all segments inside the ring.
+ */
 void xhci_trb_ring_fini(xhci_trb_ring_t *ring)
 {
@@ -150 +156 @@
 }
 
+/**
+ * Get the physical address of the enqueue pointer.
+ */
 static uintptr_t trb_ring_enqueue_phys(xhci_trb_ring_t *ring)
 {
@@ -156 +165 @@
 }
 
+/**
+ * Decides whether the TRB will trigger an interrupt after being processed.
+ */
 static bool trb_generates_interrupt(xhci_trb_t *trb)
 {
@@ -163 +175 @@
 
 /**
- * Enqueue TDs composed of TRBs.
+ * Enqueue TD composed of TRBs.
  *
  * This will copy specified number of TRBs chained together into the ring. The
@@ -256 +268 @@
 /**
  * Initializes an event ring.
- * Even when it fails, the structure needs to be finalized.
  */
 int xhci_event_ring_init(xhci_event_ring_t *ring)
@@ -275 +286 @@
         ring->dequeue_ptr = segment->phys;
 
-        if (dma_buffer_alloc(&ring->erst, PAGE_SIZE))
+        if (dma_buffer_alloc(&ring->erst, PAGE_SIZE)) {
+                xhci_event_ring_fini(ring);
                 return ENOMEM;
+        }
         xhci_erst_entry_t *erst = ring->erst.virt;
 
@@ -301 +314 @@
 }
 
+/**
+ * Get the physical address of the dequeue pointer.
+ */
 static uintptr_t event_ring_dequeue_phys(xhci_event_ring_t *ring)
 {