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 */
127 /****************************** FUNCTIONS ********************************/
129 #define MUSB_HST_MODE(_musb)\
130 { (_musb)->is_host = true; }
131 #define MUSB_DEV_MODE(_musb) \
132 { (_musb)->is_host = false; }
134 #define test_devctl_hst_mode(_x) \
135 (musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM)
137 #define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral")
139 /******************************** TYPES *************************************/
144 * struct musb_platform_ops - Operations passed to musb_core by HW glue layer
145 * @quirks: flags for platform specific quirks
146 * @enable: enable device
147 * @disable: disable device
148 * @ep_offset: returns the end point offset
149 * @ep_select: selects the specified end point
150 * @fifo_mode: sets the fifo mode
151 * @fifo_offset: returns the fifo offset
152 * @readb: read 8 bits
153 * @writeb: write 8 bits
154 * @readw: read 16 bits
155 * @writew: write 16 bits
156 * @readl: read 32 bits
157 * @writel: write 32 bits
158 * @read_fifo: reads the fifo
159 * @write_fifo: writes to fifo
160 * @init: turns on clocks, sets up platform-specific registers, etc
161 * @exit: undoes @init
162 * @set_mode: forcefully changes operating mode
163 * @try_idle: tries to idle the IP
164 * @recover: platform-specific babble recovery
165 * @vbus_status: returns vbus status if possible
166 * @set_vbus: forces vbus status
167 * @adjust_channel_params: pre check for standard dma channel_program func
169 struct musb_platform_ops {
171 #define MUSB_DMA_UX500 BIT(6)
172 #define MUSB_DMA_CPPI41 BIT(5)
173 #define MUSB_DMA_CPPI BIT(4)
174 #define MUSB_DMA_TUSB_OMAP BIT(3)
175 #define MUSB_DMA_INVENTRA BIT(2)
176 #define MUSB_IN_TUSB BIT(1)
177 #define MUSB_INDEXED_EP BIT(0)
180 int (*init)(struct musb *musb);
181 int (*exit)(struct musb *musb);
183 void (*enable)(struct musb *musb);
184 void (*disable)(struct musb *musb);
186 u32 (*ep_offset)(u8 epnum, u16 offset);
187 void (*ep_select)(void __iomem *mbase, u8 epnum);
189 u32 (*fifo_offset)(u8 epnum);
190 u8 (*readb)(const void __iomem *addr, unsigned offset);
191 void (*writeb)(void __iomem *addr, unsigned offset, u8 data);
192 u16 (*readw)(const void __iomem *addr, unsigned offset);
193 void (*writew)(void __iomem *addr, unsigned offset, u16 data);
194 u32 (*readl)(const void __iomem *addr, unsigned offset);
195 void (*writel)(void __iomem *addr, unsigned offset, u32 data);
196 void (*read_fifo)(struct musb_hw_ep *hw_ep, u16 len, u8 *buf);
197 void (*write_fifo)(struct musb_hw_ep *hw_ep, u16 len, const u8 *buf);
198 int (*set_mode)(struct musb *musb, u8 mode);
199 void (*try_idle)(struct musb *musb, unsigned long timeout);
200 int (*recover)(struct musb *musb);
202 int (*vbus_status)(struct musb *musb);
203 void (*set_vbus)(struct musb *musb, int on);
205 int (*adjust_channel_params)(struct dma_channel *channel,
206 u16 packet_sz, u8 *mode,
207 dma_addr_t *dma_addr, u32 *len);
211 * struct musb_hw_ep - endpoint hardware (bidirectional)
213 * Ordered slightly for better cacheline locality.
220 #if IS_ENABLED(CONFIG_USB_MUSB_TUSB6010)
224 /* index in musb->endpoints[] */
227 /* hardware configuration, possibly dynamic */
229 bool tx_double_buffered;
230 bool rx_double_buffered;
231 u16 max_packet_sz_tx;
232 u16 max_packet_sz_rx;
234 struct dma_channel *tx_channel;
235 struct dma_channel *rx_channel;
237 #if IS_ENABLED(CONFIG_USB_MUSB_TUSB6010)
238 /* TUSB has "asynchronous" and "synchronous" dma modes */
239 dma_addr_t fifo_async;
240 dma_addr_t fifo_sync;
241 void __iomem *fifo_sync_va;
244 void __iomem *target_regs;
246 /* currently scheduled peripheral endpoint */
247 struct musb_qh *in_qh;
248 struct musb_qh *out_qh;
253 /* peripheral side */
254 struct musb_ep ep_in; /* TX */
255 struct musb_ep ep_out; /* RX */
258 static inline struct musb_request *next_in_request(struct musb_hw_ep *hw_ep)
260 return next_request(&hw_ep->ep_in);
263 static inline struct musb_request *next_out_request(struct musb_hw_ep *hw_ep)
265 return next_request(&hw_ep->ep_out);
268 struct musb_csr_regs {
270 u16 txmaxp, txcsr, rxmaxp, rxcsr;
271 u16 rxfifoadd, txfifoadd;
272 u8 txtype, txinterval, rxtype, rxinterval;
273 u8 rxfifosz, txfifosz;
274 u8 txfunaddr, txhubaddr, txhubport;
275 u8 rxfunaddr, rxhubaddr, rxhubport;
278 struct musb_context_registers {
285 u8 devctl, busctl, misc;
288 struct musb_csr_regs index_regs[MUSB_C_NUM_EPS];
292 * struct musb - Driver instance data.
299 const struct musb_platform_ops *ops;
300 struct musb_context_registers context;
302 irqreturn_t (*isr)(int, void *);
303 struct work_struct irq_work;
304 struct delayed_work recover_work;
305 struct delayed_work deassert_reset_work;
306 struct delayed_work finish_resume_work;
311 /* this hub status bit is reserved by USB 2.0 and not seen by usbcore */
312 #define MUSB_PORT_STAT_RESUME (1 << 31)
316 unsigned long rh_timer;
318 enum musb_h_ep0_state ep0_stage;
320 /* bulk traffic normally dedicates endpoint hardware, and each
321 * direction has its own ring of host side endpoints.
322 * we try to progress the transfer at the head of each endpoint's
323 * queue until it completes or NAKs too much; then we try the next
326 struct musb_hw_ep *bulk_ep;
328 struct list_head control; /* of musb_qh */
329 struct list_head in_bulk; /* of musb_qh */
330 struct list_head out_bulk; /* of musb_qh */
332 struct timer_list otg_timer;
333 struct notifier_block nb;
335 struct dma_controller *dma_controller;
337 struct device *controller;
338 void __iomem *ctrl_base;
341 #if IS_ENABLED(CONFIG_USB_MUSB_TUSB6010)
344 void __iomem *sync_va;
348 /* passed down from chip/board specific irq handlers */
353 struct usb_phy *xceiv;
359 struct musb_hw_ep endpoints[MUSB_C_NUM_EPS];
360 #define control_ep endpoints
362 #define VBUSERR_RETRY_COUNT 3
367 int (*board_set_power)(int state);
369 u8 min_power; /* vbus for periph, in mA/2 */
371 int port_mode; /* MUSB_PORT_MODE_* */
374 int a_wait_bcon; /* VBUS timeout in msecs */
375 unsigned long idle_timeout; /* Next timeout in jiffies */
377 /* active means connected and not suspended */
378 unsigned is_active:1;
380 unsigned is_multipoint:1;
382 unsigned hb_iso_rx:1; /* high bandwidth iso rx? */
383 unsigned hb_iso_tx:1; /* high bandwidth iso tx? */
384 unsigned dyn_fifo:1; /* dynamic FIFO supported? */
386 unsigned bulk_split:1;
387 #define can_bulk_split(musb,type) \
388 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split)
390 unsigned bulk_combine:1;
391 #define can_bulk_combine(musb,type) \
392 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine)
394 /* is_suspended means USB B_PERIPHERAL suspend */
395 unsigned is_suspended:1;
396 unsigned need_finish_resume :1;
398 /* may_wakeup means remote wakeup is enabled */
399 unsigned may_wakeup:1;
401 /* is_self_powered is reported in device status and the
402 * config descriptor. is_bus_powered means B_PERIPHERAL
403 * draws some VBUS current; both can be true.
405 unsigned is_self_powered:1;
406 unsigned is_bus_powered:1;
408 unsigned set_address:1;
409 unsigned test_mode:1;
410 unsigned softconnect:1;
414 u16 ackpend; /* ep0 */
415 enum musb_g_ep0_state ep0_state;
416 struct usb_gadget g; /* the gadget */
417 struct usb_gadget_driver *gadget_driver; /* its driver */
418 struct usb_hcd *hcd; /* the usb hcd */
421 * FIXME: Remove this flag.
423 * This is only added to allow Blackfin to work
424 * with current driver. For some unknown reason
425 * Blackfin doesn't work with double buffering
426 * and that's enabled by default.
428 * We added this flag to forcefully disable double
429 * buffering until we get it working.
431 unsigned double_buffer_not_ok:1;
433 struct musb_hdrc_config *config;
436 #ifdef CONFIG_DEBUG_FS
437 struct dentry *debugfs_root;
441 static inline struct musb *gadget_to_musb(struct usb_gadget *g)
443 return container_of(g, struct musb, g);
446 #ifdef CONFIG_BLACKFIN
447 static inline int musb_read_fifosize(struct musb *musb,
448 struct musb_hw_ep *hw_ep, u8 epnum)
450 musb->nr_endpoints++;
451 musb->epmask |= (1 << epnum);
454 hw_ep->max_packet_sz_tx = 128;
455 hw_ep->max_packet_sz_rx = 128;
457 hw_ep->max_packet_sz_tx = 1024;
458 hw_ep->max_packet_sz_rx = 1024;
460 hw_ep->is_shared_fifo = false;
465 static inline void musb_configure_ep0(struct musb *musb)
467 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
468 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
469 musb->endpoints[0].is_shared_fifo = true;
474 static inline int musb_read_fifosize(struct musb *musb,
475 struct musb_hw_ep *hw_ep, u8 epnum)
477 void __iomem *mbase = musb->mregs;
480 /* read from core using indexed model */
481 reg = musb_readb(mbase, musb->io.ep_offset(epnum, MUSB_FIFOSIZE));
482 /* 0's returned when no more endpoints */
486 musb->nr_endpoints++;
487 musb->epmask |= (1 << epnum);
489 hw_ep->max_packet_sz_tx = 1 << (reg & 0x0f);
491 /* shared TX/RX FIFO? */
492 if ((reg & 0xf0) == 0xf0) {
493 hw_ep->max_packet_sz_rx = hw_ep->max_packet_sz_tx;
494 hw_ep->is_shared_fifo = true;
497 hw_ep->max_packet_sz_rx = 1 << ((reg & 0xf0) >> 4);
498 hw_ep->is_shared_fifo = false;
504 static inline void musb_configure_ep0(struct musb *musb)
506 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
507 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
508 musb->endpoints[0].is_shared_fifo = true;
510 #endif /* CONFIG_BLACKFIN */
513 /***************************** Glue it together *****************************/
515 extern const char musb_driver_name[];
517 extern void musb_stop(struct musb *musb);
518 extern void musb_start(struct musb *musb);
520 extern void musb_write_fifo(struct musb_hw_ep *ep, u16 len, const u8 *src);
521 extern void musb_read_fifo(struct musb_hw_ep *ep, u16 len, u8 *dst);
523 extern void musb_load_testpacket(struct musb *);
525 extern irqreturn_t musb_interrupt(struct musb *);
527 extern void musb_hnp_stop(struct musb *musb);
529 static inline void musb_platform_set_vbus(struct musb *musb, int is_on)
531 if (musb->ops->set_vbus)
532 musb->ops->set_vbus(musb, is_on);
535 static inline void musb_platform_enable(struct musb *musb)
537 if (musb->ops->enable)
538 musb->ops->enable(musb);
541 static inline void musb_platform_disable(struct musb *musb)
543 if (musb->ops->disable)
544 musb->ops->disable(musb);
547 static inline int musb_platform_set_mode(struct musb *musb, u8 mode)
549 if (!musb->ops->set_mode)
552 return musb->ops->set_mode(musb, mode);
555 static inline void musb_platform_try_idle(struct musb *musb,
556 unsigned long timeout)
558 if (musb->ops->try_idle)
559 musb->ops->try_idle(musb, timeout);
562 static inline int musb_platform_recover(struct musb *musb)
564 if (!musb->ops->recover)
567 return musb->ops->recover(musb);
570 static inline int musb_platform_get_vbus_status(struct musb *musb)
572 if (!musb->ops->vbus_status)
575 return musb->ops->vbus_status(musb);
578 static inline int musb_platform_init(struct musb *musb)
580 if (!musb->ops->init)
583 return musb->ops->init(musb);
586 static inline int musb_platform_exit(struct musb *musb)
588 if (!musb->ops->exit)
591 return musb->ops->exit(musb);
594 #endif /* __MUSB_CORE_H__ */