atmegadci_atmelarm.c revision 331722
1#include <sys/cdefs.h>
2__FBSDID("$FreeBSD: stable/11/sys/dev/usb/controller/atmegadci_atmelarm.c 331722 2018-03-29 02:50:57Z eadler $");
3
4/*-
5 * Copyright (c) 2009 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/atmegadci.h>
59
60#include <sys/rman.h>
61
62static device_probe_t atmegadci_probe;
63static device_attach_t atmegadci_attach;
64static device_detach_t atmegadci_detach;
65
66struct atmegadci_super_softc {
67	struct atmegadci_softc sc_otg;	/* must be first */
68};
69
70static void
71atmegadci_clocks_on(struct usb_bus *bus)
72{
73	/* TODO */
74}
75
76static void
77atmegadci_clocks_off(struct usb_bus *bus)
78{
79	/* TODO */
80}
81
82static int
83atmegadci_probe(device_t dev)
84{
85	device_set_desc(dev, "ATMEL OTG integrated USB controller");
86	return (0);
87}
88
89static int
90atmegadci_attach(device_t dev)
91{
92	struct atmegadci_super_softc *sc = device_get_softc(dev);
93	int err;
94	int rid;
95
96	/* setup MUSB OTG USB controller interface softc */
97	sc->sc_otg.sc_clocks_on = &atmegadci_clocks_on;
98	sc->sc_otg.sc_clocks_off = &atmegadci_clocks_off;
99
100	/* initialise some bus fields */
101	sc->sc_otg.sc_bus.parent = dev;
102	sc->sc_otg.sc_bus.devices = sc->sc_otg.sc_devices;
103	sc->sc_otg.sc_bus.devices_max = ATMEGA_MAX_DEVICES;
104	sc->sc_otg.sc_bus.dma_bits = 32;
105
106	/* get all DMA memory */
107	if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus,
108	    USB_GET_DMA_TAG(dev), NULL)) {
109		return (ENOMEM);
110	}
111	rid = 0;
112	sc->sc_otg.sc_io_res =
113	    bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
114
115	if (!(sc->sc_otg.sc_io_res)) {
116		err = ENOMEM;
117		goto error;
118	}
119	sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res);
120	sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res);
121
122	rid = 0;
123	sc->sc_otg.sc_irq_res =
124	    bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
125	if (!(sc->sc_otg.sc_irq_res)) {
126		goto error;
127	}
128	sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1);
129	if (!(sc->sc_otg.sc_bus.bdev)) {
130		goto error;
131	}
132	device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus);
133
134	err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
135	    NULL, (driver_intr_t *)atmegadci_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
136	if (err) {
137		sc->sc_otg.sc_intr_hdl = NULL;
138		goto error;
139	}
140	err = atmegadci_init(&sc->sc_otg);
141	if (!err) {
142		err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev);
143	}
144	if (err) {
145		goto error;
146	}
147	return (0);
148
149error:
150	atmegadci_detach(dev);
151	return (ENXIO);
152}
153
154static int
155atmegadci_detach(device_t dev)
156{
157	struct atmegadci_super_softc *sc = device_get_softc(dev);
158	int err;
159
160	/* during module unload there are lots of children leftover */
161	device_delete_children(dev);
162
163	if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) {
164		/*
165		 * only call atmegadci_uninit() after atmegadci_init()
166		 */
167		atmegadci_uninit(&sc->sc_otg);
168
169		err = bus_teardown_intr(dev, sc->sc_otg.sc_irq_res,
170		    sc->sc_otg.sc_intr_hdl);
171		sc->sc_otg.sc_intr_hdl = NULL;
172	}
173	/* free IRQ channel, if any */
174	if (sc->sc_otg.sc_irq_res) {
175		bus_release_resource(dev, SYS_RES_IRQ, 0,
176		    sc->sc_otg.sc_irq_res);
177		sc->sc_otg.sc_irq_res = NULL;
178	}
179	/* free memory resource, if any */
180	if (sc->sc_otg.sc_io_res) {
181		bus_release_resource(dev, SYS_RES_MEMORY, 0,
182		    sc->sc_otg.sc_io_res);
183		sc->sc_otg.sc_io_res = NULL;
184	}
185	usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL);
186
187	return (0);
188}
189
190static device_method_t atmegadci_methods[] = {
191	/* Device interface */
192	DEVMETHOD(device_probe, atmegadci_probe),
193	DEVMETHOD(device_attach, atmegadci_attach),
194	DEVMETHOD(device_detach, atmegadci_detach),
195	DEVMETHOD(device_suspend, bus_generic_suspend),
196	DEVMETHOD(device_resume, bus_generic_resume),
197	DEVMETHOD(device_shutdown, bus_generic_shutdown),
198
199	DEVMETHOD_END
200};
201
202static driver_t atmegadci_driver = {
203	.name = "atmegadci",
204	.methods = atmegadci_methods,
205	.size = sizeof(struct atmegadci_super_softc),
206};
207
208static devclass_t atmegadci_devclass;
209
210DRIVER_MODULE(atmegadci, atmelarm, atmegadci_driver, atmegadci_devclass, 0, 0);
211MODULE_DEPEND(atmegadci, usb, 1, 1, 1);
212