2 * Copyright (c) 2012-2013 Thomas Skibo
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
30 * A host-controller driver for Zynq-7000's USB OTG controller.
32 * Reference: Zynq-7000 All Programmable SoC Technical Reference Manual.
33 * (v1.4) November 16, 2012. Xilinx doc UG585. Ch. 15 covers the USB
34 * controller and register definitions are in appendix B.34.
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
41 #include <sys/param.h>
42 #include <sys/systm.h>
45 #include <sys/kernel.h>
47 #include <sys/module.h>
48 #include <sys/mutex.h>
49 #include <sys/condvar.h>
50 #include <sys/resource.h>
53 #include <machine/bus.h>
54 #include <machine/resource.h>
55 #include <machine/stdarg.h>
57 #include <dev/fdt/fdt_common.h>
58 #include <dev/ofw/ofw_bus.h>
59 #include <dev/ofw/ofw_bus_subr.h>
61 #include <dev/usb/usb.h>
62 #include <dev/usb/usbdi.h>
64 #include <dev/usb/usb_core.h>
65 #include <dev/usb/usb_busdma.h>
66 #include <dev/usb/usb_process.h>
67 #include <dev/usb/usb_util.h>
69 #include <dev/usb/usb_controller.h>
70 #include <dev/usb/usb_bus.h>
71 #include <dev/usb/controller/ehci.h>
72 #include <dev/usb/controller/ehcireg.h>
75 /* Register definitions. */
76 #define ZY7_USB_ID 0x0000
77 #define ZY7_USB_HWGENERAL 0x0004
78 #define ZY7_USB_HWHOST 0x0008
79 #define ZY7_USB_HWDEVICE 0x000c
80 #define ZY7_USB_HWTXBUF 0x0010
81 #define ZY7_USB_HWRXBUF 0x0014
82 #define ZY7_USB_GPTIMER0LD 0x0080
83 #define ZY7_USB_GPTIMER0CTRL 0x0084
84 #define ZY7_USB_GPTIMER1LD 0x0088
85 #define ZY7_USB_GPTIMER1CTRL 0x008c
86 #define ZY7_USB_SBUSCFG 0x0090
87 #define ZY7_USB_CAPLENGTH_HCIVERSION 0x0100
88 #define ZY7_USB_HCSPARAMS 0x0104
89 #define ZY7_USB_HCCPARAMS 0x0108
90 #define ZY7_USB_DCIVERSION 0x0120
91 #define ZY7_USB_DCCPARAMS 0x0124
92 #define ZY7_USB_USBCMD 0x0140
93 #define ZY7_USB_USBSTS 0x0144
94 #define ZY7_USB_USBINTR 0x0148
95 #define ZY7_USB_FRINDEX 0x014c
96 #define ZY7_USB_PERIODICLISTBASE_DEICEADDR 0x0154
97 #define ZY7_USB_ASYNCLISTADDR_ENDPOINTLISTADDR 0x0158
98 #define ZY7_USB_TTCTRL 0x015c
99 #define ZY7_USB_BURSTSIZE 0x0160
100 #define ZY7_USB_TXFILLTUNING 0x0164
101 #define ZY7_USB_TXFILLTUNING_TXFIFOTHRES_SHFT 16
102 #define ZY7_USB_TXFILLTUNING_TXFIFOTHRES_MASK (0x3f<<16)
103 #define ZY7_USB_TXTFILLTUNING 0x0168
104 #define ZY7_USB_IC_USB 0x016c
105 #define ZY7_USB_ULPI_VIEWPORT 0x0170
106 #define ZY7_USB_ULPI_VIEWPORT_WU (1<<31)
107 #define ZY7_USB_ULPI_VIEWPORT_RUN (1<<30)
108 #define ZY7_USB_ULPI_VIEWPORT_RW (1<<29)
109 #define ZY7_USB_ULPI_VIEWPORT_SS (1<<27)
110 #define ZY7_USB_ULPI_VIEWPORT_PORT_MASK (7<<24)
111 #define ZY7_USB_ULPI_VIEWPORT_PORT_SHIFT 24
112 #define ZY7_USB_ULPI_VIEWPORT_ADDR_MASK (0xff<<16)
113 #define ZY7_USB_ULPI_VIEWPORT_ADDR_SHIFT 16
114 #define ZY7_USB_ULPI_VIEWPORT_DATARD_MASK (0xff<<8)
115 #define ZY7_USB_ULPI_VIEWPORT_DATARD_SHIFT 8
116 #define ZY7_USB_ULPI_VIEWPORT_DATAWR_MASK (0xff<<0)
117 #define ZY7_USB_ULPI_VIEWPORT_DATAWR_SHIFT 0
118 #define ZY7_USB_ENDPTNAK 0x0178
119 #define ZY7_USB_ENDPTNAKEN 0x017c
120 #define ZY7_USB_CONFIGFLAG 0x0180
121 #define ZY7_USB_PORTSC(n) (0x0180+4*(n))
122 #define ZY7_USB_PORTSC_PTS_MASK (3<<30)
123 #define ZY7_USB_PORTSC_PTS_SHIFT 30
124 #define ZY7_USB_PORTSC_PTS_UTMI (0<<30)
125 #define ZY7_USB_PORTSC_PTS_ULPI (2<<30)
126 #define ZY7_USB_PORTSC_PTS_SERIAL (3<<30)
127 #define ZY7_USB_PORTSC_PTW (1<<28)
128 #define ZY7_USB_PORTSC_PTS2 (1<<25)
129 #define ZY7_USB_OTGSC 0x01a4
130 #define ZY7_USB_USBMODE 0x01a8
131 #define ZY7_USB_ENDPTSETUPSTAT 0x01ac
132 #define ZY7_USB_ENDPTPRIME 0x01b0
133 #define ZY7_USB_ENDPTFLUSH 0x01b4
134 #define ZY7_USB_ENDPTSTAT 0x01b8
135 #define ZY7_USB_ENDPTCOMPLETE 0x01bc
136 #define ZY7_USB_ENDPTCTRL(n) (0x01c0+4*(n))
138 #define EHCI_REG_OFFSET ZY7_USB_CAPLENGTH_HCIVERSION
139 #define EHCI_REG_SIZE 0x100
142 zy7_phy_config(device_t dev, bus_space_tag_t io_tag, bus_space_handle_t bsh)
149 node = ofw_bus_get_node(dev);
151 if (OF_getprop(node, "phy_type", buf, sizeof(buf)) > 0) {
152 portsc = bus_space_read_4(io_tag, bsh, ZY7_USB_PORTSC(1));
153 portsc &= ~(ZY7_USB_PORTSC_PTS_MASK | ZY7_USB_PORTSC_PTW |
154 ZY7_USB_PORTSC_PTS2);
156 if (strcmp(buf,"ulpi") == 0)
157 portsc |= ZY7_USB_PORTSC_PTS_ULPI;
158 else if (strcmp(buf,"utmi") == 0)
159 portsc |= ZY7_USB_PORTSC_PTS_UTMI;
160 else if (strcmp(buf,"utmi-wide") == 0)
161 portsc |= (ZY7_USB_PORTSC_PTS_UTMI |
163 else if (strcmp(buf, "serial") == 0)
164 portsc |= ZY7_USB_PORTSC_PTS_SERIAL;
166 bus_space_write_4(io_tag, bsh, ZY7_USB_PORTSC(1), portsc);
169 if (OF_getprop(node, "phy_vbus_ext", buf, sizeof(buf)) >= 0) {
171 /* Tell PHY that VBUS is supplied externally. */
172 bus_space_write_4(io_tag, bsh, ZY7_USB_ULPI_VIEWPORT,
173 ZY7_USB_ULPI_VIEWPORT_RUN |
174 ZY7_USB_ULPI_VIEWPORT_RW |
175 (0 << ZY7_USB_ULPI_VIEWPORT_PORT_SHIFT) |
176 (0x0b << ZY7_USB_ULPI_VIEWPORT_ADDR_SHIFT) |
177 (0x60 << ZY7_USB_ULPI_VIEWPORT_DATAWR_SHIFT)
181 while ((bus_space_read_4(io_tag, bsh, ZY7_USB_ULPI_VIEWPORT) &
182 ZY7_USB_ULPI_VIEWPORT_RUN) != 0) {
193 zy7_ehci_probe(device_t dev)
196 if (!ofw_bus_is_compatible(dev, "xlnx,zy7_ehci"))
199 device_set_desc(dev, "Zynq-7000 EHCI USB 2.0 controller");
203 static int zy7_ehci_detach(device_t dev);
206 zy7_ehci_attach(device_t dev)
208 ehci_softc_t *sc = device_get_softc(dev);
209 bus_space_handle_t bsh;
212 /* initialize some bus fields */
213 sc->sc_bus.parent = dev;
214 sc->sc_bus.devices = sc->sc_devices;
215 sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
217 /* get all DMA memory */
218 if (usb_bus_mem_alloc_all(&sc->sc_bus,
219 USB_GET_DMA_TAG(dev), &ehci_iterate_hw_softc))
222 /* Allocate memory. */
224 sc->sc_io_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
226 if (sc->sc_io_res == NULL) {
227 device_printf(dev, "Can't allocate memory");
228 zy7_ehci_detach(dev);
232 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
233 bsh = rman_get_bushandle(sc->sc_io_res);
234 sc->sc_io_size = EHCI_REG_SIZE;
236 if (bus_space_subregion(sc->sc_io_tag, bsh, EHCI_REG_OFFSET,
237 sc->sc_io_size, &sc->sc_io_hdl) != 0)
238 panic("%s: unable to subregion USB host registers",
239 device_get_name(dev));
243 sc->sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
245 if (sc->sc_irq_res == NULL) {
246 device_printf(dev, "Can't allocate IRQ\n");
247 zy7_ehci_detach(dev);
252 sc->sc_bus.bdev = device_add_child(dev, "usbus", -1);
253 if (!sc->sc_bus.bdev) {
254 device_printf(dev, "Could not add USB device\n");
255 zy7_ehci_detach(dev);
258 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
259 device_set_desc(sc->sc_bus.bdev, "Zynq-7000 ehci USB 2.0 controller");
261 strcpy(sc->sc_vendor, "Xilinx"); /* or IP vendor? */
263 /* Activate the interrupt */
264 err = bus_setup_intr(dev, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
265 NULL, (driver_intr_t *)ehci_interrupt, sc,
268 device_printf(dev, "Cannot setup IRQ\n");
269 zy7_ehci_detach(dev);
274 sc->sc_flags |= EHCI_SCFLG_SETMODE | EHCI_SCFLG_TT |
275 EHCI_SCFLG_NORESTERM;
277 /* Modify FIFO burst threshold from 2 to 8. */
278 bus_space_write_4(sc->sc_io_tag, bsh,
279 ZY7_USB_TXFILLTUNING,
280 8 << ZY7_USB_TXFILLTUNING_TXFIFOTHRES_SHFT);
282 /* Handle PHY options. */
283 if (zy7_phy_config(dev, sc->sc_io_tag, bsh) < 0) {
284 device_printf(dev, "Cannot config phy!\n");
285 zy7_ehci_detach(dev);
292 sc->sc_flags |= EHCI_SCFLG_DONEINIT;
293 err = device_probe_and_attach(sc->sc_bus.bdev);
296 device_printf(dev, "USB init failed err=%d\n", err);
297 zy7_ehci_detach(dev);
305 zy7_ehci_detach(device_t dev)
307 ehci_softc_t *sc = device_get_softc(dev);
309 sc->sc_flags &= ~EHCI_SCFLG_DONEINIT;
311 if (device_is_attached(dev))
312 bus_generic_detach(dev);
314 if (sc->sc_irq_res && sc->sc_intr_hdl)
315 /* call ehci_detach() after ehci_init() called after
316 * successful bus_setup_intr().
319 if (sc->sc_bus.bdev) {
320 device_detach(sc->sc_bus.bdev);
321 device_delete_child(dev, sc->sc_bus.bdev);
323 if (sc->sc_irq_res) {
324 if (sc->sc_intr_hdl != NULL)
325 bus_teardown_intr(dev, sc->sc_irq_res,
327 bus_release_resource(dev, SYS_RES_IRQ,
328 rman_get_rid(sc->sc_irq_res), sc->sc_irq_res);
332 bus_release_resource(dev, SYS_RES_MEMORY,
333 rman_get_rid(sc->sc_io_res), sc->sc_io_res);
334 usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
339 static device_method_t ehci_methods[] = {
340 /* Device interface */
341 DEVMETHOD(device_probe, zy7_ehci_probe),
342 DEVMETHOD(device_attach, zy7_ehci_attach),
343 DEVMETHOD(device_detach, zy7_ehci_detach),
344 DEVMETHOD(device_suspend, bus_generic_suspend),
345 DEVMETHOD(device_resume, bus_generic_resume),
346 DEVMETHOD(device_shutdown, bus_generic_shutdown),
349 DEVMETHOD(bus_print_child, bus_generic_print_child),
354 static driver_t ehci_driver = {
357 sizeof(struct ehci_softc),
359 static devclass_t ehci_devclass;
361 DRIVER_MODULE(ehci, simplebus, ehci_driver, ehci_devclass, NULL, NULL);
362 MODULE_DEPEND(ehci, usb, 1, 1, 1);