at91dci_fdt.c revision 331722
1#include <sys/cdefs.h> 2__FBSDID("$FreeBSD: stable/11/sys/dev/usb/controller/at91dci_fdt.c 331722 2018-03-29 02:50:57Z eadler $"); 3 4/*- 5 * Copyright (c) 2007-2008 Hans Petter Selasky. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 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> 36#include <sys/bus.h> 37#include <sys/module.h> 38#include <sys/lock.h> 39#include <sys/mutex.h> 40#include <sys/condvar.h> 41#include <sys/sysctl.h> 42#include <sys/sx.h> 43#include <sys/unistd.h> 44#include <sys/callout.h> 45#include <sys/malloc.h> 46#include <sys/priv.h> 47 48#include <dev/usb/usb.h> 49#include <dev/usb/usbdi.h> 50 51#include <dev/usb/usb_core.h> 52#include <dev/usb/usb_busdma.h> 53#include <dev/usb/usb_process.h> 54#include <dev/usb/usb_util.h> 55 56#include <dev/usb/usb_controller.h> 57#include <dev/usb/usb_bus.h> 58#include <dev/usb/controller/at91dci.h> 59 60#include <sys/rman.h> 61 62#include <arm/at91/at91_pmcvar.h> 63#include <arm/at91/at91rm92reg.h> 64#include <arm/at91/at91_pioreg.h> 65#include <arm/at91/at91_piovar.h> 66 67#include <dev/fdt/fdt_common.h> 68#include <dev/ofw/ofw_bus.h> 69#include <dev/ofw/ofw_bus_subr.h> 70 71#define MEM_RID 0 72 73/* Pin Definitions - do they belong here or somewhere else ? -- YES! */ 74 75#define VBUS_MASK AT91C_PIO_PB24 76#define VBUS_BASE AT91RM92_PIOB_BASE 77 78#define PULLUP_MASK AT91C_PIO_PB22 79#define PULLUP_BASE AT91RM92_PIOB_BASE 80 81static device_probe_t at91_udp_probe; 82static device_attach_t at91_udp_attach; 83static device_detach_t at91_udp_detach; 84 85struct at91_udp_softc { 86 struct at91dci_softc sc_dci; /* must be first */ 87 struct at91_pmc_clock *sc_mclk; 88 struct at91_pmc_clock *sc_iclk; 89 struct at91_pmc_clock *sc_fclk; 90 struct callout sc_vbus; 91}; 92 93static void 94at91_vbus_poll(struct at91_udp_softc *sc) 95{ 96 uint8_t vbus_val; 97 98 vbus_val = at91_pio_gpio_get(VBUS_BASE, VBUS_MASK) != 0; 99 at91dci_vbus_interrupt(&sc->sc_dci, vbus_val); 100 101 callout_reset(&sc->sc_vbus, hz, (void *)&at91_vbus_poll, sc); 102} 103 104static void 105at91_udp_clocks_on(void *arg) 106{ 107 struct at91_udp_softc *sc = arg; 108 109 at91_pmc_clock_enable(sc->sc_mclk); 110 at91_pmc_clock_enable(sc->sc_iclk); 111 at91_pmc_clock_enable(sc->sc_fclk); 112} 113 114static void 115at91_udp_clocks_off(void *arg) 116{ 117 struct at91_udp_softc *sc = arg; 118 119 at91_pmc_clock_disable(sc->sc_fclk); 120 at91_pmc_clock_disable(sc->sc_iclk); 121 at91_pmc_clock_disable(sc->sc_mclk); 122} 123 124static void 125at91_udp_pull_up(void *arg) 126{ 127 at91_pio_gpio_set(PULLUP_BASE, PULLUP_MASK); 128} 129 130static void 131at91_udp_pull_down(void *arg) 132{ 133 at91_pio_gpio_clear(PULLUP_BASE, PULLUP_MASK); 134} 135 136static int 137at91_udp_probe(device_t dev) 138{ 139 if (!ofw_bus_is_compatible(dev, "atmel,at91rm9200-udc")) 140 return (ENXIO); 141 device_set_desc(dev, "AT91 integrated AT91_UDP controller"); 142 return (0); 143} 144 145static int 146at91_udp_attach(device_t dev) 147{ 148 struct at91_udp_softc *sc = device_get_softc(dev); 149 int err; 150 int rid; 151 152 /* setup AT9100 USB device controller interface softc */ 153 154 sc->sc_dci.sc_clocks_on = &at91_udp_clocks_on; 155 sc->sc_dci.sc_clocks_off = &at91_udp_clocks_off; 156 sc->sc_dci.sc_clocks_arg = sc; 157 sc->sc_dci.sc_pull_up = &at91_udp_pull_up; 158 sc->sc_dci.sc_pull_down = &at91_udp_pull_down; 159 sc->sc_dci.sc_pull_arg = sc; 160 161 /* initialise some bus fields */ 162 sc->sc_dci.sc_bus.parent = dev; 163 sc->sc_dci.sc_bus.devices = sc->sc_dci.sc_devices; 164 sc->sc_dci.sc_bus.devices_max = AT91_MAX_DEVICES; 165 sc->sc_dci.sc_bus.dma_bits = 32; 166 167 /* get all DMA memory */ 168 if (usb_bus_mem_alloc_all(&sc->sc_dci.sc_bus, 169 USB_GET_DMA_TAG(dev), NULL)) { 170 return (ENOMEM); 171 } 172 callout_init_mtx(&sc->sc_vbus, &sc->sc_dci.sc_bus.bus_mtx, 0); 173 174 /* 175 * configure VBUS input pin, enable deglitch and enable 176 * interrupt : 177 */ 178 at91_pio_use_gpio(VBUS_BASE, VBUS_MASK); 179 at91_pio_gpio_input(VBUS_BASE, VBUS_MASK); 180 at91_pio_gpio_set_deglitch(VBUS_BASE, VBUS_MASK, 1); 181 at91_pio_gpio_set_interrupt(VBUS_BASE, VBUS_MASK, 0); 182 183 /* 184 * configure PULLUP output pin : 185 */ 186 at91_pio_use_gpio(PULLUP_BASE, PULLUP_MASK); 187 at91_pio_gpio_output(PULLUP_BASE, PULLUP_MASK, 0); 188 189 at91_udp_pull_down(sc); 190 191 /* wait 10ms for pulldown to stabilise */ 192 usb_pause_mtx(NULL, hz / 100); 193 194 sc->sc_mclk = at91_pmc_clock_ref("mck"); 195 sc->sc_iclk = at91_pmc_clock_ref("udc_clk"); 196 sc->sc_fclk = at91_pmc_clock_ref("udpck"); 197 198 rid = MEM_RID; 199 sc->sc_dci.sc_io_res = 200 bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE); 201 202 if (!(sc->sc_dci.sc_io_res)) { 203 err = ENOMEM; 204 goto error; 205 } 206 sc->sc_dci.sc_io_tag = rman_get_bustag(sc->sc_dci.sc_io_res); 207 sc->sc_dci.sc_io_hdl = rman_get_bushandle(sc->sc_dci.sc_io_res); 208 sc->sc_dci.sc_io_size = rman_get_size(sc->sc_dci.sc_io_res); 209 210 rid = 0; 211 sc->sc_dci.sc_irq_res = 212 bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE); 213 if (!(sc->sc_dci.sc_irq_res)) { 214 goto error; 215 } 216 sc->sc_dci.sc_bus.bdev = device_add_child(dev, "usbus", -1); 217 if (!(sc->sc_dci.sc_bus.bdev)) { 218 goto error; 219 } 220 device_set_ivars(sc->sc_dci.sc_bus.bdev, &sc->sc_dci.sc_bus); 221 222 err = bus_setup_intr(dev, sc->sc_dci.sc_irq_res, INTR_TYPE_TTY | INTR_MPSAFE, 223 at91dci_filter_interrupt, at91dci_interrupt, sc, &sc->sc_dci.sc_intr_hdl); 224 if (err) { 225 sc->sc_dci.sc_intr_hdl = NULL; 226 goto error; 227 } 228 229 err = at91dci_init(&sc->sc_dci); 230 if (!err) { 231 err = device_probe_and_attach(sc->sc_dci.sc_bus.bdev); 232 } 233 if (err) { 234 goto error; 235 } else { 236 /* poll VBUS one time */ 237 USB_BUS_LOCK(&sc->sc_dci.sc_bus); 238 at91_vbus_poll(sc); 239 USB_BUS_UNLOCK(&sc->sc_dci.sc_bus); 240 } 241 return (0); 242 243error: 244 at91_udp_detach(dev); 245 return (ENXIO); 246} 247 248static int 249at91_udp_detach(device_t dev) 250{ 251 struct at91_udp_softc *sc = device_get_softc(dev); 252 int err; 253 254 /* during module unload there are lots of children leftover */ 255 device_delete_children(dev); 256 257 USB_BUS_LOCK(&sc->sc_dci.sc_bus); 258 callout_stop(&sc->sc_vbus); 259 USB_BUS_UNLOCK(&sc->sc_dci.sc_bus); 260 261 callout_drain(&sc->sc_vbus); 262 263 /* disable Transceiver */ 264 AT91_UDP_WRITE_4(&sc->sc_dci, AT91_UDP_TXVC, AT91_UDP_TXVC_DIS); 265 266 /* disable and clear all interrupts */ 267 AT91_UDP_WRITE_4(&sc->sc_dci, AT91_UDP_IDR, 0xFFFFFFFF); 268 AT91_UDP_WRITE_4(&sc->sc_dci, AT91_UDP_ICR, 0xFFFFFFFF); 269 270 if (sc->sc_dci.sc_irq_res && sc->sc_dci.sc_intr_hdl) { 271 /* 272 * only call at91_udp_uninit() after at91_udp_init() 273 */ 274 at91dci_uninit(&sc->sc_dci); 275 276 err = bus_teardown_intr(dev, sc->sc_dci.sc_irq_res, 277 sc->sc_dci.sc_intr_hdl); 278 sc->sc_dci.sc_intr_hdl = NULL; 279 } 280 if (sc->sc_dci.sc_irq_res) { 281 bus_release_resource(dev, SYS_RES_IRQ, 0, 282 sc->sc_dci.sc_irq_res); 283 sc->sc_dci.sc_irq_res = NULL; 284 } 285 if (sc->sc_dci.sc_io_res) { 286 bus_release_resource(dev, SYS_RES_MEMORY, MEM_RID, 287 sc->sc_dci.sc_io_res); 288 sc->sc_dci.sc_io_res = NULL; 289 } 290 usb_bus_mem_free_all(&sc->sc_dci.sc_bus, NULL); 291 292 /* disable clocks */ 293 at91_pmc_clock_disable(sc->sc_iclk); 294 at91_pmc_clock_disable(sc->sc_fclk); 295 at91_pmc_clock_disable(sc->sc_mclk); 296 at91_pmc_clock_deref(sc->sc_fclk); 297 at91_pmc_clock_deref(sc->sc_iclk); 298 at91_pmc_clock_deref(sc->sc_mclk); 299 300 return (0); 301} 302 303static device_method_t at91_udp_methods[] = { 304 /* Device interface */ 305 DEVMETHOD(device_probe, at91_udp_probe), 306 DEVMETHOD(device_attach, at91_udp_attach), 307 DEVMETHOD(device_detach, at91_udp_detach), 308 DEVMETHOD(device_suspend, bus_generic_suspend), 309 DEVMETHOD(device_resume, bus_generic_resume), 310 DEVMETHOD(device_shutdown, bus_generic_shutdown), 311 312 DEVMETHOD_END 313}; 314 315static driver_t at91_udp_driver = { 316 .name = "at91_udp", 317 .methods = at91_udp_methods, 318 .size = sizeof(struct at91_udp_softc), 319}; 320 321static devclass_t at91_udp_devclass; 322 323DRIVER_MODULE(at91_udp, simplebus, at91_udp_driver, at91_udp_devclass, 0, 0); 324