1 // SPDX-License-Identifier: GPL-2.0-only
3 * Phy provider for USB 3.1 controller on HiSilicon Kirin970 platform
5 * Copyright (C) 2017-2020 Hilisicon Electronics Co., Ltd.
6 * http://www.huawei.com
11 #include <linux/bitfield.h>
12 #include <linux/clk.h>
13 #include <linux/kernel.h>
14 #include <linux/mfd/syscon.h>
15 #include <linux/module.h>
16 #include <linux/phy/phy.h>
17 #include <linux/platform_device.h>
18 #include <linux/regmap.h>
20 #define SCTRL_SCDEEPSLEEPED (0x0)
21 #define USB_CLK_SELECTED BIT(20)
23 #define PERI_CRG_PEREN0 (0x00)
24 #define PERI_CRG_PERDIS0 (0x04)
25 #define PERI_CRG_PEREN4 (0x40)
26 #define PERI_CRG_PERDIS4 (0x44)
27 #define PERI_CRG_PERRSTEN4 (0x90)
28 #define PERI_CRG_PERRSTDIS4 (0x94)
29 #define PERI_CRG_ISODIS (0x148)
30 #define PERI_CRG_PEREN6 (0x410)
31 #define PERI_CRG_PERDIS6 (0x414)
33 #define USB_REFCLK_ISO_EN BIT(25)
35 #define GT_CLK_USB2PHY_REF BIT(19)
37 #define PCTRL_PERI_CTRL3 (0x10)
38 #define PCTRL_PERI_CTRL3_MSK_START (16)
39 #define USB_TCXO_EN BIT(1)
41 #define PCTRL_PERI_CTRL24 (0x64)
42 #define SC_CLK_USB3PHY_3MUX1_SEL BIT(25)
44 #define USB3OTG_CTRL0 (0x00)
45 #define USB3OTG_CTRL3 (0x0c)
46 #define USB3OTG_CTRL4 (0x10)
47 #define USB3OTG_CTRL5 (0x14)
48 #define USB3OTG_CTRL7 (0x1c)
49 #define USB_MISC_CFG50 (0x50)
50 #define USB_MISC_CFG54 (0x54)
51 #define USB_MISC_CFG58 (0x58)
52 #define USB_MISC_CFG5C (0x5c)
53 #define USB_MISC_CFGA0 (0xa0)
54 #define TCA_CLK_RST (0x200)
55 #define TCA_INTR_EN (0x204)
56 #define TCA_INTR_STS (0x208)
57 #define TCA_GCFG (0x210)
58 #define TCA_TCPC (0x214)
59 #define TCA_SYSMODE_CFG (0x218)
60 #define TCA_VBUS_CTRL (0x240)
62 #define CTRL0_USB3_VBUSVLD BIT(7)
63 #define CTRL0_USB3_VBUSVLD_SEL BIT(6)
65 #define CTRL3_USB2_VBUSVLDEXT0 BIT(6)
66 #define CTRL3_USB2_VBUSVLDEXTSEL0 BIT(5)
68 #define CTRL5_USB2_SIDDQ BIT(0)
70 #define CTRL7_USB2_REFCLKSEL_MASK GENMASK(4, 3)
71 #define CTRL7_USB2_REFCLKSEL_ABB (BIT(4) | BIT(3))
72 #define CTRL7_USB2_REFCLKSEL_PAD BIT(4)
74 #define CFG50_USB3_PHY_TEST_POWERDOWN BIT(23)
76 #define CFG54_USB31PHY_CR_ADDR_MASK GENMASK(31, 16)
78 #define CFG54_USB3PHY_REF_USE_PAD BIT(12)
79 #define CFG54_PHY0_PMA_PWR_STABLE BIT(11)
80 #define CFG54_PHY0_PCS_PWR_STABLE BIT(9)
81 #define CFG54_USB31PHY_CR_ACK BIT(7)
82 #define CFG54_USB31PHY_CR_WR_EN BIT(5)
83 #define CFG54_USB31PHY_CR_SEL BIT(4)
84 #define CFG54_USB31PHY_CR_RD_EN BIT(3)
85 #define CFG54_USB31PHY_CR_CLK BIT(2)
86 #define CFG54_USB3_PHY0_ANA_PWR_EN BIT(1)
88 #define CFG58_USB31PHY_CR_DATA_MASK GENMASK(31, 16)
90 #define CFG5C_USB3_PHY0_SS_MPLLA_SSC_EN BIT(1)
92 #define CFGA0_VAUX_RESET BIT(9)
93 #define CFGA0_USB31C_RESET BIT(8)
94 #define CFGA0_USB2PHY_REFCLK_SELECT BIT(4)
95 #define CFGA0_USB3PHY_RESET BIT(1)
96 #define CFGA0_USB2PHY_POR BIT(0)
98 #define INTR_EN_XA_TIMEOUT_EVT_EN BIT(1)
99 #define INTR_EN_XA_ACK_EVT_EN BIT(0)
101 #define CLK_RST_TCA_REF_CLK_EN BIT(1)
102 #define CLK_RST_SUSPEND_CLK_EN BIT(0)
104 #define GCFG_ROLE_HSTDEV BIT(4)
105 #define GCFG_OP_MODE GENMASK(1, 0)
106 #define GCFG_OP_MODE_CTRL_SYNC_MODE BIT(0)
108 #define TCPC_VALID BIT(4)
109 #define TCPC_LOW_POWER_EN BIT(3)
110 #define TCPC_MUX_CONTROL_MASK GENMASK(1, 0)
111 #define TCPC_MUX_CONTROL_USB31 BIT(0)
113 #define SYSMODE_CFG_TYPEC_DISABLE BIT(3)
115 #define VBUS_CTRL_POWERPRESENT_OVERRD GENMASK(3, 2)
116 #define VBUS_CTRL_VBUSVALID_OVERRD GENMASK(1, 0)
118 #define KIRIN970_USB_DEFAULT_PHY_PARAM (0xfdfee4)
119 #define KIRIN970_USB_DEFAULT_PHY_VBOOST (0x5)
121 #define TX_VBOOST_LVL_REG (0xf)
122 #define TX_VBOOST_LVL_START (6)
123 #define TX_VBOOST_LVL_ENABLE BIT(9)
127 struct regmap *peri_crg;
128 struct regmap *pctrl;
129 struct regmap *sctrl;
130 struct regmap *usb31misc;
132 u32 eye_diagram_param;
137 u32 usb31misc_offset;
140 static int hi3670_phy_cr_clk(struct regmap *usb31misc)
145 ret = regmap_update_bits(usb31misc, USB_MISC_CFG54,
146 CFG54_USB31PHY_CR_CLK, CFG54_USB31PHY_CR_CLK);
151 return regmap_update_bits(usb31misc, USB_MISC_CFG54,
152 CFG54_USB31PHY_CR_CLK, 0);
155 static int hi3670_phy_cr_set_sel(struct regmap *usb31misc)
157 return regmap_update_bits(usb31misc, USB_MISC_CFG54,
158 CFG54_USB31PHY_CR_SEL, CFG54_USB31PHY_CR_SEL);
161 static int hi3670_phy_cr_start(struct regmap *usb31misc, int direction)
166 reg = CFG54_USB31PHY_CR_WR_EN;
168 reg = CFG54_USB31PHY_CR_RD_EN;
170 ret = regmap_update_bits(usb31misc, USB_MISC_CFG54, reg, reg);
175 ret = hi3670_phy_cr_clk(usb31misc);
179 return regmap_update_bits(usb31misc, USB_MISC_CFG54,
180 CFG54_USB31PHY_CR_RD_EN | CFG54_USB31PHY_CR_WR_EN, 0);
183 static int hi3670_phy_cr_wait_ack(struct regmap *usb31misc)
189 while (retry-- > 0) {
190 ret = regmap_read(usb31misc, USB_MISC_CFG54, ®);
193 if ((reg & CFG54_USB31PHY_CR_ACK) == CFG54_USB31PHY_CR_ACK)
196 ret = hi3670_phy_cr_clk(usb31misc);
200 usleep_range(10, 20);
206 static int hi3670_phy_cr_set_addr(struct regmap *usb31misc, u32 addr)
211 ret = regmap_read(usb31misc, USB_MISC_CFG54, ®);
215 reg = FIELD_PREP(CFG54_USB31PHY_CR_ADDR_MASK, addr);
217 return regmap_update_bits(usb31misc, USB_MISC_CFG54,
218 CFG54_USB31PHY_CR_ADDR_MASK, reg);
221 static int hi3670_phy_cr_read(struct regmap *usb31misc, u32 addr, u32 *val)
225 for (i = 0; i < 100; i++) {
226 ret = hi3670_phy_cr_clk(usb31misc);
231 ret = hi3670_phy_cr_set_sel(usb31misc);
235 ret = hi3670_phy_cr_set_addr(usb31misc, addr);
239 ret = hi3670_phy_cr_start(usb31misc, 0);
243 ret = hi3670_phy_cr_wait_ack(usb31misc);
247 ret = regmap_read(usb31misc, USB_MISC_CFG58, ®);
251 *val = FIELD_GET(CFG58_USB31PHY_CR_DATA_MASK, reg);
256 static int hi3670_phy_cr_write(struct regmap *usb31misc, u32 addr, u32 val)
261 for (i = 0; i < 100; i++) {
262 ret = hi3670_phy_cr_clk(usb31misc);
267 ret = hi3670_phy_cr_set_sel(usb31misc);
271 ret = hi3670_phy_cr_set_addr(usb31misc, addr);
275 ret = regmap_write(usb31misc, USB_MISC_CFG58,
276 FIELD_PREP(CFG58_USB31PHY_CR_DATA_MASK, val));
280 ret = hi3670_phy_cr_start(usb31misc, 1);
284 return hi3670_phy_cr_wait_ack(usb31misc);
287 static int hi3670_phy_set_params(struct hi3670_priv *priv)
293 ret = regmap_write(priv->usb31misc, USB3OTG_CTRL4,
294 priv->eye_diagram_param);
296 dev_err(priv->dev, "set USB3OTG_CTRL4 failed\n");
300 while (retry-- > 0) {
301 ret = hi3670_phy_cr_read(priv->usb31misc,
302 TX_VBOOST_LVL_REG, ®);
306 if (ret != -ETIMEDOUT) {
307 dev_err(priv->dev, "read TX_VBOOST_LVL_REG failed\n");
314 reg |= (TX_VBOOST_LVL_ENABLE | (priv->tx_vboost_lvl << TX_VBOOST_LVL_START));
315 ret = hi3670_phy_cr_write(priv->usb31misc, TX_VBOOST_LVL_REG, reg);
317 dev_err(priv->dev, "write TX_VBOOST_LVL_REG failed\n");
322 static bool hi3670_is_abbclk_selected(struct hi3670_priv *priv)
327 dev_err(priv->dev, "priv->sctrl is null!\n");
331 if (regmap_read(priv->sctrl, SCTRL_SCDEEPSLEEPED, ®)) {
332 dev_err(priv->dev, "SCTRL_SCDEEPSLEEPED read failed!\n");
336 if ((reg & USB_CLK_SELECTED) == 0)
342 static int hi3670_config_phy_clock(struct hi3670_priv *priv)
347 if (!hi3670_is_abbclk_selected(priv)) {
348 /* usb refclk iso disable */
349 ret = regmap_write(priv->peri_crg, PERI_CRG_ISODIS,
354 /* enable usb_tcxo_en */
355 ret = regmap_write(priv->pctrl, PCTRL_PERI_CTRL3,
357 (USB_TCXO_EN << PCTRL_PERI_CTRL3_MSK_START));
359 /* select usbphy clk from abb */
360 mask = SC_CLK_USB3PHY_3MUX1_SEL;
361 ret = regmap_update_bits(priv->pctrl,
362 PCTRL_PERI_CTRL24, mask, 0);
366 ret = regmap_update_bits(priv->usb31misc, USB_MISC_CFGA0,
367 CFGA0_USB2PHY_REFCLK_SELECT, 0);
371 ret = regmap_read(priv->usb31misc, USB3OTG_CTRL7, &val);
374 val &= ~CTRL7_USB2_REFCLKSEL_MASK;
375 val |= CTRL7_USB2_REFCLKSEL_ABB;
376 ret = regmap_write(priv->usb31misc, USB3OTG_CTRL7, val);
383 ret = regmap_update_bits(priv->usb31misc, USB_MISC_CFG54,
384 CFG54_USB3PHY_REF_USE_PAD,
385 CFG54_USB3PHY_REF_USE_PAD);
389 ret = regmap_update_bits(priv->usb31misc, USB_MISC_CFGA0,
390 CFGA0_USB2PHY_REFCLK_SELECT,
391 CFGA0_USB2PHY_REFCLK_SELECT);
395 ret = regmap_read(priv->usb31misc, USB3OTG_CTRL7, &val);
398 val &= ~CTRL7_USB2_REFCLKSEL_MASK;
399 val |= CTRL7_USB2_REFCLKSEL_PAD;
400 ret = regmap_write(priv->usb31misc, USB3OTG_CTRL7, val);
404 ret = regmap_write(priv->peri_crg,
405 PERI_CRG_PEREN6, GT_CLK_USB2PHY_REF);
411 dev_err(priv->dev, "failed to config phy clock ret: %d\n", ret);
415 static int hi3670_config_tca(struct hi3670_priv *priv)
420 ret = regmap_write(priv->usb31misc, TCA_INTR_STS, 0xffff);
424 ret = regmap_write(priv->usb31misc, TCA_INTR_EN,
425 INTR_EN_XA_TIMEOUT_EVT_EN | INTR_EN_XA_ACK_EVT_EN);
429 mask = CLK_RST_TCA_REF_CLK_EN | CLK_RST_SUSPEND_CLK_EN;
430 ret = regmap_update_bits(priv->usb31misc, TCA_CLK_RST, mask, 0);
434 ret = regmap_update_bits(priv->usb31misc, TCA_GCFG,
435 GCFG_ROLE_HSTDEV | GCFG_OP_MODE,
436 GCFG_ROLE_HSTDEV | GCFG_OP_MODE_CTRL_SYNC_MODE);
440 ret = regmap_update_bits(priv->usb31misc, TCA_SYSMODE_CFG,
441 SYSMODE_CFG_TYPEC_DISABLE, 0);
445 ret = regmap_read(priv->usb31misc, TCA_TCPC, &val);
448 val &= ~(TCPC_VALID | TCPC_LOW_POWER_EN | TCPC_MUX_CONTROL_MASK);
449 val |= (TCPC_VALID | TCPC_MUX_CONTROL_USB31);
450 ret = regmap_write(priv->usb31misc, TCA_TCPC, val);
454 ret = regmap_write(priv->usb31misc, TCA_VBUS_CTRL,
455 VBUS_CTRL_POWERPRESENT_OVERRD | VBUS_CTRL_VBUSVALID_OVERRD);
461 dev_err(priv->dev, "failed to config phy clock ret: %d\n", ret);
465 static int hi3670_phy_init(struct phy *phy)
467 struct hi3670_priv *priv = phy_get_drvdata(phy);
471 /* assert controller */
472 val = CFGA0_VAUX_RESET | CFGA0_USB31C_RESET |
473 CFGA0_USB3PHY_RESET | CFGA0_USB2PHY_POR;
474 ret = regmap_update_bits(priv->usb31misc, USB_MISC_CFGA0, val, 0);
478 ret = hi3670_config_phy_clock(priv);
482 /* Exit from IDDQ mode */
483 ret = regmap_update_bits(priv->usb31misc, USB3OTG_CTRL5,
484 CTRL5_USB2_SIDDQ, 0);
488 /* Release USB31 PHY out of TestPowerDown mode */
489 ret = regmap_update_bits(priv->usb31misc, USB_MISC_CFG50,
490 CFG50_USB3_PHY_TEST_POWERDOWN, 0);
495 val = CFGA0_USB3PHY_RESET | CFGA0_USB2PHY_POR;
496 ret = regmap_update_bits(priv->usb31misc, USB_MISC_CFGA0, val, val);
500 usleep_range(100, 120);
502 /* Tell the PHY power is stable */
503 val = CFG54_USB3_PHY0_ANA_PWR_EN | CFG54_PHY0_PCS_PWR_STABLE |
504 CFG54_PHY0_PMA_PWR_STABLE;
505 ret = regmap_update_bits(priv->usb31misc, USB_MISC_CFG54,
510 ret = hi3670_config_tca(priv);
515 ret = regmap_update_bits(priv->usb31misc, USB_MISC_CFG5C,
516 CFG5C_USB3_PHY0_SS_MPLLA_SSC_EN,
517 CFG5C_USB3_PHY0_SS_MPLLA_SSC_EN);
521 /* Deassert controller */
522 val = CFGA0_VAUX_RESET | CFGA0_USB31C_RESET;
523 ret = regmap_update_bits(priv->usb31misc, USB_MISC_CFGA0, val, val);
527 usleep_range(100, 120);
529 /* Set fake vbus valid signal */
530 val = CTRL0_USB3_VBUSVLD | CTRL0_USB3_VBUSVLD_SEL;
531 ret = regmap_update_bits(priv->usb31misc, USB3OTG_CTRL0, val, val);
535 val = CTRL3_USB2_VBUSVLDEXT0 | CTRL3_USB2_VBUSVLDEXTSEL0;
536 ret = regmap_update_bits(priv->usb31misc, USB3OTG_CTRL3, val, val);
540 usleep_range(100, 120);
542 ret = hi3670_phy_set_params(priv);
548 dev_err(priv->dev, "failed to init phy ret: %d\n", ret);
552 static int hi3670_phy_exit(struct phy *phy)
554 struct hi3670_priv *priv = phy_get_drvdata(phy);
559 mask = CFGA0_USB3PHY_RESET | CFGA0_USB2PHY_POR;
560 ret = regmap_update_bits(priv->usb31misc, USB_MISC_CFGA0, mask, 0);
564 if (!hi3670_is_abbclk_selected(priv)) {
565 /* disable usb_tcxo_en */
566 ret = regmap_write(priv->pctrl, PCTRL_PERI_CTRL3,
567 USB_TCXO_EN << PCTRL_PERI_CTRL3_MSK_START);
569 ret = regmap_write(priv->peri_crg, PERI_CRG_PERDIS6,
577 dev_err(priv->dev, "failed to exit phy ret: %d\n", ret);
581 static const struct phy_ops hi3670_phy_ops = {
582 .init = hi3670_phy_init,
583 .exit = hi3670_phy_exit,
584 .owner = THIS_MODULE,
587 static int hi3670_phy_probe(struct platform_device *pdev)
589 struct phy_provider *phy_provider;
590 struct device *dev = &pdev->dev;
592 struct hi3670_priv *priv;
594 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
599 priv->peri_crg = syscon_regmap_lookup_by_phandle(dev->of_node,
600 "hisilicon,pericrg-syscon");
601 if (IS_ERR(priv->peri_crg)) {
602 dev_err(dev, "no hisilicon,pericrg-syscon\n");
603 return PTR_ERR(priv->peri_crg);
606 priv->pctrl = syscon_regmap_lookup_by_phandle(dev->of_node,
607 "hisilicon,pctrl-syscon");
608 if (IS_ERR(priv->pctrl)) {
609 dev_err(dev, "no hisilicon,pctrl-syscon\n");
610 return PTR_ERR(priv->pctrl);
613 priv->sctrl = syscon_regmap_lookup_by_phandle(dev->of_node,
614 "hisilicon,sctrl-syscon");
615 if (IS_ERR(priv->sctrl)) {
616 dev_err(dev, "no hisilicon,sctrl-syscon\n");
617 return PTR_ERR(priv->sctrl);
620 /* node of hi3670 phy is a sub-node of usb3_otg_bc */
621 priv->usb31misc = syscon_node_to_regmap(dev->parent->of_node);
622 if (IS_ERR(priv->usb31misc)) {
623 dev_err(dev, "no hisilicon,usb3-otg-bc-syscon\n");
624 return PTR_ERR(priv->usb31misc);
627 if (of_property_read_u32(dev->of_node, "hisilicon,eye-diagram-param",
628 &priv->eye_diagram_param))
629 priv->eye_diagram_param = KIRIN970_USB_DEFAULT_PHY_PARAM;
631 if (of_property_read_u32(dev->of_node, "hisilicon,tx-vboost-lvl",
632 &priv->tx_vboost_lvl))
633 priv->tx_vboost_lvl = KIRIN970_USB_DEFAULT_PHY_VBOOST;
635 phy = devm_phy_create(dev, NULL, &hi3670_phy_ops);
639 phy_set_drvdata(phy, priv);
640 phy_provider = devm_of_phy_provider_register(dev, of_phy_simple_xlate);
641 return PTR_ERR_OR_ZERO(phy_provider);
644 static const struct of_device_id hi3670_phy_of_match[] = {
645 { .compatible = "hisilicon,hi3670-usb-phy" },
648 MODULE_DEVICE_TABLE(of, hi3670_phy_of_match);
650 static struct platform_driver hi3670_phy_driver = {
651 .probe = hi3670_phy_probe,
653 .name = "hi3670-usb-phy",
654 .of_match_table = hi3670_phy_of_match,
657 module_platform_driver(hi3670_phy_driver);
660 MODULE_LICENSE("GPL v2");
661 MODULE_DESCRIPTION("Hilisicon Kirin970 USB31 PHY Driver");