Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <41cc4506-57be-a831-57d5-e539e8a95610@linaro.org>
Date:   Thu, 12 May 2022 14:36:15 +0200
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.8.1
Subject: Re: [PATCH v2 02/11] dt-bindings: marvell: convert Armada 37xx
 compatibles to YAML
Content-Language: en-US
To:     Robert Marko <robert.marko@sartura.hr>
Cc:     Rob Herring <robh+dt@kernel.org>,
        krzysztof.kozlowski+dt@linaro.org, Andrew Lunn <andrew@lunn.ch>,
        gregory.clement@bootlin.com, sebastian.hesselbarth@gmail.com,
        kostap@marvell.com, devicetree <devicetree@vger.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
        Linux ARM <linux-arm-kernel@lists.infradead.org>,
        =?UTF-8?Q?Pali_Roh=c3=a1r?= <pali@kernel.org>,
        =?UTF-8?Q?Marek_Beh=c3=ban?= <marek.behun@nic.cz>
References: <20220510124929.91000-1-robert.marko@sartura.hr>
 <20220510124929.91000-2-robert.marko@sartura.hr>
 <0815f581-ca5b-6fb6-a59e-f5d0a3686caa@linaro.org>
 <CA+HBbNFnXoEghSdhTYoC-VvCMkiEuuee9p8SuNGubYCeLWoYfA@mail.gmail.com>
From:   Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
In-Reply-To: <CA+HBbNFnXoEghSdhTYoC-VvCMkiEuuee9p8SuNGubYCeLWoYfA@mail.gmail.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 12/05/2022 14:26, Robert Marko wrote:
> On Wed, May 11, 2022 at 6:52 PM Krzysztof Kozlowski
> <krzysztof.kozlowski@linaro.org> wrote:
>>
>> On 10/05/2022 14:49, Robert Marko wrote:
>>
>> Thank you for your patch. There is something to discuss/improve.
>>
>>> -
>>> - - compatible: must contain "cznic,turris-mox"
>>> diff --git a/Documentation/devicetree/bindings/arm/marvell/armada-37xx.yaml b/Documentation/devicetree/bindings/arm/marvell/armada-37xx.yaml
>>> new file mode 100644
>>> index 000000000000..3f41ef2c6f3e
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/arm/marvell/armada-37xx.yaml
>>> @@ -0,0 +1,50 @@
>>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>>> +%YAML 1.2
>>> +---
>>> +$id: http://devicetree.org/schemas/arm/marvell/armada-37xx.yaml#
>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>> +
>>> +title: Marvell Armada 37xx Platforms Device Tree Bindings
>>> +
>>> +maintainers:
>>> +  - Robert Marko <robert.marko@sartura.hr>
>>> +
>>> +properties:
>>> +  $nodename:
>>> +    const: '/'
>>> +  compatible:
>>> +    oneOf:
>>> +      - description: Armada 3710 SoC
>>> +        items:
>>> +          - const: marvell,armada3710
>>
>> This does not look correct. The SoC usually cannot be used by itself,
>> it's always a part of some product, SoM, board.
> 
> Hi Krzysztof,
> Currently, there are no Armada 3710 boards present in Linux, so I just
> put the SoC compatible.
> If that is not appropriate, I can drop it.

Yes, please drop it.

It seems several Marvel boards and bindings use wrong convention for
compatibles. We discussed it here:
https://lore.kernel.org/all/1ed03960-77f6-1a9e-2378-07a6c51f42f7@linaro.org/
AC5 and CN9130 have the same wrong patterns.

> 
>>
>>> +
>>> +      - description: Armada 3720 SoC
>>> +        items:
>>> +          - enum:
>>> +              - marvell,armada-3720-db
>>> +              - globalscale,espressobin
>>> +              - cznic,turris-mox
>>> +              - methode,udpu
>>
>> Order by name.
> Will fixup in v3.
> 
>>
>>> +          - const: marvell,armada3720
>>> +          - const: marvell,armada3710
>>> +
>>> +      - description: Globalscale Espressobin boards
>>> +        items:
>>> +          - enum:
>>> +              - globalscale,espressobin-emmc
>>> +              - globalscale,espressobin-ultra
>>> +              - globalscale,espressobin-v7
>>> +          - const: globalscale,espressobin
>>> +          - const: marvell,armada3720
>>> +          - const: marvell,armada3710
> Do these const compatibles also need to be in alphabetical ordering,
> cause I ported them as they are meant to be used with the board and
> then 3720 compatibles being in front of 3710 one as required by the current
> text bindings.

Entries in enum should be ordered alphabetically. Then the entire set "-
description: Globalscale Espressobin boards" should have some logical
order, not necessarily by name.

Anyway this is not a requirement but rather suggestion because having
things ordered reduces amount of conflicts when two people add new
boards (because they add it not at the end, but somewhere in the middle
following some order).


Best regards,
Krzysztof