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