Skip to content

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

doc/wrs-user-manual: sort WRS Command-Line Tools 

Signed-off-by: 's avatarAdam Wujek <dev_public@wujek.eu>
parent 3e9a409f
Show whitespace changes
Inline Side-by-side
Showing with 107 additions and 104 deletions
doc/wrs-user-manual.in
View file @ b2556faa
...@@ -2507,6 +2507,45 @@ The following tools and scripts are provided: ...@@ -2507,6 +2507,45 @@ The following tools and scripts are provided:
@table @file @table @file
@item apply_dot-config
The script is used to apply @t{dot-config} settings to the
current configuration files. It is run at boot time before
any service is started and by the web interface to apply changes in
the local @t{dot-config}.
The @t{dot-config} mechanism is documented in @ref{Configuration of the
Device}.
@item assembly_ppsi_conf.sh
The script is used to assembly ppsi configuration file based on
information stored in @t{dot-config}.
This script is called by @t{apply_dot-config}.
@item change_dot-config
This script changes the current @t{dot-config} file. It is
designed to be the back-end of the web interface, when changing
configuration items. The script does nothing to @i{apply}
the changes, and it only performs editing.
It is the responsibility of the caller to ensure the proper
service is restarted with the new configuration.
@item com
The program is a simple program for talking with serial ports.
@item ethtool
The standad Linux tool used to query or control network driver and
hardware settings. In WRS the number of parameters that this tool can
change is limited. However, this tool can be used to:
``@t{ethtool -s wriX autoneg off}'' disables (or enable if @t{on} is
used) autonegotiation
``@t{ethtool --set-priv-flags wriX "Unidirectional Enable" on}'' enables
(or disables if @t{off} is used) transmit regardless of whether a valid
link has been established
``@t{ethtool --set-priv-flags wriX "Accept RX Jumbo Frames" on}''
accepts (or drops if @t{off} is used) RX Jumbo Frames
@item lm32-vuart @item lm32-vuart
The tool allows connecting to the virtual UART of the LM32 soft-core CPU. The tool allows connecting to the virtual UART of the LM32 soft-core CPU.
It can be used to observe log messages from the SoftPLL (the same as It can be used to observe log messages from the SoftPLL (the same as
...@@ -2514,9 +2553,9 @@ The following tools and scripts are provided: ...@@ -2514,9 +2553,9 @@ The following tools and scripts are provided:
physical UART port available in the back of a WR switch). Use physical UART port available in the back of a WR switch). Use
@code{Ctrl+C} escape combination to go back to WR Switch Linux shell. @code{Ctrl+C} escape combination to go back to WR Switch Linux shell.
@item load-virtex
@itemx load-lm32
@item load-lm32
@itemx load-virtex
They load into the FPGA the gateware and the LM32 application. They load into the FPGA the gateware and the LM32 application.
They are used by the init scripts of the Linux system. The LM32 They are used by the init scripts of the Linux system. The LM32
loader can also change variables in the loaded binary, and loader can also change variables in the loaded binary, and
...@@ -2533,35 +2572,15 @@ The following tools and scripts are provided: ...@@ -2533,35 +2572,15 @@ The following tools and scripts are provided:
They are classic tools distributed in the @i{Linux Device Drivers} They are classic tools distributed in the @i{Linux Device Drivers}
examples since 1998. examples since 1998.
@item com @item sdb-read
The program is a simple program for talking with serial ports. The tool, copied from the @t{fpga-config-space} project,
is documented in the next section,
@item wr_phytool
A tool to read and write PHY registers in the switch.
@item wr_mon
A simple monitor of White Rabbit status. It prints to @i{stdout}
using the standard escape sequences for color output. Please check
@t{wr_mon}'s help (@t{--help} parameter) for further information.
(This is probably the most important diagnostic tool on the switch.)
@item wrs_pps_control
A tool to manually enable/disable/read status of PPS output.
It can also enable/disable/read status of the 50ohm termination for 1-PPS input.
Usage:
``@t{wrs_pps_control pps on}'' enables the PPS output,
``@t{wrs_pps_control pps off}'' disables the PPS output,
``@t{wrs_pps_control pps read}'' checks whether PPS output is enabled or disabled.
Switching the output on/off is independent @item shw_ver
of the PPSi process, but PPSi switches the PPS output back on when a A symbolic link to @t{wrs_version}, to be compatible with
link restart is detected and PPSi comes into @t{'TRACK_PHASE'} state. older versions that used this tool name. The name is
To on/off/read the 50ohm termination for 1-PPS input use inconsistent with anything else in the switch, so it was
@t{wrs_pps_control} with a parameter @t{50ohm-term-in} followed by replaced.
@t{on}, @t{off} or @t{read}.
@item wr_date @item wr_date
@anchor{wr_date} @anchor{wr_date}
...@@ -2587,50 +2606,36 @@ The following tools and scripts are provided: ...@@ -2587,50 +2606,36 @@ The following tools and scripts are provided:
White Rabbit time. This can be useful in slave switches that White Rabbit time. This can be useful in slave switches that
are not synced to NTP at boot. are not synced to NTP at boot.
@item wrs_version @item wr_mon
Print information about the software, gateware, hardware version of the WRS. A simple monitor of White Rabbit status. It prints to @i{stdout}
Please check the help message. using the standard escape sequences for color output. Please check
@t{wr_mon}'s help (@t{--help} parameter) for further information.
(This is probably the most important diagnostic tool on the switch.)
@item shw_ver @item wr_phytool
A symbolic link to @t{wrs_version}, to be compatible with A tool to read and write PHY registers in the switch.
older versions that used this tool name. The name is
inconsistent with anything else in the switch, so it was
replaced.
@item wrs_vlans @item wrs_auxclk
The tool allows to configure VLAN settings The tool allows to setup the parameters of a clock generated on the
for each port and for the RTU daemon. The @t{--help} option @i{clk2} SMC output on the front panel.
lists all configuration items of the tool. For details please
refer to the @ref{wrs_vlans}.
@item apply_dot-config @item wrs_pps_control
The script is used to apply @t{dot-config} settings to the A tool to manually enable/disable/read status of PPS output.
current configuration files. It is run at boot time before It can also enable/disable/read status of the 50ohm termination for 1-PPS input.
any service is started and by the web interface to apply changes in Usage:
the local @t{dot-config}.
The @t{dot-config} mechanism is documented in @ref{Configuration of the
Device}.
@item assembly_ppsi_conf.sh ``@t{wrs_pps_control pps on}'' enables the PPS output,
The script is used to assembly ppsi configuration file based on
information stored in @t{dot-config}.
This script is called by @t{apply_dot-config}.
@item change_dot-config ``@t{wrs_pps_control pps off}'' disables the PPS output,
This script changes the current @t{dot-config} file. It is
designed to be the back-end of the web interface, when changing
configuration items. The script does nothing to @i{apply}
the changes, and it only performs editing.
It is the responsibility of the caller to ensure the proper
service is restarted with the new configuration.
@item sdb-read ``@t{wrs_pps_control pps read}'' checks whether PPS output is enabled or disabled.
The tool, copied from the @t{fpga-config-space} project,
is documented in the next section,
@item wrs_auxclk Switching the output on/off is independent
The tool allows to setup the parameters of a clock generated on the @i{clk2} of the PPSi process, but PPSi switches the PPS output back on when a
SMC output on the front panel. link restart is detected and PPSi comes into @t{'TRACK_PHASE'} state.
To on/off/read the 50ohm termination for 1-PPS input use
@t{wrs_pps_control} with a parameter @t{50ohm-term-in} followed by
@t{on}, @t{off} or @t{read}.
@item wrs_pstats @item wrs_pstats
The tool is used to read various per-port statistics counters from the The tool is used to read various per-port statistics counters from the
...@@ -2661,20 +2666,18 @@ The following tools and scripts are provided: ...@@ -2661,20 +2666,18 @@ The following tools and scripts are provided:
information, please refer to the information, please refer to the
@ref{Configuration Items that Apply at Run Time}. @ref{Configuration Items that Apply at Run Time}.
@item ethtool @item wrs_version
The standad Linux tool used to query or control network driver and hardware Print information about the software, gateware, hardware version of the WRS.
settings. In WRS the number of parameters that this tool can change is Please check the help message.
limited. However, this tool can be used to:
``@t{ethtool -s wriX autoneg off}'' disables (or enable if @t{on} is used)
autonegotiation
``@t{ethtool --set-priv-flags wriX "Unidirectional Enable" on}'' enables @item wrs_vlans
(or disables if @t{off} is used) transmit regardless of whether a valid link The tool allows to configure VLAN settings
has been established for each port and for the RTU daemon. The @t{--help} option
lists all configuration items of the tool. For details please
refer to the @ref{wrs_vlans}.
``@t{ethtool --set-priv-flags wriX "Accept RX Jumbo Frames" on}'' accepts @item wmapper
(or drops if @t{off} is used) RX Jumbo Frames See @t{mapper}.
@c FIXME: document rtu_stat spll_dbg_proxy @c FIXME: document rtu_stat spll_dbg_proxy
@end table @end table
......
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