source: mainline/uspace/drv/bus/usb/uhci/uhci_batch.c@ e6d7df1

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

uhci: Use foreach_safe to iterate through list.
  • Property mode set to 100644
File size: 11.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 USB transfer structure
33 */
34
35#include <assert.h>
36#include <errno.h>
37#include <macros.h>
38#include <mem.h>
39#include <stdlib.h>
40
41#include <usb/usb.h>
42#include <usb/debug.h>
43#include <usb/host/endpoint.h>
44
45#include "uhci_batch.h"
46#include "hw_struct/transfer_descriptor.h"
47#include "utils/malloc32.h"
48
49#define DEFAULT_ERROR_COUNT 3
50
51/** Safely destructs uhci_transfer_batch_t structure.
52 *
53 * @param[in] uhci_batch Instance to destroy.
54 */
55static void uhci_transfer_batch_dispose(uhci_transfer_batch_t *uhci_batch)
56{
57 if (uhci_batch) {
58 usb_transfer_batch_destroy(uhci_batch->usb_batch);
59 free32(uhci_batch->device_buffer);
60 free(uhci_batch);
61 }
62}
63
64/** Finishes usb_transfer_batch and destroys the structure.
65 *
66 * @param[in] uhci_batch Instance to finish and destroy.
67 */
68void uhci_transfer_batch_finish_dispose(uhci_transfer_batch_t *uhci_batch)
69{
70 assert(uhci_batch);
71 assert(uhci_batch->usb_batch);
72 assert(!link_in_use(&uhci_batch->link));
73 usb_transfer_batch_finish(uhci_batch->usb_batch,
74 uhci_transfer_batch_data_buffer(uhci_batch));
75 uhci_transfer_batch_dispose(uhci_batch);
76}
77
78/** Transfer batch setup table. */
79static void (*const batch_setup[])(uhci_transfer_batch_t*, usb_direction_t);
80
81/** Allocate memory and initialize internal data structure.
82 *
83 * @param[in] usb_batch Pointer to generic USB batch structure.
84 * @return Valid pointer if all structures were successfully created,
85 * NULL otherwise.
86 *
87 * Determines the number of needed transfer descriptors (TDs).
88 * Prepares a transport buffer (that is accessible by the hardware).
89 * Initializes parameters needed for the transfer and callback.
90 */
91uhci_transfer_batch_t * uhci_transfer_batch_get(usb_transfer_batch_t *usb_batch)
92{
93 assert((sizeof(td_t) % 16) == 0);
94#define CHECK_NULL_DISPOSE_RETURN(ptr, message...) \
95 if (ptr == NULL) { \
96 usb_log_error(message); \
97 uhci_transfer_batch_dispose(uhci_batch); \
98 return NULL; \
99 } else (void)0
100
101 uhci_transfer_batch_t *uhci_batch =
102 calloc(1, sizeof(uhci_transfer_batch_t));
103 CHECK_NULL_DISPOSE_RETURN(uhci_batch,
104 "Failed to allocate UHCI batch.\n");
105 link_initialize(&uhci_batch->link);
106 uhci_batch->td_count =
107 (usb_batch->buffer_size + usb_batch->ep->max_packet_size - 1)
108 / usb_batch->ep->max_packet_size;
109 if (usb_batch->ep->transfer_type == USB_TRANSFER_CONTROL) {
110 uhci_batch->td_count += 2;
111 }
112
113 const size_t total_size = (sizeof(td_t) * uhci_batch->td_count)
114 + sizeof(qh_t) + usb_batch->setup_size + usb_batch->buffer_size;
115 uhci_batch->device_buffer = malloc32(total_size);
116 CHECK_NULL_DISPOSE_RETURN(uhci_batch->device_buffer,
117 "Failed to allocate UHCI buffer.\n");
118 memset(uhci_batch->device_buffer, 0, total_size);
119
120 uhci_batch->tds = uhci_batch->device_buffer;
121 uhci_batch->qh =
122 (uhci_batch->device_buffer + (sizeof(td_t) * uhci_batch->td_count));
123
124 qh_init(uhci_batch->qh);
125 qh_set_element_td(uhci_batch->qh, &uhci_batch->tds[0]);
126
127 void *dest =
128 uhci_batch->device_buffer + (sizeof(td_t) * uhci_batch->td_count)
129 + sizeof(qh_t);
130 /* Copy SETUP packet data to the device buffer */
131 memcpy(dest, usb_batch->setup_buffer, usb_batch->setup_size);
132 dest += usb_batch->setup_size;
133 /* Copy generic data unless they are provided by the device */
134 if (usb_batch->ep->direction != USB_DIRECTION_IN) {
135 memcpy(dest, usb_batch->buffer, usb_batch->buffer_size);
136 }
137 uhci_batch->usb_batch = usb_batch;
138 usb_log_debug2("Batch %p " USB_TRANSFER_BATCH_FMT
139 " memory structures ready.\n", usb_batch,
140 USB_TRANSFER_BATCH_ARGS(*usb_batch));
141
142 const usb_direction_t dir = usb_transfer_batch_direction(usb_batch);
143
144 assert(batch_setup[usb_batch->ep->transfer_type]);
145 batch_setup[usb_batch->ep->transfer_type](uhci_batch, dir);
146
147 return uhci_batch;
148}
149
150/** Check batch TDs for activity.
151 *
152 * @param[in] uhci_batch Batch structure to use.
153 * @return False, if there is an active TD, true otherwise.
154 *
155 * Walk all TDs. Stop with false if there is an active one (it is to be
156 * processed). Stop with true if an error is found. Return true if the last TD
157 * is reached.
158 */
159bool uhci_transfer_batch_is_complete(const uhci_transfer_batch_t *uhci_batch)
160{
161 assert(uhci_batch);
162 assert(uhci_batch->usb_batch);
163
164 usb_log_debug2("Batch %p " USB_TRANSFER_BATCH_FMT
165 " checking %zu transfer(s) for completion.\n",
166 uhci_batch->usb_batch,
167 USB_TRANSFER_BATCH_ARGS(*uhci_batch->usb_batch),
168 uhci_batch->td_count);
169 uhci_batch->usb_batch->transfered_size = 0;
170
171 for (size_t i = 0;i < uhci_batch->td_count; ++i) {
172 if (td_is_active(&uhci_batch->tds[i])) {
173 return false;
174 }
175
176 uhci_batch->usb_batch->error = td_status(&uhci_batch->tds[i]);
177 if (uhci_batch->usb_batch->error != EOK) {
178 assert(uhci_batch->usb_batch->ep != NULL);
179
180 usb_log_debug("Batch %p found error TD(%zu->%p):%"
181 PRIx32 ".\n", uhci_batch->usb_batch, i,
182 &uhci_batch->tds[i], uhci_batch->tds[i].status);
183 td_print_status(&uhci_batch->tds[i]);
184
185 endpoint_toggle_set(uhci_batch->usb_batch->ep,
186 td_toggle(&uhci_batch->tds[i]));
187 if (i > 0)
188 goto substract_ret;
189 return true;
190 }
191
192 uhci_batch->usb_batch->transfered_size
193 += td_act_size(&uhci_batch->tds[i]);
194 if (td_is_short(&uhci_batch->tds[i]))
195 goto substract_ret;
196 }
197substract_ret:
198 uhci_batch->usb_batch->transfered_size
199 -= uhci_batch->usb_batch->setup_size;
200 return true;
201}
202
203/** Direction to pid conversion table */
204static const usb_packet_id direction_pids[] = {
205 [USB_DIRECTION_IN] = USB_PID_IN,
206 [USB_DIRECTION_OUT] = USB_PID_OUT,
207};
208
209/** Prepare generic data transfer
210 *
211 * @param[in] uhci_batch Batch structure to use.
212 * @param[in] dir Communication direction.
213 *
214 * Transactions with alternating toggle bit and supplied pid value.
215 * The last transfer is marked with IOC flag.
216 */
217static void batch_data(uhci_transfer_batch_t *uhci_batch, usb_direction_t dir)
218{
219 assert(uhci_batch);
220 assert(uhci_batch->usb_batch);
221 assert(uhci_batch->usb_batch->ep);
222 assert(dir == USB_DIRECTION_OUT || dir == USB_DIRECTION_IN);
223
224
225 const usb_packet_id pid = direction_pids[dir];
226 const bool low_speed =
227 uhci_batch->usb_batch->ep->speed == USB_SPEED_LOW;
228 const size_t mps = uhci_batch->usb_batch->ep->max_packet_size;
229 const usb_target_t target = {{
230 uhci_batch->usb_batch->ep->address,
231 uhci_batch->usb_batch->ep->endpoint }};
232
233 int toggle = endpoint_toggle_get(uhci_batch->usb_batch->ep);
234 assert(toggle == 0 || toggle == 1);
235
236 size_t td = 0;
237 size_t remain_size = uhci_batch->usb_batch->buffer_size;
238 char *buffer = uhci_transfer_batch_data_buffer(uhci_batch);
239
240 while (remain_size > 0) {
241 const size_t packet_size = min(remain_size, mps);
242
243 const td_t *next_td = (td + 1 < uhci_batch->td_count)
244 ? &uhci_batch->tds[td + 1] : NULL;
245
246 assert(td < uhci_batch->td_count);
247 td_init(
248 &uhci_batch->tds[td], DEFAULT_ERROR_COUNT, packet_size,
249 toggle, false, low_speed, target, pid, buffer, next_td);
250
251 ++td;
252 toggle = 1 - toggle;
253 buffer += packet_size;
254 remain_size -= packet_size;
255 }
256 td_set_ioc(&uhci_batch->tds[td - 1]);
257 endpoint_toggle_set(uhci_batch->usb_batch->ep, toggle);
258 usb_log_debug2(
259 "Batch %p %s %s " USB_TRANSFER_BATCH_FMT " initialized.\n", \
260 uhci_batch->usb_batch,
261 usb_str_transfer_type(uhci_batch->usb_batch->ep->transfer_type),
262 usb_str_direction(uhci_batch->usb_batch->ep->direction),
263 USB_TRANSFER_BATCH_ARGS(*uhci_batch->usb_batch));
264}
265
266/** Prepare generic control transfer
267 *
268 * @param[in] uhci_batch Batch structure to use.
269 * @param[in] dir Communication direction.
270 *
271 * Setup stage with toggle 0 and USB_PID_SETUP.
272 * Data stage with alternating toggle and pid determined by the communication
273 * direction.
274 * Status stage with toggle 1 and pid determined by the communication direction.
275 * The last transfer is marked with IOC.
276 */
277static void batch_control(uhci_transfer_batch_t *uhci_batch, usb_direction_t dir)
278{
279 assert(uhci_batch);
280 assert(uhci_batch->usb_batch);
281 assert(uhci_batch->usb_batch->ep);
282 assert(dir == USB_DIRECTION_OUT || dir == USB_DIRECTION_IN);
283 assert(uhci_batch->td_count >= 2);
284 static const usb_packet_id status_stage_pids[] = {
285 [USB_DIRECTION_IN] = USB_PID_OUT,
286 [USB_DIRECTION_OUT] = USB_PID_IN,
287 };
288
289 const usb_packet_id data_stage_pid = direction_pids[dir];
290 const usb_packet_id status_stage_pid = status_stage_pids[dir];
291 const bool low_speed =
292 uhci_batch->usb_batch->ep->speed == USB_SPEED_LOW;
293 const size_t mps = uhci_batch->usb_batch->ep->max_packet_size;
294 const usb_target_t target = {{
295 uhci_batch->usb_batch->ep->address,
296 uhci_batch->usb_batch->ep->endpoint }};
297
298 /* setup stage */
299 td_init(
300 &uhci_batch->tds[0], DEFAULT_ERROR_COUNT,
301 uhci_batch->usb_batch->setup_size, 0, false,
302 low_speed, target, USB_PID_SETUP,
303 uhci_transfer_batch_setup_buffer(uhci_batch), &uhci_batch->tds[1]);
304
305 /* data stage */
306 size_t td = 1;
307 unsigned toggle = 1;
308 size_t remain_size = uhci_batch->usb_batch->buffer_size;
309 char *buffer = uhci_transfer_batch_data_buffer(uhci_batch);
310
311 while (remain_size > 0) {
312 const size_t packet_size = min(remain_size, mps);
313
314 td_init(
315 &uhci_batch->tds[td], DEFAULT_ERROR_COUNT, packet_size,
316 toggle, false, low_speed, target, data_stage_pid,
317 buffer, &uhci_batch->tds[td + 1]);
318
319 ++td;
320 toggle = 1 - toggle;
321 buffer += packet_size;
322 remain_size -= packet_size;
323 assert(td < uhci_batch->td_count);
324 }
325
326 /* status stage */
327 assert(td == uhci_batch->td_count - 1);
328
329 td_init(
330 &uhci_batch->tds[td], DEFAULT_ERROR_COUNT, 0, 1, false, low_speed,
331 target, status_stage_pid, NULL, NULL);
332 td_set_ioc(&uhci_batch->tds[td]);
333
334 usb_log_debug2("Control last TD status: %x.\n",
335 uhci_batch->tds[td].status);
336}
337
338static void (*const batch_setup[])(uhci_transfer_batch_t*, usb_direction_t) =
339{
340 [USB_TRANSFER_CONTROL] = batch_control,
341 [USB_TRANSFER_BULK] = batch_data,
342 [USB_TRANSFER_INTERRUPT] = batch_data,
343 [USB_TRANSFER_ISOCHRONOUS] = NULL,
344};
345/**
346 * @}
347 */
Note: See TracBrowser for help on using the repository browser.