5 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
7 * Copyright (c) 2007-2008 Hans Petter Selasky. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/stdint.h>
32 #include <sys/stddef.h>
33 #include <sys/param.h>
34 #include <sys/queue.h>
35 #include <sys/types.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
39 #include <sys/module.h>
41 #include <sys/mutex.h>
42 #include <sys/condvar.h>
43 #include <sys/sysctl.h>
45 #include <sys/unistd.h>
46 #include <sys/callout.h>
47 #include <sys/malloc.h>
50 #include <dev/usb/usb.h>
51 #include <dev/usb/usbdi.h>
53 #include <dev/usb/usb_core.h>
54 #include <dev/usb/usb_busdma.h>
55 #include <dev/usb/usb_process.h>
56 #include <dev/usb/usb_util.h>
58 #include <dev/usb/usb_controller.h>
59 #include <dev/usb/usb_bus.h>
60 #include <dev/usb/controller/at91dci.h>
64 #include <arm/at91/at91_pmcvar.h>
65 #include <arm/at91/at91rm92reg.h>
66 #include <arm/at91/at91_pioreg.h>
67 #include <arm/at91/at91_piovar.h>
71 /* Pin Definitions - do they belong here or somewhere else ? -- YES! */
73 #define VBUS_MASK AT91C_PIO_PB24
74 #define VBUS_BASE AT91RM92_PIOB_BASE
76 #define PULLUP_MASK AT91C_PIO_PB22
77 #define PULLUP_BASE AT91RM92_PIOB_BASE
79 static device_probe_t at91_udp_probe;
80 static device_attach_t at91_udp_attach;
81 static device_detach_t at91_udp_detach;
83 struct at91_udp_softc {
84 struct at91dci_softc sc_dci; /* must be first */
85 struct at91_pmc_clock *sc_mclk;
86 struct at91_pmc_clock *sc_iclk;
87 struct at91_pmc_clock *sc_fclk;
88 struct callout sc_vbus;
92 at91_vbus_poll(struct at91_udp_softc *sc)
96 vbus_val = at91_pio_gpio_get(VBUS_BASE, VBUS_MASK) != 0;
97 at91dci_vbus_interrupt(&sc->sc_dci, vbus_val);
99 callout_reset(&sc->sc_vbus, hz, (void *)&at91_vbus_poll, sc);
103 at91_udp_clocks_on(void *arg)
105 struct at91_udp_softc *sc = arg;
107 at91_pmc_clock_enable(sc->sc_mclk);
108 at91_pmc_clock_enable(sc->sc_iclk);
109 at91_pmc_clock_enable(sc->sc_fclk);
113 at91_udp_clocks_off(void *arg)
115 struct at91_udp_softc *sc = arg;
117 at91_pmc_clock_disable(sc->sc_fclk);
118 at91_pmc_clock_disable(sc->sc_iclk);
119 at91_pmc_clock_disable(sc->sc_mclk);
123 at91_udp_pull_up(void *arg)
125 at91_pio_gpio_set(PULLUP_BASE, PULLUP_MASK);
129 at91_udp_pull_down(void *arg)
131 at91_pio_gpio_clear(PULLUP_BASE, PULLUP_MASK);
135 at91_udp_probe(device_t dev)
137 device_set_desc(dev, "AT91 integrated AT91_UDP controller");
142 at91_udp_attach(device_t dev)
144 struct at91_udp_softc *sc = device_get_softc(dev);
148 /* setup AT9100 USB device controller interface softc */
150 sc->sc_dci.sc_clocks_on = &at91_udp_clocks_on;
151 sc->sc_dci.sc_clocks_off = &at91_udp_clocks_off;
152 sc->sc_dci.sc_clocks_arg = sc;
153 sc->sc_dci.sc_pull_up = &at91_udp_pull_up;
154 sc->sc_dci.sc_pull_down = &at91_udp_pull_down;
155 sc->sc_dci.sc_pull_arg = sc;
157 /* initialise some bus fields */
158 sc->sc_dci.sc_bus.parent = dev;
159 sc->sc_dci.sc_bus.devices = sc->sc_dci.sc_devices;
160 sc->sc_dci.sc_bus.devices_max = AT91_MAX_DEVICES;
161 sc->sc_dci.sc_bus.dma_bits = 32;
163 /* get all DMA memory */
164 if (usb_bus_mem_alloc_all(&sc->sc_dci.sc_bus,
165 USB_GET_DMA_TAG(dev), NULL)) {
168 callout_init_mtx(&sc->sc_vbus, &sc->sc_dci.sc_bus.bus_mtx, 0);
171 * configure VBUS input pin, enable deglitch and enable
174 at91_pio_use_gpio(VBUS_BASE, VBUS_MASK);
175 at91_pio_gpio_input(VBUS_BASE, VBUS_MASK);
176 at91_pio_gpio_set_deglitch(VBUS_BASE, VBUS_MASK, 1);
177 at91_pio_gpio_set_interrupt(VBUS_BASE, VBUS_MASK, 0);
180 * configure PULLUP output pin :
182 at91_pio_use_gpio(PULLUP_BASE, PULLUP_MASK);
183 at91_pio_gpio_output(PULLUP_BASE, PULLUP_MASK, 0);
185 at91_udp_pull_down(sc);
187 /* wait 10ms for pulldown to stabilise */
188 usb_pause_mtx(NULL, hz / 100);
190 sc->sc_mclk = at91_pmc_clock_ref("mck");
191 sc->sc_iclk = at91_pmc_clock_ref("udc_clk");
192 sc->sc_fclk = at91_pmc_clock_ref("udpck");
195 sc->sc_dci.sc_io_res =
196 bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
198 if (!(sc->sc_dci.sc_io_res)) {
202 sc->sc_dci.sc_io_tag = rman_get_bustag(sc->sc_dci.sc_io_res);
203 sc->sc_dci.sc_io_hdl = rman_get_bushandle(sc->sc_dci.sc_io_res);
204 sc->sc_dci.sc_io_size = rman_get_size(sc->sc_dci.sc_io_res);
207 sc->sc_dci.sc_irq_res =
208 bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
209 if (!(sc->sc_dci.sc_irq_res)) {
212 sc->sc_dci.sc_bus.bdev = device_add_child(dev, "usbus", -1);
213 if (!(sc->sc_dci.sc_bus.bdev)) {
216 device_set_ivars(sc->sc_dci.sc_bus.bdev, &sc->sc_dci.sc_bus);
218 err = bus_setup_intr(dev, sc->sc_dci.sc_irq_res, INTR_TYPE_TTY | INTR_MPSAFE,
219 at91dci_filter_interrupt, at91dci_interrupt, sc, &sc->sc_dci.sc_intr_hdl);
221 sc->sc_dci.sc_intr_hdl = NULL;
225 err = at91dci_init(&sc->sc_dci);
227 err = device_probe_and_attach(sc->sc_dci.sc_bus.bdev);
232 /* poll VBUS one time */
233 USB_BUS_LOCK(&sc->sc_dci.sc_bus);
235 USB_BUS_UNLOCK(&sc->sc_dci.sc_bus);
240 at91_udp_detach(dev);
245 at91_udp_detach(device_t dev)
247 struct at91_udp_softc *sc = device_get_softc(dev);
250 /* during module unload there are lots of children leftover */
251 device_delete_children(dev);
253 USB_BUS_LOCK(&sc->sc_dci.sc_bus);
254 callout_stop(&sc->sc_vbus);
255 USB_BUS_UNLOCK(&sc->sc_dci.sc_bus);
257 callout_drain(&sc->sc_vbus);
259 /* disable Transceiver */
260 AT91_UDP_WRITE_4(&sc->sc_dci, AT91_UDP_TXVC, AT91_UDP_TXVC_DIS);
262 /* disable and clear all interrupts */
263 AT91_UDP_WRITE_4(&sc->sc_dci, AT91_UDP_IDR, 0xFFFFFFFF);
264 AT91_UDP_WRITE_4(&sc->sc_dci, AT91_UDP_ICR, 0xFFFFFFFF);
266 if (sc->sc_dci.sc_irq_res && sc->sc_dci.sc_intr_hdl) {
268 * only call at91_udp_uninit() after at91_udp_init()
270 at91dci_uninit(&sc->sc_dci);
272 err = bus_teardown_intr(dev, sc->sc_dci.sc_irq_res,
273 sc->sc_dci.sc_intr_hdl);
274 sc->sc_dci.sc_intr_hdl = NULL;
276 if (sc->sc_dci.sc_irq_res) {
277 bus_release_resource(dev, SYS_RES_IRQ, 0,
278 sc->sc_dci.sc_irq_res);
279 sc->sc_dci.sc_irq_res = NULL;
281 if (sc->sc_dci.sc_io_res) {
282 bus_release_resource(dev, SYS_RES_MEMORY, MEM_RID,
283 sc->sc_dci.sc_io_res);
284 sc->sc_dci.sc_io_res = NULL;
286 usb_bus_mem_free_all(&sc->sc_dci.sc_bus, NULL);
289 at91_pmc_clock_disable(sc->sc_iclk);
290 at91_pmc_clock_disable(sc->sc_fclk);
291 at91_pmc_clock_disable(sc->sc_mclk);
292 at91_pmc_clock_deref(sc->sc_fclk);
293 at91_pmc_clock_deref(sc->sc_iclk);
294 at91_pmc_clock_deref(sc->sc_mclk);
299 static device_method_t at91_udp_methods[] = {
300 /* Device interface */
301 DEVMETHOD(device_probe, at91_udp_probe),
302 DEVMETHOD(device_attach, at91_udp_attach),
303 DEVMETHOD(device_detach, at91_udp_detach),
304 DEVMETHOD(device_suspend, bus_generic_suspend),
305 DEVMETHOD(device_resume, bus_generic_resume),
306 DEVMETHOD(device_shutdown, bus_generic_shutdown),
311 static driver_t at91_udp_driver = {
313 .methods = at91_udp_methods,
314 .size = sizeof(struct at91_udp_softc),
317 static devclass_t at91_udp_devclass;
319 DRIVER_MODULE(at91_udp, atmelarm, at91_udp_driver, at91_udp_devclass, 0, 0);