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 void usbhs_sys_clock_ctrl(struct usbhs_priv *priv, int enable)
100 usbhs_bset(priv, SYSCFG, SCKE, enable ? SCKE : 0);
103 void usbhs_sys_hispeed_ctrl(struct usbhs_priv *priv, int enable)
105 usbhs_bset(priv, SYSCFG, HSE, enable ? HSE : 0);
108 void usbhs_sys_usb_ctrl(struct usbhs_priv *priv, int enable)
110 usbhs_bset(priv, SYSCFG, USBE, enable ? USBE : 0);
113 void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable)
115 u16 mask = DCFM | DRPD | DPRPU;
116 u16 val = DCFM | DRPD;
117 int has_otg = usbhs_get_dparam(priv, has_otg);
120 usbhs_bset(priv, DVSTCTR, (EXTLP | PWEN), (EXTLP | PWEN));
126 * - D+ Line/D- Line Pull-down
128 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
131 void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable)
133 u16 mask = DCFM | DRPD | DPRPU;
139 * - select Function mode
142 usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
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);
232 static void usbhsc_set_buswait(struct usbhs_priv *priv)
234 int wait = usbhs_get_dparam(priv, buswait_bwait);
236 /* set bus wait if platform have */
238 usbhs_bset(priv, BUSWAIT, 0x000F, wait);
242 * platform default param
244 static u32 usbhsc_default_pipe_type[] = {
245 USB_ENDPOINT_XFER_CONTROL,
246 USB_ENDPOINT_XFER_ISOC,
247 USB_ENDPOINT_XFER_ISOC,
248 USB_ENDPOINT_XFER_BULK,
249 USB_ENDPOINT_XFER_BULK,
250 USB_ENDPOINT_XFER_BULK,
251 USB_ENDPOINT_XFER_INT,
252 USB_ENDPOINT_XFER_INT,
253 USB_ENDPOINT_XFER_INT,
254 USB_ENDPOINT_XFER_INT,
260 static void usbhsc_power_ctrl(struct usbhs_priv *priv, int enable)
262 struct device *dev = usbhs_priv_to_dev(priv);
266 pm_runtime_get_sync(dev);
269 usbhs_sys_clock_ctrl(priv, enable);
272 usbhs_sys_clock_ctrl(priv, enable);
275 pm_runtime_put_sync(dev);
282 static void usbhsc_hotplug(struct usbhs_priv *priv)
284 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
285 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
291 * get vbus status from platform
293 enable = usbhs_platform_call(priv, get_vbus, pdev);
296 * get id from platform
298 id = usbhs_platform_call(priv, get_id, pdev);
300 if (enable && !mod) {
301 ret = usbhs_mod_change(priv, id);
305 dev_dbg(&pdev->dev, "%s enable\n", __func__);
308 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
309 usbhsc_power_ctrl(priv, enable);
312 usbhsc_set_buswait(priv);
313 usbhsc_bus_init(priv);
316 usbhs_mod_call(priv, start, priv);
318 } else if (!enable && mod) {
319 dev_dbg(&pdev->dev, "%s disable\n", __func__);
322 usbhs_mod_call(priv, stop, priv);
325 usbhsc_bus_init(priv);
328 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
329 usbhsc_power_ctrl(priv, enable);
331 usbhs_mod_change(priv, -1);
333 /* reset phy for next connection */
334 usbhs_platform_call(priv, phy_reset, pdev);
341 static void usbhsc_notify_hotplug(struct work_struct *work)
343 struct usbhs_priv *priv = container_of(work,
345 notify_hotplug_work.work);
346 usbhsc_hotplug(priv);
349 int usbhsc_drvcllbck_notify_hotplug(struct platform_device *pdev)
351 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
352 int delay = usbhs_get_dparam(priv, detection_delay);
355 * This functions will be called in interrupt.
356 * To make sure safety context,
357 * use workqueue for usbhs_notify_hotplug
359 schedule_delayed_work(&priv->notify_hotplug_work, delay);
366 static int __devinit usbhs_probe(struct platform_device *pdev)
368 struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
369 struct renesas_usbhs_driver_callback *dfunc;
370 struct usbhs_priv *priv;
371 struct resource *res;
375 /* check platform information */
377 !info->platform_callback.get_id) {
378 dev_err(&pdev->dev, "no platform information\n");
383 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
384 irq = platform_get_irq(pdev, 0);
385 if (!res || (int)irq <= 0) {
386 dev_err(&pdev->dev, "Not enough Renesas USB platform resources.\n");
390 /* usb private data */
391 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
393 dev_err(&pdev->dev, "Could not allocate priv\n");
397 priv->base = ioremap_nocache(res->start, resource_size(res));
399 dev_err(&pdev->dev, "ioremap error.\n");
401 goto probe_end_kfree;
407 priv->pfunc = &info->platform_callback;
408 priv->dparam = &info->driver_param;
410 /* set driver callback functions for platform */
411 dfunc = &info->driver_callback;
412 dfunc->notify_hotplug = usbhsc_drvcllbck_notify_hotplug;
414 /* set default param if platform doesn't have */
415 if (!priv->dparam->pipe_type) {
416 priv->dparam->pipe_type = usbhsc_default_pipe_type;
417 priv->dparam->pipe_size = ARRAY_SIZE(usbhsc_default_pipe_type);
419 if (!priv->dparam->pio_dma_border)
420 priv->dparam->pio_dma_border = 64; /* 64byte */
423 /* runtime power control ? */
424 if (priv->pfunc->get_vbus)
425 usbhsc_flags_set(priv, USBHSF_RUNTIME_PWCTRL);
432 INIT_DELAYED_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
433 spin_lock_init(usbhs_priv_to_lock(priv));
435 /* call pipe and module init */
436 ret = usbhs_pipe_probe(priv);
438 goto probe_end_iounmap;
440 ret = usbhs_fifo_probe(priv);
442 goto probe_end_pipe_exit;
444 ret = usbhs_mod_probe(priv);
446 goto probe_end_fifo_exit;
448 /* dev_set_drvdata should be called after usbhs_mod_init */
449 dev_set_drvdata(&pdev->dev, priv);
452 * deviece reset here because
453 * USB device might be used in boot loader.
455 usbhs_sys_clock_ctrl(priv, 0);
460 * USB phy setup might depend on CPU/Board.
461 * If platform has its callback functions,
464 ret = usbhs_platform_call(priv, hardware_init, pdev);
466 dev_err(&pdev->dev, "platform prove failed.\n");
467 goto probe_end_mod_exit;
470 /* reset phy for connection */
471 usbhs_platform_call(priv, phy_reset, pdev);
474 pm_runtime_enable(&pdev->dev);
475 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL)) {
476 usbhsc_power_ctrl(priv, 1);
477 usbhs_mod_autonomy_mode(priv);
481 * manual call notify_hotplug for cold plug
483 ret = usbhsc_drvcllbck_notify_hotplug(pdev);
485 goto probe_end_call_remove;
487 dev_info(&pdev->dev, "probed\n");
491 probe_end_call_remove:
492 usbhs_platform_call(priv, hardware_exit, pdev);
494 usbhs_mod_remove(priv);
496 usbhs_fifo_remove(priv);
498 usbhs_pipe_remove(priv);
504 dev_info(&pdev->dev, "probe failed\n");
509 static int __devexit usbhs_remove(struct platform_device *pdev)
511 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
512 struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
513 struct renesas_usbhs_driver_callback *dfunc = &info->driver_callback;
515 dev_dbg(&pdev->dev, "usb remove\n");
517 dfunc->notify_hotplug = NULL;
520 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
521 usbhsc_power_ctrl(priv, 0);
523 pm_runtime_disable(&pdev->dev);
525 usbhs_platform_call(priv, hardware_exit, pdev);
526 usbhs_mod_remove(priv);
527 usbhs_fifo_remove(priv);
528 usbhs_pipe_remove(priv);
535 static int usbhsc_suspend(struct device *dev)
537 struct usbhs_priv *priv = dev_get_drvdata(dev);
538 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
541 usbhs_mod_call(priv, stop, priv);
542 usbhs_mod_change(priv, -1);
545 if (mod || !usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
546 usbhsc_power_ctrl(priv, 0);
551 static int usbhsc_resume(struct device *dev)
553 struct usbhs_priv *priv = dev_get_drvdata(dev);
554 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
556 usbhs_platform_call(priv, phy_reset, pdev);
558 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
559 usbhsc_power_ctrl(priv, 1);
561 usbhsc_hotplug(priv);
566 static int usbhsc_runtime_nop(struct device *dev)
568 /* Runtime PM callback shared between ->runtime_suspend()
569 * and ->runtime_resume(). Simply returns success.
571 * This driver re-initializes all registers after
572 * pm_runtime_get_sync() anyway so there is no need
573 * to save and restore registers here.
578 static const struct dev_pm_ops usbhsc_pm_ops = {
579 .suspend = usbhsc_suspend,
580 .resume = usbhsc_resume,
581 .runtime_suspend = usbhsc_runtime_nop,
582 .runtime_resume = usbhsc_runtime_nop,
585 static struct platform_driver renesas_usbhs_driver = {
587 .name = "renesas_usbhs",
588 .pm = &usbhsc_pm_ops,
590 .probe = usbhs_probe,
591 .remove = __devexit_p(usbhs_remove),
594 static int __init usbhs_init(void)
596 return platform_driver_register(&renesas_usbhs_driver);
599 static void __exit usbhs_exit(void)
601 platform_driver_unregister(&renesas_usbhs_driver);
604 module_init(usbhs_init);
605 module_exit(usbhs_exit);
607 MODULE_LICENSE("GPL");
608 MODULE_DESCRIPTION("Renesas USB driver");
609 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");