imxusb.c revision 1.6.2.1 1 /* $NetBSD: imxusb.c,v 1.6.2.1 2017/04/05 19:54:16 snj 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.6.2.1 2017/04/05 19:54:16 snj 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 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_normal("\n");
104
105 /* per unit registers */
106 if (bus_space_subregion(iot, aa->aa_ioh,
107 aa->aa_unit * IMXUSB_EHCI_SIZE, IMXUSB_EHCI_SIZE,
108 &sc->sc_ioh) ||
109 bus_space_subregion(iot, aa->aa_ioh,
110 aa->aa_unit * IMXUSB_EHCI_SIZE + IMXUSB_EHCIREGS,
111 IMXUSB_EHCI_SIZE - IMXUSB_EHCIREGS,
112 &sc->sc_hsc.ioh)) {
113
114 aprint_error_dev(self, "can't subregion\n");
115 return;
116 }
117
118 id = bus_space_read_4(iot, sc->sc_ioh, IMXUSB_ID);
119 hcirev = bus_space_read_2(iot, sc->sc_hsc.ioh, EHCI_HCIVERSION);
120
121 aprint_normal_dev(self,
122 "i.MX USB Controller id=%d revision=%d HCI revision=0x%x\n",
123 (int)__SHIFTOUT(id, IMXUSB_ID_ID),
124 (int)__SHIFTOUT(id, IMXUSB_ID_REVISION),
125 hcirev);
126
127 hwhost = bus_space_read_4(iot, sc->sc_ioh, IMXUSB_HWHOST);
128 hwdevice = bus_space_read_4(iot, sc->sc_ioh, IMXUSB_HWDEVICE);
129
130 aprint_normal_dev(self, "");
131
132 comma = "";
133 if (hwhost & HWHOST_HC) {
134 int n_ports = 1 + __SHIFTOUT(hwhost, HWHOST_NPORT);
135 aprint_normal("%d host port%s",
136 n_ports, n_ports > 1 ? "s" : "");
137 comma = ", ";
138 }
139
140 if (hwdevice & HWDEVICE_DC) {
141 int n_endpoints = __SHIFTOUT(hwdevice, HWDEVICE_DEVEP);
142 aprint_normal("%sdevice capable, %d endpoint%s",
143 comma,
144 n_endpoints, n_endpoints > 1 ? "s" : "");
145 }
146 aprint_normal("\n");
147
148 sc->sc_hsc.sc_bus.ub_dmatag = aa->aa_dmat;
149
150 sc->sc_hsc.sc_offs = bus_space_read_1(iot, sc->sc_hsc.ioh,
151 EHCI_CAPLENGTH);
152
153 /* Platform dependent setup */
154 if (usbc->sc_init_md_hook)
155 usbc->sc_init_md_hook(sc);
156
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
216
217
218 void
219 imxehci_select_interface(struct imxehci_softc *sc, enum imx_usb_if interface)
220 {
221 uint32_t reg;
222 struct ehci_softc *hsc = &sc->sc_hsc;
223
224 reg = EOREAD4(hsc, EHCI_PORTSC(1));
225 reg &= ~(PORTSC_PTS | PORTSC_PTW);
226 switch (interface) {
227 case IMXUSBC_IF_UTMI_WIDE:
228 reg |= PORTSC_PTW_16;
229 case IMXUSBC_IF_UTMI:
230 reg |= PORTSC_PTS_UTMI;
231 break;
232 case IMXUSBC_IF_PHILIPS:
233 reg |= PORTSC_PTS_PHILIPS;
234 break;
235 case IMXUSBC_IF_ULPI:
236 reg |= PORTSC_PTS_ULPI;
237 break;
238 case IMXUSBC_IF_SERIAL:
239 reg |= PORTSC_PTS_SERIAL;
240 break;
241 }
242 EOWRITE4(hsc, EHCI_PORTSC(1), reg);
243 }
244
245
246 static uint32_t
247 ulpi_wakeup(struct imxehci_softc *sc, int tout)
248 {
249 uint32_t ulpi_view;
250 int i = 0;
251 ulpi_view = bus_space_read_4(sc->sc_iot, sc->sc_ioh, IMXUSB_ULPIVIEW);
252
253 if ( !(ulpi_view & ULPI_SS) ) {
254 bus_space_write_4(sc->sc_iot, sc->sc_ioh,
255 IMXUSB_ULPIVIEW, ULPI_WU);
256 for (i = 0; (tout < 0) || (i < tout); i++) {
257 ulpi_view = bus_space_read_4(sc->sc_iot,
258 sc->sc_ioh, IMXUSB_ULPIVIEW);
259 if ( !(ulpi_view & ULPI_WU) )
260 break;
261 delay(1);
262 };
263 }
264
265 if ((tout > 0) && (i >= tout)) {
266 aprint_error_dev(sc->sc_hsc.sc_dev, "%s: timeout\n", __func__);
267 }
268
269 return ulpi_view;
270 }
271
272 static uint32_t
273 ulpi_wait(struct imxehci_softc *sc, int tout)
274 {
275 uint32_t ulpi_view;
276 int i;
277 ulpi_view = bus_space_read_4(sc->sc_iot, sc->sc_ioh, IMXUSB_ULPIVIEW);
278
279 for (i = 0; (tout < 0) | (i < tout); i++) {
280 ulpi_view = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
281 IMXUSB_ULPIVIEW);
282 if (!(ulpi_view & ULPI_RUN))
283 break;
284 delay(1);
285 }
286
287 if ((tout > 0) && (i >= tout)) {
288 aprint_error_dev(sc->sc_hsc.sc_dev, "%s: timeout\n", __func__);
289 }
290
291 return ulpi_view;
292 }
293
294 #define TIMEOUT 100000
295
296 uint8_t
297 imxusb_ulpi_read(struct imxehci_softc *sc, int addr)
298 {
299 uint32_t data;
300
301 ulpi_wakeup(sc, TIMEOUT);
302
303 data = ULPI_RUN | __SHIFTIN(addr, ULPI_ADDR);
304 bus_space_write_4(sc->sc_iot, sc->sc_ioh, IMXUSB_ULPIVIEW, data);
305
306 data = ulpi_wait(sc, TIMEOUT);
307
308 return __SHIFTOUT(data, ULPI_DATRD);
309 }
310
311 void
312 imxusb_ulpi_write(struct imxehci_softc *sc, int addr, uint8_t data)
313 {
314 uint32_t reg;
315
316 ulpi_wakeup(sc, TIMEOUT);
317
318 reg = ULPI_RUN | ULPI_RW | __SHIFTIN(addr, ULPI_ADDR) | __SHIFTIN(data, ULPI_DATWR);
319 bus_space_write_4(sc->sc_iot, sc->sc_ioh, IMXUSB_ULPIVIEW, reg);
320
321 ulpi_wait(sc, TIMEOUT);
322
323 return;
324 }
325
326 #if 0
327 static int
328 ulpi_scratch_test(struct imxehci_softc *sc)
329 {
330 uint32_t ulpi_view;
331
332 ulpi_view = ulpi_wakeup(sc, 1000);
333 if (ulpi_view & ULPI_WU) {
334 return -1;
335 }
336
337 bus_space_write_4(sc->sc_iot, sc->sc_ioh, IMXUSB_ULPIVIEW,
338 (ULPI_RUN | ULPI_RW |
339 (ULPI_SCRATCH << ULPI_ADDR_SHIFT) | 0xAA));
340
341 ulpi_view = ulpi_wait(sc, 1000);
342
343 if (ulpi_view & ULPI_RUN) {
344 return -1;
345 }
346
347 return 0;
348 }
349 #endif
350
351 static void
352 ulpi_reset(struct imxehci_softc *sc)
353 {
354 uint8_t data;
355 int timo = 1000 * 1000; /* XXXX: 1sec */
356
357 imxusb_ulpi_write(sc, ULPI_FUNCTION_CONTROL + ULPI_REG_SET,
358 FUNCTION_CONTROL_RESET /*0x20*/);
359 do {
360 data = imxusb_ulpi_read(sc, ULPI_FUNCTION_CONTROL);
361 if (!(data & FUNCTION_CONTROL_RESET))
362 break;
363 delay(100);
364 timo -= 100;
365 } while (timo > 0);
366 if (timo <= 0) {
367 aprint_error_dev(sc->sc_hsc.sc_dev, "%s: reset failed!!\n",
368 __func__);
369 return;
370 }
371
372 return;
373 }
374
375 void
376 imxehci_reset(struct imxehci_softc *sc)
377 {
378 uint32_t reg;
379 int i;
380 struct ehci_softc *hsc = &sc->sc_hsc;
381 #define RESET_TIMEOUT 100
382
383 reg = EOREAD4(hsc, EHCI_USBCMD);
384 reg &= ~EHCI_CMD_RS;
385 EOWRITE4(hsc, EHCI_USBCMD, reg);
386
387 for (i=0; i < RESET_TIMEOUT; ++i) {
388 reg = EOREAD4(hsc, EHCI_USBCMD);
389 if ((reg & EHCI_CMD_RS) == 0)
390 break;
391 usb_delay_ms(&hsc->sc_bus, 1);
392 }
393
394 EOWRITE4(hsc, EHCI_USBCMD, reg | EHCI_CMD_HCRESET);
395 for (i = 0; i < RESET_TIMEOUT; i++) {
396 reg = EOREAD4(hsc, EHCI_USBCMD);
397 if ((reg & EHCI_CMD_HCRESET) == 0)
398 break;
399 usb_delay_ms(&hsc->sc_bus, 1);
400 }
401 if (i >= RESET_TIMEOUT) {
402 aprint_error_dev(hsc->sc_dev, "reset timeout (%x)\n", reg);
403 }
404
405 usb_delay_ms(&hsc->sc_bus, 100);
406 }
407
408 static void
409 imxehci_init(struct ehci_softc *hsc)
410 {
411 struct imxehci_softc *sc = device_private(hsc->sc_dev);
412 uint32_t reg;
413
414 reg = EOREAD4(hsc, EHCI_PORTSC(1));
415 reg &= ~(EHCI_PS_CSC | EHCI_PS_PEC | EHCI_PS_OCC);
416 reg |= EHCI_PS_PP | EHCI_PS_PE;
417 EOWRITE4(hsc, EHCI_PORTSC(1), reg);
418
419 reg = bus_space_read_4(sc->sc_iot, sc->sc_ioh, IMXUSB_OTGSC);
420 reg |= OTGSC_IDPU;
421 /* disable IDIE not to conflict with SSP1_DETECT. */
422 //reg |= OTGSC_DPIE | OTGSC_IDIE;
423 reg |= OTGSC_DPIE;
424 bus_space_write_4(sc->sc_iot, sc->sc_ioh, IMXUSB_OTGSC, reg);
425
426 reg = bus_space_read_4(sc->sc_iot, sc->sc_ioh, IMXUSB_USBMODE);
427 reg &= ~USBMODE_CM;
428 reg |= USBMODE_CM_HOST;
429 bus_space_write_4(sc->sc_iot, sc->sc_ioh, IMXUSB_USBMODE, reg);
430 }
431