drivers/usb/musb/musbdefs.h

   1 /******************************************************************
   2  * Copyright 2005 Mentor Graphics Corporation
   3  * Copyright (C) 2005-2006 by Texas Instruments
   4  *
   5  * This file is part of the Inventra Controller Driver for Linux.
   6  *
   7  * The Inventra Controller Driver for Linux is free software; you
   8  * can redistribute it and/or modify it under the terms of the GNU
   9  * General Public License version 2 as published by the Free Software
  10  * Foundation.
  11  *
  12  * The Inventra Controller Driver for Linux is distributed in
  13  * the hope that it will be useful, but WITHOUT ANY WARRANTY;
  14  * without even the implied warranty of MERCHANTABILITY or
  15  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
  16  * License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with The Inventra Controller Driver for Linux ; if not,
  20  * write to the Free Software Foundation, Inc., 59 Temple Place,
  21  * Suite 330, Boston, MA  02111-1307  USA
  22  *
  23  * ANY DOWNLOAD, USE, REPRODUCTION, MODIFICATION OR DISTRIBUTION
  24  * OF THIS DRIVER INDICATES YOUR COMPLETE AND UNCONDITIONAL ACCEPTANCE
  25  * OF THOSE TERMS.THIS DRIVER IS PROVIDED "AS IS" AND MENTOR GRAPHICS
  26  * MAKES NO WARRANTIES, EXPRESS OR IMPLIED, RELATED TO THIS DRIVER.
  27  * MENTOR GRAPHICS SPECIFICALLY DISCLAIMS ALL IMPLIED WARRANTIES
  28  * OF MERCHANTABILITY; FITNESS FOR A PARTICULAR PURPOSE AND
  29  * NON-INFRINGEMENT.  MENTOR GRAPHICS DOES NOT PROVIDE SUPPORT
  30  * SERVICES OR UPDATES FOR THIS DRIVER, EVEN IF YOU ARE A MENTOR
  31  * GRAPHICS SUPPORT CUSTOMER.
  32  ******************************************************************/
  33
  34 #ifndef __MUSB_MUSBDEFS_H__
  35 #define __MUSB_MUSBDEFS_H__
  36
  37 #include <linux/slab.h>
  38 #include <linux/list.h>
  39 #include <linux/interrupt.h>
  40 #include <linux/smp_lock.h>
  41 #include <linux/errno.h>
  42 #include <linux/device.h>
  43 #include <linux/usb_ch9.h>
  44 #include <linux/usb_gadget.h>
  45 #include <linux/usb.h>
  46 #include <linux/usb/otg.h>
  47 #include <linux/usb/musb.h>
  48
  49 struct musb;
  50 struct musb_hw_ep;
  51 struct musb_ep;
  52
  53
  54 #include "debug.h"
  55 #include "dma.h"
  56
  57 #ifdef CONFIG_USB_MUSB_SOC
  58 /*
  59  * Get core configuration from a header converted (by cfg_conv)
  60  * from the Verilog config file generated by the core config utility
  61  *
  62  * For now we assume that header is provided along with other
  63  * arch-specific files.  Discrete chips will need a build tweak.
  64  * So will using AHB IDs from silicon that provides them.
  65  */
  66 #include <asm/arch/hdrc_cnf.h>
  67 #endif
  68
  69 #include "plat_arc.h"
  70 #include "musbhdrc.h"
  71
  72 #include "musb_gadget.h"
  73 #include "../core/hcd.h"
  74 #include "musb_host.h"
  75
  76
  77
  78 #ifdef CONFIG_USB_MUSB_OTG
  79
  80 #define is_peripheral_enabled(musb)     ((musb)->board_mode != MUSB_HOST)
  81 #define is_host_enabled(musb)           ((musb)->board_mode != MUSB_PERIPHERAL)
  82 #define is_otg_enabled(musb)            ((musb)->board_mode == MUSB_OTG)
  83
  84 /* NOTE:  otg and peripheral-only state machines start at B_IDLE.
  85  * OTG or host-only go to A_IDLE when ID is sensed.
  86  */
  87 #define is_peripheral_active(m)         (!(m)->bIsHost)
  88 #define is_host_active(m)               ((m)->bIsHost)
  89
  90 #else
  91 #define is_peripheral_enabled(musb)     is_peripheral_capable()
  92 #define is_host_enabled(musb)           is_host_capable()
  93 #define is_otg_enabled(musb)            0
  94
  95 #define is_peripheral_active(musb)      is_peripheral_capable()
  96 #define is_host_active(musb)            is_host_capable()
  97 #endif
  98
  99 #if defined(CONFIG_USB_MUSB_OTG) || defined(CONFIG_USB_MUSB_PERIPHERAL)
 100 /* for some reason, the "select USB_GADGET_MUSB_HDRC" doesn't always
 101  * override that choice selection (often USB_GADGET_DUMMY_HCD).
 102  */
 103 #ifndef CONFIG_USB_GADGET_MUSB_HDRC
 104 #error bogus Kconfig output ... select CONFIG_USB_GADGET_MUSB_HDRC
 105 #endif
 106 #endif  /* need MUSB gadget selection */
 107
 108
 109 #ifdef CONFIG_PROC_FS
 110 #include <linux/fs.h>
 111 #define MUSB_CONFIG_PROC_FS
 112 #endif
 113
 114 /****************************** PERIPHERAL ROLE *****************************/
 115
 116 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
 117
 118 #define is_peripheral_capable() (1)
 119
 120 extern irqreturn_t musb_g_ep0_irq(struct musb *);
 121 extern void musb_g_tx(struct musb *, u8);
 122 extern void musb_g_rx(struct musb *, u8);
 123 extern void musb_g_reset(struct musb *);
 124 extern void musb_g_suspend(struct musb *);
 125 extern void musb_g_resume(struct musb *);
 126 extern void musb_g_disconnect(struct musb *);
 127
 128 #else
 129
 130 #define is_peripheral_capable() (0)
 131
 132 static inline irqreturn_t musb_g_ep0_irq(struct musb *m) { return IRQ_NONE; }
 133 static inline void musb_g_reset(struct musb *m) {}
 134 static inline void musb_g_suspend(struct musb *m) {}
 135 static inline void musb_g_resume(struct musb *m) {}
 136 static inline void musb_g_disconnect(struct musb *m) {}
 137
 138 #endif
 139
 140 /****************************** HOST ROLE ***********************************/
 141
 142 #ifdef CONFIG_USB_MUSB_HDRC_HCD
 143
 144 #define is_host_capable()       (1)
 145
 146 extern irqreturn_t musb_h_ep0_irq(struct musb *);
 147 extern void musb_host_tx(struct musb *, u8);
 148 extern void musb_host_rx(struct musb *, u8);
 149
 150 #else
 151
 152 #define is_host_capable()       (0)
 153
 154 static inline irqreturn_t musb_h_ep0_irq(struct musb *m) { return IRQ_NONE; }
 155 static inline void musb_host_tx(struct musb *m, u8 e) {}
 156 static inline void musb_host_rx(struct musb *m, u8 e) {}
 157
 158 #endif
 159
 160
 161 /****************************** CONSTANTS ********************************/
 162
 163 #ifndef TRUE
 164 #define TRUE 1
 165 #endif
 166 #ifndef FALSE
 167 #define FALSE 0
 168 #endif
 169
 170 #ifndef MUSB_C_NUM_EPS
 171 #define MUSB_C_NUM_EPS ((u8)16)
 172 #endif
 173
 174 #ifndef MUSB_MAX_END0_PACKET
 175 #define MUSB_MAX_END0_PACKET ((u16)MGC_END0_FIFOSIZE)
 176 #endif
 177
 178 /* host side ep0 states */
 179 #define MGC_END0_START  0x0
 180 #define MGC_END0_OUT    0x2
 181 #define MGC_END0_IN     0x4
 182 #define MGC_END0_STATUS 0x8
 183
 184 /* peripheral side ep0 states */
 185 enum musb_g_ep0_state {
 186         MGC_END0_STAGE_SETUP,           /* idle, waiting for setup */
 187         MGC_END0_STAGE_TX,              /* IN data */
 188         MGC_END0_STAGE_RX,              /* OUT data */
 189         MGC_END0_STAGE_STATUSIN,        /* (after OUT data) */
 190         MGC_END0_STAGE_STATUSOUT,       /* (after IN data) */
 191         MGC_END0_STAGE_ACKWAIT,         /* after zlp, before statusin */
 192 } __attribute__ ((packed));
 193
 194 /* OTG protocol constants */
 195 #define OTG_TIME_A_WAIT_VRISE   100             /* msec (max) */
 196 #define OTG_TIME_A_WAIT_BCON    0               /* 0=infinite; min 1000 msec */
 197 #define OTG_TIME_A_IDLE_BDIS    200             /* msec (min) */
 198
 199 /*************************** REGISTER ACCESS ********************************/
 200
 201 /* Endpoint registers (other than dynfifo setup) can be accessed either
 202  * directly with the "flat" model, or after setting up an index register.
 203  */
 204
 205 #if defined(CONFIG_ARCH_DAVINCI) || defined(CONFIG_ARCH_OMAP243X)
 206 /* REVISIT "flat" takes about 1% more object code space and can't be very
 207  * noticeable for speed differences.  But for now indexed access seems to
 208  * misbehave (on DaVinci) for at least peripheral IN ...
 209  */
 210 #define MUSB_FLAT_REG
 211 #endif
 212
 213 /* TUSB mapping: "flat" plus ep0 special cases */
 214 #if     defined(CONFIG_USB_TUSB6010)
 215 #define MGC_SelectEnd(_pBase, _bEnd) \
 216         musb_writeb((_pBase), MGC_O_HDRC_INDEX, (_bEnd))
 217 #define MGC_END_OFFSET                  MGC_TUSB_OFFSET
 218
 219 /* "flat" mapping: each endpoint has its own i/o address */
 220 #elif   defined(MUSB_FLAT_REG)
 221 #define MGC_SelectEnd(_pBase, _bEnd)    (((void)(_pBase)),((void)(_bEnd)))
 222 #define MGC_END_OFFSET                  MGC_FLAT_OFFSET
 223
 224 /* "indexed" mapping: INDEX register controls register bank select */
 225 #else
 226 #define MGC_SelectEnd(_pBase, _bEnd) \
 227         musb_writeb((_pBase), MGC_O_HDRC_INDEX, (_bEnd))
 228 #define MGC_END_OFFSET                  MGC_INDEXED_OFFSET
 229 #endif
 230
 231 /* FIXME: replace with musb_readcsr(hw_ep *, REGNAME), etc
 232  * using hw_ep->regs, for all access except writing INDEX
 233  */
 234 #ifdef  MUSB_FLAT_REG
 235 #define MGC_ReadCsr8(_pBase, _bOffset, _bEnd) \
 236         musb_readb((_pBase), MGC_END_OFFSET((_bEnd), (_bOffset)))
 237 #define MGC_ReadCsr16(_pBase, _bOffset, _bEnd) \
 238         musb_readw((_pBase), MGC_END_OFFSET((_bEnd), (_bOffset)))
 239 #define MGC_WriteCsr8(_pBase, _bOffset, _bEnd, _bData) \
 240         musb_writeb((_pBase), MGC_END_OFFSET((_bEnd), (_bOffset)), (_bData))
 241 #define MGC_WriteCsr16(_pBase, _bOffset, _bEnd, _bData) \
 242         musb_writew((_pBase), MGC_END_OFFSET((_bEnd), (_bOffset)), (_bData))
 243 #else
 244 #define MGC_ReadCsr8(_pBase, _bOffset, _bEnd) \
 245             musb_readb(_pBase, (_bOffset + 0x10))
 246 #define MGC_ReadCsr16(_pBase, _bOffset, _bEnd) \
 247         musb_readw(_pBase, (_bOffset + 0x10))
 248 #define MGC_WriteCsr8(_pBase, _bOffset, _bEnd, _bData) \
 249         musb_writeb(_pBase, (_bOffset + 0x10), _bData)
 250 #define MGC_WriteCsr16(_pBase, _bOffset, _bEnd, _bData) \
 251         musb_writew(_pBase, (_bOffset + 0x10), _bData)
 252 #endif
 253
 254 /****************************** FUNCTIONS ********************************/
 255
 256 #define MUSB_HST_MODE(_pthis)\
 257         { (_pthis)->bIsHost=TRUE; }
 258 #define MUSB_DEV_MODE(_pthis) \
 259         { (_pthis)->bIsHost=FALSE; }
 260
 261 #define test_devctl_hst_mode(_x) \
 262         (musb_readb((_x)->pRegs, MGC_O_HDRC_DEVCTL)&MGC_M_DEVCTL_HM)
 263
 264 #define MUSB_MODE(musb) ((musb)->bIsHost ? "Host" : "Peripheral")
 265
 266 /************************** Ep Configuration ********************************/
 267
 268 /** The End point descriptor */
 269 struct MUSB_EpFifoDescriptor {
 270         u8 bType;               /* 0 for autoconfig, CNTR, ISOC, BULK, INTR */
 271         u8 bDir;                /* 0 for autoconfig, INOUT, IN, OUT */
 272         int wSize;              /* 0 for autoconfig, or the size */
 273 };
 274
 275 #define MUSB_EPD_AUTOCONFIG     0
 276
 277 #define MUSB_EPD_T_CNTRL        1
 278 #define MUSB_EPD_T_ISOC         2
 279 #define MUSB_EPD_T_BULK         3
 280 #define MUSB_EPD_T_INTR         4
 281
 282 #define MUSB_EPD_D_INOUT        0
 283 #define MUSB_EPD_D_TX           1
 284 #define MUSB_EPD_D_RX           2
 285
 286 /******************************** TYPES *************************************/
 287
 288 /*
 289  * struct musb_hw_ep - endpoint hardware (bidirectional)
 290  *
 291  * Ordered slightly for better cacheline locality.
 292  */
 293 struct musb_hw_ep {
 294         struct musb             *musb;
 295         void __iomem            *fifo;
 296         void __iomem            *regs;
 297
 298 #ifdef CONFIG_USB_TUSB6010
 299         void __iomem            *conf;
 300 #endif
 301
 302         /* index in musb->aLocalEnd[]  */
 303         u8                      bLocalEnd;
 304
 305         /* hardware configuration, possibly dynamic */
 306         u8                      bIsSharedFifo;
 307         u8                      tx_double_buffered;
 308         u8                      rx_double_buffered;
 309         u16                     wMaxPacketSizeTx;
 310         u16                     wMaxPacketSizeRx;
 311
 312         struct dma_channel      *tx_channel;
 313         struct dma_channel      *rx_channel;
 314
 315 #ifdef CONFIG_USB_TUSB6010
 316         /* TUSB has "asynchronous" and "synchronous" dma modes */
 317         dma_addr_t              fifo_async;
 318         dma_addr_t              fifo_sync;
 319 #endif
 320
 321 #ifdef CONFIG_USB_MUSB_HDRC_HCD
 322         void __iomem            *target_regs;
 323
 324         /* currently scheduled peripheral endpoint */
 325         struct musb_qh          *in_qh;
 326         struct musb_qh          *out_qh;
 327
 328         u8                      rx_reinit;
 329         u8                      tx_reinit;
 330 #endif
 331
 332 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
 333         /* peripheral side */
 334         struct musb_ep          ep_in;                  /* TX */
 335         struct musb_ep          ep_out;                 /* RX */
 336 #endif
 337 };
 338
 339 static inline struct usb_request *next_in_request(struct musb_hw_ep *hw_ep)
 340 {
 341 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
 342         return next_request(&hw_ep->ep_in);
 343 #else
 344         return NULL;
 345 #endif
 346 }
 347
 348 static inline struct usb_request *next_out_request(struct musb_hw_ep *hw_ep)
 349 {
 350 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
 351         return next_request(&hw_ep->ep_out);
 352 #else
 353         return NULL;
 354 #endif
 355 }
 356
 357 /*
 358  * struct musb - Driver instance data.
 359  */
 360 struct musb {
 361         spinlock_t              Lock;
 362         struct clk              *clock;
 363         irqreturn_t             (*isr)(int, void *);
 364         struct work_struct      irq_work;
 365
 366 #ifdef CONFIG_USB_MUSB_HDRC_HCD
 367
 368 /* this hub status bit is reserved by USB 2.0 and not seen by usbcore */
 369 #define MUSB_PORT_STAT_RESUME   (1 << 31)
 370
 371         u32                     port1_status;
 372         unsigned long           rh_timer;
 373
 374         u8 bEnd0Stage;          /* end0 stage while in host */
 375
 376         /* bulk traffic normally dedicates endpoint hardware, and each
 377          * direction has its own ring of host side endpoints.
 378          * we try to progress the transfer at the head of each endpoint's
 379          * queue until it completes or NAKs too much; then we try the next
 380          * endpoint.
 381          */
 382         struct musb_hw_ep       *bulk_ep;
 383
 384         struct list_head        control;        /* of musb_qh */
 385         struct list_head        in_bulk;        /* of musb_qh */
 386         struct list_head        out_bulk;       /* of musb_qh */
 387         struct musb_qh          *periodic[32];  /* tree of interrupt+iso */
 388 #endif
 389
 390         /* called with IRQs blocked; ON/nonzero implies starting a session,
 391          * and waiting at least a_wait_vrise_tmout.
 392          */
 393         void                    (*board_set_vbus)(struct musb *, int is_on);
 394
 395         struct dma_controller   *pDmaController;
 396
 397         struct device           *controller;
 398         void __iomem            *ctrl_base;
 399         void __iomem            *pRegs;
 400
 401 #ifdef CONFIG_USB_TUSB6010
 402         dma_addr_t              async;
 403         dma_addr_t              sync;
 404 #endif
 405
 406         /* passed down from chip/board specific irq handlers */
 407         u8                      int_usb;
 408         u16                     int_rx;
 409         u16                     int_tx;
 410
 411         struct otg_transceiver  xceiv;
 412
 413         int nIrq;
 414
 415         struct musb_hw_ep        aLocalEnd[MUSB_C_NUM_EPS];
 416 #define control_ep              aLocalEnd
 417
 418 #define VBUSERR_RETRY_COUNT     3
 419         u16                     vbuserr_retry;
 420         u16 wEndMask;
 421         u8 bEndCount;
 422
 423         u8 board_mode;          /* enum musb_mode */
 424         int                     (*board_set_power)(int state);
 425
 426         u8                      min_power;      /* vbus for periph, in mA/2 */
 427
 428         /* active means connected and not suspended */
 429         unsigned is_active:1;
 430
 431         unsigned bIsMultipoint:1;
 432         unsigned bIsHost:1;
 433         unsigned bIgnoreDisconnect:1;   /* during bus resets */
 434
 435 #ifdef C_MP_TX
 436         unsigned bBulkSplit:1;
 437 #define can_bulk_split(musb,type) \
 438                 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bBulkSplit)
 439 #else
 440 #define can_bulk_split(musb,type)       0
 441 #endif
 442
 443 #ifdef C_MP_RX
 444         unsigned bBulkCombine:1;
 445         /* REVISIT allegedly doesn't work reliably */
 446 #if 0
 447 #define can_bulk_combine(musb,type) \
 448                 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bBulkCombine)
 449 #else
 450 #define can_bulk_combine(musb,type)     0
 451 #endif
 452 #else
 453 #define can_bulk_combine(musb,type)     0
 454 #endif
 455
 456 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
 457         unsigned bIsSelfPowered:1;
 458         unsigned bMayWakeup:1;
 459         unsigned bSetAddress:1;
 460         unsigned bTestMode:1;
 461         unsigned softconnect:1;
 462
 463         enum musb_g_ep0_state   ep0_state;
 464         u8                      bAddress;
 465         u8                      bTestModeValue;
 466         u16                     ackpend;                /* ep0 */
 467         struct usb_gadget       g;                      /* the gadget */
 468         struct usb_gadget_driver *pGadgetDriver;        /* its driver */
 469 #endif
 470
 471 #ifdef CONFIG_USB_MUSB_OTG
 472         /* FIXME this can't be OTG-specific ... ? */
 473         u8 bDelayPortPowerOff;
 474 #endif
 475
 476 #ifdef MUSB_CONFIG_PROC_FS
 477         struct proc_dir_entry *pProcEntry;
 478 #endif
 479 };
 480
 481 static inline void musb_set_vbus(struct musb *musb, int is_on)
 482 {
 483         musb->board_set_vbus(musb, is_on);
 484 }
 485
 486 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
 487 static inline struct musb *gadget_to_musb(struct usb_gadget *g)
 488 {
 489         return container_of(g, struct musb, g);
 490 }
 491 #endif
 492
 493 #ifdef CONFIG_USB_MUSB_OTG
 494 /* sysfs flag to seletively force peripheral-only operation */
 495 extern int musb_otg;
 496 #else
 497 #define musb_otg 0
 498 #endif
 499
 500
 501 /***************************** Glue it together *****************************/
 502
 503 extern const char musb_driver_name[];
 504
 505 extern void musb_start(struct musb *pThis);
 506 extern void musb_stop(struct musb *pThis);
 507
 508 extern void musb_write_fifo(struct musb_hw_ep *ep,
 509                              u16 wCount, const u8 * pSource);
 510 extern void musb_read_fifo(struct musb_hw_ep *ep,
 511                                u16 wCount, u8 * pDest);
 512
 513 extern void musb_load_testpacket(struct musb *);
 514
 515 extern irqreturn_t musb_interrupt(struct musb *);
 516
 517 extern void musb_platform_enable(struct musb *musb);
 518 extern void musb_platform_disable(struct musb *musb);
 519
 520 #ifdef CONFIG_USB_TUSB6010
 521 extern void musb_platform_try_idle(struct musb *musb);
 522 extern int musb_platform_get_vbus_status(struct musb *musb);
 523 #else
 524 #define musb_platform_try_idle(x)               do {} while (0)
 525 #define musb_platform_get_vbus_status(x)        0
 526 #endif
 527
 528 extern int __devinit musb_platform_init(struct musb *musb);
 529 extern int musb_platform_exit(struct musb *musb);
 530
 531 /*-------------------------- ProcFS definitions ---------------------*/
 532
 533 struct proc_dir_entry;
 534
 535 #if (MUSB_DEBUG > 0) && defined(MUSB_CONFIG_PROC_FS)
 536 extern struct proc_dir_entry *musb_debug_create(char *name,
 537                                                     struct musb *data);
 538 extern void musb_debug_delete(char *name, struct musb *data);
 539
 540 #else
 541 static inline struct proc_dir_entry *musb_debug_create(char *name,
 542                                                            struct musb *data)
 543 {
 544         return NULL;
 545 }
 546 static inline void musb_debug_delete(char *name, struct musb *data)
 547 {
 548 }
 549 #endif
 550
 551 #endif  /* __MUSB_MUSBDEFS_H__ */