source: mainline/uspace/drv/uhci-hcd/iface.c@ 8f30c2e

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

Force endpoint existence for all transfers

root hub polling time to 250ms
  • Property mode set to 100644
File size: 17.8 KB
Line 
1/*
2 * Copyright (c) 2011 Vojtech Horky, 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 hc interface implementation
33 */
34#include <ddf/driver.h>
35#include <errno.h>
36
37#include <usb/debug.h>
38#include <usb/host/endpoint.h>
39
40#include "iface.h"
41#include "hc.h"
42
43/** Reserve default address interface function
44 *
45 * @param[in] fun DDF function that was called.
46 * @param[in] speed Speed to associate with the new default address.
47 * @return Error code.
48 */
49static int reserve_default_address(ddf_fun_t *fun, usb_speed_t speed)
50{
51 assert(fun);
52 hc_t *hc = fun_to_hc(fun);
53 assert(hc);
54 usb_log_debug("Default address request with speed %d.\n", speed);
55 usb_device_keeper_reserve_default_address(&hc->manager, speed);
56 return EOK;
57#if 0
58 endpoint_t *ep = malloc(sizeof(endpoint_t));
59 if (ep == NULL)
60 return ENOMEM;
61 const size_t max_packet_size = speed == USB_SPEED_LOW ? 8 : 64;
62 endpoint_init(ep, USB_TRANSFER_CONTROL, speed, max_packet_size);
63 int ret;
64try_retgister:
65 ret = usb_endpoint_manager_register_ep(&hc->ep_manager,
66 USB_ADDRESS_DEFAULT, 0, USB_DIRECTION_BOTH, ep, endpoint_destroy, 0);
67 if (ret == EEXISTS) {
68 async_usleep(1000);
69 goto try_retgister;
70 }
71 if (ret != EOK) {
72 endpoint_destroy(ep);
73 }
74 return ret;
75#endif
76}
77/*----------------------------------------------------------------------------*/
78/** Release default address interface function
79 *
80 * @param[in] fun DDF function that was called.
81 * @return Error code.
82 */
83static int release_default_address(ddf_fun_t *fun)
84{
85 assert(fun);
86 hc_t *hc = fun_to_hc(fun);
87 assert(hc);
88 usb_log_debug("Default address release.\n");
89// return usb_endpoint_manager_unregister_ep(&hc->ep_manager,
90// USB_ADDRESS_DEFAULT, 0, USB_DIRECTION_BOTH);
91 usb_device_keeper_release_default_address(&hc->manager);
92 return EOK;
93}
94/*----------------------------------------------------------------------------*/
95/** Request address interface function
96 *
97 * @param[in] fun DDF function that was called.
98 * @param[in] speed Speed to associate with the new default address.
99 * @param[out] address Place to write a new address.
100 * @return Error code.
101 */
102static int request_address(
103 ddf_fun_t *fun, usb_speed_t speed, usb_address_t *address)
104{
105 assert(fun);
106 hc_t *hc = fun_to_hc(fun);
107 assert(hc);
108 assert(address);
109
110 usb_log_debug("Address request with speed %d.\n", speed);
111 *address = device_keeper_get_free_address(&hc->manager, speed);
112 usb_log_debug("Address request with result: %d.\n", *address);
113 if (*address <= 0)
114 return *address;
115 return EOK;
116}
117/*----------------------------------------------------------------------------*/
118/** Bind address interface function
119 *
120 * @param[in] fun DDF function that was called.
121 * @param[in] address Address of the device
122 * @param[in] handle Devman handle of the device driver.
123 * @return Error code.
124 */
125static int bind_address(
126 ddf_fun_t *fun, usb_address_t address, devman_handle_t handle)
127{
128 assert(fun);
129 hc_t *hc = fun_to_hc(fun);
130 assert(hc);
131 usb_log_debug("Address bind %d-%d.\n", address, handle);
132 usb_device_keeper_bind(&hc->manager, address, handle);
133 return EOK;
134}
135/*----------------------------------------------------------------------------*/
136/** Release address interface function
137 *
138 * @param[in] fun DDF function that was called.
139 * @param[in] address USB address to be released.
140 * @return Error code.
141 */
142static int release_address(ddf_fun_t *fun, usb_address_t address)
143{
144 assert(fun);
145 hc_t *hc = fun_to_hc(fun);
146 assert(hc);
147 usb_log_debug("Address release %d.\n", address);
148 usb_device_keeper_release(&hc->manager, address);
149 return EOK;
150}
151/*----------------------------------------------------------------------------*/
152static int register_endpoint(
153 ddf_fun_t *fun, usb_address_t address, usb_endpoint_t endpoint,
154 usb_transfer_type_t transfer_type, usb_direction_t direction,
155 size_t max_packet_size, unsigned int interval)
156{
157 hc_t *hc = fun_to_hc(fun);
158 assert(hc);
159 const usb_speed_t speed =
160 usb_device_keeper_get_speed(&hc->manager, address);
161 const size_t size =
162 (transfer_type == USB_TRANSFER_INTERRUPT
163 || transfer_type == USB_TRANSFER_ISOCHRONOUS) ?
164 max_packet_size : 0;
165 int ret;
166
167 endpoint_t *ep = malloc(sizeof(endpoint_t));
168 if (ep == NULL)
169 return ENOMEM;
170 ret = endpoint_init(ep, address, endpoint, direction,
171 transfer_type, speed, max_packet_size);
172 if (ret != EOK) {
173 free(ep);
174 return ret;
175 }
176
177 usb_log_debug("Register endpoint %d:%d %s %s(%d) %zu(%zu) %u.\n",
178 address, endpoint, usb_str_transfer_type(transfer_type),
179 usb_str_speed(speed), direction, size, max_packet_size, interval);
180
181 ret = usb_endpoint_manager_register_ep(&hc->ep_manager, ep, size);
182 if (ret != EOK) {
183 endpoint_destroy(ep);
184 } else {
185 usb_device_keeper_add_ep(&hc->manager, address, ep);
186 }
187 return ret;
188}
189/*----------------------------------------------------------------------------*/
190static int unregister_endpoint(
191 ddf_fun_t *fun, usb_address_t address,
192 usb_endpoint_t endpoint, usb_direction_t direction)
193{
194 hc_t *hc = fun_to_hc(fun);
195 assert(hc);
196 usb_log_debug("Unregister endpoint %d:%d %d.\n",
197 address, endpoint, direction);
198 return usb_endpoint_manager_unregister_ep(&hc->ep_manager, address,
199 endpoint, direction);
200}
201/*----------------------------------------------------------------------------*/
202/** Interrupt out transaction interface function
203 *
204 * @param[in] fun DDF function that was called.
205 * @param[in] target USB device to write to.
206 * @param[in] max_packet_size maximum size of data packet the device accepts
207 * @param[in] data Source of data.
208 * @param[in] size Size of data source.
209 * @param[in] callback Function to call on transaction completion
210 * @param[in] arg Additional for callback function.
211 * @return Error code.
212 */
213static int interrupt_out(
214 ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data,
215 size_t size, usbhc_iface_transfer_out_callback_t callback, void *arg)
216{
217 assert(fun);
218 hc_t *hc = fun_to_hc(fun);
219 assert(hc);
220
221 usb_log_debug("Interrupt OUT %d:%d %zu(%zu).\n",
222 target.address, target.endpoint, size, max_packet_size);
223
224 size_t res_bw;
225 endpoint_t *ep = usb_endpoint_manager_get_ep(&hc->ep_manager,
226 target.address, target.endpoint, USB_DIRECTION_OUT, &res_bw);
227 if (ep == NULL) {
228 usb_log_error("Endpoint(%d:%d) not registered for INT OUT.\n",
229 target.address, target.endpoint);
230 return ENOENT;
231 }
232 const size_t bw = bandwidth_count_usb11(ep->speed, ep->transfer_type,
233 size, ep->max_packet_size);
234 if (res_bw < bw) {
235 usb_log_error("Endpoint(%d:%d) INT IN needs %zu bw "
236 "but only %zu is reserved.\n",
237 target.address, target.endpoint, bw, res_bw);
238 return ENOENT;
239 }
240 assert(ep->speed ==
241 usb_device_keeper_get_speed(&hc->manager, target.address));
242 assert(ep->max_packet_size == max_packet_size);
243 assert(ep->transfer_type == USB_TRANSFER_INTERRUPT);
244
245 usb_transfer_batch_t *batch =
246 batch_get(fun, target, ep->transfer_type, ep->max_packet_size,
247 ep->speed, data, size, NULL, 0, NULL, callback, arg, ep);
248 if (!batch)
249 return ENOMEM;
250 batch_interrupt_out(batch);
251 const int ret = hc_schedule(hc, batch);
252 if (ret != EOK) {
253 batch_dispose(batch);
254 }
255 return ret;
256}
257/*----------------------------------------------------------------------------*/
258/** Interrupt in transaction interface function
259 *
260 * @param[in] fun DDF function that was called.
261 * @param[in] target USB device to write to.
262 * @param[in] max_packet_size maximum size of data packet the device accepts
263 * @param[out] data Data destination.
264 * @param[in] size Size of data source.
265 * @param[in] callback Function to call on transaction completion
266 * @param[in] arg Additional for callback function.
267 * @return Error code.
268 */
269static int interrupt_in(
270 ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data,
271 size_t size, usbhc_iface_transfer_in_callback_t callback, void *arg)
272{
273 assert(fun);
274 hc_t *hc = fun_to_hc(fun);
275 assert(hc);
276
277 usb_log_debug("Interrupt IN %d:%d %zu(%zu).\n",
278 target.address, target.endpoint, size, max_packet_size);
279
280 size_t res_bw;
281 endpoint_t *ep = usb_endpoint_manager_get_ep(&hc->ep_manager,
282 target.address, target.endpoint, USB_DIRECTION_IN, &res_bw);
283 if (ep == NULL) {
284 usb_log_error("Endpoint(%d:%d) not registered for INT IN.\n",
285 target.address, target.endpoint);
286 return ENOENT;
287 }
288 const size_t bw = bandwidth_count_usb11(ep->speed, ep->transfer_type,
289 size, ep->max_packet_size);
290 if (res_bw < bw) {
291 usb_log_error("Endpoint(%d:%d) INT IN needs %zu bw "
292 "but only %zu bw is reserved.\n",
293 target.address, target.endpoint, bw, res_bw);
294 return ENOENT;
295 }
296
297 assert(ep->speed ==
298 usb_device_keeper_get_speed(&hc->manager, target.address));
299 assert(ep->max_packet_size == max_packet_size);
300 assert(ep->transfer_type == USB_TRANSFER_INTERRUPT);
301
302 usb_transfer_batch_t *batch =
303 batch_get(fun, target, ep->transfer_type, ep->max_packet_size,
304 ep->speed, data, size, NULL, 0, callback, NULL, arg, ep);
305 if (!batch)
306 return ENOMEM;
307 batch_interrupt_in(batch);
308 const int ret = hc_schedule(hc, batch);
309 if (ret != EOK) {
310 batch_dispose(batch);
311 }
312 return ret;
313}
314/*----------------------------------------------------------------------------*/
315/** Bulk out transaction interface function
316 *
317 * @param[in] fun DDF function that was called.
318 * @param[in] target USB device to write to.
319 * @param[in] max_packet_size maximum size of data packet the device accepts
320 * @param[in] data Source of data.
321 * @param[in] size Size of data source.
322 * @param[in] callback Function to call on transaction completion
323 * @param[in] arg Additional for callback function.
324 * @return Error code.
325 */
326static int bulk_out(
327 ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data,
328 size_t size, usbhc_iface_transfer_out_callback_t callback, void *arg)
329{
330 assert(fun);
331 hc_t *hc = fun_to_hc(fun);
332 assert(hc);
333
334 usb_log_debug("Bulk OUT %d:%d %zu(%zu).\n",
335 target.address, target.endpoint, size, max_packet_size);
336
337 endpoint_t *ep = usb_endpoint_manager_get_ep(&hc->ep_manager,
338 target.address, target.endpoint, USB_DIRECTION_OUT, NULL);
339 if (ep == NULL) {
340 usb_log_error("Endpoint(%d:%d) not registered for BULK OUT.\n",
341 target.address, target.endpoint);
342 return ENOENT;
343 }
344 assert(ep->speed ==
345 usb_device_keeper_get_speed(&hc->manager, target.address));
346 assert(ep->max_packet_size == max_packet_size);
347 assert(ep->transfer_type == USB_TRANSFER_BULK);
348
349 usb_transfer_batch_t *batch =
350 batch_get(fun, target, ep->transfer_type, ep->max_packet_size,
351 ep->speed, data, size, NULL, 0, NULL, callback, arg, ep);
352 if (!batch)
353 return ENOMEM;
354 batch_bulk_out(batch);
355 const int ret = hc_schedule(hc, batch);
356 if (ret != EOK) {
357 batch_dispose(batch);
358 }
359 return ret;
360}
361/*----------------------------------------------------------------------------*/
362/** Bulk in transaction interface function
363 *
364 * @param[in] fun DDF function that was called.
365 * @param[in] target USB device to write to.
366 * @param[in] max_packet_size maximum size of data packet the device accepts
367 * @param[out] data Data destination.
368 * @param[in] size Size of data source.
369 * @param[in] callback Function to call on transaction completion
370 * @param[in] arg Additional for callback function.
371 * @return Error code.
372 */
373static int bulk_in(
374 ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data,
375 size_t size, usbhc_iface_transfer_in_callback_t callback, void *arg)
376{
377 assert(fun);
378 hc_t *hc = fun_to_hc(fun);
379 assert(hc);
380 usb_log_debug("Bulk IN %d:%d %zu(%zu).\n",
381 target.address, target.endpoint, size, max_packet_size);
382
383 endpoint_t *ep = usb_endpoint_manager_get_ep(&hc->ep_manager,
384 target.address, target.endpoint, USB_DIRECTION_IN, NULL);
385 if (ep == NULL) {
386 usb_log_error("Endpoint(%d:%d) not registered for BULK IN.\n",
387 target.address, target.endpoint);
388 return ENOENT;
389 }
390 assert(ep->speed ==
391 usb_device_keeper_get_speed(&hc->manager, target.address));
392 assert(ep->max_packet_size == max_packet_size);
393 assert(ep->transfer_type == USB_TRANSFER_BULK);
394
395 usb_transfer_batch_t *batch =
396 batch_get(fun, target, ep->transfer_type, ep->max_packet_size,
397 ep->speed, data, size, NULL, 0, callback, NULL, arg, ep);
398 if (!batch)
399 return ENOMEM;
400 batch_bulk_in(batch);
401 const int ret = hc_schedule(hc, batch);
402 if (ret != EOK) {
403 batch_dispose(batch);
404 }
405 return ret;
406}
407/*----------------------------------------------------------------------------*/
408/** Control write transaction interface function
409 *
410 * @param[in] fun DDF function that was called.
411 * @param[in] target USB device to write to.
412 * @param[in] max_packet_size maximum size of data packet the device accepts.
413 * @param[in] setup_data Data to send with SETUP transfer.
414 * @param[in] setup_size Size of data to send with SETUP transfer (always 8B).
415 * @param[in] data Source of data.
416 * @param[in] size Size of data source.
417 * @param[in] callback Function to call on transaction completion.
418 * @param[in] arg Additional for callback function.
419 * @return Error code.
420 */
421static int control_write(
422 ddf_fun_t *fun, usb_target_t target, size_t max_packet_size,
423 void *setup_data, size_t setup_size, void *data, size_t size,
424 usbhc_iface_transfer_out_callback_t callback, void *arg)
425{
426 assert(fun);
427 hc_t *hc = fun_to_hc(fun);
428 assert(hc);
429
430 usb_log_debug("Control WRITE %d:%d %zu(%zu).\n",
431 target.address, target.endpoint, size, max_packet_size);
432
433 endpoint_t *ep = usb_endpoint_manager_get_ep(&hc->ep_manager,
434 target.address, target.endpoint, USB_DIRECTION_BOTH, NULL);
435 if (ep == NULL) {
436 usb_log_error("Endpoint(%d:%d) not registered for CONTROL.\n",
437 target.address, target.endpoint);
438 return ENOENT;
439 }
440 assert(ep->speed ==
441 usb_device_keeper_get_speed(&hc->manager, target.address));
442 assert(ep->max_packet_size == max_packet_size);
443 assert(ep->transfer_type == USB_TRANSFER_CONTROL);
444
445 if (setup_size != 8)
446 return EINVAL;
447
448 usb_transfer_batch_t *batch =
449 batch_get(fun, target, ep->transfer_type, ep->max_packet_size,
450 ep->speed, data, size, setup_data, setup_size, NULL, callback,
451 arg, ep);
452 if (!batch)
453 return ENOMEM;
454 usb_device_keeper_reset_if_need(&hc->manager, target, setup_data);
455 batch_control_write(batch);
456 const int ret = hc_schedule(hc, batch);
457 if (ret != EOK) {
458 batch_dispose(batch);
459 }
460 return ret;
461}
462/*----------------------------------------------------------------------------*/
463/** Control read transaction interface function
464 *
465 * @param[in] fun DDF function that was called.
466 * @param[in] target USB device to write to.
467 * @param[in] max_packet_size maximum size of data packet the device accepts.
468 * @param[in] setup_data Data to send with SETUP packet.
469 * @param[in] setup_size Size of data to send with SETUP packet (should be 8B).
470 * @param[out] data Source of data.
471 * @param[in] size Size of data source.
472 * @param[in] callback Function to call on transaction completion.
473 * @param[in] arg Additional for callback function.
474 * @return Error code.
475 */
476static int control_read(
477 ddf_fun_t *fun, usb_target_t target, size_t max_packet_size,
478 void *setup_data, size_t setup_size, void *data, size_t size,
479 usbhc_iface_transfer_in_callback_t callback, void *arg)
480{
481 assert(fun);
482 hc_t *hc = fun_to_hc(fun);
483 assert(hc);
484
485 usb_log_debug("Control READ %d:%d %zu(%zu).\n",
486 target.address, target.endpoint, size, max_packet_size);
487
488 endpoint_t *ep = usb_endpoint_manager_get_ep(&hc->ep_manager,
489 target.address, target.endpoint, USB_DIRECTION_BOTH, NULL);
490 if (ep == NULL) {
491 usb_log_error("Endpoint(%d:%d) not registered for CONTROL.\n",
492 target.address, target.endpoint);
493 return ENOENT;
494 }
495 assert(ep->speed ==
496 usb_device_keeper_get_speed(&hc->manager, target.address));
497 assert(ep->max_packet_size == max_packet_size);
498 assert(ep->transfer_type == USB_TRANSFER_CONTROL);
499
500 usb_transfer_batch_t *batch =
501 batch_get(fun, target, ep->transfer_type, ep->max_packet_size,
502 ep->speed, data, size, setup_data, setup_size,
503 callback, NULL, arg, ep);
504 if (!batch)
505 return ENOMEM;
506 batch_control_read(batch);
507 const int ret = hc_schedule(hc, batch);
508 if (ret != EOK) {
509 batch_dispose(batch);
510 }
511 return ret;
512}
513/*----------------------------------------------------------------------------*/
514usbhc_iface_t hc_iface = {
515 .reserve_default_address = reserve_default_address,
516 .release_default_address = release_default_address,
517 .request_address = request_address,
518 .bind_address = bind_address,
519 .release_address = release_address,
520
521 .register_endpoint = register_endpoint,
522 .unregister_endpoint = unregister_endpoint,
523
524 .interrupt_out = interrupt_out,
525 .interrupt_in = interrupt_in,
526
527 .bulk_out = bulk_out,
528 .bulk_in = bulk_in,
529
530 .control_write = control_write,
531 .control_read = control_read,
532};
533/**
534 * @}
535 */
Note: See TracBrowser for help on using the repository browser.