[PATCH RESEND v3 0/3] Add support for ESM

[PATCH RESEND v3 0/3] Add support for ESM

[Neha Malcom Francis]

Resending as no major changes, commit subject change only.

ESM (Error Signaling Module) is a fundamental IP responsible for
handling safety events. The driver currently present in U-Boot is
responsible for configuring ESM. This patch series adds dt-binding and
nodes for J721E and J7200. This goes towards end goal of having DTB sync
with that of U-Boot as well as ensuring completeness of hardware
description in devicetree.

Neha Malcom Francis (3):
  dt-bindings: hwmon: esm: Add ESM support for TI K3 devices
  arm64: dts: ti: k3-j721e: Add ESM support
  arm64: dts: ti: k3-j7200: Add ESM support

 .../bindings/hwmon/ti,j721e-esm.yaml          | 53 +++++++++++++++++++
 arch/arm64/boot/dts/ti/k3-j7200-main.dtsi     |  6 +++
 arch/arm64/boot/dts/ti/k3-j7200.dtsi          |  1 +
 arch/arm64/boot/dts/ti/k3-j721e.dtsi          |  1 +
 4 files changed, 61 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/hwmon/ti,j721e-esm.yaml

-- 
2.34.1

[PATCH RESEND v3 1/3] dt-bindings: hwmon: esm: Add ESM support for TI K3 devices

[Neha Malcom Francis]

Document the binding for TI K3 ESM (Error Signaling Module) block.

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

diff --git a/Documentation/devicetree/bindings/hwmon/ti,j721e-esm.yaml b/Documentation/devicetree/bindings/hwmon/ti,j721e-esm.yaml
new file mode 100644
index 000000000000..c5eb7f46cc46
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/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/hwmon/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>;
+        };
+    };
-- 
2.34.1

Re: [PATCH RESEND v3 1/3] dt-bindings: hwmon: esm: Add ESM support for TI K3 devices

[Krzysztof Kozlowski]

On 24/04/2023 12:50, 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>
> ---
>  .../bindings/hwmon/ti,j721e-esm.yaml          | 53 +++++++++++++++++++
>  1 file changed, 53 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/hwmon/ti,j721e-esm.yaml


Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

---

This is an automated instruction, just in case, because many review tags
are being ignored. If you do not know the process, here is a short
explanation:

Please add Acked-by/Reviewed-by/Tested-by tags when posting new
versions, under or above your Signed-off-by tag. Tools like b4 can help
here. However, there's no need to repost patches *only* to add the tags.
The upstream maintainer will do that for acks received on the version
they apply.

https://elixir.bootlin.com/linux/v5.17/source/Documentation/process/submitting-patches.rst#L540

Best regards,
Krzysztof

Re: [PATCH RESEND v3 1/3] dt-bindings: hwmon: esm: Add ESM support for TI K3 devices

[Guenter Roeck]

On Mon, Apr 24, 2023 at 04:20:09PM +0530, 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>

I think I am missing what this has to do with hardware
monitoring. I see a driver submission into drivers/misc,
but that doesn't explain the suggested location of the
devicetree bindings, and I kind of resist the idea that hwmon
should be the dumping ground for bindings which don't have
a home.

Guenter

> ---
>  .../bindings/hwmon/ti,j721e-esm.yaml          | 53 +++++++++++++++++++
>  1 file changed, 53 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/hwmon/ti,j721e-esm.yaml
> 
> diff --git a/Documentation/devicetree/bindings/hwmon/ti,j721e-esm.yaml b/Documentation/devicetree/bindings/hwmon/ti,j721e-esm.yaml
> new file mode 100644
> index 000000000000..c5eb7f46cc46
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/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/hwmon/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>;
> +        };
> +    };

Re: [PATCH RESEND v3 1/3] dt-bindings: hwmon: esm: Add ESM support for TI K3 devices

[Krzysztof Kozlowski]

