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
) |
281 static void usbhsc_set_buswait(struct usbhs_priv
*priv
)
283 int wait
= usbhs_get_dparam(priv
, buswait_bwait
);
285 /* set bus wait if platform have */
287 usbhs_bset(priv
, BUSWAIT
, 0x000F, wait
);
291 * platform default param
294 /* commonly used on old SH-Mobile SoCs */
295 static u32 usbhsc_default_pipe_type
[] = {
296 USB_ENDPOINT_XFER_CONTROL
,
297 USB_ENDPOINT_XFER_ISOC
,
298 USB_ENDPOINT_XFER_ISOC
,
299 USB_ENDPOINT_XFER_BULK
,
300 USB_ENDPOINT_XFER_BULK
,
301 USB_ENDPOINT_XFER_BULK
,
302 USB_ENDPOINT_XFER_INT
,
303 USB_ENDPOINT_XFER_INT
,
304 USB_ENDPOINT_XFER_INT
,
305 USB_ENDPOINT_XFER_INT
,
308 /* commonly used on newer SH-Mobile and R-Car SoCs */
309 static u32 usbhsc_new_pipe_type
[] = {
310 USB_ENDPOINT_XFER_CONTROL
,
311 USB_ENDPOINT_XFER_ISOC
,
312 USB_ENDPOINT_XFER_ISOC
,
313 USB_ENDPOINT_XFER_BULK
,
314 USB_ENDPOINT_XFER_BULK
,
315 USB_ENDPOINT_XFER_BULK
,
316 USB_ENDPOINT_XFER_INT
,
317 USB_ENDPOINT_XFER_INT
,
318 USB_ENDPOINT_XFER_INT
,
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
,
324 USB_ENDPOINT_XFER_BULK
,
325 USB_ENDPOINT_XFER_BULK
,
331 static void usbhsc_power_ctrl(struct usbhs_priv
*priv
, int enable
)
333 struct platform_device
*pdev
= usbhs_priv_to_pdev(priv
);
334 struct device
*dev
= usbhs_priv_to_dev(priv
);
338 pm_runtime_get_sync(dev
);
340 /* enable platform power */
341 usbhs_platform_call(priv
, power_ctrl
, pdev
, priv
->base
, enable
);
344 usbhs_sys_clock_ctrl(priv
, enable
);
347 usbhs_sys_clock_ctrl(priv
, enable
);
349 /* disable platform power */
350 usbhs_platform_call(priv
, power_ctrl
, pdev
, priv
->base
, enable
);
353 pm_runtime_put_sync(dev
);
360 static void usbhsc_hotplug(struct usbhs_priv
*priv
)
362 struct platform_device
*pdev
= usbhs_priv_to_pdev(priv
);
363 struct usbhs_mod
*mod
= usbhs_mod_get_current(priv
);
370 * get vbus status from platform
372 enable
= usbhs_platform_call(priv
, get_vbus
, pdev
);
375 * get id from platform
377 id
= usbhs_platform_call(priv
, get_id
, pdev
);
379 if (enable
&& !mod
) {
381 cable
= extcon_get_cable_state(priv
->edev
, "USB-HOST");
382 if ((cable
> 0 && id
!= USBHS_HOST
) ||
383 (!cable
&& id
!= USBHS_GADGET
)) {
385 "USB cable plugged in doesn't match the selected role!\n");
390 ret
= usbhs_mod_change(priv
, id
);
394 dev_dbg(&pdev
->dev
, "%s enable\n", __func__
);
397 if (usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
))
398 usbhsc_power_ctrl(priv
, enable
);
401 usbhsc_set_buswait(priv
);
402 usbhsc_bus_init(priv
);
405 usbhs_mod_call(priv
, start
, priv
);
407 } else if (!enable
&& mod
) {
408 dev_dbg(&pdev
->dev
, "%s disable\n", __func__
);
411 usbhs_mod_call(priv
, stop
, priv
);
414 usbhsc_bus_init(priv
);
417 if (usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
))
418 usbhsc_power_ctrl(priv
, enable
);
420 usbhs_mod_change(priv
, -1);
422 /* reset phy for next connection */
423 usbhs_platform_call(priv
, phy_reset
, pdev
);
430 static void usbhsc_notify_hotplug(struct work_struct
*work
)
432 struct usbhs_priv
*priv
= container_of(work
,
434 notify_hotplug_work
.work
);
435 usbhsc_hotplug(priv
);
438 static int usbhsc_drvcllbck_notify_hotplug(struct platform_device
*pdev
)
440 struct usbhs_priv
*priv
= usbhs_pdev_to_priv(pdev
);
441 int delay
= usbhs_get_dparam(priv
, detection_delay
);
444 * This functions will be called in interrupt.
445 * To make sure safety context,
446 * use workqueue for usbhs_notify_hotplug
448 schedule_delayed_work(&priv
->notify_hotplug_work
,
449 msecs_to_jiffies(delay
));
456 static const struct of_device_id usbhs_of_match
[] = {
458 .compatible
= "renesas,usbhs-r8a7790",
459 .data
= (void *)USBHS_TYPE_R8A7790
,
462 .compatible
= "renesas,usbhs-r8a7791",
463 .data
= (void *)USBHS_TYPE_R8A7791
,
467 MODULE_DEVICE_TABLE(of
, usbhs_of_match
);
469 static struct renesas_usbhs_platform_info
*usbhs_parse_dt(struct device
*dev
)
471 struct renesas_usbhs_platform_info
*info
;
472 struct renesas_usbhs_driver_param
*dparam
;
473 const struct of_device_id
*of_id
= of_match_device(usbhs_of_match
, dev
);
477 info
= devm_kzalloc(dev
, sizeof(*info
), GFP_KERNEL
);
481 dparam
= &info
->driver_param
;
482 dparam
->type
= of_id
? (u32
)of_id
->data
: 0;
483 if (!of_property_read_u32(dev
->of_node
, "renesas,buswait", &tmp
))
484 dparam
->buswait_bwait
= tmp
;
485 gpio
= of_get_named_gpio_flags(dev
->of_node
, "renesas,enable-gpio", 0,
488 dparam
->enable_gpio
= gpio
;
493 static int usbhs_probe(struct platform_device
*pdev
)
495 struct renesas_usbhs_platform_info
*info
= dev_get_platdata(&pdev
->dev
);
496 struct renesas_usbhs_driver_callback
*dfunc
;
497 struct usbhs_priv
*priv
;
498 struct resource
*res
, *irq_res
;
501 /* check device node */
502 if (pdev
->dev
.of_node
)
503 info
= pdev
->dev
.platform_data
= usbhs_parse_dt(&pdev
->dev
);
505 /* check platform information */
507 dev_err(&pdev
->dev
, "no platform information\n");
512 irq_res
= platform_get_resource(pdev
, IORESOURCE_IRQ
, 0);
514 dev_err(&pdev
->dev
, "Not enough Renesas USB platform resources.\n");
518 /* usb private data */
519 priv
= devm_kzalloc(&pdev
->dev
, sizeof(*priv
), GFP_KERNEL
);
523 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
524 priv
->base
= devm_ioremap_resource(&pdev
->dev
, res
);
525 if (IS_ERR(priv
->base
))
526 return PTR_ERR(priv
->base
);
528 if (of_property_read_bool(pdev
->dev
.of_node
, "extcon")) {
529 priv
->edev
= extcon_get_edev_by_phandle(&pdev
->dev
, 0);
530 if (IS_ERR(priv
->edev
))
531 return PTR_ERR(priv
->edev
);
538 memcpy(&priv
->dparam
,
540 sizeof(struct renesas_usbhs_driver_param
));
542 switch (priv
->dparam
.type
) {
543 case USBHS_TYPE_R8A7790
:
544 case USBHS_TYPE_R8A7791
:
545 priv
->pfunc
= usbhs_rcar2_ops
;
546 if (!priv
->dparam
.pipe_type
) {
547 priv
->dparam
.pipe_type
= usbhsc_new_pipe_type
;
548 priv
->dparam
.pipe_size
=
549 ARRAY_SIZE(usbhsc_new_pipe_type
);
553 if (!info
->platform_callback
.get_id
) {
554 dev_err(&pdev
->dev
, "no platform callbacks");
558 &info
->platform_callback
,
559 sizeof(struct renesas_usbhs_platform_callback
));
563 /* set driver callback functions for platform */
564 dfunc
= &info
->driver_callback
;
565 dfunc
->notify_hotplug
= usbhsc_drvcllbck_notify_hotplug
;
567 /* set default param if platform doesn't have */
568 if (!priv
->dparam
.pipe_type
) {
569 priv
->dparam
.pipe_type
= usbhsc_default_pipe_type
;
570 priv
->dparam
.pipe_size
= ARRAY_SIZE(usbhsc_default_pipe_type
);
572 if (!priv
->dparam
.pio_dma_border
)
573 priv
->dparam
.pio_dma_border
= 64; /* 64byte */
576 /* runtime power control ? */
577 if (priv
->pfunc
.get_vbus
)
578 usbhsc_flags_set(priv
, USBHSF_RUNTIME_PWCTRL
);
583 priv
->irq
= irq_res
->start
;
584 if (irq_res
->flags
& IORESOURCE_IRQ_SHAREABLE
)
585 priv
->irqflags
= IRQF_SHARED
;
587 INIT_DELAYED_WORK(&priv
->notify_hotplug_work
, usbhsc_notify_hotplug
);
588 spin_lock_init(usbhs_priv_to_lock(priv
));
590 /* call pipe and module init */
591 ret
= usbhs_pipe_probe(priv
);
595 ret
= usbhs_fifo_probe(priv
);
597 goto probe_end_pipe_exit
;
599 ret
= usbhs_mod_probe(priv
);
601 goto probe_end_fifo_exit
;
603 /* dev_set_drvdata should be called after usbhs_mod_init */
604 platform_set_drvdata(pdev
, priv
);
607 * deviece reset here because
608 * USB device might be used in boot loader.
610 usbhs_sys_clock_ctrl(priv
, 0);
612 /* check GPIO determining if USB function should be enabled */
613 if (priv
->dparam
.enable_gpio
) {
614 gpio_request_one(priv
->dparam
.enable_gpio
, GPIOF_IN
, NULL
);
615 ret
= !gpio_get_value(priv
->dparam
.enable_gpio
);
616 gpio_free(priv
->dparam
.enable_gpio
);
619 "USB function not selected (GPIO %d)\n",
620 priv
->dparam
.enable_gpio
);
622 goto probe_end_mod_exit
;
629 * USB phy setup might depend on CPU/Board.
630 * If platform has its callback functions,
633 ret
= usbhs_platform_call(priv
, hardware_init
, pdev
);
635 dev_err(&pdev
->dev
, "platform init failed.\n");
636 goto probe_end_mod_exit
;
639 /* reset phy for connection */
640 usbhs_platform_call(priv
, phy_reset
, pdev
);
643 pm_runtime_enable(&pdev
->dev
);
644 if (!usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
)) {
645 usbhsc_power_ctrl(priv
, 1);
646 usbhs_mod_autonomy_mode(priv
);
650 * manual call notify_hotplug for cold plug
652 usbhsc_drvcllbck_notify_hotplug(pdev
);
654 dev_info(&pdev
->dev
, "probed\n");
659 usbhs_mod_remove(priv
);
661 usbhs_fifo_remove(priv
);
663 usbhs_pipe_remove(priv
);
665 dev_info(&pdev
->dev
, "probe failed\n");
670 static int usbhs_remove(struct platform_device
*pdev
)
672 struct usbhs_priv
*priv
= usbhs_pdev_to_priv(pdev
);
673 struct renesas_usbhs_platform_info
*info
= dev_get_platdata(&pdev
->dev
);
674 struct renesas_usbhs_driver_callback
*dfunc
= &info
->driver_callback
;
676 dev_dbg(&pdev
->dev
, "usb remove\n");
678 dfunc
->notify_hotplug
= NULL
;
681 if (!usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
))
682 usbhsc_power_ctrl(priv
, 0);
684 pm_runtime_disable(&pdev
->dev
);
686 usbhs_platform_call(priv
, hardware_exit
, pdev
);
687 usbhs_mod_remove(priv
);
688 usbhs_fifo_remove(priv
);
689 usbhs_pipe_remove(priv
);
694 static int usbhsc_suspend(struct device
*dev
)
696 struct usbhs_priv
*priv
= dev_get_drvdata(dev
);
697 struct usbhs_mod
*mod
= usbhs_mod_get_current(priv
);
700 usbhs_mod_call(priv
, stop
, priv
);
701 usbhs_mod_change(priv
, -1);
704 if (mod
|| !usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
))
705 usbhsc_power_ctrl(priv
, 0);
710 static int usbhsc_resume(struct device
*dev
)
712 struct usbhs_priv
*priv
= dev_get_drvdata(dev
);
713 struct platform_device
*pdev
= usbhs_priv_to_pdev(priv
);
715 if (!usbhsc_flags_has(priv
, USBHSF_RUNTIME_PWCTRL
))
716 usbhsc_power_ctrl(priv
, 1);
718 usbhs_platform_call(priv
, phy_reset
, pdev
);
720 usbhsc_drvcllbck_notify_hotplug(pdev
);
725 static int usbhsc_runtime_nop(struct device
*dev
)
727 /* Runtime PM callback shared between ->runtime_suspend()
728 * and ->runtime_resume(). Simply returns success.
730 * This driver re-initializes all registers after
731 * pm_runtime_get_sync() anyway so there is no need
732 * to save and restore registers here.
737 static const struct dev_pm_ops usbhsc_pm_ops
= {
738 .suspend
= usbhsc_suspend
,
739 .resume
= usbhsc_resume
,
740 .runtime_suspend
= usbhsc_runtime_nop
,
741 .runtime_resume
= usbhsc_runtime_nop
,
744 static struct platform_driver renesas_usbhs_driver
= {
746 .name
= "renesas_usbhs",
747 .pm
= &usbhsc_pm_ops
,
748 .of_match_table
= of_match_ptr(usbhs_of_match
),
750 .probe
= usbhs_probe
,
751 .remove
= usbhs_remove
,
754 module_platform_driver(renesas_usbhs_driver
);
756 MODULE_LICENSE("GPL");
757 MODULE_DESCRIPTION("Renesas USB driver");
758 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");