source: mainline/uspace/drv/bus/usb/ehci/main.c@ fc0271a5

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since fc0271a5 was e4d7363, checked in by Ondřej Hlavatý <aearsis@…>, 8 years ago

usbhost: refactor the initialization

Before that, drivers had to setup MMIO range multiple times, or even parse hw
resources themselves again. The former init method was split in half - init and
start. Init shall allocate and initialize inner structures, start shall start
the HC.

In the XHCI it is demonstrated how to isolate inner HC implementation from the
fact this driver is using libusbhost. It adds some boilerplate code, but
I think it leads to cleaner design.

  • Property mode set to 100644
File size: 4.2 KB
Line 
1/*
2 * Copyright (c) 2011 Jan Vesely
3 * Copyright (c) 2011 Vojtech Horky
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
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.
17 *
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.
28 */
29
30/** @addtogroup drvusbehci
31 * @{
32 */
33/** @file
34 * Main routines of EHCI driver.
35 */
36
37#include <ddf/driver.h>
38#include <ddf/interrupt.h>
39#include <device/hw_res.h>
40#include <errno.h>
41#include <str_error.h>
42#include <io/logctl.h>
43
44#include <usb_iface.h>
45#include <usb/debug.h>
46#include <usb/host/ddf_helpers.h>
47
48#include "res.h"
49#include "hc.h"
50#include "ehci_endpoint.h"
51
52#define NAME "ehci"
53
54static int ehci_driver_init(hcd_t *, const hw_res_list_parsed_t *);
55static int ehci_driver_claim(hcd_t *, ddf_dev_t *);
56static int ehci_driver_start(hcd_t *, bool);
57static void ehci_driver_fini(hcd_t *);
58
59static const ddf_hc_driver_t ehci_hc_driver = {
60 .hc_speed = USB_SPEED_HIGH,
61 .name = "EHCI-PCI",
62 .init = ehci_driver_init,
63 .irq_code_gen = ehci_hc_gen_irq_code,
64 .claim = ehci_driver_claim,
65 .start = ehci_driver_start,
66 .fini = ehci_driver_fini,
67 .ops = {
68 .schedule = ehci_hc_schedule,
69 .ep_add_hook = ehci_endpoint_init,
70 .ep_remove_hook = ehci_endpoint_fini,
71 .irq_hook = ehci_hc_interrupt,
72 .status_hook = ehci_hc_status,
73 }
74};
75
76
77static int ehci_driver_init(hcd_t *hcd, const hw_res_list_parsed_t *res)
78{
79 assert(hcd);
80 assert(hcd_get_driver_data(hcd) == NULL);
81
82 hc_t *instance = malloc(sizeof(hc_t));
83 if (!instance)
84 return ENOMEM;
85
86 const int ret = hc_init(instance, res);
87 if (ret == EOK) {
88 hcd_set_implementation(hcd, instance, &ehci_hc_driver.ops);
89 } else {
90 free(instance);
91 }
92 return ret;
93}
94
95static int ehci_driver_claim(hcd_t *hcd, ddf_dev_t *dev)
96{
97 hc_t *instance = hcd_get_driver_data(hcd);
98 assert(instance);
99
100 return disable_legacy(instance, dev);
101}
102
103static int ehci_driver_start(hcd_t *hcd, bool irq) {
104 hc_t *instance = hcd_get_driver_data(hcd);
105 assert(instance);
106
107 return hc_start(instance, irq);
108}
109
110static void ehci_driver_fini(hcd_t *hcd)
111{
112 assert(hcd);
113 hc_t *hc = hcd_get_driver_data(hcd);
114 if (hc)
115 hc_fini(hc);
116
117 free(hc);
118 hcd_set_implementation(hcd, NULL, NULL);
119}
120
121/** Initializes a new ddf driver instance of EHCI hcd.
122 *
123 * @param[in] device DDF instance of the device to initialize.
124 * @return Error code.
125 */
126static int ehci_dev_add(ddf_dev_t *device)
127{
128 usb_log_debug("ehci_dev_add() called\n");
129 assert(device);
130
131 return hcd_ddf_add_hc(device, &ehci_hc_driver);
132
133}
134
135
136static const driver_ops_t ehci_driver_ops = {
137 .dev_add = ehci_dev_add,
138};
139
140static const driver_t ehci_driver = {
141 .name = NAME,
142 .driver_ops = &ehci_driver_ops
143};
144
145
146/** Initializes global driver structures (NONE).
147 *
148 * @param[in] argc Nmber of arguments in argv vector (ignored).
149 * @param[in] argv Cmdline argument vector (ignored).
150 * @return Error code.
151 *
152 * Driver debug level is set here.
153 */
154int main(int argc, char *argv[])
155{
156 log_init(NAME);
157 logctl_set_log_level(NAME, LVL_NOTE);
158 return ddf_driver_main(&ehci_driver);
159}
160
161/**
162 * @}
163 */
Note: See TracBrowser for help on using the repository browser.