[PATCH net-next] dt-bindings: net: ti: icssg_prueth: Add documentation for PA_STATS support

[PATCH net-next] dt-bindings: net: ti: icssg_prueth: Add documentation for PA_STATS support

[MD Danish Anwar]

Add documentation for ti,pa-stats property 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>
---
 Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml b/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml
index e253fa786092..abf372f7191b 100644
--- a/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml
+++ b/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml
@@ -55,6 +55,11 @@ properties:
     description:
       phandle to MII_RT module's syscon regmap
 
+  ti,pa-stats:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description:
+      phandle to PA_STATS module's syscon regmap
+
   ti,iep:
     $ref: /schemas/types.yaml#/definitions/phandle-array
     maxItems: 2
@@ -194,6 +199,7 @@ examples:
                     "tx1-0", "tx1-1", "tx1-2", "tx1-3",
                     "rx0", "rx1";
         ti,mii-g-rt = <&icssg2_mii_g_rt>;
+        ti,pa-stats = <&icssg2_pa_stats>;
         ti,iep = <&icssg2_iep0>, <&icssg2_iep1>;
         interrupt-parent = <&icssg2_intc>;
         interrupts = <24 0 2>, <25 1 3>;
-- 
2.34.1

Re: [PATCH net-next] dt-bindings: net: ti: icssg_prueth: Add documentation for PA_STATS support

[Krzysztof Kozlowski]

On 30/04/2024 14:24, MD Danish Anwar wrote:
> Add documentation for ti,pa-stats property 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>
> ---
>  Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml b/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml
> index e253fa786092..abf372f7191b 100644
> --- a/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml
> +++ b/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml
> @@ -55,6 +55,11 @@ properties:
>      description:
>        phandle to MII_RT module's syscon regmap
>  
> +  ti,pa-stats:
> +    $ref: /schemas/types.yaml#/definitions/phandle
> +    description:
> +      phandle to PA_STATS module's syscon regmap

One register needed? Then use phandle-array syntax - see examples.
Explain in description the purpose of this register in the context of
*this* device.

Best regards,
Krzysztof

Re: [PATCH net-next] dt-bindings: net: ti: icssg_prueth: Add documentation for PA_STATS support

[MD Danish Anwar]

Hi Krzysztof,

On 01/05/24 3:56 pm, Krzysztof Kozlowski wrote:
> On 30/04/2024 14:24, MD Danish Anwar wrote:
>> Add documentation for ti,pa-stats property 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>
>> ---
>>  Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml | 6 ++++++
>>  1 file changed, 6 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml b/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml
>> index e253fa786092..abf372f7191b 100644
>> --- a/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml
>> +++ b/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml
>> @@ -55,6 +55,11 @@ properties:
>>      description:
>>        phandle to MII_RT module's syscon regmap
>>  
>> +  ti,pa-stats:
>> +    $ref: /schemas/types.yaml#/definitions/phandle
>> +    description:
>> +      phandle to PA_STATS module's syscon regmap
> 
> One register needed? Then use phandle-array syntax - see examples.

No this is not one register only. PA_STATS is a set of registers. My bad
I should have mentioned *registers* in the commit description. Just like
MII_RT and MII_G_RT modules, PA_STATS is also a set of registers where
different statistics are dumped by ICSSG firmware. Moduling this as
syscon will help the driver read/write those statistics using
regmap_read() / write() just like the driver currently read / write
registers from mii_rt and mii_g_rt regmaps.

I have tried to describe this node *ti,pa-stats* the same way as
"ti,mii-g-rt" and "ti,mii-rt"

> Explain in description the purpose of this register in the context of
> *this* device.
> 

Sure will do that.

> Best regards,
> Krzysztof
> 

-- 
Thanks and Regards,
Danish