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