[PATCH v3 16/22] dt-bindings: net: Update Freescale TSEC to support "queue-group"

[Vladimir Oltean]

On Sun, Mar 14, 2021 at 01:15:04PM +0800, Bin Meng wrote:
> At present the Freescale TSEC node DT bindings doc requires a <reg>
> property in the TSEC node. But this might not always be the case.
> In the upstream Linux kernel, there is no DT bindings doc for it
> but the kernel driver tests a subnode of a name prefixed with
> "queue-group", as we can see from gfar_of_init():
> 
>   for_each_available_child_of_node(np, child) {
>       if (!of_node_name_eq(child, "queue-group"))
>   ...
> 
> in drivers/net/ethernet/freescale/gianfar.c
> 
> Update our DT bindings to describe this alternate description.
> 
> Signed-off-by: Bin Meng <bmeng.cn at gmail.com>
> Reviewed-by: Ramon Fried <rfried.dev at gmail.com>
> 
> ---
> 
> Changes in v3:
> - add "ranges" in the alternate example
> 
>  doc/device-tree-bindings/net/fsl-tsec-phy.txt | 16 +++++++++++++++-
>  1 file changed, 15 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/device-tree-bindings/net/fsl-tsec-phy.txt b/doc/device-tree-bindings/net/fsl-tsec-phy.txt
> index a44c5fd9d9..5a73371a97 100644
> --- a/doc/device-tree-bindings/net/fsl-tsec-phy.txt
> +++ b/doc/device-tree-bindings/net/fsl-tsec-phy.txt
> @@ -3,7 +3,9 @@
>  Properties:
>  
>    - compatible : Should be "fsl,etsec2" or "gianfar"
> -  - reg : Offset and length of the register set for the device
> +  - reg : Offset and length of the register set for the device. If this is
> +    missing, a subnode with a name prefix "queue-group" must be provided to
> +    provide the <reg> property.

You added 'ranges' to the example, but you didn't say it is required for
the alternate description (minor detail).

Either way:

Reviewed-by: Vladimir Oltean <vladimir.oltean at nxp.com>

>    - phy-handle : See ethernet.txt file in the same directory.
>    - phy-connection-type : See ethernet.txt file in the same directory. This
>      property is only really needed if the connection is of type "rgmii-id",
> @@ -18,6 +20,18 @@ Example:
>  		phy-connection-type = "sgmii";
>  	};
>  
> +An alternate description with "queue-group" subnode example:
> +	ethernet at 24000 {
> +		compatible = "fsl,etsec2";
> +		phy-handle = <&phy0>;
> +		phy-connection-type = "sgmii";
> +		ranges;
> +
> +		queue-group {
> +			reg = <0x24000 0x1000>;
> +		};
> +	};
> +
>  Child nodes of the TSEC controller are typically the individual PHY devices
>  connected via the MDIO bus (sometimes the MDIO bus controller is separate).
>  
> -- 
> 2.25.1
>