musb_gadget: fix unhandled endpoint 0 IRQs
[linux-2.6.git] / drivers / usb / musb / musb_core.h
1 /*
2  * MUSB OTG driver defines
3  *
4  * Copyright 2005 Mentor Graphics Corporation
5  * Copyright (C) 2005-2006 by Texas Instruments
6  * Copyright (C) 2006-2007 Nokia Corporation
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * version 2 as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA
21  *
22  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
23  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
25  * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
28  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
29  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  */
34
35 #ifndef __MUSB_CORE_H__
36 #define __MUSB_CORE_H__
37
38 #include <linux/slab.h>
39 #include <linux/list.h>
40 #include <linux/interrupt.h>
41 #include <linux/smp_lock.h>
42 #include <linux/errno.h>
43 #include <linux/clk.h>
44 #include <linux/device.h>
45 #include <linux/usb/ch9.h>
46 #include <linux/usb/gadget.h>
47 #include <linux/usb.h>
48 #include <linux/usb/otg.h>
49 #include <linux/usb/musb.h>
50
51 struct musb;
52 struct musb_hw_ep;
53 struct musb_ep;
54
55
56 #include "musb_debug.h"
57 #include "musb_dma.h"
58
59 #include "musb_io.h"
60 #include "musb_regs.h"
61
62 #include "musb_gadget.h"
63 #include "../core/hcd.h"
64 #include "musb_host.h"
65
66
67
68 #ifdef CONFIG_USB_MUSB_OTG
69
70 #define is_peripheral_enabled(musb)     ((musb)->board_mode != MUSB_HOST)
71 #define is_host_enabled(musb)           ((musb)->board_mode != MUSB_PERIPHERAL)
72 #define is_otg_enabled(musb)            ((musb)->board_mode == MUSB_OTG)
73
74 /* NOTE:  otg and peripheral-only state machines start at B_IDLE.
75  * OTG or host-only go to A_IDLE when ID is sensed.
76  */
77 #define is_peripheral_active(m)         (!(m)->is_host)
78 #define is_host_active(m)               ((m)->is_host)
79
80 #else
81 #define is_peripheral_enabled(musb)     is_peripheral_capable()
82 #define is_host_enabled(musb)           is_host_capable()
83 #define is_otg_enabled(musb)            0
84
85 #define is_peripheral_active(musb)      is_peripheral_capable()
86 #define is_host_active(musb)            is_host_capable()
87 #endif
88
89 #if defined(CONFIG_USB_MUSB_OTG) || defined(CONFIG_USB_MUSB_PERIPHERAL)
90 /* for some reason, the "select USB_GADGET_MUSB_HDRC" doesn't always
91  * override that choice selection (often USB_GADGET_DUMMY_HCD).
92  */
93 #ifndef CONFIG_USB_GADGET_MUSB_HDRC
94 #error bogus Kconfig output ... select CONFIG_USB_GADGET_MUSB_HDRC
95 #endif
96 #endif  /* need MUSB gadget selection */
97
98
99 #ifdef CONFIG_PROC_FS
100 #include <linux/fs.h>
101 #define MUSB_CONFIG_PROC_FS
102 #endif
103
104 /****************************** PERIPHERAL ROLE *****************************/
105
106 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
107
108 #define is_peripheral_capable() (1)
109
110 extern irqreturn_t musb_g_ep0_irq(struct musb *);
111 extern void musb_g_tx(struct musb *, u8);
112 extern void musb_g_rx(struct musb *, u8);
113 extern void musb_g_reset(struct musb *);
114 extern void musb_g_suspend(struct musb *);
115 extern void musb_g_resume(struct musb *);
116 extern void musb_g_wakeup(struct musb *);
117 extern void musb_g_disconnect(struct musb *);
118
119 #else
120
121 #define is_peripheral_capable() (0)
122
123 static inline irqreturn_t musb_g_ep0_irq(struct musb *m) { return IRQ_NONE; }
124 static inline void musb_g_reset(struct musb *m) {}
125 static inline void musb_g_suspend(struct musb *m) {}
126 static inline void musb_g_resume(struct musb *m) {}
127 static inline void musb_g_wakeup(struct musb *m) {}
128 static inline void musb_g_disconnect(struct musb *m) {}
129
130 #endif
131
132 /****************************** HOST ROLE ***********************************/
133
134 #ifdef CONFIG_USB_MUSB_HDRC_HCD
135
136 #define is_host_capable()       (1)
137
138 extern irqreturn_t musb_h_ep0_irq(struct musb *);
139 extern void musb_host_tx(struct musb *, u8);
140 extern void musb_host_rx(struct musb *, u8);
141
142 #else
143
144 #define is_host_capable()       (0)
145
146 static inline irqreturn_t musb_h_ep0_irq(struct musb *m) { return IRQ_NONE; }
147 static inline void musb_host_tx(struct musb *m, u8 e) {}
148 static inline void musb_host_rx(struct musb *m, u8 e) {}
149
150 #endif
151
152
153 /****************************** CONSTANTS ********************************/
154
155 #ifndef MUSB_C_NUM_EPS
156 #define MUSB_C_NUM_EPS ((u8)16)
157 #endif
158
159 #ifndef MUSB_MAX_END0_PACKET
160 #define MUSB_MAX_END0_PACKET ((u16)MUSB_EP0_FIFOSIZE)
161 #endif
162
163 /* host side ep0 states */
164 enum musb_h_ep0_state {
165         MUSB_EP0_IDLE,
166         MUSB_EP0_START,                 /* expect ack of setup */
167         MUSB_EP0_IN,                    /* expect IN DATA */
168         MUSB_EP0_OUT,                   /* expect ack of OUT DATA */
169         MUSB_EP0_STATUS,                /* expect ack of STATUS */
170 } __attribute__ ((packed));
171
172 /* peripheral side ep0 states */
173 enum musb_g_ep0_state {
174         MUSB_EP0_STAGE_IDLE,            /* idle, waiting for SETUP */
175         MUSB_EP0_STAGE_SETUP,           /* received SETUP */
176         MUSB_EP0_STAGE_TX,              /* IN data */
177         MUSB_EP0_STAGE_RX,              /* OUT data */
178         MUSB_EP0_STAGE_STATUSIN,        /* (after OUT data) */
179         MUSB_EP0_STAGE_STATUSOUT,       /* (after IN data) */
180         MUSB_EP0_STAGE_ACKWAIT,         /* after zlp, before statusin */
181 } __attribute__ ((packed));
182
183 /* OTG protocol constants */
184 #define OTG_TIME_A_WAIT_VRISE   100             /* msec (max) */
185 #define OTG_TIME_A_WAIT_BCON    0               /* 0=infinite; min 1000 msec */
186 #define OTG_TIME_A_IDLE_BDIS    200             /* msec (min) */
187
188 /*************************** REGISTER ACCESS ********************************/
189
190 /* Endpoint registers (other than dynfifo setup) can be accessed either
191  * directly with the "flat" model, or after setting up an index register.
192  */
193
194 #if defined(CONFIG_ARCH_DAVINCI) || defined(CONFIG_ARCH_OMAP2430) \
195                 || defined(CONFIG_ARCH_OMAP3430) || defined(CONFIG_BLACKFIN)
196 /* REVISIT indexed access seemed to
197  * misbehave (on DaVinci) for at least peripheral IN ...
198  */
199 #define MUSB_FLAT_REG
200 #endif
201
202 /* TUSB mapping: "flat" plus ep0 special cases */
203 #if     defined(CONFIG_USB_TUSB6010)
204 #define musb_ep_select(_mbase, _epnum) \
205         musb_writeb((_mbase), MUSB_INDEX, (_epnum))
206 #define MUSB_EP_OFFSET                  MUSB_TUSB_OFFSET
207
208 /* "flat" mapping: each endpoint has its own i/o address */
209 #elif   defined(MUSB_FLAT_REG)
210 #define musb_ep_select(_mbase, _epnum)  (((void)(_mbase)), ((void)(_epnum)))
211 #define MUSB_EP_OFFSET                  MUSB_FLAT_OFFSET
212
213 /* "indexed" mapping: INDEX register controls register bank select */
214 #else
215 #define musb_ep_select(_mbase, _epnum) \
216         musb_writeb((_mbase), MUSB_INDEX, (_epnum))
217 #define MUSB_EP_OFFSET                  MUSB_INDEXED_OFFSET
218 #endif
219
220 /****************************** FUNCTIONS ********************************/
221
222 #define MUSB_HST_MODE(_musb)\
223         { (_musb)->is_host = true; }
224 #define MUSB_DEV_MODE(_musb) \
225         { (_musb)->is_host = false; }
226
227 #define test_devctl_hst_mode(_x) \
228         (musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM)
229
230 #define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral")
231
232 /******************************** TYPES *************************************/
233
234 /*
235  * struct musb_hw_ep - endpoint hardware (bidirectional)
236  *
237  * Ordered slightly for better cacheline locality.
238  */
239 struct musb_hw_ep {
240         struct musb             *musb;
241         void __iomem            *fifo;
242         void __iomem            *regs;
243
244 #ifdef CONFIG_USB_TUSB6010
245         void __iomem            *conf;
246 #endif
247
248         /* index in musb->endpoints[]  */
249         u8                      epnum;
250
251         /* hardware configuration, possibly dynamic */
252         bool                    is_shared_fifo;
253         bool                    tx_double_buffered;
254         bool                    rx_double_buffered;
255         u16                     max_packet_sz_tx;
256         u16                     max_packet_sz_rx;
257
258         struct dma_channel      *tx_channel;
259         struct dma_channel      *rx_channel;
260
261 #ifdef CONFIG_USB_TUSB6010
262         /* TUSB has "asynchronous" and "synchronous" dma modes */
263         dma_addr_t              fifo_async;
264         dma_addr_t              fifo_sync;
265         void __iomem            *fifo_sync_va;
266 #endif
267
268 #ifdef CONFIG_USB_MUSB_HDRC_HCD
269         void __iomem            *target_regs;
270
271         /* currently scheduled peripheral endpoint */
272         struct musb_qh          *in_qh;
273         struct musb_qh          *out_qh;
274
275         u8                      rx_reinit;
276         u8                      tx_reinit;
277 #endif
278
279 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
280         /* peripheral side */
281         struct musb_ep          ep_in;                  /* TX */
282         struct musb_ep          ep_out;                 /* RX */
283 #endif
284 };
285
286 static inline struct usb_request *next_in_request(struct musb_hw_ep *hw_ep)
287 {
288 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
289         return next_request(&hw_ep->ep_in);
290 #else
291         return NULL;
292 #endif
293 }
294
295 static inline struct usb_request *next_out_request(struct musb_hw_ep *hw_ep)
296 {
297 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
298         return next_request(&hw_ep->ep_out);
299 #else
300         return NULL;
301 #endif
302 }
303
304 /*
305  * struct musb - Driver instance data.
306  */
307 struct musb {
308         /* device lock */
309         spinlock_t              lock;
310         struct clk              *clock;
311         irqreturn_t             (*isr)(int, void *);
312         struct work_struct      irq_work;
313
314 /* this hub status bit is reserved by USB 2.0 and not seen by usbcore */
315 #define MUSB_PORT_STAT_RESUME   (1 << 31)
316
317         u32                     port1_status;
318
319 #ifdef CONFIG_USB_MUSB_HDRC_HCD
320         unsigned long           rh_timer;
321
322         enum musb_h_ep0_state   ep0_stage;
323
324         /* bulk traffic normally dedicates endpoint hardware, and each
325          * direction has its own ring of host side endpoints.
326          * we try to progress the transfer at the head of each endpoint's
327          * queue until it completes or NAKs too much; then we try the next
328          * endpoint.
329          */
330         struct musb_hw_ep       *bulk_ep;
331
332         struct list_head        control;        /* of musb_qh */
333         struct list_head        in_bulk;        /* of musb_qh */
334         struct list_head        out_bulk;       /* of musb_qh */
335 #endif
336
337         /* called with IRQs blocked; ON/nonzero implies starting a session,
338          * and waiting at least a_wait_vrise_tmout.
339          */
340         void                    (*board_set_vbus)(struct musb *, int is_on);
341
342         struct dma_controller   *dma_controller;
343
344         struct device           *controller;
345         void __iomem            *ctrl_base;
346         void __iomem            *mregs;
347
348 #ifdef CONFIG_USB_TUSB6010
349         dma_addr_t              async;
350         dma_addr_t              sync;
351         void __iomem            *sync_va;
352 #endif
353
354         /* passed down from chip/board specific irq handlers */
355         u8                      int_usb;
356         u16                     int_rx;
357         u16                     int_tx;
358
359         struct otg_transceiver  xceiv;
360
361         int nIrq;
362         unsigned                irq_wake:1;
363
364         struct musb_hw_ep        endpoints[MUSB_C_NUM_EPS];
365 #define control_ep              endpoints
366
367 #define VBUSERR_RETRY_COUNT     3
368         u16                     vbuserr_retry;
369         u16 epmask;
370         u8 nr_endpoints;
371
372         u8 board_mode;          /* enum musb_mode */
373         int                     (*board_set_power)(int state);
374
375         int                     (*set_clock)(struct clk *clk, int is_active);
376
377         u8                      min_power;      /* vbus for periph, in mA/2 */
378
379         bool                    is_host;
380
381         int                     a_wait_bcon;    /* VBUS timeout in msecs */
382         unsigned long           idle_timeout;   /* Next timeout in jiffies */
383
384         /* active means connected and not suspended */
385         unsigned                is_active:1;
386
387         unsigned is_multipoint:1;
388         unsigned ignore_disconnect:1;   /* during bus resets */
389
390 #ifdef C_MP_TX
391         unsigned bulk_split:1;
392 #define can_bulk_split(musb,type) \
393                 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split)
394 #else
395 #define can_bulk_split(musb, type)      0
396 #endif
397
398 #ifdef C_MP_RX
399         unsigned bulk_combine:1;
400 #define can_bulk_combine(musb,type) \
401                 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine)
402 #else
403 #define can_bulk_combine(musb, type)    0
404 #endif
405
406 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
407         /* is_suspended means USB B_PERIPHERAL suspend */
408         unsigned                is_suspended:1;
409
410         /* may_wakeup means remote wakeup is enabled */
411         unsigned                may_wakeup:1;
412
413         /* is_self_powered is reported in device status and the
414          * config descriptor.  is_bus_powered means B_PERIPHERAL
415          * draws some VBUS current; both can be true.
416          */
417         unsigned                is_self_powered:1;
418         unsigned                is_bus_powered:1;
419
420         unsigned                set_address:1;
421         unsigned                test_mode:1;
422         unsigned                softconnect:1;
423
424         u8                      address;
425         u8                      test_mode_nr;
426         u16                     ackpend;                /* ep0 */
427         enum musb_g_ep0_state   ep0_state;
428         struct usb_gadget       g;                      /* the gadget */
429         struct usb_gadget_driver *gadget_driver;        /* its driver */
430 #endif
431
432         struct musb_hdrc_config *config;
433
434 #ifdef MUSB_CONFIG_PROC_FS
435         struct proc_dir_entry *proc_entry;
436 #endif
437 };
438
439 static inline void musb_set_vbus(struct musb *musb, int is_on)
440 {
441         musb->board_set_vbus(musb, is_on);
442 }
443
444 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
445 static inline struct musb *gadget_to_musb(struct usb_gadget *g)
446 {
447         return container_of(g, struct musb, g);
448 }
449 #endif
450
451 #ifdef CONFIG_BLACKFIN
452 static inline int musb_read_fifosize(struct musb *musb,
453                 struct musb_hw_ep *hw_ep, u8 epnum)
454 {
455         musb->nr_endpoints++;
456         musb->epmask |= (1 << epnum);
457
458         if (epnum < 5) {
459                 hw_ep->max_packet_sz_tx = 128;
460                 hw_ep->max_packet_sz_rx = 128;
461         } else {
462                 hw_ep->max_packet_sz_tx = 1024;
463                 hw_ep->max_packet_sz_rx = 1024;
464         }
465         hw_ep->is_shared_fifo = false;
466
467         return 0;
468 }
469
470 static inline void musb_configure_ep0(struct musb *musb)
471 {
472         musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
473         musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
474         musb->endpoints[0].is_shared_fifo = true;
475 }
476
477 #else
478
479 static inline int musb_read_fifosize(struct musb *musb,
480                 struct musb_hw_ep *hw_ep, u8 epnum)
481 {
482         void *mbase = musb->mregs;
483         u8 reg = 0;
484
485         /* read from core using indexed model */
486         reg = musb_readb(mbase, MUSB_EP_OFFSET(epnum, MUSB_FIFOSIZE));
487         /* 0's returned when no more endpoints */
488         if (!reg)
489                 return -ENODEV;
490
491         musb->nr_endpoints++;
492         musb->epmask |= (1 << epnum);
493
494         hw_ep->max_packet_sz_tx = 1 << (reg & 0x0f);
495
496         /* shared TX/RX FIFO? */
497         if ((reg & 0xf0) == 0xf0) {
498                 hw_ep->max_packet_sz_rx = hw_ep->max_packet_sz_tx;
499                 hw_ep->is_shared_fifo = true;
500                 return 0;
501         } else {
502                 hw_ep->max_packet_sz_rx = 1 << ((reg & 0xf0) >> 4);
503                 hw_ep->is_shared_fifo = false;
504         }
505
506         return 0;
507 }
508
509 static inline void musb_configure_ep0(struct musb *musb)
510 {
511         musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
512         musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
513         musb->endpoints[0].is_shared_fifo = true;
514 }
515 #endif /* CONFIG_BLACKFIN */
516
517
518 /***************************** Glue it together *****************************/
519
520 extern const char musb_driver_name[];
521
522 extern void musb_start(struct musb *musb);
523 extern void musb_stop(struct musb *musb);
524
525 extern void musb_write_fifo(struct musb_hw_ep *ep, u16 len, const u8 *src);
526 extern void musb_read_fifo(struct musb_hw_ep *ep, u16 len, u8 *dst);
527
528 extern void musb_load_testpacket(struct musb *);
529
530 extern irqreturn_t musb_interrupt(struct musb *);
531
532 extern void musb_platform_enable(struct musb *musb);
533 extern void musb_platform_disable(struct musb *musb);
534
535 extern void musb_hnp_stop(struct musb *musb);
536
537 extern int musb_platform_set_mode(struct musb *musb, u8 musb_mode);
538
539 #if defined(CONFIG_USB_TUSB6010) || defined(CONFIG_BLACKFIN) || \
540         defined(CONFIG_ARCH_OMAP2430) || defined(CONFIG_ARCH_OMAP34XX)
541 extern void musb_platform_try_idle(struct musb *musb, unsigned long timeout);
542 #else
543 #define musb_platform_try_idle(x, y)            do {} while (0)
544 #endif
545
546 #if defined(CONFIG_USB_TUSB6010) || defined(CONFIG_BLACKFIN)
547 extern int musb_platform_get_vbus_status(struct musb *musb);
548 #else
549 #define musb_platform_get_vbus_status(x)        0
550 #endif
551
552 extern int __init musb_platform_init(struct musb *musb);
553 extern int musb_platform_exit(struct musb *musb);
554
555 #endif  /* __MUSB_CORE_H__ */