linux-kernel - Re: [PATCH 1/2] spi: dt-binding: add Microchip CoreQSPI compatible

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <dab84439-9d09-c7d1-35ab-ea02d69d40ec@linaro.org>
Date:   Wed, 3 Aug 2022 09:48:18 +0200
From:   Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
To:     naga sureshkumar <nagasuresh12@...il.com>
Cc:     Mark Brown <broonie@...nel.org>,
        Naga Sureshkumar Relli <nagasuresh.relli@...rochip.com>,
        robh+dt@...nel.org, krzysztof.kozlowski+dt@...aro.org,
        conor.dooley@...rochip.com, linux-spi@...r.kernel.org,
        devicetree@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 1/2] spi: dt-binding: add Microchip CoreQSPI compatible

On 03/08/2022 08:59, naga sureshkumar wrote:
> Hi Krzysztof,
> 
> On Wed, Aug 3, 2022 at 11:42 AM Krzysztof Kozlowski
> <krzysztof.kozlowski@...aro.org> wrote:
>>
>> On 02/08/2022 15:13, Mark Brown wrote:
>>> On Tue, Aug 02, 2022 at 10:52:25AM +0200, Krzysztof Kozlowski wrote:
>>>> On 01/08/2022 11:42, Naga Sureshkumar Relli wrote:
>>>
>>>>> -    enum:
>>>>> -      - microchip,mpfs-spi
>>>>> -      - microchip,mpfs-qspi
>>>>> +    oneOf:
>>>>> +      - description: Microchip's Polarfire SoC SPI controller.
>>>>> +        const: microchip,mpfs-spi
>>>>> +      - description: Microchip's Polarfire SoC QSPI controller.
>>>
>>>> Useless descriptions - they repeat compatible. Just keep it as enum and
>>>> skip descriptions. What value do they bring?
>>>
>>> Someone not familiar with the full Microchip product line might not be
>>> aware of the expansion of mpfs, it's not blindingly obvious.
>>
>> Then it should be explained in title/description of the binding, not in
>> compatible. This is the usual way of providing some text description,
>> not for each compatible by repeating the compatible text.
> Ok. In the next version I will update the bindings like below
> 
> -title: Microchip MPFS {Q,}SPI Controller Device Tree Bindings
> +title: Microchip FPGA {Q,}SPI Controllers
> +
> +description:
> +  SPI and QSPI controllers on the Microchip PolarFire SoC and they are based
> + on the "soft"  fabric IP cores.
>  oneOf:
>        - items:
> +          - const: microchip,mpfs-qspi
> +          - const: microchip,coreqspi-rtl-v2

This piece should have its own explanation and preferably in its own
commit. As I mentioned before, you change existing compatible so it
should be explained.

Best regards,
Krzysztof