Home | History | Annotate | Line # | Download | only in nxp
imx6_usb.c revision 1.5.8.1
      1 /*	$NetBSD: imx6_usb.c,v 1.5.8.1 2021/08/04 16:51:28 thorpej 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.5.8.1 2021/08/04 16:51:28 thorpej 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,imx7d-usb" },
     79 	DEVICE_COMPAT_EOL
     80 };
     81 
     82 static int
     83 imx6_usb_match(device_t parent, cfdata_t cf, void *aux)
     84 {
     85 	struct fdt_attach_args * const faa = aux;
     86 
     87 	return of_compatible_match(faa->faa_phandle, compat_data);
     88 }
     89 
     90 static void
     91 imx6_usb_attach(device_t parent, device_t self, void *aux)
     92 {
     93 	struct imxusbc_fdt_softc *ifsc = device_private(self);
     94 	struct imxusbc_softc *sc = &ifsc->sc_imxusbc;
     95 	struct fdt_attach_args * const faa = aux;
     96 	const int phandle = faa->faa_phandle;
     97 	bus_space_tag_t bst = faa->faa_bst;
     98 	bus_space_handle_t bsh;
     99 	bus_addr_t addr;
    100 	bus_size_t size;
    101 	int error;
    102 
    103 	aprint_naive("\n");
    104 	aprint_normal("\n");
    105 
    106 	ifsc->sc_phandle = phandle;
    107 
    108 	if (fdtbus_get_reg(phandle, 0, &addr, &size) != 0) {
    109 		aprint_error(": couldn't get imxusbc registers\n");
    110 		return;
    111 	}
    112 
    113 	error = bus_space_map(bst, addr, size, 0, &bsh);
    114 	if (error) {
    115 		aprint_error(": couldn't map %#" PRIxBUSADDR ": %d", addr, error);
    116 		return;
    117 	}
    118 
    119 	sc->sc_clk = fdtbus_clock_get_index(phandle, 0);
    120 	if (sc->sc_clk == NULL) {
    121 		aprint_error(": couldn't get clock\n");
    122 		return;
    123 	}
    124 
    125 	sc->sc_init_md_hook = imx6_usb_init;
    126 	sc->sc_intr_establish_md_hook = imx6_usb_intr_establish;
    127 	sc->sc_setup_md_hook = NULL;
    128 
    129 	sc->sc_dev = self;
    130 	sc->sc_iot = bst;
    131 	sc->sc_ioh = bsh;
    132 	sc->sc_ehci_size = size;
    133 	sc->sc_ehci_offset = 0;
    134 
    135 	struct fdt_phandle_data data;
    136 	error = fdtbus_get_phandle_with_data(phandle, "fsl,usbmisc",
    137 	    "#index-cells", 0, &data);
    138 	if (error) {
    139 		aprint_error(": couldn't get usbmisc property\n");
    140 		return;
    141 	}
    142 	int unit = be32toh(data.values[0]);
    143 
    144 	if (fdtbus_get_reg(data.phandle, 0, &addr, &size) != 0) {
    145 		aprint_error(": couldn't get usbmisc registers\n");
    146 		return;
    147 	}
    148 	error = bus_space_map(bst, addr, size, 0, &bsh);
    149 	if (error) {
    150 		aprint_error(": couldn't map usbmisc registers: %d\n", error);
    151 		return;
    152 	}
    153 	sc->sc_ioh_usbnc = bsh;
    154 
    155 	if (imx6_usb_init_clocks(sc) != 0) {
    156 		aprint_error_dev(self, "couldn't init clocks\n");
    157 		return;
    158 	}
    159 
    160 	/* attach OTG/EHCI host controllers */
    161 	struct imxusbc_attach_args iaa;
    162 	iaa.aa_iot = sc->sc_iot;
    163 	iaa.aa_ioh = sc->sc_ioh;
    164 	iaa.aa_dmat = faa->faa_dmat;
    165 	iaa.aa_unit = unit;
    166 	iaa.aa_irq = IMXUSBCCF_IRQ_DEFAULT;
    167 	config_found(self, &iaa, imxusbc_print,
    168 	    CFARGS_NONE);
    169 
    170 	return;
    171 }
    172 
    173 static int
    174 imxusbc_print(void *aux, const char *name __unused)
    175 {
    176 	struct imxusbc_attach_args *iaa;
    177 
    178 	iaa = (struct imxusbc_attach_args *)aux;
    179 
    180 	aprint_normal(" unit %d", iaa->aa_unit);
    181 	return UNCONF;
    182 }
    183 
    184 
    185 static int
    186 imx6_usb_init_clocks(struct imxusbc_softc *sc)
    187 {
    188 	int error;
    189 
    190 	error = clk_enable(sc->sc_clk);
    191 	if (error) {
    192 		aprint_error_dev(sc->sc_dev, "couldn't enable: %d\n", error);
    193 		return error;
    194 	}
    195 
    196 	return 0;
    197 }
    198 
    199 static void
    200 imx6_usb_init(struct imxehci_softc *sc)
    201 {
    202 	switch (sc->sc_unit) {
    203 	case 0:	/* OTG controller */
    204 		init_otg(sc);
    205 		break;
    206 	case 1:	/* EHCI Host 1 */
    207 		init_h1(sc);
    208 		break;
    209 	case 2:	/* EHCI Host 2 */
    210 	case 3:	/* EHCI Host 3 */
    211 	default:
    212 		aprint_error_dev(sc->sc_dev, "unit %d not supported\n",
    213 		    sc->sc_unit);
    214 	}
    215 }
    216 
    217 static void
    218 init_otg(struct imxehci_softc *sc)
    219 {
    220 	struct imxusbc_softc *usbc = sc->sc_usbc;
    221 	uint32_t v;
    222 
    223 	sc->sc_iftype = IMXUSBC_IF_UTMI_WIDE;
    224 
    225 	imxehci_reset(sc);
    226 
    227 	v = bus_space_read_4(usbc->sc_iot, usbc->sc_ioh_usbnc, USBNC_USB_OTG_CTRL);
    228 	v |= USBNC_USB_OTG_CTRL_WKUP_VBUS_EN;
    229 	v |= USBNC_USB_OTG_CTRL_OVER_CUR_DIS;
    230 	v |= USBNC_USB_OTG_CTRL_PWR_POL;
    231 	v &= ~USBNC_USB_OTG_CTRL_UTMI_ON_CLOCK;
    232 	bus_space_write_4(usbc->sc_iot, usbc->sc_ioh_usbnc, USBNC_USB_OTG_CTRL, v);
    233 }
    234 
    235 static void
    236 init_h1(struct imxehci_softc *sc)
    237 {
    238 	struct imxusbc_softc *usbc = sc->sc_usbc;
    239 	uint32_t v;
    240 
    241 	sc->sc_iftype = IMXUSBC_IF_UTMI_WIDE;
    242 
    243 	v = bus_space_read_4(usbc->sc_iot, usbc->sc_ioh_usbnc, USBNC_USB_UH1_CTRL);
    244 	v |= USBNC_USB_UH1_CTRL_OVER_CUR_POL;
    245 	v |= USBNC_USB_UH1_CTRL_OVER_CUR_DIS;
    246 	bus_space_write_4(usbc->sc_iot, usbc->sc_ioh_usbnc, USBNC_USB_UH1_CTRL, v);
    247 
    248 	/* do reset */
    249 	imxehci_reset(sc);
    250 
    251 	/* set mode */
    252 	v = bus_space_read_4(usbc->sc_iot, usbc->sc_ioh, USBC_UH1_USBMODE);
    253 	v &= ~USBC_UH_USBMODE_CM;
    254 	v |= __SHIFTIN(USBC_UH_USBMODE_CM, USBC_UH_USBMODE_CM_HOST_CONTROLLER);
    255 	bus_space_write_4(usbc->sc_iot, usbc->sc_ioh, USBC_UH1_USBMODE, v);
    256 }
    257 
    258 static void *
    259 imx6_usb_intr_establish(struct imxehci_softc *sc)
    260 {
    261 	struct imxusbc_fdt_softc *ifsc = (struct imxusbc_fdt_softc *)sc->sc_usbc;
    262 	ehci_softc_t *hsc = &sc->sc_hsc;
    263 	void *ih;
    264 
    265 	char intrstr[128];
    266 	if (!fdtbus_intr_str(ifsc->sc_phandle, 0, intrstr, sizeof(intrstr))) {
    267 		aprint_error_dev(sc->sc_dev, "failed to decode interrupt\n");
    268 		return NULL;
    269 	}
    270 	ih = fdtbus_intr_establish_xname(ifsc->sc_phandle, 0, IPL_USB,
    271 	    FDT_INTR_MPSAFE, ehci_intr, hsc, device_xname(sc->sc_dev));
    272 	if (ih == NULL) {
    273 		aprint_error_dev(sc->sc_dev, "failed to establish interrupt on %s\n",
    274 		    intrstr);
    275 		return NULL;
    276 	}
    277 	aprint_normal_dev(sc->sc_dev, "interrupting on %s\n", intrstr);
    278 
    279 	return ih;
    280 }
    281