musb_otg_atmelarm.c revision 217265 
1/* $FreeBSD: head/sys/dev/usb/controller/musb_otg_atmelarm.c 217265 2011-01-11 13:59:06Z jhb $ */
2/*-
3 * Copyright (c) 2008 Hans Petter Selasky. 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#include <sys/stdint.h>
28#include <sys/stddef.h>
29#include <sys/param.h>
30#include <sys/queue.h>
31#include <sys/types.h>
32#include <sys/systm.h>
33#include <sys/kernel.h>
34#include <sys/bus.h>
35#include <sys/module.h>
36#include <sys/lock.h>
37#include <sys/mutex.h>
38#include <sys/condvar.h>
39#include <sys/sysctl.h>
40#include <sys/sx.h>
41#include <sys/unistd.h>
42#include <sys/callout.h>
43#include <sys/malloc.h>
44#include <sys/priv.h>
45
46#include <dev/usb/usb.h>
47#include <dev/usb/usbdi.h>
48
49#include <dev/usb/usb_core.h>
50#include <dev/usb/usb_busdma.h>
51#include <dev/usb/usb_process.h>
52#include <dev/usb/usb_util.h>
53
54#include <dev/usb/usb_controller.h>
55#include <dev/usb/usb_bus.h>
56#include <dev/usb/controller/musb_otg.h>
57
58#include <sys/rman.h>
59
60static device_probe_t musbotg_probe;
61static device_attach_t musbotg_attach;
62static device_detach_t musbotg_detach;
63static device_shutdown_t musbotg_shutdown;
64
65struct musbotg_super_softc {
66	struct musbotg_softc sc_otg;	/* must be first */
67};
68
69static void
70musbotg_vbus_poll(struct musbotg_super_softc *sc)
71{
72	uint8_t vbus_val = 1;		/* fake VBUS on - TODO */
73
74	/* just forward it */
75	musbotg_vbus_interrupt(&sc->sc_otg, vbus_val);
76}
77
78static void
79musbotg_clocks_on(void *arg)
80{
81#if 0
82	struct musbotg_super_softc *sc = arg;
83
84#endif
85}
86
87static void
88musbotg_clocks_off(void *arg)
89{
90#if 0
91	struct musbotg_super_softc *sc = arg;
92
93#endif
94}
95
96static int
97musbotg_probe(device_t dev)
98{
99	device_set_desc(dev, "MUSB OTG integrated USB controller");
100	return (0);
101}
102
103static int
104musbotg_attach(device_t dev)
105{
106	struct musbotg_super_softc *sc = device_get_softc(dev);
107	int err;
108	int rid;
109
110	/* setup MUSB OTG USB controller interface softc */
111	sc->sc_otg.sc_clocks_on = &musbotg_clocks_on;
112	sc->sc_otg.sc_clocks_off = &musbotg_clocks_off;
113	sc->sc_otg.sc_clocks_arg = sc;
114
115	/* initialise some bus fields */
116	sc->sc_otg.sc_bus.parent = dev;
117	sc->sc_otg.sc_bus.devices = sc->sc_otg.sc_devices;
118	sc->sc_otg.sc_bus.devices_max = MUSB2_MAX_DEVICES;
119
120	/* get all DMA memory */
121	if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus,
122	    USB_GET_DMA_TAG(dev), NULL)) {
123		return (ENOMEM);
124	}
125	rid = 0;
126	sc->sc_otg.sc_io_res =
127	    bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
128
129	if (!(sc->sc_otg.sc_io_res)) {
130		err = ENOMEM;
131		goto error;
132	}
133	sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res);
134	sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res);
135	sc->sc_otg.sc_io_size = rman_get_size(sc->sc_otg.sc_io_res);
136
137	rid = 0;
138	sc->sc_otg.sc_irq_res =
139	    bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
140	if (!(sc->sc_otg.sc_irq_res)) {
141		goto error;
142	}
143	sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1);
144	if (!(sc->sc_otg.sc_bus.bdev)) {
145		goto error;
146	}
147	device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus);
148
149#if (__FreeBSD_version >= 700031)
150	err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
151	    NULL, (driver_intr_t *)musbotg_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
152#else
153	err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
154	    (driver_intr_t *)musbotg_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
155#endif
156	if (err) {
157		sc->sc_otg.sc_intr_hdl = NULL;
158		goto error;
159	}
160	err = musbotg_init(&sc->sc_otg);
161	if (!err) {
162		err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev);
163	}
164	if (err) {
165		goto error;
166	} else {
167		/* poll VBUS one time */
168		musbotg_vbus_poll(sc);
169	}
170	return (0);
171
172error:
173	musbotg_detach(dev);
174	return (ENXIO);
175}
176
177static int
178musbotg_detach(device_t dev)
179{
180	struct musbotg_super_softc *sc = device_get_softc(dev);
181	device_t bdev;
182	int err;
183
184	if (sc->sc_otg.sc_bus.bdev) {
185		bdev = sc->sc_otg.sc_bus.bdev;
186		device_detach(bdev);
187		device_delete_child(dev, bdev);
188	}
189	/* during module unload there are lots of children leftover */
190	device_delete_all_children(dev);
191
192	if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) {
193		/*
194		 * only call musbotg_uninit() after musbotg_init()
195		 */
196		musbotg_uninit(&sc->sc_otg);
197
198		err = bus_teardown_intr(dev, sc->sc_otg.sc_irq_res,
199		    sc->sc_otg.sc_intr_hdl);
200		sc->sc_otg.sc_intr_hdl = NULL;
201	}
202	/* free IRQ channel, if any */
203	if (sc->sc_otg.sc_irq_res) {
204		bus_release_resource(dev, SYS_RES_IRQ, 0,
205		    sc->sc_otg.sc_irq_res);
206		sc->sc_otg.sc_irq_res = NULL;
207	}
208	/* free memory resource, if any */
209	if (sc->sc_otg.sc_io_res) {
210		bus_release_resource(dev, SYS_RES_MEMORY, 0,
211		    sc->sc_otg.sc_io_res);
212		sc->sc_otg.sc_io_res = NULL;
213	}
214	usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL);
215
216	return (0);
217}
218
219static int
220musbotg_shutdown(device_t dev)
221{
222	struct musbotg_super_softc *sc = device_get_softc(dev);
223	int err;
224
225	err = bus_generic_shutdown(dev);
226	if (err)
227		return (err);
228
229	musbotg_uninit(&sc->sc_otg);
230
231	return (0);
232}
233
234static device_method_t musbotg_methods[] = {
235	/* Device interface */
236	DEVMETHOD(device_probe, musbotg_probe),
237	DEVMETHOD(device_attach, musbotg_attach),
238	DEVMETHOD(device_detach, musbotg_detach),
239	DEVMETHOD(device_shutdown, musbotg_shutdown),
240
241	/* Bus interface */
242	DEVMETHOD(bus_print_child, bus_generic_print_child),
243
244	{0, 0}
245};
246
247static driver_t musbotg_driver = {
248	"musbotg",
249	musbotg_methods,
250	sizeof(struct musbotg_super_softc),
251};
252
253static devclass_t musbotg_devclass;
254
255DRIVER_MODULE(musbotg, atmelarm, musbotg_driver, musbotg_devclass, 0, 0);
256MODULE_DEPEND(musbotg, usb, 1, 1, 1);
257