]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/usb/gadget/goku_udc.c
projects / mirror_ubuntu-bionic-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
usb: gadget: use module_pci_driver
[mirror_ubuntu-bionic-kernel.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);
105 if (!_ep || !desc || ep->desc
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;
179 ep->desc = desc;
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;
236 ep->desc = NULL;
f9c56cdd 237 ep->ep.desc = NULL;
1da177e4
LT		 238 ep->stopped = 1;
239 ep->irqs = 0;
240 ep->dma = 0;
241}
242
243static int goku_ep_disable(struct usb_ep *_ep)
244{
245 struct goku_ep *ep;
246 struct goku_udc *dev;
247 unsigned long flags;
248
249 ep = container_of(_ep, struct goku_ep, ep);
250 if (!_ep || !ep->desc)
251 return -ENODEV;
252 dev = ep->dev;
253 if (dev->ep0state == EP0_SUSPEND)
254 return -EBUSY;
255
256 VDBG(dev, "disable %s\n", _ep->name);
257
258 spin_lock_irqsave(&dev->lock, flags);
259 nuke(ep, -ESHUTDOWN);
260 ep_reset(dev->regs, ep);
261 spin_unlock_irqrestore(&dev->lock, flags);
262
263 return 0;
264}
265
266/*-------------------------------------------------------------------------*/
267
268static struct usb_request *
55016f10 269goku_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
1da177e4
LT		 270{
271 struct goku_request *req;
272
273 if (!_ep)
274 return NULL;
7039f422 275 req = kzalloc(sizeof *req, gfp_flags);
1da177e4
LT		 276 if (!req)
277 return NULL;
278
1da177e4
LT		 279 req->req.dma = DMA_ADDR_INVALID;
280 INIT_LIST_HEAD(&req->queue);
281 return &req->req;
282}
283
284static void
285goku_free_request(struct usb_ep *_ep, struct usb_request *_req)
286{
287 struct goku_request *req;
288
289 if (!_ep || !_req)
290 return;
291
292 req = container_of(_req, struct goku_request, req);
293 WARN_ON(!list_empty(&req->queue));
294 kfree(req);
295}
296
297/*-------------------------------------------------------------------------*/
298
1da177e4
LT		 299static void
300done(struct goku_ep *ep, struct goku_request *req, int status)
301{
302 struct goku_udc *dev;
303 unsigned stopped = ep->stopped;
304
305 list_del_init(&req->queue);
306
307 if (likely(req->req.status == -EINPROGRESS))
308 req->req.status = status;
309 else
310 status = req->req.status;
311
312 dev = ep->dev;
6440093f
FB		 313
314 if (ep->dma)
315 usb_gadget_unmap_request(&dev->gadget, &req->req, ep->is_in);
1da177e4
LT		 316
317#ifndef USB_TRACE
318 if (status && status != -ESHUTDOWN)
319#endif
320 VDBG(dev, "complete %s req %p stat %d len %u/%u\n",
321 ep->ep.name, &req->req, status,
322 req->req.actual, req->req.length);
323
324 /* don't modify queue heads during completion callback */
325 ep->stopped = 1;
326 spin_unlock(&dev->lock);
327 req->req.complete(&ep->ep, &req->req);
328 spin_lock(&dev->lock);
329 ep->stopped = stopped;
330}
331
332/*-------------------------------------------------------------------------*/
333
334static inline int
335write_packet(u32 __iomem *fifo, u8 *buf, struct goku_request *req, unsigned max)
336{
337 unsigned length, count;
338
339 length = min(req->req.length - req->req.actual, max);
340 req->req.actual += length;
341
342 count = length;
343 while (likely(count--))
344 writel(*buf++, fifo);
345 return length;
346}
347
348// return: 0 = still running, 1 = completed, negative = errno
349static int write_fifo(struct goku_ep *ep, struct goku_request *req)
350{
351 struct goku_udc *dev = ep->dev;
352 u32 tmp;
353 u8 *buf;
354 unsigned count;
355 int is_last;
356
357 tmp = readl(&dev->regs->DataSet);
358 buf = req->req.buf + req->req.actual;
359 prefetch(buf);
360
361 dev = ep->dev;
362 if (unlikely(ep->num == 0 && dev->ep0state != EP0_IN))
363 return -EL2HLT;
364
365 /* NOTE: just single-buffered PIO-IN for now. */
366 if (unlikely((tmp & DATASET_A(ep->num)) != 0))
367 return 0;
368
369 /* clear our "packet available" irq */
370 if (ep->num != 0)
371 writel(~INT_EPxDATASET(ep->num), &dev->regs->int_status);
372
373 count = write_packet(ep->reg_fifo, buf, req, ep->ep.maxpacket);
374
375 /* last packet often short (sometimes a zlp, especially on ep0) */
376 if (unlikely(count != ep->ep.maxpacket)) {
377 writel(~(1<<ep->num), &dev->regs->EOP);
378 if (ep->num == 0) {
379 dev->ep[0].stopped = 1;
380 dev->ep0state = EP0_STATUS;
381 }
382 is_last = 1;
383 } else {
384 if (likely(req->req.length != req->req.actual)
385 || req->req.zero)
386 is_last = 0;
387 else
388 is_last = 1;
389 }
390#if 0 /* printk seemed to trash is_last...*/
391//#ifdef USB_TRACE
392 VDBG(dev, "wrote %s %u bytes%s IN %u left %p\n",
393 ep->ep.name, count, is_last ? "/last" : "",
394 req->req.length - req->req.actual, req);
395#endif
396
397 /* requests complete when all IN data is in the FIFO,
398 * or sometimes later, if a zlp was needed.
399 */
400 if (is_last) {
401 done(ep, req, 0);
402 return 1;
403 }
404
405 return 0;
406}
407
408static int read_fifo(struct goku_ep *ep, struct goku_request *req)
409{
410 struct goku_udc_regs __iomem *regs;
411 u32 size, set;
412 u8 *buf;
413 unsigned bufferspace, is_short, dbuff;
414
415 regs = ep->dev->regs;
416top:
417 buf = req->req.buf + req->req.actual;
418 prefetchw(buf);
419
420 if (unlikely(ep->num == 0 && ep->dev->ep0state != EP0_OUT))
421 return -EL2HLT;
422
423 dbuff = (ep->num == 1 || ep->num == 2);
424 do {
425 /* ack dataset irq matching the status we'll handle */
426 if (ep->num != 0)
427 writel(~INT_EPxDATASET(ep->num), &regs->int_status);
428
429 set = readl(&regs->DataSet) & DATASET_AB(ep->num);
430 size = readl(&regs->EPxSizeLA[ep->num]);
431 bufferspace = req->req.length - req->req.actual;
432
433 /* usually do nothing without an OUT packet */
434 if (likely(ep->num != 0 || bufferspace != 0)) {
435 if (unlikely(set == 0))
436 break;
437 /* use ep1/ep2 double-buffering for OUT */
438 if (!(size & PACKET_ACTIVE))
439 size = readl(&regs->EPxSizeLB[ep->num]);
2d70c99b 440 if (!(size & PACKET_ACTIVE)) /* "can't happen" */
1da177e4
LT		 441 break;
442 size &= DATASIZE; /* EPxSizeH == 0 */
443
444 /* ep0out no-out-data case for set_config, etc */
445 } else
446 size = 0;
447
448 /* read all bytes from this packet */
449 req->req.actual += size;
450 is_short = (size < ep->ep.maxpacket);
451#ifdef USB_TRACE
452 VDBG(ep->dev, "read %s %u bytes%s OUT req %p %u/%u\n",
453 ep->ep.name, size, is_short ? "/S" : "",
454 req, req->req.actual, req->req.length);
455#endif
456 while (likely(size-- != 0)) {
457 u8 byte = (u8) readl(ep->reg_fifo);
458
459 if (unlikely(bufferspace == 0)) {
460 /* this happens when the driver's buffer
461 * is smaller than what the host sent.
462 * discard the extra data in this packet.
463 */
464 if (req->req.status != -EOVERFLOW)
465 DBG(ep->dev, "%s overflow %u\n",
466 ep->ep.name, size);
467 req->req.status = -EOVERFLOW;
468 } else {
469 *buf++ = byte;
470 bufferspace--;
471 }
472 }
473
474 /* completion */
475 if (unlikely(is_short || req->req.actual == req->req.length)) {
476 if (unlikely(ep->num == 0)) {
477 /* non-control endpoints now usable? */
478 if (ep->dev->req_config)
479 writel(ep->dev->configured
480 ? USBSTATE_CONFIGURED
481 : 0,
482 &regs->UsbState);
483 /* ep0out status stage */
484 writel(~(1<<0), &regs->EOP);
485 ep->stopped = 1;
486 ep->dev->ep0state = EP0_STATUS;
487 }
488 done(ep, req, 0);
489
490 /* empty the second buffer asap */
491 if (dbuff && !list_empty(&ep->queue)) {
492 req = list_entry(ep->queue.next,
493 struct goku_request, queue);
494 goto top;
495 }
496 return 1;
497 }
498 } while (dbuff);
499 return 0;
500}
501
502static inline void
503pio_irq_enable(struct goku_udc *dev,
504 struct goku_udc_regs __iomem *regs, int epnum)
505{
506 dev->int_enable |= INT_EPxDATASET (epnum);
507 writel(dev->int_enable, &regs->int_enable);
508 /* write may still be posted */
509}
510
511static inline void
512pio_irq_disable(struct goku_udc *dev,
513 struct goku_udc_regs __iomem *regs, int epnum)
514{
515 dev->int_enable &= ~INT_EPxDATASET (epnum);
516 writel(dev->int_enable, &regs->int_enable);
517 /* write may still be posted */
518}
519
520static inline void
521pio_advance(struct goku_ep *ep)
522{
523 struct goku_request *req;
524
525 if (unlikely(list_empty (&ep->queue)))
526 return;
527 req = list_entry(ep->queue.next, struct goku_request, queue);
528 (ep->is_in ? write_fifo : read_fifo)(ep, req);
529}
530
531
532/*-------------------------------------------------------------------------*/
533
534// return: 0 = q running, 1 = q stopped, negative = errno
535static int start_dma(struct goku_ep *ep, struct goku_request *req)
536{
537 struct goku_udc_regs __iomem *regs = ep->dev->regs;
538 u32 master;
539 u32 start = req->req.dma;
540 u32 end = start + req->req.length - 1;
541
542 master = readl(&regs->dma_master) & MST_RW_BITS;
543
544 /* re-init the bits affecting IN dma; careful with zlps */
545 if (likely(ep->is_in)) {
546 if (unlikely(master & MST_RD_ENA)) {
547 DBG (ep->dev, "start, IN active dma %03x!!\n",
548 master);
549// return -EL2HLT;
550 }
551 writel(end, &regs->in_dma_end);
552 writel(start, &regs->in_dma_start);
553
554 master &= ~MST_R_BITS;
555 if (unlikely(req->req.length == 0))
556 master = MST_RD_ENA | MST_RD_EOPB;
557 else if ((req->req.length % ep->ep.maxpacket) != 0
558 || req->req.zero)
559 master = MST_RD_ENA | MST_EOPB_ENA;
560 else
561 master = MST_RD_ENA | MST_EOPB_DIS;
562
563 ep->dev->int_enable |= INT_MSTRDEND;
564
565 /* Goku DMA-OUT merges short packets, which plays poorly with
566 * protocols where short packets mark the transfer boundaries.
567 * The chip supports a nonstandard policy with INT_MSTWRTMOUT,
568 * ending transfers after 3 SOFs; we don't turn it on.
569 */
570 } else {
571 if (unlikely(master & MST_WR_ENA)) {
572 DBG (ep->dev, "start, OUT active dma %03x!!\n",
573 master);
574// return -EL2HLT;
575 }
576 writel(end, &regs->out_dma_end);
577 writel(start, &regs->out_dma_start);
578
579 master &= ~MST_W_BITS;
580 master |= MST_WR_ENA | MST_TIMEOUT_DIS;
581
582 ep->dev->int_enable |= INT_MSTWREND|INT_MSTWRTMOUT;
583 }
584
585 writel(master, &regs->dma_master);
586 writel(ep->dev->int_enable, &regs->int_enable);
587 return 0;
588}
589
590static void dma_advance(struct goku_udc *dev, struct goku_ep *ep)
591{
592 struct goku_request *req;
593 struct goku_udc_regs __iomem *regs = ep->dev->regs;
594 u32 master;
595
596 master = readl(&regs->dma_master);
597
598 if (unlikely(list_empty(&ep->queue))) {
599stop:
600 if (ep->is_in)
601 dev->int_enable &= ~INT_MSTRDEND;
602 else
603 dev->int_enable &= ~(INT_MSTWREND|INT_MSTWRTMOUT);
604 writel(dev->int_enable, &regs->int_enable);
605 return;
606 }
607 req = list_entry(ep->queue.next, struct goku_request, queue);
608
609 /* normal hw dma completion (not abort) */
610 if (likely(ep->is_in)) {
611 if (unlikely(master & MST_RD_ENA))
612 return;
613 req->req.actual = readl(&regs->in_dma_current);
614 } else {
615 if (unlikely(master & MST_WR_ENA))
616 return;
617
618 /* hardware merges short packets, and also hides packet
619 * overruns. a partial packet MAY be in the fifo here.
620 */
621 req->req.actual = readl(&regs->out_dma_current);
622 }
623 req->req.actual -= req->req.dma;
624 req->req.actual++;
625
626#ifdef USB_TRACE
627 VDBG(dev, "done %s %s dma, %u/%u bytes, req %p\n",
628 ep->ep.name, ep->is_in ? "IN" : "OUT",
629 req->req.actual, req->req.length, req);
630#endif
631 done(ep, req, 0);
632 if (list_empty(&ep->queue))
633 goto stop;
634 req = list_entry(ep->queue.next, struct goku_request, queue);
635 (void) start_dma(ep, req);
636}
637
638static void abort_dma(struct goku_ep *ep, int status)
639{
640 struct goku_udc_regs __iomem *regs = ep->dev->regs;
641 struct goku_request *req;
642 u32 curr, master;
643
644 /* NAK future host requests, hoping the implicit delay lets the
645 * dma engine finish reading (or writing) its latest packet and
646 * empty the dma buffer (up to 16 bytes).
647 *
648 * This avoids needing to clean up a partial packet in the fifo;
649 * we can't do that for IN without side effects to HALT and TOGGLE.
650 */
651 command(regs, COMMAND_FIFO_DISABLE, ep->num);
652 req = list_entry(ep->queue.next, struct goku_request, queue);
653 master = readl(&regs->dma_master) & MST_RW_BITS;
654
655 /* FIXME using these resets isn't usably documented. this may
656 * not work unless it's followed by disabling the endpoint.
657 *
658 * FIXME the OUT reset path doesn't even behave consistently.
659 */
660 if (ep->is_in) {
661 if (unlikely((readl(&regs->dma_master) & MST_RD_ENA) == 0))
662 goto finished;
663 curr = readl(&regs->in_dma_current);
664
665 writel(curr, &regs->in_dma_end);
666 writel(curr, &regs->in_dma_start);
667
668 master &= ~MST_R_BITS;
669 master |= MST_RD_RESET;
670 writel(master, &regs->dma_master);
671
672 if (readl(&regs->dma_master) & MST_RD_ENA)
673 DBG(ep->dev, "IN dma active after reset!\n");
674
675 } else {
676 if (unlikely((readl(&regs->dma_master) & MST_WR_ENA) == 0))
677 goto finished;
678 curr = readl(&regs->out_dma_current);
679
680 writel(curr, &regs->out_dma_end);
681 writel(curr, &regs->out_dma_start);
682
683 master &= ~MST_W_BITS;
684 master |= MST_WR_RESET;
685 writel(master, &regs->dma_master);
686
687 if (readl(&regs->dma_master) & MST_WR_ENA)
688 DBG(ep->dev, "OUT dma active after reset!\n");
689 }
690 req->req.actual = (curr - req->req.dma) + 1;
691 req->req.status = status;
692
441b62c1 693 VDBG(ep->dev, "%s %s %s %d/%d\n", __func__, ep->ep.name,
1da177e4
LT		 694 ep->is_in ? "IN" : "OUT",
695 req->req.actual, req->req.length);
696
697 command(regs, COMMAND_FIFO_ENABLE, ep->num);
698
699 return;
700
701finished:
702 /* dma already completed; no abort needed */
703 command(regs, COMMAND_FIFO_ENABLE, ep->num);
704 req->req.actual = req->req.length;
705 req->req.status = 0;
706}
707
708/*-------------------------------------------------------------------------*/
709
710static int
55016f10 711goku_queue(struct usb_ep *_ep, struct usb_request *_req, gfp_t gfp_flags)
1da177e4
LT		 712{
713 struct goku_request *req;
714 struct goku_ep *ep;
715 struct goku_udc *dev;
716 unsigned long flags;
717 int status;
718
719 /* always require a cpu-view buffer so pio works */
720 req = container_of(_req, struct goku_request, req);
721 if (unlikely(!_req || !_req->complete
722 || !_req->buf || !list_empty(&req->queue)))
723 return -EINVAL;
724 ep = container_of(_ep, struct goku_ep, ep);
725 if (unlikely(!_ep || (!ep->desc && ep->num != 0)))
726 return -EINVAL;
727 dev = ep->dev;
728 if (unlikely(!dev->driver || dev->gadget.speed == USB_SPEED_UNKNOWN))
729 return -ESHUTDOWN;
730
731 /* can't touch registers when suspended */
732 if (dev->ep0state == EP0_SUSPEND)
733 return -EBUSY;
734
735 /* set up dma mapping in case the caller didn't */
6440093f
FB		 736 if (ep->dma) {
737 status = usb_gadget_map_request(&dev->gadget, &req->req,
738 ep->is_in);
739 if (status)
740 return status;
1da177e4
LT		 741 }
742
743#ifdef USB_TRACE
744 VDBG(dev, "%s queue req %p, len %u buf %p\n",
745 _ep->name, _req, _req->length, _req->buf);
746#endif
747
748 spin_lock_irqsave(&dev->lock, flags);
749
750 _req->status = -EINPROGRESS;
751 _req->actual = 0;
752
753 /* for ep0 IN without premature status, zlp is required and
754 * writing EOP starts the status stage (OUT).
755 */
756 if (unlikely(ep->num == 0 && ep->is_in))
757 _req->zero = 1;
758
759 /* kickstart this i/o queue? */
760 status = 0;
761 if (list_empty(&ep->queue) && likely(!ep->stopped)) {
762 /* dma: done after dma completion IRQ (or error)
763 * pio: done after last fifo operation
764 */
765 if (ep->dma)
766 status = start_dma(ep, req);
767 else
768 status = (ep->is_in ? write_fifo : read_fifo)(ep, req);
769
770 if (unlikely(status != 0)) {
771 if (status > 0)
772 status = 0;
773 req = NULL;
774 }
775
776 } /* else pio or dma irq handler advances the queue. */
777
778 if (likely(req != 0))
779 list_add_tail(&req->queue, &ep->queue);
780
781 if (likely(!list_empty(&ep->queue))
782 && likely(ep->num != 0)
783 && !ep->dma
784 && !(dev->int_enable & INT_EPxDATASET (ep->num)))
785 pio_irq_enable(dev, dev->regs, ep->num);
786
787 spin_unlock_irqrestore(&dev->lock, flags);
788
789 /* pci writes may still be posted */
790 return status;
791}
792
793/* dequeue ALL requests */
794static void nuke(struct goku_ep *ep, int status)
795{
796 struct goku_request *req;
797
798 ep->stopped = 1;
799 if (list_empty(&ep->queue))
800 return;
801 if (ep->dma)
802 abort_dma(ep, status);
803 while (!list_empty(&ep->queue)) {
804 req = list_entry(ep->queue.next, struct goku_request, queue);
805 done(ep, req, status);
806 }
807}
808
809/* dequeue JUST ONE request */
810static int goku_dequeue(struct usb_ep *_ep, struct usb_request *_req)
811{
812 struct goku_request *req;
813 struct goku_ep *ep;
814 struct goku_udc *dev;
815 unsigned long flags;
816
817 ep = container_of(_ep, struct goku_ep, ep);
818 if (!_ep || !_req || (!ep->desc && ep->num != 0))
819 return -EINVAL;
820 dev = ep->dev;
821 if (!dev->driver)
822 return -ESHUTDOWN;
823
824 /* we can't touch (dma) registers when suspended */
825 if (dev->ep0state == EP0_SUSPEND)
826 return -EBUSY;
827
441b62c1 828 VDBG(dev, "%s %s %s %s %p\n", __func__, _ep->name,
1da177e4
LT		 829 ep->is_in ? "IN" : "OUT",
830 ep->dma ? "dma" : "pio",
831 _req);
832
833 spin_lock_irqsave(&dev->lock, flags);
834
835 /* make sure it's actually queued on this endpoint */
836 list_for_each_entry (req, &ep->queue, queue) {
837 if (&req->req == _req)
838 break;
839 }
840 if (&req->req != _req) {
841 spin_unlock_irqrestore (&dev->lock, flags);
842 return -EINVAL;
843 }
844
845 if (ep->dma && ep->queue.next == &req->queue && !ep->stopped) {
846 abort_dma(ep, -ECONNRESET);
847 done(ep, req, -ECONNRESET);
848 dma_advance(dev, ep);
849 } else if (!list_empty(&req->queue))
850 done(ep, req, -ECONNRESET);
851 else
852 req = NULL;
853 spin_unlock_irqrestore(&dev->lock, flags);
854
855 return req ? 0 : -EOPNOTSUPP;
856}
857
858/*-------------------------------------------------------------------------*/
859
860static void goku_clear_halt(struct goku_ep *ep)
861{
862 // assert (ep->num !=0)
863 VDBG(ep->dev, "%s clear halt\n", ep->ep.name);
864 command(ep->dev->regs, COMMAND_SETDATA0, ep->num);
865 command(ep->dev->regs, COMMAND_STALL_CLEAR, ep->num);
866 if (ep->stopped) {
867 ep->stopped = 0;
868 if (ep->dma) {
869 struct goku_request *req;
870
871 if (list_empty(&ep->queue))
872 return;
873 req = list_entry(ep->queue.next, struct goku_request,
874 queue);
875 (void) start_dma(ep, req);
876 } else
877 pio_advance(ep);
878 }
879}
880
881static int goku_set_halt(struct usb_ep *_ep, int value)
882{
883 struct goku_ep *ep;
884 unsigned long flags;
885 int retval = 0;
886
887 if (!_ep)
888 return -ENODEV;
889 ep = container_of (_ep, struct goku_ep, ep);
890
891 if (ep->num == 0) {
892 if (value) {
893 ep->dev->ep0state = EP0_STALL;
894 ep->dev->ep[0].stopped = 1;
895 } else
896 return -EINVAL;
897
898 /* don't change EPxSTATUS_EP_INVALID to READY */
899 } else if (!ep->desc) {
441b62c1 900 DBG(ep->dev, "%s %s inactive?\n", __func__, ep->ep.name);
1da177e4
LT		 901 return -EINVAL;
902 }
903
904 spin_lock_irqsave(&ep->dev->lock, flags);
905 if (!list_empty(&ep->queue))
906 retval = -EAGAIN;
907 else if (ep->is_in && value
908 /* data in (either) packet buffer? */
909 && (readl(&ep->dev->regs->DataSet)
910 & DATASET_AB(ep->num)))
911 retval = -EAGAIN;
912 else if (!value)
913 goku_clear_halt(ep);
914 else {
915 ep->stopped = 1;
916 VDBG(ep->dev, "%s set halt\n", ep->ep.name);
917 command(ep->dev->regs, COMMAND_STALL, ep->num);
918 readl(ep->reg_status);
919 }
920 spin_unlock_irqrestore(&ep->dev->lock, flags);
921 return retval;
922}
923
924static int goku_fifo_status(struct usb_ep *_ep)
925{
926 struct goku_ep *ep;
927 struct goku_udc_regs __iomem *regs;
928 u32 size;
929
930 if (!_ep)
931 return -ENODEV;
932 ep = container_of(_ep, struct goku_ep, ep);
933
934 /* size is only reported sanely for OUT */
935 if (ep->is_in)
936 return -EOPNOTSUPP;
937
938 /* ignores 16-byte dma buffer; SizeH == 0 */
939 regs = ep->dev->regs;
940 size = readl(&regs->EPxSizeLA[ep->num]) & DATASIZE;
941 size += readl(&regs->EPxSizeLB[ep->num]) & DATASIZE;
441b62c1 942 VDBG(ep->dev, "%s %s %u\n", __func__, ep->ep.name, size);
1da177e4
LT		 943 return size;
944}
945
946static void goku_fifo_flush(struct usb_ep *_ep)
947{
948 struct goku_ep *ep;
949 struct goku_udc_regs __iomem *regs;
950 u32 size;
951
952 if (!_ep)
953 return;
954 ep = container_of(_ep, struct goku_ep, ep);
441b62c1 955 VDBG(ep->dev, "%s %s\n", __func__, ep->ep.name);
1da177e4
LT		 956
957 /* don't change EPxSTATUS_EP_INVALID to READY */
958 if (!ep->desc && ep->num != 0) {
441b62c1 959 DBG(ep->dev, "%s %s inactive?\n", __func__, ep->ep.name);
1da177e4
LT		 960 return;
961 }
962
963 regs = ep->dev->regs;
964 size = readl(&regs->EPxSizeLA[ep->num]);
965 size &= DATASIZE;
966
967 /* Non-desirable behavior: FIFO_CLEAR also clears the
968 * endpoint halt feature. For OUT, we _could_ just read
969 * the bytes out (PIO, if !ep->dma); for in, no choice.
970 */
971 if (size)
972 command(regs, COMMAND_FIFO_CLEAR, ep->num);
973}
974
975static struct usb_ep_ops goku_ep_ops = {
976 .enable = goku_ep_enable,
977 .disable = goku_ep_disable,
978
979 .alloc_request = goku_alloc_request,
980 .free_request = goku_free_request,
981
1da177e4
LT		 982 .queue = goku_queue,
983 .dequeue = goku_dequeue,
984
985 .set_halt = goku_set_halt,
986 .fifo_status = goku_fifo_status,
987 .fifo_flush = goku_fifo_flush,
988};
989
990/*-------------------------------------------------------------------------*/
991
992static int goku_get_frame(struct usb_gadget *_gadget)
993{
994 return -EOPNOTSUPP;
995}
996
0f91349b
SAS		 997static int goku_start(struct usb_gadget_driver *driver,
998 int (*bind)(struct usb_gadget *));
999static int goku_stop(struct usb_gadget_driver *driver);
1000
1da177e4
LT		 1001static const struct usb_gadget_ops goku_ops = {
1002 .get_frame = goku_get_frame,
0f91349b
SAS		 1003 .start = goku_start,
1004 .stop = goku_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
LT		 1154
1155 if (i && !ep->desc)
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
1343static struct goku_udc *the_controller;
1344
1345/* when a driver is successfully registered, it will receive
1346 * control requests including set_configuration(), which enables
1347 * non-control requests. then usb traffic follows until a
1348 * disconnect is reported. then a host may connect again, or
1349 * the driver might get unbound.
1350 */
0f91349b 1351static int goku_start(struct usb_gadget_driver *driver,
b0fca50f 1352 int (*bind)(struct usb_gadget *))
1da177e4
LT		 1353{
1354 struct goku_udc *dev = the_controller;
1355 int retval;
1356
1357 if (!driver
7177aed4 1358 || driver->max_speed < USB_SPEED_FULL
b0fca50f 1359 || !bind
1da177e4
LT		 1360 || !driver->disconnect
1361 || !driver->setup)
1362 return -EINVAL;
1363 if (!dev)
1364 return -ENODEV;
1365 if (dev->driver)
1366 return -EBUSY;
1367
1368 /* hook up the driver */
1369 driver->driver.bus = NULL;
1370 dev->driver = driver;
1371 dev->gadget.dev.driver = &driver->driver;
b0fca50f 1372 retval = bind(&dev->gadget);
1da177e4
LT		 1373 if (retval) {
1374 DBG(dev, "bind to driver %s --> error %d\n",
1375 driver->driver.name, retval);
1376 dev->driver = NULL;
1377 dev->gadget.dev.driver = NULL;
1378 return retval;
1379 }
1380
1381 /* then enable host detection and ep0; and we're ready
1382 * for set_configuration as well as eventual disconnect.
1383 */
1384 udc_enable(dev);
1385
1386 DBG(dev, "registered gadget driver '%s'\n", driver->driver.name);
1387 return 0;
1388}
1da177e4
LT		 1389
1390static void
1391stop_activity(struct goku_udc *dev, struct usb_gadget_driver *driver)
1392{
1393 unsigned i;
1394
441b62c1 1395 DBG (dev, "%s\n", __func__);
1da177e4
LT		 1396
1397 if (dev->gadget.speed == USB_SPEED_UNKNOWN)
1398 driver = NULL;
1399
1400 /* disconnect gadget driver after quiesceing hw and the driver */
1401 udc_reset (dev);
1402 for (i = 0; i < 4; i++)
1403 nuke(&dev->ep [i], -ESHUTDOWN);
1404 if (driver) {
1405 spin_unlock(&dev->lock);
1406 driver->disconnect(&dev->gadget);
1407 spin_lock(&dev->lock);
1408 }
1409
1410 if (dev->driver)
1411 udc_enable(dev);
1412}
1413
0f91349b 1414static int goku_stop(struct usb_gadget_driver *driver)
1da177e4
LT		 1415{
1416 struct goku_udc *dev = the_controller;
1417 unsigned long flags;
1418
1419 if (!dev)
1420 return -ENODEV;
6bea476c 1421 if (!driver || driver != dev->driver || !driver->unbind)
1da177e4
LT		 1422 return -EINVAL;
1423
1424 spin_lock_irqsave(&dev->lock, flags);
1425 dev->driver = NULL;
1426 stop_activity(dev, driver);
1427 spin_unlock_irqrestore(&dev->lock, flags);
1428
1429 driver->unbind(&dev->gadget);
eb0be47d 1430 dev->gadget.dev.driver = NULL;
1da177e4
LT		 1431
1432 DBG(dev, "unregistered driver '%s'\n", driver->driver.name);
1433 return 0;
1434}
1da177e4
LT		 1435
1436/*-------------------------------------------------------------------------*/
1437
1438static void ep0_setup(struct goku_udc *dev)
1439{
1440 struct goku_udc_regs __iomem *regs = dev->regs;
1441 struct usb_ctrlrequest ctrl;
1442 int tmp;
1443
1444 /* read SETUP packet and enter DATA stage */
1445 ctrl.bRequestType = readl(&regs->bRequestType);
1446 ctrl.bRequest = readl(&regs->bRequest);
988199fe
DB		 1447 ctrl.wValue = cpu_to_le16((readl(&regs->wValueH) << 8)
1448 | readl(&regs->wValueL));
1449 ctrl.wIndex = cpu_to_le16((readl(&regs->wIndexH) << 8)
1450 | readl(&regs->wIndexL));
1451 ctrl.wLength = cpu_to_le16((readl(&regs->wLengthH) << 8)
1452 | readl(&regs->wLengthL));
1da177e4
LT		 1453 writel(0, &regs->SetupRecv);
1454
1455 nuke(&dev->ep[0], 0);
1456 dev->ep[0].stopped = 0;
1457 if (likely(ctrl.bRequestType & USB_DIR_IN)) {
1458 dev->ep[0].is_in = 1;
1459 dev->ep0state = EP0_IN;
1460 /* detect early status stages */
1461 writel(ICONTROL_STATUSNAK, &dev->regs->IntControl);
1462 } else {
1463 dev->ep[0].is_in = 0;
1464 dev->ep0state = EP0_OUT;
1465
1466 /* NOTE: CLEAR_FEATURE is done in software so that we can
1467 * synchronize transfer restarts after bulk IN stalls. data
1468 * won't even enter the fifo until the halt is cleared.
1469 */
1470 switch (ctrl.bRequest) {
1471 case USB_REQ_CLEAR_FEATURE:
1472 switch (ctrl.bRequestType) {
1473 case USB_RECIP_ENDPOINT:
988199fe 1474 tmp = le16_to_cpu(ctrl.wIndex) & 0x0f;
1da177e4
LT		 1475 /* active endpoint */
1476 if (tmp > 3 || (!dev->ep[tmp].desc && tmp != 0))
1477 goto stall;
551509d2 1478 if (ctrl.wIndex & cpu_to_le16(
988199fe 1479 USB_DIR_IN)) {
1da177e4
LT		 1480 if (!dev->ep[tmp].is_in)
1481 goto stall;
1482 } else {
1483 if (dev->ep[tmp].is_in)
1484 goto stall;
1485 }
551509d2 1486 if (ctrl.wValue != cpu_to_le16(
988199fe 1487 USB_ENDPOINT_HALT))
1da177e4
LT		 1488 goto stall;
1489 if (tmp)
1490 goku_clear_halt(&dev->ep[tmp]);
1491succeed:
1492 /* start ep0out status stage */
1493 writel(~(1<<0), &regs->EOP);
1494 dev->ep[0].stopped = 1;
1495 dev->ep0state = EP0_STATUS;
1496 return;
1497 case USB_RECIP_DEVICE:
1498 /* device remote wakeup: always clear */
551509d2 1499 if (ctrl.wValue != cpu_to_le16(1))
1da177e4
LT		 1500 goto stall;
1501 VDBG(dev, "clear dev remote wakeup\n");
1502 goto succeed;
1503 case USB_RECIP_INTERFACE:
1504 goto stall;
1505 default: /* pass to gadget driver */
1506 break;
1507 }
1508 break;
1509 default:
1510 break;
1511 }
1512 }
1513
1514#ifdef USB_TRACE
1515 VDBG(dev, "SETUP %02x.%02x v%04x i%04x l%04x\n",
1516 ctrl.bRequestType, ctrl.bRequest,
988199fe
DB		 1517 le16_to_cpu(ctrl.wValue), le16_to_cpu(ctrl.wIndex),
1518 le16_to_cpu(ctrl.wLength));
1da177e4
LT		 1519#endif
1520
1521 /* hw wants to know when we're configured (or not) */
1522 dev->req_config = (ctrl.bRequest == USB_REQ_SET_CONFIGURATION
1523 && ctrl.bRequestType == USB_RECIP_DEVICE);
1524 if (unlikely(dev->req_config))
551509d2 1525 dev->configured = (ctrl.wValue != cpu_to_le16(0));
1da177e4
LT		 1526
1527 /* delegate everything to the gadget driver.
1528 * it may respond after this irq handler returns.
1529 */
1530 spin_unlock (&dev->lock);
1531 tmp = dev->driver->setup(&dev->gadget, &ctrl);
1532 spin_lock (&dev->lock);
1533 if (unlikely(tmp < 0)) {
1534stall:
1535#ifdef USB_TRACE
1536 VDBG(dev, "req %02x.%02x protocol STALL; err %d\n",
1537 ctrl.bRequestType, ctrl.bRequest, tmp);
1538#endif
1539 command(regs, COMMAND_STALL, 0);
1540 dev->ep[0].stopped = 1;
1541 dev->ep0state = EP0_STALL;
1542 }
1543
1544 /* expect at least one data or status stage irq */
1545}
1546
1547#define ACK(irqbit) { \
1548 stat &= ~irqbit; \
1549 writel(~irqbit, &regs->int_status); \
1550 handled = 1; \
1551 }
1552
7d12e780 1553static irqreturn_t goku_irq(int irq, void *_dev)
1da177e4
LT		 1554{
1555 struct goku_udc *dev = _dev;
1556 struct goku_udc_regs __iomem *regs = dev->regs;
1557 struct goku_ep *ep;
1558 u32 stat, handled = 0;
1559 unsigned i, rescans = 5;
1560
1561 spin_lock(&dev->lock);
1562
1563rescan:
1564 stat = readl(&regs->int_status) & dev->int_enable;
1565 if (!stat)
1566 goto done;
1567 dev->irqs++;
1568
1569 /* device-wide irqs */
1570 if (unlikely(stat & INT_DEVWIDE)) {
1571 if (stat & INT_SYSERROR) {
1572 ERROR(dev, "system error\n");
1573 stop_activity(dev, dev->driver);
1574 stat = 0;
1575 handled = 1;
1576 // FIXME have a neater way to prevent re-enumeration
1577 dev->driver = NULL;
1578 goto done;
1579 }
1580 if (stat & INT_PWRDETECT) {
1581 writel(~stat, &regs->int_status);
1582 if (readl(&dev->regs->power_detect) & PW_DETECT) {
1583 VDBG(dev, "connect\n");
1584 ep0_start(dev);
1585 } else {
1586 DBG(dev, "disconnect\n");
1587 if (dev->gadget.speed == USB_SPEED_FULL)
1588 stop_activity(dev, dev->driver);
1589 dev->ep0state = EP0_DISCONNECT;
1590 dev->int_enable = INT_DEVWIDE;
1591 writel(dev->int_enable, &dev->regs->int_enable);
1592 }
1593 stat = 0;
1594 handled = 1;
1595 goto done;
1596 }
1597 if (stat & INT_SUSPEND) {
1598 ACK(INT_SUSPEND);
1599 if (readl(&regs->ep_status[0]) & EPxSTATUS_SUSPEND) {
1600 switch (dev->ep0state) {
1601 case EP0_DISCONNECT:
1602 case EP0_SUSPEND:
1603 goto pm_next;
1604 default:
1605 break;
1606 }
1607 DBG(dev, "USB suspend\n");
1608 dev->ep0state = EP0_SUSPEND;
1609 if (dev->gadget.speed != USB_SPEED_UNKNOWN
1610 && dev->driver
1611 && dev->driver->suspend) {
1612 spin_unlock(&dev->lock);
1613 dev->driver->suspend(&dev->gadget);
1614 spin_lock(&dev->lock);
1615 }
1616 } else {
1617 if (dev->ep0state != EP0_SUSPEND) {
1618 DBG(dev, "bogus USB resume %d\n",
1619 dev->ep0state);
1620 goto pm_next;
1621 }
1622 DBG(dev, "USB resume\n");
1623 dev->ep0state = EP0_IDLE;
1624 if (dev->gadget.speed != USB_SPEED_UNKNOWN
1625 && dev->driver
1626 && dev->driver->resume) {
1627 spin_unlock(&dev->lock);
1628 dev->driver->resume(&dev->gadget);
1629 spin_lock(&dev->lock);
1630 }
1631 }
1632 }
1633pm_next:
1634 if (stat & INT_USBRESET) { /* hub reset done */
1635 ACK(INT_USBRESET);
1636 INFO(dev, "USB reset done, gadget %s\n",
1637 dev->driver->driver.name);
1638 }
1639 // and INT_ERR on some endpoint's crc/bitstuff/... problem
1640 }
1641
1642 /* progress ep0 setup, data, or status stages.
1643 * no transition {EP0_STATUS, EP0_STALL} --> EP0_IDLE; saves irqs
1644 */
1645 if (stat & INT_SETUP) {
1646 ACK(INT_SETUP);
1647 dev->ep[0].irqs++;
1648 ep0_setup(dev);
1649 }
1650 if (stat & INT_STATUSNAK) {
1651 ACK(INT_STATUSNAK|INT_ENDPOINT0);
1652 if (dev->ep0state == EP0_IN) {
1653 ep = &dev->ep[0];
1654 ep->irqs++;
1655 nuke(ep, 0);
1656 writel(~(1<<0), &regs->EOP);
1657 dev->ep0state = EP0_STATUS;
1658 }
1659 }
1660 if (stat & INT_ENDPOINT0) {
1661 ACK(INT_ENDPOINT0);
1662 ep = &dev->ep[0];
1663 ep->irqs++;
1664 pio_advance(ep);
1665 }
1666
1667 /* dma completion */
1668 if (stat & INT_MSTRDEND) { /* IN */
1669 ACK(INT_MSTRDEND);
1670 ep = &dev->ep[UDC_MSTRD_ENDPOINT];
1671 ep->irqs++;
1672 dma_advance(dev, ep);
1673 }
1674 if (stat & INT_MSTWREND) { /* OUT */
1675 ACK(INT_MSTWREND);
1676 ep = &dev->ep[UDC_MSTWR_ENDPOINT];
1677 ep->irqs++;
1678 dma_advance(dev, ep);
1679 }
1680 if (stat & INT_MSTWRTMOUT) { /* OUT */
1681 ACK(INT_MSTWRTMOUT);
1682 ep = &dev->ep[UDC_MSTWR_ENDPOINT];
1683 ep->irqs++;
1684 ERROR(dev, "%s write timeout ?\n", ep->ep.name);
1685 // reset dma? then dma_advance()
1686 }
1687
1688 /* pio */
1689 for (i = 1; i < 4; i++) {
1690 u32 tmp = INT_EPxDATASET(i);
1691
1692 if (!(stat & tmp))
1693 continue;
1694 ep = &dev->ep[i];
1695 pio_advance(ep);
1696 if (list_empty (&ep->queue))
1697 pio_irq_disable(dev, regs, i);
1698 stat &= ~tmp;
1699 handled = 1;
1700 ep->irqs++;
1701 }
1702
1703 if (rescans--)
1704 goto rescan;
1705
1706done:
1707 (void)readl(&regs->int_enable);
1708 spin_unlock(&dev->lock);
1709 if (stat)
1710 DBG(dev, "unhandled irq status: %05x (%05x, %05x)\n", stat,
1711 readl(&regs->int_status), dev->int_enable);
1712 return IRQ_RETVAL(handled);
1713}
1714
1715#undef ACK
1716
1717/*-------------------------------------------------------------------------*/
1718
1719static void gadget_release(struct device *_dev)
1720{
1721 struct goku_udc *dev = dev_get_drvdata(_dev);
1722
1723 kfree(dev);
1724}
1725
1726/* tear down the binding between this driver and the pci device */
1727
1728static void goku_remove(struct pci_dev *pdev)
1729{
1730 struct goku_udc *dev = pci_get_drvdata(pdev);
1731
441b62c1 1732 DBG(dev, "%s\n", __func__);
6bea476c 1733
0f91349b
SAS		 1734 usb_del_gadget_udc(&dev->gadget);
1735
6bea476c 1736 BUG_ON(dev->driver);
1da177e4
LT		 1737
1738#ifdef CONFIG_USB_GADGET_DEBUG_FILES
1739 remove_proc_entry(proc_node_name, NULL);
1740#endif
1741 if (dev->regs)
1742 udc_reset(dev);
1743 if (dev->got_irq)
1744 free_irq(pdev->irq, dev);
1745 if (dev->regs)
1746 iounmap(dev->regs);
1747 if (dev->got_region)
1748 release_mem_region(pci_resource_start (pdev, 0),
1749 pci_resource_len (pdev, 0));
1750 if (dev->enabled)
1751 pci_disable_device(pdev);
319feaab
DC		 1752 if (dev->registered)
1753 device_unregister(&dev->gadget.dev);
1da177e4
LT		 1754
1755 pci_set_drvdata(pdev, NULL);
1756 dev->regs = NULL;
1757 the_controller = NULL;
1758
1759 INFO(dev, "unbind\n");
1760}
1761
1762/* wrap this driver around the specified pci device, but
1763 * don't respond over USB until a gadget driver binds to us.
1764 */
1765
1766static int goku_probe(struct pci_dev *pdev, const struct pci_device_id *id)
1767{
1768 struct goku_udc *dev = NULL;
1769 unsigned long resource, len;
1770 void __iomem *base = NULL;
1771 int retval;
1da177e4
LT		 1772
1773 /* if you want to support more than one controller in a system,
1774 * usb_gadget_driver_{register,unregister}() must change.
1775 */
1776 if (the_controller) {
872f8b42 1777 pr_warning("ignoring %s\n", pci_name(pdev));
1da177e4
LT		 1778 return -EBUSY;
1779 }
1780 if (!pdev->irq) {
1781 printk(KERN_ERR "Check PCI %s IRQ setup!\n", pci_name(pdev));
1782 retval = -ENODEV;
319feaab 1783 goto err;
1da177e4
LT		 1784 }
1785
1786 /* alloc, and start init */
dd00cc48 1787 dev = kzalloc (sizeof *dev, GFP_KERNEL);
1da177e4
LT		 1788 if (dev == NULL){
1789 pr_debug("enomem %s\n", pci_name(pdev));
1790 retval = -ENOMEM;
319feaab 1791 goto err;
1da177e4
LT		 1792 }
1793
1da177e4
LT		 1794 spin_lock_init(&dev->lock);
1795 dev->pdev = pdev;
1796 dev->gadget.ops = &goku_ops;
d327ab5b 1797 dev->gadget.max_speed = USB_SPEED_FULL;
1da177e4
LT		 1798
1799 /* the "gadget" abstracts/virtualizes the controller */
0031a06e 1800 dev_set_name(&dev->gadget.dev, "gadget");
1da177e4
LT		 1801 dev->gadget.dev.parent = &pdev->dev;
1802 dev->gadget.dev.dma_mask = pdev->dev.dma_mask;
1803 dev->gadget.dev.release = gadget_release;
1804 dev->gadget.name = driver_name;
1805
1806 /* now all the pci goodies ... */
1807 retval = pci_enable_device(pdev);
1808 if (retval < 0) {
1809 DBG(dev, "can't enable, %d\n", retval);
319feaab 1810 goto err;
1da177e4
LT		 1811 }
1812 dev->enabled = 1;
1813
1814 resource = pci_resource_start(pdev, 0);
1815 len = pci_resource_len(pdev, 0);
1816 if (!request_mem_region(resource, len, driver_name)) {
1817 DBG(dev, "controller already in use\n");
1818 retval = -EBUSY;
319feaab 1819 goto err;
1da177e4
LT		 1820 }
1821 dev->got_region = 1;
1822
1823 base = ioremap_nocache(resource, len);
1824 if (base == NULL) {
1825 DBG(dev, "can't map memory\n");
1826 retval = -EFAULT;
319feaab 1827 goto err;
1da177e4
LT		 1828 }
1829 dev->regs = (struct goku_udc_regs __iomem *) base;
1830
1831 pci_set_drvdata(pdev, dev);
1832 INFO(dev, "%s\n", driver_desc);
1833 INFO(dev, "version: " DRIVER_VERSION " %s\n", dmastr());
c6387a48 1834 INFO(dev, "irq %d, pci mem %p\n", pdev->irq, base);
1da177e4
LT		 1835
1836 /* init to known state, then setup irqs */
1837 udc_reset(dev);
1838 udc_reinit (dev);
d54b5caa 1839 if (request_irq(pdev->irq, goku_irq, IRQF_SHARED/*|IRQF_SAMPLE_RANDOM*/,
1da177e4 1840 driver_name, dev) != 0) {
c6387a48 1841 DBG(dev, "request interrupt %d failed\n", pdev->irq);
1da177e4 1842 retval = -EBUSY;
319feaab 1843 goto err;
1da177e4
LT		 1844 }
1845 dev->got_irq = 1;
1846 if (use_dma)
1847 pci_set_master(pdev);
1848
1849
1850#ifdef CONFIG_USB_GADGET_DEBUG_FILES
1851 create_proc_read_entry(proc_node_name, 0, NULL, udc_proc_read, dev);
1852#endif
1853
1da177e4 1854 the_controller = dev;
2d70c99b 1855 retval = device_register(&dev->gadget.dev);
319feaab
DC		 1856 if (retval) {
1857 put_device(&dev->gadget.dev);
1858 goto err;
1859 }
1860 dev->registered = 1;
0f91349b
SAS		 1861 retval = usb_add_gadget_udc(&pdev->dev, &dev->gadget);
1862 if (retval)
1863 goto err;
1864
319feaab 1865 return 0;
1da177e4 1866
319feaab 1867err:
1da177e4
LT		 1868 if (dev)
1869 goku_remove (pdev);
1870 return retval;
1871}
1872
1873
1874/*-------------------------------------------------------------------------*/
1875
1ba2557f 1876static const struct pci_device_id pci_ids[] = { {
2d70c99b
DB		 1877 .class = ((PCI_CLASS_SERIAL_USB << 8) | 0xfe),
1878 .class_mask = ~0,
1da177e4
LT		 1879 .vendor = 0x102f, /* Toshiba */
1880 .device = 0x0107, /* this UDC */
1881 .subvendor = PCI_ANY_ID,
1882 .subdevice = PCI_ANY_ID,
1883
1884}, { /* end: all zeroes */ }
1885};
1886MODULE_DEVICE_TABLE (pci, pci_ids);
1887
1888static struct pci_driver goku_pci_driver = {
1889 .name = (char *) driver_name,
1890 .id_table = pci_ids,
1891
1892 .probe = goku_probe,
1893 .remove = goku_remove,
1894
1895 /* FIXME add power management support */
1896};
1897
3cdb7721 1898module_pci_driver(goku_pci_driver);
ubuntu-bionic-kernel mirror