Re: [PATCH 1/3] dt-bindings: mtd: ti,elm: Convert to yaml

[Roger Quadros <rogerq@kernel.org>]

Hi Krzysztof,

On 24/03/2022 20:24, Krzysztof Kozlowski wrote:
> On 23/03/2022 12:18, Roger Quadros wrote:
>> Convert elm.txt to ti,elm.yaml.
>>
>> Signed-off-by: Roger Quadros <rogerq@kernel.org>
>> ---
>>  Documentation/devicetree/bindings/mtd/elm.txt | 16 -------
>>  .../devicetree/bindings/mtd/ti,elm.yaml       | 48 +++++++++++++++++++
>>  2 files changed, 48 insertions(+), 16 deletions(-)
>>  delete mode 100644 Documentation/devicetree/bindings/mtd/elm.txt
>>  create mode 100644 Documentation/devicetree/bindings/mtd/ti,elm.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/mtd/elm.txt b/Documentation/devicetree/bindings/mtd/elm.txt
>> deleted file mode 100644
>> index 59ddc61c1076..000000000000
>> --- a/Documentation/devicetree/bindings/mtd/elm.txt
>> +++ /dev/null
>> @@ -1,16 +0,0 @@
>> -Error location module
>> -
>> -Required properties:
>> -- compatible: Must be "ti,am3352-elm"
>> -- reg: physical base address and size of the registers map.
>> -- interrupts: Interrupt number for the elm.
>> -
>> -Optional properties:
>> -- ti,hwmods: Name of the hwmod associated to the elm
>> -
>> -Example:
>> -elm: elm@0 {
>> -	compatible = "ti,am3352-elm";
>> -	reg = <0x48080000 0x2000>;
>> -	interrupts = <4>;
>> -};
>> diff --git a/Documentation/devicetree/bindings/mtd/ti,elm.yaml b/Documentation/devicetree/bindings/mtd/ti,elm.yaml
>> new file mode 100644
>> index 000000000000..24ed0fb84204
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/mtd/ti,elm.yaml
>> @@ -0,0 +1,48 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/mtd/ti,elm.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Texas Instruments Error Location Module (ELM).
>> +
>> +maintainers:
>> +  - Roger Quadros <rogerq@kernel.org>
>> +
>> +description:
>> +  ELM module is used together with GPMC and NAND Flash to detect
>> +  errors and the location of the error based on BCH algorithms
>> +  so they can be corrected if possible.
>> +
>> +properties:
>> +  compatible:
>> +    items:
> 
> No items, just const.

OK.

> 
>> +      - const: ti,am3352-elm
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  interrupts:
>> +    maxItems: 1
>> +
>> +  ti,hwmods:
>> +    description:
>> +      Name of the HWMOD associated with ELM. This is for legacy
>> +      platforms only.
>> +    $ref: /schemas/types.yaml#/definitions/string
>> +    deprecated: true
> 
> It was not deprecated before. Could you explain it in commit msg because
> it is not a conversion only.

OK I will mention that hwmod usage is not recommended for new platforms.

> 
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - interrupts
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    elm: elm@0 {
> 
> This is error correction, right? So generic node name "ecc"?
> 
>> +        compatible = "ti,am3352-elm";
>> +        reg = <0x0 0x2000>;
>> +        interrupts = <4>;
>> +    };
> 
> 
> Best regards,
> Krzysztof

cheers,
-roger