1 // SPDX-License-Identifier: GPL-2.0
3 * core.c - ChipIdea USB IP core family device controller
5 * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
11 * Description: ChipIdea USB IP core family device controller
13 * This driver is composed of several blocks:
14 * - HW: hardware interface
15 * - DBG: debug facilities (optional)
17 * - ISR: interrupts handling
18 * - ENDPT: endpoint operations (Gadget API)
19 * - GADGET: gadget operations (Gadget API)
20 * - BUS: bus glue code, bus abstraction layer
23 * - STALL_IN: non-empty bulk-in pipes cannot be halted
24 * if defined mass storage compliance succeeds but with warnings
28 * if undefined usbtest 13 fails
29 * - TRACE: enable function tracing (depends on DEBUG)
32 * - Chapter 9 & Mass Storage Compliance with Gadget File Storage
33 * - Chapter 9 Compliance with Gadget Zero (STALL_IN undefined)
34 * - Normal & LPM support
37 * - OK: 0-12, 13 (STALL_IN defined) & 14
38 * - Not Supported: 15 & 16 (ISO)
41 * - Suspend & Remote Wakeup
43 #include <linux/delay.h>
44 #include <linux/device.h>
45 #include <linux/dma-mapping.h>
46 #include <linux/extcon.h>
47 #include <linux/phy/phy.h>
48 #include <linux/platform_device.h>
49 #include <linux/module.h>
50 #include <linux/idr.h>
51 #include <linux/interrupt.h>
53 #include <linux/kernel.h>
54 #include <linux/slab.h>
55 #include <linux/pm_runtime.h>
56 #include <linux/pinctrl/consumer.h>
57 #include <linux/usb/ch9.h>
58 #include <linux/usb/gadget.h>
59 #include <linux/usb/otg.h>
60 #include <linux/usb/chipidea.h>
61 #include <linux/usb/of.h>
63 #include <linux/regulator/consumer.h>
64 #include <linux/usb/ehci_def.h>
73 /* Controller register map */
74 static const u8 ci_regs_nolpm[] = {
75 [CAP_CAPLENGTH] = 0x00U,
76 [CAP_HCCPARAMS] = 0x08U,
77 [CAP_DCCPARAMS] = 0x24U,
78 [CAP_TESTMODE] = 0x38U,
82 [OP_DEVICEADDR] = 0x14U,
83 [OP_ENDPTLISTADDR] = 0x18U,
85 [OP_BURSTSIZE] = 0x20U,
86 [OP_ULPI_VIEWPORT] = 0x30U,
91 [OP_ENDPTSETUPSTAT] = 0x6CU,
92 [OP_ENDPTPRIME] = 0x70U,
93 [OP_ENDPTFLUSH] = 0x74U,
94 [OP_ENDPTSTAT] = 0x78U,
95 [OP_ENDPTCOMPLETE] = 0x7CU,
96 [OP_ENDPTCTRL] = 0x80U,
99 static const u8 ci_regs_lpm[] = {
100 [CAP_CAPLENGTH] = 0x00U,
101 [CAP_HCCPARAMS] = 0x08U,
102 [CAP_DCCPARAMS] = 0x24U,
103 [CAP_TESTMODE] = 0xFCU,
106 [OP_USBINTR] = 0x08U,
107 [OP_DEVICEADDR] = 0x14U,
108 [OP_ENDPTLISTADDR] = 0x18U,
110 [OP_BURSTSIZE] = 0x20U,
111 [OP_ULPI_VIEWPORT] = 0x30U,
115 [OP_USBMODE] = 0xC8U,
116 [OP_ENDPTSETUPSTAT] = 0xD8U,
117 [OP_ENDPTPRIME] = 0xDCU,
118 [OP_ENDPTFLUSH] = 0xE0U,
119 [OP_ENDPTSTAT] = 0xE4U,
120 [OP_ENDPTCOMPLETE] = 0xE8U,
121 [OP_ENDPTCTRL] = 0xECU,
124 static void hw_alloc_regmap(struct ci_hdrc *ci, bool is_lpm)
128 for (i = 0; i < OP_ENDPTCTRL; i++)
129 ci->hw_bank.regmap[i] =
130 (i <= CAP_LAST ? ci->hw_bank.cap : ci->hw_bank.op) +
131 (is_lpm ? ci_regs_lpm[i] : ci_regs_nolpm[i]);
133 for (; i <= OP_LAST; i++)
134 ci->hw_bank.regmap[i] = ci->hw_bank.op +
135 4 * (i - OP_ENDPTCTRL) +
137 ? ci_regs_lpm[OP_ENDPTCTRL]
138 : ci_regs_nolpm[OP_ENDPTCTRL]);
142 static enum ci_revision ci_get_revision(struct ci_hdrc *ci)
144 int ver = hw_read_id_reg(ci, ID_ID, VERSION) >> __ffs(VERSION);
145 enum ci_revision rev = CI_REVISION_UNKNOWN;
148 rev = hw_read_id_reg(ci, ID_ID, REVISION)
150 rev += CI_REVISION_20;
151 } else if (ver == 0x0) {
152 rev = CI_REVISION_1X;
159 * hw_read_intr_enable: returns interrupt enable register
161 * @ci: the controller
163 * This function returns register data
165 u32 hw_read_intr_enable(struct ci_hdrc *ci)
167 return hw_read(ci, OP_USBINTR, ~0);
171 * hw_read_intr_status: returns interrupt status register
173 * @ci: the controller
175 * This function returns register data
177 u32 hw_read_intr_status(struct ci_hdrc *ci)
179 return hw_read(ci, OP_USBSTS, ~0);
183 * hw_port_test_set: writes port test mode (execute without interruption)
186 * This function returns an error code
188 int hw_port_test_set(struct ci_hdrc *ci, u8 mode)
190 const u8 TEST_MODE_MAX = 7;
192 if (mode > TEST_MODE_MAX)
195 hw_write(ci, OP_PORTSC, PORTSC_PTC, mode << __ffs(PORTSC_PTC));
200 * hw_port_test_get: reads port test mode value
202 * @ci: the controller
204 * This function returns port test mode value
206 u8 hw_port_test_get(struct ci_hdrc *ci)
208 return hw_read(ci, OP_PORTSC, PORTSC_PTC) >> __ffs(PORTSC_PTC);
211 static void hw_wait_phy_stable(void)
214 * The phy needs some delay to output the stable status from low
215 * power mode. And for OTGSC, the status inputs are debounced
216 * using a 1 ms time constant, so, delay 2ms for controller to get
217 * the stable status, like vbus and id when the phy leaves low power.
219 usleep_range(2000, 2500);
222 /* The PHY enters/leaves low power mode */
223 static void ci_hdrc_enter_lpm(struct ci_hdrc *ci, bool enable)
225 enum ci_hw_regs reg = ci->hw_bank.lpm ? OP_DEVLC : OP_PORTSC;
226 bool lpm = !!(hw_read(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm)));
229 hw_write(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm),
230 PORTSC_PHCD(ci->hw_bank.lpm));
231 else if (!enable && lpm)
232 hw_write(ci, reg, PORTSC_PHCD(ci->hw_bank.lpm),
236 static int hw_device_init(struct ci_hdrc *ci, void __iomem *base)
240 /* bank is a module variable */
241 ci->hw_bank.abs = base;
243 ci->hw_bank.cap = ci->hw_bank.abs;
244 ci->hw_bank.cap += ci->platdata->capoffset;
245 ci->hw_bank.op = ci->hw_bank.cap + (ioread32(ci->hw_bank.cap) & 0xff);
247 hw_alloc_regmap(ci, false);
248 reg = hw_read(ci, CAP_HCCPARAMS, HCCPARAMS_LEN) >>
249 __ffs(HCCPARAMS_LEN);
250 ci->hw_bank.lpm = reg;
252 hw_alloc_regmap(ci, !!reg);
253 ci->hw_bank.size = ci->hw_bank.op - ci->hw_bank.abs;
254 ci->hw_bank.size += OP_LAST;
255 ci->hw_bank.size /= sizeof(u32);
257 reg = hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DEN) >>
258 __ffs(DCCPARAMS_DEN);
259 ci->hw_ep_max = reg * 2; /* cache hw ENDPT_MAX */
261 if (ci->hw_ep_max > ENDPT_MAX)
264 ci_hdrc_enter_lpm(ci, false);
266 /* Disable all interrupts bits */
267 hw_write(ci, OP_USBINTR, 0xffffffff, 0);
269 /* Clear all interrupts status bits*/
270 hw_write(ci, OP_USBSTS, 0xffffffff, 0xffffffff);
272 ci->rev = ci_get_revision(ci);
275 "ChipIdea HDRC found, revision: %d, lpm: %d; cap: %p op: %p\n",
276 ci->rev, ci->hw_bank.lpm, ci->hw_bank.cap, ci->hw_bank.op);
278 /* setup lock mode ? */
280 /* ENDPTSETUPSTAT is '0' by default */
282 /* HCSPARAMS.bf.ppc SHOULD BE zero for device */
287 void hw_phymode_configure(struct ci_hdrc *ci)
289 u32 portsc, lpm, sts = 0;
291 switch (ci->platdata->phy_mode) {
292 case USBPHY_INTERFACE_MODE_UTMI:
293 portsc = PORTSC_PTS(PTS_UTMI);
294 lpm = DEVLC_PTS(PTS_UTMI);
296 case USBPHY_INTERFACE_MODE_UTMIW:
297 portsc = PORTSC_PTS(PTS_UTMI) | PORTSC_PTW;
298 lpm = DEVLC_PTS(PTS_UTMI) | DEVLC_PTW;
300 case USBPHY_INTERFACE_MODE_ULPI:
301 portsc = PORTSC_PTS(PTS_ULPI);
302 lpm = DEVLC_PTS(PTS_ULPI);
304 case USBPHY_INTERFACE_MODE_SERIAL:
305 portsc = PORTSC_PTS(PTS_SERIAL);
306 lpm = DEVLC_PTS(PTS_SERIAL);
309 case USBPHY_INTERFACE_MODE_HSIC:
310 portsc = PORTSC_PTS(PTS_HSIC);
311 lpm = DEVLC_PTS(PTS_HSIC);
317 if (ci->hw_bank.lpm) {
318 hw_write(ci, OP_DEVLC, DEVLC_PTS(7) | DEVLC_PTW, lpm);
320 hw_write(ci, OP_DEVLC, DEVLC_STS, DEVLC_STS);
322 hw_write(ci, OP_PORTSC, PORTSC_PTS(7) | PORTSC_PTW, portsc);
324 hw_write(ci, OP_PORTSC, PORTSC_STS, PORTSC_STS);
327 EXPORT_SYMBOL_GPL(hw_phymode_configure);
330 * _ci_usb_phy_init: initialize phy taking in account both phy and usb_phy
332 * @ci: the controller
334 * This function returns an error code if the phy failed to init
336 static int _ci_usb_phy_init(struct ci_hdrc *ci)
341 ret = phy_init(ci->phy);
345 ret = phy_power_on(ci->phy);
351 ret = usb_phy_init(ci->usb_phy);
358 * _ci_usb_phy_exit: deinitialize phy taking in account both phy and usb_phy
360 * @ci: the controller
362 static void ci_usb_phy_exit(struct ci_hdrc *ci)
364 if (ci->platdata->flags & CI_HDRC_OVERRIDE_PHY_CONTROL)
368 phy_power_off(ci->phy);
371 usb_phy_shutdown(ci->usb_phy);
376 * ci_usb_phy_init: initialize phy according to different phy type
377 * @ci: the controller
379 * This function returns an error code if usb_phy_init has failed
381 static int ci_usb_phy_init(struct ci_hdrc *ci)
385 if (ci->platdata->flags & CI_HDRC_OVERRIDE_PHY_CONTROL)
388 switch (ci->platdata->phy_mode) {
389 case USBPHY_INTERFACE_MODE_UTMI:
390 case USBPHY_INTERFACE_MODE_UTMIW:
391 case USBPHY_INTERFACE_MODE_HSIC:
392 ret = _ci_usb_phy_init(ci);
394 hw_wait_phy_stable();
397 hw_phymode_configure(ci);
399 case USBPHY_INTERFACE_MODE_ULPI:
400 case USBPHY_INTERFACE_MODE_SERIAL:
401 hw_phymode_configure(ci);
402 ret = _ci_usb_phy_init(ci);
407 ret = _ci_usb_phy_init(ci);
409 hw_wait_phy_stable();
417 * ci_platform_configure: do controller configure
418 * @ci: the controller
421 void ci_platform_configure(struct ci_hdrc *ci)
423 bool is_device_mode, is_host_mode;
425 is_device_mode = hw_read(ci, OP_USBMODE, USBMODE_CM) == USBMODE_CM_DC;
426 is_host_mode = hw_read(ci, OP_USBMODE, USBMODE_CM) == USBMODE_CM_HC;
428 if (is_device_mode) {
429 phy_set_mode(ci->phy, PHY_MODE_USB_DEVICE);
431 if (ci->platdata->flags & CI_HDRC_DISABLE_DEVICE_STREAMING)
432 hw_write(ci, OP_USBMODE, USBMODE_CI_SDIS,
437 phy_set_mode(ci->phy, PHY_MODE_USB_HOST);
439 if (ci->platdata->flags & CI_HDRC_DISABLE_HOST_STREAMING)
440 hw_write(ci, OP_USBMODE, USBMODE_CI_SDIS,
444 if (ci->platdata->flags & CI_HDRC_FORCE_FULLSPEED) {
446 hw_write(ci, OP_DEVLC, DEVLC_PFSC, DEVLC_PFSC);
448 hw_write(ci, OP_PORTSC, PORTSC_PFSC, PORTSC_PFSC);
451 if (ci->platdata->flags & CI_HDRC_SET_NON_ZERO_TTHA)
452 hw_write(ci, OP_TTCTRL, TTCTRL_TTHA_MASK, TTCTRL_TTHA);
454 hw_write(ci, OP_USBCMD, 0xff0000, ci->platdata->itc_setting << 16);
456 if (ci->platdata->flags & CI_HDRC_OVERRIDE_AHB_BURST)
457 hw_write_id_reg(ci, ID_SBUSCFG, AHBBRST_MASK,
458 ci->platdata->ahb_burst_config);
460 /* override burst size, take effect only when ahb_burst_config is 0 */
461 if (!hw_read_id_reg(ci, ID_SBUSCFG, AHBBRST_MASK)) {
462 if (ci->platdata->flags & CI_HDRC_OVERRIDE_TX_BURST)
463 hw_write(ci, OP_BURSTSIZE, TX_BURST_MASK,
464 ci->platdata->tx_burst_size << __ffs(TX_BURST_MASK));
466 if (ci->platdata->flags & CI_HDRC_OVERRIDE_RX_BURST)
467 hw_write(ci, OP_BURSTSIZE, RX_BURST_MASK,
468 ci->platdata->rx_burst_size);
473 * hw_controller_reset: do controller reset
474 * @ci: the controller
476 * This function returns an error code
478 static int hw_controller_reset(struct ci_hdrc *ci)
482 hw_write(ci, OP_USBCMD, USBCMD_RST, USBCMD_RST);
483 while (hw_read(ci, OP_USBCMD, USBCMD_RST)) {
493 * hw_device_reset: resets chip (execute without interruption)
494 * @ci: the controller
496 * This function returns an error code
498 int hw_device_reset(struct ci_hdrc *ci)
502 /* should flush & stop before reset */
503 hw_write(ci, OP_ENDPTFLUSH, ~0, ~0);
504 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
506 ret = hw_controller_reset(ci);
508 dev_err(ci->dev, "error resetting controller, ret=%d\n", ret);
512 if (ci->platdata->notify_event) {
513 ret = ci->platdata->notify_event(ci,
514 CI_HDRC_CONTROLLER_RESET_EVENT);
519 /* USBMODE should be configured step by step */
520 hw_write(ci, OP_USBMODE, USBMODE_CM, USBMODE_CM_IDLE);
521 hw_write(ci, OP_USBMODE, USBMODE_CM, USBMODE_CM_DC);
523 hw_write(ci, OP_USBMODE, USBMODE_SLOM, USBMODE_SLOM);
525 if (hw_read(ci, OP_USBMODE, USBMODE_CM) != USBMODE_CM_DC) {
526 pr_err("cannot enter in %s device mode", ci_role(ci)->name);
527 pr_err("lpm = %i", ci->hw_bank.lpm);
531 ci_platform_configure(ci);
536 static irqreturn_t ci_irq(int irq, void *data)
538 struct ci_hdrc *ci = data;
539 irqreturn_t ret = IRQ_NONE;
543 disable_irq_nosync(irq);
544 ci->wakeup_int = true;
545 pm_runtime_get(ci->dev);
550 otgsc = hw_read_otgsc(ci, ~0);
551 if (ci_otg_is_fsm_mode(ci)) {
552 ret = ci_otg_fsm_irq(ci);
553 if (ret == IRQ_HANDLED)
559 * Handle id change interrupt, it indicates device/host function
562 if (ci->is_otg && (otgsc & OTGSC_IDIE) && (otgsc & OTGSC_IDIS)) {
564 /* Clear ID change irq status */
565 hw_write_otgsc(ci, OTGSC_IDIS, OTGSC_IDIS);
566 ci_otg_queue_work(ci);
571 * Handle vbus change interrupt, it indicates device connection
572 * and disconnection events.
574 if (ci->is_otg && (otgsc & OTGSC_BSVIE) && (otgsc & OTGSC_BSVIS)) {
575 ci->b_sess_valid_event = true;
577 hw_write_otgsc(ci, OTGSC_BSVIS, OTGSC_BSVIS);
578 ci_otg_queue_work(ci);
582 /* Handle device/host interrupt */
583 if (ci->role != CI_ROLE_END)
584 ret = ci_role(ci)->irq(ci);
589 static int ci_cable_notifier(struct notifier_block *nb, unsigned long event,
592 struct ci_hdrc_cable *cbl = container_of(nb, struct ci_hdrc_cable, nb);
593 struct ci_hdrc *ci = cbl->ci;
595 cbl->connected = event;
602 static int ci_get_platdata(struct device *dev,
603 struct ci_hdrc_platform_data *platdata)
605 struct extcon_dev *ext_vbus, *ext_id;
606 struct ci_hdrc_cable *cable;
609 if (!platdata->phy_mode)
610 platdata->phy_mode = of_usb_get_phy_mode(dev->of_node);
612 if (!platdata->dr_mode)
613 platdata->dr_mode = usb_get_dr_mode(dev);
615 if (platdata->dr_mode == USB_DR_MODE_UNKNOWN)
616 platdata->dr_mode = USB_DR_MODE_OTG;
618 if (platdata->dr_mode != USB_DR_MODE_PERIPHERAL) {
619 /* Get the vbus regulator */
620 platdata->reg_vbus = devm_regulator_get(dev, "vbus");
621 if (PTR_ERR(platdata->reg_vbus) == -EPROBE_DEFER) {
622 return -EPROBE_DEFER;
623 } else if (PTR_ERR(platdata->reg_vbus) == -ENODEV) {
624 /* no vbus regulator is needed */
625 platdata->reg_vbus = NULL;
626 } else if (IS_ERR(platdata->reg_vbus)) {
627 dev_err(dev, "Getting regulator error: %ld\n",
628 PTR_ERR(platdata->reg_vbus));
629 return PTR_ERR(platdata->reg_vbus);
631 /* Get TPL support */
632 if (!platdata->tpl_support)
633 platdata->tpl_support =
634 of_usb_host_tpl_support(dev->of_node);
637 if (platdata->dr_mode == USB_DR_MODE_OTG) {
638 /* We can support HNP and SRP of OTG 2.0 */
639 platdata->ci_otg_caps.otg_rev = 0x0200;
640 platdata->ci_otg_caps.hnp_support = true;
641 platdata->ci_otg_caps.srp_support = true;
643 /* Update otg capabilities by DT properties */
644 ret = of_usb_update_otg_caps(dev->of_node,
645 &platdata->ci_otg_caps);
650 if (usb_get_maximum_speed(dev) == USB_SPEED_FULL)
651 platdata->flags |= CI_HDRC_FORCE_FULLSPEED;
653 of_property_read_u32(dev->of_node, "phy-clkgate-delay-us",
654 &platdata->phy_clkgate_delay_us);
656 platdata->itc_setting = 1;
658 of_property_read_u32(dev->of_node, "itc-setting",
659 &platdata->itc_setting);
661 ret = of_property_read_u32(dev->of_node, "ahb-burst-config",
662 &platdata->ahb_burst_config);
664 platdata->flags |= CI_HDRC_OVERRIDE_AHB_BURST;
665 } else if (ret != -EINVAL) {
666 dev_err(dev, "failed to get ahb-burst-config\n");
670 ret = of_property_read_u32(dev->of_node, "tx-burst-size-dword",
671 &platdata->tx_burst_size);
673 platdata->flags |= CI_HDRC_OVERRIDE_TX_BURST;
674 } else if (ret != -EINVAL) {
675 dev_err(dev, "failed to get tx-burst-size-dword\n");
679 ret = of_property_read_u32(dev->of_node, "rx-burst-size-dword",
680 &platdata->rx_burst_size);
682 platdata->flags |= CI_HDRC_OVERRIDE_RX_BURST;
683 } else if (ret != -EINVAL) {
684 dev_err(dev, "failed to get rx-burst-size-dword\n");
688 if (of_find_property(dev->of_node, "non-zero-ttctrl-ttha", NULL))
689 platdata->flags |= CI_HDRC_SET_NON_ZERO_TTHA;
691 ext_id = ERR_PTR(-ENODEV);
692 ext_vbus = ERR_PTR(-ENODEV);
693 if (of_property_read_bool(dev->of_node, "extcon")) {
694 /* Each one of them is not mandatory */
695 ext_vbus = extcon_get_edev_by_phandle(dev, 0);
696 if (IS_ERR(ext_vbus) && PTR_ERR(ext_vbus) != -ENODEV)
697 return PTR_ERR(ext_vbus);
699 ext_id = extcon_get_edev_by_phandle(dev, 1);
700 if (IS_ERR(ext_id) && PTR_ERR(ext_id) != -ENODEV)
701 return PTR_ERR(ext_id);
704 cable = &platdata->vbus_extcon;
705 cable->nb.notifier_call = ci_cable_notifier;
706 cable->edev = ext_vbus;
708 if (!IS_ERR(ext_vbus)) {
709 ret = extcon_get_state(cable->edev, EXTCON_USB);
711 cable->connected = true;
713 cable->connected = false;
716 cable = &platdata->id_extcon;
717 cable->nb.notifier_call = ci_cable_notifier;
718 cable->edev = ext_id;
720 if (!IS_ERR(ext_id)) {
721 ret = extcon_get_state(cable->edev, EXTCON_USB_HOST);
723 cable->connected = true;
725 cable->connected = false;
728 platdata->pctl = devm_pinctrl_get(dev);
729 if (!IS_ERR(platdata->pctl)) {
730 struct pinctrl_state *p;
732 p = pinctrl_lookup_state(platdata->pctl, "default");
734 platdata->pins_default = p;
736 p = pinctrl_lookup_state(platdata->pctl, "host");
738 platdata->pins_host = p;
740 p = pinctrl_lookup_state(platdata->pctl, "device");
742 platdata->pins_device = p;
748 static int ci_extcon_register(struct ci_hdrc *ci)
750 struct ci_hdrc_cable *id, *vbus;
753 id = &ci->platdata->id_extcon;
755 if (!IS_ERR_OR_NULL(id->edev)) {
756 ret = devm_extcon_register_notifier(ci->dev, id->edev,
757 EXTCON_USB_HOST, &id->nb);
759 dev_err(ci->dev, "register ID failed\n");
764 vbus = &ci->platdata->vbus_extcon;
766 if (!IS_ERR_OR_NULL(vbus->edev)) {
767 ret = devm_extcon_register_notifier(ci->dev, vbus->edev,
768 EXTCON_USB, &vbus->nb);
770 dev_err(ci->dev, "register VBUS failed\n");
778 static DEFINE_IDA(ci_ida);
780 struct platform_device *ci_hdrc_add_device(struct device *dev,
781 struct resource *res, int nres,
782 struct ci_hdrc_platform_data *platdata)
784 struct platform_device *pdev;
787 ret = ci_get_platdata(dev, platdata);
791 id = ida_simple_get(&ci_ida, 0, 0, GFP_KERNEL);
795 pdev = platform_device_alloc("ci_hdrc", id);
801 pdev->dev.parent = dev;
803 ret = platform_device_add_resources(pdev, res, nres);
807 ret = platform_device_add_data(pdev, platdata, sizeof(*platdata));
811 ret = platform_device_add(pdev);
818 platform_device_put(pdev);
820 ida_simple_remove(&ci_ida, id);
823 EXPORT_SYMBOL_GPL(ci_hdrc_add_device);
825 void ci_hdrc_remove_device(struct platform_device *pdev)
828 platform_device_unregister(pdev);
829 ida_simple_remove(&ci_ida, id);
831 EXPORT_SYMBOL_GPL(ci_hdrc_remove_device);
833 static inline void ci_role_destroy(struct ci_hdrc *ci)
835 ci_hdrc_gadget_destroy(ci);
836 ci_hdrc_host_destroy(ci);
837 if (ci->is_otg && ci->roles[CI_ROLE_GADGET])
838 ci_hdrc_otg_destroy(ci);
841 static void ci_get_otg_capable(struct ci_hdrc *ci)
843 if (ci->platdata->flags & CI_HDRC_DUAL_ROLE_NOT_OTG)
846 ci->is_otg = (hw_read(ci, CAP_DCCPARAMS,
847 DCCPARAMS_DC | DCCPARAMS_HC)
848 == (DCCPARAMS_DC | DCCPARAMS_HC));
850 dev_dbg(ci->dev, "It is OTG capable controller\n");
851 /* Disable and clear all OTG irq */
852 hw_write_otgsc(ci, OTGSC_INT_EN_BITS | OTGSC_INT_STATUS_BITS,
853 OTGSC_INT_STATUS_BITS);
857 static ssize_t role_show(struct device *dev, struct device_attribute *attr,
860 struct ci_hdrc *ci = dev_get_drvdata(dev);
862 if (ci->role != CI_ROLE_END)
863 return sprintf(buf, "%s\n", ci_role(ci)->name);
868 static ssize_t role_store(struct device *dev,
869 struct device_attribute *attr, const char *buf, size_t n)
871 struct ci_hdrc *ci = dev_get_drvdata(dev);
875 if (!(ci->roles[CI_ROLE_HOST] && ci->roles[CI_ROLE_GADGET])) {
876 dev_warn(dev, "Current configuration is not dual-role, quit\n");
880 for (role = CI_ROLE_HOST; role < CI_ROLE_END; role++)
881 if (!strncmp(buf, ci->roles[role]->name,
882 strlen(ci->roles[role]->name)))
885 if (role == CI_ROLE_END || role == ci->role)
888 pm_runtime_get_sync(dev);
889 disable_irq(ci->irq);
891 ret = ci_role_start(ci, role);
892 if (!ret && ci->role == CI_ROLE_GADGET)
893 ci_handle_vbus_change(ci);
895 pm_runtime_put_sync(dev);
897 return (ret == 0) ? n : ret;
899 static DEVICE_ATTR_RW(role);
901 static struct attribute *ci_attrs[] = {
906 static const struct attribute_group ci_attr_group = {
910 static int ci_hdrc_probe(struct platform_device *pdev)
912 struct device *dev = &pdev->dev;
914 struct resource *res;
917 enum usb_dr_mode dr_mode;
919 if (!dev_get_platdata(dev)) {
920 dev_err(dev, "platform data missing\n");
924 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
925 base = devm_ioremap_resource(dev, res);
927 return PTR_ERR(base);
929 ci = devm_kzalloc(dev, sizeof(*ci), GFP_KERNEL);
933 spin_lock_init(&ci->lock);
935 ci->platdata = dev_get_platdata(dev);
936 ci->imx28_write_fix = !!(ci->platdata->flags &
937 CI_HDRC_IMX28_WRITE_FIX);
938 ci->supports_runtime_pm = !!(ci->platdata->flags &
939 CI_HDRC_SUPPORTS_RUNTIME_PM);
940 platform_set_drvdata(pdev, ci);
942 ret = hw_device_init(ci, base);
944 dev_err(dev, "can't initialize hardware\n");
948 ret = ci_ulpi_init(ci);
952 if (ci->platdata->phy) {
953 ci->phy = ci->platdata->phy;
954 } else if (ci->platdata->usb_phy) {
955 ci->usb_phy = ci->platdata->usb_phy;
957 /* Look for a generic PHY first */
958 ci->phy = devm_phy_get(dev->parent, "usb-phy");
960 if (PTR_ERR(ci->phy) == -EPROBE_DEFER) {
963 } else if (IS_ERR(ci->phy)) {
967 /* Look for a legacy USB PHY from device-tree next */
969 ci->usb_phy = devm_usb_get_phy_by_phandle(dev->parent,
972 if (PTR_ERR(ci->usb_phy) == -EPROBE_DEFER) {
975 } else if (IS_ERR(ci->usb_phy)) {
980 /* Look for any registered legacy USB PHY as last resort */
981 if (!ci->phy && !ci->usb_phy) {
982 ci->usb_phy = devm_usb_get_phy(dev->parent,
985 if (PTR_ERR(ci->usb_phy) == -EPROBE_DEFER) {
988 } else if (IS_ERR(ci->usb_phy)) {
993 /* No USB PHY was found in the end */
994 if (!ci->phy && !ci->usb_phy) {
1000 ret = ci_usb_phy_init(ci);
1002 dev_err(dev, "unable to init phy: %d\n", ret);
1006 ci->hw_bank.phys = res->start;
1008 ci->irq = platform_get_irq(pdev, 0);
1010 dev_err(dev, "missing IRQ\n");
1015 ci_get_otg_capable(ci);
1017 dr_mode = ci->platdata->dr_mode;
1018 /* initialize role(s) before the interrupt is requested */
1019 if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_HOST) {
1020 ret = ci_hdrc_host_init(ci);
1023 dev_info(dev, "doesn't support host\n");
1029 if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_PERIPHERAL) {
1030 ret = ci_hdrc_gadget_init(ci);
1033 dev_info(dev, "doesn't support gadget\n");
1039 if (!ci->roles[CI_ROLE_HOST] && !ci->roles[CI_ROLE_GADGET]) {
1040 dev_err(dev, "no supported roles\n");
1045 if (ci->is_otg && ci->roles[CI_ROLE_GADGET]) {
1046 ret = ci_hdrc_otg_init(ci);
1048 dev_err(dev, "init otg fails, ret = %d\n", ret);
1053 if (ci->roles[CI_ROLE_HOST] && ci->roles[CI_ROLE_GADGET]) {
1055 ci->role = ci_otg_role(ci);
1056 /* Enable ID change irq */
1057 hw_write_otgsc(ci, OTGSC_IDIE, OTGSC_IDIE);
1060 * If the controller is not OTG capable, but support
1061 * role switch, the defalt role is gadget, and the
1062 * user can switch it through debugfs.
1064 ci->role = CI_ROLE_GADGET;
1067 ci->role = ci->roles[CI_ROLE_HOST]
1072 if (!ci_otg_is_fsm_mode(ci)) {
1073 /* only update vbus status for peripheral */
1074 if (ci->role == CI_ROLE_GADGET)
1075 ci_handle_vbus_change(ci);
1077 ret = ci_role_start(ci, ci->role);
1079 dev_err(dev, "can't start %s role\n",
1085 ret = devm_request_irq(dev, ci->irq, ci_irq, IRQF_SHARED,
1086 ci->platdata->name, ci);
1090 ret = ci_extcon_register(ci);
1094 if (ci->supports_runtime_pm) {
1095 pm_runtime_set_active(&pdev->dev);
1096 pm_runtime_enable(&pdev->dev);
1097 pm_runtime_set_autosuspend_delay(&pdev->dev, 2000);
1098 pm_runtime_mark_last_busy(ci->dev);
1099 pm_runtime_use_autosuspend(&pdev->dev);
1102 if (ci_otg_is_fsm_mode(ci))
1103 ci_hdrc_otg_fsm_start(ci);
1105 device_set_wakeup_capable(&pdev->dev, true);
1106 dbg_create_files(ci);
1108 ret = sysfs_create_group(&dev->kobj, &ci_attr_group);
1115 dbg_remove_files(ci);
1117 if (ci->is_otg && ci->roles[CI_ROLE_GADGET])
1118 ci_hdrc_otg_destroy(ci);
1120 ci_hdrc_gadget_destroy(ci);
1122 ci_hdrc_host_destroy(ci);
1124 ci_usb_phy_exit(ci);
1131 static int ci_hdrc_remove(struct platform_device *pdev)
1133 struct ci_hdrc *ci = platform_get_drvdata(pdev);
1135 if (ci->supports_runtime_pm) {
1136 pm_runtime_get_sync(&pdev->dev);
1137 pm_runtime_disable(&pdev->dev);
1138 pm_runtime_put_noidle(&pdev->dev);
1141 dbg_remove_files(ci);
1142 sysfs_remove_group(&ci->dev->kobj, &ci_attr_group);
1143 ci_role_destroy(ci);
1144 ci_hdrc_enter_lpm(ci, true);
1145 ci_usb_phy_exit(ci);
1152 /* Prepare wakeup by SRP before suspend */
1153 static void ci_otg_fsm_suspend_for_srp(struct ci_hdrc *ci)
1155 if ((ci->fsm.otg->state == OTG_STATE_A_IDLE) &&
1156 !hw_read_otgsc(ci, OTGSC_ID)) {
1157 hw_write(ci, OP_PORTSC, PORTSC_W1C_BITS | PORTSC_PP,
1159 hw_write(ci, OP_PORTSC, PORTSC_W1C_BITS | PORTSC_WKCN,
1164 /* Handle SRP when wakeup by data pulse */
1165 static void ci_otg_fsm_wakeup_by_srp(struct ci_hdrc *ci)
1167 if ((ci->fsm.otg->state == OTG_STATE_A_IDLE) &&
1168 (ci->fsm.a_bus_drop == 1) && (ci->fsm.a_bus_req == 0)) {
1169 if (!hw_read_otgsc(ci, OTGSC_ID)) {
1170 ci->fsm.a_srp_det = 1;
1171 ci->fsm.a_bus_drop = 0;
1175 ci_otg_queue_work(ci);
1179 static void ci_controller_suspend(struct ci_hdrc *ci)
1181 disable_irq(ci->irq);
1182 ci_hdrc_enter_lpm(ci, true);
1183 if (ci->platdata->phy_clkgate_delay_us)
1184 usleep_range(ci->platdata->phy_clkgate_delay_us,
1185 ci->platdata->phy_clkgate_delay_us + 50);
1186 usb_phy_set_suspend(ci->usb_phy, 1);
1188 enable_irq(ci->irq);
1191 static int ci_controller_resume(struct device *dev)
1193 struct ci_hdrc *ci = dev_get_drvdata(dev);
1196 dev_dbg(dev, "at %s\n", __func__);
1203 ci_hdrc_enter_lpm(ci, false);
1205 ret = ci_ulpi_resume(ci);
1210 usb_phy_set_suspend(ci->usb_phy, 0);
1211 usb_phy_set_wakeup(ci->usb_phy, false);
1212 hw_wait_phy_stable();
1216 if (ci->wakeup_int) {
1217 ci->wakeup_int = false;
1218 pm_runtime_mark_last_busy(ci->dev);
1219 pm_runtime_put_autosuspend(ci->dev);
1220 enable_irq(ci->irq);
1221 if (ci_otg_is_fsm_mode(ci))
1222 ci_otg_fsm_wakeup_by_srp(ci);
1228 #ifdef CONFIG_PM_SLEEP
1229 static int ci_suspend(struct device *dev)
1231 struct ci_hdrc *ci = dev_get_drvdata(dev);
1234 flush_workqueue(ci->wq);
1236 * Controller needs to be active during suspend, otherwise the core
1237 * may run resume when the parent is at suspend if other driver's
1238 * suspend fails, it occurs before parent's suspend has not started,
1239 * but the core suspend has finished.
1242 pm_runtime_resume(dev);
1249 if (device_may_wakeup(dev)) {
1250 if (ci_otg_is_fsm_mode(ci))
1251 ci_otg_fsm_suspend_for_srp(ci);
1253 usb_phy_set_wakeup(ci->usb_phy, true);
1254 enable_irq_wake(ci->irq);
1257 ci_controller_suspend(ci);
1262 static int ci_resume(struct device *dev)
1264 struct ci_hdrc *ci = dev_get_drvdata(dev);
1267 if (device_may_wakeup(dev))
1268 disable_irq_wake(ci->irq);
1270 ret = ci_controller_resume(dev);
1274 if (ci->supports_runtime_pm) {
1275 pm_runtime_disable(dev);
1276 pm_runtime_set_active(dev);
1277 pm_runtime_enable(dev);
1282 #endif /* CONFIG_PM_SLEEP */
1284 static int ci_runtime_suspend(struct device *dev)
1286 struct ci_hdrc *ci = dev_get_drvdata(dev);
1288 dev_dbg(dev, "at %s\n", __func__);
1295 if (ci_otg_is_fsm_mode(ci))
1296 ci_otg_fsm_suspend_for_srp(ci);
1298 usb_phy_set_wakeup(ci->usb_phy, true);
1299 ci_controller_suspend(ci);
1304 static int ci_runtime_resume(struct device *dev)
1306 return ci_controller_resume(dev);
1309 #endif /* CONFIG_PM */
1310 static const struct dev_pm_ops ci_pm_ops = {
1311 SET_SYSTEM_SLEEP_PM_OPS(ci_suspend, ci_resume)
1312 SET_RUNTIME_PM_OPS(ci_runtime_suspend, ci_runtime_resume, NULL)
1315 static struct platform_driver ci_hdrc_driver = {
1316 .probe = ci_hdrc_probe,
1317 .remove = ci_hdrc_remove,
1324 static int __init ci_hdrc_platform_register(void)
1326 ci_hdrc_host_driver_init();
1327 return platform_driver_register(&ci_hdrc_driver);
1329 module_init(ci_hdrc_platform_register);
1331 static void __exit ci_hdrc_platform_unregister(void)
1333 platform_driver_unregister(&ci_hdrc_driver);
1335 module_exit(ci_hdrc_platform_unregister);
1337 MODULE_ALIAS("platform:ci_hdrc");
1338 MODULE_LICENSE("GPL v2");
1340 MODULE_DESCRIPTION("ChipIdea HDRC Driver");