Skip to contentSkip to conversation

dt-bindings: usb: Add the binding example for the Genesys Logic GL3523 hub

PATCH Superseded Anand Moon 3 participants 8 messages Oct 11, 2023 – Oct 13, 2023

Subsystems (3)

v2 of 7 Superseded Latest is v7 →

lore
Share & tools
lore

Anand Moon

author
#0 lore raw

PATCH v2 1/2 dt-bindings: usb: Add the binding example for the Genesys Logic GL3523 hub

Add the binding example for the USB3.1 Genesys Logic GL3523 integrates with USB 3.1 Gen 1 Super Speed and USB 2.0 High-Speed hub.

---
New patch.

---
 .../bindings/usb/genesys,gl850g.yaml          | 28 +++++++++++++++++--
 1 file changed, 25 insertions(+), 3 deletions(-)
Documentation/devicetree/bindings/usb/genesys,gl850g.yaml +25 -3
index d0927f6768a4..2f6e0c870e1d 100644
@@ -22,29 +22,51 @@ properties:
   reg: true
 
   reset-gpios:
+    maxItems: 1
     description: GPIO controlling the RESET# pin.
 
   vdd-supply:
     description:
       the regulator that provides 3.3V core power to the hub.
 
+  peer-hub:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description:
+      phandle to the peer hub on the controller.
+
 required:
   - compatible
   - reg
+  - reset-gpios
+  - vdd-supply
+  - peer-hub
 
 additionalProperties: false
 
 examples:
   - |
     #include <dt-bindings/gpio/gpio.h>
