From 3341a8a767d6fd06b8108340d105a44c9388d0c7 Mon Sep 17 00:00:00 2001
From: Grzegorz Daniluk <grzegorz.daniluk@cern.ch>
Date: Thu, 11 Aug 2016 10:23:48 +0200
Subject: [PATCH] doc: adding wrs_throttling description

B/W throttling requires bitstream synthesized at least from commit 8f10817 of
the wr-switch-hdl repository.
---
 doc/wrs-user-manual.in | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/wrs-user-manual.in b/doc/wrs-user-manual.in
index 243e47314..151d6ece1 100644
--- a/doc/wrs-user-manual.in
+++ b/doc/wrs-user-manual.in
@@ -1283,6 +1283,13 @@ The following tools and scripts are provided:
 	transactions. The race can cause errors while reading SFPs memory,
 	wrong notification of LEDs, the false insert/remove SFP notifications.
 
+@item wrs_throttling
+  The tool is used to control Rx bandwidth throttling of the traffic that goes
+  from WR ports to Linux. It configures the FPGA module with a maximum allowed
+  bandwidth in KB/s. Throttling can be enabled to prevent Linux using 100% of
+  the processing power to receive Ethernet frames coming from WR ports to the
+  CPU.
+
 @c FIXME: document lm32-vuart rtu_stat spll_dbg_proxy
 @c FIXME: document wrs_pstats
 @end table
-- 
GitLab