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/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>
55 /* Helper defines for struct musb->hwvers */
56 #define MUSB_HWVERS_MAJOR(x) ((x >> 10) & 0x1f)
57 #define MUSB_HWVERS_MINOR(x) (x & 0x3ff)
58 #define MUSB_HWVERS_RC 0x8000
59 #define MUSB_HWVERS_1300 0x52C
60 #define MUSB_HWVERS_1400 0x590
61 #define MUSB_HWVERS_1800 0x720
62 #define MUSB_HWVERS_1900 0x784
63 #define MUSB_HWVERS_2000 0x800
65 #include "musb_debug.h"
69 #include "musb_regs.h"
71 #include "musb_gadget.h"
72 #include <linux/usb/hcd.h>
73 #include "musb_host.h"
75 #define is_peripheral_enabled(musb) ((musb)->board_mode != MUSB_HOST)
76 #define is_host_enabled(musb) ((musb)->board_mode != MUSB_PERIPHERAL)
77 #define is_otg_enabled(musb) ((musb)->board_mode == MUSB_OTG)
79 /* NOTE: otg and peripheral-only state machines start at B_IDLE.
80 * OTG or host-only go to A_IDLE when ID is sensed.
82 #define is_peripheral_active(m) (!(m)->is_host)
83 #define is_host_active(m) ((m)->is_host)
85 #ifndef CONFIG_HAVE_CLK
86 /* Dummy stub for clk framework */
87 #define clk_get(dev, id) NULL
88 #define clk_put(clock) do {} while (0)
89 #define clk_enable(clock) do {} while (0)
90 #define clk_disable(clock) do {} while (0)
95 #define MUSB_CONFIG_PROC_FS
98 /****************************** PERIPHERAL ROLE *****************************/
100 #define is_peripheral_capable() (1)
102 extern irqreturn_t musb_g_ep0_irq(struct musb *);
103 extern void musb_g_tx(struct musb *, u8);
104 extern void musb_g_rx(struct musb *, u8);
105 extern void musb_g_reset(struct musb *);
106 extern void musb_g_suspend(struct musb *);
107 extern void musb_g_resume(struct musb *);
108 extern void musb_g_wakeup(struct musb *);
109 extern void musb_g_disconnect(struct musb *);
111 /****************************** HOST ROLE ***********************************/
113 #define is_host_capable() (1)
115 extern irqreturn_t musb_h_ep0_irq(struct musb *);
116 extern void musb_host_tx(struct musb *, u8);
117 extern void musb_host_rx(struct musb *, u8);
119 /****************************** CONSTANTS ********************************/
121 #ifndef MUSB_C_NUM_EPS
122 #define MUSB_C_NUM_EPS ((u8)16)
125 #ifndef MUSB_MAX_END0_PACKET
126 #define MUSB_MAX_END0_PACKET ((u16)MUSB_EP0_FIFOSIZE)
129 /* host side ep0 states */
130 enum musb_h_ep0_state {
132 MUSB_EP0_START, /* expect ack of setup */
133 MUSB_EP0_IN, /* expect IN DATA */
134 MUSB_EP0_OUT, /* expect ack of OUT DATA */
135 MUSB_EP0_STATUS, /* expect ack of STATUS */
136 } __attribute__ ((packed));
138 /* peripheral side ep0 states */
139 enum musb_g_ep0_state {
140 MUSB_EP0_STAGE_IDLE, /* idle, waiting for SETUP */
141 MUSB_EP0_STAGE_SETUP, /* received SETUP */
142 MUSB_EP0_STAGE_TX, /* IN data */
143 MUSB_EP0_STAGE_RX, /* OUT data */
144 MUSB_EP0_STAGE_STATUSIN, /* (after OUT data) */
145 MUSB_EP0_STAGE_STATUSOUT, /* (after IN data) */
146 MUSB_EP0_STAGE_ACKWAIT, /* after zlp, before statusin */
147 } __attribute__ ((packed));
150 * OTG protocol constants. See USB OTG 1.3 spec,
151 * sections 5.5 "Device Timings" and 6.6.5 "Timers".
153 #define OTG_TIME_A_WAIT_VRISE 100 /* msec (max) */
154 #define OTG_TIME_A_WAIT_BCON 1100 /* min 1 second */
155 #define OTG_TIME_A_AIDL_BDIS 200 /* min 200 msec */
156 #define OTG_TIME_B_ASE0_BRST 100 /* min 3.125 ms */
159 /*************************** REGISTER ACCESS ********************************/
161 /* Endpoint registers (other than dynfifo setup) can be accessed either
162 * directly with the "flat" model, or after setting up an index register.
165 #if defined(CONFIG_ARCH_DAVINCI) || defined(CONFIG_SOC_OMAP2430) \
166 || defined(CONFIG_SOC_OMAP3430) || defined(CONFIG_BLACKFIN) \
167 || defined(CONFIG_ARCH_OMAP4)
168 /* REVISIT indexed access seemed to
169 * misbehave (on DaVinci) for at least peripheral IN ...
171 #define MUSB_FLAT_REG
174 /* TUSB mapping: "flat" plus ep0 special cases */
175 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
176 defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
177 #define musb_ep_select(_mbase, _epnum) \
178 musb_writeb((_mbase), MUSB_INDEX, (_epnum))
179 #define MUSB_EP_OFFSET MUSB_TUSB_OFFSET
181 /* "flat" mapping: each endpoint has its own i/o address */
182 #elif defined(MUSB_FLAT_REG)
183 #define musb_ep_select(_mbase, _epnum) (((void)(_mbase)), ((void)(_epnum)))
184 #define MUSB_EP_OFFSET MUSB_FLAT_OFFSET
186 /* "indexed" mapping: INDEX register controls register bank select */
188 #define musb_ep_select(_mbase, _epnum) \
189 musb_writeb((_mbase), MUSB_INDEX, (_epnum))
190 #define MUSB_EP_OFFSET MUSB_INDEXED_OFFSET
193 /****************************** FUNCTIONS ********************************/
195 #define MUSB_HST_MODE(_musb)\
196 { (_musb)->is_host = true; }
197 #define MUSB_DEV_MODE(_musb) \
198 { (_musb)->is_host = false; }
200 #define test_devctl_hst_mode(_x) \
201 (musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM)
203 #define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral")
205 /******************************** TYPES *************************************/
208 * struct musb_platform_ops - Operations passed to musb_core by HW glue layer
209 * @init: turns on clocks, sets up platform-specific registers, etc
210 * @exit: undoes @init
211 * @set_mode: forcefully changes operating mode
212 * @try_ilde: tries to idle the IP
213 * @vbus_status: returns vbus status if possible
214 * @set_vbus: forces vbus status
215 * @adjust_channel_params: pre check for standard dma channel_program func
217 struct musb_platform_ops {
218 int (*init)(struct musb *musb);
219 int (*exit)(struct musb *musb);
221 void (*enable)(struct musb *musb);
222 void (*disable)(struct musb *musb);
224 int (*set_mode)(struct musb *musb, u8 mode);
225 void (*try_idle)(struct musb *musb, unsigned long timeout);
227 int (*vbus_status)(struct musb *musb);
228 void (*set_vbus)(struct musb *musb, int on);
230 int (*adjust_channel_params)(struct dma_channel *channel,
231 u16 packet_sz, u8 *mode,
232 dma_addr_t *dma_addr, u32 *len);
236 * struct musb_hw_ep - endpoint hardware (bidirectional)
238 * Ordered slightly for better cacheline locality.
245 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
246 defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
250 /* index in musb->endpoints[] */
253 /* hardware configuration, possibly dynamic */
255 bool tx_double_buffered;
256 bool rx_double_buffered;
257 u16 max_packet_sz_tx;
258 u16 max_packet_sz_rx;
260 struct dma_channel *tx_channel;
261 struct dma_channel *rx_channel;
263 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
264 defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
265 /* TUSB has "asynchronous" and "synchronous" dma modes */
266 dma_addr_t fifo_async;
267 dma_addr_t fifo_sync;
268 void __iomem *fifo_sync_va;
271 void __iomem *target_regs;
273 /* currently scheduled peripheral endpoint */
274 struct musb_qh *in_qh;
275 struct musb_qh *out_qh;
280 /* peripheral side */
281 struct musb_ep ep_in; /* TX */
282 struct musb_ep ep_out; /* RX */
285 static inline struct musb_request *next_in_request(struct musb_hw_ep *hw_ep)
287 return next_request(&hw_ep->ep_in);
290 static inline struct musb_request *next_out_request(struct musb_hw_ep *hw_ep)
292 return next_request(&hw_ep->ep_out);
295 struct musb_csr_regs {
297 u16 txmaxp, txcsr, rxmaxp, rxcsr;
298 u16 rxfifoadd, txfifoadd;
299 u8 txtype, txinterval, rxtype, rxinterval;
300 u8 rxfifosz, txfifosz;
301 u8 txfunaddr, txhubaddr, txhubport;
302 u8 rxfunaddr, rxhubaddr, rxhubport;
305 struct musb_context_registers {
308 u16 intrtxe, intrrxe;
313 u8 devctl, busctl, misc;
316 struct musb_csr_regs index_regs[MUSB_C_NUM_EPS];
320 * struct musb - Driver instance data.
326 const struct musb_platform_ops *ops;
327 struct musb_context_registers context;
329 irqreturn_t (*isr)(int, void *);
330 struct work_struct irq_work;
333 /* this hub status bit is reserved by USB 2.0 and not seen by usbcore */
334 #define MUSB_PORT_STAT_RESUME (1 << 31)
338 unsigned long rh_timer;
340 enum musb_h_ep0_state ep0_stage;
342 /* bulk traffic normally dedicates endpoint hardware, and each
343 * direction has its own ring of host side endpoints.
344 * we try to progress the transfer at the head of each endpoint's
345 * queue until it completes or NAKs too much; then we try the next
348 struct musb_hw_ep *bulk_ep;
350 struct list_head control; /* of musb_qh */
351 struct list_head in_bulk; /* of musb_qh */
352 struct list_head out_bulk; /* of musb_qh */
354 struct timer_list otg_timer;
355 struct notifier_block nb;
357 struct dma_controller *dma_controller;
359 struct device *controller;
360 void __iomem *ctrl_base;
363 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
364 defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
367 void __iomem *sync_va;
370 /* passed down from chip/board specific irq handlers */
375 struct otg_transceiver *xceiv;
380 struct musb_hw_ep endpoints[MUSB_C_NUM_EPS];
381 #define control_ep endpoints
383 #define VBUSERR_RETRY_COUNT 3
388 u8 board_mode; /* enum musb_mode */
389 int (*board_set_power)(int state);
391 u8 min_power; /* vbus for periph, in mA/2 */
395 int a_wait_bcon; /* VBUS timeout in msecs */
396 unsigned long idle_timeout; /* Next timeout in jiffies */
398 /* active means connected and not suspended */
399 unsigned is_active:1;
401 unsigned is_multipoint:1;
402 unsigned ignore_disconnect:1; /* during bus resets */
404 unsigned hb_iso_rx:1; /* high bandwidth iso rx? */
405 unsigned hb_iso_tx:1; /* high bandwidth iso tx? */
406 unsigned dyn_fifo:1; /* dynamic FIFO supported? */
408 unsigned bulk_split:1;
409 #define can_bulk_split(musb,type) \
410 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split)
412 unsigned bulk_combine:1;
413 #define can_bulk_combine(musb,type) \
414 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine)
416 /* is_suspended means USB B_PERIPHERAL suspend */
417 unsigned is_suspended:1;
419 /* may_wakeup means remote wakeup is enabled */
420 unsigned may_wakeup:1;
422 /* is_self_powered is reported in device status and the
423 * config descriptor. is_bus_powered means B_PERIPHERAL
424 * draws some VBUS current; both can be true.
426 unsigned is_self_powered:1;
427 unsigned is_bus_powered:1;
429 unsigned set_address:1;
430 unsigned test_mode:1;
431 unsigned softconnect:1;
435 u16 ackpend; /* ep0 */
436 enum musb_g_ep0_state ep0_state;
437 struct usb_gadget g; /* the gadget */
438 struct usb_gadget_driver *gadget_driver; /* its driver */
441 * FIXME: Remove this flag.
443 * This is only added to allow Blackfin to work
444 * with current driver. For some unknown reason
445 * Blackfin doesn't work with double buffering
446 * and that's enabled by default.
448 * We added this flag to forcefully disable double
449 * buffering until we get it working.
451 unsigned double_buffer_not_ok:1 __deprecated;
453 struct musb_hdrc_config *config;
455 #ifdef MUSB_CONFIG_PROC_FS
456 struct proc_dir_entry *proc_entry;
458 struct delayed_work vbus_workaround_work;
461 static inline struct musb *gadget_to_musb(struct usb_gadget *g)
463 return container_of(g, struct musb, g);
466 #ifdef CONFIG_BLACKFIN
467 static inline int musb_read_fifosize(struct musb *musb,
468 struct musb_hw_ep *hw_ep, u8 epnum)
470 musb->nr_endpoints++;
471 musb->epmask |= (1 << epnum);
474 hw_ep->max_packet_sz_tx = 128;
475 hw_ep->max_packet_sz_rx = 128;
477 hw_ep->max_packet_sz_tx = 1024;
478 hw_ep->max_packet_sz_rx = 1024;
480 hw_ep->is_shared_fifo = false;
485 static inline void musb_configure_ep0(struct musb *musb)
487 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
488 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
489 musb->endpoints[0].is_shared_fifo = true;
494 static inline int musb_read_fifosize(struct musb *musb,
495 struct musb_hw_ep *hw_ep, u8 epnum)
497 void *mbase = musb->mregs;
500 /* read from core using indexed model */
501 reg = musb_readb(mbase, MUSB_EP_OFFSET(epnum, MUSB_FIFOSIZE));
502 /* 0's returned when no more endpoints */
506 musb->nr_endpoints++;
507 musb->epmask |= (1 << epnum);
509 hw_ep->max_packet_sz_tx = 1 << (reg & 0x0f);
511 /* shared TX/RX FIFO? */
512 if ((reg & 0xf0) == 0xf0) {
513 hw_ep->max_packet_sz_rx = hw_ep->max_packet_sz_tx;
514 hw_ep->is_shared_fifo = true;
517 hw_ep->max_packet_sz_rx = 1 << ((reg & 0xf0) >> 4);
518 hw_ep->is_shared_fifo = false;
524 static inline void musb_configure_ep0(struct musb *musb)
526 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
527 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
528 musb->endpoints[0].is_shared_fifo = true;
530 #endif /* CONFIG_BLACKFIN */
533 /***************************** Glue it together *****************************/
535 extern const char musb_driver_name[];
537 extern void musb_start(struct musb *musb);
538 extern void musb_stop(struct musb *musb);
540 extern void musb_write_fifo(struct musb_hw_ep *ep, u16 len, const u8 *src);
541 extern void musb_read_fifo(struct musb_hw_ep *ep, u16 len, u8 *dst);
543 extern void musb_load_testpacket(struct musb *);
545 extern irqreturn_t musb_interrupt(struct musb *);
547 extern void musb_hnp_stop(struct musb *musb);
549 static inline void musb_platform_set_vbus(struct musb *musb, int is_on)
551 if (musb->ops->set_vbus)
552 musb->ops->set_vbus(musb, is_on);
555 static inline void musb_platform_enable(struct musb *musb)
557 if (musb->ops->enable)
558 musb->ops->enable(musb);
561 static inline void musb_platform_disable(struct musb *musb)
563 if (musb->ops->disable)
564 musb->ops->disable(musb);
567 static inline int musb_platform_set_mode(struct musb *musb, u8 mode)
569 if (!musb->ops->set_mode)
572 return musb->ops->set_mode(musb, mode);
575 static inline void musb_platform_try_idle(struct musb *musb,
576 unsigned long timeout)
578 if (musb->ops->try_idle)
579 musb->ops->try_idle(musb, timeout);
582 static inline int musb_platform_get_vbus_status(struct musb *musb)
584 if (!musb->ops->vbus_status)
587 return musb->ops->vbus_status(musb);
590 static inline int musb_platform_init(struct musb *musb)
592 if (!musb->ops->init)
595 return musb->ops->init(musb);
598 static inline int musb_platform_exit(struct musb *musb)
600 if (!musb->ops->exit)
603 return musb->ops->exit(musb);
606 #endif /* __MUSB_CORE_H__ */