1/*-
2 * Copyright (c) 1998 The NetBSD Foundation, Inc.
3 * All rights reserved.
4 *
5 * This code is derived from software contributed to The NetBSD Foundation
6 * by Lennart Augustsson (augustss@carlstedt.se) at
7 * Carlstedt Research & Technology.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#include <sys/cdefs.h>
32__FBSDID("$FreeBSD: stable/11/sys/mips/rmi/xls_ehci.c 323202 2017-09-06 02:04:14Z emaste $");
33
34#include "opt_bus.h"
35
36#include <sys/stdint.h>
37#include <sys/stddef.h>
38#include <sys/param.h>
39#include <sys/queue.h>
40#include <sys/types.h>
41#include <sys/systm.h>
42#include <sys/kernel.h>
43#include <sys/bus.h>
44#include <sys/module.h>
45#include <sys/lock.h>
46#include <sys/mutex.h>
47#include <sys/condvar.h>
48#include <sys/sysctl.h>
49#include <sys/sx.h>
50#include <sys/unistd.h>
51#include <sys/callout.h>
52#include <sys/malloc.h>
53#include <sys/priv.h>
54
55#include <sys/rman.h>
56#include <machine/resource.h>
57
58#include <dev/usb/usb.h>
59#include <dev/usb/usbdi.h>
60
61#include <dev/usb/usb_core.h>
62#include <dev/usb/usb_busdma.h>
63#include <dev/usb/usb_process.h>
64#include <dev/usb/usb_util.h>
65
66#include <dev/usb/usb_controller.h>
67#include <dev/usb/usb_bus.h>
68#include <dev/usb/controller/ehci.h>
69#include <dev/usb/controller/ehcireg.h>
70#include <mips/rmi/pic.h>
71
72static device_attach_t ehci_xls_attach;
73static device_detach_t ehci_xls_detach;
74
75static const char *xlr_usb_dev_desc = "RMI XLR USB 2.0 controller";
76static const char *xlr_vendor_desc = "RMI Corp";
77
78static int
79ehci_xls_probe(device_t self)
80{
81	/* TODO see if usb is enabled on the board */
82	device_set_desc(self, xlr_usb_dev_desc);
83	return BUS_PROBE_DEFAULT;
84}
85
86static int
87ehci_xls_attach(device_t self)
88{
89	ehci_softc_t *sc = device_get_softc(self);
90	int err;
91	int rid;
92
93	sc->sc_bus.parent = self;
94	sc->sc_bus.devices = sc->sc_devices;
95	sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
96	sc->sc_bus.dma_bits = 32;
97
98	/* get all DMA memory */
99	if (usb_bus_mem_alloc_all(&sc->sc_bus,
100	    USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) {
101		return (ENOMEM);
102	}
103
104	rid = 0;
105	sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
106	    RF_ACTIVE);
107	if (!sc->sc_io_res) {
108		device_printf(self, "Could not map memory\n");
109		goto error;
110	}
111	sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
112	sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
113	printf("IO Resource tag %lx, hdl %lx, size %lx\n",
114	       (u_long)sc->sc_io_tag, (u_long)sc->sc_io_hdl,
115	       (u_long)sc->sc_io_size);
116
117	rid = 0;
118	sc->sc_irq_res = bus_alloc_resource(self, SYS_RES_IRQ, &rid,
119	    PIC_USB_IRQ, PIC_USB_IRQ, 1, RF_SHAREABLE | RF_ACTIVE);
120	if (sc->sc_irq_res == NULL) {
121		device_printf(self, "Could not allocate irq\n");
122		goto error;
123	}
124
125	sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
126	if (!sc->sc_bus.bdev) {
127		device_printf(self, "Could not add USB device\n");
128		goto error;
129	}
130	device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
131	device_set_desc(sc->sc_bus.bdev, xlr_usb_dev_desc);
132
133	strlcpy(sc->sc_vendor, xlr_vendor_desc, sizeof(sc->sc_vendor));
134
135	err = bus_setup_intr(self, sc->sc_irq_res,
136	    INTR_TYPE_BIO | INTR_MPSAFE, NULL,
137	    (driver_intr_t *) ehci_interrupt, sc, &sc->sc_intr_hdl);
138	if (err) {
139		device_printf(self, "Could not setup irq, %d\n", err);
140		sc->sc_intr_hdl = NULL;
141		goto error;
142	}
143
144	err = ehci_init(sc);
145	if (err) {
146		device_printf(self, "USB init failed err=%d\n", err);
147		goto error;
148	}
149
150	err = device_probe_and_attach(sc->sc_bus.bdev);
151	if (err) {
152		device_printf(self, "USB probe and attach failed err=%d\n", err);
153		goto error;
154	}
155
156	return (0);
157
158error:
159	ehci_xls_detach(self);
160	return (ENXIO);
161}
162
163static int
164ehci_xls_detach(device_t self)
165{
166	ehci_softc_t *sc = device_get_softc(self);
167	int err;
168
169	/* during module unload there are lots of children leftover */
170	device_delete_children(self);
171
172	if (sc->sc_irq_res && sc->sc_intr_hdl) {
173		ehci_detach(sc);
174
175		err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
176		if (err)
177			device_printf(self, "Could not tear down irq, %d\n",
178			    err);
179		sc->sc_intr_hdl = 0;
180	}
181
182	if (sc->sc_irq_res) {
183		bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
184		sc->sc_irq_res = NULL;
185	}
186	if (sc->sc_io_res) {
187		bus_release_resource(self, SYS_RES_MEMORY, 0,
188		    sc->sc_io_res);
189		sc->sc_io_res = NULL;
190		sc->sc_io_tag = 0;
191		sc->sc_io_hdl = 0;
192	}
193
194	usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
195
196	return (0);
197}
198
199static device_method_t ehci_methods[] = {
200	/* Device interface */
201	DEVMETHOD(device_probe, ehci_xls_probe),
202	DEVMETHOD(device_attach, ehci_xls_attach),
203	DEVMETHOD(device_detach, ehci_xls_detach),
204	DEVMETHOD(device_suspend, bus_generic_suspend),
205	DEVMETHOD(device_resume, bus_generic_resume),
206	DEVMETHOD(device_shutdown, bus_generic_shutdown),
207
208	DEVMETHOD_END
209};
210
211static driver_t ehci_driver = {
212	.name = "ehci",
213	.methods = ehci_methods,
214	.size = sizeof(struct ehci_softc),
215};
216
217static devclass_t ehci_devclass;
218
219DRIVER_MODULE(ehci, iodi, ehci_driver, ehci_devclass, 0, 0);
220MODULE_DEPEND(ehci, usb, 1, 1, 1);
221