Skip to content

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

doc: rename network interfaces from wrX to wriX+1 

Signed-off-by: Adam Wujek's avatarAdam Wujek <adam.wujek@cern.ch>
parent 3ebcbe77
Hide whitespace changes
Inline Side-by-side
Showing with 59 additions and 59 deletions
doc/snmp-pain.in
View file @ ea14e362
...@@ -520,7 +520,7 @@ interface is a line. This approach allows the same MIB to work for ...@@ -520,7 +520,7 @@ interface is a line. This approach allows the same MIB to work for
every possible configuration. For WR port statistics we chose a every possible configuration. For WR port statistics we chose a
different approach: the counters themselves are somehow dynamic (they different approach: the counters themselves are somehow dynamic (they
may change across versions, while the gateware develops) while the may change across versions, while the gateware develops) while the
interfaces are restricted to be in the set @t{wr0}--@t{wr17}. interfaces are restricted to be in the set @t{wri1}--@t{wri18}.
So our pStats table is reversed from the common use of @sc{snmp} tables. So our pStats table is reversed from the common use of @sc{snmp} tables.
As a side effect this allows the WR switch to return the name of each As a side effect this allows the WR switch to return the name of each
......
doc/wrs-developer-manual.in
View file @ ea14e362
...@@ -1927,7 +1927,7 @@ The binary image includes 4 files, stored as an @sc{sdb} filesystem: ...@@ -1927,7 +1927,7 @@ The binary image includes 4 files, stored as an @sc{sdb} filesystem:
The MAC address for the management Ethernet port (RJ45, 100Mb/s). The MAC address for the management Ethernet port (RJ45, 100Mb/s).
@item wr0.ethaddr @item wri1.ethaddr
The MAC address for the first fiber port (SFP, 1Gb/s). Other ports The MAC address for the first fiber port (SFP, 1Gb/s). Other ports
are assigned sequential addresses starting from this one. are assigned sequential addresses starting from this one.
...@@ -2068,7 +2068,7 @@ in the boot scripts, as we now extract the mac addresses from sdb. ...@@ -2068,7 +2068,7 @@ in the boot scripts, as we now extract the mac addresses from sdb.
bb> sdb ls /dev/dataflash0.hwinfo bb> sdb ls /dev/dataflash0.hwinfo
46696c6544617461:2e202020 @ 00000000-0000083f . 46696c6544617461:2e202020 @ 00000000-0000083f .
46696c6544617461:7363625f @ 00000240-00000243 scb_version 46696c6544617461:7363625f @ 00000240-00000243 scb_version
46696c6544617461:7772302e @ 00000220-00000231 wr0.ethaddr 46696c6544617461:7772302e @ 00000220-00000231 wri1.ethaddr
46696c6544617461:6d616e75 @ 00000260-0000026f manufacturer 46696c6544617461:6d616e75 @ 00000260-0000026f manufacturer
46696c6544617461:68775f69 @ 00000420-0000083f hw_info 46696c6544617461:68775f69 @ 00000420-0000083f hw_info
46696c6544617461:65746830 @ 00000200-00000211 eth0.ethaddr 46696c6544617461:65746830 @ 00000200-00000211 eth0.ethaddr
...@@ -2078,7 +2078,7 @@ in the boot scripts, as we now extract the mac addresses from sdb. ...@@ -2078,7 +2078,7 @@ in the boot scripts, as we now extract the mac addresses from sdb.
bb> sdb cat /dev/dataflash0.hwinfo hw_info bb> sdb cat /dev/dataflash0.hwinfo hw_info
fpga: LX240T fpga: LX240T
scb_serial: 12345 scb_serial: 12345
bb> sdb set /dev/dataflash0.hwinfo wraddr wr0.ethaddr bb> sdb set /dev/dataflash0.hwinfo wraddr wri1.ethaddr
bb> echo $wraddr bb> echo $wraddr
22:33:44:55:66:77 22:33:44:55:66:77
......
doc/wrs-todo.in
View file @ ea14e362
...@@ -256,7 +256,7 @@ implementation. ...@@ -256,7 +256,7 @@ implementation.
@item WR GrandMaster Switch should be holy provided it has an @item WR GrandMaster Switch should be holy provided it has an
external reference. Currently if we have a GrandMaster Switch and we external reference. Currently if we have a GrandMaster Switch and we
connect a Free-running Master to it's Slave port (wr0) then it becomes connect a Free-running Master to it's Slave port (wri1) then it becomes
Slave to the Free-running Master and jumps it's WR time. All the Slave to the Free-running Master and jumps it's WR time. All the
mechanism is in place, this should be trivial to fix. mechanism is in place, this should be trivial to fix.
......
doc/wrs-user-manual.in
View file @ ea14e362
...@@ -588,10 +588,10 @@ value is changed by the web interface, proper action is taken. ...@@ -588,10 +588,10 @@ value is changed by the web interface, proper action is taken.
Please note that unknown facility names will generate a runtime error Please note that unknown facility names will generate a runtime error
on the switch. on the switch.
@item CONFIG_PORT00_PARAMS @item CONFIG_PORT01_PARAMS
@itemx CONFIG_PORT01_PARAMS @itemx CONFIG_PORT02_PARAMS
@itemx ... @itemx ...
@itemx CONFIG_PORT17_PARAMS @itemx CONFIG_PORT18_PARAMS
These configuration items are used to set up port parameters; These configuration items are used to set up port parameters;
this includes the delays, the PTP role, PTP protocol type this includes the delays, the PTP role, PTP protocol type
...@@ -635,7 +635,7 @@ value is changed by the web interface, proper action is taken. ...@@ -635,7 +635,7 @@ value is changed by the web interface, proper action is taken.
By default, PPSi configuration file is assembled based on role and By default, PPSi configuration file is assembled based on role and
protocol parameters stored in @t{PORTxx_PARAMS}. @t{TIME_BC} selected protocol parameters stored in @t{PORTxx_PARAMS}. @t{TIME_BC} selected
by @i{Kconfig} defaults role of port @t{wr0} to slave, other ports by @i{Kconfig} defaults role of port @t{wri1} to slave, other ports
to master. For @t{TIME_GM} and @t{TIME_FM} all ports are mandated to to master. For @t{TIME_GM} and @t{TIME_FM} all ports are mandated to
master. master.
Parameters @t{clock-class} and @t{clock-accuracy} can be changed Parameters @t{clock-class} and @t{clock-accuracy} can be changed
...@@ -743,12 +743,12 @@ description. ...@@ -743,12 +743,12 @@ description.
This is, for explanation's sake, an example of such items: This is, for explanation's sake, an example of such items:
@smallexample @smallexample
CONFIG_PORT09_PARAMS="name=wr9,proto=raw,tx=226214,rx=226758,role=slave,fiber=2" CONFIG_PORT09_PARAMS="name=wri9,proto=raw,tx=226214,rx=226758,role=slave,fiber=2"
CONFIG_SFP00_PARAMS="pn=AXGE-1254-0531,tx=0,rx=0,wl_txrx=1310+1490" CONFIG_SFP00_PARAMS="pn=AXGE-1254-0531,tx=0,rx=0,wl_txrx=1310+1490"
CONFIG_FIBER02_PARAMS="alpha_1310_1490=2.6787e-04" CONFIG_FIBER02_PARAMS="alpha_1310_1490=2.6787e-04"
@end smallexample @end smallexample
When making timing calculation for port @t{wr9}, assuming the When making timing calculation for port @t{wri9}, assuming the
auto-detected @sc{sfp} model is``AXGE-1254-0531'', the software auto-detected @sc{sfp} model is``AXGE-1254-0531'', the software
uses configuration in the following way: uses configuration in the following way:
...@@ -1149,9 +1149,7 @@ The following tools and scripts are provided: ...@@ -1149,9 +1149,7 @@ The following tools and scripts are provided:
A tool to switch the TX (laser) of a port on and off by use of the @t{TX A tool to switch the TX (laser) of a port on and off by use of the @t{TX
disable} pin on the SFP. Usage ``@t{wrs_port_tx_control <port_no> on}'' disable} pin on the SFP. Usage ``@t{wrs_port_tx_control <port_no> on}''
switches the TX on, and ``@t{wrs_port_tx_control <port_no> off}'' switches the TX on, and ``@t{wrs_port_tx_control <port_no> off}''
switches the TX off. The port number @t{<port_no>} ranges from 0 to the switches the TX off. The port number @t{<port_no>} ranges from 1 to 18.
maximum number of ports on the device minus one, and is currently
limited to 17.
@item wr_date @item wr_date
...@@ -1189,8 +1187,10 @@ The following tools and scripts are provided: ...@@ -1189,8 +1187,10 @@ The following tools and scripts are provided:
@item apply_dot-config @item apply_dot-config
The script is used to apply @t{dot-config} settings to the The script is used to apply @t{dot-config} settings to the
current configuration files. It is run at boot time before current configuration files. It is run at boot time before
any service is started. The @t{dot-config} mechanism is any service is started and by web interface to apply changes in
documented in @ref{Configuration of the Device}. the local dot-config.
The @t{dot-config} mechanism is documented in @ref{Configuration of the
Device}.
@item assembly_ppsi_conf.sh @item assembly_ppsi_conf.sh
The script is used to assembly ppsi configuration file based on The script is used to assembly ppsi configuration file based on
...@@ -1572,8 +1572,8 @@ WR-SWITCH-MIB::wrsPtpRTT.1 = Counter64: 943893 ...@@ -1572,8 +1572,8 @@ WR-SWITCH-MIB::wrsPtpRTT.1 = Counter64: 943893
WR-SWITCH-MIB::wrsPtpLinkLength.1 = Gauge32: 91 WR-SWITCH-MIB::wrsPtpLinkLength.1 = Gauge32: 91
WR-SWITCH-MIB::wrsPtpServoUpdates.1 = Counter32: 33 WR-SWITCH-MIB::wrsPtpServoUpdates.1 = Counter32: 33
[...] [...]
WR-SWITCH-MIB::wrsPortStatusPortName.1 = STRING: wr0 WR-SWITCH-MIB::wrsPortStatusPortName.1 = STRING: wri1
WR-SWITCH-MIB::wrsPortStatusPortName.2 = STRING: wr1 WR-SWITCH-MIB::wrsPortStatusPortName.2 = STRING: wri2
[...] [...]
WR-SWITCH-MIB::wrsPortStatusLink.1 = INTEGER: up(2) WR-SWITCH-MIB::wrsPortStatusLink.1 = INTEGER: up(2)
WR-SWITCH-MIB::wrsPortStatusLink.2 = INTEGER: up(2) WR-SWITCH-MIB::wrsPortStatusLink.2 = INTEGER: up(2)
...@@ -1587,8 +1587,8 @@ WR-SWITCH-MIB::wrsPortStatusSfpVN.2 = STRING: Axcen Photonics ...@@ -1587,8 +1587,8 @@ WR-SWITCH-MIB::wrsPortStatusSfpVN.2 = STRING: Axcen Photonics
WR-SWITCH-MIB::wrsPortStatusSfpPN.1 = STRING: AXGE-3454-0531 WR-SWITCH-MIB::wrsPortStatusSfpPN.1 = STRING: AXGE-3454-0531
WR-SWITCH-MIB::wrsPortStatusSfpPN.2 = STRING: AXGE-3454-0531 WR-SWITCH-MIB::wrsPortStatusSfpPN.2 = STRING: AXGE-3454-0531
[...] [...]
WR-SWITCH-MIB::wrsPstatsHCPortName.1 = STRING: wr0 WR-SWITCH-MIB::wrsPstatsHCPortName.1 = STRING: wri1
WR-SWITCH-MIB::wrsPstatsHCPortName.2 = STRING: wr1 WR-SWITCH-MIB::wrsPstatsHCPortName.2 = STRING: wri2
[...] [...]
WR-SWITCH-MIB::wrsPstatsHCTXFrames.1 = Counter64: 232 WR-SWITCH-MIB::wrsPstatsHCTXFrames.1 = Counter64: 232
WR-SWITCH-MIB::wrsPstatsHCTXFrames.2 = Counter64: 543 WR-SWITCH-MIB::wrsPstatsHCTXFrames.2 = Counter64: 543
...@@ -1639,47 +1639,47 @@ Output is in text form and looks like: ...@@ -1639,47 +1639,47 @@ Output is in text form and looks like:
@smallexample @smallexample
SNMP table: WR-SWITCH-MIB::wrsPstatsHCTable SNMP table: WR-SWITCH-MIB::wrsPstatsHCTable
wrsPstatsHCPortName wrsPstatsHCTXUnderrun wrsPstatsHCRXOverrun wrsPstatsHCRXInvalidCode wrsPstatsHCPortName wrsPstatsHCTXUnderrun wrsPstatsHCRXOverrun
wr0 0 0 0 wri1 0 0
wr1 0 0 0 wri2 0 0
wr2 0 0 0 wri3 0 0
wr3 0 0 0 wri4 0 0
wr4 0 0 0 wri5 0 0
wr5 0 0 0 wri6 0 0
wr6 0 0 0 wri7 0 0
wr7 0 0 0 wri8 0 0
wr8 0 0 0 wri9 0 0
wr9 0 0 0 wri10 0 0
wr10 0 0 0 wri11 0 0
wr11 0 0 0 wri12 0 0
wr12 0 0 0 wri13 0 0
wr13 0 0 0 wri14 0 0
wr14 0 0 0 wri15 0 0
wr15 0 0 0 wri16 0 0
wr16 0 0 0 wri17 0 0
wr17 0 0 0 wri18 0 0
SNMP table WR-SWITCH-MIB::wrsPstatsHCTable, part 2 SNMP table WR-SWITCH-MIB::wrsPstatsHCTable, part 2
wrsPstatsHCRXSyncLost wrsPstatsHCRXPauseFrames wrsPstatsHCRXPfilterDropped wrsPstatsHCRXInvalidCode wrsPstatsHCRXSyncLost wrsPstatsHCRXPauseFrames
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
0 0 0 0 0 0
(...) (...)
@end smallexample @end smallexample
......
doc/wrs_failures/snmp_objects.tex
View file @ ea14e362
...@@ -273,7 +273,7 @@ ...@@ -273,7 +273,7 @@
messages to determine the WR port on which the problem is reported. In messages to determine the WR port on which the problem is reported. In
case of Syslog, you should see a message similar to this one:\\ case of Syslog, you should see a message similar to this one:\\
\texttt{Unknown SFP vn="AVAGO" pn="ABCU-5710RZ" vs="AN1151PD8A" on port \texttt{Unknown SFP vn="AVAGO" pn="ABCU-5710RZ" vs="AN1151PD8A" on port
wr1} wri2}
\item If the reported port is intended to be used to connect a device that \item If the reported port is intended to be used to connect a device that
does not require WR synchronization (e.g. using a copper SFP module), does not require WR synchronization (e.g. using a copper SFP module),
then you should verify whether the role in the timing configuration for then you should verify whether the role in the timing configuration for
......
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