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

[PATCH] dt-bindings: mfd: omap-usb-tll: convert to YAML

Posted by Karol Przybylski 1 week, 1 day ago

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/cd915c18-7230-4c38-a860-d2a777223147@kernel.org/

Signed-off-by: Karol Przybylski <karprzy7@gmail.com>
---
 .../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

diff --git a/Documentation/devicetree/bindings/mfd/omap-usb-tll.txt b/Documentation/devicetree/bindings/mfd/omap-usb-tll.txt
deleted file mode 100644
index c58d70437fce..000000000000
--- a/Documentation/devicetree/bindings/mfd/omap-usb-tll.txt
+++ /dev/null
@@ -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";
-	  };
diff --git a/Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml b/Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml
new file mode 100644
index 000000000000..f49417d1faf7
--- /dev/null
+++ b/Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml
@@ -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#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: OMAP HS USB Host TLL (Transceiver-Less Interface)
+
+maintainers:
+  - <maintainer@kernel.org>
+
+properties:
+  compatible:
+    enum:
+      - ti,usbhs-tll
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  ti,hwmod:
+    const: usb_tll_hs
+
+  clocks:
+    minItems: 2
+
+  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";
+    };
-- 
2.34.1

Re: [PATCH] dt-bindings: mfd: omap-usb-tll: convert to YAML

Posted by Andreas Kemnade 1 week ago

Am Thu, 14 Nov 2024 19:58:30 +0100
schrieb Karol Przybylski <karprzy7@gmail.com>:

> 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/cd915c18-7230-4c38-a860-d2a777223147@kernel.org/
> 
> Signed-off-by: Karol Przybylski <karprzy7@gmail.com>
> ---
>  .../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
> 
> diff --git a/Documentation/devicetree/bindings/mfd/omap-usb-tll.txt b/Documentation/devicetree/bindings/mfd/omap-usb-tll.txt
> deleted file mode 100644
> index c58d70437fce..000000000000
> --- a/Documentation/devicetree/bindings/mfd/omap-usb-tll.txt
> +++ /dev/null
> @@ -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";
> -	  };
> diff --git a/Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml b/Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml
> new file mode 100644
> index 000000000000..f49417d1faf7
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml
> @@ -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#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: OMAP HS USB Host TLL (Transceiver-Less Interface)
> +
> +maintainers:
> +  - <maintainer@kernel.org>
> +
Roger? 

> +properties:
> +  compatible:
> +    enum:
> +      - ti,usbhs-tll
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  ti,hwmod:
> +    const: usb_tll_hs
> +
> +  clocks:
> +    minItems: 2
> +
> +  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

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

Regards,
Andreas

Re: [PATCH] dt-bindings: mfd: omap-usb-tll: convert to YAML

Posted by Roger Quadros 4 days, 9 hours ago


On 15/11/2024 22:05, Andreas Kemnade wrote:
> Am Thu, 14 Nov 2024 19:58:30 +0100
> schrieb Karol Przybylski <karprzy7@gmail.com>:
> 
>> 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/cd915c18-7230-4c38-a860-d2a777223147@kernel.org/
>>
>> Signed-off-by: Karol Przybylski <karprzy7@gmail.com>
>> ---
>>  .../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
>>
>> diff --git a/Documentation/devicetree/bindings/mfd/omap-usb-tll.txt b/Documentation/devicetree/bindings/mfd/omap-usb-tll.txt
>> deleted file mode 100644
>> index c58d70437fce..000000000000
>> --- a/Documentation/devicetree/bindings/mfd/omap-usb-tll.txt
>> +++ /dev/null
>> @@ -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";
>> -	  };
>> diff --git a/Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml b/Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml
>> new file mode 100644
>> index 000000000000..f49417d1faf7
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml
>> @@ -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#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: OMAP HS USB Host TLL (Transceiver-Less Interface)
>> +
>> +maintainers:
>> +  - <maintainer@kernel.org>
>> +
> Roger? 

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

> 
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - ti,usbhs-tll
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  interrupts:
>> +    maxItems: 1
>> +
>> +  ti,hwmod:
>> +    const: usb_tll_hs
>> +
>> +  clocks:
>> +    minItems: 2
>> +
>> +  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
> 
> keeping the binding in pace with reality... ti,hwmod should
> be deprecated. 
> 
> Regards,
> Andreas

-- 
cheers,
-roger

Re: [PATCH] dt-bindings: mfd: omap-usb-tll: convert to YAML

Posted by Conor Dooley 1 week ago

On Thu, Nov 14, 2024 at 07:58:30PM +0100, Karol Przybylski wrote:
> diff --git a/Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml b/Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml
> new file mode 100644
> index 000000000000..f49417d1faf7
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/omap-usb-tll.yaml
> @@ -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.

> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: OMAP HS USB Host TLL (Transceiver-Less Interface)
> +
> +maintainers:
> +  - <maintainer@kernel.org>

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

> +
> +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

> +    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.

> +
> +  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";
> +    };
> -- 
> 2.34.1
>