source: mainline/uspace/drv/bus/usb/uhci/hw_struct/queue_head.h

Last change on this file was c8ea6eca, checked in by Jakub Jermar <jakub@…>, 7 years ago

Improve doxygen documentation

  • Property mode set to 100644
File size: 3.4 KB
Line 
1/*
2 * Copyright (c) 2010 Jan Vesely
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup drvusbuhci
30 * @{
31 */
32/** @file
33 * @brief UHCI driver
34 */
35
36#ifndef DRV_UHCI_HW_STRUCT_QH_H
37#define DRV_UHCI_HW_STRUCT_QH_H
38
39#include <assert.h>
40#include <stdint.h>
41#include <usb/host/utils/malloc32.h>
42
43#include "link_pointer.h"
44#include "transfer_descriptor.h"
45
46/** This structure is defined in UHCI design guide p. 31 */
47typedef struct queue_head {
48 /** Pointer to the next entity (another QH or TD */
49 volatile link_pointer_t next;
50 /**
51 * Pointer to the contained entities
52 * (execution controlled by vertical flag)
53 */
54 volatile link_pointer_t element;
55} __attribute__((packed, aligned(16))) qh_t;
56
57/** Initialize queue head structure
58 *
59 * @param[in] instance qh_t structure to initialize.
60 *
61 * Sets both pointer to terminal NULL.
62 */
63static inline void qh_init(qh_t *instance)
64{
65 assert(instance);
66
67 instance->element = LINK_POINTER_TERM;
68 instance->next = LINK_POINTER_TERM;
69}
70
71/** Set queue head next pointer
72 *
73 * @param[in] instance qh_t structure to use.
74 * @param[in] next Address of the next queue.
75 *
76 * Adds proper flag. If the pointer is NULL, sets next to terminal NULL.
77 */
78static inline void qh_set_next_qh(qh_t *instance, qh_t *next)
79{
80 /*
81 * Physical address has to be below 4GB,
82 * it is an UHCI limitation and malloc32
83 * should guarantee this
84 */
85 const uint32_t pa = addr_to_phys(next);
86 if (pa) {
87 instance->next = LINK_POINTER_QH(pa);
88 } else {
89 instance->next = LINK_POINTER_TERM;
90 }
91}
92
93/** Set queue head element pointer
94 *
95 * @param[in] instance qh_t structure to use.
96 * @param[in] td Transfer descriptor to set as the first element.
97 *
98 * Adds proper flag. If the pointer is NULL, sets element to terminal NULL.
99 */
100static inline void qh_set_element_td(qh_t *instance, td_t *td)
101{
102 /*
103 * Physical address has to be below 4GB,
104 * it is an UHCI limitation and malloc32
105 * should guarantee this
106 */
107 const uint32_t pa = addr_to_phys(td);
108 if (pa) {
109 instance->element = LINK_POINTER_TD(pa);
110 } else {
111 instance->element = LINK_POINTER_TERM;
112 }
113}
114
115#endif
116
117/**
118 * @}
119 */
Note: See TracBrowser for help on using the repository browser.