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