usb: musb: gadget: use variables according to their names in rxstate()
[platform/upstream/kernel-adaptation-pc.git] / drivers / usb / musb / musb_gadget.c
1 /*
2  * MUSB OTG driver peripheral support
3  *
4  * Copyright 2005 Mentor Graphics Corporation
5  * Copyright (C) 2005-2006 by Texas Instruments
6  * Copyright (C) 2006-2007 Nokia Corporation
7  * Copyright (C) 2009 MontaVista Software, Inc. <source@mvista.com>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * version 2 as published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21  * 02110-1301 USA
22  *
23  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
24  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
26  * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
29  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
30  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  */
35
36 #include <linux/kernel.h>
37 #include <linux/list.h>
38 #include <linux/timer.h>
39 #include <linux/module.h>
40 #include <linux/smp.h>
41 #include <linux/spinlock.h>
42 #include <linux/delay.h>
43 #include <linux/dma-mapping.h>
44 #include <linux/slab.h>
45
46 #include "musb_core.h"
47
48
49 /* MUSB PERIPHERAL status 3-mar-2006:
50  *
51  * - EP0 seems solid.  It passes both USBCV and usbtest control cases.
52  *   Minor glitches:
53  *
54  *     + remote wakeup to Linux hosts work, but saw USBCV failures;
55  *       in one test run (operator error?)
56  *     + endpoint halt tests -- in both usbtest and usbcv -- seem
57  *       to break when dma is enabled ... is something wrongly
58  *       clearing SENDSTALL?
59  *
60  * - Mass storage behaved ok when last tested.  Network traffic patterns
61  *   (with lots of short transfers etc) need retesting; they turn up the
62  *   worst cases of the DMA, since short packets are typical but are not
63  *   required.
64  *
65  * - TX/IN
66  *     + both pio and dma behave in with network and g_zero tests
67  *     + no cppi throughput issues other than no-hw-queueing
68  *     + failed with FLAT_REG (DaVinci)
69  *     + seems to behave with double buffering, PIO -and- CPPI
70  *     + with gadgetfs + AIO, requests got lost?
71  *
72  * - RX/OUT
73  *     + both pio and dma behave in with network and g_zero tests
74  *     + dma is slow in typical case (short_not_ok is clear)
75  *     + double buffering ok with PIO
76  *     + double buffering *FAILS* with CPPI, wrong data bytes sometimes
77  *     + request lossage observed with gadgetfs
78  *
79  * - ISO not tested ... might work, but only weakly isochronous
80  *
81  * - Gadget driver disabling of softconnect during bind() is ignored; so
82  *   drivers can't hold off host requests until userspace is ready.
83  *   (Workaround:  they can turn it off later.)
84  *
85  * - PORTABILITY (assumes PIO works):
86  *     + DaVinci, basically works with cppi dma
87  *     + OMAP 2430, ditto with mentor dma
88  *     + TUSB 6010, platform-specific dma in the works
89  */
90
91 /* ----------------------------------------------------------------------- */
92
93 #define is_buffer_mapped(req) (is_dma_capable() && \
94                                         (req->map_state != UN_MAPPED))
95
96 /* Maps the buffer to dma  */
97
98 static inline void map_dma_buffer(struct musb_request *request,
99                         struct musb *musb, struct musb_ep *musb_ep)
100 {
101         int compatible = true;
102         struct dma_controller *dma = musb->dma_controller;
103
104         request->map_state = UN_MAPPED;
105
106         if (!is_dma_capable() || !musb_ep->dma)
107                 return;
108
109         /* Check if DMA engine can handle this request.
110          * DMA code must reject the USB request explicitly.
111          * Default behaviour is to map the request.
112          */
113         if (dma->is_compatible)
114                 compatible = dma->is_compatible(musb_ep->dma,
115                                 musb_ep->packet_sz, request->request.buf,
116                                 request->request.length);
117         if (!compatible)
118                 return;
119
120         if (request->request.dma == DMA_ADDR_INVALID) {
121                 request->request.dma = dma_map_single(
122                                 musb->controller,
123                                 request->request.buf,
124                                 request->request.length,
125                                 request->tx
126                                         ? DMA_TO_DEVICE
127                                         : DMA_FROM_DEVICE);
128                 request->map_state = MUSB_MAPPED;
129         } else {
130                 dma_sync_single_for_device(musb->controller,
131                         request->request.dma,
132                         request->request.length,
133                         request->tx
134                                 ? DMA_TO_DEVICE
135                                 : DMA_FROM_DEVICE);
136                 request->map_state = PRE_MAPPED;
137         }
138 }
139
140 /* Unmap the buffer from dma and maps it back to cpu */
141 static inline void unmap_dma_buffer(struct musb_request *request,
142                                 struct musb *musb)
143 {
144         if (!is_buffer_mapped(request))
145                 return;
146
147         if (request->request.dma == DMA_ADDR_INVALID) {
148                 dev_vdbg(musb->controller,
149                                 "not unmapping a never mapped buffer\n");
150                 return;
151         }
152         if (request->map_state == MUSB_MAPPED) {
153                 dma_unmap_single(musb->controller,
154                         request->request.dma,
155                         request->request.length,
156                         request->tx
157                                 ? DMA_TO_DEVICE
158                                 : DMA_FROM_DEVICE);
159                 request->request.dma = DMA_ADDR_INVALID;
160         } else { /* PRE_MAPPED */
161                 dma_sync_single_for_cpu(musb->controller,
162                         request->request.dma,
163                         request->request.length,
164                         request->tx
165                                 ? DMA_TO_DEVICE
166                                 : DMA_FROM_DEVICE);
167         }
168         request->map_state = UN_MAPPED;
169 }
170
171 /*
172  * Immediately complete a request.
173  *
174  * @param request the request to complete
175  * @param status the status to complete the request with
176  * Context: controller locked, IRQs blocked.
177  */
178 void musb_g_giveback(
179         struct musb_ep          *ep,
180         struct usb_request      *request,
181         int                     status)
182 __releases(ep->musb->lock)
183 __acquires(ep->musb->lock)
184 {
185         struct musb_request     *req;
186         struct musb             *musb;
187         int                     busy = ep->busy;
188
189         req = to_musb_request(request);
190
191         list_del(&req->list);
192         if (req->request.status == -EINPROGRESS)
193                 req->request.status = status;
194         musb = req->musb;
195
196         ep->busy = 1;
197         spin_unlock(&musb->lock);
198         unmap_dma_buffer(req, musb);
199         if (request->status == 0)
200                 dev_dbg(musb->controller, "%s done request %p,  %d/%d\n",
201                                 ep->end_point.name, request,
202                                 req->request.actual, req->request.length);
203         else
204                 dev_dbg(musb->controller, "%s request %p, %d/%d fault %d\n",
205                                 ep->end_point.name, request,
206                                 req->request.actual, req->request.length,
207                                 request->status);
208         req->request.complete(&req->ep->end_point, &req->request);
209         spin_lock(&musb->lock);
210         ep->busy = busy;
211 }
212
213 /* ----------------------------------------------------------------------- */
214
215 /*
216  * Abort requests queued to an endpoint using the status. Synchronous.
217  * caller locked controller and blocked irqs, and selected this ep.
218  */
219 static void nuke(struct musb_ep *ep, const int status)
220 {
221         struct musb             *musb = ep->musb;
222         struct musb_request     *req = NULL;
223         void __iomem *epio = ep->musb->endpoints[ep->current_epnum].regs;
224
225         ep->busy = 1;
226
227         if (is_dma_capable() && ep->dma) {
228                 struct dma_controller   *c = ep->musb->dma_controller;
229                 int value;
230
231                 if (ep->is_in) {
232                         /*
233                          * The programming guide says that we must not clear
234                          * the DMAMODE bit before DMAENAB, so we only
235                          * clear it in the second write...
236                          */
237                         musb_writew(epio, MUSB_TXCSR,
238                                     MUSB_TXCSR_DMAMODE | MUSB_TXCSR_FLUSHFIFO);
239                         musb_writew(epio, MUSB_TXCSR,
240                                         0 | MUSB_TXCSR_FLUSHFIFO);
241                 } else {
242                         musb_writew(epio, MUSB_RXCSR,
243                                         0 | MUSB_RXCSR_FLUSHFIFO);
244                         musb_writew(epio, MUSB_RXCSR,
245                                         0 | MUSB_RXCSR_FLUSHFIFO);
246                 }
247
248                 value = c->channel_abort(ep->dma);
249                 dev_dbg(musb->controller, "%s: abort DMA --> %d\n",
250                                 ep->name, value);
251                 c->channel_release(ep->dma);
252                 ep->dma = NULL;
253         }
254
255         while (!list_empty(&ep->req_list)) {
256                 req = list_first_entry(&ep->req_list, struct musb_request, list);
257                 musb_g_giveback(ep, &req->request, status);
258         }
259 }
260
261 /* ----------------------------------------------------------------------- */
262
263 /* Data transfers - pure PIO, pure DMA, or mixed mode */
264
265 /*
266  * This assumes the separate CPPI engine is responding to DMA requests
267  * from the usb core ... sequenced a bit differently from mentor dma.
268  */
269
270 static inline int max_ep_writesize(struct musb *musb, struct musb_ep *ep)
271 {
272         if (can_bulk_split(musb, ep->type))
273                 return ep->hw_ep->max_packet_sz_tx;
274         else
275                 return ep->packet_sz;
276 }
277
278
279 #ifdef CONFIG_USB_INVENTRA_DMA
280
281 /* Peripheral tx (IN) using Mentor DMA works as follows:
282         Only mode 0 is used for transfers <= wPktSize,
283         mode 1 is used for larger transfers,
284
285         One of the following happens:
286         - Host sends IN token which causes an endpoint interrupt
287                 -> TxAvail
288                         -> if DMA is currently busy, exit.
289                         -> if queue is non-empty, txstate().
290
291         - Request is queued by the gadget driver.
292                 -> if queue was previously empty, txstate()
293
294         txstate()
295                 -> start
296                   /\    -> setup DMA
297                   |     (data is transferred to the FIFO, then sent out when
298                   |     IN token(s) are recd from Host.
299                   |             -> DMA interrupt on completion
300                   |                calls TxAvail.
301                   |                   -> stop DMA, ~DMAENAB,
302                   |                   -> set TxPktRdy for last short pkt or zlp
303                   |                   -> Complete Request
304                   |                   -> Continue next request (call txstate)
305                   |___________________________________|
306
307  * Non-Mentor DMA engines can of course work differently, such as by
308  * upleveling from irq-per-packet to irq-per-buffer.
309  */
310
311 #endif
312
313 /*
314  * An endpoint is transmitting data. This can be called either from
315  * the IRQ routine or from ep.queue() to kickstart a request on an
316  * endpoint.
317  *
318  * Context: controller locked, IRQs blocked, endpoint selected
319  */
320 static void txstate(struct musb *musb, struct musb_request *req)
321 {
322         u8                      epnum = req->epnum;
323         struct musb_ep          *musb_ep;
324         void __iomem            *epio = musb->endpoints[epnum].regs;
325         struct usb_request      *request;
326         u16                     fifo_count = 0, csr;
327         int                     use_dma = 0;
328
329         musb_ep = req->ep;
330
331         /* Check if EP is disabled */
332         if (!musb_ep->desc) {
333                 dev_dbg(musb->controller, "ep:%s disabled - ignore request\n",
334                                                 musb_ep->end_point.name);
335                 return;
336         }
337
338         /* we shouldn't get here while DMA is active ... but we do ... */
339         if (dma_channel_status(musb_ep->dma) == MUSB_DMA_STATUS_BUSY) {
340                 dev_dbg(musb->controller, "dma pending...\n");
341                 return;
342         }
343
344         /* read TXCSR before */
345         csr = musb_readw(epio, MUSB_TXCSR);
346
347         request = &req->request;
348         fifo_count = min(max_ep_writesize(musb, musb_ep),
349                         (int)(request->length - request->actual));
350
351         if (csr & MUSB_TXCSR_TXPKTRDY) {
352                 dev_dbg(musb->controller, "%s old packet still ready , txcsr %03x\n",
353                                 musb_ep->end_point.name, csr);
354                 return;
355         }
356
357         if (csr & MUSB_TXCSR_P_SENDSTALL) {
358                 dev_dbg(musb->controller, "%s stalling, txcsr %03x\n",
359                                 musb_ep->end_point.name, csr);
360                 return;
361         }
362
363         dev_dbg(musb->controller, "hw_ep%d, maxpacket %d, fifo count %d, txcsr %03x\n",
364                         epnum, musb_ep->packet_sz, fifo_count,
365                         csr);
366
367 #ifndef CONFIG_MUSB_PIO_ONLY
368         if (is_buffer_mapped(req)) {
369                 struct dma_controller   *c = musb->dma_controller;
370                 size_t request_size;
371
372                 /* setup DMA, then program endpoint CSR */
373                 request_size = min_t(size_t, request->length - request->actual,
374                                         musb_ep->dma->max_len);
375
376                 use_dma = (request->dma != DMA_ADDR_INVALID);
377
378                 /* MUSB_TXCSR_P_ISO is still set correctly */
379
380 #if defined(CONFIG_USB_INVENTRA_DMA) || defined(CONFIG_USB_UX500_DMA)
381                 {
382                         if (request_size < musb_ep->packet_sz)
383                                 musb_ep->dma->desired_mode = 0;
384                         else
385                                 musb_ep->dma->desired_mode = 1;
386
387                         use_dma = use_dma && c->channel_program(
388                                         musb_ep->dma, musb_ep->packet_sz,
389                                         musb_ep->dma->desired_mode,
390                                         request->dma + request->actual, request_size);
391                         if (use_dma) {
392                                 if (musb_ep->dma->desired_mode == 0) {
393                                         /*
394                                          * We must not clear the DMAMODE bit
395                                          * before the DMAENAB bit -- and the
396                                          * latter doesn't always get cleared
397                                          * before we get here...
398                                          */
399                                         csr &= ~(MUSB_TXCSR_AUTOSET
400                                                 | MUSB_TXCSR_DMAENAB);
401                                         musb_writew(epio, MUSB_TXCSR, csr
402                                                 | MUSB_TXCSR_P_WZC_BITS);
403                                         csr &= ~MUSB_TXCSR_DMAMODE;
404                                         csr |= (MUSB_TXCSR_DMAENAB |
405                                                         MUSB_TXCSR_MODE);
406                                         /* against programming guide */
407                                 } else {
408                                         csr |= (MUSB_TXCSR_DMAENAB
409                                                         | MUSB_TXCSR_DMAMODE
410                                                         | MUSB_TXCSR_MODE);
411                                         if (!musb_ep->hb_mult)
412                                                 csr |= MUSB_TXCSR_AUTOSET;
413                                 }
414                                 csr &= ~MUSB_TXCSR_P_UNDERRUN;
415
416                                 musb_writew(epio, MUSB_TXCSR, csr);
417                         }
418                 }
419
420 #elif defined(CONFIG_USB_TI_CPPI_DMA)
421                 /* program endpoint CSR first, then setup DMA */
422                 csr &= ~(MUSB_TXCSR_P_UNDERRUN | MUSB_TXCSR_TXPKTRDY);
423                 csr |= MUSB_TXCSR_DMAENAB | MUSB_TXCSR_DMAMODE |
424                        MUSB_TXCSR_MODE;
425                 musb_writew(epio, MUSB_TXCSR,
426                         (MUSB_TXCSR_P_WZC_BITS & ~MUSB_TXCSR_P_UNDERRUN)
427                                 | csr);
428
429                 /* ensure writebuffer is empty */
430                 csr = musb_readw(epio, MUSB_TXCSR);
431
432                 /* NOTE host side sets DMAENAB later than this; both are
433                  * OK since the transfer dma glue (between CPPI and Mentor
434                  * fifos) just tells CPPI it could start.  Data only moves
435                  * to the USB TX fifo when both fifos are ready.
436                  */
437
438                 /* "mode" is irrelevant here; handle terminating ZLPs like
439                  * PIO does, since the hardware RNDIS mode seems unreliable
440                  * except for the last-packet-is-already-short case.
441                  */
442                 use_dma = use_dma && c->channel_program(
443                                 musb_ep->dma, musb_ep->packet_sz,
444                                 0,
445                                 request->dma + request->actual,
446                                 request_size);
447                 if (!use_dma) {
448                         c->channel_release(musb_ep->dma);
449                         musb_ep->dma = NULL;
450                         csr &= ~MUSB_TXCSR_DMAENAB;
451                         musb_writew(epio, MUSB_TXCSR, csr);
452                         /* invariant: prequest->buf is non-null */
453                 }
454 #elif defined(CONFIG_USB_TUSB_OMAP_DMA)
455                 use_dma = use_dma && c->channel_program(
456                                 musb_ep->dma, musb_ep->packet_sz,
457                                 request->zero,
458                                 request->dma + request->actual,
459                                 request_size);
460 #endif
461         }
462 #endif
463
464         if (!use_dma) {
465                 /*
466                  * Unmap the dma buffer back to cpu if dma channel
467                  * programming fails
468                  */
469                 unmap_dma_buffer(req, musb);
470
471                 musb_write_fifo(musb_ep->hw_ep, fifo_count,
472                                 (u8 *) (request->buf + request->actual));
473                 request->actual += fifo_count;
474                 csr |= MUSB_TXCSR_TXPKTRDY;
475                 csr &= ~MUSB_TXCSR_P_UNDERRUN;
476                 musb_writew(epio, MUSB_TXCSR, csr);
477         }
478
479         /* host may already have the data when this message shows... */
480         dev_dbg(musb->controller, "%s TX/IN %s len %d/%d, txcsr %04x, fifo %d/%d\n",
481                         musb_ep->end_point.name, use_dma ? "dma" : "pio",
482                         request->actual, request->length,
483                         musb_readw(epio, MUSB_TXCSR),
484                         fifo_count,
485                         musb_readw(epio, MUSB_TXMAXP));
486 }
487
488 /*
489  * FIFO state update (e.g. data ready).
490  * Called from IRQ,  with controller locked.
491  */
492 void musb_g_tx(struct musb *musb, u8 epnum)
493 {
494         u16                     csr;
495         struct musb_request     *req;
496         struct usb_request      *request;
497         u8 __iomem              *mbase = musb->mregs;
498         struct musb_ep          *musb_ep = &musb->endpoints[epnum].ep_in;
499         void __iomem            *epio = musb->endpoints[epnum].regs;
500         struct dma_channel      *dma;
501
502         musb_ep_select(mbase, epnum);
503         req = next_request(musb_ep);
504         request = &req->request;
505
506         csr = musb_readw(epio, MUSB_TXCSR);
507         dev_dbg(musb->controller, "<== %s, txcsr %04x\n", musb_ep->end_point.name, csr);
508
509         dma = is_dma_capable() ? musb_ep->dma : NULL;
510
511         /*
512          * REVISIT: for high bandwidth, MUSB_TXCSR_P_INCOMPTX
513          * probably rates reporting as a host error.
514          */
515         if (csr & MUSB_TXCSR_P_SENTSTALL) {
516                 csr |=  MUSB_TXCSR_P_WZC_BITS;
517                 csr &= ~MUSB_TXCSR_P_SENTSTALL;
518                 musb_writew(epio, MUSB_TXCSR, csr);
519                 return;
520         }
521
522         if (csr & MUSB_TXCSR_P_UNDERRUN) {
523                 /* We NAKed, no big deal... little reason to care. */
524                 csr |=   MUSB_TXCSR_P_WZC_BITS;
525                 csr &= ~(MUSB_TXCSR_P_UNDERRUN | MUSB_TXCSR_TXPKTRDY);
526                 musb_writew(epio, MUSB_TXCSR, csr);
527                 dev_vdbg(musb->controller, "underrun on ep%d, req %p\n",
528                                 epnum, request);
529         }
530
531         if (dma_channel_status(dma) == MUSB_DMA_STATUS_BUSY) {
532                 /*
533                  * SHOULD NOT HAPPEN... has with CPPI though, after
534                  * changing SENDSTALL (and other cases); harmless?
535                  */
536                 dev_dbg(musb->controller, "%s dma still busy?\n", musb_ep->end_point.name);
537                 return;
538         }
539
540         if (request) {
541                 u8      is_dma = 0;
542
543                 if (dma && (csr & MUSB_TXCSR_DMAENAB)) {
544                         is_dma = 1;
545                         csr |= MUSB_TXCSR_P_WZC_BITS;
546                         csr &= ~(MUSB_TXCSR_DMAENAB | MUSB_TXCSR_P_UNDERRUN |
547                                  MUSB_TXCSR_TXPKTRDY | MUSB_TXCSR_AUTOSET);
548                         musb_writew(epio, MUSB_TXCSR, csr);
549                         /* Ensure writebuffer is empty. */
550                         csr = musb_readw(epio, MUSB_TXCSR);
551                         request->actual += musb_ep->dma->actual_len;
552                         dev_dbg(musb->controller, "TXCSR%d %04x, DMA off, len %zu, req %p\n",
553                                 epnum, csr, musb_ep->dma->actual_len, request);
554                 }
555
556                 /*
557                  * First, maybe a terminating short packet. Some DMA
558                  * engines might handle this by themselves.
559                  */
560                 if ((request->zero && request->length
561                         && (request->length % musb_ep->packet_sz == 0)
562                         && (request->actual == request->length))
563 #if defined(CONFIG_USB_INVENTRA_DMA) || defined(CONFIG_USB_UX500_DMA)
564                         || (is_dma && (!dma->desired_mode ||
565                                 (request->actual &
566                                         (musb_ep->packet_sz - 1))))
567 #endif
568                 ) {
569                         /*
570                          * On DMA completion, FIFO may not be
571                          * available yet...
572                          */
573                         if (csr & MUSB_TXCSR_TXPKTRDY)
574                                 return;
575
576                         dev_dbg(musb->controller, "sending zero pkt\n");
577                         musb_writew(epio, MUSB_TXCSR, MUSB_TXCSR_MODE
578                                         | MUSB_TXCSR_TXPKTRDY);
579                         request->zero = 0;
580                 }
581
582                 if (request->actual == request->length) {
583                         musb_g_giveback(musb_ep, request, 0);
584                         /*
585                          * In the giveback function the MUSB lock is
586                          * released and acquired after sometime. During
587                          * this time period the INDEX register could get
588                          * changed by the gadget_queue function especially
589                          * on SMP systems. Reselect the INDEX to be sure
590                          * we are reading/modifying the right registers
591                          */
592                         musb_ep_select(mbase, epnum);
593                         req = musb_ep->desc ? next_request(musb_ep) : NULL;
594                         if (!req) {
595                                 dev_dbg(musb->controller, "%s idle now\n",
596                                         musb_ep->end_point.name);
597                                 return;
598                         }
599                 }
600
601                 txstate(musb, req);
602         }
603 }
604
605 /* ------------------------------------------------------------ */
606
607 #ifdef CONFIG_USB_INVENTRA_DMA
608
609 /* Peripheral rx (OUT) using Mentor DMA works as follows:
610         - Only mode 0 is used.
611
612         - Request is queued by the gadget class driver.
613                 -> if queue was previously empty, rxstate()
614
615         - Host sends OUT token which causes an endpoint interrupt
616           /\      -> RxReady
617           |           -> if request queued, call rxstate
618           |             /\      -> setup DMA
619           |             |            -> DMA interrupt on completion
620           |             |               -> RxReady
621           |             |                     -> stop DMA
622           |             |                     -> ack the read
623           |             |                     -> if data recd = max expected
624           |             |                               by the request, or host
625           |             |                               sent a short packet,
626           |             |                               complete the request,
627           |             |                               and start the next one.
628           |             |_____________________________________|
629           |                                      else just wait for the host
630           |                                         to send the next OUT token.
631           |__________________________________________________|
632
633  * Non-Mentor DMA engines can of course work differently.
634  */
635
636 #endif
637
638 /*
639  * Context: controller locked, IRQs blocked, endpoint selected
640  */
641 static void rxstate(struct musb *musb, struct musb_request *req)
642 {
643         const u8                epnum = req->epnum;
644         struct usb_request      *request = &req->request;
645         struct musb_ep          *musb_ep;
646         void __iomem            *epio = musb->endpoints[epnum].regs;
647         unsigned                len = 0;
648         u16                     fifo_count;
649         u16                     csr = musb_readw(epio, MUSB_RXCSR);
650         struct musb_hw_ep       *hw_ep = &musb->endpoints[epnum];
651         u8                      use_mode_1;
652
653         if (hw_ep->is_shared_fifo)
654                 musb_ep = &hw_ep->ep_in;
655         else
656                 musb_ep = &hw_ep->ep_out;
657
658         fifo_count = musb_ep->packet_sz;
659
660         /* Check if EP is disabled */
661         if (!musb_ep->desc) {
662                 dev_dbg(musb->controller, "ep:%s disabled - ignore request\n",
663                                                 musb_ep->end_point.name);
664                 return;
665         }
666
667         /* We shouldn't get here while DMA is active, but we do... */
668         if (dma_channel_status(musb_ep->dma) == MUSB_DMA_STATUS_BUSY) {
669                 dev_dbg(musb->controller, "DMA pending...\n");
670                 return;
671         }
672
673         if (csr & MUSB_RXCSR_P_SENDSTALL) {
674                 dev_dbg(musb->controller, "%s stalling, RXCSR %04x\n",
675                     musb_ep->end_point.name, csr);
676                 return;
677         }
678
679         if (is_cppi_enabled() && is_buffer_mapped(req)) {
680                 struct dma_controller   *c = musb->dma_controller;
681                 struct dma_channel      *channel = musb_ep->dma;
682
683                 /* NOTE:  CPPI won't actually stop advancing the DMA
684                  * queue after short packet transfers, so this is almost
685                  * always going to run as IRQ-per-packet DMA so that
686                  * faults will be handled correctly.
687                  */
688                 if (c->channel_program(channel,
689                                 musb_ep->packet_sz,
690                                 !request->short_not_ok,
691                                 request->dma + request->actual,
692                                 request->length - request->actual)) {
693
694                         /* make sure that if an rxpkt arrived after the irq,
695                          * the cppi engine will be ready to take it as soon
696                          * as DMA is enabled
697                          */
698                         csr &= ~(MUSB_RXCSR_AUTOCLEAR
699                                         | MUSB_RXCSR_DMAMODE);
700                         csr |= MUSB_RXCSR_DMAENAB | MUSB_RXCSR_P_WZC_BITS;
701                         musb_writew(epio, MUSB_RXCSR, csr);
702                         return;
703                 }
704         }
705
706         if (csr & MUSB_RXCSR_RXPKTRDY) {
707                 fifo_count = musb_readw(epio, MUSB_RXCOUNT);
708
709                 /*
710                  * Enable Mode 1 on RX transfers only when short_not_ok flag
711                  * is set. Currently short_not_ok flag is set only from
712                  * file_storage and f_mass_storage drivers
713                  */
714
715                 if (request->short_not_ok && fifo_count == musb_ep->packet_sz)
716                         use_mode_1 = 1;
717                 else
718                         use_mode_1 = 0;
719
720                 if (request->actual < request->length) {
721 #ifdef CONFIG_USB_INVENTRA_DMA
722                         if (is_buffer_mapped(req)) {
723                                 struct dma_controller   *c;
724                                 struct dma_channel      *channel;
725                                 int                     use_dma = 0;
726
727                                 c = musb->dma_controller;
728                                 channel = musb_ep->dma;
729
730         /* We use DMA Req mode 0 in rx_csr, and DMA controller operates in
731          * mode 0 only. So we do not get endpoint interrupts due to DMA
732          * completion. We only get interrupts from DMA controller.
733          *
734          * We could operate in DMA mode 1 if we knew the size of the tranfer
735          * in advance. For mass storage class, request->length = what the host
736          * sends, so that'd work.  But for pretty much everything else,
737          * request->length is routinely more than what the host sends. For
738          * most these gadgets, end of is signified either by a short packet,
739          * or filling the last byte of the buffer.  (Sending extra data in
740          * that last pckate should trigger an overflow fault.)  But in mode 1,
741          * we don't get DMA completion interrupt for short packets.
742          *
743          * Theoretically, we could enable DMAReq irq (MUSB_RXCSR_DMAMODE = 1),
744          * to get endpoint interrupt on every DMA req, but that didn't seem
745          * to work reliably.
746          *
747          * REVISIT an updated g_file_storage can set req->short_not_ok, which
748          * then becomes usable as a runtime "use mode 1" hint...
749          */
750
751                                 /* Experimental: Mode1 works with mass storage use cases */
752                                 if (use_mode_1) {
753                                         csr |= MUSB_RXCSR_AUTOCLEAR;
754                                         musb_writew(epio, MUSB_RXCSR, csr);
755                                         csr |= MUSB_RXCSR_DMAENAB;
756                                         musb_writew(epio, MUSB_RXCSR, csr);
757
758                                         /*
759                                          * this special sequence (enabling and then
760                                          * disabling MUSB_RXCSR_DMAMODE) is required
761                                          * to get DMAReq to activate
762                                          */
763                                         musb_writew(epio, MUSB_RXCSR,
764                                                 csr | MUSB_RXCSR_DMAMODE);
765                                         musb_writew(epio, MUSB_RXCSR, csr);
766
767                                 } else {
768                                         if (!musb_ep->hb_mult &&
769                                                 musb_ep->hw_ep->rx_double_buffered)
770                                                 csr |= MUSB_RXCSR_AUTOCLEAR;
771                                         csr |= MUSB_RXCSR_DMAENAB;
772                                         musb_writew(epio, MUSB_RXCSR, csr);
773                                 }
774
775                                 if (request->actual < request->length) {
776                                         int transfer_size = 0;
777                                         if (use_mode_1) {
778                                                 transfer_size = min(request->length - request->actual,
779                                                                 channel->max_len);
780                                                 musb_ep->dma->desired_mode = 1;
781                                         } else {
782                                                 transfer_size = min(request->length - request->actual,
783                                                         (unsigned)fifo_count);
784                                                 musb_ep->dma->desired_mode = 0;
785                                         }
786
787                                         use_dma = c->channel_program(
788                                                         channel,
789                                                         musb_ep->packet_sz,
790                                                         channel->desired_mode,
791                                                         request->dma
792                                                         + request->actual,
793                                                         transfer_size);
794                                 }
795
796                                 if (use_dma)
797                                         return;
798                         }
799 #elif defined(CONFIG_USB_UX500_DMA)
800                         if ((is_buffer_mapped(req)) &&
801                                 (request->actual < request->length)) {
802
803                                 struct dma_controller *c;
804                                 struct dma_channel *channel;
805                                 int transfer_size = 0;
806
807                                 c = musb->dma_controller;
808                                 channel = musb_ep->dma;
809
810                                 /* In case first packet is short */
811                                 if (fifo_count < musb_ep->packet_sz)
812                                         transfer_size = fifo_count;
813                                 else if (request->short_not_ok)
814                                         transfer_size = min(request->length -
815                                                         request->actual,
816                                                         channel->max_len);
817                                 else
818                                         transfer_size = min(request->length -
819                                                         request->actual,
820                                                         (unsigned)fifo_count);
821
822                                 csr &= ~MUSB_RXCSR_DMAMODE;
823                                 csr |= (MUSB_RXCSR_DMAENAB |
824                                         MUSB_RXCSR_AUTOCLEAR);
825
826                                 musb_writew(epio, MUSB_RXCSR, csr);
827
828                                 if (transfer_size <= musb_ep->packet_sz) {
829                                         musb_ep->dma->desired_mode = 0;
830                                 } else {
831                                         musb_ep->dma->desired_mode = 1;
832                                         /* Mode must be set after DMAENAB */
833                                         csr |= MUSB_RXCSR_DMAMODE;
834                                         musb_writew(epio, MUSB_RXCSR, csr);
835                                 }
836
837                                 if (c->channel_program(channel,
838                                                         musb_ep->packet_sz,
839                                                         channel->desired_mode,
840                                                         request->dma
841                                                         + request->actual,
842                                                         transfer_size))
843
844                                         return;
845                         }
846 #endif  /* Mentor's DMA */
847
848                         len = request->length - request->actual;
849                         dev_dbg(musb->controller, "%s OUT/RX pio fifo %d/%d, maxpacket %d\n",
850                                         musb_ep->end_point.name,
851                                         fifo_count, len,
852                                         musb_ep->packet_sz);
853
854                         fifo_count = min_t(unsigned, len, fifo_count);
855
856 #ifdef  CONFIG_USB_TUSB_OMAP_DMA
857                         if (tusb_dma_omap() && is_buffer_mapped(req)) {
858                                 struct dma_controller *c = musb->dma_controller;
859                                 struct dma_channel *channel = musb_ep->dma;
860                                 u32 dma_addr = request->dma + request->actual;
861                                 int ret;
862
863                                 ret = c->channel_program(channel,
864                                                 musb_ep->packet_sz,
865                                                 channel->desired_mode,
866                                                 dma_addr,
867                                                 fifo_count);
868                                 if (ret)
869                                         return;
870                         }
871 #endif
872                         /*
873                          * Unmap the dma buffer back to cpu if dma channel
874                          * programming fails. This buffer is mapped if the
875                          * channel allocation is successful
876                          */
877                          if (is_buffer_mapped(req)) {
878                                 unmap_dma_buffer(req, musb);
879
880                                 /*
881                                  * Clear DMAENAB and AUTOCLEAR for the
882                                  * PIO mode transfer
883                                  */
884                                 csr &= ~(MUSB_RXCSR_DMAENAB | MUSB_RXCSR_AUTOCLEAR);
885                                 musb_writew(epio, MUSB_RXCSR, csr);
886                         }
887
888                         musb_read_fifo(musb_ep->hw_ep, fifo_count, (u8 *)
889                                         (request->buf + request->actual));
890                         request->actual += fifo_count;
891
892                         /* REVISIT if we left anything in the fifo, flush
893                          * it and report -EOVERFLOW
894                          */
895
896                         /* ack the read! */
897                         csr |= MUSB_RXCSR_P_WZC_BITS;
898                         csr &= ~MUSB_RXCSR_RXPKTRDY;
899                         musb_writew(epio, MUSB_RXCSR, csr);
900                 }
901         }
902
903         /* reach the end or short packet detected */
904         if (request->actual == request->length ||
905             fifo_count < musb_ep->packet_sz)
906                 musb_g_giveback(musb_ep, request, 0);
907 }
908
909 /*
910  * Data ready for a request; called from IRQ
911  */
912 void musb_g_rx(struct musb *musb, u8 epnum)
913 {
914         u16                     csr;
915         struct musb_request     *req;
916         struct usb_request      *request;
917         void __iomem            *mbase = musb->mregs;
918         struct musb_ep          *musb_ep;
919         void __iomem            *epio = musb->endpoints[epnum].regs;
920         struct dma_channel      *dma;
921         struct musb_hw_ep       *hw_ep = &musb->endpoints[epnum];
922
923         if (hw_ep->is_shared_fifo)
924                 musb_ep = &hw_ep->ep_in;
925         else
926                 musb_ep = &hw_ep->ep_out;
927
928         musb_ep_select(mbase, epnum);
929
930         req = next_request(musb_ep);
931         if (!req)
932                 return;
933
934         request = &req->request;
935
936         csr = musb_readw(epio, MUSB_RXCSR);
937         dma = is_dma_capable() ? musb_ep->dma : NULL;
938
939         dev_dbg(musb->controller, "<== %s, rxcsr %04x%s %p\n", musb_ep->end_point.name,
940                         csr, dma ? " (dma)" : "", request);
941
942         if (csr & MUSB_RXCSR_P_SENTSTALL) {
943                 csr |= MUSB_RXCSR_P_WZC_BITS;
944                 csr &= ~MUSB_RXCSR_P_SENTSTALL;
945                 musb_writew(epio, MUSB_RXCSR, csr);
946                 return;
947         }
948
949         if (csr & MUSB_RXCSR_P_OVERRUN) {
950                 /* csr |= MUSB_RXCSR_P_WZC_BITS; */
951                 csr &= ~MUSB_RXCSR_P_OVERRUN;
952                 musb_writew(epio, MUSB_RXCSR, csr);
953
954                 dev_dbg(musb->controller, "%s iso overrun on %p\n", musb_ep->name, request);
955                 if (request->status == -EINPROGRESS)
956                         request->status = -EOVERFLOW;
957         }
958         if (csr & MUSB_RXCSR_INCOMPRX) {
959                 /* REVISIT not necessarily an error */
960                 dev_dbg(musb->controller, "%s, incomprx\n", musb_ep->end_point.name);
961         }
962
963         if (dma_channel_status(dma) == MUSB_DMA_STATUS_BUSY) {
964                 /* "should not happen"; likely RXPKTRDY pending for DMA */
965                 dev_dbg(musb->controller, "%s busy, csr %04x\n",
966                         musb_ep->end_point.name, csr);
967                 return;
968         }
969
970         if (dma && (csr & MUSB_RXCSR_DMAENAB)) {
971                 csr &= ~(MUSB_RXCSR_AUTOCLEAR
972                                 | MUSB_RXCSR_DMAENAB
973                                 | MUSB_RXCSR_DMAMODE);
974                 musb_writew(epio, MUSB_RXCSR,
975                         MUSB_RXCSR_P_WZC_BITS | csr);
976
977                 request->actual += musb_ep->dma->actual_len;
978
979                 dev_dbg(musb->controller, "RXCSR%d %04x, dma off, %04x, len %zu, req %p\n",
980                         epnum, csr,
981                         musb_readw(epio, MUSB_RXCSR),
982                         musb_ep->dma->actual_len, request);
983
984 #if defined(CONFIG_USB_INVENTRA_DMA) || defined(CONFIG_USB_TUSB_OMAP_DMA) || \
985         defined(CONFIG_USB_UX500_DMA)
986                 /* Autoclear doesn't clear RxPktRdy for short packets */
987                 if ((dma->desired_mode == 0 && !hw_ep->rx_double_buffered)
988                                 || (dma->actual_len
989                                         & (musb_ep->packet_sz - 1))) {
990                         /* ack the read! */
991                         csr &= ~MUSB_RXCSR_RXPKTRDY;
992                         musb_writew(epio, MUSB_RXCSR, csr);
993                 }
994
995                 /* incomplete, and not short? wait for next IN packet */
996                 if ((request->actual < request->length)
997                                 && (musb_ep->dma->actual_len
998                                         == musb_ep->packet_sz)) {
999                         /* In double buffer case, continue to unload fifo if
1000                          * there is Rx packet in FIFO.
1001                          **/
1002                         csr = musb_readw(epio, MUSB_RXCSR);
1003                         if ((csr & MUSB_RXCSR_RXPKTRDY) &&
1004                                 hw_ep->rx_double_buffered)
1005                                 goto exit;
1006                         return;
1007                 }
1008 #endif
1009                 musb_g_giveback(musb_ep, request, 0);
1010                 /*
1011                  * In the giveback function the MUSB lock is
1012                  * released and acquired after sometime. During
1013                  * this time period the INDEX register could get
1014                  * changed by the gadget_queue function especially
1015                  * on SMP systems. Reselect the INDEX to be sure
1016                  * we are reading/modifying the right registers
1017                  */
1018                 musb_ep_select(mbase, epnum);
1019
1020                 req = next_request(musb_ep);
1021                 if (!req)
1022                         return;
1023         }
1024 #if defined(CONFIG_USB_INVENTRA_DMA) || defined(CONFIG_USB_TUSB_OMAP_DMA) || \
1025         defined(CONFIG_USB_UX500_DMA)
1026 exit:
1027 #endif
1028         /* Analyze request */
1029         rxstate(musb, req);
1030 }
1031
1032 /* ------------------------------------------------------------ */
1033
1034 static int musb_gadget_enable(struct usb_ep *ep,
1035                         const struct usb_endpoint_descriptor *desc)
1036 {
1037         unsigned long           flags;
1038         struct musb_ep          *musb_ep;
1039         struct musb_hw_ep       *hw_ep;
1040         void __iomem            *regs;
1041         struct musb             *musb;
1042         void __iomem    *mbase;
1043         u8              epnum;
1044         u16             csr;
1045         unsigned        tmp;
1046         int             status = -EINVAL;
1047
1048         if (!ep || !desc)
1049                 return -EINVAL;
1050
1051         musb_ep = to_musb_ep(ep);
1052         hw_ep = musb_ep->hw_ep;
1053         regs = hw_ep->regs;
1054         musb = musb_ep->musb;
1055         mbase = musb->mregs;
1056         epnum = musb_ep->current_epnum;
1057
1058         spin_lock_irqsave(&musb->lock, flags);
1059
1060         if (musb_ep->desc) {
1061                 status = -EBUSY;
1062                 goto fail;
1063         }
1064         musb_ep->type = usb_endpoint_type(desc);
1065
1066         /* check direction and (later) maxpacket size against endpoint */
1067         if (usb_endpoint_num(desc) != epnum)
1068                 goto fail;
1069
1070         /* REVISIT this rules out high bandwidth periodic transfers */
1071         tmp = usb_endpoint_maxp(desc);
1072         if (tmp & ~0x07ff) {
1073                 int ok;
1074
1075                 if (usb_endpoint_dir_in(desc))
1076                         ok = musb->hb_iso_tx;
1077                 else
1078                         ok = musb->hb_iso_rx;
1079
1080                 if (!ok) {
1081                         dev_dbg(musb->controller, "no support for high bandwidth ISO\n");
1082                         goto fail;
1083                 }
1084                 musb_ep->hb_mult = (tmp >> 11) & 3;
1085         } else {
1086                 musb_ep->hb_mult = 0;
1087         }
1088
1089         musb_ep->packet_sz = tmp & 0x7ff;
1090         tmp = musb_ep->packet_sz * (musb_ep->hb_mult + 1);
1091
1092         /* enable the interrupts for the endpoint, set the endpoint
1093          * packet size (or fail), set the mode, clear the fifo
1094          */
1095         musb_ep_select(mbase, epnum);
1096         if (usb_endpoint_dir_in(desc)) {
1097                 u16 int_txe = musb_readw(mbase, MUSB_INTRTXE);
1098
1099                 if (hw_ep->is_shared_fifo)
1100                         musb_ep->is_in = 1;
1101                 if (!musb_ep->is_in)
1102                         goto fail;
1103
1104                 if (tmp > hw_ep->max_packet_sz_tx) {
1105                         dev_dbg(musb->controller, "packet size beyond hardware FIFO size\n");
1106                         goto fail;
1107                 }
1108
1109                 int_txe |= (1 << epnum);
1110                 musb_writew(mbase, MUSB_INTRTXE, int_txe);
1111
1112                 /* REVISIT if can_bulk_split(), use by updating "tmp";
1113                  * likewise high bandwidth periodic tx
1114                  */
1115                 /* Set TXMAXP with the FIFO size of the endpoint
1116                  * to disable double buffering mode.
1117                  */
1118                 if (musb->double_buffer_not_ok)
1119                         musb_writew(regs, MUSB_TXMAXP, hw_ep->max_packet_sz_tx);
1120                 else
1121                         musb_writew(regs, MUSB_TXMAXP, musb_ep->packet_sz
1122                                         | (musb_ep->hb_mult << 11));
1123
1124                 csr = MUSB_TXCSR_MODE | MUSB_TXCSR_CLRDATATOG;
1125                 if (musb_readw(regs, MUSB_TXCSR)
1126                                 & MUSB_TXCSR_FIFONOTEMPTY)
1127                         csr |= MUSB_TXCSR_FLUSHFIFO;
1128                 if (musb_ep->type == USB_ENDPOINT_XFER_ISOC)
1129                         csr |= MUSB_TXCSR_P_ISO;
1130
1131                 /* set twice in case of double buffering */
1132                 musb_writew(regs, MUSB_TXCSR, csr);
1133                 /* REVISIT may be inappropriate w/o FIFONOTEMPTY ... */
1134                 musb_writew(regs, MUSB_TXCSR, csr);
1135
1136         } else {
1137                 u16 int_rxe = musb_readw(mbase, MUSB_INTRRXE);
1138
1139                 if (hw_ep->is_shared_fifo)
1140                         musb_ep->is_in = 0;
1141                 if (musb_ep->is_in)
1142                         goto fail;
1143
1144                 if (tmp > hw_ep->max_packet_sz_rx) {
1145                         dev_dbg(musb->controller, "packet size beyond hardware FIFO size\n");
1146                         goto fail;
1147                 }
1148
1149                 int_rxe |= (1 << epnum);
1150                 musb_writew(mbase, MUSB_INTRRXE, int_rxe);
1151
1152                 /* REVISIT if can_bulk_combine() use by updating "tmp"
1153                  * likewise high bandwidth periodic rx
1154                  */
1155                 /* Set RXMAXP with the FIFO size of the endpoint
1156                  * to disable double buffering mode.
1157                  */
1158                 if (musb->double_buffer_not_ok)
1159                         musb_writew(regs, MUSB_RXMAXP, hw_ep->max_packet_sz_tx);
1160                 else
1161                         musb_writew(regs, MUSB_RXMAXP, musb_ep->packet_sz
1162                                         | (musb_ep->hb_mult << 11));
1163
1164                 /* force shared fifo to OUT-only mode */
1165                 if (hw_ep->is_shared_fifo) {
1166                         csr = musb_readw(regs, MUSB_TXCSR);
1167                         csr &= ~(MUSB_TXCSR_MODE | MUSB_TXCSR_TXPKTRDY);
1168                         musb_writew(regs, MUSB_TXCSR, csr);
1169                 }
1170
1171                 csr = MUSB_RXCSR_FLUSHFIFO | MUSB_RXCSR_CLRDATATOG;
1172                 if (musb_ep->type == USB_ENDPOINT_XFER_ISOC)
1173                         csr |= MUSB_RXCSR_P_ISO;
1174                 else if (musb_ep->type == USB_ENDPOINT_XFER_INT)
1175                         csr |= MUSB_RXCSR_DISNYET;
1176
1177                 /* set twice in case of double buffering */
1178                 musb_writew(regs, MUSB_RXCSR, csr);
1179                 musb_writew(regs, MUSB_RXCSR, csr);
1180         }
1181
1182         /* NOTE:  all the I/O code _should_ work fine without DMA, in case
1183          * for some reason you run out of channels here.
1184          */
1185         if (is_dma_capable() && musb->dma_controller) {
1186                 struct dma_controller   *c = musb->dma_controller;
1187
1188                 musb_ep->dma = c->channel_alloc(c, hw_ep,
1189                                 (desc->bEndpointAddress & USB_DIR_IN));
1190         } else
1191                 musb_ep->dma = NULL;
1192
1193         musb_ep->desc = desc;
1194         musb_ep->busy = 0;
1195         musb_ep->wedged = 0;
1196         status = 0;
1197
1198         pr_debug("%s periph: enabled %s for %s %s, %smaxpacket %d\n",
1199                         musb_driver_name, musb_ep->end_point.name,
1200                         ({ char *s; switch (musb_ep->type) {
1201                         case USB_ENDPOINT_XFER_BULK:    s = "bulk"; break;
1202                         case USB_ENDPOINT_XFER_INT:     s = "int"; break;
1203                         default:                        s = "iso"; break;
1204                         }; s; }),
1205                         musb_ep->is_in ? "IN" : "OUT",
1206                         musb_ep->dma ? "dma, " : "",
1207                         musb_ep->packet_sz);
1208
1209         schedule_work(&musb->irq_work);
1210
1211 fail:
1212         spin_unlock_irqrestore(&musb->lock, flags);
1213         return status;
1214 }
1215
1216 /*
1217  * Disable an endpoint flushing all requests queued.
1218  */
1219 static int musb_gadget_disable(struct usb_ep *ep)
1220 {
1221         unsigned long   flags;
1222         struct musb     *musb;
1223         u8              epnum;
1224         struct musb_ep  *musb_ep;
1225         void __iomem    *epio;
1226         int             status = 0;
1227
1228         musb_ep = to_musb_ep(ep);
1229         musb = musb_ep->musb;
1230         epnum = musb_ep->current_epnum;
1231         epio = musb->endpoints[epnum].regs;
1232
1233         spin_lock_irqsave(&musb->lock, flags);
1234         musb_ep_select(musb->mregs, epnum);
1235
1236         /* zero the endpoint sizes */
1237         if (musb_ep->is_in) {
1238                 u16 int_txe = musb_readw(musb->mregs, MUSB_INTRTXE);
1239                 int_txe &= ~(1 << epnum);
1240                 musb_writew(musb->mregs, MUSB_INTRTXE, int_txe);
1241                 musb_writew(epio, MUSB_TXMAXP, 0);
1242         } else {
1243                 u16 int_rxe = musb_readw(musb->mregs, MUSB_INTRRXE);
1244                 int_rxe &= ~(1 << epnum);
1245                 musb_writew(musb->mregs, MUSB_INTRRXE, int_rxe);
1246                 musb_writew(epio, MUSB_RXMAXP, 0);
1247         }
1248
1249         musb_ep->desc = NULL;
1250         musb_ep->end_point.desc = NULL;
1251
1252         /* abort all pending DMA and requests */
1253         nuke(musb_ep, -ESHUTDOWN);
1254
1255         schedule_work(&musb->irq_work);
1256
1257         spin_unlock_irqrestore(&(musb->lock), flags);
1258
1259         dev_dbg(musb->controller, "%s\n", musb_ep->end_point.name);
1260
1261         return status;
1262 }
1263
1264 /*
1265  * Allocate a request for an endpoint.
1266  * Reused by ep0 code.
1267  */
1268 struct usb_request *musb_alloc_request(struct usb_ep *ep, gfp_t gfp_flags)
1269 {
1270         struct musb_ep          *musb_ep = to_musb_ep(ep);
1271         struct musb             *musb = musb_ep->musb;
1272         struct musb_request     *request = NULL;
1273
1274         request = kzalloc(sizeof *request, gfp_flags);
1275         if (!request) {
1276                 dev_dbg(musb->controller, "not enough memory\n");
1277                 return NULL;
1278         }
1279
1280         request->request.dma = DMA_ADDR_INVALID;
1281         request->epnum = musb_ep->current_epnum;
1282         request->ep = musb_ep;
1283
1284         return &request->request;
1285 }
1286
1287 /*
1288  * Free a request
1289  * Reused by ep0 code.
1290  */
1291 void musb_free_request(struct usb_ep *ep, struct usb_request *req)
1292 {
1293         kfree(to_musb_request(req));
1294 }
1295
1296 static LIST_HEAD(buffers);
1297
1298 struct free_record {
1299         struct list_head        list;
1300         struct device           *dev;
1301         unsigned                bytes;
1302         dma_addr_t              dma;
1303 };
1304
1305 /*
1306  * Context: controller locked, IRQs blocked.
1307  */
1308 void musb_ep_restart(struct musb *musb, struct musb_request *req)
1309 {
1310         dev_dbg(musb->controller, "<== %s request %p len %u on hw_ep%d\n",
1311                 req->tx ? "TX/IN" : "RX/OUT",
1312                 &req->request, req->request.length, req->epnum);
1313
1314         musb_ep_select(musb->mregs, req->epnum);
1315         if (req->tx)
1316                 txstate(musb, req);
1317         else
1318                 rxstate(musb, req);
1319 }
1320
1321 static int musb_gadget_queue(struct usb_ep *ep, struct usb_request *req,
1322                         gfp_t gfp_flags)
1323 {
1324         struct musb_ep          *musb_ep;
1325         struct musb_request     *request;
1326         struct musb             *musb;
1327         int                     status = 0;
1328         unsigned long           lockflags;
1329
1330         if (!ep || !req)
1331                 return -EINVAL;
1332         if (!req->buf)
1333                 return -ENODATA;
1334
1335         musb_ep = to_musb_ep(ep);
1336         musb = musb_ep->musb;
1337
1338         request = to_musb_request(req);
1339         request->musb = musb;
1340
1341         if (request->ep != musb_ep)
1342                 return -EINVAL;
1343
1344         dev_dbg(musb->controller, "<== to %s request=%p\n", ep->name, req);
1345
1346         /* request is mine now... */
1347         request->request.actual = 0;
1348         request->request.status = -EINPROGRESS;
1349         request->epnum = musb_ep->current_epnum;
1350         request->tx = musb_ep->is_in;
1351
1352         map_dma_buffer(request, musb, musb_ep);
1353
1354         spin_lock_irqsave(&musb->lock, lockflags);
1355
1356         /* don't queue if the ep is down */
1357         if (!musb_ep->desc) {
1358                 dev_dbg(musb->controller, "req %p queued to %s while ep %s\n",
1359                                 req, ep->name, "disabled");
1360                 status = -ESHUTDOWN;
1361                 goto cleanup;
1362         }
1363
1364         /* add request to the list */
1365         list_add_tail(&request->list, &musb_ep->req_list);
1366
1367         /* it this is the head of the queue, start i/o ... */
1368         if (!musb_ep->busy && &request->list == musb_ep->req_list.next)
1369                 musb_ep_restart(musb, request);
1370
1371 cleanup:
1372         spin_unlock_irqrestore(&musb->lock, lockflags);
1373         return status;
1374 }
1375
1376 static int musb_gadget_dequeue(struct usb_ep *ep, struct usb_request *request)
1377 {
1378         struct musb_ep          *musb_ep = to_musb_ep(ep);
1379         struct musb_request     *req = to_musb_request(request);
1380         struct musb_request     *r;
1381         unsigned long           flags;
1382         int                     status = 0;
1383         struct musb             *musb = musb_ep->musb;
1384
1385         if (!ep || !request || to_musb_request(request)->ep != musb_ep)
1386                 return -EINVAL;
1387
1388         spin_lock_irqsave(&musb->lock, flags);
1389
1390         list_for_each_entry(r, &musb_ep->req_list, list) {
1391                 if (r == req)
1392                         break;
1393         }
1394         if (r != req) {
1395                 dev_dbg(musb->controller, "request %p not queued to %s\n", request, ep->name);
1396                 status = -EINVAL;
1397                 goto done;
1398         }
1399
1400         /* if the hardware doesn't have the request, easy ... */
1401         if (musb_ep->req_list.next != &req->list || musb_ep->busy)
1402                 musb_g_giveback(musb_ep, request, -ECONNRESET);
1403
1404         /* ... else abort the dma transfer ... */
1405         else if (is_dma_capable() && musb_ep->dma) {
1406                 struct dma_controller   *c = musb->dma_controller;
1407
1408                 musb_ep_select(musb->mregs, musb_ep->current_epnum);
1409                 if (c->channel_abort)
1410                         status = c->channel_abort(musb_ep->dma);
1411                 else
1412                         status = -EBUSY;
1413                 if (status == 0)
1414                         musb_g_giveback(musb_ep, request, -ECONNRESET);
1415         } else {
1416                 /* NOTE: by sticking to easily tested hardware/driver states,
1417                  * we leave counting of in-flight packets imprecise.
1418                  */
1419                 musb_g_giveback(musb_ep, request, -ECONNRESET);
1420         }
1421
1422 done:
1423         spin_unlock_irqrestore(&musb->lock, flags);
1424         return status;
1425 }
1426
1427 /*
1428  * Set or clear the halt bit of an endpoint. A halted enpoint won't tx/rx any
1429  * data but will queue requests.
1430  *
1431  * exported to ep0 code
1432  */
1433 static int musb_gadget_set_halt(struct usb_ep *ep, int value)
1434 {
1435         struct musb_ep          *musb_ep = to_musb_ep(ep);
1436         u8                      epnum = musb_ep->current_epnum;
1437         struct musb             *musb = musb_ep->musb;
1438         void __iomem            *epio = musb->endpoints[epnum].regs;
1439         void __iomem            *mbase;
1440         unsigned long           flags;
1441         u16                     csr;
1442         struct musb_request     *request;
1443         int                     status = 0;
1444
1445         if (!ep)
1446                 return -EINVAL;
1447         mbase = musb->mregs;
1448
1449         spin_lock_irqsave(&musb->lock, flags);
1450
1451         if ((USB_ENDPOINT_XFER_ISOC == musb_ep->type)) {
1452                 status = -EINVAL;
1453                 goto done;
1454         }
1455
1456         musb_ep_select(mbase, epnum);
1457
1458         request = next_request(musb_ep);
1459         if (value) {
1460                 if (request) {
1461                         dev_dbg(musb->controller, "request in progress, cannot halt %s\n",
1462                             ep->name);
1463                         status = -EAGAIN;
1464                         goto done;
1465                 }
1466                 /* Cannot portably stall with non-empty FIFO */
1467                 if (musb_ep->is_in) {
1468                         csr = musb_readw(epio, MUSB_TXCSR);
1469                         if (csr & MUSB_TXCSR_FIFONOTEMPTY) {
1470                                 dev_dbg(musb->controller, "FIFO busy, cannot halt %s\n", ep->name);
1471                                 status = -EAGAIN;
1472                                 goto done;
1473                         }
1474                 }
1475         } else
1476                 musb_ep->wedged = 0;
1477
1478         /* set/clear the stall and toggle bits */
1479         dev_dbg(musb->controller, "%s: %s stall\n", ep->name, value ? "set" : "clear");
1480         if (musb_ep->is_in) {
1481                 csr = musb_readw(epio, MUSB_TXCSR);
1482                 csr |= MUSB_TXCSR_P_WZC_BITS
1483                         | MUSB_TXCSR_CLRDATATOG;
1484                 if (value)
1485                         csr |= MUSB_TXCSR_P_SENDSTALL;
1486                 else
1487                         csr &= ~(MUSB_TXCSR_P_SENDSTALL
1488                                 | MUSB_TXCSR_P_SENTSTALL);
1489                 csr &= ~MUSB_TXCSR_TXPKTRDY;
1490                 musb_writew(epio, MUSB_TXCSR, csr);
1491         } else {
1492                 csr = musb_readw(epio, MUSB_RXCSR);
1493                 csr |= MUSB_RXCSR_P_WZC_BITS
1494                         | MUSB_RXCSR_FLUSHFIFO
1495                         | MUSB_RXCSR_CLRDATATOG;
1496                 if (value)
1497                         csr |= MUSB_RXCSR_P_SENDSTALL;
1498                 else
1499                         csr &= ~(MUSB_RXCSR_P_SENDSTALL
1500                                 | MUSB_RXCSR_P_SENTSTALL);
1501                 musb_writew(epio, MUSB_RXCSR, csr);
1502         }
1503
1504         /* maybe start the first request in the queue */
1505         if (!musb_ep->busy && !value && request) {
1506                 dev_dbg(musb->controller, "restarting the request\n");
1507                 musb_ep_restart(musb, request);
1508         }
1509
1510 done:
1511         spin_unlock_irqrestore(&musb->lock, flags);
1512         return status;
1513 }
1514
1515 /*
1516  * Sets the halt feature with the clear requests ignored
1517  */
1518 static int musb_gadget_set_wedge(struct usb_ep *ep)
1519 {
1520         struct musb_ep          *musb_ep = to_musb_ep(ep);
1521
1522         if (!ep)
1523                 return -EINVAL;
1524
1525         musb_ep->wedged = 1;
1526
1527         return usb_ep_set_halt(ep);
1528 }
1529
1530 static int musb_gadget_fifo_status(struct usb_ep *ep)
1531 {
1532         struct musb_ep          *musb_ep = to_musb_ep(ep);
1533         void __iomem            *epio = musb_ep->hw_ep->regs;
1534         int                     retval = -EINVAL;
1535
1536         if (musb_ep->desc && !musb_ep->is_in) {
1537                 struct musb             *musb = musb_ep->musb;
1538                 int                     epnum = musb_ep->current_epnum;
1539                 void __iomem            *mbase = musb->mregs;
1540                 unsigned long           flags;
1541
1542                 spin_lock_irqsave(&musb->lock, flags);
1543
1544                 musb_ep_select(mbase, epnum);
1545                 /* FIXME return zero unless RXPKTRDY is set */
1546                 retval = musb_readw(epio, MUSB_RXCOUNT);
1547
1548                 spin_unlock_irqrestore(&musb->lock, flags);
1549         }
1550         return retval;
1551 }
1552
1553 static void musb_gadget_fifo_flush(struct usb_ep *ep)
1554 {
1555         struct musb_ep  *musb_ep = to_musb_ep(ep);
1556         struct musb     *musb = musb_ep->musb;
1557         u8              epnum = musb_ep->current_epnum;
1558         void __iomem    *epio = musb->endpoints[epnum].regs;
1559         void __iomem    *mbase;
1560         unsigned long   flags;
1561         u16             csr, int_txe;
1562
1563         mbase = musb->mregs;
1564
1565         spin_lock_irqsave(&musb->lock, flags);
1566         musb_ep_select(mbase, (u8) epnum);
1567
1568         /* disable interrupts */
1569         int_txe = musb_readw(mbase, MUSB_INTRTXE);
1570         musb_writew(mbase, MUSB_INTRTXE, int_txe & ~(1 << epnum));
1571
1572         if (musb_ep->is_in) {
1573                 csr = musb_readw(epio, MUSB_TXCSR);
1574                 if (csr & MUSB_TXCSR_FIFONOTEMPTY) {
1575                         csr |= MUSB_TXCSR_FLUSHFIFO | MUSB_TXCSR_P_WZC_BITS;
1576                         /*
1577                          * Setting both TXPKTRDY and FLUSHFIFO makes controller
1578                          * to interrupt current FIFO loading, but not flushing
1579                          * the already loaded ones.
1580                          */
1581                         csr &= ~MUSB_TXCSR_TXPKTRDY;
1582                         musb_writew(epio, MUSB_TXCSR, csr);
1583                         /* REVISIT may be inappropriate w/o FIFONOTEMPTY ... */
1584                         musb_writew(epio, MUSB_TXCSR, csr);
1585                 }
1586         } else {
1587                 csr = musb_readw(epio, MUSB_RXCSR);
1588                 csr |= MUSB_RXCSR_FLUSHFIFO | MUSB_RXCSR_P_WZC_BITS;
1589                 musb_writew(epio, MUSB_RXCSR, csr);
1590                 musb_writew(epio, MUSB_RXCSR, csr);
1591         }
1592
1593         /* re-enable interrupt */
1594         musb_writew(mbase, MUSB_INTRTXE, int_txe);
1595         spin_unlock_irqrestore(&musb->lock, flags);
1596 }
1597
1598 static const struct usb_ep_ops musb_ep_ops = {
1599         .enable         = musb_gadget_enable,
1600         .disable        = musb_gadget_disable,
1601         .alloc_request  = musb_alloc_request,
1602         .free_request   = musb_free_request,
1603         .queue          = musb_gadget_queue,
1604         .dequeue        = musb_gadget_dequeue,
1605         .set_halt       = musb_gadget_set_halt,
1606         .set_wedge      = musb_gadget_set_wedge,
1607         .fifo_status    = musb_gadget_fifo_status,
1608         .fifo_flush     = musb_gadget_fifo_flush
1609 };
1610
1611 /* ----------------------------------------------------------------------- */
1612
1613 static int musb_gadget_get_frame(struct usb_gadget *gadget)
1614 {
1615         struct musb     *musb = gadget_to_musb(gadget);
1616
1617         return (int)musb_readw(musb->mregs, MUSB_FRAME);
1618 }
1619
1620 static int musb_gadget_wakeup(struct usb_gadget *gadget)
1621 {
1622         struct musb     *musb = gadget_to_musb(gadget);
1623         void __iomem    *mregs = musb->mregs;
1624         unsigned long   flags;
1625         int             status = -EINVAL;
1626         u8              power, devctl;
1627         int             retries;
1628
1629         spin_lock_irqsave(&musb->lock, flags);
1630
1631         switch (musb->xceiv->state) {
1632         case OTG_STATE_B_PERIPHERAL:
1633                 /* NOTE:  OTG state machine doesn't include B_SUSPENDED;
1634                  * that's part of the standard usb 1.1 state machine, and
1635                  * doesn't affect OTG transitions.
1636                  */
1637                 if (musb->may_wakeup && musb->is_suspended)
1638                         break;
1639                 goto done;
1640         case OTG_STATE_B_IDLE:
1641                 /* Start SRP ... OTG not required. */
1642                 devctl = musb_readb(mregs, MUSB_DEVCTL);
1643                 dev_dbg(musb->controller, "Sending SRP: devctl: %02x\n", devctl);
1644                 devctl |= MUSB_DEVCTL_SESSION;
1645                 musb_writeb(mregs, MUSB_DEVCTL, devctl);
1646                 devctl = musb_readb(mregs, MUSB_DEVCTL);
1647                 retries = 100;
1648                 while (!(devctl & MUSB_DEVCTL_SESSION)) {
1649                         devctl = musb_readb(mregs, MUSB_DEVCTL);
1650                         if (retries-- < 1)
1651                                 break;
1652                 }
1653                 retries = 10000;
1654                 while (devctl & MUSB_DEVCTL_SESSION) {
1655                         devctl = musb_readb(mregs, MUSB_DEVCTL);
1656                         if (retries-- < 1)
1657                                 break;
1658                 }
1659
1660                 spin_unlock_irqrestore(&musb->lock, flags);
1661                 otg_start_srp(musb->xceiv->otg);
1662                 spin_lock_irqsave(&musb->lock, flags);
1663
1664                 /* Block idling for at least 1s */
1665                 musb_platform_try_idle(musb,
1666                         jiffies + msecs_to_jiffies(1 * HZ));
1667
1668                 status = 0;
1669                 goto done;
1670         default:
1671                 dev_dbg(musb->controller, "Unhandled wake: %s\n",
1672                         otg_state_string(musb->xceiv->state));
1673                 goto done;
1674         }
1675
1676         status = 0;
1677
1678         power = musb_readb(mregs, MUSB_POWER);
1679         power |= MUSB_POWER_RESUME;
1680         musb_writeb(mregs, MUSB_POWER, power);
1681         dev_dbg(musb->controller, "issue wakeup\n");
1682
1683         /* FIXME do this next chunk in a timer callback, no udelay */
1684         mdelay(2);
1685
1686         power = musb_readb(mregs, MUSB_POWER);
1687         power &= ~MUSB_POWER_RESUME;
1688         musb_writeb(mregs, MUSB_POWER, power);
1689 done:
1690         spin_unlock_irqrestore(&musb->lock, flags);
1691         return status;
1692 }
1693
1694 static int
1695 musb_gadget_set_self_powered(struct usb_gadget *gadget, int is_selfpowered)
1696 {
1697         struct musb     *musb = gadget_to_musb(gadget);
1698
1699         musb->is_self_powered = !!is_selfpowered;
1700         return 0;
1701 }
1702
1703 static void musb_pullup(struct musb *musb, int is_on)
1704 {
1705         u8 power;
1706
1707         power = musb_readb(musb->mregs, MUSB_POWER);
1708         if (is_on)
1709                 power |= MUSB_POWER_SOFTCONN;
1710         else
1711                 power &= ~MUSB_POWER_SOFTCONN;
1712
1713         /* FIXME if on, HdrcStart; if off, HdrcStop */
1714
1715         dev_dbg(musb->controller, "gadget D+ pullup %s\n",
1716                 is_on ? "on" : "off");
1717         musb_writeb(musb->mregs, MUSB_POWER, power);
1718 }
1719
1720 #if 0
1721 static int musb_gadget_vbus_session(struct usb_gadget *gadget, int is_active)
1722 {
1723         dev_dbg(musb->controller, "<= %s =>\n", __func__);
1724
1725         /*
1726          * FIXME iff driver's softconnect flag is set (as it is during probe,
1727          * though that can clear it), just musb_pullup().
1728          */
1729
1730         return -EINVAL;
1731 }
1732 #endif
1733
1734 static int musb_gadget_vbus_draw(struct usb_gadget *gadget, unsigned mA)
1735 {
1736         struct musb     *musb = gadget_to_musb(gadget);
1737
1738         if (!musb->xceiv->set_power)
1739                 return -EOPNOTSUPP;
1740         return usb_phy_set_power(musb->xceiv, mA);
1741 }
1742
1743 static int musb_gadget_pullup(struct usb_gadget *gadget, int is_on)
1744 {
1745         struct musb     *musb = gadget_to_musb(gadget);
1746         unsigned long   flags;
1747
1748         is_on = !!is_on;
1749
1750         pm_runtime_get_sync(musb->controller);
1751
1752         /* NOTE: this assumes we are sensing vbus; we'd rather
1753          * not pullup unless the B-session is active.
1754          */
1755         spin_lock_irqsave(&musb->lock, flags);
1756         if (is_on != musb->softconnect) {
1757                 musb->softconnect = is_on;
1758                 musb_pullup(musb, is_on);
1759         }
1760         spin_unlock_irqrestore(&musb->lock, flags);
1761
1762         pm_runtime_put(musb->controller);
1763
1764         return 0;
1765 }
1766
1767 static int musb_gadget_start(struct usb_gadget *g,
1768                 struct usb_gadget_driver *driver);
1769 static int musb_gadget_stop(struct usb_gadget *g,
1770                 struct usb_gadget_driver *driver);
1771
1772 static const struct usb_gadget_ops musb_gadget_operations = {
1773         .get_frame              = musb_gadget_get_frame,
1774         .wakeup                 = musb_gadget_wakeup,
1775         .set_selfpowered        = musb_gadget_set_self_powered,
1776         /* .vbus_session                = musb_gadget_vbus_session, */
1777         .vbus_draw              = musb_gadget_vbus_draw,
1778         .pullup                 = musb_gadget_pullup,
1779         .udc_start              = musb_gadget_start,
1780         .udc_stop               = musb_gadget_stop,
1781 };
1782
1783 /* ----------------------------------------------------------------------- */
1784
1785 /* Registration */
1786
1787 /* Only this registration code "knows" the rule (from USB standards)
1788  * about there being only one external upstream port.  It assumes
1789  * all peripheral ports are external...
1790  */
1791
1792 static void musb_gadget_release(struct device *dev)
1793 {
1794         /* kref_put(WHAT) */
1795         dev_dbg(dev, "%s\n", __func__);
1796 }
1797
1798
1799 static void __devinit
1800 init_peripheral_ep(struct musb *musb, struct musb_ep *ep, u8 epnum, int is_in)
1801 {
1802         struct musb_hw_ep       *hw_ep = musb->endpoints + epnum;
1803
1804         memset(ep, 0, sizeof *ep);
1805
1806         ep->current_epnum = epnum;
1807         ep->musb = musb;
1808         ep->hw_ep = hw_ep;
1809         ep->is_in = is_in;
1810
1811         INIT_LIST_HEAD(&ep->req_list);
1812
1813         sprintf(ep->name, "ep%d%s", epnum,
1814                         (!epnum || hw_ep->is_shared_fifo) ? "" : (
1815                                 is_in ? "in" : "out"));
1816         ep->end_point.name = ep->name;
1817         INIT_LIST_HEAD(&ep->end_point.ep_list);
1818         if (!epnum) {
1819                 ep->end_point.maxpacket = 64;
1820                 ep->end_point.ops = &musb_g_ep0_ops;
1821                 musb->g.ep0 = &ep->end_point;
1822         } else {
1823                 if (is_in)
1824                         ep->end_point.maxpacket = hw_ep->max_packet_sz_tx;
1825                 else
1826                         ep->end_point.maxpacket = hw_ep->max_packet_sz_rx;
1827                 ep->end_point.ops = &musb_ep_ops;
1828                 list_add_tail(&ep->end_point.ep_list, &musb->g.ep_list);
1829         }
1830 }
1831
1832 /*
1833  * Initialize the endpoints exposed to peripheral drivers, with backlinks
1834  * to the rest of the driver state.
1835  */
1836 static inline void __devinit musb_g_init_endpoints(struct musb *musb)
1837 {
1838         u8                      epnum;
1839         struct musb_hw_ep       *hw_ep;
1840         unsigned                count = 0;
1841
1842         /* initialize endpoint list just once */
1843         INIT_LIST_HEAD(&(musb->g.ep_list));
1844
1845         for (epnum = 0, hw_ep = musb->endpoints;
1846                         epnum < musb->nr_endpoints;
1847                         epnum++, hw_ep++) {
1848                 if (hw_ep->is_shared_fifo /* || !epnum */) {
1849                         init_peripheral_ep(musb, &hw_ep->ep_in, epnum, 0);
1850                         count++;
1851                 } else {
1852                         if (hw_ep->max_packet_sz_tx) {
1853                                 init_peripheral_ep(musb, &hw_ep->ep_in,
1854                                                         epnum, 1);
1855                                 count++;
1856                         }
1857                         if (hw_ep->max_packet_sz_rx) {
1858                                 init_peripheral_ep(musb, &hw_ep->ep_out,
1859                                                         epnum, 0);
1860                                 count++;
1861                         }
1862                 }
1863         }
1864 }
1865
1866 /* called once during driver setup to initialize and link into
1867  * the driver model; memory is zeroed.
1868  */
1869 int __devinit musb_gadget_setup(struct musb *musb)
1870 {
1871         int status;
1872
1873         /* REVISIT minor race:  if (erroneously) setting up two
1874          * musb peripherals at the same time, only the bus lock
1875          * is probably held.
1876          */
1877
1878         musb->g.ops = &musb_gadget_operations;
1879         musb->g.max_speed = USB_SPEED_HIGH;
1880         musb->g.speed = USB_SPEED_UNKNOWN;
1881
1882         /* this "gadget" abstracts/virtualizes the controller */
1883         dev_set_name(&musb->g.dev, "gadget");
1884         musb->g.dev.parent = musb->controller;
1885         musb->g.dev.dma_mask = musb->controller->dma_mask;
1886         musb->g.dev.release = musb_gadget_release;
1887         musb->g.name = musb_driver_name;
1888
1889         if (is_otg_enabled(musb))
1890                 musb->g.is_otg = 1;
1891
1892         musb_g_init_endpoints(musb);
1893
1894         musb->is_active = 0;
1895         musb_platform_try_idle(musb, 0);
1896
1897         status = device_register(&musb->g.dev);
1898         if (status != 0) {
1899                 put_device(&musb->g.dev);
1900                 return status;
1901         }
1902         status = usb_add_gadget_udc(musb->controller, &musb->g);
1903         if (status)
1904                 goto err;
1905
1906         return 0;
1907 err:
1908         musb->g.dev.parent = NULL;
1909         device_unregister(&musb->g.dev);
1910         return status;
1911 }
1912
1913 void musb_gadget_cleanup(struct musb *musb)
1914 {
1915         usb_del_gadget_udc(&musb->g);
1916         if (musb->g.dev.parent)
1917                 device_unregister(&musb->g.dev);
1918 }
1919
1920 /*
1921  * Register the gadget driver. Used by gadget drivers when
1922  * registering themselves with the controller.
1923  *
1924  * -EINVAL something went wrong (not driver)
1925  * -EBUSY another gadget is already using the controller
1926  * -ENOMEM no memory to perform the operation
1927  *
1928  * @param driver the gadget driver
1929  * @return <0 if error, 0 if everything is fine
1930  */
1931 static int musb_gadget_start(struct usb_gadget *g,
1932                 struct usb_gadget_driver *driver)
1933 {
1934         struct musb             *musb = gadget_to_musb(g);
1935         struct usb_otg          *otg = musb->xceiv->otg;
1936         unsigned long           flags;
1937         int                     retval = -EINVAL;
1938
1939         if (driver->max_speed < USB_SPEED_HIGH)
1940                 goto err0;
1941
1942         pm_runtime_get_sync(musb->controller);
1943
1944         dev_dbg(musb->controller, "registering driver %s\n", driver->function);
1945
1946         musb->softconnect = 0;
1947         musb->gadget_driver = driver;
1948
1949         spin_lock_irqsave(&musb->lock, flags);
1950         musb->is_active = 1;
1951
1952         otg_set_peripheral(otg, &musb->g);
1953         musb->xceiv->state = OTG_STATE_B_IDLE;
1954
1955         /*
1956          * FIXME this ignores the softconnect flag.  Drivers are
1957          * allowed hold the peripheral inactive until for example
1958          * userspace hooks up printer hardware or DSP codecs, so
1959          * hosts only see fully functional devices.
1960          */
1961
1962         if (!is_otg_enabled(musb))
1963                 musb_start(musb);
1964
1965         spin_unlock_irqrestore(&musb->lock, flags);
1966
1967         if (is_otg_enabled(musb)) {
1968                 struct usb_hcd  *hcd = musb_to_hcd(musb);
1969
1970                 dev_dbg(musb->controller, "OTG startup...\n");
1971
1972                 /* REVISIT:  funcall to other code, which also
1973                  * handles power budgeting ... this way also
1974                  * ensures HdrcStart is indirectly called.
1975                  */
1976                 retval = usb_add_hcd(musb_to_hcd(musb), 0, 0);
1977                 if (retval < 0) {
1978                         dev_dbg(musb->controller, "add_hcd failed, %d\n", retval);
1979                         goto err2;
1980                 }
1981
1982                 if ((musb->xceiv->last_event == USB_EVENT_ID)
1983                                         && otg->set_vbus)
1984                         otg_set_vbus(otg, 1);
1985
1986                 hcd->self.uses_pio_for_control = 1;
1987         }
1988         if (musb->xceiv->last_event == USB_EVENT_NONE)
1989                 pm_runtime_put(musb->controller);
1990
1991         return 0;
1992
1993 err2:
1994         if (!is_otg_enabled(musb))
1995                 musb_stop(musb);
1996 err0:
1997         return retval;
1998 }
1999
2000 static void stop_activity(struct musb *musb, struct usb_gadget_driver *driver)
2001 {
2002         int                     i;
2003         struct musb_hw_ep       *hw_ep;
2004
2005         /* don't disconnect if it's not connected */
2006         if (musb->g.speed == USB_SPEED_UNKNOWN)
2007                 driver = NULL;
2008         else
2009                 musb->g.speed = USB_SPEED_UNKNOWN;
2010
2011         /* deactivate the hardware */
2012         if (musb->softconnect) {
2013                 musb->softconnect = 0;
2014                 musb_pullup(musb, 0);
2015         }
2016         musb_stop(musb);
2017
2018         /* killing any outstanding requests will quiesce the driver;
2019          * then report disconnect
2020          */
2021         if (driver) {
2022                 for (i = 0, hw_ep = musb->endpoints;
2023                                 i < musb->nr_endpoints;
2024                                 i++, hw_ep++) {
2025                         musb_ep_select(musb->mregs, i);
2026                         if (hw_ep->is_shared_fifo /* || !epnum */) {
2027                                 nuke(&hw_ep->ep_in, -ESHUTDOWN);
2028                         } else {
2029                                 if (hw_ep->max_packet_sz_tx)
2030                                         nuke(&hw_ep->ep_in, -ESHUTDOWN);
2031                                 if (hw_ep->max_packet_sz_rx)
2032                                         nuke(&hw_ep->ep_out, -ESHUTDOWN);
2033                         }
2034                 }
2035         }
2036 }
2037
2038 /*
2039  * Unregister the gadget driver. Used by gadget drivers when
2040  * unregistering themselves from the controller.
2041  *
2042  * @param driver the gadget driver to unregister
2043  */
2044 static int musb_gadget_stop(struct usb_gadget *g,
2045                 struct usb_gadget_driver *driver)
2046 {
2047         struct musb     *musb = gadget_to_musb(g);
2048         unsigned long   flags;
2049
2050         if (musb->xceiv->last_event == USB_EVENT_NONE)
2051                 pm_runtime_get_sync(musb->controller);
2052
2053         /*
2054          * REVISIT always use otg_set_peripheral() here too;
2055          * this needs to shut down the OTG engine.
2056          */
2057
2058         spin_lock_irqsave(&musb->lock, flags);
2059
2060         musb_hnp_stop(musb);
2061
2062         (void) musb_gadget_vbus_draw(&musb->g, 0);
2063
2064         musb->xceiv->state = OTG_STATE_UNDEFINED;
2065         stop_activity(musb, driver);
2066         otg_set_peripheral(musb->xceiv->otg, NULL);
2067
2068         dev_dbg(musb->controller, "unregistering driver %s\n", driver->function);
2069
2070         musb->is_active = 0;
2071         musb_platform_try_idle(musb, 0);
2072         spin_unlock_irqrestore(&musb->lock, flags);
2073
2074         if (is_otg_enabled(musb)) {
2075                 usb_remove_hcd(musb_to_hcd(musb));
2076                 /* FIXME we need to be able to register another
2077                  * gadget driver here and have everything work;
2078                  * that currently misbehaves.
2079                  */
2080         }
2081
2082         if (!is_otg_enabled(musb))
2083                 musb_stop(musb);
2084
2085         pm_runtime_put(musb->controller);
2086
2087         return 0;
2088 }
2089
2090 /* ----------------------------------------------------------------------- */
2091
2092 /* lifecycle operations called through plat_uds.c */
2093
2094 void musb_g_resume(struct musb *musb)
2095 {
2096         musb->is_suspended = 0;
2097         switch (musb->xceiv->state) {
2098         case OTG_STATE_B_IDLE:
2099                 break;
2100         case OTG_STATE_B_WAIT_ACON:
2101         case OTG_STATE_B_PERIPHERAL:
2102                 musb->is_active = 1;
2103                 if (musb->gadget_driver && musb->gadget_driver->resume) {
2104                         spin_unlock(&musb->lock);
2105                         musb->gadget_driver->resume(&musb->g);
2106                         spin_lock(&musb->lock);
2107                 }
2108                 break;
2109         default:
2110                 WARNING("unhandled RESUME transition (%s)\n",
2111                                 otg_state_string(musb->xceiv->state));
2112         }
2113 }
2114
2115 /* called when SOF packets stop for 3+ msec */
2116 void musb_g_suspend(struct musb *musb)
2117 {
2118         u8      devctl;
2119
2120         devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
2121         dev_dbg(musb->controller, "devctl %02x\n", devctl);
2122
2123         switch (musb->xceiv->state) {
2124         case OTG_STATE_B_IDLE:
2125                 if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS)
2126                         musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
2127                 break;
2128         case OTG_STATE_B_PERIPHERAL:
2129                 musb->is_suspended = 1;
2130                 if (musb->gadget_driver && musb->gadget_driver->suspend) {
2131                         spin_unlock(&musb->lock);
2132                         musb->gadget_driver->suspend(&musb->g);
2133                         spin_lock(&musb->lock);
2134                 }
2135                 break;
2136         default:
2137                 /* REVISIT if B_HOST, clear DEVCTL.HOSTREQ;
2138                  * A_PERIPHERAL may need care too
2139                  */
2140                 WARNING("unhandled SUSPEND transition (%s)\n",
2141                                 otg_state_string(musb->xceiv->state));
2142         }
2143 }
2144
2145 /* Called during SRP */
2146 void musb_g_wakeup(struct musb *musb)
2147 {
2148         musb_gadget_wakeup(&musb->g);
2149 }
2150
2151 /* called when VBUS drops below session threshold, and in other cases */
2152 void musb_g_disconnect(struct musb *musb)
2153 {
2154         void __iomem    *mregs = musb->mregs;
2155         u8      devctl = musb_readb(mregs, MUSB_DEVCTL);
2156
2157         dev_dbg(musb->controller, "devctl %02x\n", devctl);
2158
2159         /* clear HR */
2160         musb_writeb(mregs, MUSB_DEVCTL, devctl & MUSB_DEVCTL_SESSION);
2161
2162         /* don't draw vbus until new b-default session */
2163         (void) musb_gadget_vbus_draw(&musb->g, 0);
2164
2165         musb->g.speed = USB_SPEED_UNKNOWN;
2166         if (musb->gadget_driver && musb->gadget_driver->disconnect) {
2167                 spin_unlock(&musb->lock);
2168                 musb->gadget_driver->disconnect(&musb->g);
2169                 spin_lock(&musb->lock);
2170         }
2171
2172         switch (musb->xceiv->state) {
2173         default:
2174                 dev_dbg(musb->controller, "Unhandled disconnect %s, setting a_idle\n",
2175                         otg_state_string(musb->xceiv->state));
2176                 musb->xceiv->state = OTG_STATE_A_IDLE;
2177                 MUSB_HST_MODE(musb);
2178                 break;
2179         case OTG_STATE_A_PERIPHERAL:
2180                 musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
2181                 MUSB_HST_MODE(musb);
2182                 break;
2183         case OTG_STATE_B_WAIT_ACON:
2184         case OTG_STATE_B_HOST:
2185         case OTG_STATE_B_PERIPHERAL:
2186         case OTG_STATE_B_IDLE:
2187                 musb->xceiv->state = OTG_STATE_B_IDLE;
2188                 break;
2189         case OTG_STATE_B_SRP_INIT:
2190                 break;
2191         }
2192
2193         musb->is_active = 0;
2194 }
2195
2196 void musb_g_reset(struct musb *musb)
2197 __releases(musb->lock)
2198 __acquires(musb->lock)
2199 {
2200         void __iomem    *mbase = musb->mregs;
2201         u8              devctl = musb_readb(mbase, MUSB_DEVCTL);
2202         u8              power;
2203
2204         dev_dbg(musb->controller, "<== %s addr=%x driver '%s'\n",
2205                         (devctl & MUSB_DEVCTL_BDEVICE)
2206                                 ? "B-Device" : "A-Device",
2207                         musb_readb(mbase, MUSB_FADDR),
2208                         musb->gadget_driver
2209                                 ? musb->gadget_driver->driver.name
2210                                 : NULL
2211                         );
2212
2213         /* report disconnect, if we didn't already (flushing EP state) */
2214         if (musb->g.speed != USB_SPEED_UNKNOWN)
2215                 musb_g_disconnect(musb);
2216
2217         /* clear HR */
2218         else if (devctl & MUSB_DEVCTL_HR)
2219                 musb_writeb(mbase, MUSB_DEVCTL, MUSB_DEVCTL_SESSION);
2220
2221
2222         /* what speed did we negotiate? */
2223         power = musb_readb(mbase, MUSB_POWER);
2224         musb->g.speed = (power & MUSB_POWER_HSMODE)
2225                         ? USB_SPEED_HIGH : USB_SPEED_FULL;
2226
2227         /* start in USB_STATE_DEFAULT */
2228         musb->is_active = 1;
2229         musb->is_suspended = 0;
2230         MUSB_DEV_MODE(musb);
2231         musb->address = 0;
2232         musb->ep0_state = MUSB_EP0_STAGE_SETUP;
2233
2234         musb->may_wakeup = 0;
2235         musb->g.b_hnp_enable = 0;
2236         musb->g.a_alt_hnp_support = 0;
2237         musb->g.a_hnp_support = 0;
2238
2239         /* Normal reset, as B-Device;
2240          * or else after HNP, as A-Device
2241          */
2242         if (devctl & MUSB_DEVCTL_BDEVICE) {
2243                 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
2244                 musb->g.is_a_peripheral = 0;
2245         } else if (is_otg_enabled(musb)) {
2246                 musb->xceiv->state = OTG_STATE_A_PERIPHERAL;
2247                 musb->g.is_a_peripheral = 1;
2248         } else
2249                 WARN_ON(1);
2250
2251         /* start with default limits on VBUS power draw */
2252         (void) musb_gadget_vbus_draw(&musb->g,
2253                         is_otg_enabled(musb) ? 8 : 100);
2254 }