sys/dev/usb/controller/ehci_fsl.c

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