xref: /rk3399_rockchip-uboot/drivers/usb/host/ehci-hcd.c (revision aeca43e3883e2a25a8ecb183555df9ac2da311a7)
1 /*-
2  * Copyright (c) 2007-2008, Juniper Networks, Inc.
3  * Copyright (c) 2008, Excito Elektronik i Skåne AB
4  * Copyright (c) 2008, Michael Trimarchi <trimarchimichael@yahoo.it>
5  *
6  * All rights reserved.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License as
10  * published by the Free Software Foundation version 2 of
11  * the License.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21  * MA 02111-1307 USA
22  */
23 #include <common.h>
24 #include <errno.h>
25 #include <asm/byteorder.h>
26 #include <asm/unaligned.h>
27 #include <usb.h>
28 #include <asm/io.h>
29 #include <malloc.h>
30 #include <watchdog.h>
31 #include <linux/compiler.h>
32 
33 #include "ehci.h"
34 
35 #ifndef CONFIG_USB_MAX_CONTROLLER_COUNT
36 #define CONFIG_USB_MAX_CONTROLLER_COUNT 1
37 #endif
38 
39 /*
40  * EHCI spec page 20 says that the HC may take up to 16 uFrames (= 4ms) to halt.
41  * Let's time out after 8 to have a little safety margin on top of that.
42  */
43 #define HCHALT_TIMEOUT (8 * 1000)
44 
45 static struct ehci_ctrl ehcic[CONFIG_USB_MAX_CONTROLLER_COUNT];
46 
47 #define ALIGN_END_ADDR(type, ptr, size)			\
48 	((unsigned long)(ptr) + roundup((size) * sizeof(type), USB_DMA_MINALIGN))
49 
50 static struct descriptor {
51 	struct usb_hub_descriptor hub;
52 	struct usb_device_descriptor device;
53 	struct usb_linux_config_descriptor config;
54 	struct usb_linux_interface_descriptor interface;
55 	struct usb_endpoint_descriptor endpoint;
56 }  __attribute__ ((packed)) descriptor = {
57 	{
58 		0x8,		/* bDescLength */
59 		0x29,		/* bDescriptorType: hub descriptor */
60 		2,		/* bNrPorts -- runtime modified */
61 		0,		/* wHubCharacteristics */
62 		10,		/* bPwrOn2PwrGood */
63 		0,		/* bHubCntrCurrent */
64 		{},		/* Device removable */
65 		{}		/* at most 7 ports! XXX */
66 	},
67 	{
68 		0x12,		/* bLength */
69 		1,		/* bDescriptorType: UDESC_DEVICE */
70 		cpu_to_le16(0x0200), /* bcdUSB: v2.0 */
71 		9,		/* bDeviceClass: UDCLASS_HUB */
72 		0,		/* bDeviceSubClass: UDSUBCLASS_HUB */
73 		1,		/* bDeviceProtocol: UDPROTO_HSHUBSTT */
74 		64,		/* bMaxPacketSize: 64 bytes */
75 		0x0000,		/* idVendor */
76 		0x0000,		/* idProduct */
77 		cpu_to_le16(0x0100), /* bcdDevice */
78 		1,		/* iManufacturer */
79 		2,		/* iProduct */
80 		0,		/* iSerialNumber */
81 		1		/* bNumConfigurations: 1 */
82 	},
83 	{
84 		0x9,
85 		2,		/* bDescriptorType: UDESC_CONFIG */
86 		cpu_to_le16(0x19),
87 		1,		/* bNumInterface */
88 		1,		/* bConfigurationValue */
89 		0,		/* iConfiguration */
90 		0x40,		/* bmAttributes: UC_SELF_POWER */
91 		0		/* bMaxPower */
92 	},
93 	{
94 		0x9,		/* bLength */
95 		4,		/* bDescriptorType: UDESC_INTERFACE */
96 		0,		/* bInterfaceNumber */
97 		0,		/* bAlternateSetting */
98 		1,		/* bNumEndpoints */
99 		9,		/* bInterfaceClass: UICLASS_HUB */
100 		0,		/* bInterfaceSubClass: UISUBCLASS_HUB */
101 		0,		/* bInterfaceProtocol: UIPROTO_HSHUBSTT */
102 		0		/* iInterface */
103 	},
104 	{
105 		0x7,		/* bLength */
106 		5,		/* bDescriptorType: UDESC_ENDPOINT */
107 		0x81,		/* bEndpointAddress:
108 				 * UE_DIR_IN | EHCI_INTR_ENDPT
109 				 */
110 		3,		/* bmAttributes: UE_INTERRUPT */
111 		8,		/* wMaxPacketSize */
112 		255		/* bInterval */
113 	},
114 };
115 
116 #if defined(CONFIG_EHCI_IS_TDI)
117 #define ehci_is_TDI()	(1)
118 #else
119 #define ehci_is_TDI()	(0)
120 #endif
121 
122 static struct ehci_ctrl *ehci_get_ctrl(struct usb_device *udev)
123 {
124 	return udev->controller;
125 }
126 
127 static int ehci_get_port_speed(struct ehci_ctrl *ctrl, uint32_t reg)
128 {
129 	return PORTSC_PSPD(reg);
130 }
131 
132 static void ehci_set_usbmode(struct ehci_ctrl *ctrl)
133 {
134 	uint32_t tmp;
135 	uint32_t *reg_ptr;
136 
137 	reg_ptr = (uint32_t *)((u8 *)&ctrl->hcor->or_usbcmd + USBMODE);
138 	tmp = ehci_readl(reg_ptr);
139 	tmp |= USBMODE_CM_HC;
140 #if defined(CONFIG_EHCI_MMIO_BIG_ENDIAN)
141 	tmp |= USBMODE_BE;
142 #endif
143 	ehci_writel(reg_ptr, tmp);
144 }
145 
146 static void ehci_powerup_fixup(struct ehci_ctrl *ctrl, uint32_t *status_reg,
147 			       uint32_t *reg)
148 {
149 	mdelay(50);
150 }
151 
152 static uint32_t *ehci_get_portsc_register(struct ehci_ctrl *ctrl, int port)
153 {
154 	if (port < 0 || port >= CONFIG_SYS_USB_EHCI_MAX_ROOT_PORTS) {
155 		/* Printing the message would cause a scan failure! */
156 		debug("The request port(%u) is not configured\n", port);
157 		return NULL;
158 	}
159 
160 	return (uint32_t *)&ctrl->hcor->or_portsc[port];
161 }
162 
163 static int handshake(uint32_t *ptr, uint32_t mask, uint32_t done, int usec)
164 {
165 	uint32_t result;
166 	do {
167 		result = ehci_readl(ptr);
168 		udelay(5);
169 		if (result == ~(uint32_t)0)
170 			return -1;
171 		result &= mask;
172 		if (result == done)
173 			return 0;
174 		usec--;
175 	} while (usec > 0);
176 	return -1;
177 }
178 
179 static int ehci_reset(struct ehci_ctrl *ctrl)
180 {
181 	uint32_t cmd;
182 	int ret = 0;
183 
184 	cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
185 	cmd = (cmd & ~CMD_RUN) | CMD_RESET;
186 	ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
187 	ret = handshake((uint32_t *)&ctrl->hcor->or_usbcmd,
188 			CMD_RESET, 0, 250 * 1000);
189 	if (ret < 0) {
190 		printf("EHCI fail to reset\n");
191 		goto out;
192 	}
193 
194 	if (ehci_is_TDI())
195 		ctrl->ops.set_usb_mode(ctrl);
196 
197 #ifdef CONFIG_USB_EHCI_TXFIFO_THRESH
198 	cmd = ehci_readl(&ctrl->hcor->or_txfilltuning);
199 	cmd &= ~TXFIFO_THRESH_MASK;
200 	cmd |= TXFIFO_THRESH(CONFIG_USB_EHCI_TXFIFO_THRESH);
201 	ehci_writel(&ctrl->hcor->or_txfilltuning, cmd);
202 #endif
203 out:
204 	return ret;
205 }
206 
207 static int ehci_shutdown(struct ehci_ctrl *ctrl)
208 {
209 	int i, ret = 0;
210 	uint32_t cmd, reg;
211 
212 	if (!ctrl || !ctrl->hcor)
213 		return -EINVAL;
214 
215 	cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
216 	cmd &= ~(CMD_PSE | CMD_ASE);
217 	ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
218 	ret = handshake(&ctrl->hcor->or_usbsts, STS_ASS | STS_PSS, 0,
219 		100 * 1000);
220 
221 	if (!ret) {
222 		for (i = 0; i < CONFIG_SYS_USB_EHCI_MAX_ROOT_PORTS; i++) {
223 			reg = ehci_readl(&ctrl->hcor->or_portsc[i]);
224 			reg |= EHCI_PS_SUSP;
225 			ehci_writel(&ctrl->hcor->or_portsc[i], reg);
226 		}
227 
228 		cmd &= ~CMD_RUN;
229 		ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
230 		ret = handshake(&ctrl->hcor->or_usbsts, STS_HALT, STS_HALT,
231 			HCHALT_TIMEOUT);
232 	}
233 
234 	if (ret)
235 		puts("EHCI failed to shut down host controller.\n");
236 
237 	return ret;
238 }
239 
240 static int ehci_td_buffer(struct qTD *td, void *buf, size_t sz)
241 {
242 	uint32_t delta, next;
243 	uint32_t addr = (unsigned long)buf;
244 	int idx;
245 
246 	if (addr != ALIGN(addr, ARCH_DMA_MINALIGN))
247 		debug("EHCI-HCD: Misaligned buffer address (%p)\n", buf);
248 
249 	flush_dcache_range(addr, ALIGN(addr + sz, ARCH_DMA_MINALIGN));
250 
251 	idx = 0;
252 	while (idx < QT_BUFFER_CNT) {
253 		td->qt_buffer[idx] = cpu_to_hc32(addr);
254 		td->qt_buffer_hi[idx] = 0;
255 		next = (addr + EHCI_PAGE_SIZE) & ~(EHCI_PAGE_SIZE - 1);
256 		delta = next - addr;
257 		if (delta >= sz)
258 			break;
259 		sz -= delta;
260 		addr = next;
261 		idx++;
262 	}
263 
264 	if (idx == QT_BUFFER_CNT) {
265 		printf("out of buffer pointers (%zu bytes left)\n", sz);
266 		return -1;
267 	}
268 
269 	return 0;
270 }
271 
272 static inline u8 ehci_encode_speed(enum usb_device_speed speed)
273 {
274 	#define QH_HIGH_SPEED	2
275 	#define QH_FULL_SPEED	0
276 	#define QH_LOW_SPEED	1
277 	if (speed == USB_SPEED_HIGH)
278 		return QH_HIGH_SPEED;
279 	if (speed == USB_SPEED_LOW)
280 		return QH_LOW_SPEED;
281 	return QH_FULL_SPEED;
282 }
283 
284 static void ehci_update_endpt2_dev_n_port(struct usb_device *dev,
285 					  struct QH *qh)
286 {
287 	struct usb_device *ttdev;
288 
289 	if (dev->speed != USB_SPEED_LOW && dev->speed != USB_SPEED_FULL)
290 		return;
291 
292 	/*
293 	 * For full / low speed devices we need to get the devnum and portnr of
294 	 * the tt, so of the first upstream usb-2 hub, there may be usb-1 hubs
295 	 * in the tree before that one!
296 	 */
297 	ttdev = dev;
298 	while (ttdev->parent && ttdev->parent->speed != USB_SPEED_HIGH)
299 		ttdev = ttdev->parent;
300 	if (!ttdev->parent)
301 		return;
302 
303 	qh->qh_endpt2 |= cpu_to_hc32(QH_ENDPT2_PORTNUM(ttdev->portnr) |
304 				     QH_ENDPT2_HUBADDR(ttdev->parent->devnum));
305 }
306 
307 static int
308 ehci_submit_async(struct usb_device *dev, unsigned long pipe, void *buffer,
309 		   int length, struct devrequest *req)
310 {
311 	ALLOC_ALIGN_BUFFER(struct QH, qh, 1, USB_DMA_MINALIGN);
312 	struct qTD *qtd;
313 	int qtd_count = 0;
314 	int qtd_counter = 0;
315 	volatile struct qTD *vtd;
316 	unsigned long ts;
317 	uint32_t *tdp;
318 	uint32_t endpt, maxpacket, token, usbsts;
319 	uint32_t c, toggle;
320 	uint32_t cmd;
321 	int timeout;
322 	int ret = 0;
323 	struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
324 
325 	debug("dev=%p, pipe=%lx, buffer=%p, length=%d, req=%p\n", dev, pipe,
326 	      buffer, length, req);
327 	if (req != NULL)
328 		debug("req=%u (%#x), type=%u (%#x), value=%u (%#x), index=%u\n",
329 		      req->request, req->request,
330 		      req->requesttype, req->requesttype,
331 		      le16_to_cpu(req->value), le16_to_cpu(req->value),
332 		      le16_to_cpu(req->index));
333 
334 #define PKT_ALIGN	512
335 	/*
336 	 * The USB transfer is split into qTD transfers. Eeach qTD transfer is
337 	 * described by a transfer descriptor (the qTD). The qTDs form a linked
338 	 * list with a queue head (QH).
339 	 *
340 	 * Each qTD transfer starts with a new USB packet, i.e. a packet cannot
341 	 * have its beginning in a qTD transfer and its end in the following
342 	 * one, so the qTD transfer lengths have to be chosen accordingly.
343 	 *
344 	 * Each qTD transfer uses up to QT_BUFFER_CNT data buffers, mapped to
345 	 * single pages. The first data buffer can start at any offset within a
346 	 * page (not considering the cache-line alignment issues), while the
347 	 * following buffers must be page-aligned. There is no alignment
348 	 * constraint on the size of a qTD transfer.
349 	 */
350 	if (req != NULL)
351 		/* 1 qTD will be needed for SETUP, and 1 for ACK. */
352 		qtd_count += 1 + 1;
353 	if (length > 0 || req == NULL) {
354 		/*
355 		 * Determine the qTD transfer size that will be used for the
356 		 * data payload (not considering the first qTD transfer, which
357 		 * may be longer or shorter, and the final one, which may be
358 		 * shorter).
359 		 *
360 		 * In order to keep each packet within a qTD transfer, the qTD
361 		 * transfer size is aligned to PKT_ALIGN, which is a multiple of
362 		 * wMaxPacketSize (except in some cases for interrupt transfers,
363 		 * see comment in submit_int_msg()).
364 		 *
365 		 * By default, i.e. if the input buffer is aligned to PKT_ALIGN,
366 		 * QT_BUFFER_CNT full pages will be used.
367 		 */
368 		int xfr_sz = QT_BUFFER_CNT;
369 		/*
370 		 * However, if the input buffer is not aligned to PKT_ALIGN, the
371 		 * qTD transfer size will be one page shorter, and the first qTD
372 		 * data buffer of each transfer will be page-unaligned.
373 		 */
374 		if ((unsigned long)buffer & (PKT_ALIGN - 1))
375 			xfr_sz--;
376 		/* Convert the qTD transfer size to bytes. */
377 		xfr_sz *= EHCI_PAGE_SIZE;
378 		/*
379 		 * Approximate by excess the number of qTDs that will be
380 		 * required for the data payload. The exact formula is way more
381 		 * complicated and saves at most 2 qTDs, i.e. a total of 128
382 		 * bytes.
383 		 */
384 		qtd_count += 2 + length / xfr_sz;
385 	}
386 /*
387  * Threshold value based on the worst-case total size of the allocated qTDs for
388  * a mass-storage transfer of 65535 blocks of 512 bytes.
389  */
390 #if CONFIG_SYS_MALLOC_LEN <= 64 + 128 * 1024
391 #warning CONFIG_SYS_MALLOC_LEN may be too small for EHCI
392 #endif
393 	qtd = memalign(USB_DMA_MINALIGN, qtd_count * sizeof(struct qTD));
394 	if (qtd == NULL) {
395 		printf("unable to allocate TDs\n");
396 		return -1;
397 	}
398 
399 	memset(qh, 0, sizeof(struct QH));
400 	memset(qtd, 0, qtd_count * sizeof(*qtd));
401 
402 	toggle = usb_gettoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
403 
404 	/*
405 	 * Setup QH (3.6 in ehci-r10.pdf)
406 	 *
407 	 *   qh_link ................. 03-00 H
408 	 *   qh_endpt1 ............... 07-04 H
409 	 *   qh_endpt2 ............... 0B-08 H
410 	 * - qh_curtd
411 	 *   qh_overlay.qt_next ...... 13-10 H
412 	 * - qh_overlay.qt_altnext
413 	 */
414 	qh->qh_link = cpu_to_hc32((unsigned long)&ctrl->qh_list | QH_LINK_TYPE_QH);
415 	c = (dev->speed != USB_SPEED_HIGH) && !usb_pipeendpoint(pipe);
416 	maxpacket = usb_maxpacket(dev, pipe);
417 	endpt = QH_ENDPT1_RL(8) | QH_ENDPT1_C(c) |
418 		QH_ENDPT1_MAXPKTLEN(maxpacket) | QH_ENDPT1_H(0) |
419 		QH_ENDPT1_DTC(QH_ENDPT1_DTC_DT_FROM_QTD) |
420 		QH_ENDPT1_EPS(ehci_encode_speed(dev->speed)) |
421 		QH_ENDPT1_ENDPT(usb_pipeendpoint(pipe)) | QH_ENDPT1_I(0) |
422 		QH_ENDPT1_DEVADDR(usb_pipedevice(pipe));
423 	qh->qh_endpt1 = cpu_to_hc32(endpt);
424 	endpt = QH_ENDPT2_MULT(1) | QH_ENDPT2_UFCMASK(0) | QH_ENDPT2_UFSMASK(0);
425 	qh->qh_endpt2 = cpu_to_hc32(endpt);
426 	ehci_update_endpt2_dev_n_port(dev, qh);
427 	qh->qh_overlay.qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
428 	qh->qh_overlay.qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
429 
430 	tdp = &qh->qh_overlay.qt_next;
431 
432 	if (req != NULL) {
433 		/*
434 		 * Setup request qTD (3.5 in ehci-r10.pdf)
435 		 *
436 		 *   qt_next ................ 03-00 H
437 		 *   qt_altnext ............. 07-04 H
438 		 *   qt_token ............... 0B-08 H
439 		 *
440 		 *   [ buffer, buffer_hi ] loaded with "req".
441 		 */
442 		qtd[qtd_counter].qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
443 		qtd[qtd_counter].qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
444 		token = QT_TOKEN_DT(0) | QT_TOKEN_TOTALBYTES(sizeof(*req)) |
445 			QT_TOKEN_IOC(0) | QT_TOKEN_CPAGE(0) | QT_TOKEN_CERR(3) |
446 			QT_TOKEN_PID(QT_TOKEN_PID_SETUP) |
447 			QT_TOKEN_STATUS(QT_TOKEN_STATUS_ACTIVE);
448 		qtd[qtd_counter].qt_token = cpu_to_hc32(token);
449 		if (ehci_td_buffer(&qtd[qtd_counter], req, sizeof(*req))) {
450 			printf("unable to construct SETUP TD\n");
451 			goto fail;
452 		}
453 		/* Update previous qTD! */
454 		*tdp = cpu_to_hc32((unsigned long)&qtd[qtd_counter]);
455 		tdp = &qtd[qtd_counter++].qt_next;
456 		toggle = 1;
457 	}
458 
459 	if (length > 0 || req == NULL) {
460 		uint8_t *buf_ptr = buffer;
461 		int left_length = length;
462 
463 		do {
464 			/*
465 			 * Determine the size of this qTD transfer. By default,
466 			 * QT_BUFFER_CNT full pages can be used.
467 			 */
468 			int xfr_bytes = QT_BUFFER_CNT * EHCI_PAGE_SIZE;
469 			/*
470 			 * However, if the input buffer is not page-aligned, the
471 			 * portion of the first page before the buffer start
472 			 * offset within that page is unusable.
473 			 */
474 			xfr_bytes -= (unsigned long)buf_ptr & (EHCI_PAGE_SIZE - 1);
475 			/*
476 			 * In order to keep each packet within a qTD transfer,
477 			 * align the qTD transfer size to PKT_ALIGN.
478 			 */
479 			xfr_bytes &= ~(PKT_ALIGN - 1);
480 			/*
481 			 * This transfer may be shorter than the available qTD
482 			 * transfer size that has just been computed.
483 			 */
484 			xfr_bytes = min(xfr_bytes, left_length);
485 
486 			/*
487 			 * Setup request qTD (3.5 in ehci-r10.pdf)
488 			 *
489 			 *   qt_next ................ 03-00 H
490 			 *   qt_altnext ............. 07-04 H
491 			 *   qt_token ............... 0B-08 H
492 			 *
493 			 *   [ buffer, buffer_hi ] loaded with "buffer".
494 			 */
495 			qtd[qtd_counter].qt_next =
496 					cpu_to_hc32(QT_NEXT_TERMINATE);
497 			qtd[qtd_counter].qt_altnext =
498 					cpu_to_hc32(QT_NEXT_TERMINATE);
499 			token = QT_TOKEN_DT(toggle) |
500 				QT_TOKEN_TOTALBYTES(xfr_bytes) |
501 				QT_TOKEN_IOC(req == NULL) | QT_TOKEN_CPAGE(0) |
502 				QT_TOKEN_CERR(3) |
503 				QT_TOKEN_PID(usb_pipein(pipe) ?
504 					QT_TOKEN_PID_IN : QT_TOKEN_PID_OUT) |
505 				QT_TOKEN_STATUS(QT_TOKEN_STATUS_ACTIVE);
506 			qtd[qtd_counter].qt_token = cpu_to_hc32(token);
507 			if (ehci_td_buffer(&qtd[qtd_counter], buf_ptr,
508 						xfr_bytes)) {
509 				printf("unable to construct DATA TD\n");
510 				goto fail;
511 			}
512 			/* Update previous qTD! */
513 			*tdp = cpu_to_hc32((unsigned long)&qtd[qtd_counter]);
514 			tdp = &qtd[qtd_counter++].qt_next;
515 			/*
516 			 * Data toggle has to be adjusted since the qTD transfer
517 			 * size is not always an even multiple of
518 			 * wMaxPacketSize.
519 			 */
520 			if ((xfr_bytes / maxpacket) & 1)
521 				toggle ^= 1;
522 			buf_ptr += xfr_bytes;
523 			left_length -= xfr_bytes;
524 		} while (left_length > 0);
525 	}
526 
527 	if (req != NULL) {
528 		/*
529 		 * Setup request qTD (3.5 in ehci-r10.pdf)
530 		 *
531 		 *   qt_next ................ 03-00 H
532 		 *   qt_altnext ............. 07-04 H
533 		 *   qt_token ............... 0B-08 H
534 		 */
535 		qtd[qtd_counter].qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
536 		qtd[qtd_counter].qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
537 		token = QT_TOKEN_DT(1) | QT_TOKEN_TOTALBYTES(0) |
538 			QT_TOKEN_IOC(1) | QT_TOKEN_CPAGE(0) | QT_TOKEN_CERR(3) |
539 			QT_TOKEN_PID(usb_pipein(pipe) ?
540 				QT_TOKEN_PID_OUT : QT_TOKEN_PID_IN) |
541 			QT_TOKEN_STATUS(QT_TOKEN_STATUS_ACTIVE);
542 		qtd[qtd_counter].qt_token = cpu_to_hc32(token);
543 		/* Update previous qTD! */
544 		*tdp = cpu_to_hc32((unsigned long)&qtd[qtd_counter]);
545 		tdp = &qtd[qtd_counter++].qt_next;
546 	}
547 
548 	ctrl->qh_list.qh_link = cpu_to_hc32((unsigned long)qh | QH_LINK_TYPE_QH);
549 
550 	/* Flush dcache */
551 	flush_dcache_range((unsigned long)&ctrl->qh_list,
552 		ALIGN_END_ADDR(struct QH, &ctrl->qh_list, 1));
553 	flush_dcache_range((unsigned long)qh, ALIGN_END_ADDR(struct QH, qh, 1));
554 	flush_dcache_range((unsigned long)qtd,
555 			   ALIGN_END_ADDR(struct qTD, qtd, qtd_count));
556 
557 	/* Set async. queue head pointer. */
558 	ehci_writel(&ctrl->hcor->or_asynclistaddr, (unsigned long)&ctrl->qh_list);
559 
560 	usbsts = ehci_readl(&ctrl->hcor->or_usbsts);
561 	ehci_writel(&ctrl->hcor->or_usbsts, (usbsts & 0x3f));
562 
563 	/* Enable async. schedule. */
564 	cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
565 	cmd |= CMD_ASE;
566 	ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
567 
568 	ret = handshake((uint32_t *)&ctrl->hcor->or_usbsts, STS_ASS, STS_ASS,
569 			100 * 1000);
570 	if (ret < 0) {
571 		printf("EHCI fail timeout STS_ASS set\n");
572 		goto fail;
573 	}
574 
575 	/* Wait for TDs to be processed. */
576 	ts = get_timer(0);
577 	vtd = &qtd[qtd_counter - 1];
578 	timeout = USB_TIMEOUT_MS(pipe);
579 	do {
580 		/* Invalidate dcache */
581 		invalidate_dcache_range((unsigned long)&ctrl->qh_list,
582 			ALIGN_END_ADDR(struct QH, &ctrl->qh_list, 1));
583 		invalidate_dcache_range((unsigned long)qh,
584 			ALIGN_END_ADDR(struct QH, qh, 1));
585 		invalidate_dcache_range((unsigned long)qtd,
586 			ALIGN_END_ADDR(struct qTD, qtd, qtd_count));
587 
588 		token = hc32_to_cpu(vtd->qt_token);
589 		if (!(QT_TOKEN_GET_STATUS(token) & QT_TOKEN_STATUS_ACTIVE))
590 			break;
591 		WATCHDOG_RESET();
592 	} while (get_timer(ts) < timeout);
593 
594 	/*
595 	 * Invalidate the memory area occupied by buffer
596 	 * Don't try to fix the buffer alignment, if it isn't properly
597 	 * aligned it's upper layer's fault so let invalidate_dcache_range()
598 	 * vow about it. But we have to fix the length as it's actual
599 	 * transfer length and can be unaligned. This is potentially
600 	 * dangerous operation, it's responsibility of the calling
601 	 * code to make sure enough space is reserved.
602 	 */
603 	invalidate_dcache_range((unsigned long)buffer,
604 		ALIGN((unsigned long)buffer + length, ARCH_DMA_MINALIGN));
605 
606 	/* Check that the TD processing happened */
607 	if (QT_TOKEN_GET_STATUS(token) & QT_TOKEN_STATUS_ACTIVE)
608 		printf("EHCI timed out on TD - token=%#x\n", token);
609 
610 	/* Disable async schedule. */
611 	cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
612 	cmd &= ~CMD_ASE;
613 	ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
614 
615 	ret = handshake((uint32_t *)&ctrl->hcor->or_usbsts, STS_ASS, 0,
616 			100 * 1000);
617 	if (ret < 0) {
618 		printf("EHCI fail timeout STS_ASS reset\n");
619 		goto fail;
620 	}
621 
622 	token = hc32_to_cpu(qh->qh_overlay.qt_token);
623 	if (!(QT_TOKEN_GET_STATUS(token) & QT_TOKEN_STATUS_ACTIVE)) {
624 		debug("TOKEN=%#x\n", token);
625 		switch (QT_TOKEN_GET_STATUS(token) &
626 			~(QT_TOKEN_STATUS_SPLITXSTATE | QT_TOKEN_STATUS_PERR)) {
627 		case 0:
628 			toggle = QT_TOKEN_GET_DT(token);
629 			usb_settoggle(dev, usb_pipeendpoint(pipe),
630 				       usb_pipeout(pipe), toggle);
631 			dev->status = 0;
632 			break;
633 		case QT_TOKEN_STATUS_HALTED:
634 			dev->status = USB_ST_STALLED;
635 			break;
636 		case QT_TOKEN_STATUS_ACTIVE | QT_TOKEN_STATUS_DATBUFERR:
637 		case QT_TOKEN_STATUS_DATBUFERR:
638 			dev->status = USB_ST_BUF_ERR;
639 			break;
640 		case QT_TOKEN_STATUS_HALTED | QT_TOKEN_STATUS_BABBLEDET:
641 		case QT_TOKEN_STATUS_BABBLEDET:
642 			dev->status = USB_ST_BABBLE_DET;
643 			break;
644 		default:
645 			dev->status = USB_ST_CRC_ERR;
646 			if (QT_TOKEN_GET_STATUS(token) & QT_TOKEN_STATUS_HALTED)
647 				dev->status |= USB_ST_STALLED;
648 			break;
649 		}
650 		dev->act_len = length - QT_TOKEN_GET_TOTALBYTES(token);
651 	} else {
652 		dev->act_len = 0;
653 #ifndef CONFIG_USB_EHCI_FARADAY
654 		debug("dev=%u, usbsts=%#x, p[1]=%#x, p[2]=%#x\n",
655 		      dev->devnum, ehci_readl(&ctrl->hcor->or_usbsts),
656 		      ehci_readl(&ctrl->hcor->or_portsc[0]),
657 		      ehci_readl(&ctrl->hcor->or_portsc[1]));
658 #endif
659 	}
660 
661 	free(qtd);
662 	return (dev->status != USB_ST_NOT_PROC) ? 0 : -1;
663 
664 fail:
665 	free(qtd);
666 	return -1;
667 }
668 
669 static int ehci_submit_root(struct usb_device *dev, unsigned long pipe,
670 			    void *buffer, int length, struct devrequest *req)
671 {
672 	uint8_t tmpbuf[4];
673 	u16 typeReq;
674 	void *srcptr = NULL;
675 	int len, srclen;
676 	uint32_t reg;
677 	uint32_t *status_reg;
678 	int port = le16_to_cpu(req->index) & 0xff;
679 	struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
680 
681 	srclen = 0;
682 
683 	debug("req=%u (%#x), type=%u (%#x), value=%u, index=%u\n",
684 	      req->request, req->request,
685 	      req->requesttype, req->requesttype,
686 	      le16_to_cpu(req->value), le16_to_cpu(req->index));
687 
688 	typeReq = req->request | req->requesttype << 8;
689 
690 	switch (typeReq) {
691 	case USB_REQ_GET_STATUS | ((USB_RT_PORT | USB_DIR_IN) << 8):
692 	case USB_REQ_SET_FEATURE | ((USB_DIR_OUT | USB_RT_PORT) << 8):
693 	case USB_REQ_CLEAR_FEATURE | ((USB_DIR_OUT | USB_RT_PORT) << 8):
694 		status_reg = ctrl->ops.get_portsc_register(ctrl, port - 1);
695 		if (!status_reg)
696 			return -1;
697 		break;
698 	default:
699 		status_reg = NULL;
700 		break;
701 	}
702 
703 	switch (typeReq) {
704 	case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
705 		switch (le16_to_cpu(req->value) >> 8) {
706 		case USB_DT_DEVICE:
707 			debug("USB_DT_DEVICE request\n");
708 			srcptr = &descriptor.device;
709 			srclen = descriptor.device.bLength;
710 			break;
711 		case USB_DT_CONFIG:
712 			debug("USB_DT_CONFIG config\n");
713 			srcptr = &descriptor.config;
714 			srclen = descriptor.config.bLength +
715 					descriptor.interface.bLength +
716 					descriptor.endpoint.bLength;
717 			break;
718 		case USB_DT_STRING:
719 			debug("USB_DT_STRING config\n");
720 			switch (le16_to_cpu(req->value) & 0xff) {
721 			case 0:	/* Language */
722 				srcptr = "\4\3\1\0";
723 				srclen = 4;
724 				break;
725 			case 1:	/* Vendor */
726 				srcptr = "\16\3u\0-\0b\0o\0o\0t\0";
727 				srclen = 14;
728 				break;
729 			case 2:	/* Product */
730 				srcptr = "\52\3E\0H\0C\0I\0 "
731 					 "\0H\0o\0s\0t\0 "
732 					 "\0C\0o\0n\0t\0r\0o\0l\0l\0e\0r\0";
733 				srclen = 42;
734 				break;
735 			default:
736 				debug("unknown value DT_STRING %x\n",
737 					le16_to_cpu(req->value));
738 				goto unknown;
739 			}
740 			break;
741 		default:
742 			debug("unknown value %x\n", le16_to_cpu(req->value));
743 			goto unknown;
744 		}
745 		break;
746 	case USB_REQ_GET_DESCRIPTOR | ((USB_DIR_IN | USB_RT_HUB) << 8):
747 		switch (le16_to_cpu(req->value) >> 8) {
748 		case USB_DT_HUB:
749 			debug("USB_DT_HUB config\n");
750 			srcptr = &descriptor.hub;
751 			srclen = descriptor.hub.bLength;
752 			break;
753 		default:
754 			debug("unknown value %x\n", le16_to_cpu(req->value));
755 			goto unknown;
756 		}
757 		break;
758 	case USB_REQ_SET_ADDRESS | (USB_RECIP_DEVICE << 8):
759 		debug("USB_REQ_SET_ADDRESS\n");
760 		ctrl->rootdev = le16_to_cpu(req->value);
761 		break;
762 	case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
763 		debug("USB_REQ_SET_CONFIGURATION\n");
764 		/* Nothing to do */
765 		break;
766 	case USB_REQ_GET_STATUS | ((USB_DIR_IN | USB_RT_HUB) << 8):
767 		tmpbuf[0] = 1;	/* USB_STATUS_SELFPOWERED */
768 		tmpbuf[1] = 0;
769 		srcptr = tmpbuf;
770 		srclen = 2;
771 		break;
772 	case USB_REQ_GET_STATUS | ((USB_RT_PORT | USB_DIR_IN) << 8):
773 		memset(tmpbuf, 0, 4);
774 		reg = ehci_readl(status_reg);
775 		if (reg & EHCI_PS_CS)
776 			tmpbuf[0] |= USB_PORT_STAT_CONNECTION;
777 		if (reg & EHCI_PS_PE)
778 			tmpbuf[0] |= USB_PORT_STAT_ENABLE;
779 		if (reg & EHCI_PS_SUSP)
780 			tmpbuf[0] |= USB_PORT_STAT_SUSPEND;
781 		if (reg & EHCI_PS_OCA)
782 			tmpbuf[0] |= USB_PORT_STAT_OVERCURRENT;
783 		if (reg & EHCI_PS_PR)
784 			tmpbuf[0] |= USB_PORT_STAT_RESET;
785 		if (reg & EHCI_PS_PP)
786 			tmpbuf[1] |= USB_PORT_STAT_POWER >> 8;
787 
788 		if (ehci_is_TDI()) {
789 			switch (ctrl->ops.get_port_speed(ctrl, reg)) {
790 			case PORTSC_PSPD_FS:
791 				break;
792 			case PORTSC_PSPD_LS:
793 				tmpbuf[1] |= USB_PORT_STAT_LOW_SPEED >> 8;
794 				break;
795 			case PORTSC_PSPD_HS:
796 			default:
797 				tmpbuf[1] |= USB_PORT_STAT_HIGH_SPEED >> 8;
798 				break;
799 			}
800 		} else {
801 			tmpbuf[1] |= USB_PORT_STAT_HIGH_SPEED >> 8;
802 		}
803 
804 		if (reg & EHCI_PS_CSC)
805 			tmpbuf[2] |= USB_PORT_STAT_C_CONNECTION;
806 		if (reg & EHCI_PS_PEC)
807 			tmpbuf[2] |= USB_PORT_STAT_C_ENABLE;
808 		if (reg & EHCI_PS_OCC)
809 			tmpbuf[2] |= USB_PORT_STAT_C_OVERCURRENT;
810 		if (ctrl->portreset & (1 << port))
811 			tmpbuf[2] |= USB_PORT_STAT_C_RESET;
812 
813 		srcptr = tmpbuf;
814 		srclen = 4;
815 		break;
816 	case USB_REQ_SET_FEATURE | ((USB_DIR_OUT | USB_RT_PORT) << 8):
817 		reg = ehci_readl(status_reg);
818 		reg &= ~EHCI_PS_CLEAR;
819 		switch (le16_to_cpu(req->value)) {
820 		case USB_PORT_FEAT_ENABLE:
821 			reg |= EHCI_PS_PE;
822 			ehci_writel(status_reg, reg);
823 			break;
824 		case USB_PORT_FEAT_POWER:
825 			if (HCS_PPC(ehci_readl(&ctrl->hccr->cr_hcsparams))) {
826 				reg |= EHCI_PS_PP;
827 				ehci_writel(status_reg, reg);
828 			}
829 			break;
830 		case USB_PORT_FEAT_RESET:
831 			if ((reg & (EHCI_PS_PE | EHCI_PS_CS)) == EHCI_PS_CS &&
832 			    !ehci_is_TDI() &&
833 			    EHCI_PS_IS_LOWSPEED(reg)) {
834 				/* Low speed device, give up ownership. */
835 				debug("port %d low speed --> companion\n",
836 				      port - 1);
837 				reg |= EHCI_PS_PO;
838 				ehci_writel(status_reg, reg);
839 				break;
840 			} else {
841 				int ret;
842 
843 				reg |= EHCI_PS_PR;
844 				reg &= ~EHCI_PS_PE;
845 				ehci_writel(status_reg, reg);
846 				/*
847 				 * caller must wait, then call GetPortStatus
848 				 * usb 2.0 specification say 50 ms resets on
849 				 * root
850 				 */
851 				ctrl->ops.powerup_fixup(ctrl, status_reg, &reg);
852 
853 				ehci_writel(status_reg, reg & ~EHCI_PS_PR);
854 				/*
855 				 * A host controller must terminate the reset
856 				 * and stabilize the state of the port within
857 				 * 2 milliseconds
858 				 */
859 				ret = handshake(status_reg, EHCI_PS_PR, 0,
860 						2 * 1000);
861 				if (!ret)
862 					ctrl->portreset |= 1 << port;
863 				else
864 					printf("port(%d) reset error\n",
865 					       port - 1);
866 			}
867 			break;
868 		case USB_PORT_FEAT_TEST:
869 			ehci_shutdown(ctrl);
870 			reg &= ~(0xf << 16);
871 			reg |= ((le16_to_cpu(req->index) >> 8) & 0xf) << 16;
872 			ehci_writel(status_reg, reg);
873 			break;
874 		default:
875 			debug("unknown feature %x\n", le16_to_cpu(req->value));
876 			goto unknown;
877 		}
878 		/* unblock posted writes */
879 		(void) ehci_readl(&ctrl->hcor->or_usbcmd);
880 		break;
881 	case USB_REQ_CLEAR_FEATURE | ((USB_DIR_OUT | USB_RT_PORT) << 8):
882 		reg = ehci_readl(status_reg);
883 		reg &= ~EHCI_PS_CLEAR;
884 		switch (le16_to_cpu(req->value)) {
885 		case USB_PORT_FEAT_ENABLE:
886 			reg &= ~EHCI_PS_PE;
887 			break;
888 		case USB_PORT_FEAT_C_ENABLE:
889 			reg |= EHCI_PS_PE;
890 			break;
891 		case USB_PORT_FEAT_POWER:
892 			if (HCS_PPC(ehci_readl(&ctrl->hccr->cr_hcsparams)))
893 				reg &= ~EHCI_PS_PP;
894 			break;
895 		case USB_PORT_FEAT_C_CONNECTION:
896 			reg |= EHCI_PS_CSC;
897 			break;
898 		case USB_PORT_FEAT_OVER_CURRENT:
899 			reg |= EHCI_PS_OCC;
900 			break;
901 		case USB_PORT_FEAT_C_RESET:
902 			ctrl->portreset &= ~(1 << port);
903 			break;
904 		default:
905 			debug("unknown feature %x\n", le16_to_cpu(req->value));
906 			goto unknown;
907 		}
908 		ehci_writel(status_reg, reg);
909 		/* unblock posted write */
910 		(void) ehci_readl(&ctrl->hcor->or_usbcmd);
911 		break;
912 	default:
913 		debug("Unknown request\n");
914 		goto unknown;
915 	}
916 
917 	mdelay(1);
918 	len = min3(srclen, (int)le16_to_cpu(req->length), length);
919 	if (srcptr != NULL && len > 0)
920 		memcpy(buffer, srcptr, len);
921 	else
922 		debug("Len is 0\n");
923 
924 	dev->act_len = len;
925 	dev->status = 0;
926 	return 0;
927 
928 unknown:
929 	debug("requesttype=%x, request=%x, value=%x, index=%x, length=%x\n",
930 	      req->requesttype, req->request, le16_to_cpu(req->value),
931 	      le16_to_cpu(req->index), le16_to_cpu(req->length));
932 
933 	dev->act_len = 0;
934 	dev->status = USB_ST_STALLED;
935 	return -1;
936 }
937 
938 const struct ehci_ops default_ehci_ops = {
939 	.set_usb_mode		= ehci_set_usbmode,
940 	.get_port_speed		= ehci_get_port_speed,
941 	.powerup_fixup		= ehci_powerup_fixup,
942 	.get_portsc_register	= ehci_get_portsc_register,
943 };
944 
945 static void ehci_setup_ops(struct ehci_ctrl *ctrl, const struct ehci_ops *ops)
946 {
947 	if (!ops) {
948 		ctrl->ops = default_ehci_ops;
949 	} else {
950 		ctrl->ops = *ops;
951 		if (!ctrl->ops.set_usb_mode)
952 			ctrl->ops.set_usb_mode = ehci_set_usbmode;
953 		if (!ctrl->ops.get_port_speed)
954 			ctrl->ops.get_port_speed = ehci_get_port_speed;
955 		if (!ctrl->ops.powerup_fixup)
956 			ctrl->ops.powerup_fixup = ehci_powerup_fixup;
957 		if (!ctrl->ops.get_portsc_register)
958 			ctrl->ops.get_portsc_register =
959 					ehci_get_portsc_register;
960 	}
961 }
962 
963 void ehci_set_controller_priv(int index, void *priv, const struct ehci_ops *ops)
964 {
965 	struct ehci_ctrl *ctrl = &ehcic[index];
966 
967 	ctrl->priv = priv;
968 	ehci_setup_ops(ctrl, ops);
969 }
970 
971 void *ehci_get_controller_priv(int index)
972 {
973 	return ehcic[index].priv;
974 }
975 
976 static int ehci_common_init(struct ehci_ctrl *ctrl, uint tweaks)
977 {
978 	struct QH *qh_list;
979 	struct QH *periodic;
980 	uint32_t reg;
981 	uint32_t cmd;
982 	int i;
983 
984 	/* Set the high address word (aka segment) for 64-bit controller */
985 	if (ehci_readl(&ctrl->hccr->cr_hccparams) & 1)
986 		ehci_writel(&ctrl->hcor->or_ctrldssegment, 0);
987 
988 	qh_list = &ctrl->qh_list;
989 
990 	/* Set head of reclaim list */
991 	memset(qh_list, 0, sizeof(*qh_list));
992 	qh_list->qh_link = cpu_to_hc32((unsigned long)qh_list | QH_LINK_TYPE_QH);
993 	qh_list->qh_endpt1 = cpu_to_hc32(QH_ENDPT1_H(1) |
994 						QH_ENDPT1_EPS(USB_SPEED_HIGH));
995 	qh_list->qh_overlay.qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
996 	qh_list->qh_overlay.qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
997 	qh_list->qh_overlay.qt_token =
998 			cpu_to_hc32(QT_TOKEN_STATUS(QT_TOKEN_STATUS_HALTED));
999 
1000 	flush_dcache_range((unsigned long)qh_list,
1001 			   ALIGN_END_ADDR(struct QH, qh_list, 1));
1002 
1003 	/* Set async. queue head pointer. */
1004 	ehci_writel(&ctrl->hcor->or_asynclistaddr, (unsigned long)qh_list);
1005 
1006 	/*
1007 	 * Set up periodic list
1008 	 * Step 1: Parent QH for all periodic transfers.
1009 	 */
1010 	ctrl->periodic_schedules = 0;
1011 	periodic = &ctrl->periodic_queue;
1012 	memset(periodic, 0, sizeof(*periodic));
1013 	periodic->qh_link = cpu_to_hc32(QH_LINK_TERMINATE);
1014 	periodic->qh_overlay.qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
1015 	periodic->qh_overlay.qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
1016 
1017 	flush_dcache_range((unsigned long)periodic,
1018 			   ALIGN_END_ADDR(struct QH, periodic, 1));
1019 
1020 	/*
1021 	 * Step 2: Setup frame-list: Every microframe, USB tries the same list.
1022 	 *         In particular, device specifications on polling frequency
1023 	 *         are disregarded. Keyboards seem to send NAK/NYet reliably
1024 	 *         when polled with an empty buffer.
1025 	 *
1026 	 *         Split Transactions will be spread across microframes using
1027 	 *         S-mask and C-mask.
1028 	 */
1029 	if (ctrl->periodic_list == NULL)
1030 		ctrl->periodic_list = memalign(4096, 1024 * 4);
1031 
1032 	if (!ctrl->periodic_list)
1033 		return -ENOMEM;
1034 	for (i = 0; i < 1024; i++) {
1035 		ctrl->periodic_list[i] = cpu_to_hc32((unsigned long)periodic
1036 						| QH_LINK_TYPE_QH);
1037 	}
1038 
1039 	flush_dcache_range((unsigned long)ctrl->periodic_list,
1040 			   ALIGN_END_ADDR(uint32_t, ctrl->periodic_list,
1041 					  1024));
1042 
1043 	/* Set periodic list base address */
1044 	ehci_writel(&ctrl->hcor->or_periodiclistbase,
1045 		(unsigned long)ctrl->periodic_list);
1046 
1047 	reg = ehci_readl(&ctrl->hccr->cr_hcsparams);
1048 	descriptor.hub.bNbrPorts = HCS_N_PORTS(reg);
1049 	debug("Register %x NbrPorts %d\n", reg, descriptor.hub.bNbrPorts);
1050 	/* Port Indicators */
1051 	if (HCS_INDICATOR(reg))
1052 		put_unaligned(get_unaligned(&descriptor.hub.wHubCharacteristics)
1053 				| 0x80, &descriptor.hub.wHubCharacteristics);
1054 	/* Port Power Control */
1055 	if (HCS_PPC(reg))
1056 		put_unaligned(get_unaligned(&descriptor.hub.wHubCharacteristics)
1057 				| 0x01, &descriptor.hub.wHubCharacteristics);
1058 
1059 	/* Start the host controller. */
1060 	cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
1061 	/*
1062 	 * Philips, Intel, and maybe others need CMD_RUN before the
1063 	 * root hub will detect new devices (why?); NEC doesn't
1064 	 */
1065 	cmd &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
1066 	cmd |= CMD_RUN;
1067 	ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
1068 
1069 	if (!(tweaks & EHCI_TWEAK_NO_INIT_CF)) {
1070 		/* take control over the ports */
1071 		cmd = ehci_readl(&ctrl->hcor->or_configflag);
1072 		cmd |= FLAG_CF;
1073 		ehci_writel(&ctrl->hcor->or_configflag, cmd);
1074 	}
1075 
1076 	/* unblock posted write */
1077 	cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
1078 	mdelay(5);
1079 	reg = HC_VERSION(ehci_readl(&ctrl->hccr->cr_capbase));
1080 	printf("USB EHCI %x.%02x\n", reg >> 8, reg & 0xff);
1081 
1082 	return 0;
1083 }
1084 
1085 int usb_lowlevel_stop(int index)
1086 {
1087 	ehci_shutdown(&ehcic[index]);
1088 	return ehci_hcd_stop(index);
1089 }
1090 
1091 int usb_lowlevel_init(int index, enum usb_init_type init, void **controller)
1092 {
1093 	struct ehci_ctrl *ctrl = &ehcic[index];
1094 	uint tweaks = 0;
1095 	int rc;
1096 
1097 	/**
1098 	 * Set ops to default_ehci_ops, ehci_hcd_init should call
1099 	 * ehci_set_controller_priv to change any of these function pointers.
1100 	 */
1101 	ctrl->ops = default_ehci_ops;
1102 
1103 	rc = ehci_hcd_init(index, init, &ctrl->hccr, &ctrl->hcor);
1104 	if (rc)
1105 		return rc;
1106 	if (init == USB_INIT_DEVICE)
1107 		goto done;
1108 
1109 	/* EHCI spec section 4.1 */
1110 	if (ehci_reset(ctrl))
1111 		return -1;
1112 
1113 #if defined(CONFIG_EHCI_HCD_INIT_AFTER_RESET)
1114 	rc = ehci_hcd_init(index, init, &ctrl->hccr, &ctrl->hcor);
1115 	if (rc)
1116 		return rc;
1117 #endif
1118 #ifdef CONFIG_USB_EHCI_FARADAY
1119 	tweaks |= EHCI_TWEAK_NO_INIT_CF;
1120 #endif
1121 	rc = ehci_common_init(ctrl, tweaks);
1122 	if (rc)
1123 		return rc;
1124 
1125 	ctrl->rootdev = 0;
1126 done:
1127 	*controller = &ehcic[index];
1128 	return 0;
1129 }
1130 
1131 static int _ehci_submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
1132 				 void *buffer, int length)
1133 {
1134 
1135 	if (usb_pipetype(pipe) != PIPE_BULK) {
1136 		debug("non-bulk pipe (type=%lu)", usb_pipetype(pipe));
1137 		return -1;
1138 	}
1139 	return ehci_submit_async(dev, pipe, buffer, length, NULL);
1140 }
1141 
1142 static int _ehci_submit_control_msg(struct usb_device *dev, unsigned long pipe,
1143 				    void *buffer, int length,
1144 				    struct devrequest *setup)
1145 {
1146 	struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
1147 
1148 	if (usb_pipetype(pipe) != PIPE_CONTROL) {
1149 		debug("non-control pipe (type=%lu)", usb_pipetype(pipe));
1150 		return -1;
1151 	}
1152 
1153 	if (usb_pipedevice(pipe) == ctrl->rootdev) {
1154 		if (!ctrl->rootdev)
1155 			dev->speed = USB_SPEED_HIGH;
1156 		return ehci_submit_root(dev, pipe, buffer, length, setup);
1157 	}
1158 	return ehci_submit_async(dev, pipe, buffer, length, setup);
1159 }
1160 
1161 struct int_queue {
1162 	int elementsize;
1163 	struct QH *first;
1164 	struct QH *current;
1165 	struct QH *last;
1166 	struct qTD *tds;
1167 };
1168 
1169 #define NEXT_QH(qh) (struct QH *)((unsigned long)hc32_to_cpu((qh)->qh_link) & ~0x1f)
1170 
1171 static int
1172 enable_periodic(struct ehci_ctrl *ctrl)
1173 {
1174 	uint32_t cmd;
1175 	struct ehci_hcor *hcor = ctrl->hcor;
1176 	int ret;
1177 
1178 	cmd = ehci_readl(&hcor->or_usbcmd);
1179 	cmd |= CMD_PSE;
1180 	ehci_writel(&hcor->or_usbcmd, cmd);
1181 
1182 	ret = handshake((uint32_t *)&hcor->or_usbsts,
1183 			STS_PSS, STS_PSS, 100 * 1000);
1184 	if (ret < 0) {
1185 		printf("EHCI failed: timeout when enabling periodic list\n");
1186 		return -ETIMEDOUT;
1187 	}
1188 	udelay(1000);
1189 	return 0;
1190 }
1191 
1192 static int
1193 disable_periodic(struct ehci_ctrl *ctrl)
1194 {
1195 	uint32_t cmd;
1196 	struct ehci_hcor *hcor = ctrl->hcor;
1197 	int ret;
1198 
1199 	cmd = ehci_readl(&hcor->or_usbcmd);
1200 	cmd &= ~CMD_PSE;
1201 	ehci_writel(&hcor->or_usbcmd, cmd);
1202 
1203 	ret = handshake((uint32_t *)&hcor->or_usbsts,
1204 			STS_PSS, 0, 100 * 1000);
1205 	if (ret < 0) {
1206 		printf("EHCI failed: timeout when disabling periodic list\n");
1207 		return -ETIMEDOUT;
1208 	}
1209 	return 0;
1210 }
1211 
1212 struct int_queue *
1213 create_int_queue(struct usb_device *dev, unsigned long pipe, int queuesize,
1214 		 int elementsize, void *buffer, int interval)
1215 {
1216 	struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
1217 	struct int_queue *result = NULL;
1218 	int i;
1219 
1220 	/*
1221 	 * Interrupt transfers requiring several transactions are not supported
1222 	 * because bInterval is ignored.
1223 	 *
1224 	 * Also, ehci_submit_async() relies on wMaxPacketSize being a power of 2
1225 	 * <= PKT_ALIGN if several qTDs are required, while the USB
1226 	 * specification does not constrain this for interrupt transfers. That
1227 	 * means that ehci_submit_async() would support interrupt transfers
1228 	 * requiring several transactions only as long as the transfer size does
1229 	 * not require more than a single qTD.
1230 	 */
1231 	if (elementsize > usb_maxpacket(dev, pipe)) {
1232 		printf("%s: xfers requiring several transactions are not supported.\n",
1233 		       __func__);
1234 		return NULL;
1235 	}
1236 
1237 	debug("Enter create_int_queue\n");
1238 	if (usb_pipetype(pipe) != PIPE_INTERRUPT) {
1239 		debug("non-interrupt pipe (type=%lu)", usb_pipetype(pipe));
1240 		return NULL;
1241 	}
1242 
1243 	/* limit to 4 full pages worth of data -
1244 	 * we can safely fit them in a single TD,
1245 	 * no matter the alignment
1246 	 */
1247 	if (elementsize >= 16384) {
1248 		debug("too large elements for interrupt transfers\n");
1249 		return NULL;
1250 	}
1251 
1252 	result = malloc(sizeof(*result));
1253 	if (!result) {
1254 		debug("ehci intr queue: out of memory\n");
1255 		goto fail1;
1256 	}
1257 	result->elementsize = elementsize;
1258 	result->first = memalign(USB_DMA_MINALIGN,
1259 				 sizeof(struct QH) * queuesize);
1260 	if (!result->first) {
1261 		debug("ehci intr queue: out of memory\n");
1262 		goto fail2;
1263 	}
1264 	result->current = result->first;
1265 	result->last = result->first + queuesize - 1;
1266 	result->tds = memalign(USB_DMA_MINALIGN,
1267 			       sizeof(struct qTD) * queuesize);
1268 	if (!result->tds) {
1269 		debug("ehci intr queue: out of memory\n");
1270 		goto fail3;
1271 	}
1272 	memset(result->first, 0, sizeof(struct QH) * queuesize);
1273 	memset(result->tds, 0, sizeof(struct qTD) * queuesize);
1274 
1275 	for (i = 0; i < queuesize; i++) {
1276 		struct QH *qh = result->first + i;
1277 		struct qTD *td = result->tds + i;
1278 		void **buf = &qh->buffer;
1279 
1280 		qh->qh_link = cpu_to_hc32((unsigned long)(qh+1) | QH_LINK_TYPE_QH);
1281 		if (i == queuesize - 1)
1282 			qh->qh_link = cpu_to_hc32(QH_LINK_TERMINATE);
1283 
1284 		qh->qh_overlay.qt_next = cpu_to_hc32((unsigned long)td);
1285 		qh->qh_overlay.qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
1286 		qh->qh_endpt1 =
1287 			cpu_to_hc32((0 << 28) | /* No NAK reload (ehci 4.9) */
1288 			(usb_maxpacket(dev, pipe) << 16) | /* MPS */
1289 			(1 << 14) |
1290 			QH_ENDPT1_EPS(ehci_encode_speed(dev->speed)) |
1291 			(usb_pipeendpoint(pipe) << 8) | /* Endpoint Number */
1292 			(usb_pipedevice(pipe) << 0));
1293 		qh->qh_endpt2 = cpu_to_hc32((1 << 30) | /* 1 Tx per mframe */
1294 			(1 << 0)); /* S-mask: microframe 0 */
1295 		if (dev->speed == USB_SPEED_LOW ||
1296 				dev->speed == USB_SPEED_FULL) {
1297 			/* C-mask: microframes 2-4 */
1298 			qh->qh_endpt2 |= cpu_to_hc32((0x1c << 8));
1299 		}
1300 		ehci_update_endpt2_dev_n_port(dev, qh);
1301 
1302 		td->qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
1303 		td->qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
1304 		debug("communication direction is '%s'\n",
1305 		      usb_pipein(pipe) ? "in" : "out");
1306 		td->qt_token = cpu_to_hc32((elementsize << 16) |
1307 			((usb_pipein(pipe) ? 1 : 0) << 8) | /* IN/OUT token */
1308 			0x80); /* active */
1309 		td->qt_buffer[0] =
1310 		    cpu_to_hc32((unsigned long)buffer + i * elementsize);
1311 		td->qt_buffer[1] =
1312 		    cpu_to_hc32((td->qt_buffer[0] + 0x1000) & ~0xfff);
1313 		td->qt_buffer[2] =
1314 		    cpu_to_hc32((td->qt_buffer[0] + 0x2000) & ~0xfff);
1315 		td->qt_buffer[3] =
1316 		    cpu_to_hc32((td->qt_buffer[0] + 0x3000) & ~0xfff);
1317 		td->qt_buffer[4] =
1318 		    cpu_to_hc32((td->qt_buffer[0] + 0x4000) & ~0xfff);
1319 
1320 		*buf = buffer + i * elementsize;
1321 	}
1322 
1323 	flush_dcache_range((unsigned long)buffer,
1324 			   ALIGN_END_ADDR(char, buffer,
1325 					  queuesize * elementsize));
1326 	flush_dcache_range((unsigned long)result->first,
1327 			   ALIGN_END_ADDR(struct QH, result->first,
1328 					  queuesize));
1329 	flush_dcache_range((unsigned long)result->tds,
1330 			   ALIGN_END_ADDR(struct qTD, result->tds,
1331 					  queuesize));
1332 
1333 	if (ctrl->periodic_schedules > 0) {
1334 		if (disable_periodic(ctrl) < 0) {
1335 			debug("FATAL: periodic should never fail, but did");
1336 			goto fail3;
1337 		}
1338 	}
1339 
1340 	/* hook up to periodic list */
1341 	struct QH *list = &ctrl->periodic_queue;
1342 	result->last->qh_link = list->qh_link;
1343 	list->qh_link = cpu_to_hc32((unsigned long)result->first | QH_LINK_TYPE_QH);
1344 
1345 	flush_dcache_range((unsigned long)result->last,
1346 			   ALIGN_END_ADDR(struct QH, result->last, 1));
1347 	flush_dcache_range((unsigned long)list,
1348 			   ALIGN_END_ADDR(struct QH, list, 1));
1349 
1350 	if (enable_periodic(ctrl) < 0) {
1351 		debug("FATAL: periodic should never fail, but did");
1352 		goto fail3;
1353 	}
1354 	ctrl->periodic_schedules++;
1355 
1356 	debug("Exit create_int_queue\n");
1357 	return result;
1358 fail3:
1359 	if (result->tds)
1360 		free(result->tds);
1361 fail2:
1362 	if (result->first)
1363 		free(result->first);
1364 	if (result)
1365 		free(result);
1366 fail1:
1367 	return NULL;
1368 }
1369 
1370 void *poll_int_queue(struct usb_device *dev, struct int_queue *queue)
1371 {
1372 	struct QH *cur = queue->current;
1373 	struct qTD *cur_td;
1374 
1375 	/* depleted queue */
1376 	if (cur == NULL) {
1377 		debug("Exit poll_int_queue with completed queue\n");
1378 		return NULL;
1379 	}
1380 	/* still active */
1381 	cur_td = &queue->tds[queue->current - queue->first];
1382 	invalidate_dcache_range((unsigned long)cur_td,
1383 				ALIGN_END_ADDR(struct qTD, cur_td, 1));
1384 	if (QT_TOKEN_GET_STATUS(hc32_to_cpu(cur_td->qt_token)) &
1385 			QT_TOKEN_STATUS_ACTIVE) {
1386 		debug("Exit poll_int_queue with no completed intr transfer. token is %x\n",
1387 		      hc32_to_cpu(cur_td->qt_token));
1388 		return NULL;
1389 	}
1390 	if (!(cur->qh_link & QH_LINK_TERMINATE))
1391 		queue->current++;
1392 	else
1393 		queue->current = NULL;
1394 
1395 	invalidate_dcache_range((unsigned long)cur->buffer,
1396 				ALIGN_END_ADDR(char, cur->buffer,
1397 					       queue->elementsize));
1398 
1399 	debug("Exit poll_int_queue with completed intr transfer. token is %x at %p (first at %p)\n",
1400 	      hc32_to_cpu(cur_td->qt_token), cur, queue->first);
1401 	return cur->buffer;
1402 }
1403 
1404 /* Do not free buffers associated with QHs, they're owned by someone else */
1405 int
1406 destroy_int_queue(struct usb_device *dev, struct int_queue *queue)
1407 {
1408 	struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
1409 	int result = -1;
1410 	unsigned long timeout;
1411 
1412 	if (disable_periodic(ctrl) < 0) {
1413 		debug("FATAL: periodic should never fail, but did");
1414 		goto out;
1415 	}
1416 	ctrl->periodic_schedules--;
1417 
1418 	struct QH *cur = &ctrl->periodic_queue;
1419 	timeout = get_timer(0) + 500; /* abort after 500ms */
1420 	while (!(cur->qh_link & cpu_to_hc32(QH_LINK_TERMINATE))) {
1421 		debug("considering %p, with qh_link %x\n", cur, cur->qh_link);
1422 		if (NEXT_QH(cur) == queue->first) {
1423 			debug("found candidate. removing from chain\n");
1424 			cur->qh_link = queue->last->qh_link;
1425 			flush_dcache_range((unsigned long)cur,
1426 					   ALIGN_END_ADDR(struct QH, cur, 1));
1427 			result = 0;
1428 			break;
1429 		}
1430 		cur = NEXT_QH(cur);
1431 		if (get_timer(0) > timeout) {
1432 			printf("Timeout destroying interrupt endpoint queue\n");
1433 			result = -1;
1434 			goto out;
1435 		}
1436 	}
1437 
1438 	if (ctrl->periodic_schedules > 0) {
1439 		result = enable_periodic(ctrl);
1440 		if (result < 0)
1441 			debug("FATAL: periodic should never fail, but did");
1442 	}
1443 
1444 out:
1445 	free(queue->tds);
1446 	free(queue->first);
1447 	free(queue);
1448 
1449 	return result;
1450 }
1451 
1452 static int _ehci_submit_int_msg(struct usb_device *dev, unsigned long pipe,
1453 				void *buffer, int length, int interval)
1454 {
1455 	void *backbuffer;
1456 	struct int_queue *queue;
1457 	unsigned long timeout;
1458 	int result = 0, ret;
1459 
1460 	debug("dev=%p, pipe=%lu, buffer=%p, length=%d, interval=%d",
1461 	      dev, pipe, buffer, length, interval);
1462 
1463 	queue = create_int_queue(dev, pipe, 1, length, buffer, interval);
1464 	if (!queue)
1465 		return -1;
1466 
1467 	timeout = get_timer(0) + USB_TIMEOUT_MS(pipe);
1468 	while ((backbuffer = poll_int_queue(dev, queue)) == NULL)
1469 		if (get_timer(0) > timeout) {
1470 			printf("Timeout poll on interrupt endpoint\n");
1471 			result = -ETIMEDOUT;
1472 			break;
1473 		}
1474 
1475 	if (backbuffer != buffer) {
1476 		debug("got wrong buffer back (%p instead of %p)\n",
1477 		      backbuffer, buffer);
1478 		return -EINVAL;
1479 	}
1480 
1481 	ret = destroy_int_queue(dev, queue);
1482 	if (ret < 0)
1483 		return ret;
1484 
1485 	/* everything worked out fine */
1486 	return result;
1487 }
1488 
1489 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
1490 			    void *buffer, int length)
1491 {
1492 	return _ehci_submit_bulk_msg(dev, pipe, buffer, length);
1493 }
1494 
1495 int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
1496 		   int length, struct devrequest *setup)
1497 {
1498 	return _ehci_submit_control_msg(dev, pipe, buffer, length, setup);
1499 }
1500 
1501 int submit_int_msg(struct usb_device *dev, unsigned long pipe,
1502 		   void *buffer, int length, int interval)
1503 {
1504 	return _ehci_submit_int_msg(dev, pipe, buffer, length, interval);
1505 }
1506