Changeset 2ef036a in mainline for uspace/drv/uhci-hcd/uhci_struct/queue_head.h

Timestamp:

2011-03-14T22:51:09Z (14 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

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

Children:

2180979

Parents:

7ffe82f (diff), fcf07e6 (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:

Merge development/ changes

File:

• uspace/drv/uhci-hcd/uhci_struct/queue_head.h (modified) (6 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
  * @{
  */
@@ -47 +46 @@
 } __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)
 {
@@ -55 +60 @@
 }
 /*----------------------------------------------------------------------------*/
+/** 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)
 {
-        /* address is valid and not terminal */
+        /* Address is valid and not terminal */
         if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) {
                 instance->next = (pa & LINK_POINTER_ADDRESS_MASK)
@@ -66 +79 @@
 }
 /*----------------------------------------------------------------------------*/
+/** 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)
 {
-        /* address is valid and not terminal */
+        /* Address is valid and not terminal */
         if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) {
                 instance->element = (pa & LINK_POINTER_ADDRESS_MASK)
@@ -77 +98 @@
 }
 /*----------------------------------------------------------------------------*/
+/** 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)
 {