1 /*- 2 * Copyright (c) 1998 The NetBSD Foundation, Inc. 3 * All rights reserved. 4 * 5 * This code is derived from software contributed to The NetBSD Foundation 6 * by Lennart Augustsson (augustss@carlstedt.se) at 7 * Carlstedt Research & Technology. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 3. All advertising materials mentioning features or use of this software 18 * must display the following acknowledgement: 19 * This product includes software developed by the NetBSD 20 * Foundation, Inc. and its contributors. 21 * 4. Neither the name of The NetBSD Foundation nor the names of its 22 * contributors may be used to endorse or promote products derived 23 * from this software without specific prior written permission. 24 * 25 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35 * POSSIBILITY OF SUCH DAMAGE. 36 */ 37 38 #include <sys/cdefs.h> 39 __FBSDID("$FreeBSD$"); 40 41 /* 42 * USB Open Host Controller driver. 43 * 44 * OHCI spec: http://www.intel.com/design/usb/ohci11d.pdf 45 */ 46 47 /* The low level controller code for OHCI has been split into 48 * PCI probes and OHCI specific code. This was done to facilitate the 49 * sharing of code between *BSD's 50 */ 51 52 #include <sys/stdint.h> 53 #include <sys/stddef.h> 54 #include <sys/param.h> 55 #include <sys/queue.h> 56 #include <sys/types.h> 57 #include <sys/systm.h> 58 #include <sys/kernel.h> 59 #include <sys/bus.h> 60 #include <sys/linker_set.h> 61 #include <sys/module.h> 62 #include <sys/lock.h> 63 #include <sys/mutex.h> 64 #include <sys/condvar.h> 65 #include <sys/sysctl.h> 66 #include <sys/sx.h> 67 #include <sys/unistd.h> 68 #include <sys/callout.h> 69 #include <sys/malloc.h> 70 #include <sys/priv.h> 71 72 #include <dev/usb/usb.h> 73 #include <dev/usb/usbdi.h> 74 75 #include <dev/usb/usb_core.h> 76 #include <dev/usb/usb_busdma.h> 77 #include <dev/usb/usb_process.h> 78 #include <dev/usb/usb_util.h> 79 80 #include <dev/usb/usb_controller.h> 81 #include <dev/usb/usb_bus.h> 82 #include <dev/usb/usb_pci.h> 83 #include <dev/usb/controller/ohci.h> 84 85 #define PCI_OHCI_VENDORID_ACERLABS 0x10b9 86 #define PCI_OHCI_VENDORID_AMD 0x1022 87 #define PCI_OHCI_VENDORID_APPLE 0x106b 88 #define PCI_OHCI_VENDORID_ATI 0x1002 89 #define PCI_OHCI_VENDORID_CMDTECH 0x1095 90 #define PCI_OHCI_VENDORID_NEC 0x1033 91 #define PCI_OHCI_VENDORID_NVIDIA 0x12D2 92 #define PCI_OHCI_VENDORID_NVIDIA2 0x10DE 93 #define PCI_OHCI_VENDORID_OPTI 0x1045 94 #define PCI_OHCI_VENDORID_SIS 0x1039 95 #define PCI_OHCI_VENDORID_SUN 0x108e 96 97 #define PCI_OHCI_BASE_REG 0x10 98 99 static device_probe_t ohci_pci_probe; 100 static device_attach_t ohci_pci_attach; 101 static device_detach_t ohci_pci_detach; 102 static device_suspend_t ohci_pci_suspend; 103 static device_resume_t ohci_pci_resume; 104 105 static int 106 ohci_pci_suspend(device_t self) 107 { 108 ohci_softc_t *sc = device_get_softc(self); 109 int err; 110 111 err = bus_generic_suspend(self); 112 if (err) { 113 return (err); 114 } 115 ohci_suspend(sc); 116 return (0); 117 } 118 119 static int 120 ohci_pci_resume(device_t self) 121 { 122 ohci_softc_t *sc = device_get_softc(self); 123 uint32_t reg, int_line; 124 125 if (pci_get_powerstate(self) != PCI_POWERSTATE_D0) { 126 device_printf(self, "chip is in D%d mode " 127 "-- setting to D0\n", pci_get_powerstate(self)); 128 reg = pci_read_config(self, PCI_CBMEM, 4); 129 int_line = pci_read_config(self, PCIR_INTLINE, 4); 130 pci_set_powerstate(self, PCI_POWERSTATE_D0); 131 pci_write_config(self, PCI_CBMEM, reg, 4); 132 pci_write_config(self, PCIR_INTLINE, int_line, 4); 133 } 134 ohci_resume(sc); 135 136 bus_generic_resume(self); 137 return (0); 138 } 139 140 static const char * 141 ohci_pci_match(device_t self) 142 { 143 uint32_t device_id = pci_get_devid(self); 144 145 switch (device_id) { 146 case 0x523710b9: 147 return ("AcerLabs M5237 (Aladdin-V) USB controller"); 148 149 case 0x740c1022: 150 return ("AMD-756 USB Controller"); 151 152 case 0x74141022: 153 return ("AMD-766 USB Controller"); 154 155 case 0x43741002: 156 return "ATI SB400 USB Controller"; 157 case 0x43751002: 158 return "ATI SB400 USB Controller"; 159 160 case 0x06701095: 161 return ("CMD Tech 670 (USB0670) USB controller"); 162 163 case 0x06731095: 164 return ("CMD Tech 673 (USB0673) USB controller"); 165 166 case 0xc8611045: 167 return ("OPTi 82C861 (FireLink) USB controller"); 168 169 case 0x00351033: 170 return ("NEC uPD 9210 USB controller"); 171 172 case 0x00d710de: 173 return ("nVidia nForce3 USB Controller"); 174 175 case 0x70011039: 176 return ("SiS 5571 USB controller"); 177 178 case 0x1103108e: 179 return "Sun PCIO-2 USB controller"; 180 181 case 0x0019106b: 182 return ("Apple KeyLargo USB controller"); 183 184 default: 185 break; 186 } 187 if ((pci_get_class(self) == PCIC_SERIALBUS) && 188 (pci_get_subclass(self) == PCIS_SERIALBUS_USB) && 189 (pci_get_progif(self) == PCI_INTERFACE_OHCI)) { 190 return ("OHCI (generic) USB controller"); 191 } 192 return (NULL); 193 } 194 195 static int 196 ohci_pci_probe(device_t self) 197 { 198 const char *desc = ohci_pci_match(self); 199 200 if (desc) { 201 device_set_desc(self, desc); 202 return (0); 203 } else { 204 return (ENXIO); 205 } 206 } 207 208 static int 209 ohci_pci_attach(device_t self) 210 { 211 ohci_softc_t *sc = device_get_softc(self); 212 int rid; 213 int err; 214 215 /* initialise some bus fields */ 216 sc->sc_bus.parent = self; 217 sc->sc_bus.devices = sc->sc_devices; 218 sc->sc_bus.devices_max = OHCI_MAX_DEVICES; 219 220 /* get all DMA memory */ 221 if (usb_bus_mem_alloc_all(&sc->sc_bus, USB_GET_DMA_TAG(self), 222 &ohci_iterate_hw_softc)) { 223 return (ENOMEM); 224 } 225 sc->sc_dev = self; 226 227 pci_enable_busmaster(self); 228 229 /* 230 * Some Sun PCIO-2 USB controllers have their intpin register 231 * bogusly set to 0, although it should be 4. Correct that. 232 */ 233 if (pci_get_devid(self) == 0x1103108e && pci_get_intpin(self) == 0) 234 pci_set_intpin(self, 4); 235 236 rid = PCI_CBMEM; 237 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, 238 RF_ACTIVE); 239 if (!sc->sc_io_res) { 240 device_printf(self, "Could not map memory\n"); 241 goto error; 242 } 243 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res); 244 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res); 245 sc->sc_io_size = rman_get_size(sc->sc_io_res); 246 247 rid = 0; 248 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 249 RF_SHAREABLE | RF_ACTIVE); 250 if (sc->sc_irq_res == NULL) { 251 device_printf(self, "Could not allocate irq\n"); 252 goto error; 253 } 254 sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 255 if (!sc->sc_bus.bdev) { 256 device_printf(self, "Could not add USB device\n"); 257 goto error; 258 } 259 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 260 261 /* 262 * ohci_pci_match will never return NULL if ohci_pci_probe 263 * succeeded 264 */ 265 device_set_desc(sc->sc_bus.bdev, ohci_pci_match(self)); 266 switch (pci_get_vendor(self)) { 267 case PCI_OHCI_VENDORID_ACERLABS: 268 sprintf(sc->sc_vendor, "AcerLabs"); 269 break; 270 case PCI_OHCI_VENDORID_AMD: 271 sprintf(sc->sc_vendor, "AMD"); 272 break; 273 case PCI_OHCI_VENDORID_APPLE: 274 sprintf(sc->sc_vendor, "Apple"); 275 break; 276 case PCI_OHCI_VENDORID_ATI: 277 sprintf(sc->sc_vendor, "ATI"); 278 break; 279 case PCI_OHCI_VENDORID_CMDTECH: 280 sprintf(sc->sc_vendor, "CMDTECH"); 281 break; 282 case PCI_OHCI_VENDORID_NEC: 283 sprintf(sc->sc_vendor, "NEC"); 284 break; 285 case PCI_OHCI_VENDORID_NVIDIA: 286 case PCI_OHCI_VENDORID_NVIDIA2: 287 sprintf(sc->sc_vendor, "nVidia"); 288 break; 289 case PCI_OHCI_VENDORID_OPTI: 290 sprintf(sc->sc_vendor, "OPTi"); 291 break; 292 case PCI_OHCI_VENDORID_SIS: 293 sprintf(sc->sc_vendor, "SiS"); 294 break; 295 case PCI_OHCI_VENDORID_SUN: 296 sprintf(sc->sc_vendor, "SUN"); 297 break; 298 default: 299 if (bootverbose) { 300 device_printf(self, "(New OHCI DeviceId=0x%08x)\n", 301 pci_get_devid(self)); 302 } 303 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self)); 304 } 305 306 /* sc->sc_bus.usbrev; set by ohci_init() */ 307 308 #if (__FreeBSD_version >= 700031) 309 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 310 NULL, (driver_intr_t *)ohci_interrupt, sc, &sc->sc_intr_hdl); 311 #else 312 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 313 (driver_intr_t *)ohci_interrupt, sc, &sc->sc_intr_hdl); 314 #endif 315 if (err) { 316 device_printf(self, "Could not setup irq, %d\n", err); 317 sc->sc_intr_hdl = NULL; 318 goto error; 319 } 320 err = ohci_init(sc); 321 if (!err) { 322 err = device_probe_and_attach(sc->sc_bus.bdev); 323 } 324 if (err) { 325 device_printf(self, "USB init failed\n"); 326 goto error; 327 } 328 return (0); 329 330 error: 331 ohci_pci_detach(self); 332 return (ENXIO); 333 } 334 335 static int 336 ohci_pci_detach(device_t self) 337 { 338 ohci_softc_t *sc = device_get_softc(self); 339 device_t bdev; 340 341 if (sc->sc_bus.bdev) { 342 bdev = sc->sc_bus.bdev; 343 device_detach(bdev); 344 device_delete_child(self, bdev); 345 } 346 /* during module unload there are lots of children leftover */ 347 device_delete_all_children(self); 348 349 pci_disable_busmaster(self); 350 351 if (sc->sc_irq_res && sc->sc_intr_hdl) { 352 /* 353 * only call ohci_detach() after ohci_init() 354 */ 355 ohci_detach(sc); 356 357 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 358 359 if (err) { 360 /* XXX or should we panic? */ 361 device_printf(self, "Could not tear down irq, %d\n", 362 err); 363 } 364 sc->sc_intr_hdl = NULL; 365 } 366 if (sc->sc_irq_res) { 367 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 368 sc->sc_irq_res = NULL; 369 } 370 if (sc->sc_io_res) { 371 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM, 372 sc->sc_io_res); 373 sc->sc_io_res = NULL; 374 } 375 usb_bus_mem_free_all(&sc->sc_bus, &ohci_iterate_hw_softc); 376 377 return (0); 378 } 379 380 static driver_t ohci_driver = 381 { 382 .name = "ohci", 383 .methods = (device_method_t[]){ 384 /* device interface */ 385 DEVMETHOD(device_probe, ohci_pci_probe), 386 DEVMETHOD(device_attach, ohci_pci_attach), 387 DEVMETHOD(device_detach, ohci_pci_detach), 388 DEVMETHOD(device_suspend, ohci_pci_suspend), 389 DEVMETHOD(device_resume, ohci_pci_resume), 390 DEVMETHOD(device_shutdown, bus_generic_shutdown), 391 392 /* bus interface */ 393 DEVMETHOD(bus_print_child, bus_generic_print_child), 394 395 {0, 0} 396 }, 397 .size = sizeof(struct ohci_softc), 398 }; 399 400 static devclass_t ohci_devclass; 401 402 DRIVER_MODULE(ohci, pci, ohci_driver, ohci_devclass, 0, 0); 403 MODULE_DEPEND(ohci, usb, 1, 1, 1); 404