[PATCH v3 0/2] Extend Sparx5 switch reset driver for lan966x

This patch serie extends the Microchip Sparx5 reset driver to support
lan966x

v2->v3:
  - rename variable reset_gpio to phy_reset_gpio
  - rename gpios property in documentation to phy-reset-gpios

v1->v2:
  - add reviewed-by tag
  - extend driver to be able to release the reset also for external PHYs

Horatiu Vultur (2):
  dt-bindings: reset: Add lan966x support
  reset: mchp: sparx5: Extend support for lan966x

 .../bindings/reset/microchip,rst.yaml         | 14 +++-
 drivers/reset/Kconfig                         |  2 +-
 drivers/reset/reset-microchip-sparx5.c        | 81 +++++++++++++++++--
 3 files changed, 87 insertions(+), 10 deletions(-)

-- 
2.33.0


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

This adds support for lan966x.

Signed-off-by: Horatiu Vultur <horatiu.vultur@microchip.com>
---
 .../devicetree/bindings/reset/microchip,rst.yaml   | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/reset/microchip,rst.yaml b/Documentation/devicetree/bindings/reset/microchip,rst.yaml
index 370579aeeca1..fb170ed2c57a 100644
--- a/Documentation/devicetree/bindings/reset/microchip,rst.yaml
+++ b/Documentation/devicetree/bindings/reset/microchip,rst.yaml

@@ -20,7 +20,11 @@ properties:
     pattern: "^reset-controller@[0-9a-f]+$"
 
   compatible:
-    const: microchip,sparx5-switch-reset
+    oneOf:
+      - items:
+          - const: microchip,sparx5-switch-reset
+      - items:
+          - const: microchip,lan966x-switch-reset
 
   reg:
     items:

@@ -37,6 +41,14 @@ properties:
     $ref: "/schemas/types.yaml#/definitions/phandle"
     description: syscon used to access CPU reset
 
+  cuphy-syscon:
+    $ref: "/schemas/types.yaml#/definitions/phandle"
+    description: syscon used to access CuPHY
+
+  phy-reset-gpios:
+    description: used for release of reset of the external PHY
+    maxItems: 1
+
 required:
   - compatible
   - reg

-- 
2.33.0


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

This patch extends sparx5 driver to support also the lan966x. The
process to reset the switch is the same only it has different offsets.
Therefore make the driver more generic and add support for lan966x.

Signed-off-by: Horatiu Vultur <horatiu.vultur@microchip.com>
Reviewed-by: Andrew Lunn <andrew@lunn.ch>
---
 drivers/reset/Kconfig                  |  2 +-
 drivers/reset/reset-microchip-sparx5.c | 81 +++++++++++++++++++++++---
 2 files changed, 74 insertions(+), 9 deletions(-)

diff --git a/drivers/reset/Kconfig b/drivers/reset/Kconfig
index be799a5abf8a..36ce6c8bcf1e 100644
--- a/drivers/reset/Kconfig
+++ b/drivers/reset/Kconfig

@@ -116,7 +116,7 @@ config RESET_LPC18XX
 
 config RESET_MCHP_SPARX5
 	bool "Microchip Sparx5 reset driver"
-	depends on ARCH_SPARX5 || COMPILE_TEST
+	depends on ARCH_SPARX5 || SOC_LAN966 || COMPILE_TEST
 	default y if SPARX5_SWITCH
 	select MFD_SYSCON
 	help

diff --git a/drivers/reset/reset-microchip-sparx5.c b/drivers/reset/reset-microchip-sparx5.c
index f01e7db8e83b..211ee338e4b6 100644
--- a/drivers/reset/reset-microchip-sparx5.c
+++ b/drivers/reset/reset-microchip-sparx5.c

@@ -6,6 +6,7 @@
  * The Sparx5 Chip Register Model can be browsed at this location:
  * https://github.com/microchip-ung/sparx-5_reginfo
  */