On 24/04/2023 16:44, Guenter Roeck wrote:
> On Mon, Apr 24, 2023 at 04:20:09PM +0530, 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>
> 
> I think I am missing what this has to do with hardware
> monitoring. I see a driver submission into drivers/misc,
> but that doesn't explain the suggested location of the
> devicetree bindings, and I kind of resist the idea that hwmon
> should be the dumping ground for bindings which don't have
> a home.

Hi Guenter,

This was my suggestion in the previous version, that this device could
look like something related to fault handling or hardware monitoring.
Whether it fits hwmon, I am no sure, just proposed it. Definitely I do
not think of hwmon as dumping ground, but I am rather trying to find
proper place for esm, instead of dumping it in misc (which is a dumping
ground :) ).

https://lore.kernel.org/all/eb6bfe2e-1e44-bfb5-01b9-bbf53eba6501@linaro.org/

Best regards,
Krzysztof

[PATCH RESEND v3 2/3] arm64: dts: ti: k3-j721e: Add ESM support

[Neha Malcom Francis]

Add address entry mapping ESM on J721E.

Signed-off-by: Neha Malcom Francis <n-francis@ti.com>
---
 arch/arm64/boot/dts/ti/k3-j721e.dtsi | 1 +
 1 file changed, 1 insertion(+)

diff --git a/arch/arm64/boot/dts/ti/k3-j721e.dtsi b/arch/arm64/boot/dts/ti/k3-j721e.dtsi
index b912143b6a11..52bcde601eb8 100644
--- a/arch/arm64/boot/dts/ti/k3-j721e.dtsi
+++ b/arch/arm64/boot/dts/ti/k3-j721e.dtsi
@@ -131,6 +131,7 @@ cbass_main: bus@100000 {
 		#size-cells = <2>;
 		ranges = <0x00 0x00100000 0x00 0x00100000 0x00 0x00020000>, /* ctrl mmr */
 			 <0x00 0x00600000 0x00 0x00600000 0x00 0x00031100>, /* GPIO */
+			 <0x00 0x00700000 0x00 0x00700000 0x00 0x00001000>, /* ESM */
 			 <0x00 0x00900000 0x00 0x00900000 0x00 0x00012000>, /* serdes */
 			 <0x00 0x00a40000 0x00 0x00a40000 0x00 0x00000800>, /* timesync router */
 			 <0x00 0x06000000 0x00 0x06000000 0x00 0x00400000>, /* USBSS0 */
-- 
2.34.1

[PATCH RESEND v3 3/3] arm64: dts: ti: k3-j7200: Add ESM support

[Neha Malcom Francis]

Add address entry mapping ESM on J7200.

Signed-off-by: Neha Malcom Francis <n-francis@ti.com>
---
 arch/arm64/boot/dts/ti/k3-j7200-main.dtsi | 6 ++++++
 arch/arm64/boot/dts/ti/k3-j7200.dtsi      | 1 +
 2 files changed, 7 insertions(+)

diff --git a/arch/arm64/boot/dts/ti/k3-j7200-main.dtsi b/arch/arm64/boot/dts/ti/k3-j7200-main.dtsi
index ef352e32f19d..89f816f5e53d 100644
--- a/arch/arm64/boot/dts/ti/k3-j7200-main.dtsi
+++ b/arch/arm64/boot/dts/ti/k3-j7200-main.dtsi
@@ -1010,4 +1010,10 @@ main_r5fss0_core1: r5f@5d00000 {
 			ti,loczrama = <1>;
 		};
 	};
+
+	main_esm: esm@700000 {
+		compatible = "ti,j721e-esm";
+		reg = <0x0 0x700000 0x0 0x1000>;
+		ti,esm-pins = <656>, <657>;
+	};
 };
