musb_otg_atmelarm.c revision 227849 
1/*-
2 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 * SUCH DAMAGE.
24 */
25
26#include <sys/cdefs.h>
27__FBSDID("$FreeBSD: head/sys/dev/usb/controller/musb_otg_atmelarm.c 227849 2011-11-22 21:56:55Z hselasky $");
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/musb_otg.h>
59
60#include <sys/rman.h>
61
62static device_probe_t musbotg_probe;
63static device_attach_t musbotg_attach;
64static device_detach_t musbotg_detach;
65static device_shutdown_t musbotg_shutdown;
66
67struct musbotg_super_softc {
68	struct musbotg_softc sc_otg;	/* must be first */
69};
70
71static void
72musbotg_vbus_poll(struct musbotg_super_softc *sc)
73{
74	uint8_t vbus_val = 1;		/* fake VBUS on - TODO */
75
76	/* just forward it */
77	musbotg_vbus_interrupt(&sc->sc_otg, vbus_val);
78}
79
80static void
81musbotg_clocks_on(void *arg)
82{
83#if 0
84	struct musbotg_super_softc *sc = arg;
85
86#endif
87}
88
89static void
90musbotg_clocks_off(void *arg)
91{
92#if 0
93	struct musbotg_super_softc *sc = arg;
94
95#endif
96}
97
98static int
99musbotg_probe(device_t dev)
100{
101	device_set_desc(dev, "MUSB OTG integrated USB controller");
102	return (0);
103}
104
105static int
106musbotg_attach(device_t dev)
107{
108	struct musbotg_super_softc *sc = device_get_softc(dev);
109	int err;
110	int rid;
111
112	/* setup MUSB OTG USB controller interface softc */
113	sc->sc_otg.sc_clocks_on = &musbotg_clocks_on;
114	sc->sc_otg.sc_clocks_off = &musbotg_clocks_off;
115	sc->sc_otg.sc_clocks_arg = sc;
116
117	/* initialise some bus fields */
118	sc->sc_otg.sc_bus.parent = dev;
119	sc->sc_otg.sc_bus.devices = sc->sc_otg.sc_devices;
120	sc->sc_otg.sc_bus.devices_max = MUSB2_MAX_DEVICES;
121
122	/* get all DMA memory */
123	if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus,
124	    USB_GET_DMA_TAG(dev), NULL)) {
125		return (ENOMEM);
126	}
127	rid = 0;
128	sc->sc_otg.sc_io_res =
129	    bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
130
131	if (!(sc->sc_otg.sc_io_res)) {
132		err = ENOMEM;
133		goto error;
134	}
135	sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res);
136	sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res);
137	sc->sc_otg.sc_io_size = rman_get_size(sc->sc_otg.sc_io_res);
138
139	rid = 0;
140	sc->sc_otg.sc_irq_res =
141	    bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
142	if (!(sc->sc_otg.sc_irq_res)) {
143		goto error;
144	}
145	sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1);
146	if (!(sc->sc_otg.sc_bus.bdev)) {
147		goto error;
148	}
149	device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus);
150
151#if (__FreeBSD_version >= 700031)
152	err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
153	    NULL, (driver_intr_t *)musbotg_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
154#else
155	err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
156	    (driver_intr_t *)musbotg_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
157#endif
158	if (err) {
159		sc->sc_otg.sc_intr_hdl = NULL;
160		goto error;
161	}
162	err = musbotg_init(&sc->sc_otg);
163	if (!err) {
164		err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev);
165	}
166	if (err) {
167		goto error;
168	} else {
169		/* poll VBUS one time */
170		musbotg_vbus_poll(sc);
171	}
172	return (0);
173
174error:
175	musbotg_detach(dev);
176	return (ENXIO);
177}
178
179static int
180musbotg_detach(device_t dev)
181{
182	struct musbotg_super_softc *sc = device_get_softc(dev);
183	device_t bdev;
184	int err;
185
186	if (sc->sc_otg.sc_bus.bdev) {
187		bdev = sc->sc_otg.sc_bus.bdev;
188		device_detach(bdev);
189		device_delete_child(dev, bdev);
190	}
191	/* during module unload there are lots of children leftover */
192	device_delete_children(dev);
193
194	if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) {
195		/*
196		 * only call musbotg_uninit() after musbotg_init()
197		 */
198		musbotg_uninit(&sc->sc_otg);
199
200		err = bus_teardown_intr(dev, sc->sc_otg.sc_irq_res,
201		    sc->sc_otg.sc_intr_hdl);
202		sc->sc_otg.sc_intr_hdl = NULL;
203	}
204	/* free IRQ channel, if any */
205	if (sc->sc_otg.sc_irq_res) {
206		bus_release_resource(dev, SYS_RES_IRQ, 0,
207		    sc->sc_otg.sc_irq_res);
208		sc->sc_otg.sc_irq_res = NULL;
209	}
210	/* free memory resource, if any */
211	if (sc->sc_otg.sc_io_res) {
212		bus_release_resource(dev, SYS_RES_MEMORY, 0,
213		    sc->sc_otg.sc_io_res);
214		sc->sc_otg.sc_io_res = NULL;
215	}
216	usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL);
217
218	return (0);
219}
220
221static int
222musbotg_shutdown(device_t dev)
223{
224	struct musbotg_super_softc *sc = device_get_softc(dev);
225	int err;
226
227	err = bus_generic_shutdown(dev);
228	if (err)
229		return (err);
230
231	musbotg_uninit(&sc->sc_otg);
232
233	return (0);
234}
235
236static device_method_t musbotg_methods[] = {
237	/* Device interface */
238	DEVMETHOD(device_probe, musbotg_probe),
239	DEVMETHOD(device_attach, musbotg_attach),
240	DEVMETHOD(device_detach, musbotg_detach),
241	DEVMETHOD(device_shutdown, musbotg_shutdown),
242
243	DEVMETHOD_END
244};
245
246static driver_t musbotg_driver = {
247	"musbotg",
248	musbotg_methods,
249	sizeof(struct musbotg_super_softc),
250};
251
252static devclass_t musbotg_devclass;
253
254DRIVER_MODULE(musbotg, atmelarm, musbotg_driver, musbotg_devclass, 0, 0);
255MODULE_DEPEND(musbotg, usb, 1, 1, 1);
256