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

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

Adds new calbacks implementation

several debug texts
  • Property mode set to 100644
File size: 15.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 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
108 return instance;
109}
110/*----------------------------------------------------------------------------*/
111void tracker_control_write(
112 tracker_t *instance, char* setup_buffer, size_t setup_size)
113{
114 assert(instance);
115 assert(instance->buffer_offset == 0);
116 assert(setup_size == 8);
117
118 instance->packet_size = 0;
119 memcpy(instance->packet, setup_buffer, setup_size);
120
121 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
122 setup_size, instance->toggle++, false, instance->target,
123 USB_PID_SETUP, instance->packet);
124
125 instance->next_step = tracker_control_write_data;
126
127 tracker_schedule(instance);
128}
129/*----------------------------------------------------------------------------*/
130void tracker_control_read(
131 tracker_t *instance, char* setup_buffer, size_t setup_size)
132{
133 assert(instance);
134 assert(instance->buffer_offset == 0);
135 assert(setup_size == 8);
136
137 memcpy(instance->packet, setup_buffer, setup_size);
138
139 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
140 setup_size, instance->toggle++, false, instance->target,
141 USB_PID_SETUP, instance->packet);
142
143 instance->buffer_offset += SETUP_PACKET_DATA_SIZE;
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 if (instance->packet_size) {
289 /* we are data in, we want data from our device. if there is data */
290 memcpy(instance->buffer + instance->buffer_offset, instance->packet,
291 instance->packet_size);
292 instance->buffer_offset += instance->packet_size;
293 }
294
295 /* prepare next packet, no copy, we are receiving data */
296 instance->packet_size = MIN(instance->max_packet_size,
297 instance->buffer_size - instance->buffer_offset);
298 assert(instance->packet_size <= instance->max_packet_size);
299
300 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
301 instance->packet_size, instance->toggle++, false, instance->target,
302 USB_PID_IN, instance->packet);
303
304 tracker_schedule(instance);
305
306 /* set next step */
307 if ((instance->buffer_offset + instance->packet_size)
308 >= instance->buffer_size) {
309 /* that's all, end coomunication */
310 instance->next_step = tracker_call_in_and_dispose;
311 }
312}
313/*----------------------------------------------------------------------------*/
314void tracker_interrupt_out(tracker_t *instance)
315{
316 assert(instance);
317
318 /* check for errors */
319 int err = transfer_descriptor_status(instance->td);
320 if (err != EOK) {
321 tracker_call_out_and_dispose(instance);
322 return;
323 }
324
325 /* we are data out, we down't want data from our device */
326 instance->buffer_offset += instance->packet_size;
327
328 /* prepare next packet, copy data to packet */
329 instance->packet_size = MIN(instance->max_packet_size,
330 instance->buffer_size - instance->buffer_offset);
331 memcpy(instance->packet, instance->buffer + instance->buffer_offset,
332 instance->packet_size);
333
334 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
335 instance->packet_size, instance->toggle++, false, instance->target,
336 USB_PID_OUT, instance->packet);
337
338 tracker_schedule(instance);
339
340 /* set next step */
341 if ((instance->buffer_offset + instance->packet_size)
342 >= instance->buffer_size) {
343 /* that's all, end coomunication */
344 instance->next_step = tracker_call_out_and_dispose;
345 }
346}
347/*----------------------------------------------------------------------------*/
348void tracker_call_in(tracker_t *instance)
349{
350 assert(instance);
351 assert(instance->callback_in);
352
353 /* check for errors */
354 int err = transfer_descriptor_status(instance->td);
355 if (err == EOK && instance->packet_size) {
356 memcpy(instance->buffer + instance->buffer_offset, instance->packet,
357 instance->packet_size);
358 }
359 instance->buffer_offset += instance->packet_size;
360 usb_log_debug("Callback IN(%d): %d, %zu.\n", instance->transfer_type,
361 err, instance->buffer_offset);
362 instance->callback_in(instance->dev,
363 err ? USB_OUTCOME_CRCERROR : USB_OUTCOME_OK, instance->buffer_offset,
364 instance->arg);
365}
366/*----------------------------------------------------------------------------*/
367void tracker_call_out(tracker_t *instance)
368{
369 assert(instance);
370 assert(instance->callback_out);
371
372 /* check for errors */
373 int err = transfer_descriptor_status(instance->td);
374 usb_log_debug("Callback OUT(%d): %d, %zu.\n", instance->transfer_type,
375 err, instance->buffer_offset);
376 instance->callback_out(instance->dev,
377 err ? USB_OUTCOME_CRCERROR : USB_OUTCOME_OK, instance->arg);
378}
379/*----------------------------------------------------------------------------*/
380void tracker_call_in_and_dispose(tracker_t *instance)
381{
382 assert(instance);
383 tracker_call_in(instance);
384 free32(instance->td);
385 free32(instance->packet);
386 free(instance);
387}
388/*----------------------------------------------------------------------------*/
389void tracker_call_out_and_dispose(tracker_t *instance)
390{
391 assert(instance);
392 tracker_call_out(instance);
393 free32(instance->td);
394 free32(instance->packet);
395 free(instance);
396}
397/*----------------------------------------------------------------------------*/
398int tracker_schedule(tracker_t *instance)
399{
400 assert(instance);
401 uhci_t *hc = dev_to_uhci(instance->dev);
402 assert(hc);
403 return uhci_schedule(hc, instance);
404}
405/*----------------------------------------------------------------------------*/
406/* DEPRECATED FUNCTIONS NEEDED BY THE OLD API */
407void tracker_control_setup_old(tracker_t *instance)
408{
409 assert(instance);
410 assert(instance->buffer_offset == 0);
411
412 instance->packet_size = SETUP_PACKET_DATA_SIZE;
413 memcpy(instance->packet, instance->buffer, SETUP_PACKET_DATA_SIZE);
414
415 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
416 SETUP_PACKET_DATA_SIZE, 0, false, instance->target, USB_PID_SETUP,
417 instance->packet);
418
419 instance->buffer_offset += SETUP_PACKET_DATA_SIZE;
420 instance->next_step = tracker_call_out_and_dispose;
421
422 tracker_schedule(instance);
423}
424
425void tracker_control_write_data_old(tracker_t *instance)
426{
427 assert(instance);
428 assert(instance->max_packet_size == instance->buffer_size);
429
430 memcpy(instance->packet, instance->buffer, instance->max_packet_size);
431 instance->packet_size = instance->max_packet_size;
432
433 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
434 instance->packet_size, 1, false, instance->target, USB_PID_OUT,
435 instance->packet);
436 instance->next_step = tracker_call_out_and_dispose;
437
438 tracker_schedule(instance);
439}
440
441void tracker_control_read_data_old(tracker_t *instance)
442{
443 assert(instance);
444 assert(instance->max_packet_size == instance->buffer_size);
445
446 instance->packet_size = instance->max_packet_size;
447
448 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
449 instance->packet_size, 1, false, instance->target, USB_PID_IN,
450 instance->packet);
451
452 instance->next_step = tracker_call_in_and_dispose;
453
454 tracker_schedule(instance);
455}
456
457void tracker_control_write_status_old(tracker_t *instance)
458{
459 assert(instance);
460 assert(instance->max_packet_size == 0);
461 assert(instance->buffer_size == 0);
462 assert(instance->packet == NULL);
463
464 instance->packet_size = instance->max_packet_size;
465 instance->next_step = tracker_call_in_and_dispose;
466
467 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
468 instance->packet_size, 1, false, instance->target, USB_PID_IN,
469 instance->packet);
470
471 tracker_schedule(instance);
472}
473
474void tracker_control_read_status_old(tracker_t *instance)
475{
476 assert(instance);
477 assert(instance->max_packet_size == 0);
478 assert(instance->buffer_size == 0);
479 assert(instance->packet == NULL);
480
481 instance->packet_size = instance->max_packet_size;
482 instance->next_step = tracker_call_out_and_dispose;
483
484 transfer_descriptor_init(instance->td, DEFAULT_ERROR_COUNT,
485 instance->packet_size, 1, false, instance->target, USB_PID_OUT,
486 instance->packet);
487
488 tracker_schedule(instance);
489}
490/**
491 * @}
492 */
Note: See TracBrowser for help on using the repository browser.