| 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 drvusbuhci
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /** @file
|
|---|
| 33 | * @brief UHCI driver
|
|---|
| 34 | */
|
|---|
| 35 | #include <errno.h>
|
|---|
| 36 | #include <str_error.h>
|
|---|
| 37 | #include <ddf/interrupt.h>
|
|---|
| 38 | #include <usb_iface.h>
|
|---|
| 39 | #include <usb/ddfiface.h>
|
|---|
| 40 | #include <usb/debug.h>
|
|---|
| 41 |
|
|---|
| 42 | #include "uhci.h"
|
|---|
| 43 | #include "iface.h"
|
|---|
| 44 | #include "pci.h"
|
|---|
| 45 |
|
|---|
| 46 | #include "hc.h"
|
|---|
| 47 | #include "root_hub.h"
|
|---|
| 48 |
|
|---|
| 49 | /** Structure representing both functions of UHCI hc, USB host controller
|
|---|
| 50 | * and USB root hub */
|
|---|
| 51 | typedef struct uhci {
|
|---|
| 52 | /** Pointer to DDF represenation of UHCI host controller */
|
|---|
| 53 | ddf_fun_t *hc_fun;
|
|---|
| 54 | /** Pointer to DDF represenation of UHCI root hub */
|
|---|
| 55 | ddf_fun_t *rh_fun;
|
|---|
| 56 |
|
|---|
| 57 | /** Internal driver's represenation of UHCI host controller */
|
|---|
| 58 | hc_t hc;
|
|---|
| 59 | /** Internal driver's represenation of UHCI root hub */
|
|---|
| 60 | rh_t rh;
|
|---|
| 61 | } uhci_t;
|
|---|
| 62 |
|
|---|
| 63 | static inline uhci_t * dev_to_uhci(ddf_dev_t *dev)
|
|---|
| 64 | {
|
|---|
| 65 | assert(dev);
|
|---|
| 66 | assert(dev->driver_data);
|
|---|
| 67 | return dev->driver_data;
|
|---|
| 68 | }
|
|---|
| 69 | /*----------------------------------------------------------------------------*/
|
|---|
| 70 | /** IRQ handling callback, forward status from call to diver structure.
|
|---|
| 71 | *
|
|---|
| 72 | * @param[in] dev DDF instance of the device to use.
|
|---|
| 73 | * @param[in] iid (Unused).
|
|---|
| 74 | * @param[in] call Pointer to the call from kernel.
|
|---|
| 75 | */
|
|---|
| 76 | static void irq_handler(ddf_dev_t *dev, ipc_callid_t iid, ipc_call_t *call)
|
|---|
| 77 | {
|
|---|
| 78 | assert(dev);
|
|---|
| 79 | uhci_t *uhci = dev->driver_data;
|
|---|
| 80 | assert(uhci);
|
|---|
| 81 | hc_t *hc = &uhci->hc;
|
|---|
| 82 | uint16_t status = IPC_GET_ARG1(*call);
|
|---|
| 83 | assert(hc);
|
|---|
| 84 | hc_interrupt(hc, status);
|
|---|
| 85 | }
|
|---|
| 86 | /*----------------------------------------------------------------------------*/
|
|---|
| 87 | /** Get address of the device identified by handle.
|
|---|
| 88 | *
|
|---|
| 89 | * @param[in] fun DDF instance of the function to use.
|
|---|
| 90 | * @param[in] handle DDF handle of the driver seeking its USB address.
|
|---|
| 91 | * @param[out] address Found address.
|
|---|
| 92 | */
|
|---|
| 93 | static int usb_iface_get_address(
|
|---|
| 94 | ddf_fun_t *fun, devman_handle_t handle, usb_address_t *address)
|
|---|
| 95 | {
|
|---|
| 96 | assert(fun);
|
|---|
| 97 | usb_device_keeper_t *manager = &dev_to_uhci(fun->dev)->hc.manager;
|
|---|
| 98 | usb_address_t addr = usb_device_keeper_find(manager, handle);
|
|---|
| 99 |
|
|---|
| 100 | if (addr < 0) {
|
|---|
| 101 | return addr;
|
|---|
| 102 | }
|
|---|
| 103 |
|
|---|
| 104 | if (address != NULL) {
|
|---|
| 105 | *address = addr;
|
|---|
| 106 | }
|
|---|
| 107 |
|
|---|
| 108 | return EOK;
|
|---|
| 109 | }
|
|---|
| 110 | /*----------------------------------------------------------------------------*/
|
|---|
| 111 | /** Gets handle of the respective hc.
|
|---|
| 112 | *
|
|---|
| 113 | * @param[in] fun DDF function of uhci device.
|
|---|
| 114 | * @param[out] handle Host cotnroller handle.
|
|---|
| 115 | * @return Error code.
|
|---|
| 116 | */
|
|---|
| 117 | static int usb_iface_get_hc_handle(
|
|---|
| 118 | ddf_fun_t *fun, devman_handle_t *handle)
|
|---|
| 119 | {
|
|---|
| 120 | assert(fun);
|
|---|
| 121 | ddf_fun_t *hc_fun = dev_to_uhci(fun->dev)->hc_fun;
|
|---|
| 122 | assert(hc_fun);
|
|---|
| 123 |
|
|---|
| 124 | if (handle != NULL)
|
|---|
| 125 | *handle = hc_fun->handle;
|
|---|
| 126 | return EOK;
|
|---|
| 127 | }
|
|---|
| 128 | /*----------------------------------------------------------------------------*/
|
|---|
| 129 | /** USB interface implementation used by RH */
|
|---|
| 130 | static usb_iface_t usb_iface = {
|
|---|
| 131 | .get_hc_handle = usb_iface_get_hc_handle,
|
|---|
| 132 | .get_address = usb_iface_get_address
|
|---|
| 133 | };
|
|---|
| 134 | /*----------------------------------------------------------------------------*/
|
|---|
| 135 | /** Operations supported by the HC driver */
|
|---|
| 136 | static ddf_dev_ops_t hc_ops = {
|
|---|
| 137 | .interfaces[USBHC_DEV_IFACE] = &hc_iface, /* see iface.h/c */
|
|---|
| 138 | };
|
|---|
| 139 | /*----------------------------------------------------------------------------*/
|
|---|
| 140 | /** Get root hub hw resources (I/O registers).
|
|---|
| 141 | *
|
|---|
| 142 | * @param[in] fun Root hub function.
|
|---|
| 143 | * @return Pointer to the resource list used by the root hub.
|
|---|
| 144 | */
|
|---|
| 145 | static hw_resource_list_t *get_resource_list(ddf_fun_t *fun)
|
|---|
| 146 | {
|
|---|
| 147 | assert(fun);
|
|---|
| 148 | rh_t *rh = fun->driver_data;
|
|---|
| 149 | assert(rh);
|
|---|
| 150 | return &rh->resource_list;
|
|---|
| 151 | }
|
|---|
| 152 | /*----------------------------------------------------------------------------*/
|
|---|
| 153 | /** Interface to provide the root hub driver with hw info */
|
|---|
| 154 | static hw_res_ops_t hw_res_iface = {
|
|---|
| 155 | .get_resource_list = get_resource_list,
|
|---|
| 156 | .enable_interrupt = NULL,
|
|---|
| 157 | };
|
|---|
| 158 | /*----------------------------------------------------------------------------*/
|
|---|
| 159 | /** RH function support for uhci-rhd */
|
|---|
| 160 | static ddf_dev_ops_t rh_ops = {
|
|---|
| 161 | .interfaces[USB_DEV_IFACE] = &usb_iface,
|
|---|
| 162 | .interfaces[HW_RES_DEV_IFACE] = &hw_res_iface
|
|---|
| 163 | };
|
|---|
| 164 | /*----------------------------------------------------------------------------*/
|
|---|
| 165 | /** Initialize hc and rh DDF structures and their respective drivers.
|
|---|
| 166 | *
|
|---|
| 167 | * @param[in] device DDF instance of the device to use.
|
|---|
| 168 | *
|
|---|
| 169 | * This function does all the preparatory work for hc and rh drivers:
|
|---|
| 170 | * - gets device's hw resources
|
|---|
| 171 | * - disables UHCI legacy support (PCI config space)
|
|---|
| 172 | * - attempts to enable interrupts
|
|---|
| 173 | * - registers interrupt handler
|
|---|
| 174 | */
|
|---|
| 175 | int device_setup_uhci(ddf_dev_t *device)
|
|---|
| 176 | {
|
|---|
| 177 | assert(device);
|
|---|
| 178 | uhci_t *instance = malloc(sizeof(uhci_t));
|
|---|
| 179 | if (instance == NULL) {
|
|---|
| 180 | usb_log_error("Failed to allocate OHCI driver.\n");
|
|---|
| 181 | return ENOMEM;
|
|---|
| 182 | }
|
|---|
| 183 |
|
|---|
| 184 | #define CHECK_RET_DEST_FREE_RETURN(ret, message...) \
|
|---|
| 185 | if (ret != EOK) { \
|
|---|
| 186 | if (instance->hc_fun) \
|
|---|
| 187 | instance->hc_fun->ops = NULL; \
|
|---|
| 188 | instance->hc_fun->driver_data = NULL; \
|
|---|
| 189 | ddf_fun_destroy(instance->hc_fun); \
|
|---|
| 190 | if (instance->rh_fun) {\
|
|---|
| 191 | instance->rh_fun->ops = NULL; \
|
|---|
| 192 | instance->rh_fun->driver_data = NULL; \
|
|---|
| 193 | ddf_fun_destroy(instance->rh_fun); \
|
|---|
| 194 | } \
|
|---|
| 195 | free(instance); \
|
|---|
| 196 | usb_log_error(message); \
|
|---|
| 197 | return ret; \
|
|---|
| 198 | } else (void)0
|
|---|
| 199 |
|
|---|
| 200 | instance->rh_fun = NULL;
|
|---|
| 201 | instance->hc_fun = ddf_fun_create(device, fun_exposed, "uhci-hc");
|
|---|
| 202 | int ret = (instance->hc_fun == NULL) ? ENOMEM : EOK;
|
|---|
| 203 | CHECK_RET_DEST_FREE_RETURN(ret, "Failed to create UHCI HC function.\n");
|
|---|
| 204 | instance->hc_fun->ops = &hc_ops;
|
|---|
| 205 | instance->hc_fun->driver_data = &instance->hc;
|
|---|
| 206 |
|
|---|
| 207 | instance->rh_fun = ddf_fun_create(device, fun_inner, "uhci-rh");
|
|---|
| 208 | ret = (instance->rh_fun == NULL) ? ENOMEM : EOK;
|
|---|
| 209 | CHECK_RET_DEST_FREE_RETURN(ret, "Failed to create UHCI RH function.\n");
|
|---|
| 210 | instance->rh_fun->ops = &rh_ops;
|
|---|
| 211 | instance->rh_fun->driver_data = &instance->rh;
|
|---|
| 212 |
|
|---|
| 213 | uintptr_t reg_base = 0;
|
|---|
| 214 | size_t reg_size = 0;
|
|---|
| 215 | int irq = 0;
|
|---|
| 216 |
|
|---|
| 217 | ret = pci_get_my_registers(device, ®_base, ®_size, &irq);
|
|---|
| 218 | CHECK_RET_DEST_FREE_RETURN(ret,
|
|---|
| 219 | "Failed to get I/O addresses for %" PRIun ": %s.\n",
|
|---|
| 220 | device->handle, str_error(ret));
|
|---|
| 221 | usb_log_debug("I/O regs at 0x%p (size %zu), IRQ %d.\n",
|
|---|
| 222 | (void *) reg_base, reg_size, irq);
|
|---|
| 223 |
|
|---|
| 224 | ret = pci_disable_legacy(device);
|
|---|
| 225 | CHECK_RET_DEST_FREE_RETURN(ret,
|
|---|
| 226 | "Failed(%d) to disable legacy USB: %s.\n", ret, str_error(ret));
|
|---|
| 227 |
|
|---|
| 228 | bool interrupts = false;
|
|---|
| 229 | #ifdef CONFIG_USBHC_NO_INTERRUPTS
|
|---|
| 230 | usb_log_warning("Interrupts disabled in OS config, " \
|
|---|
| 231 | "falling back to polling.\n");
|
|---|
| 232 | #else
|
|---|
| 233 | ret = pci_enable_interrupts(device);
|
|---|
| 234 | if (ret != EOK) {
|
|---|
| 235 | usb_log_warning("Failed to enable interrupts: %s.\n",
|
|---|
| 236 | str_error(ret));
|
|---|
| 237 | usb_log_info("HW interrupts not available, " \
|
|---|
| 238 | "falling back to polling.\n");
|
|---|
| 239 | } else {
|
|---|
| 240 | usb_log_debug("Hw interrupts enabled.\n");
|
|---|
| 241 | interrupts = true;
|
|---|
| 242 | }
|
|---|
| 243 | #endif
|
|---|
| 244 |
|
|---|
| 245 |
|
|---|
| 246 | ret = hc_init(&instance->hc, (void*)reg_base, reg_size, interrupts);
|
|---|
| 247 | CHECK_RET_DEST_FREE_RETURN(ret,
|
|---|
| 248 | "Failed(%d) to init uhci-hcd: %s.\n", ret, str_error(ret));
|
|---|
| 249 |
|
|---|
| 250 | #define CHECK_RET_FINI_RETURN(ret, message...) \
|
|---|
| 251 | if (ret != EOK) { \
|
|---|
| 252 | hc_fini(&instance->hc); \
|
|---|
| 253 | CHECK_RET_DEST_FREE_RETURN(ret, message); \
|
|---|
| 254 | return ret; \
|
|---|
| 255 | } else (void)0
|
|---|
| 256 |
|
|---|
| 257 | /* It does no harm if we register this on polling */
|
|---|
| 258 | ret = register_interrupt_handler(device, irq, irq_handler,
|
|---|
| 259 | &instance->hc.interrupt_code);
|
|---|
| 260 | CHECK_RET_FINI_RETURN(ret,
|
|---|
| 261 | "Failed(%d) to register interrupt handler: %s.\n",
|
|---|
| 262 | ret, str_error(ret));
|
|---|
| 263 |
|
|---|
| 264 | ret = ddf_fun_bind(instance->hc_fun);
|
|---|
| 265 | CHECK_RET_FINI_RETURN(ret,
|
|---|
| 266 | "Failed(%d) to bind UHCI device function: %s.\n",
|
|---|
| 267 | ret, str_error(ret));
|
|---|
| 268 |
|
|---|
| 269 | ret = ddf_fun_add_to_class(instance->hc_fun, USB_HC_DDF_CLASS_NAME);
|
|---|
| 270 | CHECK_RET_FINI_RETURN(ret,
|
|---|
| 271 | "Failed to add UHCI to HC class: %s.\n", str_error(ret));
|
|---|
| 272 |
|
|---|
| 273 | ret = rh_init(&instance->rh, instance->rh_fun,
|
|---|
| 274 | (uintptr_t)instance->hc.registers + 0x10, 4);
|
|---|
| 275 | CHECK_RET_FINI_RETURN(ret,
|
|---|
| 276 | "Failed(%d) to setup UHCI root hub: %s.\n", ret, str_error(ret));
|
|---|
| 277 |
|
|---|
| 278 | ret = ddf_fun_bind(instance->rh_fun);
|
|---|
| 279 | CHECK_RET_FINI_RETURN(ret,
|
|---|
| 280 | "Failed(%d) to register UHCI root hub: %s.\n", ret, str_error(ret));
|
|---|
| 281 |
|
|---|
| 282 | device->driver_data = instance;
|
|---|
| 283 | return EOK;
|
|---|
| 284 | #undef CHECK_RET_FINI_RETURN
|
|---|
| 285 | }
|
|---|
| 286 | /**
|
|---|
| 287 | * @}
|
|---|
| 288 | */
|
|---|
