[PATCH] dt-bindings: soc: ti: pruss: Add documentation for PA_STATS support

[PATCH] dt-bindings: soc: ti: pruss: Add documentation for PA_STATS support

[MD Danish Anwar]

Add documentation for pa-stats node which is syscon regmap for
PA_STATS register. This will be used to dump statistics maintained by
ICSSG firmware.

Signed-off-by: MD Danish Anwar <danishanwar@ti.com>
---
 .../devicetree/bindings/soc/ti/ti,pruss.yaml    | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml b/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml
index c402cb2928e8..cb6f41660847 100644
--- a/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml
+++ b/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml
@@ -278,6 +278,23 @@ patternProperties:
 
     additionalProperties: false
 
+  pa-stats@[a-f0-9]+$:
+    description: |
+      PA-STATS sub-module represented as a SysCon.
+
+    type: object
+
+    properties:
+      compatible:
+        items:
+          - const: ti,pruss-pa-st
+          - const: syscon
+
+      reg:
+        maxItems: 1
+
+    additionalProperties: false
+
   interrupt-controller@[a-f0-9]+$:
     description: |
       PRUSS INTC Node. Each PRUSS has a single interrupt controller instance
-- 
2.34.1

Re: [PATCH] dt-bindings: soc: ti: pruss: Add documentation for PA_STATS support

[Krzysztof Kozlowski]

On 30/04/2024 14:19, MD Danish Anwar wrote:
> Add documentation for pa-stats node which is syscon regmap for
> PA_STATS register. This will be used to dump statistics maintained by
> ICSSG firmware.
> 
> Signed-off-by: MD Danish Anwar <danishanwar@ti.com>
> ---
>  .../devicetree/bindings/soc/ti/ti,pruss.yaml    | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml b/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml
> index c402cb2928e8..cb6f41660847 100644
> --- a/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml
> +++ b/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml
> @@ -278,6 +278,23 @@ patternProperties:
>  
>      additionalProperties: false
>  
> +  pa-stats@[a-f0-9]+$:

Missing ^

> +    description: |
> +      PA-STATS sub-module represented as a SysCon.
> +
> +    type: object
> +
> +    properties:
> +      compatible:
> +        items:
> +          - const: ti,pruss-pa-st
> +          - const: syscon
> +

No resources? So you use it just to instantiate Linux driver? That's not
the purpose of DT. Just squash it into parent node?

> +      reg:
> +        maxItems: 1
> +
> +    additionalProperties: false

Put it after type:object.

> +
>    interrupt-controller@[a-f0-9]+$:
>      description: |
>        PRUSS INTC Node. Each PRUSS has a single interrupt controller instance

Best regards,
Krzysztof

Re: [PATCH] dt-bindings: soc: ti: pruss: Add documentation for PA_STATS support

[MD Danish Anwar]

Hi Krzysztof,

On 01/05/24 3:58 pm, Krzysztof Kozlowski wrote:
> On 30/04/2024 14:19, MD Danish Anwar wrote:
>> Add documentation for pa-stats node which is syscon regmap for
>> PA_STATS register. This will be used to dump statistics maintained by
>> ICSSG firmware.
>>
>> Signed-off-by: MD Danish Anwar <danishanwar@ti.com>
>> ---
>>  .../devicetree/bindings/soc/ti/ti,pruss.yaml    | 17 +++++++++++++++++
>>  1 file changed, 17 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml b/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml
>> index c402cb2928e8..cb6f41660847 100644
>> --- a/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml
>> +++ b/Documentation/devicetree/bindings/soc/ti/ti,pruss.yaml
>> @@ -278,6 +278,23 @@ patternProperties:
>>  
>>      additionalProperties: false
>>  
>> +  pa-stats@[a-f0-9]+$:
> 
> Missing ^
> 

Sure, I will add that.

>> +    description: |
>> +      PA-STATS sub-module represented as a SysCon.
>> +
>> +    type: object
>> +
>> +    properties:
>> +      compatible:
>> +        items:
>> +          - const: ti,pruss-pa-st
>> +          - const: syscon
>> +
> 
> No resources? So you use it just to instantiate Linux driver? That's not
> the purpose of DT. Just squash it into parent node?
> 

I am trying to module pa-stats as a regmap just like mii-rt and
mii-g-rt. ICSSG has different segments for storing different types of
registers. mii-rt, starting at 0x32000 have registers that stores mainly
TX and RX configurations. mii-g-rt, starting at 0x33000 have registers
that stores hardware statistics counters (TX RX good frame, drop etc).
Similarly pa-stats starting at 0x2c000 have registers that stores some
diagnostic counters which is maintained by firmware. ICSSG firmware
stores statistics other than hadrware statistics like if the packet was
pushed to dma or not. Why was the packet dropped etc. This is very
helpful in debugging failures. Also ICSSG firmware maintains all TSN
related statistics in this memory only, which will be needed to be
dumped from driver once TSN support is enabled (the patches for that are
still under review).

More or less the functionality of pa-stats here is same as mii-rt and
mii-g-rt and that is why I am trying to describe the node in exactly the
same way as the other two nodes.

>> +      reg:
>> +        maxItems: 1
>> +
>> +    additionalProperties: false
> 
> Put it after type:object.
> 

Sure, will move it.

>> +
>>    interrupt-controller@[a-f0-9]+$:
>>      description: |
>>        PRUSS INTC Node. Each PRUSS has a single interrupt controller instance
> 
> Best regards,
> Krzysztof
> 

-- 
Thanks and Regards,
Danish