2 * MUSB OTG controller driver for Blackfin Processors
4 * Copyright 2006-2008 Analog Devices Inc.
6 * Enter bugs at http://blackfin.uclinux.org/
8 * Licensed under the GPL-2 or later.
11 #include <linux/module.h>
12 #include <linux/kernel.h>
13 #include <linux/sched.h>
14 #include <linux/list.h>
15 #include <linux/gpio.h>
17 #include <linux/err.h>
18 #include <linux/platform_device.h>
19 #include <linux/dma-mapping.h>
20 #include <linux/prefetch.h>
21 #include <linux/usb/usb_phy_generic.h>
23 #include <asm/cacheflush.h>
25 #include "musb_core.h"
26 #include "musbhsdma.h"
31 struct platform_device
*musb
;
32 struct platform_device
*phy
;
34 #define glue_to_musb(g) platform_get_drvdata(g->musb)
36 static u32
bfin_fifo_offset(u8 epnum
)
38 return USB_OFFSET(USB_EP0_FIFO
) + (epnum
* 8);
41 static u8
bfin_readb(const void __iomem
*addr
, unsigned offset
)
43 return (u8
)(bfin_read16(addr
+ offset
));
46 static u16
bfin_readw(const void __iomem
*addr
, unsigned offset
)
48 return bfin_read16(addr
+ offset
);
51 static u32
bfin_readl(const void __iomem
*addr
, unsigned offset
)
53 return (u32
)(bfin_read16(addr
+ offset
));
56 static void bfin_writeb(void __iomem
*addr
, unsigned offset
, u8 data
)
58 bfin_write16(addr
+ offset
, (u16
)data
);
61 static void bfin_writew(void __iomem
*addr
, unsigned offset
, u16 data
)
63 bfin_write16(addr
+ offset
, data
);
66 static void bfin_writel(void __iomem
*addr
, unsigned offset
, u32 data
)
68 bfin_write16(addr
+ offset
, (u16
)data
);
72 * Load an endpoint's FIFO
74 static void bfin_write_fifo(struct musb_hw_ep
*hw_ep
, u16 len
, const u8
*src
)
76 struct musb
*musb
= hw_ep
->musb
;
77 void __iomem
*fifo
= hw_ep
->fifo
;
78 void __iomem
*epio
= hw_ep
->regs
;
79 u8 epnum
= hw_ep
->epnum
;
83 musb_writew(epio
, MUSB_TXCOUNT
, len
);
85 dev_dbg(musb
->controller
, "TX ep%d fifo %p count %d buf %p, epio %p\n",
86 hw_ep
->epnum
, fifo
, len
, src
, epio
);
88 dump_fifo_data(src
, len
);
90 if (!ANOMALY_05000380
&& epnum
!= 0) {
93 flush_dcache_range((unsigned long)src
,
94 (unsigned long)(src
+ len
));
96 /* Setup DMA address register */
98 bfin_write16(USB_DMA_REG(epnum
, USB_DMAx_ADDR_LOW
), dma_reg
);
101 dma_reg
= (u32
)src
>> 16;
102 bfin_write16(USB_DMA_REG(epnum
, USB_DMAx_ADDR_HIGH
), dma_reg
);
105 /* Setup DMA count register */
106 bfin_write16(USB_DMA_REG(epnum
, USB_DMAx_COUNT_LOW
), len
);
107 bfin_write16(USB_DMA_REG(epnum
, USB_DMAx_COUNT_HIGH
), 0);
111 dma_reg
= (epnum
<< 4) | DMA_ENA
| INT_ENA
| DIRECTION
;
112 bfin_write16(USB_DMA_REG(epnum
, USB_DMAx_CTRL
), dma_reg
);
115 /* Wait for complete */
116 while (!(bfin_read_USB_DMA_INTERRUPT() & (1 << epnum
)))
119 /* acknowledge dma interrupt */
120 bfin_write_USB_DMA_INTERRUPT(1 << epnum
);
124 bfin_write16(USB_DMA_REG(epnum
, USB_DMAx_CTRL
), 0);
129 if (unlikely((unsigned long)src
& 0x01))
130 outsw_8((unsigned long)fifo
, src
, (len
+ 1) >> 1);
132 outsw((unsigned long)fifo
, src
, (len
+ 1) >> 1);
136 * Unload an endpoint's FIFO
138 static void bfin_read_fifo(struct musb_hw_ep
*hw_ep
, u16 len
, u8
*dst
)
140 struct musb
*musb
= hw_ep
->musb
;
141 void __iomem
*fifo
= hw_ep
->fifo
;
142 u8 epnum
= hw_ep
->epnum
;
144 if (ANOMALY_05000467
&& epnum
!= 0) {
147 invalidate_dcache_range((unsigned long)dst
,
148 (unsigned long)(dst
+ len
));
150 /* Setup DMA address register */
152 bfin_write16(USB_DMA_REG(epnum
, USB_DMAx_ADDR_LOW
), dma_reg
);
155 dma_reg
= (u32
)dst
>> 16;
156 bfin_write16(USB_DMA_REG(epnum
, USB_DMAx_ADDR_HIGH
), dma_reg
);
159 /* Setup DMA count register */
160 bfin_write16(USB_DMA_REG(epnum
, USB_DMAx_COUNT_LOW
), len
);
161 bfin_write16(USB_DMA_REG(epnum
, USB_DMAx_COUNT_HIGH
), 0);
165 dma_reg
= (epnum
<< 4) | DMA_ENA
| INT_ENA
;
166 bfin_write16(USB_DMA_REG(epnum
, USB_DMAx_CTRL
), dma_reg
);
169 /* Wait for complete */
170 while (!(bfin_read_USB_DMA_INTERRUPT() & (1 << epnum
)))
173 /* acknowledge dma interrupt */
174 bfin_write_USB_DMA_INTERRUPT(1 << epnum
);
178 bfin_write16(USB_DMA_REG(epnum
, USB_DMAx_CTRL
), 0);
182 /* Read the last byte of packet with odd size from address fifo + 4
183 * to trigger 1 byte access to EP0 FIFO.
186 *dst
= (u8
)inw((unsigned long)fifo
+ 4);
188 if (unlikely((unsigned long)dst
& 0x01))
189 insw_8((unsigned long)fifo
, dst
, len
>> 1);
191 insw((unsigned long)fifo
, dst
, len
>> 1);
194 *(dst
+ len
- 1) = (u8
)inw((unsigned long)fifo
+ 4);
197 dev_dbg(musb
->controller
, "%cX ep%d fifo %p count %d buf %p\n",
198 'R', hw_ep
->epnum
, fifo
, len
, dst
);
200 dump_fifo_data(dst
, len
);
203 static irqreturn_t
blackfin_interrupt(int irq
, void *__hci
)
206 irqreturn_t retval
= IRQ_NONE
;
207 struct musb
*musb
= __hci
;
209 spin_lock_irqsave(&musb
->lock
, flags
);
211 musb
->int_usb
= musb_readb(musb
->mregs
, MUSB_INTRUSB
);
212 musb
->int_tx
= musb_readw(musb
->mregs
, MUSB_INTRTX
);
213 musb
->int_rx
= musb_readw(musb
->mregs
, MUSB_INTRRX
);
215 if (musb
->int_usb
|| musb
->int_tx
|| musb
->int_rx
) {
216 musb_writeb(musb
->mregs
, MUSB_INTRUSB
, musb
->int_usb
);
217 musb_writew(musb
->mregs
, MUSB_INTRTX
, musb
->int_tx
);
218 musb_writew(musb
->mregs
, MUSB_INTRRX
, musb
->int_rx
);
219 retval
= musb_interrupt(musb
);
222 /* Start sampling ID pin, when plug is removed from MUSB */
223 if ((musb
->xceiv
->otg
->state
== OTG_STATE_B_IDLE
224 || musb
->xceiv
->otg
->state
== OTG_STATE_A_WAIT_BCON
) ||
225 (musb
->int_usb
& MUSB_INTR_DISCONNECT
&& is_host_active(musb
))) {
226 mod_timer(&musb_conn_timer
, jiffies
+ TIMER_DELAY
);
227 musb
->a_wait_bcon
= TIMER_DELAY
;
230 spin_unlock_irqrestore(&musb
->lock
, flags
);
235 static void musb_conn_timer_handler(unsigned long _musb
)
237 struct musb
*musb
= (void *)_musb
;
242 spin_lock_irqsave(&musb
->lock
, flags
);
243 switch (musb
->xceiv
->otg
->state
) {
244 case OTG_STATE_A_IDLE
:
245 case OTG_STATE_A_WAIT_BCON
:
246 /* Start a new session */
247 val
= musb_readw(musb
->mregs
, MUSB_DEVCTL
);
248 val
&= ~MUSB_DEVCTL_SESSION
;
249 musb_writew(musb
->mregs
, MUSB_DEVCTL
, val
);
250 val
|= MUSB_DEVCTL_SESSION
;
251 musb_writew(musb
->mregs
, MUSB_DEVCTL
, val
);
252 /* Check if musb is host or peripheral. */
253 val
= musb_readw(musb
->mregs
, MUSB_DEVCTL
);
255 if (!(val
& MUSB_DEVCTL_BDEVICE
)) {
256 gpio_set_value(musb
->config
->gpio_vrsel
, 1);
257 musb
->xceiv
->otg
->state
= OTG_STATE_A_WAIT_BCON
;
259 gpio_set_value(musb
->config
->gpio_vrsel
, 0);
260 /* Ignore VBUSERROR and SUSPEND IRQ */
261 val
= musb_readb(musb
->mregs
, MUSB_INTRUSBE
);
262 val
&= ~MUSB_INTR_VBUSERROR
;
263 musb_writeb(musb
->mregs
, MUSB_INTRUSBE
, val
);
265 val
= MUSB_INTR_SUSPEND
| MUSB_INTR_VBUSERROR
;
266 musb_writeb(musb
->mregs
, MUSB_INTRUSB
, val
);
267 musb
->xceiv
->otg
->state
= OTG_STATE_B_IDLE
;
269 mod_timer(&musb_conn_timer
, jiffies
+ TIMER_DELAY
);
271 case OTG_STATE_B_IDLE
:
273 * Start a new session. It seems that MUSB needs taking
274 * some time to recognize the type of the plug inserted?
276 val
= musb_readw(musb
->mregs
, MUSB_DEVCTL
);
277 val
|= MUSB_DEVCTL_SESSION
;
278 musb_writew(musb
->mregs
, MUSB_DEVCTL
, val
);
279 val
= musb_readw(musb
->mregs
, MUSB_DEVCTL
);
281 if (!(val
& MUSB_DEVCTL_BDEVICE
)) {
282 gpio_set_value(musb
->config
->gpio_vrsel
, 1);
283 musb
->xceiv
->otg
->state
= OTG_STATE_A_WAIT_BCON
;
285 gpio_set_value(musb
->config
->gpio_vrsel
, 0);
287 /* Ignore VBUSERROR and SUSPEND IRQ */
288 val
= musb_readb(musb
->mregs
, MUSB_INTRUSBE
);
289 val
&= ~MUSB_INTR_VBUSERROR
;
290 musb_writeb(musb
->mregs
, MUSB_INTRUSBE
, val
);
292 val
= MUSB_INTR_SUSPEND
| MUSB_INTR_VBUSERROR
;
293 musb_writeb(musb
->mregs
, MUSB_INTRUSB
, val
);
295 /* Toggle the Soft Conn bit, so that we can response to
296 * the inserting of either A-plug or B-plug.
299 val
= musb_readb(musb
->mregs
, MUSB_POWER
);
300 val
&= ~MUSB_POWER_SOFTCONN
;
301 musb_writeb(musb
->mregs
, MUSB_POWER
, val
);
304 val
= musb_readb(musb
->mregs
, MUSB_POWER
);
305 val
|= MUSB_POWER_SOFTCONN
;
306 musb_writeb(musb
->mregs
, MUSB_POWER
, val
);
309 /* The delay time is set to 1/4 second by default,
310 * shortening it, if accelerating A-plug detection
311 * is needed in OTG mode.
313 mod_timer(&musb_conn_timer
, jiffies
+ TIMER_DELAY
/ 4);
317 dev_dbg(musb
->controller
, "%s state not handled\n",
318 usb_otg_state_string(musb
->xceiv
->otg
->state
));
321 spin_unlock_irqrestore(&musb
->lock
, flags
);
323 dev_dbg(musb
->controller
, "state is %s\n",
324 usb_otg_state_string(musb
->xceiv
->otg
->state
));
327 static void bfin_musb_enable(struct musb
*musb
)
329 /* REVISIT is this really correct ? */
332 static void bfin_musb_disable(struct musb
*musb
)
336 static void bfin_musb_set_vbus(struct musb
*musb
, int is_on
)
338 int value
= musb
->config
->gpio_vrsel_active
;
341 gpio_set_value(musb
->config
->gpio_vrsel
, value
);
343 dev_dbg(musb
->controller
, "VBUS %s, devctl %02x "
344 /* otg %3x conf %08x prcm %08x */ "\n",
345 usb_otg_state_string(musb
->xceiv
->otg
->state
),
346 musb_readb(musb
->mregs
, MUSB_DEVCTL
));
349 static int bfin_musb_set_power(struct usb_phy
*x
, unsigned mA
)
354 static int bfin_musb_vbus_status(struct musb
*musb
)
359 static int bfin_musb_set_mode(struct musb
*musb
, u8 musb_mode
)
364 static int bfin_musb_adjust_channel_params(struct dma_channel
*channel
,
365 u16 packet_sz
, u8
*mode
,
366 dma_addr_t
*dma_addr
, u32
*len
)
368 struct musb_dma_channel
*musb_channel
= channel
->private_data
;
371 * Anomaly 05000450 might cause data corruption when using DMA
372 * MODE 1 transmits with short packet. So to work around this,
373 * we truncate all MODE 1 transfers down to a multiple of the
374 * max packet size, and then do the last short packet transfer
375 * (if there is any) using MODE 0.
377 if (ANOMALY_05000450
) {
378 if (musb_channel
->transmit
&& *mode
== 1)
379 *len
= *len
- (*len
% packet_sz
);
385 static void bfin_musb_reg_init(struct musb
*musb
)
387 if (ANOMALY_05000346
) {
388 bfin_write_USB_APHY_CALIB(ANOMALY_05000346_value
);
392 if (ANOMALY_05000347
) {
393 bfin_write_USB_APHY_CNTRL(0x0);
397 /* Configure PLL oscillator register */
398 bfin_write_USB_PLLOSC_CTRL(0x3080 |
399 ((480/musb
->config
->clkin
) << 1));
402 bfin_write_USB_SRP_CLKDIV((get_sclk()/1000) / 32 - 1);
405 bfin_write_USB_EP_NI0_RXMAXP(64);
408 bfin_write_USB_EP_NI0_TXMAXP(64);
411 /* Route INTRUSB/INTR_RX/INTR_TX to USB_INT0*/
412 bfin_write_USB_GLOBINTR(0x7);
415 bfin_write_USB_GLOBAL_CTL(GLOBAL_ENA
| EP1_TX_ENA
| EP2_TX_ENA
|
416 EP3_TX_ENA
| EP4_TX_ENA
| EP5_TX_ENA
|
417 EP6_TX_ENA
| EP7_TX_ENA
| EP1_RX_ENA
|
418 EP2_RX_ENA
| EP3_RX_ENA
| EP4_RX_ENA
|
419 EP5_RX_ENA
| EP6_RX_ENA
| EP7_RX_ENA
);
423 static int bfin_musb_init(struct musb
*musb
)
427 * Rev 1.0 BF549 EZ-KITs require PE7 to be high for both DEVICE
428 * and OTG HOST modes, while rev 1.1 and greater require PE7 to
429 * be low for DEVICE mode and high for HOST mode. We set it high
430 * here because we are in host mode
433 if (gpio_request(musb
->config
->gpio_vrsel
, "USB_VRSEL")) {
434 printk(KERN_ERR
"Failed ro request USB_VRSEL GPIO_%d\n",
435 musb
->config
->gpio_vrsel
);
438 gpio_direction_output(musb
->config
->gpio_vrsel
, 0);
440 musb
->xceiv
= usb_get_phy(USB_PHY_TYPE_USB2
);
441 if (IS_ERR_OR_NULL(musb
->xceiv
)) {
442 gpio_free(musb
->config
->gpio_vrsel
);
443 return -EPROBE_DEFER
;
446 bfin_musb_reg_init(musb
);
448 setup_timer(&musb_conn_timer
, musb_conn_timer_handler
,
449 (unsigned long) musb
);
451 musb
->xceiv
->set_power
= bfin_musb_set_power
;
453 musb
->isr
= blackfin_interrupt
;
454 musb
->double_buffer_not_ok
= true;
459 static int bfin_musb_exit(struct musb
*musb
)
461 gpio_free(musb
->config
->gpio_vrsel
);
462 usb_put_phy(musb
->xceiv
);
467 static const struct musb_platform_ops bfin_ops
= {
468 .init
= bfin_musb_init
,
469 .exit
= bfin_musb_exit
,
472 .writeb
= bfin_writeb
,
474 .writew
= bfin_writew
,
476 .writel
= bfin_writel
,
478 .read_fifo
= bfin_read_fifo
,
479 .write_fifo
= bfin_write_fifo
,
480 .enable
= bfin_musb_enable
,
481 .disable
= bfin_musb_disable
,
483 .set_mode
= bfin_musb_set_mode
,
485 .vbus_status
= bfin_musb_vbus_status
,
486 .set_vbus
= bfin_musb_set_vbus
,
488 .adjust_channel_params
= bfin_musb_adjust_channel_params
,
491 static u64 bfin_dmamask
= DMA_BIT_MASK(32);
493 static int bfin_probe(struct platform_device
*pdev
)
495 struct resource musb_resources
[2];
496 struct musb_hdrc_platform_data
*pdata
= dev_get_platdata(&pdev
->dev
);
497 struct platform_device
*musb
;
498 struct bfin_glue
*glue
;
502 glue
= devm_kzalloc(&pdev
->dev
, sizeof(*glue
), GFP_KERNEL
);
506 musb
= platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO
);
510 musb
->dev
.parent
= &pdev
->dev
;
511 musb
->dev
.dma_mask
= &bfin_dmamask
;
512 musb
->dev
.coherent_dma_mask
= bfin_dmamask
;
514 glue
->dev
= &pdev
->dev
;
517 pdata
->platform_ops
= &bfin_ops
;
519 glue
->phy
= usb_phy_generic_register();
520 if (IS_ERR(glue
->phy
))
522 platform_set_drvdata(pdev
, glue
);
524 memset(musb_resources
, 0x00, sizeof(*musb_resources
) *
525 ARRAY_SIZE(musb_resources
));
527 musb_resources
[0].name
= pdev
->resource
[0].name
;
528 musb_resources
[0].start
= pdev
->resource
[0].start
;
529 musb_resources
[0].end
= pdev
->resource
[0].end
;
530 musb_resources
[0].flags
= pdev
->resource
[0].flags
;
532 musb_resources
[1].name
= pdev
->resource
[1].name
;
533 musb_resources
[1].start
= pdev
->resource
[1].start
;
534 musb_resources
[1].end
= pdev
->resource
[1].end
;
535 musb_resources
[1].flags
= pdev
->resource
[1].flags
;
537 ret
= platform_device_add_resources(musb
, musb_resources
,
538 ARRAY_SIZE(musb_resources
));
540 dev_err(&pdev
->dev
, "failed to add resources\n");
544 ret
= platform_device_add_data(musb
, pdata
, sizeof(*pdata
));
546 dev_err(&pdev
->dev
, "failed to add platform_data\n");
550 ret
= platform_device_add(musb
);
552 dev_err(&pdev
->dev
, "failed to register musb device\n");
559 usb_phy_generic_unregister(glue
->phy
);
562 platform_device_put(musb
);
568 static int bfin_remove(struct platform_device
*pdev
)
570 struct bfin_glue
*glue
= platform_get_drvdata(pdev
);
572 platform_device_unregister(glue
->musb
);
573 usb_phy_generic_unregister(glue
->phy
);
579 static int bfin_suspend(struct device
*dev
)
581 struct bfin_glue
*glue
= dev_get_drvdata(dev
);
582 struct musb
*musb
= glue_to_musb(glue
);
584 if (is_host_active(musb
))
586 * During hibernate gpio_vrsel will change from high to low
587 * low which will generate wakeup event resume the system
588 * immediately. Set it to 0 before hibernate to avoid this
591 gpio_set_value(musb
->config
->gpio_vrsel
, 0);
596 static int bfin_resume(struct device
*dev
)
598 struct bfin_glue
*glue
= dev_get_drvdata(dev
);
599 struct musb
*musb
= glue_to_musb(glue
);
601 bfin_musb_reg_init(musb
);
607 static SIMPLE_DEV_PM_OPS(bfin_pm_ops
, bfin_suspend
, bfin_resume
);
609 static struct platform_driver bfin_driver
= {
611 .remove
= bfin_remove
,
613 .name
= "musb-blackfin",
618 MODULE_DESCRIPTION("Blackfin MUSB Glue Layer");
619 MODULE_AUTHOR("Bryan Wy <cooloney@kernel.org>");
620 MODULE_LICENSE("GPL v2");
621 module_platform_driver(bfin_driver
);