Skip to contentSkip to conversation

dt-bindings: mfd: omap-usb-tll: convert to YAML

PATCH Superseded Karol Przybylski 4 participants 4 messages Nov 14, 2024 – Nov 18, 2024

Subsystems (2)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 dt-bindings: mfd: omap-usb-tll: convert to YAML

Conversion of omap-usb-tll.txt into yaml format, inspired by discussion in [1]

All feedback greatly appreciated, especially about what to put in 'maintainer'

1 - https://lore.kernel.org/all/[email protected]/

---
 .../devicetree/bindings/mfd/omap-usb-tll.txt  | 27 ----------
 .../devicetree/bindings/mfd/omap-usb-tll.yaml | 51 +++++++++++++++++++
 2 files changed, 51 insertions(+), 27 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/mfd/omap-usb-tll.txt
 create mode 100644 Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml
Documentation/devicetree/bindings/mfd/omap-usb-tll.txt deleted +0 -27
deleted file mode 100644
index c58d70437fce..000000000000
@@ -1,27 +0,0 @@
-OMAP HS USB Host TLL (Transceiver-Less Interface)
-
-Required properties:
-
-- compatible : should be "ti,usbhs-tll"
-- reg : should contain one register range i.e. start and length
-- interrupts : should contain the TLL module's interrupt
-- ti,hwmod : must contain "usb_tll_hs"
-
-Optional properties:
-
-- clocks: a list of phandles and clock-specifier pairs, one for each entry in
-  clock-names.
-
-- clock-names: should include:
-  * "usb_tll_hs_usb_ch0_clk" - USB TLL channel 0 clock
-  * "usb_tll_hs_usb_ch1_clk" - USB TLL channel 1 clock
-  * "usb_tll_hs_usb_ch2_clk" - USB TLL channel 2 clock
-
-Example:
-
-	usbhstll: usbhstll@4a062000 {
-		compatible = "ti,usbhs-tll";
-		reg = <0x4a062000 0x1000>;
-		interrupts = <78>;
-		ti,hwmods = "usb_tll_hs";
-	  };
Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml new file +51 -0

51 lines not on this page · raw message

Signature · 1 line
2.34.1
#1 lore raw

Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml line 4

Quoted 10 lines · Karol Przybylski
Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml new file +4 -0
new file mode 100644
index 000000000000..f49417d1faf7
@@ -0,0 +1,51 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/omap-usb-tll.yaml#

ti,usbhs-tll.yaml as the filename please.

Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml line 10

Quoted 6 lines
Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml new file +6 -0
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: OMAP HS USB Host TLL (Transceiver-Less Interface)
+
+maintainers:
+  - <[email protected]>

Put whoever the original author of the binding was here, failing that probably the platform maintainers for omap.

Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml line 23

Quoted 13 lines
Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml new file +13 -0
+
+properties:
+  compatible:
+    enum:
+      - ti,usbhs-tll
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  ti,hwmod:

Pretty sure you need a type here:
$ref: /schemas/types.yaml#/definitions/string

Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml line 27

Quoted 4 lines
Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml new file +4 -0
+    const: usb_tll_hs
+
+  clocks:
+    minItems: 2

Please add an items list here for each clock with a description.

Where did the minItems: 2 come from? The text binding suggests that 1 would be valid.

Cheers,
Conor.

Quoted 27 lines
Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml new file +24 -0
+
+  clock-names:
+    items:
+      - const: usb_tll_hs_usb_ch0_clk
+      - const: usb_tll_hs_usb_ch1_clk
+      - const: usb_tll_hs_usb_ch2_clk
+    minItems: 2
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - ti,hwmod
+
+additionalProperties: false
+
+examples:
+  - |
+    usbhstll@4a062000 {
+      compatible = "ti,usbhs-tll";
+      reg = <0x4a062000 0x1000>;
+      interrupts = <78>;
+      ti,hwmod = "usb_tll_hs";
+    };
Signature · 1 line
2.34.1
#2 lore raw
In reply to Karol Przybylski

Am Thu, 14 Nov 2024 19:58:30 +0100
schrieb Karol Przybylski <[email protected]>:

Quoted 54 lines

Conversion of omap-usb-tll.txt into yaml format, inspired by discussion in [1]

All feedback greatly appreciated, especially about what to put in 'maintainer'

1 - https://lore.kernel.org/all/[email protected]/

---
 .../devicetree/bindings/mfd/omap-usb-tll.txt  | 27 ----------
 .../devicetree/bindings/mfd/omap-usb-tll.yaml | 51 +++++++++++++++++++
 2 files changed, 51 insertions(+), 27 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/mfd/omap-usb-tll.txt
 create mode 100644 Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml
