source: mainline/uspace/lib/usbhost/include/usb/host/hcd.h@ daf59d1

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

libusbhost: Move lsit of usb device to ddf helper structure.

  • Property mode set to 100644
File size: 3.7 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
29/** @addtogroup libusbhost
30 * @{
31 */
32/** @file
33 *
34 */
35
36#ifndef LIBUSBHOST_HOST_HCD_H
37#define LIBUSBHOST_HOST_HCD_H
38
39#include <assert.h>
40#include <adt/list.h>
41#include <usbhc_iface.h>
42
43#include <usb/host/usb_device_manager.h>
44#include <usb/host/usb_endpoint_manager.h>
45#include <usb/host/usb_transfer_batch.h>
46
47typedef struct hcd hcd_t;
48
49typedef int (*schedule_hook_t)(hcd_t *, usb_transfer_batch_t *);
50typedef int (*ep_add_hook_t)(hcd_t *, endpoint_t *);
51typedef void (*ep_remove_hook_t)(hcd_t *, endpoint_t *);
52
53/** Generic host controller driver structure. */
54struct hcd {
55 /** Device manager storing handles and addresses. */
56 usb_device_manager_t dev_manager;
57 /** Endpoint manager. */
58 usb_endpoint_manager_t ep_manager;
59
60 /** Device specific driver data. */
61 void *private_data;
62 /** Transfer scheduling, implement in device driver. */
63 schedule_hook_t schedule;
64 /** Hook called upon registering new endpoint. */
65 ep_add_hook_t ep_add_hook;
66 /** Hook called upon removing of an endpoint. */
67 ep_remove_hook_t ep_remove_hook;
68};
69
70void hcd_init(hcd_t *hcd, usb_speed_t max_speed, size_t bandwidth,
71 bw_count_func_t bw_count);
72
73static inline void hcd_set_implementation(hcd_t *hcd, void *data,
74 schedule_hook_t schedule, ep_add_hook_t add_hook, ep_remove_hook_t rem_hook)
75{
76 assert(hcd);
77 hcd->private_data = data;
78 hcd->schedule = schedule;
79 hcd->ep_add_hook = add_hook;
80 hcd->ep_remove_hook = rem_hook;
81
82}
83
84/** Check registered endpoints and reset toggle bit if necessary.
85 * @param hcd hcd_t structure, non-null.
86 * @param target Control communication target.
87 * @param setup_data Setup packet of the control communication.
88 */
89static inline void reset_ep_if_need(hcd_t *hcd, usb_target_t target,
90 const char setup_data[8])
91{
92 assert(hcd);
93 usb_endpoint_manager_reset_eps_if_need(
94 &hcd->ep_manager, target, (const uint8_t *)setup_data);
95}
96
97int hcd_send_batch(
98 hcd_t *hcd, ddf_fun_t *fun, usb_target_t target, usb_direction_t direction,
99 void *data, size_t size, uint64_t setup_data,
100 usbhc_iface_transfer_in_callback_t in,
101 usbhc_iface_transfer_out_callback_t out, void *arg, const char* name);
102
103
104/** Data retrieve wrapper.
105 * @param fun ddf function, non-null.
106 * @return pointer cast to hcd_t*.
107 */
108static inline hcd_t *fun_to_hcd(ddf_fun_t *fun)
109{
110 return ddf_fun_data_get(fun);
111}
112
113
114#endif
115
116/**
117 * @}
118 */
Note: See TracBrowser for help on using the repository browser.