xhci_pci.c revision 222018 
1/*-
2 * Copyright (c) 2010 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/xhci_pci.c 222018 2011-05-17 11:23:43Z ru $");
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/usb_pci.h>
59#include <dev/usb/controller/xhci.h>
60#include <dev/usb/controller/xhcireg.h>
61
62static device_probe_t xhci_pci_probe;
63static device_attach_t xhci_pci_attach;
64static device_detach_t xhci_pci_detach;
65static device_suspend_t xhci_pci_suspend;
66static device_resume_t xhci_pci_resume;
67static device_shutdown_t xhci_pci_shutdown;
68static void xhci_pci_takecontroller(device_t);
69
70static device_method_t xhci_device_methods[] = {
71	/* device interface */
72	DEVMETHOD(device_probe, xhci_pci_probe),
73	DEVMETHOD(device_attach, xhci_pci_attach),
74	DEVMETHOD(device_detach, xhci_pci_detach),
75	DEVMETHOD(device_suspend, xhci_pci_suspend),
76	DEVMETHOD(device_resume, xhci_pci_resume),
77	DEVMETHOD(device_shutdown, xhci_pci_shutdown),
78	/* bus interface */
79	DEVMETHOD(bus_print_child, bus_generic_print_child),
80
81	{0, 0}
82};
83
84static driver_t xhci_driver = {
85	.name = "xhci",
86	.methods = xhci_device_methods,
87	.size = sizeof(struct xhci_softc),
88};
89
90static devclass_t xhci_devclass;
91
92DRIVER_MODULE(xhci, pci, xhci_driver, xhci_devclass, 0, 0);
93MODULE_DEPEND(xhci, usb, 1, 1, 1);
94
95static int
96xhci_pci_suspend(device_t self)
97{
98	struct xhci_softc *sc = device_get_softc(self);
99	int err;
100
101	err = bus_generic_suspend(self);
102	if (err)
103		return (err);
104	xhci_suspend(sc);
105	return (0);
106}
107
108static int
109xhci_pci_resume(device_t self)
110{
111	struct xhci_softc *sc = device_get_softc(self);
112
113	xhci_pci_takecontroller(self);
114	xhci_resume(sc);
115
116	bus_generic_resume(self);
117
118	return (0);
119}
120
121static int
122xhci_pci_shutdown(device_t self)
123{
124	struct xhci_softc *sc = device_get_softc(self);
125	int err;
126
127	err = bus_generic_shutdown(self);
128	if (err)
129		return (err);
130	xhci_shutdown(sc);
131
132	return (0);
133}
134
135static const char *
136xhci_pci_match(device_t self)
137{
138	if ((pci_get_class(self) == PCIC_SERIALBUS)
139	    && (pci_get_subclass(self) == PCIS_SERIALBUS_USB)
140	    && (pci_get_progif(self) == PCIP_SERIALBUS_USB_XHCI)) {
141		return ("XHCI (generic) USB 3.0 controller");
142	}
143	return (NULL);			/* dunno */
144}
145
146static int
147xhci_pci_probe(device_t self)
148{
149	const char *desc = xhci_pci_match(self);
150
151	if (desc) {
152		device_set_desc(self, desc);
153		return (0);
154	} else {
155		return (ENXIO);
156	}
157}
158
159static int
160xhci_pci_attach(device_t self)
161{
162	struct xhci_softc *sc = device_get_softc(self);
163	int err;
164	int rid;
165
166	/* XXX check for 64-bit capability */
167
168	if (xhci_init(sc, self)) {
169		device_printf(self, "Could not initialize softc\n");
170		goto error;
171	}
172
173	pci_enable_busmaster(self);
174
175	rid = PCI_XHCI_CBMEM;
176	sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
177	    RF_ACTIVE);
178	if (!sc->sc_io_res) {
179		device_printf(self, "Could not map memory\n");
180		goto error;
181	}
182	sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
183	sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
184	sc->sc_io_size = rman_get_size(sc->sc_io_res);
185
186	rid = 0;
187	sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
188	    RF_SHAREABLE | RF_ACTIVE);
189	if (sc->sc_irq_res == NULL) {
190		device_printf(self, "Could not allocate IRQ\n");
191		goto error;
192	}
193	sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
194	if (sc->sc_bus.bdev == NULL) {
195		device_printf(self, "Could not add USB device\n");
196		goto error;
197	}
198	device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
199
200	sprintf(sc->sc_vendor, "0x%04x", pci_get_vendor(self));
201
202#if (__FreeBSD_version >= 700031)
203	err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
204	    NULL, (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl);
205#else
206	err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
207	    (driver_intr_t *)xhci_interrupt, sc, &sc->sc_intr_hdl);
208#endif
209	if (err) {
210		device_printf(self, "Could not setup IRQ, err=%d\n", err);
211		sc->sc_intr_hdl = NULL;
212		goto error;
213	}
214	xhci_pci_takecontroller(self);
215
216	err = xhci_halt_controller(sc);
217
218	if (err == 0)
219		err = xhci_start_controller(sc);
220
221	if (err == 0)
222		err = device_probe_and_attach(sc->sc_bus.bdev);
223
224	if (err) {
225		device_printf(self, "XHCI halt/start/probe failed err=%d\n", err);
226		goto error;
227	}
228	return (0);
229
230error:
231	xhci_pci_detach(self);
232	return (ENXIO);
233}
234
235static int
236xhci_pci_detach(device_t self)
237{
238	struct xhci_softc *sc = device_get_softc(self);
239	device_t bdev;
240
241	if (sc->sc_bus.bdev != NULL) {
242		bdev = sc->sc_bus.bdev;
243		device_detach(bdev);
244		device_delete_child(self, bdev);
245	}
246	/* during module unload there are lots of children leftover */
247	device_delete_all_children(self);
248
249	pci_disable_busmaster(self);
250
251	if (sc->sc_irq_res && sc->sc_intr_hdl) {
252
253		xhci_halt_controller(sc);
254
255		bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
256		sc->sc_intr_hdl = NULL;
257	}
258	if (sc->sc_irq_res) {
259		bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
260		sc->sc_irq_res = NULL;
261	}
262	if (sc->sc_io_res) {
263		bus_release_resource(self, SYS_RES_MEMORY, PCI_XHCI_CBMEM,
264		    sc->sc_io_res);
265		sc->sc_io_res = NULL;
266	}
267
268	xhci_uninit(sc);
269
270	return (0);
271}
272
273static void
274xhci_pci_takecontroller(device_t self)
275{
276	struct xhci_softc *sc = device_get_softc(self);
277	uint32_t cparams;
278	uint32_t eecp;
279	uint32_t eec;
280	uint16_t to;
281	uint8_t bios_sem;
282
283	cparams = XREAD4(sc, capa, XHCI_HCSPARAMS0);
284
285	eec = -1;
286
287	/* Synchronise with the BIOS if it owns the controller. */
288	for (eecp = XHCI_HCS0_XECP(cparams) << 2; eecp != 0 && XHCI_XECP_NEXT(eec);
289	    eecp += XHCI_XECP_NEXT(eec) << 2) {
290		eec = XREAD4(sc, capa, eecp);
291
292		if (XHCI_XECP_ID(eec) != XHCI_ID_USB_LEGACY)
293			continue;
294		bios_sem = XREAD1(sc, capa, eecp +
295		    XHCI_XECP_BIOS_SEM);
296		if (bios_sem == 0)
297			continue;
298		device_printf(sc->sc_bus.bdev, "waiting for BIOS "
299		    "to give up control\n");
300		XWRITE1(sc, capa, eecp +
301		    XHCI_XECP_OS_SEM, 1);
302		to = 500;
303		while (1) {
304			bios_sem = XREAD1(sc, capa, eecp +
305			    XHCI_XECP_BIOS_SEM);
306			if (bios_sem == 0)
307				break;
308
309			if (--to == 0) {
310				device_printf(sc->sc_bus.bdev,
311				    "timed out waiting for BIOS\n");
312				break;
313			}
314			usb_pause_mtx(NULL, hz / 100);	/* wait 10ms */
315		}
316	}
317}
318