Loading...
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * Allwinner sun4i MUSB Glue Layer
4 *
5 * Copyright (C) 2015 Hans de Goede <hdegoede@redhat.com>
6 *
7 * Based on code from
8 * Allwinner Technology Co., Ltd. <www.allwinnertech.com>
9 */
10
11#include <linux/clk.h>
12#include <linux/err.h>
13#include <linux/extcon.h>
14#include <linux/io.h>
15#include <linux/kernel.h>
16#include <linux/module.h>
17#include <linux/of.h>
18#include <linux/phy/phy-sun4i-usb.h>
19#include <linux/platform_device.h>
20#include <linux/reset.h>
21#include <linux/soc/sunxi/sunxi_sram.h>
22#include <linux/usb/musb.h>
23#include <linux/usb/of.h>
24#include <linux/usb/usb_phy_generic.h>
25#include <linux/workqueue.h>
26#include "musb_core.h"
27
28/*
29 * Register offsets, note sunxi musb has a different layout then most
30 * musb implementations, we translate the layout in musb_readb & friends.
31 */
32#define SUNXI_MUSB_POWER 0x0040
33#define SUNXI_MUSB_DEVCTL 0x0041
34#define SUNXI_MUSB_INDEX 0x0042
35#define SUNXI_MUSB_VEND0 0x0043
36#define SUNXI_MUSB_INTRTX 0x0044
37#define SUNXI_MUSB_INTRRX 0x0046
38#define SUNXI_MUSB_INTRTXE 0x0048
39#define SUNXI_MUSB_INTRRXE 0x004a
40#define SUNXI_MUSB_INTRUSB 0x004c
41#define SUNXI_MUSB_INTRUSBE 0x0050
42#define SUNXI_MUSB_FRAME 0x0054
43#define SUNXI_MUSB_TXFIFOSZ 0x0090
44#define SUNXI_MUSB_TXFIFOADD 0x0092
45#define SUNXI_MUSB_RXFIFOSZ 0x0094
46#define SUNXI_MUSB_RXFIFOADD 0x0096
47#define SUNXI_MUSB_FADDR 0x0098
48#define SUNXI_MUSB_TXFUNCADDR 0x0098
49#define SUNXI_MUSB_TXHUBADDR 0x009a
50#define SUNXI_MUSB_TXHUBPORT 0x009b
51#define SUNXI_MUSB_RXFUNCADDR 0x009c
52#define SUNXI_MUSB_RXHUBADDR 0x009e
53#define SUNXI_MUSB_RXHUBPORT 0x009f
54#define SUNXI_MUSB_CONFIGDATA 0x00c0
55
56/* VEND0 bits */
57#define SUNXI_MUSB_VEND0_PIO_MODE 0
58
59/* flags */
60#define SUNXI_MUSB_FL_ENABLED 0
61#define SUNXI_MUSB_FL_HOSTMODE 1
62#define SUNXI_MUSB_FL_HOSTMODE_PEND 2
63#define SUNXI_MUSB_FL_VBUS_ON 3
64#define SUNXI_MUSB_FL_PHY_ON 4
65#define SUNXI_MUSB_FL_HAS_SRAM 5
66#define SUNXI_MUSB_FL_HAS_RESET 6
67#define SUNXI_MUSB_FL_NO_CONFIGDATA 7
68#define SUNXI_MUSB_FL_PHY_MODE_PEND 8
69
70struct sunxi_musb_cfg {
71 const struct musb_hdrc_config *hdrc_config;
72 bool has_sram;
73 bool has_reset;
74 bool no_configdata;
75};
76
77/* Our read/write methods need access and do not get passed in a musb ref :| */
78static struct musb *sunxi_musb;
79
80struct sunxi_glue {
81 struct device *dev;
82 struct musb *musb;
83 struct platform_device *musb_pdev;
84 struct clk *clk;
85 struct reset_control *rst;
86 struct phy *phy;
87 struct platform_device *usb_phy;
88 struct usb_phy *xceiv;
89 enum phy_mode phy_mode;
90 unsigned long flags;
91 struct work_struct work;
92 struct extcon_dev *extcon;
93 struct notifier_block host_nb;
94};
95
96/* phy_power_on / off may sleep, so we use a workqueue */
97static void sunxi_musb_work(struct work_struct *work)
98{
99 struct sunxi_glue *glue = container_of(work, struct sunxi_glue, work);
100 bool vbus_on, phy_on;
101
102 if (!test_bit(SUNXI_MUSB_FL_ENABLED, &glue->flags))
103 return;
104
105 if (test_and_clear_bit(SUNXI_MUSB_FL_HOSTMODE_PEND, &glue->flags)) {
106 struct musb *musb = glue->musb;
107 unsigned long flags;
108 u8 devctl;
109
110 spin_lock_irqsave(&musb->lock, flags);
111
112 devctl = readb(musb->mregs + SUNXI_MUSB_DEVCTL);
113 if (test_bit(SUNXI_MUSB_FL_HOSTMODE, &glue->flags)) {
114 set_bit(SUNXI_MUSB_FL_VBUS_ON, &glue->flags);
115 musb->xceiv->otg->state = OTG_STATE_A_WAIT_VRISE;
116 MUSB_HST_MODE(musb);
117 devctl |= MUSB_DEVCTL_SESSION;
118 } else {
119 clear_bit(SUNXI_MUSB_FL_VBUS_ON, &glue->flags);
120 musb->xceiv->otg->state = OTG_STATE_B_IDLE;
121 MUSB_DEV_MODE(musb);
122 devctl &= ~MUSB_DEVCTL_SESSION;
123 }
124 writeb(devctl, musb->mregs + SUNXI_MUSB_DEVCTL);
125
126 spin_unlock_irqrestore(&musb->lock, flags);
127 }
128
129 vbus_on = test_bit(SUNXI_MUSB_FL_VBUS_ON, &glue->flags);
130 phy_on = test_bit(SUNXI_MUSB_FL_PHY_ON, &glue->flags);
131
132 if (phy_on != vbus_on) {
133 if (vbus_on) {
134 phy_power_on(glue->phy);
135 set_bit(SUNXI_MUSB_FL_PHY_ON, &glue->flags);
136 } else {
137 phy_power_off(glue->phy);
138 clear_bit(SUNXI_MUSB_FL_PHY_ON, &glue->flags);
139 }
140 }
141
142 if (test_and_clear_bit(SUNXI_MUSB_FL_PHY_MODE_PEND, &glue->flags))
143 phy_set_mode(glue->phy, glue->phy_mode);
144}
145
146static void sunxi_musb_set_vbus(struct musb *musb, int is_on)
147{
148 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
149
150 if (is_on) {
151 set_bit(SUNXI_MUSB_FL_VBUS_ON, &glue->flags);
152 musb->xceiv->otg->state = OTG_STATE_A_WAIT_VRISE;
153 } else {
154 clear_bit(SUNXI_MUSB_FL_VBUS_ON, &glue->flags);
155 }
156
157 schedule_work(&glue->work);
158}
159
160static void sunxi_musb_pre_root_reset_end(struct musb *musb)
161{
162 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
163
164 sun4i_usb_phy_set_squelch_detect(glue->phy, false);
165}
166
167static void sunxi_musb_post_root_reset_end(struct musb *musb)
168{
169 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
170
171 sun4i_usb_phy_set_squelch_detect(glue->phy, true);
172}
173
174static irqreturn_t sunxi_musb_interrupt(int irq, void *__hci)
175{
176 struct musb *musb = __hci;
177 unsigned long flags;
178
179 spin_lock_irqsave(&musb->lock, flags);
180
181 musb->int_usb = readb(musb->mregs + SUNXI_MUSB_INTRUSB);
182 if (musb->int_usb)
183 writeb(musb->int_usb, musb->mregs + SUNXI_MUSB_INTRUSB);
184
185 if ((musb->int_usb & MUSB_INTR_RESET) && !is_host_active(musb)) {
186 /* ep0 FADDR must be 0 when (re)entering peripheral mode */
187 musb_ep_select(musb->mregs, 0);
188 musb_writeb(musb->mregs, MUSB_FADDR, 0);
189 }
190
191 musb->int_tx = readw(musb->mregs + SUNXI_MUSB_INTRTX);
192 if (musb->int_tx)
193 writew(musb->int_tx, musb->mregs + SUNXI_MUSB_INTRTX);
194
195 musb->int_rx = readw(musb->mregs + SUNXI_MUSB_INTRRX);
196 if (musb->int_rx)
197 writew(musb->int_rx, musb->mregs + SUNXI_MUSB_INTRRX);
198
199 musb_interrupt(musb);
200
201 spin_unlock_irqrestore(&musb->lock, flags);
202
203 return IRQ_HANDLED;
204}
205
206static int sunxi_musb_host_notifier(struct notifier_block *nb,
207 unsigned long event, void *ptr)
208{
209 struct sunxi_glue *glue = container_of(nb, struct sunxi_glue, host_nb);
210
211 if (event)
212 set_bit(SUNXI_MUSB_FL_HOSTMODE, &glue->flags);
213 else
214 clear_bit(SUNXI_MUSB_FL_HOSTMODE, &glue->flags);
215
216 set_bit(SUNXI_MUSB_FL_HOSTMODE_PEND, &glue->flags);
217 schedule_work(&glue->work);
218
219 return NOTIFY_DONE;
220}
221
222static int sunxi_musb_init(struct musb *musb)
223{
224 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
225 int ret;
226
227 sunxi_musb = musb;
228 musb->phy = glue->phy;
229 musb->xceiv = glue->xceiv;
230
231 if (test_bit(SUNXI_MUSB_FL_HAS_SRAM, &glue->flags)) {
232 ret = sunxi_sram_claim(musb->controller->parent);
233 if (ret)
234 return ret;
235 }
236
237 ret = clk_prepare_enable(glue->clk);
238 if (ret)
239 goto error_sram_release;
240
241 if (test_bit(SUNXI_MUSB_FL_HAS_RESET, &glue->flags)) {
242 ret = reset_control_deassert(glue->rst);
243 if (ret)
244 goto error_clk_disable;
245 }
246
247 writeb(SUNXI_MUSB_VEND0_PIO_MODE, musb->mregs + SUNXI_MUSB_VEND0);
248
249 /* Register notifier before calling phy_init() */
250 ret = devm_extcon_register_notifier(glue->dev, glue->extcon,
251 EXTCON_USB_HOST, &glue->host_nb);
252 if (ret)
253 goto error_reset_assert;
254
255 ret = phy_init(glue->phy);
256 if (ret)
257 goto error_reset_assert;
258
259 musb->isr = sunxi_musb_interrupt;
260
261 /* Stop the musb-core from doing runtime pm (not supported on sunxi) */
262 pm_runtime_get(musb->controller);
263
264 return 0;
265
266error_reset_assert:
267 if (test_bit(SUNXI_MUSB_FL_HAS_RESET, &glue->flags))
268 reset_control_assert(glue->rst);
269error_clk_disable:
270 clk_disable_unprepare(glue->clk);
271error_sram_release:
272 if (test_bit(SUNXI_MUSB_FL_HAS_SRAM, &glue->flags))
273 sunxi_sram_release(musb->controller->parent);
274 return ret;
275}
276
277static int sunxi_musb_exit(struct musb *musb)
278{
279 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
280
281 pm_runtime_put(musb->controller);
282
283 cancel_work_sync(&glue->work);
284 if (test_bit(SUNXI_MUSB_FL_PHY_ON, &glue->flags))
285 phy_power_off(glue->phy);
286
287 phy_exit(glue->phy);
288
289 if (test_bit(SUNXI_MUSB_FL_HAS_RESET, &glue->flags))
290 reset_control_assert(glue->rst);
291
292 clk_disable_unprepare(glue->clk);
293 if (test_bit(SUNXI_MUSB_FL_HAS_SRAM, &glue->flags))
294 sunxi_sram_release(musb->controller->parent);
295
296 return 0;
297}
298
299static void sunxi_musb_enable(struct musb *musb)
300{
301 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
302
303 glue->musb = musb;
304
305 /* musb_core does not call us in a balanced manner */
306 if (test_and_set_bit(SUNXI_MUSB_FL_ENABLED, &glue->flags))
307 return;
308
309 schedule_work(&glue->work);
310}
311
312static void sunxi_musb_disable(struct musb *musb)
313{
314 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
315
316 clear_bit(SUNXI_MUSB_FL_ENABLED, &glue->flags);
317}
318
319static struct dma_controller *
320sunxi_musb_dma_controller_create(struct musb *musb, void __iomem *base)
321{
322 return NULL;
323}
324
325static void sunxi_musb_dma_controller_destroy(struct dma_controller *c)
326{
327}
328
329static int sunxi_musb_set_mode(struct musb *musb, u8 mode)
330{
331 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
332 enum phy_mode new_mode;
333
334 switch (mode) {
335 case MUSB_HOST:
336 new_mode = PHY_MODE_USB_HOST;
337 break;
338 case MUSB_PERIPHERAL:
339 new_mode = PHY_MODE_USB_DEVICE;
340 break;
341 case MUSB_OTG:
342 new_mode = PHY_MODE_USB_OTG;
343 break;
344 default:
345 dev_err(musb->controller->parent,
346 "Error requested mode not supported by this kernel\n");
347 return -EINVAL;
348 }
349
350 if (glue->phy_mode == new_mode)
351 return 0;
352
353 if (musb->port_mode != MUSB_OTG) {
354 dev_err(musb->controller->parent,
355 "Error changing modes is only supported in dual role mode\n");
356 return -EINVAL;
357 }
358
359 if (musb->port1_status & USB_PORT_STAT_ENABLE)
360 musb_root_disconnect(musb);
361
362 /*
363 * phy_set_mode may sleep, and we're called with a spinlock held,
364 * so let sunxi_musb_work deal with it.
365 */
366 glue->phy_mode = new_mode;
367 set_bit(SUNXI_MUSB_FL_PHY_MODE_PEND, &glue->flags);
368 schedule_work(&glue->work);
369
370 return 0;
371}
372
373static int sunxi_musb_recover(struct musb *musb)
374{
375 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
376
377 /*
378 * Schedule a phy_set_mode with the current glue->phy_mode value,
379 * this will force end the current session.
380 */
381 set_bit(SUNXI_MUSB_FL_PHY_MODE_PEND, &glue->flags);
382 schedule_work(&glue->work);
383
384 return 0;
385}
386
387/*
388 * sunxi musb register layout
389 * 0x00 - 0x17 fifo regs, 1 long per fifo
390 * 0x40 - 0x57 generic control regs (power - frame)
391 * 0x80 - 0x8f ep control regs (addressed through hw_ep->regs, indexed)
392 * 0x90 - 0x97 fifo control regs (indexed)
393 * 0x98 - 0x9f multipoint / busctl regs (indexed)
394 * 0xc0 configdata reg
395 */
396
397static u32 sunxi_musb_fifo_offset(u8 epnum)
398{
399 return (epnum * 4);
400}
401
402static u32 sunxi_musb_ep_offset(u8 epnum, u16 offset)
403{
404 WARN_ONCE(offset != 0,
405 "sunxi_musb_ep_offset called with non 0 offset\n");
406
407 return 0x80; /* indexed, so ignore epnum */
408}
409
410static u32 sunxi_musb_busctl_offset(u8 epnum, u16 offset)
411{
412 return SUNXI_MUSB_TXFUNCADDR + offset;
413}
414
415static u8 sunxi_musb_readb(void __iomem *addr, u32 offset)
416{
417 struct sunxi_glue *glue;
418
419 if (addr == sunxi_musb->mregs) {
420 /* generic control or fifo control reg access */
421 switch (offset) {
422 case MUSB_FADDR:
423 return readb(addr + SUNXI_MUSB_FADDR);
424 case MUSB_POWER:
425 return readb(addr + SUNXI_MUSB_POWER);
426 case MUSB_INTRUSB:
427 return readb(addr + SUNXI_MUSB_INTRUSB);
428 case MUSB_INTRUSBE:
429 return readb(addr + SUNXI_MUSB_INTRUSBE);
430 case MUSB_INDEX:
431 return readb(addr + SUNXI_MUSB_INDEX);
432 case MUSB_TESTMODE:
433 return 0; /* No testmode on sunxi */
434 case MUSB_DEVCTL:
435 return readb(addr + SUNXI_MUSB_DEVCTL);
436 case MUSB_TXFIFOSZ:
437 return readb(addr + SUNXI_MUSB_TXFIFOSZ);
438 case MUSB_RXFIFOSZ:
439 return readb(addr + SUNXI_MUSB_RXFIFOSZ);
440 case MUSB_CONFIGDATA + 0x10: /* See musb_read_configdata() */
441 glue = dev_get_drvdata(sunxi_musb->controller->parent);
442 /* A33 saves a reg, and we get to hardcode this */
443 if (test_bit(SUNXI_MUSB_FL_NO_CONFIGDATA,
444 &glue->flags))
445 return 0xde;
446
447 return readb(addr + SUNXI_MUSB_CONFIGDATA);
448 case MUSB_ULPI_BUSCONTROL:
449 dev_warn(sunxi_musb->controller->parent,
450 "sunxi-musb does not have ULPI bus control register\n");
451 return 0;
452 /* Offset for these is fixed by sunxi_musb_busctl_offset() */
453 case SUNXI_MUSB_TXFUNCADDR:
454 case SUNXI_MUSB_TXHUBADDR:
455 case SUNXI_MUSB_TXHUBPORT:
456 case SUNXI_MUSB_RXFUNCADDR:
457 case SUNXI_MUSB_RXHUBADDR:
458 case SUNXI_MUSB_RXHUBPORT:
459 /* multipoint / busctl reg access */
460 return readb(addr + offset);
461 default:
462 dev_err(sunxi_musb->controller->parent,
463 "Error unknown readb offset %u\n", offset);
464 return 0;
465 }
466 } else if (addr == (sunxi_musb->mregs + 0x80)) {
467 /* ep control reg access */
468 /* sunxi has a 2 byte hole before the txtype register */
469 if (offset >= MUSB_TXTYPE)
470 offset += 2;
471 return readb(addr + offset);
472 }
473
474 dev_err(sunxi_musb->controller->parent,
475 "Error unknown readb at 0x%x bytes offset\n",
476 (int)(addr - sunxi_musb->mregs));
477 return 0;
478}
479
480static void sunxi_musb_writeb(void __iomem *addr, unsigned offset, u8 data)
481{
482 if (addr == sunxi_musb->mregs) {
483 /* generic control or fifo control reg access */
484 switch (offset) {
485 case MUSB_FADDR:
486 return writeb(data, addr + SUNXI_MUSB_FADDR);
487 case MUSB_POWER:
488 return writeb(data, addr + SUNXI_MUSB_POWER);
489 case MUSB_INTRUSB:
490 return writeb(data, addr + SUNXI_MUSB_INTRUSB);
491 case MUSB_INTRUSBE:
492 return writeb(data, addr + SUNXI_MUSB_INTRUSBE);
493 case MUSB_INDEX:
494 return writeb(data, addr + SUNXI_MUSB_INDEX);
495 case MUSB_TESTMODE:
496 if (data)
497 dev_warn(sunxi_musb->controller->parent,
498 "sunxi-musb does not have testmode\n");
499 return;
500 case MUSB_DEVCTL:
501 return writeb(data, addr + SUNXI_MUSB_DEVCTL);
502 case MUSB_TXFIFOSZ:
503 return writeb(data, addr + SUNXI_MUSB_TXFIFOSZ);
504 case MUSB_RXFIFOSZ:
505 return writeb(data, addr + SUNXI_MUSB_RXFIFOSZ);
506 case MUSB_ULPI_BUSCONTROL:
507 dev_warn(sunxi_musb->controller->parent,
508 "sunxi-musb does not have ULPI bus control register\n");
509 return;
510 /* Offset for these is fixed by sunxi_musb_busctl_offset() */
511 case SUNXI_MUSB_TXFUNCADDR:
512 case SUNXI_MUSB_TXHUBADDR:
513 case SUNXI_MUSB_TXHUBPORT:
514 case SUNXI_MUSB_RXFUNCADDR:
515 case SUNXI_MUSB_RXHUBADDR:
516 case SUNXI_MUSB_RXHUBPORT:
517 /* multipoint / busctl reg access */
518 return writeb(data, addr + offset);
519 default:
520 dev_err(sunxi_musb->controller->parent,
521 "Error unknown writeb offset %u\n", offset);
522 return;
523 }
524 } else if (addr == (sunxi_musb->mregs + 0x80)) {
525 /* ep control reg access */
526 if (offset >= MUSB_TXTYPE)
527 offset += 2;
528 return writeb(data, addr + offset);
529 }
530
531 dev_err(sunxi_musb->controller->parent,
532 "Error unknown writeb at 0x%x bytes offset\n",
533 (int)(addr - sunxi_musb->mregs));
534}
535
536static u16 sunxi_musb_readw(void __iomem *addr, u32 offset)
537{
538 if (addr == sunxi_musb->mregs) {
539 /* generic control or fifo control reg access */
540 switch (offset) {
541 case MUSB_INTRTX:
542 return readw(addr + SUNXI_MUSB_INTRTX);
543 case MUSB_INTRRX:
544 return readw(addr + SUNXI_MUSB_INTRRX);
545 case MUSB_INTRTXE:
546 return readw(addr + SUNXI_MUSB_INTRTXE);
547 case MUSB_INTRRXE:
548 return readw(addr + SUNXI_MUSB_INTRRXE);
549 case MUSB_FRAME:
550 return readw(addr + SUNXI_MUSB_FRAME);
551 case MUSB_TXFIFOADD:
552 return readw(addr + SUNXI_MUSB_TXFIFOADD);
553 case MUSB_RXFIFOADD:
554 return readw(addr + SUNXI_MUSB_RXFIFOADD);
555 case MUSB_HWVERS:
556 return 0; /* sunxi musb version is not known */
557 default:
558 dev_err(sunxi_musb->controller->parent,
559 "Error unknown readw offset %u\n", offset);
560 return 0;
561 }
562 } else if (addr == (sunxi_musb->mregs + 0x80)) {
563 /* ep control reg access */
564 return readw(addr + offset);
565 }
566
567 dev_err(sunxi_musb->controller->parent,
568 "Error unknown readw at 0x%x bytes offset\n",
569 (int)(addr - sunxi_musb->mregs));
570 return 0;
571}
572
573static void sunxi_musb_writew(void __iomem *addr, unsigned offset, u16 data)
574{
575 if (addr == sunxi_musb->mregs) {
576 /* generic control or fifo control reg access */
577 switch (offset) {
578 case MUSB_INTRTX:
579 return writew(data, addr + SUNXI_MUSB_INTRTX);
580 case MUSB_INTRRX:
581 return writew(data, addr + SUNXI_MUSB_INTRRX);
582 case MUSB_INTRTXE:
583 return writew(data, addr + SUNXI_MUSB_INTRTXE);
584 case MUSB_INTRRXE:
585 return writew(data, addr + SUNXI_MUSB_INTRRXE);
586 case MUSB_FRAME:
587 return writew(data, addr + SUNXI_MUSB_FRAME);
588 case MUSB_TXFIFOADD:
589 return writew(data, addr + SUNXI_MUSB_TXFIFOADD);
590 case MUSB_RXFIFOADD:
591 return writew(data, addr + SUNXI_MUSB_RXFIFOADD);
592 default:
593 dev_err(sunxi_musb->controller->parent,
594 "Error unknown writew offset %u\n", offset);
595 return;
596 }
597 } else if (addr == (sunxi_musb->mregs + 0x80)) {
598 /* ep control reg access */
599 return writew(data, addr + offset);
600 }
601
602 dev_err(sunxi_musb->controller->parent,
603 "Error unknown writew at 0x%x bytes offset\n",
604 (int)(addr - sunxi_musb->mregs));
605}
606
607static const struct musb_platform_ops sunxi_musb_ops = {
608 .quirks = MUSB_INDEXED_EP,
609 .init = sunxi_musb_init,
610 .exit = sunxi_musb_exit,
611 .enable = sunxi_musb_enable,
612 .disable = sunxi_musb_disable,
613 .fifo_offset = sunxi_musb_fifo_offset,
614 .ep_offset = sunxi_musb_ep_offset,
615 .busctl_offset = sunxi_musb_busctl_offset,
616 .readb = sunxi_musb_readb,
617 .writeb = sunxi_musb_writeb,
618 .readw = sunxi_musb_readw,
619 .writew = sunxi_musb_writew,
620 .dma_init = sunxi_musb_dma_controller_create,
621 .dma_exit = sunxi_musb_dma_controller_destroy,
622 .set_mode = sunxi_musb_set_mode,
623 .recover = sunxi_musb_recover,
624 .set_vbus = sunxi_musb_set_vbus,
625 .pre_root_reset_end = sunxi_musb_pre_root_reset_end,
626 .post_root_reset_end = sunxi_musb_post_root_reset_end,
627};
628
629#define SUNXI_MUSB_RAM_BITS 11
630
631/* Allwinner OTG supports up to 5 endpoints */
632static struct musb_fifo_cfg sunxi_musb_mode_cfg_5eps[] = {
633 MUSB_EP_FIFO_SINGLE(1, FIFO_TX, 512),
634 MUSB_EP_FIFO_SINGLE(1, FIFO_RX, 512),
635 MUSB_EP_FIFO_SINGLE(2, FIFO_TX, 512),
636 MUSB_EP_FIFO_SINGLE(2, FIFO_RX, 512),
637 MUSB_EP_FIFO_SINGLE(3, FIFO_TX, 512),
638 MUSB_EP_FIFO_SINGLE(3, FIFO_RX, 512),
639 MUSB_EP_FIFO_SINGLE(4, FIFO_TX, 512),
640 MUSB_EP_FIFO_SINGLE(4, FIFO_RX, 512),
641 MUSB_EP_FIFO_SINGLE(5, FIFO_TX, 512),
642 MUSB_EP_FIFO_SINGLE(5, FIFO_RX, 512),
643};
644
645/* H3/V3s OTG supports only 4 endpoints */
646static struct musb_fifo_cfg sunxi_musb_mode_cfg_4eps[] = {
647 MUSB_EP_FIFO_SINGLE(1, FIFO_TX, 512),
648 MUSB_EP_FIFO_SINGLE(1, FIFO_RX, 512),
649 MUSB_EP_FIFO_SINGLE(2, FIFO_TX, 512),
650 MUSB_EP_FIFO_SINGLE(2, FIFO_RX, 512),
651 MUSB_EP_FIFO_SINGLE(3, FIFO_TX, 512),
652 MUSB_EP_FIFO_SINGLE(3, FIFO_RX, 512),
653 MUSB_EP_FIFO_SINGLE(4, FIFO_TX, 512),
654 MUSB_EP_FIFO_SINGLE(4, FIFO_RX, 512),
655};
656
657static const struct musb_hdrc_config sunxi_musb_hdrc_config_5eps = {
658 .fifo_cfg = sunxi_musb_mode_cfg_5eps,
659 .fifo_cfg_size = ARRAY_SIZE(sunxi_musb_mode_cfg_5eps),
660 .multipoint = true,
661 .dyn_fifo = true,
662 /* Two FIFOs per endpoint, plus ep_0. */
663 .num_eps = (ARRAY_SIZE(sunxi_musb_mode_cfg_5eps) / 2) + 1,
664 .ram_bits = SUNXI_MUSB_RAM_BITS,
665};
666
667static const struct musb_hdrc_config sunxi_musb_hdrc_config_4eps = {
668 .fifo_cfg = sunxi_musb_mode_cfg_4eps,
669 .fifo_cfg_size = ARRAY_SIZE(sunxi_musb_mode_cfg_4eps),
670 .multipoint = true,
671 .dyn_fifo = true,
672 /* Two FIFOs per endpoint, plus ep_0. */
673 .num_eps = (ARRAY_SIZE(sunxi_musb_mode_cfg_4eps) / 2) + 1,
674 .ram_bits = SUNXI_MUSB_RAM_BITS,
675};
676
677static int sunxi_musb_probe(struct platform_device *pdev)
678{
679 struct musb_hdrc_platform_data pdata;
680 struct platform_device_info pinfo;
681 struct sunxi_glue *glue;
682 struct device_node *np = pdev->dev.of_node;
683 const struct sunxi_musb_cfg *cfg;
684 int ret;
685
686 if (!np) {
687 dev_err(&pdev->dev, "Error no device tree node found\n");
688 return -EINVAL;
689 }
690
691 glue = devm_kzalloc(&pdev->dev, sizeof(*glue), GFP_KERNEL);
692 if (!glue)
693 return -ENOMEM;
694
695 memset(&pdata, 0, sizeof(pdata));
696 switch (usb_get_dr_mode(&pdev->dev)) {
697#if defined CONFIG_USB_MUSB_DUAL_ROLE || defined CONFIG_USB_MUSB_HOST
698 case USB_DR_MODE_HOST:
699 pdata.mode = MUSB_HOST;
700 glue->phy_mode = PHY_MODE_USB_HOST;
701 break;
702#endif
703#if defined CONFIG_USB_MUSB_DUAL_ROLE || defined CONFIG_USB_MUSB_GADGET
704 case USB_DR_MODE_PERIPHERAL:
705 pdata.mode = MUSB_PERIPHERAL;
706 glue->phy_mode = PHY_MODE_USB_DEVICE;
707 break;
708#endif
709#ifdef CONFIG_USB_MUSB_DUAL_ROLE
710 case USB_DR_MODE_OTG:
711 pdata.mode = MUSB_OTG;
712 glue->phy_mode = PHY_MODE_USB_OTG;
713 break;
714#endif
715 default:
716 dev_err(&pdev->dev, "Invalid or missing 'dr_mode' property\n");
717 return -EINVAL;
718 }
719 pdata.platform_ops = &sunxi_musb_ops;
720
721 cfg = of_device_get_match_data(&pdev->dev);
722 if (!cfg)
723 return -EINVAL;
724
725 pdata.config = cfg->hdrc_config;
726
727 glue->dev = &pdev->dev;
728 INIT_WORK(&glue->work, sunxi_musb_work);
729 glue->host_nb.notifier_call = sunxi_musb_host_notifier;
730
731 if (cfg->has_sram)
732 set_bit(SUNXI_MUSB_FL_HAS_SRAM, &glue->flags);
733
734 if (cfg->has_reset)
735 set_bit(SUNXI_MUSB_FL_HAS_RESET, &glue->flags);
736
737 if (cfg->no_configdata)
738 set_bit(SUNXI_MUSB_FL_NO_CONFIGDATA, &glue->flags);
739
740 glue->clk = devm_clk_get(&pdev->dev, NULL);
741 if (IS_ERR(glue->clk)) {
742 dev_err(&pdev->dev, "Error getting clock: %ld\n",
743 PTR_ERR(glue->clk));
744 return PTR_ERR(glue->clk);
745 }
746
747 if (test_bit(SUNXI_MUSB_FL_HAS_RESET, &glue->flags)) {
748 glue->rst = devm_reset_control_get(&pdev->dev, NULL);
749 if (IS_ERR(glue->rst))
750 return dev_err_probe(&pdev->dev, PTR_ERR(glue->rst),
751 "Error getting reset\n");
752 }
753
754 glue->extcon = extcon_get_edev_by_phandle(&pdev->dev, 0);
755 if (IS_ERR(glue->extcon))
756 return dev_err_probe(&pdev->dev, PTR_ERR(glue->extcon),
757 "Invalid or missing extcon\n");
758
759 glue->phy = devm_phy_get(&pdev->dev, "usb");
760 if (IS_ERR(glue->phy))
761 return dev_err_probe(&pdev->dev, PTR_ERR(glue->phy),
762 "Error getting phy\n");
763
764 glue->usb_phy = usb_phy_generic_register();
765 if (IS_ERR(glue->usb_phy)) {
766 dev_err(&pdev->dev, "Error registering usb-phy %ld\n",
767 PTR_ERR(glue->usb_phy));
768 return PTR_ERR(glue->usb_phy);
769 }
770
771 glue->xceiv = devm_usb_get_phy(&pdev->dev, USB_PHY_TYPE_USB2);
772 if (IS_ERR(glue->xceiv)) {
773 ret = PTR_ERR(glue->xceiv);
774 dev_err(&pdev->dev, "Error getting usb-phy %d\n", ret);
775 goto err_unregister_usb_phy;
776 }
777
778 platform_set_drvdata(pdev, glue);
779
780 memset(&pinfo, 0, sizeof(pinfo));
781 pinfo.name = "musb-hdrc";
782 pinfo.id = PLATFORM_DEVID_AUTO;
783 pinfo.parent = &pdev->dev;
784 pinfo.fwnode = of_fwnode_handle(pdev->dev.of_node);
785 pinfo.of_node_reused = true;
786 pinfo.res = pdev->resource;
787 pinfo.num_res = pdev->num_resources;
788 pinfo.data = &pdata;
789 pinfo.size_data = sizeof(pdata);
790
791 glue->musb_pdev = platform_device_register_full(&pinfo);
792 if (IS_ERR(glue->musb_pdev)) {
793 ret = PTR_ERR(glue->musb_pdev);
794 dev_err(&pdev->dev, "Error registering musb dev: %d\n", ret);
795 goto err_unregister_usb_phy;
796 }
797
798 return 0;
799
800err_unregister_usb_phy:
801 usb_phy_generic_unregister(glue->usb_phy);
802 return ret;
803}
804
805static void sunxi_musb_remove(struct platform_device *pdev)
806{
807 struct sunxi_glue *glue = platform_get_drvdata(pdev);
808 struct platform_device *usb_phy = glue->usb_phy;
809
810 platform_device_unregister(glue->musb_pdev);
811 usb_phy_generic_unregister(usb_phy);
812}
813
814static const struct sunxi_musb_cfg sun4i_a10_musb_cfg = {
815 .hdrc_config = &sunxi_musb_hdrc_config_5eps,
816 .has_sram = true,
817};
818
819static const struct sunxi_musb_cfg sun6i_a31_musb_cfg = {
820 .hdrc_config = &sunxi_musb_hdrc_config_5eps,
821 .has_reset = true,
822};
823
824static const struct sunxi_musb_cfg sun8i_a33_musb_cfg = {
825 .hdrc_config = &sunxi_musb_hdrc_config_5eps,
826 .has_reset = true,
827 .no_configdata = true,
828};
829
830static const struct sunxi_musb_cfg sun8i_h3_musb_cfg = {
831 .hdrc_config = &sunxi_musb_hdrc_config_4eps,
832 .has_reset = true,
833 .no_configdata = true,
834};
835
836static const struct sunxi_musb_cfg suniv_f1c100s_musb_cfg = {
837 .hdrc_config = &sunxi_musb_hdrc_config_5eps,
838 .has_sram = true,
839 .has_reset = true,
840 .no_configdata = true,
841};
842
843static const struct of_device_id sunxi_musb_match[] = {
844 { .compatible = "allwinner,sun4i-a10-musb",
845 .data = &sun4i_a10_musb_cfg, },
846 { .compatible = "allwinner,sun6i-a31-musb",
847 .data = &sun6i_a31_musb_cfg, },
848 { .compatible = "allwinner,sun8i-a33-musb",
849 .data = &sun8i_a33_musb_cfg, },
850 { .compatible = "allwinner,sun8i-h3-musb",
851 .data = &sun8i_h3_musb_cfg, },
852 { .compatible = "allwinner,suniv-f1c100s-musb",
853 .data = &suniv_f1c100s_musb_cfg, },
854 {}
855};
856MODULE_DEVICE_TABLE(of, sunxi_musb_match);
857
858static struct platform_driver sunxi_musb_driver = {
859 .probe = sunxi_musb_probe,
860 .remove = sunxi_musb_remove,
861 .driver = {
862 .name = "musb-sunxi",
863 .of_match_table = sunxi_musb_match,
864 },
865};
866module_platform_driver(sunxi_musb_driver);
867
868MODULE_DESCRIPTION("Allwinner sunxi MUSB Glue Layer");
869MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
870MODULE_LICENSE("GPL v2");
1/*
2 * Allwinner sun4i MUSB Glue Layer
3 *
4 * Copyright (C) 2015 Hans de Goede <hdegoede@redhat.com>
5 *
6 * Based on code from
7 * Allwinner Technology Co., Ltd. <www.allwinnertech.com>
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 */
19
20#include <linux/clk.h>
21#include <linux/err.h>
22#include <linux/extcon.h>
23#include <linux/io.h>
24#include <linux/kernel.h>
25#include <linux/module.h>
26#include <linux/of.h>
27#include <linux/phy/phy-sun4i-usb.h>
28#include <linux/platform_device.h>
29#include <linux/reset.h>
30#include <linux/soc/sunxi/sunxi_sram.h>
31#include <linux/usb/musb.h>
32#include <linux/usb/of.h>
33#include <linux/usb/usb_phy_generic.h>
34#include <linux/workqueue.h>
35#include "musb_core.h"
36
37/*
38 * Register offsets, note sunxi musb has a different layout then most
39 * musb implementations, we translate the layout in musb_readb & friends.
40 */
41#define SUNXI_MUSB_POWER 0x0040
42#define SUNXI_MUSB_DEVCTL 0x0041
43#define SUNXI_MUSB_INDEX 0x0042
44#define SUNXI_MUSB_VEND0 0x0043
45#define SUNXI_MUSB_INTRTX 0x0044
46#define SUNXI_MUSB_INTRRX 0x0046
47#define SUNXI_MUSB_INTRTXE 0x0048
48#define SUNXI_MUSB_INTRRXE 0x004a
49#define SUNXI_MUSB_INTRUSB 0x004c
50#define SUNXI_MUSB_INTRUSBE 0x0050
51#define SUNXI_MUSB_FRAME 0x0054
52#define SUNXI_MUSB_TXFIFOSZ 0x0090
53#define SUNXI_MUSB_TXFIFOADD 0x0092
54#define SUNXI_MUSB_RXFIFOSZ 0x0094
55#define SUNXI_MUSB_RXFIFOADD 0x0096
56#define SUNXI_MUSB_FADDR 0x0098
57#define SUNXI_MUSB_TXFUNCADDR 0x0098
58#define SUNXI_MUSB_TXHUBADDR 0x009a
59#define SUNXI_MUSB_TXHUBPORT 0x009b
60#define SUNXI_MUSB_RXFUNCADDR 0x009c
61#define SUNXI_MUSB_RXHUBADDR 0x009e
62#define SUNXI_MUSB_RXHUBPORT 0x009f
63#define SUNXI_MUSB_CONFIGDATA 0x00c0
64
65/* VEND0 bits */
66#define SUNXI_MUSB_VEND0_PIO_MODE 0
67
68/* flags */
69#define SUNXI_MUSB_FL_ENABLED 0
70#define SUNXI_MUSB_FL_HOSTMODE 1
71#define SUNXI_MUSB_FL_HOSTMODE_PEND 2
72#define SUNXI_MUSB_FL_VBUS_ON 3
73#define SUNXI_MUSB_FL_PHY_ON 4
74#define SUNXI_MUSB_FL_HAS_SRAM 5
75#define SUNXI_MUSB_FL_HAS_RESET 6
76#define SUNXI_MUSB_FL_NO_CONFIGDATA 7
77#define SUNXI_MUSB_FL_PHY_MODE_PEND 8
78
79/* Our read/write methods need access and do not get passed in a musb ref :| */
80static struct musb *sunxi_musb;
81
82struct sunxi_glue {
83 struct device *dev;
84 struct musb *musb;
85 struct platform_device *musb_pdev;
86 struct clk *clk;
87 struct reset_control *rst;
88 struct phy *phy;
89 struct platform_device *usb_phy;
90 struct usb_phy *xceiv;
91 enum phy_mode phy_mode;
92 unsigned long flags;
93 struct work_struct work;
94 struct extcon_dev *extcon;
95 struct notifier_block host_nb;
96};
97
98/* phy_power_on / off may sleep, so we use a workqueue */
99static void sunxi_musb_work(struct work_struct *work)
100{
101 struct sunxi_glue *glue = container_of(work, struct sunxi_glue, work);
102 bool vbus_on, phy_on;
103
104 if (!test_bit(SUNXI_MUSB_FL_ENABLED, &glue->flags))
105 return;
106
107 if (test_and_clear_bit(SUNXI_MUSB_FL_HOSTMODE_PEND, &glue->flags)) {
108 struct musb *musb = glue->musb;
109 unsigned long flags;
110 u8 devctl;
111
112 spin_lock_irqsave(&musb->lock, flags);
113
114 devctl = readb(musb->mregs + SUNXI_MUSB_DEVCTL);
115 if (test_bit(SUNXI_MUSB_FL_HOSTMODE, &glue->flags)) {
116 set_bit(SUNXI_MUSB_FL_VBUS_ON, &glue->flags);
117 musb->xceiv->otg->default_a = 1;
118 musb->xceiv->otg->state = OTG_STATE_A_WAIT_VRISE;
119 MUSB_HST_MODE(musb);
120 devctl |= MUSB_DEVCTL_SESSION;
121 } else {
122 clear_bit(SUNXI_MUSB_FL_VBUS_ON, &glue->flags);
123 musb->xceiv->otg->default_a = 0;
124 musb->xceiv->otg->state = OTG_STATE_B_IDLE;
125 MUSB_DEV_MODE(musb);
126 devctl &= ~MUSB_DEVCTL_SESSION;
127 }
128 writeb(devctl, musb->mregs + SUNXI_MUSB_DEVCTL);
129
130 spin_unlock_irqrestore(&musb->lock, flags);
131 }
132
133 vbus_on = test_bit(SUNXI_MUSB_FL_VBUS_ON, &glue->flags);
134 phy_on = test_bit(SUNXI_MUSB_FL_PHY_ON, &glue->flags);
135
136 if (phy_on != vbus_on) {
137 if (vbus_on) {
138 phy_power_on(glue->phy);
139 set_bit(SUNXI_MUSB_FL_PHY_ON, &glue->flags);
140 } else {
141 phy_power_off(glue->phy);
142 clear_bit(SUNXI_MUSB_FL_PHY_ON, &glue->flags);
143 }
144 }
145
146 if (test_and_clear_bit(SUNXI_MUSB_FL_PHY_MODE_PEND, &glue->flags))
147 phy_set_mode(glue->phy, glue->phy_mode);
148}
149
150static void sunxi_musb_set_vbus(struct musb *musb, int is_on)
151{
152 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
153
154 if (is_on) {
155 set_bit(SUNXI_MUSB_FL_VBUS_ON, &glue->flags);
156 musb->xceiv->otg->state = OTG_STATE_A_WAIT_VRISE;
157 } else {
158 clear_bit(SUNXI_MUSB_FL_VBUS_ON, &glue->flags);
159 }
160
161 schedule_work(&glue->work);
162}
163
164static void sunxi_musb_pre_root_reset_end(struct musb *musb)
165{
166 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
167
168 sun4i_usb_phy_set_squelch_detect(glue->phy, false);
169}
170
171static void sunxi_musb_post_root_reset_end(struct musb *musb)
172{
173 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
174
175 sun4i_usb_phy_set_squelch_detect(glue->phy, true);
176}
177
178static irqreturn_t sunxi_musb_interrupt(int irq, void *__hci)
179{
180 struct musb *musb = __hci;
181 unsigned long flags;
182
183 spin_lock_irqsave(&musb->lock, flags);
184
185 musb->int_usb = readb(musb->mregs + SUNXI_MUSB_INTRUSB);
186 if (musb->int_usb)
187 writeb(musb->int_usb, musb->mregs + SUNXI_MUSB_INTRUSB);
188
189 if ((musb->int_usb & MUSB_INTR_RESET) && !is_host_active(musb)) {
190 /* ep0 FADDR must be 0 when (re)entering peripheral mode */
191 musb_ep_select(musb->mregs, 0);
192 musb_writeb(musb->mregs, MUSB_FADDR, 0);
193 }
194
195 musb->int_tx = readw(musb->mregs + SUNXI_MUSB_INTRTX);
196 if (musb->int_tx)
197 writew(musb->int_tx, musb->mregs + SUNXI_MUSB_INTRTX);
198
199 musb->int_rx = readw(musb->mregs + SUNXI_MUSB_INTRRX);
200 if (musb->int_rx)
201 writew(musb->int_rx, musb->mregs + SUNXI_MUSB_INTRRX);
202
203 musb_interrupt(musb);
204
205 spin_unlock_irqrestore(&musb->lock, flags);
206
207 return IRQ_HANDLED;
208}
209
210static int sunxi_musb_host_notifier(struct notifier_block *nb,
211 unsigned long event, void *ptr)
212{
213 struct sunxi_glue *glue = container_of(nb, struct sunxi_glue, host_nb);
214
215 if (event)
216 set_bit(SUNXI_MUSB_FL_HOSTMODE, &glue->flags);
217 else
218 clear_bit(SUNXI_MUSB_FL_HOSTMODE, &glue->flags);
219
220 set_bit(SUNXI_MUSB_FL_HOSTMODE_PEND, &glue->flags);
221 schedule_work(&glue->work);
222
223 return NOTIFY_DONE;
224}
225
226static int sunxi_musb_init(struct musb *musb)
227{
228 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
229 int ret;
230
231 sunxi_musb = musb;
232 musb->phy = glue->phy;
233 musb->xceiv = glue->xceiv;
234
235 if (test_bit(SUNXI_MUSB_FL_HAS_SRAM, &glue->flags)) {
236 ret = sunxi_sram_claim(musb->controller->parent);
237 if (ret)
238 return ret;
239 }
240
241 ret = clk_prepare_enable(glue->clk);
242 if (ret)
243 goto error_sram_release;
244
245 if (test_bit(SUNXI_MUSB_FL_HAS_RESET, &glue->flags)) {
246 ret = reset_control_deassert(glue->rst);
247 if (ret)
248 goto error_clk_disable;
249 }
250
251 writeb(SUNXI_MUSB_VEND0_PIO_MODE, musb->mregs + SUNXI_MUSB_VEND0);
252
253 /* Register notifier before calling phy_init() */
254 ret = extcon_register_notifier(glue->extcon, EXTCON_USB_HOST,
255 &glue->host_nb);
256 if (ret)
257 goto error_reset_assert;
258
259 ret = phy_init(glue->phy);
260 if (ret)
261 goto error_unregister_notifier;
262
263 musb->isr = sunxi_musb_interrupt;
264
265 /* Stop the musb-core from doing runtime pm (not supported on sunxi) */
266 pm_runtime_get(musb->controller);
267
268 return 0;
269
270error_unregister_notifier:
271 extcon_unregister_notifier(glue->extcon, EXTCON_USB_HOST,
272 &glue->host_nb);
273error_reset_assert:
274 if (test_bit(SUNXI_MUSB_FL_HAS_RESET, &glue->flags))
275 reset_control_assert(glue->rst);
276error_clk_disable:
277 clk_disable_unprepare(glue->clk);
278error_sram_release:
279 if (test_bit(SUNXI_MUSB_FL_HAS_SRAM, &glue->flags))
280 sunxi_sram_release(musb->controller->parent);
281 return ret;
282}
283
284static int sunxi_musb_exit(struct musb *musb)
285{
286 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
287
288 pm_runtime_put(musb->controller);
289
290 cancel_work_sync(&glue->work);
291 if (test_bit(SUNXI_MUSB_FL_PHY_ON, &glue->flags))
292 phy_power_off(glue->phy);
293
294 phy_exit(glue->phy);
295
296 extcon_unregister_notifier(glue->extcon, EXTCON_USB_HOST,
297 &glue->host_nb);
298
299 if (test_bit(SUNXI_MUSB_FL_HAS_RESET, &glue->flags))
300 reset_control_assert(glue->rst);
301
302 clk_disable_unprepare(glue->clk);
303 if (test_bit(SUNXI_MUSB_FL_HAS_SRAM, &glue->flags))
304 sunxi_sram_release(musb->controller->parent);
305
306 return 0;
307}
308
309static void sunxi_musb_enable(struct musb *musb)
310{
311 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
312
313 glue->musb = musb;
314
315 /* musb_core does not call us in a balanced manner */
316 if (test_and_set_bit(SUNXI_MUSB_FL_ENABLED, &glue->flags))
317 return;
318
319 schedule_work(&glue->work);
320}
321
322static void sunxi_musb_disable(struct musb *musb)
323{
324 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
325
326 clear_bit(SUNXI_MUSB_FL_ENABLED, &glue->flags);
327}
328
329static struct dma_controller *
330sunxi_musb_dma_controller_create(struct musb *musb, void __iomem *base)
331{
332 return NULL;
333}
334
335static void sunxi_musb_dma_controller_destroy(struct dma_controller *c)
336{
337}
338
339static int sunxi_musb_set_mode(struct musb *musb, u8 mode)
340{
341 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
342 enum phy_mode new_mode;
343
344 switch (mode) {
345 case MUSB_HOST:
346 new_mode = PHY_MODE_USB_HOST;
347 break;
348 case MUSB_PERIPHERAL:
349 new_mode = PHY_MODE_USB_DEVICE;
350 break;
351 case MUSB_OTG:
352 new_mode = PHY_MODE_USB_OTG;
353 break;
354 default:
355 dev_err(musb->controller->parent,
356 "Error requested mode not supported by this kernel\n");
357 return -EINVAL;
358 }
359
360 if (glue->phy_mode == new_mode)
361 return 0;
362
363 if (musb->port_mode != MUSB_PORT_MODE_DUAL_ROLE) {
364 dev_err(musb->controller->parent,
365 "Error changing modes is only supported in dual role mode\n");
366 return -EINVAL;
367 }
368
369 if (musb->port1_status & USB_PORT_STAT_ENABLE)
370 musb_root_disconnect(musb);
371
372 /*
373 * phy_set_mode may sleep, and we're called with a spinlock held,
374 * so let sunxi_musb_work deal with it.
375 */
376 glue->phy_mode = new_mode;
377 set_bit(SUNXI_MUSB_FL_PHY_MODE_PEND, &glue->flags);
378 schedule_work(&glue->work);
379
380 return 0;
381}
382
383static int sunxi_musb_recover(struct musb *musb)
384{
385 struct sunxi_glue *glue = dev_get_drvdata(musb->controller->parent);
386
387 /*
388 * Schedule a phy_set_mode with the current glue->phy_mode value,
389 * this will force end the current session.
390 */
391 set_bit(SUNXI_MUSB_FL_PHY_MODE_PEND, &glue->flags);
392 schedule_work(&glue->work);
393
394 return 0;
395}
396
397/*
398 * sunxi musb register layout
399 * 0x00 - 0x17 fifo regs, 1 long per fifo
400 * 0x40 - 0x57 generic control regs (power - frame)
401 * 0x80 - 0x8f ep control regs (addressed through hw_ep->regs, indexed)
402 * 0x90 - 0x97 fifo control regs (indexed)
403 * 0x98 - 0x9f multipoint / busctl regs (indexed)
404 * 0xc0 configdata reg
405 */
406
407static u32 sunxi_musb_fifo_offset(u8 epnum)
408{
409 return (epnum * 4);
410}
411
412static u32 sunxi_musb_ep_offset(u8 epnum, u16 offset)
413{
414 WARN_ONCE(offset != 0,
415 "sunxi_musb_ep_offset called with non 0 offset\n");
416
417 return 0x80; /* indexed, so ignore epnum */
418}
419
420static u32 sunxi_musb_busctl_offset(u8 epnum, u16 offset)
421{
422 return SUNXI_MUSB_TXFUNCADDR + offset;
423}
424
425static u8 sunxi_musb_readb(const void __iomem *addr, unsigned offset)
426{
427 struct sunxi_glue *glue;
428
429 if (addr == sunxi_musb->mregs) {
430 /* generic control or fifo control reg access */
431 switch (offset) {
432 case MUSB_FADDR:
433 return readb(addr + SUNXI_MUSB_FADDR);
434 case MUSB_POWER:
435 return readb(addr + SUNXI_MUSB_POWER);
436 case MUSB_INTRUSB:
437 return readb(addr + SUNXI_MUSB_INTRUSB);
438 case MUSB_INTRUSBE:
439 return readb(addr + SUNXI_MUSB_INTRUSBE);
440 case MUSB_INDEX:
441 return readb(addr + SUNXI_MUSB_INDEX);
442 case MUSB_TESTMODE:
443 return 0; /* No testmode on sunxi */
444 case MUSB_DEVCTL:
445 return readb(addr + SUNXI_MUSB_DEVCTL);
446 case MUSB_TXFIFOSZ:
447 return readb(addr + SUNXI_MUSB_TXFIFOSZ);
448 case MUSB_RXFIFOSZ:
449 return readb(addr + SUNXI_MUSB_RXFIFOSZ);
450 case MUSB_CONFIGDATA + 0x10: /* See musb_read_configdata() */
451 glue = dev_get_drvdata(sunxi_musb->controller->parent);
452 /* A33 saves a reg, and we get to hardcode this */
453 if (test_bit(SUNXI_MUSB_FL_NO_CONFIGDATA,
454 &glue->flags))
455 return 0xde;
456
457 return readb(addr + SUNXI_MUSB_CONFIGDATA);
458 /* Offset for these is fixed by sunxi_musb_busctl_offset() */
459 case SUNXI_MUSB_TXFUNCADDR:
460 case SUNXI_MUSB_TXHUBADDR:
461 case SUNXI_MUSB_TXHUBPORT:
462 case SUNXI_MUSB_RXFUNCADDR:
463 case SUNXI_MUSB_RXHUBADDR:
464 case SUNXI_MUSB_RXHUBPORT:
465 /* multipoint / busctl reg access */
466 return readb(addr + offset);
467 default:
468 dev_err(sunxi_musb->controller->parent,
469 "Error unknown readb offset %u\n", offset);
470 return 0;
471 }
472 } else if (addr == (sunxi_musb->mregs + 0x80)) {
473 /* ep control reg access */
474 /* sunxi has a 2 byte hole before the txtype register */
475 if (offset >= MUSB_TXTYPE)
476 offset += 2;
477 return readb(addr + offset);
478 }
479
480 dev_err(sunxi_musb->controller->parent,
481 "Error unknown readb at 0x%x bytes offset\n",
482 (int)(addr - sunxi_musb->mregs));
483 return 0;
484}
485
486static void sunxi_musb_writeb(void __iomem *addr, unsigned offset, u8 data)
487{
488 if (addr == sunxi_musb->mregs) {
489 /* generic control or fifo control reg access */
490 switch (offset) {
491 case MUSB_FADDR:
492 return writeb(data, addr + SUNXI_MUSB_FADDR);
493 case MUSB_POWER:
494 return writeb(data, addr + SUNXI_MUSB_POWER);
495 case MUSB_INTRUSB:
496 return writeb(data, addr + SUNXI_MUSB_INTRUSB);
497 case MUSB_INTRUSBE:
498 return writeb(data, addr + SUNXI_MUSB_INTRUSBE);
499 case MUSB_INDEX:
500 return writeb(data, addr + SUNXI_MUSB_INDEX);
501 case MUSB_TESTMODE:
502 if (data)
503 dev_warn(sunxi_musb->controller->parent,
504 "sunxi-musb does not have testmode\n");
505 return;
506 case MUSB_DEVCTL:
507 return writeb(data, addr + SUNXI_MUSB_DEVCTL);
508 case MUSB_TXFIFOSZ:
509 return writeb(data, addr + SUNXI_MUSB_TXFIFOSZ);
510 case MUSB_RXFIFOSZ:
511 return writeb(data, addr + SUNXI_MUSB_RXFIFOSZ);
512 /* Offset for these is fixed by sunxi_musb_busctl_offset() */
513 case SUNXI_MUSB_TXFUNCADDR:
514 case SUNXI_MUSB_TXHUBADDR:
515 case SUNXI_MUSB_TXHUBPORT:
516 case SUNXI_MUSB_RXFUNCADDR:
517 case SUNXI_MUSB_RXHUBADDR:
518 case SUNXI_MUSB_RXHUBPORT:
519 /* multipoint / busctl reg access */
520 return writeb(data, addr + offset);
521 default:
522 dev_err(sunxi_musb->controller->parent,
523 "Error unknown writeb offset %u\n", offset);
524 return;
525 }
526 } else if (addr == (sunxi_musb->mregs + 0x80)) {
527 /* ep control reg access */
528 if (offset >= MUSB_TXTYPE)
529 offset += 2;
530 return writeb(data, addr + offset);
531 }
532
533 dev_err(sunxi_musb->controller->parent,
534 "Error unknown writeb at 0x%x bytes offset\n",
535 (int)(addr - sunxi_musb->mregs));
536}
537
538static u16 sunxi_musb_readw(const void __iomem *addr, unsigned offset)
539{
540 if (addr == sunxi_musb->mregs) {
541 /* generic control or fifo control reg access */
542 switch (offset) {
543 case MUSB_INTRTX:
544 return readw(addr + SUNXI_MUSB_INTRTX);
545 case MUSB_INTRRX:
546 return readw(addr + SUNXI_MUSB_INTRRX);
547 case MUSB_INTRTXE:
548 return readw(addr + SUNXI_MUSB_INTRTXE);
549 case MUSB_INTRRXE:
550 return readw(addr + SUNXI_MUSB_INTRRXE);
551 case MUSB_FRAME:
552 return readw(addr + SUNXI_MUSB_FRAME);
553 case MUSB_TXFIFOADD:
554 return readw(addr + SUNXI_MUSB_TXFIFOADD);
555 case MUSB_RXFIFOADD:
556 return readw(addr + SUNXI_MUSB_RXFIFOADD);
557 case MUSB_HWVERS:
558 return 0; /* sunxi musb version is not known */
559 default:
560 dev_err(sunxi_musb->controller->parent,
561 "Error unknown readw offset %u\n", offset);
562 return 0;
563 }
564 } else if (addr == (sunxi_musb->mregs + 0x80)) {
565 /* ep control reg access */
566 return readw(addr + offset);
567 }
568
569 dev_err(sunxi_musb->controller->parent,
570 "Error unknown readw at 0x%x bytes offset\n",
571 (int)(addr - sunxi_musb->mregs));
572 return 0;
573}
574
575static void sunxi_musb_writew(void __iomem *addr, unsigned offset, u16 data)
576{
577 if (addr == sunxi_musb->mregs) {
578 /* generic control or fifo control reg access */
579 switch (offset) {
580 case MUSB_INTRTX:
581 return writew(data, addr + SUNXI_MUSB_INTRTX);
582 case MUSB_INTRRX:
583 return writew(data, addr + SUNXI_MUSB_INTRRX);
584 case MUSB_INTRTXE:
585 return writew(data, addr + SUNXI_MUSB_INTRTXE);
586 case MUSB_INTRRXE:
587 return writew(data, addr + SUNXI_MUSB_INTRRXE);
588 case MUSB_FRAME:
589 return writew(data, addr + SUNXI_MUSB_FRAME);
590 case MUSB_TXFIFOADD:
591 return writew(data, addr + SUNXI_MUSB_TXFIFOADD);
592 case MUSB_RXFIFOADD:
593 return writew(data, addr + SUNXI_MUSB_RXFIFOADD);
594 default:
595 dev_err(sunxi_musb->controller->parent,
596 "Error unknown writew offset %u\n", offset);
597 return;
598 }
599 } else if (addr == (sunxi_musb->mregs + 0x80)) {
600 /* ep control reg access */
601 return writew(data, addr + offset);
602 }
603
604 dev_err(sunxi_musb->controller->parent,
605 "Error unknown writew at 0x%x bytes offset\n",
606 (int)(addr - sunxi_musb->mregs));
607}
608
609static const struct musb_platform_ops sunxi_musb_ops = {
610 .quirks = MUSB_INDEXED_EP,
611 .init = sunxi_musb_init,
612 .exit = sunxi_musb_exit,
613 .enable = sunxi_musb_enable,
614 .disable = sunxi_musb_disable,
615 .fifo_offset = sunxi_musb_fifo_offset,
616 .ep_offset = sunxi_musb_ep_offset,
617 .busctl_offset = sunxi_musb_busctl_offset,
618 .readb = sunxi_musb_readb,
619 .writeb = sunxi_musb_writeb,
620 .readw = sunxi_musb_readw,
621 .writew = sunxi_musb_writew,
622 .dma_init = sunxi_musb_dma_controller_create,
623 .dma_exit = sunxi_musb_dma_controller_destroy,
624 .set_mode = sunxi_musb_set_mode,
625 .recover = sunxi_musb_recover,
626 .set_vbus = sunxi_musb_set_vbus,
627 .pre_root_reset_end = sunxi_musb_pre_root_reset_end,
628 .post_root_reset_end = sunxi_musb_post_root_reset_end,
629};
630
631/* Allwinner OTG supports up to 5 endpoints */
632#define SUNXI_MUSB_MAX_EP_NUM 6
633#define SUNXI_MUSB_RAM_BITS 11
634
635static struct musb_fifo_cfg sunxi_musb_mode_cfg[] = {
636 MUSB_EP_FIFO_SINGLE(1, FIFO_TX, 512),
637 MUSB_EP_FIFO_SINGLE(1, FIFO_RX, 512),
638 MUSB_EP_FIFO_SINGLE(2, FIFO_TX, 512),
639 MUSB_EP_FIFO_SINGLE(2, FIFO_RX, 512),
640 MUSB_EP_FIFO_SINGLE(3, FIFO_TX, 512),
641 MUSB_EP_FIFO_SINGLE(3, FIFO_RX, 512),
642 MUSB_EP_FIFO_SINGLE(4, FIFO_TX, 512),
643 MUSB_EP_FIFO_SINGLE(4, FIFO_RX, 512),
644 MUSB_EP_FIFO_SINGLE(5, FIFO_TX, 512),
645 MUSB_EP_FIFO_SINGLE(5, FIFO_RX, 512),
646};
647
648static struct musb_hdrc_config sunxi_musb_hdrc_config = {
649 .fifo_cfg = sunxi_musb_mode_cfg,
650 .fifo_cfg_size = ARRAY_SIZE(sunxi_musb_mode_cfg),
651 .multipoint = true,
652 .dyn_fifo = true,
653 .soft_con = true,
654 .num_eps = SUNXI_MUSB_MAX_EP_NUM,
655 .ram_bits = SUNXI_MUSB_RAM_BITS,
656 .dma = 0,
657};
658
659static int sunxi_musb_probe(struct platform_device *pdev)
660{
661 struct musb_hdrc_platform_data pdata;
662 struct platform_device_info pinfo;
663 struct sunxi_glue *glue;
664 struct device_node *np = pdev->dev.of_node;
665 int ret;
666
667 if (!np) {
668 dev_err(&pdev->dev, "Error no device tree node found\n");
669 return -EINVAL;
670 }
671
672 glue = devm_kzalloc(&pdev->dev, sizeof(*glue), GFP_KERNEL);
673 if (!glue)
674 return -ENOMEM;
675
676 memset(&pdata, 0, sizeof(pdata));
677 switch (usb_get_dr_mode(&pdev->dev)) {
678#if defined CONFIG_USB_MUSB_DUAL_ROLE || defined CONFIG_USB_MUSB_HOST
679 case USB_DR_MODE_HOST:
680 pdata.mode = MUSB_PORT_MODE_HOST;
681 glue->phy_mode = PHY_MODE_USB_HOST;
682 break;
683#endif
684#if defined CONFIG_USB_MUSB_DUAL_ROLE || defined CONFIG_USB_MUSB_GADGET
685 case USB_DR_MODE_PERIPHERAL:
686 pdata.mode = MUSB_PORT_MODE_GADGET;
687 glue->phy_mode = PHY_MODE_USB_DEVICE;
688 break;
689#endif
690#ifdef CONFIG_USB_MUSB_DUAL_ROLE
691 case USB_DR_MODE_OTG:
692 pdata.mode = MUSB_PORT_MODE_DUAL_ROLE;
693 glue->phy_mode = PHY_MODE_USB_OTG;
694 break;
695#endif
696 default:
697 dev_err(&pdev->dev, "Invalid or missing 'dr_mode' property\n");
698 return -EINVAL;
699 }
700 pdata.platform_ops = &sunxi_musb_ops;
701 pdata.config = &sunxi_musb_hdrc_config;
702
703 glue->dev = &pdev->dev;
704 INIT_WORK(&glue->work, sunxi_musb_work);
705 glue->host_nb.notifier_call = sunxi_musb_host_notifier;
706
707 if (of_device_is_compatible(np, "allwinner,sun4i-a10-musb"))
708 set_bit(SUNXI_MUSB_FL_HAS_SRAM, &glue->flags);
709
710 if (of_device_is_compatible(np, "allwinner,sun6i-a31-musb"))
711 set_bit(SUNXI_MUSB_FL_HAS_RESET, &glue->flags);
712
713 if (of_device_is_compatible(np, "allwinner,sun8i-a33-musb")) {
714 set_bit(SUNXI_MUSB_FL_HAS_RESET, &glue->flags);
715 set_bit(SUNXI_MUSB_FL_NO_CONFIGDATA, &glue->flags);
716 }
717
718 glue->clk = devm_clk_get(&pdev->dev, NULL);
719 if (IS_ERR(glue->clk)) {
720 dev_err(&pdev->dev, "Error getting clock: %ld\n",
721 PTR_ERR(glue->clk));
722 return PTR_ERR(glue->clk);
723 }
724
725 if (test_bit(SUNXI_MUSB_FL_HAS_RESET, &glue->flags)) {
726 glue->rst = devm_reset_control_get(&pdev->dev, NULL);
727 if (IS_ERR(glue->rst)) {
728 if (PTR_ERR(glue->rst) == -EPROBE_DEFER)
729 return -EPROBE_DEFER;
730 dev_err(&pdev->dev, "Error getting reset %ld\n",
731 PTR_ERR(glue->rst));
732 return PTR_ERR(glue->rst);
733 }
734 }
735
736 glue->extcon = extcon_get_edev_by_phandle(&pdev->dev, 0);
737 if (IS_ERR(glue->extcon)) {
738 if (PTR_ERR(glue->extcon) == -EPROBE_DEFER)
739 return -EPROBE_DEFER;
740 dev_err(&pdev->dev, "Invalid or missing extcon\n");
741 return PTR_ERR(glue->extcon);
742 }
743
744 glue->phy = devm_phy_get(&pdev->dev, "usb");
745 if (IS_ERR(glue->phy)) {
746 if (PTR_ERR(glue->phy) == -EPROBE_DEFER)
747 return -EPROBE_DEFER;
748 dev_err(&pdev->dev, "Error getting phy %ld\n",
749 PTR_ERR(glue->phy));
750 return PTR_ERR(glue->phy);
751 }
752
753 glue->usb_phy = usb_phy_generic_register();
754 if (IS_ERR(glue->usb_phy)) {
755 dev_err(&pdev->dev, "Error registering usb-phy %ld\n",
756 PTR_ERR(glue->usb_phy));
757 return PTR_ERR(glue->usb_phy);
758 }
759
760 glue->xceiv = devm_usb_get_phy(&pdev->dev, USB_PHY_TYPE_USB2);
761 if (IS_ERR(glue->xceiv)) {
762 ret = PTR_ERR(glue->xceiv);
763 dev_err(&pdev->dev, "Error getting usb-phy %d\n", ret);
764 goto err_unregister_usb_phy;
765 }
766
767 platform_set_drvdata(pdev, glue);
768
769 memset(&pinfo, 0, sizeof(pinfo));
770 pinfo.name = "musb-hdrc";
771 pinfo.id = PLATFORM_DEVID_AUTO;
772 pinfo.parent = &pdev->dev;
773 pinfo.res = pdev->resource;
774 pinfo.num_res = pdev->num_resources;
775 pinfo.data = &pdata;
776 pinfo.size_data = sizeof(pdata);
777
778 glue->musb_pdev = platform_device_register_full(&pinfo);
779 if (IS_ERR(glue->musb_pdev)) {
780 ret = PTR_ERR(glue->musb_pdev);
781 dev_err(&pdev->dev, "Error registering musb dev: %d\n", ret);
782 goto err_unregister_usb_phy;
783 }
784
785 return 0;
786
787err_unregister_usb_phy:
788 usb_phy_generic_unregister(glue->usb_phy);
789 return ret;
790}
791
792static int sunxi_musb_remove(struct platform_device *pdev)
793{
794 struct sunxi_glue *glue = platform_get_drvdata(pdev);
795 struct platform_device *usb_phy = glue->usb_phy;
796
797 platform_device_unregister(glue->musb_pdev);
798 usb_phy_generic_unregister(usb_phy);
799
800 return 0;
801}
802
803static const struct of_device_id sunxi_musb_match[] = {
804 { .compatible = "allwinner,sun4i-a10-musb", },
805 { .compatible = "allwinner,sun6i-a31-musb", },
806 { .compatible = "allwinner,sun8i-a33-musb", },
807 {}
808};
809MODULE_DEVICE_TABLE(of, sunxi_musb_match);
810
811static struct platform_driver sunxi_musb_driver = {
812 .probe = sunxi_musb_probe,
813 .remove = sunxi_musb_remove,
814 .driver = {
815 .name = "musb-sunxi",
816 .of_match_table = sunxi_musb_match,
817 },
818};
819module_platform_driver(sunxi_musb_driver);
820
821MODULE_DESCRIPTION("Allwinner sunxi MUSB Glue Layer");
822MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
823MODULE_LICENSE("GPL v2");