a10_ehci.c revision 295464
1/*- 2 * Copyright (c) 2012 Ganbold Tsagaankhuu <ganbold@freebsd.org> 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/* 28 * Allwinner A10 attachment driver for the USB Enhanced Host Controller. 29 */ 30 31#include <sys/cdefs.h> 32__FBSDID("$FreeBSD: head/sys/arm/allwinner/a10_ehci.c 295464 2016-02-10 09:19:29Z andrew $"); 33 34#include "opt_bus.h" 35 36#include <sys/param.h> 37#include <sys/systm.h> 38#include <sys/bus.h> 39#include <sys/rman.h> 40#include <sys/condvar.h> 41#include <sys/kernel.h> 42#include <sys/module.h> 43#include <sys/gpio.h> 44 45#include <machine/bus.h> 46#include <dev/ofw/ofw_bus.h> 47#include <dev/ofw/ofw_bus_subr.h> 48 49#include <dev/usb/usb.h> 50#include <dev/usb/usbdi.h> 51 52#include <dev/usb/usb_core.h> 53#include <dev/usb/usb_busdma.h> 54#include <dev/usb/usb_process.h> 55#include <dev/usb/usb_util.h> 56 57#include <dev/usb/usb_controller.h> 58#include <dev/usb/usb_bus.h> 59#include <dev/usb/controller/ehci.h> 60#include <dev/usb/controller/ehcireg.h> 61 62#include "gpio_if.h" 63 64#include "a10_clk.h" 65 66#define EHCI_HC_DEVSTR "Allwinner Integrated USB 2.0 controller" 67 68#define SW_USB_PMU_IRQ_ENABLE 0x800 69 70#define SW_SDRAM_REG_HPCR_USB1 (0x250 + ((1 << 2) * 4)) 71#define SW_SDRAM_REG_HPCR_USB2 (0x250 + ((1 << 2) * 5)) 72#define SW_SDRAM_BP_HPCR_ACCESS (1 << 0) 73 74#define SW_ULPI_BYPASS (1 << 0) 75#define SW_AHB_INCRX_ALIGN (1 << 8) 76#define SW_AHB_INCR4 (1 << 9) 77#define SW_AHB_INCR8 (1 << 10) 78#define GPIO_USB1_PWR 230 79#define GPIO_USB2_PWR 227 80 81#define A10_READ_4(sc, reg) \ 82 bus_space_read_4((sc)->sc_io_tag, (sc)->sc_io_hdl, reg) 83 84#define A10_WRITE_4(sc, reg, data) \ 85 bus_space_write_4((sc)->sc_io_tag, (sc)->sc_io_hdl, reg, data) 86 87static device_attach_t a10_ehci_attach; 88static device_detach_t a10_ehci_detach; 89 90bs_r_1_proto(reversed); 91bs_w_1_proto(reversed); 92 93static struct ofw_compat_data compat_data[] = { 94 {"allwinner,sun4i-a10-ehci", 1}, 95 {"allwinner,sun7i-a20-ehci", 1}, 96 {NULL, 0} 97}; 98 99static int 100a10_ehci_probe(device_t self) 101{ 102 103 if (!ofw_bus_status_okay(self)) 104 return (ENXIO); 105 106 if (ofw_bus_search_compatible(self, compat_data)->ocd_data == 0) 107 return (ENXIO); 108 109 device_set_desc(self, EHCI_HC_DEVSTR); 110 111 return (BUS_PROBE_DEFAULT); 112} 113 114static int 115a10_ehci_attach(device_t self) 116{ 117 ehci_softc_t *sc = device_get_softc(self); 118 bus_space_handle_t bsh; 119 device_t sc_gpio_dev; 120 int err; 121 int rid; 122 uint32_t reg_value = 0; 123 124 /* initialise some bus fields */ 125 sc->sc_bus.parent = self; 126 sc->sc_bus.devices = sc->sc_devices; 127 sc->sc_bus.devices_max = EHCI_MAX_DEVICES; 128 sc->sc_bus.dma_bits = 32; 129 130 /* get all DMA memory */ 131 if (usb_bus_mem_alloc_all(&sc->sc_bus, 132 USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) { 133 return (ENOMEM); 134 } 135 136 sc->sc_bus.usbrev = USB_REV_2_0; 137 138 rid = 0; 139 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, RF_ACTIVE); 140 if (!sc->sc_io_res) { 141 device_printf(self, "Could not map memory\n"); 142 goto error; 143 } 144 145 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res); 146 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res); 147 bsh = rman_get_bushandle(sc->sc_io_res); 148 149 sc->sc_io_size = rman_get_size(sc->sc_io_res); 150 151 if (bus_space_subregion(sc->sc_io_tag, bsh, 0x00, 152 sc->sc_io_size, &sc->sc_io_hdl) != 0) 153 panic("%s: unable to subregion USB host registers", 154 device_get_name(self)); 155 156 rid = 0; 157 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 158 RF_SHAREABLE | RF_ACTIVE); 159 if (sc->sc_irq_res == NULL) { 160 device_printf(self, "Could not allocate irq\n"); 161 goto error; 162 } 163 sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 164 if (!sc->sc_bus.bdev) { 165 device_printf(self, "Could not add USB device\n"); 166 goto error; 167 } 168 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 169 device_set_desc(sc->sc_bus.bdev, EHCI_HC_DEVSTR); 170 171 sprintf(sc->sc_vendor, "Allwinner"); 172 173 /* Get the GPIO device, we need this to give power to USB */ 174 sc_gpio_dev = devclass_get_device(devclass_find("gpio"), 0); 175 if (sc_gpio_dev == NULL) { 176 device_printf(self, "Error: failed to get the GPIO device\n"); 177 goto error; 178 } 179 180 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 181 NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl); 182 if (err) { 183 device_printf(self, "Could not setup irq, %d\n", err); 184 sc->sc_intr_hdl = NULL; 185 goto error; 186 } 187 188 sc->sc_flags |= EHCI_SCFLG_DONTRESET; 189 190 /* Enable clock for USB */ 191 a10_clk_usb_activate(); 192 193 /* Give power to USB */ 194 GPIO_PIN_SETFLAGS(sc_gpio_dev, GPIO_USB2_PWR, GPIO_PIN_OUTPUT); 195 GPIO_PIN_SET(sc_gpio_dev, GPIO_USB2_PWR, GPIO_PIN_HIGH); 196 197 /* Give power to USB */ 198 GPIO_PIN_SETFLAGS(sc_gpio_dev, GPIO_USB1_PWR, GPIO_PIN_OUTPUT); 199 GPIO_PIN_SET(sc_gpio_dev, GPIO_USB1_PWR, GPIO_PIN_HIGH); 200 201 /* Enable passby */ 202 reg_value = A10_READ_4(sc, SW_USB_PMU_IRQ_ENABLE); 203 reg_value |= SW_AHB_INCR8; /* AHB INCR8 enable */ 204 reg_value |= SW_AHB_INCR4; /* AHB burst type INCR4 enable */ 205 reg_value |= SW_AHB_INCRX_ALIGN; /* AHB INCRX align enable */ 206 reg_value |= SW_ULPI_BYPASS; /* ULPI bypass enable */ 207 A10_WRITE_4(sc, SW_USB_PMU_IRQ_ENABLE, reg_value); 208 209 /* Configure port */ 210 reg_value = A10_READ_4(sc, SW_SDRAM_REG_HPCR_USB2); 211 reg_value |= SW_SDRAM_BP_HPCR_ACCESS; 212 A10_WRITE_4(sc, SW_SDRAM_REG_HPCR_USB2, reg_value); 213 214 err = ehci_init(sc); 215 if (!err) { 216 err = device_probe_and_attach(sc->sc_bus.bdev); 217 } 218 if (err) { 219 device_printf(self, "USB init failed err=%d\n", err); 220 goto error; 221 } 222 return (0); 223 224error: 225 a10_ehci_detach(self); 226 return (ENXIO); 227} 228 229static int 230a10_ehci_detach(device_t self) 231{ 232 ehci_softc_t *sc = device_get_softc(self); 233 device_t bdev; 234 int err; 235 uint32_t reg_value = 0; 236 237 if (sc->sc_bus.bdev) { 238 bdev = sc->sc_bus.bdev; 239 device_detach(bdev); 240 device_delete_child(self, bdev); 241 } 242 /* during module unload there are lots of children leftover */ 243 device_delete_children(self); 244 245 if (sc->sc_irq_res && sc->sc_intr_hdl) { 246 /* 247 * only call ehci_detach() after ehci_init() 248 */ 249 ehci_detach(sc); 250 251 err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 252 253 if (err) 254 /* XXX or should we panic? */ 255 device_printf(self, "Could not tear down irq, %d\n", 256 err); 257 sc->sc_intr_hdl = NULL; 258 } 259 260 if (sc->sc_irq_res) { 261 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 262 sc->sc_irq_res = NULL; 263 } 264 if (sc->sc_io_res) { 265 bus_release_resource(self, SYS_RES_MEMORY, 0, 266 sc->sc_io_res); 267 sc->sc_io_res = NULL; 268 } 269 usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc); 270 271 /* Disable configure port */ 272 reg_value = A10_READ_4(sc, SW_SDRAM_REG_HPCR_USB2); 273 reg_value &= ~SW_SDRAM_BP_HPCR_ACCESS; 274 A10_WRITE_4(sc, SW_SDRAM_REG_HPCR_USB2, reg_value); 275 276 /* Disable passby */ 277 reg_value = A10_READ_4(sc, SW_USB_PMU_IRQ_ENABLE); 278 reg_value &= ~SW_AHB_INCR8; /* AHB INCR8 disable */ 279 reg_value &= ~SW_AHB_INCR4; /* AHB burst type INCR4 disable */ 280 reg_value &= ~SW_AHB_INCRX_ALIGN; /* AHB INCRX align disable */ 281 reg_value &= ~SW_ULPI_BYPASS; /* ULPI bypass disable */ 282 A10_WRITE_4(sc, SW_USB_PMU_IRQ_ENABLE, reg_value); 283 284 /* Disable clock for USB */ 285 a10_clk_usb_deactivate(); 286 287 return (0); 288} 289 290static device_method_t ehci_methods[] = { 291 /* Device interface */ 292 DEVMETHOD(device_probe, a10_ehci_probe), 293 DEVMETHOD(device_attach, a10_ehci_attach), 294 DEVMETHOD(device_detach, a10_ehci_detach), 295 DEVMETHOD(device_suspend, bus_generic_suspend), 296 DEVMETHOD(device_resume, bus_generic_resume), 297 DEVMETHOD(device_shutdown, bus_generic_shutdown), 298 299 DEVMETHOD_END 300}; 301 302static driver_t ehci_driver = { 303 .name = "ehci", 304 .methods = ehci_methods, 305 .size = sizeof(ehci_softc_t), 306}; 307 308static devclass_t ehci_devclass; 309 310DRIVER_MODULE(ehci, simplebus, ehci_driver, ehci_devclass, 0, 0); 311MODULE_DEPEND(ehci, usb, 1, 1, 1); 312