1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2010-2012 Semihalf 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #include <sys/cdefs.h> 30 __FBSDID("$FreeBSD$"); 31 32 #include "opt_bus.h" 33 34 #include <sys/param.h> 35 #include <sys/systm.h> 36 #include <sys/kernel.h> 37 #include <sys/module.h> 38 #include <sys/bus.h> 39 #include <sys/queue.h> 40 #include <sys/lock.h> 41 #include <sys/lockmgr.h> 42 #include <sys/condvar.h> 43 #include <sys/rman.h> 44 45 #include <dev/ofw/ofw_bus.h> 46 #include <dev/ofw/ofw_bus_subr.h> 47 48 #include <dev/usb/usb.h> 49 #include <dev/usb/usbdi.h> 50 #include <dev/usb/usb_core.h> 51 #include <dev/usb/usb_busdma.h> 52 #include <dev/usb/usb_process.h> 53 #include <dev/usb/usb_util.h> 54 #include <dev/usb/usb_controller.h> 55 #include <dev/usb/usb_bus.h> 56 #include <dev/usb/controller/ehci.h> 57 #include <dev/usb/controller/ehcireg.h> 58 59 #include <machine/bus.h> 60 #include <machine/clock.h> 61 #include <machine/resource.h> 62 63 #include <powerpc/include/tlb.h> 64 65 #include "opt_platform.h" 66 67 /* 68 * Register the driver 69 */ 70 /* Forward declarations */ 71 static int fsl_ehci_attach(device_t self); 72 static int fsl_ehci_detach(device_t self); 73 static int fsl_ehci_probe(device_t self); 74 75 static device_method_t ehci_methods[] = { 76 /* Device interface */ 77 DEVMETHOD(device_probe, fsl_ehci_probe), 78 DEVMETHOD(device_attach, fsl_ehci_attach), 79 DEVMETHOD(device_detach, fsl_ehci_detach), 80 DEVMETHOD(device_suspend, bus_generic_suspend), 81 DEVMETHOD(device_resume, bus_generic_resume), 82 DEVMETHOD(device_shutdown, bus_generic_shutdown), 83 84 /* Bus interface */ 85 DEVMETHOD(bus_print_child, bus_generic_print_child), 86 { 0, 0 } 87 }; 88 89 /* kobj_class definition */ 90 static driver_t ehci_driver = { 91 "ehci", 92 ehci_methods, 93 sizeof(struct ehci_softc) 94 }; 95 96 DRIVER_MODULE(ehci, simplebus, ehci_driver, 0, 0); 97 MODULE_DEPEND(ehci, usb, 1, 1, 1); 98 99 /* 100 * Private defines 101 */ 102 #define FSL_EHCI_REG_OFF 0x100 103 #define FSL_EHCI_REG_SIZE 0x300 104 105 /* 106 * Internal interface registers' offsets. 107 * Offsets from 0x000 ehci dev space, big-endian access. 108 */ 109 enum internal_reg { 110 SNOOP1 = 0x400, 111 SNOOP2 = 0x404, 112 AGE_CNT_THRESH = 0x408, 113 SI_CTRL = 0x410, 114 CONTROL = 0x500 115 }; 116 117 /* CONTROL register bit flags */ 118 enum control_flags { 119 USB_EN = 0x00000004, 120 UTMI_PHY_EN = 0x00000200, 121 ULPI_INT_EN = 0x00000001 122 }; 123 124 /* SI_CTRL register bit flags */ 125 enum si_ctrl_flags { 126 FETCH_32 = 1, 127 FETCH_64 = 0 128 }; 129 130 #define SNOOP_RANGE_2GB 0x1E 131 132 /* 133 * Operational registers' offsets. 134 * Offsets from USBCMD register, little-endian access. 135 */ 136 enum special_op_reg { 137 USBMODE = 0x0A8, 138 PORTSC = 0x084, 139 ULPI_VIEWPORT = 0x70 140 }; 141 142 /* USBMODE register bit flags */ 143 enum usbmode_flags { 144 HOST_MODE = 0x3, 145 DEVICE_MODE = 0x2 146 }; 147 148 #define PORT_POWER_MASK 0x00001000 149 150 /* 151 * Private methods 152 */ 153 154 static void 155 set_to_host_mode(ehci_softc_t *sc) 156 { 157 int tmp; 158 159 tmp = bus_space_read_4(sc->sc_io_tag, sc->sc_io_hdl, USBMODE); 160 bus_space_write_4(sc->sc_io_tag, sc->sc_io_hdl, USBMODE, tmp | HOST_MODE); 161 } 162 163 static void 164 enable_usb(device_t dev, bus_space_tag_t iot, bus_space_handle_t ioh) 165 { 166 int tmp; 167 phandle_t node; 168 char *phy_type; 169 170 phy_type = NULL; 171 tmp = bus_space_read_4(iot, ioh, CONTROL) | USB_EN; 172 173 node = ofw_bus_get_node(dev); 174 if ((node != 0) && 175 (OF_getprop_alloc(node, "phy_type", (void **)&phy_type) > 0)) { 176 if (strncasecmp(phy_type, "utmi", strlen("utmi")) == 0) 177 tmp |= UTMI_PHY_EN; 178 OF_prop_free(phy_type); 179 } 180 bus_space_write_4(iot, ioh, CONTROL, tmp); 181 } 182 183 static void 184 set_32b_prefetch(bus_space_tag_t iot, bus_space_handle_t ioh) 185 { 186 187 bus_space_write_4(iot, ioh, SI_CTRL, FETCH_32); 188 } 189 190 static void 191 set_snooping(bus_space_tag_t iot, bus_space_handle_t ioh) 192 { 193 194 bus_space_write_4(iot, ioh, SNOOP1, SNOOP_RANGE_2GB); 195 bus_space_write_4(iot, ioh, SNOOP2, 0x80000000 | SNOOP_RANGE_2GB); 196 } 197 198 static void 199 clear_port_power(ehci_softc_t *sc) 200 { 201 int tmp; 202 203 tmp = bus_space_read_4(sc->sc_io_tag, sc->sc_io_hdl, PORTSC); 204 bus_space_write_4(sc->sc_io_tag, sc->sc_io_hdl, PORTSC, tmp & ~PORT_POWER_MASK); 205 } 206 207 /* 208 * Public methods 209 */ 210 static int 211 fsl_ehci_probe(device_t dev) 212 { 213 214 if (!ofw_bus_status_okay(dev)) 215 return (ENXIO); 216 217 if (((ofw_bus_is_compatible(dev, "fsl-usb2-dr")) == 0) && 218 ((ofw_bus_is_compatible(dev, "fsl-usb2-mph")) == 0)) 219 return (ENXIO); 220 221 device_set_desc(dev, "Freescale integrated EHCI controller"); 222 223 return (BUS_PROBE_DEFAULT); 224 } 225 226 static int 227 fsl_ehci_attach(device_t self) 228 { 229 ehci_softc_t *sc; 230 int rid; 231 int err; 232 bus_space_handle_t ioh; 233 bus_space_tag_t iot; 234 235 sc = device_get_softc(self); 236 rid = 0; 237 238 sc->sc_bus.parent = self; 239 sc->sc_bus.devices = sc->sc_devices; 240 sc->sc_bus.devices_max = EHCI_MAX_DEVICES; 241 sc->sc_bus.dma_bits = 32; 242 243 if (usb_bus_mem_alloc_all(&sc->sc_bus, 244 USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) 245 return (ENOMEM); 246 247 /* Allocate io resource for EHCI */ 248 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, 249 RF_ACTIVE); 250 if (sc->sc_io_res == NULL) { 251 err = fsl_ehci_detach(self); 252 if (err) { 253 device_printf(self, 254 "Detach of the driver failed with error %d\n", 255 err); 256 } 257 return (ENXIO); 258 } 259 iot = rman_get_bustag(sc->sc_io_res); 260 261 /* 262 * Set handle to USB related registers subregion used by generic 263 * EHCI driver 264 */ 265 ioh = rman_get_bushandle(sc->sc_io_res); 266 267 err = bus_space_subregion(iot, ioh, FSL_EHCI_REG_OFF, FSL_EHCI_REG_SIZE, 268 &sc->sc_io_hdl); 269 if (err != 0) { 270 err = fsl_ehci_detach(self); 271 if (err) { 272 device_printf(self, 273 "Detach of the driver failed with error %d\n", 274 err); 275 } 276 return (ENXIO); 277 } 278 279 /* Set little-endian tag for use by the generic EHCI driver */ 280 sc->sc_io_tag = &bs_le_tag; 281 282 /* Allocate irq */ 283 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 284 RF_ACTIVE); 285 if (sc->sc_irq_res == NULL) { 286 err = fsl_ehci_detach(self); 287 if (err) { 288 device_printf(self, 289 "Detach of the driver failed with error %d\n", 290 err); 291 } 292 return (ENXIO); 293 } 294 295 /* Setup interrupt handler */ 296 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 297 NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl); 298 if (err) { 299 device_printf(self, "Could not setup irq, %d\n", err); 300 sc->sc_intr_hdl = NULL; 301 err = fsl_ehci_detach(self); 302 if (err) { 303 device_printf(self, 304 "Detach of the driver failed with error %d\n", 305 err); 306 } 307 return (ENXIO); 308 } 309 310 /* Add USB device */ 311 sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 312 if (!sc->sc_bus.bdev) { 313 device_printf(self, "Could not add USB device\n"); 314 err = fsl_ehci_detach(self); 315 if (err) { 316 device_printf(self, 317 "Detach of the driver failed with error %d\n", 318 err); 319 } 320 return (ENOMEM); 321 } 322 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 323 324 sc->sc_id_vendor = 0x1234; 325 strlcpy(sc->sc_vendor, "Freescale", sizeof(sc->sc_vendor)); 326 327 /* Enable USB */ 328 err = ehci_reset(sc); 329 if (err) { 330 device_printf(self, "Could not reset the controller\n"); 331 err = fsl_ehci_detach(self); 332 if (err) { 333 device_printf(self, 334 "Detach of the driver failed with error %d\n", 335 err); 336 } 337 return (ENXIO); 338 } 339 340 enable_usb(self, iot, ioh); 341 set_snooping(iot, ioh); 342 set_to_host_mode(sc); 343 set_32b_prefetch(iot, ioh); 344 345 /* 346 * If usb subsystem is enabled in U-Boot, port power has to be turned 347 * off to allow proper discovery of devices during boot up. 348 */ 349 clear_port_power(sc); 350 351 /* Set flags */ 352 sc->sc_flags |= EHCI_SCFLG_DONTRESET | EHCI_SCFLG_NORESTERM; 353 354 err = ehci_init(sc); 355 if (!err) { 356 sc->sc_flags |= EHCI_SCFLG_DONEINIT; 357 err = device_probe_and_attach(sc->sc_bus.bdev); 358 } 359 360 if (err) { 361 device_printf(self, "USB init failed err=%d\n", err); 362 err = fsl_ehci_detach(self); 363 if (err) { 364 device_printf(self, 365 "Detach of the driver failed with error %d\n", 366 err); 367 } 368 return (EIO); 369 } 370 371 return (0); 372 } 373 374 static int 375 fsl_ehci_detach(device_t self) 376 { 377 378 int err; 379 ehci_softc_t *sc; 380 381 sc = device_get_softc(self); 382 /* 383 * only call ehci_detach() after ehci_init() 384 */ 385 if (sc->sc_flags & EHCI_SCFLG_DONEINIT) { 386 ehci_detach(sc); 387 sc->sc_flags &= ~EHCI_SCFLG_DONEINIT; 388 } 389 390 /* Disable interrupts that might have been switched on in ehci_init */ 391 if (sc->sc_io_tag && sc->sc_io_hdl) 392 bus_space_write_4(sc->sc_io_tag, sc->sc_io_hdl, EHCI_USBINTR, 0); 393 394 if (sc->sc_irq_res && sc->sc_intr_hdl) { 395 err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 396 if (err) { 397 device_printf(self, "Could not tear down irq, %d\n", 398 err); 399 return (err); 400 } 401 sc->sc_intr_hdl = NULL; 402 } 403 404 if (sc->sc_bus.bdev) { 405 device_delete_child(self, sc->sc_bus.bdev); 406 sc->sc_bus.bdev = NULL; 407 } 408 409 /* During module unload there are lots of children leftover */ 410 device_delete_children(self); 411 412 if (sc->sc_irq_res) { 413 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 414 sc->sc_irq_res = NULL; 415 } 416 417 if (sc->sc_io_res) { 418 bus_release_resource(self, SYS_RES_MEMORY, 0, sc->sc_io_res); 419 sc->sc_io_res = NULL; 420 sc->sc_io_tag = 0; 421 sc->sc_io_hdl = 0; 422 } 423 424 return (0); 425 } 426