[PATCH v10 1/2] dt-bindings: edac: dmc-520.yaml

[PATCH v10 1/2] dt-bindings: edac: dmc-520.yaml

[Shiping Ji]

This is the device tree bindings for new EDAC driver dmc520_edac.c.

From: Lei Wang <leiwang_git@outlook.com>

Signed-off-by: Lei Wang <leiwang_git@outlook.com>
Signed-off-by: Shiping Ji <shiping.linux@gmail.com>
Reviewed-by: James Morse <james.morse@arm.com>

---
     Changes in v10:
         - Convert to the YAML format for binding description

---
 .../devicetree/bindings/edac/dmc-520.yaml     | 56 +++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/edac/dmc-520.yaml

diff --git a/Documentation/devicetree/bindings/edac/dmc-520.yaml b/Documentation/devicetree/bindings/edac/dmc-520.yaml
new file mode 100644
index 000000000000..dd5982b227b2
--- /dev/null
+++ b/Documentation/devicetree/bindings/edac/dmc-520.yaml
@@ -0,0 +1,56 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/edac/dmc-520.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ARM DMC-520 EDAC bindings
+
+maintainers:
+  - Lei Wang <lewan@microsoft.com>
+
+description: |+
+  DMC-520 node is defined to describe DRAM error detection and correction.
+
+  https://static.docs.arm.com/100000/0200/corelink_dmc520_trm_100000_0200_01_en.pdf
+
+properties:
+  compatible:
+    items:
+      - const: brcm,dmc-520
+      - const: arm,dmc-520
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    minItems: 1
+
+  interrupt-names:
+    minItems: 1
+    items:
+      - const: ram_ecc_errc
+      - const: ram_ecc_errd
+      - const: dram_ecc_errc
+      - const: dram_ecc_errd
+      - const: failed_access
+      - const: failed_prog
+      - const: link_err
+      - const: temperature_event
+      - const: arch_fsm
+      - const: phy_request
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - interrupt-names
+
+examples:
+  - |
+    dmc0: dmc@200000 {
+        compatible = "brcm,dmc-520", "arm,dmc-520";
+        reg = <0x200000 0x80000>;
+        interrupts = <0x0 0x349 0x4>, <0x0 0x34B 0x4>;
+        interrupt-names = "dram_ecc_errc", "dram_ecc_errd";
+    };
-- 
2.17.1

Re: [PATCH v10 1/2] dt-bindings: edac: dmc-520.yaml

[Borislav Petkov]

On Wed, Jan 22, 2020 at 04:31:07PM -0800, Shiping Ji wrote:
> This is the device tree bindings for new EDAC driver dmc520_edac.c.
> 
> From: Lei Wang <leiwang_git@outlook.com>
> 
> Signed-off-by: Lei Wang <leiwang_git@outlook.com>
> Signed-off-by: Shiping Ji <shiping.linux@gmail.com>
> Reviewed-by: James Morse <james.morse@arm.com>
> 
> ---
>      Changes in v10:
>          - Convert to the YAML format for binding description

So you've changed this patch considerably. If you do so, you cannot keep
Reviewed-by tags.

Also, AFAICT, you've written a completely *new* patch which would mean
that this time you're the author. Correct?

If so, you don't need to keep Lei's From.

In any case, please take some time to read this:

https://www.kernel.org/doc/html/latest/process/index.html

It is a lot so do concentrate on the whole process, i.e., this:

https://www.kernel.org/doc/html/latest/process/development-process.html

so that you have a basic idea.

If you have questions, I'm sure Sasha would be willing to answer them
even if he's away now.

Thx.

-- 
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette

Re: [PATCH v10 1/2] dt-bindings: edac: dmc-520.yaml

[Rob Herring]

On Wed, Jan 22, 2020 at 6:31 PM Shiping Ji <shiping.linux@gmail.com> wrote:
>
> This is the device tree bindings for new EDAC driver dmc520_edac.c.
>
> From: Lei Wang <leiwang_git@outlook.com>
>
> Signed-off-by: Lei Wang <leiwang_git@outlook.com>
> Signed-off-by: Shiping Ji <shiping.linux@gmail.com>
> Reviewed-by: James Morse <james.morse@arm.com>
>
> ---
>      Changes in v10:
>          - Convert to the YAML format for binding description
>
> ---
>  .../devicetree/bindings/edac/dmc-520.yaml     | 56 +++++++++++++++++++
>  1 file changed, 56 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/edac/dmc-520.yaml
>
> diff --git a/Documentation/devicetree/bindings/edac/dmc-520.yaml b/Documentation/devicetree/bindings/edac/dmc-520.yaml
> new file mode 100644
> index 000000000000..dd5982b227b2
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/edac/dmc-520.yaml
> @@ -0,0 +1,56 @@
> +# SPDX-License-Identifier: GPL-2.0

Dual license new bindings please:

