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/timer.h>
44 #include <linux/clk.h>
45 #include <linux/device.h>
46 #include <linux/usb/ch9.h>
47 #include <linux/usb/gadget.h>
48 #include <linux/usb.h>
49 #include <linux/usb/otg.h>
50 #include <linux/usb/musb.h>
57 #include "musb_debug.h"
61 #include "musb_regs.h"
63 #include "musb_gadget.h"
64 #include "../core/hcd.h"
65 #include "musb_host.h"
69 #ifdef CONFIG_USB_MUSB_OTG
71 #define is_peripheral_enabled(musb) ((musb)->board_mode != MUSB_HOST)
72 #define is_host_enabled(musb) ((musb)->board_mode != MUSB_PERIPHERAL)
73 #define is_otg_enabled(musb) ((musb)->board_mode == MUSB_OTG)
75 /* NOTE: otg and peripheral-only state machines start at B_IDLE.
76 * OTG or host-only go to A_IDLE when ID is sensed.
78 #define is_peripheral_active(m) (!(m)->is_host)
79 #define is_host_active(m) ((m)->is_host)
82 #define is_peripheral_enabled(musb) is_peripheral_capable()
83 #define is_host_enabled(musb) is_host_capable()
84 #define is_otg_enabled(musb) 0
86 #define is_peripheral_active(musb) is_peripheral_capable()
87 #define is_host_active(musb) is_host_capable()
90 #if defined(CONFIG_USB_MUSB_OTG) || defined(CONFIG_USB_MUSB_PERIPHERAL)
91 /* for some reason, the "select USB_GADGET_MUSB_HDRC" doesn't always
92 * override that choice selection (often USB_GADGET_DUMMY_HCD).
94 #ifndef CONFIG_USB_GADGET_MUSB_HDRC
95 #error bogus Kconfig output ... select CONFIG_USB_GADGET_MUSB_HDRC
97 #endif /* need MUSB gadget selection */
100 #ifdef CONFIG_PROC_FS
101 #include <linux/fs.h>
102 #define MUSB_CONFIG_PROC_FS
105 /****************************** PERIPHERAL ROLE *****************************/
107 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
109 #define is_peripheral_capable() (1)
111 extern irqreturn_t musb_g_ep0_irq(struct musb *);
112 extern void musb_g_tx(struct musb *, u8);
113 extern void musb_g_rx(struct musb *, u8);
114 extern void musb_g_reset(struct musb *);
115 extern void musb_g_suspend(struct musb *);
116 extern void musb_g_resume(struct musb *);
117 extern void musb_g_wakeup(struct musb *);
118 extern void musb_g_disconnect(struct musb *);
122 #define is_peripheral_capable() (0)
124 static inline irqreturn_t musb_g_ep0_irq(struct musb *m) { return IRQ_NONE; }
125 static inline void musb_g_reset(struct musb *m) {}
126 static inline void musb_g_suspend(struct musb *m) {}
127 static inline void musb_g_resume(struct musb *m) {}
128 static inline void musb_g_wakeup(struct musb *m) {}
129 static inline void musb_g_disconnect(struct musb *m) {}
133 /****************************** HOST ROLE ***********************************/
135 #ifdef CONFIG_USB_MUSB_HDRC_HCD
137 #define is_host_capable() (1)
139 extern irqreturn_t musb_h_ep0_irq(struct musb *);
140 extern void musb_host_tx(struct musb *, u8);
141 extern void musb_host_rx(struct musb *, u8);
145 #define is_host_capable() (0)
147 static inline irqreturn_t musb_h_ep0_irq(struct musb *m) { return IRQ_NONE; }
148 static inline void musb_host_tx(struct musb *m, u8 e) {}
149 static inline void musb_host_rx(struct musb *m, u8 e) {}
154 /****************************** CONSTANTS ********************************/
156 #ifndef MUSB_C_NUM_EPS
157 #define MUSB_C_NUM_EPS ((u8)16)
160 #ifndef MUSB_MAX_END0_PACKET
161 #define MUSB_MAX_END0_PACKET ((u16)MUSB_EP0_FIFOSIZE)
164 /* host side ep0 states */
165 enum musb_h_ep0_state {
167 MUSB_EP0_START, /* expect ack of setup */
168 MUSB_EP0_IN, /* expect IN DATA */
169 MUSB_EP0_OUT, /* expect ack of OUT DATA */
170 MUSB_EP0_STATUS, /* expect ack of STATUS */
171 } __attribute__ ((packed));
173 /* peripheral side ep0 states */
174 enum musb_g_ep0_state {
175 MUSB_EP0_STAGE_IDLE, /* idle, waiting for SETUP */
176 MUSB_EP0_STAGE_SETUP, /* received SETUP */
177 MUSB_EP0_STAGE_TX, /* IN data */
178 MUSB_EP0_STAGE_RX, /* OUT data */
179 MUSB_EP0_STAGE_STATUSIN, /* (after OUT data) */
180 MUSB_EP0_STAGE_STATUSOUT, /* (after IN data) */
181 MUSB_EP0_STAGE_ACKWAIT, /* after zlp, before statusin */
182 } __attribute__ ((packed));
185 * OTG protocol constants. See USB OTG 1.3 spec,
186 * sections 5.5 "Device Timings" and 6.6.5 "Timers".
188 #define OTG_TIME_A_WAIT_VRISE 100 /* msec (max) */
189 #define OTG_TIME_A_WAIT_BCON 1100 /* min 1 second */
190 #define OTG_TIME_A_AIDL_BDIS 200 /* min 200 msec */
191 #define OTG_TIME_B_ASE0_BRST 100 /* min 3.125 ms */
194 /*************************** REGISTER ACCESS ********************************/
196 /* Endpoint registers (other than dynfifo setup) can be accessed either
197 * directly with the "flat" model, or after setting up an index register.
200 #if defined(CONFIG_ARCH_DAVINCI) || defined(CONFIG_ARCH_OMAP2430) \
201 || defined(CONFIG_ARCH_OMAP3430) || defined(CONFIG_BLACKFIN)
202 /* REVISIT indexed access seemed to
203 * misbehave (on DaVinci) for at least peripheral IN ...
205 #define MUSB_FLAT_REG
208 /* TUSB mapping: "flat" plus ep0 special cases */
209 #if defined(CONFIG_USB_TUSB6010)
210 #define musb_ep_select(_mbase, _epnum) \
211 musb_writeb((_mbase), MUSB_INDEX, (_epnum))
212 #define MUSB_EP_OFFSET MUSB_TUSB_OFFSET
214 /* "flat" mapping: each endpoint has its own i/o address */
215 #elif defined(MUSB_FLAT_REG)
216 #define musb_ep_select(_mbase, _epnum) (((void)(_mbase)), ((void)(_epnum)))
217 #define MUSB_EP_OFFSET MUSB_FLAT_OFFSET
219 /* "indexed" mapping: INDEX register controls register bank select */
221 #define musb_ep_select(_mbase, _epnum) \
222 musb_writeb((_mbase), MUSB_INDEX, (_epnum))
223 #define MUSB_EP_OFFSET MUSB_INDEXED_OFFSET
226 /****************************** FUNCTIONS ********************************/
228 #define MUSB_HST_MODE(_musb)\
229 { (_musb)->is_host = true; }
230 #define MUSB_DEV_MODE(_musb) \
231 { (_musb)->is_host = false; }
233 #define test_devctl_hst_mode(_x) \
234 (musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM)
236 #define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral")
238 /******************************** TYPES *************************************/
241 * struct musb_hw_ep - endpoint hardware (bidirectional)
243 * Ordered slightly for better cacheline locality.
250 #ifdef CONFIG_USB_TUSB6010
254 /* index in musb->endpoints[] */
257 /* hardware configuration, possibly dynamic */
259 bool tx_double_buffered;
260 bool rx_double_buffered;
261 u16 max_packet_sz_tx;
262 u16 max_packet_sz_rx;
264 struct dma_channel *tx_channel;
265 struct dma_channel *rx_channel;
267 #ifdef CONFIG_USB_TUSB6010
268 /* TUSB has "asynchronous" and "synchronous" dma modes */
269 dma_addr_t fifo_async;
270 dma_addr_t fifo_sync;
271 void __iomem *fifo_sync_va;
274 #ifdef CONFIG_USB_MUSB_HDRC_HCD
275 void __iomem *target_regs;
277 /* currently scheduled peripheral endpoint */
278 struct musb_qh *in_qh;
279 struct musb_qh *out_qh;
285 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
286 /* peripheral side */
287 struct musb_ep ep_in; /* TX */
288 struct musb_ep ep_out; /* RX */
292 static inline struct usb_request *next_in_request(struct musb_hw_ep *hw_ep)
294 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
295 return next_request(&hw_ep->ep_in);
301 static inline struct usb_request *next_out_request(struct musb_hw_ep *hw_ep)
303 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
304 return next_request(&hw_ep->ep_out);
311 * struct musb - Driver instance data.
317 irqreturn_t (*isr)(int, void *);
318 struct work_struct irq_work;
320 /* this hub status bit is reserved by USB 2.0 and not seen by usbcore */
321 #define MUSB_PORT_STAT_RESUME (1 << 31)
325 #ifdef CONFIG_USB_MUSB_HDRC_HCD
326 unsigned long rh_timer;
328 enum musb_h_ep0_state ep0_stage;
330 /* bulk traffic normally dedicates endpoint hardware, and each
331 * direction has its own ring of host side endpoints.
332 * we try to progress the transfer at the head of each endpoint's
333 * queue until it completes or NAKs too much; then we try the next
336 struct musb_hw_ep *bulk_ep;
338 struct list_head control; /* of musb_qh */
339 struct list_head in_bulk; /* of musb_qh */
340 struct list_head out_bulk; /* of musb_qh */
342 struct timer_list otg_timer;
345 /* called with IRQs blocked; ON/nonzero implies starting a session,
346 * and waiting at least a_wait_vrise_tmout.
348 void (*board_set_vbus)(struct musb *, int is_on);
350 struct dma_controller *dma_controller;
352 struct device *controller;
353 void __iomem *ctrl_base;
356 #ifdef CONFIG_USB_TUSB6010
359 void __iomem *sync_va;
362 /* passed down from chip/board specific irq handlers */
367 struct otg_transceiver *xceiv;
372 struct musb_hw_ep endpoints[MUSB_C_NUM_EPS];
373 #define control_ep endpoints
375 #define VBUSERR_RETRY_COUNT 3
380 u8 board_mode; /* enum musb_mode */
381 int (*board_set_power)(int state);
383 int (*set_clock)(struct clk *clk, int is_active);
385 u8 min_power; /* vbus for periph, in mA/2 */
389 int a_wait_bcon; /* VBUS timeout in msecs */
390 unsigned long idle_timeout; /* Next timeout in jiffies */
392 /* active means connected and not suspended */
393 unsigned is_active:1;
395 unsigned is_multipoint:1;
396 unsigned ignore_disconnect:1; /* during bus resets */
398 unsigned hb_iso_rx:1; /* high bandwidth iso rx? */
399 unsigned hb_iso_tx:1; /* high bandwidth iso tx? */
402 unsigned bulk_split:1;
403 #define can_bulk_split(musb,type) \
404 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split)
406 #define can_bulk_split(musb, type) 0
410 unsigned bulk_combine:1;
411 #define can_bulk_combine(musb,type) \
412 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine)
414 #define can_bulk_combine(musb, type) 0
417 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
418 /* is_suspended means USB B_PERIPHERAL suspend */
419 unsigned is_suspended:1;
421 /* may_wakeup means remote wakeup is enabled */
422 unsigned may_wakeup:1;
424 /* is_self_powered is reported in device status and the
425 * config descriptor. is_bus_powered means B_PERIPHERAL
426 * draws some VBUS current; both can be true.
428 unsigned is_self_powered:1;
429 unsigned is_bus_powered:1;
431 unsigned set_address:1;
432 unsigned test_mode:1;
433 unsigned softconnect:1;
437 u16 ackpend; /* ep0 */
438 enum musb_g_ep0_state ep0_state;
439 struct usb_gadget g; /* the gadget */
440 struct usb_gadget_driver *gadget_driver; /* its driver */
443 struct musb_hdrc_config *config;
445 #ifdef MUSB_CONFIG_PROC_FS
446 struct proc_dir_entry *proc_entry;
450 static inline void musb_set_vbus(struct musb *musb, int is_on)
452 musb->board_set_vbus(musb, is_on);
455 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
456 static inline struct musb *gadget_to_musb(struct usb_gadget *g)
458 return container_of(g, struct musb, g);
462 #ifdef CONFIG_BLACKFIN
463 static inline int musb_read_fifosize(struct musb *musb,
464 struct musb_hw_ep *hw_ep, u8 epnum)
466 musb->nr_endpoints++;
467 musb->epmask |= (1 << epnum);
470 hw_ep->max_packet_sz_tx = 128;
471 hw_ep->max_packet_sz_rx = 128;
473 hw_ep->max_packet_sz_tx = 1024;
474 hw_ep->max_packet_sz_rx = 1024;
476 hw_ep->is_shared_fifo = false;
481 static inline void musb_configure_ep0(struct musb *musb)
483 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
484 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
485 musb->endpoints[0].is_shared_fifo = true;
490 static inline int musb_read_fifosize(struct musb *musb,
491 struct musb_hw_ep *hw_ep, u8 epnum)
493 void *mbase = musb->mregs;
496 /* read from core using indexed model */
497 reg = musb_readb(mbase, MUSB_EP_OFFSET(epnum, MUSB_FIFOSIZE));
498 /* 0's returned when no more endpoints */
502 musb->nr_endpoints++;
503 musb->epmask |= (1 << epnum);
505 hw_ep->max_packet_sz_tx = 1 << (reg & 0x0f);
507 /* shared TX/RX FIFO? */
508 if ((reg & 0xf0) == 0xf0) {
509 hw_ep->max_packet_sz_rx = hw_ep->max_packet_sz_tx;
510 hw_ep->is_shared_fifo = true;
513 hw_ep->max_packet_sz_rx = 1 << ((reg & 0xf0) >> 4);
514 hw_ep->is_shared_fifo = false;
520 static inline void musb_configure_ep0(struct musb *musb)
522 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
523 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
524 musb->endpoints[0].is_shared_fifo = true;
526 #endif /* CONFIG_BLACKFIN */
529 /***************************** Glue it together *****************************/
531 extern const char musb_driver_name[];
533 extern void musb_start(struct musb *musb);
534 extern void musb_stop(struct musb *musb);
536 extern void musb_write_fifo(struct musb_hw_ep *ep, u16 len, const u8 *src);
537 extern void musb_read_fifo(struct musb_hw_ep *ep, u16 len, u8 *dst);
539 extern void musb_load_testpacket(struct musb *);
541 extern irqreturn_t musb_interrupt(struct musb *);
543 extern void musb_platform_enable(struct musb *musb);
544 extern void musb_platform_disable(struct musb *musb);
546 extern void musb_hnp_stop(struct musb *musb);
548 extern int musb_platform_set_mode(struct musb *musb, u8 musb_mode);
550 #if defined(CONFIG_USB_TUSB6010) || defined(CONFIG_BLACKFIN) || \
551 defined(CONFIG_ARCH_OMAP2430) || defined(CONFIG_ARCH_OMAP34XX)
552 extern void musb_platform_try_idle(struct musb *musb, unsigned long timeout);
554 #define musb_platform_try_idle(x, y) do {} while (0)
557 #if defined(CONFIG_USB_TUSB6010) || defined(CONFIG_BLACKFIN)
558 extern int musb_platform_get_vbus_status(struct musb *musb);
560 #define musb_platform_get_vbus_status(x) 0
563 extern int __init musb_platform_init(struct musb *musb);
564 extern int musb_platform_exit(struct musb *musb);
566 #endif /* __MUSB_CORE_H__ */