Changeset 4f66cc7b in mainline for uspace/drv/uhci-hcd/uhci_struct/queue_head.h

Timestamp:

2011-03-17T12:45:23Z (14 years ago)

Author:

Lubos Slovak <lubos.slovak@…>

Branches:

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

Children:

4fec9ee, 6e3b9a58

Parents:

45dd8bf (diff), 039c66c (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merged development changes

File:

• uspace/drv/uhci-hcd/uhci_struct/queue_head.h (modified) (3 diffs)

uspace/drv/uhci-hcd/uhci_struct/queue_head.h

@@ -1 @@
-
 /*
  * Copyright (c) 2010 Jan Vesely
@@ -27 +26 @@
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-/** @addtogroup usb
+/** @addtogroup drv usbuhcihc
  * @{
  */
@@ -43 +42 @@
 
 typedef struct queue_head {
-        volatile link_pointer_t next_queue;
+        volatile link_pointer_t next;
         volatile link_pointer_t element;
-} __attribute__((packed)) queue_head_t;
-
-static inline void queue_head_init(queue_head_t *instance)
+} __attribute__((packed)) qh_t;
+/*----------------------------------------------------------------------------*/
+/** Initialize queue head structure
+ *
+ * @param[in] instance qh_t structure to initialize.
+ *
+ * Sets both pointer to terminal NULL.
+ */
+static inline void qh_init(qh_t *instance)
 {
         assert(instance);
 
         instance->element = 0 | LINK_POINTER_TERMINATE_FLAG;
-        instance->next_queue = 0 | LINK_POINTER_TERMINATE_FLAG;
+        instance->next = 0 | LINK_POINTER_TERMINATE_FLAG;
 }
-
-static inline void queue_head_append_qh(queue_head_t *instance, uint32_t pa)
+/*----------------------------------------------------------------------------*/
+/** Set queue head next pointer
+ *
+ * @param[in] instance qh_t structure to use.
+ * @param[in] pa Physical address of the next queue head.
+ *
+ * Adds proper flag. If the pointer is NULL or terminal, sets next to terminal
+ * NULL.
+ */
+static inline void qh_set_next_qh(qh_t *instance, uint32_t pa)
 {
-        if (pa) {
-                instance->next_queue = (pa & LINK_POINTER_ADDRESS_MASK)
+        /* Address is valid and not terminal */
+        if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) {
+                instance->next = (pa & LINK_POINTER_ADDRESS_MASK)
                     | LINK_POINTER_QUEUE_HEAD_FLAG;
+        } else {
+                instance->next = 0 | LINK_POINTER_TERMINATE_FLAG;
         }
 }
-
-static inline void queue_head_element_qh(queue_head_t *instance, uint32_t pa)
+/*----------------------------------------------------------------------------*/
+/** Set queue head element pointer
+ *
+ * @param[in] instance qh_t structure to initialize.
+ * @param[in] pa Physical address of the next queue head.
+ *
+ * Adds proper flag. If the pointer is NULL or terminal, sets element
+ * to terminal NULL.
+ */
+static inline void qh_set_element_qh(qh_t *instance, uint32_t pa)
 {
-        if (pa) {
-                instance->next_queue = (pa & LINK_POINTER_ADDRESS_MASK)
+        /* Address is valid and not terminal */
+        if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) {
+                instance->element = (pa & LINK_POINTER_ADDRESS_MASK)
                     | LINK_POINTER_QUEUE_HEAD_FLAG;
+        } else {
+                instance->element = 0 | LINK_POINTER_TERMINATE_FLAG;
         }
 }
-
-static inline void queue_head_set_element_td(queue_head_t *instance, uint32_t pa)
+/*----------------------------------------------------------------------------*/
+/** Set queue head element pointer
+ *
+ * @param[in] instance qh_t structure to initialize.
+ * @param[in] pa Physical address of the TD structure.
+ *
+ * Adds proper flag. If the pointer is NULL or terminal, sets element
+ * to terminal NULL.
+ */
+static inline void qh_set_element_td(qh_t *instance, uint32_t pa)
 {
-        if (pa) {
+        if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) {
                 instance->element = (pa & LINK_POINTER_ADDRESS_MASK);
+        } else {
+                instance->element = 0 | LINK_POINTER_TERMINATE_FLAG;
         }
 }