linux-kernel - Re: [PATCH] dt-bindings: rtc: mcp795: convert to YAML

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] [day] [month] [year] [list]

Message-ID: <808e0a07-9bba-0499-564f-83872101a19a@wolfvision.net>
Date:   Wed, 6 Sep 2023 13:48:16 +0200
From:   Javier Carrasco <javier.carrasco@...fvision.net>
To:     Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>,
        Javier Carrasco <javier.carrasco.cruz@...il.com>,
        Alessandro Zummo <a.zummo@...ertech.it>,
        Alexandre Belloni <alexandre.belloni@...tlin.com>,
        Rob Herring <robh+dt@...nel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@...aro.org>,
        Conor Dooley <conor+dt@...nel.org>,
        Emil Bartczak <emilbart@...il.com>,
        Josef Gajdusek <atx@....name>
Cc:     linux-rtc@...r.kernel.org, devicetree@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] dt-bindings: rtc: mcp795: convert to YAML

Hi Krzysztof,

On 06.09.23 12:42, Krzysztof Kozlowski wrote:
> On 06/09/2023 12:23, Javier Carrasco wrote:
>> Convert the MCP795 bindings from text to YAML format to support bindings
>> validation.
>>
>> Signed-off-by: Javier Carrasco <javier.carrasco.cruz@...il.com>
>> ---
>> YAML is the preferred format for dt-bindings, which allows validation.
>> ---
>>  .../devicetree/bindings/rtc/maxim,mcp795.txt       | 11 -------
>>  .../devicetree/bindings/rtc/maxim,mcp795.yaml      | 35 ++++++++++++++++++++++
>>  2 files changed, 35 insertions(+), 11 deletions(-)
>>
>> diff --git a/Documentation/devicetree/bindings/rtc/maxim,mcp795.txt b/Documentation/devicetree/bindings/rtc/maxim,mcp795.txt
>> deleted file mode 100644
>> index a59fdd8c236d..000000000000
>> --- a/Documentation/devicetree/bindings/rtc/maxim,mcp795.txt
>> +++ /dev/null
>> @@ -1,11 +0,0 @@
>> -* Maxim MCP795		SPI Serial Real-Time Clock
>> -
>> -Required properties:
>> -- compatible: Should contain "maxim,mcp795".
>> -- reg: SPI address for chip
>> -
>> -Example:
>> -	mcp795: rtc@0 {
>> -		compatible = "maxim,mcp795";
>> -		reg = <0>;
>> -	};
>> diff --git a/Documentation/devicetree/bindings/rtc/maxim,mcp795.yaml b/Documentation/devicetree/bindings/rtc/maxim,mcp795.yaml
>> new file mode 100644
>> index 000000000000..77e465747d43
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/rtc/maxim,mcp795.yaml
>> @@ -0,0 +1,35 @@
>> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/rtc/maxim,mcp795.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Maxim MCP795 SPI Serial Real Time Clock
>> +
>> +allOf:
>> +  - $ref: rtc.yaml#
> 
> Nit: By convention, this goes after maintainers/description.
> 
>> +
>> +maintainers:
>> +  - Josef Gajdusek <atx@....name>
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - maxim,mcp795
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +
>> +additionalProperties: false
> 
> This should be unevaluatedProperties:false, so you allow other common
> RTC properties. But then, it is even smaller than trivial RTC devices, so:
> 1. What about interrupts? No interrupt line?
> 2. If there is interrupt line, just add it to trivial-rtc. Otherwise,
> it's fine here with changes above.
> 
> Best regards,
> Krzysztof
> 
The RTC has indeed an interrupt line and I just checked that the driver
supports it. Apparently the functionality was added later but never
documented.
The interrupt is optional and therefore it is a perfect candidate to get
into trivial-rtc in v2.

Thanks and best regards,
Javier Carrasco