1/*- 2 * Copyright (c) 2008 Sam Leffler. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 16 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 19 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 20 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 23 */ 24 25/* 26 * IXP435 attachment driver for the USB Enhanced Host Controller. 27 */ 28 29#include <sys/cdefs.h> 30__FBSDID("$FreeBSD$"); 31 32#include "opt_bus.h" 33 34#include <sys/stdint.h> 35#include <sys/stddef.h> 36#include <sys/param.h> 37#include <sys/queue.h> 38#include <sys/types.h> 39#include <sys/systm.h> 40#include <sys/kernel.h> 41#include <sys/bus.h> 42#include <sys/module.h> 43#include <sys/lock.h> 44#include <sys/mutex.h> 45#include <sys/condvar.h> 46#include <sys/sysctl.h> 47#include <sys/sx.h> 48#include <sys/unistd.h> 49#include <sys/callout.h> 50#include <sys/malloc.h> 51#include <sys/priv.h> 52 53#include <dev/usb/usb.h> 54#include <dev/usb/usbdi.h> 55 56#include <dev/usb/usb_core.h> 57#include <dev/usb/usb_busdma.h> 58#include <dev/usb/usb_process.h> 59#include <dev/usb/usb_util.h> 60 61#include <dev/usb/usb_controller.h> 62#include <dev/usb/usb_bus.h> 63#include <dev/usb/controller/ehci.h> 64#include <dev/usb/controller/ehcireg.h> 65 66#include <arm/xscale/ixp425/ixp425reg.h> 67#include <arm/xscale/ixp425/ixp425var.h> 68 69#define EHCI_VENDORID_IXP4XX 0x42fa05 70#define EHCI_HC_DEVSTR "IXP4XX Integrated USB 2.0 controller" 71 72struct ixp_ehci_softc { 73 ehci_softc_t base; /* storage for EHCI code */ 74 bus_space_tag_t iot; 75 bus_space_handle_t ioh; 76 struct bus_space tag; /* tag for private bus space ops */ 77}; 78 79static device_attach_t ehci_ixp_attach; 80static device_detach_t ehci_ixp_detach; 81 82static uint8_t ehci_bs_r_1(void *, bus_space_handle_t, bus_size_t); 83static void ehci_bs_w_1(void *, bus_space_handle_t, bus_size_t, u_int8_t); 84static uint16_t ehci_bs_r_2(void *, bus_space_handle_t, bus_size_t); 85static void ehci_bs_w_2(void *, bus_space_handle_t, bus_size_t, uint16_t); 86static uint32_t ehci_bs_r_4(void *, bus_space_handle_t, bus_size_t); 87static void ehci_bs_w_4(void *, bus_space_handle_t, bus_size_t, uint32_t); 88 89static int 90ehci_ixp_probe(device_t self) 91{ 92 93 device_set_desc(self, EHCI_HC_DEVSTR); 94 95 return (BUS_PROBE_DEFAULT); 96} 97 98static int 99ehci_ixp_attach(device_t self) 100{ 101 struct ixp_ehci_softc *isc = device_get_softc(self); 102 ehci_softc_t *sc = &isc->base; 103 int err; 104 int rid; 105 106 /* initialise some bus fields */ 107 sc->sc_bus.parent = self; 108 sc->sc_bus.devices = sc->sc_devices; 109 sc->sc_bus.devices_max = EHCI_MAX_DEVICES; 110 111 /* get all DMA memory */ 112 if (usb_bus_mem_alloc_all(&sc->sc_bus, 113 USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) { 114 return (ENOMEM); 115 } 116 117 /* NB: hints fix the memory location and irq */ 118 119 rid = 0; 120 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, RF_ACTIVE); 121 if (!sc->sc_io_res) { 122 device_printf(self, "Could not map memory\n"); 123 goto error; 124 } 125 126 /* 127 * Craft special resource for bus space ops that handle 128 * byte-alignment of non-word addresses. Also, since 129 * we're already intercepting bus space ops we handle 130 * the register window offset that could otherwise be 131 * done with bus_space_subregion. 132 */ 133 isc->iot = rman_get_bustag(sc->sc_io_res); 134 isc->tag.bs_cookie = isc->iot; 135 /* read single */ 136 isc->tag.bs_r_1 = ehci_bs_r_1, 137 isc->tag.bs_r_2 = ehci_bs_r_2, 138 isc->tag.bs_r_4 = ehci_bs_r_4, 139 /* write (single) */ 140 isc->tag.bs_w_1 = ehci_bs_w_1, 141 isc->tag.bs_w_2 = ehci_bs_w_2, 142 isc->tag.bs_w_4 = ehci_bs_w_4, 143 144 sc->sc_io_tag = &isc->tag; 145 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res); 146 sc->sc_io_size = IXP435_USB1_SIZE - 0x100; 147 148 rid = 0; 149 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 150 RF_ACTIVE); 151 if (sc->sc_irq_res == NULL) { 152 device_printf(self, "Could not allocate irq\n"); 153 goto error; 154 } 155 sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 156 if (!sc->sc_bus.bdev) { 157 device_printf(self, "Could not add USB device\n"); 158 goto error; 159 } 160 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 161 device_set_desc(sc->sc_bus.bdev, EHCI_HC_DEVSTR); 162 163 sprintf(sc->sc_vendor, "Intel"); 164 165 166 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 167 NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl); 168 if (err) { 169 device_printf(self, "Could not setup irq, %d\n", err); 170 sc->sc_intr_hdl = NULL; 171 goto error; 172 } 173 174 /* 175 * Arrange to force Host mode, select big-endian byte alignment, 176 * and arrange to not terminate reset operations (the adapter 177 * will ignore it if we do but might as well save a reg write). 178 * Also, the controller has an embedded Transaction Translator 179 * which means port speed must be read from the Port Status 180 * register following a port enable. 181 */ 182 sc->sc_flags |= EHCI_SCFLG_TT 183 | EHCI_SCFLG_SETMODE 184 | EHCI_SCFLG_BIGEDESC 185 | EHCI_SCFLG_BIGEMMIO 186 | EHCI_SCFLG_NORESTERM 187 ; 188 189 err = ehci_init(sc); 190 if (!err) { 191 err = device_probe_and_attach(sc->sc_bus.bdev); 192 } 193 if (err) { 194 device_printf(self, "USB init failed err=%d\n", err); 195 goto error; 196 } 197 return (0); 198 199error: 200 ehci_ixp_detach(self); 201 return (ENXIO); 202} 203 204static int 205ehci_ixp_detach(device_t self) 206{ 207 struct ixp_ehci_softc *isc = device_get_softc(self); 208 ehci_softc_t *sc = &isc->base; 209 device_t bdev; 210 int err; 211 212 if (sc->sc_bus.bdev) { 213 bdev = sc->sc_bus.bdev; 214 device_detach(bdev); 215 device_delete_child(self, bdev); 216 } 217 /* during module unload there are lots of children leftover */ 218 device_delete_children(self); 219 220 if (sc->sc_irq_res && sc->sc_intr_hdl) { 221 /* 222 * only call ehci_detach() after ehci_init() 223 */ 224 ehci_detach(sc); 225 226 err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 227 228 if (err) 229 /* XXX or should we panic? */ 230 device_printf(self, "Could not tear down irq, %d\n", 231 err); 232 sc->sc_intr_hdl = NULL; 233 } 234 235 if (sc->sc_irq_res) { 236 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 237 sc->sc_irq_res = NULL; 238 } 239 if (sc->sc_io_res) { 240 bus_release_resource(self, SYS_RES_MEMORY, 0, 241 sc->sc_io_res); 242 sc->sc_io_res = NULL; 243 } 244 usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc); 245 246 return (0); 247} 248 249/* 250 * Bus space accessors for PIO operations. 251 */ 252 253static uint8_t 254ehci_bs_r_1(void *t, bus_space_handle_t h, bus_size_t o) 255{ 256 return bus_space_read_1((bus_space_tag_t) t, h, 257 0x100 + (o &~ 3) + (3 - (o & 3))); 258} 259 260static void 261ehci_bs_w_1(void *t, bus_space_handle_t h, bus_size_t o, u_int8_t v) 262{ 263 panic("%s", __func__); 264} 265 266static uint16_t 267ehci_bs_r_2(void *t, bus_space_handle_t h, bus_size_t o) 268{ 269 return bus_space_read_2((bus_space_tag_t) t, h, 270 0x100 + (o &~ 3) + (2 - (o & 3))); 271} 272 273static void 274ehci_bs_w_2(void *t, bus_space_handle_t h, bus_size_t o, uint16_t v) 275{ 276 panic("%s", __func__); 277} 278 279static uint32_t 280ehci_bs_r_4(void *t, bus_space_handle_t h, bus_size_t o) 281{ 282 return bus_space_read_4((bus_space_tag_t) t, h, 0x100 + o); 283} 284 285static void 286ehci_bs_w_4(void *t, bus_space_handle_t h, bus_size_t o, uint32_t v) 287{ 288 bus_space_write_4((bus_space_tag_t) t, h, 0x100 + o, v); 289} 290 291static device_method_t ehci_methods[] = { 292 /* Device interface */ 293 DEVMETHOD(device_probe, ehci_ixp_probe), 294 DEVMETHOD(device_attach, ehci_ixp_attach), 295 DEVMETHOD(device_detach, ehci_ixp_detach), 296 DEVMETHOD(device_suspend, bus_generic_suspend), 297 DEVMETHOD(device_resume, bus_generic_resume), 298 DEVMETHOD(device_shutdown, bus_generic_shutdown), 299 300 DEVMETHOD_END 301}; 302 303static driver_t ehci_driver = { 304 "ehci", 305 ehci_methods, 306 sizeof(struct ixp_ehci_softc), 307}; 308 309static devclass_t ehci_devclass; 310 311DRIVER_MODULE(ehci, ixp, ehci_driver, ehci_devclass, 0, 0); 312MODULE_DEPEND(ehci, usb, 1, 1, 1); 313