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 #define is_peripheral_enabled(musb)     ((musb)->board_mode != MUSB_HOST)
  75 #define is_host_enabled(musb)           ((musb)->board_mode != MUSB_PERIPHERAL)
  76 #define is_otg_enabled(musb)            ((musb)->board_mode == MUSB_OTG)
  77
  78 /* NOTE:  otg and peripheral-only state machines start at B_IDLE.
  79  * OTG or host-only go to A_IDLE when ID is sensed.
  80  */
  81 #define is_peripheral_active(m)         (!(m)->is_host)
  82 #define is_host_active(m)               ((m)->is_host)
  83
  84 #ifdef CONFIG_PROC_FS
  85 #include <linux/fs.h>
  86 #define MUSB_CONFIG_PROC_FS
  87 #endif
  88
  89 /****************************** PERIPHERAL ROLE *****************************/
  90
  91 #define is_peripheral_capable() (1)
  92
  93 extern irqreturn_t musb_g_ep0_irq(struct musb *);
  94 extern void musb_g_tx(struct musb *, u8);
  95 extern void musb_g_rx(struct musb *, u8);
  96 extern void musb_g_reset(struct musb *);
  97 extern void musb_g_suspend(struct musb *);
  98 extern void musb_g_resume(struct musb *);
  99 extern void musb_g_wakeup(struct musb *);
 100 extern void musb_g_disconnect(struct musb *);
 101
 102 /****************************** HOST ROLE ***********************************/
 103
 104 #define is_host_capable()       (1)
 105
 106 extern irqreturn_t musb_h_ep0_irq(struct musb *);
 107 extern void musb_host_tx(struct musb *, u8);
 108 extern void musb_host_rx(struct musb *, u8);
 109
 110 /****************************** CONSTANTS ********************************/
 111
 112 #ifndef MUSB_C_NUM_EPS
 113 #define MUSB_C_NUM_EPS ((u8)16)
 114 #endif
 115
 116 #ifndef MUSB_MAX_END0_PACKET
 117 #define MUSB_MAX_END0_PACKET ((u16)MUSB_EP0_FIFOSIZE)
 118 #endif
 119
 120 /* host side ep0 states */
 121 enum musb_h_ep0_state {
 122         MUSB_EP0_IDLE,
 123         MUSB_EP0_START,                 /* expect ack of setup */
 124         MUSB_EP0_IN,                    /* expect IN DATA */
 125         MUSB_EP0_OUT,                   /* expect ack of OUT DATA */
 126         MUSB_EP0_STATUS,                /* expect ack of STATUS */
 127 } __attribute__ ((packed));
 128
 129 /* peripheral side ep0 states */
 130 enum musb_g_ep0_state {
 131         MUSB_EP0_STAGE_IDLE,            /* idle, waiting for SETUP */
 132         MUSB_EP0_STAGE_SETUP,           /* received SETUP */
 133         MUSB_EP0_STAGE_TX,              /* IN data */
 134         MUSB_EP0_STAGE_RX,              /* OUT data */
 135         MUSB_EP0_STAGE_STATUSIN,        /* (after OUT data) */
 136         MUSB_EP0_STAGE_STATUSOUT,       /* (after IN data) */
 137         MUSB_EP0_STAGE_ACKWAIT,         /* after zlp, before statusin */
 138 } __attribute__ ((packed));
 139
 140 /*
 141  * OTG protocol constants.  See USB OTG 1.3 spec,
 142  * sections 5.5 "Device Timings" and 6.6.5 "Timers".
 143  */
 144 #define OTG_TIME_A_WAIT_VRISE   100             /* msec (max) */
 145 #define OTG_TIME_A_WAIT_BCON    1100            /* min 1 second */
 146 #define OTG_TIME_A_AIDL_BDIS    200             /* min 200 msec */
 147 #define OTG_TIME_B_ASE0_BRST    100             /* min 3.125 ms */
 148
 149
 150 /*************************** REGISTER ACCESS ********************************/
 151
 152 /* Endpoint registers (other than dynfifo setup) can be accessed either
 153  * directly with the "flat" model, or after setting up an index register.
 154  */
 155
 156 #if defined(CONFIG_ARCH_DAVINCI) || defined(CONFIG_SOC_OMAP2430) \
 157                 || defined(CONFIG_SOC_OMAP3430) || defined(CONFIG_BLACKFIN) \
 158                 || defined(CONFIG_ARCH_OMAP4)
 159 /* REVISIT indexed access seemed to
 160  * misbehave (on DaVinci) for at least peripheral IN ...
 161  */
 162 #define MUSB_FLAT_REG
 163 #endif
 164
 165 /* TUSB mapping: "flat" plus ep0 special cases */
 166 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
 167         defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
 168 #define musb_ep_select(_mbase, _epnum) \
 169         musb_writeb((_mbase), MUSB_INDEX, (_epnum))
 170 #define MUSB_EP_OFFSET                  MUSB_TUSB_OFFSET
 171
 172 /* "flat" mapping: each endpoint has its own i/o address */
 173 #elif   defined(MUSB_FLAT_REG)
 174 #define musb_ep_select(_mbase, _epnum)  (((void)(_mbase)), ((void)(_epnum)))
 175 #define MUSB_EP_OFFSET                  MUSB_FLAT_OFFSET
 176
 177 /* "indexed" mapping: INDEX register controls register bank select */
 178 #else
 179 #define musb_ep_select(_mbase, _epnum) \
 180         musb_writeb((_mbase), MUSB_INDEX, (_epnum))
 181 #define MUSB_EP_OFFSET                  MUSB_INDEXED_OFFSET
 182 #endif
 183
 184 /****************************** FUNCTIONS ********************************/
 185
 186 #define MUSB_HST_MODE(_musb)\
 187         { (_musb)->is_host = true; }
 188 #define MUSB_DEV_MODE(_musb) \
 189         { (_musb)->is_host = false; }
 190
 191 #define test_devctl_hst_mode(_x) \
 192         (musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM)
 193
 194 #define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral")
 195
 196 /******************************** TYPES *************************************/
 197
 198 /**
 199  * struct musb_platform_ops - Operations passed to musb_core by HW glue layer
 200  * @init:       turns on clocks, sets up platform-specific registers, etc
 201  * @exit:       undoes @init
 202  * @set_mode:   forcefully changes operating mode
 203  * @try_ilde:   tries to idle the IP
 204  * @vbus_status: returns vbus status if possible
 205  * @set_vbus:   forces vbus status
 206  * @adjust_channel_params: pre check for standard dma channel_program func
 207  */
 208 struct musb_platform_ops {
 209         int     (*init)(struct musb *musb);
 210         int     (*exit)(struct musb *musb);
 211
 212         void    (*enable)(struct musb *musb);
 213         void    (*disable)(struct musb *musb);
 214
 215         int     (*set_mode)(struct musb *musb, u8 mode);
 216         void    (*try_idle)(struct musb *musb, unsigned long timeout);
 217
 218         int     (*vbus_status)(struct musb *musb);
 219         void    (*set_vbus)(struct musb *musb, int on);
 220
 221         int     (*adjust_channel_params)(struct dma_channel *channel,
 222                                 u16 packet_sz, u8 *mode,
 223                                 dma_addr_t *dma_addr, u32 *len);
 224 };
 225
 226 /*
 227  * struct musb_hw_ep - endpoint hardware (bidirectional)
 228  *
 229  * Ordered slightly for better cacheline locality.
 230  */
 231 struct musb_hw_ep {
 232         struct musb             *musb;
 233         void __iomem            *fifo;
 234         void __iomem            *regs;
 235
 236 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
 237         defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
 238         void __iomem            *conf;
 239 #endif
 240
 241         /* index in musb->endpoints[]  */
 242         u8                      epnum;
 243
 244         /* hardware configuration, possibly dynamic */
 245         bool                    is_shared_fifo;
 246         bool                    tx_double_buffered;
 247         bool                    rx_double_buffered;
 248         u16                     max_packet_sz_tx;
 249         u16                     max_packet_sz_rx;
 250
 251         struct dma_channel      *tx_channel;
 252         struct dma_channel      *rx_channel;
 253
 254 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
 255         defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
 256         /* TUSB has "asynchronous" and "synchronous" dma modes */
 257         dma_addr_t              fifo_async;
 258         dma_addr_t              fifo_sync;
 259         void __iomem            *fifo_sync_va;
 260 #endif
 261
 262         void __iomem            *target_regs;
 263
 264         /* currently scheduled peripheral endpoint */
 265         struct musb_qh          *in_qh;
 266         struct musb_qh          *out_qh;
 267
 268         u8                      rx_reinit;
 269         u8                      tx_reinit;
 270
 271         /* peripheral side */
 272         struct musb_ep          ep_in;                  /* TX */
 273         struct musb_ep          ep_out;                 /* RX */
 274 };
 275
 276 static inline struct musb_request *next_in_request(struct musb_hw_ep *hw_ep)
 277 {
 278         return next_request(&hw_ep->ep_in);
 279 }
 280
 281 static inline struct musb_request *next_out_request(struct musb_hw_ep *hw_ep)
 282 {
 283         return next_request(&hw_ep->ep_out);
 284 }
 285
 286 struct musb_csr_regs {
 287         /* FIFO registers */
 288         u16 txmaxp, txcsr, rxmaxp, rxcsr;
 289         u16 rxfifoadd, txfifoadd;
 290         u8 txtype, txinterval, rxtype, rxinterval;
 291         u8 rxfifosz, txfifosz;
 292         u8 txfunaddr, txhubaddr, txhubport;
 293         u8 rxfunaddr, rxhubaddr, rxhubport;
 294 };
 295
 296 struct musb_context_registers {
 297
 298         u8 power;
 299         u16 intrtxe, intrrxe;
 300         u8 intrusbe;
 301         u16 frame;
 302         u8 index, testmode;
 303
 304         u8 devctl, busctl, misc;
 305         u32 otg_interfsel;
 306
 307         struct musb_csr_regs index_regs[MUSB_C_NUM_EPS];
 308 };
 309
 310 /*
 311  * struct musb - Driver instance data.
 312  */
 313 struct musb {
 314         /* device lock */
 315         spinlock_t              lock;
 316
 317         const struct musb_platform_ops *ops;
 318         struct musb_context_registers context;
 319
 320         irqreturn_t             (*isr)(int, void *);
 321         struct work_struct      irq_work;
 322         u16                     hwvers;
 323
 324 /* this hub status bit is reserved by USB 2.0 and not seen by usbcore */
 325 #define MUSB_PORT_STAT_RESUME   (1 << 31)
 326
 327         u32                     port1_status;
 328
 329         unsigned long           rh_timer;
 330
 331         enum musb_h_ep0_state   ep0_stage;
 332
 333         /* bulk traffic normally dedicates endpoint hardware, and each
 334          * direction has its own ring of host side endpoints.
 335          * we try to progress the transfer at the head of each endpoint's
 336          * queue until it completes or NAKs too much; then we try the next
 337          * endpoint.
 338          */
 339         struct musb_hw_ep       *bulk_ep;
 340
 341         struct list_head        control;        /* of musb_qh */
 342         struct list_head        in_bulk;        /* of musb_qh */
 343         struct list_head        out_bulk;       /* of musb_qh */
 344
 345         struct timer_list       otg_timer;
 346         struct notifier_block   nb;
 347
 348         struct dma_controller   *dma_controller;
 349
 350         struct device           *controller;
 351         void __iomem            *ctrl_base;
 352         void __iomem            *mregs;
 353
 354 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
 355         defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
 356         dma_addr_t              async;
 357         dma_addr_t              sync;
 358         void __iomem            *sync_va;
 359 #endif
 360
 361         /* passed down from chip/board specific irq handlers */
 362         u8                      int_usb;
 363         u16                     int_rx;
 364         u16                     int_tx;
 365
 366         struct usb_phy          *xceiv;
 367
 368         int nIrq;
 369         unsigned                irq_wake:1;
 370
 371         struct musb_hw_ep        endpoints[MUSB_C_NUM_EPS];
 372 #define control_ep              endpoints
 373
 374 #define VBUSERR_RETRY_COUNT     3
 375         u16                     vbuserr_retry;
 376         u16 epmask;
 377         u8 nr_endpoints;
 378
 379         u8 board_mode;          /* enum musb_mode */
 380         int                     (*board_set_power)(int state);
 381
 382         u8                      min_power;      /* vbus for periph, in mA/2 */
 383
 384         bool                    is_host;
 385
 386         int                     a_wait_bcon;    /* VBUS timeout in msecs */
 387         unsigned long           idle_timeout;   /* Next timeout in jiffies */
 388
 389         /* active means connected and not suspended */
 390         unsigned                is_active:1;
 391
 392         unsigned is_multipoint:1;
 393         unsigned ignore_disconnect:1;   /* during bus resets */
 394
 395         unsigned                hb_iso_rx:1;    /* high bandwidth iso rx? */
 396         unsigned                hb_iso_tx:1;    /* high bandwidth iso tx? */
 397         unsigned                dyn_fifo:1;     /* dynamic FIFO supported? */
 398
 399         unsigned                bulk_split:1;
 400 #define can_bulk_split(musb,type) \
 401         (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split)
 402
 403         unsigned                bulk_combine:1;
 404 #define can_bulk_combine(musb,type) \
 405         (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine)
 406
 407         /* is_suspended means USB B_PERIPHERAL suspend */
 408         unsigned                is_suspended:1;
 409
 410         /* may_wakeup means remote wakeup is enabled */
 411         unsigned                may_wakeup:1;
 412
 413         /* is_self_powered is reported in device status and the
 414          * config descriptor.  is_bus_powered means B_PERIPHERAL
 415          * draws some VBUS current; both can be true.
 416          */
 417         unsigned                is_self_powered:1;
 418         unsigned                is_bus_powered:1;
 419
 420         unsigned                set_address:1;
 421         unsigned                test_mode:1;
 422         unsigned                softconnect:1;
 423
 424         u8                      address;
 425         u8                      test_mode_nr;
 426         u16                     ackpend;                /* ep0 */
 427         enum musb_g_ep0_state   ep0_state;
 428         struct usb_gadget       g;                      /* the gadget */
 429         struct usb_gadget_driver *gadget_driver;        /* its driver */
 430
 431         /*
 432          * FIXME: Remove this flag.
 433          *
 434          * This is only added to allow Blackfin to work
 435          * with current driver. For some unknown reason
 436          * Blackfin doesn't work with double buffering
 437          * and that's enabled by default.
 438          *
 439          * We added this flag to forcefully disable double
 440          * buffering until we get it working.
 441          */
 442         unsigned                double_buffer_not_ok:1;
 443
 444         struct musb_hdrc_config *config;
 445
 446 #ifdef MUSB_CONFIG_PROC_FS
 447         struct proc_dir_entry *proc_entry;
 448 #endif
 449 };
 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 *mbase = musb->mregs;
 488         u8 reg = 0;
 489
 490         /* read from core using indexed model */
 491         reg = musb_readb(mbase, MUSB_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_start(struct musb *musb);
 528 extern void musb_stop(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_get_vbus_status(struct musb *musb)
 573 {
 574         if (!musb->ops->vbus_status)
 575                 return 0;
 576
 577         return musb->ops->vbus_status(musb);
 578 }
 579
 580 static inline int musb_platform_init(struct musb *musb)
 581 {
 582         if (!musb->ops->init)
 583                 return -EINVAL;
 584
 585         return musb->ops->init(musb);
 586 }
 587
 588 static inline int musb_platform_exit(struct musb *musb)
 589 {
 590         if (!musb->ops->exit)
 591                 return -EINVAL;
 592
 593         return musb->ops->exit(musb);
 594 }
 595
 596 #endif  /* __MUSB_CORE_H__ */