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