2 * Copyright (c) 2011 Jan Vesely
3 * Copyright (c) 2018 Ondrej Hlavaty
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * - Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * - The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 /** @addtogroup libusbhost
37 #ifndef LIBUSBHOST_HOST_HCD_H
38 #define LIBUSBHOST_HOST_HCD_H
41 #include <ddf/driver.h>
42 #include <usb/request.h>
44 typedef struct hw_resource_list_parsed hw_res_list_parsed_t
;
45 typedef struct bus bus_t
;
46 typedef struct device device_t
;
49 * Treat this header as read-only in driver code.
50 * It could be opaque, but why to complicate matters.
52 typedef struct hc_device
{
56 /* Managed DDF device */
59 /* Control function */
62 /* IRQ capability handle of the subscribed IRQ code */
63 cap_irq_handle_t irq_handle
;
65 /** Interrupt replacement fibril */
68 /* This structure is meant to be extended by driver code. */
71 typedef struct hc_driver
{
74 /** Size of the device data to be allocated, and passed as the
77 size_t hc_device_size
;
79 /** Initialize device structures. */
80 int (*hc_add
)(hc_device_t
*, const hw_res_list_parsed_t
*);
82 /** Generate IRQ code to handle interrupts. */
83 int (*irq_code_gen
)(irq_code_t
*, hc_device_t
*,
84 const hw_res_list_parsed_t
*, int *);
86 /** Claim device from BIOS. */
87 int (*claim
)(hc_device_t
*);
89 /** Start the host controller. */
90 int (*start
)(hc_device_t
*);
92 /** Setup the virtual roothub. */
93 int (*setup_root_hub
)(hc_device_t
*);
95 /** Stop the host controller (after start has been called) */
96 int (*stop
)(hc_device_t
*);
98 /** HC was asked to be removed (after hc_add has been called) */
99 int (*hc_remove
)(hc_device_t
*);
102 int (*hc_gone
)(hc_device_t
*);
105 /* Drivers should call this before leaving hc_add */
106 static inline void hc_device_setup(hc_device_t
*hcd
, bus_t
*bus
)
111 static inline hc_device_t
*dev_to_hcd(ddf_dev_t
*dev
)
113 return ddf_dev_data_get(dev
);
116 extern errno_t
hc_driver_main(const hc_driver_t
*);