source: mainline/uspace/drv/uhci-hcd/transfer_list.c@ e247d83

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since e247d83 was e247d83, checked in by Jan Vesely <jano.vesely@…>, 14 years ago

Const, type-casting and other minor fixes
  • Property mode set to 100644
File size: 7.5 KB
Line 
1/*
2 * Copyright (c) 2011 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 drvusbuhcihc
29 * @{
30 */
31/** @file
32 * @brief UHCI driver transfer list implementation
33 */
34#include <errno.h>
35#include <usb/debug.h>
36#include <arch/barrier.h>
37
38#include "transfer_list.h"
39
40static void transfer_list_remove_batch(
41 transfer_list_t *instance, usb_transfer_batch_t *batch);
42/*----------------------------------------------------------------------------*/
43/** Initialize transfer list structures.
44 *
45 * @param[in] instance Memory place to use.
46 * @param[in] name Name of the new list.
47 * @return Error code
48 *
49 * Allocates memory for internal qh_t structure.
50 */
51int transfer_list_init(transfer_list_t *instance, const char *name)
52{
53 assert(instance);
54 instance->name = name;
55 instance->queue_head = malloc32(sizeof(qh_t));
56 if (!instance->queue_head) {
57 usb_log_error("Failed to allocate queue head.\n");
58 return ENOMEM;
59 }
60 const uint32_t queue_head_pa = addr_to_phys(instance->queue_head);
61 usb_log_debug2("Transfer list %s setup with QH: %p (%#" PRIx32" ).\n",
62 name, instance->queue_head, queue_head_pa);
63
64 qh_init(instance->queue_head);
65 list_initialize(&instance->batch_list);
66 fibril_mutex_initialize(&instance->guard);
67 return EOK;
68}
69/*----------------------------------------------------------------------------*/
70/** Dispose transfer list structures.
71 *
72 * @param[in] instance Memory place to use.
73 *
74 * Frees memory of the internal qh_t structure.
75 */
76void transfer_list_fini(transfer_list_t *instance)
77{
78 assert(instance);
79 free32(instance->queue_head);
80}
81/** Set the next list in transfer list chain.
82 *
83 * @param[in] instance List to lead.
84 * @param[in] next List to append.
85 * @return Error code
86 *
87 * Does not check whether this replaces an existing list .
88 */
89void transfer_list_set_next(transfer_list_t *instance, transfer_list_t *next)
90{
91 assert(instance);
92 assert(instance->queue_head);
93 assert(next);
94 /* Set queue_head.next to point to the follower */
95 qh_set_next_qh(instance->queue_head, next->queue_head);
96}
97/*----------------------------------------------------------------------------*/
98/** Add transfer batch to the list and queue.
99 *
100 * @param[in] instance List to use.
101 * @param[in] batch Transfer batch to submit.
102 *
103 * The batch is added to the end of the list and queue.
104 */
105void transfer_list_add_batch(
106 transfer_list_t *instance, usb_transfer_batch_t *batch)
107{
108 assert(instance);
109 assert(batch);
110 usb_log_debug2("Queue %s: Adding batch(%p).\n", instance->name, batch);
111
112 fibril_mutex_lock(&instance->guard);
113
114 qh_t *last_qh = NULL;
115 /* Add to the hardware queue. */
116 if (list_empty(&instance->batch_list)) {
117 /* There is nothing scheduled */
118 last_qh = instance->queue_head;
119 } else {
120 /* There is something scheduled */
121 usb_transfer_batch_t *last =
122 usb_transfer_batch_from_link(instance->batch_list.prev);
123 last_qh = batch_qh(last);
124 }
125 const uint32_t pa = addr_to_phys(batch_qh(batch));
126 assert((pa & LINK_POINTER_ADDRESS_MASK) == pa);
127
128 /* Make sure all data in the batch are written */
129 write_barrier();
130
131 /* keep link */
132 batch_qh(batch)->next = last_qh->next;
133 qh_set_next_qh(last_qh, batch_qh(batch));
134
135 /* Make sure the pointer is updated */
136 write_barrier();
137
138 /* Add to the driver's list */
139 list_append(&batch->link, &instance->batch_list);
140
141 usb_transfer_batch_t *first = list_get_instance(
142 instance->batch_list.next, usb_transfer_batch_t, link);
143 usb_log_debug("Batch(%p) added to queue %s, first is %p.\n",
144 batch, instance->name, first);
145 fibril_mutex_unlock(&instance->guard);
146}
147/*----------------------------------------------------------------------------*/
148/** Add completed bantches to the provided list.
149 *
150 * @param[in] instance List to use.
151 * @param[in] done list to fill
152 */
153void transfer_list_remove_finished(transfer_list_t *instance, link_t *done)
154{
155 assert(instance);
156 assert(done);
157
158 fibril_mutex_lock(&instance->guard);
159 link_t *current = instance->batch_list.next;
160 while (current != &instance->batch_list) {
161 link_t * const next = current->next;
162 usb_transfer_batch_t *batch =
163 usb_transfer_batch_from_link(current);
164
165 if (batch_is_complete(batch)) {
166 /* Save for processing */
167 transfer_list_remove_batch(instance, batch);
168 list_append(current, done);
169 }
170 current = next;
171 }
172 fibril_mutex_unlock(&instance->guard);
173}
174/*----------------------------------------------------------------------------*/
175/** Walk the list and finish all batches with EINTR.
176 *
177 * @param[in] instance List to use.
178 */
179void transfer_list_abort_all(transfer_list_t *instance)
180{
181 fibril_mutex_lock(&instance->guard);
182 while (!list_empty(&instance->batch_list)) {
183 link_t * const current = instance->batch_list.next;
184 usb_transfer_batch_t *batch =
185 usb_transfer_batch_from_link(current);
186 transfer_list_remove_batch(instance, batch);
187 usb_transfer_batch_finish_error(batch, EINTR);
188 }
189 fibril_mutex_unlock(&instance->guard);
190}
191/*----------------------------------------------------------------------------*/
192/** Remove a transfer batch from the list and queue.
193 *
194 * @param[in] instance List to use.
195 * @param[in] batch Transfer batch to remove.
196 *
197 * Does not lock the transfer list, caller is responsible for that.
198 */
199void transfer_list_remove_batch(
200 transfer_list_t *instance, usb_transfer_batch_t *batch)
201{
202 assert(instance);
203 assert(instance->queue_head);
204 assert(batch);
205 assert(batch_qh(batch));
206 assert(fibril_mutex_is_locked(&instance->guard));
207
208 usb_log_debug2(
209 "Queue %s: removing batch(%p).\n", instance->name, batch);
210
211 const char *qpos = NULL;
212 qh_t *prev_qh = NULL;
213 /* Remove from the hardware queue */
214 if (instance->batch_list.next == &batch->link) {
215 /* I'm the first one here */
216 prev_qh = instance->queue_head;
217 qpos = "FIRST";
218 } else {
219 /* The thing before me is a batch too */
220 usb_transfer_batch_t *prev =
221 usb_transfer_batch_from_link(batch->link.prev);
222 prev_qh = batch_qh(prev);
223 qpos = "NOT FIRST";
224 }
225 assert((prev_qh->next & LINK_POINTER_ADDRESS_MASK)
226 == addr_to_phys(batch_qh(batch)));
227 prev_qh->next = batch_qh(batch)->next;
228
229 /* Make sure the pointer is updated */
230 write_barrier();
231
232 /* Remove from the batch list */
233 list_remove(&batch->link);
234 usb_log_debug("Batch(%p) removed (%s) from %s, next: %x.\n",
235 batch, qpos, instance->name, batch_qh(batch)->next);
236}
237/**
238 * @}
239 */
Note: See TracBrowser for help on using the repository browser.