uhci_pci.c revision 187186
155682Smarkm/*- 272445Sassar * Copyright (c) 1998 The NetBSD Foundation, Inc. 355682Smarkm * All rights reserved. 455682Smarkm * 555682Smarkm * This code is derived from software contributed to The NetBSD Foundation 655682Smarkm * by Lennart Augustsson (augustss@carlstedt.se) at 755682Smarkm * Carlstedt Research & Technology. 855682Smarkm * 955682Smarkm * Redistribution and use in source and binary forms, with or without 1055682Smarkm * modification, are permitted provided that the following conditions 1155682Smarkm * are met: 1255682Smarkm * 1. Redistributions of source code must retain the above copyright 1355682Smarkm * notice, this list of conditions and the following disclaimer. 1455682Smarkm * 2. Redistributions in binary form must reproduce the above copyright 1555682Smarkm * notice, this list of conditions and the following disclaimer in the 1655682Smarkm * documentation and/or other materials provided with the distribution. 1755682Smarkm * 3. All advertising materials mentioning features or use of this software 1855682Smarkm * must display the following acknowledgement: 1955682Smarkm * This product includes software developed by the NetBSD 2055682Smarkm * Foundation, Inc. and its contributors. 2155682Smarkm * 4. Neither the name of The NetBSD Foundation nor the names of its 2255682Smarkm * contributors may be used to endorse or promote products derived 2355682Smarkm * from this software without specific prior written permission. 2455682Smarkm * 2555682Smarkm * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 2655682Smarkm * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 2755682Smarkm * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2855682Smarkm * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 2955682Smarkm * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 3055682Smarkm * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 3155682Smarkm * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 3255682Smarkm * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 3355682Smarkm * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 3455682Smarkm * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 3572445Sassar * POSSIBILITY OF SUCH DAMAGE. 3655682Smarkm */ 3755682Smarkm 3855682Smarkm#include <sys/cdefs.h> 3955682Smarkm__FBSDID("$FreeBSD: head/sys/dev/usb2/controller/uhci2_pci.c 187186 2009-01-13 19:14:51Z thompsa $"); 4055682Smarkm 4155682Smarkm/* Universal Host Controller Interface 4255682Smarkm * 4372445Sassar * UHCI spec: http://www.intel.com/ 4455682Smarkm */ 4555682Smarkm 4655682Smarkm/* The low level controller code for UHCI has been split into 4755682Smarkm * PCI probes and UHCI specific code. This was done to facilitate the 4855682Smarkm * sharing of code between *BSD's 4955682Smarkm */ 5055682Smarkm 5155682Smarkm#include <dev/usb2/include/usb2_mfunc.h> 5255682Smarkm#include <dev/usb2/include/usb2_defs.h> 5355682Smarkm#include <dev/usb2/include/usb2_standard.h> 5455682Smarkm 5555682Smarkm#include <dev/usb2/core/usb2_core.h> 5655682Smarkm#include <dev/usb2/core/usb2_busdma.h> 5755682Smarkm#include <dev/usb2/core/usb2_process.h> 5855682Smarkm#include <dev/usb2/core/usb2_sw_transfer.h> 5955682Smarkm#include <dev/usb2/core/usb2_util.h> 6055682Smarkm#include <dev/usb2/core/usb2_debug.h> 6155682Smarkm 6255682Smarkm#include <dev/usb2/controller/usb2_controller.h> 6355682Smarkm#include <dev/usb2/controller/usb2_bus.h> 6455682Smarkm#include <dev/usb2/controller/usb2_pci.h> 6555682Smarkm#include <dev/usb2/controller/uhci2.h> 6672445Sassar 6755682Smarkm#define PCI_UHCI_VENDORID_INTEL 0x8086 6855682Smarkm#define PCI_UHCI_VENDORID_VIA 0x1106 6955682Smarkm 7055682Smarkm/* PIIX4E has no separate stepping */ 7155682Smarkm 7255682Smarkm#define PCI_UHCI_BASE_REG 0x20 7355682Smarkm 7455682Smarkmstatic device_probe_t uhci_pci_probe; 7555682Smarkmstatic device_attach_t uhci_pci_attach; 7655682Smarkmstatic device_detach_t uhci_pci_detach; 7755682Smarkmstatic device_suspend_t uhci_pci_suspend; 7855682Smarkmstatic device_resume_t uhci_pci_resume; 7955682Smarkm 8055682Smarkmstatic int 8155682Smarkmuhci_pci_suspend(device_t self) 8255682Smarkm{ 8355682Smarkm uhci_softc_t *sc = device_get_softc(self); 8455682Smarkm int err; 8555682Smarkm 8655682Smarkm err = bus_generic_suspend(self); 8755682Smarkm if (err) { 8855682Smarkm return (err); 8955682Smarkm } 9055682Smarkm uhci_suspend(sc); 9155682Smarkm return (0); 9255682Smarkm} 9355682Smarkm 9455682Smarkmstatic int 9555682Smarkmuhci_pci_resume(device_t self) 9655682Smarkm{ 9755682Smarkm uhci_softc_t *sc = device_get_softc(self); 9855682Smarkm 9955682Smarkm pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2); 10055682Smarkm 10155682Smarkm uhci_resume(sc); 10255682Smarkm 10355682Smarkm bus_generic_resume(self); 10455682Smarkm return (0); 10555682Smarkm} 10655682Smarkm 10755682Smarkmstatic const char * 10855682Smarkmuhci_pci_match(device_t self) 10955682Smarkm{ 11055682Smarkm uint32_t device_id = pci_get_devid(self); 11155682Smarkm 11255682Smarkm switch (device_id) { 11355682Smarkm case 0x26888086: 11455682Smarkm return ("Intel 631XESB/632XESB/3100 USB controller USB-1"); 11555682Smarkm 11655682Smarkm case 0x26898086: 11755682Smarkm return ("Intel 631XESB/632XESB/3100 USB controller USB-2"); 11855682Smarkm 11955682Smarkm case 0x268a8086: 12055682Smarkm return ("Intel 631XESB/632XESB/3100 USB controller USB-3"); 12155682Smarkm 12255682Smarkm case 0x268b8086: 12355682Smarkm return ("Intel 631XESB/632XESB/3100 USB controller USB-4"); 12455682Smarkm 12555682Smarkm case 0x70208086: 12655682Smarkm return ("Intel 82371SB (PIIX3) USB controller"); 12755682Smarkm 12855682Smarkm case 0x71128086: 12955682Smarkm return ("Intel 82371AB/EB (PIIX4) USB controller"); 13055682Smarkm 13155682Smarkm case 0x24128086: 13255682Smarkm return ("Intel 82801AA (ICH) USB controller"); 13355682Smarkm 13455682Smarkm case 0x24228086: 13555682Smarkm return ("Intel 82801AB (ICH0) USB controller"); 13655682Smarkm 13755682Smarkm case 0x24428086: 13855682Smarkm return ("Intel 82801BA/BAM (ICH2) USB controller USB-A"); 13955682Smarkm 14055682Smarkm case 0x24448086: 14155682Smarkm return ("Intel 82801BA/BAM (ICH2) USB controller USB-B"); 14255682Smarkm 14355682Smarkm case 0x24828086: 14455682Smarkm return ("Intel 82801CA/CAM (ICH3) USB controller USB-A"); 14555682Smarkm 14655682Smarkm case 0x24848086: 14755682Smarkm return ("Intel 82801CA/CAM (ICH3) USB controller USB-B"); 14855682Smarkm 14955682Smarkm case 0x24878086: 15055682Smarkm return ("Intel 82801CA/CAM (ICH3) USB controller USB-C"); 15155682Smarkm 15255682Smarkm case 0x24c28086: 15355682Smarkm return ("Intel 82801DB (ICH4) USB controller USB-A"); 15455682Smarkm 15555682Smarkm case 0x24c48086: 15655682Smarkm return ("Intel 82801DB (ICH4) USB controller USB-B"); 15755682Smarkm 15855682Smarkm case 0x24c78086: 15955682Smarkm return ("Intel 82801DB (ICH4) USB controller USB-C"); 16055682Smarkm 16155682Smarkm case 0x24d28086: 16255682Smarkm return ("Intel 82801EB (ICH5) USB controller USB-A"); 16355682Smarkm 16455682Smarkm case 0x24d48086: 16555682Smarkm return ("Intel 82801EB (ICH5) USB controller USB-B"); 16655682Smarkm 16755682Smarkm case 0x24d78086: 16855682Smarkm return ("Intel 82801EB (ICH5) USB controller USB-C"); 16955682Smarkm 17055682Smarkm case 0x24de8086: 17155682Smarkm return ("Intel 82801EB (ICH5) USB controller USB-D"); 17255682Smarkm 17355682Smarkm case 0x26588086: 17455682Smarkm return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-A"); 17555682Smarkm 176 case 0x26598086: 177 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-B"); 178 179 case 0x265a8086: 180 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-C"); 181 182 case 0x265b8086: 183 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-D"); 184 185 case 0x28308086: 186 return ("Intel 82801H (ICH8) USB controller USB-A"); 187 case 0x28318086: 188 return ("Intel 82801H (ICH8) USB controller USB-B"); 189 case 0x28328086: 190 return ("Intel 82801H (ICH8) USB controller USB-C"); 191 case 0x28348086: 192 return ("Intel 82801H (ICH8) USB controller USB-D"); 193 case 0x28358086: 194 return ("Intel 82801H (ICH8) USB controller USB-E"); 195 case 0x29348086: 196 return ("Intel 82801I (ICH9) USB controller"); 197 case 0x29358086: 198 return ("Intel 82801I (ICH9) USB controller"); 199 case 0x29368086: 200 return ("Intel 82801I (ICH9) USB controller"); 201 case 0x29378086: 202 return ("Intel 82801I (ICH9) USB controller"); 203 case 0x29388086: 204 return ("Intel 82801I (ICH9) USB controller"); 205 case 0x29398086: 206 return ("Intel 82801I (ICH9) USB controller"); 207 208 case 0x719a8086: 209 return ("Intel 82443MX USB controller"); 210 211 case 0x76028086: 212 return ("Intel 82372FB/82468GX USB controller"); 213 214 case 0x30381106: 215 return ("VIA 83C572 USB controller"); 216 217 default: 218 break; 219 } 220 221 if ((pci_get_class(self) == PCIC_SERIALBUS) && 222 (pci_get_subclass(self) == PCIS_SERIALBUS_USB) && 223 (pci_get_progif(self) == PCI_INTERFACE_UHCI)) { 224 return ("UHCI (generic) USB controller"); 225 } 226 return (NULL); 227} 228 229static int 230uhci_pci_probe(device_t self) 231{ 232 const char *desc = uhci_pci_match(self); 233 234 if (desc) { 235 device_set_desc(self, desc); 236 return (0); 237 } else { 238 return (ENXIO); 239 } 240} 241 242static int 243uhci_pci_attach(device_t self) 244{ 245 uhci_softc_t *sc = device_get_softc(self); 246 int rid; 247 int err; 248 249 if (sc == NULL) { 250 device_printf(self, "Could not allocate sc\n"); 251 return (ENXIO); 252 } 253 /* initialise some bus fields */ 254 sc->sc_bus.parent = self; 255 sc->sc_bus.devices = sc->sc_devices; 256 sc->sc_bus.devices_max = UHCI_MAX_DEVICES; 257 258 /* get all DMA memory */ 259 if (usb2_bus_mem_alloc_all(&sc->sc_bus, USB_GET_DMA_TAG(self), 260 &uhci_iterate_hw_softc)) { 261 return ENOMEM; 262 } 263 sc->sc_dev = self; 264 265 pci_enable_busmaster(self); 266 267 rid = PCI_UHCI_BASE_REG; 268 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_IOPORT, &rid, 269 RF_ACTIVE); 270 if (!sc->sc_io_res) { 271 device_printf(self, "Could not map ports\n"); 272 goto error; 273 } 274 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res); 275 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res); 276 sc->sc_io_size = rman_get_size(sc->sc_io_res); 277 278 /* disable interrupts */ 279 bus_space_write_2(sc->sc_io_tag, sc->sc_io_hdl, UHCI_INTR, 0); 280 281 rid = 0; 282 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 283 RF_SHAREABLE | RF_ACTIVE); 284 if (sc->sc_irq_res == NULL) { 285 device_printf(self, "Could not allocate irq\n"); 286 goto error; 287 } 288 sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 289 if (!sc->sc_bus.bdev) { 290 device_printf(self, "Could not add USB device\n"); 291 goto error; 292 } 293 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 294 295 /* 296 * uhci_pci_match must never return NULL if uhci_pci_probe 297 * succeeded 298 */ 299 device_set_desc(sc->sc_bus.bdev, uhci_pci_match(self)); 300 switch (pci_get_vendor(self)) { 301 case PCI_UHCI_VENDORID_INTEL: 302 sprintf(sc->sc_vendor, "Intel"); 303 break; 304 case PCI_UHCI_VENDORID_VIA: 305 sprintf(sc->sc_vendor, "VIA"); 306 break; 307 default: 308 if (bootverbose) { 309 device_printf(self, "(New UHCI DeviceId=0x%08x)\n", 310 pci_get_devid(self)); 311 } 312 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self)); 313 } 314 315 switch (pci_read_config(self, PCI_USBREV, 1) & PCI_USB_REV_MASK) { 316 case PCI_USB_REV_PRE_1_0: 317 sc->sc_bus.usbrev = USB_REV_PRE_1_0; 318 break; 319 case PCI_USB_REV_1_0: 320 sc->sc_bus.usbrev = USB_REV_1_0; 321 break; 322 default: 323 /* Quirk for Parallels Desktop 4.0 */ 324 device_printf(self, "USB revision is unknown. Assuming v1.1.\n"); 325 sc->sc_bus.usbrev = USB_REV_1_1; 326 break; 327 } 328 329#if (__FreeBSD_version >= 700031) 330 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 331 NULL, (void *)(void *)uhci_interrupt, sc, &sc->sc_intr_hdl); 332#else 333 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 334 (void *)(void *)uhci_interrupt, sc, &sc->sc_intr_hdl); 335#endif 336 337 if (err) { 338 device_printf(self, "Could not setup irq, %d\n", err); 339 sc->sc_intr_hdl = NULL; 340 goto error; 341 } 342 /* 343 * Set the PIRQD enable bit and switch off all the others. We don't 344 * want legacy support to interfere with us XXX Does this also mean 345 * that the BIOS won't touch the keyboard anymore if it is connected 346 * to the ports of the root hub? 347 */ 348#if USB_DEBUG 349 if (pci_read_config(self, PCI_LEGSUP, 2) != PCI_LEGSUP_USBPIRQDEN) { 350 device_printf(self, "LegSup = 0x%04x\n", 351 pci_read_config(self, PCI_LEGSUP, 2)); 352 } 353#endif 354 pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2); 355 356 err = uhci_init(sc); 357 if (!err) { 358 err = device_probe_and_attach(sc->sc_bus.bdev); 359 } 360 if (err) { 361 device_printf(self, "USB init failed\n"); 362 goto error; 363 } 364 return (0); 365 366error: 367 uhci_pci_detach(self); 368 return (ENXIO); 369} 370 371int 372uhci_pci_detach(device_t self) 373{ 374 uhci_softc_t *sc = device_get_softc(self); 375 device_t bdev; 376 377 if (sc->sc_bus.bdev) { 378 bdev = sc->sc_bus.bdev; 379 device_detach(bdev); 380 device_delete_child(self, bdev); 381 } 382 /* during module unload there are lots of children leftover */ 383 device_delete_all_children(self); 384 385 /* 386 * disable interrupts that might have been switched on in 387 * uhci_init. 388 */ 389 if (sc->sc_io_res) { 390 USB_BUS_LOCK(&sc->sc_bus); 391 392 /* stop the controller */ 393 uhci_reset(sc); 394 395 USB_BUS_UNLOCK(&sc->sc_bus); 396 } 397 pci_disable_busmaster(self); 398 399 if (sc->sc_irq_res && sc->sc_intr_hdl) { 400 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 401 402 if (err) { 403 /* XXX or should we panic? */ 404 device_printf(self, "Could not tear down irq, %d\n", 405 err); 406 } 407 sc->sc_intr_hdl = NULL; 408 } 409 if (sc->sc_irq_res) { 410 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 411 sc->sc_irq_res = NULL; 412 } 413 if (sc->sc_io_res) { 414 bus_release_resource(self, SYS_RES_IOPORT, PCI_UHCI_BASE_REG, 415 sc->sc_io_res); 416 sc->sc_io_res = NULL; 417 } 418 usb2_bus_mem_free_all(&sc->sc_bus, &uhci_iterate_hw_softc); 419 420 return (0); 421} 422 423static driver_t uhci_driver = 424{ 425 .name = "uhci", 426 .methods = (device_method_t[]){ 427 /* device interface */ 428 DEVMETHOD(device_probe, uhci_pci_probe), 429 DEVMETHOD(device_attach, uhci_pci_attach), 430 DEVMETHOD(device_detach, uhci_pci_detach), 431 432 DEVMETHOD(device_suspend, uhci_pci_suspend), 433 DEVMETHOD(device_resume, uhci_pci_resume), 434 DEVMETHOD(device_shutdown, bus_generic_shutdown), 435 436 /* Bus interface */ 437 DEVMETHOD(bus_print_child, bus_generic_print_child), 438 {0, 0} 439 }, 440 .size = sizeof(struct uhci_softc), 441}; 442 443static devclass_t uhci_devclass; 444 445DRIVER_MODULE(uhci, pci, uhci_driver, uhci_devclass, 0, 0); 446DRIVER_MODULE(uhci, cardbus, uhci_driver, uhci_devclass, 0, 0); 447MODULE_DEPEND(uhci, usb2_controller, 1, 1, 1); 448MODULE_DEPEND(uhci, usb2_core, 1, 1, 1); 449