Re: [PATCH net-next 2/2] bindings: net: stmmac: Add documentation for TSN parameters

[Florian Fainelli <f.fainelli@gmail.com>]

On 10/25/2017 07:04 AM, Jose Abreu wrote:
> This adds the documentation for TSN feature EST and FP.
> 
> Signed-off-by: Jose Abreu <joabreu@synopsys.com>
> Cc: David S. Miller <davem@davemloft.net>
> Cc: Joao Pinto <jpinto@synopsys.com>
> Cc: Giuseppe Cavallaro <peppe.cavallaro@st.com>
> Cc: Alexandre Torgue <alexandre.torgue@st.com>
> Cc: Rob Herring <robh+dt@kernel.org>
> ---
>  Documentation/devicetree/bindings/net/stmmac.txt | 20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/net/stmmac.txt b/Documentation/devicetree/bindings/net/stmmac.txt
> index c3a7be6..6359df6 100644
> --- a/Documentation/devicetree/bindings/net/stmmac.txt
> +++ b/Documentation/devicetree/bindings/net/stmmac.txt
> @@ -114,6 +114,16 @@ Optional properties:
>  			- snps,high_credit: max write outstanding req. limit
>  			- snps,low_credit: max read outstanding req. limit
>  		- snps,priority: TX queue priority (Range: 0x0 to 0xF)
> +- TSN parameters: below the list of all the parameters to configure TSN
> +		  features (only applicable for IP version >= 5.00)
> +	- snps,est: Enable EST algorithm
> +	- If EST enabled provide these parameters:
> +		- snps,btr: Array size of 2 with BTR value for EST algorithm
> +		- snps,ctr: Array size of 2 with CTR value for EST algorithm
> +		- snps,ter: TER value for EST algorithm
> +		- snps,gcl: Variable size array with GCL table entries.
> +	- snps,fp: Enable FP feature. This needs EST enabled.

You are using Device Tree as a configuration interface, that does not
sound right at all.

> +
>  Examples:
>  
>  	stmmac_axi_setup: stmmac-axi-config {
> @@ -151,6 +161,15 @@ Examples:
>  		};
>  	};
>  
> +	tsn_setup: tsn-config {
> +		snps,est;
> +		snps,btr = <0x00000000 0x00000001>;
> +		snps,ctr = <0x00000000 0x10000000>;
> +		snps,ter = <0x00000000>;
> +		snps,gcl = <0x00000001 0x00000002 0x00000003>;
> +		snps,fp;
> +	};
> +
>  	gmac0: ethernet@e0800000 {
>  		compatible = "st,spear600-gmac";
>  		reg = <0xe0800000 0x8000>;
> @@ -176,4 +195,5 @@ Examples:
>  		};
>  		snps,mtl-rx-config = <&mtl_rx_setup>;
>  		snps,mtl-tx-config = <&mtl_tx_setup>;
> +		snps,tsn-config = <&tsn_setup>;

Yes, this is definitively using Device Tree as a configuration
interface, don't do that please.
-- 
Florian