e070251deb2ae3efe3f7f8946f4de25e38a8dc0a
[sitara-epos/sitara-epos-kernel.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  */
35 #ifndef __MUSB_CORE_H__
36 #define __MUSB_CORE_H__
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>
50 struct musb;
51 struct musb_hw_ep;
52 struct musb_ep;
54 /* Helper defines for struct musb->hwvers */
55 #define MUSB_HWVERS_MAJOR(x)    ((x >> 10) & 0x1f)
56 #define MUSB_HWVERS_MINOR(x)    (x & 0x3ff)
57 #define MUSB_HWVERS_RC          0x8000
58 #define MUSB_HWVERS_1300        0x52C
59 #define MUSB_HWVERS_1400        0x590
60 #define MUSB_HWVERS_1800        0x720
61 #define MUSB_HWVERS_1900        0x784
62 #define MUSB_HWVERS_2000        0x800
64 extern u8 (*musb_readb)(const void __iomem *addr, unsigned offset);
65 extern void (*musb_writeb)(void __iomem *addr, unsigned offset, u8 data);
67 #include "musb_debug.h"
68 #include "musb_dma.h"
70 #include "musb_io.h"
71 #include "musb_regs.h"
73 #include "musb_gadget.h"
74 #include <linux/usb/hcd.h>
75 #include "musb_host.h"
77 #define is_peripheral_enabled(musb)     ((musb)->board_mode != MUSB_HOST)
78 #define is_host_enabled(musb)           ((musb)->board_mode != MUSB_PERIPHERAL)
79 #define is_otg_enabled(musb)            ((musb)->board_mode == MUSB_OTG)
81 /* NOTE:  otg and peripheral-only state machines start at B_IDLE.
82  * OTG or host-only go to A_IDLE when ID is sensed.
83  */
84 #define is_peripheral_active(m)         (!(m)->is_host)
85 #define is_host_active(m)               ((m)->is_host)
87 #ifndef CONFIG_HAVE_CLK
88 /* Dummy stub for clk framework */
89 #define clk_get(dev, id)        NULL
90 #define clk_put(clock)          do {} while (0)
91 #define clk_enable(clock)       do {} while (0)
92 #define clk_disable(clock)      do {} while (0)
93 #endif
95 #ifdef CONFIG_PROC_FS
96 #include <linux/fs.h>
97 #define MUSB_CONFIG_PROC_FS
98 #endif
100 /****************************** PERIPHERAL ROLE *****************************/
102 #define is_peripheral_capable() (1)
104 extern irqreturn_t musb_g_ep0_irq(struct musb *);
105 extern void musb_g_tx(struct musb *, u8);
106 extern void musb_g_rx(struct musb *, u8);
107 extern void musb_g_reset(struct musb *);
108 extern void musb_g_suspend(struct musb *);
109 extern void musb_g_resume(struct musb *);
110 extern void musb_g_wakeup(struct musb *);
111 extern void musb_g_disconnect(struct musb *);
113 /****************************** HOST ROLE ***********************************/
115 #define is_host_capable()       (1)
117 extern irqreturn_t musb_h_ep0_irq(struct musb *);
118 extern void musb_host_tx(struct musb *, u8);
119 extern void musb_host_rx(struct musb *, u8);
121 /****************************** CONSTANTS ********************************/
123 #ifndef MUSB_C_NUM_EPS
124 #define MUSB_C_NUM_EPS ((u8)16)
125 #endif
127 #ifndef MUSB_MAX_END0_PACKET
128 #define MUSB_MAX_END0_PACKET ((u16)MUSB_EP0_FIFOSIZE)
129 #endif
131 /* host side ep0 states */
132 enum musb_h_ep0_state {
133         MUSB_EP0_IDLE,
134         MUSB_EP0_START,                 /* expect ack of setup */
135         MUSB_EP0_IN,                    /* expect IN DATA */
136         MUSB_EP0_OUT,                   /* expect ack of OUT DATA */
137         MUSB_EP0_STATUS,                /* expect ack of STATUS */
138 } __attribute__ ((packed));
140 /* peripheral side ep0 states */
141 enum musb_g_ep0_state {
142         MUSB_EP0_STAGE_IDLE,            /* idle, waiting for SETUP */
143         MUSB_EP0_STAGE_SETUP,           /* received SETUP */
144         MUSB_EP0_STAGE_TX,              /* IN data */
145         MUSB_EP0_STAGE_RX,              /* OUT data */
146         MUSB_EP0_STAGE_STATUSIN,        /* (after OUT data) */
147         MUSB_EP0_STAGE_STATUSOUT,       /* (after IN data) */
148         MUSB_EP0_STAGE_ACKWAIT,         /* after zlp, before statusin */
149 } __attribute__ ((packed));
151 /*
152  * OTG protocol constants.  See USB OTG 1.3 spec,
153  * sections 5.5 "Device Timings" and 6.6.5 "Timers".
154  */
155 #define OTG_TIME_A_WAIT_VRISE   100             /* msec (max) */
156 #define OTG_TIME_A_WAIT_BCON    1100            /* min 1 second */
157 #define OTG_TIME_A_AIDL_BDIS    200             /* min 200 msec */
158 #define OTG_TIME_B_ASE0_BRST    100             /* min 3.125 ms */
161 /*************************** REGISTER ACCESS ********************************/
163 /* Endpoint registers (other than dynfifo setup) can be accessed either
164  * directly with the "flat" model, or after setting up an index register.
165  */
167 #if defined(CONFIG_ARCH_DAVINCI) || defined(CONFIG_SOC_OMAP2430) \
168                 || defined(CONFIG_SOC_OMAP3430) || defined(CONFIG_BLACKFIN) \
169                 || defined(CONFIG_ARCH_OMAP4)
170 /* REVISIT indexed access seemed to
171  * misbehave (on DaVinci) for at least peripheral IN ...
172  */
173 #define MUSB_FLAT_REG
174 #endif
176 /* "flat" mapping: each endpoint has its own i/o address */
177 #ifdef  MUSB_FLAT_REG
178 #define musb_ep_select(_musb, _mbase, _epnum)   \
179         (((void)(_mbase)), ((void)(_epnum)))
180 #define MUSB_EP_OFFSET                  MUSB_FLAT_OFFSET
182 /* "indexed" mapping: INDEX register controls register bank select */
183 #else
184 #define musb_ep_select(_musb, _mbase, _epnum) \
185         musb_writeb((_mbase), MUSB_INDEX, (_epnum))
186 #define MUSB_EP_OFFSET                  MUSB_INDEXED_OFFSET
187 #endif
189 /****************************** FUNCTIONS ********************************/
191 #define MUSB_HST_MODE(_musb)\
192         { (_musb)->is_host = true; }
193 #define MUSB_DEV_MODE(_musb) \
194         { (_musb)->is_host = false; }
196 #define test_devctl_hst_mode(_x) \
197         (musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM)
199 #define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral")
201 /******************************** TYPES *************************************/
203 #define     MUSB_GLUE_TUSB_STYLE   0x0001
205 /**
206  * struct musb_platform_ops - Operations passed to musb_core by HW glue layer
207  * @fifo_mode: which fifo_mode is taken by me
208  * @flags:      each hw glue difference information will be here
209  * @init:       turns on clocks, sets up platform-specific registers, etc
210  * @exit:       undoes @init
211  * @read_fifo: read data from musb fifo in PIO
212  * @write_fifo: write data into musb fifo in PIO
213  * @set_mode:   forcefully changes operating mode
214  * @try_ilde:   tries to idle the IP
215  * @get_hw_revision: get hardware revision
216  * @vbus_status: returns vbus status if possible
217  * @set_vbus:   forces vbus status
218  * @adjust_channel_params: pre check for standard dma channel_program func
219  */
220 struct musb_platform_ops {
221         short   fifo_mode;
222         unsigned short  flags;
223         int     (*init)(struct musb *musb);
224         int     (*exit)(struct musb *musb);
226         void    (*enable)(struct musb *musb);
227         void    (*disable)(struct musb *musb);
229         void (*read_fifo)(struct musb_hw_ep *hw_ep, u16 len, u8 *buf);
230         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);
235         u16  (*get_hw_revision)(struct musb *musb);
237         int     (*vbus_status)(struct musb *musb);
238         void    (*set_vbus)(struct musb *musb, int on);
240         int     (*adjust_channel_params)(struct dma_channel *channel,
241                                 u16 packet_sz, u8 *mode,
242                                 dma_addr_t *dma_addr, u32 *len);
243 };
245 /*
246  * struct musb_hw_ep - endpoint hardware (bidirectional)
247  *
248  * Ordered slightly for better cacheline locality.
249  */
250 struct musb_hw_ep {
251         struct musb             *musb;
252         void __iomem            *fifo;
253         void __iomem            *regs;
255         /*Fixme: the following field is only used by tusb*/
256         void __iomem            *conf;
258         /* index in musb->endpoints[]  */
259         u8                      epnum;
261         /* hardware configuration, possibly dynamic */
262         bool                    is_shared_fifo;
263         bool                    tx_double_buffered;
264         bool                    rx_double_buffered;
265         u16                     max_packet_sz_tx;
266         u16                     max_packet_sz_rx;
268         struct dma_channel      *tx_channel;
269         struct dma_channel      *rx_channel;
271         /*
272          * TUSB has "asynchronous" and "synchronous" dma modes
273          * Fixme: the following three fields are only valid for TUSB.
274          * */
275         dma_addr_t              fifo_async;
276         dma_addr_t              fifo_sync;
277         void __iomem            *fifo_sync_va;
279         void __iomem            *target_regs;
281         /* currently scheduled peripheral endpoint */
282         struct musb_qh          *in_qh;
283         struct musb_qh          *out_qh;
285         u8                      rx_reinit;
286         u8                      tx_reinit;
288         /* peripheral side */
289         struct musb_ep          ep_in;                  /* TX */
290         struct musb_ep          ep_out;                 /* RX */
291 };
293 static inline struct musb_request *next_in_request(struct musb_hw_ep *hw_ep)
295         return next_request(&hw_ep->ep_in);
298 static inline struct musb_request *next_out_request(struct musb_hw_ep *hw_ep)
300         return next_request(&hw_ep->ep_out);
303 struct musb_csr_regs {
304         /* FIFO registers */
305         u16 txmaxp, txcsr, rxmaxp, rxcsr;
306         u16 rxfifoadd, txfifoadd;
307         u8 txtype, txinterval, rxtype, rxinterval;
308         u8 rxfifosz, txfifosz;
309         u8 txfunaddr, txhubaddr, txhubport;
310         u8 rxfunaddr, rxhubaddr, rxhubport;
311 };
313 struct musb_context_registers {
315         u8 power;
316         u16 intrtxe, intrrxe;
317         u8 intrusbe;
318         u16 frame;
319         u8 index, testmode;
321         u8 devctl, busctl, misc;
322         u32 otg_interfsel;
324         struct musb_csr_regs index_regs[MUSB_C_NUM_EPS];
325 };
327 /*
328  * struct musb - Driver instance data.
329  */
330 struct musb {
331         /* device lock */
332         spinlock_t              lock;
334         const struct musb_platform_ops *ops;
335         struct musb_context_registers context;
337         irqreturn_t             (*isr)(int, void *);
338         struct work_struct      irq_work;
339         struct work_struct      otg_notifier_work;
340         u16                     hwvers;
342 /* this hub status bit is reserved by USB 2.0 and not seen by usbcore */
343 #define MUSB_PORT_STAT_RESUME   (1 << 31)
345         u32                     port1_status;
347         unsigned long           rh_timer;
349         enum musb_h_ep0_state   ep0_stage;
351         /* bulk traffic normally dedicates endpoint hardware, and each
352          * direction has its own ring of host side endpoints.
353          * we try to progress the transfer at the head of each endpoint's
354          * queue until it completes or NAKs too much; then we try the next
355          * endpoint.
356          */
357         struct musb_hw_ep       *bulk_ep;
359         struct list_head        control;        /* of musb_qh */
360         struct list_head        in_bulk;        /* of musb_qh */
361         struct list_head        out_bulk;       /* of musb_qh */
363         struct timer_list       otg_timer;
364         struct notifier_block   nb;
366         struct dma_controller   *dma_controller;
368         struct device           *controller;
369         void __iomem            *ctrl_base;
370         void __iomem            *mregs;
372         /*Fixme: the three fields below are only used by tusb*/
373         dma_addr_t              async;
374         dma_addr_t              sync;
375         void __iomem            *sync_va;
377         /* passed down from chip/board specific irq handlers */
378         u8                      int_usb;
379         u16                     int_rx;
380         u16                     int_tx;
382         struct otg_transceiver  *xceiv;
383         u8                      xceiv_event;
385         int nIrq;
386         unsigned                irq_wake:1;
388         struct musb_hw_ep        endpoints[MUSB_C_NUM_EPS];
389 #define control_ep              endpoints
391 #define VBUSERR_RETRY_COUNT     3
392         u16                     vbuserr_retry;
393         u16 epmask;
394         u8 nr_endpoints;
396         u8 board_mode;          /* enum musb_mode */
397         int                     (*board_set_power)(int state);
399         u8                      min_power;      /* vbus for periph, in mA/2 */
401         bool                    is_host;
403         int                     a_wait_bcon;    /* VBUS timeout in msecs */
404         unsigned long           idle_timeout;   /* Next timeout in jiffies */
406         /* active means connected and not suspended */
407         unsigned                is_active:1;
409         unsigned is_multipoint:1;
410         unsigned ignore_disconnect:1;   /* during bus resets */
412         unsigned                hb_iso_rx:1;    /* high bandwidth iso rx? */
413         unsigned                hb_iso_tx:1;    /* high bandwidth iso tx? */
414         unsigned                dyn_fifo:1;     /* dynamic FIFO supported? */
416         unsigned                bulk_split:1;
417 #define can_bulk_split(musb,type) \
418         (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split)
420         unsigned                bulk_combine:1;
421 #define can_bulk_combine(musb,type) \
422         (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine)
424         /* is_suspended means USB B_PERIPHERAL suspend */
425         unsigned                is_suspended:1;
427         /* may_wakeup means remote wakeup is enabled */
428         unsigned                may_wakeup:1;
430         /* is_self_powered is reported in device status and the
431          * config descriptor.  is_bus_powered means B_PERIPHERAL
432          * draws some VBUS current; both can be true.
433          */
434         unsigned                is_self_powered:1;
435         unsigned                is_bus_powered:1;
437         unsigned                set_address:1;
438         unsigned                test_mode:1;
439         unsigned                softconnect:1;
441         u8                      address;
442         u8                      test_mode_nr;
443         u16                     ackpend;                /* ep0 */
444         enum musb_g_ep0_state   ep0_state;
445         struct usb_gadget       g;                      /* the gadget */
446         struct usb_gadget_driver *gadget_driver;        /* its driver */
448         /*
449          * FIXME: Remove this flag.
450          *
451          * This is only added to allow Blackfin to work
452          * with current driver. For some unknown reason
453          * Blackfin doesn't work with double buffering
454          * and that's enabled by default.
455          *
456          * We added this flag to forcefully disable double
457          * buffering until we get it working.
458          */
459         unsigned                double_buffer_not_ok:1 __deprecated;
461         struct musb_hdrc_config *config;
463 #ifdef MUSB_CONFIG_PROC_FS
464         struct proc_dir_entry *proc_entry;
465 #endif
466 };
468 static inline struct musb *gadget_to_musb(struct usb_gadget *g)
470         return container_of(g, struct musb, g);
473 #ifdef CONFIG_BLACKFIN
474 static inline int musb_read_fifosize(struct musb *musb,
475                 struct musb_hw_ep *hw_ep, u8 epnum)
477         musb->nr_endpoints++;
478         musb->epmask |= (1 << epnum);
480         if (epnum < 5) {
481                 hw_ep->max_packet_sz_tx = 128;
482                 hw_ep->max_packet_sz_rx = 128;
483         } else {
484                 hw_ep->max_packet_sz_tx = 1024;
485                 hw_ep->max_packet_sz_rx = 1024;
486         }
487         hw_ep->is_shared_fifo = false;
489         return 0;
492 static inline void musb_configure_ep0(struct musb *musb)
494         musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
495         musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
496         musb->endpoints[0].is_shared_fifo = true;
499 #else
501 static inline int musb_read_fifosize(struct musb *musb,
502                 struct musb_hw_ep *hw_ep, u8 epnum)
504         void *mbase = musb->mregs;
505         u8 reg = 0;
507         /* read from core using indexed model */
508         reg = musb_readb(mbase, MUSB_EP_OFFSET(musb, epnum, MUSB_FIFOSIZE));
509         /* 0's returned when no more endpoints */
510         if (!reg)
511                 return -ENODEV;
513         musb->nr_endpoints++;
514         musb->epmask |= (1 << epnum);
516         hw_ep->max_packet_sz_tx = 1 << (reg & 0x0f);
518         /* shared TX/RX FIFO? */
519         if ((reg & 0xf0) == 0xf0) {
520                 hw_ep->max_packet_sz_rx = hw_ep->max_packet_sz_tx;
521                 hw_ep->is_shared_fifo = true;
522                 return 0;
523         } else {
524                 hw_ep->max_packet_sz_rx = 1 << ((reg & 0xf0) >> 4);
525                 hw_ep->is_shared_fifo = false;
526         }
528         return 0;
531 static inline void musb_configure_ep0(struct musb *musb)
533         musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
534         musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
535         musb->endpoints[0].is_shared_fifo = true;
537 #endif /* CONFIG_BLACKFIN */
540 /***************************** Glue it together *****************************/
542 extern const char musb_driver_name[];
544 extern void musb_start(struct musb *musb);
545 extern void musb_stop(struct musb *musb);
547 extern void musb_write_fifo(struct musb_hw_ep *ep, u16 len, const u8 *src);
548 extern void musb_read_fifo(struct musb_hw_ep *ep, u16 len, u8 *dst);
550 extern void musb_load_testpacket(struct musb *);
552 extern irqreturn_t musb_interrupt(struct musb *);
554 extern void musb_hnp_stop(struct musb *musb);
556 static inline void musb_platform_set_vbus(struct musb *musb, int is_on)
558         if (musb->ops->set_vbus)
559                 musb->ops->set_vbus(musb, is_on);
562 static inline void musb_platform_enable(struct musb *musb)
564         if (musb->ops->enable)
565                 musb->ops->enable(musb);
568 static inline void musb_platform_disable(struct musb *musb)
570         if (musb->ops->disable)
571                 musb->ops->disable(musb);
574 static inline int musb_platform_set_mode(struct musb *musb, u8 mode)
576         if (!musb->ops->set_mode)
577                 return 0;
579         return musb->ops->set_mode(musb, mode);
582 static inline void musb_platform_try_idle(struct musb *musb,
583                 unsigned long timeout)
585         if (musb->ops->try_idle)
586                 musb->ops->try_idle(musb, timeout);
589 static inline int musb_platform_get_vbus_status(struct musb *musb)
591         if (!musb->ops->vbus_status)
592                 return 0;
594         return musb->ops->vbus_status(musb);
597 static inline int musb_platform_init(struct musb *musb)
599         if (!musb->ops->init)
600                 return -EINVAL;
602         return musb->ops->init(musb);
605 static inline int musb_platform_exit(struct musb *musb)
607         if (!musb->ops->exit)
608                 return -EINVAL;
610         return musb->ops->exit(musb);
613 static inline u16 musb_platform_get_hw_revision(struct musb *musb)
615         if (!musb->ops->get_hw_revision)
616                 return musb_readw(musb->mregs, MUSB_HWVERS);
618         return musb->ops->get_hw_revision(musb);
621 #endif  /* __MUSB_CORE_H__ */