]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - drivers/usb/gadget/udc/goku_udc.c
USB: add SPDX identifiers to all remaining files in drivers/usb/
[mirror_ubuntu-jammy-kernel.git] / drivers / usb / gadget / udc / goku_udc.c
CommitLineData
5fd54ace 1// SPDX-License-Identifier: GPL-2.0
1da177e4
LT
2/*
3 * Toshiba TC86C001 ("Goku-S") USB Device Controller driver
4 *
5 * Copyright (C) 2000-2002 Lineo
6 * by Stuart Lynne, Tom Rushworth, and Bruce Balden
7 * Copyright (C) 2002 Toshiba Corporation
8 * Copyright (C) 2003 MontaVista Software (source@mvista.com)
9 *
10 * This file is licensed under the terms of the GNU General Public
11 * License version 2. This program is licensed "as is" without any
12 * warranty of any kind, whether express or implied.
13 */
14
15/*
16 * This device has ep0 and three semi-configurable bulk/interrupt endpoints.
17 *
18 * - Endpoint numbering is fixed: ep{1,2,3}-bulk
19 * - Gadget drivers can choose ep maxpacket (8/16/32/64)
20 * - Gadget drivers can choose direction (IN, OUT)
21 * - DMA works with ep1 (OUT transfers) and ep2 (IN transfers).
22 */
23
1da177e4
LT
24// #define VERBOSE /* extra debug messages (success too) */
25// #define USB_TRACE /* packet-level success messages */
26
1da177e4
LT
27#include <linux/kernel.h>
28#include <linux/module.h>
29#include <linux/pci.h>
30#include <linux/delay.h>
31#include <linux/ioport.h>
1da177e4 32#include <linux/slab.h>
1da177e4 33#include <linux/errno.h>
1da177e4
LT
34#include <linux/timer.h>
35#include <linux/list.h>
36#include <linux/interrupt.h>
37#include <linux/proc_fs.h>
96c7a22e 38#include <linux/seq_file.h>
1da177e4 39#include <linux/device.h>
5f848137 40#include <linux/usb/ch9.h>
9454a57a 41#include <linux/usb/gadget.h>
268bb0ce 42#include <linux/prefetch.h>
1da177e4
LT
43
44#include <asm/byteorder.h>
45#include <asm/io.h>
46#include <asm/irq.h>
1da177e4
LT
47#include <asm/unaligned.h>
48
49
50#include "goku_udc.h"
51
52#define DRIVER_DESC "TC86C001 USB Device Controller"
53#define DRIVER_VERSION "30-Oct 2003"
54
1da177e4
LT
55static const char driver_name [] = "goku_udc";
56static const char driver_desc [] = DRIVER_DESC;
57
58MODULE_AUTHOR("source@mvista.com");
59MODULE_DESCRIPTION(DRIVER_DESC);
60MODULE_LICENSE("GPL");
61
62
63/*
64 * IN dma behaves ok under testing, though the IN-dma abort paths don't
65 * seem to behave quite as expected. Used by default.
66 *
67 * OUT dma documents design problems handling the common "short packet"
988199fe 68 * transfer termination policy; it couldn't be enabled by default, even
1da177e4
LT
69 * if the OUT-dma abort problems had a resolution.
70 */
71static unsigned use_dma = 1;
72
73#if 0
74//#include <linux/moduleparam.h>
75/* "modprobe goku_udc use_dma=1" etc
76 * 0 to disable dma
77 * 1 to use IN dma only (normal operation)
78 * 2 to use IN and OUT dma
79 */
80module_param(use_dma, uint, S_IRUGO);
81#endif
82
83/*-------------------------------------------------------------------------*/
84
85static void nuke(struct goku_ep *, int status);
86
87static inline void
88command(struct goku_udc_regs __iomem *regs, int command, unsigned epnum)
89{
90 writel(COMMAND_EP(epnum) | command, &regs->Command);
91 udelay(300);
92}
93
94static int
95goku_ep_enable(struct usb_ep *_ep, const struct usb_endpoint_descriptor *desc)
96{
97 struct goku_udc *dev;
98 struct goku_ep *ep;
99 u32 mode;
100 u16 max;
101 unsigned long flags;
102
103 ep = container_of(_ep, struct goku_ep, ep);
aedaa44d 104 if (!_ep || !desc
1da177e4
LT
105 || desc->bDescriptorType != USB_DT_ENDPOINT)
106 return -EINVAL;
107 dev = ep->dev;
108 if (ep == &dev->ep[0])
109 return -EINVAL;
110 if (!dev->driver || dev->gadget.speed == USB_SPEED_UNKNOWN)
111 return -ESHUTDOWN;
9ab15651 112 if (ep->num != usb_endpoint_num(desc))
1da177e4
LT
113 return -EINVAL;
114
9ab15651 115 switch (usb_endpoint_type(desc)) {
1da177e4
LT
116 case USB_ENDPOINT_XFER_BULK:
117 case USB_ENDPOINT_XFER_INT:
118 break;
119 default:
120 return -EINVAL;
121 }
122
123 if ((readl(ep->reg_status) & EPxSTATUS_EP_MASK)
124 != EPxSTATUS_EP_INVALID)
125 return -EBUSY;
126
127 /* enabling the no-toggle interrupt mode would need an api hook */
128 mode = 0;
a5abdeaf 129 max = get_unaligned_le16(&desc->wMaxPacketSize);
1da177e4 130 switch (max) {
457b16d4
GS
131 case 64:
132 mode++; /* fall through */
133 case 32:
134 mode++; /* fall through */
135 case 16:
136 mode++; /* fall through */
137 case 8:
138 mode <<= 3;
139 break;
1da177e4
LT
140 default:
141 return -EINVAL;
142 }
143 mode |= 2 << 1; /* bulk, or intr-with-toggle */
144
145 /* ep1/ep2 dma direction is chosen early; it works in the other
146 * direction, with pio. be cautious with out-dma.
147 */
9ab15651 148 ep->is_in = usb_endpoint_dir_in(desc);
1da177e4
LT
149 if (ep->is_in) {
150 mode |= 1;
151 ep->dma = (use_dma != 0) && (ep->num == UDC_MSTRD_ENDPOINT);
152 } else {
153 ep->dma = (use_dma == 2) && (ep->num == UDC_MSTWR_ENDPOINT);
154 if (ep->dma)
155 DBG(dev, "%s out-dma hides short packets\n",
156 ep->ep.name);
157 }
158
159 spin_lock_irqsave(&ep->dev->lock, flags);
160
161 /* ep1 and ep2 can do double buffering and/or dma */
162 if (ep->num < 3) {
163 struct goku_udc_regs __iomem *regs = ep->dev->regs;
164 u32 tmp;
165
166 /* double buffer except (for now) with pio in */
167 tmp = ((ep->dma || !ep->is_in)
168 ? 0x10 /* double buffered */
169 : 0x11 /* single buffer */
170 ) << ep->num;
171 tmp |= readl(&regs->EPxSingle);
172 writel(tmp, &regs->EPxSingle);
173
174 tmp = (ep->dma ? 0x10/*dma*/ : 0x11/*pio*/) << ep->num;
175 tmp |= readl(&regs->EPxBCS);
176 writel(tmp, &regs->EPxBCS);
177 }
178 writel(mode, ep->reg_mode);
179 command(ep->dev->regs, COMMAND_RESET, ep->num);
180 ep->ep.maxpacket = max;
181 ep->stopped = 0;
db79d981 182 ep->ep.desc = desc;
1da177e4
LT
183 spin_unlock_irqrestore(&ep->dev->lock, flags);
184
185 DBG(dev, "enable %s %s %s maxpacket %u\n", ep->ep.name,
186 ep->is_in ? "IN" : "OUT",
187 ep->dma ? "dma" : "pio",
188 max);
189
190 return 0;
191}
192
193static void ep_reset(struct goku_udc_regs __iomem *regs, struct goku_ep *ep)
194{
195 struct goku_udc *dev = ep->dev;
196
197 if (regs) {
198 command(regs, COMMAND_INVALID, ep->num);
199 if (ep->num) {
200 if (ep->num == UDC_MSTWR_ENDPOINT)
201 dev->int_enable &= ~(INT_MSTWREND
202 |INT_MSTWRTMOUT);
203 else if (ep->num == UDC_MSTRD_ENDPOINT)
204 dev->int_enable &= ~INT_MSTRDEND;
205 dev->int_enable &= ~INT_EPxDATASET (ep->num);
206 } else
207 dev->int_enable &= ~INT_EP0;
208 writel(dev->int_enable, &regs->int_enable);
209 readl(&regs->int_enable);
210 if (ep->num < 3) {
211 struct goku_udc_regs __iomem *r = ep->dev->regs;
212 u32 tmp;
213
214 tmp = readl(&r->EPxSingle);
215 tmp &= ~(0x11 << ep->num);
216 writel(tmp, &r->EPxSingle);
217
218 tmp = readl(&r->EPxBCS);
219 tmp &= ~(0x11 << ep->num);
220 writel(tmp, &r->EPxBCS);
221 }
222 /* reset dma in case we're still using it */
223 if (ep->dma) {
224 u32 master;
225
226 master = readl(&regs->dma_master) & MST_RW_BITS;
227 if (ep->num == UDC_MSTWR_ENDPOINT) {
228 master &= ~MST_W_BITS;
229 master |= MST_WR_RESET;
230 } else {
231 master &= ~MST_R_BITS;
232 master |= MST_RD_RESET;
233 }
234 writel(master, &regs->dma_master);
235 }
236 }
237
e117e742 238 usb_ep_set_maxpacket_limit(&ep->ep, MAX_FIFO_SIZE);
f9c56cdd 239 ep->ep.desc = NULL;
1da177e4
LT
240 ep->stopped = 1;
241 ep->irqs = 0;
242 ep->dma = 0;
243}
244
245static int goku_ep_disable(struct usb_ep *_ep)
246{
247 struct goku_ep *ep;
248 struct goku_udc *dev;
249 unsigned long flags;
250
251 ep = container_of(_ep, struct goku_ep, ep);
db79d981 252 if (!_ep || !ep->ep.desc)
1da177e4
LT
253 return -ENODEV;
254 dev = ep->dev;
255 if (dev->ep0state == EP0_SUSPEND)
256 return -EBUSY;
257
258 VDBG(dev, "disable %s\n", _ep->name);
259
260 spin_lock_irqsave(&dev->lock, flags);
261 nuke(ep, -ESHUTDOWN);
262 ep_reset(dev->regs, ep);
263 spin_unlock_irqrestore(&dev->lock, flags);
264
265 return 0;
266}
267
268/*-------------------------------------------------------------------------*/
269
270static struct usb_request *
55016f10 271goku_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
1da177e4
LT
272{
273 struct goku_request *req;
274
275 if (!_ep)
276 return NULL;
7039f422 277 req = kzalloc(sizeof *req, gfp_flags);
1da177e4
LT
278 if (!req)
279 return NULL;
280
1da177e4
LT
281 INIT_LIST_HEAD(&req->queue);
282 return &req->req;
283}
284
285static void
286goku_free_request(struct usb_ep *_ep, struct usb_request *_req)
287{
288 struct goku_request *req;
289
290 if (!_ep || !_req)
291 return;
292
293 req = container_of(_req, struct goku_request, req);
294 WARN_ON(!list_empty(&req->queue));
295 kfree(req);
296}
297
298/*-------------------------------------------------------------------------*/
299
1da177e4
LT
300static void
301done(struct goku_ep *ep, struct goku_request *req, int status)
302{
303 struct goku_udc *dev;
304 unsigned stopped = ep->stopped;
305
306 list_del_init(&req->queue);
307
308 if (likely(req->req.status == -EINPROGRESS))
309 req->req.status = status;
310 else
311 status = req->req.status;
312
313 dev = ep->dev;
6440093f
FB
314
315 if (ep->dma)
316 usb_gadget_unmap_request(&dev->gadget, &req->req, ep->is_in);
1da177e4
LT
317
318#ifndef USB_TRACE
319 if (status && status != -ESHUTDOWN)
320#endif
321 VDBG(dev, "complete %s req %p stat %d len %u/%u\n",
322 ep->ep.name, &req->req, status,
323 req->req.actual, req->req.length);
324
325 /* don't modify queue heads during completion callback */
326 ep->stopped = 1;
327 spin_unlock(&dev->lock);
304f7e5e 328 usb_gadget_giveback_request(&ep->ep, &req->req);
1da177e4
LT
329 spin_lock(&dev->lock);
330 ep->stopped = stopped;
331}
332
333/*-------------------------------------------------------------------------*/
334
335static inline int
336write_packet(u32 __iomem *fifo, u8 *buf, struct goku_request *req, unsigned max)
337{
338 unsigned length, count;
339
340 length = min(req->req.length - req->req.actual, max);
341 req->req.actual += length;
342
343 count = length;
344 while (likely(count--))
345 writel(*buf++, fifo);
346 return length;
347}
348
349// return: 0 = still running, 1 = completed, negative = errno
350static int write_fifo(struct goku_ep *ep, struct goku_request *req)
351{
352 struct goku_udc *dev = ep->dev;
353 u32 tmp;
354 u8 *buf;
355 unsigned count;
356 int is_last;
357
358 tmp = readl(&dev->regs->DataSet);
359 buf = req->req.buf + req->req.actual;
360 prefetch(buf);
361
362 dev = ep->dev;
363 if (unlikely(ep->num == 0 && dev->ep0state != EP0_IN))
364 return -EL2HLT;
365
366 /* NOTE: just single-buffered PIO-IN for now. */
367 if (unlikely((tmp & DATASET_A(ep->num)) != 0))
368 return 0;
369
370 /* clear our "packet available" irq */
371 if (ep->num != 0)
372 writel(~INT_EPxDATASET(ep->num), &dev->regs->int_status);
373
374 count = write_packet(ep->reg_fifo, buf, req, ep->ep.maxpacket);
375
376 /* last packet often short (sometimes a zlp, especially on ep0) */
377 if (unlikely(count != ep->ep.maxpacket)) {
378 writel(~(1<<ep->num), &dev->regs->EOP);
379 if (ep->num == 0) {
380 dev->ep[0].stopped = 1;
381 dev->ep0state = EP0_STATUS;
382 }
383 is_last = 1;
384 } else {
385 if (likely(req->req.length != req->req.actual)
386 || req->req.zero)
387 is_last = 0;
388 else
389 is_last = 1;
390 }
391#if 0 /* printk seemed to trash is_last...*/
392//#ifdef USB_TRACE
393 VDBG(dev, "wrote %s %u bytes%s IN %u left %p\n",
394 ep->ep.name, count, is_last ? "/last" : "",
395 req->req.length - req->req.actual, req);
396#endif
397
398 /* requests complete when all IN data is in the FIFO,
399 * or sometimes later, if a zlp was needed.
400 */
401 if (is_last) {
402 done(ep, req, 0);
403 return 1;
404 }
405
406 return 0;
407}
408
409static int read_fifo(struct goku_ep *ep, struct goku_request *req)
410{
411 struct goku_udc_regs __iomem *regs;
412 u32 size, set;
413 u8 *buf;
414 unsigned bufferspace, is_short, dbuff;
415
416 regs = ep->dev->regs;
417top:
418 buf = req->req.buf + req->req.actual;
419 prefetchw(buf);
420
421 if (unlikely(ep->num == 0 && ep->dev->ep0state != EP0_OUT))
422 return -EL2HLT;
423
424 dbuff = (ep->num == 1 || ep->num == 2);
425 do {
426 /* ack dataset irq matching the status we'll handle */
427 if (ep->num != 0)
428 writel(~INT_EPxDATASET(ep->num), &regs->int_status);
429
430 set = readl(&regs->DataSet) & DATASET_AB(ep->num);
431 size = readl(&regs->EPxSizeLA[ep->num]);
432 bufferspace = req->req.length - req->req.actual;
433
434 /* usually do nothing without an OUT packet */
435 if (likely(ep->num != 0 || bufferspace != 0)) {
436 if (unlikely(set == 0))
437 break;
438 /* use ep1/ep2 double-buffering for OUT */
439 if (!(size & PACKET_ACTIVE))
440 size = readl(&regs->EPxSizeLB[ep->num]);
2d70c99b 441 if (!(size & PACKET_ACTIVE)) /* "can't happen" */
1da177e4
LT
442 break;
443 size &= DATASIZE; /* EPxSizeH == 0 */
444
445 /* ep0out no-out-data case for set_config, etc */
446 } else
447 size = 0;
448
449 /* read all bytes from this packet */
450 req->req.actual += size;
451 is_short = (size < ep->ep.maxpacket);
452#ifdef USB_TRACE
453 VDBG(ep->dev, "read %s %u bytes%s OUT req %p %u/%u\n",
454 ep->ep.name, size, is_short ? "/S" : "",
455 req, req->req.actual, req->req.length);
456#endif
457 while (likely(size-- != 0)) {
458 u8 byte = (u8) readl(ep->reg_fifo);
459
460 if (unlikely(bufferspace == 0)) {
461 /* this happens when the driver's buffer
462 * is smaller than what the host sent.
463 * discard the extra data in this packet.
464 */
465 if (req->req.status != -EOVERFLOW)
466 DBG(ep->dev, "%s overflow %u\n",
467 ep->ep.name, size);
468 req->req.status = -EOVERFLOW;
469 } else {
470 *buf++ = byte;
471 bufferspace--;
472 }
473 }
474
475 /* completion */
476 if (unlikely(is_short || req->req.actual == req->req.length)) {
477 if (unlikely(ep->num == 0)) {
478 /* non-control endpoints now usable? */
479 if (ep->dev->req_config)
480 writel(ep->dev->configured
481 ? USBSTATE_CONFIGURED
482 : 0,
483 &regs->UsbState);
484 /* ep0out status stage */
485 writel(~(1<<0), &regs->EOP);
486 ep->stopped = 1;
487 ep->dev->ep0state = EP0_STATUS;
488 }
489 done(ep, req, 0);
490
491 /* empty the second buffer asap */
492 if (dbuff && !list_empty(&ep->queue)) {
493 req = list_entry(ep->queue.next,
494 struct goku_request, queue);
495 goto top;
496 }
497 return 1;
498 }
499 } while (dbuff);
500 return 0;
501}
502
503static inline void
504pio_irq_enable(struct goku_udc *dev,
505 struct goku_udc_regs __iomem *regs, int epnum)
506{
507 dev->int_enable |= INT_EPxDATASET (epnum);
508 writel(dev->int_enable, &regs->int_enable);
509 /* write may still be posted */
510}
511
512static inline void
513pio_irq_disable(struct goku_udc *dev,
514 struct goku_udc_regs __iomem *regs, int epnum)
515{
516 dev->int_enable &= ~INT_EPxDATASET (epnum);
517 writel(dev->int_enable, &regs->int_enable);
518 /* write may still be posted */
519}
520
521static inline void
522pio_advance(struct goku_ep *ep)
523{
524 struct goku_request *req;
525
526 if (unlikely(list_empty (&ep->queue)))
527 return;
528 req = list_entry(ep->queue.next, struct goku_request, queue);
529 (ep->is_in ? write_fifo : read_fifo)(ep, req);
530}
531
532
533/*-------------------------------------------------------------------------*/
534
535// return: 0 = q running, 1 = q stopped, negative = errno
536static int start_dma(struct goku_ep *ep, struct goku_request *req)
537{
538 struct goku_udc_regs __iomem *regs = ep->dev->regs;
539 u32 master;
540 u32 start = req->req.dma;
541 u32 end = start + req->req.length - 1;
542
543 master = readl(&regs->dma_master) & MST_RW_BITS;
544
545 /* re-init the bits affecting IN dma; careful with zlps */
546 if (likely(ep->is_in)) {
547 if (unlikely(master & MST_RD_ENA)) {
548 DBG (ep->dev, "start, IN active dma %03x!!\n",
549 master);
550// return -EL2HLT;
551 }
552 writel(end, &regs->in_dma_end);
553 writel(start, &regs->in_dma_start);
554
555 master &= ~MST_R_BITS;
556 if (unlikely(req->req.length == 0))
557 master = MST_RD_ENA | MST_RD_EOPB;
558 else if ((req->req.length % ep->ep.maxpacket) != 0
559 || req->req.zero)
560 master = MST_RD_ENA | MST_EOPB_ENA;
561 else
562 master = MST_RD_ENA | MST_EOPB_DIS;
563
564 ep->dev->int_enable |= INT_MSTRDEND;
565
566 /* Goku DMA-OUT merges short packets, which plays poorly with
567 * protocols where short packets mark the transfer boundaries.
568 * The chip supports a nonstandard policy with INT_MSTWRTMOUT,
569 * ending transfers after 3 SOFs; we don't turn it on.
570 */
571 } else {
572 if (unlikely(master & MST_WR_ENA)) {
573 DBG (ep->dev, "start, OUT active dma %03x!!\n",
574 master);
575// return -EL2HLT;
576 }
577 writel(end, &regs->out_dma_end);
578 writel(start, &regs->out_dma_start);
579
580 master &= ~MST_W_BITS;
581 master |= MST_WR_ENA | MST_TIMEOUT_DIS;
582
583 ep->dev->int_enable |= INT_MSTWREND|INT_MSTWRTMOUT;
584 }
585
586 writel(master, &regs->dma_master);
587 writel(ep->dev->int_enable, &regs->int_enable);
588 return 0;
589}
590
591static void dma_advance(struct goku_udc *dev, struct goku_ep *ep)
592{
593 struct goku_request *req;
594 struct goku_udc_regs __iomem *regs = ep->dev->regs;
595 u32 master;
596
597 master = readl(&regs->dma_master);
598
599 if (unlikely(list_empty(&ep->queue))) {
600stop:
601 if (ep->is_in)
602 dev->int_enable &= ~INT_MSTRDEND;
603 else
604 dev->int_enable &= ~(INT_MSTWREND|INT_MSTWRTMOUT);
605 writel(dev->int_enable, &regs->int_enable);
606 return;
607 }
608 req = list_entry(ep->queue.next, struct goku_request, queue);
609
610 /* normal hw dma completion (not abort) */
611 if (likely(ep->is_in)) {
612 if (unlikely(master & MST_RD_ENA))
613 return;
614 req->req.actual = readl(&regs->in_dma_current);
615 } else {
616 if (unlikely(master & MST_WR_ENA))
617 return;
618
619 /* hardware merges short packets, and also hides packet
620 * overruns. a partial packet MAY be in the fifo here.
621 */
622 req->req.actual = readl(&regs->out_dma_current);
623 }
624 req->req.actual -= req->req.dma;
625 req->req.actual++;
626
627#ifdef USB_TRACE
628 VDBG(dev, "done %s %s dma, %u/%u bytes, req %p\n",
629 ep->ep.name, ep->is_in ? "IN" : "OUT",
630 req->req.actual, req->req.length, req);
631#endif
632 done(ep, req, 0);
633 if (list_empty(&ep->queue))
634 goto stop;
635 req = list_entry(ep->queue.next, struct goku_request, queue);
636 (void) start_dma(ep, req);
637}
638
639static void abort_dma(struct goku_ep *ep, int status)
640{
641 struct goku_udc_regs __iomem *regs = ep->dev->regs;
642 struct goku_request *req;
643 u32 curr, master;
644
645 /* NAK future host requests, hoping the implicit delay lets the
646 * dma engine finish reading (or writing) its latest packet and
647 * empty the dma buffer (up to 16 bytes).
648 *
649 * This avoids needing to clean up a partial packet in the fifo;
650 * we can't do that for IN without side effects to HALT and TOGGLE.
651 */
652 command(regs, COMMAND_FIFO_DISABLE, ep->num);
653 req = list_entry(ep->queue.next, struct goku_request, queue);
654 master = readl(&regs->dma_master) & MST_RW_BITS;
655
656 /* FIXME using these resets isn't usably documented. this may
657 * not work unless it's followed by disabling the endpoint.
658 *
659 * FIXME the OUT reset path doesn't even behave consistently.
660 */
661 if (ep->is_in) {
662 if (unlikely((readl(&regs->dma_master) & MST_RD_ENA) == 0))
663 goto finished;
664 curr = readl(&regs->in_dma_current);
665
666 writel(curr, &regs->in_dma_end);
667 writel(curr, &regs->in_dma_start);
668
669 master &= ~MST_R_BITS;
670 master |= MST_RD_RESET;
671 writel(master, &regs->dma_master);
672
673 if (readl(&regs->dma_master) & MST_RD_ENA)
674 DBG(ep->dev, "IN dma active after reset!\n");
675
676 } else {
677 if (unlikely((readl(&regs->dma_master) & MST_WR_ENA) == 0))
678 goto finished;
679 curr = readl(&regs->out_dma_current);
680
681 writel(curr, &regs->out_dma_end);
682 writel(curr, &regs->out_dma_start);
683
684 master &= ~MST_W_BITS;
685 master |= MST_WR_RESET;
686 writel(master, &regs->dma_master);
687
688 if (readl(&regs->dma_master) & MST_WR_ENA)
689 DBG(ep->dev, "OUT dma active after reset!\n");
690 }
691 req->req.actual = (curr - req->req.dma) + 1;
692 req->req.status = status;
693
441b62c1 694 VDBG(ep->dev, "%s %s %s %d/%d\n", __func__, ep->ep.name,
1da177e4
LT
695 ep->is_in ? "IN" : "OUT",
696 req->req.actual, req->req.length);
697
698 command(regs, COMMAND_FIFO_ENABLE, ep->num);
699
700 return;
701
702finished:
703 /* dma already completed; no abort needed */
704 command(regs, COMMAND_FIFO_ENABLE, ep->num);
705 req->req.actual = req->req.length;
706 req->req.status = 0;
707}
708
709/*-------------------------------------------------------------------------*/
710
711static int
55016f10 712goku_queue(struct usb_ep *_ep, struct usb_request *_req, gfp_t gfp_flags)
1da177e4
LT
713{
714 struct goku_request *req;
715 struct goku_ep *ep;
716 struct goku_udc *dev;
717 unsigned long flags;
718 int status;
719
720 /* always require a cpu-view buffer so pio works */
721 req = container_of(_req, struct goku_request, req);
722 if (unlikely(!_req || !_req->complete
723 || !_req->buf || !list_empty(&req->queue)))
724 return -EINVAL;
725 ep = container_of(_ep, struct goku_ep, ep);
db79d981 726 if (unlikely(!_ep || (!ep->ep.desc && ep->num != 0)))
1da177e4
LT
727 return -EINVAL;
728 dev = ep->dev;
729 if (unlikely(!dev->driver || dev->gadget.speed == USB_SPEED_UNKNOWN))
730 return -ESHUTDOWN;
731
732 /* can't touch registers when suspended */
733 if (dev->ep0state == EP0_SUSPEND)
734 return -EBUSY;
735
736 /* set up dma mapping in case the caller didn't */
6440093f
FB
737 if (ep->dma) {
738 status = usb_gadget_map_request(&dev->gadget, &req->req,
739 ep->is_in);
740 if (status)
741 return status;
1da177e4
LT
742 }
743
744#ifdef USB_TRACE
745 VDBG(dev, "%s queue req %p, len %u buf %p\n",
746 _ep->name, _req, _req->length, _req->buf);
747#endif
748
749 spin_lock_irqsave(&dev->lock, flags);
750
751 _req->status = -EINPROGRESS;
752 _req->actual = 0;
753
754 /* for ep0 IN without premature status, zlp is required and
755 * writing EOP starts the status stage (OUT).
756 */
757 if (unlikely(ep->num == 0 && ep->is_in))
758 _req->zero = 1;
759
760 /* kickstart this i/o queue? */
761 status = 0;
762 if (list_empty(&ep->queue) && likely(!ep->stopped)) {
763 /* dma: done after dma completion IRQ (or error)
764 * pio: done after last fifo operation
765 */
766 if (ep->dma)
767 status = start_dma(ep, req);
768 else
769 status = (ep->is_in ? write_fifo : read_fifo)(ep, req);
770
771 if (unlikely(status != 0)) {
772 if (status > 0)
773 status = 0;
774 req = NULL;
775 }
776
777 } /* else pio or dma irq handler advances the queue. */
778
027ca0d2 779 if (likely(req != NULL))
1da177e4
LT
780 list_add_tail(&req->queue, &ep->queue);
781
782 if (likely(!list_empty(&ep->queue))
783 && likely(ep->num != 0)
784 && !ep->dma
785 && !(dev->int_enable & INT_EPxDATASET (ep->num)))
786 pio_irq_enable(dev, dev->regs, ep->num);
787
788 spin_unlock_irqrestore(&dev->lock, flags);
789
790 /* pci writes may still be posted */
791 return status;
792}
793
794/* dequeue ALL requests */
795static void nuke(struct goku_ep *ep, int status)
796{
797 struct goku_request *req;
798
799 ep->stopped = 1;
800 if (list_empty(&ep->queue))
801 return;
802 if (ep->dma)
803 abort_dma(ep, status);
804 while (!list_empty(&ep->queue)) {
805 req = list_entry(ep->queue.next, struct goku_request, queue);
806 done(ep, req, status);
807 }
808}
809
810/* dequeue JUST ONE request */
811static int goku_dequeue(struct usb_ep *_ep, struct usb_request *_req)
812{
813 struct goku_request *req;
814 struct goku_ep *ep;
815 struct goku_udc *dev;
816 unsigned long flags;
817
818 ep = container_of(_ep, struct goku_ep, ep);
db79d981 819 if (!_ep || !_req || (!ep->ep.desc && ep->num != 0))
1da177e4
LT
820 return -EINVAL;
821 dev = ep->dev;
822 if (!dev->driver)
823 return -ESHUTDOWN;
824
825 /* we can't touch (dma) registers when suspended */
826 if (dev->ep0state == EP0_SUSPEND)
827 return -EBUSY;
828
441b62c1 829 VDBG(dev, "%s %s %s %s %p\n", __func__, _ep->name,
1da177e4
LT
830 ep->is_in ? "IN" : "OUT",
831 ep->dma ? "dma" : "pio",
832 _req);
833
834 spin_lock_irqsave(&dev->lock, flags);
835
836 /* make sure it's actually queued on this endpoint */
837 list_for_each_entry (req, &ep->queue, queue) {
838 if (&req->req == _req)
839 break;
840 }
841 if (&req->req != _req) {
842 spin_unlock_irqrestore (&dev->lock, flags);
843 return -EINVAL;
844 }
845
846 if (ep->dma && ep->queue.next == &req->queue && !ep->stopped) {
847 abort_dma(ep, -ECONNRESET);
848 done(ep, req, -ECONNRESET);
849 dma_advance(dev, ep);
850 } else if (!list_empty(&req->queue))
851 done(ep, req, -ECONNRESET);
852 else
853 req = NULL;
854 spin_unlock_irqrestore(&dev->lock, flags);
855
856 return req ? 0 : -EOPNOTSUPP;
857}
858
859/*-------------------------------------------------------------------------*/
860
861static void goku_clear_halt(struct goku_ep *ep)
862{
863 // assert (ep->num !=0)
864 VDBG(ep->dev, "%s clear halt\n", ep->ep.name);
865 command(ep->dev->regs, COMMAND_SETDATA0, ep->num);
866 command(ep->dev->regs, COMMAND_STALL_CLEAR, ep->num);
867 if (ep->stopped) {
868 ep->stopped = 0;
869 if (ep->dma) {
870 struct goku_request *req;
871
872 if (list_empty(&ep->queue))
873 return;
874 req = list_entry(ep->queue.next, struct goku_request,
875 queue);
876 (void) start_dma(ep, req);
877 } else
878 pio_advance(ep);
879 }
880}
881
882static int goku_set_halt(struct usb_ep *_ep, int value)
883{
884 struct goku_ep *ep;
885 unsigned long flags;
886 int retval = 0;
887
888 if (!_ep)
889 return -ENODEV;
890 ep = container_of (_ep, struct goku_ep, ep);
891
892 if (ep->num == 0) {
893 if (value) {
894 ep->dev->ep0state = EP0_STALL;
895 ep->dev->ep[0].stopped = 1;
896 } else
897 return -EINVAL;
898
899 /* don't change EPxSTATUS_EP_INVALID to READY */
db79d981 900 } else if (!ep->ep.desc) {
441b62c1 901 DBG(ep->dev, "%s %s inactive?\n", __func__, ep->ep.name);
1da177e4
LT
902 return -EINVAL;
903 }
904
905 spin_lock_irqsave(&ep->dev->lock, flags);
906 if (!list_empty(&ep->queue))
907 retval = -EAGAIN;
908 else if (ep->is_in && value
909 /* data in (either) packet buffer? */
910 && (readl(&ep->dev->regs->DataSet)
911 & DATASET_AB(ep->num)))
912 retval = -EAGAIN;
913 else if (!value)
914 goku_clear_halt(ep);
915 else {
916 ep->stopped = 1;
917 VDBG(ep->dev, "%s set halt\n", ep->ep.name);
918 command(ep->dev->regs, COMMAND_STALL, ep->num);
919 readl(ep->reg_status);
920 }
921 spin_unlock_irqrestore(&ep->dev->lock, flags);
922 return retval;
923}
924
925static int goku_fifo_status(struct usb_ep *_ep)
926{
927 struct goku_ep *ep;
928 struct goku_udc_regs __iomem *regs;
929 u32 size;
930
931 if (!_ep)
932 return -ENODEV;
933 ep = container_of(_ep, struct goku_ep, ep);
934
935 /* size is only reported sanely for OUT */
936 if (ep->is_in)
937 return -EOPNOTSUPP;
938
939 /* ignores 16-byte dma buffer; SizeH == 0 */
940 regs = ep->dev->regs;
941 size = readl(&regs->EPxSizeLA[ep->num]) & DATASIZE;
942 size += readl(&regs->EPxSizeLB[ep->num]) & DATASIZE;
441b62c1 943 VDBG(ep->dev, "%s %s %u\n", __func__, ep->ep.name, size);
1da177e4
LT
944 return size;
945}
946
947static void goku_fifo_flush(struct usb_ep *_ep)
948{
949 struct goku_ep *ep;
950 struct goku_udc_regs __iomem *regs;
951 u32 size;
952
953 if (!_ep)
954 return;
955 ep = container_of(_ep, struct goku_ep, ep);
441b62c1 956 VDBG(ep->dev, "%s %s\n", __func__, ep->ep.name);
1da177e4
LT
957
958 /* don't change EPxSTATUS_EP_INVALID to READY */
db79d981 959 if (!ep->ep.desc && ep->num != 0) {
441b62c1 960 DBG(ep->dev, "%s %s inactive?\n", __func__, ep->ep.name);
1da177e4
LT
961 return;
962 }
963
964 regs = ep->dev->regs;
965 size = readl(&regs->EPxSizeLA[ep->num]);
966 size &= DATASIZE;
967
968 /* Non-desirable behavior: FIFO_CLEAR also clears the
969 * endpoint halt feature. For OUT, we _could_ just read
970 * the bytes out (PIO, if !ep->dma); for in, no choice.
971 */
972 if (size)
973 command(regs, COMMAND_FIFO_CLEAR, ep->num);
974}
975
977ac789 976static const struct usb_ep_ops goku_ep_ops = {
1da177e4
LT
977 .enable = goku_ep_enable,
978 .disable = goku_ep_disable,
979
980 .alloc_request = goku_alloc_request,
981 .free_request = goku_free_request,
982
1da177e4
LT
983 .queue = goku_queue,
984 .dequeue = goku_dequeue,
985
986 .set_halt = goku_set_halt,
987 .fifo_status = goku_fifo_status,
988 .fifo_flush = goku_fifo_flush,
989};
990
991/*-------------------------------------------------------------------------*/
992
993static int goku_get_frame(struct usb_gadget *_gadget)
994{
995 return -EOPNOTSUPP;
996}
997
8cc67b7b
RB
998static struct usb_ep *goku_match_ep(struct usb_gadget *g,
999 struct usb_endpoint_descriptor *desc,
1000 struct usb_ss_ep_comp_descriptor *ep_comp)
1001{
1002 struct goku_udc *dev = to_goku_udc(g);
1003 struct usb_ep *ep;
1004
1005 switch (usb_endpoint_type(desc)) {
1006 case USB_ENDPOINT_XFER_INT:
1007 /* single buffering is enough */
1008 ep = &dev->ep[3].ep;
1009 if (usb_gadget_ep_match_desc(g, ep, desc, ep_comp))
1010 return ep;
1011 break;
1012 case USB_ENDPOINT_XFER_BULK:
1013 if (usb_endpoint_dir_in(desc)) {
1014 /* DMA may be available */
1015 ep = &dev->ep[2].ep;
1016 if (usb_gadget_ep_match_desc(g, ep, desc, ep_comp))
1017 return ep;
1018 }
1019 break;
1020 default:
1021 /* nothing */ ;
1022 }
1023
1024 return NULL;
1025}
1026
950b3c1d
FB
1027static int goku_udc_start(struct usb_gadget *g,
1028 struct usb_gadget_driver *driver);
22835b80 1029static int goku_udc_stop(struct usb_gadget *g);
0f91349b 1030
1da177e4
LT
1031static const struct usb_gadget_ops goku_ops = {
1032 .get_frame = goku_get_frame,
950b3c1d
FB
1033 .udc_start = goku_udc_start,
1034 .udc_stop = goku_udc_stop,
8cc67b7b 1035 .match_ep = goku_match_ep,
1da177e4
LT
1036 // no remote wakeup
1037 // not selfpowered
1038};
1039
1040/*-------------------------------------------------------------------------*/
1041
96c7a22e 1042static inline const char *dmastr(void)
1da177e4
LT
1043{
1044 if (use_dma == 0)
1045 return "(dma disabled)";
1046 else if (use_dma == 2)
1047 return "(dma IN and OUT)";
1048 else
1049 return "(dma IN)";
1050}
1051
1052#ifdef CONFIG_USB_GADGET_DEBUG_FILES
1053
1054static const char proc_node_name [] = "driver/udc";
1055
1056#define FOURBITS "%s%s%s%s"
1057#define EIGHTBITS FOURBITS FOURBITS
1058
96c7a22e 1059static void dump_intmask(struct seq_file *m, const char *label, u32 mask)
1da177e4 1060{
1da177e4 1061 /* int_status is the same format ... */
557f3586
JP
1062 seq_printf(m, "%s %05X =" FOURBITS EIGHTBITS EIGHTBITS "\n",
1063 label, mask,
1064 (mask & INT_PWRDETECT) ? " power" : "",
1065 (mask & INT_SYSERROR) ? " sys" : "",
1066 (mask & INT_MSTRDEND) ? " in-dma" : "",
1067 (mask & INT_MSTWRTMOUT) ? " wrtmo" : "",
1068
1069 (mask & INT_MSTWREND) ? " out-dma" : "",
1070 (mask & INT_MSTWRSET) ? " wrset" : "",
1071 (mask & INT_ERR) ? " err" : "",
1072 (mask & INT_SOF) ? " sof" : "",
1073
1074 (mask & INT_EP3NAK) ? " ep3nak" : "",
1075 (mask & INT_EP2NAK) ? " ep2nak" : "",
1076 (mask & INT_EP1NAK) ? " ep1nak" : "",
1077 (mask & INT_EP3DATASET) ? " ep3" : "",
1078
1079 (mask & INT_EP2DATASET) ? " ep2" : "",
1080 (mask & INT_EP1DATASET) ? " ep1" : "",
1081 (mask & INT_STATUSNAK) ? " ep0snak" : "",
1082 (mask & INT_STATUS) ? " ep0status" : "",
1083
1084 (mask & INT_SETUP) ? " setup" : "",
1085 (mask & INT_ENDPOINT0) ? " ep0" : "",
1086 (mask & INT_USBRESET) ? " reset" : "",
1087 (mask & INT_SUSPEND) ? " suspend" : "");
1088}
1089
1090static const char *udc_ep_state(enum ep0state state)
1091{
1092 switch (state) {
1093 case EP0_DISCONNECT:
1094 return "ep0_disconnect";
1095 case EP0_IDLE:
1096 return "ep0_idle";
1097 case EP0_IN:
1098 return "ep0_in";
1099 case EP0_OUT:
1100 return "ep0_out";
1101 case EP0_STATUS:
1102 return "ep0_status";
1103 case EP0_STALL:
1104 return "ep0_stall";
1105 case EP0_SUSPEND:
1106 return "ep0_suspend";
1107 }
1108
1109 return "ep0_?";
1da177e4
LT
1110}
1111
557f3586
JP
1112static const char *udc_ep_status(u32 status)
1113{
1114 switch (status & EPxSTATUS_EP_MASK) {
1115 case EPxSTATUS_EP_READY:
1116 return "ready";
1117 case EPxSTATUS_EP_DATAIN:
1118 return "packet";
1119 case EPxSTATUS_EP_FULL:
1120 return "full";
1121 case EPxSTATUS_EP_TX_ERR: /* host will retry */
1122 return "tx_err";
1123 case EPxSTATUS_EP_RX_ERR:
1124 return "rx_err";
1125 case EPxSTATUS_EP_BUSY: /* ep0 only */
1126 return "busy";
1127 case EPxSTATUS_EP_STALL:
1128 return "stall";
1129 case EPxSTATUS_EP_INVALID: /* these "can't happen" */
1130 return "invalid";
1131 }
1132
1133 return "?";
1134}
1da177e4 1135
96c7a22e 1136static int udc_proc_read(struct seq_file *m, void *v)
1da177e4 1137{
96c7a22e 1138 struct goku_udc *dev = m->private;
1da177e4 1139 struct goku_udc_regs __iomem *regs = dev->regs;
1da177e4 1140 unsigned long flags;
96c7a22e 1141 int i, is_usb_connected;
1da177e4
LT
1142 u32 tmp;
1143
1da177e4
LT
1144 local_irq_save(flags);
1145
1146 /* basic device status */
1147 tmp = readl(&regs->power_detect);
1148 is_usb_connected = tmp & PW_DETECT;
96c7a22e 1149 seq_printf(m,
557f3586
JP
1150 "%s - %s\n"
1151 "%s version: %s %s\n"
1152 "Gadget driver: %s\n"
1153 "Host %s, %s\n"
1154 "\n",
1155 pci_name(dev->pdev), driver_desc,
1156 driver_name, DRIVER_VERSION, dmastr(),
1157 dev->driver ? dev->driver->driver.name : "(none)",
1158 is_usb_connected
1159 ? ((tmp & PW_PULLUP) ? "full speed" : "powered")
1160 : "disconnected",
1161 udc_ep_state(dev->ep0state));
1da177e4 1162
96c7a22e
DH
1163 dump_intmask(m, "int_status", readl(&regs->int_status));
1164 dump_intmask(m, "int_enable", readl(&regs->int_enable));
1da177e4
LT
1165
1166 if (!is_usb_connected || !dev->driver || (tmp & PW_PULLUP) == 0)
1167 goto done;
1168
1169 /* registers for (active) device and ep0 */
557f3586
JP
1170 seq_printf(m, "\nirqs %lu\ndataset %02x single.bcs %02x.%02x state %x addr %u\n",
1171 dev->irqs, readl(&regs->DataSet),
1172 readl(&regs->EPxSingle), readl(&regs->EPxBCS),
1173 readl(&regs->UsbState),
1174 readl(&regs->address));
1175 if (seq_has_overflowed(m))
96c7a22e 1176 goto done;
1da177e4
LT
1177
1178 tmp = readl(&regs->dma_master);
557f3586
JP
1179 seq_printf(m, "dma %03X =" EIGHTBITS "%s %s\n",
1180 tmp,
1181 (tmp & MST_EOPB_DIS) ? " eopb-" : "",
1182 (tmp & MST_EOPB_ENA) ? " eopb+" : "",
1183 (tmp & MST_TIMEOUT_DIS) ? " tmo-" : "",
1184 (tmp & MST_TIMEOUT_ENA) ? " tmo+" : "",
1185
1186 (tmp & MST_RD_EOPB) ? " eopb" : "",
1187 (tmp & MST_RD_RESET) ? " in_reset" : "",
1188 (tmp & MST_WR_RESET) ? " out_reset" : "",
1189 (tmp & MST_RD_ENA) ? " IN" : "",
1190
1191 (tmp & MST_WR_ENA) ? " OUT" : "",
1192 (tmp & MST_CONNECTION) ? "ep1in/ep2out" : "ep1out/ep2in");
1193 if (seq_has_overflowed(m))
96c7a22e 1194 goto done;
1da177e4
LT
1195
1196 /* dump endpoint queues */
1197 for (i = 0; i < 4; i++) {
1198 struct goku_ep *ep = &dev->ep [i];
1199 struct goku_request *req;
1da177e4 1200
db79d981 1201 if (i && !ep->ep.desc)
1da177e4
LT
1202 continue;
1203
1204 tmp = readl(ep->reg_status);
557f3586
JP
1205 seq_printf(m, "%s %s max %u %s, irqs %lu, status %02x (%s) " FOURBITS "\n",
1206 ep->ep.name,
1207 ep->is_in ? "in" : "out",
1208 ep->ep.maxpacket,
1209 ep->dma ? "dma" : "pio",
1210 ep->irqs,
1211 tmp, udc_ep_status(tmp),
1212 (tmp & EPxSTATUS_TOGGLE) ? "data1" : "data0",
1213 (tmp & EPxSTATUS_SUSPEND) ? " suspend" : "",
1214 (tmp & EPxSTATUS_FIFO_DISABLE) ? " disable" : "",
1215 (tmp & EPxSTATUS_STAGE_ERROR) ? " ep0stat" : "");
1216 if (seq_has_overflowed(m))
1da177e4 1217 goto done;
1da177e4
LT
1218
1219 if (list_empty(&ep->queue)) {
557f3586
JP
1220 seq_puts(m, "\t(nothing queued)\n");
1221 if (seq_has_overflowed(m))
1da177e4 1222 goto done;
1da177e4
LT
1223 continue;
1224 }
1225 list_for_each_entry(req, &ep->queue, queue) {
1226 if (ep->dma && req->queue.prev == &ep->queue) {
1227 if (i == UDC_MSTRD_ENDPOINT)
1228 tmp = readl(&regs->in_dma_current);
1229 else
1230 tmp = readl(&regs->out_dma_current);
1231 tmp -= req->req.dma;
1232 tmp++;
1233 } else
1234 tmp = req->req.actual;
1235
557f3586
JP
1236 seq_printf(m, "\treq %p len %u/%u buf %p\n",
1237 &req->req, tmp, req->req.length,
1238 req->req.buf);
1239 if (seq_has_overflowed(m))
1da177e4 1240 goto done;
1da177e4
LT
1241 }
1242 }
1243
1244done:
1245 local_irq_restore(flags);
96c7a22e
DH
1246 return 0;
1247}
1248
1249/*
1250 * seq_file wrappers for procfile show routines.
1251 */
1252static int udc_proc_open(struct inode *inode, struct file *file)
1253{
1254 return single_open(file, udc_proc_read, PDE_DATA(file_inode(file)));
1da177e4
LT
1255}
1256
96c7a22e
DH
1257static const struct file_operations udc_proc_fops = {
1258 .open = udc_proc_open,
1259 .read = seq_read,
1260 .llseek = seq_lseek,
962a1ab2 1261 .release = single_release,
96c7a22e
DH
1262};
1263
1da177e4
LT
1264#endif /* CONFIG_USB_GADGET_DEBUG_FILES */
1265
1266/*-------------------------------------------------------------------------*/
1267
1268static void udc_reinit (struct goku_udc *dev)
1269{
1270 static char *names [] = { "ep0", "ep1-bulk", "ep2-bulk", "ep3-bulk" };
2d70c99b 1271
1da177e4
LT
1272 unsigned i;
1273
1274 INIT_LIST_HEAD (&dev->gadget.ep_list);
1275 dev->gadget.ep0 = &dev->ep [0].ep;
1276 dev->gadget.speed = USB_SPEED_UNKNOWN;
1277 dev->ep0state = EP0_DISCONNECT;
1278 dev->irqs = 0;
1279
1280 for (i = 0; i < 4; i++) {
1281 struct goku_ep *ep = &dev->ep[i];
1282
1283 ep->num = i;
1284 ep->ep.name = names[i];
1285 ep->reg_fifo = &dev->regs->ep_fifo [i];
1286 ep->reg_status = &dev->regs->ep_status [i];
1287 ep->reg_mode = &dev->regs->ep_mode[i];
1288
1289 ep->ep.ops = &goku_ep_ops;
1290 list_add_tail (&ep->ep.ep_list, &dev->gadget.ep_list);
1291 ep->dev = dev;
1292 INIT_LIST_HEAD (&ep->queue);
1293
1294 ep_reset(NULL, ep);
b0bf5fbf
RB
1295
1296 if (i == 0)
1297 ep->ep.caps.type_control = true;
1298 else
1299 ep->ep.caps.type_bulk = true;
1300
1301 ep->ep.caps.dir_in = true;
1302 ep->ep.caps.dir_out = true;
1da177e4
LT
1303 }
1304
1305 dev->ep[0].reg_mode = NULL;
e117e742 1306 usb_ep_set_maxpacket_limit(&dev->ep[0].ep, MAX_EP0_SIZE);
1da177e4
LT
1307 list_del_init (&dev->ep[0].ep.ep_list);
1308}
1309
1310static void udc_reset(struct goku_udc *dev)
1311{
1312 struct goku_udc_regs __iomem *regs = dev->regs;
1313
1314 writel(0, &regs->power_detect);
1315 writel(0, &regs->int_enable);
1316 readl(&regs->int_enable);
1317 dev->int_enable = 0;
1318
1319 /* deassert reset, leave USB D+ at hi-Z (no pullup)
1320 * don't let INT_PWRDETECT sequence begin
1321 */
1322 udelay(250);
1323 writel(PW_RESETB, &regs->power_detect);
1324 readl(&regs->int_enable);
1325}
1326
1327static void ep0_start(struct goku_udc *dev)
1328{
1329 struct goku_udc_regs __iomem *regs = dev->regs;
1330 unsigned i;
1331
441b62c1 1332 VDBG(dev, "%s\n", __func__);
1da177e4
LT
1333
1334 udc_reset(dev);
1335 udc_reinit (dev);
1336 //writel(MST_EOPB_ENA | MST_TIMEOUT_ENA, &regs->dma_master);
1337
1338 /* hw handles set_address, set_feature, get_status; maybe more */
1339 writel( G_REQMODE_SET_INTF | G_REQMODE_GET_INTF
1340 | G_REQMODE_SET_CONF | G_REQMODE_GET_CONF
1341 | G_REQMODE_GET_DESC
1342 | G_REQMODE_CLEAR_FEAT
1343 , &regs->reqmode);
1344
1345 for (i = 0; i < 4; i++)
1346 dev->ep[i].irqs = 0;
1347
1348 /* can't modify descriptors after writing UsbReady */
1349 for (i = 0; i < DESC_LEN; i++)
1350 writel(0, &regs->descriptors[i]);
1351 writel(0, &regs->UsbReady);
1352
1353 /* expect ep0 requests when the host drops reset */
1354 writel(PW_RESETB | PW_PULLUP, &regs->power_detect);
1355 dev->int_enable = INT_DEVWIDE | INT_EP0;
1356 writel(dev->int_enable, &dev->regs->int_enable);
1357 readl(&regs->int_enable);
1358 dev->gadget.speed = USB_SPEED_FULL;
1359 dev->ep0state = EP0_IDLE;
1360}
1361
1362static void udc_enable(struct goku_udc *dev)
1363{
1364 /* start enumeration now, or after power detect irq */
1365 if (readl(&dev->regs->power_detect) & PW_DETECT)
1366 ep0_start(dev);
1367 else {
441b62c1 1368 DBG(dev, "%s\n", __func__);
1da177e4
LT
1369 dev->int_enable = INT_PWRDETECT;
1370 writel(dev->int_enable, &dev->regs->int_enable);
1371 }
1372}
1373
1374/*-------------------------------------------------------------------------*/
1375
1376/* keeping it simple:
1377 * - one bus driver, initted first;
1378 * - one function driver, initted second
1379 */
1380
1da177e4
LT
1381/* when a driver is successfully registered, it will receive
1382 * control requests including set_configuration(), which enables
1383 * non-control requests. then usb traffic follows until a
1384 * disconnect is reported. then a host may connect again, or
1385 * the driver might get unbound.
1386 */
950b3c1d
FB
1387static int goku_udc_start(struct usb_gadget *g,
1388 struct usb_gadget_driver *driver)
1da177e4 1389{
950b3c1d 1390 struct goku_udc *dev = to_goku_udc(g);
1da177e4
LT
1391
1392 /* hook up the driver */
1393 driver->driver.bus = NULL;
1394 dev->driver = driver;
1da177e4 1395
950b3c1d
FB
1396 /*
1397 * then enable host detection and ep0; and we're ready
1da177e4
LT
1398 * for set_configuration as well as eventual disconnect.
1399 */
1400 udc_enable(dev);
1401
1da177e4
LT
1402 return 0;
1403}
1da177e4 1404
4fbc5566 1405static void stop_activity(struct goku_udc *dev)
1da177e4
LT
1406{
1407 unsigned i;
1408
441b62c1 1409 DBG (dev, "%s\n", __func__);
1da177e4 1410
1da177e4
LT
1411 /* disconnect gadget driver after quiesceing hw and the driver */
1412 udc_reset (dev);
1413 for (i = 0; i < 4; i++)
1414 nuke(&dev->ep [i], -ESHUTDOWN);
1da177e4
LT
1415
1416 if (dev->driver)
1417 udc_enable(dev);
1418}
1419
22835b80 1420static int goku_udc_stop(struct usb_gadget *g)
1da177e4 1421{
950b3c1d 1422 struct goku_udc *dev = to_goku_udc(g);
1da177e4
LT
1423 unsigned long flags;
1424
1da177e4
LT
1425 spin_lock_irqsave(&dev->lock, flags);
1426 dev->driver = NULL;
4fbc5566 1427 stop_activity(dev);
1da177e4 1428 spin_unlock_irqrestore(&dev->lock, flags);
1da177e4 1429
1da177e4
LT
1430 return 0;
1431}
1da177e4
LT
1432
1433/*-------------------------------------------------------------------------*/
1434
1435static void ep0_setup(struct goku_udc *dev)
1436{
1437 struct goku_udc_regs __iomem *regs = dev->regs;
1438 struct usb_ctrlrequest ctrl;
1439 int tmp;
1440
1441 /* read SETUP packet and enter DATA stage */
1442 ctrl.bRequestType = readl(&regs->bRequestType);
1443 ctrl.bRequest = readl(&regs->bRequest);
988199fe
DB
1444 ctrl.wValue = cpu_to_le16((readl(&regs->wValueH) << 8)
1445 | readl(&regs->wValueL));
1446 ctrl.wIndex = cpu_to_le16((readl(&regs->wIndexH) << 8)
1447 | readl(&regs->wIndexL));
1448 ctrl.wLength = cpu_to_le16((readl(&regs->wLengthH) << 8)
1449 | readl(&regs->wLengthL));
1da177e4
LT
1450 writel(0, &regs->SetupRecv);
1451
1452 nuke(&dev->ep[0], 0);
1453 dev->ep[0].stopped = 0;
1454 if (likely(ctrl.bRequestType & USB_DIR_IN)) {
1455 dev->ep[0].is_in = 1;
1456 dev->ep0state = EP0_IN;
1457 /* detect early status stages */
1458 writel(ICONTROL_STATUSNAK, &dev->regs->IntControl);
1459 } else {
1460 dev->ep[0].is_in = 0;
1461 dev->ep0state = EP0_OUT;
1462
1463 /* NOTE: CLEAR_FEATURE is done in software so that we can
1464 * synchronize transfer restarts after bulk IN stalls. data
1465 * won't even enter the fifo until the halt is cleared.
1466 */
1467 switch (ctrl.bRequest) {
1468 case USB_REQ_CLEAR_FEATURE:
1469 switch (ctrl.bRequestType) {
1470 case USB_RECIP_ENDPOINT:
988199fe 1471 tmp = le16_to_cpu(ctrl.wIndex) & 0x0f;
1da177e4 1472 /* active endpoint */
db79d981
IS
1473 if (tmp > 3 ||
1474 (!dev->ep[tmp].ep.desc && tmp != 0))
1da177e4 1475 goto stall;
551509d2 1476 if (ctrl.wIndex & cpu_to_le16(
988199fe 1477 USB_DIR_IN)) {
1da177e4
LT
1478 if (!dev->ep[tmp].is_in)
1479 goto stall;
1480 } else {
1481 if (dev->ep[tmp].is_in)
1482 goto stall;
1483 }
551509d2 1484 if (ctrl.wValue != cpu_to_le16(
988199fe 1485 USB_ENDPOINT_HALT))
1da177e4
LT
1486 goto stall;
1487 if (tmp)
1488 goku_clear_halt(&dev->ep[tmp]);
1489succeed:
1490 /* start ep0out status stage */
1491 writel(~(1<<0), &regs->EOP);
1492 dev->ep[0].stopped = 1;
1493 dev->ep0state = EP0_STATUS;
1494 return;
1495 case USB_RECIP_DEVICE:
1496 /* device remote wakeup: always clear */
551509d2 1497 if (ctrl.wValue != cpu_to_le16(1))
1da177e4
LT
1498 goto stall;
1499 VDBG(dev, "clear dev remote wakeup\n");
1500 goto succeed;
1501 case USB_RECIP_INTERFACE:
1502 goto stall;
1503 default: /* pass to gadget driver */
1504 break;
1505 }
1506 break;
1507 default:
1508 break;
1509 }
1510 }
1511
1512#ifdef USB_TRACE
1513 VDBG(dev, "SETUP %02x.%02x v%04x i%04x l%04x\n",
1514 ctrl.bRequestType, ctrl.bRequest,
988199fe
DB
1515 le16_to_cpu(ctrl.wValue), le16_to_cpu(ctrl.wIndex),
1516 le16_to_cpu(ctrl.wLength));
1da177e4
LT
1517#endif
1518
1519 /* hw wants to know when we're configured (or not) */
1520 dev->req_config = (ctrl.bRequest == USB_REQ_SET_CONFIGURATION
1521 && ctrl.bRequestType == USB_RECIP_DEVICE);
1522 if (unlikely(dev->req_config))
551509d2 1523 dev->configured = (ctrl.wValue != cpu_to_le16(0));
1da177e4
LT
1524
1525 /* delegate everything to the gadget driver.
1526 * it may respond after this irq handler returns.
1527 */
1528 spin_unlock (&dev->lock);
1529 tmp = dev->driver->setup(&dev->gadget, &ctrl);
1530 spin_lock (&dev->lock);
1531 if (unlikely(tmp < 0)) {
1532stall:
1533#ifdef USB_TRACE
1534 VDBG(dev, "req %02x.%02x protocol STALL; err %d\n",
1535 ctrl.bRequestType, ctrl.bRequest, tmp);
1536#endif
1537 command(regs, COMMAND_STALL, 0);
1538 dev->ep[0].stopped = 1;
1539 dev->ep0state = EP0_STALL;
1540 }
1541
1542 /* expect at least one data or status stage irq */
1543}
1544
1545#define ACK(irqbit) { \
1546 stat &= ~irqbit; \
1547 writel(~irqbit, &regs->int_status); \
1548 handled = 1; \
1549 }
1550
7d12e780 1551static irqreturn_t goku_irq(int irq, void *_dev)
1da177e4
LT
1552{
1553 struct goku_udc *dev = _dev;
1554 struct goku_udc_regs __iomem *regs = dev->regs;
1555 struct goku_ep *ep;
1556 u32 stat, handled = 0;
1557 unsigned i, rescans = 5;
1558
1559 spin_lock(&dev->lock);
1560
1561rescan:
1562 stat = readl(&regs->int_status) & dev->int_enable;
1563 if (!stat)
1564 goto done;
1565 dev->irqs++;
1566
1567 /* device-wide irqs */
1568 if (unlikely(stat & INT_DEVWIDE)) {
1569 if (stat & INT_SYSERROR) {
1570 ERROR(dev, "system error\n");
4fbc5566 1571 stop_activity(dev);
1da177e4
LT
1572 stat = 0;
1573 handled = 1;
1574 // FIXME have a neater way to prevent re-enumeration
1575 dev->driver = NULL;
1576 goto done;
1577 }
1578 if (stat & INT_PWRDETECT) {
1579 writel(~stat, &regs->int_status);
1580 if (readl(&dev->regs->power_detect) & PW_DETECT) {
1581 VDBG(dev, "connect\n");
1582 ep0_start(dev);
1583 } else {
1584 DBG(dev, "disconnect\n");
1585 if (dev->gadget.speed == USB_SPEED_FULL)
4fbc5566 1586 stop_activity(dev);
1da177e4
LT
1587 dev->ep0state = EP0_DISCONNECT;
1588 dev->int_enable = INT_DEVWIDE;
1589 writel(dev->int_enable, &dev->regs->int_enable);
1590 }
1591 stat = 0;
1592 handled = 1;
1593 goto done;
1594 }
1595 if (stat & INT_SUSPEND) {
1596 ACK(INT_SUSPEND);
1597 if (readl(&regs->ep_status[0]) & EPxSTATUS_SUSPEND) {
1598 switch (dev->ep0state) {
1599 case EP0_DISCONNECT:
1600 case EP0_SUSPEND:
1601 goto pm_next;
1602 default:
1603 break;
1604 }
1605 DBG(dev, "USB suspend\n");
1606 dev->ep0state = EP0_SUSPEND;
1607 if (dev->gadget.speed != USB_SPEED_UNKNOWN
1608 && dev->driver
1609 && dev->driver->suspend) {
1610 spin_unlock(&dev->lock);
1611 dev->driver->suspend(&dev->gadget);
1612 spin_lock(&dev->lock);
1613 }
1614 } else {
1615 if (dev->ep0state != EP0_SUSPEND) {
1616 DBG(dev, "bogus USB resume %d\n",
1617 dev->ep0state);
1618 goto pm_next;
1619 }
1620 DBG(dev, "USB resume\n");
1621 dev->ep0state = EP0_IDLE;
1622 if (dev->gadget.speed != USB_SPEED_UNKNOWN
1623 && dev->driver
1624 && dev->driver->resume) {
1625 spin_unlock(&dev->lock);
1626 dev->driver->resume(&dev->gadget);
1627 spin_lock(&dev->lock);
1628 }
1629 }
1630 }
1631pm_next:
1632 if (stat & INT_USBRESET) { /* hub reset done */
1633 ACK(INT_USBRESET);
1634 INFO(dev, "USB reset done, gadget %s\n",
1635 dev->driver->driver.name);
1636 }
1637 // and INT_ERR on some endpoint's crc/bitstuff/... problem
1638 }
1639
1640 /* progress ep0 setup, data, or status stages.
1641 * no transition {EP0_STATUS, EP0_STALL} --> EP0_IDLE; saves irqs
1642 */
1643 if (stat & INT_SETUP) {
1644 ACK(INT_SETUP);
1645 dev->ep[0].irqs++;
1646 ep0_setup(dev);
1647 }
1648 if (stat & INT_STATUSNAK) {
1649 ACK(INT_STATUSNAK|INT_ENDPOINT0);
1650 if (dev->ep0state == EP0_IN) {
1651 ep = &dev->ep[0];
1652 ep->irqs++;
1653 nuke(ep, 0);
1654 writel(~(1<<0), &regs->EOP);
1655 dev->ep0state = EP0_STATUS;
1656 }
1657 }
1658 if (stat & INT_ENDPOINT0) {
1659 ACK(INT_ENDPOINT0);
1660 ep = &dev->ep[0];
1661 ep->irqs++;
1662 pio_advance(ep);
1663 }
1664
1665 /* dma completion */
1666 if (stat & INT_MSTRDEND) { /* IN */
1667 ACK(INT_MSTRDEND);
1668 ep = &dev->ep[UDC_MSTRD_ENDPOINT];
1669 ep->irqs++;
1670 dma_advance(dev, ep);
1671 }
1672 if (stat & INT_MSTWREND) { /* OUT */
1673 ACK(INT_MSTWREND);
1674 ep = &dev->ep[UDC_MSTWR_ENDPOINT];
1675 ep->irqs++;
1676 dma_advance(dev, ep);
1677 }
1678 if (stat & INT_MSTWRTMOUT) { /* OUT */
1679 ACK(INT_MSTWRTMOUT);
1680 ep = &dev->ep[UDC_MSTWR_ENDPOINT];
1681 ep->irqs++;
1682 ERROR(dev, "%s write timeout ?\n", ep->ep.name);
1683 // reset dma? then dma_advance()
1684 }
1685
1686 /* pio */
1687 for (i = 1; i < 4; i++) {
1688 u32 tmp = INT_EPxDATASET(i);
1689
1690 if (!(stat & tmp))
1691 continue;
1692 ep = &dev->ep[i];
1693 pio_advance(ep);
1694 if (list_empty (&ep->queue))
1695 pio_irq_disable(dev, regs, i);
1696 stat &= ~tmp;
1697 handled = 1;
1698 ep->irqs++;
1699 }
1700
1701 if (rescans--)
1702 goto rescan;
1703
1704done:
1705 (void)readl(&regs->int_enable);
1706 spin_unlock(&dev->lock);
1707 if (stat)
1708 DBG(dev, "unhandled irq status: %05x (%05x, %05x)\n", stat,
1709 readl(&regs->int_status), dev->int_enable);
1710 return IRQ_RETVAL(handled);
1711}
1712
1713#undef ACK
1714
1715/*-------------------------------------------------------------------------*/
1716
1717static void gadget_release(struct device *_dev)
1718{
1719 struct goku_udc *dev = dev_get_drvdata(_dev);
1720
1721 kfree(dev);
1722}
1723
1724/* tear down the binding between this driver and the pci device */
1725
1726static void goku_remove(struct pci_dev *pdev)
1727{
1728 struct goku_udc *dev = pci_get_drvdata(pdev);
1729
441b62c1 1730 DBG(dev, "%s\n", __func__);
6bea476c 1731
0f91349b
SAS
1732 usb_del_gadget_udc(&dev->gadget);
1733
6bea476c 1734 BUG_ON(dev->driver);
1da177e4
LT
1735
1736#ifdef CONFIG_USB_GADGET_DEBUG_FILES
1737 remove_proc_entry(proc_node_name, NULL);
1738#endif
1739 if (dev->regs)
1740 udc_reset(dev);
1741 if (dev->got_irq)
1742 free_irq(pdev->irq, dev);
1743 if (dev->regs)
1744 iounmap(dev->regs);
1745 if (dev->got_region)
1746 release_mem_region(pci_resource_start (pdev, 0),
1747 pci_resource_len (pdev, 0));
1748 if (dev->enabled)
1749 pci_disable_device(pdev);
1da177e4 1750
1da177e4 1751 dev->regs = NULL;
1da177e4
LT
1752
1753 INFO(dev, "unbind\n");
1754}
1755
1756/* wrap this driver around the specified pci device, but
1757 * don't respond over USB until a gadget driver binds to us.
1758 */
1759
1760static int goku_probe(struct pci_dev *pdev, const struct pci_device_id *id)
1761{
1762 struct goku_udc *dev = NULL;
1763 unsigned long resource, len;
1764 void __iomem *base = NULL;
1765 int retval;
1da177e4 1766
1da177e4
LT
1767 if (!pdev->irq) {
1768 printk(KERN_ERR "Check PCI %s IRQ setup!\n", pci_name(pdev));
1769 retval = -ENODEV;
319feaab 1770 goto err;
1da177e4
LT
1771 }
1772
1773 /* alloc, and start init */
dd00cc48 1774 dev = kzalloc (sizeof *dev, GFP_KERNEL);
1a7c1d58 1775 if (!dev) {
1da177e4 1776 retval = -ENOMEM;
319feaab 1777 goto err;
1da177e4
LT
1778 }
1779
1da177e4
LT
1780 spin_lock_init(&dev->lock);
1781 dev->pdev = pdev;
1782 dev->gadget.ops = &goku_ops;
d327ab5b 1783 dev->gadget.max_speed = USB_SPEED_FULL;
1da177e4
LT
1784
1785 /* the "gadget" abstracts/virtualizes the controller */
1da177e4
LT
1786 dev->gadget.name = driver_name;
1787
1788 /* now all the pci goodies ... */
1789 retval = pci_enable_device(pdev);
1790 if (retval < 0) {
1791 DBG(dev, "can't enable, %d\n", retval);
319feaab 1792 goto err;
1da177e4
LT
1793 }
1794 dev->enabled = 1;
1795
1796 resource = pci_resource_start(pdev, 0);
1797 len = pci_resource_len(pdev, 0);
1798 if (!request_mem_region(resource, len, driver_name)) {
1799 DBG(dev, "controller already in use\n");
1800 retval = -EBUSY;
319feaab 1801 goto err;
1da177e4
LT
1802 }
1803 dev->got_region = 1;
1804
1805 base = ioremap_nocache(resource, len);
1806 if (base == NULL) {
1807 DBG(dev, "can't map memory\n");
1808 retval = -EFAULT;
319feaab 1809 goto err;
1da177e4
LT
1810 }
1811 dev->regs = (struct goku_udc_regs __iomem *) base;
1812
1813 pci_set_drvdata(pdev, dev);
1814 INFO(dev, "%s\n", driver_desc);
1815 INFO(dev, "version: " DRIVER_VERSION " %s\n", dmastr());
c6387a48 1816 INFO(dev, "irq %d, pci mem %p\n", pdev->irq, base);
1da177e4
LT
1817
1818 /* init to known state, then setup irqs */
1819 udc_reset(dev);
1820 udc_reinit (dev);
11bc2683 1821 if (request_irq(pdev->irq, goku_irq, IRQF_SHARED,
1da177e4 1822 driver_name, dev) != 0) {
c6387a48 1823 DBG(dev, "request interrupt %d failed\n", pdev->irq);
1da177e4 1824 retval = -EBUSY;
319feaab 1825 goto err;
1da177e4
LT
1826 }
1827 dev->got_irq = 1;
1828 if (use_dma)
1829 pci_set_master(pdev);
1830
1831
1832#ifdef CONFIG_USB_GADGET_DEBUG_FILES
96c7a22e 1833 proc_create_data(proc_node_name, 0, NULL, &udc_proc_fops, dev);
1da177e4
LT
1834#endif
1835
2ae837e4
FB
1836 retval = usb_add_gadget_udc_release(&pdev->dev, &dev->gadget,
1837 gadget_release);
0f91349b
SAS
1838 if (retval)
1839 goto err;
1840
319feaab 1841 return 0;
1da177e4 1842
319feaab 1843err:
1da177e4
LT
1844 if (dev)
1845 goku_remove (pdev);
2a334cfa
AK
1846 /* gadget_release is not registered yet, kfree explicitly */
1847 kfree(dev);
1da177e4
LT
1848 return retval;
1849}
1850
1851
1852/*-------------------------------------------------------------------------*/
1853
1ba2557f 1854static const struct pci_device_id pci_ids[] = { {
7b78f48a 1855 .class = PCI_CLASS_SERIAL_USB_DEVICE,
2d70c99b 1856 .class_mask = ~0,
1da177e4
LT
1857 .vendor = 0x102f, /* Toshiba */
1858 .device = 0x0107, /* this UDC */
1859 .subvendor = PCI_ANY_ID,
1860 .subdevice = PCI_ANY_ID,
1861
1862}, { /* end: all zeroes */ }
1863};
1864MODULE_DEVICE_TABLE (pci, pci_ids);
1865
1866static struct pci_driver goku_pci_driver = {
1867 .name = (char *) driver_name,
1868 .id_table = pci_ids,
1869
1870 .probe = goku_probe,
1871 .remove = goku_remove,
1872
1873 /* FIXME add power management support */
1874};
1875
3cdb7721 1876module_pci_driver(goku_pci_driver);