at91dci_atmelarm.c revision 239531 
1#include <sys/cdefs.h>
2__FBSDID("$FreeBSD: head/sys/dev/usb/controller/at91dci_atmelarm.c 239531 2012-08-21 20:10:59Z hselasky $");
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#define	MEM_RID	0
68
69/* Pin Definitions - do they belong here or somewhere else ? -- YES! */
70
71#define	VBUS_MASK	AT91C_PIO_PB24
72#define	VBUS_BASE	AT91RM92_PIOB_BASE
73
74#define	PULLUP_MASK	AT91C_PIO_PB22
75#define	PULLUP_BASE	AT91RM92_PIOB_BASE
76
77static device_probe_t at91_udp_probe;
78static device_attach_t at91_udp_attach;
79static device_detach_t at91_udp_detach;
80
81struct at91_udp_softc {
82	struct at91dci_softc sc_dci;	/* must be first */
83	struct at91_pmc_clock *sc_mclk;
84	struct at91_pmc_clock *sc_iclk;
85	struct at91_pmc_clock *sc_fclk;
86	struct resource *sc_vbus_irq_res;
87	void   *sc_vbus_intr_hdl;
88};
89
90static void
91at91_vbus_poll(struct at91_udp_softc *sc)
92{
93	uint32_t temp;
94	uint8_t vbus_val;
95
96	/* XXX temporary clear interrupts here */
97
98	temp = at91_pio_gpio_clear_interrupt(VBUS_BASE);
99
100	/* just forward it */
101
102	vbus_val = at91_pio_gpio_get(VBUS_BASE, VBUS_MASK);
103	at91dci_vbus_interrupt(&sc->sc_dci, vbus_val);
104}
105
106static void
107at91_udp_clocks_on(void *arg)
108{
109	struct at91_udp_softc *sc = arg;
110
111	at91_pmc_clock_enable(sc->sc_mclk);
112	at91_pmc_clock_enable(sc->sc_iclk);
113	at91_pmc_clock_enable(sc->sc_fclk);
114}
115
116static void
117at91_udp_clocks_off(void *arg)
118{
119	struct at91_udp_softc *sc = arg;
120
121	at91_pmc_clock_disable(sc->sc_fclk);
122	at91_pmc_clock_disable(sc->sc_iclk);
123	at91_pmc_clock_disable(sc->sc_mclk);
124}
125
126static void
127at91_udp_pull_up(void *arg)
128{
129	at91_pio_gpio_set(PULLUP_BASE, PULLUP_MASK);
130}
131
132static void
133at91_udp_pull_down(void *arg)
134{
135	at91_pio_gpio_clear(PULLUP_BASE, PULLUP_MASK);
136}
137
138static int
139at91_udp_probe(device_t dev)
140{
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
166	/* get all DMA memory */
167	if (usb_bus_mem_alloc_all(&sc->sc_dci.sc_bus,
168	    USB_GET_DMA_TAG(dev), NULL)) {
169		return (ENOMEM);
170	}
171	/*
172	 * configure VBUS input pin, enable deglitch and enable
173	 * interrupt :
174	 */
175	at91_pio_use_gpio(VBUS_BASE, VBUS_MASK);
176	at91_pio_gpio_input(VBUS_BASE, VBUS_MASK);
177	at91_pio_gpio_set_deglitch(VBUS_BASE, VBUS_MASK, 1);
178	at91_pio_gpio_set_interrupt(VBUS_BASE, VBUS_MASK, 1);
179
180	/*
181	 * configure PULLUP output pin :
182	 */
183	at91_pio_use_gpio(PULLUP_BASE, PULLUP_MASK);
184	at91_pio_gpio_output(PULLUP_BASE, PULLUP_MASK, 0);
185
186	at91_udp_pull_down(sc);
187
188	/* wait 10ms for pulldown to stabilise */
189	usb_pause_mtx(NULL, hz / 100);
190
191	sc->sc_mclk = at91_pmc_clock_ref("mck");
192	sc->sc_iclk = at91_pmc_clock_ref("udc_clk");
193	sc->sc_fclk = at91_pmc_clock_ref("udpck");
194
195	rid = MEM_RID;
196	sc->sc_dci.sc_io_res =
197	    bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
198
199	if (!(sc->sc_dci.sc_io_res)) {
200		err = ENOMEM;
201		goto error;
202	}
203	sc->sc_dci.sc_io_tag = rman_get_bustag(sc->sc_dci.sc_io_res);
204	sc->sc_dci.sc_io_hdl = rman_get_bushandle(sc->sc_dci.sc_io_res);
205	sc->sc_dci.sc_io_size = rman_get_size(sc->sc_dci.sc_io_res);
206
207	rid = 0;
208	sc->sc_dci.sc_irq_res =
209	    bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
210	if (!(sc->sc_dci.sc_irq_res)) {
211		goto error;
212	}
213	rid = 1;
214	sc->sc_vbus_irq_res =
215	    bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
216	if (sc->sc_vbus_irq_res == NULL) {
217		at91_pio_gpio_set_interrupt(VBUS_BASE, VBUS_MASK, 0);
218		device_printf(dev, "No VBUS IRQ!");
219	}
220	sc->sc_dci.sc_bus.bdev = device_add_child(dev, "usbus", -1);
221	if (!(sc->sc_dci.sc_bus.bdev)) {
222		goto error;
223	}
224	device_set_ivars(sc->sc_dci.sc_bus.bdev, &sc->sc_dci.sc_bus);
225
226#if (__FreeBSD_version >= 700031)
227	err = bus_setup_intr(dev, sc->sc_dci.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
228	    NULL, (driver_intr_t *)at91dci_interrupt, sc, &sc->sc_dci.sc_intr_hdl);
229#else
230	err = bus_setup_intr(dev, sc->sc_dci.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
231	    (driver_intr_t *)at91dci_interrupt, sc, &sc->sc_dci.sc_intr_hdl);
232#endif
233	if (err) {
234		sc->sc_dci.sc_intr_hdl = NULL;
235		goto error;
236	}
237#if (__FreeBSD_version >= 700031)
238	if (sc->sc_vbus_irq_res != NULL) {
239		err = bus_setup_intr(dev, sc->sc_vbus_irq_res,
240		    INTR_TYPE_BIO | INTR_MPSAFE,
241		    NULL, (driver_intr_t *)at91_vbus_poll, sc,
242		    &sc->sc_vbus_intr_hdl);
243	}
244#else
245	if (sc->sc_vbus_irq_res != NULL) {
246		err = bus_setup_intr(dev, sc->sc_vbus_irq_res,
247		    INTR_TYPE_BIO | INTR_MPSAFE,
248		    (driver_intr_t *)at91_vbus_poll, sc,
249		    &sc->sc_vbus_intr_hdl);
250	}
251#endif
252	if (err) {
253		sc->sc_vbus_intr_hdl = NULL;
254		goto error;
255	}
256	err = at91dci_init(&sc->sc_dci);
257	if (!err) {
258		err = device_probe_and_attach(sc->sc_dci.sc_bus.bdev);
259	}
260	if (err) {
261		goto error;
262	} else {
263		/* poll VBUS one time */
264		at91_vbus_poll(sc);
265	}
266	return (0);
267
268error:
269	at91_udp_detach(dev);
270	return (ENXIO);
271}
272
273static int
274at91_udp_detach(device_t dev)
275{
276	struct at91_udp_softc *sc = device_get_softc(dev);
277	device_t bdev;
278	int err;
279
280	if (sc->sc_dci.sc_bus.bdev) {
281		bdev = sc->sc_dci.sc_bus.bdev;
282		device_detach(bdev);
283		device_delete_child(dev, bdev);
284	}
285	/* during module unload there are lots of children leftover */
286	device_delete_children(dev);
287
288	/* disable Transceiver */
289	AT91_UDP_WRITE_4(&sc->sc_dci, AT91_UDP_TXVC, AT91_UDP_TXVC_DIS);
290
291	/* disable and clear all interrupts */
292	AT91_UDP_WRITE_4(&sc->sc_dci, AT91_UDP_IDR, 0xFFFFFFFF);
293	AT91_UDP_WRITE_4(&sc->sc_dci, AT91_UDP_ICR, 0xFFFFFFFF);
294
295	/* disable VBUS interrupt */
296	at91_pio_gpio_set_interrupt(VBUS_BASE, VBUS_MASK, 0);
297
298	if (sc->sc_vbus_irq_res && sc->sc_vbus_intr_hdl) {
299		err = bus_teardown_intr(dev, sc->sc_vbus_irq_res,
300		    sc->sc_vbus_intr_hdl);
301		sc->sc_vbus_intr_hdl = NULL;
302	}
303	if (sc->sc_vbus_irq_res) {
304		bus_release_resource(dev, SYS_RES_IRQ, 1,
305		    sc->sc_vbus_irq_res);
306		sc->sc_vbus_irq_res = NULL;
307	}
308	if (sc->sc_dci.sc_irq_res && sc->sc_dci.sc_intr_hdl) {
309		/*
310		 * only call at91_udp_uninit() after at91_udp_init()
311		 */
312		at91dci_uninit(&sc->sc_dci);
313
314		err = bus_teardown_intr(dev, sc->sc_dci.sc_irq_res,
315		    sc->sc_dci.sc_intr_hdl);
316		sc->sc_dci.sc_intr_hdl = NULL;
317	}
318	if (sc->sc_dci.sc_irq_res) {
319		bus_release_resource(dev, SYS_RES_IRQ, 0,
320		    sc->sc_dci.sc_irq_res);
321		sc->sc_dci.sc_irq_res = NULL;
322	}
323	if (sc->sc_dci.sc_io_res) {
324		bus_release_resource(dev, SYS_RES_MEMORY, MEM_RID,
325		    sc->sc_dci.sc_io_res);
326		sc->sc_dci.sc_io_res = NULL;
327	}
328	usb_bus_mem_free_all(&sc->sc_dci.sc_bus, NULL);
329
330	/* disable clocks */
331	at91_pmc_clock_disable(sc->sc_iclk);
332	at91_pmc_clock_disable(sc->sc_fclk);
333	at91_pmc_clock_disable(sc->sc_mclk);
334	at91_pmc_clock_deref(sc->sc_fclk);
335	at91_pmc_clock_deref(sc->sc_iclk);
336	at91_pmc_clock_deref(sc->sc_mclk);
337
338	return (0);
339}
340
341static device_method_t at91_udp_methods[] = {
342	/* Device interface */
343	DEVMETHOD(device_probe, at91_udp_probe),
344	DEVMETHOD(device_attach, at91_udp_attach),
345	DEVMETHOD(device_detach, at91_udp_detach),
346	DEVMETHOD(device_suspend, bus_generic_suspend),
347	DEVMETHOD(device_resume, bus_generic_resume),
348	DEVMETHOD(device_shutdown, bus_generic_shutdown),
349
350	DEVMETHOD_END
351};
352
353static driver_t at91_udp_driver = {
354	.name = "at91_udp",
355	.methods = at91_udp_methods,
356	.size = sizeof(struct at91_udp_softc),
357};
358
359static devclass_t at91_udp_devclass;
360
361DRIVER_MODULE(at91_udp, atmelarm, at91_udp_driver, at91_udp_devclass, 0, 0);
362