diff --git a/arch/arm64/boot/dts/ti/k3-j7200.dtsi b/arch/arm64/boot/dts/ti/k3-j7200.dtsi
index bbe380c72a7e..4998eb4fbe75 100644
--- a/arch/arm64/boot/dts/ti/k3-j7200.dtsi
+++ b/arch/arm64/boot/dts/ti/k3-j7200.dtsi
@@ -128,6 +128,7 @@ cbass_main: bus@100000 {
 		#size-cells = <2>;
 		ranges = <0x00 0x00100000 0x00 0x00100000 0x00 0x00020000>, /* ctrl mmr */
 			 <0x00 0x00600000 0x00 0x00600000 0x00 0x00031100>, /* GPIO */
+			 <0x00 0x00700000 0x00 0x00700000 0x00 0x00001000>, /* ESM */
 			 <0x00 0x00a40000 0x00 0x00a40000 0x00 0x00000800>, /* timesync router */
 			 <0x00 0x01000000 0x00 0x01000000 0x00 0x0d000000>, /* Most peripherals */
 			 <0x00 0x30000000 0x00 0x30000000 0x00 0x0c400000>, /* MAIN NAVSS */
-- 
2.34.1

Re: [PATCH RESEND v3 0/3] Add support for ESM

[Krzysztof Kozlowski]

On 24/04/2023 12:50, Neha Malcom Francis wrote:
> Resending as no major changes, commit subject change only.

That's a new version. Keep changelog - for some reason it disappeared.
> 

Best regards,
Krzysztof

Re: [PATCH RESEND v3 0/3] Add support for ESM

[Guenter Roeck]

On 4/24/23 03:50, Neha Malcom Francis wrote:
> Resending as no major changes, commit subject change only.
> 

Maybe you consider changing the subject of the bindings from "misc"
to "hwmon" as not being a major change, but it made me aware that you
are trying to sneak bindings which in my opinion don't belong there
into the hwmon bindings directory. This is not a hardware monitoring
device, it doesn't have anything to do with hardware monitoring, and the
bindings do not belong into bindings/hwmon/.

Maybe you can convince the devicetree maintainers to accept the bindings
into the suggested location, but that will be over my objection.

Guenter


> ESM (Error Signaling Module) is a fundamental IP responsible for
> handling safety events. The driver currently present in U-Boot is
> responsible for configuring ESM. This patch series adds dt-binding and
> nodes for J721E and J7200. This goes towards end goal of having DTB sync
> with that of U-Boot as well as ensuring completeness of hardware
> description in devicetree.
> 
> Neha Malcom Francis (3):
>    dt-bindings: hwmon: esm: Add ESM support for TI K3 devices
>    arm64: dts: ti: k3-j721e: Add ESM support
>    arm64: dts: ti: k3-j7200: Add ESM support
> 
>   .../bindings/hwmon/ti,j721e-esm.yaml          | 53 +++++++++++++++++++
>   arch/arm64/boot/dts/ti/k3-j7200-main.dtsi     |  6 +++
>   arch/arm64/boot/dts/ti/k3-j7200.dtsi          |  1 +
>   arch/arm64/boot/dts/ti/k3-j721e.dtsi          |  1 +
>   4 files changed, 61 insertions(+)
>   create mode 100644 Documentation/devicetree/bindings/hwmon/ti,j721e-esm.yaml
> 

Re: [PATCH RESEND v3 0/3] Add support for ESM

[Neha Malcom Francis]

Hi Guenter

On 24/04/23 20:27, Guenter Roeck wrote:
> On 4/24/23 03:50, Neha Malcom Francis wrote:
>> Resending as no major changes, commit subject change only.
>>
> 
> Maybe you consider changing the subject of the bindings from "misc"
> to "hwmon" as not being a major change, but it made me aware that you
> are trying to sneak bindings which in my opinion don't belong there
> into the hwmon bindings directory. This is not a hardware monitoring
> device, it doesn't have anything to do with hardware monitoring, and the
> bindings do not belong into bindings/hwmon/.
> 

I understand, it's a thin line across which I pushed ESM into hwmon; my 
reasoning was ESM also actively looks for signals that it aggregates, 
and is overall monitoring the device health. But if there was an option, 
in order of fitting: fault/ > misc/ > hwmon/

Using misc/ was questioned in an earlier review; and fault/ is not yet 
created and I did not think there were enough instances to back me up on 
creating a new dt-bindings dir

To come to a common solution, let us keep this binding in misc/ along 
with other fault detection mechanisms existing and take it up as a 
follow up action to create a fault/ ?

> Maybe you can convince the devicetree maintainers to accept the bindings
> into the suggested location, but that will be over my objection.
> 
> Guenter
> 
> 
>> ESM (Error Signaling Module) is a fundamental IP responsible for
>> handling safety events. The driver currently present in U-Boot is
>> responsible for configuring ESM. This patch series adds dt-binding and
>> nodes for J721E and J7200. This goes towards end goal of having DTB sync
>> with that of U-Boot as well as ensuring completeness of hardware
>> description in devicetree.
>>
>> Neha Malcom Francis (3):
>>    dt-bindings: hwmon: esm: Add ESM support for TI K3 devices
>>    arm64: dts: ti: k3-j721e: Add ESM support
>>    arm64: dts: ti: k3-j7200: Add ESM support
>>
>>   .../bindings/hwmon/ti,j721e-esm.yaml          | 53 +++++++++++++++++++
>>   arch/arm64/boot/dts/ti/k3-j7200-main.dtsi     |  6 +++
>>   arch/arm64/boot/dts/ti/k3-j7200.dtsi          |  1 +
>>   arch/arm64/boot/dts/ti/k3-j721e.dtsi          |  1 +
>>   4 files changed, 61 insertions(+)
>>   create mode 100644 
>> Documentation/devicetree/bindings/hwmon/ti,j721e-esm.yaml
>>
> 

-- 
Thanking You
Neha Malcom Francis

Re: [PATCH RESEND v3 0/3] Add support for ESM

[Guenter Roeck]

On 4/25/23 01:49, Neha Malcom Francis wrote:
> Hi Guenter
> 
> On 24/04/23 20:27, Guenter Roeck wrote:
>> On 4/24/23 03:50, Neha Malcom Francis wrote:
>>> Resending as no major changes, commit subject change only.
>>>
>>
>> Maybe you consider changing the subject of the bindings from "misc"
>> to "hwmon" as not being a major change, but it made me aware that you
>> are trying to sneak bindings which in my opinion don't belong there
>> into the hwmon bindings directory. This is not a hardware monitoring
>> device, it doesn't have anything to do with hardware monitoring, and the
>> bindings do not belong into bindings/hwmon/.
>>
> 
> I understand, it's a thin line across which I pushed ESM into hwmon; my reasoning was ESM also actively looks for signals that it aggregates, and is overall monitoring the device health. But if there was an option, in order of fitting: fault/ > misc/ > hwmon/
> 

That is really a stretch. It doesn't monitor anything. It is a signal
routing mechanism.

With that logic every transistor would be a hardware monitoring device.

Guenter

Re: [PATCH RESEND v3 0/3] Add support for ESM

[Krzysztof Kozlowski]

On 25/04/2023 16:34, Guenter Roeck wrote:
> On 4/25/23 01:49, Neha Malcom Francis wrote:
>> Hi Guenter
>>
>> On 24/04/23 20:27, Guenter Roeck wrote:
>>> On 4/24/23 03:50, Neha Malcom Francis wrote:
>>>> Resending as no major changes, commit subject change only.
>>>>
>>>
>>> Maybe you consider changing the subject of the bindings from "misc"
>>> to "hwmon" as not being a major change, but it made me aware that you
>>> are trying to sneak bindings which in my opinion don't belong there
>>> into the hwmon bindings directory. This is not a hardware monitoring
>>> device, it doesn't have anything to do with hardware monitoring, and the
>>> bindings do not belong into bindings/hwmon/.
>>>
>>
>> I understand, it's a thin line across which I pushed ESM into hwmon; my reasoning was ESM also actively looks for signals that it aggregates, and is overall monitoring the device health. But if there was an option, in order of fitting: fault/ > misc/ > hwmon/
>>
> 
> That is really a stretch. It doesn't monitor anything. It is a signal
> routing mechanism.
> 
> With that logic every transistor would be a hardware monitoring device.

Then let's move it to misc/ as I don't have other ideas for the placement.

Best regards,
Krzysztof