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/clk.h> 44 #include <linux/device.h> 45 #include <linux/usb/ch9.h> 46 #include <linux/usb/gadget.h> 47 #include <linux/usb.h> 48 #include <linux/usb/otg.h> 49 #include <linux/usb/musb.h> 50 51 struct musb; 52 struct musb_hw_ep; 53 struct musb_ep; 54 55 56 #include "musb_debug.h" 57 #include "musb_dma.h" 58 59 #include "musb_io.h" 60 #include "musb_regs.h" 61 62 #include "musb_gadget.h" 63 #include "../core/hcd.h" 64 #include "musb_host.h" 65 66 67 68 #ifdef CONFIG_USB_MUSB_OTG 69 70 #define is_peripheral_enabled(musb) ((musb)->board_mode != MUSB_HOST) 71 #define is_host_enabled(musb) ((musb)->board_mode != MUSB_PERIPHERAL) 72 #define is_otg_enabled(musb) ((musb)->board_mode == MUSB_OTG) 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 #else 81 #define is_peripheral_enabled(musb) is_peripheral_capable() 82 #define is_host_enabled(musb) is_host_capable() 83 #define is_otg_enabled(musb) 0 84 85 #define is_peripheral_active(musb) is_peripheral_capable() 86 #define is_host_active(musb) is_host_capable() 87 #endif 88 89 #if defined(CONFIG_USB_MUSB_OTG) || defined(CONFIG_USB_MUSB_PERIPHERAL) 90 /* for some reason, the "select USB_GADGET_MUSB_HDRC" doesn't always 91 * override that choice selection (often USB_GADGET_DUMMY_HCD). 92 */ 93 #ifndef CONFIG_USB_GADGET_MUSB_HDRC 94 #error bogus Kconfig output ... select CONFIG_USB_GADGET_MUSB_HDRC 95 #endif 96 #endif /* need MUSB gadget selection */ 97 98 99 #ifdef CONFIG_PROC_FS 100 #include <linux/fs.h> 101 #define MUSB_CONFIG_PROC_FS 102 #endif 103 104 /****************************** PERIPHERAL ROLE *****************************/ 105 106 #ifdef CONFIG_USB_GADGET_MUSB_HDRC 107 108 #define is_peripheral_capable() (1) 109 110 extern irqreturn_t musb_g_ep0_irq(struct musb *); 111 extern void musb_g_tx(struct musb *, u8); 112 extern void musb_g_rx(struct musb *, u8); 113 extern void musb_g_reset(struct musb *); 114 extern void musb_g_suspend(struct musb *); 115 extern void musb_g_resume(struct musb *); 116 extern void musb_g_wakeup(struct musb *); 117 extern void musb_g_disconnect(struct musb *); 118 119 #else 120 121 #define is_peripheral_capable() (0) 122 123 static inline irqreturn_t musb_g_ep0_irq(struct musb *m) { return IRQ_NONE; } 124 static inline void musb_g_reset(struct musb *m) {} 125 static inline void musb_g_suspend(struct musb *m) {} 126 static inline void musb_g_resume(struct musb *m) {} 127 static inline void musb_g_wakeup(struct musb *m) {} 128 static inline void musb_g_disconnect(struct musb *m) {} 129 130 #endif 131 132 /****************************** HOST ROLE ***********************************/ 133 134 #ifdef CONFIG_USB_MUSB_HDRC_HCD 135 136 #define is_host_capable() (1) 137 138 extern irqreturn_t musb_h_ep0_irq(struct musb *); 139 extern void musb_host_tx(struct musb *, u8); 140 extern void musb_host_rx(struct musb *, u8); 141 142 #else 143 144 #define is_host_capable() (0) 145 146 static inline irqreturn_t musb_h_ep0_irq(struct musb *m) { return IRQ_NONE; } 147 static inline void musb_host_tx(struct musb *m, u8 e) {} 148 static inline void musb_host_rx(struct musb *m, u8 e) {} 149 150 #endif 151 152 153 /****************************** CONSTANTS ********************************/ 154 155 #ifndef MUSB_C_NUM_EPS 156 #define MUSB_C_NUM_EPS ((u8)16) 157 #endif 158 159 #ifndef MUSB_MAX_END0_PACKET 160 #define MUSB_MAX_END0_PACKET ((u16)MUSB_EP0_FIFOSIZE) 161 #endif 162 163 /* host side ep0 states */ 164 enum musb_h_ep0_state { 165 MUSB_EP0_IDLE, 166 MUSB_EP0_START, /* expect ack of setup */ 167 MUSB_EP0_IN, /* expect IN DATA */ 168 MUSB_EP0_OUT, /* expect ack of OUT DATA */ 169 MUSB_EP0_STATUS, /* expect ack of STATUS */ 170 } __attribute__ ((packed)); 171 172 /* peripheral side ep0 states */ 173 enum musb_g_ep0_state { 174 MUSB_EP0_STAGE_IDLE, /* idle, waiting for SETUP */ 175 MUSB_EP0_STAGE_SETUP, /* received SETUP */ 176 MUSB_EP0_STAGE_TX, /* IN data */ 177 MUSB_EP0_STAGE_RX, /* OUT data */ 178 MUSB_EP0_STAGE_STATUSIN, /* (after OUT data) */ 179 MUSB_EP0_STAGE_STATUSOUT, /* (after IN data) */ 180 MUSB_EP0_STAGE_ACKWAIT, /* after zlp, before statusin */ 181 } __attribute__ ((packed)); 182 183 /* 184 * OTG protocol constants. See USB OTG 1.3 spec, 185 * sections 5.5 "Device Timings" and 6.6.5 "Timers". 186 */ 187 #define OTG_TIME_A_WAIT_VRISE 100 /* msec (max) */ 188 #define OTG_TIME_A_WAIT_BCON 1100 /* min 1 second */ 189 #define OTG_TIME_A_AIDL_BDIS 200 /* min 200 msec */ 190 #define OTG_TIME_B_ASE0_BRST 100 /* min 3.125 ms */ 191 192 193 /*************************** REGISTER ACCESS ********************************/ 194 195 /* Endpoint registers (other than dynfifo setup) can be accessed either 196 * directly with the "flat" model, or after setting up an index register. 197 */ 198 199 #if defined(CONFIG_ARCH_DAVINCI) || defined(CONFIG_ARCH_OMAP2430) \ 200 || defined(CONFIG_ARCH_OMAP3430) || defined(CONFIG_BLACKFIN) 201 /* REVISIT indexed access seemed to 202 * misbehave (on DaVinci) for at least peripheral IN ... 203 */ 204 #define MUSB_FLAT_REG 205 #endif 206 207 /* TUSB mapping: "flat" plus ep0 special cases */ 208 #if defined(CONFIG_USB_TUSB6010) 209 #define musb_ep_select(_mbase, _epnum) \ 210 musb_writeb((_mbase), MUSB_INDEX, (_epnum)) 211 #define MUSB_EP_OFFSET MUSB_TUSB_OFFSET 212 213 /* "flat" mapping: each endpoint has its own i/o address */ 214 #elif defined(MUSB_FLAT_REG) 215 #define musb_ep_select(_mbase, _epnum) (((void)(_mbase)), ((void)(_epnum))) 216 #define MUSB_EP_OFFSET MUSB_FLAT_OFFSET 217 218 /* "indexed" mapping: INDEX register controls register bank select */ 219 #else 220 #define musb_ep_select(_mbase, _epnum) \ 221 musb_writeb((_mbase), MUSB_INDEX, (_epnum)) 222 #define MUSB_EP_OFFSET MUSB_INDEXED_OFFSET 223 #endif 224 225 /****************************** FUNCTIONS ********************************/ 226 227 #define MUSB_HST_MODE(_musb)\ 228 { (_musb)->is_host = true; } 229 #define MUSB_DEV_MODE(_musb) \ 230 { (_musb)->is_host = false; } 231 232 #define test_devctl_hst_mode(_x) \ 233 (musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM) 234 235 #define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral") 236 237 /******************************** TYPES *************************************/ 238 239 /* 240 * struct musb_hw_ep - endpoint hardware (bidirectional) 241 * 242 * Ordered slightly for better cacheline locality. 243 */ 244 struct musb_hw_ep { 245 struct musb *musb; 246 void __iomem *fifo; 247 void __iomem *regs; 248 249 #ifdef CONFIG_USB_TUSB6010 250 void __iomem *conf; 251 #endif 252 253 /* index in musb->endpoints[] */ 254 u8 epnum; 255 256 /* hardware configuration, possibly dynamic */ 257 bool is_shared_fifo; 258 bool tx_double_buffered; 259 bool rx_double_buffered; 260 u16 max_packet_sz_tx; 261 u16 max_packet_sz_rx; 262 263 struct dma_channel *tx_channel; 264 struct dma_channel *rx_channel; 265 266 #ifdef CONFIG_USB_TUSB6010 267 /* TUSB has "asynchronous" and "synchronous" dma modes */ 268 dma_addr_t fifo_async; 269 dma_addr_t fifo_sync; 270 void __iomem *fifo_sync_va; 271 #endif 272 273 #ifdef CONFIG_USB_MUSB_HDRC_HCD 274 void __iomem *target_regs; 275 276 /* currently scheduled peripheral endpoint */ 277 struct musb_qh *in_qh; 278 struct musb_qh *out_qh; 279 280 u8 rx_reinit; 281 u8 tx_reinit; 282 #endif 283 284 #ifdef CONFIG_USB_GADGET_MUSB_HDRC 285 /* peripheral side */ 286 struct musb_ep ep_in; /* TX */ 287 struct musb_ep ep_out; /* RX */ 288 #endif 289 }; 290 291 static inline struct usb_request *next_in_request(struct musb_hw_ep *hw_ep) 292 { 293 #ifdef CONFIG_USB_GADGET_MUSB_HDRC 294 return next_request(&hw_ep->ep_in); 295 #else 296 return NULL; 297 #endif 298 } 299 300 static inline struct usb_request *next_out_request(struct musb_hw_ep *hw_ep) 301 { 302 #ifdef CONFIG_USB_GADGET_MUSB_HDRC 303 return next_request(&hw_ep->ep_out); 304 #else 305 return NULL; 306 #endif 307 } 308 309 /* 310 * struct musb - Driver instance data. 311 */ 312 struct musb { 313 /* device lock */ 314 spinlock_t lock; 315 struct clk *clock; 316 irqreturn_t (*isr)(int, void *); 317 struct work_struct irq_work; 318 319 /* this hub status bit is reserved by USB 2.0 and not seen by usbcore */ 320 #define MUSB_PORT_STAT_RESUME (1 << 31) 321 322 u32 port1_status; 323 324 #ifdef CONFIG_USB_MUSB_HDRC_HCD 325 unsigned long rh_timer; 326 327 enum musb_h_ep0_state ep0_stage; 328 329 /* bulk traffic normally dedicates endpoint hardware, and each 330 * direction has its own ring of host side endpoints. 331 * we try to progress the transfer at the head of each endpoint's 332 * queue until it completes or NAKs too much; then we try the next 333 * endpoint. 334 */ 335 struct musb_hw_ep *bulk_ep; 336 337 struct list_head control; /* of musb_qh */ 338 struct list_head in_bulk; /* of musb_qh */ 339 struct list_head out_bulk; /* of musb_qh */ 340 341 struct timer_list otg_timer; 342 #endif 343 344 /* called with IRQs blocked; ON/nonzero implies starting a session, 345 * and waiting at least a_wait_vrise_tmout. 346 */ 347 void (*board_set_vbus)(struct musb *, int is_on); 348 349 struct dma_controller *dma_controller; 350 351 struct device *controller; 352 void __iomem *ctrl_base; 353 void __iomem *mregs; 354 355 #ifdef CONFIG_USB_TUSB6010 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 otg_transceiver *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 int (*set_clock)(struct clk *clk, int is_active); 383 384 u8 min_power; /* vbus for periph, in mA/2 */ 385 386 bool is_host; 387 388 int a_wait_bcon; /* VBUS timeout in msecs */ 389 unsigned long idle_timeout; /* Next timeout in jiffies */ 390 391 /* active means connected and not suspended */ 392 unsigned is_active:1; 393 394 unsigned is_multipoint:1; 395 unsigned ignore_disconnect:1; /* during bus resets */ 396 397 unsigned hb_iso_rx:1; /* high bandwidth iso rx? */ 398 unsigned hb_iso_tx:1; /* high bandwidth iso tx? */ 399 400 #ifdef C_MP_TX 401 unsigned bulk_split:1; 402 #define can_bulk_split(musb,type) \ 403 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split) 404 #else 405 #define can_bulk_split(musb, type) 0 406 #endif 407 408 #ifdef C_MP_RX 409 unsigned bulk_combine:1; 410 #define can_bulk_combine(musb,type) \ 411 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine) 412 #else 413 #define can_bulk_combine(musb, type) 0 414 #endif 415 416 #ifdef CONFIG_USB_GADGET_MUSB_HDRC 417 /* is_suspended means USB B_PERIPHERAL suspend */ 418 unsigned is_suspended:1; 419 420 /* may_wakeup means remote wakeup is enabled */ 421 unsigned may_wakeup:1; 422 423 /* is_self_powered is reported in device status and the 424 * config descriptor. is_bus_powered means B_PERIPHERAL 425 * draws some VBUS current; both can be true. 426 */ 427 unsigned is_self_powered:1; 428 unsigned is_bus_powered:1; 429 430 unsigned set_address:1; 431 unsigned test_mode:1; 432 unsigned softconnect:1; 433 434 u8 address; 435 u8 test_mode_nr; 436 u16 ackpend; /* ep0 */ 437 enum musb_g_ep0_state ep0_state; 438 struct usb_gadget g; /* the gadget */ 439 struct usb_gadget_driver *gadget_driver; /* its driver */ 440 #endif 441 442 struct musb_hdrc_config *config; 443 444 #ifdef MUSB_CONFIG_PROC_FS 445 struct proc_dir_entry *proc_entry; 446 #endif 447 }; 448 449 static inline void musb_set_vbus(struct musb *musb, int is_on) 450 { 451 musb->board_set_vbus(musb, is_on); 452 } 453 454 #ifdef CONFIG_USB_GADGET_MUSB_HDRC 455 static inline struct musb *gadget_to_musb(struct usb_gadget *g) 456 { 457 return container_of(g, struct musb, g); 458 } 459 #endif 460 461 #ifdef CONFIG_BLACKFIN 462 static inline int musb_read_fifosize(struct musb *musb, 463 struct musb_hw_ep *hw_ep, u8 epnum) 464 { 465 musb->nr_endpoints++; 466 musb->epmask |= (1 << epnum); 467 468 if (epnum < 5) { 469 hw_ep->max_packet_sz_tx = 128; 470 hw_ep->max_packet_sz_rx = 128; 471 } else { 472 hw_ep->max_packet_sz_tx = 1024; 473 hw_ep->max_packet_sz_rx = 1024; 474 } 475 hw_ep->is_shared_fifo = false; 476 477 return 0; 478 } 479 480 static inline void musb_configure_ep0(struct musb *musb) 481 { 482 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE; 483 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE; 484 musb->endpoints[0].is_shared_fifo = true; 485 } 486 487 #else 488 489 static inline int musb_read_fifosize(struct musb *musb, 490 struct musb_hw_ep *hw_ep, u8 epnum) 491 { 492 void *mbase = musb->mregs; 493 u8 reg = 0; 494 495 /* read from core using indexed model */ 496 reg = musb_readb(mbase, MUSB_EP_OFFSET(epnum, MUSB_FIFOSIZE)); 497 /* 0's returned when no more endpoints */ 498 if (!reg) 499 return -ENODEV; 500 501 musb->nr_endpoints++; 502 musb->epmask |= (1 << epnum); 503 504 hw_ep->max_packet_sz_tx = 1 << (reg & 0x0f); 505 506 /* shared TX/RX FIFO? */ 507 if ((reg & 0xf0) == 0xf0) { 508 hw_ep->max_packet_sz_rx = hw_ep->max_packet_sz_tx; 509 hw_ep->is_shared_fifo = true; 510 return 0; 511 } else { 512 hw_ep->max_packet_sz_rx = 1 << ((reg & 0xf0) >> 4); 513 hw_ep->is_shared_fifo = false; 514 } 515 516 return 0; 517 } 518 519 static inline void musb_configure_ep0(struct musb *musb) 520 { 521 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE; 522 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE; 523 musb->endpoints[0].is_shared_fifo = true; 524 } 525 #endif /* CONFIG_BLACKFIN */ 526 527 528 /***************************** Glue it together *****************************/ 529 530 extern const char musb_driver_name[]; 531 532 extern void musb_start(struct musb *musb); 533 extern void musb_stop(struct musb *musb); 534 535 extern void musb_write_fifo(struct musb_hw_ep *ep, u16 len, const u8 *src); 536 extern void musb_read_fifo(struct musb_hw_ep *ep, u16 len, u8 *dst); 537 538 extern void musb_load_testpacket(struct musb *); 539 540 extern irqreturn_t musb_interrupt(struct musb *); 541 542 extern void musb_platform_enable(struct musb *musb); 543 extern void musb_platform_disable(struct musb *musb); 544 545 extern void musb_hnp_stop(struct musb *musb); 546 547 extern int musb_platform_set_mode(struct musb *musb, u8 musb_mode); 548 549 #if defined(CONFIG_USB_TUSB6010) || defined(CONFIG_BLACKFIN) || \ 550 defined(CONFIG_ARCH_OMAP2430) || defined(CONFIG_ARCH_OMAP34XX) 551 extern void musb_platform_try_idle(struct musb *musb, unsigned long timeout); 552 #else 553 #define musb_platform_try_idle(x, y) do {} while (0) 554 #endif 555 556 #if defined(CONFIG_USB_TUSB6010) || defined(CONFIG_BLACKFIN) 557 extern int musb_platform_get_vbus_status(struct musb *musb); 558 #else 559 #define musb_platform_get_vbus_status(x) 0 560 #endif 561 562 extern int __init musb_platform_init(struct musb *musb); 563 extern int musb_platform_exit(struct musb *musb); 564 565 #endif /* __MUSB_CORE_H__ */ 566