source: mainline/uspace/drv/uhci-hcd/tracker.c@ 5d4193c

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

Fix: interrupt calls should use interrupt trackers
Fix: interrupt tracker should always set next step (it is NULL during te first call)
  • Property mode set to 100644
File size: 15.6 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 usb
29 * @{
30 */
31/** @file
32 * @brief UHCI driver
33 */
34#include <errno.h>
35
36#include <usb/debug.h>
37
38#include "tracker.h"
39#include "uhci.h"
40#include "utils/malloc32.h"
41
42#define SETUP_PACKET_DATA_SIZE 8
43#define DEFAULT_ERROR_COUNT 3
44#define MAX(a,b) ((a > b) ? a : b)
45#define MIN(a,b) ((a < b) ? a : b)
46
47static int tracker_schedule(tracker_t *instance);
48
49static void tracker_control_read_data(tracker_t *instance);
50static void tracker_control_write_data(tracker_t *instance);
51static void tracker_control_read_status(tracker_t *instance);
52static void tracker_control_write_status(tracker_t *instance);
53
54static void tracker_call_in(tracker_t *instance);
55static void tracker_call_out(tracker_t *instance);
56static void tracker_call_in_and_dispose(tracker_t *instance);
57static void tracker_call_out_and_dispose(tracker_t *instance);
58
59
60tracker_t * tracker_get(device_t *dev, usb_target_t target,
61 usb_transfer_type_t transfer_type, size_t max_packet_size,
62 dev_speed_t speed, char *buffer, size_t size,
63 usbhc_iface_transfer_in_callback_t func_in,
64 usbhc_iface_transfer_out_callback_t func_out, void *arg)
65{
66 assert(func_in == NULL || func_out == NULL);
67 assert(func_in != NULL || func_out != NULL);
68
69 tracker_t *instance = malloc(sizeof(tracker_t));
70 if (!instance) {
71 usb_log_error("Failed to allocate tracker isntance.\n");
72 return NULL;
73 }
74
75 instance->td = malloc32(sizeof(transfer_descriptor_t));
76 if (!instance->td) {
77 usb_log_error("Failed to allocate transfer descriptor.\n");
78 free(instance);
79 return NULL;
80 }
81 bzero(instance->td, sizeof(transfer_descriptor_t));
82
83 instance->packet = max_packet_size ? malloc32(max_packet_size) : NULL;
84 if (max_packet_size && !instance->packet) {
85 usb_log_error("Failed to allocate device acessible buffer.\n");
86 free32(instance->td);
87 free(instance);
88 return NULL;
89 }
90 instance->max_packet_size = max_packet_size;
91 instance->packet_size = 0;
92 instance->buffer_offset = 0;
93
94 link_initialize(&instance->link);
95 instance->target = target;
96 instance->transfer_type = transfer_type;
97
98 if (func_out)
99 instance->callback_out = func_out;
100 if (func_in)
101 instance->callback_in = func_in;
102 instance->buffer = buffer;
103 instance->buffer_size = size;
104 instance->dev = dev;
105 instance->arg = arg;
106 instance->toggle = 0;
107 instance->speed = speed;
108
109 return instance;
110}
111/*----------------------------------------------------------------------------*/
112void tracker_control_write(
113 tracker_t *instance, char* setup_buffer, size_t setup_size)
114{
115 assert(instance);
116 assert(instance->buffer_offset == 0);
117 assert(setup_size == 8);
118
119 instance->packet_size = 0;
120 memcpy(instance->packet, setup_buffer, setup_size);
121
122 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
123 setup_size, instance->toggle++, false, instance->target,
124 USB_PID_SETUP, instance->packet);
125
126 instance->next_step = tracker_control_write_data;
127
128 tracker_schedule(instance);
129}
130/*----------------------------------------------------------------------------*/
131void tracker_control_read(
132 tracker_t *instance, char* setup_buffer, size_t setup_size)
133{
134 assert(instance);
135 assert(instance->buffer_offset == 0);
136 assert(setup_size == 8);
137
138 memcpy(instance->packet, setup_buffer, setup_size);
139
140 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
141 setup_size, instance->toggle++, false, instance->target,
142 USB_PID_SETUP, instance->packet);
143
144 instance->next_step = tracker_control_read_data;
145
146 tracker_schedule(instance);
147}
148/*----------------------------------------------------------------------------*/
149void tracker_control_read_data(tracker_t *instance)
150{
151 assert(instance);
152
153 /* check for errors */
154 int err = transfer_descriptor_status(instance->td);
155 if (err != EOK) {
156 tracker_call_in_and_dispose(instance);
157 return;
158 }
159
160 /* we are data in, we want data from our device */
161 if (instance->packet_size) {
162 memcpy(instance->buffer + instance->buffer_offset, instance->packet,
163 instance->packet_size);
164 }
165 instance->buffer_offset += instance->packet_size;
166
167 /* prepare next packet, no copy, we are receiving data */
168 instance->packet_size = MIN(instance->max_packet_size,
169 instance->buffer_size - instance->buffer_offset);
170
171 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
172 instance->packet_size, instance->toggle++, false, instance->target,
173 USB_PID_IN, instance->packet);
174
175 tracker_schedule(instance);
176
177 /* set next step */
178 if ((instance->buffer_offset + instance->packet_size)
179 >= instance->buffer_size) {
180 /* that's all, end coomunication */
181 instance->next_step = tracker_control_read_status;
182 }
183}
184/*----------------------------------------------------------------------------*/
185void tracker_control_write_data(tracker_t *instance)
186{
187 assert(instance);
188
189 /* check for errors */
190 int err = transfer_descriptor_status(instance->td);
191 if (err != EOK) {
192 tracker_call_out_and_dispose(instance);
193 return;
194 }
195
196 /* we are data out, we don't want data from our device */
197 instance->buffer_offset += instance->packet_size;
198
199 /* prepare next packet, copy data to packet */
200 instance->packet_size = MIN(instance->max_packet_size,
201 instance->buffer_size - instance->buffer_offset);
202 memcpy(instance->packet, instance->buffer + instance->buffer_offset,
203 instance->packet_size);
204
205 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
206 instance->packet_size, instance->toggle++, false, instance->target,
207 USB_PID_OUT, instance->packet);
208
209 tracker_schedule(instance);
210
211 /* set next step */
212 if ((instance->buffer_offset + instance->packet_size)
213 >= instance->buffer_size) {
214 /* that's all, end coomunication */
215 instance->next_step = tracker_control_write_status;
216 }
217}
218/*----------------------------------------------------------------------------*/
219void tracker_control_read_status(tracker_t *instance)
220{
221 assert(instance);
222
223 /* check for errors */
224 int err = transfer_descriptor_status(instance->td);
225 if (err != EOK) {
226 tracker_call_in_and_dispose(instance);
227 return;
228 }
229
230 /* we are data in, we want data from our device */
231 memcpy(instance->buffer + instance->buffer_offset, instance->packet,
232 instance->packet_size);
233 instance->buffer_offset += instance->packet_size;
234 assert(instance->buffer_offset = instance->buffer_size);
235
236 /* prepare next packet, no nothing, just an empty packet */
237 instance->packet_size = 0;
238 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
239 instance->packet_size, 1, false, instance->target, USB_PID_OUT, NULL);
240
241 tracker_schedule(instance);
242
243 /* set next step, callback and cleanup */
244 instance->next_step = tracker_call_in_and_dispose;
245}
246/*----------------------------------------------------------------------------*/
247void tracker_control_write_status(tracker_t *instance)
248{
249 assert(instance);
250
251 /* check for errors */
252 int err = transfer_descriptor_status(instance->td);
253 if (err != EOK) {
254 tracker_call_out_and_dispose(instance);
255 return;
256 }
257
258 /* we are data in, we want data from our device */
259 assert(
260 instance->buffer_offset + instance->packet_size <= instance->buffer_size);
261 memcpy(instance->buffer + instance->buffer_offset, instance->packet,
262 instance->packet_size);
263 instance->buffer_offset += instance->packet_size;
264 assert(instance->buffer_offset = instance->buffer_size);
265
266 /* prepare next packet, no nothing, just an empty packet */
267 instance->packet_size = 0;
268 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
269 instance->packet_size, 1, false, instance->target, USB_PID_IN, NULL);
270
271 tracker_schedule(instance);
272
273 /* set next step, callback and cleanup */
274 instance->next_step = tracker_call_out_and_dispose;
275}
276/*----------------------------------------------------------------------------*/
277void tracker_interrupt_in(tracker_t *instance)
278{
279 assert(instance);
280
281 /* check for errors */
282 int err = transfer_descriptor_status(instance->td);
283 if (err != EOK) {
284 tracker_call_in_and_dispose(instance);
285 return;
286 }
287
288 assert(instance->packet_size <= instance->max_packet_size);
289 if (instance->packet_size) {
290 /* we are data in, we want data from our device. if there is data */
291 memcpy(instance->buffer + instance->buffer_offset, instance->packet,
292 instance->packet_size);
293 instance->buffer_offset += instance->packet_size;
294 }
295
296 /* prepare next packet, no copy, we are receiving data */
297 instance->packet_size = MIN(instance->max_packet_size,
298 instance->buffer_size - instance->buffer_offset);
299 assert(instance->packet_size <= instance->max_packet_size);
300
301 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
302 instance->packet_size, instance->toggle++, false, instance->target,
303 USB_PID_IN, instance->packet);
304
305 tracker_schedule(instance);
306
307 /* set next step */
308 if ((instance->buffer_offset + instance->packet_size)
309 >= instance->buffer_size) {
310 /* that's all, end coomunication */
311 instance->next_step = tracker_call_in_and_dispose;
312 } else {
313 instance->next_step = tracker_interrupt_in;
314 }
315}
316/*----------------------------------------------------------------------------*/
317void tracker_interrupt_out(tracker_t *instance)
318{
319 assert(instance);
320
321 /* check for errors */
322 int err = transfer_descriptor_status(instance->td);
323 if (err != EOK) {
324 tracker_call_out_and_dispose(instance);
325 return;
326 }
327
328 /* we are data out, we don't want data from our device */
329 instance->buffer_offset += instance->packet_size;
330
331 /* prepare next packet, copy data to packet */
332 instance->packet_size = MIN(instance->max_packet_size,
333 instance->buffer_size - instance->buffer_offset);
334 memcpy(instance->packet, instance->buffer + instance->buffer_offset,
335 instance->packet_size);
336
337 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
338 instance->packet_size, instance->toggle++, false, instance->target,
339 USB_PID_OUT, instance->packet);
340
341 tracker_schedule(instance);
342
343 /* set next step */
344 if ((instance->buffer_offset + instance->packet_size)
345 >= instance->buffer_size) {
346 /* that's all, end coomunication */
347 instance->next_step = tracker_call_out_and_dispose;
348 } else {
349 instance->next_step = tracker_interrupt_out;
350 }
351}
352/*----------------------------------------------------------------------------*/
353void tracker_call_in(tracker_t *instance)
354{
355 assert(instance);
356 assert(instance->callback_in);
357
358 /* check for errors */
359 int err = transfer_descriptor_status(instance->td);
360 if (err == EOK && instance->packet_size) {
361 memcpy(instance->buffer + instance->buffer_offset, instance->packet,
362 instance->packet_size);
363 instance->buffer_offset += instance->packet_size;
364 }
365 usb_log_debug("Callback IN(%d): %d, %zu.\n", instance->transfer_type,
366 err, instance->buffer_offset);
367 instance->callback_in(instance->dev,
368 err ? USB_OUTCOME_CRCERROR : USB_OUTCOME_OK, instance->buffer_offset,
369 instance->arg);
370}
371/*----------------------------------------------------------------------------*/
372void tracker_call_out(tracker_t *instance)
373{
374 assert(instance);
375 assert(instance->callback_out);
376
377 /* check for errors */
378 int err = transfer_descriptor_status(instance->td);
379 usb_log_debug("Callback OUT(%d): %d, %zu.\n", instance->transfer_type,
380 err, instance->buffer_offset);
381 instance->callback_out(instance->dev,
382 err ? USB_OUTCOME_CRCERROR : USB_OUTCOME_OK, instance->arg);
383}
384/*----------------------------------------------------------------------------*/
385void tracker_call_in_and_dispose(tracker_t *instance)
386{
387 assert(instance);
388 tracker_call_in(instance);
389 free32(instance->td);
390 free32(instance->packet);
391 free(instance);
392}
393/*----------------------------------------------------------------------------*/
394void tracker_call_out_and_dispose(tracker_t *instance)
395{
396 assert(instance);
397 tracker_call_out(instance);
398 free32(instance->td);
399 free32(instance->packet);
400 free(instance);
401}
402/*----------------------------------------------------------------------------*/
403int tracker_schedule(tracker_t *instance)
404{
405 assert(instance);
406 uhci_t *hc = dev_to_uhci(instance->dev);
407 assert(hc);
408 return uhci_schedule(hc, instance);
409}
410/*----------------------------------------------------------------------------*/
411/* DEPRECATED FUNCTIONS NEEDED BY THE OLD API */
412void tracker_control_setup_old(tracker_t *instance)
413{
414 assert(instance);
415 assert(instance->buffer_offset == 0);
416
417 instance->packet_size = SETUP_PACKET_DATA_SIZE;
418 memcpy(instance->packet, instance->buffer, SETUP_PACKET_DATA_SIZE);
419
420 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
421 SETUP_PACKET_DATA_SIZE, 0, false, instance->target, USB_PID_SETUP,
422 instance->packet);
423
424 instance->buffer_offset += SETUP_PACKET_DATA_SIZE;
425 instance->next_step = tracker_call_out_and_dispose;
426
427 tracker_schedule(instance);
428}
429
430void tracker_control_write_data_old(tracker_t *instance)
431{
432 assert(instance);
433 assert(instance->max_packet_size == instance->buffer_size);
434
435 memcpy(instance->packet, instance->buffer, instance->max_packet_size);
436 instance->packet_size = instance->max_packet_size;
437
438 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
439 instance->packet_size, 1, false, instance->target, USB_PID_OUT,
440 instance->packet);
441 instance->next_step = tracker_call_out_and_dispose;
442
443 tracker_schedule(instance);
444}
445
446void tracker_control_read_data_old(tracker_t *instance)
447{
448 assert(instance);
449 assert(instance->max_packet_size == instance->buffer_size);
450
451 instance->packet_size = instance->max_packet_size;
452
453 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
454 instance->packet_size, 1, false, instance->target, USB_PID_IN,
455 instance->packet);
456
457 instance->next_step = tracker_call_in_and_dispose;
458
459 tracker_schedule(instance);
460}
461
462void tracker_control_write_status_old(tracker_t *instance)
463{
464 assert(instance);
465 assert(instance->max_packet_size == 0);
466 assert(instance->buffer_size == 0);
467 assert(instance->packet == NULL);
468
469 instance->packet_size = instance->max_packet_size;
470 instance->next_step = tracker_call_in_and_dispose;
471
472 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
473 instance->packet_size, 1, false, instance->target, USB_PID_IN,
474 instance->packet);
475
476 tracker_schedule(instance);
477}
478
479void tracker_control_read_status_old(tracker_t *instance)
480{
481 assert(instance);
482 assert(instance->max_packet_size == 0);
483 assert(instance->buffer_size == 0);
484 assert(instance->packet == NULL);
485
486 instance->packet_size = instance->max_packet_size;
487 instance->next_step = tracker_call_out_and_dispose;
488
489 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
490 instance->packet_size, 1, false, instance->target, USB_PID_OUT,
491 instance->packet);
492
493 tracker_schedule(instance);
494}
495/**
496 * @}
497 */
Note: See TracBrowser for help on using the repository browser.