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