4 * Copyright (C) 2011 Renesas Solutions Corp.
5 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17 #include <linux/err.h>
18 #include <linux/gpio.h>
20 #include <linux/module.h>
21 #include <linux/of_device.h>
22 #include <linux/of_gpio.h>
23 #include <linux/pm_runtime.h>
24 #include <linux/slab.h>
25 #include <linux/sysfs.h>
30 * image of renesas_usbhs
36 * mod_host.c pipe.c fifo.c
38 * +-------+ +-----------+
39 * | pipe0 |------>| fifo pio |
40 * +------------+ +-------+ +-----------+
41 * | mod_gadget |=====> | pipe1 |--+
42 * +------------+ +-------+ | +-----------+
43 * | pipe2 | | +-| fifo dma0 |
44 * +------------+ +-------+ | | +-----------+
45 * | mod_host | | pipe3 |<-|--+
46 * +------------+ +-------+ | +-----------+
47 * | .... | +--->| fifo dma1 |
48 * | .... | +-----------+
52 #define USBHSF_RUNTIME_PWCTRL (1 << 0)
55 #define usbhsc_flags_init(p) do {(p)->flags = 0; } while (0)
56 #define usbhsc_flags_set(p, b) ((p)->flags |= (b))
57 #define usbhsc_flags_clr(p, b) ((p)->flags &= ~(b))
58 #define usbhsc_flags_has(p, b) ((p)->flags & (b))
63 * renesas usb support platform callback function.
64 * Below macro call it.
65 * if platform doesn't have callback, it return 0 (no error)
67 #define usbhs_platform_call(priv, func, args...)\
68 (!(priv) ? -ENODEV : \
69 !((priv)->pfunc.func) ? 0 : \
70 (priv)->pfunc.func(args))
75 u16
usbhs_read(struct usbhs_priv
*priv
, u32 reg
)
77 return ioread16(priv
->base
+ reg
);
80 void usbhs_write(struct usbhs_priv
*priv
, u32 reg
, u16 data
)
82 iowrite16(data
, priv
->base
+ reg
);
85 void usbhs_bset(struct usbhs_priv
*priv
, u32 reg
, u16 mask
, u16 data
)
87 u16 val
= usbhs_read(priv
, reg
);
92 usbhs_write(priv
, reg
, val
);
95 struct usbhs_priv
*usbhs_pdev_to_priv(struct platform_device
*pdev
)
97 return dev_get_drvdata(&pdev
->dev
);
103 static void usbhs_sys_clock_ctrl(struct usbhs_priv
*priv
, int enable
)
105 usbhs_bset(priv
, SYSCFG
, SCKE
, enable
? SCKE
: 0);
108 void usbhs_sys_host_ctrl(struct usbhs_priv
*priv
, int enable
)
110 u16 mask
= DCFM
| DRPD
| DPRPU
| HSE
| USBE
;
111 u16 val
= DCFM
| DRPD
| HSE
| USBE
;
112 int has_otg
= usbhs_get_dparam(priv
, has_otg
);
115 usbhs_bset(priv
, DVSTCTR
, (EXTLP
| PWEN
), (EXTLP
| PWEN
));
121 * - D+ Line/D- Line Pull-down
123 usbhs_bset(priv
, SYSCFG
, mask
, enable
? val
: 0);
126 void usbhs_sys_function_ctrl(struct usbhs_priv
*priv
, int enable
)
128 u16 mask
= DCFM
| DRPD
| DPRPU
| HSE
| USBE
;
129 u16 val
= HSE
| USBE
;
134 * - select Function mode
135 * - D+ Line Pull-up is disabled
136 * When D+ Line Pull-up is enabled,
137 * calling usbhs_sys_function_pullup(,1)
139 usbhs_bset(priv
, SYSCFG
, mask
, enable
? val
: 0);
142 void usbhs_sys_function_pullup(struct usbhs_priv
*priv
, int enable
)
144 usbhs_bset(priv
, SYSCFG
, DPRPU
, enable
? DPRPU
: 0);
147 void usbhs_sys_set_test_mode(struct usbhs_priv
*priv
, u16 mode
)
149 usbhs_write(priv
, TESTMODE
, mode
);
155 int usbhs_frame_get_num(struct usbhs_priv
*priv
)
157 return usbhs_read(priv
, FRMNUM
) & FRNM_MASK
;
161 * usb request functions
163 void usbhs_usbreq_get_val(struct usbhs_priv
*priv
, struct usb_ctrlrequest
*req
)
167 val
= usbhs_read(priv
, USBREQ
);
168 req
->bRequest
= (val
>> 8) & 0xFF;
169 req
->bRequestType
= (val
>> 0) & 0xFF;
171 req
->wValue
= usbhs_read(priv
, USBVAL
);
172 req
->wIndex
= usbhs_read(priv
, USBINDX
);
173 req
->wLength
= usbhs_read(priv
, USBLENG
);
176 void usbhs_usbreq_set_val(struct usbhs_priv
*priv
, struct usb_ctrlrequest
*req
)
178 usbhs_write(priv
, USBREQ
, (req
->bRequest
<< 8) | req
->bRequestType
);
179 usbhs_write(priv
, USBVAL
, req
->wValue
);
180 usbhs_write(priv
, USBINDX
, req
->wIndex
);
181 usbhs_write(priv
, USBLENG
, req
->wLength
);
183 usbhs_bset(priv
, DCPCTR
, SUREQ
, SUREQ
);
189 void usbhs_bus_send_sof_enable(struct usbhs_priv
*priv
)
191 u16 status
= usbhs_read(priv
, DVSTCTR
) & (USBRST
| UACT
);
193 if (status
!= USBRST
) {
194 struct device
*dev
= usbhs_priv_to_dev(priv
);
195 dev_err(dev
, "usbhs should be reset\n");
198 usbhs_bset(priv
, DVSTCTR
, (USBRST
| UACT
), UACT
);
201 void usbhs_bus_send_reset(struct usbhs_priv
*priv
)
203 usbhs_bset(priv
, DVSTCTR
, (USBRST
| UACT
), USBRST
);
206 int usbhs_bus_get_speed(struct usbhs_priv
*priv
)
208 u16 dvstctr
= usbhs_read(priv
, DVSTCTR
);
210 switch (RHST
& dvstctr
) {
212 return USB_SPEED_LOW
;
213 case RHST_FULL_SPEED
:
214 return USB_SPEED_FULL
;
215 case RHST_HIGH_SPEED
:
216 return USB_SPEED_HIGH
;
219 return USB_SPEED_UNKNOWN
;
222 int usbhs_vbus_ctrl(struct usbhs_priv
*priv
, int enable
)
224 struct platform_device
*pdev
= usbhs_priv_to_pdev(priv
);
226 return usbhs_platform_call(priv
, set_vbus
, pdev
, enable
);
229 static void usbhsc_bus_init(struct usbhs_priv
*priv
)
231 usbhs_write(priv
, DVSTCTR
, 0);
233 usbhs_vbus_ctrl(priv
, 0);
237 * device configuration
239 int usbhs_set_device_config(struct usbhs_priv
*priv
, int devnum
,
240 u16 upphub
, u16 hubport
, u16 speed
)
242 struct device
*dev
= usbhs_priv_to_dev(priv
);
244 u32 reg
= DEVADD0
+ (2 * devnum
);
247 dev_err(dev
, "cannot set speed to unknown device %d\n", devnum
);
252 dev_err(dev
, "unsupported hub number %d\n", upphub
);
258 usbspd
= USBSPD_SPEED_LOW
;
261 usbspd
= USBSPD_SPEED_FULL
;
264 usbspd
= USBSPD_SPEED_HIGH
;
267 dev_err(dev
, "unsupported speed %d\n", speed
);
271 usbhs_write(priv
, reg
, UPPHUB(upphub
) |
279 * interrupt functions
281 void usbhs_xxxsts_clear(struct usbhs_priv
*priv
, u16 sts_reg
, u16 bit
)
283 u16 pipe_mask
= (u16
)GENMASK(usbhs_get_dparam(priv
, pipe_size
), 0);
285 usbhs_write(priv
, sts_reg
, ~(1 << bit
) & pipe_mask
);
291 static void usbhsc_set_buswait(struct usbhs_priv
*priv
)
293 int wait
= usbhs_get_dparam(priv
, buswait_bwait
);
295 /* set bus wait if platform have */
297 usbhs_bset(priv
, BUSWAIT
, 0x000F, wait
);
301 * platform default param
304 /* commonly used on old SH-Mobile SoCs */
305 static u32 usbhsc_default_pipe_type
[] = {
306 USB_ENDPOINT_XFER_CONTROL
,
307 USB_ENDPOINT_XFER_ISOC
,
308 USB_ENDPOINT_XFER_ISOC
,
309 USB_ENDPOINT_XFER_BULK
,
310 USB_ENDPOINT_XFER_BULK
,
311 USB_ENDPOINT_XFER_BULK
,
312 USB_ENDPOINT_XFER_INT
,
313 USB_ENDPOINT_XFER_INT
,
314 USB_ENDPOINT_XFER_INT
,
315 USB_ENDPOINT_XFER_INT
,
318 /* commonly used on newer SH-Mobile and R-Car SoCs */
319 static u32 usbhsc_new_pipe_type
[] = {
320 USB_ENDPOINT_XFER_CONTROL
,
321 USB_ENDPOINT_XFER_ISOC
,
322 USB_ENDPOINT_XFER_ISOC
,
323 USB_ENDPOINT_XFER_BULK
,
324 USB_ENDPOINT_XFER_BULK
,
325 USB_ENDPOINT_XFER_BULK
,
326 USB_ENDPOINT_XFER_INT
,
327 USB_ENDPOINT_XFER_INT
,
328 USB_ENDPOINT_XFER_INT
,
329 USB_ENDPOINT_XFER_BULK
,
330 USB_ENDPOINT_XFER_BULK
,
331 USB_ENDPOINT_XFER_BULK
,
332 USB_ENDPOINT_XFER_BULK
,
333 USB_ENDPOINT_XFER_BULK
,
334 USB_ENDPOINT_XFER_BULK
,
335 USB_ENDPOINT_XFER_BULK
,
341 static void usbhsc_power_ctrl(struct usbhs_priv
*priv
, int enable
)
343 struct platform_device
*pdev
= usbhs_priv_to_pdev(priv
);
344 struct device
*dev
= usbhs_priv_to_dev(priv
);
348 pm_runtime_get_sync(dev
);
350 /* enable platform power */
351 usbhs_platform_call(priv
, power_ctrl
, pdev
, priv
->base
, enable
);
354 usbhs_sys_clock_ctrl(priv
, enable
);
357 usbhs_sys_clock_ctrl(priv
, enable
);
359 /* disable platform power */
360 usbhs_platform_call(priv
, power_ctrl
, pdev
, priv
->base
, enable
);
363 pm_runtime_put_sync(dev
);
370 static void usbhsc_hotplug(struct usbhs_priv
*priv
)
372 struct platform_device
*pdev
= usbhs_priv_to_pdev(priv
);
373 struct usbhs_mod
*mod
= usbhs_mod_get_current(priv
);
380 * get vbus status from platform
382 enable
= usbhs_platform_call(priv
, get_vbus
, pdev
);
385 * get id from platform
387 id
= usbhs_platform_call(priv
, get_id
, pdev
);
389 if (enable
&& !mod
) {
391 cable
= extcon_get_cable_state_(priv
->edev
, EXTCON_USB_HOST
);
392 if ((cable
> 0 && id
!= USBHS_HOST
) ||
393 (!cable
&& id
!= USBHS_GADGET
)) {
395 "USB cable plugged in doesn't match the selected role!\n");
400 ret
= usbhs_mod_change(priv
, id
);
404 dev_dbg(&pdev
->dev
, "%s enable\n", __func__
);
407 if (usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
))
408 usbhsc_power_ctrl(priv
, enable
);
411 usbhsc_set_buswait(priv
);
412 usbhsc_bus_init(priv
);
415 usbhs_mod_call(priv
, start
, priv
);
417 } else if (!enable
&& mod
) {
418 dev_dbg(&pdev
->dev
, "%s disable\n", __func__
);
421 usbhs_mod_call(priv
, stop
, priv
);
424 usbhsc_bus_init(priv
);
427 if (usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
))
428 usbhsc_power_ctrl(priv
, enable
);
430 usbhs_mod_change(priv
, -1);
432 /* reset phy for next connection */
433 usbhs_platform_call(priv
, phy_reset
, pdev
);
440 static void usbhsc_notify_hotplug(struct work_struct
*work
)
442 struct usbhs_priv
*priv
= container_of(work
,
444 notify_hotplug_work
.work
);
445 usbhsc_hotplug(priv
);
448 static int usbhsc_drvcllbck_notify_hotplug(struct platform_device
*pdev
)
450 struct usbhs_priv
*priv
= usbhs_pdev_to_priv(pdev
);
451 int delay
= usbhs_get_dparam(priv
, detection_delay
);
454 * This functions will be called in interrupt.
455 * To make sure safety context,
456 * use workqueue for usbhs_notify_hotplug
458 schedule_delayed_work(&priv
->notify_hotplug_work
,
459 msecs_to_jiffies(delay
));
466 static const struct of_device_id usbhs_of_match
[] = {
468 .compatible
= "renesas,usbhs-r8a7790",
469 .data
= (void *)USBHS_TYPE_RCAR_GEN2
,
472 .compatible
= "renesas,usbhs-r8a7791",
473 .data
= (void *)USBHS_TYPE_RCAR_GEN2
,
476 .compatible
= "renesas,usbhs-r8a7794",
477 .data
= (void *)USBHS_TYPE_RCAR_GEN2
,
480 /* Gen3 is compatible with Gen2 */
481 .compatible
= "renesas,usbhs-r8a7795",
482 .data
= (void *)USBHS_TYPE_RCAR_GEN2
,
486 MODULE_DEVICE_TABLE(of
, usbhs_of_match
);
488 static struct renesas_usbhs_platform_info
*usbhs_parse_dt(struct device
*dev
)
490 struct renesas_usbhs_platform_info
*info
;
491 struct renesas_usbhs_driver_param
*dparam
;
492 const struct of_device_id
*of_id
= of_match_device(usbhs_of_match
, dev
);
496 info
= devm_kzalloc(dev
, sizeof(*info
), GFP_KERNEL
);
500 dparam
= &info
->driver_param
;
501 dparam
->type
= of_id
? (uintptr_t)of_id
->data
: 0;
502 if (!of_property_read_u32(dev
->of_node
, "renesas,buswait", &tmp
))
503 dparam
->buswait_bwait
= tmp
;
504 gpio
= of_get_named_gpio_flags(dev
->of_node
, "renesas,enable-gpio", 0,
507 dparam
->enable_gpio
= gpio
;
509 if (dparam
->type
== USBHS_TYPE_RCAR_GEN2
)
510 dparam
->has_usb_dmac
= 1;
515 static int usbhs_probe(struct platform_device
*pdev
)
517 struct renesas_usbhs_platform_info
*info
= dev_get_platdata(&pdev
->dev
);
518 struct renesas_usbhs_driver_callback
*dfunc
;
519 struct usbhs_priv
*priv
;
520 struct resource
*res
, *irq_res
;
523 /* check device node */
524 if (pdev
->dev
.of_node
)
525 info
= pdev
->dev
.platform_data
= usbhs_parse_dt(&pdev
->dev
);
527 /* check platform information */
529 dev_err(&pdev
->dev
, "no platform information\n");
534 irq_res
= platform_get_resource(pdev
, IORESOURCE_IRQ
, 0);
536 dev_err(&pdev
->dev
, "Not enough Renesas USB platform resources.\n");
540 /* usb private data */
541 priv
= devm_kzalloc(&pdev
->dev
, sizeof(*priv
), GFP_KERNEL
);
545 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
546 priv
->base
= devm_ioremap_resource(&pdev
->dev
, res
);
547 if (IS_ERR(priv
->base
))
548 return PTR_ERR(priv
->base
);
550 if (of_property_read_bool(pdev
->dev
.of_node
, "extcon")) {
551 priv
->edev
= extcon_get_edev_by_phandle(&pdev
->dev
, 0);
552 if (IS_ERR(priv
->edev
))
553 return PTR_ERR(priv
->edev
);
560 memcpy(&priv
->dparam
,
562 sizeof(struct renesas_usbhs_driver_param
));
564 switch (priv
->dparam
.type
) {
565 case USBHS_TYPE_RCAR_GEN2
:
566 priv
->pfunc
= usbhs_rcar2_ops
;
567 if (!priv
->dparam
.pipe_type
) {
568 priv
->dparam
.pipe_type
= usbhsc_new_pipe_type
;
569 priv
->dparam
.pipe_size
=
570 ARRAY_SIZE(usbhsc_new_pipe_type
);
574 if (!info
->platform_callback
.get_id
) {
575 dev_err(&pdev
->dev
, "no platform callbacks");
579 &info
->platform_callback
,
580 sizeof(struct renesas_usbhs_platform_callback
));
584 /* set driver callback functions for platform */
585 dfunc
= &info
->driver_callback
;
586 dfunc
->notify_hotplug
= usbhsc_drvcllbck_notify_hotplug
;
588 /* set default param if platform doesn't have */
589 if (!priv
->dparam
.pipe_type
) {
590 priv
->dparam
.pipe_type
= usbhsc_default_pipe_type
;
591 priv
->dparam
.pipe_size
= ARRAY_SIZE(usbhsc_default_pipe_type
);
593 if (!priv
->dparam
.pio_dma_border
)
594 priv
->dparam
.pio_dma_border
= 64; /* 64byte */
597 /* runtime power control ? */
598 if (priv
->pfunc
.get_vbus
)
599 usbhsc_flags_set(priv
, USBHSF_RUNTIME_PWCTRL
);
604 priv
->irq
= irq_res
->start
;
605 if (irq_res
->flags
& IORESOURCE_IRQ_SHAREABLE
)
606 priv
->irqflags
= IRQF_SHARED
;
608 INIT_DELAYED_WORK(&priv
->notify_hotplug_work
, usbhsc_notify_hotplug
);
609 spin_lock_init(usbhs_priv_to_lock(priv
));
611 /* call pipe and module init */
612 ret
= usbhs_pipe_probe(priv
);
616 ret
= usbhs_fifo_probe(priv
);
618 goto probe_end_pipe_exit
;
620 ret
= usbhs_mod_probe(priv
);
622 goto probe_end_fifo_exit
;
624 /* dev_set_drvdata should be called after usbhs_mod_init */
625 platform_set_drvdata(pdev
, priv
);
628 * deviece reset here because
629 * USB device might be used in boot loader.
631 usbhs_sys_clock_ctrl(priv
, 0);
633 /* check GPIO determining if USB function should be enabled */
634 if (priv
->dparam
.enable_gpio
) {
635 gpio_request_one(priv
->dparam
.enable_gpio
, GPIOF_IN
, NULL
);
636 ret
= !gpio_get_value(priv
->dparam
.enable_gpio
);
637 gpio_free(priv
->dparam
.enable_gpio
);
640 "USB function not selected (GPIO %d)\n",
641 priv
->dparam
.enable_gpio
);
643 goto probe_end_mod_exit
;
650 * USB phy setup might depend on CPU/Board.
651 * If platform has its callback functions,
654 ret
= usbhs_platform_call(priv
, hardware_init
, pdev
);
656 dev_err(&pdev
->dev
, "platform init failed.\n");
657 goto probe_end_mod_exit
;
660 /* reset phy for connection */
661 usbhs_platform_call(priv
, phy_reset
, pdev
);
664 pm_runtime_enable(&pdev
->dev
);
665 if (!usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
)) {
666 usbhsc_power_ctrl(priv
, 1);
667 usbhs_mod_autonomy_mode(priv
);
671 * manual call notify_hotplug for cold plug
673 usbhsc_drvcllbck_notify_hotplug(pdev
);
675 dev_info(&pdev
->dev
, "probed\n");
680 usbhs_mod_remove(priv
);
682 usbhs_fifo_remove(priv
);
684 usbhs_pipe_remove(priv
);
686 dev_info(&pdev
->dev
, "probe failed\n");
691 static int usbhs_remove(struct platform_device
*pdev
)
693 struct usbhs_priv
*priv
= usbhs_pdev_to_priv(pdev
);
694 struct renesas_usbhs_platform_info
*info
= dev_get_platdata(&pdev
->dev
);
695 struct renesas_usbhs_driver_callback
*dfunc
= &info
->driver_callback
;
697 dev_dbg(&pdev
->dev
, "usb remove\n");
699 dfunc
->notify_hotplug
= NULL
;
702 if (!usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
))
703 usbhsc_power_ctrl(priv
, 0);
705 pm_runtime_disable(&pdev
->dev
);
707 usbhs_platform_call(priv
, hardware_exit
, pdev
);
708 usbhs_mod_remove(priv
);
709 usbhs_fifo_remove(priv
);
710 usbhs_pipe_remove(priv
);
715 static int usbhsc_suspend(struct device
*dev
)
717 struct usbhs_priv
*priv
= dev_get_drvdata(dev
);
718 struct usbhs_mod
*mod
= usbhs_mod_get_current(priv
);
721 usbhs_mod_call(priv
, stop
, priv
);
722 usbhs_mod_change(priv
, -1);
725 if (mod
|| !usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
))
726 usbhsc_power_ctrl(priv
, 0);
731 static int usbhsc_resume(struct device
*dev
)
733 struct usbhs_priv
*priv
= dev_get_drvdata(dev
);
734 struct platform_device
*pdev
= usbhs_priv_to_pdev(priv
);
736 if (!usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
))
737 usbhsc_power_ctrl(priv
, 1);
739 usbhs_platform_call(priv
, phy_reset
, pdev
);
741 usbhsc_drvcllbck_notify_hotplug(pdev
);
746 static int usbhsc_runtime_nop(struct device
*dev
)
748 /* Runtime PM callback shared between ->runtime_suspend()
749 * and ->runtime_resume(). Simply returns success.
751 * This driver re-initializes all registers after
752 * pm_runtime_get_sync() anyway so there is no need
753 * to save and restore registers here.
758 static const struct dev_pm_ops usbhsc_pm_ops
= {
759 .suspend
= usbhsc_suspend
,
760 .resume
= usbhsc_resume
,
761 .runtime_suspend
= usbhsc_runtime_nop
,
762 .runtime_resume
= usbhsc_runtime_nop
,
765 static struct platform_driver renesas_usbhs_driver
= {
767 .name
= "renesas_usbhs",
768 .pm
= &usbhsc_pm_ops
,
769 .of_match_table
= of_match_ptr(usbhs_of_match
),
771 .probe
= usbhs_probe
,
772 .remove
= usbhs_remove
,
775 module_platform_driver(renesas_usbhs_driver
);
777 MODULE_LICENSE("GPL");
778 MODULE_DESCRIPTION("Renesas USB driver");
779 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");