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