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
= DPRPU
| HSE
| USBE
;
134 * - select Function mode
137 usbhs_bset(priv
, SYSCFG
, mask
, enable
? val
: 0);
140 void usbhs_sys_function_pullup(struct usbhs_priv
*priv
, int enable
)
142 usbhs_bset(priv
, SYSCFG
, DPRPU
, enable
? DPRPU
: 0);
145 void usbhs_sys_set_test_mode(struct usbhs_priv
*priv
, u16 mode
)
147 usbhs_write(priv
, TESTMODE
, mode
);
153 int usbhs_frame_get_num(struct usbhs_priv
*priv
)
155 return usbhs_read(priv
, FRMNUM
) & FRNM_MASK
;
159 * usb request functions
161 void usbhs_usbreq_get_val(struct usbhs_priv
*priv
, struct usb_ctrlrequest
*req
)
165 val
= usbhs_read(priv
, USBREQ
);
166 req
->bRequest
= (val
>> 8) & 0xFF;
167 req
->bRequestType
= (val
>> 0) & 0xFF;
169 req
->wValue
= usbhs_read(priv
, USBVAL
);
170 req
->wIndex
= usbhs_read(priv
, USBINDX
);
171 req
->wLength
= usbhs_read(priv
, USBLENG
);
174 void usbhs_usbreq_set_val(struct usbhs_priv
*priv
, struct usb_ctrlrequest
*req
)
176 usbhs_write(priv
, USBREQ
, (req
->bRequest
<< 8) | req
->bRequestType
);
177 usbhs_write(priv
, USBVAL
, req
->wValue
);
178 usbhs_write(priv
, USBINDX
, req
->wIndex
);
179 usbhs_write(priv
, USBLENG
, req
->wLength
);
181 usbhs_bset(priv
, DCPCTR
, SUREQ
, SUREQ
);
187 void usbhs_bus_send_sof_enable(struct usbhs_priv
*priv
)
189 u16 status
= usbhs_read(priv
, DVSTCTR
) & (USBRST
| UACT
);
191 if (status
!= USBRST
) {
192 struct device
*dev
= usbhs_priv_to_dev(priv
);
193 dev_err(dev
, "usbhs should be reset\n");
196 usbhs_bset(priv
, DVSTCTR
, (USBRST
| UACT
), UACT
);
199 void usbhs_bus_send_reset(struct usbhs_priv
*priv
)
201 usbhs_bset(priv
, DVSTCTR
, (USBRST
| UACT
), USBRST
);
204 int usbhs_bus_get_speed(struct usbhs_priv
*priv
)
206 u16 dvstctr
= usbhs_read(priv
, DVSTCTR
);
208 switch (RHST
& dvstctr
) {
210 return USB_SPEED_LOW
;
211 case RHST_FULL_SPEED
:
212 return USB_SPEED_FULL
;
213 case RHST_HIGH_SPEED
:
214 return USB_SPEED_HIGH
;
217 return USB_SPEED_UNKNOWN
;
220 int usbhs_vbus_ctrl(struct usbhs_priv
*priv
, int enable
)
222 struct platform_device
*pdev
= usbhs_priv_to_pdev(priv
);
224 return usbhs_platform_call(priv
, set_vbus
, pdev
, enable
);
227 static void usbhsc_bus_init(struct usbhs_priv
*priv
)
229 usbhs_write(priv
, DVSTCTR
, 0);
231 usbhs_vbus_ctrl(priv
, 0);
235 * device configuration
237 int usbhs_set_device_config(struct usbhs_priv
*priv
, int devnum
,
238 u16 upphub
, u16 hubport
, u16 speed
)
240 struct device
*dev
= usbhs_priv_to_dev(priv
);
242 u32 reg
= DEVADD0
+ (2 * devnum
);
245 dev_err(dev
, "cannot set speed to unknown device %d\n", devnum
);
250 dev_err(dev
, "unsupported hub number %d\n", upphub
);
256 usbspd
= USBSPD_SPEED_LOW
;
259 usbspd
= USBSPD_SPEED_FULL
;
262 usbspd
= USBSPD_SPEED_HIGH
;
265 dev_err(dev
, "unsupported speed %d\n", speed
);
269 usbhs_write(priv
, reg
, UPPHUB(upphub
) |
279 static void usbhsc_set_buswait(struct usbhs_priv
*priv
)
281 int wait
= usbhs_get_dparam(priv
, buswait_bwait
);
283 /* set bus wait if platform have */
285 usbhs_bset(priv
, BUSWAIT
, 0x000F, wait
);
289 * platform default param
292 /* commonly used on old SH-Mobile SoCs */
293 static u32 usbhsc_default_pipe_type
[] = {
294 USB_ENDPOINT_XFER_CONTROL
,
295 USB_ENDPOINT_XFER_ISOC
,
296 USB_ENDPOINT_XFER_ISOC
,
297 USB_ENDPOINT_XFER_BULK
,
298 USB_ENDPOINT_XFER_BULK
,
299 USB_ENDPOINT_XFER_BULK
,
300 USB_ENDPOINT_XFER_INT
,
301 USB_ENDPOINT_XFER_INT
,
302 USB_ENDPOINT_XFER_INT
,
303 USB_ENDPOINT_XFER_INT
,
306 /* commonly used on newer SH-Mobile and R-Car SoCs */
307 static u32 usbhsc_new_pipe_type
[] = {
308 USB_ENDPOINT_XFER_CONTROL
,
309 USB_ENDPOINT_XFER_ISOC
,
310 USB_ENDPOINT_XFER_ISOC
,
311 USB_ENDPOINT_XFER_BULK
,
312 USB_ENDPOINT_XFER_BULK
,
313 USB_ENDPOINT_XFER_BULK
,
314 USB_ENDPOINT_XFER_INT
,
315 USB_ENDPOINT_XFER_INT
,
316 USB_ENDPOINT_XFER_INT
,
317 USB_ENDPOINT_XFER_BULK
,
318 USB_ENDPOINT_XFER_BULK
,
319 USB_ENDPOINT_XFER_BULK
,
320 USB_ENDPOINT_XFER_BULK
,
321 USB_ENDPOINT_XFER_BULK
,
322 USB_ENDPOINT_XFER_BULK
,
323 USB_ENDPOINT_XFER_BULK
,
329 static void usbhsc_power_ctrl(struct usbhs_priv
*priv
, int enable
)
331 struct platform_device
*pdev
= usbhs_priv_to_pdev(priv
);
332 struct device
*dev
= usbhs_priv_to_dev(priv
);
336 pm_runtime_get_sync(dev
);
338 /* enable platform power */
339 usbhs_platform_call(priv
, power_ctrl
, pdev
, priv
->base
, enable
);
342 usbhs_sys_clock_ctrl(priv
, enable
);
345 usbhs_sys_clock_ctrl(priv
, enable
);
347 /* disable platform power */
348 usbhs_platform_call(priv
, power_ctrl
, pdev
, priv
->base
, enable
);
351 pm_runtime_put_sync(dev
);
358 static void usbhsc_hotplug(struct usbhs_priv
*priv
)
360 struct platform_device
*pdev
= usbhs_priv_to_pdev(priv
);
361 struct usbhs_mod
*mod
= usbhs_mod_get_current(priv
);
367 * get vbus status from platform
369 enable
= usbhs_platform_call(priv
, get_vbus
, pdev
);
372 * get id from platform
374 id
= usbhs_platform_call(priv
, get_id
, pdev
);
376 if (enable
&& !mod
) {
377 ret
= usbhs_mod_change(priv
, id
);
381 dev_dbg(&pdev
->dev
, "%s enable\n", __func__
);
384 if (usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
))
385 usbhsc_power_ctrl(priv
, enable
);
388 usbhsc_set_buswait(priv
);
389 usbhsc_bus_init(priv
);
392 usbhs_mod_call(priv
, start
, priv
);
394 } else if (!enable
&& mod
) {
395 dev_dbg(&pdev
->dev
, "%s disable\n", __func__
);
398 usbhs_mod_call(priv
, stop
, priv
);
401 usbhsc_bus_init(priv
);
404 if (usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
))
405 usbhsc_power_ctrl(priv
, enable
);
407 usbhs_mod_change(priv
, -1);
409 /* reset phy for next connection */
410 usbhs_platform_call(priv
, phy_reset
, pdev
);
417 static void usbhsc_notify_hotplug(struct work_struct
*work
)
419 struct usbhs_priv
*priv
= container_of(work
,
421 notify_hotplug_work
.work
);
422 usbhsc_hotplug(priv
);
425 static int usbhsc_drvcllbck_notify_hotplug(struct platform_device
*pdev
)
427 struct usbhs_priv
*priv
= usbhs_pdev_to_priv(pdev
);
428 int delay
= usbhs_get_dparam(priv
, detection_delay
);
431 * This functions will be called in interrupt.
432 * To make sure safety context,
433 * use workqueue for usbhs_notify_hotplug
435 schedule_delayed_work(&priv
->notify_hotplug_work
,
436 msecs_to_jiffies(delay
));
443 static const struct of_device_id usbhs_of_match
[] = {
445 .compatible
= "renesas,usbhs-r8a7790",
446 .data
= (void *)USBHS_TYPE_R8A7790
,
449 .compatible
= "renesas,usbhs-r8a7791",
450 .data
= (void *)USBHS_TYPE_R8A7791
,
454 MODULE_DEVICE_TABLE(of
, usbhs_of_match
);
456 static struct renesas_usbhs_platform_info
*usbhs_parse_dt(struct device
*dev
)
458 struct renesas_usbhs_platform_info
*info
;
459 struct renesas_usbhs_driver_param
*dparam
;
460 const struct of_device_id
*of_id
= of_match_device(usbhs_of_match
, dev
);
464 info
= devm_kzalloc(dev
, sizeof(*info
), GFP_KERNEL
);
468 dparam
= &info
->driver_param
;
469 dparam
->type
= of_id
? (u32
)of_id
->data
: 0;
470 if (!of_property_read_u32(dev
->of_node
, "renesas,buswait", &tmp
))
471 dparam
->buswait_bwait
= tmp
;
472 gpio
= of_get_named_gpio_flags(dev
->of_node
, "renesas,enable-gpio", 0,
475 dparam
->enable_gpio
= gpio
;
480 static int usbhs_probe(struct platform_device
*pdev
)
482 struct renesas_usbhs_platform_info
*info
= dev_get_platdata(&pdev
->dev
);
483 struct renesas_usbhs_driver_callback
*dfunc
;
484 struct usbhs_priv
*priv
;
485 struct resource
*res
, *irq_res
;
488 /* check device node */
489 if (pdev
->dev
.of_node
)
490 info
= pdev
->dev
.platform_data
= usbhs_parse_dt(&pdev
->dev
);
492 /* check platform information */
494 dev_err(&pdev
->dev
, "no platform information\n");
499 irq_res
= platform_get_resource(pdev
, IORESOURCE_IRQ
, 0);
501 dev_err(&pdev
->dev
, "Not enough Renesas USB platform resources.\n");
505 /* usb private data */
506 priv
= devm_kzalloc(&pdev
->dev
, sizeof(*priv
), GFP_KERNEL
);
510 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
511 priv
->base
= devm_ioremap_resource(&pdev
->dev
, res
);
512 if (IS_ERR(priv
->base
))
513 return PTR_ERR(priv
->base
);
519 memcpy(&priv
->dparam
,
521 sizeof(struct renesas_usbhs_driver_param
));
523 switch (priv
->dparam
.type
) {
524 case USBHS_TYPE_R8A7790
:
525 case USBHS_TYPE_R8A7791
:
526 priv
->pfunc
= usbhs_rcar2_ops
;
527 if (!priv
->dparam
.pipe_type
) {
528 priv
->dparam
.pipe_type
= usbhsc_new_pipe_type
;
529 priv
->dparam
.pipe_size
=
530 ARRAY_SIZE(usbhsc_new_pipe_type
);
534 if (!info
->platform_callback
.get_id
) {
535 dev_err(&pdev
->dev
, "no platform callbacks");
539 &info
->platform_callback
,
540 sizeof(struct renesas_usbhs_platform_callback
));
544 /* set driver callback functions for platform */
545 dfunc
= &info
->driver_callback
;
546 dfunc
->notify_hotplug
= usbhsc_drvcllbck_notify_hotplug
;
548 /* set default param if platform doesn't have */
549 if (!priv
->dparam
.pipe_type
) {
550 priv
->dparam
.pipe_type
= usbhsc_default_pipe_type
;
551 priv
->dparam
.pipe_size
= ARRAY_SIZE(usbhsc_default_pipe_type
);
553 if (!priv
->dparam
.pio_dma_border
)
554 priv
->dparam
.pio_dma_border
= 64; /* 64byte */
557 /* runtime power control ? */
558 if (priv
->pfunc
.get_vbus
)
559 usbhsc_flags_set(priv
, USBHSF_RUNTIME_PWCTRL
);
564 priv
->irq
= irq_res
->start
;
565 if (irq_res
->flags
& IORESOURCE_IRQ_SHAREABLE
)
566 priv
->irqflags
= IRQF_SHARED
;
568 INIT_DELAYED_WORK(&priv
->notify_hotplug_work
, usbhsc_notify_hotplug
);
569 spin_lock_init(usbhs_priv_to_lock(priv
));
571 /* call pipe and module init */
572 ret
= usbhs_pipe_probe(priv
);
576 ret
= usbhs_fifo_probe(priv
);
578 goto probe_end_pipe_exit
;
580 ret
= usbhs_mod_probe(priv
);
582 goto probe_end_fifo_exit
;
584 /* dev_set_drvdata should be called after usbhs_mod_init */
585 platform_set_drvdata(pdev
, priv
);
588 * deviece reset here because
589 * USB device might be used in boot loader.
591 usbhs_sys_clock_ctrl(priv
, 0);
593 /* check GPIO determining if USB function should be enabled */
594 if (priv
->dparam
.enable_gpio
) {
595 gpio_request_one(priv
->dparam
.enable_gpio
, GPIOF_IN
, NULL
);
596 ret
= !gpio_get_value(priv
->dparam
.enable_gpio
);
597 gpio_free(priv
->dparam
.enable_gpio
);
600 "USB function not selected (GPIO %d)\n",
601 priv
->dparam
.enable_gpio
);
603 goto probe_end_mod_exit
;
610 * USB phy setup might depend on CPU/Board.
611 * If platform has its callback functions,
614 ret
= usbhs_platform_call(priv
, hardware_init
, pdev
);
616 dev_err(&pdev
->dev
, "platform prove failed.\n");
617 goto probe_end_mod_exit
;
620 /* reset phy for connection */
621 usbhs_platform_call(priv
, phy_reset
, pdev
);
624 pm_runtime_enable(&pdev
->dev
);
625 if (!usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
)) {
626 usbhsc_power_ctrl(priv
, 1);
627 usbhs_mod_autonomy_mode(priv
);
631 * manual call notify_hotplug for cold plug
633 ret
= usbhsc_drvcllbck_notify_hotplug(pdev
);
635 goto probe_end_call_remove
;
637 dev_info(&pdev
->dev
, "probed\n");
641 probe_end_call_remove
:
642 usbhs_platform_call(priv
, hardware_exit
, pdev
);
644 usbhs_mod_remove(priv
);
646 usbhs_fifo_remove(priv
);
648 usbhs_pipe_remove(priv
);
650 dev_info(&pdev
->dev
, "probe failed\n");
655 static int usbhs_remove(struct platform_device
*pdev
)
657 struct usbhs_priv
*priv
= usbhs_pdev_to_priv(pdev
);
658 struct renesas_usbhs_platform_info
*info
= dev_get_platdata(&pdev
->dev
);
659 struct renesas_usbhs_driver_callback
*dfunc
= &info
->driver_callback
;
661 dev_dbg(&pdev
->dev
, "usb remove\n");
663 dfunc
->notify_hotplug
= NULL
;
666 if (!usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
))
667 usbhsc_power_ctrl(priv
, 0);
669 pm_runtime_disable(&pdev
->dev
);
671 usbhs_platform_call(priv
, hardware_exit
, pdev
);
672 usbhs_mod_remove(priv
);
673 usbhs_fifo_remove(priv
);
674 usbhs_pipe_remove(priv
);
679 static int usbhsc_suspend(struct device
*dev
)
681 struct usbhs_priv
*priv
= dev_get_drvdata(dev
);
682 struct usbhs_mod
*mod
= usbhs_mod_get_current(priv
);
685 usbhs_mod_call(priv
, stop
, priv
);
686 usbhs_mod_change(priv
, -1);
689 if (mod
|| !usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
))
690 usbhsc_power_ctrl(priv
, 0);
695 static int usbhsc_resume(struct device
*dev
)
697 struct usbhs_priv
*priv
= dev_get_drvdata(dev
);
698 struct platform_device
*pdev
= usbhs_priv_to_pdev(priv
);
700 if (!usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
))
701 usbhsc_power_ctrl(priv
, 1);
703 usbhs_platform_call(priv
, phy_reset
, pdev
);
705 usbhsc_drvcllbck_notify_hotplug(pdev
);
710 static int usbhsc_runtime_nop(struct device
*dev
)
712 /* Runtime PM callback shared between ->runtime_suspend()
713 * and ->runtime_resume(). Simply returns success.
715 * This driver re-initializes all registers after
716 * pm_runtime_get_sync() anyway so there is no need
717 * to save and restore registers here.
722 static const struct dev_pm_ops usbhsc_pm_ops
= {
723 .suspend
= usbhsc_suspend
,
724 .resume
= usbhsc_resume
,
725 .runtime_suspend
= usbhsc_runtime_nop
,
726 .runtime_resume
= usbhsc_runtime_nop
,
729 static struct platform_driver renesas_usbhs_driver
= {
731 .name
= "renesas_usbhs",
732 .pm
= &usbhsc_pm_ops
,
733 .of_match_table
= of_match_ptr(usbhs_of_match
),
735 .probe
= usbhs_probe
,
736 .remove
= usbhs_remove
,
739 module_platform_driver(renesas_usbhs_driver
);
741 MODULE_LICENSE("GPL");
742 MODULE_DESCRIPTION("Renesas USB driver");
743 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");