ohci_pci.c revision 278278
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: stable/10/sys/dev/usb/controller/ohci_pci.c 278278 2015-02-05 20:03:02Z hselasky $"); 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/module.h> 54#include <sys/lock.h> 55#include <sys/mutex.h> 56#include <sys/condvar.h> 57#include <sys/sysctl.h> 58#include <sys/sx.h> 59#include <sys/unistd.h> 60#include <sys/callout.h> 61#include <sys/malloc.h> 62#include <sys/priv.h> 63 64#include <dev/usb/usb.h> 65#include <dev/usb/usbdi.h> 66 67#include <dev/usb/usb_core.h> 68#include <dev/usb/usb_busdma.h> 69#include <dev/usb/usb_process.h> 70#include <dev/usb/usb_util.h> 71 72#include <dev/usb/usb_controller.h> 73#include <dev/usb/usb_bus.h> 74#include <dev/usb/usb_pci.h> 75#include <dev/usb/controller/ohci.h> 76#include <dev/usb/controller/ohcireg.h> 77#include "usb_if.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 93static device_probe_t ohci_pci_probe; 94static device_attach_t ohci_pci_attach; 95static device_detach_t ohci_pci_detach; 96static usb_take_controller_t ohci_pci_take_controller; 97 98static int 99ohci_pci_take_controller(device_t self) 100{ 101 uint32_t reg; 102 uint32_t int_line; 103 104 if (pci_get_powerstate(self) != PCI_POWERSTATE_D0) { 105 device_printf(self, "chip is in D%d mode " 106 "-- setting to D0\n", pci_get_powerstate(self)); 107 reg = pci_read_config(self, PCI_CBMEM, 4); 108 int_line = pci_read_config(self, PCIR_INTLINE, 4); 109 pci_set_powerstate(self, PCI_POWERSTATE_D0); 110 pci_write_config(self, PCI_CBMEM, reg, 4); 111 pci_write_config(self, PCIR_INTLINE, int_line, 4); 112 } 113 return (0); 114} 115 116static const char * 117ohci_pci_match(device_t self) 118{ 119 uint32_t device_id = pci_get_devid(self); 120 121 switch (device_id) { 122 case 0x523710b9: 123 return ("AcerLabs M5237 (Aladdin-V) USB controller"); 124 125 case 0x740c1022: 126 return ("AMD-756 USB Controller"); 127 128 case 0x74141022: 129 return ("AMD-766 USB Controller"); 130 131 case 0x43741002: 132 return "ATI SB400 USB Controller"; 133 case 0x43751002: 134 return "ATI SB400 USB Controller"; 135 case 0x43971002: 136 return ("AMD SB7x0/SB8x0/SB9x0 USB controller"); 137 case 0x43981002: 138 return ("AMD SB7x0/SB8x0/SB9x0 USB controller"); 139 case 0x43991002: 140 return ("AMD SB7x0/SB8x0/SB9x0 USB controller"); 141 142 case 0x06701095: 143 return ("CMD Tech 670 (USB0670) USB controller"); 144 145 case 0x06731095: 146 return ("CMD Tech 673 (USB0673) USB controller"); 147 148 case 0xc8611045: 149 return ("OPTi 82C861 (FireLink) USB controller"); 150 151 case 0x00351033: 152 return ("NEC uPD 9210 USB controller"); 153 154 case 0x00d710de: 155 return ("nVidia nForce3 USB Controller"); 156 157 case 0x005a10de: 158 return ("nVidia nForce CK804 USB Controller"); 159 case 0x036c10de: 160 return ("nVidia nForce MCP55 USB Controller"); 161 case 0x03f110de: 162 return ("nVidia nForce MCP61 USB Controller"); 163 case 0x0aa510de: 164 return ("nVidia nForce MCP79 USB Controller"); 165 case 0x0aa710de: 166 return ("nVidia nForce MCP79 USB Controller"); 167 case 0x0aa810de: 168 return ("nVidia nForce MCP79 USB Controller"); 169 170 case 0x70011039: 171 return ("SiS 5571 USB controller"); 172 173 case 0x1103108e: 174 return "Sun PCIO-2 USB controller"; 175 176 case 0x0019106b: 177 return ("Apple KeyLargo USB controller"); 178 179 default: 180 break; 181 } 182 if ((pci_get_class(self) == PCIC_SERIALBUS) && 183 (pci_get_subclass(self) == PCIS_SERIALBUS_USB) && 184 (pci_get_progif(self) == PCI_INTERFACE_OHCI)) { 185 return ("OHCI (generic) USB controller"); 186 } 187 return (NULL); 188} 189 190static int 191ohci_pci_probe(device_t self) 192{ 193 const char *desc = ohci_pci_match(self); 194 195 if (desc) { 196 device_set_desc(self, desc); 197 return (0); 198 } else { 199 return (ENXIO); 200 } 201} 202 203static int 204ohci_pci_attach(device_t self) 205{ 206 ohci_softc_t *sc = device_get_softc(self); 207 int rid; 208 int err; 209 210 /* initialise some bus fields */ 211 sc->sc_bus.parent = self; 212 sc->sc_bus.devices = sc->sc_devices; 213 sc->sc_bus.devices_max = OHCI_MAX_DEVICES; 214 sc->sc_bus.dma_bits = 32; 215 216 /* get all DMA memory */ 217 if (usb_bus_mem_alloc_all(&sc->sc_bus, USB_GET_DMA_TAG(self), 218 &ohci_iterate_hw_softc)) { 219 return (ENOMEM); 220 } 221 sc->sc_dev = self; 222 223 pci_enable_busmaster(self); 224 225 /* 226 * Some Sun PCIO-2 USB controllers have their intpin register 227 * bogusly set to 0, although it should be 4. Correct that. 228 */ 229 if (pci_get_devid(self) == 0x1103108e && pci_get_intpin(self) == 0) 230 pci_set_intpin(self, 4); 231 232 rid = PCI_CBMEM; 233 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, 234 RF_ACTIVE); 235 if (!sc->sc_io_res) { 236 device_printf(self, "Could not map memory\n"); 237 goto error; 238 } 239 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res); 240 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res); 241 sc->sc_io_size = rman_get_size(sc->sc_io_res); 242 243 rid = 0; 244 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 245 RF_SHAREABLE | RF_ACTIVE); 246 if (sc->sc_irq_res == NULL) { 247 device_printf(self, "Could not allocate irq\n"); 248 goto error; 249 } 250 sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 251 if (!sc->sc_bus.bdev) { 252 device_printf(self, "Could not add USB device\n"); 253 goto error; 254 } 255 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 256 257 /* 258 * ohci_pci_match will never return NULL if ohci_pci_probe 259 * succeeded 260 */ 261 device_set_desc(sc->sc_bus.bdev, ohci_pci_match(self)); 262 switch (pci_get_vendor(self)) { 263 case PCI_OHCI_VENDORID_ACERLABS: 264 sprintf(sc->sc_vendor, "AcerLabs"); 265 break; 266 case PCI_OHCI_VENDORID_AMD: 267 sprintf(sc->sc_vendor, "AMD"); 268 break; 269 case PCI_OHCI_VENDORID_APPLE: 270 sprintf(sc->sc_vendor, "Apple"); 271 break; 272 case PCI_OHCI_VENDORID_ATI: 273 sprintf(sc->sc_vendor, "ATI"); 274 break; 275 case PCI_OHCI_VENDORID_CMDTECH: 276 sprintf(sc->sc_vendor, "CMDTECH"); 277 break; 278 case PCI_OHCI_VENDORID_NEC: 279 sprintf(sc->sc_vendor, "NEC"); 280 break; 281 case PCI_OHCI_VENDORID_NVIDIA: 282 case PCI_OHCI_VENDORID_NVIDIA2: 283 sprintf(sc->sc_vendor, "nVidia"); 284 break; 285 case PCI_OHCI_VENDORID_OPTI: 286 sprintf(sc->sc_vendor, "OPTi"); 287 break; 288 case PCI_OHCI_VENDORID_SIS: 289 sprintf(sc->sc_vendor, "SiS"); 290 break; 291 case PCI_OHCI_VENDORID_SUN: 292 sprintf(sc->sc_vendor, "SUN"); 293 break; 294 default: 295 if (bootverbose) { 296 device_printf(self, "(New OHCI DeviceId=0x%08x)\n", 297 pci_get_devid(self)); 298 } 299 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self)); 300 } 301 302 /* sc->sc_bus.usbrev; set by ohci_init() */ 303 304#if (__FreeBSD_version >= 700031) 305 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 306 NULL, (driver_intr_t *)ohci_interrupt, sc, &sc->sc_intr_hdl); 307#else 308 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 309 (driver_intr_t *)ohci_interrupt, sc, &sc->sc_intr_hdl); 310#endif 311 if (err) { 312 device_printf(self, "Could not setup irq, %d\n", err); 313 sc->sc_intr_hdl = NULL; 314 goto error; 315 } 316 err = ohci_init(sc); 317 if (!err) { 318 err = device_probe_and_attach(sc->sc_bus.bdev); 319 } 320 if (err) { 321 device_printf(self, "USB init failed\n"); 322 goto error; 323 } 324 return (0); 325 326error: 327 ohci_pci_detach(self); 328 return (ENXIO); 329} 330 331static int 332ohci_pci_detach(device_t self) 333{ 334 ohci_softc_t *sc = device_get_softc(self); 335 device_t bdev; 336 337 if (sc->sc_bus.bdev) { 338 bdev = sc->sc_bus.bdev; 339 device_detach(bdev); 340 device_delete_child(self, bdev); 341 } 342 /* during module unload there are lots of children leftover */ 343 device_delete_children(self); 344 345 pci_disable_busmaster(self); 346 347 if (sc->sc_irq_res && sc->sc_intr_hdl) { 348 /* 349 * only call ohci_detach() after ohci_init() 350 */ 351 ohci_detach(sc); 352 353 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 354 355 if (err) { 356 /* XXX or should we panic? */ 357 device_printf(self, "Could not tear down irq, %d\n", 358 err); 359 } 360 sc->sc_intr_hdl = NULL; 361 } 362 if (sc->sc_irq_res) { 363 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 364 sc->sc_irq_res = NULL; 365 } 366 if (sc->sc_io_res) { 367 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM, 368 sc->sc_io_res); 369 sc->sc_io_res = NULL; 370 } 371 usb_bus_mem_free_all(&sc->sc_bus, &ohci_iterate_hw_softc); 372 373 return (0); 374} 375 376static device_method_t ohci_pci_methods[] = { 377 /* Device interface */ 378 DEVMETHOD(device_probe, ohci_pci_probe), 379 DEVMETHOD(device_attach, ohci_pci_attach), 380 DEVMETHOD(device_detach, ohci_pci_detach), 381 DEVMETHOD(device_suspend, bus_generic_suspend), 382 DEVMETHOD(device_resume, bus_generic_resume), 383 DEVMETHOD(device_shutdown, bus_generic_shutdown), 384 DEVMETHOD(usb_take_controller, ohci_pci_take_controller), 385 386 DEVMETHOD_END 387}; 388 389static driver_t ohci_driver = { 390 .name = "ohci", 391 .methods = ohci_pci_methods, 392 .size = sizeof(struct ohci_softc), 393}; 394 395static devclass_t ohci_devclass; 396 397DRIVER_MODULE(ohci, pci, ohci_driver, ohci_devclass, 0, 0); 398MODULE_DEPEND(ohci, usb, 1, 1, 1); 399