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/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>
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
66 #include "musb_debug.h"
70 #include "musb_regs.h"
72 #include "musb_gadget.h"
73 #include <linux/usb/hcd.h>
74 #include "musb_host.h"
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.
79 #define is_peripheral_active(m) (!(m)->is_host)
80 #define is_host_active(m) ((m)->is_host)
83 MUSB_PORT_MODE_HOST = 1,
84 MUSB_PORT_MODE_GADGET,
85 MUSB_PORT_MODE_DUAL_ROLE,
88 /****************************** CONSTANTS ********************************/
90 #ifndef MUSB_C_NUM_EPS
91 #define MUSB_C_NUM_EPS ((u8)16)
94 #ifndef MUSB_MAX_END0_PACKET
95 #define MUSB_MAX_END0_PACKET ((u16)MUSB_EP0_FIFOSIZE)
98 /* host side ep0 states */
99 enum musb_h_ep0_state {
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));
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));
119 * OTG protocol constants. See USB OTG 1.3 spec,
120 * sections 5.5 "Device Timings" and 6.6.5 "Timers".
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 */
128 /*************************** REGISTER ACCESS ********************************/
130 /* Endpoint registers (other than dynfifo setup) can be accessed either
131 * directly with the "flat" model, or after setting up an index register.
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 ...
140 #define MUSB_FLAT_REG
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
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
155 /* "indexed" mapping: INDEX register controls register bank select */
157 #define musb_ep_select(_mbase, _epnum) \
158 musb_writeb((_mbase), MUSB_INDEX, (_epnum))
159 #define MUSB_EP_OFFSET MUSB_INDEXED_OFFSET
162 /****************************** FUNCTIONS ********************************/
164 #define MUSB_HST_MODE(_musb)\
165 { (_musb)->is_host = true; }
166 #define MUSB_DEV_MODE(_musb) \
167 { (_musb)->is_host = false; }
169 #define test_devctl_hst_mode(_x) \
170 (musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM)
172 #define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral")
174 /******************************** TYPES *************************************/
179 * struct musb_platform_ops - Operations passed to musb_core by HW glue layer
180 * @quirks: flags for platform specific quirks
181 * @enable: enable device
182 * @disable: disable device
183 * @ep_offset: returns the end point offset
184 * @ep_select: selects the specified end point
185 * @fifo_mode: sets the fifo mode
186 * @fifo_offset: returns the fifo offset
187 * @readb: read 8 bits
188 * @writeb: write 8 bits
189 * @readw: read 16 bits
190 * @writew: write 16 bits
191 * @readl: read 32 bits
192 * @writel: write 32 bits
193 * @read_fifo: reads the fifo
194 * @write_fifo: writes to fifo
195 * @init: turns on clocks, sets up platform-specific registers, etc
196 * @exit: undoes @init
197 * @set_mode: forcefully changes operating mode
198 * @try_ilde: tries to idle the IP
199 * @vbus_status: returns vbus status if possible
200 * @set_vbus: forces vbus status
201 * @adjust_channel_params: pre check for standard dma channel_program func
203 struct musb_platform_ops {
205 #define MUSB_DMA_UX500 BIT(6)
206 #define MUSB_DMA_CPPI41 BIT(5)
207 #define MUSB_DMA_CPPI BIT(4)
208 #define MUSB_DMA_TUSB_OMAP BIT(3)
209 #define MUSB_DMA_INVENTRA BIT(2)
210 #define MUSB_IN_TUSB BIT(1)
211 #define MUSB_INDEXED_EP BIT(0)
214 int (*init)(struct musb *musb);
215 int (*exit)(struct musb *musb);
217 void (*enable)(struct musb *musb);
218 void (*disable)(struct musb *musb);
220 u32 (*ep_offset)(u8 epnum, u16 offset);
221 void (*ep_select)(void __iomem *mbase, u8 epnum);
223 u32 (*fifo_offset)(u8 epnum);
224 u8 (*readb)(const void __iomem *addr, unsigned offset);
225 void (*writeb)(void __iomem *addr, unsigned offset, u8 data);
226 u16 (*readw)(const void __iomem *addr, unsigned offset);
227 void (*writew)(void __iomem *addr, unsigned offset, u16 data);
228 u32 (*readl)(const void __iomem *addr, unsigned offset);
229 void (*writel)(void __iomem *addr, unsigned offset, u32 data);
230 void (*read_fifo)(struct musb_hw_ep *hw_ep, u16 len, u8 *buf);
231 void (*write_fifo)(struct musb_hw_ep *hw_ep, u16 len, const u8 *buf);
232 int (*set_mode)(struct musb *musb, u8 mode);
233 void (*try_idle)(struct musb *musb, unsigned long timeout);
234 int (*reset)(struct musb *musb);
236 int (*vbus_status)(struct musb *musb);
237 void (*set_vbus)(struct musb *musb, int on);
239 int (*adjust_channel_params)(struct dma_channel *channel,
240 u16 packet_sz, u8 *mode,
241 dma_addr_t *dma_addr, u32 *len);
245 * struct musb_hw_ep - endpoint hardware (bidirectional)
247 * Ordered slightly for better cacheline locality.
254 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
255 defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
259 /* index in musb->endpoints[] */
262 /* hardware configuration, possibly dynamic */
264 bool tx_double_buffered;
265 bool rx_double_buffered;
266 u16 max_packet_sz_tx;
267 u16 max_packet_sz_rx;
269 struct dma_channel *tx_channel;
270 struct dma_channel *rx_channel;
272 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
273 defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
274 /* TUSB has "asynchronous" and "synchronous" dma modes */
275 dma_addr_t fifo_async;
276 dma_addr_t fifo_sync;
277 void __iomem *fifo_sync_va;
280 void __iomem *target_regs;
282 /* currently scheduled peripheral endpoint */
283 struct musb_qh *in_qh;
284 struct musb_qh *out_qh;
289 /* peripheral side */
290 struct musb_ep ep_in; /* TX */
291 struct musb_ep ep_out; /* RX */
294 static inline struct musb_request *next_in_request(struct musb_hw_ep *hw_ep)
296 return next_request(&hw_ep->ep_in);
299 static inline struct musb_request *next_out_request(struct musb_hw_ep *hw_ep)
301 return next_request(&hw_ep->ep_out);
304 struct musb_csr_regs {
306 u16 txmaxp, txcsr, rxmaxp, rxcsr;
307 u16 rxfifoadd, txfifoadd;
308 u8 txtype, txinterval, rxtype, rxinterval;
309 u8 rxfifosz, txfifosz;
310 u8 txfunaddr, txhubaddr, txhubport;
311 u8 rxfunaddr, rxhubaddr, rxhubport;
314 struct musb_context_registers {
321 u8 devctl, busctl, misc;
324 struct musb_csr_regs index_regs[MUSB_C_NUM_EPS];
328 * struct musb - Driver instance data.
335 const struct musb_platform_ops *ops;
336 struct musb_context_registers context;
338 irqreturn_t (*isr)(int, void *);
339 struct work_struct irq_work;
340 struct delayed_work recover_work;
341 struct delayed_work deassert_reset_work;
342 struct delayed_work finish_resume_work;
347 /* this hub status bit is reserved by USB 2.0 and not seen by usbcore */
348 #define MUSB_PORT_STAT_RESUME (1 << 31)
352 unsigned long rh_timer;
354 enum musb_h_ep0_state ep0_stage;
356 /* bulk traffic normally dedicates endpoint hardware, and each
357 * direction has its own ring of host side endpoints.
358 * we try to progress the transfer at the head of each endpoint's
359 * queue until it completes or NAKs too much; then we try the next
362 struct musb_hw_ep *bulk_ep;
364 struct list_head control; /* of musb_qh */
365 struct list_head in_bulk; /* of musb_qh */
366 struct list_head out_bulk; /* of musb_qh */
368 struct timer_list otg_timer;
369 struct notifier_block nb;
371 struct dma_controller *dma_controller;
373 struct device *controller;
374 void __iomem *ctrl_base;
377 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
378 defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
381 void __iomem *sync_va;
385 /* passed down from chip/board specific irq handlers */
390 struct usb_phy *xceiv;
396 struct musb_hw_ep endpoints[MUSB_C_NUM_EPS];
397 #define control_ep endpoints
399 #define VBUSERR_RETRY_COUNT 3
404 int (*board_set_power)(int state);
406 u8 min_power; /* vbus for periph, in mA/2 */
408 int port_mode; /* MUSB_PORT_MODE_* */
411 int a_wait_bcon; /* VBUS timeout in msecs */
412 unsigned long idle_timeout; /* Next timeout in jiffies */
414 /* active means connected and not suspended */
415 unsigned is_active:1;
417 unsigned is_multipoint:1;
419 unsigned hb_iso_rx:1; /* high bandwidth iso rx? */
420 unsigned hb_iso_tx:1; /* high bandwidth iso tx? */
421 unsigned dyn_fifo:1; /* dynamic FIFO supported? */
423 unsigned bulk_split:1;
424 #define can_bulk_split(musb,type) \
425 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split)
427 unsigned bulk_combine:1;
428 #define can_bulk_combine(musb,type) \
429 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine)
431 /* is_suspended means USB B_PERIPHERAL suspend */
432 unsigned is_suspended:1;
433 unsigned need_finish_resume :1;
435 /* may_wakeup means remote wakeup is enabled */
436 unsigned may_wakeup:1;
438 /* is_self_powered is reported in device status and the
439 * config descriptor. is_bus_powered means B_PERIPHERAL
440 * draws some VBUS current; both can be true.
442 unsigned is_self_powered:1;
443 unsigned is_bus_powered:1;
445 unsigned set_address:1;
446 unsigned test_mode:1;
447 unsigned softconnect:1;
451 u16 ackpend; /* ep0 */
452 enum musb_g_ep0_state ep0_state;
453 struct usb_gadget g; /* the gadget */
454 struct usb_gadget_driver *gadget_driver; /* its driver */
455 struct usb_hcd *hcd; /* the usb hcd */
458 * FIXME: Remove this flag.
460 * This is only added to allow Blackfin to work
461 * with current driver. For some unknown reason
462 * Blackfin doesn't work with double buffering
463 * and that's enabled by default.
465 * We added this flag to forcefully disable double
466 * buffering until we get it working.
468 unsigned double_buffer_not_ok:1;
470 struct musb_hdrc_config *config;
473 #ifdef CONFIG_DEBUG_FS
474 struct dentry *debugfs_root;
478 static inline struct musb *gadget_to_musb(struct usb_gadget *g)
480 return container_of(g, struct musb, g);
483 #ifdef CONFIG_BLACKFIN
484 static inline int musb_read_fifosize(struct musb *musb,
485 struct musb_hw_ep *hw_ep, u8 epnum)
487 musb->nr_endpoints++;
488 musb->epmask |= (1 << epnum);
491 hw_ep->max_packet_sz_tx = 128;
492 hw_ep->max_packet_sz_rx = 128;
494 hw_ep->max_packet_sz_tx = 1024;
495 hw_ep->max_packet_sz_rx = 1024;
497 hw_ep->is_shared_fifo = false;
502 static inline void musb_configure_ep0(struct musb *musb)
504 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
505 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
506 musb->endpoints[0].is_shared_fifo = true;
511 static inline int musb_read_fifosize(struct musb *musb,
512 struct musb_hw_ep *hw_ep, u8 epnum)
514 void __iomem *mbase = musb->mregs;
517 /* read from core using indexed model */
518 reg = musb_readb(mbase, MUSB_EP_OFFSET(epnum, MUSB_FIFOSIZE));
519 /* 0's returned when no more endpoints */
523 musb->nr_endpoints++;
524 musb->epmask |= (1 << epnum);
526 hw_ep->max_packet_sz_tx = 1 << (reg & 0x0f);
528 /* shared TX/RX FIFO? */
529 if ((reg & 0xf0) == 0xf0) {
530 hw_ep->max_packet_sz_rx = hw_ep->max_packet_sz_tx;
531 hw_ep->is_shared_fifo = true;
534 hw_ep->max_packet_sz_rx = 1 << ((reg & 0xf0) >> 4);
535 hw_ep->is_shared_fifo = false;
541 static inline void musb_configure_ep0(struct musb *musb)
543 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
544 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
545 musb->endpoints[0].is_shared_fifo = true;
547 #endif /* CONFIG_BLACKFIN */
550 /***************************** Glue it together *****************************/
552 extern const char musb_driver_name[];
554 extern void musb_stop(struct musb *musb);
555 extern void musb_start(struct musb *musb);
557 extern void musb_write_fifo(struct musb_hw_ep *ep, u16 len, const u8 *src);
558 extern void musb_read_fifo(struct musb_hw_ep *ep, u16 len, u8 *dst);
560 extern void musb_load_testpacket(struct musb *);
562 extern irqreturn_t musb_interrupt(struct musb *);
564 extern void musb_hnp_stop(struct musb *musb);
566 static inline void musb_platform_set_vbus(struct musb *musb, int is_on)
568 if (musb->ops->set_vbus)
569 musb->ops->set_vbus(musb, is_on);
572 static inline void musb_platform_enable(struct musb *musb)
574 if (musb->ops->enable)
575 musb->ops->enable(musb);
578 static inline void musb_platform_disable(struct musb *musb)
580 if (musb->ops->disable)
581 musb->ops->disable(musb);
584 static inline int musb_platform_set_mode(struct musb *musb, u8 mode)
586 if (!musb->ops->set_mode)
589 return musb->ops->set_mode(musb, mode);
592 static inline void musb_platform_try_idle(struct musb *musb,
593 unsigned long timeout)
595 if (musb->ops->try_idle)
596 musb->ops->try_idle(musb, timeout);
599 static inline int musb_platform_reset(struct musb *musb)
601 if (!musb->ops->reset)
604 return musb->ops->reset(musb);
607 static inline int musb_platform_get_vbus_status(struct musb *musb)
609 if (!musb->ops->vbus_status)
612 return musb->ops->vbus_status(musb);
615 static inline int musb_platform_init(struct musb *musb)
617 if (!musb->ops->init)
620 return musb->ops->init(musb);
623 static inline int musb_platform_exit(struct musb *musb)
625 if (!musb->ops->exit)
628 return musb->ops->exit(musb);
631 #endif /* __MUSB_CORE_H__ */