usb: musb: same MUSB_OFFSET/musb_ep_select for all controller
[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 #define musb_ep_select(_musb, _mbase, _epnum) do { \
168         if (_musb->ops->flags & MUSB_GLUE_EP_ADDR_INDEXED_MAPPING) \
169                 musb_writeb((_mbase), MUSB_INDEX, (_epnum)); \
170  } while (0)
172 #define MUSB_EP_OFFSET  MUSB_OFFSET
173 /****************************** FUNCTIONS ********************************/
175 #define MUSB_HST_MODE(_musb)\
176         { (_musb)->is_host = true; }
177 #define MUSB_DEV_MODE(_musb) \
178         { (_musb)->is_host = false; }
180 #define test_devctl_hst_mode(_x) \
181         (musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM)
183 #define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral")
185 /******************************** TYPES *************************************/
187 #define     MUSB_GLUE_TUSB_STYLE   0x0001
188 #define     MUSB_GLUE_EP_ADDR_FLAT_MAPPING      0x0002
189 #define     MUSB_GLUE_EP_ADDR_INDEXED_MAPPING   0x0004
191 /**
192  * struct musb_platform_ops - Operations passed to musb_core by HW glue layer
193  * @fifo_mode: which fifo_mode is taken by me
194  * @flags:      each hw glue difference information will be here
195  * @init:       turns on clocks, sets up platform-specific registers, etc
196  * @exit:       undoes @init
197  * @read_fifo: read data from musb fifo in PIO
198  * @write_fifo: write data into musb fifo in PIO
199  * @set_mode:   forcefully changes operating mode
200  * @try_ilde:   tries to idle the IP
201  * @get_hw_revision: get hardware revision
202  * @vbus_status: returns vbus status if possible
203  * @set_vbus:   forces vbus status
204  * @adjust_channel_params: pre check for standard dma channel_program func
205  */
206 struct musb_platform_ops {
207         short   fifo_mode;
208         unsigned short  flags;
209         int     (*init)(struct musb *musb);
210         int     (*exit)(struct musb *musb);
212         void    (*enable)(struct musb *musb);
213         void    (*disable)(struct musb *musb);
215         void (*read_fifo)(struct musb_hw_ep *hw_ep, u16 len, u8 *buf);
216         void (*write_fifo)(struct musb_hw_ep *hw_ep, u16 len, const u8 *buf);
218         int     (*set_mode)(struct musb *musb, u8 mode);
219         void    (*try_idle)(struct musb *musb, unsigned long timeout);
221         u16  (*get_hw_revision)(struct musb *musb);
223         int     (*vbus_status)(struct musb *musb);
224         void    (*set_vbus)(struct musb *musb, int on);
226         int     (*adjust_channel_params)(struct dma_channel *channel,
227                                 u16 packet_sz, u8 *mode,
228                                 dma_addr_t *dma_addr, u32 *len);
229 };
231 /*
232  * struct musb_hw_ep - endpoint hardware (bidirectional)
233  *
234  * Ordered slightly for better cacheline locality.
235  */
236 struct musb_hw_ep {
237         struct musb             *musb;
238         void __iomem            *fifo;
239         void __iomem            *regs;
241         /*Fixme: the following field is only used by tusb*/
242         void __iomem            *conf;
244         /* index in musb->endpoints[]  */
245         u8                      epnum;
247         /* hardware configuration, possibly dynamic */
248         bool                    is_shared_fifo;
249         bool                    tx_double_buffered;
250         bool                    rx_double_buffered;
251         u16                     max_packet_sz_tx;
252         u16                     max_packet_sz_rx;
254         struct dma_channel      *tx_channel;
255         struct dma_channel      *rx_channel;
257         /*
258          * TUSB has "asynchronous" and "synchronous" dma modes
259          * Fixme: the following three fields are only valid for TUSB.
260          * */
261         dma_addr_t              fifo_async;
262         dma_addr_t              fifo_sync;
263         void __iomem            *fifo_sync_va;
265         void __iomem            *target_regs;
267         /* currently scheduled peripheral endpoint */
268         struct musb_qh          *in_qh;
269         struct musb_qh          *out_qh;
271         u8                      rx_reinit;
272         u8                      tx_reinit;
274         /* peripheral side */
275         struct musb_ep          ep_in;                  /* TX */
276         struct musb_ep          ep_out;                 /* RX */
277 };
279 static inline struct musb_request *next_in_request(struct musb_hw_ep *hw_ep)
281         return next_request(&hw_ep->ep_in);
284 static inline struct musb_request *next_out_request(struct musb_hw_ep *hw_ep)
286         return next_request(&hw_ep->ep_out);
289 struct musb_csr_regs {
290         /* FIFO registers */
291         u16 txmaxp, txcsr, rxmaxp, rxcsr;
292         u16 rxfifoadd, txfifoadd;
293         u8 txtype, txinterval, rxtype, rxinterval;
294         u8 rxfifosz, txfifosz;
295         u8 txfunaddr, txhubaddr, txhubport;
296         u8 rxfunaddr, rxhubaddr, rxhubport;
297 };
299 struct musb_context_registers {
301         u8 power;
302         u16 intrtxe, intrrxe;
303         u8 intrusbe;
304         u16 frame;
305         u8 index, testmode;
307         u8 devctl, busctl, misc;
308         u32 otg_interfsel;
310         struct musb_csr_regs index_regs[MUSB_C_NUM_EPS];
311 };
313 /*
314  * struct musb - Driver instance data.
315  */
316 struct musb {
317         /* device lock */
318         spinlock_t              lock;
320         const struct musb_platform_ops *ops;
321         struct musb_context_registers context;
323         irqreturn_t             (*isr)(int, void *);
324         struct work_struct      irq_work;
325         struct work_struct      otg_notifier_work;
326         u16                     hwvers;
328 /* this hub status bit is reserved by USB 2.0 and not seen by usbcore */
329 #define MUSB_PORT_STAT_RESUME   (1 << 31)
331         u32                     port1_status;
333         unsigned long           rh_timer;
335         enum musb_h_ep0_state   ep0_stage;
337         /* bulk traffic normally dedicates endpoint hardware, and each
338          * direction has its own ring of host side endpoints.
339          * we try to progress the transfer at the head of each endpoint's
340          * queue until it completes or NAKs too much; then we try the next
341          * endpoint.
342          */
343         struct musb_hw_ep       *bulk_ep;
345         struct list_head        control;        /* of musb_qh */
346         struct list_head        in_bulk;        /* of musb_qh */
347         struct list_head        out_bulk;       /* of musb_qh */
349         struct timer_list       otg_timer;
350         struct notifier_block   nb;
352         struct dma_controller   *dma_controller;
354         struct device           *controller;
355         void __iomem            *ctrl_base;
356         void __iomem            *mregs;
358         /*Fixme: the three fields below are only used by tusb*/
359         dma_addr_t              async;
360         dma_addr_t              sync;
361         void __iomem            *sync_va;
363         /* passed down from chip/board specific irq handlers */
364         u8                      int_usb;
365         u16                     int_rx;
366         u16                     int_tx;
368         struct otg_transceiver  *xceiv;
369         u8                      xceiv_event;
371         int nIrq;
372         unsigned                irq_wake:1;
374         struct musb_hw_ep        endpoints[MUSB_C_NUM_EPS];
375 #define control_ep              endpoints
377 #define VBUSERR_RETRY_COUNT     3
378         u16                     vbuserr_retry;
379         u16 epmask;
380         u8 nr_endpoints;
382         u8 board_mode;          /* enum musb_mode */
383         int                     (*board_set_power)(int state);
385         u8                      min_power;      /* vbus for periph, in mA/2 */
387         bool                    is_host;
389         int                     a_wait_bcon;    /* VBUS timeout in msecs */
390         unsigned long           idle_timeout;   /* Next timeout in jiffies */
392         /* active means connected and not suspended */
393         unsigned                is_active:1;
395         unsigned is_multipoint:1;
396         unsigned ignore_disconnect:1;   /* during bus resets */
398         unsigned                hb_iso_rx:1;    /* high bandwidth iso rx? */
399         unsigned                hb_iso_tx:1;    /* high bandwidth iso tx? */
400         unsigned                dyn_fifo:1;     /* dynamic FIFO supported? */
402         unsigned                bulk_split:1;
403 #define can_bulk_split(musb,type) \
404         (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split)
406         unsigned                bulk_combine:1;
407 #define can_bulk_combine(musb,type) \
408         (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine)
410         /* is_suspended means USB B_PERIPHERAL suspend */
411         unsigned                is_suspended:1;
413         /* may_wakeup means remote wakeup is enabled */
414         unsigned                may_wakeup:1;
416         /* is_self_powered is reported in device status and the
417          * config descriptor.  is_bus_powered means B_PERIPHERAL
418          * draws some VBUS current; both can be true.
419          */
420         unsigned                is_self_powered:1;
421         unsigned                is_bus_powered:1;
423         unsigned                set_address:1;
424         unsigned                test_mode:1;
425         unsigned                softconnect:1;
427         u8                      address;
428         u8                      test_mode_nr;
429         u16                     ackpend;                /* ep0 */
430         enum musb_g_ep0_state   ep0_state;
431         struct usb_gadget       g;                      /* the gadget */
432         struct usb_gadget_driver *gadget_driver;        /* its driver */
434         /*
435          * FIXME: Remove this flag.
436          *
437          * This is only added to allow Blackfin to work
438          * with current driver. For some unknown reason
439          * Blackfin doesn't work with double buffering
440          * and that's enabled by default.
441          *
442          * We added this flag to forcefully disable double
443          * buffering until we get it working.
444          */
445         unsigned                double_buffer_not_ok:1 __deprecated;
447         struct musb_hdrc_config *config;
449 #ifdef MUSB_CONFIG_PROC_FS
450         struct proc_dir_entry *proc_entry;
451 #endif
452 };
454 static inline struct musb *gadget_to_musb(struct usb_gadget *g)
456         return container_of(g, struct musb, g);
459 #ifdef CONFIG_BLACKFIN
460 static inline int musb_read_fifosize(struct musb *musb,
461                 struct musb_hw_ep *hw_ep, u8 epnum)
463         musb->nr_endpoints++;
464         musb->epmask |= (1 << epnum);
466         if (epnum < 5) {
467                 hw_ep->max_packet_sz_tx = 128;
468                 hw_ep->max_packet_sz_rx = 128;
469         } else {
470                 hw_ep->max_packet_sz_tx = 1024;
471                 hw_ep->max_packet_sz_rx = 1024;
472         }
473         hw_ep->is_shared_fifo = false;
475         return 0;
478 static inline void musb_configure_ep0(struct musb *musb)
480         musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
481         musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
482         musb->endpoints[0].is_shared_fifo = true;
485 #else
487 static inline int musb_read_fifosize(struct musb *musb,
488                 struct musb_hw_ep *hw_ep, u8 epnum)
490         void *mbase = musb->mregs;
491         u8 reg = 0;
493         /* read from core using indexed model */
494         reg = musb_readb(mbase, MUSB_EP_OFFSET(musb, epnum, MUSB_FIFOSIZE));
495         /* 0's returned when no more endpoints */
496         if (!reg)
497                 return -ENODEV;
499         musb->nr_endpoints++;
500         musb->epmask |= (1 << epnum);
502         hw_ep->max_packet_sz_tx = 1 << (reg & 0x0f);
504         /* shared TX/RX FIFO? */
505         if ((reg & 0xf0) == 0xf0) {
506                 hw_ep->max_packet_sz_rx = hw_ep->max_packet_sz_tx;
507                 hw_ep->is_shared_fifo = true;
508                 return 0;
509         } else {
510                 hw_ep->max_packet_sz_rx = 1 << ((reg & 0xf0) >> 4);
511                 hw_ep->is_shared_fifo = false;
512         }
514         return 0;
517 static inline void musb_configure_ep0(struct musb *musb)
519         musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
520         musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
521         musb->endpoints[0].is_shared_fifo = true;
523 #endif /* CONFIG_BLACKFIN */
526 /***************************** Glue it together *****************************/
528 extern const char musb_driver_name[];
530 extern void musb_start(struct musb *musb);
531 extern void musb_stop(struct musb *musb);
533 extern void musb_write_fifo(struct musb_hw_ep *ep, u16 len, const u8 *src);
534 extern void musb_read_fifo(struct musb_hw_ep *ep, u16 len, u8 *dst);
536 extern void musb_load_testpacket(struct musb *);
538 extern irqreturn_t musb_interrupt(struct musb *);
540 extern void musb_hnp_stop(struct musb *musb);
542 static inline void musb_platform_set_vbus(struct musb *musb, int is_on)
544         if (musb->ops->set_vbus)
545                 musb->ops->set_vbus(musb, is_on);
548 static inline void musb_platform_enable(struct musb *musb)
550         if (musb->ops->enable)
551                 musb->ops->enable(musb);
554 static inline void musb_platform_disable(struct musb *musb)
556         if (musb->ops->disable)
557                 musb->ops->disable(musb);
560 static inline int musb_platform_set_mode(struct musb *musb, u8 mode)
562         if (!musb->ops->set_mode)
563                 return 0;
565         return musb->ops->set_mode(musb, mode);
568 static inline void musb_platform_try_idle(struct musb *musb,
569                 unsigned long timeout)
571         if (musb->ops->try_idle)
572                 musb->ops->try_idle(musb, timeout);
575 static inline int musb_platform_get_vbus_status(struct musb *musb)
577         if (!musb->ops->vbus_status)
578                 return 0;
580         return musb->ops->vbus_status(musb);
583 static inline int musb_platform_init(struct musb *musb)
585         if (!musb->ops->init)
586                 return -EINVAL;
588         return musb->ops->init(musb);
591 static inline int musb_platform_exit(struct musb *musb)
593         if (!musb->ops->exit)
594                 return -EINVAL;
596         return musb->ops->exit(musb);
599 static inline u16 musb_platform_get_hw_revision(struct musb *musb)
601         if (!musb->ops->get_hw_revision)
602                 return musb_readw(musb->mregs, MUSB_HWVERS);
604         return musb->ops->get_hw_revision(musb);
607 #endif  /* __MUSB_CORE_H__ */