netdev - [PATCH 2/2 net-next] net: stmmac: Improve documentation on AVB parameters

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <95bf7beef1abfb3c140ef56a8f59374bf6513496.1496944749.git.jpinto@synopsys.com>
Date:   Thu,  8 Jun 2017 19:02:52 +0100
From:   Joao Pinto <Joao.Pinto@...opsys.com>
To:     davem@...emloft.net
Cc:     netdev@...r.kernel.org, peppe.cavallaro@...com,
        alexandre.torgue@...com, Joao Pinto <Joao.Pinto@...opsys.com>
Subject: [PATCH 2/2 net-next] net: stmmac: Improve documentation on AVB parameters

This patch fixes the description of the DT AVB parameters and gives
an accurate example. It was also included the base values that were
used to get the example' CBS paremeter values.

Signed-off-by: Joao Pinto <jpinto@...opsys.com>
---
 Documentation/devicetree/bindings/net/stmmac.txt | 24 ++++++++++++++++--------
 1 file changed, 16 insertions(+), 8 deletions(-)

diff --git a/Documentation/devicetree/bindings/net/stmmac.txt b/Documentation/devicetree/bindings/net/stmmac.txt
index c3a7be6..707426d 100644
--- a/Documentation/devicetree/bindings/net/stmmac.txt
+++ b/Documentation/devicetree/bindings/net/stmmac.txt
@@ -109,10 +109,10 @@ Optional properties:
 			  [Attention] Queue 0 is reserved for legacy traffic
 			  and so no AVB is available in this queue.
 		- Configure Credit Base Shaper (if AVB Mode selected):
-			- snps,send_slope: enable Low Power Interface
-			- snps,idle_slope: unlock on WoL
-			- snps,high_credit: max write outstanding req. limit
-			- snps,low_credit: max read outstanding req. limit
+			- snps,send_slope: Send Slope Credit value
+			- snps,idle_slope:  Idle Slope Credit value
+			- snps,high_credit: High Credit value
+			- snps,low_credit: Low Credit value
 		- snps,priority: TX queue priority (Range: 0x0 to 0xF)
 Examples:
 
@@ -143,10 +143,18 @@ Examples:
 
 		queue1 {
 			snps,avb-algorithm;
-			snps,send_slope = <0x1000>;
-			snps,idle_slope = <0x1000>;
-			snps,high_credit = <0x3E800>;
-			snps,low_credit = <0xFFC18000>;
+			/*
+			 *  Example AVB parameters based on:
+			 *   Allocated Bandwidth: 40%
+			 *   Maximum Frame size: 1000 bytes
+			 *   Maximum Interference size: 1500 bytes
+			 *   Port Transmit Rate: 8
+			 *   Scaling Factor: 1024
+			 */
+			snps,idle_slope = <0xCCC>;
+			snps,send_slope = <0x1333>;
+			snps,high_credit = <0x4B0000>;
+			snps,low_credit = <0xFFB50000>;
 			snps,priority = <0x1>;
 		};
 	};
-- 
2.9.3