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