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