diff mbox series

[v2,1/8] dt-bindings: marvell: a38x: convert the soc compatibles description to yaml

Message ID 20231224143750.5604-2-josua@solid-run.com (mailing list archive)
State New, archived
Headers show
Series arm: dts: marvell: clearfog-gtr: miscellaneous enhancements | expand

Commit Message

Josua Mayer Dec. 24, 2023, 2:37 p.m. UTC
Convert the existing txt binding for armada-38x socs to DT schema
format.

Signed-off-by: Josua Mayer <josua@solid-run.com>
---
 .../bindings/arm/marvell/armada-38x.txt       | 27 ---------------
 .../bindings/arm/marvell/armada-38x.yaml      | 33 +++++++++++++++++++
 2 files changed, 33 insertions(+), 27 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/arm/marvell/armada-38x.txt
 create mode 100644 Documentation/devicetree/bindings/arm/marvell/armada-38x.yaml

Comments

Krzysztof Kozlowski Dec. 24, 2023, 2:57 p.m. UTC | #1
On 24/12/2023 15:37, Josua Mayer wrote:
> Convert the existing txt binding for armada-38x socs to DT schema
> format.
> 
> Signed-off-by: Josua Mayer <josua@solid-run.com>

Please use scripts/get_maintainers.pl to get a list of necessary people
and lists to CC. It might happen, that command when run on an older
kernel, gives you outdated entries. Therefore please be sure you base
your patches on recent Linux kernel.

You missed at least devicetree list (maybe more), so this won't be
tested by automated tooling. Performing review on untested code might be
a waste of time, thus I will skip this patch entirely till you follow
the process allowing the patch to be tested.

Please kindly resend and include all necessary To/Cc entries.

> +
> +properties:
> +  $nodename:
> +    const: '/'
> +  compatible:
> +    oneOf:
> +
> +      - description: Armada 380 SoC
> +        items:
> +          - const: marvell,armada380
> +
> +      - description: Armada 385 SoC
> +        items:
> +          - const: marvell,armada385
> +          - const: marvell,armada380
> +
> +      - description: Armada 388 SoC
> +        items:
> +          - const: marvell,armada388
> +          - const: marvell,armada385
> +          - const: marvell,armada380

These should not be used alone, so such schema is not what we want. We
want boards to be documented with these SoCs.

Best regards,
Krzysztof
Josua Mayer Dec. 24, 2023, 3:45 p.m. UTC | #2
Am 24.12.23 um 15:57 schrieb Krzysztof Kozlowski:
> On 24/12/2023 15:37, Josua Mayer wrote:
>> Convert the existing txt binding for armada-38x socs to DT schema
>> format.
>>
>> Signed-off-by: Josua Mayer <josua@solid-run.com>
> Please use scripts/get_maintainers.pl to get a list of necessary people
> and lists to CC. It might happen, that command when run on an older
> kernel, gives you outdated entries. Therefore please be sure you base
> your patches on recent Linux kernel.
>
> You missed at least devicetree list (maybe more), so this won't be
> tested by automated tooling. Performing review on untested code might be
> a waste of time, thus I will skip this patch entirely till you follow
> the process allowing the patch to be tested.
>
> Please kindly resend and include all necessary To/Cc entries.
I am sorry ...
I will verify what get_maintainers said ...

https://www.kernel.org/doc/html/latest/process/submitting-patches.html#select-the-recipients-for-your-patch
I got confused from this guide - what to do when it tells me 3 or more 
lists.
Should I take the most specific one? Or all of them? I.e.:

linux-arm-kernel@lists.infradead.org (moderated list:ARM/Marvell 
Kirkwood and Armada 370, 375, 38x,...)
devicetree@vger.kernel.org (open list:OPEN FIRMWARE AND FLATTENED DEVICE 
TREE BINDINGS)
linux-kernel@vger.kernel.org (open list)

>
>> +
>> +properties:
>> +  $nodename:
>> +    const: '/'
>> +  compatible:
>> +    oneOf:
>> +
>> +      - description: Armada 380 SoC
>> +        items:
>> +          - const: marvell,armada380
>> +
>> +      - description: Armada 385 SoC
>> +        items:
>> +          - const: marvell,armada385
>> +          - const: marvell,armada380
>> +
>> +      - description: Armada 388 SoC
>> +        items:
>> +          - const: marvell,armada388
>> +          - const: marvell,armada385
>> +          - const: marvell,armada380
> These should not be used alone, so such schema is not what we want. We
> want boards to be documented with these SoCs.
There is only one Marvell example for armada-8k:
Documentation/devicetree/bindings/arm/marvell/armada-7k-8k.yaml

I mirrored how that conversion had been done from text to yaml.
If only boards belong in the yaml, then the conversion from txt will 
create an empty file,
to which I could then add specific boards on top.

>
> Best regards,
> Krzysztof
>
sincerely
Josua Mayer
Krzysztof Kozlowski Dec. 24, 2023, 3:52 p.m. UTC | #3
On 24/12/2023 16:45, Josua Mayer wrote:
> Am 24.12.23 um 15:57 schrieb Krzysztof Kozlowski:
>> On 24/12/2023 15:37, Josua Mayer wrote:
>>> Convert the existing txt binding for armada-38x socs to DT schema
>>> format.
>>>
>>> Signed-off-by: Josua Mayer <josua@solid-run.com>
>> Please use scripts/get_maintainers.pl to get a list of necessary people
>> and lists to CC. It might happen, that command when run on an older
>> kernel, gives you outdated entries. Therefore please be sure you base
>> your patches on recent Linux kernel.
>>
>> You missed at least devicetree list (maybe more), so this won't be
>> tested by automated tooling. Performing review on untested code might be
>> a waste of time, thus I will skip this patch entirely till you follow
>> the process allowing the patch to be tested.
>>
>> Please kindly resend and include all necessary To/Cc entries.
> I am sorry ...
> I will verify what get_maintainers said ...
> 
> https://www.kernel.org/doc/html/latest/process/submitting-patches.html#select-the-recipients-for-your-patch
> I got confused from this guide - what to do when it tells me 3 or more 
> lists.
> Should I take the most specific one? Or all of them? I.e.:
> 
> linux-arm-kernel@lists.infradead.org (moderated list:ARM/Marvell 
> Kirkwood and Armada 370, 375, 38x,...)
> devicetree@vger.kernel.org (open list:OPEN FIRMWARE AND FLATTENED DEVICE 
> TREE BINDINGS)
> linux-kernel@vger.kernel.org (open list)

The same what b4 and all scripts are doing: all lists. Why even
bothering in selective remove of people or lists?

> 
>>
>>> +
>>> +properties:
>>> +  $nodename:
>>> +    const: '/'
>>> +  compatible:
>>> +    oneOf:
>>> +
>>> +      - description: Armada 380 SoC
>>> +        items:
>>> +          - const: marvell,armada380
>>> +
>>> +      - description: Armada 385 SoC
>>> +        items:
>>> +          - const: marvell,armada385
>>> +          - const: marvell,armada380
>>> +
>>> +      - description: Armada 388 SoC
>>> +        items:
>>> +          - const: marvell,armada388
>>> +          - const: marvell,armada385
>>> +          - const: marvell,armada380
>> These should not be used alone, so such schema is not what we want. We
>> want boards to be documented with these SoCs.
> There is only one Marvell example for armada-8k:
> Documentation/devicetree/bindings/arm/marvell/armada-7k-8k.yaml
> 
> I mirrored how that conversion had been done from text to yaml.
> If only boards belong in the yaml, then the conversion from txt will 
> create an empty file,
> to which I could then add specific boards on top.


Marvell is a mess, someone should really take care about these files...

