1 /* $NetBSD: ehci_pci.c,v 1.32 2007/12/09 20:28:07 jmcneill Exp $ */ 2 3 /* 4 * Copyright (c) 2001, 2002 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Lennart Augustsson (lennart@augustsson.net). 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39 #include <sys/cdefs.h> 40 __KERNEL_RCSID(0, "$NetBSD: ehci_pci.c,v 1.32 2007/12/09 20:28:07 jmcneill Exp $"); 41 42 #include <sys/param.h> 43 #include <sys/systm.h> 44 #include <sys/kernel.h> 45 #include <sys/device.h> 46 #include <sys/proc.h> 47 #include <sys/queue.h> 48 49 #include <sys/bus.h> 50 51 #include <dev/pci/pcidevs.h> 52 #include <dev/pci/pcivar.h> 53 #include <dev/pci/usb_pci.h> 54 55 #include <dev/usb/usb.h> 56 #include <dev/usb/usbdi.h> 57 #include <dev/usb/usbdivar.h> 58 #include <dev/usb/usb_mem.h> 59 60 #include <dev/usb/ehcireg.h> 61 #include <dev/usb/ehcivar.h> 62 63 #ifdef EHCI_DEBUG 64 #define DPRINTF(x) if (ehcidebug) printf x 65 extern int ehcidebug; 66 #else 67 #define DPRINTF(x) 68 #endif 69 70 static void ehci_get_ownership(ehci_softc_t *sc, pci_chipset_tag_t pc, 71 pcitag_t tag); 72 static bool ehci_pci_resume(device_t); 73 74 struct ehci_pci_softc { 75 ehci_softc_t sc; 76 pci_chipset_tag_t sc_pc; 77 pcitag_t sc_tag; 78 void *sc_ih; /* interrupt vectoring */ 79 }; 80 81 #define EHCI_MAX_BIOS_WAIT 1000 /* ms */ 82 83 static int 84 ehci_pci_match(struct device *parent, struct cfdata *match, 85 void *aux) 86 { 87 struct pci_attach_args *pa = (struct pci_attach_args *) aux; 88 89 if (PCI_CLASS(pa->pa_class) == PCI_CLASS_SERIALBUS && 90 PCI_SUBCLASS(pa->pa_class) == PCI_SUBCLASS_SERIALBUS_USB && 91 PCI_INTERFACE(pa->pa_class) == PCI_INTERFACE_EHCI) 92 return (1); 93 94 return (0); 95 } 96 97 static void 98 ehci_pci_attach(struct device *parent, struct device *self, void *aux) 99 { 100 struct ehci_pci_softc *sc = (struct ehci_pci_softc *)self; 101 struct pci_attach_args *pa = (struct pci_attach_args *)aux; 102 pci_chipset_tag_t pc = pa->pa_pc; 103 pcitag_t tag = pa->pa_tag; 104 char const *intrstr; 105 pci_intr_handle_t ih; 106 pcireg_t csr; 107 const char *vendor; 108 const char *devname = sc->sc.sc_bus.bdev.dv_xname; 109 char devinfo[256]; 110 usbd_status r; 111 int ncomp; 112 struct usb_pci *up; 113 114 aprint_naive(": USB controller\n"); 115 116 pci_devinfo(pa->pa_id, pa->pa_class, 0, devinfo, sizeof(devinfo)); 117 aprint_normal(": %s (rev. 0x%02x)\n", devinfo, 118 PCI_REVISION(pa->pa_class)); 119 120 /* Map I/O registers */ 121 if (pci_mapreg_map(pa, PCI_CBMEM, PCI_MAPREG_TYPE_MEM, 0, 122 &sc->sc.iot, &sc->sc.ioh, NULL, &sc->sc.sc_size)) { 123 aprint_error("%s: can't map memory space\n", devname); 124 return; 125 } 126 127 sc->sc_pc = pc; 128 sc->sc_tag = tag; 129 sc->sc.sc_bus.dmatag = pa->pa_dmat; 130 131 /* Enable the device. */ 132 csr = pci_conf_read(pc, tag, PCI_COMMAND_STATUS_REG); 133 pci_conf_write(pc, tag, PCI_COMMAND_STATUS_REG, 134 csr | PCI_COMMAND_MASTER_ENABLE); 135 136 /* Disable interrupts, so we don't get any spurious ones. */ 137 sc->sc.sc_offs = EREAD1(&sc->sc, EHCI_CAPLENGTH); 138 DPRINTF(("%s: offs=%d\n", devname, sc->sc.sc_offs)); 139 EOWRITE2(&sc->sc, EHCI_USBINTR, 0); 140 141 /* Map and establish the interrupt. */ 142 if (pci_intr_map(pa, &ih)) { 143 aprint_error("%s: couldn't map interrupt\n", devname); 144 return; 145 } 146 intrstr = pci_intr_string(pc, ih); 147 sc->sc_ih = pci_intr_establish(pc, ih, IPL_USB, ehci_intr, sc); 148 if (sc->sc_ih == NULL) { 149 aprint_error("%s: couldn't establish interrupt", devname); 150 if (intrstr != NULL) 151 aprint_normal(" at %s", intrstr); 152 aprint_normal("\n"); 153 return; 154 } 155 aprint_normal("%s: interrupting at %s\n", devname, intrstr); 156 157 switch(pci_conf_read(pc, tag, PCI_USBREV) & PCI_USBREV_MASK) { 158 case PCI_USBREV_PRE_1_0: 159 case PCI_USBREV_1_0: 160 case PCI_USBREV_1_1: 161 sc->sc.sc_bus.usbrev = USBREV_UNKNOWN; 162 aprint_verbose("%s: pre-2.0 USB rev\n", devname); 163 return; 164 case PCI_USBREV_2_0: 165 sc->sc.sc_bus.usbrev = USBREV_2_0; 166 break; 167 default: 168 sc->sc.sc_bus.usbrev = USBREV_UNKNOWN; 169 break; 170 } 171 172 /* Figure out vendor for root hub descriptor. */ 173 vendor = pci_findvendor(pa->pa_id); 174 sc->sc.sc_id_vendor = PCI_VENDOR(pa->pa_id); 175 if (vendor) 176 strlcpy(sc->sc.sc_vendor, vendor, sizeof(sc->sc.sc_vendor)); 177 else 178 snprintf(sc->sc.sc_vendor, sizeof(sc->sc.sc_vendor), 179 "vendor 0x%04x", PCI_VENDOR(pa->pa_id)); 180 181 /* Enable workaround for dropped interrupts as required */ 182 switch (sc->sc.sc_id_vendor) { 183 case PCI_VENDOR_ATI: 184 case PCI_VENDOR_VIATECH: 185 sc->sc.sc_flags |= EHCIF_DROPPED_INTR_WORKAROUND; 186 aprint_normal("%s: dropped intr workaround enabled\n", devname); 187 break; 188 default: 189 break; 190 } 191 192 /* 193 * Find companion controllers. According to the spec they always 194 * have lower function numbers so they should be enumerated already. 195 */ 196 ncomp = 0; 197 TAILQ_FOREACH(up, &ehci_pci_alldevs, next) { 198 if (up->bus == pa->pa_bus && up->device == pa->pa_device) { 199 DPRINTF(("ehci_pci_attach: companion %s\n", 200 USBDEVNAME(up->usb->bdev))); 201 sc->sc.sc_comps[ncomp++] = up->usb; 202 if (ncomp >= EHCI_COMPANION_MAX) 203 break; 204 } 205 } 206 sc->sc.sc_ncomp = ncomp; 207 208 ehci_get_ownership(&sc->sc, pc, tag); 209 210 r = ehci_init(&sc->sc); 211 if (r != USBD_NORMAL_COMPLETION) { 212 aprint_error("%s: init failed, error=%d\n", devname, r); 213 return; 214 } 215 216 if (!pmf_device_register(self, ehci_suspend, ehci_pci_resume)) 217 aprint_error_dev(self, "couldn't establish power handler\n"); 218 219 /* Attach usb device. */ 220 sc->sc.sc_child = config_found((void *)sc, &sc->sc.sc_bus, 221 usbctlprint); 222 } 223 224 static int 225 ehci_pci_detach(device_ptr_t self, int flags) 226 { 227 struct ehci_pci_softc *sc = (struct ehci_pci_softc *)self; 228 int rv; 229 230 pmf_device_deregister(self); 231 rv = ehci_detach(&sc->sc, flags); 232 if (rv) 233 return (rv); 234 if (sc->sc_ih != NULL) { 235 pci_intr_disestablish(sc->sc_pc, sc->sc_ih); 236 sc->sc_ih = NULL; 237 } 238 if (sc->sc.sc_size) { 239 bus_space_unmap(sc->sc.iot, sc->sc.ioh, sc->sc.sc_size); 240 sc->sc.sc_size = 0; 241 } 242 return (0); 243 } 244 245 CFATTACH_DECL(ehci_pci, sizeof(struct ehci_pci_softc), 246 ehci_pci_match, ehci_pci_attach, ehci_pci_detach, ehci_activate); 247 248 #ifdef EHCI_DEBUG 249 static void 250 ehci_dump_caps(ehci_softc_t *sc, pci_chipset_tag_t pc, pcitag_t tag) 251 { 252 u_int32_t cparams, legctlsts, addr, cap, id; 253 int maxdump = 10; 254 255 cparams = EREAD4(sc, EHCI_HCCPARAMS); 256 addr = EHCI_HCC_EECP(cparams); 257 while (addr != 0) { 258 cap = pci_conf_read(pc, tag, addr); 259 id = EHCI_CAP_GET_ID(cap); 260 switch (id) { 261 case EHCI_CAP_ID_LEGACY: 262 legctlsts = pci_conf_read(pc, tag, 263 addr + PCI_EHCI_USBLEGCTLSTS); 264 printf("ehci_dump_caps: legsup=0x%08x " 265 "legctlsts=0x%08x\n", cap, legctlsts); 266 break; 267 default: 268 printf("ehci_dump_caps: cap=0x%08x\n", cap); 269 break; 270 } 271 if (--maxdump < 0) 272 break; 273 addr = EHCI_CAP_GET_NEXT(cap); 274 } 275 } 276 #endif 277 278 static void 279 ehci_get_ownership(ehci_softc_t *sc, pci_chipset_tag_t pc, pcitag_t tag) 280 { 281 const char *devname = sc->sc_bus.bdev.dv_xname; 282 u_int32_t cparams, addr, cap, legsup; 283 int maxcap = 10; 284 int ms; 285 286 #ifdef EHCI_DEBUG 287 if (ehcidebug) 288 ehci_dump_caps(sc, pc, tag); 289 #endif 290 cparams = EREAD4(sc, EHCI_HCCPARAMS); 291 addr = EHCI_HCC_EECP(cparams); 292 while (addr != 0) { 293 cap = pci_conf_read(pc, tag, addr); 294 if (EHCI_CAP_GET_ID(cap) == EHCI_CAP_ID_LEGACY) 295 break; 296 if (--maxcap < 0) { 297 aprint_normal("%s: broken extended capabilities " 298 "ignored\n", devname); 299 return; 300 } 301 addr = EHCI_CAP_GET_NEXT(cap); 302 } 303 304 /* If the USB legacy capability is not specified, we are done */ 305 if (addr == 0) 306 return; 307 308 legsup = pci_conf_read(pc, tag, addr + PCI_EHCI_USBLEGSUP); 309 /* Ask BIOS to give up ownership */ 310 legsup |= EHCI_LEG_HC_OS_OWNED; 311 pci_conf_write(pc, tag, addr + PCI_EHCI_USBLEGSUP, legsup); 312 for (ms = 0; ms < EHCI_MAX_BIOS_WAIT; ms++) { 313 legsup = pci_conf_read(pc, tag, addr + PCI_EHCI_USBLEGSUP); 314 if (!(legsup & EHCI_LEG_HC_BIOS_OWNED)) 315 break; 316 delay(1000); 317 } 318 if (ms == EHCI_MAX_BIOS_WAIT) { 319 aprint_normal("%s: BIOS refuses to give up ownership, " 320 "using force\n", devname); 321 pci_conf_write(pc, tag, addr + PCI_EHCI_USBLEGSUP, 0); 322 pci_conf_write(pc, tag, addr + PCI_EHCI_USBLEGCTLSTS, 0); 323 } else { 324 aprint_verbose("%s: BIOS has given up ownership\n", devname); 325 } 326 } 327 328 static bool 329 ehci_pci_resume(device_t dv) 330 { 331 struct ehci_pci_softc *sc = device_private(dv); 332 333 ehci_get_ownership(&sc->sc, sc->sc_pc, sc->sc_tag); 334 return ehci_resume(dv); 335 } 336