+#include <linux/gpio/consumer.h>
 #include <linux/mfd/syscon.h>
 #include <linux/of_device.h>
 #include <linux/module.h>

@@ -13,15 +14,22 @@
 #include <linux/regmap.h>
 #include <linux/reset-controller.h>
 
-#define PROTECT_REG    0x84
-#define PROTECT_BIT    BIT(10)
-#define SOFT_RESET_REG 0x00
-#define SOFT_RESET_BIT BIT(1)
+struct reset_props {
+	u32 protect_reg;
+	u32 protect_bit;
+	u32 reset_reg;
+	u32 reset_bit;
+	u32 cuphy_reg;
+	u32 cuphy_bit;
+};
 
 struct mchp_reset_context {
 	struct regmap *cpu_ctrl;
 	struct regmap *gcb_ctrl;
+	struct regmap *cuphy_ctrl;
 	struct reset_controller_dev rcdev;
+	const struct reset_props *props;
+	struct gpio_desc *phy_reset_gpio;
 };
 
 static struct regmap_config sparx5_reset_regmap_config = {

@@ -36,17 +44,39 @@ static int sparx5_switch_reset(struct reset_controller_dev *rcdev,
 	struct mchp_reset_context *ctx =
 		container_of(rcdev, struct mchp_reset_context, rcdev);
 	u32 val;
+	int err;
 
 	/* Make sure the core is PROTECTED from reset */
-	regmap_update_bits(ctx->cpu_ctrl, PROTECT_REG, PROTECT_BIT, PROTECT_BIT);
+	regmap_update_bits(ctx->cpu_ctrl, ctx->props->protect_reg,
+			   ctx->props->protect_bit, ctx->props->protect_bit);
 
 	/* Start soft reset */
-	regmap_write(ctx->gcb_ctrl, SOFT_RESET_REG, SOFT_RESET_BIT);
+	regmap_write(ctx->gcb_ctrl, ctx->props->reset_reg,
+		     ctx->props->reset_bit);
 
 	/* Wait for soft reset done */
-	return regmap_read_poll_timeout(ctx->gcb_ctrl, SOFT_RESET_REG, val,
-					(val & SOFT_RESET_BIT) == 0,
+	err = regmap_read_poll_timeout(ctx->gcb_ctrl, ctx->props->reset_reg, val,
+					(val & ctx->props->reset_bit) == 0,
 					1, 100);
+	if (err)
+		return err;
+
+	if (!ctx->cuphy_ctrl)
+		return 0;
+
+	/* In case there are external PHYs toggle the GPIO to release the reset
+	 * of the PHYs
+	 */
+	if (ctx->phy_reset_gpio) {
+		gpiod_direction_output(ctx->phy_reset_gpio, 1);
+		gpiod_set_value(ctx->phy_reset_gpio, 0);
+		gpiod_set_value(ctx->phy_reset_gpio, 1);
+		gpiod_set_value(ctx->phy_reset_gpio, 0);
+	}
+
+	/* Release the reset of internal PHY */
+	return regmap_update_bits(ctx->cuphy_ctrl, ctx->props->cuphy_reg,
+				  ctx->props->cuphy_bit, ctx->props->cuphy_bit);
 }
 
 static const struct reset_control_ops sparx5_reset_ops = {

@@ -111,17 +141,52 @@ static int mchp_sparx5_reset_probe(struct platform_device *pdev)
 	if (err)
 		return err;
 
+	/* This resource is required on lan966x, to take the internal PHYs out
+	 * of reset
+	 */
+	err = mchp_sparx5_map_syscon(pdev, "cuphy-syscon", &ctx->cuphy_ctrl);
+	if (err && err != -ENODEV)
+		return err;
+
 	ctx->rcdev.owner = THIS_MODULE;
 	ctx->rcdev.nr_resets = 1;
 	ctx->rcdev.ops = &sparx5_reset_ops;
 	ctx->rcdev.of_node = dn;
+	ctx->props = device_get_match_data(&pdev->dev);
+
+	ctx->phy_reset_gpio = devm_gpiod_get_optional(&pdev->dev, "phy-reset",
+						      GPIOD_OUT_LOW);
+	if (IS_ERR(ctx->phy_reset_gpio)) {
+		dev_err(&pdev->dev, "Could not get reset GPIO\n");
+		return PTR_ERR(ctx->phy_reset_gpio);
+	}
 
 	return devm_reset_controller_register(&pdev->dev, &ctx->rcdev);
 }
 
+static const struct reset_props reset_props_sparx5 = {
+	.protect_reg    = 0x84,
+	.protect_bit    = BIT(10),
+	.reset_reg      = 0x0,
+	.reset_bit      = BIT(1),
+};
+
+static const struct reset_props reset_props_lan966x = {
+	.protect_reg    = 0x88,
+	.protect_bit    = BIT(5),
+	.reset_reg      = 0x0,
+	.reset_bit      = BIT(1),
+	.cuphy_reg       = 0x10,
+	.cuphy_bit       = BIT(0),
+};
+
 static const struct of_device_id mchp_sparx5_reset_of_match[] = {
 	{
 		.compatible = "microchip,sparx5-switch-reset",
+		.data = &reset_props_sparx5,
+	}, {
+		.compatible = "microchip,lan966x-switch-reset",
+		.data = &reset_props_lan966x,
 	},
 	{ }
 };

-- 
2.33.0


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

On Wed, 2021-10-13 at 09:38 +0200, Horatiu Vultur wrote:

Can this be used on sparx5?
Is it optional on lan966x?

+  phy-reset-gpios:
+    description: used for release of reset of the external PHY
+    maxItems: 1
+
 required:
   - compatible
   - reg

I'd like somebody to reassure me that putting the CuPHY reset and
external PHY GPIO reset in the reset controller is the right thing to
do.

It looks fine to me, but I'm not sure if these should rather be in
separate phy nodes that are referenced from the switch.

regards
Philipp

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

On Wed, 2021-10-13 at 09:38 +0200, Horatiu Vultur wrote:

Ah, here we go, required on lan966x. This should be reflected in the
binding yaml.

+	 */
+	err = mchp_sparx5_map_syscon(pdev, "cuphy-syscon", &ctx->cuphy_ctrl);
+	if (err && err != -ENODEV)
+		return err;

So -ENODEV should return an error if .cuphy_reg is set?

+
 	ctx->rcdev.owner = THIS_MODULE;
 	ctx->rcdev.nr_resets = 1;
 	ctx->rcdev.ops = &sparx5_reset_ops;
 	ctx->rcdev.of_node = dn;
+	ctx->props = device_get_match_data(&pdev->dev);
+
+	ctx->phy_reset_gpio = devm_gpiod_get_optional(&pdev->dev, "phy-reset",
+						      GPIOD_OUT_LOW);
+	if (IS_ERR(ctx->phy_reset_gpio)) {
+		dev_err(&pdev->dev, "Could not get reset GPIO\n");
+		return PTR_ERR(ctx->phy_reset_gpio);

You could use dev_err_probe() here.

regards
Philipp

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

Hi Philipp,

The 10/14/2021 13:55, Philipp Zabel wrote:

On Wed, 2021-10-13 at 09:38 +0200, Horatiu Vultur wrote:

quoted

This adds support for lan966x.

Signed-off-by: Horatiu Vultur <horatiu.vultur@microchip.com>
---
 .../devicetree/bindings/reset/microchip,rst.yaml   | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/reset/microchip,rst.yaml b/Documentation/devicetree/bindings/reset/microchip,rst.yaml
index 370579aeeca1..fb170ed2c57a 100644
--- a/Documentation/devicetree/bindings/reset/microchip,rst.yaml
+++ b/Documentation/devicetree/bindings/reset/microchip,rst.yaml

@@ -20,7 +20,11 @@ properties:
     pattern: "^reset-controller@[0-9a-f]+$"

   compatible:
-    const: microchip,sparx5-switch-reset
+    oneOf:
+      - items:
+          - const: microchip,sparx5-switch-reset
+      - items:
+          - const: microchip,lan966x-switch-reset

   reg:
     items:

@@ -37,6 +41,14 @@ properties:
     $ref: "/schemas/types.yaml#/definitions/phandle"
     description: syscon used to access CPU reset

+  cuphy-syscon:
+    $ref: "/schemas/types.yaml#/definitions/phandle"
+    description: syscon used to access CuPHY

Can this be used on sparx5?

No, because the sparx5 doesn't have any internal PHYs that need to
be released of the reset.

Is it optional on lan966x?

No, it is required on lan966x. I will update the binding to show this.

quoted

+  phy-reset-gpios:
+    description: used for release of reset of the external PHY
+    maxItems: 1
+
 required:
   - compatible
   - reg

I'd like somebody to reassure me that putting the CuPHY reset and
external PHY GPIO reset in the reset controller is the right thing to
do.

It looks fine to me, but I'm not sure if these should rather be in
separate phy nodes that are referenced from the switch.

regards
Philipp

-- 
/Horatiu

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

The 10/14/2021 14:00, Philipp Zabel wrote:

On Wed, 2021-10-13 at 09:38 +0200, Horatiu Vultur wrote:

quoted

This patch extends sparx5 driver to support also the lan966x. The
process to reset the switch is the same only it has different offsets.
Therefore make the driver more generic and add support for lan966x.

Signed-off-by: Horatiu Vultur <horatiu.vultur@microchip.com>
Reviewed-by: Andrew Lunn <andrew@lunn.ch>
---
 drivers/reset/Kconfig                  |  2 +-
 drivers/reset/reset-microchip-sparx5.c | 81 +++++++++++++++++++++++---
 2 files changed, 74 insertions(+), 9 deletions(-)

diff --git a/drivers/reset/Kconfig b/drivers/reset/Kconfig
index be799a5abf8a..36ce6c8bcf1e 100644
--- a/drivers/reset/Kconfig
+++ b/drivers/reset/Kconfig

@@ -116,7 +116,7 @@ config RESET_LPC18XX

 config RESET_MCHP_SPARX5
      bool "Microchip Sparx5 reset driver"
-     depends on ARCH_SPARX5 || COMPILE_TEST
+     depends on ARCH_SPARX5 || SOC_LAN966 || COMPILE_TEST
      default y if SPARX5_SWITCH
      select MFD_SYSCON
      help

diff --git a/drivers/reset/reset-microchip-sparx5.c b/drivers/reset/reset-microchip-sparx5.c
index f01e7db8e83b..211ee338e4b6 100644
--- a/drivers/reset/reset-microchip-sparx5.c
+++ b/drivers/reset/reset-microchip-sparx5.c

@@ -6,6 +6,7 @@
  * The Sparx5 Chip Register Model can be browsed at this location:
  * https://github.com/microchip-ung/sparx-5_reginfo
  */
+#include <linux/gpio/consumer.h>
 #include <linux/mfd/syscon.h>
 #include <linux/of_device.h>
 #include <linux/module.h>

@@ -13,15 +14,22 @@
 #include <linux/regmap.h>
 #include <linux/reset-controller.h>

-#define PROTECT_REG    0x84
-#define PROTECT_BIT    BIT(10)
-#define SOFT_RESET_REG 0x00
-#define SOFT_RESET_BIT BIT(1)
+struct reset_props {
+     u32 protect_reg;
+     u32 protect_bit;
+     u32 reset_reg;
+     u32 reset_bit;
+     u32 cuphy_reg;
+     u32 cuphy_bit;
+};

 struct mchp_reset_context {
      struct regmap *cpu_ctrl;
      struct regmap *gcb_ctrl;
+     struct regmap *cuphy_ctrl;
      struct reset_controller_dev rcdev;
+     const struct reset_props *props;
+     struct gpio_desc *phy_reset_gpio;
 };

 static struct regmap_config sparx5_reset_regmap_config = {

@@ -36,17 +44,39 @@ static int sparx5_switch_reset(struct reset_controller_dev *rcdev,
      struct mchp_reset_context *ctx =
              container_of(rcdev, struct mchp_reset_context, rcdev);
      u32 val;
+     int err;

      /* Make sure the core is PROTECTED from reset */
-     regmap_update_bits(ctx->cpu_ctrl, PROTECT_REG, PROTECT_BIT, PROTECT_BIT);
+     regmap_update_bits(ctx->cpu_ctrl, ctx->props->protect_reg,
+                        ctx->props->protect_bit, ctx->props->protect_bit);

      /* Start soft reset */
-     regmap_write(ctx->gcb_ctrl, SOFT_RESET_REG, SOFT_RESET_BIT);
+     regmap_write(ctx->gcb_ctrl, ctx->props->reset_reg,
+                  ctx->props->reset_bit);

      /* Wait for soft reset done */
-     return regmap_read_poll_timeout(ctx->gcb_ctrl, SOFT_RESET_REG, val,
-                                     (val & SOFT_RESET_BIT) == 0,
+     err = regmap_read_poll_timeout(ctx->gcb_ctrl, ctx->props->reset_reg, val,
+                                     (val & ctx->props->reset_bit) == 0,
                                      1, 100);
+     if (err)
+             return err;
+
+     if (!ctx->cuphy_ctrl)
+             return 0;
+
+     /* In case there are external PHYs toggle the GPIO to release the reset
+      * of the PHYs
+      */
+     if (ctx->phy_reset_gpio) {
+             gpiod_direction_output(ctx->phy_reset_gpio, 1);
+             gpiod_set_value(ctx->phy_reset_gpio, 0);
+             gpiod_set_value(ctx->phy_reset_gpio, 1);
+             gpiod_set_value(ctx->phy_reset_gpio, 0);
+     }
+
+     /* Release the reset of internal PHY */
+     return regmap_update_bits(ctx->cuphy_ctrl, ctx->props->cuphy_reg,
+                               ctx->props->cuphy_bit, ctx->props->cuphy_bit);
 }

 static const struct reset_control_ops sparx5_reset_ops = {

@@ -111,17 +141,52 @@ static int mchp_sparx5_reset_probe(struct platform_device *pdev)
      if (err)
              return err;

+     /* This resource is required on lan966x, to take the internal PHYs out
+      * of reset

Ah, here we go, required on lan966x. This should be reflected in the
binding yaml.

I will update the binding yaml.

quoted

+      */
+     err = mchp_sparx5_map_syscon(pdev, "cuphy-syscon", &ctx->cuphy_ctrl);
+     if (err && err != -ENODEV)
+             return err;

So -ENODEV should return an error if .cuphy_reg is set?

I am not sure I follow this.
If cuphy-syscon is not set then mchp_sparx5_map_syscon will return
-ENODEV. This can be ignored for sparx5 as this is not required.
If cuphy-syscon is set then if mchp_sparx5_map_syscon returns an error
then report this error.

quoted

+
      ctx->rcdev.owner = THIS_MODULE;
      ctx->rcdev.nr_resets = 1;
      ctx->rcdev.ops = &sparx5_reset_ops;
      ctx->rcdev.of_node = dn;
+     ctx->props = device_get_match_data(&pdev->dev);
+
+     ctx->phy_reset_gpio = devm_gpiod_get_optional(&pdev->dev, "phy-reset",
+                                                   GPIOD_OUT_LOW);
+     if (IS_ERR(ctx->phy_reset_gpio)) {
+             dev_err(&pdev->dev, "Could not get reset GPIO\n");
+             return PTR_ERR(ctx->phy_reset_gpio);

You could use dev_err_probe() here.

Yes, I will use this.

regards
Philipp

-- 
/Horatiu

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

The 10/14/2021 17:20, Horatiu Vultur wrote:

Hi Philipp,

The 10/14/2021 13:55, Philipp Zabel wrote:

quoted

On Wed, 2021-10-13 at 09:38 +0200, Horatiu Vultur wrote:

quoted

This adds support for lan966x.

Signed-off-by: Horatiu Vultur <horatiu.vultur@microchip.com>
---
 .../devicetree/bindings/reset/microchip,rst.yaml   | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/reset/microchip,rst.yaml b/Documentation/devicetree/bindings/reset/microchip,rst.yaml
index 370579aeeca1..fb170ed2c57a 100644
--- a/Documentation/devicetree/bindings/reset/microchip,rst.yaml
+++ b/Documentation/devicetree/bindings/reset/microchip,rst.yaml

@@ -20,7 +20,11 @@ properties:
     pattern: "^reset-controller@[0-9a-f]+$"

   compatible:
-    const: microchip,sparx5-switch-reset
+    oneOf:
+      - items:
+          - const: microchip,sparx5-switch-reset
+      - items:
+          - const: microchip,lan966x-switch-reset

   reg:
     items:

@@ -37,6 +41,14 @@ properties:
     $ref: "/schemas/types.yaml#/definitions/phandle"
     description: syscon used to access CPU reset

+  cuphy-syscon:
+    $ref: "/schemas/types.yaml#/definitions/phandle"
+    description: syscon used to access CuPHY

Can this be used on sparx5?

No, because the sparx5 doesn't have any internal PHYs that need to
be released of the reset.

quoted

Is it optional on lan966x?

No, it is required on lan966x. I will update the binding to show this.

quoted

quoted

+  phy-reset-gpios:
+    description: used for release of reset of the external PHY
+    maxItems: 1
+
 required:
   - compatible
   - reg

I'd like somebody to reassure me that putting the CuPHY reset and
external PHY GPIO reset in the reset controller is the right thing to
do.

It looks fine to me, but I'm not sure if these should rather be in
separate phy nodes that are referenced from the switch.

Were you thinking to have just another reset driver('phy-reset') and then
the switch to refer to both of them?
I like this idea because then is more clear what is doing each driver.

quoted

regards
Philipp

-- 
/Horatiu

-- 
/Horatiu

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

On Fri, 2021-10-15 at 16:14 +0200, Horatiu Vultur wrote:
[...]

Were you thinking to have just another reset driver('phy-reset') and then
the switch to refer to both of them?
I like this idea because then is more clear what is doing each driver.

Yes, especially if there is no requirement to handle switch and PHY
resets at the same time: this would allow the sgpio driver to trigger
the required switch reset without already releasing the PHYs from reset.

regards
Philipp

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

On Thu, 2021-10-14 at 17:40 +0200, Horatiu Vultur wrote:

quoted

quoted

+      */
+     err = mchp_sparx5_map_syscon(pdev, "cuphy-syscon", &ctx->cuphy_ctrl);
+     if (err && err != -ENODEV)
+             return err;

So -ENODEV should return an error if .cuphy_reg is set?

I am not sure I follow this.
If cuphy-syscon is not set then mchp_sparx5_map_syscon will return
-ENODEV. This can be ignored for sparx5 as this is not required.
If cuphy-syscon is set then if mchp_sparx5_map_syscon returns an error
then report this error.

My point was that in case of cuphy-syscon missing from the DT, the
lan966x compatible reset controller should probably throw the error
instead of ignoring it. With v4 this is not relevant any more.

regards
Philipp

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel