Skip to contentSkip to conversation

dt-bindings: usb: ti,keystone-dwc3.yaml: Improve schema

PATCH Superseded Roger Quadros 2 participants 4 messages Jun 2, 2020 – Jun 24, 2020

Subsystems (2)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 dt-bindings: usb: ti,keystone-dwc3.yaml: Improve schema

There were some review comments after the patch was integrated. Address those.

Fixes 1883a934e156 ("dt-bindings: usb: convert keystone-usb.txt to YAML")
---
 .../bindings/usb/ti,keystone-dwc3.yaml        | 47 ++++++++++++++-----
 1 file changed, 35 insertions(+), 12 deletions(-)
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +35 -12
index f127535feb0b..017c5883184b 100644
@@ -11,30 +11,44 @@ maintainers:
 
 properties:
   compatible:
-    oneOf:
-      - const: "ti,keystone-dwc3"
-      - const: "ti,am654-dwc3"
+    items:
+      - enum:
+        - "ti,keystone-dwc3"
+        - "ti,am654-dwc3"
 
   reg:
     maxItems: 1
-    description: Address and length of the register set for the USB subsystem on
-      the SOC.
+
+  '#address-cells':
+    const: 1
+
+  '#size-cells':
+    const: 1
+
+  ranges: true
 
   interrupts:
     maxItems: 1
-    description: The irq number of this device that is used to interrupt the MPU.
-
 
   clocks:
+    $ref: /schemas/types.yaml#definitions/phandle-array
     description: Clock ID for USB functional clock.
 
+  assigned-clocks:
+    $ref: /schemas/types.yaml#definitions/phandle-array
+
+  assigned-clock-parents:
+    $ref: /schemas/types.yaml#definitions/phandle-array
+
   power-domains:
+    $ref: /schemas/types.yaml#definitions/phandle-array
     description: Should contain a phandle to a PM domain provider node
       and an args specifier containing the USB device id
       value. This property is as per the binding,
       Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
 
   phys:
+    $ref: /schemas/types.yaml#/definitions/phandle-array
     description:
       PHY specifier for the USB3.0 PHY. Some SoCs need the USB3.0 PHY
       to be turned on before the controller.
@@ -44,31 +58,40 @@ properties:
     items:
       - const: "usb3-phy"
 
-  dwc3:
+  dma-coherent: true
+
+  dma-ranges: true
+
+patternProperties:
+  "usb@[a-f0-9]+$":
+    type: object
     description: This is the node representing the DWC3 controller instance
       Documentation/devicetree/bindings/usb/dwc3.txt
 
 required:
   - compatible
   - reg
+  - "#address-cells"
+  - "#size-cells"
+  - ranges
   - interrupts
-  - clocks
+
+additionalProperties: false
 
 examples:
   - |
     #include <dt-bindings/interrupt-controller/arm-gic.h>
 
