xref: /netbsd-src/sys/dev/acpi/xhci_acpi.c (revision cef8759bd76c1b621f8eab8faa6f208faabc2e15)
1 /* $NetBSD: xhci_acpi.c,v 1.7 2020/01/31 23:12:13 jmcneill Exp $ */
2 
3 /*-
4  * Copyright (c) 2018 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jared McNeill <jmcneill@invisible.ca>.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #include <sys/cdefs.h>
33 __KERNEL_RCSID(0, "$NetBSD: xhci_acpi.c,v 1.7 2020/01/31 23:12:13 jmcneill Exp $");
34 
35 #include <sys/param.h>
36 #include <sys/bus.h>
37 #include <sys/cpu.h>
38 #include <sys/device.h>
39 
40 #include <dev/usb/usb.h>
41 #include <dev/usb/usbdi.h>
42 #include <dev/usb/usbdivar.h>
43 #include <dev/usb/usb_mem.h>
44 #include <dev/usb/xhcireg.h>
45 #include <dev/usb/xhcivar.h>
46 
47 #include <dev/acpi/acpireg.h>
48 #include <dev/acpi/acpivar.h>
49 #include <dev/acpi/acpi_intr.h>
50 #include <dev/acpi/acpi_usb.h>
51 
52 static const char * const compatible[] = {
53 	"PNP0D10",	/* XHCI-compliant USB controller without standard debug */
54 	"PNP0D15",	/* XHCI-compliant USB controller with standard debug */
55 	"808622B7",	/* DesignWare Dual Role SuperSpeed USB controller */
56 	NULL
57 };
58 
59 struct xhci_acpi_softc {
60 	struct xhci_softc	sc_xhci;
61 	ACPI_HANDLE		sc_handle;
62 };
63 
64 static int	xhci_acpi_match(device_t, cfdata_t, void *);
65 static void	xhci_acpi_attach(device_t, device_t, void *);
66 
67 static void	xhci_acpi_init(struct xhci_softc *);
68 
69 CFATTACH_DECL2_NEW(xhci_acpi, sizeof(struct xhci_acpi_softc),
70 	xhci_acpi_match, xhci_acpi_attach, NULL,
71 	xhci_activate, NULL, xhci_childdet);
72 
73 static int
74 xhci_acpi_match(device_t parent, cfdata_t cf, void *aux)
75 {
76 	struct acpi_attach_args *aa = aux;
77 
78 	if (aa->aa_node->ad_type != ACPI_TYPE_DEVICE)
79 		return 0;
80 
81 	return acpi_match_hid(aa->aa_node->ad_devinfo, compatible);
82 }
83 
84 static void
85 xhci_acpi_attach(device_t parent, device_t self, void *aux)
86 {
87 	struct xhci_acpi_softc * const asc = device_private(self);
88 	struct xhci_softc * const sc = &asc->sc_xhci;
89 	struct acpi_attach_args *aa = aux;
90 	struct acpi_resources res;
91 	struct acpi_mem *mem;
92 	struct acpi_irq *irq;
93 	uint32_t hccparams;
94 	ACPI_STATUS rv;
95 	int error;
96 	void *ih;
97 
98 	asc->sc_handle = aa->aa_node->ad_handle;
99 
100 	sc->sc_dev = self;
101 	sc->sc_bus.ub_hcpriv = sc;
102 	sc->sc_bus.ub_revision = USBREV_3_0;
103 	sc->sc_quirks = 0;
104 	sc->sc_vendor_init = xhci_acpi_init;
105 
106 	rv = acpi_resource_parse(sc->sc_dev, asc->sc_handle, "_CRS",
107 	    &res, &acpi_resource_parse_ops_default);
108 	if (ACPI_FAILURE(rv))
109 		return;
110 
111 	mem = acpi_res_mem(&res, 0);
112 	if (mem == NULL) {
113 		aprint_error_dev(self, "couldn't find mem resource\n");
114 		goto done;
115 	}
116 
117 	irq = acpi_res_irq(&res, 0);
118 	if (irq == NULL) {
119 		aprint_error_dev(self, "couldn't find irq resource\n");
120 		goto done;
121 	}
122 
123 	sc->sc_ios = mem->ar_length;
124 	sc->sc_iot = aa->aa_memt;
125 	error = bus_space_map(sc->sc_iot, mem->ar_base, mem->ar_length, 0, &sc->sc_ioh);
126 	if (error) {
127 		aprint_error_dev(self, "couldn't map registers\n");
128 		return;
129 	}
130 
131 	hccparams = bus_space_read_4(sc->sc_iot, sc->sc_ioh, XHCI_HCCPARAMS);
132 	if (XHCI_HCC_AC64(hccparams)) {
133 		aprint_verbose_dev(self, "using 64-bit DMA\n");
134 		sc->sc_bus.ub_dmatag = BUS_DMA_TAG_VALID(aa->aa_dmat64) ?
135 		    aa->aa_dmat64 : aa->aa_dmat;
136 	} else {
137 		aprint_verbose_dev(self, "using 32-bit DMA\n");
138 		sc->sc_bus.ub_dmatag = aa->aa_dmat;
139 	}
140 
141         ih = acpi_intr_establish(self, (uint64_t)aa->aa_node->ad_handle,
142 	    IPL_USB, true, xhci_intr, sc, device_xname(self));
143 	if (ih == NULL) {
144 		aprint_error_dev(self, "couldn't establish interrupt\n");
145 		return;
146 	}
147 
148 	error = xhci_init(sc);
149 	if (error) {
150 		aprint_error_dev(self, "init failed, error = %d\n", error);
151 		return;
152 	}
153 
154 	sc->sc_child = config_found(self, &sc->sc_bus, usbctlprint);
155 	sc->sc_child2 = config_found(self, &sc->sc_bus2, usbctlprint);
156 
157 done:
158 	acpi_resource_cleanup(&res);
159 }
160 
161 static void
162 xhci_acpi_init(struct xhci_softc *sc)
163 {
164 	struct xhci_acpi_softc * const asc = (struct xhci_acpi_softc *)sc;
165 
166 	acpi_usb_post_reset(asc->sc_handle);
167 }
168