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"
71 #include "musb_gadget.h"
72 #include <linux/usb/hcd.h>
73 #include "musb_host.h"
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 MUSB_PORT_MODE_HOST = 1,
83 MUSB_PORT_MODE_GADGET,
84 MUSB_PORT_MODE_DUAL_ROLE,
87 /****************************** CONSTANTS ********************************/
89 #ifndef MUSB_C_NUM_EPS
90 #define MUSB_C_NUM_EPS ((u8)16)
93 #ifndef MUSB_MAX_END0_PACKET
94 #define MUSB_MAX_END0_PACKET ((u16)MUSB_EP0_FIFOSIZE)
97 /* host side ep0 states */
98 enum musb_h_ep0_state {
100 MUSB_EP0_START, /* expect ack of setup */
101 MUSB_EP0_IN, /* expect IN DATA */
102 MUSB_EP0_OUT, /* expect ack of OUT DATA */
103 MUSB_EP0_STATUS, /* expect ack of STATUS */
104 } __attribute__ ((packed));
106 /* peripheral side ep0 states */
107 enum musb_g_ep0_state {
108 MUSB_EP0_STAGE_IDLE, /* idle, waiting for SETUP */
109 MUSB_EP0_STAGE_SETUP, /* received SETUP */
110 MUSB_EP0_STAGE_TX, /* IN data */
111 MUSB_EP0_STAGE_RX, /* OUT data */
112 MUSB_EP0_STAGE_STATUSIN, /* (after OUT data) */
113 MUSB_EP0_STAGE_STATUSOUT, /* (after IN data) */
114 MUSB_EP0_STAGE_ACKWAIT, /* after zlp, before statusin */
115 } __attribute__ ((packed));
118 * OTG protocol constants. See USB OTG 1.3 spec,
119 * sections 5.5 "Device Timings" and 6.6.5 "Timers".
121 #define OTG_TIME_A_WAIT_VRISE 100 /* msec (max) */
122 #define OTG_TIME_A_WAIT_BCON 1100 /* min 1 second */
123 #define OTG_TIME_A_AIDL_BDIS 200 /* min 200 msec */
124 #define OTG_TIME_B_ASE0_BRST 100 /* min 3.125 ms */
126 /****************************** FUNCTIONS ********************************/
128 #define MUSB_HST_MODE(_musb)\
129 { (_musb)->is_host = true; }
130 #define MUSB_DEV_MODE(_musb) \
131 { (_musb)->is_host = false; }
133 #define test_devctl_hst_mode(_x) \
134 (musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM)
136 #define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral")
138 /******************************** TYPES *************************************/
143 * struct musb_platform_ops - Operations passed to musb_core by HW glue layer
144 * @quirks: flags for platform specific quirks
145 * @enable: enable device
146 * @disable: disable device
147 * @ep_offset: returns the end point offset
148 * @ep_select: selects the specified end point
149 * @fifo_mode: sets the fifo mode
150 * @fifo_offset: returns the fifo offset
151 * @readb: read 8 bits
152 * @writeb: write 8 bits
153 * @readw: read 16 bits
154 * @writew: write 16 bits
155 * @readl: read 32 bits
156 * @writel: write 32 bits
157 * @read_fifo: reads the fifo
158 * @write_fifo: writes to fifo
159 * @dma_init: platform specific dma init function
160 * @dma_exit: platform specific dma exit function
161 * @init: turns on clocks, sets up platform-specific registers, etc
162 * @exit: undoes @init
163 * @set_mode: forcefully changes operating mode
164 * @try_idle: tries to idle the IP
165 * @recover: platform-specific babble recovery
166 * @vbus_status: returns vbus status if possible
167 * @set_vbus: forces vbus status
168 * @adjust_channel_params: pre check for standard dma channel_program func
169 * @pre_root_reset_end: called before the root usb port reset flag gets cleared
170 * @post_root_reset_end: called after the root usb port reset flag gets cleared
171 * @phy_callback: optional callback function for the phy to call
173 struct musb_platform_ops {
175 #define MUSB_G_NO_SKB_RESERVE BIT(9)
176 #define MUSB_DA8XX BIT(8)
177 #define MUSB_PRESERVE_SESSION BIT(7)
178 #define MUSB_DMA_UX500 BIT(6)
179 #define MUSB_DMA_CPPI41 BIT(5)
180 #define MUSB_DMA_CPPI BIT(4)
181 #define MUSB_DMA_TUSB_OMAP BIT(3)
182 #define MUSB_DMA_INVENTRA BIT(2)
183 #define MUSB_IN_TUSB BIT(1)
184 #define MUSB_INDEXED_EP BIT(0)
187 int (*init)(struct musb *musb);
188 int (*exit)(struct musb *musb);
190 void (*enable)(struct musb *musb);
191 void (*disable)(struct musb *musb);
193 u32 (*ep_offset)(u8 epnum, u16 offset);
194 void (*ep_select)(void __iomem *mbase, u8 epnum);
196 u32 (*fifo_offset)(u8 epnum);
197 u32 (*busctl_offset)(u8 epnum, u16 offset);
198 u8 (*readb)(const void __iomem *addr, unsigned offset);
199 void (*writeb)(void __iomem *addr, unsigned offset, u8 data);
200 u16 (*readw)(const void __iomem *addr, unsigned offset);
201 void (*writew)(void __iomem *addr, unsigned offset, u16 data);
202 u32 (*readl)(const void __iomem *addr, unsigned offset);
203 void (*writel)(void __iomem *addr, unsigned offset, u32 data);
204 void (*read_fifo)(struct musb_hw_ep *hw_ep, u16 len, u8 *buf);
205 void (*write_fifo)(struct musb_hw_ep *hw_ep, u16 len, const u8 *buf);
206 struct dma_controller *
207 (*dma_init) (struct musb *musb, void __iomem *base);
208 void (*dma_exit)(struct dma_controller *c);
209 int (*set_mode)(struct musb *musb, u8 mode);
210 void (*try_idle)(struct musb *musb, unsigned long timeout);
211 int (*recover)(struct musb *musb);
213 int (*vbus_status)(struct musb *musb);
214 void (*set_vbus)(struct musb *musb, int on);
216 int (*adjust_channel_params)(struct dma_channel *channel,
217 u16 packet_sz, u8 *mode,
218 dma_addr_t *dma_addr, u32 *len);
219 void (*pre_root_reset_end)(struct musb *musb);
220 void (*post_root_reset_end)(struct musb *musb);
221 int (*phy_callback)(enum musb_vbus_id_status status);
222 void (*clear_ep_rxintr)(struct musb *musb, int epnum);
226 * struct musb_hw_ep - endpoint hardware (bidirectional)
228 * Ordered slightly for better cacheline locality.
235 #if IS_ENABLED(CONFIG_USB_MUSB_TUSB6010)
239 /* index in musb->endpoints[] */
242 /* hardware configuration, possibly dynamic */
244 bool tx_double_buffered;
245 bool rx_double_buffered;
246 u16 max_packet_sz_tx;
247 u16 max_packet_sz_rx;
249 struct dma_channel *tx_channel;
250 struct dma_channel *rx_channel;
252 #if IS_ENABLED(CONFIG_USB_MUSB_TUSB6010)
253 /* TUSB has "asynchronous" and "synchronous" dma modes */
254 dma_addr_t fifo_async;
255 dma_addr_t fifo_sync;
256 void __iomem *fifo_sync_va;
259 /* currently scheduled peripheral endpoint */
260 struct musb_qh *in_qh;
261 struct musb_qh *out_qh;
266 /* peripheral side */
267 struct musb_ep ep_in; /* TX */
268 struct musb_ep ep_out; /* RX */
271 static inline struct musb_request *next_in_request(struct musb_hw_ep *hw_ep)
273 return next_request(&hw_ep->ep_in);
276 static inline struct musb_request *next_out_request(struct musb_hw_ep *hw_ep)
278 return next_request(&hw_ep->ep_out);
281 struct musb_csr_regs {
283 u16 txmaxp, txcsr, rxmaxp, rxcsr;
284 u16 rxfifoadd, txfifoadd;
285 u8 txtype, txinterval, rxtype, rxinterval;
286 u8 rxfifosz, txfifosz;
287 u8 txfunaddr, txhubaddr, txhubport;
288 u8 rxfunaddr, rxhubaddr, rxhubport;
291 struct musb_context_registers {
298 u8 devctl, busctl, misc;
301 struct musb_csr_regs index_regs[MUSB_C_NUM_EPS];
305 * struct musb - Driver instance data.
310 spinlock_t list_lock; /* resume work list lock */
313 const struct musb_platform_ops *ops;
314 struct musb_context_registers context;
316 irqreturn_t (*isr)(int, void *);
317 struct delayed_work irq_work;
318 struct delayed_work deassert_reset_work;
319 struct delayed_work finish_resume_work;
320 struct delayed_work gadget_work;
325 /* this hub status bit is reserved by USB 2.0 and not seen by usbcore */
326 #define MUSB_PORT_STAT_RESUME (1 << 31)
330 unsigned long rh_timer;
332 enum musb_h_ep0_state ep0_stage;
334 /* bulk traffic normally dedicates endpoint hardware, and each
335 * direction has its own ring of host side endpoints.
336 * we try to progress the transfer at the head of each endpoint's
337 * queue until it completes or NAKs too much; then we try the next
340 struct musb_hw_ep *bulk_ep;
342 struct list_head control; /* of musb_qh */
343 struct list_head in_bulk; /* of musb_qh */
344 struct list_head out_bulk; /* of musb_qh */
345 struct list_head pending_list; /* pending work list */
347 struct timer_list otg_timer;
348 struct notifier_block nb;
350 struct dma_controller *dma_controller;
352 struct device *controller;
353 void __iomem *ctrl_base;
356 #if IS_ENABLED(CONFIG_USB_MUSB_TUSB6010)
359 void __iomem *sync_va;
363 /* passed down from chip/board specific irq handlers */
368 struct usb_phy *xceiv;
374 struct musb_hw_ep endpoints[MUSB_C_NUM_EPS];
375 #define control_ep endpoints
377 #define VBUSERR_RETRY_COUNT 3
382 int (*board_set_power)(int state);
384 u8 min_power; /* vbus for periph, in mA/2 */
386 int port_mode; /* MUSB_PORT_MODE_* */
388 unsigned long quirk_retries;
391 int a_wait_bcon; /* VBUS timeout in msecs */
392 unsigned long idle_timeout; /* Next timeout in jiffies */
394 unsigned is_initialized:1;
395 unsigned is_runtime_suspended:1;
397 /* active means connected and not suspended */
398 unsigned is_active:1;
400 unsigned is_multipoint:1;
402 unsigned hb_iso_rx:1; /* high bandwidth iso rx? */
403 unsigned hb_iso_tx:1; /* high bandwidth iso tx? */
404 unsigned dyn_fifo:1; /* dynamic FIFO supported? */
406 unsigned bulk_split:1;
407 #define can_bulk_split(musb,type) \
408 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split)
410 unsigned bulk_combine:1;
411 #define can_bulk_combine(musb,type) \
412 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine)
414 /* is_suspended means USB B_PERIPHERAL suspend */
415 unsigned is_suspended:1;
417 /* may_wakeup means remote wakeup is enabled */
418 unsigned may_wakeup:1;
420 /* is_self_powered is reported in device status and the
421 * config descriptor. is_bus_powered means B_PERIPHERAL
422 * draws some VBUS current; both can be true.
424 unsigned is_self_powered:1;
425 unsigned is_bus_powered:1;
427 unsigned set_address:1;
428 unsigned test_mode:1;
429 unsigned softconnect:1;
431 unsigned flush_irq_work: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 */
439 struct usb_hcd *hcd; /* the usb hcd */
442 * FIXME: Remove this flag.
444 * This is only added to allow Blackfin to work
445 * with current driver. For some unknown reason
446 * Blackfin doesn't work with double buffering
447 * and that's enabled by default.
449 * We added this flag to forcefully disable double
450 * buffering until we get it working.
452 unsigned double_buffer_not_ok:1;
454 const struct musb_hdrc_config *config;
457 #ifdef CONFIG_DEBUG_FS
458 struct dentry *debugfs_root;
462 /* This must be included after struct musb is defined */
463 #include "musb_regs.h"
465 static inline struct musb *gadget_to_musb(struct usb_gadget *g)
467 return container_of(g, struct musb, g);
470 static inline char *musb_ep_xfertype_string(u8 type)
475 case USB_ENDPOINT_XFER_CONTROL:
478 case USB_ENDPOINT_XFER_ISOC:
481 case USB_ENDPOINT_XFER_BULK:
484 case USB_ENDPOINT_XFER_INT:
494 #ifdef CONFIG_BLACKFIN
495 static inline int musb_read_fifosize(struct musb *musb,
496 struct musb_hw_ep *hw_ep, u8 epnum)
498 musb->nr_endpoints++;
499 musb->epmask |= (1 << epnum);
502 hw_ep->max_packet_sz_tx = 128;
503 hw_ep->max_packet_sz_rx = 128;
505 hw_ep->max_packet_sz_tx = 1024;
506 hw_ep->max_packet_sz_rx = 1024;
508 hw_ep->is_shared_fifo = false;
513 static inline void musb_configure_ep0(struct musb *musb)
515 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
516 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
517 musb->endpoints[0].is_shared_fifo = true;
522 static inline int musb_read_fifosize(struct musb *musb,
523 struct musb_hw_ep *hw_ep, u8 epnum)
525 void __iomem *mbase = musb->mregs;
528 /* read from core using indexed model */
529 reg = musb_readb(mbase, musb->io.ep_offset(epnum, MUSB_FIFOSIZE));
530 /* 0's returned when no more endpoints */
534 musb->nr_endpoints++;
535 musb->epmask |= (1 << epnum);
537 hw_ep->max_packet_sz_tx = 1 << (reg & 0x0f);
539 /* shared TX/RX FIFO? */
540 if ((reg & 0xf0) == 0xf0) {
541 hw_ep->max_packet_sz_rx = hw_ep->max_packet_sz_tx;
542 hw_ep->is_shared_fifo = true;
545 hw_ep->max_packet_sz_rx = 1 << ((reg & 0xf0) >> 4);
546 hw_ep->is_shared_fifo = false;
552 static inline void musb_configure_ep0(struct musb *musb)
554 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
555 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
556 musb->endpoints[0].is_shared_fifo = true;
558 #endif /* CONFIG_BLACKFIN */
561 /***************************** Glue it together *****************************/
563 extern const char musb_driver_name[];
565 extern void musb_stop(struct musb *musb);
566 extern void musb_start(struct musb *musb);
568 extern void musb_write_fifo(struct musb_hw_ep *ep, u16 len, const u8 *src);
569 extern void musb_read_fifo(struct musb_hw_ep *ep, u16 len, u8 *dst);
571 extern void musb_load_testpacket(struct musb *);
573 extern irqreturn_t musb_interrupt(struct musb *);
575 extern void musb_hnp_stop(struct musb *musb);
577 int musb_queue_resume_work(struct musb *musb,
578 int (*callback)(struct musb *musb, void *data),
581 static inline void musb_platform_set_vbus(struct musb *musb, int is_on)
583 if (musb->ops->set_vbus)
584 musb->ops->set_vbus(musb, is_on);
587 static inline void musb_platform_enable(struct musb *musb)
589 if (musb->ops->enable)
590 musb->ops->enable(musb);
593 static inline void musb_platform_disable(struct musb *musb)
595 if (musb->ops->disable)
596 musb->ops->disable(musb);
599 static inline int musb_platform_set_mode(struct musb *musb, u8 mode)
601 if (!musb->ops->set_mode)
604 return musb->ops->set_mode(musb, mode);
607 static inline void musb_platform_try_idle(struct musb *musb,
608 unsigned long timeout)
610 if (musb->ops->try_idle)
611 musb->ops->try_idle(musb, timeout);
614 static inline int musb_platform_recover(struct musb *musb)
616 if (!musb->ops->recover)
619 return musb->ops->recover(musb);
622 static inline int musb_platform_get_vbus_status(struct musb *musb)
624 if (!musb->ops->vbus_status)
627 return musb->ops->vbus_status(musb);
630 static inline int musb_platform_init(struct musb *musb)
632 if (!musb->ops->init)
635 return musb->ops->init(musb);
638 static inline int musb_platform_exit(struct musb *musb)
640 if (!musb->ops->exit)
643 return musb->ops->exit(musb);
646 static inline void musb_platform_pre_root_reset_end(struct musb *musb)
648 if (musb->ops->pre_root_reset_end)
649 musb->ops->pre_root_reset_end(musb);
652 static inline void musb_platform_post_root_reset_end(struct musb *musb)
654 if (musb->ops->post_root_reset_end)
655 musb->ops->post_root_reset_end(musb);
658 static inline void musb_platform_clear_ep_rxintr(struct musb *musb, int epnum)
660 if (musb->ops->clear_ep_rxintr)
661 musb->ops->clear_ep_rxintr(musb, epnum);
665 * gets the "dr_mode" property from DT and converts it into musb_mode
666 * if the property is not found or not recognized returns MUSB_OTG
668 extern enum musb_mode musb_get_mode(struct device *dev);
670 #endif /* __MUSB_CORE_H__ */