2 * MUSB OTG driver defines
4 * Copyright 2005 Mentor Graphics Corporation
5 * Copyright (C) 2005-2006 by Texas Instruments
6 * Copyright (C) 2006-2007 Nokia Corporation
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.
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.
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
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.
35 #ifndef __MUSB_CORE_H__
36 #define __MUSB_CORE_H__
38 #include <linux/slab.h>
39 #include <linux/list.h>
40 #include <linux/interrupt.h>
41 #include <linux/smp_lock.h>
42 #include <linux/errno.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>
56 #include "musb_debug.h"
60 #include "musb_regs.h"
62 #include "musb_gadget.h"
63 #include "../core/hcd.h"
64 #include "musb_host.h"
67 #ifdef CONFIG_USB_MUSB_OTG
69 #define is_peripheral_enabled(musb) ((musb)->board_mode != MUSB_HOST)
70 #define is_host_enabled(musb) ((musb)->board_mode != MUSB_PERIPHERAL)
71 #define is_otg_enabled(musb) ((musb)->board_mode == MUSB_OTG)
73 /* NOTE: otg and peripheral-only state machines start at B_IDLE.
74 * OTG or host-only go to A_IDLE when ID is sensed.
76 #define is_peripheral_active(m) (!(m)->is_host)
77 #define is_host_active(m) ((m)->is_host)
80 #define is_peripheral_enabled(musb) is_peripheral_capable()
81 #define is_host_enabled(musb) is_host_capable()
82 #define is_otg_enabled(musb) 0
84 #define is_peripheral_active(musb) is_peripheral_capable()
85 #define is_host_active(musb) is_host_capable()
88 #if defined(CONFIG_USB_MUSB_OTG) || defined(CONFIG_USB_MUSB_PERIPHERAL)
89 /* for some reason, the "select USB_GADGET_MUSB_HDRC" doesn't always
90 * override that choice selection (often USB_GADGET_DUMMY_HCD).
92 #ifndef CONFIG_USB_GADGET_MUSB_HDRC
93 #error bogus Kconfig output ... select CONFIG_USB_GADGET_MUSB_HDRC
95 #endif /* need MUSB gadget selection */
100 #define MUSB_CONFIG_PROC_FS
103 /****************************** PERIPHERAL ROLE *****************************/
105 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
107 #define is_peripheral_capable() (1)
109 extern irqreturn_t musb_g_ep0_irq(struct musb *);
110 extern void musb_g_tx(struct musb *, u8);
111 extern void musb_g_rx(struct musb *, u8, bool);
112 extern void musb_g_reset(struct musb *);
113 extern void musb_g_suspend(struct musb *);
114 extern void musb_g_resume(struct musb *);
115 extern void musb_g_wakeup(struct musb *);
116 extern void musb_g_disconnect(struct musb *);
120 #define is_peripheral_capable() (0)
122 static inline irqreturn_t musb_g_ep0_irq(struct musb *m) { return IRQ_NONE; }
123 static inline void musb_g_reset(struct musb *m) {}
124 static inline void musb_g_suspend(struct musb *m) {}
125 static inline void musb_g_resume(struct musb *m) {}
126 static inline void musb_g_wakeup(struct musb *m) {}
127 static inline void musb_g_disconnect(struct musb *m) {}
131 /****************************** HOST ROLE ***********************************/
133 #ifdef CONFIG_USB_MUSB_HDRC_HCD
135 #define is_host_capable() (1)
137 extern irqreturn_t musb_h_ep0_irq(struct musb *);
138 extern void musb_host_tx(struct musb *, u8);
139 extern void musb_host_rx(struct musb *, u8);
143 #define is_host_capable() (0)
145 static inline irqreturn_t musb_h_ep0_irq(struct musb *m) { return IRQ_NONE; }
146 static inline void musb_host_tx(struct musb *m, u8 e) {}
147 static inline void musb_host_rx(struct musb *m, u8 e) {}
152 /****************************** CONSTANTS ********************************/
154 #ifndef MUSB_C_NUM_EPS
155 #define MUSB_C_NUM_EPS ((u8)16)
158 #ifndef MUSB_MAX_END0_PACKET
159 #define MUSB_MAX_END0_PACKET ((u16)MUSB_EP0_FIFOSIZE)
162 /* host side ep0 states */
163 enum musb_h_ep0_state {
165 MUSB_EP0_START, /* expect ack of setup */
166 MUSB_EP0_IN, /* expect IN DATA */
167 MUSB_EP0_OUT, /* expect ack of OUT DATA */
168 MUSB_EP0_STATUS, /* expect ack of STATUS */
169 } __attribute__ ((packed));
171 /* peripheral side ep0 states */
172 enum musb_g_ep0_state {
173 MUSB_EP0_STAGE_SETUP, /* idle, waiting for setup */
174 MUSB_EP0_STAGE_TX, /* IN data */
175 MUSB_EP0_STAGE_RX, /* OUT data */
176 MUSB_EP0_STAGE_STATUSIN, /* (after OUT data) */
177 MUSB_EP0_STAGE_STATUSOUT, /* (after IN data) */
178 MUSB_EP0_STAGE_ACKWAIT, /* after zlp, before statusin */
179 } __attribute__ ((packed));
181 /* OTG protocol constants */
182 #define OTG_TIME_A_WAIT_VRISE 100 /* msec (max) */
183 #define OTG_TIME_A_WAIT_BCON 0 /* 0=infinite; min 1000 msec */
184 #define OTG_TIME_A_IDLE_BDIS 200 /* msec (min) */
186 /*************************** REGISTER ACCESS ********************************/
188 /* Endpoint registers (other than dynfifo setup) can be accessed either
189 * directly with the "flat" model, or after setting up an index register.
192 #if defined(CONFIG_ARCH_DAVINCI) || defined(CONFIG_ARCH_OMAP2430) \
193 || defined(CONFIG_ARCH_OMAP3430) || defined(CONFIG_BLACKFIN)
194 /* REVISIT indexed access seemed to
195 * misbehave (on DaVinci) for at least peripheral IN ...
197 #define MUSB_FLAT_REG
200 /* TUSB mapping: "flat" plus ep0 special cases */
201 #if defined(CONFIG_USB_TUSB6010)
202 #define musb_ep_select(_mbase, _epnum) \
203 musb_writeb((_mbase), MUSB_INDEX, (_epnum))
204 #define MUSB_EP_OFFSET MUSB_TUSB_OFFSET
206 /* "flat" mapping: each endpoint has its own i/o address */
207 #elif defined(MUSB_FLAT_REG)
208 #define musb_ep_select(_mbase, _epnum) (((void)(_mbase)), ((void)(_epnum)))
209 #define MUSB_EP_OFFSET MUSB_FLAT_OFFSET
211 /* "indexed" mapping: INDEX register controls register bank select */
213 #define musb_ep_select(_mbase, _epnum) \
214 musb_writeb((_mbase), MUSB_INDEX, (_epnum))
215 #define MUSB_EP_OFFSET MUSB_INDEXED_OFFSET
218 /****************************** FUNCTIONS ********************************/
220 #define MUSB_HST_MODE(_musb)\
221 { (_musb)->is_host = true; }
222 #define MUSB_DEV_MODE(_musb) \
223 { (_musb)->is_host = false; }
225 #define test_devctl_hst_mode(_x) \
226 (musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM)
228 #define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral")
230 /******************************** TYPES *************************************/
233 * struct musb_hw_ep - endpoint hardware (bidirectional)
235 * Ordered slightly for better cacheline locality.
242 #ifdef CONFIG_USB_TUSB6010
246 /* index in musb->endpoints[] */
249 /* hardware configuration, possibly dynamic */
251 bool tx_double_buffered;
252 bool rx_double_buffered;
253 u16 max_packet_sz_tx;
254 u16 max_packet_sz_rx;
256 struct dma_channel *tx_channel;
257 struct dma_channel *rx_channel;
259 #ifdef CONFIG_USB_TUSB6010
260 /* TUSB has "asynchronous" and "synchronous" dma modes */
261 dma_addr_t fifo_async;
262 dma_addr_t fifo_sync;
263 void __iomem *fifo_sync_va;
266 #ifdef CONFIG_USB_MUSB_HDRC_HCD
267 void __iomem *target_regs;
269 /* currently scheduled peripheral endpoint */
270 struct musb_qh *in_qh;
271 struct musb_qh *out_qh;
273 /* list of rx and tx qhs, control transfer needs only
274 * one list thus only in_list is used for control.
276 struct list_head in_list;
277 struct list_head out_list;
283 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
284 /* peripheral side */
285 struct musb_ep ep_in; /* TX */
286 struct musb_ep ep_out; /* RX */
290 static inline struct usb_request *next_in_request(struct musb_hw_ep *hw_ep)
292 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
293 return next_request(&hw_ep->ep_in);
299 static inline struct usb_request *next_out_request(struct musb_hw_ep *hw_ep)
301 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
302 return next_request(&hw_ep->ep_out);
308 #define MUSB_MAX_EPS 16
311 /* common register */
326 /* indexed registers */
327 u16 txmaxp[MUSB_MAX_EPS];
328 u16 txcsr[MUSB_MAX_EPS];
330 u16 rxmaxp[MUSB_MAX_EPS];
331 u16 rxcsr[MUSB_MAX_EPS];
333 u16 csr0; /* select ep0 to read/write this register */
335 u8 txtype[MUSB_MAX_EPS];
336 u8 txinterval[MUSB_MAX_EPS];
338 u8 rxtype[MUSB_MAX_EPS];
339 u8 rxinterval[MUSB_MAX_EPS];
341 u8 fifosize[MUSB_MAX_EPS];
343 u8 rxfifosz[MUSB_MAX_EPS];
344 u8 txfifosz[MUSB_MAX_EPS];
345 u16 txfifoadd[MUSB_MAX_EPS];
346 u16 rxfifoadd[MUSB_MAX_EPS];
354 * struct musb - Driver instance data.
361 irqreturn_t (*isr)(int, void *);
362 struct work_struct irq_work;
363 struct work_struct vbus_work;
365 /* this hub status bit is reserved by USB 2.0 and not seen by usbcore */
366 #define MUSB_PORT_STAT_RESUME (1 << 31)
370 #ifdef CONFIG_USB_MUSB_HDRC_HCD
371 unsigned long rh_timer;
373 enum musb_h_ep0_state ep0_stage;
375 /* bulk traffic normally dedicates endpoint hardware, and each
376 * direction has its own ring of host side endpoints.
377 * we try to progress the transfer at the head of each endpoint's
378 * queue until it completes or NAKs too much; then we try the next
381 struct musb_hw_ep *bulk_ep;
383 struct musb_qh *periodic[32]; /* tree of interrupt+iso */
386 /* called with IRQs blocked; ON/nonzero implies starting a session,
387 * and waiting at least a_wait_vrise_tmout.
389 void (*board_set_vbus)(struct musb *, int is_on);
391 struct dma_controller *dma_controller;
393 struct device *controller;
394 void __iomem *ctrl_base;
397 #ifdef CONFIG_USB_TUSB6010
400 void __iomem *sync_va;
403 /* passed down from chip/board specific irq handlers */
408 struct otg_transceiver *xceiv;
413 struct musb_hw_ep endpoints[MUSB_C_NUM_EPS];
414 #define control_ep endpoints
416 #define VBUSERR_RETRY_COUNT 3
421 struct musb_board_data *board;
422 u8 board_mode; /* enum musb_mode */
423 int (*board_set_power)(int state);
425 int (*set_clock)(struct clk *clk, int is_active);
427 u8 min_power; /* vbus for periph, in mA/2 */
429 unsigned power_draw; /* current power draw, gadget only */
433 int a_wait_bcon; /* VBUS timeout in msecs */
434 unsigned long idle_timeout; /* Next timeout in jiffies */
436 /* active means connected and not suspended */
437 unsigned is_active:1;
439 unsigned is_multipoint:1;
440 unsigned ignore_disconnect:1; /* during bus resets */
443 unsigned bulk_split:1;
444 #define can_bulk_split(musb,type) \
445 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split)
447 #define can_bulk_split(musb, type) 0
451 unsigned bulk_combine:1;
452 #define can_bulk_combine(musb,type) \
453 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine)
455 #define can_bulk_combine(musb, type) 0
458 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
459 /* is_suspended means USB B_PERIPHERAL suspend */
460 unsigned is_suspended:1;
462 /* may_wakeup means remote wakeup is enabled */
463 unsigned may_wakeup:1;
465 /* is_self_powered is reported in device status and the
466 * config descriptor. is_bus_powered means B_PERIPHERAL
467 * draws some VBUS current; both can be true.
469 unsigned is_self_powered:1;
470 unsigned is_bus_powered:1;
472 unsigned set_address:1;
473 unsigned test_mode:1;
474 unsigned softconnect:1;
478 u16 ackpend; /* ep0 */
479 enum musb_g_ep0_state ep0_state;
480 struct usb_gadget g; /* the gadget */
481 struct usb_gadget_driver *gadget_driver; /* its driver */
484 /* true if this chip can enable SUSPENDM */
487 /* true if we're using dma */
490 struct musb_hdrc_config *config;
492 #ifdef MUSB_CONFIG_PROC_FS
493 struct proc_dir_entry *proc_entry;
495 unsigned is_charger:1;
498 static inline void musb_set_vbus(struct musb *musb, int is_on)
500 musb->board_set_vbus(musb, is_on);
503 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
504 static inline struct musb *gadget_to_musb(struct usb_gadget *g)
506 return container_of(g, struct musb, g);
510 #ifdef CONFIG_BLACKFIN
511 static inline int musb_read_fifosize(struct musb *musb,
512 struct musb_hw_ep *hw_ep, u8 epnum)
514 musb->nr_endpoints++;
515 musb->epmask |= (1 << epnum);
518 hw_ep->max_packet_sz_tx = 128;
519 hw_ep->max_packet_sz_rx = 128;
521 hw_ep->max_packet_sz_tx = 1024;
522 hw_ep->max_packet_sz_rx = 1024;
524 hw_ep->is_shared_fifo = false;
529 static inline void musb_configure_ep0(struct musb *musb)
531 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
532 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
533 musb->endpoints[0].is_shared_fifo = true;
538 static inline int musb_read_fifosize(struct musb *musb,
539 struct musb_hw_ep *hw_ep, u8 epnum)
543 /* read from core using indexed model */
544 reg = musb_readb(hw_ep->regs, 0x10 + MUSB_FIFOSIZE);
545 /* 0's returned when no more endpoints */
549 musb->nr_endpoints++;
550 musb->epmask |= (1 << epnum);
552 hw_ep->max_packet_sz_tx = 1 << (reg & 0x0f);
554 /* shared TX/RX FIFO? */
555 if ((reg & 0xf0) == 0xf0) {
556 hw_ep->max_packet_sz_rx = hw_ep->max_packet_sz_tx;
557 hw_ep->is_shared_fifo = true;
560 hw_ep->max_packet_sz_rx = 1 << ((reg & 0xf0) >> 4);
561 hw_ep->is_shared_fifo = false;
567 static inline void musb_configure_ep0(struct musb *musb)
569 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
570 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
572 #endif /* CONFIG_BLACKFIN */
575 /***************************** Glue it together *****************************/
577 extern const char musb_driver_name[];
579 extern void musb_start(struct musb *musb);
580 extern void musb_stop(struct musb *musb);
582 extern void musb_write_fifo(struct musb_hw_ep *ep, u16 len, const u8 *src);
583 extern void musb_read_fifo(struct musb_hw_ep *ep, u16 len, u8 *dst);
585 extern void musb_load_testpacket(struct musb *);
587 extern irqreturn_t musb_interrupt(struct musb *);
589 extern void musb_platform_enable(struct musb *musb);
590 extern void musb_platform_disable(struct musb *musb);
592 extern void musb_hnp_stop(struct musb *musb);
594 extern int musb_platform_set_mode(struct musb *musb, u8 musb_mode);
596 #if defined(CONFIG_USB_TUSB6010) || defined(CONFIG_BLACKFIN) || \
597 defined(CONFIG_ARCH_OMAP2430) || defined(CONFIG_ARCH_OMAP34XX)
598 extern void musb_platform_try_idle(struct musb *musb, unsigned long timeout);
600 #define musb_platform_try_idle(x, y) do {} while (0)
603 #if defined(CONFIG_USB_TUSB6010) || defined(CONFIG_BLACKFIN)
604 extern int musb_platform_get_vbus_status(struct musb *musb);
606 #define musb_platform_get_vbus_status(x) 0
610 extern void musb_save_ctx(struct musb *musb);
611 extern void musb_restore_ctx(struct musb *musb);
612 extern void musb_save_ctx_and_suspend(struct usb_gadget *, int);
613 extern void musb_restore_ctx_and_resume(struct usb_gadget *);
615 static inline void musb_save_ctx(struct musb *musb) {}
616 static inline void musb_restore_ctx(struct musb *musb) {}
617 static inline void musb_save_ctx_and_suspend(struct usb_gadget *, int) {}
618 static inline void musb_restore_ctx_and_resume(struct usb_gadget *) {}
621 extern int __init musb_platform_init(struct musb *musb);
622 extern int musb_platform_exit(struct musb *musb);
624 /*-------------------------- ProcFS definitions ---------------------*/
626 struct proc_dir_entry;
628 #ifdef CONFIG_MUSB_PROC_FS
629 extern struct proc_dir_entry *musb_debug_create(char *name, struct musb *data);
630 extern void musb_debug_delete(char *name, struct musb *data);
632 static inline struct proc_dir_entry *
633 musb_debug_create(char *name, struct musb *data)
637 static inline void musb_debug_delete(char *name, struct musb *data)
642 #endif /* __MUSB_CORE_H__ */