+
     usb {
         dr_mode = "host";
         #address-cells = <1>;
         #size-cells = <0>;
 
-        hub: hub@1 {
-            compatible = "usb5e3,608";
+        /* 2.0 hub on port 1 */
+        hub_2_0: hub@1 {
+            compatible = "usb5e3,610";
             reg = <1>;
-            reset-gpios = <&pio 7 2 GPIO_ACTIVE_LOW>;
+            vdd-supply = <&vcc_5v>;
+            peer-hub = <&hub_3_0>;
+            reset-gpios = <&gpio 20 GPIO_ACTIVE_LOW>;
+        };
+
+        /* 3.1 hub on port 4 */
+        hub_3_0: hub@2 {
+            compatible = "usb5e3,620";
+            reg = <2>;
+            vdd-supply = <&vcc_5v>;
+            peer-hub = <&hub_2_0>;
+            reset-gpios = <&gpio 20 GPIO_ACTIVE_LOW>;
         };
     };
Signature · 1 line
2.42.0
author
#1 lore raw

PATCH v2 2/2 arm64: dts: amlogic: Used onboard usb hub reset on odroid n2

On Odroid n2/n2+ previously use gpio-hog to reset the usb hub, switch to used on-board usb hub reset to enable the usb hub and enable power to hub.

---
v2 no change.

---
 .../dts/amlogic/meson-g12b-odroid-n2.dtsi     | 36 ++++++++++++-------
 1 file changed, 24 insertions(+), 12 deletions(-)
arch/arm64/boot/dts/amlogic/meson-g12b-odroid-n2.dtsi +24 -12
index 91c9769fda20..9e671444eca6 100644
@@ -31,6 +31,30 @@ hub_5v: regulator-hub_5v {
 		enable-active-high;
 	};
 
+	/* USB hub supports both USB 2.0 and USB 3.0 root hub */
+	usb-hub {
+		dr_mode = "host";
+		#address-cells = <1>;
+		#size-cells = <0>;
+
+		/* 2.0 hub on port 1 */
+		hub_2_0: hub@1 {
+			compatible = "usb5e3,610";
+			reg = <1>;
+			peer-hub = <&hub_3_0>;
+			vdd-supply = <&usb_pwr_en>;
+		};
+
+		/* 3.0 hub on port 4 */
+		hub_3_0: hub@2 {
+			compatible = "usb5e3,620";
+			reg = <2>;
+			peer-hub = <&hub_2_0>;
+			reset-gpios = <&gpio GPIOH_4 GPIO_ACTIVE_LOW>;
+			vdd-supply = <&vcc_5v>;
+		};
+	};
+
 	sound {
 		compatible = "amlogic,axg-sound-card";
 		model = "ODROID-N2";
@@ -234,18 +258,6 @@ &gpio {
 		"PIN_3",  /* GPIOX_17 */
 		"PIN_5",  /* GPIOX_18 */
 		"PIN_36"; /* GPIOX_19 */
-	/*
-	 * WARNING: The USB Hub on the Odroid-N2 needs a reset signal
-	 * to be turned high in order to be detected by the USB Controller
-	 * This signal should be handled by a USB specific power sequence
-	 * in order to reset the Hub when USB bus is powered down.
-	 */
-	usb-hub-hog {
-		gpio-hog;
-		gpios = <GPIOH_4 GPIO_ACTIVE_HIGH>;
-		output-high;
-		line-name = "usb-hub-reset";
-	};
 };
 
 &i2c3 {
Signature · 1 line
2.42.0
maintainer
#2 lore raw
In reply to Anand Moon
Quoted 11 lines · Anand Moon

Add the binding example for the USB3.1 Genesys Logic GL3523 integrates with USB 3.1 Gen 1 Super Speed and USB 2.0 High-Speed hub.

---
New patch.

---
 .../bindings/usb/genesys,gl850g.yaml          | 28 +++++++++++++++++--
 1 file changed, 25 insertions(+), 3 deletions(-)

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check' on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/usb/usb-hcd.example.dtb: hub@1: 'reset-gpios' is a required property
from schema $id: http://devicetree.org/schemas/usb/genesys,gl850g.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/usb/usb-hcd.example.dtb: hub@1: 'vdd-supply' is a required property
from schema $id: http://devicetree.org/schemas/usb/genesys,gl850g.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/usb/usb-hcd.example.dtb: hub@1: 'peer-hub' is a required property
from schema $id: http://devicetree.org/schemas/usb/genesys,gl850g.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/usb/usb-device.example.dtb: hub@1: 'reset-gpios' is a required property
from schema $id: http://devicetree.org/schemas/usb/genesys,gl850g.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/usb/usb-device.example.dtb: hub@1: 'vdd-supply' is a required property
from schema $id: http://devicetree.org/schemas/usb/genesys,gl850g.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/usb/usb-device.example.dtb: hub@1: 'peer-hub' is a required property
from schema $id: http://devicetree.org/schemas/usb/genesys,gl850g.yaml#

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/[email protected]

The base for the series is generally the latest rc1. A different dependency should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note that DT_SCHEMA_FILES can be set to your schema file to speed up checking your schema. However, it must be unset to test all examples with your schema.

author
#3 lore raw

Hi Rob,

Quoted 45 lines · Rob Herring
Quoted 11 lines · Anand Moon

Add the binding example for the USB3.1 Genesys Logic GL3523 integrates with USB 3.1 Gen 1 Super Speed and USB 2.0 High-Speed hub.

---
New patch.

---
 .../bindings/usb/genesys,gl850g.yaml          | 28 +++++++++++++++++--
 1 file changed, 25 insertions(+), 3 deletions(-)

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check' on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/usb/usb-hcd.example.dtb: hub@1: 'reset-gpios' is a required property
from schema $id: http://devicetree.org/schemas/usb/genesys,gl850g.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/usb/usb-hcd.example.dtb: hub@1: 'vdd-supply' is a required property
from schema $id: http://devicetree.org/schemas/usb/genesys,gl850g.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/usb/usb-hcd.example.dtb: hub@1: 'peer-hub' is a required property
from schema $id: http://devicetree.org/schemas/usb/genesys,gl850g.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/usb/usb-device.example.dtb: hub@1: 'reset-gpios' is a required property
from schema $id: http://devicetree.org/schemas/usb/genesys,gl850g.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/usb/usb-device.example.dtb: hub@1: 'vdd-supply' is a required property
from schema $id: http://devicetree.org/schemas/usb/genesys,gl850g.yaml#
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/usb/usb-device.example.dtb: hub@1: 'peer-hub' is a required property
from schema $id: http://devicetree.org/schemas/usb/genesys,gl850g.yaml#

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/[email protected]

The base for the series is generally the latest rc1. A different dependency should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date:

Quoted 6 lines

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note that DT_SCHEMA_FILES can be set to your schema file to speed up checking your schema. However, it must be unset to test all examples with your schema.

Can you share an example to add two examples in this binding? one for usb5e3,608 and other for usb5e3,610, usb5e3,620, I have tried but I got an error for duplicate

I have tried to modify it with the following example

+allOf:
+ - if:
+ properties:
+ compatible:
+ contains:
+ const: usb5e3,608
+ then:
+ properties:

+        reset-gpios: true
+        vdd-supply: false
+        peer-hub: false

+ else:
+ $ref: usb-device.yaml
+ required:
+ - peer-hub

but it still shows me his warning,

DTC_CHK Documentation/devicetree/bindings/usb/usb-hcd.example.dtb
/home/amoon/mainline/linux-amlogic-6.y-devel/Documentation/devicetree/bindings/usb/usb-hcd.example.dtb:
hub@1: 'peer-hub' is a required property
from schema $id: http://devicetree.org/schemas/usb/genesys,gl850g.yaml#

I could not find any binding which supports these properties.
- reset-gpios
- vdd-supply
- peer-hub

Please suggest to me how to resolve this warning.

Thanks
-Anand

#4 lore raw
In reply to Anand Moon
Quoted 3 lines · Anand Moon

Add the binding example for the USB3.1 Genesys Logic GL3523 integrates with USB 3.1 Gen 1 Super Speed and USB 2.0 High-Speed hub.

That's not what the patch does.

Quoted 13 lines

---
New patch.

---
 .../bindings/usb/genesys,gl850g.yaml          | 28 +++++++++++++++++--
 1 file changed, 25 insertions(+), 3 deletions(-)
Documentation/devicetree/bindings/usb/genesys,gl850g.yaml +0 -0
index d0927f6768a4..2f6e0c870e1d 100644

Documentation/devicetree/bindings/usb/genesys,gl850g.yaml properties: · line 25

Quoted 4 lines
Documentation/devicetree/bindings/usb/genesys,gl850g.yaml +1 -0
@@ -22,29 +22,51 @@ properties:
   reg: true
 
   reset-gpios:
+    maxItems: 1

Why?

Quoted 5 lines
Documentation/devicetree/bindings/usb/genesys,gl850g.yaml +0 -0
     description: GPIO controlling the RESET# pin.
 
   vdd-supply:
     description:
       the regulator that provides 3.3V core power to the hub.

Documentation/devicetree/bindings/usb/genesys,gl850g.yaml properties: · line 40

Quoted 10 lines
Documentation/devicetree/bindings/usb/genesys,gl850g.yaml +6 -0
 
+  peer-hub:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description:
+      phandle to the peer hub on the controller.
+
 required:
   - compatible
   - reg
+  - reset-gpios

Why?

Quoted 23 lines
Documentation/devicetree/bindings/usb/genesys,gl850g.yaml +8 -3
+  - vdd-supply
+  - peer-hub
 
 additionalProperties: false
 
 examples:
   - |
     #include <dt-bindings/gpio/gpio.h>
+
     usb {
         dr_mode = "host";
         #address-cells = <1>;
         #size-cells = <0>;
 
-        hub: hub@1 {
-            compatible = "usb5e3,608";
+        /* 2.0 hub on port 1 */
+        hub_2_0: hub@1 {
+            compatible = "usb5e3,610";
             reg = <1>;
-            reset-gpios = <&pio 7 2 GPIO_ACTIVE_LOW>;
+            vdd-supply = <&vcc_5v>;
+            peer-hub = <&hub_3_0>;

Documentation/devicetree/bindings/usb/genesys,gl850g.yaml properties: · line 70

Quoted 10 lines
Documentation/devicetree/bindings/usb/genesys,gl850g.yaml +10 -0
+            reset-gpios = <&gpio 20 GPIO_ACTIVE_LOW>;
+        };
+
+        /* 3.1 hub on port 4 */
+        hub_3_0: hub@2 {
+            compatible = "usb5e3,620";
+            reg = <2>;
+            vdd-supply = <&vcc_5v>;
+            peer-hub = <&hub_2_0>;
+            reset-gpios = <&gpio 20 GPIO_ACTIVE_LOW>;

Really, what is happening here?

Best regards,
Krzysztof

author
#5 lore raw

Hi Krzysztof,

Quoted 7 lines · Krzysztof Kozlowski
Quoted 3 lines · Anand Moon

Add the binding example for the USB3.1 Genesys Logic GL3523 integrates with USB 3.1 Gen 1 Super Speed and USB 2.0 High-Speed hub.

That's not what the patch does.

Ok I have tried to add an example below the original changes but the device tree complained of duplicate entries. Hence I modified these changes.

This change was requested to update the peer-hub example below.
[0] https://lore.kernel.org/all/[email protected]/

Quoted 16 lines
Quoted 16 lines

---
New patch.

---
 .../bindings/usb/genesys,gl850g.yaml          | 28 +++++++++++++++++--
 1 file changed, 25 insertions(+), 3 deletions(-)
Documentation/devicetree/bindings/usb/genesys,gl850g.yaml +0 -0
index d0927f6768a4..2f6e0c870e1d 100644
@@ -22,29 +22,51 @@ properties:
   reg: true
 
Quoted 4 lines

Documentation/devicetree/bindings/usb/genesys,gl850g.yaml properties: · line 25

Quoted 2 lines
Documentation/devicetree/bindings/usb/genesys,gl850g.yaml +1 -0
   reset-gpios:
+    maxItems: 1

Why?

Following another example, I added this and will drop this.

Quoted 17 lines
Quoted 6 lines
Documentation/devicetree/bindings/usb/genesys,gl850g.yaml +0 -0
     description: GPIO controlling the RESET# pin.
 
   vdd-supply:
     description:
       the regulator that provides 3.3V core power to the hub.

Documentation/devicetree/bindings/usb/genesys,gl850g.yaml properties: · line 40

Quoted 10 lines
Documentation/devicetree/bindings/usb/genesys,gl850g.yaml +6 -0
 
+  peer-hub:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description:
+      phandle to the peer hub on the controller.
+
 required:
   - compatible
   - reg
+  - reset-gpios
Quoted 1 line

Why?

see below.

Quoted 28 lines
Quoted 28 lines
Documentation/devicetree/bindings/usb/genesys,gl850g.yaml +12 -3
+  - vdd-supply
+  - peer-hub
 
 additionalProperties: false
 
 examples:
   - |
     #include <dt-bindings/gpio/gpio.h>
+
     usb {
         dr_mode = "host";
         #address-cells = <1>;
         #size-cells = <0>;
 
-        hub: hub@1 {
-            compatible = "usb5e3,608";
+        /* 2.0 hub on port 1 */
+        hub_2_0: hub@1 {
+            compatible = "usb5e3,610";
             reg = <1>;
-            reset-gpios = <&pio 7 2 GPIO_ACTIVE_LOW>;
+            vdd-supply = <&vcc_5v>;
+            peer-hub = <&hub_3_0>;
+            reset-gpios = <&gpio 20 GPIO_ACTIVE_LOW>;
+        };
+
+        /* 3.1 hub on port 4 */
Quoted 8 lines

Documentation/devicetree/bindings/usb/genesys,gl850g.yaml properties: · line 70

Quoted 6 lines
Documentation/devicetree/bindings/usb/genesys,gl850g.yaml +6 -0
+        hub_3_0: hub@2 {
+            compatible = "usb5e3,620";
+            reg = <2>;
+            vdd-supply = <&vcc_5v>;
+            peer-hub = <&hub_2_0>;
+            reset-gpios = <&gpio 20 GPIO_ACTIVE_LOW>;

Really, what is happening here?

USB hub GL3523-QFN76 supports two pins CHIP_EN and RST_N pins so RST_N (GPIOH_4) is used to reset the USB hub, earlier we were using gpio-hog to reset the hub.

Quoted 4 lines

Best regards,
Krzysztof

Thanks
-Anand

#6 lore raw
Quoted 10 lines · Anand Moon

Hi Krzysztof,

Quoted 6 lines · Krzysztof Kozlowski
Quoted 3 lines · Anand Moon

Add the binding example for the USB3.1 Genesys Logic GL3523 integrates with USB 3.1 Gen 1 Super Speed and USB 2.0 High-Speed hub.

Quoted 8 lines
Quoted 1 line

That's not what the patch does.

Ok I have tried to add an example below the original changes but the device tree complained of duplicate entries. Hence I modified these changes.

This change was requested to update the peer-hub example below.
[0] https://lore.kernel.org/all/[email protected]/

Neil did not ask you to add it to the example but to the binding. Existing example should be extended, but that's byproduct of main change.

Best regards,
Krzysztof

author
#7 lore raw

Hi Krzysztof,

Quoted 18 lines · Krzysztof Kozlowski
Quoted 16 lines · Anand Moon

Hi Krzysztof,

Quoted 7 lines · Krzysztof Kozlowski
Quoted 3 lines · Anand Moon

Add the binding example for the USB3.1 Genesys Logic GL3523 integrates with USB 3.1 Gen 1 Super Speed and USB 2.0 High-Speed hub.

That's not what the patch does.

Ok I have tried to add an example below the original changes but the device tree complained of duplicate entries. Hence I modified these changes.

Quoted 6 lines
Quoted 2 lines

This change was requested to update the peer-hub example below.
[0] https://lore.kernel.org/all/[email protected]/

Neil did not ask you to add it to the example but to the binding. Existing example should be extended, but that's byproduct of main change.

Do you want me to add a new binding file to support this example.

# Documentation/devicetree/bindings/usb/genesys,gpn76.yaml

Quoted 3 lines

Best regards,
Krzysztof

Thanks
-Anand