[1/2] dt-bindings usb: typec: rt1711h: Use a generic node name

Message ID 20230216121211.3964433-1-konrad.dybcio@linaro.org
State New
Headers
Series [1/2] dt-bindings usb: typec: rt1711h: Use a generic node name |

Commit Message

Konrad Dybcio Feb. 16, 2023, 12:12 p.m. UTC
  Node names should be generic. Use typec-portc@ instead of rt1711h@.

Fixes: a72095ed8e65 ("dt-bindings usb: typec: rt1711h: Add binding for Richtek RT1711H")
Signed-off-by: Konrad Dybcio <konrad.dybcio@linaro.org>
---
 Documentation/devicetree/bindings/usb/richtek,rt1711h.yaml | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
  

Comments

Rob Herring Feb. 21, 2023, 2:01 a.m. UTC | #1
On Thu, Feb 16, 2023 at 01:12:10PM +0100, Konrad Dybcio wrote:
> Node names should be generic. Use typec-portc@ instead of rt1711h@.

What's generic? Others use just 'typec' IIRC. We must first define the 
generic name for everyone, then do this. It doesn't really work defining 
this in each binding either as there's no checking a generic name is in 
fact used. We either need a class type schema (which don't work when 
devices support multiple classes) or a meta-schema checking $nodename 
patterns match a set of known node names.

> 
> Fixes: a72095ed8e65 ("dt-bindings usb: typec: rt1711h: Add binding for Richtek RT1711H")
> Signed-off-by: Konrad Dybcio <konrad.dybcio@linaro.org>
> ---
>  Documentation/devicetree/bindings/usb/richtek,rt1711h.yaml | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/usb/richtek,rt1711h.yaml b/Documentation/devicetree/bindings/usb/richtek,rt1711h.yaml
> index 1999f614c89b..7431c25d82ce 100644
> --- a/Documentation/devicetree/bindings/usb/richtek,rt1711h.yaml
> +++ b/Documentation/devicetree/bindings/usb/richtek,rt1711h.yaml
> @@ -17,6 +17,9 @@ description: |
>    support for alternative interfaces of the Type-C specification.
>  
>  properties:
> +  $nodename:
> +    pattern: "^typec-portc@[0-9a-f]+$"
> +
>    compatible:
>      enum:
>        - richtek,rt1711h
> @@ -55,7 +58,7 @@ examples:
>        #address-cells = <1>;
>        #size-cells = <0>;
>  
> -      rt1711h@4e {
> +      typec-portc@4e {
>          compatible = "richtek,rt1711h";
>          reg = <0x4e>;
>          interrupts-extended = <&gpio26 3 IRQ_TYPE_LEVEL_LOW>;
> -- 
> 2.39.1
>
  

Patch

diff --git a/Documentation/devicetree/bindings/usb/richtek,rt1711h.yaml b/Documentation/devicetree/bindings/usb/richtek,rt1711h.yaml
index 1999f614c89b..7431c25d82ce 100644
--- a/Documentation/devicetree/bindings/usb/richtek,rt1711h.yaml
+++ b/Documentation/devicetree/bindings/usb/richtek,rt1711h.yaml
@@ -17,6 +17,9 @@  description: |
   support for alternative interfaces of the Type-C specification.
 
 properties:
+  $nodename:
+    pattern: "^typec-portc@[0-9a-f]+$"
+
   compatible:
     enum:
       - richtek,rt1711h
@@ -55,7 +58,7 @@  examples:
       #address-cells = <1>;
       #size-cells = <0>;
 
-      rt1711h@4e {
+      typec-portc@4e {
         compatible = "richtek,rt1711h";
         reg = <0x4e>;
         interrupts-extended = <&gpio26 3 IRQ_TYPE_LEVEL_LOW>;