2 * Copyright (c) 2010-2012 Semihalf
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/module.h>
37 #include <sys/queue.h>
39 #include <sys/lockmgr.h>
40 #include <sys/condvar.h>
43 #include <dev/ofw/ofw_bus.h>
44 #include <dev/ofw/ofw_bus_subr.h>
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>
57 #include <machine/bus.h>
58 #include <machine/clock.h>
59 #include <machine/resource.h>
61 #include <powerpc/include/tlb.h>
63 #include "opt_platform.h"
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);
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),
83 DEVMETHOD(bus_print_child, bus_generic_print_child),
88 /* kobj_class definition */
89 static driver_t ehci_driver = {
92 sizeof(struct ehci_softc)
95 static devclass_t ehci_devclass;
97 DRIVER_MODULE(ehci, simplebus, ehci_driver, ehci_devclass, 0, 0);
98 MODULE_DEPEND(ehci, usb, 1, 1, 1);
103 #define FSL_EHCI_REG_OFF 0x100
104 #define FSL_EHCI_REG_SIZE 0x300
107 * Internal interface registers' offsets.
108 * Offsets from 0x000 ehci dev space, big-endian access.
113 AGE_CNT_THRESH = 0x408,
118 /* CONTROL register bit flags */
121 UTMI_PHY_EN = 0x00000200,
122 ULPI_INT_EN = 0x00000001
125 /* SI_CTRL register bit flags */
131 #define SNOOP_RANGE_2GB 0x1E
134 * Operational registers' offsets.
135 * Offsets from USBCMD register, little-endian access.
137 enum special_op_reg {
143 /* USBMODE register bit flags */
149 #define PORT_POWER_MASK 0x00001000
156 set_to_host_mode(ehci_softc_t *sc)
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);
165 enable_usb(device_t dev, bus_space_tag_t iot, bus_space_handle_t ioh)
172 tmp = bus_space_read_4(iot, ioh, CONTROL) | USB_EN;
174 node = ofw_bus_get_node(dev);
176 (OF_getprop_alloc(node, "phy_type", 1, (void **)&phy_type) > 0)) {
177 if (strncasecmp(phy_type, "utmi", strlen("utmi")) == 0)
179 OF_prop_free(phy_type);
181 bus_space_write_4(iot, ioh, CONTROL, tmp);
185 set_32b_prefetch(bus_space_tag_t iot, bus_space_handle_t ioh)
188 bus_space_write_4(iot, ioh, SI_CTRL, FETCH_32);
192 set_snooping(bus_space_tag_t iot, bus_space_handle_t ioh)
195 bus_space_write_4(iot, ioh, SNOOP1, SNOOP_RANGE_2GB);
196 bus_space_write_4(iot, ioh, SNOOP2, 0x80000000 | SNOOP_RANGE_2GB);
200 clear_port_power(ehci_softc_t *sc)
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);
212 fsl_ehci_probe(device_t dev)
215 if (!ofw_bus_status_okay(dev))
218 if (((ofw_bus_is_compatible(dev, "fsl-usb2-dr")) == 0) &&
219 ((ofw_bus_is_compatible(dev, "fsl-usb2-mph")) == 0))
222 device_set_desc(dev, "Freescale integrated EHCI controller");
224 return (BUS_PROBE_DEFAULT);
228 fsl_ehci_attach(device_t self)
233 bus_space_handle_t ioh;
236 sc = device_get_softc(self);
239 sc->sc_bus.parent = self;
240 sc->sc_bus.devices = sc->sc_devices;
241 sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
242 sc->sc_bus.dma_bits = 32;
244 if (usb_bus_mem_alloc_all(&sc->sc_bus,
245 USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc))
248 /* Allocate io resource for EHCI */
249 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
251 if (sc->sc_io_res == NULL) {
252 err = fsl_ehci_detach(self);
255 "Detach of the driver failed with error %d\n",
260 iot = rman_get_bustag(sc->sc_io_res);
263 * Set handle to USB related registers subregion used by generic
266 ioh = rman_get_bushandle(sc->sc_io_res);
268 err = bus_space_subregion(iot, ioh, FSL_EHCI_REG_OFF, FSL_EHCI_REG_SIZE,
271 err = fsl_ehci_detach(self);
274 "Detach of the driver failed with error %d\n",
280 /* Set little-endian tag for use by the generic EHCI driver */
281 sc->sc_io_tag = &bs_le_tag;
284 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
286 if (sc->sc_irq_res == NULL) {
287 err = fsl_ehci_detach(self);
290 "Detach of the driver failed with error %d\n",
296 /* Setup interrupt handler */
297 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
298 NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
300 device_printf(self, "Could not setup irq, %d\n", err);
301 sc->sc_intr_hdl = NULL;
302 err = fsl_ehci_detach(self);
305 "Detach of the driver failed with error %d\n",
312 sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
313 if (!sc->sc_bus.bdev) {
314 device_printf(self, "Could not add USB device\n");
315 err = fsl_ehci_detach(self);
318 "Detach of the driver failed with error %d\n",
323 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
325 sc->sc_id_vendor = 0x1234;
326 strlcpy(sc->sc_vendor, "Freescale", sizeof(sc->sc_vendor));
329 err = ehci_reset(sc);
331 device_printf(self, "Could not reset the controller\n");
332 err = fsl_ehci_detach(self);
335 "Detach of the driver failed with error %d\n",
341 enable_usb(self, iot, ioh);
342 set_snooping(iot, ioh);
343 set_to_host_mode(sc);
344 set_32b_prefetch(iot, ioh);
347 * If usb subsystem is enabled in U-Boot, port power has to be turned
348 * off to allow proper discovery of devices during boot up.
350 clear_port_power(sc);
353 sc->sc_flags |= EHCI_SCFLG_DONTRESET | EHCI_SCFLG_NORESTERM;
357 sc->sc_flags |= EHCI_SCFLG_DONEINIT;
358 err = device_probe_and_attach(sc->sc_bus.bdev);
362 device_printf(self, "USB init failed err=%d\n", err);
363 err = fsl_ehci_detach(self);
366 "Detach of the driver failed with error %d\n",
376 fsl_ehci_detach(device_t self)
382 sc = device_get_softc(self);
384 * only call ehci_detach() after ehci_init()
386 if (sc->sc_flags & EHCI_SCFLG_DONEINIT) {
388 sc->sc_flags &= ~EHCI_SCFLG_DONEINIT;
391 /* Disable interrupts that might have been switched on in ehci_init */
392 if (sc->sc_io_tag && sc->sc_io_hdl)
393 bus_space_write_4(sc->sc_io_tag, sc->sc_io_hdl, EHCI_USBINTR, 0);
395 if (sc->sc_irq_res && sc->sc_intr_hdl) {
396 err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
398 device_printf(self, "Could not tear down irq, %d\n",
402 sc->sc_intr_hdl = NULL;
405 if (sc->sc_bus.bdev) {
406 device_delete_child(self, sc->sc_bus.bdev);
407 sc->sc_bus.bdev = NULL;
410 /* During module unload there are lots of children leftover */
411 device_delete_children(self);
413 if (sc->sc_irq_res) {
414 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
415 sc->sc_irq_res = NULL;
419 bus_release_resource(self, SYS_RES_MEMORY, 0, sc->sc_io_res);
420 sc->sc_io_res = NULL;