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

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

Make batch_t a library structure
  • Property mode set to 100644
File size: 7.2 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
37#include "transfer_list.h"
38
39static void transfer_list_remove_batch(
40 transfer_list_t *instance, batch_t *batch);
41/*----------------------------------------------------------------------------*/
42/** Initialize transfer list structures.
43 *
44 * @param[in] instance Memory place to use.
45 * @param[in] name Name of the new list.
46 * @return Error code
47 *
48 * Allocates memory for internal qh_t structure.
49 */
50int transfer_list_init(transfer_list_t *instance, const char *name)
51{
52 assert(instance);
53 instance->name = name;
54 instance->queue_head = malloc32(sizeof(qh_t));
55 if (!instance->queue_head) {
56 usb_log_error("Failed to allocate queue head.\n");
57 return ENOMEM;
58 }
59 instance->queue_head_pa = addr_to_phys(instance->queue_head);
60
61 qh_init(instance->queue_head);
62 list_initialize(&instance->batch_list);
63 fibril_mutex_initialize(&instance->guard);
64 return EOK;
65}
66/*----------------------------------------------------------------------------*/
67/** Set the next list in transfer list chain.
68 *
69 * @param[in] instance List to lead.
70 * @param[in] next List to append.
71 * @return Error code
72 *
73 * Does not check whether this replaces an existing list .
74 */
75void transfer_list_set_next(transfer_list_t *instance, transfer_list_t *next)
76{
77 assert(instance);
78 assert(next);
79 if (!instance->queue_head)
80 return;
81 /* Set both next and element to point to the same QH */
82 qh_set_next_qh(instance->queue_head, next->queue_head_pa);
83 qh_set_element_qh(instance->queue_head, next->queue_head_pa);
84}
85/*----------------------------------------------------------------------------*/
86/** Submit transfer batch to the list and queue.
87 *
88 * @param[in] instance List to use.
89 * @param[in] batch Transfer batch to submit.
90 * @return Error code
91 *
92 * The batch is added to the end of the list and queue.
93 */
94void transfer_list_add_batch(transfer_list_t *instance, batch_t *batch)
95{
96 assert(instance);
97 assert(batch);
98 usb_log_debug2("Queue %s: Adding batch(%p).\n", instance->name, batch);
99
100 const uint32_t pa = addr_to_phys(batch_qh(batch));
101 assert((pa & LINK_POINTER_ADDRESS_MASK) == pa);
102
103 /* New batch will be added to the end of the current list
104 * so set the link accordingly */
105 qh_set_next_qh(batch_qh(batch), instance->queue_head->next);
106
107 fibril_mutex_lock(&instance->guard);
108
109 /* Add to the hardware queue. */
110 if (list_empty(&instance->batch_list)) {
111 /* There is nothing scheduled */
112 qh_t *qh = instance->queue_head;
113 assert(qh->element == qh->next);
114 qh_set_element_qh(qh, pa);
115 } else {
116 /* There is something scheduled */
117 batch_t *last = list_get_instance(
118 instance->batch_list.prev, batch_t, link);
119 qh_set_next_qh(batch_qh(last), pa);
120 }
121 /* Add to the driver list */
122 list_append(&batch->link, &instance->batch_list);
123
124 batch_t *first = list_get_instance(
125 instance->batch_list.next, batch_t, link);
126 usb_log_debug("Batch(%p) added to queue %s, first is %p.\n",
127 batch, instance->name, first);
128 fibril_mutex_unlock(&instance->guard);
129}
130/*----------------------------------------------------------------------------*/
131/** Check list for finished batches.
132 *
133 * @param[in] instance List to use.
134 * @return Error code
135 *
136 * Creates a local list of finished batches and calls next_step on each and
137 * every one. This is safer because next_step may theoretically access
138 * this transfer list leading to the deadlock if its done inline.
139 */
140void transfer_list_remove_finished(transfer_list_t *instance)
141{
142 assert(instance);
143
144 LIST_INITIALIZE(done);
145
146 fibril_mutex_lock(&instance->guard);
147 link_t *current = instance->batch_list.next;
148 while (current != &instance->batch_list) {
149 link_t *next = current->next;
150 batch_t *batch = list_get_instance(current, batch_t, link);
151
152 if (batch_is_complete(batch)) {
153 /* Save for post-processing */
154 transfer_list_remove_batch(instance, batch);
155 list_append(current, &done);
156 }
157 current = next;
158 }
159 fibril_mutex_unlock(&instance->guard);
160
161 while (!list_empty(&done)) {
162 link_t *item = done.next;
163 list_remove(item);
164 batch_t *batch = list_get_instance(item, batch_t, link);
165 batch->next_step(batch);
166 }
167}
168/*----------------------------------------------------------------------------*/
169/** Walk the list and abort all batches.
170 *
171 * @param[in] instance List to use.
172 */
173void transfer_list_abort_all(transfer_list_t *instance)
174{
175 fibril_mutex_lock(&instance->guard);
176 while (list_empty(&instance->batch_list)) {
177 link_t *current = instance->batch_list.next;
178 batch_t *batch = list_get_instance(current, batch_t, link);
179 transfer_list_remove_batch(instance, batch);
180 batch_finish(batch, EIO);
181 }
182 fibril_mutex_unlock(&instance->guard);
183}
184/*----------------------------------------------------------------------------*/
185/** Remove a transfer batch from the list and queue.
186 *
187 * @param[in] instance List to use.
188 * @param[in] batch Transfer batch to remove.
189 * @return Error code
190 *
191 * Does not lock the transfer list, caller is responsible for that.
192 */
193void transfer_list_remove_batch(transfer_list_t *instance, batch_t *batch)
194{
195 assert(instance);
196 assert(instance->queue_head);
197 assert(batch);
198 assert(batch_qh(batch));
199 usb_log_debug2(
200 "Queue %s: removing batch(%p).\n", instance->name, batch);
201
202 const char * pos = NULL;
203 /* Remove from the hardware queue */
204 if (batch->link.prev == &instance->batch_list) {
205 /* I'm the first one here */
206 qh_set_element_qh(instance->queue_head, batch_qh(batch)->next);
207 pos = "FIRST";
208 } else {
209 batch_t *prev =
210 list_get_instance(batch->link.prev, batch_t, link);
211 qh_set_next_qh(batch_qh(prev), batch_qh(batch)->next);
212 pos = "NOT FIRST";
213 }
214 /* Remove from the driver list */
215 list_remove(&batch->link);
216 usb_log_debug("Batch(%p) removed (%s) from %s, next element %x.\n",
217 batch, pos, instance->name, batch_qh(batch)->next);
218}
219/**
220 * @}
221 */
Note: See TracBrowser for help on using the repository browser.