1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2007-2008, Juniper Networks, Inc.
4 * Copyright (c) 2008, Excito Elektronik i Skåne AB
5 * Copyright (c) 2008, Michael Trimarchi <trimarchimichael@yahoo.it>
13 #include <asm/byteorder.h>
14 #include <asm/cache.h>
15 #include <asm/unaligned.h>
21 #include <dm/device_compat.h>
22 #include <linux/compiler.h>
23 #include <linux/delay.h>
28 * EHCI spec page 20 says that the HC may take up to 16 uFrames (= 4ms) to halt.
29 * Let's time out after 8 to have a little safety margin on top of that.
31 #define HCHALT_TIMEOUT (8 * 1000)
33 #if !CONFIG_IS_ENABLED(DM_USB)
34 static struct ehci_ctrl ehcic[CONFIG_USB_MAX_CONTROLLER_COUNT];
37 #define ALIGN_END_ADDR(type, ptr, size) \
38 ((unsigned long)(ptr) + roundup((size) * sizeof(type), USB_DMA_MINALIGN))
40 static struct descriptor {
41 struct usb_hub_descriptor hub;
42 struct usb_device_descriptor device;
43 struct usb_linux_config_descriptor config;
44 struct usb_linux_interface_descriptor interface;
45 struct usb_endpoint_descriptor endpoint;
46 } __attribute__ ((packed)) descriptor = {
48 0x8, /* bDescLength */
49 0x29, /* bDescriptorType: hub descriptor */
50 2, /* bNrPorts -- runtime modified */
51 0, /* wHubCharacteristics */
52 10, /* bPwrOn2PwrGood */
53 0, /* bHubCntrCurrent */
54 { /* Device removable */
55 } /* at most 7 ports! XXX */
59 1, /* bDescriptorType: UDESC_DEVICE */
60 cpu_to_le16(0x0200), /* bcdUSB: v2.0 */
61 9, /* bDeviceClass: UDCLASS_HUB */
62 0, /* bDeviceSubClass: UDSUBCLASS_HUB */
63 1, /* bDeviceProtocol: UDPROTO_HSHUBSTT */
64 64, /* bMaxPacketSize: 64 bytes */
65 0x0000, /* idVendor */
66 0x0000, /* idProduct */
67 cpu_to_le16(0x0100), /* bcdDevice */
68 1, /* iManufacturer */
70 0, /* iSerialNumber */
71 1 /* bNumConfigurations: 1 */
75 2, /* bDescriptorType: UDESC_CONFIG */
77 1, /* bNumInterface */
78 1, /* bConfigurationValue */
79 0, /* iConfiguration */
80 0x40, /* bmAttributes: UC_SELF_POWER */
85 4, /* bDescriptorType: UDESC_INTERFACE */
86 0, /* bInterfaceNumber */
87 0, /* bAlternateSetting */
88 1, /* bNumEndpoints */
89 9, /* bInterfaceClass: UICLASS_HUB */
90 0, /* bInterfaceSubClass: UISUBCLASS_HUB */
91 0, /* bInterfaceProtocol: UIPROTO_HSHUBSTT */
96 5, /* bDescriptorType: UDESC_ENDPOINT */
97 0x81, /* bEndpointAddress:
98 * UE_DIR_IN | EHCI_INTR_ENDPT
100 3, /* bmAttributes: UE_INTERRUPT */
101 8, /* wMaxPacketSize */
106 #if defined(CONFIG_USB_EHCI_IS_TDI)
107 #define ehci_is_TDI() (1)
109 #define ehci_is_TDI() (0)
112 static struct ehci_ctrl *ehci_get_ctrl(struct usb_device *udev)
114 #if CONFIG_IS_ENABLED(DM_USB)
115 return dev_get_priv(usb_get_bus(udev->dev));
117 return udev->controller;
121 static int ehci_get_port_speed(struct ehci_ctrl *ctrl, uint32_t reg)
123 return PORTSC_PSPD(reg);
126 static void ehci_set_usbmode(struct ehci_ctrl *ctrl)
131 reg_ptr = (uint32_t *)((u8 *)&ctrl->hcor->or_usbcmd + USBMODE);
132 tmp = ehci_readl(reg_ptr);
133 tmp |= USBMODE_CM_HC;
134 #if defined(CONFIG_EHCI_MMIO_BIG_ENDIAN)
139 ehci_writel(reg_ptr, tmp);
142 static void ehci_powerup_fixup(struct ehci_ctrl *ctrl, uint32_t *status_reg,
148 static uint32_t *ehci_get_portsc_register(struct ehci_ctrl *ctrl, int port)
150 int max_ports = HCS_N_PORTS(ehci_readl(&ctrl->hccr->cr_hcsparams));
152 if (port < 0 || port >= max_ports) {
153 /* Printing the message would cause a scan failure! */
154 debug("The request port(%u) exceeds maximum port number\n",
159 return (uint32_t *)&ctrl->hcor->or_portsc[port];
162 static int handshake(uint32_t *ptr, uint32_t mask, uint32_t done, int usec)
166 result = ehci_readl(ptr);
168 if (result == ~(uint32_t)0)
178 static int ehci_reset(struct ehci_ctrl *ctrl)
183 cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
184 cmd = (cmd & ~CMD_RUN) | CMD_RESET;
185 ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
186 ret = handshake((uint32_t *)&ctrl->hcor->or_usbcmd,
187 CMD_RESET, 0, 250 * 1000);
189 printf("EHCI fail to reset\n");
194 ctrl->ops.set_usb_mode(ctrl);
196 #ifdef CONFIG_USB_EHCI_TXFIFO_THRESH
197 cmd = ehci_readl(&ctrl->hcor->or_txfilltuning);
198 cmd &= ~TXFIFO_THRESH_MASK;
199 cmd |= TXFIFO_THRESH(CONFIG_USB_EHCI_TXFIFO_THRESH);
200 ehci_writel(&ctrl->hcor->or_txfilltuning, cmd);
206 static int ehci_shutdown(struct ehci_ctrl *ctrl)
210 int max_ports = HCS_N_PORTS(ehci_readl(&ctrl->hccr->cr_hcsparams));
212 cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
213 /* If not run, directly return */
214 if (!(cmd & CMD_RUN))
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,
222 for (i = 0; i < max_ports; i++) {
223 reg = ehci_readl(&ctrl->hcor->or_portsc[i]);
225 ehci_writel(&ctrl->hcor->or_portsc[i], reg);
229 ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
230 ret = handshake(&ctrl->hcor->or_usbsts, STS_HALT, STS_HALT,
235 puts("EHCI failed to shut down host controller.\n");
240 static int ehci_td_buffer(struct qTD *td, void *buf, size_t sz)
242 uint32_t delta, next;
243 unsigned long addr = (unsigned long)buf;
246 if (addr != ALIGN(addr, ARCH_DMA_MINALIGN))
247 debug("EHCI-HCD: Misaligned buffer address (%p)\n", buf);
249 flush_dcache_range(addr, ALIGN(addr + sz, ARCH_DMA_MINALIGN));
252 while (idx < QT_BUFFER_CNT) {
253 td->qt_buffer[idx] = cpu_to_hc32(virt_to_phys((void *)addr));
254 td->qt_buffer_hi[idx] = 0;
255 next = (addr + EHCI_PAGE_SIZE) & ~(EHCI_PAGE_SIZE - 1);
264 if (idx == QT_BUFFER_CNT) {
265 printf("out of buffer pointers (%zu bytes left)\n", sz);
272 static inline u8 ehci_encode_speed(enum usb_device_speed speed)
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)
281 return QH_FULL_SPEED;
284 static void ehci_update_endpt2_dev_n_port(struct usb_device *udev,
290 if (udev->speed != USB_SPEED_LOW && udev->speed != USB_SPEED_FULL)
293 usb_find_usb2_hub_address_port(udev, &hubaddr, &portnr);
295 qh->qh_endpt2 |= cpu_to_hc32(QH_ENDPT2_PORTNUM(portnr) |
296 QH_ENDPT2_HUBADDR(hubaddr));
299 static int ehci_enable_async(struct ehci_ctrl *ctrl)
304 /* Enable async. schedule. */
305 cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
310 ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
312 ret = handshake((uint32_t *)&ctrl->hcor->or_usbsts, STS_ASS, STS_ASS,
315 printf("EHCI fail timeout STS_ASS set\n");
320 static int ehci_disable_async(struct ehci_ctrl *ctrl)
325 if (ctrl->async_locked)
328 /* Disable async schedule. */
329 cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
330 if (!(cmd & CMD_ASE))
334 ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
336 ret = handshake((uint32_t *)&ctrl->hcor->or_usbsts, STS_ASS, 0,
339 printf("EHCI fail timeout STS_ASS reset\n");
344 static int ehci_iaa_cycle(struct ehci_ctrl *ctrl)
349 /* Enable Interrupt on Async Advance Doorbell. */
350 cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
352 ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
354 ret = handshake(&ctrl->hcor->or_usbsts, STS_IAA, STS_IAA,
355 10 * 1000); /* 10ms timeout */
357 printf("EHCI fail timeout STS_IAA set\n");
359 status = ehci_readl(&ctrl->hcor->or_usbsts);
360 if (status & STS_IAA)
361 ehci_writel(&ctrl->hcor->or_usbsts, STS_IAA);
367 ehci_submit_async(struct usb_device *dev, unsigned long pipe, void *buffer,
368 int length, struct devrequest *req)
370 ALLOC_ALIGN_BUFFER(struct QH, qh, 1, USB_DMA_MINALIGN);
374 volatile struct qTD *vtd;
377 uint32_t endpt, maxpacket, token, usbsts, qhtoken;
381 struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
383 debug("dev=%p, pipe=%lx, buffer=%p, length=%d, req=%p\n", dev, pipe,
384 buffer, length, req);
386 debug("req=%u (%#x), type=%u (%#x), value=%u (%#x), index=%u\n",
387 req->request, req->request,
388 req->requesttype, req->requesttype,
389 le16_to_cpu(req->value), le16_to_cpu(req->value),
390 le16_to_cpu(req->index));
392 #define PKT_ALIGN 512
394 * The USB transfer is split into qTD transfers. Eeach qTD transfer is
395 * described by a transfer descriptor (the qTD). The qTDs form a linked
396 * list with a queue head (QH).
398 * Each qTD transfer starts with a new USB packet, i.e. a packet cannot
399 * have its beginning in a qTD transfer and its end in the following
400 * one, so the qTD transfer lengths have to be chosen accordingly.
402 * Each qTD transfer uses up to QT_BUFFER_CNT data buffers, mapped to
403 * single pages. The first data buffer can start at any offset within a
404 * page (not considering the cache-line alignment issues), while the
405 * following buffers must be page-aligned. There is no alignment
406 * constraint on the size of a qTD transfer.
409 /* 1 qTD will be needed for SETUP, and 1 for ACK. */
411 if (length > 0 || req == NULL) {
413 * Determine the qTD transfer size that will be used for the
414 * data payload (not considering the first qTD transfer, which
415 * may be longer or shorter, and the final one, which may be
418 * In order to keep each packet within a qTD transfer, the qTD
419 * transfer size is aligned to PKT_ALIGN, which is a multiple of
420 * wMaxPacketSize (except in some cases for interrupt transfers,
421 * see comment in submit_int_msg()).
423 * By default, i.e. if the input buffer is aligned to PKT_ALIGN,
424 * QT_BUFFER_CNT full pages will be used.
426 int xfr_sz = QT_BUFFER_CNT;
428 * However, if the input buffer is not aligned to PKT_ALIGN, the
429 * qTD transfer size will be one page shorter, and the first qTD
430 * data buffer of each transfer will be page-unaligned.
432 if ((unsigned long)buffer & (PKT_ALIGN - 1))
434 /* Convert the qTD transfer size to bytes. */
435 xfr_sz *= EHCI_PAGE_SIZE;
437 * Approximate by excess the number of qTDs that will be
438 * required for the data payload. The exact formula is way more
439 * complicated and saves at most 2 qTDs, i.e. a total of 128
442 qtd_count += 2 + length / xfr_sz;
445 * Threshold value based on the worst-case total size of the allocated qTDs for
446 * a mass-storage transfer of 65535 blocks of 512 bytes.
448 #if CONFIG_SYS_MALLOC_LEN <= 64 + 128 * 1024
449 #warning CONFIG_SYS_MALLOC_LEN may be too small for EHCI
451 qtd = memalign(USB_DMA_MINALIGN, qtd_count * sizeof(struct qTD));
453 printf("unable to allocate TDs\n");
457 memset(qh, 0, sizeof(struct QH));
458 memset(qtd, 0, qtd_count * sizeof(*qtd));
460 toggle = usb_gettoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
463 * Setup QH (3.6 in ehci-r10.pdf)
465 * qh_link ................. 03-00 H
466 * qh_endpt1 ............... 07-04 H
467 * qh_endpt2 ............... 0B-08 H
469 * qh_overlay.qt_next ...... 13-10 H
470 * - qh_overlay.qt_altnext
472 qh->qh_link = cpu_to_hc32(virt_to_phys(&ctrl->qh_list) | QH_LINK_TYPE_QH);
473 c = (dev->speed != USB_SPEED_HIGH) && !usb_pipeendpoint(pipe);
474 maxpacket = usb_maxpacket(dev, pipe);
475 endpt = QH_ENDPT1_RL(8) | QH_ENDPT1_C(c) |
476 QH_ENDPT1_MAXPKTLEN(maxpacket) | QH_ENDPT1_H(0) |
477 QH_ENDPT1_DTC(QH_ENDPT1_DTC_DT_FROM_QTD) |
478 QH_ENDPT1_ENDPT(usb_pipeendpoint(pipe)) | QH_ENDPT1_I(0) |
479 QH_ENDPT1_DEVADDR(usb_pipedevice(pipe));
481 /* Force FS for fsl HS quirk */
482 if (!ctrl->has_fsl_erratum_a005275)
483 endpt |= QH_ENDPT1_EPS(ehci_encode_speed(dev->speed));
485 endpt |= QH_ENDPT1_EPS(ehci_encode_speed(QH_FULL_SPEED));
487 qh->qh_endpt1 = cpu_to_hc32(endpt);
488 endpt = QH_ENDPT2_MULT(1) | QH_ENDPT2_UFCMASK(0) | QH_ENDPT2_UFSMASK(0);
489 qh->qh_endpt2 = cpu_to_hc32(endpt);
490 ehci_update_endpt2_dev_n_port(dev, qh);
491 qh->qh_overlay.qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
492 qh->qh_overlay.qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
494 tdp = &qh->qh_overlay.qt_next;
497 * Setup request qTD (3.5 in ehci-r10.pdf)
499 * qt_next ................ 03-00 H
500 * qt_altnext ............. 07-04 H
501 * qt_token ............... 0B-08 H
503 * [ buffer, buffer_hi ] loaded with "req".
505 qtd[qtd_counter].qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
506 qtd[qtd_counter].qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
507 token = QT_TOKEN_DT(0) | QT_TOKEN_TOTALBYTES(sizeof(*req)) |
508 QT_TOKEN_IOC(0) | QT_TOKEN_CPAGE(0) | QT_TOKEN_CERR(3) |
509 QT_TOKEN_PID(QT_TOKEN_PID_SETUP) |
510 QT_TOKEN_STATUS(QT_TOKEN_STATUS_ACTIVE);
511 qtd[qtd_counter].qt_token = cpu_to_hc32(token);
512 if (ehci_td_buffer(&qtd[qtd_counter], req, sizeof(*req))) {
513 printf("unable to construct SETUP TD\n");
516 /* Update previous qTD! */
517 *tdp = cpu_to_hc32(virt_to_phys(&qtd[qtd_counter]));
518 tdp = &qtd[qtd_counter++].qt_next;
522 if (length > 0 || req == NULL) {
523 uint8_t *buf_ptr = buffer;
524 int left_length = length;
528 * Determine the size of this qTD transfer. By default,
529 * QT_BUFFER_CNT full pages can be used.
531 int xfr_bytes = QT_BUFFER_CNT * EHCI_PAGE_SIZE;
533 * However, if the input buffer is not page-aligned, the
534 * portion of the first page before the buffer start
535 * offset within that page is unusable.
537 xfr_bytes -= (unsigned long)buf_ptr & (EHCI_PAGE_SIZE - 1);
539 * In order to keep each packet within a qTD transfer,
540 * align the qTD transfer size to PKT_ALIGN.
542 xfr_bytes &= ~(PKT_ALIGN - 1);
544 * This transfer may be shorter than the available qTD
545 * transfer size that has just been computed.
547 xfr_bytes = min(xfr_bytes, left_length);
550 * Setup request qTD (3.5 in ehci-r10.pdf)
552 * qt_next ................ 03-00 H
553 * qt_altnext ............. 07-04 H
554 * qt_token ............... 0B-08 H
556 * [ buffer, buffer_hi ] loaded with "buffer".
558 qtd[qtd_counter].qt_next =
559 cpu_to_hc32(QT_NEXT_TERMINATE);
560 qtd[qtd_counter].qt_altnext =
561 cpu_to_hc32(QT_NEXT_TERMINATE);
562 token = QT_TOKEN_DT(toggle) |
563 QT_TOKEN_TOTALBYTES(xfr_bytes) |
564 QT_TOKEN_IOC(req == NULL) | QT_TOKEN_CPAGE(0) |
566 QT_TOKEN_PID(usb_pipein(pipe) ?
567 QT_TOKEN_PID_IN : QT_TOKEN_PID_OUT) |
568 QT_TOKEN_STATUS(QT_TOKEN_STATUS_ACTIVE);
569 qtd[qtd_counter].qt_token = cpu_to_hc32(token);
570 if (ehci_td_buffer(&qtd[qtd_counter], buf_ptr,
572 printf("unable to construct DATA TD\n");
575 /* Update previous qTD! */
576 *tdp = cpu_to_hc32(virt_to_phys(&qtd[qtd_counter]));
577 tdp = &qtd[qtd_counter++].qt_next;
579 * Data toggle has to be adjusted since the qTD transfer
580 * size is not always an even multiple of
583 if ((xfr_bytes / maxpacket) & 1)
585 buf_ptr += xfr_bytes;
586 left_length -= xfr_bytes;
587 } while (left_length > 0);
592 * Setup request qTD (3.5 in ehci-r10.pdf)
594 * qt_next ................ 03-00 H
595 * qt_altnext ............. 07-04 H
596 * qt_token ............... 0B-08 H
598 qtd[qtd_counter].qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
599 qtd[qtd_counter].qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
600 token = QT_TOKEN_DT(1) | QT_TOKEN_TOTALBYTES(0) |
601 QT_TOKEN_IOC(1) | QT_TOKEN_CPAGE(0) | QT_TOKEN_CERR(3) |
602 QT_TOKEN_PID(usb_pipein(pipe) ?
603 QT_TOKEN_PID_OUT : QT_TOKEN_PID_IN) |
604 QT_TOKEN_STATUS(QT_TOKEN_STATUS_ACTIVE);
605 qtd[qtd_counter].qt_token = cpu_to_hc32(token);
606 /* Update previous qTD! */
607 *tdp = cpu_to_hc32(virt_to_phys(&qtd[qtd_counter]));
608 tdp = &qtd[qtd_counter++].qt_next;
611 ctrl->qh_list.qh_link = cpu_to_hc32(virt_to_phys(qh) | QH_LINK_TYPE_QH);
614 flush_dcache_range((unsigned long)&ctrl->qh_list,
615 ALIGN_END_ADDR(struct QH, &ctrl->qh_list, 1));
616 flush_dcache_range((unsigned long)qh, ALIGN_END_ADDR(struct QH, qh, 1));
617 flush_dcache_range((unsigned long)qtd,
618 ALIGN_END_ADDR(struct qTD, qtd, qtd_count));
620 usbsts = ehci_readl(&ctrl->hcor->or_usbsts);
621 ehci_writel(&ctrl->hcor->or_usbsts, (usbsts & 0x3f));
623 ret = ehci_enable_async(ctrl);
627 /* Wait for TDs to be processed. */
629 vtd = &qtd[qtd_counter - 1];
630 timeout = USB_TIMEOUT_MS(pipe);
632 /* Invalidate dcache */
633 invalidate_dcache_range((unsigned long)&ctrl->qh_list,
634 ALIGN_END_ADDR(struct QH, &ctrl->qh_list, 1));
635 invalidate_dcache_range((unsigned long)qh,
636 ALIGN_END_ADDR(struct QH, qh, 1));
637 invalidate_dcache_range((unsigned long)qtd,
638 ALIGN_END_ADDR(struct qTD, qtd, qtd_count));
640 token = hc32_to_cpu(vtd->qt_token);
641 if (!(QT_TOKEN_GET_STATUS(token) & QT_TOKEN_STATUS_ACTIVE))
644 } while (get_timer(ts) < timeout);
645 qhtoken = hc32_to_cpu(qh->qh_overlay.qt_token);
647 ctrl->qh_list.qh_link = cpu_to_hc32(virt_to_phys(&ctrl->qh_list) | QH_LINK_TYPE_QH);
648 flush_dcache_range((unsigned long)&ctrl->qh_list,
649 ALIGN_END_ADDR(struct QH, &ctrl->qh_list, 1));
651 /* Set IAAD, poll IAA */
652 ret = ehci_iaa_cycle(ctrl);
657 * Invalidate the memory area occupied by buffer
658 * Don't try to fix the buffer alignment, if it isn't properly
659 * aligned it's upper layer's fault so let invalidate_dcache_range()
660 * vow about it. But we have to fix the length as it's actual
661 * transfer length and can be unaligned. This is potentially
662 * dangerous operation, it's responsibility of the calling
663 * code to make sure enough space is reserved.
665 if (buffer != NULL && length > 0)
666 invalidate_dcache_range((unsigned long)buffer,
667 ALIGN((unsigned long)buffer + length, ARCH_DMA_MINALIGN));
669 /* Check that the TD processing happened */
670 if (QT_TOKEN_GET_STATUS(token) & QT_TOKEN_STATUS_ACTIVE)
671 printf("EHCI timed out on TD - token=%#x\n", token);
673 ret = ehci_disable_async(ctrl);
677 if (!(QT_TOKEN_GET_STATUS(qhtoken) & QT_TOKEN_STATUS_ACTIVE)) {
678 debug("TOKEN=%#x\n", qhtoken);
679 switch (QT_TOKEN_GET_STATUS(qhtoken) &
680 ~(QT_TOKEN_STATUS_SPLITXSTATE | QT_TOKEN_STATUS_PERR)) {
682 toggle = QT_TOKEN_GET_DT(qhtoken);
683 usb_settoggle(dev, usb_pipeendpoint(pipe),
684 usb_pipeout(pipe), toggle);
687 case QT_TOKEN_STATUS_HALTED:
688 dev->status = USB_ST_STALLED;
690 case QT_TOKEN_STATUS_ACTIVE | QT_TOKEN_STATUS_DATBUFERR:
691 case QT_TOKEN_STATUS_DATBUFERR:
692 dev->status = USB_ST_BUF_ERR;
694 case QT_TOKEN_STATUS_HALTED | QT_TOKEN_STATUS_BABBLEDET:
695 case QT_TOKEN_STATUS_BABBLEDET:
696 dev->status = USB_ST_BABBLE_DET;
699 dev->status = USB_ST_CRC_ERR;
700 if (QT_TOKEN_GET_STATUS(qhtoken) & QT_TOKEN_STATUS_HALTED)
701 dev->status |= USB_ST_STALLED;
704 dev->act_len = length - QT_TOKEN_GET_TOTALBYTES(qhtoken);
707 debug("dev=%u, usbsts=%#x, p[1]=%#x, p[2]=%#x\n",
708 dev->devnum, ehci_readl(&ctrl->hcor->or_usbsts),
709 ehci_readl(&ctrl->hcor->or_portsc[0]),
710 ehci_readl(&ctrl->hcor->or_portsc[1]));
714 return (dev->status != USB_ST_NOT_PROC) ? 0 : -1;
721 static int ehci_submit_root(struct usb_device *dev, unsigned long pipe,
722 void *buffer, int length, struct devrequest *req)
729 uint32_t *status_reg;
730 int port = le16_to_cpu(req->index) & 0xff;
731 struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
735 debug("req=%u (%#x), type=%u (%#x), value=%u, index=%u\n",
736 req->request, req->request,
737 req->requesttype, req->requesttype,
738 le16_to_cpu(req->value), le16_to_cpu(req->index));
740 typeReq = req->request | req->requesttype << 8;
743 case USB_REQ_GET_STATUS | ((USB_RT_PORT | USB_DIR_IN) << 8):
744 case USB_REQ_SET_FEATURE | ((USB_DIR_OUT | USB_RT_PORT) << 8):
745 case USB_REQ_CLEAR_FEATURE | ((USB_DIR_OUT | USB_RT_PORT) << 8):
746 status_reg = ctrl->ops.get_portsc_register(ctrl, port - 1);
756 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
757 switch (le16_to_cpu(req->value) >> 8) {
759 debug("USB_DT_DEVICE request\n");
760 srcptr = &descriptor.device;
761 srclen = descriptor.device.bLength;
764 debug("USB_DT_CONFIG config\n");
765 srcptr = &descriptor.config;
766 srclen = descriptor.config.bLength +
767 descriptor.interface.bLength +
768 descriptor.endpoint.bLength;
771 debug("USB_DT_STRING config\n");
772 switch (le16_to_cpu(req->value) & 0xff) {
773 case 0: /* Language */
778 srcptr = "\16\3u\0-\0b\0o\0o\0t\0";
781 case 2: /* Product */
782 srcptr = "\52\3E\0H\0C\0I\0 "
784 "\0C\0o\0n\0t\0r\0o\0l\0l\0e\0r\0";
788 debug("unknown value DT_STRING %x\n",
789 le16_to_cpu(req->value));
794 debug("unknown value %x\n", le16_to_cpu(req->value));
798 case USB_REQ_GET_DESCRIPTOR | ((USB_DIR_IN | USB_RT_HUB) << 8):
799 switch (le16_to_cpu(req->value) >> 8) {
801 debug("USB_DT_HUB config\n");
802 srcptr = &descriptor.hub;
803 srclen = descriptor.hub.bLength;
806 debug("unknown value %x\n", le16_to_cpu(req->value));
810 case USB_REQ_SET_ADDRESS | (USB_RECIP_DEVICE << 8):
811 debug("USB_REQ_SET_ADDRESS\n");
812 ctrl->rootdev = le16_to_cpu(req->value);
814 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
815 debug("USB_REQ_SET_CONFIGURATION\n");
818 case USB_REQ_GET_STATUS | ((USB_DIR_IN | USB_RT_HUB) << 8):
819 tmpbuf[0] = 1; /* USB_STATUS_SELFPOWERED */
824 case USB_REQ_GET_STATUS | ((USB_RT_PORT | USB_DIR_IN) << 8):
825 memset(tmpbuf, 0, 4);
826 reg = ehci_readl(status_reg);
827 if (reg & EHCI_PS_CS)
828 tmpbuf[0] |= USB_PORT_STAT_CONNECTION;
829 if (reg & EHCI_PS_PE)
830 tmpbuf[0] |= USB_PORT_STAT_ENABLE;
831 if (reg & EHCI_PS_SUSP)
832 tmpbuf[0] |= USB_PORT_STAT_SUSPEND;
833 if (reg & EHCI_PS_OCA)
834 tmpbuf[0] |= USB_PORT_STAT_OVERCURRENT;
835 if (reg & EHCI_PS_PR)
836 tmpbuf[0] |= USB_PORT_STAT_RESET;
837 if (reg & EHCI_PS_PP)
838 tmpbuf[1] |= USB_PORT_STAT_POWER >> 8;
841 switch (ctrl->ops.get_port_speed(ctrl, reg)) {
845 tmpbuf[1] |= USB_PORT_STAT_LOW_SPEED >> 8;
849 tmpbuf[1] |= USB_PORT_STAT_HIGH_SPEED >> 8;
853 tmpbuf[1] |= USB_PORT_STAT_HIGH_SPEED >> 8;
856 if (reg & EHCI_PS_CSC)
857 tmpbuf[2] |= USB_PORT_STAT_C_CONNECTION;
858 if (reg & EHCI_PS_PEC)
859 tmpbuf[2] |= USB_PORT_STAT_C_ENABLE;
860 if (reg & EHCI_PS_OCC)
861 tmpbuf[2] |= USB_PORT_STAT_C_OVERCURRENT;
862 if (ctrl->portreset & (1 << port))
863 tmpbuf[2] |= USB_PORT_STAT_C_RESET;
868 case USB_REQ_SET_FEATURE | ((USB_DIR_OUT | USB_RT_PORT) << 8):
869 reg = ehci_readl(status_reg);
870 reg &= ~EHCI_PS_CLEAR;
871 switch (le16_to_cpu(req->value)) {
872 case USB_PORT_FEAT_ENABLE:
874 ehci_writel(status_reg, reg);
876 case USB_PORT_FEAT_POWER:
877 if (HCS_PPC(ehci_readl(&ctrl->hccr->cr_hcsparams))) {
879 ehci_writel(status_reg, reg);
882 case USB_PORT_FEAT_RESET:
883 if ((reg & (EHCI_PS_PE | EHCI_PS_CS)) == EHCI_PS_CS &&
885 EHCI_PS_IS_LOWSPEED(reg)) {
886 /* Low speed device, give up ownership. */
887 debug("port %d low speed --> companion\n",
890 ehci_writel(status_reg, reg);
895 /* Disable chirp for HS erratum */
896 if (ctrl->has_fsl_erratum_a005275)
897 reg |= PORTSC_FSL_PFSC;
901 ehci_writel(status_reg, reg);
903 * caller must wait, then call GetPortStatus
904 * usb 2.0 specification say 50 ms resets on
907 ctrl->ops.powerup_fixup(ctrl, status_reg, ®);
909 ehci_writel(status_reg, reg & ~EHCI_PS_PR);
911 * A host controller must terminate the reset
912 * and stabilize the state of the port within
915 ret = handshake(status_reg, EHCI_PS_PR, 0,
918 reg = ehci_readl(status_reg);
919 if ((reg & (EHCI_PS_PE | EHCI_PS_CS))
920 == EHCI_PS_CS && !ehci_is_TDI()) {
921 debug("port %d full speed --> companion\n", port - 1);
922 reg &= ~EHCI_PS_CLEAR;
924 ehci_writel(status_reg, reg);
927 ctrl->portreset |= 1 << port;
930 printf("port(%d) reset error\n",
935 case USB_PORT_FEAT_TEST:
938 reg |= ((le16_to_cpu(req->index) >> 8) & 0xf) << 16;
939 ehci_writel(status_reg, reg);
942 debug("unknown feature %x\n", le16_to_cpu(req->value));
945 /* unblock posted writes */
946 (void) ehci_readl(&ctrl->hcor->or_usbcmd);
948 case USB_REQ_CLEAR_FEATURE | ((USB_DIR_OUT | USB_RT_PORT) << 8):
949 reg = ehci_readl(status_reg);
950 reg &= ~EHCI_PS_CLEAR;
951 switch (le16_to_cpu(req->value)) {
952 case USB_PORT_FEAT_ENABLE:
955 case USB_PORT_FEAT_C_ENABLE:
958 case USB_PORT_FEAT_POWER:
959 if (HCS_PPC(ehci_readl(&ctrl->hccr->cr_hcsparams)))
962 case USB_PORT_FEAT_C_CONNECTION:
965 case USB_PORT_FEAT_OVER_CURRENT:
968 case USB_PORT_FEAT_C_RESET:
969 ctrl->portreset &= ~(1 << port);
972 debug("unknown feature %x\n", le16_to_cpu(req->value));
975 ehci_writel(status_reg, reg);
976 /* unblock posted write */
977 (void) ehci_readl(&ctrl->hcor->or_usbcmd);
980 debug("Unknown request\n");
985 len = min3(srclen, (int)le16_to_cpu(req->length), length);
986 if (srcptr != NULL && len > 0)
987 memcpy(buffer, srcptr, len);
996 debug("requesttype=%x, request=%x, value=%x, index=%x, length=%x\n",
997 req->requesttype, req->request, le16_to_cpu(req->value),
998 le16_to_cpu(req->index), le16_to_cpu(req->length));
1001 dev->status = USB_ST_STALLED;
1005 static const struct ehci_ops default_ehci_ops = {
1006 .set_usb_mode = ehci_set_usbmode,
1007 .get_port_speed = ehci_get_port_speed,
1008 .powerup_fixup = ehci_powerup_fixup,
1009 .get_portsc_register = ehci_get_portsc_register,
1012 static void ehci_setup_ops(struct ehci_ctrl *ctrl, const struct ehci_ops *ops)
1015 ctrl->ops = default_ehci_ops;
1018 if (!ctrl->ops.set_usb_mode)
1019 ctrl->ops.set_usb_mode = ehci_set_usbmode;
1020 if (!ctrl->ops.get_port_speed)
1021 ctrl->ops.get_port_speed = ehci_get_port_speed;
1022 if (!ctrl->ops.powerup_fixup)
1023 ctrl->ops.powerup_fixup = ehci_powerup_fixup;
1024 if (!ctrl->ops.get_portsc_register)
1025 ctrl->ops.get_portsc_register =
1026 ehci_get_portsc_register;
1030 #if !CONFIG_IS_ENABLED(DM_USB)
1031 void ehci_set_controller_priv(int index, void *priv, const struct ehci_ops *ops)
1033 struct ehci_ctrl *ctrl = &ehcic[index];
1036 ehci_setup_ops(ctrl, ops);
1039 void *ehci_get_controller_priv(int index)
1041 return ehcic[index].priv;
1045 static int ehci_common_init(struct ehci_ctrl *ctrl, uint tweaks)
1048 struct QH *periodic;
1053 /* Set the high address word (aka segment) for 64-bit controller */
1054 if (ehci_readl(&ctrl->hccr->cr_hccparams) & 1)
1055 ehci_writel(&ctrl->hcor->or_ctrldssegment, 0);
1057 qh_list = &ctrl->qh_list;
1059 /* Set head of reclaim list */
1060 memset(qh_list, 0, sizeof(*qh_list));
1061 qh_list->qh_link = cpu_to_hc32(virt_to_phys(qh_list) | QH_LINK_TYPE_QH);
1062 qh_list->qh_endpt1 = cpu_to_hc32(QH_ENDPT1_H(1) |
1063 QH_ENDPT1_EPS(USB_SPEED_HIGH));
1064 qh_list->qh_overlay.qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
1065 qh_list->qh_overlay.qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
1066 qh_list->qh_overlay.qt_token =
1067 cpu_to_hc32(QT_TOKEN_STATUS(QT_TOKEN_STATUS_HALTED));
1069 flush_dcache_range((unsigned long)qh_list,
1070 ALIGN_END_ADDR(struct QH, qh_list, 1));
1072 /* Set async. queue head pointer. */
1073 ehci_writel(&ctrl->hcor->or_asynclistaddr, virt_to_phys(qh_list));
1076 * Set up periodic list
1077 * Step 1: Parent QH for all periodic transfers.
1079 ctrl->periodic_schedules = 0;
1080 periodic = &ctrl->periodic_queue;
1081 memset(periodic, 0, sizeof(*periodic));
1082 periodic->qh_link = cpu_to_hc32(QH_LINK_TERMINATE);
1083 periodic->qh_overlay.qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
1084 periodic->qh_overlay.qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
1086 flush_dcache_range((unsigned long)periodic,
1087 ALIGN_END_ADDR(struct QH, periodic, 1));
1090 * Step 2: Setup frame-list: Every microframe, USB tries the same list.
1091 * In particular, device specifications on polling frequency
1092 * are disregarded. Keyboards seem to send NAK/NYet reliably
1093 * when polled with an empty buffer.
1095 * Split Transactions will be spread across microframes using
1096 * S-mask and C-mask.
1098 if (ctrl->periodic_list == NULL)
1099 ctrl->periodic_list = memalign(4096, 1024 * 4);
1101 if (!ctrl->periodic_list)
1103 for (i = 0; i < 1024; i++) {
1104 ctrl->periodic_list[i] = cpu_to_hc32((unsigned long)periodic
1108 flush_dcache_range((unsigned long)ctrl->periodic_list,
1109 ALIGN_END_ADDR(uint32_t, ctrl->periodic_list,
1112 /* Set periodic list base address */
1113 ehci_writel(&ctrl->hcor->or_periodiclistbase,
1114 (unsigned long)ctrl->periodic_list);
1116 reg = ehci_readl(&ctrl->hccr->cr_hcsparams);
1117 descriptor.hub.bNbrPorts = HCS_N_PORTS(reg);
1118 debug("Register %x NbrPorts %d\n", reg, descriptor.hub.bNbrPorts);
1119 /* Port Indicators */
1120 if (HCS_INDICATOR(reg))
1121 put_unaligned(get_unaligned(&descriptor.hub.wHubCharacteristics)
1122 | 0x80, &descriptor.hub.wHubCharacteristics);
1123 /* Port Power Control */
1125 put_unaligned(get_unaligned(&descriptor.hub.wHubCharacteristics)
1126 | 0x01, &descriptor.hub.wHubCharacteristics);
1128 /* Start the host controller. */
1129 cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
1131 * Philips, Intel, and maybe others need CMD_RUN before the
1132 * root hub will detect new devices (why?); NEC doesn't
1134 cmd &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
1136 ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
1138 if (!(tweaks & EHCI_TWEAK_NO_INIT_CF)) {
1139 /* take control over the ports */
1140 cmd = ehci_readl(&ctrl->hcor->or_configflag);
1142 ehci_writel(&ctrl->hcor->or_configflag, cmd);
1145 /* unblock posted write */
1146 cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
1148 reg = HC_VERSION(ehci_readl(&ctrl->hccr->cr_capbase));
1149 printf("USB EHCI %x.%02x\n", reg >> 8, reg & 0xff);
1154 #if !CONFIG_IS_ENABLED(DM_USB)
1155 int usb_lowlevel_stop(int index)
1157 ehci_shutdown(&ehcic[index]);
1158 return ehci_hcd_stop(index);
1161 int usb_lowlevel_init(int index, enum usb_init_type init, void **controller)
1163 struct ehci_ctrl *ctrl = &ehcic[index];
1168 * Set ops to default_ehci_ops, ehci_hcd_init should call
1169 * ehci_set_controller_priv to change any of these function pointers.
1171 ctrl->ops = default_ehci_ops;
1173 rc = ehci_hcd_init(index, init, &ctrl->hccr, &ctrl->hcor);
1176 if (!ctrl->hccr || !ctrl->hcor)
1178 if (init == USB_INIT_DEVICE)
1181 /* EHCI spec section 4.1 */
1182 if (ehci_reset(ctrl))
1185 #if defined(CONFIG_EHCI_HCD_INIT_AFTER_RESET)
1186 rc = ehci_hcd_init(index, init, &ctrl->hccr, &ctrl->hcor);
1190 rc = ehci_common_init(ctrl, tweaks);
1196 *controller = &ehcic[index];
1201 static int _ehci_submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
1202 void *buffer, int length)
1205 if (usb_pipetype(pipe) != PIPE_BULK) {
1206 debug("non-bulk pipe (type=%lu)", usb_pipetype(pipe));
1209 return ehci_submit_async(dev, pipe, buffer, length, NULL);
1212 static int _ehci_submit_control_msg(struct usb_device *dev, unsigned long pipe,
1213 void *buffer, int length,
1214 struct devrequest *setup)
1216 struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
1218 if (usb_pipetype(pipe) != PIPE_CONTROL) {
1219 debug("non-control pipe (type=%lu)", usb_pipetype(pipe));
1223 if (usb_pipedevice(pipe) == ctrl->rootdev) {
1225 dev->speed = USB_SPEED_HIGH;
1226 return ehci_submit_root(dev, pipe, buffer, length, setup);
1228 return ehci_submit_async(dev, pipe, buffer, length, setup);
1240 #define NEXT_QH(qh) (struct QH *)((unsigned long)hc32_to_cpu((qh)->qh_link) & ~0x1f)
1243 enable_periodic(struct ehci_ctrl *ctrl)
1246 struct ehci_hcor *hcor = ctrl->hcor;
1249 cmd = ehci_readl(&hcor->or_usbcmd);
1251 ehci_writel(&hcor->or_usbcmd, cmd);
1253 ret = handshake((uint32_t *)&hcor->or_usbsts,
1254 STS_PSS, STS_PSS, 100 * 1000);
1256 printf("EHCI failed: timeout when enabling periodic list\n");
1264 disable_periodic(struct ehci_ctrl *ctrl)
1267 struct ehci_hcor *hcor = ctrl->hcor;
1270 cmd = ehci_readl(&hcor->or_usbcmd);
1272 ehci_writel(&hcor->or_usbcmd, cmd);
1274 ret = handshake((uint32_t *)&hcor->or_usbsts,
1275 STS_PSS, 0, 100 * 1000);
1277 printf("EHCI failed: timeout when disabling periodic list\n");
1283 static struct int_queue *_ehci_create_int_queue(struct usb_device *dev,
1284 unsigned long pipe, int queuesize, int elementsize,
1285 void *buffer, int interval)
1287 struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
1288 struct int_queue *result = NULL;
1292 * Interrupt transfers requiring several transactions are not supported
1293 * because bInterval is ignored.
1295 * Also, ehci_submit_async() relies on wMaxPacketSize being a power of 2
1296 * <= PKT_ALIGN if several qTDs are required, while the USB
1297 * specification does not constrain this for interrupt transfers. That
1298 * means that ehci_submit_async() would support interrupt transfers
1299 * requiring several transactions only as long as the transfer size does
1300 * not require more than a single qTD.
1302 if (elementsize > usb_maxpacket(dev, pipe)) {
1303 printf("%s: xfers requiring several transactions are not supported.\n",
1308 debug("Enter create_int_queue\n");
1309 if (usb_pipetype(pipe) != PIPE_INTERRUPT) {
1310 debug("non-interrupt pipe (type=%lu)", usb_pipetype(pipe));
1314 /* limit to 4 full pages worth of data -
1315 * we can safely fit them in a single TD,
1316 * no matter the alignment
1318 if (elementsize >= 16384) {
1319 debug("too large elements for interrupt transfers\n");
1323 result = malloc(sizeof(*result));
1325 debug("ehci intr queue: out of memory\n");
1328 result->elementsize = elementsize;
1329 result->pipe = pipe;
1330 result->first = memalign(USB_DMA_MINALIGN,
1331 sizeof(struct QH) * queuesize);
1332 if (!result->first) {
1333 debug("ehci intr queue: out of memory\n");
1336 result->current = result->first;
1337 result->last = result->first + queuesize - 1;
1338 result->tds = memalign(USB_DMA_MINALIGN,
1339 sizeof(struct qTD) * queuesize);
1341 debug("ehci intr queue: out of memory\n");
1344 memset(result->first, 0, sizeof(struct QH) * queuesize);
1345 memset(result->tds, 0, sizeof(struct qTD) * queuesize);
1347 toggle = usb_gettoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
1349 for (i = 0; i < queuesize; i++) {
1350 struct QH *qh = result->first + i;
1351 struct qTD *td = result->tds + i;
1352 void **buf = &qh->buffer;
1354 qh->qh_link = cpu_to_hc32((unsigned long)(qh+1) | QH_LINK_TYPE_QH);
1355 if (i == queuesize - 1)
1356 qh->qh_link = cpu_to_hc32(QH_LINK_TERMINATE);
1358 qh->qh_overlay.qt_next = cpu_to_hc32((unsigned long)td);
1359 qh->qh_overlay.qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
1361 cpu_to_hc32((0 << 28) | /* No NAK reload (ehci 4.9) */
1362 (usb_maxpacket(dev, pipe) << 16) | /* MPS */
1364 QH_ENDPT1_EPS(ehci_encode_speed(dev->speed)) |
1365 (usb_pipeendpoint(pipe) << 8) | /* Endpoint Number */
1366 (usb_pipedevice(pipe) << 0));
1367 qh->qh_endpt2 = cpu_to_hc32((1 << 30) | /* 1 Tx per mframe */
1368 (1 << 0)); /* S-mask: microframe 0 */
1369 if (dev->speed == USB_SPEED_LOW ||
1370 dev->speed == USB_SPEED_FULL) {
1371 /* C-mask: microframes 2-4 */
1372 qh->qh_endpt2 |= cpu_to_hc32((0x1c << 8));
1374 ehci_update_endpt2_dev_n_port(dev, qh);
1376 td->qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
1377 td->qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
1378 debug("communication direction is '%s'\n",
1379 usb_pipein(pipe) ? "in" : "out");
1380 td->qt_token = cpu_to_hc32(
1381 QT_TOKEN_DT(toggle) |
1382 (elementsize << 16) |
1383 ((usb_pipein(pipe) ? 1 : 0) << 8) | /* IN/OUT token */
1386 cpu_to_hc32((unsigned long)buffer + i * elementsize);
1388 cpu_to_hc32((td->qt_buffer[0] + 0x1000) & ~0xfff);
1390 cpu_to_hc32((td->qt_buffer[0] + 0x2000) & ~0xfff);
1392 cpu_to_hc32((td->qt_buffer[0] + 0x3000) & ~0xfff);
1394 cpu_to_hc32((td->qt_buffer[0] + 0x4000) & ~0xfff);
1396 *buf = buffer + i * elementsize;
1400 flush_dcache_range((unsigned long)buffer,
1401 ALIGN_END_ADDR(char, buffer,
1402 queuesize * elementsize));
1403 flush_dcache_range((unsigned long)result->first,
1404 ALIGN_END_ADDR(struct QH, result->first,
1406 flush_dcache_range((unsigned long)result->tds,
1407 ALIGN_END_ADDR(struct qTD, result->tds,
1410 if (ctrl->periodic_schedules > 0) {
1411 if (disable_periodic(ctrl) < 0) {
1412 debug("FATAL: periodic should never fail, but did");
1417 /* hook up to periodic list */
1418 struct QH *list = &ctrl->periodic_queue;
1419 result->last->qh_link = list->qh_link;
1420 list->qh_link = cpu_to_hc32((unsigned long)result->first | QH_LINK_TYPE_QH);
1422 flush_dcache_range((unsigned long)result->last,
1423 ALIGN_END_ADDR(struct QH, result->last, 1));
1424 flush_dcache_range((unsigned long)list,
1425 ALIGN_END_ADDR(struct QH, list, 1));
1427 if (enable_periodic(ctrl) < 0) {
1428 debug("FATAL: periodic should never fail, but did");
1431 ctrl->periodic_schedules++;
1433 debug("Exit create_int_queue\n");
1438 free(result->first);
1444 static void *_ehci_poll_int_queue(struct usb_device *dev,
1445 struct int_queue *queue)
1447 struct QH *cur = queue->current;
1449 uint32_t token, toggle;
1450 unsigned long pipe = queue->pipe;
1452 /* depleted queue */
1454 debug("Exit poll_int_queue with completed queue\n");
1458 cur_td = &queue->tds[queue->current - queue->first];
1459 invalidate_dcache_range((unsigned long)cur_td,
1460 ALIGN_END_ADDR(struct qTD, cur_td, 1));
1461 token = hc32_to_cpu(cur_td->qt_token);
1462 if (QT_TOKEN_GET_STATUS(token) & QT_TOKEN_STATUS_ACTIVE) {
1463 debug("Exit poll_int_queue with no completed intr transfer. token is %x\n", token);
1467 toggle = QT_TOKEN_GET_DT(token);
1468 usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), toggle);
1470 if (!(cur->qh_link & QH_LINK_TERMINATE))
1473 queue->current = NULL;
1475 invalidate_dcache_range((unsigned long)cur->buffer,
1476 ALIGN_END_ADDR(char, cur->buffer,
1477 queue->elementsize));
1479 debug("Exit poll_int_queue with completed intr transfer. token is %x at %p (first at %p)\n",
1480 token, cur, queue->first);
1484 /* Do not free buffers associated with QHs, they're owned by someone else */
1485 static int _ehci_destroy_int_queue(struct usb_device *dev,
1486 struct int_queue *queue)
1488 struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
1490 unsigned long timeout;
1492 if (disable_periodic(ctrl) < 0) {
1493 debug("FATAL: periodic should never fail, but did");
1496 ctrl->periodic_schedules--;
1498 struct QH *cur = &ctrl->periodic_queue;
1499 timeout = get_timer(0) + 500; /* abort after 500ms */
1500 while (!(cur->qh_link & cpu_to_hc32(QH_LINK_TERMINATE))) {
1501 debug("considering %p, with qh_link %x\n", cur, cur->qh_link);
1502 if (NEXT_QH(cur) == queue->first) {
1503 debug("found candidate. removing from chain\n");
1504 cur->qh_link = queue->last->qh_link;
1505 flush_dcache_range((unsigned long)cur,
1506 ALIGN_END_ADDR(struct QH, cur, 1));
1511 if (get_timer(0) > timeout) {
1512 printf("Timeout destroying interrupt endpoint queue\n");
1518 if (ctrl->periodic_schedules > 0) {
1519 result = enable_periodic(ctrl);
1521 debug("FATAL: periodic should never fail, but did");
1532 static int _ehci_submit_int_msg(struct usb_device *dev, unsigned long pipe,
1533 void *buffer, int length, int interval,
1537 struct int_queue *queue;
1538 unsigned long timeout;
1539 int result = 0, ret;
1541 debug("dev=%p, pipe=%lu, buffer=%p, length=%d, interval=%d",
1542 dev, pipe, buffer, length, interval);
1544 queue = _ehci_create_int_queue(dev, pipe, 1, length, buffer, interval);
1548 timeout = get_timer(0) + USB_TIMEOUT_MS(pipe);
1549 while ((backbuffer = _ehci_poll_int_queue(dev, queue)) == NULL)
1550 if (get_timer(0) > timeout) {
1551 printf("Timeout poll on interrupt endpoint\n");
1552 result = -ETIMEDOUT;
1556 if (backbuffer != buffer) {
1557 debug("got wrong buffer back (%p instead of %p)\n",
1558 backbuffer, buffer);
1562 ret = _ehci_destroy_int_queue(dev, queue);
1566 /* everything worked out fine */
1570 static int _ehci_lock_async(struct ehci_ctrl *ctrl, int lock)
1572 ctrl->async_locked = lock;
1577 return ehci_disable_async(ctrl);
1580 #if !CONFIG_IS_ENABLED(DM_USB)
1581 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
1582 void *buffer, int length)
1584 return _ehci_submit_bulk_msg(dev, pipe, buffer, length);
1587 int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
1588 int length, struct devrequest *setup)
1590 return _ehci_submit_control_msg(dev, pipe, buffer, length, setup);
1593 int submit_int_msg(struct usb_device *dev, unsigned long pipe,
1594 void *buffer, int length, int interval, bool nonblock)
1596 return _ehci_submit_int_msg(dev, pipe, buffer, length, interval,
1600 struct int_queue *create_int_queue(struct usb_device *dev,
1601 unsigned long pipe, int queuesize, int elementsize,
1602 void *buffer, int interval)
1604 return _ehci_create_int_queue(dev, pipe, queuesize, elementsize,
1608 void *poll_int_queue(struct usb_device *dev, struct int_queue *queue)
1610 return _ehci_poll_int_queue(dev, queue);
1613 int destroy_int_queue(struct usb_device *dev, struct int_queue *queue)
1615 return _ehci_destroy_int_queue(dev, queue);
1618 int usb_lock_async(struct usb_device *dev, int lock)
1620 struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
1622 return _ehci_lock_async(ctrl, lock);
1626 #if CONFIG_IS_ENABLED(DM_USB)
1627 static int ehci_submit_control_msg(struct udevice *dev, struct usb_device *udev,
1628 unsigned long pipe, void *buffer, int length,
1629 struct devrequest *setup)
1631 debug("%s: dev='%s', udev=%p, udev->dev='%s', portnr=%d\n", __func__,
1632 dev->name, udev, udev->dev->name, udev->portnr);
1634 return _ehci_submit_control_msg(udev, pipe, buffer, length, setup);
1637 static int ehci_submit_bulk_msg(struct udevice *dev, struct usb_device *udev,
1638 unsigned long pipe, void *buffer, int length)
1640 debug("%s: dev='%s', udev=%p\n", __func__, dev->name, udev);
1641 return _ehci_submit_bulk_msg(udev, pipe, buffer, length);
1644 static int ehci_submit_int_msg(struct udevice *dev, struct usb_device *udev,
1645 unsigned long pipe, void *buffer, int length,
1646 int interval, bool nonblock)
1648 debug("%s: dev='%s', udev=%p\n", __func__, dev->name, udev);
1649 return _ehci_submit_int_msg(udev, pipe, buffer, length, interval,
1653 static struct int_queue *ehci_create_int_queue(struct udevice *dev,
1654 struct usb_device *udev, unsigned long pipe, int queuesize,
1655 int elementsize, void *buffer, int interval)
1657 debug("%s: dev='%s', udev=%p\n", __func__, dev->name, udev);
1658 return _ehci_create_int_queue(udev, pipe, queuesize, elementsize,
1662 static void *ehci_poll_int_queue(struct udevice *dev, struct usb_device *udev,
1663 struct int_queue *queue)
1665 debug("%s: dev='%s', udev=%p\n", __func__, dev->name, udev);
1666 return _ehci_poll_int_queue(udev, queue);
1669 static int ehci_destroy_int_queue(struct udevice *dev, struct usb_device *udev,
1670 struct int_queue *queue)
1672 debug("%s: dev='%s', udev=%p\n", __func__, dev->name, udev);
1673 return _ehci_destroy_int_queue(udev, queue);
1676 static int ehci_get_max_xfer_size(struct udevice *dev, size_t *size)
1679 * EHCD can handle any transfer length as long as there is enough
1680 * free heap space left, hence set the theoretical max number here.
1687 static int ehci_lock_async(struct udevice *dev, int lock)
1689 struct ehci_ctrl *ctrl = dev_get_priv(dev);
1691 return _ehci_lock_async(ctrl, lock);
1694 int ehci_register(struct udevice *dev, struct ehci_hccr *hccr,
1695 struct ehci_hcor *hcor, const struct ehci_ops *ops,
1696 uint tweaks, enum usb_init_type init)
1698 struct usb_bus_priv *priv = dev_get_uclass_priv(dev);
1699 struct ehci_ctrl *ctrl = dev_get_priv(dev);
1702 debug("%s: dev='%s', ctrl=%p, hccr=%p, hcor=%p, init=%d\n", __func__,
1703 dev->name, ctrl, hccr, hcor, init);
1705 if (!ctrl || !hccr || !hcor)
1708 priv->desc_before_addr = true;
1710 ehci_setup_ops(ctrl, ops);
1716 if (ctrl->init == USB_INIT_DEVICE)
1719 ret = ehci_reset(ctrl);
1723 if (ctrl->ops.init_after_reset) {
1724 ret = ctrl->ops.init_after_reset(ctrl);
1729 ret = ehci_common_init(ctrl, tweaks);
1736 debug("%s: failed, ret=%d\n", __func__, ret);
1740 int ehci_deregister(struct udevice *dev)
1742 struct ehci_ctrl *ctrl = dev_get_priv(dev);
1744 if (ctrl->init == USB_INIT_DEVICE)
1747 ehci_shutdown(ctrl);
1752 struct dm_usb_ops ehci_usb_ops = {
1753 .control = ehci_submit_control_msg,
1754 .bulk = ehci_submit_bulk_msg,
1755 .interrupt = ehci_submit_int_msg,
1756 .create_int_queue = ehci_create_int_queue,
1757 .poll_int_queue = ehci_poll_int_queue,
1758 .destroy_int_queue = ehci_destroy_int_queue,
1759 .get_max_xfer_size = ehci_get_max_xfer_size,
1760 .lock_async = ehci_lock_async,