-    usb: usb@2680000 {
+    dwc3@2680000 {
       compatible = "ti,keystone-dwc3";
       #address-cells = <1>;
       #size-cells = <1>;
       reg = <0x2680000 0x10000>;
       clocks = <&clkusb>;
-      clock-names = "usb";
       interrupts = <GIC_SPI 393 IRQ_TYPE_EDGE_RISING>;
       ranges;
 
-      dwc3@2690000 {
+      usb@2690000 {
         compatible = "synopsys,dwc3";
         reg = <0x2690000 0x70000>;
         interrupts = <GIC_SPI 393 IRQ_TYPE_EDGE_RISING>;
Signature · 2 lines
Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki.
Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki
#1 lore raw

PATCH v2 1/1 dt-bindings: usb: ti,keystone-dwc3.yaml: Improve schema

There were some review comments after the patch was integrated. Address those.

Fixes 1883a934e156 ("dt-bindings: usb: convert keystone-usb.txt to YAML")

---

Changelog:
v2
- don't use quotes for enum/const string
- use phandle instead of phandle-array for phys
- add maxItems for phy-names

 .../bindings/usb/ti,keystone-dwc3.yaml        | 50 ++++++++++++++-----
 1 file changed, 37 insertions(+), 13 deletions(-)
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +37 -13
index f127535feb0b..394e47d2f5d7 100644
@@ -11,64 +11,88 @@ maintainers:
 
 properties:
   compatible:
-    oneOf:
-      - const: "ti,keystone-dwc3"
-      - const: "ti,am654-dwc3"
+    items:
+      - enum:
+        - ti,keystone-dwc3
+        - ti,am654-dwc3
 
   reg:
     maxItems: 1
-    description: Address and length of the register set for the USB subsystem on
-      the SOC.
+
+  '#address-cells':
+    const: 1
+
+  '#size-cells':
+    const: 1
+
+  ranges: true
 
   interrupts:
     maxItems: 1
-    description: The irq number of this device that is used to interrupt the MPU.
-
 
   clocks:
+    $ref: /schemas/types.yaml#definitions/phandle-array
     description: Clock ID for USB functional clock.
 
+  assigned-clocks:
+    $ref: /schemas/types.yaml#definitions/phandle-array
+
+  assigned-clock-parents:
+    $ref: /schemas/types.yaml#definitions/phandle-array
+
   power-domains:
+    $ref: /schemas/types.yaml#definitions/phandle-array
     description: Should contain a phandle to a PM domain provider node
       and an args specifier containing the USB device id
       value. This property is as per the binding,
       Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
 
   phys:
+    $ref: /schemas/types.yaml#/definitions/phandle
     description:
       PHY specifier for the USB3.0 PHY. Some SoCs need the USB3.0 PHY
       to be turned on before the controller.
       Documentation/devicetree/bindings/phy/phy-bindings.txt
 
   phy-names:
+    maxItems: 1
     items:
-      - const: "usb3-phy"
+      - const: usb3-phy
+
+  dma-coherent: true
 
-  dwc3:
+  dma-ranges: true
+
+patternProperties:
+  "usb@[a-f0-9]+$":
+    type: object
     description: This is the node representing the DWC3 controller instance
       Documentation/devicetree/bindings/usb/dwc3.txt
 
 required:
   - compatible
   - reg
+  - "#address-cells"
+  - "#size-cells"
+  - ranges
   - interrupts
-  - clocks
+
+additionalProperties: false
 
 examples:
   - |
     #include <dt-bindings/interrupt-controller/arm-gic.h>
 
-    usb: usb@2680000 {
+    dwc3@2680000 {
       compatible = "ti,keystone-dwc3";
       #address-cells = <1>;
       #size-cells = <1>;
       reg = <0x2680000 0x10000>;
       clocks = <&clkusb>;
-      clock-names = "usb";
       interrupts = <GIC_SPI 393 IRQ_TYPE_EDGE_RISING>;
       ranges;
 
-      dwc3@2690000 {
+      usb@2690000 {
         compatible = "synopsys,dwc3";
         reg = <0x2690000 0x70000>;
         interrupts = <GIC_SPI 393 IRQ_TYPE_EDGE_RISING>;
Signature · 2 lines
Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki.
Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki
maintainer
#2 lore raw
Quoted 32 lines · Roger Quadros

There were some review comments after the patch was integrated. Address those.

Fixes 1883a934e156 ("dt-bindings: usb: convert keystone-usb.txt to YAML")

---

Changelog:
v2
- don't use quotes for enum/const string
- use phandle instead of phandle-array for phys
- add maxItems for phy-names

 .../bindings/usb/ti,keystone-dwc3.yaml        | 50 ++++++++++++++-----
 1 file changed, 37 insertions(+), 13 deletions(-)
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +4 -3
index f127535feb0b..394e47d2f5d7 100644
@@ -11,64 +11,88 @@ maintainers:
 properties:
   compatible:
-    oneOf:
-      - const: "ti,keystone-dwc3"
-      - const: "ti,am654-dwc3"
+    items:
+      - enum:
+        - ti,keystone-dwc3
+        - ti,am654-dwc3
   reg:
     maxItems: 1

Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml maintainers: · line 26

Quoted 10 lines
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +8 -2
-    description: Address and length of the register set for the USB subsystem on
-      the SOC.
+
+  '#address-cells':
+    const: 1
+
+  '#size-cells':
+    const: 1
+
+  ranges: true

blank line

Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml maintainers: · line 34

Quoted 6 lines
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +1 -2
   interrupts:
     maxItems: 1
-    description: The irq number of this device that is used to interrupt the MPU.
-
   clocks:
+    $ref: /schemas/types.yaml#definitions/phandle-array

Common property. It already has a type and doesn't need to be redefined here.

Just "maxItems: 1" if it is a single clock is enough, or an 'items' list for each entry if more than 1.

Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml maintainers: · line 35

Quoted 1 line
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +0 -0
     description: Clock ID for USB functional clock.

Drop.

Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml maintainers: · line 44

Quoted 10 lines
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +7 -0
+  assigned-clocks:
+    $ref: /schemas/types.yaml#definitions/phandle-array
 
 
+
+  assigned-clock-parents:
+    $ref: /schemas/types.yaml#definitions/phandle-array
+
   power-domains:
+    $ref: /schemas/types.yaml#definitions/phandle-array

Same as 'clocks'.

Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml maintainers: · line 51

Quoted 6 lines
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +1 -0
     description: Should contain a phandle to a PM domain provider node
       and an args specifier containing the USB device id
       value. This property is as per the binding,
       Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
   phys:
+    $ref: /schemas/types.yaml#/definitions/phandle

Same as 'clocks'.

Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml maintainers: · line 60

Quoted 9 lines
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +2 -1
     description:
       PHY specifier for the USB3.0 PHY. Some SoCs need the USB3.0 PHY
       to be turned on before the controller.
       Documentation/devicetree/bindings/phy/phy-bindings.txt
   phy-names:
+    maxItems: 1
     items:
-      - const: "usb3-phy"
+      - const: usb3-phy

Don't need maxItems as that's implied by the length of 'items'.

Quoted 43 lines
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +14 -6
+
+  dma-coherent: true
-  dwc3:
+  dma-ranges: true
+
+patternProperties:
+  "usb@[a-f0-9]+$":
+    type: object
     description: This is the node representing the DWC3 controller instance
       Documentation/devicetree/bindings/usb/dwc3.txt
 required:
   - compatible
   - reg
+  - "#address-cells"
+  - "#size-cells"
+  - ranges
   - interrupts
-  - clocks
+
+additionalProperties: false
 examples:
   - |
     #include <dt-bindings/interrupt-controller/arm-gic.h>
-    usb: usb@2680000 {
+    dwc3@2680000 {
       compatible = "ti,keystone-dwc3";
       #address-cells = <1>;
       #size-cells = <1>;
       reg = <0x2680000 0x10000>;
       clocks = <&clkusb>;
-      clock-names = "usb";
       interrupts = <GIC_SPI 393 IRQ_TYPE_EDGE_RISING>;
       ranges;
-      dwc3@2690000 {
+      usb@2690000 {
         compatible = "synopsys,dwc3";
         reg = <0x2690000 0x70000>;
         interrupts = <GIC_SPI 393 IRQ_TYPE_EDGE_RISING>;
-- 

Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki. Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki

#3 lore raw

Hi,

Quoted 37 lines · Rob Herring
Quoted 36 lines · Roger Quadros

There were some review comments after the patch was integrated. Address those.

Fixes 1883a934e156 ("dt-bindings: usb: convert keystone-usb.txt to YAML")

---

Changelog:
v2
- don't use quotes for enum/const string
- use phandle instead of phandle-array for phys
- add maxItems for phy-names

  .../bindings/usb/ti,keystone-dwc3.yaml        | 50 ++++++++++++++-----
  1 file changed, 37 insertions(+), 13 deletions(-)
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +6 -5
index f127535feb0b..394e47d2f5d7 100644
@@ -11,64 +11,88 @@ maintainers:
  properties:
    compatible:
-    oneOf:
-      - const: "ti,keystone-dwc3"
-      - const: "ti,am654-dwc3"
+    items:
+      - enum:
+        - ti,keystone-dwc3
+        - ti,am654-dwc3
    reg:
      maxItems: 1
-    description: Address and length of the register set for the USB subsystem on
-      the SOC.
+
+  '#address-cells':
Quoted 8 lines

Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml maintainers: · line 28

Quoted 6 lines
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +6 -0
+    const: 1
+
+  '#size-cells':
+    const: 1
+
+  ranges: true

blank line

There is a blank line before interrupts.

Quoted 8 lines

Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml maintainers: · line 34

Quoted 7 lines
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +1 -2
    interrupts:
      maxItems: 1
-    description: The irq number of this device that is used to interrupt the MPU.
-
    clocks:
+    $ref: /schemas/types.yaml#definitions/phandle-array
Quoted 5 lines

Common property. It already has a type and doesn't need to be redefined here.

Just "maxItems: 1" if it is a single clock is enough, or an 'items' list for each entry if more than 1.

Some nodes need 1 and some need 2. So "minItems: 1" and "maxItems: 2"? The driver doesn't really care, and relies of device/clock framework to just set the right clock parent.

In this case do I need to add items list?

cheers,
-roger

Quoted 82 lines

Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml maintainers: · line 35

Quoted 2 lines
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +0 -0
      description: Clock ID for USB functional clock.

Drop.

Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml maintainers: · line 44

Quoted 10 lines
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +7 -0
+  assigned-clocks:
+    $ref: /schemas/types.yaml#definitions/phandle-array
 
 
+
+  assigned-clock-parents:
+    $ref: /schemas/types.yaml#definitions/phandle-array
+
    power-domains:
+    $ref: /schemas/types.yaml#definitions/phandle-array

Same as 'clocks'.

Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml maintainers: · line 51

Quoted 6 lines
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +1 -0
      description: Should contain a phandle to a PM domain provider node
        and an args specifier containing the USB device id
        value. This property is as per the binding,
        Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
    phys:
+    $ref: /schemas/types.yaml#/definitions/phandle

Same as 'clocks'.

Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml maintainers: · line 60

Quoted 9 lines
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +2 -1
      description:
        PHY specifier for the USB3.0 PHY. Some SoCs need the USB3.0 PHY
        to be turned on before the controller.
        Documentation/devicetree/bindings/phy/phy-bindings.txt
    phy-names:
+    maxItems: 1
      items:
-      - const: "usb3-phy"
+      - const: usb3-phy

Don't need maxItems as that's implied by the length of 'items'.

Quoted 43 lines
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +14 -6
+
+  dma-coherent: true
-  dwc3:
+  dma-ranges: true
+
+patternProperties:
+  "usb@[a-f0-9]+$":
+    type: object
      description: This is the node representing the DWC3 controller instance
        Documentation/devicetree/bindings/usb/dwc3.txt
  required:
    - compatible
    - reg
+  - "#address-cells"
+  - "#size-cells"
+  - ranges
    - interrupts
-  - clocks
+
+additionalProperties: false
  examples:
    - |
      #include <dt-bindings/interrupt-controller/arm-gic.h>
-    usb: usb@2680000 {
+    dwc3@2680000 {
        compatible = "ti,keystone-dwc3";
        #address-cells = <1>;
        #size-cells = <1>;
        reg = <0x2680000 0x10000>;
        clocks = <&clkusb>;
-      clock-names = "usb";
        interrupts = <GIC_SPI 393 IRQ_TYPE_EDGE_RISING>;
        ranges;
-      dwc3@2690000 {
+      usb@2690000 {
          compatible = "synopsys,dwc3";
          reg = <0x2690000 0x70000>;
          interrupts = <GIC_SPI 393 IRQ_TYPE_EDGE_RISING>;
-- 

Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki. Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki

Signature · 2 lines
Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki.
Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki