Skip to content

W
White Rabbit Switch - Software
Commit 52654a35 authored by Adam Wujek's avatar Adam Wujek 💬
Browse files
Options

doc/wrs-user-manual: improve documentation of throttling's settings 

Improve documentation of throttling's settings in the dot-config.
In the wrs-user-manual and in the Kconfig.

Supplements:
Merge branch 'greg-throttling'
Signed-off-by: Adam Wujek's avatarAdam Wujek <adam.wujek@cern.ch>
parent 19d5dd74
Hide whitespace changes
Inline Side-by-side
Showing with 15 additions and 2 deletions
Kconfig
View file @ 52654a35
......@@ -757,7 +757,10 @@ config NIC_THROTTLING_ENABLED
bool "Enable NIC throttling"
default n
help
Limit bandwith on NIC
Limit the Rx bandwidth of the traffic that goes from WR ports to
Linux. Throttling can be enabled to prevent Linux using 100% of the
processing power to receive Ethernet frames coming from WR ports to
the CPU.
config NIC_THROTTLING_VAL
int "NIC throttling value"
......@@ -765,7 +768,7 @@ config NIC_THROTTLING_VAL
default "4000"
range 1 65535
help
Value to which bandwith should be limited
Value to which bandwith should be limited (in KB/s).
endmenu
......
doc/wrs-user-manual.in
View file @ 52654a35
......@@ -785,6 +785,16 @@ value is changed by the web interface, proper action is taken.
Set of parameters passed to @t{wrs_auxclk} at boot time.
For more information please check @ref{wrs_auxclk}.
@item CONFIG_NIC_THROTTLING_ENABLED
@itemx CONFIG_NIC_THROTTLING_VAL
Limit the Rx bandwidth of the traffic that goes from WR ports to Linux.
Throttling can be enabled to prevent Linux using 100% of the processing
power to receive Ethernet frames coming from WR ports to the CPU.
To enable throttling set @t{CONFIG_NIC_THROTTLING_ENABLED}.
@t{CONFIG_NIC_THROTTLING_VAL} contains maximum allowed bandwidth
in KB/s.
@item CONFIG_MONIT_DISABLE
Disable monitoring of running processes by monit. Monit by default
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment