2 * Rockchip USB2.0 PHY with Innosilicon IP block driver
4 * Copyright (C) 2016 Fuzhou Rockchip Electronics Co., Ltd
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
17 #include <linux/clk.h>
18 #include <linux/clk-provider.h>
19 #include <linux/delay.h>
20 #include <linux/extcon.h>
21 #include <linux/interrupt.h>
23 #include <linux/gpio/consumer.h>
24 #include <linux/jiffies.h>
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/mutex.h>
29 #include <linux/of_address.h>
30 #include <linux/of_irq.h>
31 #include <linux/of_platform.h>
32 #include <linux/phy/phy.h>
33 #include <linux/platform_device.h>
34 #include <linux/power_supply.h>
35 #include <linux/regmap.h>
36 #include <linux/mfd/syscon.h>
37 #include <linux/usb/of.h>
38 #include <linux/usb/otg.h>
40 #define BIT_WRITEABLE_SHIFT 16
41 #define SCHEDULE_DELAY (60 * HZ)
42 #define OTG_SCHEDULE_DELAY (2 * HZ)
44 enum rockchip_usb2phy_port_id
{
50 enum rockchip_usb2phy_host_state
{
51 PHY_STATE_HS_ONLINE
= 0,
52 PHY_STATE_DISCONNECT
= 1,
53 PHY_STATE_CONNECT
= 2,
54 PHY_STATE_FS_LS_ONLINE
= 4,
58 * Different states involved in USB charger detection.
59 * USB_CHG_STATE_UNDEFINED USB charger is not connected or detection
60 * process is not yet started.
61 * USB_CHG_STATE_WAIT_FOR_DCD Waiting for Data pins contact.
62 * USB_CHG_STATE_DCD_DONE Data pin contact is detected.
63 * USB_CHG_STATE_PRIMARY_DONE Primary detection is completed (Detects
64 * between SDP and DCP/CDP).
65 * USB_CHG_STATE_SECONDARY_DONE Secondary detection is completed (Detects
66 * between DCP and CDP).
67 * USB_CHG_STATE_DETECTED USB charger type is determined.
70 USB_CHG_STATE_UNDEFINED
= 0,
71 USB_CHG_STATE_WAIT_FOR_DCD
,
72 USB_CHG_STATE_DCD_DONE
,
73 USB_CHG_STATE_PRIMARY_DONE
,
74 USB_CHG_STATE_SECONDARY_DONE
,
75 USB_CHG_STATE_DETECTED
,
78 static const unsigned int rockchip_usb2phy_extcon_cable
[] = {
91 unsigned int bitstart
;
97 * struct rockchip_chg_det_reg: usb charger detect registers
98 * @cp_det: charging port detected successfully.
99 * @dcp_det: dedicated charging port detected successfully.
100 * @dp_det: assert data pin connect successfully.
101 * @idm_sink_en: open dm sink curren.
102 * @idp_sink_en: open dp sink current.
103 * @idp_src_en: open dm source current.
104 * @rdm_pdwn_en: open dm pull down resistor.
105 * @vdm_src_en: open dm voltage source.
106 * @vdp_src_en: open dp voltage source.
107 * @opmode: utmi operational mode.
109 struct rockchip_chg_det_reg
{
110 struct usb2phy_reg cp_det
;
111 struct usb2phy_reg dcp_det
;
112 struct usb2phy_reg dp_det
;
113 struct usb2phy_reg idm_sink_en
;
114 struct usb2phy_reg idp_sink_en
;
115 struct usb2phy_reg idp_src_en
;
116 struct usb2phy_reg rdm_pdwn_en
;
117 struct usb2phy_reg vdm_src_en
;
118 struct usb2phy_reg vdp_src_en
;
119 struct usb2phy_reg opmode
;
123 * struct rockchip_usb2phy_port_cfg: usb-phy port configuration.
124 * @phy_sus: phy suspend register.
125 * @bvalid_det_en: vbus valid rise detection enable register.
126 * @bvalid_det_st: vbus valid rise detection status register.
127 * @bvalid_det_clr: vbus valid rise detection clear register.
128 * @ls_det_en: linestate detection enable register.
129 * @ls_det_st: linestate detection state register.
130 * @ls_det_clr: linestate detection clear register.
131 * @utmi_avalid: utmi vbus avalid status register.
132 * @utmi_bvalid: utmi vbus bvalid status register.
133 * @utmi_ls: utmi linestate state register.
134 * @utmi_hstdet: utmi host disconnect register.
136 struct rockchip_usb2phy_port_cfg
{
137 struct usb2phy_reg phy_sus
;
138 struct usb2phy_reg bvalid_det_en
;
139 struct usb2phy_reg bvalid_det_st
;
140 struct usb2phy_reg bvalid_det_clr
;
141 struct usb2phy_reg ls_det_en
;
142 struct usb2phy_reg ls_det_st
;
143 struct usb2phy_reg ls_det_clr
;
144 struct usb2phy_reg utmi_avalid
;
145 struct usb2phy_reg utmi_bvalid
;
146 struct usb2phy_reg utmi_ls
;
147 struct usb2phy_reg utmi_hstdet
;
151 * struct rockchip_usb2phy_cfg: usb-phy configuration.
152 * @reg: the address offset of grf for usb-phy config.
153 * @num_ports: specify how many ports that the phy has.
154 * @clkout_ctl: keep on/turn off output clk of phy.
155 * @chg_det: charger detection registers.
157 struct rockchip_usb2phy_cfg
{
159 unsigned int num_ports
;
160 struct usb2phy_reg clkout_ctl
;
161 const struct rockchip_usb2phy_port_cfg port_cfgs
[USB2PHY_NUM_PORTS
];
162 const struct rockchip_chg_det_reg chg_det
;
166 * struct rockchip_usb2phy_port: usb-phy port data.
167 * @port_id: flag for otg port or host port.
168 * @suspended: phy suspended flag.
169 * @utmi_avalid: utmi avalid status usage flag.
170 * true - use avalid to get vbus status
171 * flase - use bvalid to get vbus status
172 * @vbus_attached: otg device vbus status.
173 * @bvalid_irq: IRQ number assigned for vbus valid rise detection.
174 * @ls_irq: IRQ number assigned for linestate detection.
175 * @mutex: for register updating in sm_work.
176 * @chg_work: charge detect work.
177 * @otg_sm_work: OTG state machine work.
178 * @sm_work: HOST state machine work.
179 * @phy_cfg: port register configuration, assigned by driver data.
180 * @event_nb: hold event notification callback.
181 * @state: define OTG enumeration states before device reset.
182 * @mode: the dr_mode of the controller.
184 struct rockchip_usb2phy_port
{
186 unsigned int port_id
;
193 struct delayed_work chg_work
;
194 struct delayed_work otg_sm_work
;
195 struct delayed_work sm_work
;
196 const struct rockchip_usb2phy_port_cfg
*port_cfg
;
197 struct notifier_block event_nb
;
198 enum usb_otg_state state
;
199 enum usb_dr_mode mode
;
203 * struct rockchip_usb2phy: usb2.0 phy driver data.
204 * @grf: General Register Files regmap.
205 * @clk: clock struct of phy input clk.
206 * @clk480m: clock struct of phy output clk.
207 * @clk_hw: clock struct of phy output clk management.
208 * @chg_state: states involved in USB charger detection.
209 * @chg_type: USB charger types.
210 * @dcd_retries: The retry count used to track Data contact
212 * @edev: extcon device for notification registration
213 * @phy_cfg: phy register configuration, assigned by driver data.
214 * @ports: phy port instance.
216 struct rockchip_usb2phy
{
221 struct clk_hw clk480m_hw
;
222 enum usb_chg_state chg_state
;
223 enum power_supply_type chg_type
;
225 struct extcon_dev
*edev
;
226 const struct rockchip_usb2phy_cfg
*phy_cfg
;
227 struct rockchip_usb2phy_port ports
[USB2PHY_NUM_PORTS
];
230 static inline int property_enable(struct rockchip_usb2phy
*rphy
,
231 const struct usb2phy_reg
*reg
, bool en
)
233 unsigned int val
, mask
, tmp
;
235 tmp
= en
? reg
->enable
: reg
->disable
;
236 mask
= GENMASK(reg
->bitend
, reg
->bitstart
);
237 val
= (tmp
<< reg
->bitstart
) | (mask
<< BIT_WRITEABLE_SHIFT
);
239 return regmap_write(rphy
->grf
, reg
->offset
, val
);
242 static inline bool property_enabled(struct rockchip_usb2phy
*rphy
,
243 const struct usb2phy_reg
*reg
)
246 unsigned int tmp
, orig
;
247 unsigned int mask
= GENMASK(reg
->bitend
, reg
->bitstart
);
249 ret
= regmap_read(rphy
->grf
, reg
->offset
, &orig
);
253 tmp
= (orig
& mask
) >> reg
->bitstart
;
254 return tmp
== reg
->enable
;
257 static int rockchip_usb2phy_clk480m_prepare(struct clk_hw
*hw
)
259 struct rockchip_usb2phy
*rphy
=
260 container_of(hw
, struct rockchip_usb2phy
, clk480m_hw
);
263 /* turn on 480m clk output if it is off */
264 if (!property_enabled(rphy
, &rphy
->phy_cfg
->clkout_ctl
)) {
265 ret
= property_enable(rphy
, &rphy
->phy_cfg
->clkout_ctl
, true);
269 /* waiting for the clk become stable */
270 usleep_range(1200, 1300);
276 static void rockchip_usb2phy_clk480m_unprepare(struct clk_hw
*hw
)
278 struct rockchip_usb2phy
*rphy
=
279 container_of(hw
, struct rockchip_usb2phy
, clk480m_hw
);
281 /* turn off 480m clk output */
282 property_enable(rphy
, &rphy
->phy_cfg
->clkout_ctl
, false);
285 static int rockchip_usb2phy_clk480m_prepared(struct clk_hw
*hw
)
287 struct rockchip_usb2phy
*rphy
=
288 container_of(hw
, struct rockchip_usb2phy
, clk480m_hw
);
290 return property_enabled(rphy
, &rphy
->phy_cfg
->clkout_ctl
);
294 rockchip_usb2phy_clk480m_recalc_rate(struct clk_hw
*hw
,
295 unsigned long parent_rate
)
300 static const struct clk_ops rockchip_usb2phy_clkout_ops
= {
301 .prepare
= rockchip_usb2phy_clk480m_prepare
,
302 .unprepare
= rockchip_usb2phy_clk480m_unprepare
,
303 .is_prepared
= rockchip_usb2phy_clk480m_prepared
,
304 .recalc_rate
= rockchip_usb2phy_clk480m_recalc_rate
,
307 static void rockchip_usb2phy_clk480m_unregister(void *data
)
309 struct rockchip_usb2phy
*rphy
= data
;
311 of_clk_del_provider(rphy
->dev
->of_node
);
312 clk_unregister(rphy
->clk480m
);
316 rockchip_usb2phy_clk480m_register(struct rockchip_usb2phy
*rphy
)
318 struct device_node
*node
= rphy
->dev
->of_node
;
319 struct clk_init_data init
;
320 const char *clk_name
;
324 init
.name
= "clk_usbphy_480m";
325 init
.ops
= &rockchip_usb2phy_clkout_ops
;
327 /* optional override of the clockname */
328 of_property_read_string(node
, "clock-output-names", &init
.name
);
331 clk_name
= __clk_get_name(rphy
->clk
);
332 init
.parent_names
= &clk_name
;
333 init
.num_parents
= 1;
335 init
.parent_names
= NULL
;
336 init
.num_parents
= 0;
339 rphy
->clk480m_hw
.init
= &init
;
341 /* register the clock */
342 rphy
->clk480m
= clk_register(rphy
->dev
, &rphy
->clk480m_hw
);
343 if (IS_ERR(rphy
->clk480m
)) {
344 ret
= PTR_ERR(rphy
->clk480m
);
348 ret
= of_clk_add_provider(node
, of_clk_src_simple_get
, rphy
->clk480m
);
350 goto err_clk_provider
;
352 ret
= devm_add_action(rphy
->dev
, rockchip_usb2phy_clk480m_unregister
,
355 goto err_unreg_action
;
360 of_clk_del_provider(node
);
362 clk_unregister(rphy
->clk480m
);
367 static int rockchip_usb2phy_extcon_register(struct rockchip_usb2phy
*rphy
)
370 struct device_node
*node
= rphy
->dev
->of_node
;
371 struct extcon_dev
*edev
;
373 if (of_property_read_bool(node
, "extcon")) {
374 edev
= extcon_get_edev_by_phandle(rphy
->dev
, 0);
376 if (PTR_ERR(edev
) != -EPROBE_DEFER
)
377 dev_err(rphy
->dev
, "Invalid or missing extcon\n");
378 return PTR_ERR(edev
);
381 /* Initialize extcon device */
382 edev
= devm_extcon_dev_allocate(rphy
->dev
,
383 rockchip_usb2phy_extcon_cable
);
388 ret
= devm_extcon_dev_register(rphy
->dev
, edev
);
390 dev_err(rphy
->dev
, "failed to register extcon device\n");
400 static int rockchip_usb2phy_init(struct phy
*phy
)
402 struct rockchip_usb2phy_port
*rport
= phy_get_drvdata(phy
);
403 struct rockchip_usb2phy
*rphy
= dev_get_drvdata(phy
->dev
.parent
);
406 mutex_lock(&rport
->mutex
);
408 if (rport
->port_id
== USB2PHY_PORT_OTG
) {
409 if (rport
->mode
!= USB_DR_MODE_HOST
) {
410 /* clear bvalid status and enable bvalid detect irq */
411 ret
= property_enable(rphy
,
412 &rport
->port_cfg
->bvalid_det_clr
,
417 ret
= property_enable(rphy
,
418 &rport
->port_cfg
->bvalid_det_en
,
423 schedule_delayed_work(&rport
->otg_sm_work
,
426 /* If OTG works in host only mode, do nothing. */
427 dev_dbg(&rport
->phy
->dev
, "mode %d\n", rport
->mode
);
429 } else if (rport
->port_id
== USB2PHY_PORT_HOST
) {
430 /* clear linestate and enable linestate detect irq */
431 ret
= property_enable(rphy
, &rport
->port_cfg
->ls_det_clr
, true);
435 ret
= property_enable(rphy
, &rport
->port_cfg
->ls_det_en
, true);
439 schedule_delayed_work(&rport
->sm_work
, SCHEDULE_DELAY
);
443 mutex_unlock(&rport
->mutex
);
447 static int rockchip_usb2phy_power_on(struct phy
*phy
)
449 struct rockchip_usb2phy_port
*rport
= phy_get_drvdata(phy
);
450 struct rockchip_usb2phy
*rphy
= dev_get_drvdata(phy
->dev
.parent
);
453 dev_dbg(&rport
->phy
->dev
, "port power on\n");
455 if (!rport
->suspended
)
458 ret
= clk_prepare_enable(rphy
->clk480m
);
462 ret
= property_enable(rphy
, &rport
->port_cfg
->phy_sus
, false);
466 rport
->suspended
= false;
470 static int rockchip_usb2phy_power_off(struct phy
*phy
)
472 struct rockchip_usb2phy_port
*rport
= phy_get_drvdata(phy
);
473 struct rockchip_usb2phy
*rphy
= dev_get_drvdata(phy
->dev
.parent
);
476 dev_dbg(&rport
->phy
->dev
, "port power off\n");
478 if (rport
->suspended
)
481 ret
= property_enable(rphy
, &rport
->port_cfg
->phy_sus
, true);
485 rport
->suspended
= true;
486 clk_disable_unprepare(rphy
->clk480m
);
491 static int rockchip_usb2phy_exit(struct phy
*phy
)
493 struct rockchip_usb2phy_port
*rport
= phy_get_drvdata(phy
);
495 if (rport
->port_id
== USB2PHY_PORT_OTG
&&
496 rport
->mode
!= USB_DR_MODE_HOST
) {
497 cancel_delayed_work_sync(&rport
->otg_sm_work
);
498 cancel_delayed_work_sync(&rport
->chg_work
);
499 } else if (rport
->port_id
== USB2PHY_PORT_HOST
)
500 cancel_delayed_work_sync(&rport
->sm_work
);
505 static const struct phy_ops rockchip_usb2phy_ops
= {
506 .init
= rockchip_usb2phy_init
,
507 .exit
= rockchip_usb2phy_exit
,
508 .power_on
= rockchip_usb2phy_power_on
,
509 .power_off
= rockchip_usb2phy_power_off
,
510 .owner
= THIS_MODULE
,
513 static void rockchip_usb2phy_otg_sm_work(struct work_struct
*work
)
515 struct rockchip_usb2phy_port
*rport
=
516 container_of(work
, struct rockchip_usb2phy_port
,
518 struct rockchip_usb2phy
*rphy
= dev_get_drvdata(rport
->phy
->dev
.parent
);
519 static unsigned int cable
;
521 bool vbus_attach
, sch_work
, notify_charger
;
523 if (rport
->utmi_avalid
)
525 property_enabled(rphy
, &rport
->port_cfg
->utmi_avalid
);
528 property_enabled(rphy
, &rport
->port_cfg
->utmi_bvalid
);
531 notify_charger
= false;
532 delay
= OTG_SCHEDULE_DELAY
;
533 dev_dbg(&rport
->phy
->dev
, "%s otg sm work\n",
534 usb_otg_state_string(rport
->state
));
536 switch (rport
->state
) {
537 case OTG_STATE_UNDEFINED
:
538 rport
->state
= OTG_STATE_B_IDLE
;
540 rockchip_usb2phy_power_off(rport
->phy
);
542 case OTG_STATE_B_IDLE
:
543 if (extcon_get_cable_state_(rphy
->edev
, EXTCON_USB_HOST
) > 0) {
544 dev_dbg(&rport
->phy
->dev
, "usb otg host connect\n");
545 rport
->state
= OTG_STATE_A_HOST
;
546 rockchip_usb2phy_power_on(rport
->phy
);
548 } else if (vbus_attach
) {
549 dev_dbg(&rport
->phy
->dev
, "vbus_attach\n");
550 switch (rphy
->chg_state
) {
551 case USB_CHG_STATE_UNDEFINED
:
552 schedule_delayed_work(&rport
->chg_work
, 0);
554 case USB_CHG_STATE_DETECTED
:
555 switch (rphy
->chg_type
) {
556 case POWER_SUPPLY_TYPE_USB
:
557 dev_dbg(&rport
->phy
->dev
,
558 "sdp cable is connecetd\n");
559 rockchip_usb2phy_power_on(rport
->phy
);
560 rport
->state
= OTG_STATE_B_PERIPHERAL
;
561 notify_charger
= true;
563 cable
= EXTCON_CHG_USB_SDP
;
565 case POWER_SUPPLY_TYPE_USB_DCP
:
566 dev_dbg(&rport
->phy
->dev
,
567 "dcp cable is connecetd\n");
568 rockchip_usb2phy_power_off(rport
->phy
);
569 notify_charger
= true;
571 cable
= EXTCON_CHG_USB_DCP
;
573 case POWER_SUPPLY_TYPE_USB_CDP
:
574 dev_dbg(&rport
->phy
->dev
,
575 "cdp cable is connecetd\n");
576 rockchip_usb2phy_power_on(rport
->phy
);
577 rport
->state
= OTG_STATE_B_PERIPHERAL
;
578 notify_charger
= true;
580 cable
= EXTCON_CHG_USB_CDP
;
590 notify_charger
= true;
591 rphy
->chg_state
= USB_CHG_STATE_UNDEFINED
;
592 rphy
->chg_type
= POWER_SUPPLY_TYPE_UNKNOWN
;
595 if (rport
->vbus_attached
!= vbus_attach
) {
596 rport
->vbus_attached
= vbus_attach
;
598 if (notify_charger
&& rphy
->edev
)
599 extcon_set_cable_state_(rphy
->edev
,
603 case OTG_STATE_B_PERIPHERAL
:
605 dev_dbg(&rport
->phy
->dev
, "usb disconnect\n");
606 rphy
->chg_state
= USB_CHG_STATE_UNDEFINED
;
607 rphy
->chg_type
= POWER_SUPPLY_TYPE_UNKNOWN
;
608 rport
->state
= OTG_STATE_B_IDLE
;
610 rockchip_usb2phy_power_off(rport
->phy
);
614 case OTG_STATE_A_HOST
:
615 if (extcon_get_cable_state_(rphy
->edev
, EXTCON_USB_HOST
) == 0) {
616 dev_dbg(&rport
->phy
->dev
, "usb otg host disconnect\n");
617 rport
->state
= OTG_STATE_B_IDLE
;
618 rockchip_usb2phy_power_off(rport
->phy
);
626 schedule_delayed_work(&rport
->otg_sm_work
, delay
);
629 static const char *chg_to_string(enum power_supply_type chg_type
)
632 case POWER_SUPPLY_TYPE_USB
:
633 return "USB_SDP_CHARGER";
634 case POWER_SUPPLY_TYPE_USB_DCP
:
635 return "USB_DCP_CHARGER";
636 case POWER_SUPPLY_TYPE_USB_CDP
:
637 return "USB_CDP_CHARGER";
639 return "INVALID_CHARGER";
643 static void rockchip_chg_enable_dcd(struct rockchip_usb2phy
*rphy
,
646 property_enable(rphy
, &rphy
->phy_cfg
->chg_det
.rdm_pdwn_en
, en
);
647 property_enable(rphy
, &rphy
->phy_cfg
->chg_det
.idp_src_en
, en
);
650 static void rockchip_chg_enable_primary_det(struct rockchip_usb2phy
*rphy
,
653 property_enable(rphy
, &rphy
->phy_cfg
->chg_det
.vdp_src_en
, en
);
654 property_enable(rphy
, &rphy
->phy_cfg
->chg_det
.idm_sink_en
, en
);
657 static void rockchip_chg_enable_secondary_det(struct rockchip_usb2phy
*rphy
,
660 property_enable(rphy
, &rphy
->phy_cfg
->chg_det
.vdm_src_en
, en
);
661 property_enable(rphy
, &rphy
->phy_cfg
->chg_det
.idp_sink_en
, en
);
664 #define CHG_DCD_POLL_TIME (100 * HZ / 1000)
665 #define CHG_DCD_MAX_RETRIES 6
666 #define CHG_PRIMARY_DET_TIME (40 * HZ / 1000)
667 #define CHG_SECONDARY_DET_TIME (40 * HZ / 1000)
668 static void rockchip_chg_detect_work(struct work_struct
*work
)
670 struct rockchip_usb2phy_port
*rport
=
671 container_of(work
, struct rockchip_usb2phy_port
, chg_work
.work
);
672 struct rockchip_usb2phy
*rphy
= dev_get_drvdata(rport
->phy
->dev
.parent
);
673 bool is_dcd
, tmout
, vout
;
676 dev_dbg(&rport
->phy
->dev
, "chg detection work state = %d\n",
678 switch (rphy
->chg_state
) {
679 case USB_CHG_STATE_UNDEFINED
:
680 if (!rport
->suspended
)
681 rockchip_usb2phy_power_off(rport
->phy
);
682 /* put the controller in non-driving mode */
683 property_enable(rphy
, &rphy
->phy_cfg
->chg_det
.opmode
, false);
684 /* Start DCD processing stage 1 */
685 rockchip_chg_enable_dcd(rphy
, true);
686 rphy
->chg_state
= USB_CHG_STATE_WAIT_FOR_DCD
;
687 rphy
->dcd_retries
= 0;
688 delay
= CHG_DCD_POLL_TIME
;
690 case USB_CHG_STATE_WAIT_FOR_DCD
:
691 /* get data contact detection status */
692 is_dcd
= property_enabled(rphy
, &rphy
->phy_cfg
->chg_det
.dp_det
);
693 tmout
= ++rphy
->dcd_retries
== CHG_DCD_MAX_RETRIES
;
695 if (is_dcd
|| tmout
) {
697 /* Turn off DCD circuitry */
698 rockchip_chg_enable_dcd(rphy
, false);
699 /* Voltage Source on DP, Probe on DM */
700 rockchip_chg_enable_primary_det(rphy
, true);
701 delay
= CHG_PRIMARY_DET_TIME
;
702 rphy
->chg_state
= USB_CHG_STATE_DCD_DONE
;
705 delay
= CHG_DCD_POLL_TIME
;
708 case USB_CHG_STATE_DCD_DONE
:
709 vout
= property_enabled(rphy
, &rphy
->phy_cfg
->chg_det
.cp_det
);
710 rockchip_chg_enable_primary_det(rphy
, false);
712 /* Voltage Source on DM, Probe on DP */
713 rockchip_chg_enable_secondary_det(rphy
, true);
714 delay
= CHG_SECONDARY_DET_TIME
;
715 rphy
->chg_state
= USB_CHG_STATE_PRIMARY_DONE
;
717 if (rphy
->dcd_retries
== CHG_DCD_MAX_RETRIES
) {
718 /* floating charger found */
719 rphy
->chg_type
= POWER_SUPPLY_TYPE_USB_DCP
;
720 rphy
->chg_state
= USB_CHG_STATE_DETECTED
;
723 rphy
->chg_type
= POWER_SUPPLY_TYPE_USB
;
724 rphy
->chg_state
= USB_CHG_STATE_DETECTED
;
729 case USB_CHG_STATE_PRIMARY_DONE
:
730 vout
= property_enabled(rphy
, &rphy
->phy_cfg
->chg_det
.dcp_det
);
731 /* Turn off voltage source */
732 rockchip_chg_enable_secondary_det(rphy
, false);
734 rphy
->chg_type
= POWER_SUPPLY_TYPE_USB_DCP
;
736 rphy
->chg_type
= POWER_SUPPLY_TYPE_USB_CDP
;
738 case USB_CHG_STATE_SECONDARY_DONE
:
739 rphy
->chg_state
= USB_CHG_STATE_DETECTED
;
742 case USB_CHG_STATE_DETECTED
:
743 /* put the controller in normal mode */
744 property_enable(rphy
, &rphy
->phy_cfg
->chg_det
.opmode
, true);
745 rockchip_usb2phy_otg_sm_work(&rport
->otg_sm_work
.work
);
746 dev_info(&rport
->phy
->dev
, "charger = %s\n",
747 chg_to_string(rphy
->chg_type
));
753 schedule_delayed_work(&rport
->chg_work
, delay
);
757 * The function manage host-phy port state and suspend/resume phy port
760 * we rely on utmi_linestate and utmi_hostdisconnect to identify whether
761 * devices is disconnect or not. Besides, we do not need care it is FS/LS
762 * disconnected or HS disconnected, actually, we just only need get the
763 * device is disconnected at last through rearm the delayed work,
764 * to suspend the phy port in _PHY_STATE_DISCONNECT_ case.
766 * NOTE: It may invoke *phy_powr_off or *phy_power_on which will invoke
767 * some clk related APIs, so do not invoke it from interrupt context directly.
769 static void rockchip_usb2phy_sm_work(struct work_struct
*work
)
771 struct rockchip_usb2phy_port
*rport
=
772 container_of(work
, struct rockchip_usb2phy_port
, sm_work
.work
);
773 struct rockchip_usb2phy
*rphy
= dev_get_drvdata(rport
->phy
->dev
.parent
);
774 unsigned int sh
= rport
->port_cfg
->utmi_hstdet
.bitend
-
775 rport
->port_cfg
->utmi_hstdet
.bitstart
+ 1;
776 unsigned int ul
, uhd
, state
;
777 unsigned int ul_mask
, uhd_mask
;
780 mutex_lock(&rport
->mutex
);
782 ret
= regmap_read(rphy
->grf
, rport
->port_cfg
->utmi_ls
.offset
, &ul
);
786 ret
= regmap_read(rphy
->grf
, rport
->port_cfg
->utmi_hstdet
.offset
,
791 uhd_mask
= GENMASK(rport
->port_cfg
->utmi_hstdet
.bitend
,
792 rport
->port_cfg
->utmi_hstdet
.bitstart
);
793 ul_mask
= GENMASK(rport
->port_cfg
->utmi_ls
.bitend
,
794 rport
->port_cfg
->utmi_ls
.bitstart
);
796 /* stitch on utmi_ls and utmi_hstdet as phy state */
797 state
= ((uhd
& uhd_mask
) >> rport
->port_cfg
->utmi_hstdet
.bitstart
) |
798 (((ul
& ul_mask
) >> rport
->port_cfg
->utmi_ls
.bitstart
) << sh
);
801 case PHY_STATE_HS_ONLINE
:
802 dev_dbg(&rport
->phy
->dev
, "HS online\n");
804 case PHY_STATE_FS_LS_ONLINE
:
806 * For FS/LS device, the online state share with connect state
807 * from utmi_ls and utmi_hstdet register, so we distinguish
808 * them via suspended flag.
810 * Plus, there are two cases, one is D- Line pull-up, and D+
811 * line pull-down, the state is 4; another is D+ line pull-up,
812 * and D- line pull-down, the state is 2.
814 if (!rport
->suspended
) {
815 /* D- line pull-up, D+ line pull-down */
816 dev_dbg(&rport
->phy
->dev
, "FS/LS online\n");
820 case PHY_STATE_CONNECT
:
821 if (rport
->suspended
) {
822 dev_dbg(&rport
->phy
->dev
, "Connected\n");
823 rockchip_usb2phy_power_on(rport
->phy
);
824 rport
->suspended
= false;
826 /* D+ line pull-up, D- line pull-down */
827 dev_dbg(&rport
->phy
->dev
, "FS/LS online\n");
830 case PHY_STATE_DISCONNECT
:
831 if (!rport
->suspended
) {
832 dev_dbg(&rport
->phy
->dev
, "Disconnected\n");
833 rockchip_usb2phy_power_off(rport
->phy
);
834 rport
->suspended
= true;
838 * activate the linestate detection to get the next device
841 property_enable(rphy
, &rport
->port_cfg
->ls_det_clr
, true);
842 property_enable(rphy
, &rport
->port_cfg
->ls_det_en
, true);
845 * we don't need to rearm the delayed work when the phy port
848 mutex_unlock(&rport
->mutex
);
851 dev_dbg(&rport
->phy
->dev
, "unknown phy state\n");
856 mutex_unlock(&rport
->mutex
);
857 schedule_delayed_work(&rport
->sm_work
, SCHEDULE_DELAY
);
860 static irqreturn_t
rockchip_usb2phy_linestate_irq(int irq
, void *data
)
862 struct rockchip_usb2phy_port
*rport
= data
;
863 struct rockchip_usb2phy
*rphy
= dev_get_drvdata(rport
->phy
->dev
.parent
);
865 if (!property_enabled(rphy
, &rport
->port_cfg
->ls_det_st
))
868 mutex_lock(&rport
->mutex
);
870 /* disable linestate detect irq and clear its status */
871 property_enable(rphy
, &rport
->port_cfg
->ls_det_en
, false);
872 property_enable(rphy
, &rport
->port_cfg
->ls_det_clr
, true);
874 mutex_unlock(&rport
->mutex
);
877 * In this case for host phy port, a new device is plugged in,
878 * meanwhile, if the phy port is suspended, we need rearm the work to
879 * resume it and mange its states; otherwise, we do nothing about that.
881 if (rport
->suspended
&& rport
->port_id
== USB2PHY_PORT_HOST
)
882 rockchip_usb2phy_sm_work(&rport
->sm_work
.work
);
887 static irqreturn_t
rockchip_usb2phy_bvalid_irq(int irq
, void *data
)
889 struct rockchip_usb2phy_port
*rport
= data
;
890 struct rockchip_usb2phy
*rphy
= dev_get_drvdata(rport
->phy
->dev
.parent
);
892 if (!property_enabled(rphy
, &rport
->port_cfg
->bvalid_det_st
))
895 mutex_lock(&rport
->mutex
);
897 /* clear bvalid detect irq pending status */
898 property_enable(rphy
, &rport
->port_cfg
->bvalid_det_clr
, true);
900 mutex_unlock(&rport
->mutex
);
902 rockchip_usb2phy_otg_sm_work(&rport
->otg_sm_work
.work
);
907 static int rockchip_usb2phy_host_port_init(struct rockchip_usb2phy
*rphy
,
908 struct rockchip_usb2phy_port
*rport
,
909 struct device_node
*child_np
)
913 rport
->port_id
= USB2PHY_PORT_HOST
;
914 rport
->port_cfg
= &rphy
->phy_cfg
->port_cfgs
[USB2PHY_PORT_HOST
];
915 rport
->suspended
= true;
917 mutex_init(&rport
->mutex
);
918 INIT_DELAYED_WORK(&rport
->sm_work
, rockchip_usb2phy_sm_work
);
920 rport
->ls_irq
= of_irq_get_byname(child_np
, "linestate");
921 if (rport
->ls_irq
< 0) {
922 dev_err(rphy
->dev
, "no linestate irq provided\n");
923 return rport
->ls_irq
;
926 ret
= devm_request_threaded_irq(rphy
->dev
, rport
->ls_irq
, NULL
,
927 rockchip_usb2phy_linestate_irq
,
929 "rockchip_usb2phy", rport
);
931 dev_err(rphy
->dev
, "failed to request linestate irq handle\n");
938 static int rockchip_otg_event(struct notifier_block
*nb
,
939 unsigned long event
, void *ptr
)
941 struct rockchip_usb2phy_port
*rport
=
942 container_of(nb
, struct rockchip_usb2phy_port
, event_nb
);
944 schedule_delayed_work(&rport
->otg_sm_work
, OTG_SCHEDULE_DELAY
);
949 static int rockchip_usb2phy_otg_port_init(struct rockchip_usb2phy
*rphy
,
950 struct rockchip_usb2phy_port
*rport
,
951 struct device_node
*child_np
)
955 rport
->port_id
= USB2PHY_PORT_OTG
;
956 rport
->port_cfg
= &rphy
->phy_cfg
->port_cfgs
[USB2PHY_PORT_OTG
];
957 rport
->state
= OTG_STATE_UNDEFINED
;
960 * set suspended flag to true, but actually don't
961 * put phy in suspend mode, it aims to enable usb
962 * phy and clock in power_on() called by usb controller
963 * driver during probe.
965 rport
->suspended
= true;
966 rport
->vbus_attached
= false;
968 mutex_init(&rport
->mutex
);
970 rport
->mode
= of_usb_get_dr_mode_by_phy(child_np
, -1);
971 if (rport
->mode
== USB_DR_MODE_HOST
) {
976 INIT_DELAYED_WORK(&rport
->chg_work
, rockchip_chg_detect_work
);
977 INIT_DELAYED_WORK(&rport
->otg_sm_work
, rockchip_usb2phy_otg_sm_work
);
980 of_property_read_bool(child_np
, "rockchip,utmi-avalid");
982 rport
->bvalid_irq
= of_irq_get_byname(child_np
, "otg-bvalid");
983 if (rport
->bvalid_irq
< 0) {
984 dev_err(rphy
->dev
, "no vbus valid irq provided\n");
985 ret
= rport
->bvalid_irq
;
989 ret
= devm_request_threaded_irq(rphy
->dev
, rport
->bvalid_irq
, NULL
,
990 rockchip_usb2phy_bvalid_irq
,
992 "rockchip_usb2phy_bvalid", rport
);
994 dev_err(rphy
->dev
, "failed to request otg-bvalid irq handle\n");
998 if (!IS_ERR(rphy
->edev
)) {
999 rport
->event_nb
.notifier_call
= rockchip_otg_event
;
1001 ret
= extcon_register_notifier(rphy
->edev
, EXTCON_USB_HOST
,
1004 dev_err(rphy
->dev
, "register USB HOST notifier failed\n");
1011 static int rockchip_usb2phy_probe(struct platform_device
*pdev
)
1013 struct device
*dev
= &pdev
->dev
;
1014 struct device_node
*np
= dev
->of_node
;
1015 struct device_node
*child_np
;
1016 struct phy_provider
*provider
;
1017 struct rockchip_usb2phy
*rphy
;
1018 const struct rockchip_usb2phy_cfg
*phy_cfgs
;
1019 const struct of_device_id
*match
;
1023 rphy
= devm_kzalloc(dev
, sizeof(*rphy
), GFP_KERNEL
);
1027 match
= of_match_device(dev
->driver
->of_match_table
, dev
);
1028 if (!match
|| !match
->data
) {
1029 dev_err(dev
, "phy configs are not assigned!\n");
1033 if (!dev
->parent
|| !dev
->parent
->of_node
)
1036 rphy
->grf
= syscon_node_to_regmap(dev
->parent
->of_node
);
1037 if (IS_ERR(rphy
->grf
))
1038 return PTR_ERR(rphy
->grf
);
1040 if (of_property_read_u32(np
, "reg", ®
)) {
1041 dev_err(dev
, "the reg property is not assigned in %s node\n",
1047 phy_cfgs
= match
->data
;
1048 rphy
->chg_state
= USB_CHG_STATE_UNDEFINED
;
1049 rphy
->chg_type
= POWER_SUPPLY_TYPE_UNKNOWN
;
1050 platform_set_drvdata(pdev
, rphy
);
1052 ret
= rockchip_usb2phy_extcon_register(rphy
);
1056 /* find out a proper config which can be matched with dt. */
1058 while (phy_cfgs
[index
].reg
) {
1059 if (phy_cfgs
[index
].reg
== reg
) {
1060 rphy
->phy_cfg
= &phy_cfgs
[index
];
1067 if (!rphy
->phy_cfg
) {
1068 dev_err(dev
, "no phy-config can be matched with %s node\n",
1073 rphy
->clk
= of_clk_get_by_name(np
, "phyclk");
1074 if (!IS_ERR(rphy
->clk
)) {
1075 clk_prepare_enable(rphy
->clk
);
1077 dev_info(&pdev
->dev
, "no phyclk specified\n");
1081 ret
= rockchip_usb2phy_clk480m_register(rphy
);
1083 dev_err(dev
, "failed to register 480m output clock\n");
1088 for_each_available_child_of_node(np
, child_np
) {
1089 struct rockchip_usb2phy_port
*rport
= &rphy
->ports
[index
];
1092 /* This driver aims to support both otg-port and host-port */
1093 if (of_node_cmp(child_np
->name
, "host-port") &&
1094 of_node_cmp(child_np
->name
, "otg-port"))
1097 phy
= devm_phy_create(dev
, child_np
, &rockchip_usb2phy_ops
);
1099 dev_err(dev
, "failed to create phy\n");
1105 phy_set_drvdata(rport
->phy
, rport
);
1107 /* initialize otg/host port separately */
1108 if (!of_node_cmp(child_np
->name
, "host-port")) {
1109 ret
= rockchip_usb2phy_host_port_init(rphy
, rport
,
1114 ret
= rockchip_usb2phy_otg_port_init(rphy
, rport
,
1121 /* to prevent out of boundary */
1122 if (++index
>= rphy
->phy_cfg
->num_ports
)
1126 provider
= devm_of_phy_provider_register(dev
, of_phy_simple_xlate
);
1127 return PTR_ERR_OR_ZERO(provider
);
1130 of_node_put(child_np
);
1133 clk_disable_unprepare(rphy
->clk
);
1139 static const struct rockchip_usb2phy_cfg rk3366_phy_cfgs
[] = {
1143 .clkout_ctl
= { 0x0724, 15, 15, 1, 0 },
1145 [USB2PHY_PORT_HOST
] = {
1146 .phy_sus
= { 0x0728, 15, 0, 0, 0x1d1 },
1147 .ls_det_en
= { 0x0680, 4, 4, 0, 1 },
1148 .ls_det_st
= { 0x0690, 4, 4, 0, 1 },
1149 .ls_det_clr
= { 0x06a0, 4, 4, 0, 1 },
1150 .utmi_ls
= { 0x049c, 14, 13, 0, 1 },
1151 .utmi_hstdet
= { 0x049c, 12, 12, 0, 1 }
1158 static const struct rockchip_usb2phy_cfg rk3399_phy_cfgs
[] = {
1162 .clkout_ctl
= { 0xe450, 4, 4, 1, 0 },
1164 [USB2PHY_PORT_OTG
] = {
1165 .phy_sus
= { 0xe454, 1, 0, 2, 1 },
1166 .bvalid_det_en
= { 0xe3c0, 3, 3, 0, 1 },
1167 .bvalid_det_st
= { 0xe3e0, 3, 3, 0, 1 },
1168 .bvalid_det_clr
= { 0xe3d0, 3, 3, 0, 1 },
1169 .utmi_avalid
= { 0xe2ac, 7, 7, 0, 1 },
1170 .utmi_bvalid
= { 0xe2ac, 12, 12, 0, 1 },
1172 [USB2PHY_PORT_HOST
] = {
1173 .phy_sus
= { 0xe458, 1, 0, 0x2, 0x1 },
1174 .ls_det_en
= { 0xe3c0, 6, 6, 0, 1 },
1175 .ls_det_st
= { 0xe3e0, 6, 6, 0, 1 },
1176 .ls_det_clr
= { 0xe3d0, 6, 6, 0, 1 },
1177 .utmi_ls
= { 0xe2ac, 22, 21, 0, 1 },
1178 .utmi_hstdet
= { 0xe2ac, 23, 23, 0, 1 }
1182 .opmode
= { 0xe454, 3, 0, 5, 1 },
1183 .cp_det
= { 0xe2ac, 2, 2, 0, 1 },
1184 .dcp_det
= { 0xe2ac, 1, 1, 0, 1 },
1185 .dp_det
= { 0xe2ac, 0, 0, 0, 1 },
1186 .idm_sink_en
= { 0xe450, 8, 8, 0, 1 },
1187 .idp_sink_en
= { 0xe450, 7, 7, 0, 1 },
1188 .idp_src_en
= { 0xe450, 9, 9, 0, 1 },
1189 .rdm_pdwn_en
= { 0xe450, 10, 10, 0, 1 },
1190 .vdm_src_en
= { 0xe450, 12, 12, 0, 1 },
1191 .vdp_src_en
= { 0xe450, 11, 11, 0, 1 },
1197 .clkout_ctl
= { 0xe460, 4, 4, 1, 0 },
1199 [USB2PHY_PORT_OTG
] = {
1200 .phy_sus
= { 0xe464, 1, 0, 2, 1 },
1201 .bvalid_det_en
= { 0xe3c0, 8, 8, 0, 1 },
1202 .bvalid_det_st
= { 0xe3e0, 8, 8, 0, 1 },
1203 .bvalid_det_clr
= { 0xe3d0, 8, 8, 0, 1 },
1204 .utmi_avalid
= { 0xe2ac, 10, 10, 0, 1 },
1205 .utmi_bvalid
= { 0xe2ac, 16, 16, 0, 1 },
1207 [USB2PHY_PORT_HOST
] = {
1208 .phy_sus
= { 0xe468, 1, 0, 0x2, 0x1 },
1209 .ls_det_en
= { 0xe3c0, 11, 11, 0, 1 },
1210 .ls_det_st
= { 0xe3e0, 11, 11, 0, 1 },
1211 .ls_det_clr
= { 0xe3d0, 11, 11, 0, 1 },
1212 .utmi_ls
= { 0xe2ac, 26, 25, 0, 1 },
1213 .utmi_hstdet
= { 0xe2ac, 27, 27, 0, 1 }
1220 static const struct of_device_id rockchip_usb2phy_dt_match
[] = {
1221 { .compatible
= "rockchip,rk3366-usb2phy", .data
= &rk3366_phy_cfgs
},
1222 { .compatible
= "rockchip,rk3399-usb2phy", .data
= &rk3399_phy_cfgs
},
1225 MODULE_DEVICE_TABLE(of
, rockchip_usb2phy_dt_match
);
1227 static struct platform_driver rockchip_usb2phy_driver
= {
1228 .probe
= rockchip_usb2phy_probe
,
1230 .name
= "rockchip-usb2phy",
1231 .of_match_table
= rockchip_usb2phy_dt_match
,
1234 module_platform_driver(rockchip_usb2phy_driver
);
1236 MODULE_AUTHOR("Frank Wang <frank.wang@rock-chips.com>");
1237 MODULE_DESCRIPTION("Rockchip USB2.0 PHY driver");
1238 MODULE_LICENSE("GPL v2");