]> git.ipfire.org Git - people/ms/u-boot.git/blob - drivers/usb/musb-new/musb_core.h
Merge git://git.denx.de/u-boot-usb
[people/ms/u-boot.git] / drivers / usb / musb-new / musb_core.h
1 /*
2 * MUSB OTG driver defines
3 *
4 * Copyright 2005 Mentor Graphics Corporation
5 * Copyright (C) 2005-2006 by Texas Instruments
6 * Copyright (C) 2006-2007 Nokia Corporation
7 *
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.
11 *
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.
16 *
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
20 * 02110-1301 USA
21 *
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.
32 *
33 */
34
35 #ifndef __MUSB_CORE_H__
36 #define __MUSB_CORE_H__
37
38 #ifndef __UBOOT__
39 #include <linux/slab.h>
40 #include <linux/list.h>
41 #include <linux/interrupt.h>
42 #include <linux/errno.h>
43 #include <linux/timer.h>
44 #include <linux/device.h>
45 #include <linux/usb.h>
46 #include <linux/usb/otg.h>
47 #else
48 #include <asm/errno.h>
49 #endif
50 #include <linux/usb/ch9.h>
51 #include <linux/usb/gadget.h>
52 #include <linux/usb/musb.h>
53
54 struct musb;
55 struct musb_hw_ep;
56 struct musb_ep;
57
58 /* Helper defines for struct musb->hwvers */
59 #define MUSB_HWVERS_MAJOR(x) ((x >> 10) & 0x1f)
60 #define MUSB_HWVERS_MINOR(x) (x & 0x3ff)
61 #define MUSB_HWVERS_RC 0x8000
62 #define MUSB_HWVERS_1300 0x52C
63 #define MUSB_HWVERS_1400 0x590
64 #define MUSB_HWVERS_1800 0x720
65 #define MUSB_HWVERS_1900 0x784
66 #define MUSB_HWVERS_2000 0x800
67
68 #include "musb_debug.h"
69 #include "musb_dma.h"
70
71 #include "musb_io.h"
72 #include "musb_regs.h"
73
74 #include "musb_gadget.h"
75 #ifndef __UBOOT__
76 #include <linux/usb/hcd.h>
77 #endif
78 #include "musb_host.h"
79
80 #define is_peripheral_enabled(musb) ((musb)->board_mode != MUSB_HOST)
81 #define is_host_enabled(musb) ((musb)->board_mode != MUSB_PERIPHERAL)
82 #define is_otg_enabled(musb) ((musb)->board_mode == MUSB_OTG)
83
84 /* NOTE: otg and peripheral-only state machines start at B_IDLE.
85 * OTG or host-only go to A_IDLE when ID is sensed.
86 */
87 #define is_peripheral_active(m) (!(m)->is_host)
88 #define is_host_active(m) ((m)->is_host)
89
90 #ifdef CONFIG_PROC_FS
91 #include <linux/fs.h>
92 #define MUSB_CONFIG_PROC_FS
93 #endif
94
95 /****************************** PERIPHERAL ROLE *****************************/
96
97 #ifndef __UBOOT__
98 #define is_peripheral_capable() (1)
99 #else
100 #ifdef CONFIG_MUSB_GADGET
101 #define is_peripheral_capable() (1)
102 #else
103 #define is_peripheral_capable() (0)
104 #endif
105 #endif
106
107 extern irqreturn_t musb_g_ep0_irq(struct musb *);
108 extern void musb_g_tx(struct musb *, u8);
109 extern void musb_g_rx(struct musb *, u8);
110 extern void musb_g_reset(struct musb *);
111 extern void musb_g_suspend(struct musb *);
112 extern void musb_g_resume(struct musb *);
113 extern void musb_g_wakeup(struct musb *);
114 extern void musb_g_disconnect(struct musb *);
115
116 /****************************** HOST ROLE ***********************************/
117
118 #ifndef __UBOOT__
119 #define is_host_capable() (1)
120 #else
121 #ifdef CONFIG_MUSB_HOST
122 #define is_host_capable() (1)
123 #else
124 #define is_host_capable() (0)
125 #endif
126 #endif
127
128 extern irqreturn_t musb_h_ep0_irq(struct musb *);
129 extern void musb_host_tx(struct musb *, u8);
130 extern void musb_host_rx(struct musb *, u8);
131
132 /****************************** CONSTANTS ********************************/
133
134 #ifndef MUSB_C_NUM_EPS
135 #define MUSB_C_NUM_EPS ((u8)16)
136 #endif
137
138 #ifndef MUSB_MAX_END0_PACKET
139 #define MUSB_MAX_END0_PACKET ((u16)MUSB_EP0_FIFOSIZE)
140 #endif
141
142 /* host side ep0 states */
143 enum musb_h_ep0_state {
144 MUSB_EP0_IDLE,
145 MUSB_EP0_START, /* expect ack of setup */
146 MUSB_EP0_IN, /* expect IN DATA */
147 MUSB_EP0_OUT, /* expect ack of OUT DATA */
148 MUSB_EP0_STATUS, /* expect ack of STATUS */
149 } __attribute__ ((packed));
150
151 /* peripheral side ep0 states */
152 enum musb_g_ep0_state {
153 MUSB_EP0_STAGE_IDLE, /* idle, waiting for SETUP */
154 MUSB_EP0_STAGE_SETUP, /* received SETUP */
155 MUSB_EP0_STAGE_TX, /* IN data */
156 MUSB_EP0_STAGE_RX, /* OUT data */
157 MUSB_EP0_STAGE_STATUSIN, /* (after OUT data) */
158 MUSB_EP0_STAGE_STATUSOUT, /* (after IN data) */
159 MUSB_EP0_STAGE_ACKWAIT, /* after zlp, before statusin */
160 } __attribute__ ((packed));
161
162 /*
163 * OTG protocol constants. See USB OTG 1.3 spec,
164 * sections 5.5 "Device Timings" and 6.6.5 "Timers".
165 */
166 #define OTG_TIME_A_WAIT_VRISE 100 /* msec (max) */
167 #define OTG_TIME_A_WAIT_BCON 1100 /* min 1 second */
168 #define OTG_TIME_A_AIDL_BDIS 200 /* min 200 msec */
169 #define OTG_TIME_B_ASE0_BRST 100 /* min 3.125 ms */
170
171
172 /*************************** REGISTER ACCESS ********************************/
173
174 /* Endpoint registers (other than dynfifo setup) can be accessed either
175 * directly with the "flat" model, or after setting up an index register.
176 */
177
178 #if defined(CONFIG_ARCH_DAVINCI) || defined(CONFIG_SOC_OMAP2430) \
179 || defined(CONFIG_SOC_OMAP3430) || defined(CONFIG_BLACKFIN) \
180 || defined(CONFIG_ARCH_OMAP4)
181 /* REVISIT indexed access seemed to
182 * misbehave (on DaVinci) for at least peripheral IN ...
183 */
184 #define MUSB_FLAT_REG
185 #endif
186
187 /* TUSB mapping: "flat" plus ep0 special cases */
188 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
189 defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
190 #define musb_ep_select(_mbase, _epnum) \
191 musb_writeb((_mbase), MUSB_INDEX, (_epnum))
192 #define MUSB_EP_OFFSET MUSB_TUSB_OFFSET
193
194 /* "flat" mapping: each endpoint has its own i/o address */
195 #elif defined(MUSB_FLAT_REG)
196 #define musb_ep_select(_mbase, _epnum) (((void)(_mbase)), ((void)(_epnum)))
197 #define MUSB_EP_OFFSET MUSB_FLAT_OFFSET
198
199 /* "indexed" mapping: INDEX register controls register bank select */
200 #else
201 #define musb_ep_select(_mbase, _epnum) \
202 musb_writeb((_mbase), MUSB_INDEX, (_epnum))
203 #define MUSB_EP_OFFSET MUSB_INDEXED_OFFSET
204 #endif
205
206 /****************************** FUNCTIONS ********************************/
207
208 #define MUSB_HST_MODE(_musb)\
209 { (_musb)->is_host = true; }
210 #define MUSB_DEV_MODE(_musb) \
211 { (_musb)->is_host = false; }
212
213 #define test_devctl_hst_mode(_x) \
214 (musb_readb((_x)->mregs, MUSB_DEVCTL)&MUSB_DEVCTL_HM)
215
216 #define MUSB_MODE(musb) ((musb)->is_host ? "Host" : "Peripheral")
217
218 /******************************** TYPES *************************************/
219
220 /**
221 * struct musb_platform_ops - Operations passed to musb_core by HW glue layer
222 * @init: turns on clocks, sets up platform-specific registers, etc
223 * @exit: undoes @init
224 * @set_mode: forcefully changes operating mode
225 * @try_ilde: tries to idle the IP
226 * @vbus_status: returns vbus status if possible
227 * @set_vbus: forces vbus status
228 * @adjust_channel_params: pre check for standard dma channel_program func
229 */
230 struct musb_platform_ops {
231 int (*init)(struct musb *musb);
232 int (*exit)(struct musb *musb);
233
234 #ifndef __UBOOT__
235 void (*enable)(struct musb *musb);
236 #else
237 int (*enable)(struct musb *musb);
238 #endif
239 void (*disable)(struct musb *musb);
240
241 int (*set_mode)(struct musb *musb, u8 mode);
242 void (*try_idle)(struct musb *musb, unsigned long timeout);
243
244 int (*vbus_status)(struct musb *musb);
245 void (*set_vbus)(struct musb *musb, int on);
246
247 int (*adjust_channel_params)(struct dma_channel *channel,
248 u16 packet_sz, u8 *mode,
249 dma_addr_t *dma_addr, u32 *len);
250 };
251
252 /*
253 * struct musb_hw_ep - endpoint hardware (bidirectional)
254 *
255 * Ordered slightly for better cacheline locality.
256 */
257 struct musb_hw_ep {
258 struct musb *musb;
259 void __iomem *fifo;
260 void __iomem *regs;
261
262 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
263 defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
264 void __iomem *conf;
265 #endif
266
267 /* index in musb->endpoints[] */
268 u8 epnum;
269
270 /* hardware configuration, possibly dynamic */
271 bool is_shared_fifo;
272 bool tx_double_buffered;
273 bool rx_double_buffered;
274 u16 max_packet_sz_tx;
275 u16 max_packet_sz_rx;
276
277 struct dma_channel *tx_channel;
278 struct dma_channel *rx_channel;
279
280 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
281 defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
282 /* TUSB has "asynchronous" and "synchronous" dma modes */
283 dma_addr_t fifo_async;
284 dma_addr_t fifo_sync;
285 void __iomem *fifo_sync_va;
286 #endif
287
288 void __iomem *target_regs;
289
290 /* currently scheduled peripheral endpoint */
291 struct musb_qh *in_qh;
292 struct musb_qh *out_qh;
293
294 u8 rx_reinit;
295 u8 tx_reinit;
296
297 /* peripheral side */
298 struct musb_ep ep_in; /* TX */
299 struct musb_ep ep_out; /* RX */
300 };
301
302 static inline struct musb_request *next_in_request(struct musb_hw_ep *hw_ep)
303 {
304 return next_request(&hw_ep->ep_in);
305 }
306
307 static inline struct musb_request *next_out_request(struct musb_hw_ep *hw_ep)
308 {
309 return next_request(&hw_ep->ep_out);
310 }
311
312 struct musb_csr_regs {
313 /* FIFO registers */
314 u16 txmaxp, txcsr, rxmaxp, rxcsr;
315 u16 rxfifoadd, txfifoadd;
316 u8 txtype, txinterval, rxtype, rxinterval;
317 u8 rxfifosz, txfifosz;
318 u8 txfunaddr, txhubaddr, txhubport;
319 u8 rxfunaddr, rxhubaddr, rxhubport;
320 };
321
322 struct musb_context_registers {
323
324 u8 power;
325 u16 intrtxe, intrrxe;
326 u8 intrusbe;
327 u16 frame;
328 u8 index, testmode;
329
330 u8 devctl, busctl, misc;
331 u32 otg_interfsel;
332
333 struct musb_csr_regs index_regs[MUSB_C_NUM_EPS];
334 };
335
336 /*
337 * struct musb - Driver instance data.
338 */
339 struct musb {
340 /* device lock */
341 spinlock_t lock;
342
343 const struct musb_platform_ops *ops;
344 struct musb_context_registers context;
345
346 irqreturn_t (*isr)(int, void *);
347 struct work_struct irq_work;
348 u16 hwvers;
349
350 /* this hub status bit is reserved by USB 2.0 and not seen by usbcore */
351 #define MUSB_PORT_STAT_RESUME (1 << 31)
352
353 u32 port1_status;
354
355 unsigned long rh_timer;
356
357 enum musb_h_ep0_state ep0_stage;
358
359 /* bulk traffic normally dedicates endpoint hardware, and each
360 * direction has its own ring of host side endpoints.
361 * we try to progress the transfer at the head of each endpoint's
362 * queue until it completes or NAKs too much; then we try the next
363 * endpoint.
364 */
365 struct musb_hw_ep *bulk_ep;
366
367 struct list_head control; /* of musb_qh */
368 struct list_head in_bulk; /* of musb_qh */
369 struct list_head out_bulk; /* of musb_qh */
370
371 struct timer_list otg_timer;
372 struct notifier_block nb;
373
374 struct dma_controller *dma_controller;
375
376 struct device *controller;
377 void __iomem *ctrl_base;
378 void __iomem *mregs;
379
380 #if defined(CONFIG_USB_MUSB_TUSB6010) || \
381 defined(CONFIG_USB_MUSB_TUSB6010_MODULE)
382 dma_addr_t async;
383 dma_addr_t sync;
384 void __iomem *sync_va;
385 #endif
386
387 /* passed down from chip/board specific irq handlers */
388 u8 int_usb;
389 u16 int_rx;
390 u16 int_tx;
391
392 struct usb_phy *xceiv;
393
394 int nIrq;
395 unsigned irq_wake:1;
396
397 struct musb_hw_ep endpoints[MUSB_C_NUM_EPS];
398 #define control_ep endpoints
399
400 #define VBUSERR_RETRY_COUNT 3
401 u16 vbuserr_retry;
402 u16 epmask;
403 u8 nr_endpoints;
404
405 u8 board_mode; /* enum musb_mode */
406 int (*board_set_power)(int state);
407
408 u8 min_power; /* vbus for periph, in mA/2 */
409
410 bool is_host;
411
412 int a_wait_bcon; /* VBUS timeout in msecs */
413 unsigned long idle_timeout; /* Next timeout in jiffies */
414
415 /* active means connected and not suspended */
416 unsigned is_active:1;
417
418 unsigned is_multipoint:1;
419 unsigned ignore_disconnect:1; /* during bus resets */
420
421 unsigned hb_iso_rx:1; /* high bandwidth iso rx? */
422 unsigned hb_iso_tx:1; /* high bandwidth iso tx? */
423 unsigned dyn_fifo:1; /* dynamic FIFO supported? */
424
425 unsigned bulk_split:1;
426 #define can_bulk_split(musb,type) \
427 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_split)
428
429 unsigned bulk_combine:1;
430 #define can_bulk_combine(musb,type) \
431 (((type) == USB_ENDPOINT_XFER_BULK) && (musb)->bulk_combine)
432
433 /* is_suspended means USB B_PERIPHERAL suspend */
434 unsigned is_suspended:1;
435
436 /* may_wakeup means remote wakeup is enabled */
437 unsigned may_wakeup:1;
438
439 /* is_self_powered is reported in device status and the
440 * config descriptor. is_bus_powered means B_PERIPHERAL
441 * draws some VBUS current; both can be true.
442 */
443 unsigned is_self_powered:1;
444 unsigned is_bus_powered:1;
445
446 unsigned set_address:1;
447 unsigned test_mode:1;
448 unsigned softconnect:1;
449
450 u8 address;
451 u8 test_mode_nr;
452 u16 ackpend; /* ep0 */
453 enum musb_g_ep0_state ep0_state;
454 struct usb_gadget g; /* the gadget */
455 struct usb_gadget_driver *gadget_driver; /* its driver */
456
457 /*
458 * FIXME: Remove this flag.
459 *
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.
464 *
465 * We added this flag to forcefully disable double
466 * buffering until we get it working.
467 */
468 unsigned double_buffer_not_ok:1;
469
470 struct musb_hdrc_config *config;
471
472 #ifdef MUSB_CONFIG_PROC_FS
473 struct proc_dir_entry *proc_entry;
474 #endif
475 };
476
477 static inline struct musb *gadget_to_musb(struct usb_gadget *g)
478 {
479 return container_of(g, struct musb, g);
480 }
481
482 #ifdef CONFIG_BLACKFIN
483 static inline int musb_read_fifosize(struct musb *musb,
484 struct musb_hw_ep *hw_ep, u8 epnum)
485 {
486 musb->nr_endpoints++;
487 musb->epmask |= (1 << epnum);
488
489 if (epnum < 5) {
490 hw_ep->max_packet_sz_tx = 128;
491 hw_ep->max_packet_sz_rx = 128;
492 } else {
493 hw_ep->max_packet_sz_tx = 1024;
494 hw_ep->max_packet_sz_rx = 1024;
495 }
496 hw_ep->is_shared_fifo = false;
497
498 return 0;
499 }
500
501 static inline void musb_configure_ep0(struct musb *musb)
502 {
503 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
504 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
505 musb->endpoints[0].is_shared_fifo = true;
506 }
507
508 #else
509
510 static inline int musb_read_fifosize(struct musb *musb,
511 struct musb_hw_ep *hw_ep, u8 epnum)
512 {
513 void *mbase = musb->mregs;
514 u8 reg = 0;
515
516 /* read from core using indexed model */
517 reg = musb_readb(mbase, MUSB_EP_OFFSET(epnum, MUSB_FIFOSIZE));
518 /* 0's returned when no more endpoints */
519 if (!reg)
520 return -ENODEV;
521
522 musb->nr_endpoints++;
523 musb->epmask |= (1 << epnum);
524
525 hw_ep->max_packet_sz_tx = 1 << (reg & 0x0f);
526
527 /* shared TX/RX FIFO? */
528 if ((reg & 0xf0) == 0xf0) {
529 hw_ep->max_packet_sz_rx = hw_ep->max_packet_sz_tx;
530 hw_ep->is_shared_fifo = true;
531 return 0;
532 } else {
533 hw_ep->max_packet_sz_rx = 1 << ((reg & 0xf0) >> 4);
534 hw_ep->is_shared_fifo = false;
535 }
536
537 return 0;
538 }
539
540 static inline void musb_configure_ep0(struct musb *musb)
541 {
542 musb->endpoints[0].max_packet_sz_tx = MUSB_EP0_FIFOSIZE;
543 musb->endpoints[0].max_packet_sz_rx = MUSB_EP0_FIFOSIZE;
544 musb->endpoints[0].is_shared_fifo = true;
545 }
546 #endif /* CONFIG_BLACKFIN */
547
548
549 /***************************** Glue it together *****************************/
550
551 extern const char musb_driver_name[];
552
553 #ifndef __UBOOT__
554 extern void musb_start(struct musb *musb);
555 #else
556 extern int musb_start(struct musb *musb);
557 #endif
558 extern void musb_stop(struct musb *musb);
559
560 extern void musb_write_fifo(struct musb_hw_ep *ep, u16 len, const u8 *src);
561 extern void musb_read_fifo(struct musb_hw_ep *ep, u16 len, u8 *dst);
562
563 extern void musb_load_testpacket(struct musb *);
564
565 extern irqreturn_t musb_interrupt(struct musb *);
566
567 extern void musb_hnp_stop(struct musb *musb);
568
569 static inline void musb_platform_set_vbus(struct musb *musb, int is_on)
570 {
571 if (musb->ops->set_vbus)
572 musb->ops->set_vbus(musb, is_on);
573 }
574
575 #ifndef __UBOOT__
576 static inline void musb_platform_enable(struct musb *musb)
577 {
578 if (musb->ops->enable)
579 musb->ops->enable(musb);
580 }
581 #else
582 static inline int musb_platform_enable(struct musb *musb)
583 {
584 if (!musb->ops->enable)
585 return 0;
586
587 return musb->ops->enable(musb);
588 }
589 #endif
590
591 static inline void musb_platform_disable(struct musb *musb)
592 {
593 if (musb->ops->disable)
594 musb->ops->disable(musb);
595 }
596
597 static inline int musb_platform_set_mode(struct musb *musb, u8 mode)
598 {
599 if (!musb->ops->set_mode)
600 return 0;
601
602 return musb->ops->set_mode(musb, mode);
603 }
604
605 static inline void musb_platform_try_idle(struct musb *musb,
606 unsigned long timeout)
607 {
608 if (musb->ops->try_idle)
609 musb->ops->try_idle(musb, timeout);
610 }
611
612 static inline int musb_platform_get_vbus_status(struct musb *musb)
613 {
614 if (!musb->ops->vbus_status)
615 return 0;
616
617 return musb->ops->vbus_status(musb);
618 }
619
620 static inline int musb_platform_init(struct musb *musb)
621 {
622 if (!musb->ops->init)
623 return -EINVAL;
624
625 return musb->ops->init(musb);
626 }
627
628 static inline int musb_platform_exit(struct musb *musb)
629 {
630 if (!musb->ops->exit)
631 return -EINVAL;
632
633 return musb->ops->exit(musb);
634 }
635
636 #ifdef __UBOOT__
637 struct musb *
638 musb_init_controller(struct musb_hdrc_platform_data *plat, struct device *dev,
639 void *ctrl);
640 #endif
641 #endif /* __MUSB_CORE_H__ */