Home | History | Annotate | Line # | Download | only in imx
imxusb.c revision 1.7.2.4
      1 /*	$NetBSD: imxusb.c,v 1.7.2.4 2015/09/22 12:05:37 skrll Exp $	*/
      2 /*
      3  * Copyright (c) 2009, 2010  Genetec Corporation.  All rights reserved.
      4  * Written by Hashimoto Kenichi and Hiroyuki Bessho for Genetec Corporation.
      5  *
      6  * Redistribution and use in source and binary forms, with or without
      7  * modification, are permitted provided that the following conditions
      8  * are met:
      9  * 1. Redistributions of source code must retain the above copyright
     10  *    notice, this list of conditions and the following disclaimer.
     11  * 2. Redistributions in binary form must reproduce the above copyright
     12  *    notice, this list of conditions and the following disclaimer in the
     13  *    documentation and/or other materials provided with the distribution.
     14  *
     15  * THIS SOFTWARE IS PROVIDED BY GENETEC CORPORATION ``AS IS'' AND
     16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL GENETEC CORPORATION
     19  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     25  * POSSIBILITY OF SUCH DAMAGE.
     26  */
     27 #include <sys/cdefs.h>
     28 __KERNEL_RCSID(0, "$NetBSD: imxusb.c,v 1.7.2.4 2015/09/22 12:05:37 skrll Exp $");
     29 
     30 #include "opt_imx.h"
     31 
     32 #include <sys/param.h>
     33 #include <sys/systm.h>
     34 #include <sys/conf.h>
     35 #include <sys/kernel.h>
     36 #include <sys/device.h>
     37 #include <sys/intr.h>
     38 #include <sys/bus.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 
     45 #include <dev/usb/ehcireg.h>
     46 #include <dev/usb/ehcivar.h>
     47 
     48 #include <arm/pic/picvar.h>	/* XXX: for intr_establish! */
     49 
     50 #include <arm/imx/imxusbreg.h>
     51 #include <arm/imx/imxusbvar.h>
     52 #include <arm/imx/imxgpiovar.h>
     53 #include "locators.h"
     54 
     55 #include <dev/usb/ulpireg.h>	/* for test */
     56 
     57 static int	imxehci_match(device_t, cfdata_t, void *);
     58 static void	imxehci_attach(device_t, device_t, void *);
     59 
     60 uint8_t imxusb_ulpi_read(struct imxehci_softc *sc, int addr);
     61 void imxusb_ulpi_write(struct imxehci_softc *sc, int addr, uint8_t data);
     62 static void ulpi_reset(struct imxehci_softc *sc);
     63 
     64 static void imxehci_select_interface(struct imxehci_softc *, enum imx_usb_if);
     65 static void imxehci_init(struct ehci_softc *);
     66 
     67 /* attach structures */
     68 CFATTACH_DECL_NEW(imxehci, sizeof(struct imxehci_softc),
     69     imxehci_match, imxehci_attach, NULL, NULL);
     70 
     71 static int
     72 imxehci_match(device_t parent, cfdata_t cf, void *aux)
     73 {
     74 	struct imxusbc_attach_args *aa = aux;
     75 
     76 	if (aa->aa_unit < 0 || 3 < aa->aa_unit) {
     77 		return 0;
     78 	}
     79 
     80 	return 1;
     81 }
     82 
     83 static void
     84 imxehci_attach(device_t parent, device_t self, void *aux)
     85 {
     86 	struct imxusbc_attach_args *aa = aux;
     87 	struct imxusbc_softc *usbc = device_private(parent);
     88 	struct imxehci_softc *sc = device_private(self);
     89 	ehci_softc_t *hsc = &sc->sc_hsc;
     90 	bus_space_tag_t iot;
     91 	uint16_t hcirev;
     92 	uint32_t id, hwhost, hwdevice;
     93 	const char *comma;
     94 
     95 	sc->sc_hsc.sc_dev = self;
     96 	iot = sc->sc_iot = sc->sc_hsc.iot = aa->aa_iot;
     97 	sc->sc_unit = aa->aa_unit;
     98 	sc->sc_usbc = usbc;
     99 	hsc->sc_bus.ub_hcpriv = sc;
    100 	hsc->sc_flags |= EHCIF_ETTF;
    101 	hsc->sc_vendor_init = imxehci_init;
    102 
    103 	aprint_naive("\n");
    104 	aprint_normal(": i.MX USB Controller\n");
    105 
    106 	/* per unit registers */
    107 	if (bus_space_subregion(iot, aa->aa_ioh,
    108 		aa->aa_unit * IMXUSB_EHCI_SIZE, IMXUSB_EHCI_SIZE,
    109 		&sc->sc_ioh) ||
    110 	    bus_space_subregion(iot, aa->aa_ioh,
    111 		aa->aa_unit * IMXUSB_EHCI_SIZE + IMXUSB_EHCIREGS,
    112 		IMXUSB_EHCI_SIZE - IMXUSB_EHCIREGS,
    113 		&sc->sc_hsc.ioh)) {
    114 
    115 		aprint_error_dev(self, "can't subregion\n");
    116 		return;
    117 	}
    118 
    119 	id = bus_space_read_4(iot, sc->sc_ioh, IMXUSB_ID);
    120 	hcirev = bus_space_read_2(iot, sc->sc_hsc.ioh, EHCI_HCIVERSION);
    121 
    122 	aprint_normal_dev(self,
    123 	    "id=%d revision=%d HCI revision=0x%x\n",
    124 	    (int)__SHIFTOUT(id, IMXUSB_ID_ID),
    125 	    (int)__SHIFTOUT(id, IMXUSB_ID_REVISION),
    126 	    hcirev);
    127 
    128 	hwhost = bus_space_read_4(iot, sc->sc_ioh, IMXUSB_HWHOST);
    129 	hwdevice = bus_space_read_4(iot, sc->sc_ioh, IMXUSB_HWDEVICE);
    130 
    131 	aprint_normal_dev(self, "");
    132 
    133 	comma = "";
    134 	if (hwhost & HWHOST_HC) {
    135 		int n_ports = 1 + __SHIFTOUT(hwhost, HWHOST_NPORT);
    136 		aprint_normal("%d host port%s",
    137 		    n_ports, n_ports > 1 ? "s" : "");
    138 		comma = ", ";
    139 	}
    140 
    141 	if (hwdevice & HWDEVICE_DC) {
    142 		int n_endpoints = __SHIFTOUT(hwdevice, HWDEVICE_DEVEP);
    143 		aprint_normal("%sdevice capable, %d endpoint%s",
    144 		    comma,
    145 		    n_endpoints, n_endpoints > 1 ? "s" : "");
    146 	}
    147 	aprint_normal("\n");
    148 
    149 	sc->sc_hsc.sc_bus.ub_dmatag = aa->aa_dmat;
    150 
    151 	sc->sc_hsc.sc_offs = bus_space_read_1(iot, sc->sc_hsc.ioh,
    152 	    EHCI_CAPLENGTH);
    153 
    154 	/* Platform dependent setup */
    155 	if (usbc->sc_init_md_hook)
    156 		usbc->sc_init_md_hook(sc);
    157 
    158 	imxehci_reset(sc);
    159 	imxehci_select_interface(sc, sc->sc_iftype);
    160 
    161 	if (sc->sc_iftype == IMXUSBC_IF_ULPI) {
    162 		bus_space_write_4(sc->sc_iot, sc->sc_ioh, IMXUSB_ULPIVIEW, 0);
    163 
    164 		aprint_normal_dev(hsc->sc_dev,
    165 		    "ULPI phy VID 0x%04x PID 0x%04x\n",
    166 		    (imxusb_ulpi_read(sc, ULPI_VENDOR_ID_LOW) |
    167 			imxusb_ulpi_read(sc, ULPI_VENDOR_ID_HIGH) << 8),
    168 		    (imxusb_ulpi_read(sc, ULPI_PRODUCT_ID_LOW) |
    169 			imxusb_ulpi_read(sc, ULPI_PRODUCT_ID_HIGH) << 8));
    170 
    171 		ulpi_reset(sc);
    172 
    173 	}
    174 
    175 	if (usbc->sc_setup_md_hook)
    176 		usbc->sc_setup_md_hook(sc, IMXUSB_HOST);
    177 
    178 	if (sc->sc_iftype == IMXUSBC_IF_ULPI) {
    179 #if 0
    180 		if(hsc->sc_bus.ub_revision == USBREV_2_0)
    181 			ulpi_write(hsc, ULPI_FUNCTION_CONTROL + ULPI_REG_CLEAR, (1 << 0));
    182 		else
    183 			ulpi_write(hsc, ULPI_FUNCTION_CONTROL + ULPI_REG_SET, (1 << 2));
    184 #endif
    185 
    186 		imxusb_ulpi_write(sc, ULPI_FUNCTION_CONTROL + ULPI_REG_CLEAR,
    187 		    OTG_CONTROL_IDPULLUP);
    188 
    189 		imxusb_ulpi_write(sc, ULPI_OTG_CONTROL + ULPI_REG_SET,
    190 		    OTG_CONTROL_USEEXTVBUSIND |
    191 		    OTG_CONTROL_DRVVBUSEXT |
    192 		    OTG_CONTROL_DRVVBUS |
    193 		    OTG_CONTROL_CHRGVBUS
    194 		    );
    195 	}
    196 
    197 	/* Disable interrupts, so we don't get any spurious ones. */
    198 	EOWRITE4(hsc, EHCI_USBINTR, 0);
    199 
    200 	intr_establish(aa->aa_irq, IPL_USB, IST_LEVEL, ehci_intr, hsc);
    201 
    202 	/* Figure out vendor for root hub descriptor. */
    203 	strlcpy(hsc->sc_vendor, "i.MX", sizeof(hsc->sc_vendor));
    204 
    205 	int err = ehci_init(hsc);
    206 	if (err) {
    207 		aprint_error_dev(self, "init failed, error=%d\n", err);
    208 		return;
    209 	}
    210 
    211 	/* Attach usb device. */
    212 	hsc->sc_child = config_found(self, &hsc->sc_bus, usbctlprint);
    213 }
    214 
    215 static void
    216 imxehci_select_interface(struct imxehci_softc *sc, enum imx_usb_if interface)
    217 {
    218 	uint32_t reg;
    219 	struct ehci_softc *hsc = &sc->sc_hsc;
    220 
    221 	reg = EOREAD4(hsc, EHCI_PORTSC(1));
    222 	reg &= ~(PORTSC_PTS | PORTSC_PTW);
    223 	switch (interface) {
    224 	case IMXUSBC_IF_UTMI_WIDE:
    225 		reg |= PORTSC_PTW_16;
    226 	case IMXUSBC_IF_UTMI:
    227 		reg |= PORTSC_PTS_UTMI;
    228 		break;
    229 	case IMXUSBC_IF_PHILIPS:
    230 		reg |= PORTSC_PTS_PHILIPS;
    231 		break;
    232 	case IMXUSBC_IF_ULPI:
    233 		reg |= PORTSC_PTS_ULPI;
    234 		break;
    235 	case IMXUSBC_IF_SERIAL:
    236 		reg |= PORTSC_PTS_SERIAL;
    237 		break;
    238 	}
    239 	EOWRITE4(hsc, EHCI_PORTSC(1), reg);
    240 }
    241 
    242 static uint32_t
    243 ulpi_wakeup(struct imxehci_softc *sc, int tout)
    244 {
    245 	uint32_t ulpi_view;
    246 	int i = 0;
    247 	ulpi_view = bus_space_read_4(sc->sc_iot, sc->sc_ioh, IMXUSB_ULPIVIEW);
    248 
    249 	if ( !(ulpi_view & ULPI_SS) ) {
    250 		bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    251 		    IMXUSB_ULPIVIEW, ULPI_WU);
    252 		for (i = 0; (tout < 0) || (i < tout); i++) {
    253 			ulpi_view = bus_space_read_4(sc->sc_iot,
    254 			    sc->sc_ioh, IMXUSB_ULPIVIEW);
    255 			if ( !(ulpi_view & ULPI_WU) )
    256 				break;
    257 			delay(1);
    258 		};
    259 	}
    260 
    261 	if ((tout > 0) && (i >= tout)) {
    262 		aprint_error_dev(sc->sc_hsc.sc_dev, "%s: timeout\n", __func__);
    263 	}
    264 
    265 	return ulpi_view;
    266 }
    267 
    268 static uint32_t
    269 ulpi_wait(struct imxehci_softc *sc, int tout)
    270 {
    271 	uint32_t ulpi_view;
    272 	int i;
    273 	ulpi_view = bus_space_read_4(sc->sc_iot, sc->sc_ioh, IMXUSB_ULPIVIEW);
    274 
    275 	for (i = 0; (tout < 0) | (i < tout); i++) {
    276 		ulpi_view = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    277 		    IMXUSB_ULPIVIEW);
    278 		if (!(ulpi_view & ULPI_RUN))
    279 			break;
    280 		delay(1);
    281 	}
    282 
    283 	if ((tout > 0) && (i >= tout)) {
    284 		aprint_error_dev(sc->sc_hsc.sc_dev, "%s: timeout\n", __func__);
    285 	}
    286 
    287 	return ulpi_view;
    288 }
    289 
    290 #define	TIMEOUT	100000
    291 
    292 uint8_t
    293 imxusb_ulpi_read(struct imxehci_softc *sc, int addr)
    294 {
    295 	uint32_t data;
    296 
    297 	ulpi_wakeup(sc, TIMEOUT);
    298 
    299 	data = ULPI_RUN | __SHIFTIN(addr, ULPI_ADDR);
    300 	bus_space_write_4(sc->sc_iot, sc->sc_ioh, IMXUSB_ULPIVIEW, data);
    301 
    302 	data = ulpi_wait(sc, TIMEOUT);
    303 
    304 	return __SHIFTOUT(data, ULPI_DATRD);
    305 }
    306 
    307 void
    308 imxusb_ulpi_write(struct imxehci_softc *sc, int addr, uint8_t data)
    309 {
    310 	uint32_t reg;
    311 
    312 	ulpi_wakeup(sc, TIMEOUT);
    313 
    314 	reg = ULPI_RUN | ULPI_RW | __SHIFTIN(addr, ULPI_ADDR) | __SHIFTIN(data, ULPI_DATWR);
    315 	bus_space_write_4(sc->sc_iot, sc->sc_ioh, IMXUSB_ULPIVIEW, reg);
    316 
    317 	ulpi_wait(sc, TIMEOUT);
    318 
    319 	return;
    320 }
    321 
    322 #if 0
    323 static int
    324 ulpi_scratch_test(struct imxehci_softc *sc)
    325 {
    326 	uint32_t ulpi_view;
    327 
    328 	ulpi_view = ulpi_wakeup(sc, 1000);
    329 	if (ulpi_view & ULPI_WU) {
    330 		return -1;
    331 	}
    332 
    333 	bus_space_write_4(sc->sc_iot, sc->sc_ioh, IMXUSB_ULPIVIEW,
    334 		(ULPI_RUN | ULPI_RW |
    335 		 (ULPI_SCRATCH << ULPI_ADDR_SHIFT) | 0xAA));
    336 
    337 	ulpi_view = ulpi_wait(sc, 1000);
    338 
    339 	if (ulpi_view & ULPI_RUN) {
    340 		return -1;
    341 	}
    342 
    343 	return 0;
    344 }
    345 #endif
    346 
    347 static void
    348 ulpi_reset(struct imxehci_softc *sc)
    349 {
    350 	uint8_t data;
    351 	int timo = 1000 * 1000;	/* XXXX: 1sec */
    352 
    353 	imxusb_ulpi_write(sc, ULPI_FUNCTION_CONTROL + ULPI_REG_SET,
    354 	    FUNCTION_CONTROL_RESET /*0x20*/);
    355 	do {
    356 		data = imxusb_ulpi_read(sc, ULPI_FUNCTION_CONTROL);
    357 		if (!(data & FUNCTION_CONTROL_RESET))
    358 			break;
    359 		delay(100);
    360 		timo -= 100;
    361 	} while (timo > 0);
    362 	if (timo <= 0) {
    363 		aprint_error_dev(sc->sc_hsc.sc_dev, "%s: reset failed!!\n",
    364 		    __func__);
    365 		return;
    366 	}
    367 
    368 	return;
    369 }
    370 
    371 void
    372 imxehci_reset(struct imxehci_softc *sc)
    373 {
    374 	uint32_t reg;
    375 	int i;
    376 	struct ehci_softc *hsc = &sc->sc_hsc;
    377 #define	RESET_TIMEOUT 100
    378 
    379 	reg = EOREAD4(hsc, EHCI_USBCMD);
    380 	reg &= ~EHCI_CMD_RS;
    381 	EOWRITE4(hsc, EHCI_USBCMD, reg);
    382 
    383 	for (i=0; i < RESET_TIMEOUT; ++i) {
    384 		reg = EOREAD4(hsc, EHCI_USBCMD);
    385 		if ((reg & EHCI_CMD_RS) == 0)
    386 			break;
    387 		usb_delay_ms(&hsc->sc_bus, 1);
    388 	}
    389 
    390 	EOWRITE4(hsc, EHCI_USBCMD, reg | EHCI_CMD_HCRESET);
    391 	for (i = 0; i < RESET_TIMEOUT; i++) {
    392 		reg = EOREAD4(hsc, EHCI_USBCMD);
    393 		if ((reg &  EHCI_CMD_HCRESET) == 0)
    394 			break;
    395 		usb_delay_ms(&hsc->sc_bus, 1);
    396 	}
    397 	if (i >= RESET_TIMEOUT) {
    398 		aprint_error_dev(hsc->sc_dev, "reset timeout (%x)\n", reg);
    399 	}
    400 
    401 	usb_delay_ms(&hsc->sc_bus, 100);
    402 }
    403 
    404 static void
    405 imxehci_init(struct ehci_softc *hsc)
    406 {
    407 	struct imxehci_softc *sc = device_private(hsc->sc_dev);
    408 	uint32_t reg;
    409 
    410 	reg = EOREAD4(hsc, EHCI_PORTSC(1));
    411 	reg &= ~(EHCI_PS_CSC | EHCI_PS_PEC | EHCI_PS_OCC);
    412 	reg |= EHCI_PS_PP | EHCI_PS_PE;
    413 	EOWRITE4(hsc, EHCI_PORTSC(1), reg);
    414 
    415 	reg = bus_space_read_4(sc->sc_iot, sc->sc_ioh, IMXUSB_OTGSC);
    416 	reg |= OTGSC_IDPU;
    417 	/* disable IDIE not to conflict with SSP1_DETECT. */
    418 	//reg |= OTGSC_DPIE | OTGSC_IDIE;
    419 	reg |= OTGSC_DPIE;
    420 	bus_space_write_4(sc->sc_iot, sc->sc_ioh, IMXUSB_OTGSC, reg);
    421 
    422 	reg = bus_space_read_4(sc->sc_iot, sc->sc_ioh, IMXUSB_USBMODE);
    423 	reg &= ~USBMODE_CM;
    424 	reg |= USBMODE_CM_HOST;
    425 	bus_space_write_4(sc->sc_iot, sc->sc_ioh, IMXUSB_USBMODE, reg);
    426 }
    427