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
18 #include <linux/module.h>
19 #include <linux/pm_runtime.h>
20 #include <linux/slab.h>
21 #include <linux/sysfs.h>
25 * image of renesas_usbhs
31 * mod_host.c pipe.c fifo.c
33 * +-------+ +-----------+
34 * | pipe0 |------>| fifo pio |
35 * +------------+ +-------+ +-----------+
36 * | mod_gadget |=====> | pipe1 |--+
37 * +------------+ +-------+ | +-----------+
38 * | pipe2 | | +-| fifo dma0 |
39 * +------------+ +-------+ | | +-----------+
40 * | mod_host | | pipe3 |<-|--+
41 * +------------+ +-------+ | +-----------+
42 * | .... | +--->| fifo dma1 |
43 * | .... | +-----------+
47 #define USBHSF_RUNTIME_PWCTRL (1 << 0)
50 #define usbhsc_flags_init(p) do {(p)->flags = 0; } while (0)
51 #define usbhsc_flags_set(p, b) ((p)->flags |= (b))
52 #define usbhsc_flags_clr(p, b) ((p)->flags &= ~(b))
53 #define usbhsc_flags_has(p, b) ((p)->flags & (b))
58 * renesas usb support platform callback function.
59 * Below macro call it.
60 * if platform doesn't have callback, it return 0 (no error)
62 #define usbhs_platform_call(priv, func, args...)\
63 (!(priv) ? -ENODEV : \
64 !((priv)->pfunc.func) ? 0 : \
65 (priv)->pfunc.func(args))
70 u16 usbhs_read(struct usbhs_priv *priv, u32 reg)
72 return ioread16(priv->base + reg);
75 void usbhs_write(struct usbhs_priv *priv, u32 reg, u16 data)
77 iowrite16(data, priv->base + reg);
80 void usbhs_bset(struct usbhs_priv *priv, u32 reg, u16 mask, u16 data)
82 u16 val = usbhs_read(priv, reg);
87 usbhs_write(priv, reg, val);
90 struct usbhs_priv *usbhs_pdev_to_priv(struct platform_device *pdev)
92 return dev_get_drvdata(&pdev->dev);
98 static void usbhs_sys_clock_ctrl(struct usbhs_priv *priv, int enable)
100 usbhs_bset(priv, SYSCFG, SCKE, enable ? SCKE : 0);
103 void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable)
105 u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
106 u16 val = DCFM | DRPD | HSE | USBE;
107 int has_otg = usbhs_get_dparam(priv, has_otg);
110 usbhs_bset(priv, DVSTCTR, (EXTLP | PWEN), (EXTLP | PWEN));
116 * - D+ Line/D- Line Pull-down
118 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
121 void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable)
123 u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
124 u16 val = DPRPU | HSE | USBE;
129 * - select Function mode
132 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
135 void usbhs_sys_function_pullup(struct usbhs_priv *priv, int enable)
137 usbhs_bset(priv, SYSCFG, DPRPU, enable ? DPRPU : 0);
140 void usbhs_sys_set_test_mode(struct usbhs_priv *priv, u16 mode)
142 usbhs_write(priv, TESTMODE, mode);
148 int usbhs_frame_get_num(struct usbhs_priv *priv)
150 return usbhs_read(priv, FRMNUM) & FRNM_MASK;
154 * usb request functions
156 void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
160 val = usbhs_read(priv, USBREQ);
161 req->bRequest = (val >> 8) & 0xFF;
162 req->bRequestType = (val >> 0) & 0xFF;
164 req->wValue = usbhs_read(priv, USBVAL);
165 req->wIndex = usbhs_read(priv, USBINDX);
166 req->wLength = usbhs_read(priv, USBLENG);
169 void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
171 usbhs_write(priv, USBREQ, (req->bRequest << 8) | req->bRequestType);
172 usbhs_write(priv, USBVAL, req->wValue);
173 usbhs_write(priv, USBINDX, req->wIndex);
174 usbhs_write(priv, USBLENG, req->wLength);
176 usbhs_bset(priv, DCPCTR, SUREQ, SUREQ);
182 void usbhs_bus_send_sof_enable(struct usbhs_priv *priv)
184 u16 status = usbhs_read(priv, DVSTCTR) & (USBRST | UACT);
186 if (status != USBRST) {
187 struct device *dev = usbhs_priv_to_dev(priv);
188 dev_err(dev, "usbhs should be reset\n");
191 usbhs_bset(priv, DVSTCTR, (USBRST | UACT), UACT);
194 void usbhs_bus_send_reset(struct usbhs_priv *priv)
196 usbhs_bset(priv, DVSTCTR, (USBRST | UACT), USBRST);
199 int usbhs_bus_get_speed(struct usbhs_priv *priv)
201 u16 dvstctr = usbhs_read(priv, DVSTCTR);
203 switch (RHST & dvstctr) {
205 return USB_SPEED_LOW;
206 case RHST_FULL_SPEED:
207 return USB_SPEED_FULL;
208 case RHST_HIGH_SPEED:
209 return USB_SPEED_HIGH;
212 return USB_SPEED_UNKNOWN;
215 int usbhs_vbus_ctrl(struct usbhs_priv *priv, int enable)
217 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
219 return usbhs_platform_call(priv, set_vbus, pdev, enable);
222 static void usbhsc_bus_init(struct usbhs_priv *priv)
224 usbhs_write(priv, DVSTCTR, 0);
226 usbhs_vbus_ctrl(priv, 0);
230 * device configuration
232 int usbhs_set_device_config(struct usbhs_priv *priv, int devnum,
233 u16 upphub, u16 hubport, u16 speed)
235 struct device *dev = usbhs_priv_to_dev(priv);
237 u32 reg = DEVADD0 + (2 * devnum);
240 dev_err(dev, "cannot set speed to unknown device %d\n", devnum);
245 dev_err(dev, "unsupported hub number %d\n", upphub);
251 usbspd = USBSPD_SPEED_LOW;
254 usbspd = USBSPD_SPEED_FULL;
257 usbspd = USBSPD_SPEED_HIGH;
260 dev_err(dev, "unsupported speed %d\n", speed);
264 usbhs_write(priv, reg, UPPHUB(upphub) |
274 static void usbhsc_set_buswait(struct usbhs_priv *priv)
276 int wait = usbhs_get_dparam(priv, buswait_bwait);
278 /* set bus wait if platform have */
280 usbhs_bset(priv, BUSWAIT, 0x000F, wait);
284 * platform default param
286 static u32 usbhsc_default_pipe_type[] = {
287 USB_ENDPOINT_XFER_CONTROL,
288 USB_ENDPOINT_XFER_ISOC,
289 USB_ENDPOINT_XFER_ISOC,
290 USB_ENDPOINT_XFER_BULK,
291 USB_ENDPOINT_XFER_BULK,
292 USB_ENDPOINT_XFER_BULK,
293 USB_ENDPOINT_XFER_INT,
294 USB_ENDPOINT_XFER_INT,
295 USB_ENDPOINT_XFER_INT,
296 USB_ENDPOINT_XFER_INT,
302 static void usbhsc_power_ctrl(struct usbhs_priv *priv, int enable)
304 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
305 struct device *dev = usbhs_priv_to_dev(priv);
309 pm_runtime_get_sync(dev);
311 /* enable platform power */
312 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
315 usbhs_sys_clock_ctrl(priv, enable);
318 usbhs_sys_clock_ctrl(priv, enable);
320 /* disable platform power */
321 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
324 pm_runtime_put_sync(dev);
331 static void usbhsc_hotplug(struct usbhs_priv *priv)
333 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
334 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
340 * get vbus status from platform
342 enable = usbhs_platform_call(priv, get_vbus, pdev);
345 * get id from platform
347 id = usbhs_platform_call(priv, get_id, pdev);
349 if (enable && !mod) {
350 ret = usbhs_mod_change(priv, id);
354 dev_dbg(&pdev->dev, "%s enable\n", __func__);
357 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
358 usbhsc_power_ctrl(priv, enable);
361 usbhsc_set_buswait(priv);
362 usbhsc_bus_init(priv);
365 usbhs_mod_call(priv, start, priv);
367 } else if (!enable && mod) {
368 dev_dbg(&pdev->dev, "%s disable\n", __func__);
371 usbhs_mod_call(priv, stop, priv);
374 usbhsc_bus_init(priv);
377 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
378 usbhsc_power_ctrl(priv, enable);
380 usbhs_mod_change(priv, -1);
382 /* reset phy for next connection */
383 usbhs_platform_call(priv, phy_reset, pdev);
390 static void usbhsc_notify_hotplug(struct work_struct *work)
392 struct usbhs_priv *priv = container_of(work,
394 notify_hotplug_work.work);
395 usbhsc_hotplug(priv);
398 static int usbhsc_drvcllbck_notify_hotplug(struct platform_device *pdev)
400 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
401 int delay = usbhs_get_dparam(priv, detection_delay);
404 * This functions will be called in interrupt.
405 * To make sure safety context,
406 * use workqueue for usbhs_notify_hotplug
408 schedule_delayed_work(&priv->notify_hotplug_work,
409 msecs_to_jiffies(delay));
416 static int usbhs_probe(struct platform_device *pdev)
418 struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
419 struct renesas_usbhs_driver_callback *dfunc;
420 struct usbhs_priv *priv;
421 struct resource *res, *irq_res;
424 /* check platform information */
426 !info->platform_callback.get_id) {
427 dev_err(&pdev->dev, "no platform information\n");
432 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
433 irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
434 if (!res || !irq_res) {
435 dev_err(&pdev->dev, "Not enough Renesas USB platform resources.\n");
439 /* usb private data */
440 priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
442 dev_err(&pdev->dev, "Could not allocate priv\n");
446 priv->base = devm_request_and_ioremap(&pdev->dev, res);
448 dev_err(&pdev->dev, "ioremap error.\n");
456 &info->platform_callback,
457 sizeof(struct renesas_usbhs_platform_callback));
458 memcpy(&priv->dparam,
460 sizeof(struct renesas_usbhs_driver_param));
462 /* set driver callback functions for platform */
463 dfunc = &info->driver_callback;
464 dfunc->notify_hotplug = usbhsc_drvcllbck_notify_hotplug;
466 /* set default param if platform doesn't have */
467 if (!priv->dparam.pipe_type) {
468 priv->dparam.pipe_type = usbhsc_default_pipe_type;
469 priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_default_pipe_type);
471 if (!priv->dparam.pio_dma_border)
472 priv->dparam.pio_dma_border = 64; /* 64byte */
475 /* runtime power control ? */
476 if (priv->pfunc.get_vbus)
477 usbhsc_flags_set(priv, USBHSF_RUNTIME_PWCTRL);
482 priv->irq = irq_res->start;
483 if (irq_res->flags & IORESOURCE_IRQ_SHAREABLE)
484 priv->irqflags = IRQF_SHARED;
486 INIT_DELAYED_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
487 spin_lock_init(usbhs_priv_to_lock(priv));
489 /* call pipe and module init */
490 ret = usbhs_pipe_probe(priv);
494 ret = usbhs_fifo_probe(priv);
496 goto probe_end_pipe_exit;
498 ret = usbhs_mod_probe(priv);
500 goto probe_end_fifo_exit;
502 /* dev_set_drvdata should be called after usbhs_mod_init */
503 dev_set_drvdata(&pdev->dev, priv);
506 * deviece reset here because
507 * USB device might be used in boot loader.
509 usbhs_sys_clock_ctrl(priv, 0);
514 * USB phy setup might depend on CPU/Board.
515 * If platform has its callback functions,
518 ret = usbhs_platform_call(priv, hardware_init, pdev);
520 dev_err(&pdev->dev, "platform prove failed.\n");
521 goto probe_end_mod_exit;
524 /* reset phy for connection */
525 usbhs_platform_call(priv, phy_reset, pdev);
528 pm_runtime_enable(&pdev->dev);
529 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL)) {
530 usbhsc_power_ctrl(priv, 1);
531 usbhs_mod_autonomy_mode(priv);
535 * manual call notify_hotplug for cold plug
537 ret = usbhsc_drvcllbck_notify_hotplug(pdev);
539 goto probe_end_call_remove;
541 dev_info(&pdev->dev, "probed\n");
545 probe_end_call_remove:
546 usbhs_platform_call(priv, hardware_exit, pdev);
548 usbhs_mod_remove(priv);
550 usbhs_fifo_remove(priv);
552 usbhs_pipe_remove(priv);
554 dev_info(&pdev->dev, "probe failed\n");
559 static int usbhs_remove(struct platform_device *pdev)
561 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
562 struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
563 struct renesas_usbhs_driver_callback *dfunc = &info->driver_callback;
565 dev_dbg(&pdev->dev, "usb remove\n");
567 dfunc->notify_hotplug = NULL;
570 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
571 usbhsc_power_ctrl(priv, 0);
573 pm_runtime_disable(&pdev->dev);
575 usbhs_platform_call(priv, hardware_exit, pdev);
576 usbhs_mod_remove(priv);
577 usbhs_fifo_remove(priv);
578 usbhs_pipe_remove(priv);
583 static int usbhsc_suspend(struct device *dev)
585 struct usbhs_priv *priv = dev_get_drvdata(dev);
586 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
589 usbhs_mod_call(priv, stop, priv);
590 usbhs_mod_change(priv, -1);
593 if (mod || !usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
594 usbhsc_power_ctrl(priv, 0);
599 static int usbhsc_resume(struct device *dev)
601 struct usbhs_priv *priv = dev_get_drvdata(dev);
602 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
604 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
605 usbhsc_power_ctrl(priv, 1);
607 usbhs_platform_call(priv, phy_reset, pdev);
609 usbhsc_drvcllbck_notify_hotplug(pdev);
614 static int usbhsc_runtime_nop(struct device *dev)
616 /* Runtime PM callback shared between ->runtime_suspend()
617 * and ->runtime_resume(). Simply returns success.
619 * This driver re-initializes all registers after
620 * pm_runtime_get_sync() anyway so there is no need
621 * to save and restore registers here.
626 static const struct dev_pm_ops usbhsc_pm_ops = {
627 .suspend = usbhsc_suspend,
628 .resume = usbhsc_resume,
629 .runtime_suspend = usbhsc_runtime_nop,
630 .runtime_resume = usbhsc_runtime_nop,
633 static struct platform_driver renesas_usbhs_driver = {
635 .name = "renesas_usbhs",
636 .pm = &usbhsc_pm_ops,
638 .probe = usbhs_probe,
639 .remove = usbhs_remove,
642 module_platform_driver(renesas_usbhs_driver);
644 MODULE_LICENSE("GPL");
645 MODULE_DESCRIPTION("Renesas USB driver");
646 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");