| 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 | /** @addtogroup drv usbuhcihc
|
|---|
| 29 | * @{
|
|---|
| 30 | */
|
|---|
| 31 | /** @file
|
|---|
| 32 | * @brief UHCI driver
|
|---|
| 33 | */
|
|---|
| 34 | #ifndef DRV_UHCI_QH_H
|
|---|
| 35 | #define DRV_UHCI_QH_H
|
|---|
| 36 |
|
|---|
| 37 | /* libc */
|
|---|
| 38 | #include <assert.h>
|
|---|
| 39 |
|
|---|
| 40 | #include "link_pointer.h"
|
|---|
| 41 | #include "utils/malloc32.h"
|
|---|
| 42 |
|
|---|
| 43 | typedef struct queue_head {
|
|---|
| 44 | volatile link_pointer_t next;
|
|---|
| 45 | volatile link_pointer_t element;
|
|---|
| 46 | } __attribute__((packed)) qh_t;
|
|---|
| 47 | /*----------------------------------------------------------------------------*/
|
|---|
| 48 | /** Initialize queue head structure
|
|---|
| 49 | *
|
|---|
| 50 | * @param[in] instance qh_t structure to initialize.
|
|---|
| 51 | *
|
|---|
| 52 | * Sets both pointer to terminal NULL.
|
|---|
| 53 | */
|
|---|
| 54 | static inline void qh_init(qh_t *instance)
|
|---|
| 55 | {
|
|---|
| 56 | assert(instance);
|
|---|
| 57 |
|
|---|
| 58 | instance->element = 0 | LINK_POINTER_TERMINATE_FLAG;
|
|---|
| 59 | instance->next = 0 | LINK_POINTER_TERMINATE_FLAG;
|
|---|
| 60 | }
|
|---|
| 61 | /*----------------------------------------------------------------------------*/
|
|---|
| 62 | /** Set queue head next pointer
|
|---|
| 63 | *
|
|---|
| 64 | * @param[in] instance qh_t structure to use.
|
|---|
| 65 | * @param[in] pa Physical address of the next queue head.
|
|---|
| 66 | *
|
|---|
| 67 | * Adds proper flag. If the pointer is NULL or terminal, sets next to terminal
|
|---|
| 68 | * NULL.
|
|---|
| 69 | */
|
|---|
| 70 | static inline void qh_set_next_qh(qh_t *instance, uint32_t pa)
|
|---|
| 71 | {
|
|---|
| 72 | /* Address is valid and not terminal */
|
|---|
| 73 | if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) {
|
|---|
| 74 | instance->next = (pa & LINK_POINTER_ADDRESS_MASK)
|
|---|
| 75 | | LINK_POINTER_QUEUE_HEAD_FLAG;
|
|---|
| 76 | } else {
|
|---|
| 77 | instance->next = 0 | LINK_POINTER_TERMINATE_FLAG;
|
|---|
| 78 | }
|
|---|
| 79 | }
|
|---|
| 80 | /*----------------------------------------------------------------------------*/
|
|---|
| 81 | /** Set queue head element pointer
|
|---|
| 82 | *
|
|---|
| 83 | * @param[in] instance qh_t structure to initialize.
|
|---|
| 84 | * @param[in] pa Physical address of the next queue head.
|
|---|
| 85 | *
|
|---|
| 86 | * Adds proper flag. If the pointer is NULL or terminal, sets element
|
|---|
| 87 | * to terminal NULL.
|
|---|
| 88 | */
|
|---|
| 89 | static inline void qh_set_element_qh(qh_t *instance, uint32_t pa)
|
|---|
| 90 | {
|
|---|
| 91 | /* Address is valid and not terminal */
|
|---|
| 92 | if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) {
|
|---|
| 93 | instance->element = (pa & LINK_POINTER_ADDRESS_MASK)
|
|---|
| 94 | | LINK_POINTER_QUEUE_HEAD_FLAG;
|
|---|
| 95 | } else {
|
|---|
| 96 | instance->element = 0 | LINK_POINTER_TERMINATE_FLAG;
|
|---|
| 97 | }
|
|---|
| 98 | }
|
|---|
| 99 | /*----------------------------------------------------------------------------*/
|
|---|
| 100 | /** Set queue head element pointer
|
|---|
| 101 | *
|
|---|
| 102 | * @param[in] instance qh_t structure to initialize.
|
|---|
| 103 | * @param[in] pa Physical address of the TD structure.
|
|---|
| 104 | *
|
|---|
| 105 | * Adds proper flag. If the pointer is NULL or terminal, sets element
|
|---|
| 106 | * to terminal NULL.
|
|---|
| 107 | */
|
|---|
| 108 | static inline void qh_set_element_td(qh_t *instance, uint32_t pa)
|
|---|
| 109 | {
|
|---|
| 110 | if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) {
|
|---|
| 111 | instance->element = (pa & LINK_POINTER_ADDRESS_MASK);
|
|---|
| 112 | } else {
|
|---|
| 113 | instance->element = 0 | LINK_POINTER_TERMINATE_FLAG;
|
|---|
| 114 | }
|
|---|
| 115 | }
|
|---|
| 116 |
|
|---|
| 117 | #endif
|
|---|
| 118 | /**
|
|---|
| 119 | * @}
|
|---|
| 120 | */
|
|---|
