2 * Copyright (c) 2013 Oleksandr Tymoshenko <gonzo@freebsd.org>
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 #include <sys/cdefs.h>
27 __FBSDID("$FreeBSD$");
29 #include <sys/stdint.h>
30 #include <sys/stddef.h>
31 #include <sys/param.h>
32 #include <sys/queue.h>
33 #include <sys/types.h>
34 #include <sys/systm.h>
35 #include <sys/kernel.h>
37 #include <sys/module.h>
39 #include <sys/mutex.h>
40 #include <sys/condvar.h>
41 #include <sys/sysctl.h>
43 #include <sys/unistd.h>
44 #include <sys/callout.h>
45 #include <sys/malloc.h>
48 #include <dev/fdt/fdt_common.h>
49 #include <dev/ofw/openfirm.h>
50 #include <dev/ofw/ofw_bus.h>
51 #include <dev/ofw/ofw_bus_subr.h>
53 #include <dev/usb/usb.h>
54 #include <dev/usb/usbdi.h>
56 #include <dev/usb/usb_core.h>
57 #include <dev/usb/usb_busdma.h>
58 #include <dev/usb/usb_process.h>
59 #include <dev/usb/usb_util.h>
61 #define USB_DEBUG_VAR usbssdebug
63 #include <dev/usb/usb_controller.h>
64 #include <dev/usb/usb_bus.h>
65 #include <dev/usb/controller/musb_otg.h>
66 #include <dev/usb/usb_debug.h>
70 #include <arm/ti/ti_prcm.h>
71 #include <arm/ti/ti_scm.h>
72 #include <arm/ti/am335x/am335x_scm.h>
74 #define AM335X_USB_PORTS 2
76 #define USBSS_REVREG 0x00
77 #define USBSS_SYSCONFIG 0x10
78 #define USBSS_SYSCONFIG_SRESET 1
80 #define USBCTRL_REV 0x00
81 #define USBCTRL_CTRL 0x14
82 #define USBCTRL_STAT 0x18
83 #define USBCTRL_IRQ_STAT0 0x30
84 #define IRQ_STAT0_RXSHIFT 16
85 #define IRQ_STAT0_TXSHIFT 0
86 #define USBCTRL_IRQ_STAT1 0x34
87 #define IRQ_STAT1_DRVVBUS (1 << 8)
88 #define USBCTRL_INTEN_SET0 0x38
89 #define USBCTRL_INTEN_SET1 0x3C
90 #define USBCTRL_INTEN_USB_ALL 0x1ff
91 #define USBCTRL_INTEN_USB_SOF (1 << 3)
92 #define USBCTRL_INTEN_CLR0 0x40
93 #define USBCTRL_INTEN_CLR1 0x44
94 #define USBCTRL_UTMI 0xE0
95 #define USBCTRL_UTMI_FSDATAEXT (1 << 1)
96 #define USBCTRL_MODE 0xE8
97 #define USBCTRL_MODE_IDDIG (1 << 8)
98 #define USBCTRL_MODE_IDDIGMUX (1 << 7)
100 /* USBSS resource + 2 MUSB ports */
103 #define RES_USBCTRL(i) (3*i+1)
104 #define RES_USBPHY(i) (3*i+2)
105 #define RES_USBCORE(i) (3*i+3)
107 #define USB_WRITE4(sc, idx, reg, val) do { \
108 bus_write_4((sc)->sc_mem_res[idx], (reg), (val)); \
111 #define USB_READ4(sc, idx, reg) bus_read_4((sc)->sc_mem_res[idx], (reg))
113 #define USBSS_WRITE4(sc, reg, val) \
114 USB_WRITE4((sc), RES_USBSS, (reg), (val))
115 #define USBSS_READ4(sc, reg) \
116 USB_READ4((sc), RES_USBSS, (reg))
117 #define USBCTRL_WRITE4(sc, unit, reg, val) \
118 USB_WRITE4((sc), RES_USBCTRL(unit), (reg), (val))
119 #define USBCTRL_READ4(sc, unit, reg) \
120 USB_READ4((sc), RES_USBCTRL(unit), (reg))
121 #define USBPHY_WRITE4(sc, unit, reg, val) \
122 USB_WRITE4((sc), RES_USBPHY(unit), (reg), (val))
123 #define USBPHY_READ4(sc, unit, reg) \
124 USB_READ4((sc), RES_USBPHY(unit), (reg))
126 static struct resource_spec am335x_musbotg_mem_spec[] = {
127 { SYS_RES_MEMORY, 0, RF_ACTIVE },
128 { SYS_RES_MEMORY, 1, RF_ACTIVE },
129 { SYS_RES_MEMORY, 2, RF_ACTIVE },
130 { SYS_RES_MEMORY, 3, RF_ACTIVE },
131 { SYS_RES_MEMORY, 4, RF_ACTIVE },
132 { SYS_RES_MEMORY, 5, RF_ACTIVE },
133 { SYS_RES_MEMORY, 6, RF_ACTIVE },
137 static struct resource_spec am335x_musbotg_irq_spec[] = {
138 { SYS_RES_IRQ, 0, RF_ACTIVE },
139 { SYS_RES_IRQ, 1, RF_ACTIVE },
140 { SYS_RES_IRQ, 2, RF_ACTIVE },
145 static int usbssdebug = 0;
147 static SYSCTL_NODE(_hw_usb, OID_AUTO, am335x_usbss, CTLFLAG_RW, 0, "AM335x USBSS");
148 SYSCTL_INT(_hw_usb_am335x_usbss, OID_AUTO, debug, CTLFLAG_RW,
149 &usbssdebug, 0, "Debug level");
152 static device_probe_t musbotg_probe;
153 static device_attach_t musbotg_attach;
154 static device_detach_t musbotg_detach;
156 struct musbotg_super_softc {
157 struct musbotg_softc sc_otg[AM335X_USB_PORTS];
158 struct resource *sc_mem_res[AM335X_USB_PORTS*3+1];
159 struct resource *sc_irq_res[AM335X_USB_PORTS+1];
164 musbotg_vbus_poll(struct musbotg_super_softc *sc, int port)
168 if (sc->sc_otg[port].sc_mode == MUSB2_DEVICE_MODE)
169 musbotg_vbus_interrupt(&sc->sc_otg[port], 1);
171 stat = USBCTRL_READ4(sc, port, USBCTRL_STAT);
172 musbotg_vbus_interrupt(&sc->sc_otg[port], stat & 1);
177 * Arg to musbotg_clocks_on and musbot_clocks_off is
178 * a uint32_t * pointing to the SCM register offset.
180 static uint32_t USB_CTRL[] = {SCM_USB_CTRL0, SCM_USB_CTRL1};
183 musbotg_clocks_on(void *arg)
185 uint32_t c, reg = *(uint32_t *)arg;
187 ti_scm_reg_read_4(reg, &c);
188 c &= ~3; /* Enable power */
189 c |= 1 << 19; /* VBUS detect enable */
190 c |= 1 << 20; /* Session end enable */
191 ti_scm_reg_write_4(reg, c);
195 musbotg_clocks_off(void *arg)
197 uint32_t c, reg = *(uint32_t *)arg;
199 /* Disable power to PHY */
200 ti_scm_reg_read_4(reg, &c);
201 ti_scm_reg_write_4(reg, c | 3);
205 musbotg_ep_int_set(struct musbotg_softc *sc, int ep, int on)
207 struct musbotg_super_softc *ssc = sc->sc_platform_data;
210 epmask = ((1 << ep) << IRQ_STAT0_RXSHIFT);
211 epmask |= ((1 << ep) << IRQ_STAT0_TXSHIFT);
213 USBCTRL_WRITE4(ssc, sc->sc_id,
214 USBCTRL_INTEN_SET0, epmask);
216 USBCTRL_WRITE4(ssc, sc->sc_id,
217 USBCTRL_INTEN_CLR0, epmask);
221 musbotg_usbss_interrupt(void *arg)
223 panic("USBSS real interrupt");
227 musbotg_wrapper_interrupt(void *arg)
229 struct musbotg_softc *sc = arg;
230 struct musbotg_super_softc *ssc = sc->sc_platform_data;
231 uint32_t stat, stat0, stat1;
232 stat = USBCTRL_READ4(ssc, sc->sc_id, USBCTRL_STAT);
233 stat0 = USBCTRL_READ4(ssc, sc->sc_id, USBCTRL_IRQ_STAT0);
234 stat1 = USBCTRL_READ4(ssc, sc->sc_id, USBCTRL_IRQ_STAT1);
236 USBCTRL_WRITE4(ssc, sc->sc_id, USBCTRL_IRQ_STAT0, stat0);
238 USBCTRL_WRITE4(ssc, sc->sc_id, USBCTRL_IRQ_STAT1, stat1);
240 DPRINTFN(4, "port%d: stat0=%08x stat1=%08x, stat=%08x\n",
241 sc->sc_id, stat0, stat1, stat);
243 if (stat1 & IRQ_STAT1_DRVVBUS)
244 musbotg_vbus_interrupt(sc, stat & 1);
246 musbotg_interrupt(arg, ((stat0 >> 16) & 0xffff),
247 stat0 & 0xffff, stat1 & 0xff);
251 musbotg_probe(device_t dev)
254 if (!ofw_bus_status_okay(dev))
257 if (!ofw_bus_is_compatible(dev, "ti,musb-am33xx"))
260 device_set_desc(dev, "TI AM33xx integrated USB OTG controller");
262 return (BUS_PROBE_DEFAULT);
266 musbotg_attach(device_t dev)
268 struct musbotg_super_softc *sc = device_get_softc(dev);
273 /* Request the memory resources */
274 err = bus_alloc_resources(dev, am335x_musbotg_mem_spec,
278 "Error: could not allocate mem resources\n");
282 /* Request the IRQ resources */
283 err = bus_alloc_resources(dev, am335x_musbotg_irq_spec,
287 "Error: could not allocate irq resources\n");
291 /* Enable device clocks. */
292 ti_prcm_clk_enable(MUSB0_CLK);
295 * Reset USBSS, USB0 and USB1.
296 * The registers of USB subsystem must not be accessed while the
297 * reset pulse is active (200ns).
299 USBSS_WRITE4(sc, USBSS_SYSCONFIG, USBSS_SYSCONFIG_SRESET);
302 while (USBSS_READ4(sc, USBSS_SYSCONFIG) & USBSS_SYSCONFIG_SRESET) {
305 device_printf(dev, "reset timeout.\n");
310 /* Read the module revision. */
311 rev = USBSS_READ4(sc, USBSS_REVREG);
312 device_printf(dev, "TI AM335X USBSS v%d.%d.%d\n",
313 (rev >> 8) & 7, (rev >> 6) & 3, rev & 63);
315 err = bus_setup_intr(dev, sc->sc_irq_res[0],
316 INTR_TYPE_BIO | INTR_MPSAFE,
317 NULL, (driver_intr_t *)musbotg_usbss_interrupt, sc,
321 sc->sc_intr_hdl = NULL;
322 device_printf(dev, "Failed to setup USBSS interrupt\n");
326 for (i = 0; i < AM335X_USB_PORTS; i++) {
327 /* setup MUSB OTG USB controller interface softc */
328 sc->sc_otg[i].sc_clocks_on = &musbotg_clocks_on;
329 sc->sc_otg[i].sc_clocks_off = &musbotg_clocks_off;
330 sc->sc_otg[i].sc_clocks_arg = &USB_CTRL[i];
332 sc->sc_otg[i].sc_ep_int_set = musbotg_ep_int_set;
334 /* initialise some bus fields */
335 sc->sc_otg[i].sc_bus.parent = dev;
336 sc->sc_otg[i].sc_bus.devices = sc->sc_otg[i].sc_devices;
337 sc->sc_otg[i].sc_bus.devices_max = MUSB2_MAX_DEVICES;
338 sc->sc_otg[i].sc_bus.dma_bits = 32;
340 /* get all DMA memory */
341 if (usb_bus_mem_alloc_all(&sc->sc_otg[i].sc_bus,
342 USB_GET_DMA_TAG(dev), NULL)) {
344 "Failed allocate bus mem for musb%d\n", i);
347 sc->sc_otg[i].sc_io_res = sc->sc_mem_res[RES_USBCORE(i)];
348 sc->sc_otg[i].sc_io_tag =
349 rman_get_bustag(sc->sc_otg[i].sc_io_res);
350 sc->sc_otg[i].sc_io_hdl =
351 rman_get_bushandle(sc->sc_otg[i].sc_io_res);
352 sc->sc_otg[i].sc_io_size =
353 rman_get_size(sc->sc_otg[i].sc_io_res);
355 sc->sc_otg[i].sc_irq_res = sc->sc_irq_res[i+1];
357 sc->sc_otg[i].sc_bus.bdev = device_add_child(dev, "usbus", -1);
358 if (!(sc->sc_otg[i].sc_bus.bdev)) {
359 device_printf(dev, "No busdev for musb%d\n", i);
362 device_set_ivars(sc->sc_otg[i].sc_bus.bdev,
363 &sc->sc_otg[i].sc_bus);
365 err = bus_setup_intr(dev, sc->sc_otg[i].sc_irq_res,
366 INTR_TYPE_BIO | INTR_MPSAFE,
367 NULL, (driver_intr_t *)musbotg_wrapper_interrupt,
368 &sc->sc_otg[i], &sc->sc_otg[i].sc_intr_hdl);
370 sc->sc_otg[i].sc_intr_hdl = NULL;
372 "Failed to setup interrupt for musb%d\n", i);
376 sc->sc_otg[i].sc_id = i;
377 sc->sc_otg[i].sc_platform_data = sc;
379 sc->sc_otg[i].sc_mode = MUSB2_DEVICE_MODE;
381 sc->sc_otg[i].sc_mode = MUSB2_HOST_MODE;
384 * software-controlled function
387 if (sc->sc_otg[i].sc_mode == MUSB2_HOST_MODE) {
388 reg = USBCTRL_READ4(sc, i, USBCTRL_MODE);
389 reg |= USBCTRL_MODE_IDDIGMUX;
390 reg &= ~USBCTRL_MODE_IDDIG;
391 USBCTRL_WRITE4(sc, i, USBCTRL_MODE, reg);
392 USBCTRL_WRITE4(sc, i, USBCTRL_UTMI,
393 USBCTRL_UTMI_FSDATAEXT);
395 reg = USBCTRL_READ4(sc, i, USBCTRL_MODE);
396 reg |= USBCTRL_MODE_IDDIGMUX;
397 reg |= USBCTRL_MODE_IDDIG;
398 USBCTRL_WRITE4(sc, i, USBCTRL_MODE, reg);
401 reg = USBCTRL_INTEN_USB_ALL & ~USBCTRL_INTEN_USB_SOF;
402 USBCTRL_WRITE4(sc, i, USBCTRL_INTEN_SET1, reg);
403 USBCTRL_WRITE4(sc, i, USBCTRL_INTEN_CLR0, 0xffffffff);
405 err = musbotg_init(&sc->sc_otg[i]);
407 err = device_probe_and_attach(sc->sc_otg[i].sc_bus.bdev);
412 /* poll VBUS one time */
413 musbotg_vbus_poll(sc, i);
424 musbotg_detach(device_t dev)
426 struct musbotg_super_softc *sc = device_get_softc(dev);
431 for (i = 0; i < AM335X_USB_PORTS; i++) {
432 if (sc->sc_otg[i].sc_bus.bdev) {
433 bdev = sc->sc_otg[i].sc_bus.bdev;
435 device_delete_child(dev, bdev);
438 if (sc->sc_otg[i].sc_irq_res && sc->sc_otg[i].sc_intr_hdl) {
440 * only call musbotg_uninit() after musbotg_init()
442 musbotg_uninit(&sc->sc_otg[i]);
444 err = bus_teardown_intr(dev, sc->sc_otg[i].sc_irq_res,
445 sc->sc_otg[i].sc_intr_hdl);
446 sc->sc_otg[i].sc_intr_hdl = NULL;
449 usb_bus_mem_free_all(&sc->sc_otg[i].sc_bus, NULL);
452 if (sc->sc_intr_hdl) {
453 bus_teardown_intr(dev, sc->sc_irq_res[0],
455 sc->sc_intr_hdl = NULL;
459 /* Free resources if any */
460 if (sc->sc_mem_res[0])
461 bus_release_resources(dev, am335x_musbotg_mem_spec,
464 if (sc->sc_irq_res[0])
465 bus_release_resources(dev, am335x_musbotg_irq_spec,
468 /* during module unload there are lots of children leftover */
469 device_delete_children(dev);
474 static device_method_t musbotg_methods[] = {
475 /* Device interface */
476 DEVMETHOD(device_probe, musbotg_probe),
477 DEVMETHOD(device_attach, musbotg_attach),
478 DEVMETHOD(device_detach, musbotg_detach),
479 DEVMETHOD(device_suspend, bus_generic_suspend),
480 DEVMETHOD(device_resume, bus_generic_resume),
481 DEVMETHOD(device_shutdown, bus_generic_shutdown),
486 static driver_t musbotg_driver = {
488 .methods = musbotg_methods,
489 .size = sizeof(struct musbotg_super_softc),
492 static devclass_t musbotg_devclass;
494 DRIVER_MODULE(musbotg, simplebus, musbotg_driver, musbotg_devclass, 0, 0);
495 MODULE_DEPEND(musbotg, usb, 1, 1, 1);