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