Skip to contentSkip to conversation

phy: phy-imx8mq-usb: add vbus regulator support

PATCH Superseded Tim Harvey 2 participants 4 messages Jul 13, 2023

Subsystems (2)

v6 of 7 Superseded Latest is v7 →

lore
Share & tools
lore

Tim Harvey

author
#0 lore raw

PATCH v6 1/2 phy: phy-imx8mq-usb: add vbus regulator support

Add support for enabling and disabling vbus-supply regulator found on several imx8mp boards in the usb3_phy0 and usb3_phy1 nodes.

---
v6:
- move changes to clk to separate patch
- sort new vars in reverse christmas tree style

v5:
- remove #if CONFIG_IS_ENABLED around struct members
(you can not conditionally include if using if (CONFIG_IS_ENABLED(foo)) )
- replace clk '#if CONFIG_IS_ENABLED(CLK)' with 'if (CONFIG_IS_ENABLED(CLK))'

v4:
- use regulator_set_enable_if_allowed to handle regulator reference
counting
errors
- added Marek's rb tag

v3:
- change pr_err to dev_err
- add #if CONFIG_IS_ENABLED around vbus_supply in struct
- add fail path to disable clock if regulator enable failed

v2:
- protect ret with __maybe_unused in case CONFIG_CLK and CONFIG_DM_REGULATOR not defined
- add error prints on failures
- add Adam's rb tag

---
 drivers/phy/phy-imx8mq-usb.c | 37 +++++++++++++++++++++++++++++++++---
 1 file changed, 34 insertions(+), 3 deletions(-)
drivers/phy/phy-imx8mq-usb.c +34 -3
index 69f01de55538..0ab7965df2ff 100644
@@ -14,6 +14,8 @@
 #include <linux/delay.h>
 #include <linux/err.h>
 #include <clk.h>
+#include <dm/device_compat.h>
+#include <power/regulator.h>
 
 #define PHY_CTRL0			0x0
 #define PHY_CTRL0_REF_SSP_EN		BIT(2)
@@ -81,6 +83,7 @@ struct imx8mq_usb_phy {
 #endif
 	void __iomem *base;
 	enum imx8mpq_phy_type type;
+	struct udevice *vbus_supply;
 };
 
 static const struct udevice_id imx8mq_usb_phy_of_match[] = {
@@ -173,9 +176,9 @@ static int imx8mq_usb_phy_power_on(struct phy *usb_phy)
 	struct udevice *dev = usb_phy->dev;
 	struct imx8mq_usb_phy *imx_phy = dev_get_priv(dev);
 	u32 value;
+	int ret;
 
 #if CONFIG_IS_ENABLED(CLK)
-	int ret;
 	ret = clk_enable(&imx_phy->phy_clk);
 	if (ret) {
 		printf("Failed to enable usb phy clock\n");
@@ -183,12 +186,24 @@ static int imx8mq_usb_phy_power_on(struct phy *usb_phy)
 	}
 #endif
 
+	if (CONFIG_IS_ENABLED(DM_REGULATOR) && imx_phy->vbus_supply) {
+		ret = regulator_set_enable_if_allowed(imx_phy->vbus_supply, true);
+		if (ret && ret != -ENOSYS) {
+			dev_err(dev, "Failed to enable VBUS regulator: %d\n", ret);
+			goto err;
+		}
+	}
+
 	/* Disable rx term override */
 	value = readl(imx_phy->base + PHY_CTRL6);
 	value &= ~PHY_CTRL6_RXTERM_OVERRIDE_SEL;
 	writel(value, imx_phy->base + PHY_CTRL6);
 
 	return 0;
+
+err:
+	clk_disable(&imx_phy->phy_clk);
+	return ret;
 }
 
 static int imx8mq_usb_phy_power_off(struct phy *usb_phy)
