xhci_pci.c revision 1.9 1 /* $NetBSD: xhci_pci.c,v 1.9 2017/09/05 08:01:43 skrll Exp $ */
2 /* OpenBSD: xhci_pci.c,v 1.4 2014/07/12 17:38:51 yuo Exp */
3
4 /*
5 * Copyright (c) 1998 The NetBSD Foundation, Inc.
6 * All rights reserved.
7 *
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Lennart Augustsson (lennart (at) augustsson.net) at
10 * Carlstedt Research & Technology.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 #include <sys/cdefs.h>
35 __KERNEL_RCSID(0, "$NetBSD: xhci_pci.c,v 1.9 2017/09/05 08:01:43 skrll Exp $");
36
37 #ifdef _KERNEL_OPT
38 #include "opt_xhci_pci.h"
39 #endif
40
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/device.h>
45 #include <sys/proc.h>
46 #include <sys/queue.h>
47
48 #include <sys/bus.h>
49
50 #include <dev/pci/pcivar.h>
51 #include <dev/pci/pcidevs.h>
52
53 #include <dev/usb/usb.h>
54 #include <dev/usb/usbdi.h>
55 #include <dev/usb/usbdivar.h>
56 #include <dev/usb/usb_mem.h>
57
58 #include <dev/usb/xhcireg.h>
59 #include <dev/usb/xhcivar.h>
60
61 struct xhci_pci_softc {
62 struct xhci_softc sc_xhci;
63 pci_chipset_tag_t sc_pc;
64 pcitag_t sc_tag;
65 void *sc_ih;
66 pci_intr_handle_t *sc_pihp;
67 };
68
69 static int
70 xhci_pci_match(device_t parent, cfdata_t match, void *aux)
71 {
72 struct pci_attach_args *pa = (struct pci_attach_args *) aux;
73
74 if (PCI_CLASS(pa->pa_class) == PCI_CLASS_SERIALBUS &&
75 PCI_SUBCLASS(pa->pa_class) == PCI_SUBCLASS_SERIALBUS_USB &&
76 PCI_INTERFACE(pa->pa_class) == PCI_INTERFACE_XHCI)
77 return 1;
78
79 return 0;
80 }
81
82 static int
83 xhci_pci_port_route(struct xhci_pci_softc *psc)
84 {
85 struct xhci_softc * const sc = &psc->sc_xhci;
86
87 pcireg_t val;
88
89 /*
90 * Check USB3 Port Routing Mask register that indicates the ports
91 * can be changed from OS, and turn on by USB3 Port SS Enable register.
92 */
93 val = pci_conf_read(psc->sc_pc, psc->sc_tag, PCI_XHCI_INTEL_USB3PRM);
94 aprint_debug_dev(sc->sc_dev,
95 "USB3PRM / USB3.0 configurable ports: 0x%08x\n", val);
96
97 pci_conf_write(psc->sc_pc, psc->sc_tag, PCI_XHCI_INTEL_USB3_PSSEN, val);
98 val = pci_conf_read(psc->sc_pc, psc->sc_tag,PCI_XHCI_INTEL_USB3_PSSEN);
99 aprint_debug_dev(sc->sc_dev,
100 "USB3_PSSEN / Enabled USB3.0 ports under xHCI: 0x%08x\n", val);
101
102 /*
103 * Check USB2 Port Routing Mask register that indicates the USB2.0
104 * ports to be controlled by xHCI HC, and switch them to xHCI HC.
105 */
106 val = pci_conf_read(psc->sc_pc, psc->sc_tag, PCI_XHCI_INTEL_USB2PRM);
107 aprint_debug_dev(sc->sc_dev,
108 "XUSB2PRM / USB2.0 ports can switch from EHCI to xHCI:"
109 "0x%08x\n", val);
110 pci_conf_write(psc->sc_pc, psc->sc_tag, PCI_XHCI_INTEL_XUSB2PR, val);
111 val = pci_conf_read(psc->sc_pc, psc->sc_tag, PCI_XHCI_INTEL_XUSB2PR);
112 aprint_debug_dev(sc->sc_dev,
113 "XUSB2PR / USB2.0 ports under xHCI: 0x%08x\n", val);
114
115 return 0;
116 }
117
118 static void
119 xhci_pci_attach(device_t parent, device_t self, void *aux)
120 {
121 struct xhci_pci_softc * const psc = device_private(self);
122 struct xhci_softc * const sc = &psc->sc_xhci;
123 struct pci_attach_args *const pa = (struct pci_attach_args *)aux;
124 const pci_chipset_tag_t pc = pa->pa_pc;
125 const pcitag_t tag = pa->pa_tag;
126 char const *intrstr;
127 pcireg_t csr, memtype;
128 int err;
129 uint32_t hccparams;
130 char intrbuf[PCI_INTRSTR_LEN];
131
132 sc->sc_dev = self;
133
134 pci_aprint_devinfo(pa, "USB Controller");
135
136 /* Check for quirks */
137 sc->sc_quirks = 0;
138
139 /* check if memory space access is enabled */
140 csr = pci_conf_read(pc, tag, PCI_COMMAND_STATUS_REG);
141 #ifdef DEBUG
142 printf("%s: csr: %08x\n", __func__, csr);
143 #endif
144 if ((csr & PCI_COMMAND_MEM_ENABLE) == 0) {
145 aprint_error_dev(self, "memory access is disabled\n");
146 return;
147 }
148
149 /* map MMIO registers */
150 memtype = pci_mapreg_type(pa->pa_pc, pa->pa_tag, PCI_CBMEM);
151 switch (memtype) {
152 case PCI_MAPREG_TYPE_MEM | PCI_MAPREG_MEM_TYPE_32BIT:
153 case PCI_MAPREG_TYPE_MEM | PCI_MAPREG_MEM_TYPE_64BIT:
154 if (pci_mapreg_map(pa, PCI_CBMEM, memtype, 0,
155 &sc->sc_iot, &sc->sc_ioh, NULL, &sc->sc_ios)) {
156 sc->sc_ios = 0;
157 aprint_error_dev(self, "can't map mem space\n");
158 return;
159 }
160 break;
161 default:
162 aprint_error_dev(self, "BAR not 64 or 32-bit MMIO\n");
163 return;
164 }
165
166 psc->sc_pc = pc;
167 psc->sc_tag = tag;
168
169 hccparams = bus_space_read_4(sc->sc_iot, sc->sc_ioh, XHCI_HCCPARAMS);
170
171 if (pci_dma64_available(pa) && (XHCI_HCC_AC64(hccparams) != 0))
172 sc->sc_bus.ub_dmatag = pa->pa_dmat64;
173 else
174 sc->sc_bus.ub_dmatag = pa->pa_dmat;
175
176 /* Enable the device. */
177 pci_conf_write(pc, tag, PCI_COMMAND_STATUS_REG,
178 csr | PCI_COMMAND_MASTER_ENABLE);
179
180 /* Allocation settings */
181 int counts[PCI_INTR_TYPE_SIZE] = {
182 [PCI_INTR_TYPE_INTX] = 1,
183 #ifndef XHCI_DISABLE_MSI
184 [PCI_INTR_TYPE_MSI] = 1,
185 #endif
186 };
187
188 /* Allocate and establish the interrupt. */
189 if (pci_intr_alloc(pa, &psc->sc_pihp, counts, PCI_INTR_TYPE_MSIX)) {
190 aprint_error_dev(self, "can't allocate handler\n");
191 goto fail;
192 }
193 intrstr = pci_intr_string(pc, psc->sc_pihp[0], intrbuf,
194 sizeof(intrbuf));
195 psc->sc_ih = pci_intr_establish_xname(pc, psc->sc_pihp[0], IPL_USB,
196 xhci_intr, sc, device_xname(sc->sc_dev));
197 if (psc->sc_ih == NULL) {
198 aprint_error_dev(self, "couldn't establish interrupt");
199 if (intrstr != NULL)
200 aprint_error(" at %s", intrstr);
201 aprint_error("\n");
202 goto fail;
203 }
204 aprint_normal_dev(self, "interrupting at %s\n", intrstr);
205
206 /* Figure out vendor for root hub descriptor. */
207 sc->sc_id_vendor = PCI_VENDOR(pa->pa_id);
208 pci_findvendor(sc->sc_vendor, sizeof(sc->sc_vendor),
209 sc->sc_id_vendor);
210
211 /* Intel chipset requires SuperSpeed enable and USB2 port routing */
212 switch (PCI_VENDOR(pa->pa_id)) {
213 case PCI_VENDOR_INTEL:
214 sc->sc_quirks |= XHCI_QUIRK_INTEL;
215 break;
216 default:
217 break;
218 }
219
220 err = xhci_init(sc);
221 if (err) {
222 aprint_error_dev(self, "init failed, error=%d\n", err);
223 goto fail;
224 }
225
226 if ((sc->sc_quirks & XHCI_QUIRK_INTEL) != 0)
227 xhci_pci_port_route(psc);
228
229 if (!pmf_device_register1(self, xhci_suspend, xhci_resume,
230 xhci_shutdown))
231 aprint_error_dev(self, "couldn't establish power handler\n");
232
233 /* Attach usb buses. */
234 sc->sc_child = config_found(self, &sc->sc_bus, usbctlprint);
235
236 sc->sc_child2 = config_found(self, &sc->sc_bus2, usbctlprint);
237
238 return;
239
240 fail:
241 if (psc->sc_ih) {
242 pci_intr_release(psc->sc_pc, psc->sc_pihp, 1);
243 psc->sc_ih = NULL;
244 }
245 if (sc->sc_ios) {
246 bus_space_unmap(sc->sc_iot, sc->sc_ioh, sc->sc_ios);
247 sc->sc_ios = 0;
248 }
249 return;
250 }
251
252 static int
253 xhci_pci_detach(device_t self, int flags)
254 {
255 struct xhci_pci_softc * const psc = device_private(self);
256 struct xhci_softc * const sc = &psc->sc_xhci;
257 int rv;
258
259 rv = xhci_detach(sc, flags);
260 if (rv)
261 return rv;
262
263 pmf_device_deregister(self);
264
265 xhci_shutdown(self, flags);
266
267 if (sc->sc_ios) {
268 #if 0
269 /* Disable interrupts, so we don't get any spurious ones. */
270 bus_space_write_4(sc->sc_iot, sc->sc_ioh,
271 OHCI_INTERRUPT_DISABLE, OHCI_ALL_INTRS);
272 #endif
273 }
274
275 if (psc->sc_ih != NULL) {
276 pci_intr_release(psc->sc_pc, psc->sc_pihp, 1);
277 psc->sc_ih = NULL;
278 }
279 if (sc->sc_ios) {
280 bus_space_unmap(sc->sc_iot, sc->sc_ioh, sc->sc_ios);
281 sc->sc_ios = 0;
282 }
283
284 return 0;
285 }
286
287 CFATTACH_DECL3_NEW(xhci_pci, sizeof(struct xhci_pci_softc),
288 xhci_pci_match, xhci_pci_attach, xhci_pci_detach, xhci_activate, NULL,
289 xhci_childdet, DVF_DETACH_SHUTDOWN);
290