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