[v5,1/3] dt-bindings: misc: esm: Add ESM support for TI K3 devices

Message ID 20230503123212.208457-2-n-francis@ti.com
State New
Headers
Series Add support for ESM |

Commit Message

Neha Malcom Francis May 3, 2023, 12:32 p.m. UTC
  Document the binding for TI K3 ESM (Error Signaling Module) block.

Signed-off-by: Neha Malcom Francis <n-francis@ti.com>
---
 .../bindings/misc/ti,j721e-esm.yaml           | 53 +++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/misc/ti,j721e-esm.yaml
  

Comments

Krzysztof Kozlowski May 4, 2023, 6:51 a.m. UTC | #1
On 03/05/2023 14:32, Neha Malcom Francis wrote:
> Document the binding for TI K3 ESM (Error Signaling Module) block.
> 
> Signed-off-by: Neha Malcom Francis <n-francis@ti.com>

???

You were already asked to keep it and it was in v4, so you had to
explicitly remove it from your git... It takes me time to figure out
what is happening here. But ok, if you do not keep my review, comment
follows.

...

> +  ti,esm-pins:
> +    $ref: /schemas/types.yaml#/definitions/uint32-array
> +    description:
> +      integer array of ESM interrupt pins to route to external event pin
> +      which can be used to reset the SoC.
> +    minItems: 1
> +    maxItems: 255
> +
> +additionalProperties: false

Put aditionalProperties after required:, just like in example-schema.

> +
> +required:
> +  - compatible
> +  - reg
> +  - ti,esm-pins



Best regards,
Krzysztof
  
Neha Malcom Francis May 4, 2023, 7:43 a.m. UTC | #2
Hi Krzysztof

On 04/05/23 12:21, Krzysztof Kozlowski wrote:
> On 03/05/2023 14:32, Neha Malcom Francis wrote:
>> Document the binding for TI K3 ESM (Error Signaling Module) block.
>>
>> Signed-off-by: Neha Malcom Francis <n-francis@ti.com>
> 
> ???
> 
> You were already asked to keep it and it was in v4, so you had to
> explicitly remove it from your git... It takes me time to figure out
> what is happening here. But ok, if you do not keep my review, comment
> follows.
> 
> ...

Really sorry about that, forgot to add it back for v5. Sending next 
version soon...

> 
>> +  ti,esm-pins:
>> +    $ref: /schemas/types.yaml#/definitions/uint32-array
>> +    description:
>> +      integer array of ESM interrupt pins to route to external event pin
>> +      which can be used to reset the SoC.
>> +    minItems: 1
>> +    maxItems: 255
>> +
>> +additionalProperties: false
> 
> Put aditionalProperties after required:, just like in example-schema.
> 
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - ti,esm-pins
> 
> 
> 
> Best regards,
> Krzysztof
>
  

Patch

diff --git a/Documentation/devicetree/bindings/misc/ti,j721e-esm.yaml b/Documentation/devicetree/bindings/misc/ti,j721e-esm.yaml
new file mode 100644
index 000000000000..408296157576
--- /dev/null
+++ b/Documentation/devicetree/bindings/misc/ti,j721e-esm.yaml
@@ -0,0 +1,53 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (C) 2022 Texas Instruments Incorporated
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/misc/ti,j721e-esm.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments K3 ESM
+
+maintainers:
+  - Neha Malcom Francis <n-francis@ti.com>
+
+description:
+  The ESM (Error Signaling Module) is an IP block on TI K3 devices
+  that allows handling of safety events somewhat similar to what interrupt
+  controller would do. The safety signals have their separate paths within
+  the SoC, and they are handled by the ESM, which routes them to the proper
+  destination, which can be system reset, interrupt controller, etc. In the
+  simplest configuration the signals are just routed to reset the SoC.
+
+properties:
+  compatible:
+    const: ti,j721e-esm
+
+  reg:
+    maxItems: 1
+
+  ti,esm-pins:
+    $ref: /schemas/types.yaml#/definitions/uint32-array
+    description:
+      integer array of ESM interrupt pins to route to external event pin
+      which can be used to reset the SoC.
+    minItems: 1
+    maxItems: 255
+
+additionalProperties: false
+
+required:
+  - compatible
+  - reg
+  - ti,esm-pins
+
+examples:
+  - |
+    bus {
+        #address-cells = <2>;
+        #size-cells = <2>;
+        esm@700000 {
+            compatible = "ti,j721e-esm";
+            reg = <0x0 0x700000 0x0 0x1000>;
+            ti,esm-pins = <344>, <345>;
+        };
+    };