OSDN Git Service

e5410bc67df6f1022ac6bdb72b94e41abc7a29db
[uclinux-h8/linux.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/errno.h>
42 #include <linux/timer.h>
43 #include <linux/device.h>
44 #include <linux/usb/ch9.h>
45 #include <linux/usb/gadget.h>
46 #include <linux/usb.h>
47 #include <linux/usb/otg.h>
48 #include <linux/usb/musb.h>
49 #include <linux/phy/phy.h>
50 #include <linux/workqueue.h>
51
52 struct musb;
53 struct musb_hw_ep;
54 struct musb_ep;
55
56 /* Helper defines for struct musb->hwvers */
57 #define MUSB_HWVERS_MAJOR(x)    ((x >> 10) & 0x1f)
58 #define MUSB_HWVERS_MINOR(x)    (x & 0x3ff)
59 #define MUSB_HWVERS_RC          0x8000
60 #define MUSB_HWVERS_1300        0x52C
61 #define MUSB_HWVERS_1400        0x590
62 #define MUSB_HWVERS_1800        0x720
63 #define MUSB_HWVERS_1900        0x784
64 #define MUSB_HWVERS_2000        0x800
65
66 #include "musb_debug.h"
67 #include "musb_dma.h"
68
69 #include "musb_io.h"
70 #include "musb_regs.h"
71
72 #include "musb_gadget.h"
73 #include <linux/usb/hcd.h>
74 #include "musb_host.h"
75
76 /* NOTE:  otg and peripheral-only state machines start at B_IDLE.
77  * OTG or host-only go to A_IDLE when ID is sensed.
78  */
79 #define is_peripheral_active(m)         (!(m)->is_host)
80 #define is_host_active(m)               ((m)->is_host)
81
82 enum {
83         MUSB_PORT_MODE_HOST     = 1,
84         MUSB_PORT_MODE_GADGET,
85         MUSB_PORT_MODE_DUAL_ROLE,
86 };
87
88 /****************************** CONSTANTS ********************************/
89
90 #ifndef MUSB_C_NUM_EPS
91 #define MUSB_C_NUM_EPS ((u8)16)
92 #endif
93
94 #ifndef MUSB_MAX_END0_PACKET
95 #define MUSB_MAX_END0_PACKET ((u16)MUSB_EP0_FIFOSIZE)
96 #endif
97
98 /* host side ep0 states */
99 enum musb_h_ep0_state {
100         MUSB_EP0_IDLE,
101         MUSB_EP0_START,                 /* expect ack of setup */
102         MUSB_EP0_IN,                    /* expect IN DATA */
103         MUSB_EP0_OUT,                   /* expect ack of OUT DATA */
104         MUSB_EP0_STATUS,                /* expect ack of STATUS */
105 } __attribute__ ((packed));
106
107 /* peripheral side ep0 states */
108 enum musb_g_ep0_state {
109         MUSB_EP0_STAGE_IDLE,            /* idle, waiting for SETUP */
110         MUSB_EP0_STAGE_SETUP,           /* received SETUP */
111         MUSB_EP0_STAGE_TX,              /* IN data */
112         MUSB_EP0_STAGE_RX,              /* OUT data */
113         MUSB_EP0_STAGE_STATUSIN,        /* (after OUT data) */
114         MUSB_EP0_STAGE_STATUSOUT,       /* (after IN data) */
115         MUSB_EP0_STAGE_ACKWAIT,         /* after zlp, before statusin */
116 } __attribute__ ((packed));
117
118 /*
119  * OTG protocol constants.  See USB OTG 1.3 spec,
120  * sections 5.5 "Device Timings" and 6.6.5 "Timers".
121  */
122 #define OTG_TIME_A_WAIT_VRISE   100             /* msec (max) */
123 #define OTG_TIME_A_WAIT_BCON    1100            /* min 1 second */
124 #define OTG_TIME_A_AIDL_BDIS    200             /* min 200 msec */
125 #define OTG_TIME_B_ASE0_BRST    100             /* min 3.125 ms */
126
127
128 /*************************** REGISTER ACCESS ********************************/
129
130 /* Endpoint registers (other than dynfifo setup) can be accessed either
131  * directly with the "flat" model, or after setting up an index register.
132  */
133
134 #if defined(CONFIG_ARCH_DAVINCI) || defined(CONFIG_SOC_OMAP2430) \
135                 || defined(CONFIG_SOC_OMAP3430) || defined(CONFIG_BLACKFIN) \
136                 || defined(CONFIG_ARCH_OMAP4)
137 /* REVISIT indexed access seemed to
138  * misbehave (on DaVinci) for at least peripheral IN ...
139  */
140 #define MUSB_FLAT_REG
141 #endif
142
143 /* TUSB mapping: "flat" plus ep0 special cases */
144 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
145         defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
146 #define musb_ep_select(_mbase, _epnum) \
147         musb_writeb((_mbase), MUSB_INDEX, (_epnum))
148 #define MUSB_EP_OFFSET                  MUSB_TUSB_OFFSET
149
150 /* "flat" mapping: each endpoint has its own i/o address */
151 #elif   defined(MUSB_FLAT_REG)
152 #define musb_ep_select(_mbase, _epnum)  (((void)(_mbase)), ((void)(_epnum)))
153 #define MUSB_EP_OFFSET                  MUSB_FLAT_OFFSET
154
155 /* "indexed" mapping: INDEX register controls register bank select */
156 #else
157 #define musb_ep_select(_mbase, _epnum) \
158         musb_writeb((_mbase), MUSB_INDEX, (_epnum))
159 #define MUSB_EP_OFFSET                  MUSB_INDEXED_OFFSET
160 #endif
161
162 /****************************** FUNCTIONS ********************************/
163
164 #define MUSB_HST_MODE(_musb)\
165         { (_musb)->is_host = true; }
166 #define MUSB_DEV_MODE(_musb) \
167         { (_musb)->is_host = false; }
168
169 #define test_devctl_hst_mode(_x) \
170         (musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM)
171
172 #define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral")
173
174 /******************************** TYPES *************************************/
175
176 struct musb_io;
177
178 /**
179  * struct musb_platform_ops - Operations passed to musb_core by HW glue layer
180  * @quirks:     flags for platform specific quirks
181  * @enable:     enable device
182  * @disable:    disable device
183  * @ep_offset:  returns the end point offset
184  * @ep_select:  selects the specified end point
185  * @fifo_mode:  sets the fifo mode
186  * @fifo_offset: returns the fifo offset
187  * @readb:      read 8 bits
188  * @writeb:     write 8 bits
189  * @readw:      read 16 bits
190  * @writew:     write 16 bits
191  * @readl:      read 32 bits
192  * @writel:     write 32 bits
193  * @read_fifo:  reads the fifo
194  * @write_fifo: writes to fifo
195  * @init:       turns on clocks, sets up platform-specific registers, etc
196  * @exit:       undoes @init
197  * @set_mode:   forcefully changes operating mode
198  * @try_ilde:   tries to idle the IP
199  * @vbus_status: returns vbus status if possible
200  * @set_vbus:   forces vbus status
201  * @adjust_channel_params: pre check for standard dma channel_program func
202  */
203 struct musb_platform_ops {
204
205 #define MUSB_DMA_UX500          BIT(6)
206 #define MUSB_DMA_CPPI41         BIT(5)
207 #define MUSB_DMA_CPPI           BIT(4)
208 #define MUSB_DMA_TUSB_OMAP      BIT(3)
209 #define MUSB_DMA_INVENTRA       BIT(2)
210 #define MUSB_IN_TUSB            BIT(1)
211 #define MUSB_INDEXED_EP         BIT(0)
212         u32     quirks;
213
214         int     (*init)(struct musb *musb);
215         int     (*exit)(struct musb *musb);
216
217         void    (*enable)(struct musb *musb);
218         void    (*disable)(struct musb *musb);
219
220         u32     (*ep_offset)(u8 epnum, u16 offset);
221         void    (*ep_select)(void __iomem *mbase, u8 epnum);
222         u16     fifo_mode;
223         u32     (*fifo_offset)(u8 epnum);
224         u8      (*readb)(const void __iomem *addr, unsigned offset);
225         void    (*writeb)(void __iomem *addr, unsigned offset, u8 data);
226         u16     (*readw)(const void __iomem *addr, unsigned offset);
227         void    (*writew)(void __iomem *addr, unsigned offset, u16 data);
228         u32     (*readl)(const void __iomem *addr, unsigned offset);
229         void    (*writel)(void __iomem *addr, unsigned offset, u32 data);
230         void    (*read_fifo)(struct musb_hw_ep *hw_ep, u16 len, u8 *buf);
231         void    (*write_fifo)(struct musb_hw_ep *hw_ep, u16 len, const u8 *buf);
232         int     (*set_mode)(struct musb *musb, u8 mode);
233         void    (*try_idle)(struct musb *musb, unsigned long timeout);
234         int     (*reset)(struct musb *musb);
235
236         int     (*vbus_status)(struct musb *musb);
237         void    (*set_vbus)(struct musb *musb, int on);
238
239         int     (*adjust_channel_params)(struct dma_channel *channel,
240                                 u16 packet_sz, u8 *mode,
241                                 dma_addr_t *dma_addr, u32 *len);
242 };
243
244 /*
245  * struct musb_hw_ep - endpoint hardware (bidirectional)
246  *
247  * Ordered slightly for better cacheline locality.
248  */
249 struct musb_hw_ep {
250         struct musb             *musb;
251         void __iomem            *fifo;
252         void __iomem            *regs;
253
254 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
255         defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
256         void __iomem            *conf;
257 #endif
258
259         /* index in musb->endpoints[]  */
260         u8                      epnum;
261
262         /* hardware configuration, possibly dynamic */
263         bool                    is_shared_fifo;
264         bool                    tx_double_buffered;
265         bool                    rx_double_buffered;
266         u16                     max_packet_sz_tx;
267         u16                     max_packet_sz_rx;
268
269         struct dma_channel      *tx_channel;
270         struct dma_channel      *rx_channel;
271
272 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
273         defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
274         /* TUSB has "asynchronous" and "synchronous" dma modes */
275         dma_addr_t              fifo_async;
276         dma_addr_t              fifo_sync;
277         void __iomem            *fifo_sync_va;
278 #endif
279
280         void __iomem            *target_regs;
281
282         /* currently scheduled peripheral endpoint */
283         struct musb_qh          *in_qh;
284         struct musb_qh          *out_qh;
285
286         u8                      rx_reinit;
287         u8                      tx_reinit;
288
289         /* peripheral side */
290         struct musb_ep          ep_in;                  /* TX */
291         struct musb_ep          ep_out;                 /* RX */
292 };
293
294 static inline struct musb_request *next_in_request(struct musb_hw_ep *hw_ep)
295 {
296         return next_request(&hw_ep->ep_in);
297 }
298
299 static inline struct musb_request *next_out_request(struct musb_hw_ep *hw_ep)
300 {
301         return next_request(&hw_ep->ep_out);
302 }
303
304 struct musb_csr_regs {
305         /* FIFO registers */
306         u16 txmaxp, txcsr, rxmaxp, rxcsr;
307         u16 rxfifoadd, txfifoadd;
308         u8 txtype, txinterval, rxtype, rxinterval;
309         u8 rxfifosz, txfifosz;
310         u8 txfunaddr, txhubaddr, txhubport;
311         u8 rxfunaddr, rxhubaddr, rxhubport;
312 };
313
314 struct musb_context_registers {
315
316         u8 power;
317         u8 intrusbe;
318         u16 frame;
319         u8 index, testmode;
320
321         u8 devctl, busctl, misc;
322         u32 otg_interfsel;
323
324         struct musb_csr_regs index_regs[MUSB_C_NUM_EPS];
325 };
326
327 /*
328  * struct musb - Driver instance data.
329  */
330 struct musb {
331         /* device lock */
332         spinlock_t              lock;
333
334         struct musb_io          io;
335         const struct musb_platform_ops *ops;
336         struct musb_context_registers context;
337
338         irqreturn_t             (*isr)(int, void *);
339         struct work_struct      irq_work;
340         struct delayed_work     recover_work;
341         struct delayed_work     deassert_reset_work;
342         struct delayed_work     finish_resume_work;
343         u16                     hwvers;
344
345         u16                     intrrxe;
346         u16                     intrtxe;
347 /* this hub status bit is reserved by USB 2.0 and not seen by usbcore */
348 #define MUSB_PORT_STAT_RESUME   (1 << 31)
349
350         u32                     port1_status;
351
352         unsigned long           rh_timer;
353
354         enum musb_h_ep0_state   ep0_stage;
355
356         /* bulk traffic normally dedicates endpoint hardware, and each
357          * direction has its own ring of host side endpoints.
358          * we try to progress the transfer at the head of each endpoint's
359          * queue until it completes or NAKs too much; then we try the next
360          * endpoint.
361          */
362         struct musb_hw_ep       *bulk_ep;
363
364         struct list_head        control;        /* of musb_qh */
365         struct list_head        in_bulk;        /* of musb_qh */
366         struct list_head        out_bulk;       /* of musb_qh */
367
368         struct timer_list       otg_timer;
369         struct notifier_block   nb;
370
371         struct dma_controller   *dma_controller;
372
373         struct device           *controller;
374         void __iomem            *ctrl_base;
375         void __iomem            *mregs;
376
377 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
378         defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
379         dma_addr_t              async;
380         dma_addr_t              sync;
381         void __iomem            *sync_va;
382         u8                      tusb_revision;
383 #endif
384
385         /* passed down from chip/board specific irq handlers */
386         u8                      int_usb;
387         u16                     int_rx;
388         u16                     int_tx;
389
390         struct usb_phy          *xceiv;
391         struct phy              *phy;
392
393         int nIrq;
394         unsigned                irq_wake:1;
395
396         struct musb_hw_ep        endpoints[MUSB_C_NUM_EPS];
397 #define control_ep              endpoints
398
399 #define VBUSERR_RETRY_COUNT     3
400         u16                     vbuserr_retry;
401         u16 epmask;
402         u8 nr_endpoints;
403
404         int                     (*board_set_power)(int state);
405
406         u8                      min_power;      /* vbus for periph, in mA/2 */
407
408         int                     port_mode;      /* MUSB_PORT_MODE_* */
409         bool                    is_host;
410
411         int                     a_wait_bcon;    /* VBUS timeout in msecs */
412         unsigned long           idle_timeout;   /* Next timeout in jiffies */
413
414         /* active means connected and not suspended */
415         unsigned                is_active:1;
416
417         unsigned is_multipoint:1;
418
419         unsigned                hb_iso_rx:1;    /* high bandwidth iso rx? */
420         unsigned                hb_iso_tx:1;    /* high bandwidth iso tx? */
421         unsigned                dyn_fifo:1;     /* dynamic FIFO supported? */
422
423         unsigned                bulk_split:1;
424 #define can_bulk_split(musb,type) \
425         (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split)
426
427         unsigned                bulk_combine:1;
428 #define can_bulk_combine(musb,type) \
429         (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine)
430
431         /* is_suspended means USB B_PERIPHERAL suspend */
432         unsigned                is_suspended:1;
433         unsigned                need_finish_resume :1;
434
435         /* may_wakeup means remote wakeup is enabled */
436         unsigned                may_wakeup:1;
437
438         /* is_self_powered is reported in device status and the
439          * config descriptor.  is_bus_powered means B_PERIPHERAL
440          * draws some VBUS current; both can be true.
441          */
442         unsigned                is_self_powered:1;
443         unsigned                is_bus_powered:1;
444
445         unsigned                set_address:1;
446         unsigned                test_mode:1;
447         unsigned                softconnect:1;
448
449         u8                      address;
450         u8                      test_mode_nr;
451         u16                     ackpend;                /* ep0 */
452         enum musb_g_ep0_state   ep0_state;
453         struct usb_gadget       g;                      /* the gadget */
454         struct usb_gadget_driver *gadget_driver;        /* its driver */
455         struct usb_hcd          *hcd;                   /* the usb hcd */
456
457         /*
458          * FIXME: Remove this flag.
459          *
460          * This is only added to allow Blackfin to work
461          * with current driver. For some unknown reason
462          * Blackfin doesn't work with double buffering
463          * and that's enabled by default.
464          *
465          * We added this flag to forcefully disable double
466          * buffering until we get it working.
467          */
468         unsigned                double_buffer_not_ok:1;
469
470         struct musb_hdrc_config *config;
471
472         int                     xceiv_old_state;
473 #ifdef CONFIG_DEBUG_FS
474         struct dentry           *debugfs_root;
475 #endif
476 };
477
478 static inline struct musb *gadget_to_musb(struct usb_gadget *g)
479 {
480         return container_of(g, struct musb, g);
481 }
482
483 #ifdef CONFIG_BLACKFIN
484 static inline int musb_read_fifosize(struct musb *musb,
485                 struct musb_hw_ep *hw_ep, u8 epnum)
486 {
487         musb->nr_endpoints++;
488         musb->epmask |= (1 << epnum);
489
490         if (epnum < 5) {
491                 hw_ep->max_packet_sz_tx = 128;
492                 hw_ep->max_packet_sz_rx = 128;
493         } else {
494                 hw_ep->max_packet_sz_tx = 1024;
495                 hw_ep->max_packet_sz_rx = 1024;
496         }
497         hw_ep->is_shared_fifo = false;
498
499         return 0;
500 }
501
502 static inline void musb_configure_ep0(struct musb *musb)
503 {
504         musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
505         musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
506         musb->endpoints[0].is_shared_fifo = true;
507 }
508
509 #else
510
511 static inline int musb_read_fifosize(struct musb *musb,
512                 struct musb_hw_ep *hw_ep, u8 epnum)
513 {
514         void __iomem *mbase = musb->mregs;
515         u8 reg = 0;
516
517         /* read from core using indexed model */
518         reg = musb_readb(mbase, MUSB_EP_OFFSET(epnum, MUSB_FIFOSIZE));
519         /* 0's returned when no more endpoints */
520         if (!reg)
521                 return -ENODEV;
522
523         musb->nr_endpoints++;
524         musb->epmask |= (1 << epnum);
525
526         hw_ep->max_packet_sz_tx = 1 << (reg & 0x0f);
527
528         /* shared TX/RX FIFO? */
529         if ((reg & 0xf0) == 0xf0) {
530                 hw_ep->max_packet_sz_rx = hw_ep->max_packet_sz_tx;
531                 hw_ep->is_shared_fifo = true;
532                 return 0;
533         } else {
534                 hw_ep->max_packet_sz_rx = 1 << ((reg & 0xf0) >> 4);
535                 hw_ep->is_shared_fifo = false;
536         }
537
538         return 0;
539 }
540
541 static inline void musb_configure_ep0(struct musb *musb)
542 {
543         musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
544         musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
545         musb->endpoints[0].is_shared_fifo = true;
546 }
547 #endif /* CONFIG_BLACKFIN */
548
549
550 /***************************** Glue it together *****************************/
551
552 extern const char musb_driver_name[];
553
554 extern void musb_stop(struct musb *musb);
555 extern void musb_start(struct musb *musb);
556
557 extern void musb_write_fifo(struct musb_hw_ep *ep, u16 len, const u8 *src);
558 extern void musb_read_fifo(struct musb_hw_ep *ep, u16 len, u8 *dst);
559
560 extern void musb_load_testpacket(struct musb *);
561
562 extern irqreturn_t musb_interrupt(struct musb *);
563
564 extern void musb_hnp_stop(struct musb *musb);
565
566 static inline void musb_platform_set_vbus(struct musb *musb, int is_on)
567 {
568         if (musb->ops->set_vbus)
569                 musb->ops->set_vbus(musb, is_on);
570 }
571
572 static inline void musb_platform_enable(struct musb *musb)
573 {
574         if (musb->ops->enable)
575                 musb->ops->enable(musb);
576 }
577
578 static inline void musb_platform_disable(struct musb *musb)
579 {
580         if (musb->ops->disable)
581                 musb->ops->disable(musb);
582 }
583
584 static inline int musb_platform_set_mode(struct musb *musb, u8 mode)
585 {
586         if (!musb->ops->set_mode)
587                 return 0;
588
589         return musb->ops->set_mode(musb, mode);
590 }
591
592 static inline void musb_platform_try_idle(struct musb *musb,
593                 unsigned long timeout)
594 {
595         if (musb->ops->try_idle)
596                 musb->ops->try_idle(musb, timeout);
597 }
598
599 static inline int  musb_platform_reset(struct musb *musb)
600 {
601         if (!musb->ops->reset)
602                 return -EINVAL;
603
604         return musb->ops->reset(musb);
605 }
606
607 static inline int musb_platform_get_vbus_status(struct musb *musb)
608 {
609         if (!musb->ops->vbus_status)
610                 return 0;
611
612         return musb->ops->vbus_status(musb);
613 }
614
615 static inline int musb_platform_init(struct musb *musb)
616 {
617         if (!musb->ops->init)
618                 return -EINVAL;
619
620         return musb->ops->init(musb);
621 }
622
623 static inline int musb_platform_exit(struct musb *musb)
624 {
625         if (!musb->ops->exit)
626                 return -EINVAL;
627
628         return musb->ops->exit(musb);
629 }
630
631 #endif  /* __MUSB_CORE_H__ */