@@ -196,6 +211,7 @@ static int imx8mq_usb_phy_power_off(struct phy *usb_phy)
 	struct udevice *dev = usb_phy->dev;
 	struct imx8mq_usb_phy *imx_phy = dev_get_priv(dev);
 	u32 value;
+	int ret;
 
 	/* Override rx term to be 0 */
 	value = readl(imx_phy->base + PHY_CTRL6);
@@ -206,6 +222,14 @@ static int imx8mq_usb_phy_power_off(struct phy *usb_phy)
 	clk_disable(&imx_phy->phy_clk);
 #endif
 
+	if (CONFIG_IS_ENABLED(DM_REGULATOR) && imx_phy->vbus_supply) {
+		ret = regulator_set_enable_if_allowed(imx_phy->vbus_supply, false);
+		if (ret && ret != -ENOSYS) {
+			dev_err(dev, "Failed to disable VBUS regulator: %d\n", ret);
+			return ret;
+		}
+	}
+
 	return 0;
 }
 
@@ -224,6 +248,7 @@ struct phy_ops imx8mq_usb_phy_ops = {
 int imx8mq_usb_phy_probe(struct udevice *dev)
 {
 	struct imx8mq_usb_phy *priv = dev_get_priv(dev);
+	int ret;
 
 	priv->type = dev_get_driver_data(dev);
 	priv->base = dev_read_addr_ptr(dev);
@@ -232,8 +257,6 @@ int imx8mq_usb_phy_probe(struct udevice *dev)
 		return -EINVAL;
 
 #if CONFIG_IS_ENABLED(CLK)
-	int ret;
-
 	/* Assigned clock already set clock */
 	ret = clk_get_by_name(dev, "phy", &priv->phy_clk);
 	if (ret) {
@@ -241,6 +264,14 @@ int imx8mq_usb_phy_probe(struct udevice *dev)
 		return ret;
 	}
 #endif
+	if (CONFIG_IS_ENABLED(DM_REGULATOR)) {
+		ret = device_get_supply_regulator(dev, "vbus-supply",
+						  &priv->vbus_supply);
+		if (ret && ret != -ENOENT) {
+			dev_err(dev, "Failed to get VBUS regulator: %d\n", ret);
+			return ret;
+		}
+	}
 
 	return 0;
 }
Signature · 1 line
2.25.1
author
#1 lore raw

PATCH v6 2/2 phy: phy-imx8mq-usb: clean up clock code

use CONFIG_IS_ENABLED for clock enable/disable and change printf's to dev_err. Additionlly remove the comment that does not make sense.

---
v6: new patch

 drivers/phy/phy-imx8mq-usb.c | 33 +++++++++++++++------------------
 1 file changed, 15 insertions(+), 18 deletions(-)
drivers/phy/phy-imx8mq-usb.c +15 -18
index 0ab7965df2ff..bf9b0b6f3450 100644
@@ -78,9 +78,7 @@ enum imx8mpq_phy_type {
 };
 
 struct imx8mq_usb_phy {
-#if CONFIG_IS_ENABLED(CLK)
 	struct clk phy_clk;
-#endif
 	void __iomem *base;
 	enum imx8mpq_phy_type type;
 	struct udevice *vbus_supply;
@@ -178,13 +176,13 @@ static int imx8mq_usb_phy_power_on(struct phy *usb_phy)
 	u32 value;
 	int ret;
 
-#if CONFIG_IS_ENABLED(CLK)
-	ret = clk_enable(&imx_phy->phy_clk);
-	if (ret) {
-		printf("Failed to enable usb phy clock\n");
-		return ret;
+	if (CONFIG_IS_ENABLED(CLK)) {
+		ret = clk_enable(&imx_phy->phy_clk);
+		if (ret) {
+			dev_err(dev, "Failed to enable usb phy clock: %d\n", ret);
+			return ret;
+		}
 	}
-#endif
 
 	if (CONFIG_IS_ENABLED(DM_REGULATOR) && imx_phy->vbus_supply) {
 		ret = regulator_set_enable_if_allowed(imx_phy->vbus_supply, true);
@@ -218,9 +216,8 @@ static int imx8mq_usb_phy_power_off(struct phy *usb_phy)
 	value |= PHY_CTRL6_RXTERM_OVERRIDE_SEL;
 	writel(value, imx_phy->base + PHY_CTRL6);
 
-#if CONFIG_IS_ENABLED(CLK)
-	clk_disable(&imx_phy->phy_clk);
-#endif
+	if (CONFIG_IS_ENABLED(CLK))
+		clk_disable(&imx_phy->phy_clk);
 
 	if (CONFIG_IS_ENABLED(DM_REGULATOR) && imx_phy->vbus_supply) {
 		ret = regulator_set_enable_if_allowed(imx_phy->vbus_supply, false);
@@ -256,14 +253,14 @@ int imx8mq_usb_phy_probe(struct udevice *dev)
 	if (!priv->base)
 		return -EINVAL;
 
-#if CONFIG_IS_ENABLED(CLK)
-	/* Assigned clock already set clock */
-	ret = clk_get_by_name(dev, "phy", &priv->phy_clk);
-	if (ret) {
-		printf("Failed to get usb phy clock\n");
-		return ret;
+	if (CONFIG_IS_ENABLED(CLK)) {
+		ret = clk_get_by_name(dev, "phy", &priv->phy_clk);
+		if (ret) {
+			dev_err(dev, "Failed to get usb phy clock %d\n", ret);
+			return ret;
+		}
 	}
-#endif
+
 	if (CONFIG_IS_ENABLED(DM_REGULATOR)) {
 		ret = device_get_supply_regulator(dev, "vbus-supply",
 						  &priv->vbus_supply);
Signature · 1 line
2.25.1
#2 lore raw

Re: [PATCH v6 2/2] phy: phy-imx8mq-usb: clean up clock code

Quoted 34 lines · Tim Harvey

use CONFIG_IS_ENABLED for clock enable/disable and change printf's to dev_err. Additionlly remove the comment that does not make sense.

---
v6: new patch

  drivers/phy/phy-imx8mq-usb.c | 33 +++++++++++++++------------------
  1 file changed, 15 insertions(+), 18 deletions(-)
drivers/phy/phy-imx8mq-usb.c +1 -7
index 0ab7965df2ff..bf9b0b6f3450 100644
@@ -78,9 +78,7 @@ enum imx8mpq_phy_type {
  };
 
  struct imx8mq_usb_phy {
-#if CONFIG_IS_ENABLED(CLK)
  	struct clk phy_clk;
-#endif
  	void __iomem *base;
  	enum imx8mpq_phy_type type;
  	struct udevice *vbus_supply;
@@ -178,13 +176,13 @@ static int imx8mq_usb_phy_power_on(struct phy *usb_phy)
  	u32 value;
  	int ret;
 
-#if CONFIG_IS_ENABLED(CLK)
-	ret = clk_enable(&imx_phy->phy_clk);
-	if (ret) {
-		printf("Failed to enable usb phy clock\n");
-		return ret;
+	if (CONFIG_IS_ENABLED(CLK)) {

drivers/phy/phy-imx8mq-usb.c static int imx8mq_usb_phy_power_on(struct phy *usb_phy) · line 188

Quoted 10 lines
drivers/phy/phy-imx8mq-usb.c +5 -1
+		ret = clk_enable(&imx_phy->phy_clk);
+		if (ret) {
+			dev_err(dev, "Failed to enable usb phy clock: %d\n", ret);
+			return ret;
+		}
  	}
-#endif
 
  	if (CONFIG_IS_ENABLED(DM_REGULATOR) && imx_phy->vbus_supply) {
  		ret = regulator_set_enable_if_allowed(imx_phy->vbus_supply, true);

You likely want some if (CONFIG_IS_ENABLED(CLK)) in the err: fail path at the end of this function too.

#3 lore raw
In reply to Tim Harvey
Quoted 79 lines · Tim Harvey

Add support for enabling and disabling vbus-supply regulator found on several imx8mp boards in the usb3_phy0 and usb3_phy1 nodes.

---
v6:
- move changes to clk to separate patch
- sort new vars in reverse christmas tree style

v5:
- remove #if CONFIG_IS_ENABLED around struct members
(you can not conditionally include if using if (CONFIG_IS_ENABLED(foo)) )
- replace clk '#if CONFIG_IS_ENABLED(CLK)' with 'if (CONFIG_IS_ENABLED(CLK))'

v4:
- use regulator_set_enable_if_allowed to handle regulator reference
counting
errors
- added Marek's rb tag

v3:
- change pr_err to dev_err
- add #if CONFIG_IS_ENABLED around vbus_supply in struct
- add fail path to disable clock if regulator enable failed

v2:
- protect ret with __maybe_unused in case CONFIG_CLK and CONFIG_DM_REGULATOR not defined
- add error prints on failures
- add Adam's rb tag

---
  drivers/phy/phy-imx8mq-usb.c | 37 +++++++++++++++++++++++++++++++++---
  1 file changed, 34 insertions(+), 3 deletions(-)
drivers/phy/phy-imx8mq-usb.c +11 -1
index 69f01de55538..0ab7965df2ff 100644
@@ -14,6 +14,8 @@
  #include <linux/delay.h>
  #include <linux/err.h>
  #include <clk.h>
+#include <dm/device_compat.h>
+#include <power/regulator.h>
 
  #define PHY_CTRL0			0x0
  #define PHY_CTRL0_REF_SSP_EN		BIT(2)
@@ -81,6 +83,7 @@ struct imx8mq_usb_phy {
  #endif
  	void __iomem *base;
  	enum imx8mpq_phy_type type;
+	struct udevice *vbus_supply;
  };
 
  static const struct udevice_id imx8mq_usb_phy_of_match[] = {
@@ -173,9 +176,9 @@ static int imx8mq_usb_phy_power_on(struct phy *usb_phy)
  	struct udevice *dev = usb_phy->dev;
  	struct imx8mq_usb_phy *imx_phy = dev_get_priv(dev);
  	u32 value;
+	int ret;
 
  #if CONFIG_IS_ENABLED(CLK)
-	int ret;
  	ret = clk_enable(&imx_phy->phy_clk);
  	if (ret) {
  		printf("Failed to enable usb phy clock\n");
@@ -183,12 +186,24 @@ static int imx8mq_usb_phy_power_on(struct phy *usb_phy)
  	}
  #endif
 
+	if (CONFIG_IS_ENABLED(DM_REGULATOR) && imx_phy->vbus_supply) {
+		ret = regulator_set_enable_if_allowed(imx_phy->vbus_supply, true);
+		if (ret && ret != -ENOSYS) {
+			dev_err(dev, "Failed to enable VBUS regulator: %d\n", ret);
+			goto err;
+		}
+	}

drivers/phy/phy-imx8mq-usb.c static int imx8mq_usb_phy_power_on(struct phy *usb_phy) · line 205

Quoted 10 lines
drivers/phy/phy-imx8mq-usb.c +4 -0
+
  	/* Disable rx term override */
  	value = readl(imx_phy->base + PHY_CTRL6);
  	value &= ~PHY_CTRL6_RXTERM_OVERRIDE_SEL;
  	writel(value, imx_phy->base + PHY_CTRL6);
 
  	return 0;
+
+err:
+	clk_disable(&imx_phy->phy_clk);

This would fail if CLK is not enabled , or cause clock imbalance.

(you would avoid this issue if you were to swap the two patches, or add +if CONFIG_IS_ENABLED(CLK)
clk_disable(...);

[...]