imx6_usb.c revision 1.7 1 /* $NetBSD: imx6_usb.c,v 1.7 2023/05/04 13:29:33 bouyer Exp $ */
2
3 /*-
4 * Copyright (c) 2019 Genetec Corporation. All rights reserved.
5 * Written by Hashimoto Kenichi for Genetec Corporation.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29 #include <sys/cdefs.h>
30 __KERNEL_RCSID(0, "$NetBSD: imx6_usb.c,v 1.7 2023/05/04 13:29:33 bouyer Exp $");
31
32 #include "opt_fdt.h"
33
34 #include <locators.h>
35
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/conf.h>
39 #include <sys/kernel.h>
40 #include <sys/device.h>
41 #include <sys/intr.h>
42 #include <sys/bus.h>
43
44 #include <dev/usb/usb.h>
45 #include <dev/usb/usbdi.h>
46 #include <dev/usb/usbdivar.h>
47 #include <dev/usb/usb_mem.h>
48
49 #include <dev/usb/ehcireg.h>
50 #include <dev/usb/ehcivar.h>
51
52 #include <arm/nxp/imx6_usbreg.h>
53 #include <arm/imx/imxusbvar.h>
54
55 #include <dev/fdt/fdtvar.h>
56
57 struct imxusbc_fdt_softc {
58 struct imxusbc_softc sc_imxusbc; /* Must be first */
59
60 int sc_phandle;
61 };
62
63 static int imx6_usb_match(device_t, struct cfdata *, void *);
64 static void imx6_usb_attach(device_t, device_t, void *);
65 static int imx6_usb_init_clocks(struct imxusbc_softc *);
66 static void imx6_usb_init(struct imxehci_softc *);
67 static void init_otg(struct imxehci_softc *);
68 static void init_h1(struct imxehci_softc *);
69 static int imxusbc_print(void *, const char *);
70 static void *imx6_usb_intr_establish(struct imxehci_softc *);
71
72 /* attach structures */
73 CFATTACH_DECL_NEW(imxusbc_fdt, sizeof(struct imxusbc_fdt_softc),
74 imx6_usb_match, imx6_usb_attach, NULL, NULL);
75
76 static const struct device_compatible_entry compat_data[] = {
77 { .compat = "fsl,imx6q-usb" },
78 { .compat = "fsl,imx6sx-usb" },
79 { .compat = "fsl,imx7d-usb" },
80 DEVICE_COMPAT_EOL
81 };
82
83 static int
84 imx6_usb_match(device_t parent, cfdata_t cf, void *aux)
85 {
86 struct fdt_attach_args * const faa = aux;
87
88 return of_compatible_match(faa->faa_phandle, compat_data);
89 }
90
91 static void
92 imx6_usb_attach(device_t parent, device_t self, void *aux)
93 {
94 struct imxusbc_fdt_softc *ifsc = device_private(self);
95 struct imxusbc_softc *sc = &ifsc->sc_imxusbc;
96 struct fdt_attach_args * const faa = aux;
97 const int phandle = faa->faa_phandle;
98 bus_space_tag_t bst = faa->faa_bst;
99 bus_space_handle_t bsh;
100 bus_addr_t addr;
101 bus_size_t size;
102 int error;
103
104 aprint_naive("\n");
105 aprint_normal("\n");
106
107 ifsc->sc_phandle = phandle;
108
109 if (fdtbus_get_reg(phandle, 0, &addr, &size) != 0) {
110 aprint_error(": couldn't get imxusbc registers\n");
111 return;
112 }
113
114 error = bus_space_map(bst, addr, size, 0, &bsh);
115 if (error) {
116 aprint_error(": couldn't map %#" PRIxBUSADDR ": %d", addr, error);
117 return;
118 }
119
120 sc->sc_clk = fdtbus_clock_get_index(phandle, 0);
121 if (sc->sc_clk == NULL) {
122 aprint_error(": couldn't get clock\n");
123 return;
124 }
125
126 sc->sc_init_md_hook = imx6_usb_init;
127 sc->sc_intr_establish_md_hook = imx6_usb_intr_establish;
128 sc->sc_setup_md_hook = NULL;
129
130 sc->sc_dev = self;
131 sc->sc_iot = bst;
132 sc->sc_ioh = bsh;
133 sc->sc_ehci_size = size;
134 sc->sc_ehci_offset = 0;
135
136 struct fdt_phandle_data data;
137 error = fdtbus_get_phandle_with_data(phandle, "fsl,usbmisc",
138 "#index-cells", 0, &data);
139 if (error) {
140 aprint_error(": couldn't get usbmisc property\n");
141 return;
142 }
143 int unit = be32toh(data.values[0]);
144
145 if (fdtbus_get_reg(data.phandle, 0, &addr, &size) != 0) {
146 aprint_error(": couldn't get usbmisc registers\n");
147 return;
148 }
149 error = bus_space_map(bst, addr, size, 0, &bsh);
150 if (error) {
151 aprint_error(": couldn't map usbmisc registers: %d\n", error);
152 return;
153 }
154 sc->sc_ioh_usbnc = bsh;
155
156 if (imx6_usb_init_clocks(sc) != 0) {
157 aprint_error_dev(self, "couldn't init clocks\n");
158 return;
159 }
160
161 /* attach OTG/EHCI host controllers */
162 struct imxusbc_attach_args iaa;
163 iaa.aa_iot = sc->sc_iot;
164 iaa.aa_ioh = sc->sc_ioh;
165 iaa.aa_dmat = faa->faa_dmat;
166 iaa.aa_unit = unit;
167 iaa.aa_irq = IMXUSBCCF_IRQ_DEFAULT;
168 config_found(self, &iaa, imxusbc_print,
169 CFARGS_NONE);
170
171 return;
172 }
173
174 static int
175 imxusbc_print(void *aux, const char *name __unused)
176 {
177 struct imxusbc_attach_args *iaa;
178
179 iaa = (struct imxusbc_attach_args *)aux;
180
181 aprint_normal(" unit %d", iaa->aa_unit);
182 return UNCONF;
183 }
184
185
186 static int
187 imx6_usb_init_clocks(struct imxusbc_softc *sc)
188 {
189 int error;
190
191 error = clk_enable(sc->sc_clk);
192 if (error) {
193 aprint_error_dev(sc->sc_dev, "couldn't enable: %d\n", error);
194 return error;
195 }
196
197 return 0;
198 }
199
200 static void
201 imx6_usb_init(struct imxehci_softc *sc)
202 {
203 switch (sc->sc_unit) {
204 case 0: /* OTG controller */
205 init_otg(sc);
206 break;
207 case 1: /* EHCI Host 1 */
208 init_h1(sc);
209 break;
210 case 2: /* EHCI Host 2 */
211 case 3: /* EHCI Host 3 */
212 default:
213 aprint_error_dev(sc->sc_dev, "unit %d not supported\n",
214 sc->sc_unit);
215 }
216 }
217
218 static void
219 init_otg(struct imxehci_softc *sc)
220 {
221 struct imxusbc_softc *usbc = sc->sc_usbc;
222 uint32_t v;
223
224 sc->sc_iftype = IMXUSBC_IF_UTMI_WIDE;
225
226 imxehci_reset(sc);
227
228 v = bus_space_read_4(usbc->sc_iot, usbc->sc_ioh_usbnc, USBNC_USB_OTG_CTRL);
229 v |= USBNC_USB_OTG_CTRL_WKUP_VBUS_EN;
230 v |= USBNC_USB_OTG_CTRL_OVER_CUR_DIS;
231 v |= USBNC_USB_OTG_CTRL_PWR_POL;
232 v &= ~USBNC_USB_OTG_CTRL_UTMI_ON_CLOCK;
233 bus_space_write_4(usbc->sc_iot, usbc->sc_ioh_usbnc, USBNC_USB_OTG_CTRL, v);
234 }
235
236 static void
237 init_h1(struct imxehci_softc *sc)
238 {
239 struct imxusbc_softc *usbc = sc->sc_usbc;
240 uint32_t v;
241
242 sc->sc_iftype = IMXUSBC_IF_UTMI_WIDE;
243
244 v = bus_space_read_4(usbc->sc_iot, usbc->sc_ioh_usbnc, USBNC_USB_UH1_CTRL);
245 v |= USBNC_USB_UH1_CTRL_OVER_CUR_POL;
246 v |= USBNC_USB_UH1_CTRL_OVER_CUR_DIS;
247 bus_space_write_4(usbc->sc_iot, usbc->sc_ioh_usbnc, USBNC_USB_UH1_CTRL, v);
248
249 /* do reset */
250 imxehci_reset(sc);
251
252 /* set mode */
253 v = bus_space_read_4(usbc->sc_iot, usbc->sc_ioh, USBC_UH1_USBMODE);
254 v &= ~USBC_UH_USBMODE_CM;
255 v |= __SHIFTIN(USBC_UH_USBMODE_CM, USBC_UH_USBMODE_CM_HOST_CONTROLLER);
256 bus_space_write_4(usbc->sc_iot, usbc->sc_ioh, USBC_UH1_USBMODE, v);
257 }
258
259 static void *
260 imx6_usb_intr_establish(struct imxehci_softc *sc)
261 {
262 struct imxusbc_fdt_softc *ifsc = (struct imxusbc_fdt_softc *)sc->sc_usbc;
263 ehci_softc_t *hsc = &sc->sc_hsc;
264 void *ih;
265
266 char intrstr[128];
267 if (!fdtbus_intr_str(ifsc->sc_phandle, 0, intrstr, sizeof(intrstr))) {
268 aprint_error_dev(sc->sc_dev, "failed to decode interrupt\n");
269 return NULL;
270 }
271 ih = fdtbus_intr_establish_xname(ifsc->sc_phandle, 0, IPL_USB,
272 FDT_INTR_MPSAFE, ehci_intr, hsc, device_xname(sc->sc_dev));
273 if (ih == NULL) {
274 aprint_error_dev(sc->sc_dev, "failed to establish interrupt on %s\n",
275 intrstr);
276 return NULL;
277 }
278 aprint_normal_dev(sc->sc_dev, "interrupting on %s\n", intrstr);
279
280 return ih;
281 }
282