Documentation/devicetree/bindings/mfd/omap-usb-tll.txt deleted +0 -27
deleted file mode 100644
index c58d70437fce..000000000000
@@ -1,27 +0,0 @@
-OMAP HS USB Host TLL (Transceiver-Less Interface)
-
-Required properties:
-
-- compatible : should be "ti,usbhs-tll"
-- reg : should contain one register range i.e. start and length
-- interrupts : should contain the TLL module's interrupt
-- ti,hwmod : must contain "usb_tll_hs"
-
-Optional properties:
-
-- clocks: a list of phandles and clock-specifier pairs, one for each entry in
-  clock-names.
-
-- clock-names: should include:
-  * "usb_tll_hs_usb_ch0_clk" - USB TLL channel 0 clock
-  * "usb_tll_hs_usb_ch1_clk" - USB TLL channel 1 clock
-  * "usb_tll_hs_usb_ch2_clk" - USB TLL channel 2 clock
-
-Example:
-
-	usbhstll: usbhstll@4a062000 {
-		compatible = "ti,usbhs-tll";
-		reg = <0x4a062000 0x1000>;
-		interrupts = <78>;
-		ti,hwmods = "usb_tll_hs";
-	  };
Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml new file +1 -0
new file mode 100644
index 000000000000..f49417d1faf7
@@ -0,0 +1,51 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml line 11

Quoted 10 lines
Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml new file +10 -0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/omap-usb-tll.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: OMAP HS USB Host TLL (Transceiver-Less Interface)
+
+maintainers:
+  - <[email protected]>
+

Roger?

Quoted 19 lines
Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml new file +19 -0
+properties:
+  compatible:
+    enum:
+      - ti,usbhs-tll
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  ti,hwmod:
+    const: usb_tll_hs
+
+  clocks:
+    minItems: 2
+
+  clock-names:
+    items:

Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml line 40

Quoted 10 lines
Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml new file +10 -0
+      - const: usb_tll_hs_usb_ch0_clk
+      - const: usb_tll_hs_usb_ch1_clk
+      - const: usb_tll_hs_usb_ch2_clk
+    minItems: 2
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - ti,hwmod

keeping the binding in pace with reality... ti,hwmod should be deprecated.

Regards,
Andreas

#3 lore raw
Quoted 60 lines · Andreas Kemnade

Am Thu, 14 Nov 2024 19:58:30 +0100
schrieb Karol Przybylski <[email protected]>:

Quoted 57 lines

Conversion of omap-usb-tll.txt into yaml format, inspired by discussion in [1]

All feedback greatly appreciated, especially about what to put in 'maintainer'

1 - https://lore.kernel.org/all/[email protected]/

---
 .../devicetree/bindings/mfd/omap-usb-tll.txt  | 27 ----------
 .../devicetree/bindings/mfd/omap-usb-tll.yaml | 51 +++++++++++++++++++
 2 files changed, 51 insertions(+), 27 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/mfd/omap-usb-tll.txt
 create mode 100644 Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml
Documentation/devicetree/bindings/mfd/omap-usb-tll.txt deleted +0 -27
deleted file mode 100644
index c58d70437fce..000000000000
@@ -1,27 +0,0 @@
-OMAP HS USB Host TLL (Transceiver-Less Interface)
-
-Required properties:
-
-- compatible : should be "ti,usbhs-tll"
-- reg : should contain one register range i.e. start and length
-- interrupts : should contain the TLL module's interrupt
-- ti,hwmod : must contain "usb_tll_hs"
-
-Optional properties:
-
-- clocks: a list of phandles and clock-specifier pairs, one for each entry in
-  clock-names.
-
-- clock-names: should include:
-  * "usb_tll_hs_usb_ch0_clk" - USB TLL channel 0 clock
-  * "usb_tll_hs_usb_ch1_clk" - USB TLL channel 1 clock
-  * "usb_tll_hs_usb_ch2_clk" - USB TLL channel 2 clock
-
-Example:
-
-	usbhstll: usbhstll@4a062000 {
-		compatible = "ti,usbhs-tll";
-		reg = <0x4a062000 0x1000>;
-		interrupts = <78>;
-		ti,hwmods = "usb_tll_hs";
-	  };
Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml new file +4 -0
new file mode 100644
index 000000000000..f49417d1faf7
@@ -0,0 +1,51 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mfd/omap-usb-tll.yaml#
Quoted 8 lines

Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml line 11

Quoted 7 lines
Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml new file +7 -0
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: OMAP HS USB Host TLL (Transceiver-Less Interface)
+
+maintainers:
+  - <[email protected]>
+

Roger?

Sure, but I do not have any board to test this.

Quoted 36 lines
Quoted 20 lines
Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml new file +19 -0
+properties:
+  compatible:
+    enum:
+      - ti,usbhs-tll
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  ti,hwmod:
+    const: usb_tll_hs
+
+  clocks:
+    minItems: 2
+
+  clock-names:
+    items:

Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml line 40

Quoted 10 lines
Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml new file +10 -0
+      - const: usb_tll_hs_usb_ch0_clk
+      - const: usb_tll_hs_usb_ch1_clk
+      - const: usb_tll_hs_usb_ch2_clk
+    minItems: 2
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - ti,hwmod

keeping the binding in pace with reality... ti,hwmod should be deprecated.

Regards,
Andreas

Signature · 2 lines
cheers,
-roger