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>
14 #include <asm/byteorder.h>
15 #include <asm/cache.h>
16 #include <asm/unaligned.h>
22 #include <dm/device_compat.h>
23 #include <linux/compiler.h>
24 #include <linux/delay.h>
29 * EHCI spec page 20 says that the HC may take up to 16 uFrames (= 4ms) to halt.
30 * Let's time out after 8 to have a little safety margin on top of that.
32 #define HCHALT_TIMEOUT (8 * 1000)
34 #if !CONFIG_IS_ENABLED(DM_USB)
35 static struct ehci_ctrl ehcic[CONFIG_USB_MAX_CONTROLLER_COUNT];
38 #define ALIGN_END_ADDR(type, ptr, size) \
39 ((unsigned long)(ptr) + roundup((size) * sizeof(type), USB_DMA_MINALIGN))
41 static struct descriptor {
42 struct usb_hub_descriptor hub;
43 struct usb_device_descriptor device;
44 struct usb_linux_config_descriptor config;
45 struct usb_linux_interface_descriptor interface;
46 struct usb_endpoint_descriptor endpoint;
47 } __attribute__ ((packed)) descriptor = {
49 0x8, /* bDescLength */
50 0x29, /* bDescriptorType: hub descriptor */
51 2, /* bNrPorts -- runtime modified */
52 0, /* wHubCharacteristics */
53 10, /* bPwrOn2PwrGood */
54 0, /* bHubCntrCurrent */
55 { /* Device removable */
56 } /* at most 7 ports! XXX */
60 1, /* bDescriptorType: UDESC_DEVICE */
61 cpu_to_le16(0x0200), /* bcdUSB: v2.0 */
62 9, /* bDeviceClass: UDCLASS_HUB */
63 0, /* bDeviceSubClass: UDSUBCLASS_HUB */
64 1, /* bDeviceProtocol: UDPROTO_HSHUBSTT */
65 64, /* bMaxPacketSize: 64 bytes */
66 0x0000, /* idVendor */
67 0x0000, /* idProduct */
68 cpu_to_le16(0x0100), /* bcdDevice */
69 1, /* iManufacturer */
71 0, /* iSerialNumber */
72 1 /* bNumConfigurations: 1 */
76 2, /* bDescriptorType: UDESC_CONFIG */
78 1, /* bNumInterface */
79 1, /* bConfigurationValue */
80 0, /* iConfiguration */
81 0x40, /* bmAttributes: UC_SELF_POWER */
86 4, /* bDescriptorType: UDESC_INTERFACE */
87 0, /* bInterfaceNumber */
88 0, /* bAlternateSetting */
89 1, /* bNumEndpoints */
90 9, /* bInterfaceClass: UICLASS_HUB */
91 0, /* bInterfaceSubClass: UISUBCLASS_HUB */
92 0, /* bInterfaceProtocol: UIPROTO_HSHUBSTT */
97 5, /* bDescriptorType: UDESC_ENDPOINT */
98 0x81, /* bEndpointAddress:
99 * UE_DIR_IN | EHCI_INTR_ENDPT
101 3, /* bmAttributes: UE_INTERRUPT */
102 8, /* wMaxPacketSize */
107 #if defined(CONFIG_USB_EHCI_IS_TDI)
108 #define ehci_is_TDI() (1)
110 #define ehci_is_TDI() (0)
113 static struct ehci_ctrl *ehci_get_ctrl(struct usb_device *udev)
115 #if CONFIG_IS_ENABLED(DM_USB)
116 return dev_get_priv(usb_get_bus(udev->dev));
118 return udev->controller;
122 static int ehci_get_port_speed(struct ehci_ctrl *ctrl, uint32_t reg)
124 return PORTSC_PSPD(reg);
127 static void ehci_set_usbmode(struct ehci_ctrl *ctrl)
132 reg_ptr = (uint32_t *)((u8 *)&ctrl->hcor->or_usbcmd + USBMODE);
133 tmp = ehci_readl(reg_ptr);
134 tmp |= USBMODE_CM_HC;
135 #if defined(CONFIG_EHCI_MMIO_BIG_ENDIAN)
140 ehci_writel(reg_ptr, tmp);
143 static void ehci_powerup_fixup(struct ehci_ctrl *ctrl, uint32_t *status_reg,
149 static uint32_t *ehci_get_portsc_register(struct ehci_ctrl *ctrl, int port)
151 int max_ports = HCS_N_PORTS(ehci_readl(&ctrl->hccr->cr_hcsparams));
153 if (port < 0 || port >= max_ports) {
154 /* Printing the message would cause a scan failure! */
155 debug("The request port(%u) exceeds maximum port number\n",
160 return (uint32_t *)&ctrl->hcor->or_portsc[port];
163 static int handshake(uint32_t *ptr, uint32_t mask, uint32_t done, int usec)
167 result = ehci_readl(ptr);
169 if (result == ~(uint32_t)0)
179 static int ehci_reset(struct ehci_ctrl *ctrl)
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);
190 printf("EHCI fail to reset\n");
195 ctrl->ops.set_usb_mode(ctrl);
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);
207 static int ehci_shutdown(struct ehci_ctrl *ctrl)
211 int max_ports = HCS_N_PORTS(ehci_readl(&ctrl->hccr->cr_hcsparams));
213 cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
214 /* If not run, directly return */
215 if (!(cmd & CMD_RUN))
217 cmd &= ~(CMD_PSE | CMD_ASE);
218 ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
219 ret = handshake(&ctrl->hcor->or_usbsts, STS_ASS | STS_PSS, 0,
223 for (i = 0; i < max_ports; i++) {
224 reg = ehci_readl(&ctrl->hcor->or_portsc[i]);
226 ehci_writel(&ctrl->hcor->or_portsc[i], reg);
230 ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
231 ret = handshake(&ctrl->hcor->or_usbsts, STS_HALT, STS_HALT,
236 puts("EHCI failed to shut down host controller.\n");
241 static int ehci_td_buffer(struct qTD *td, void *buf, size_t sz)
243 uint32_t delta, next;
244 unsigned long addr = (unsigned long)buf;
247 if (addr != ALIGN(addr, ARCH_DMA_MINALIGN))
248 debug("EHCI-HCD: Misaligned buffer address (%p)\n", buf);
250 flush_dcache_range(addr, ALIGN(addr + sz, ARCH_DMA_MINALIGN));
253 while (idx < QT_BUFFER_CNT) {
254 td->qt_buffer[idx] = cpu_to_hc32(virt_to_phys((void *)addr));
255 td->qt_buffer_hi[idx] = 0;
256 next = (addr + EHCI_PAGE_SIZE) & ~(EHCI_PAGE_SIZE - 1);
265 if (idx == QT_BUFFER_CNT) {
266 printf("out of buffer pointers (%zu bytes left)\n", sz);
273 static inline u8 ehci_encode_speed(enum usb_device_speed speed)
275 #define QH_HIGH_SPEED 2
276 #define QH_FULL_SPEED 0
277 #define QH_LOW_SPEED 1
278 if (speed == USB_SPEED_HIGH)
279 return QH_HIGH_SPEED;
280 if (speed == USB_SPEED_LOW)
282 return QH_FULL_SPEED;
285 static void ehci_update_endpt2_dev_n_port(struct usb_device *udev,
291 if (udev->speed != USB_SPEED_LOW && udev->speed != USB_SPEED_FULL)
294 usb_find_usb2_hub_address_port(udev, &hubaddr, &portnr);
296 qh->qh_endpt2 |= cpu_to_hc32(QH_ENDPT2_PORTNUM(portnr) |
297 QH_ENDPT2_HUBADDR(hubaddr));
300 static int ehci_enable_async(struct ehci_ctrl *ctrl)
305 /* Enable async. schedule. */
306 cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
311 ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
313 ret = handshake((uint32_t *)&ctrl->hcor->or_usbsts, STS_ASS, STS_ASS,
316 printf("EHCI fail timeout STS_ASS set\n");
321 static int ehci_disable_async(struct ehci_ctrl *ctrl)
326 if (ctrl->async_locked)
329 /* Disable async schedule. */
330 cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
331 if (!(cmd & CMD_ASE))
335 ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
337 ret = handshake((uint32_t *)&ctrl->hcor->or_usbsts, STS_ASS, 0,
340 printf("EHCI fail timeout STS_ASS reset\n");
345 static int ehci_iaa_cycle(struct ehci_ctrl *ctrl)
350 /* Enable Interrupt on Async Advance Doorbell. */
351 cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
353 ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
355 ret = handshake(&ctrl->hcor->or_usbsts, STS_IAA, STS_IAA,
356 10 * 1000); /* 10ms timeout */
358 printf("EHCI fail timeout STS_IAA set\n");
360 status = ehci_readl(&ctrl->hcor->or_usbsts);
361 if (status & STS_IAA)
362 ehci_writel(&ctrl->hcor->or_usbsts, STS_IAA);
368 ehci_submit_async(struct usb_device *dev, unsigned long pipe, void *buffer,
369 int length, struct devrequest *req)
371 ALLOC_ALIGN_BUFFER(struct QH, qh, 1, USB_DMA_MINALIGN);
375 volatile struct qTD *vtd;
378 uint32_t endpt, maxpacket, token, usbsts, qhtoken;
382 struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
384 debug("dev=%p, pipe=%lx, buffer=%p, length=%d, req=%p\n", dev, pipe,
385 buffer, length, req);
387 debug("req=%u (%#x), type=%u (%#x), value=%u (%#x), index=%u\n",
388 req->request, req->request,
389 req->requesttype, req->requesttype,
390 le16_to_cpu(req->value), le16_to_cpu(req->value),
391 le16_to_cpu(req->index));
393 #define PKT_ALIGN 512
395 * The USB transfer is split into qTD transfers. Eeach qTD transfer is
396 * described by a transfer descriptor (the qTD). The qTDs form a linked
397 * list with a queue head (QH).
399 * Each qTD transfer starts with a new USB packet, i.e. a packet cannot
400 * have its beginning in a qTD transfer and its end in the following
401 * one, so the qTD transfer lengths have to be chosen accordingly.
403 * Each qTD transfer uses up to QT_BUFFER_CNT data buffers, mapped to
404 * single pages. The first data buffer can start at any offset within a
405 * page (not considering the cache-line alignment issues), while the
406 * following buffers must be page-aligned. There is no alignment
407 * constraint on the size of a qTD transfer.
410 /* 1 qTD will be needed for SETUP, and 1 for ACK. */
412 if (length > 0 || req == NULL) {
414 * Determine the qTD transfer size that will be used for the
415 * data payload (not considering the first qTD transfer, which
416 * may be longer or shorter, and the final one, which may be
419 * In order to keep each packet within a qTD transfer, the qTD
420 * transfer size is aligned to PKT_ALIGN, which is a multiple of
421 * wMaxPacketSize (except in some cases for interrupt transfers,
422 * see comment in submit_int_msg()).
424 * By default, i.e. if the input buffer is aligned to PKT_ALIGN,
425 * QT_BUFFER_CNT full pages will be used.
427 int xfr_sz = QT_BUFFER_CNT;
429 * However, if the input buffer is not aligned to PKT_ALIGN, the
430 * qTD transfer size will be one page shorter, and the first qTD
431 * data buffer of each transfer will be page-unaligned.
433 if ((unsigned long)buffer & (PKT_ALIGN - 1))
435 /* Convert the qTD transfer size to bytes. */
436 xfr_sz *= EHCI_PAGE_SIZE;
438 * Approximate by excess the number of qTDs that will be
439 * required for the data payload. The exact formula is way more
440 * complicated and saves at most 2 qTDs, i.e. a total of 128
443 qtd_count += 2 + length / xfr_sz;
446 * Threshold value based on the worst-case total size of the allocated qTDs for
447 * a mass-storage transfer of 65535 blocks of 512 bytes.
449 #if CONFIG_SYS_MALLOC_LEN <= 64 + 128 * 1024
450 #warning CONFIG_SYS_MALLOC_LEN may be too small for EHCI
452 qtd = memalign(USB_DMA_MINALIGN, qtd_count * sizeof(struct qTD));
454 printf("unable to allocate TDs\n");
458 memset(qh, 0, sizeof(struct QH));
459 memset(qtd, 0, qtd_count * sizeof(*qtd));
461 toggle = usb_gettoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
464 * Setup QH (3.6 in ehci-r10.pdf)
466 * qh_link ................. 03-00 H
467 * qh_endpt1 ............... 07-04 H
468 * qh_endpt2 ............... 0B-08 H
470 * qh_overlay.qt_next ...... 13-10 H
471 * - qh_overlay.qt_altnext
473 qh->qh_link = cpu_to_hc32(virt_to_phys(&ctrl->qh_list) | QH_LINK_TYPE_QH);
474 c = (dev->speed != USB_SPEED_HIGH) && !usb_pipeendpoint(pipe);
475 maxpacket = usb_maxpacket(dev, pipe);
476 endpt = QH_ENDPT1_RL(8) | QH_ENDPT1_C(c) |
477 QH_ENDPT1_MAXPKTLEN(maxpacket) | QH_ENDPT1_H(0) |
478 QH_ENDPT1_DTC(QH_ENDPT1_DTC_DT_FROM_QTD) |
479 QH_ENDPT1_ENDPT(usb_pipeendpoint(pipe)) | QH_ENDPT1_I(0) |
480 QH_ENDPT1_DEVADDR(usb_pipedevice(pipe));
482 /* Force FS for fsl HS quirk */
483 if (!ctrl->has_fsl_erratum_a005275)
484 endpt |= QH_ENDPT1_EPS(ehci_encode_speed(dev->speed));
486 endpt |= QH_ENDPT1_EPS(ehci_encode_speed(QH_FULL_SPEED));
488 qh->qh_endpt1 = cpu_to_hc32(endpt);
489 endpt = QH_ENDPT2_MULT(1) | QH_ENDPT2_UFCMASK(0) | QH_ENDPT2_UFSMASK(0);
490 qh->qh_endpt2 = cpu_to_hc32(endpt);
491 ehci_update_endpt2_dev_n_port(dev, qh);
492 qh->qh_overlay.qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
493 qh->qh_overlay.qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
495 tdp = &qh->qh_overlay.qt_next;
498 * Setup request qTD (3.5 in ehci-r10.pdf)
500 * qt_next ................ 03-00 H
501 * qt_altnext ............. 07-04 H
502 * qt_token ............... 0B-08 H
504 * [ buffer, buffer_hi ] loaded with "req".
506 qtd[qtd_counter].qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
507 qtd[qtd_counter].qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
508 token = QT_TOKEN_DT(0) | QT_TOKEN_TOTALBYTES(sizeof(*req)) |
509 QT_TOKEN_IOC(0) | QT_TOKEN_CPAGE(0) | QT_TOKEN_CERR(3) |
510 QT_TOKEN_PID(QT_TOKEN_PID_SETUP) |
511 QT_TOKEN_STATUS(QT_TOKEN_STATUS_ACTIVE);
512 qtd[qtd_counter].qt_token = cpu_to_hc32(token);
513 if (ehci_td_buffer(&qtd[qtd_counter], req, sizeof(*req))) {
514 printf("unable to construct SETUP TD\n");
517 /* Update previous qTD! */
518 *tdp = cpu_to_hc32(virt_to_phys(&qtd[qtd_counter]));
519 tdp = &qtd[qtd_counter++].qt_next;
523 if (length > 0 || req == NULL) {
524 uint8_t *buf_ptr = buffer;
525 int left_length = length;
529 * Determine the size of this qTD transfer. By default,
530 * QT_BUFFER_CNT full pages can be used.
532 int xfr_bytes = QT_BUFFER_CNT * EHCI_PAGE_SIZE;
534 * However, if the input buffer is not page-aligned, the
535 * portion of the first page before the buffer start
536 * offset within that page is unusable.
538 xfr_bytes -= (unsigned long)buf_ptr & (EHCI_PAGE_SIZE - 1);
540 * In order to keep each packet within a qTD transfer,
541 * align the qTD transfer size to PKT_ALIGN.
543 xfr_bytes &= ~(PKT_ALIGN - 1);
545 * This transfer may be shorter than the available qTD
546 * transfer size that has just been computed.
548 xfr_bytes = min(xfr_bytes, left_length);
551 * Setup request qTD (3.5 in ehci-r10.pdf)
553 * qt_next ................ 03-00 H
554 * qt_altnext ............. 07-04 H
555 * qt_token ............... 0B-08 H
557 * [ buffer, buffer_hi ] loaded with "buffer".
559 qtd[qtd_counter].qt_next =
560 cpu_to_hc32(QT_NEXT_TERMINATE);
561 qtd[qtd_counter].qt_altnext =
562 cpu_to_hc32(QT_NEXT_TERMINATE);
563 token = QT_TOKEN_DT(toggle) |
564 QT_TOKEN_TOTALBYTES(xfr_bytes) |
565 QT_TOKEN_IOC(req == NULL) | QT_TOKEN_CPAGE(0) |
567 QT_TOKEN_PID(usb_pipein(pipe) ?
568 QT_TOKEN_PID_IN : QT_TOKEN_PID_OUT) |
569 QT_TOKEN_STATUS(QT_TOKEN_STATUS_ACTIVE);
570 qtd[qtd_counter].qt_token = cpu_to_hc32(token);
571 if (ehci_td_buffer(&qtd[qtd_counter], buf_ptr,
573 printf("unable to construct DATA TD\n");
576 /* Update previous qTD! */
577 *tdp = cpu_to_hc32(virt_to_phys(&qtd[qtd_counter]));
578 tdp = &qtd[qtd_counter++].qt_next;
580 * Data toggle has to be adjusted since the qTD transfer
581 * size is not always an even multiple of
584 if ((xfr_bytes / maxpacket) & 1)
586 buf_ptr += xfr_bytes;
587 left_length -= xfr_bytes;
588 } while (left_length > 0);
593 * Setup request qTD (3.5 in ehci-r10.pdf)
595 * qt_next ................ 03-00 H
596 * qt_altnext ............. 07-04 H
597 * qt_token ............... 0B-08 H
599 qtd[qtd_counter].qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
600 qtd[qtd_counter].qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
601 token = QT_TOKEN_DT(1) | QT_TOKEN_TOTALBYTES(0) |
602 QT_TOKEN_IOC(1) | QT_TOKEN_CPAGE(0) | QT_TOKEN_CERR(3) |
603 QT_TOKEN_PID(usb_pipein(pipe) ?
604 QT_TOKEN_PID_OUT : QT_TOKEN_PID_IN) |
605 QT_TOKEN_STATUS(QT_TOKEN_STATUS_ACTIVE);
606 qtd[qtd_counter].qt_token = cpu_to_hc32(token);
607 /* Update previous qTD! */
608 *tdp = cpu_to_hc32(virt_to_phys(&qtd[qtd_counter]));
609 tdp = &qtd[qtd_counter++].qt_next;
612 ctrl->qh_list.qh_link = cpu_to_hc32(virt_to_phys(qh) | QH_LINK_TYPE_QH);
615 flush_dcache_range((unsigned long)&ctrl->qh_list,
616 ALIGN_END_ADDR(struct QH, &ctrl->qh_list, 1));
617 flush_dcache_range((unsigned long)qh, ALIGN_END_ADDR(struct QH, qh, 1));
618 flush_dcache_range((unsigned long)qtd,
619 ALIGN_END_ADDR(struct qTD, qtd, qtd_count));
621 usbsts = ehci_readl(&ctrl->hcor->or_usbsts);
622 ehci_writel(&ctrl->hcor->or_usbsts, (usbsts & 0x3f));
624 ret = ehci_enable_async(ctrl);
628 /* Wait for TDs to be processed. */
630 vtd = &qtd[qtd_counter - 1];
631 timeout = USB_TIMEOUT_MS(pipe);
633 /* Invalidate dcache */
634 invalidate_dcache_range((unsigned long)&ctrl->qh_list,
635 ALIGN_END_ADDR(struct QH, &ctrl->qh_list, 1));
636 invalidate_dcache_range((unsigned long)qh,
637 ALIGN_END_ADDR(struct QH, qh, 1));
638 invalidate_dcache_range((unsigned long)qtd,
639 ALIGN_END_ADDR(struct qTD, qtd, qtd_count));
641 token = hc32_to_cpu(vtd->qt_token);
642 if (!(QT_TOKEN_GET_STATUS(token) & QT_TOKEN_STATUS_ACTIVE))
645 } while (get_timer(ts) < timeout);
646 qhtoken = hc32_to_cpu(qh->qh_overlay.qt_token);
648 ctrl->qh_list.qh_link = cpu_to_hc32(virt_to_phys(&ctrl->qh_list) | QH_LINK_TYPE_QH);
649 flush_dcache_range((unsigned long)&ctrl->qh_list,
650 ALIGN_END_ADDR(struct QH, &ctrl->qh_list, 1));
652 /* Set IAAD, poll IAA */
653 ret = ehci_iaa_cycle(ctrl);
658 * Invalidate the memory area occupied by buffer
659 * Don't try to fix the buffer alignment, if it isn't properly
660 * aligned it's upper layer's fault so let invalidate_dcache_range()
661 * vow about it. But we have to fix the length as it's actual
662 * transfer length and can be unaligned. This is potentially
663 * dangerous operation, it's responsibility of the calling
664 * code to make sure enough space is reserved.
666 if (buffer != NULL && length > 0)
667 invalidate_dcache_range((unsigned long)buffer,
668 ALIGN((unsigned long)buffer + length, ARCH_DMA_MINALIGN));
670 /* Check that the TD processing happened */
671 if (QT_TOKEN_GET_STATUS(token) & QT_TOKEN_STATUS_ACTIVE)
672 printf("EHCI timed out on TD - token=%#x\n", token);
674 ret = ehci_disable_async(ctrl);
678 if (!(QT_TOKEN_GET_STATUS(qhtoken) & QT_TOKEN_STATUS_ACTIVE)) {
679 debug("TOKEN=%#x\n", qhtoken);
680 switch (QT_TOKEN_GET_STATUS(qhtoken) &
681 ~(QT_TOKEN_STATUS_SPLITXSTATE | QT_TOKEN_STATUS_PERR)) {
683 toggle = QT_TOKEN_GET_DT(qhtoken);
684 usb_settoggle(dev, usb_pipeendpoint(pipe),
685 usb_pipeout(pipe), toggle);
688 case QT_TOKEN_STATUS_HALTED:
689 dev->status = USB_ST_STALLED;
691 case QT_TOKEN_STATUS_ACTIVE | QT_TOKEN_STATUS_DATBUFERR:
692 case QT_TOKEN_STATUS_DATBUFERR:
693 dev->status = USB_ST_BUF_ERR;
695 case QT_TOKEN_STATUS_HALTED | QT_TOKEN_STATUS_BABBLEDET:
696 case QT_TOKEN_STATUS_BABBLEDET:
697 dev->status = USB_ST_BABBLE_DET;
700 dev->status = USB_ST_CRC_ERR;
701 if (QT_TOKEN_GET_STATUS(qhtoken) & QT_TOKEN_STATUS_HALTED)
702 dev->status |= USB_ST_STALLED;
705 dev->act_len = length - QT_TOKEN_GET_TOTALBYTES(qhtoken);
708 debug("dev=%u, usbsts=%#x, p[1]=%#x, p[2]=%#x\n",
709 dev->devnum, ehci_readl(&ctrl->hcor->or_usbsts),
710 ehci_readl(&ctrl->hcor->or_portsc[0]),
711 ehci_readl(&ctrl->hcor->or_portsc[1]));
715 return (dev->status != USB_ST_NOT_PROC) ? 0 : -1;
722 static int ehci_submit_root(struct usb_device *dev, unsigned long pipe,
723 void *buffer, int length, struct devrequest *req)
730 uint32_t *status_reg;
731 int port = le16_to_cpu(req->index) & 0xff;
732 struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
736 debug("req=%u (%#x), type=%u (%#x), value=%u, index=%u\n",
737 req->request, req->request,
738 req->requesttype, req->requesttype,
739 le16_to_cpu(req->value), le16_to_cpu(req->index));
741 typeReq = req->request | req->requesttype << 8;
744 case USB_REQ_GET_STATUS | ((USB_RT_PORT | USB_DIR_IN) << 8):
745 case USB_REQ_SET_FEATURE | ((USB_DIR_OUT | USB_RT_PORT) << 8):
746 case USB_REQ_CLEAR_FEATURE | ((USB_DIR_OUT | USB_RT_PORT) << 8):
747 status_reg = ctrl->ops.get_portsc_register(ctrl, port - 1);
757 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
758 switch (le16_to_cpu(req->value) >> 8) {
760 debug("USB_DT_DEVICE request\n");
761 srcptr = &descriptor.device;
762 srclen = descriptor.device.bLength;
765 debug("USB_DT_CONFIG config\n");
766 srcptr = &descriptor.config;
767 srclen = descriptor.config.bLength +
768 descriptor.interface.bLength +
769 descriptor.endpoint.bLength;
772 debug("USB_DT_STRING config\n");
773 switch (le16_to_cpu(req->value) & 0xff) {
774 case 0: /* Language */
779 srcptr = "\16\3u\0-\0b\0o\0o\0t\0";
782 case 2: /* Product */
783 srcptr = "\52\3E\0H\0C\0I\0 "
785 "\0C\0o\0n\0t\0r\0o\0l\0l\0e\0r\0";
789 debug("unknown value DT_STRING %x\n",
790 le16_to_cpu(req->value));
795 debug("unknown value %x\n", le16_to_cpu(req->value));
799 case USB_REQ_GET_DESCRIPTOR | ((USB_DIR_IN | USB_RT_HUB) << 8):
800 switch (le16_to_cpu(req->value) >> 8) {
802 debug("USB_DT_HUB config\n");
803 srcptr = &descriptor.hub;
804 srclen = descriptor.hub.bLength;
807 debug("unknown value %x\n", le16_to_cpu(req->value));
811 case USB_REQ_SET_ADDRESS | (USB_RECIP_DEVICE << 8):
812 debug("USB_REQ_SET_ADDRESS\n");
813 ctrl->rootdev = le16_to_cpu(req->value);
815 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
816 debug("USB_REQ_SET_CONFIGURATION\n");
819 case USB_REQ_GET_STATUS | ((USB_DIR_IN | USB_RT_HUB) << 8):
820 tmpbuf[0] = 1; /* USB_STATUS_SELFPOWERED */
825 case USB_REQ_GET_STATUS | ((USB_RT_PORT | USB_DIR_IN) << 8):
826 memset(tmpbuf, 0, 4);
827 reg = ehci_readl(status_reg);
828 if (reg & EHCI_PS_CS)
829 tmpbuf[0] |= USB_PORT_STAT_CONNECTION;
830 if (reg & EHCI_PS_PE)
831 tmpbuf[0] |= USB_PORT_STAT_ENABLE;
832 if (reg & EHCI_PS_SUSP)
833 tmpbuf[0] |= USB_PORT_STAT_SUSPEND;
834 if (reg & EHCI_PS_OCA)
835 tmpbuf[0] |= USB_PORT_STAT_OVERCURRENT;
836 if (reg & EHCI_PS_PR)
837 tmpbuf[0] |= USB_PORT_STAT_RESET;
838 if (reg & EHCI_PS_PP)
839 tmpbuf[1] |= USB_PORT_STAT_POWER >> 8;
842 switch (ctrl->ops.get_port_speed(ctrl, reg)) {
846 tmpbuf[1] |= USB_PORT_STAT_LOW_SPEED >> 8;
850 tmpbuf[1] |= USB_PORT_STAT_HIGH_SPEED >> 8;
854 tmpbuf[1] |= USB_PORT_STAT_HIGH_SPEED >> 8;
857 if (reg & EHCI_PS_CSC)
858 tmpbuf[2] |= USB_PORT_STAT_C_CONNECTION;
859 if (reg & EHCI_PS_PEC)
860 tmpbuf[2] |= USB_PORT_STAT_C_ENABLE;
861 if (reg & EHCI_PS_OCC)
862 tmpbuf[2] |= USB_PORT_STAT_C_OVERCURRENT;
863 if (ctrl->portreset & (1 << port))
864 tmpbuf[2] |= USB_PORT_STAT_C_RESET;
869 case USB_REQ_SET_FEATURE | ((USB_DIR_OUT | USB_RT_PORT) << 8):
870 reg = ehci_readl(status_reg);
871 reg &= ~EHCI_PS_CLEAR;
872 switch (le16_to_cpu(req->value)) {
873 case USB_PORT_FEAT_ENABLE:
875 ehci_writel(status_reg, reg);
877 case USB_PORT_FEAT_POWER:
878 if (HCS_PPC(ehci_readl(&ctrl->hccr->cr_hcsparams))) {
880 ehci_writel(status_reg, reg);
883 case USB_PORT_FEAT_RESET:
884 if ((reg & (EHCI_PS_PE | EHCI_PS_CS)) == EHCI_PS_CS &&
886 EHCI_PS_IS_LOWSPEED(reg)) {
887 /* Low speed device, give up ownership. */
888 debug("port %d low speed --> companion\n",
891 ehci_writel(status_reg, reg);
896 /* Disable chirp for HS erratum */
897 if (ctrl->has_fsl_erratum_a005275)
898 reg |= PORTSC_FSL_PFSC;
902 ehci_writel(status_reg, reg);
904 * caller must wait, then call GetPortStatus
905 * usb 2.0 specification say 50 ms resets on
908 ctrl->ops.powerup_fixup(ctrl, status_reg, ®);
910 ehci_writel(status_reg, reg & ~EHCI_PS_PR);
912 * A host controller must terminate the reset
913 * and stabilize the state of the port within
916 ret = handshake(status_reg, EHCI_PS_PR, 0,
919 reg = ehci_readl(status_reg);
920 if ((reg & (EHCI_PS_PE | EHCI_PS_CS))
921 == EHCI_PS_CS && !ehci_is_TDI()) {
922 debug("port %d full speed --> companion\n", port - 1);
923 reg &= ~EHCI_PS_CLEAR;
925 ehci_writel(status_reg, reg);
928 ctrl->portreset |= 1 << port;
931 printf("port(%d) reset error\n",
936 case USB_PORT_FEAT_TEST:
939 reg |= ((le16_to_cpu(req->index) >> 8) & 0xf) << 16;
940 ehci_writel(status_reg, reg);
943 debug("unknown feature %x\n", le16_to_cpu(req->value));
946 /* unblock posted writes */
947 (void) ehci_readl(&ctrl->hcor->or_usbcmd);
949 case USB_REQ_CLEAR_FEATURE | ((USB_DIR_OUT | USB_RT_PORT) << 8):
950 reg = ehci_readl(status_reg);
951 reg &= ~EHCI_PS_CLEAR;
952 switch (le16_to_cpu(req->value)) {
953 case USB_PORT_FEAT_ENABLE:
956 case USB_PORT_FEAT_C_ENABLE:
959 case USB_PORT_FEAT_POWER:
960 if (HCS_PPC(ehci_readl(&ctrl->hccr->cr_hcsparams)))
963 case USB_PORT_FEAT_C_CONNECTION:
966 case USB_PORT_FEAT_OVER_CURRENT:
969 case USB_PORT_FEAT_C_RESET:
970 ctrl->portreset &= ~(1 << port);
973 debug("unknown feature %x\n", le16_to_cpu(req->value));
976 ehci_writel(status_reg, reg);
977 /* unblock posted write */
978 (void) ehci_readl(&ctrl->hcor->or_usbcmd);
981 debug("Unknown request\n");
986 len = min3(srclen, (int)le16_to_cpu(req->length), length);
987 if (srcptr != NULL && len > 0)
988 memcpy(buffer, srcptr, len);
997 debug("requesttype=%x, request=%x, value=%x, index=%x, length=%x\n",
998 req->requesttype, req->request, le16_to_cpu(req->value),
999 le16_to_cpu(req->index), le16_to_cpu(req->length));
1002 dev->status = USB_ST_STALLED;
1006 static const struct ehci_ops default_ehci_ops = {
1007 .set_usb_mode = ehci_set_usbmode,
1008 .get_port_speed = ehci_get_port_speed,
1009 .powerup_fixup = ehci_powerup_fixup,
1010 .get_portsc_register = ehci_get_portsc_register,
1013 static void ehci_setup_ops(struct ehci_ctrl *ctrl, const struct ehci_ops *ops)
1016 ctrl->ops = default_ehci_ops;
1019 if (!ctrl->ops.set_usb_mode)
1020 ctrl->ops.set_usb_mode = ehci_set_usbmode;
1021 if (!ctrl->ops.get_port_speed)
1022 ctrl->ops.get_port_speed = ehci_get_port_speed;
1023 if (!ctrl->ops.powerup_fixup)
1024 ctrl->ops.powerup_fixup = ehci_powerup_fixup;
1025 if (!ctrl->ops.get_portsc_register)
1026 ctrl->ops.get_portsc_register =
1027 ehci_get_portsc_register;
1031 #if !CONFIG_IS_ENABLED(DM_USB)
1032 void ehci_set_controller_priv(int index, void *priv, const struct ehci_ops *ops)
1034 struct ehci_ctrl *ctrl = &ehcic[index];
1037 ehci_setup_ops(ctrl, ops);
1040 void *ehci_get_controller_priv(int index)
1042 return ehcic[index].priv;
1046 static int ehci_common_init(struct ehci_ctrl *ctrl, uint tweaks)
1049 struct QH *periodic;
1054 /* Set the high address word (aka segment) for 64-bit controller */
1055 if (ehci_readl(&ctrl->hccr->cr_hccparams) & 1)
1056 ehci_writel(&ctrl->hcor->or_ctrldssegment, 0);
1058 qh_list = &ctrl->qh_list;
1060 /* Set head of reclaim list */
1061 memset(qh_list, 0, sizeof(*qh_list));
1062 qh_list->qh_link = cpu_to_hc32(virt_to_phys(qh_list) | QH_LINK_TYPE_QH);
1063 qh_list->qh_endpt1 = cpu_to_hc32(QH_ENDPT1_H(1) |
1064 QH_ENDPT1_EPS(USB_SPEED_HIGH));
1065 qh_list->qh_overlay.qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
1066 qh_list->qh_overlay.qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
1067 qh_list->qh_overlay.qt_token =
1068 cpu_to_hc32(QT_TOKEN_STATUS(QT_TOKEN_STATUS_HALTED));
1070 flush_dcache_range((unsigned long)qh_list,
1071 ALIGN_END_ADDR(struct QH, qh_list, 1));
1073 /* Set async. queue head pointer. */
1074 ehci_writel(&ctrl->hcor->or_asynclistaddr, virt_to_phys(qh_list));
1077 * Set up periodic list
1078 * Step 1: Parent QH for all periodic transfers.
1080 ctrl->periodic_schedules = 0;
1081 periodic = &ctrl->periodic_queue;
1082 memset(periodic, 0, sizeof(*periodic));
1083 periodic->qh_link = cpu_to_hc32(QH_LINK_TERMINATE);
1084 periodic->qh_overlay.qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
1085 periodic->qh_overlay.qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
1087 flush_dcache_range((unsigned long)periodic,
1088 ALIGN_END_ADDR(struct QH, periodic, 1));
1091 * Step 2: Setup frame-list: Every microframe, USB tries the same list.
1092 * In particular, device specifications on polling frequency
1093 * are disregarded. Keyboards seem to send NAK/NYet reliably
1094 * when polled with an empty buffer.
1096 * Split Transactions will be spread across microframes using
1097 * S-mask and C-mask.
1099 if (ctrl->periodic_list == NULL)
1100 ctrl->periodic_list = memalign(4096, 1024 * 4);
1102 if (!ctrl->periodic_list)
1104 for (i = 0; i < 1024; i++) {
1105 ctrl->periodic_list[i] = cpu_to_hc32((unsigned long)periodic
1109 flush_dcache_range((unsigned long)ctrl->periodic_list,
1110 ALIGN_END_ADDR(uint32_t, ctrl->periodic_list,
1113 /* Set periodic list base address */
1114 ehci_writel(&ctrl->hcor->or_periodiclistbase,
1115 (unsigned long)ctrl->periodic_list);
1117 reg = ehci_readl(&ctrl->hccr->cr_hcsparams);
1118 descriptor.hub.bNbrPorts = HCS_N_PORTS(reg);
1119 debug("Register %x NbrPorts %d\n", reg, descriptor.hub.bNbrPorts);
1120 /* Port Indicators */
1121 if (HCS_INDICATOR(reg))
1122 put_unaligned(get_unaligned(&descriptor.hub.wHubCharacteristics)
1123 | 0x80, &descriptor.hub.wHubCharacteristics);
1124 /* Port Power Control */
1126 put_unaligned(get_unaligned(&descriptor.hub.wHubCharacteristics)
1127 | 0x01, &descriptor.hub.wHubCharacteristics);
1129 /* Start the host controller. */
1130 cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
1132 * Philips, Intel, and maybe others need CMD_RUN before the
1133 * root hub will detect new devices (why?); NEC doesn't
1135 cmd &= ~(CMD_LRESET|CMD_IAAD|CMD_PSE|CMD_ASE|CMD_RESET);
1137 ehci_writel(&ctrl->hcor->or_usbcmd, cmd);
1139 if (!(tweaks & EHCI_TWEAK_NO_INIT_CF)) {
1140 /* take control over the ports */
1141 cmd = ehci_readl(&ctrl->hcor->or_configflag);
1143 ehci_writel(&ctrl->hcor->or_configflag, cmd);
1146 /* unblock posted write */
1147 cmd = ehci_readl(&ctrl->hcor->or_usbcmd);
1149 reg = HC_VERSION(ehci_readl(&ctrl->hccr->cr_capbase));
1150 printf("USB EHCI %x.%02x\n", reg >> 8, reg & 0xff);
1155 #if !CONFIG_IS_ENABLED(DM_USB)
1156 int usb_lowlevel_stop(int index)
1158 ehci_shutdown(&ehcic[index]);
1159 return ehci_hcd_stop(index);
1162 int usb_lowlevel_init(int index, enum usb_init_type init, void **controller)
1164 struct ehci_ctrl *ctrl = &ehcic[index];
1169 * Set ops to default_ehci_ops, ehci_hcd_init should call
1170 * ehci_set_controller_priv to change any of these function pointers.
1172 ctrl->ops = default_ehci_ops;
1174 rc = ehci_hcd_init(index, init, &ctrl->hccr, &ctrl->hcor);
1177 if (!ctrl->hccr || !ctrl->hcor)
1179 if (init == USB_INIT_DEVICE)
1182 /* EHCI spec section 4.1 */
1183 if (ehci_reset(ctrl))
1186 #if defined(CONFIG_EHCI_HCD_INIT_AFTER_RESET)
1187 rc = ehci_hcd_init(index, init, &ctrl->hccr, &ctrl->hcor);
1191 rc = ehci_common_init(ctrl, tweaks);
1197 *controller = &ehcic[index];
1202 static int _ehci_submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
1203 void *buffer, int length)
1206 if (usb_pipetype(pipe) != PIPE_BULK) {
1207 debug("non-bulk pipe (type=%lu)", usb_pipetype(pipe));
1210 return ehci_submit_async(dev, pipe, buffer, length, NULL);
1213 static int _ehci_submit_control_msg(struct usb_device *dev, unsigned long pipe,
1214 void *buffer, int length,
1215 struct devrequest *setup)
1217 struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
1219 if (usb_pipetype(pipe) != PIPE_CONTROL) {
1220 debug("non-control pipe (type=%lu)", usb_pipetype(pipe));
1224 if (usb_pipedevice(pipe) == ctrl->rootdev) {
1226 dev->speed = USB_SPEED_HIGH;
1227 return ehci_submit_root(dev, pipe, buffer, length, setup);
1229 return ehci_submit_async(dev, pipe, buffer, length, setup);
1241 #define NEXT_QH(qh) (struct QH *)((unsigned long)hc32_to_cpu((qh)->qh_link) & ~0x1f)
1244 enable_periodic(struct ehci_ctrl *ctrl)
1247 struct ehci_hcor *hcor = ctrl->hcor;
1250 cmd = ehci_readl(&hcor->or_usbcmd);
1252 ehci_writel(&hcor->or_usbcmd, cmd);
1254 ret = handshake((uint32_t *)&hcor->or_usbsts,
1255 STS_PSS, STS_PSS, 100 * 1000);
1257 printf("EHCI failed: timeout when enabling periodic list\n");
1265 disable_periodic(struct ehci_ctrl *ctrl)
1268 struct ehci_hcor *hcor = ctrl->hcor;
1271 cmd = ehci_readl(&hcor->or_usbcmd);
1273 ehci_writel(&hcor->or_usbcmd, cmd);
1275 ret = handshake((uint32_t *)&hcor->or_usbsts,
1276 STS_PSS, 0, 100 * 1000);
1278 printf("EHCI failed: timeout when disabling periodic list\n");
1284 static struct int_queue *_ehci_create_int_queue(struct usb_device *dev,
1285 unsigned long pipe, int queuesize, int elementsize,
1286 void *buffer, int interval)
1288 struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
1289 struct int_queue *result = NULL;
1293 * Interrupt transfers requiring several transactions are not supported
1294 * because bInterval is ignored.
1296 * Also, ehci_submit_async() relies on wMaxPacketSize being a power of 2
1297 * <= PKT_ALIGN if several qTDs are required, while the USB
1298 * specification does not constrain this for interrupt transfers. That
1299 * means that ehci_submit_async() would support interrupt transfers
1300 * requiring several transactions only as long as the transfer size does
1301 * not require more than a single qTD.
1303 if (elementsize > usb_maxpacket(dev, pipe)) {
1304 printf("%s: xfers requiring several transactions are not supported.\n",
1309 debug("Enter create_int_queue\n");
1310 if (usb_pipetype(pipe) != PIPE_INTERRUPT) {
1311 debug("non-interrupt pipe (type=%lu)", usb_pipetype(pipe));
1315 /* limit to 4 full pages worth of data -
1316 * we can safely fit them in a single TD,
1317 * no matter the alignment
1319 if (elementsize >= 16384) {
1320 debug("too large elements for interrupt transfers\n");
1324 result = malloc(sizeof(*result));
1326 debug("ehci intr queue: out of memory\n");
1329 result->elementsize = elementsize;
1330 result->pipe = pipe;
1331 result->first = memalign(USB_DMA_MINALIGN,
1332 sizeof(struct QH) * queuesize);
1333 if (!result->first) {
1334 debug("ehci intr queue: out of memory\n");
1337 result->current = result->first;
1338 result->last = result->first + queuesize - 1;
1339 result->tds = memalign(USB_DMA_MINALIGN,
1340 sizeof(struct qTD) * queuesize);
1342 debug("ehci intr queue: out of memory\n");
1345 memset(result->first, 0, sizeof(struct QH) * queuesize);
1346 memset(result->tds, 0, sizeof(struct qTD) * queuesize);
1348 toggle = usb_gettoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
1350 for (i = 0; i < queuesize; i++) {
1351 struct QH *qh = result->first + i;
1352 struct qTD *td = result->tds + i;
1353 void **buf = &qh->buffer;
1355 qh->qh_link = cpu_to_hc32((unsigned long)(qh+1) | QH_LINK_TYPE_QH);
1356 if (i == queuesize - 1)
1357 qh->qh_link = cpu_to_hc32(QH_LINK_TERMINATE);
1359 qh->qh_overlay.qt_next = cpu_to_hc32((unsigned long)td);
1360 qh->qh_overlay.qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
1362 cpu_to_hc32((0 << 28) | /* No NAK reload (ehci 4.9) */
1363 (usb_maxpacket(dev, pipe) << 16) | /* MPS */
1365 QH_ENDPT1_EPS(ehci_encode_speed(dev->speed)) |
1366 (usb_pipeendpoint(pipe) << 8) | /* Endpoint Number */
1367 (usb_pipedevice(pipe) << 0));
1368 qh->qh_endpt2 = cpu_to_hc32((1 << 30) | /* 1 Tx per mframe */
1369 (1 << 0)); /* S-mask: microframe 0 */
1370 if (dev->speed == USB_SPEED_LOW ||
1371 dev->speed == USB_SPEED_FULL) {
1372 /* C-mask: microframes 2-4 */
1373 qh->qh_endpt2 |= cpu_to_hc32((0x1c << 8));
1375 ehci_update_endpt2_dev_n_port(dev, qh);
1377 td->qt_next = cpu_to_hc32(QT_NEXT_TERMINATE);
1378 td->qt_altnext = cpu_to_hc32(QT_NEXT_TERMINATE);
1379 debug("communication direction is '%s'\n",
1380 usb_pipein(pipe) ? "in" : "out");
1381 td->qt_token = cpu_to_hc32(
1382 QT_TOKEN_DT(toggle) |
1383 (elementsize << 16) |
1384 ((usb_pipein(pipe) ? 1 : 0) << 8) | /* IN/OUT token */
1387 cpu_to_hc32((unsigned long)buffer + i * elementsize);
1389 cpu_to_hc32((td->qt_buffer[0] + 0x1000) & ~0xfff);
1391 cpu_to_hc32((td->qt_buffer[0] + 0x2000) & ~0xfff);
1393 cpu_to_hc32((td->qt_buffer[0] + 0x3000) & ~0xfff);
1395 cpu_to_hc32((td->qt_buffer[0] + 0x4000) & ~0xfff);
1397 *buf = buffer + i * elementsize;
1401 flush_dcache_range((unsigned long)buffer,
1402 ALIGN_END_ADDR(char, buffer,
1403 queuesize * elementsize));
1404 flush_dcache_range((unsigned long)result->first,
1405 ALIGN_END_ADDR(struct QH, result->first,
1407 flush_dcache_range((unsigned long)result->tds,
1408 ALIGN_END_ADDR(struct qTD, result->tds,
1411 if (ctrl->periodic_schedules > 0) {
1412 if (disable_periodic(ctrl) < 0) {
1413 debug("FATAL: periodic should never fail, but did");
1418 /* hook up to periodic list */
1419 struct QH *list = &ctrl->periodic_queue;
1420 result->last->qh_link = list->qh_link;
1421 list->qh_link = cpu_to_hc32((unsigned long)result->first | QH_LINK_TYPE_QH);
1423 flush_dcache_range((unsigned long)result->last,
1424 ALIGN_END_ADDR(struct QH, result->last, 1));
1425 flush_dcache_range((unsigned long)list,
1426 ALIGN_END_ADDR(struct QH, list, 1));
1428 if (enable_periodic(ctrl) < 0) {
1429 debug("FATAL: periodic should never fail, but did");
1432 ctrl->periodic_schedules++;
1434 debug("Exit create_int_queue\n");
1439 free(result->first);
1445 static void *_ehci_poll_int_queue(struct usb_device *dev,
1446 struct int_queue *queue)
1448 struct QH *cur = queue->current;
1450 uint32_t token, toggle;
1451 unsigned long pipe = queue->pipe;
1453 /* depleted queue */
1455 debug("Exit poll_int_queue with completed queue\n");
1459 cur_td = &queue->tds[queue->current - queue->first];
1460 invalidate_dcache_range((unsigned long)cur_td,
1461 ALIGN_END_ADDR(struct qTD, cur_td, 1));
1462 token = hc32_to_cpu(cur_td->qt_token);
1463 if (QT_TOKEN_GET_STATUS(token) & QT_TOKEN_STATUS_ACTIVE) {
1464 debug("Exit poll_int_queue with no completed intr transfer. token is %x\n", token);
1468 toggle = QT_TOKEN_GET_DT(token);
1469 usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), toggle);
1471 if (!(cur->qh_link & QH_LINK_TERMINATE))
1474 queue->current = NULL;
1476 invalidate_dcache_range((unsigned long)cur->buffer,
1477 ALIGN_END_ADDR(char, cur->buffer,
1478 queue->elementsize));
1480 debug("Exit poll_int_queue with completed intr transfer. token is %x at %p (first at %p)\n",
1481 token, cur, queue->first);
1485 /* Do not free buffers associated with QHs, they're owned by someone else */
1486 static int _ehci_destroy_int_queue(struct usb_device *dev,
1487 struct int_queue *queue)
1489 struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
1491 unsigned long timeout;
1493 if (disable_periodic(ctrl) < 0) {
1494 debug("FATAL: periodic should never fail, but did");
1497 ctrl->periodic_schedules--;
1499 struct QH *cur = &ctrl->periodic_queue;
1500 timeout = get_timer(0) + 500; /* abort after 500ms */
1501 while (!(cur->qh_link & cpu_to_hc32(QH_LINK_TERMINATE))) {
1502 debug("considering %p, with qh_link %x\n", cur, cur->qh_link);
1503 if (NEXT_QH(cur) == queue->first) {
1504 debug("found candidate. removing from chain\n");
1505 cur->qh_link = queue->last->qh_link;
1506 flush_dcache_range((unsigned long)cur,
1507 ALIGN_END_ADDR(struct QH, cur, 1));
1512 if (get_timer(0) > timeout) {
1513 printf("Timeout destroying interrupt endpoint queue\n");
1519 if (ctrl->periodic_schedules > 0) {
1520 result = enable_periodic(ctrl);
1522 debug("FATAL: periodic should never fail, but did");
1533 static int _ehci_submit_int_msg(struct usb_device *dev, unsigned long pipe,
1534 void *buffer, int length, int interval,
1538 struct int_queue *queue;
1539 unsigned long timeout;
1540 int result = 0, ret;
1542 debug("dev=%p, pipe=%lu, buffer=%p, length=%d, interval=%d",
1543 dev, pipe, buffer, length, interval);
1545 queue = _ehci_create_int_queue(dev, pipe, 1, length, buffer, interval);
1549 timeout = get_timer(0) + USB_TIMEOUT_MS(pipe);
1550 while ((backbuffer = _ehci_poll_int_queue(dev, queue)) == NULL)
1551 if (get_timer(0) > timeout) {
1552 printf("Timeout poll on interrupt endpoint\n");
1553 result = -ETIMEDOUT;
1557 if (backbuffer != buffer) {
1558 debug("got wrong buffer back (%p instead of %p)\n",
1559 backbuffer, buffer);
1563 ret = _ehci_destroy_int_queue(dev, queue);
1567 /* everything worked out fine */
1571 static int _ehci_lock_async(struct ehci_ctrl *ctrl, int lock)
1573 ctrl->async_locked = lock;
1578 return ehci_disable_async(ctrl);
1581 #if !CONFIG_IS_ENABLED(DM_USB)
1582 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
1583 void *buffer, int length)
1585 return _ehci_submit_bulk_msg(dev, pipe, buffer, length);
1588 int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
1589 int length, struct devrequest *setup)
1591 return _ehci_submit_control_msg(dev, pipe, buffer, length, setup);
1594 int submit_int_msg(struct usb_device *dev, unsigned long pipe,
1595 void *buffer, int length, int interval, bool nonblock)
1597 return _ehci_submit_int_msg(dev, pipe, buffer, length, interval,
1601 struct int_queue *create_int_queue(struct usb_device *dev,
1602 unsigned long pipe, int queuesize, int elementsize,
1603 void *buffer, int interval)
1605 return _ehci_create_int_queue(dev, pipe, queuesize, elementsize,
1609 void *poll_int_queue(struct usb_device *dev, struct int_queue *queue)
1611 return _ehci_poll_int_queue(dev, queue);
1614 int destroy_int_queue(struct usb_device *dev, struct int_queue *queue)
1616 return _ehci_destroy_int_queue(dev, queue);
1619 int usb_lock_async(struct usb_device *dev, int lock)
1621 struct ehci_ctrl *ctrl = ehci_get_ctrl(dev);
1623 return _ehci_lock_async(ctrl, lock);
1627 #if CONFIG_IS_ENABLED(DM_USB)
1628 static int ehci_submit_control_msg(struct udevice *dev, struct usb_device *udev,
1629 unsigned long pipe, void *buffer, int length,
1630 struct devrequest *setup)
1632 debug("%s: dev='%s', udev=%p, udev->dev='%s', portnr=%d\n", __func__,
1633 dev->name, udev, udev->dev->name, udev->portnr);
1635 return _ehci_submit_control_msg(udev, pipe, buffer, length, setup);
1638 static int ehci_submit_bulk_msg(struct udevice *dev, struct usb_device *udev,
1639 unsigned long pipe, void *buffer, int length)
1641 debug("%s: dev='%s', udev=%p\n", __func__, dev->name, udev);
1642 return _ehci_submit_bulk_msg(udev, pipe, buffer, length);
1645 static int ehci_submit_int_msg(struct udevice *dev, struct usb_device *udev,
1646 unsigned long pipe, void *buffer, int length,
1647 int interval, bool nonblock)
1649 debug("%s: dev='%s', udev=%p\n", __func__, dev->name, udev);
1650 return _ehci_submit_int_msg(udev, pipe, buffer, length, interval,
1654 static struct int_queue *ehci_create_int_queue(struct udevice *dev,
1655 struct usb_device *udev, unsigned long pipe, int queuesize,
1656 int elementsize, void *buffer, int interval)
1658 debug("%s: dev='%s', udev=%p\n", __func__, dev->name, udev);
1659 return _ehci_create_int_queue(udev, pipe, queuesize, elementsize,
1663 static void *ehci_poll_int_queue(struct udevice *dev, struct usb_device *udev,
1664 struct int_queue *queue)
1666 debug("%s: dev='%s', udev=%p\n", __func__, dev->name, udev);
1667 return _ehci_poll_int_queue(udev, queue);
1670 static int ehci_destroy_int_queue(struct udevice *dev, struct usb_device *udev,
1671 struct int_queue *queue)
1673 debug("%s: dev='%s', udev=%p\n", __func__, dev->name, udev);
1674 return _ehci_destroy_int_queue(udev, queue);
1677 static int ehci_get_max_xfer_size(struct udevice *dev, size_t *size)
1680 * EHCD can handle any transfer length as long as there is enough
1681 * free heap space left, hence set the theoretical max number here.
1688 static int ehci_lock_async(struct udevice *dev, int lock)
1690 struct ehci_ctrl *ctrl = dev_get_priv(dev);
1692 return _ehci_lock_async(ctrl, lock);
1695 int ehci_register(struct udevice *dev, struct ehci_hccr *hccr,
1696 struct ehci_hcor *hcor, const struct ehci_ops *ops,
1697 uint tweaks, enum usb_init_type init)
1699 struct usb_bus_priv *priv = dev_get_uclass_priv(dev);
1700 struct ehci_ctrl *ctrl = dev_get_priv(dev);
1703 debug("%s: dev='%s', ctrl=%p, hccr=%p, hcor=%p, init=%d\n", __func__,
1704 dev->name, ctrl, hccr, hcor, init);
1706 if (!ctrl || !hccr || !hcor)
1709 priv->desc_before_addr = true;
1711 ehci_setup_ops(ctrl, ops);
1717 if (ctrl->init == USB_INIT_DEVICE)
1720 ret = ehci_reset(ctrl);
1724 if (ctrl->ops.init_after_reset) {
1725 ret = ctrl->ops.init_after_reset(ctrl);
1730 ret = ehci_common_init(ctrl, tweaks);
1737 debug("%s: failed, ret=%d\n", __func__, ret);
1741 int ehci_deregister(struct udevice *dev)
1743 struct ehci_ctrl *ctrl = dev_get_priv(dev);
1745 if (ctrl->init == USB_INIT_DEVICE)
1748 ehci_shutdown(ctrl);
1753 struct dm_usb_ops ehci_usb_ops = {
1754 .control = ehci_submit_control_msg,
1755 .bulk = ehci_submit_bulk_msg,
1756 .interrupt = ehci_submit_int_msg,
1757 .create_int_queue = ehci_create_int_queue,
1758 .poll_int_queue = ehci_poll_int_queue,
1759 .destroy_int_queue = ehci_destroy_int_queue,
1760 .get_max_xfer_size = ehci_get_max_xfer_size,
1761 .lock_async = ehci_lock_async,