(GPL-2.0-only OR BSD-2-Clause)

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/edac/dmc-520.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ARM DMC-520 EDAC bindings
> +
> +maintainers:
> +  - Lei Wang <lewan@microsoft.com>
> +
> +description: |+
> +  DMC-520 node is defined to describe DRAM error detection and correction.
> +
> +  https://static.docs.arm.com/100000/0200/corelink_dmc520_trm_100000_0200_01_en.pdf
> +
> +properties:
> +  compatible:
> +    items:
> +      - const: brcm,dmc-520
> +      - const: arm,dmc-520
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    minItems: 1
> +
> +  interrupt-names:
> +    minItems: 1
> +    items:
> +      - const: ram_ecc_errc
> +      - const: ram_ecc_errd
> +      - const: dram_ecc_errc
> +      - const: dram_ecc_errd
> +      - const: failed_access
> +      - const: failed_prog
> +      - const: link_err
> +      - const: temperature_event
> +      - const: arch_fsm
> +      - const: phy_request

This defines not just the names, but the index they must be at which I
don't think you want.

minItems: 1
maxItems: 10
items:
  enum:
    - ram_ecc_errc
    - ram_ecc_errd
    ...

Note the lack of '-' under 'items' making it a schema that applies to all items.

Run 'make dt_binding_check' as that would have caught this issue on the example.

Rob

Re: [PATCH v10 1/2] dt-bindings: edac: dmc-520.yaml

[Rob Herring]

On Wed, Jan 22, 2020 at 6:31 PM Shiping Ji <shiping.linux@gmail.com> wrote:
>
> This is the device tree bindings for new EDAC driver dmc520_edac.c.
>
> From: Lei Wang <leiwang_git@outlook.com>
>
> Signed-off-by: Lei Wang <leiwang_git@outlook.com>
> Signed-off-by: Shiping Ji <shiping.linux@gmail.com>
> Reviewed-by: James Morse <james.morse@arm.com>
>
> ---
>      Changes in v10:
>          - Convert to the YAML format for binding description
>
> ---
>  .../devicetree/bindings/edac/dmc-520.yaml     | 56 +++++++++++++++++++
>  1 file changed, 56 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/edac/dmc-520.yaml
>
> diff --git a/Documentation/devicetree/bindings/edac/dmc-520.yaml b/Documentation/devicetree/bindings/edac/dmc-520.yaml
> new file mode 100644
> index 000000000000..dd5982b227b2
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/edac/dmc-520.yaml
> @@ -0,0 +1,56 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/edac/dmc-520.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ARM DMC-520 EDAC bindings
> +
> +maintainers:
> +  - Lei Wang <lewan@microsoft.com>
> +
> +description: |+
> +  DMC-520 node is defined to describe DRAM error detection and correction.
> +
> +  https://static.docs.arm.com/100000/0200/corelink_dmc520_trm_100000_0200_01_en.pdf
> +
> +properties:
> +  compatible:
> +    items:
> +      - const: brcm,dmc-520
> +      - const: arm,dmc-520
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    minItems: 1

You also need 'maxItems: 10' here.

Re: [PATCH v10 1/2] dt-bindings: edac: dmc-520.yaml

[Shiping Ji]

On 1/23/2020 12:23 AM, Borislav Petkov wrote:
> On Wed, Jan 22, 2020 at 04:31:07PM -0800, Shiping Ji wrote:
>> This is the device tree bindings for new EDAC driver dmc520_edac.c.
>>
>> From: Lei Wang <leiwang_git@outlook.com>
>>
>> Signed-off-by: Lei Wang <leiwang_git@outlook.com>
>> Signed-off-by: Shiping Ji <shiping.linux@gmail.com>
>> Reviewed-by: James Morse <james.morse@arm.com>
>>
>> ---
>>      Changes in v10:
>>          - Convert to the YAML format for binding description
> 
> So you've changed this patch considerably. If you do so, you cannot keep
> Reviewed-by tags.
> 
> Also, AFAICT, you've written a completely *new* patch which would mean
> that this time you're the author. Correct?
> 
> If so, you don't need to keep Lei's From.

Boris, we'd still like to keep her as the author since this patch is just updating to a new documentation format where the content being documented was still designed by Lei. I hope this is OK.

> In any case, please take some time to read this:
> 
> https://www.kernel.org/doc/html/latest/process/index.html
> 
> It is a lot so do concentrate on the whole process, i.e., this:
> 
> https://www.kernel.org/doc/html/latest/process/development-process.html
> 
> so that you have a basic idea.
> 
> If you have questions, I'm sure Sasha would be willing to answer them
> even if he's away now.

Thanks! I'll certainly read this.

-- 
Best regards,
Shiping Ji

Re: [PATCH v10 1/2] dt-bindings: edac: dmc-520.yaml

[Borislav Petkov]

On Thu, Jan 23, 2020 at 08:47:31AM -0800, Shiping Ji wrote:
> Boris, we'd still like to keep her as the author since this patch is
> just updating to a new documentation format where the content being
> documented was still designed by Lei. I hope this is OK.

Ok, fair enough.

Thx.

-- 
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette

Re: [PATCH v10 1/2] dt-bindings: edac: dmc-520.yaml

[Shiping Ji]

On 1/23/2020 5:44 AM, Rob Herring wrote:

> Run 'make dt_binding_check' as that would have caught this issue on the example.

Eventually I have the dtc with yaml output built and resolved issues reported by "make dt_binding_check". Shall I submit a new v11 patch for the dt-bindings only or I should add driver code patch into v11 too?

Thanks!

-- 
Best regards,
Shiping Ji