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_set_test_mode(struct usbhs_priv *priv, u16 mode)
137 usbhs_write(priv, TESTMODE, mode);
143 int usbhs_frame_get_num(struct usbhs_priv *priv)
145 return usbhs_read(priv, FRMNUM) & FRNM_MASK;
149 * usb request functions
151 void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
155 val = usbhs_read(priv, USBREQ);
156 req->bRequest = (val >> 8) & 0xFF;
157 req->bRequestType = (val >> 0) & 0xFF;
159 req->wValue = usbhs_read(priv, USBVAL);
160 req->wIndex = usbhs_read(priv, USBINDX);
161 req->wLength = usbhs_read(priv, USBLENG);
164 void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
166 usbhs_write(priv, USBREQ, (req->bRequest << 8) | req->bRequestType);
167 usbhs_write(priv, USBVAL, req->wValue);
168 usbhs_write(priv, USBINDX, req->wIndex);
169 usbhs_write(priv, USBLENG, req->wLength);
171 usbhs_bset(priv, DCPCTR, SUREQ, SUREQ);
177 void usbhs_bus_send_sof_enable(struct usbhs_priv *priv)
179 u16 status = usbhs_read(priv, DVSTCTR) & (USBRST | UACT);
181 if (status != USBRST) {
182 struct device *dev = usbhs_priv_to_dev(priv);
183 dev_err(dev, "usbhs should be reset\n");
186 usbhs_bset(priv, DVSTCTR, (USBRST | UACT), UACT);
189 void usbhs_bus_send_reset(struct usbhs_priv *priv)
191 usbhs_bset(priv, DVSTCTR, (USBRST | UACT), USBRST);
194 int usbhs_bus_get_speed(struct usbhs_priv *priv)
196 u16 dvstctr = usbhs_read(priv, DVSTCTR);
198 switch (RHST & dvstctr) {
200 return USB_SPEED_LOW;
201 case RHST_FULL_SPEED:
202 return USB_SPEED_FULL;
203 case RHST_HIGH_SPEED:
204 return USB_SPEED_HIGH;
207 return USB_SPEED_UNKNOWN;
210 int usbhs_vbus_ctrl(struct usbhs_priv *priv, int enable)
212 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
214 return usbhs_platform_call(priv, set_vbus, pdev, enable);
217 static void usbhsc_bus_init(struct usbhs_priv *priv)
219 usbhs_write(priv, DVSTCTR, 0);
221 usbhs_vbus_ctrl(priv, 0);
225 * device configuration
227 int usbhs_set_device_config(struct usbhs_priv *priv, int devnum,
228 u16 upphub, u16 hubport, u16 speed)
230 struct device *dev = usbhs_priv_to_dev(priv);
232 u32 reg = DEVADD0 + (2 * devnum);
235 dev_err(dev, "cannot set speed to unknown device %d\n", devnum);
240 dev_err(dev, "unsupported hub number %d\n", upphub);
246 usbspd = USBSPD_SPEED_LOW;
249 usbspd = USBSPD_SPEED_FULL;
252 usbspd = USBSPD_SPEED_HIGH;
255 dev_err(dev, "unsupported speed %d\n", speed);
259 usbhs_write(priv, reg, UPPHUB(upphub) |
269 static void usbhsc_set_buswait(struct usbhs_priv *priv)
271 int wait = usbhs_get_dparam(priv, buswait_bwait);
273 /* set bus wait if platform have */
275 usbhs_bset(priv, BUSWAIT, 0x000F, wait);
279 * platform default param
281 static u32 usbhsc_default_pipe_type[] = {
282 USB_ENDPOINT_XFER_CONTROL,
283 USB_ENDPOINT_XFER_ISOC,
284 USB_ENDPOINT_XFER_ISOC,
285 USB_ENDPOINT_XFER_BULK,
286 USB_ENDPOINT_XFER_BULK,
287 USB_ENDPOINT_XFER_BULK,
288 USB_ENDPOINT_XFER_INT,
289 USB_ENDPOINT_XFER_INT,
290 USB_ENDPOINT_XFER_INT,
291 USB_ENDPOINT_XFER_INT,
297 static void usbhsc_power_ctrl(struct usbhs_priv *priv, int enable)
299 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
300 struct device *dev = usbhs_priv_to_dev(priv);
304 pm_runtime_get_sync(dev);
306 /* enable platform power */
307 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
310 usbhs_sys_clock_ctrl(priv, enable);
313 usbhs_sys_clock_ctrl(priv, enable);
315 /* disable platform power */
316 usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);
319 pm_runtime_put_sync(dev);
326 static void usbhsc_hotplug(struct usbhs_priv *priv)
328 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
329 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
335 * get vbus status from platform
337 enable = usbhs_platform_call(priv, get_vbus, pdev);
340 * get id from platform
342 id = usbhs_platform_call(priv, get_id, pdev);
344 if (enable && !mod) {
345 ret = usbhs_mod_change(priv, id);
349 dev_dbg(&pdev->dev, "%s enable\n", __func__);
352 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
353 usbhsc_power_ctrl(priv, enable);
356 usbhsc_set_buswait(priv);
357 usbhsc_bus_init(priv);
360 usbhs_mod_call(priv, start, priv);
362 } else if (!enable && mod) {
363 dev_dbg(&pdev->dev, "%s disable\n", __func__);
366 usbhs_mod_call(priv, stop, priv);
369 usbhsc_bus_init(priv);
372 if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
373 usbhsc_power_ctrl(priv, enable);
375 usbhs_mod_change(priv, -1);
377 /* reset phy for next connection */
378 usbhs_platform_call(priv, phy_reset, pdev);
385 static void usbhsc_notify_hotplug(struct work_struct *work)
387 struct usbhs_priv *priv = container_of(work,
389 notify_hotplug_work.work);
390 usbhsc_hotplug(priv);
393 static int usbhsc_drvcllbck_notify_hotplug(struct platform_device *pdev)
395 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
396 int delay = usbhs_get_dparam(priv, detection_delay);
399 * This functions will be called in interrupt.
400 * To make sure safety context,
401 * use workqueue for usbhs_notify_hotplug
403 schedule_delayed_work(&priv->notify_hotplug_work,
404 msecs_to_jiffies(delay));
411 static int usbhs_probe(struct platform_device *pdev)
413 struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
414 struct renesas_usbhs_driver_callback *dfunc;
415 struct usbhs_priv *priv;
416 struct resource *res, *irq_res;
419 /* check platform information */
421 !info->platform_callback.get_id) {
422 dev_err(&pdev->dev, "no platform information\n");
427 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
428 irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
429 if (!res || !irq_res) {
430 dev_err(&pdev->dev, "Not enough Renesas USB platform resources.\n");
434 /* usb private data */
435 priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
437 dev_err(&pdev->dev, "Could not allocate priv\n");
441 priv->base = devm_request_and_ioremap(&pdev->dev, res);
443 dev_err(&pdev->dev, "ioremap error.\n");
451 &info->platform_callback,
452 sizeof(struct renesas_usbhs_platform_callback));
453 memcpy(&priv->dparam,
455 sizeof(struct renesas_usbhs_driver_param));
457 /* set driver callback functions for platform */
458 dfunc = &info->driver_callback;
459 dfunc->notify_hotplug = usbhsc_drvcllbck_notify_hotplug;
461 /* set default param if platform doesn't have */
462 if (!priv->dparam.pipe_type) {
463 priv->dparam.pipe_type = usbhsc_default_pipe_type;
464 priv->dparam.pipe_size = ARRAY_SIZE(usbhsc_default_pipe_type);
466 if (!priv->dparam.pio_dma_border)
467 priv->dparam.pio_dma_border = 64; /* 64byte */
470 /* runtime power control ? */
471 if (priv->pfunc.get_vbus)
472 usbhsc_flags_set(priv, USBHSF_RUNTIME_PWCTRL);
477 priv->irq = irq_res->start;
478 if (irq_res->flags & IORESOURCE_IRQ_SHAREABLE)
479 priv->irqflags = IRQF_SHARED;
481 INIT_DELAYED_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
482 spin_lock_init(usbhs_priv_to_lock(priv));
484 /* call pipe and module init */
485 ret = usbhs_pipe_probe(priv);
489 ret = usbhs_fifo_probe(priv);
491 goto probe_end_pipe_exit;
493 ret = usbhs_mod_probe(priv);
495 goto probe_end_fifo_exit;
497 /* dev_set_drvdata should be called after usbhs_mod_init */
498 dev_set_drvdata(&pdev->dev, priv);
501 * deviece reset here because
502 * USB device might be used in boot loader.
504 usbhs_sys_clock_ctrl(priv, 0);
509 * USB phy setup might depend on CPU/Board.
510 * If platform has its callback functions,
513 ret = usbhs_platform_call(priv, hardware_init, pdev);
515 dev_err(&pdev->dev, "platform prove failed.\n");
516 goto probe_end_mod_exit;
519 /* reset phy for connection */
520 usbhs_platform_call(priv, phy_reset, pdev);
523 pm_runtime_enable(&pdev->dev);
524 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL)) {
525 usbhsc_power_ctrl(priv, 1);
526 usbhs_mod_autonomy_mode(priv);
530 * manual call notify_hotplug for cold plug
532 ret = usbhsc_drvcllbck_notify_hotplug(pdev);
534 goto probe_end_call_remove;
536 dev_info(&pdev->dev, "probed\n");
540 probe_end_call_remove:
541 usbhs_platform_call(priv, hardware_exit, pdev);
543 usbhs_mod_remove(priv);
545 usbhs_fifo_remove(priv);
547 usbhs_pipe_remove(priv);
549 dev_info(&pdev->dev, "probe failed\n");
554 static int __devexit usbhs_remove(struct platform_device *pdev)
556 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
557 struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
558 struct renesas_usbhs_driver_callback *dfunc = &info->driver_callback;
560 dev_dbg(&pdev->dev, "usb remove\n");
562 dfunc->notify_hotplug = NULL;
565 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
566 usbhsc_power_ctrl(priv, 0);
568 pm_runtime_disable(&pdev->dev);
570 usbhs_platform_call(priv, hardware_exit, pdev);
571 usbhs_mod_remove(priv);
572 usbhs_fifo_remove(priv);
573 usbhs_pipe_remove(priv);
578 static int usbhsc_suspend(struct device *dev)
580 struct usbhs_priv *priv = dev_get_drvdata(dev);
581 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
584 usbhs_mod_call(priv, stop, priv);
585 usbhs_mod_change(priv, -1);
588 if (mod || !usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
589 usbhsc_power_ctrl(priv, 0);
594 static int usbhsc_resume(struct device *dev)
596 struct usbhs_priv *priv = dev_get_drvdata(dev);
597 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
599 if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
600 usbhsc_power_ctrl(priv, 1);
602 usbhs_platform_call(priv, phy_reset, pdev);
604 usbhsc_drvcllbck_notify_hotplug(pdev);
609 static int usbhsc_runtime_nop(struct device *dev)
611 /* Runtime PM callback shared between ->runtime_suspend()
612 * and ->runtime_resume(). Simply returns success.
614 * This driver re-initializes all registers after
615 * pm_runtime_get_sync() anyway so there is no need
616 * to save and restore registers here.
621 static const struct dev_pm_ops usbhsc_pm_ops = {
622 .suspend = usbhsc_suspend,
623 .resume = usbhsc_resume,
624 .runtime_suspend = usbhsc_runtime_nop,
625 .runtime_resume = usbhsc_runtime_nop,
628 static struct platform_driver renesas_usbhs_driver = {
630 .name = "renesas_usbhs",
631 .pm = &usbhsc_pm_ops,
633 .probe = usbhs_probe,
634 .remove = __devexit_p(usbhs_remove),
637 module_platform_driver(renesas_usbhs_driver);
639 MODULE_LICENSE("GPL");
640 MODULE_DESCRIPTION("Renesas USB driver");
641 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");