Best regards,
Krzysztof
Josua Mayer Dec. 24, 2023, 4:04 p.m. UTC | #4
Am 24.12.23 um 16:52 schrieb Krzysztof Kozlowski:
> On 24/12/2023 16:45, Josua Mayer wrote:
>> Am 24.12.23 um 15:57 schrieb Krzysztof Kozlowski:
>>> On 24/12/2023 15:37, Josua Mayer wrote:
>>>> Convert the existing txt binding for armada-38x socs to DT schema
>>>> format.
>>>>
>>>> Signed-off-by: Josua Mayer <josua@solid-run.com>
>>> Please use scripts/get_maintainers.pl to get a list of necessary people
>>> and lists to CC. It might happen, that command when run on an older
>>> kernel, gives you outdated entries. Therefore please be sure you base
>>> your patches on recent Linux kernel.
>>>
>>> You missed at least devicetree list (maybe more), so this won't be
>>> tested by automated tooling. Performing review on untested code might be
>>> a waste of time, thus I will skip this patch entirely till you follow
>>> the process allowing the patch to be tested.
>>>
>>> Please kindly resend and include all necessary To/Cc entries.
>> I am sorry ...
>> I will verify what get_maintainers said ...
>>
>> https://www.kernel.org/doc/html/latest/process/submitting-patches.html#select-the-recipients-for-your-patch
>> I got confused from this guide - what to do when it tells me 3 or more
>> lists.
>> Should I take the most specific one? Or all of them? I.e.:
>>
>> linux-arm-kernel@lists.infradead.org (moderated list:ARM/Marvell
>> Kirkwood and Armada 370, 375, 38x,...)
>> devicetree@vger.kernel.org (open list:OPEN FIRMWARE AND FLATTENED DEVICE
>> TREE BINDINGS)
>> linux-kernel@vger.kernel.org (open list)
> The same what b4 and all scripts are doing: all lists. Why even
> bothering in selective remove of people or lists?
Understood, thank you.
>
>>>> +
>>>> +properties:
>>>> +  $nodename:
>>>> +    const: '/'
>>>> +  compatible:
>>>> +    oneOf:
>>>> +
>>>> +      - description: Armada 380 SoC
>>>> +        items:
>>>> +          - const: marvell,armada380
>>>> +
>>>> +      - description: Armada 385 SoC
>>>> +        items:
>>>> +          - const: marvell,armada385
>>>> +          - const: marvell,armada380
>>>> +
>>>> +      - description: Armada 388 SoC
>>>> +        items:
>>>> +          - const: marvell,armada388
>>>> +          - const: marvell,armada385
>>>> +          - const: marvell,armada380
>>> These should not be used alone, so such schema is not what we want. We
>>> want boards to be documented with these SoCs.
>> There is only one Marvell example for armada-8k:
>> Documentation/devicetree/bindings/arm/marvell/armada-7k-8k.yaml
>>
>> I mirrored how that conversion had been done from text to yaml.
>> If only boards belong in the yaml, then the conversion from txt will
>> create an empty file,
>> to which I could then add specific boards on top.
>
> Marvell is a mess, someone should really take care about these files...
Okay ... so better to re-open discussion once I submit properly?
>
> Best regards,
> Krzysztof
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/arm/marvell/armada-38x.txt b/Documentation/devicetree/bindings/arm/marvell/armada-38x.txt
deleted file mode 100644
index 202953f1887e..000000000000
--- a/Documentation/devicetree/bindings/arm/marvell/armada-38x.txt
+++ /dev/null
@@ -1,27 +0,0 @@ 
-Marvell Armada 38x Platforms Device Tree Bindings
--------------------------------------------------
-
-Boards with a SoC of the Marvell Armada 38x family shall have the
-following property:
-
-Required root node property:
-
- - compatible: must contain "marvell,armada380"
-
-In addition, boards using the Marvell Armada 385 SoC shall have the
-following property before the previous one:
-
-Required root node property:
-
-compatible: must contain "marvell,armada385"
-
-In addition, boards using the Marvell Armada 388 SoC shall have the
-following property before the previous one:
-
-Required root node property:
-
-compatible: must contain "marvell,armada388"
-
-Example:
-
-compatible = "marvell,a385-rd", "marvell,armada385", "marvell,armada380";
diff --git a/Documentation/devicetree/bindings/arm/marvell/armada-38x.yaml b/Documentation/devicetree/bindings/arm/marvell/armada-38x.yaml
new file mode 100644
index 000000000000..5af222e6db18
--- /dev/null
+++ b/Documentation/devicetree/bindings/arm/marvell/armada-38x.yaml
@@ -0,0 +1,33 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/arm/marvell/armada-38x.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Marvell Armada 38x Platforms
+
+maintainers:
+  - Gregory CLEMENT <gregory.clement@bootlin.com>
+
+properties:
+  $nodename:
+    const: '/'
+  compatible:
+    oneOf:
+
+      - description: Armada 380 SoC
+        items:
+          - const: marvell,armada380
+
+      - description: Armada 385 SoC
+        items:
+          - const: marvell,armada385
+          - const: marvell,armada380
+
+      - description: Armada 388 SoC
+        items:
+          - const: marvell,armada388
+          - const: marvell,armada385
+          - const: marvell,armada380
+
+additionalProperties: true