Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
W
White Rabbit Switch - Software
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
86
Issues
86
List
Board
Labels
Milestones
Merge Requests
4
Merge Requests
4
CI / CD
CI / CD
Pipelines
Schedules
Wiki
Wiki
image/svg+xml
Discourse
Discourse
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Projects
White Rabbit Switch - Software
Commits
32169dbc
Commit
32169dbc
authored
Jan 21, 2020
by
Jean-Claude BAU
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
wrs-user_manual updated for version 6.0.0
parent
976c6328
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
496 additions
and
173 deletions
+496
-173
wrs-user-manual.in
doc/wrs-user-manual.in
+496
-173
No files found.
doc/wrs-user-manual.in
View file @
32169dbc
...
...
@@ -35,17 +35,22 @@
@setchapternewpage off
@set update-month
August 2017
@set update-month
February 2020
@c the release name below is substituted at build time
@set release
__
RELEASE
_
GIT
_
ID
__
@comment
%**useful declaration used in the document
@set release
_
version 6.0
@set release
_
version
_
tiny 0
@set url
_
docs https://www.ohwr.org/project/wr-switch-sw/wikis/Documents#files
@finalout
@titlepage
@title White Rabbit Switch: User's Manual
@subtitle Information about configuring the White Rabbit switch, for final users
@subtitle @value
{
update-month
}
(@value
{
release
}
)
@author A
lessandro Rubini, Adam Wujek, Benoit Rat, Federico Vaga,
...
@author A
. Rubini, A. Wujek, B. Rat, F. Vaga, J-C. Bau
...
@end titlepage
@headings single
...
...
@@ -111,7 +116,7 @@ This is the current set of manuals that accompany the @sc{wrs}:
The official @sc
{
pdf
}
copy of these manuals at each release
is published in the @i
{
files
}
tab of the software project in @t
{
ohwr.org
}
:
(@ur
l
{
http://www.ohwr.org/projects/wr-switch-sw/files
}
).
(@ur
ef
{
@value
{
url
_
docs
}}
)
).
This doesn't apply to release v4.0 and earlier.
The source form of all four manuals is maintained in @t
{
wr-switch-sw/doc
}
.
...
...
@@ -131,7 +136,8 @@ device.
Very few specimens of @t
{
wrs
}
3.0 though 3.2 were manufactured; if you
are the owner of one of them, please refer to version 3.3 of the
@i
{
wrs-build
}
document, that includes appendixes about using older
versions. As usual, it is in the @i
{
files
}
tab of @t
{
ohwr.org
}
.
versions. As usual, it is in the @i
{
files
}
tab of
@t
{
@uref
{
@value
{
url
_
docs
}}}
.
V1 and V2 were development items, never shipped.
...
...
@@ -158,7 +164,7 @@ Additionally, the @t{wrs-firmware.tar} containing corrupted file is renamed to
the next successful update.
When checksums in the @t
{
wrs-firmware.tar
}
are not available
(for example during downgrading to version pre-
5.0
) appropriate warning
(for example during downgrading to version pre-
@value
{
release
_
version
}
) appropriate warning
message is printed to the console.
If this method of upgrading firmware works for you, you can ignore the rest of
...
...
@@ -167,10 +173,10 @@ explains a transition between the initial way we passed MAC addresses
and the safer approach we introduced in v4.1
@c ==========================================================================
@node Upgrade from pre-v5.0 to v
5.0
@section Upgrade from pre-v5.0 to v
5.0
@node Upgrade from pre-v5.0 to v
@value
{
release
_
version
}
@section Upgrade from pre-v5.0 to v
@value
{
release
_
version
}
During the update from the pre-v5.0 firmware to v
5.0
(or later) you might see
During the update from the pre-v5.0 firmware to v
@value
{
release
_
version
}
(or later) you might see
the following errors on the console.
@example
/wr/bin/sdb-read: can't load library 'libm.so.1'
...
...
@@ -207,8 +213,8 @@ When upgrading from a pre-4.1 switch software, you need to create this
need to be aware of the steps involved, in case something goes wrong.
@c ==========================================================================
@node Upgrading from v4.0
@section Upgrading from v4.0
@node Upgrading from v4.0
and later
@section Upgrading from v4.0
and later
Version 4.0 and later of @t
{
wr-switch-sw
}
are able to upgrade
themselves if you place the proper files in the @i
{
/update
}
directory
...
...
@@ -228,7 +234,7 @@ you prefer we can't tell. Both work, each with its own drawbacks.
Each of them preserves the current MAC addresses.
@c =-------------------------------------------------------------------------
@node Upgrading
from v4.0
with the USB cable
@node Upgrading with the USB cable
@subsection Upgrading from v4.0 with the USB cable
This is the procedure if you are able to walk to your @sc
{
wrs
}
and
...
...
@@ -309,7 +315,7 @@ access to the device and, unfortunately, requires some extra steps
especially if you want to preserve your MAC addresses.
One possible path is flashing version 4.0 (please refer to v4.0
manuals) and then proceed as described in @ref
{
Upgrading from v4.0
}
.
manuals) and then proceed as described in @ref
{
Upgrading from v4.0
and later
}
.
When flashing version 4.0 you'll need to pass your MAC addresses on
the command line of the flasher, so please take note of what they are.
...
...
@@ -387,7 +393,7 @@ The configuration step creates @t{.config}, that you can copy to your
choices in effect.
The first three configuration items are free-text fields which are intended for
dot-config management purposed. As now (v
5.0.1
) these fields are not used for
dot-config management purposed. As now (v
@value
{
release
_
version
}
.@value
{
release
_
version
_
tiny
}
) these fields are not used for
any functionality on the switch.
@table @t
...
...
@@ -426,12 +432,20 @@ sources are implemented in current version:
Server can be configured in a way to provide the entire URL to
the @t
{
dot-config
}
in the ``@t
{
filename
}
'' configuration field of the
DHCP server. In this case, provided URL has to be in the same form
as @t
{
CONFIG
_
DOTCONF
_
URL
}
.
as @t
{
CONFIG
_
DOTCONF
_
URL
}
.
As an alternative, ``@t
{
filename
}
'' can be configured only as a
path. It will be then interpreted as a path on a TFTP server, which IP
address is taken from the configuration field
``@t
{
The BOOTP next server option
}
'' of a DHCP server.
If the DHCP service is not available at boot time, the switch will wait
forever until it has obtained the DHCP lease from server. If the DHCP server is reachable
but switch fails to download @t
{
dot-config
}
file then it will
cause errors in SNMP's objects.
This choice is only available if CONFIG
_
ETH0
_
DHCP is chosen for network configuration.
@item CONFIG
_
DOTCONF
_
SOURCE
_
TRY
_
DHCP
The same as @t
{
CONFIG
_
DOTCONF
_
SOURCE
_
FORCE
_
DHCP
}
, but this option does
...
...
@@ -650,11 +664,14 @@ appropriate way, before the respective service is started.
@item CONFIG
_
REMOTE
_
SYSLOG
_
SERVER
@itemx CONFIG
_
REMOTE
_
SYSLOG
_
UDP
@itemx CONFIG
_
LOCAL
_
SYSLOG
_
FILE
Configuration for system log. The name (or IP address) of the
server is stored in @t
{
/etc/rsyslog.conf
}
of the runtime
filesystem. The UDP option, set by default, chooses UDP transmission;
if unset it selects TCP communication.
@t
{
CONFIG
_
LOCAL
_
SYSLOG
_
FILE
}
option indicates the file to which syslog messages will be stored.
The file is rotated when reaching 1MB. If remote
server is specified, the messages go to both, server and local file.
@item CONFIG
_
WRS
_
LOG
_
HAL
@itemx CONFIG
_
WRS
_
LOG
_
RTU
...
...
@@ -742,52 +759,51 @@ appropriate way, before the respective service is started.
Please note that unknown facility names will generate a runtime error
on the switch.
@item CONFIG
_
PORT01
_
PARAMS
@itemx CONFIG
_
PORT02
_
PARAMS
@item CONFIG
_
LEAPSEC
_
SOURCE
_
LOCAL
@itemx CONFIG
_
LEAPSEC
_
SOURCE
_
REMOTE
_
FORCE
@itemx CONFIG
_
LEAPSEC
_
SOURCE
_
REMOTE
_
TRY
@itemx CONFIG
_
LEAPSEC
_
URL
The @t
{
/etc/leap-seconds.list
}
file is used to get the current TAI offset.@xref
{
wr
_
date
}
.
The @t
{
CONFIG
_
LEAPSEC
_
SOURCE
_
LOCAL
}
choice forces to use the local version,
if exists, of @t
{
/etc/leap-seconds.list
}
file.
@t
{
CONFIG
_
LEAPSEC
_
SOURCE
_
REMOTE
_
FORCE
}
and @t
{
CONFIG
_
LEAPSEC
_
SOURCE
_
REMOTE
_
TRY
}
choices are
acting in the same way. The @t
{
leap-seconds.list
}
is read remotely using the URL
defined in @t
{
CONFIG
_
LEAPSEC
_
URL
}
using the same format as @t
{
CONFIG
_
DOTCONF
_
URL
}
. If the
downloaded file is newer than the local @t
{
/etc/leap-seconds.list
}
file, it will replace it.
Unlike @t
{
CONFIG
_
LEAPSEC
_
SOURCE
_
REMOTE
_
FORCE
}
, @t
{
CONFIG
_
LEAPSEC
_
SOURCE
_
REMOTE
_
TRY
}
option does
not cause errors in SNMP's objects if switch fails to download the file.
@item CONFIG
_
PTP
_
OPT
_
EXT
_
PORT
_
CONFIG
_
ENABLED
@itemx CONFIG
_
PORT@i
{
xx
}_
@i
{
zz
}
@itemx ...
@itemx CONFIG
_
PORT18
_
PARAMS
These configuration items are used to set up timing parameters of the
WR ports:
WR port.
Items build using the format @t
{
CONFIG
_
PORT@i
{
xx
}_
@i
{
zz
}}
are composed of :
@itemize
@item @t
{
name
}
-- the name of a given interface
@item @t
{
proto
}
-- PTP protocol type to be used on particular
port; possible values:
@itemize
@item @t
{
raw
}
-- use raw Ethernet frames for timing
@item @t
{
udp
}
-- use UDP packets for timing
@end itemize
@item @t
{
tx
}
-- TX delay of a port in picoseconds
@item @t
{
rx
}
-- RX delay of a port in picoseconds
@item @t
{
role
}
-- PTP role of a port; possible values:
@itemize
@item @t
{
master
}
-- configure port as WR master
@item @t
{
slave
}
-- configure port as WR slave
@item @t
{
auto
}
-- when a port is connected to master
behave as a slave, otherwise behave
as master
@item @t
{
non-wr
}
-- for this port don't report SNMP
errors like: SFP not in DB,
copper SFP connected, non 1GB
SFP etc. This role should be used
for synchronizing regular IEEE-1588
slaves.
@item @t
{
none
}
-- disable White Rabbit and PTP on a
port
@end itemize
@item @t
{
fiber
}
-- fiber index from @t
{
CONFIG
_
FIBERXX
_
PARAMS
}
that is connected to this port
@end itemize
@item @i
{
xx
}
-- represent the port number ('01' to '18')
@item @i
{
yy
}
-- the item signification for the given port @i
{
xx
}
@end itemize
Most likely the default values work for you.
See @ref
{
Timing Configuration
}
for details.
Most likely the default values work for you.
See @ref
{
Timing Configuration
}
for details.
@item CONFIG
_
SFP00
_
PARAMS
@item CONFIG
_
N
_
SFP
_
ENTRIES
@itemx CONFIG
_
SFP00
_
PARAMS
@itemx ...
@itemx CONFIG
_
SFP09
_
PARAMS
Configuration for @sc
{
sfp
}
models. You should fill
@itemx CONFIG
_
SFP17
_
PARAMS
Configuration for @sc
{
sfp
}
models.
@t
{
CONFIG
_
N
_
SFP
_
ENTRIES
}
indicates number of available SFP entries defined. Up to 18 SFPs
can be defined.
@t
{
CONFIG
_
SFP@i
{
xx
}_
PARAMS
}
with index @i
{
xx
}
in range 00 to 17, contains @sc
{
sfp
}
parameters.
You should fill
all @sc
{
sfp
}
models and all
wavelengths you are using in your @sc
{
wrs
}
@itemize
...
...
@@ -805,149 +821,201 @@ appropriate way, before the respective service is started.
@end itemize
See @ref
{
Timing Configuration
}
for details.
@item CONFIG
_
N
_
FIBER
_
ENTRIES
@item CONFIG
_
FIBER00
_
PARAMS
@itemx ...
@itemx CONFIG
_
FIBER
03
_
PARAMS
@itemx CONFIG
_
FIBER
17
_
PARAMS
This parameter specifies the physical features of used fiber types.
Specify the alpha value for each pair of used wavelengths.
@t
{
CONFIG
_
N
_
FIBER
_
ENTRIES
}
indicates number of available fiber type entries defined. Up to 18
different fiber types can be defined.
@t
{
CONFIG
_
FIBER@i
{
xx
}_
PARAMS
}
with index @i
{
xx
}
in range 00 to 17, specifies the alpha value for each pair of used wavelengths.
This parameter follows a format:
@t
{
alpha
_
XXXX
_
YYYY=1.23e-04,alpha
_
AAAA
_
BBBB
=4.56e-04,...
}
@t
{
alpha
_
@i
{
xxxx
}_
@i
{
yyyy
}
=1.23e-04,alpha
_
@i
{
aaaa
}_
@i
{
bbbb
}
=4.56e-04,...
}
Where:
@itemize
@item @t
{
XXX
_
YYYY
}
and @t
{
AAAA
_
BBBB
}
are pairs of used wavelengths
@item @t
{
@i
{
xxxx
}_
@i
{
yyyy
}}
and @t
{
@i
{
aaaa
}_
@i
{
bbbb
}
}
are pairs of used wavelengths
@item @t
{
1.23e-04
}
and @t
{
4.56e-04
}
are alpha values to be used for
particular wavelengths.
@end itemize
The index (@t
{
00
}
onwards) is used to match the port
(@t
{
CONFIG
_
PORTxx
_
PARAMS
}
) with one of several installed fiber types.
See @ref
{
Timing Configuration
}
for details.
The index (@t
{
00
}
onwards) is used by the @t
{
CONFIG
_
PORT@i
{
xx
}_
FIBER
}
port parameter to
reference the connected fiber type. @xref
{
Timing Configuration
}
.
You are expected to have no more than
4
fiber types installed in
You are expected to have no more than
18
fiber types installed in
your deployment.
@item CONFIG
_
TIME
_
GM
@itemx CONFIG
_
TIME
_
ARB
_
GM
@itemx CONFIG
_
TIME
_
FM
@itemx CONFIG
_
TIME
_
BC
@itemx CONFIG
_
TIME
_
CUSTOM
The type of PTP clock this switch is. Only one of the
three
The type of PTP clock this switch is. Only one of the
five first
items should be set (e.g. running ``@t
{
make menuconfig
}
'' offers
them as an exclusive choice). The options select: a grand-master (GM)
with external reference, e.g. GPS or Cesium; a free-running
master (FM), used for isolated acquisition networks, without an
external reference; or a normal ``boundary-clock'' (BC) device that
is slave on some ports and master on other ports.
The PTP's clockClass is set based on which option is selected.
For the GM the clockClass is 6, for the FM is 52, for the BC is 248.
@item CONFIG
_
PTP
_
PORT
_
PARAMS
@itemx CONFIG
_
PTP
_
CUSTOM
@itemx CONFIG
_
PTP
_
REMOTE
_
CONF
By default, PTP daemon (PPSi) configuration file is assembled based on role and
protocol parameters stored in @t
{
PORTxx
_
PARAMS
}
. If VLANs are
configured, the items
@t
{
CONFIG
_
VLANS
_
PORTXX
_
VID
}
are used as well.
Parameters @t
{
clock-class
}
and @t
{
clock-accuracy
}
can be changed
or new global PPSi settings can be added by editing file
@t
{
/wr/etc/ppsi-pre.conf
}
, which is used as beginning of final
PPSi configuration file.
Alternatively, PPSi can use a custom user file for configuration
(@t
{
CONFIG
_
PTP
_
CUSTOM
}
).
Finally, you can choose @t
{
PTP
_
REMOTE
_
CONF
}
to
specify an URL whence the switch will download the @t
{
ppsi.conf
}
at
boot time.
Please see the help provided within @i
{
Kconfig
}
for more details about
the various options we support.
@item CONFIG
_
PTP
_
CUSTOM
_
FILENAME
If you chose @t
{
CONFIG
_
PTP
_
CUSTOM
}
in the choice above, you
can provide your own filename for the PPSi configuration file;
the chosen name is expected to be installed in the @sc
{
wrs
}
filesystem.
@item CONFIG
_
PTP
_
CONF
_
URL
If you choose @t
{
CONFIG
_
PTP
_
REMOTE
_
CONF
}
specify an URL
(@t
{
http://
}
, @t
{
ftp://
}
or @t
{
tftp://
}
) whence
the switch will download the @t
{
ppsi.conf
}
at boot time.
The filename in the URL can include @t
{
HOSTNAME
}
, @t
{
IPADDR
}
and/or @t
{
MACADDR
}
, so the same configuration string can be used to set
up a batch of switches with different configurations (similar to the
@t
{
CONFIG
_
DOTCONF
_
URL
}
, please refer to @ref
{
The Configuration File
}
).
them as an exclusive choice). The options select:
@itemize
@item @t
{
CONFIG
_
TIME
_
GM
}
a grand-master with external reference, e.g. GPS or Cesium.
@item @t
{
CONFIG
_
TIME
_
ARB
_
GM
}
a arbitrary grand-master which designates
a clock that is synchronized to an application-specific source of time.
@item @t
{
CONFIG
_
TIME
_
FM
}
a free-running master (FM), used for isolated
acquisition networks, without an external reference.
@item @t
{
CONFIG
_
TIME
_
BC
}
a normal ``boundary-clock'' device that
is slave on some ports and master on other ports.
@item @t
{
CONFIG
_
TIME
_
CUSTOM
}
an option which leave the possibility to define freely the clock class.
@end itemize
@item CONFIG
_
PTP
_
OPT
_
CLOCK
_
CLASS
An attribute defining the TAI traceability, synchronization state and
expected performance of the time or frequency distributed by a
Boundary Clock or Ordinary Clock.
Its value can be set only if @t
{
CONFIG
_
TIME
_
CUSTOM
}
parameter is selected. The following table shows the default value
used depending on the timing mode ''@t
{
CONFIG
_
TIME
_
@i
{
xx
}}
'' choice:
@multitable @columnfractions .3 .4
@headitem Timing mode @tab CONFIG
_
PTP
_
OPT
_
CLOCK
_
CLASS
@item CONFIG
_
TIME
_
GM @tab 6
@item CONFIG
_
TIME
_
ARB
_
GM @tab 13
@item CONFIG
_
TIME
_
FM @tab 193
@item CONFIG
_
TIME
_
BC @tab 248
@end multitable
For more details please refer to the IEEE 1588-2008 standard.
If set, this configuration item overwrites the default value from
ppsi-pre.conf during generation of ppsi.conf.
@item CONFIG
_
PTP
_
OPT
_
CLOCK
_
ACCURACY
An attribute defining the accuracy of the Local Clock (e.g. local
oscillator) of a Boundary Clock or Ordinary Clock.
For more details please refer to the IEEE 1588-2008 standard.
If set, this configuration item overwrites the default value from
ppsi-pre.conf during generation of ppsi.conf.
By default its value is set automatically according to the timing mode ''@t
{
CONFIG
_
TIME
_
@i
{
xx
}}
'' choice.
However a value can be manually set either the option @t
{
CONFIG
_
PTP
_
OPT
_
OVERWRITE
_
ATTRIBUTES
}
is set
or the timing mode ``@t
{
CONFIG
_
TIME
_
CUSTOM
}
`` is selected.
The following table gives the default values depending on the timing mode ''@t
{
CONFIG
_
TIME
_
@i
{
xx
}}
'' choice :
@multitable @columnfractions .3 .4
@headitem Timing mode @tab CONFIG
_
PTP
_
OPT
_
CLOCK
_
ACCURACY
@item CONFIG
_
TIME
_
GM @tab 33
@item CONFIG
_
TIME
_
ARB
_
GM @tab 33
@item CONFIG
_
TIME
_
FM @tab 32
@item CONFIG
_
TIME
_
BC @tab 254
@end multitable
For more details please refer to the IEEE 1588-2008 standard.
@item CONFIG
_
PTP
_
OPT
_
CLOCK
_
ALLAN
_
VARIANCE
An attribute defining the stability of the Local Clock of a
Boundary Clock or Ordinary Clock.
By default its value is set automatically according to the timing mode ''@t
{
CONFIG
_
TIME
_
@i
{
xx
}}
'' choice.
However a value can be manually set either the option @t
{
CONFIG
_
PTP
_
OPT
_
OVERWRITE
_
ATTRIBUTES
}
is set
or the timing mode ``@t
{
CONFIG
_
TIME
_
CUSTOM
}
`` is selected.
The following table gives the default values depending on the timing mode ''@t
{
CONFIG
_
TIME
_
@i
{
xx
}}
'' choice :
@multitable @columnfractions .3 .4
@headitem Timing mode @tab CONFIG
_
PTP
_
OPT
_
CLOCK
_
ALLAN
_
VARIANCE
@item CONFIG
_
TIME
_
GM @tab 47360
@item CONFIG
_
TIME
_
ARB
_
GM @tab 47360
@item CONFIG
_
TIME
_
FM @tab 50973
@item CONFIG
_
TIME
_
BC @tab 65535
@end multitable
For more details please refer to the IEEE 1588-2008 standard.
If set, this configuration item overwrites the default value from
ppsi-pre.conf during generation of ppsi.conf.
@item CONFIG
_
PTP
_
OPT
_
TIME
_
SOURCE
This information-only attribute indicates the source of time used
by the grandmaster (or free-running master).
The following table gives the default values depending on the timing mode ''@t
{
CONFIG
_
TIME
_
@i
{
xx
}}
'' choice :
@multitable @columnfractions .3 .4
@headitem Timing mode @tab CONFIG
_
PTP
_
OPT
_
TIME
_
SOURCE
@item CONFIG
_
TIME
_
GM @tab 32 (GNSS)
@item CONFIG
_
TIME
_
ARB
_
GM @tab 32 (GNSS)
@item CONFIG
_
TIME
_
FM @tab 160 (INTERNAL
_
OSCILLATOR)
@item CONFIG
_
TIME
_
BC @tab --
@end multitable
@item CONFIG
_
PTP
_
OPT
_
DOMAIN
_
NUMBER
A domain consists of one or more PTP devices communicating with each
other as defined by the PTP protocol. A domain defines the scope of
PTP message communication, state, operations, data sets, and
timescale. PTP devices may participate in multiple domains.
For more details please refer to the IEEE 1588-2008 standard.
If set, this configuration item overwrites the default value from
ppsi-pre.conf during generation of ppsi.conf.
@item CONFIG
_
PTP
_
OPT
_
ANNOUNCE
_
INTERVAL
The mean time interval between transmissions of successive
Announce messages.
If set, this configuration item overwrites the default value from
ppsi-pre.conf during generation of ppsi.conf.
@item CONFIG
_
PTP
_
OPT
_
SYNC
_
INTERVAL
The mean time interval between transmission of successive
Sync messages, i.e., the sync-interval, when transmitted
as multicast messages. The value is the logarithm to the base 2.
If set, this configuration item overwrites the default value from
ppsi-pre.conf during generation of ppsi.conf.
@item CONFIG
_
PTP
_
OPT
_
PRIORITY1
A user configurable designation that a clock belongs to an ordered
set of PTP devices from which a PTP Master is selected.
For more details please refer to the IEEE 1588-2008 standard.
If set, this configuration item overwrites the default value from
ppsi-pre.conf during generation of ppsi.conf.
@item CONFIG
_
PTP
_
OPT
_
PRIORITY2
A user configurable designation that provides finer grained ordering
among otherwise equivalent PTP devices.
For more details please refer to the IEEE 1588-2008 standard.
If set, this configuration item overwrites the default value from
ppsi-pre.conf during generation of ppsi.conf.
@item CONFIG
_
PTP
_
OPT
_
TIME
_
SOURCE
This information-only attribute indicates the source of time used
by the grandmaster (or free-running master).
@item CONFIG
_
PORT@i
{
xx
}_
@i
{
zz
}
@itemx CONFIG
_
PTP
_
CUSTOM
@itemx CONFIG
_
PTP
_
REMOTE
_
CONF
By default, PTP daemon (PPSi) configuration file is assembled based on parameters stored
in @t
{
CONFIG
_
PORT@i
{
xx
}_
@i
{
zz
}}
parameters.
If VLANs are configured, the items @t
{
CONFIG
_
VLANS
_
PORT@i
{
xx
}_
VID
}
are used as well.
New global PPSi settings can be added by editing file
@t
{
/wr/etc/ppsi-pre.conf
}
, which is used as beginning of final
PPSi configuration file.
Alternatively, PPSi can use a custom user file for configuration (@t
{
CONFIG
_
PTP
_
CUSTOM
}
).
Finally, you can choose @t
{
PTP
_
REMOTE
_
CONF
}
to
specify an URL whence the switch will download the @t
{
ppsi.conf
}
at
boot time.
Please see the help provided within @i
{
Kconfig
}
for more details about
the various options we support.
@item CONFIG
_
PTP
_
CUSTOM
_
FILENAME
NOTE: This is not supported yet by the PPSi.
If you chose @t
{
CONFIG
_
PTP
_
CUSTOM
}
in the choice above, you
can provide your own filename for the PPSi configuration file;
the chosen name is expected to be installed in the @sc
{
wrs
}
filesystem.
@item CONFIG
_
PTP
_
CONF
_
URL
If you choose @t
{
CONFIG
_
PTP
_
REMOTE
_
CONF
}
specify an URL
(@t
{
http://
}
, @t
{
ftp://
}
or @t
{
tftp://
}
) whence
the switch will download the @t
{
ppsi.conf
}
at boot time.
The filename in the URL can include @t
{
HOSTNAME
}
, @t
{
IPADDR
}
and/or @t
{
MACADDR
}
, so the same configuration string can be used to set
up a batch of switches with different configurations (similar to the
@t
{
CONFIG
_
DOTCONF
_
URL
}
, please refer to @ref
{
The Configuration File
}
).
@item CONFIG
_
PPSGEN
_
PTP
_
FALLBACK
@itemx CONFIG
_
PPSGEN
_
PTP
_
THRESHOLD
_
MS
@itemx CONFIG
_
PPSGEN
_
GM
_
DELAY
_
TO
_
GEN
_
PPS
_
SEC
@itemx CONFIG
_
PPSGEN
_
FORCE
Configuration of the PPS output. By default, the PPS is generated on a grand master switch
only when the timing mode is set either to @t
{
CONFIG
_
TIMING
_
GM
}
or @t
{
CONFIG
_
TIME
_
FM
}
.
However the @t
{
CONFIG
_
PPSGEN
_
FORCE
}
option, if activated, leaves the possibility to force the PPS
generation all the time.
When a switch becomes grand master by BMCA, the @t
{
CONFIG
_
PPSGEN
_
GM
_
DELAY
_
TO
_
GEN
_
PPS
_
SEC
}
option
, if it contains a value greater than 0, defines a delay in seconds to respect before
to start the PPS generation.
The @t
{
CONFIG
_
PPSGEN
_
PTP
_
THRESHOLD
_
MS
}
option defines the threshold corresponding to the offset from the
master used to start the generation of the PPS. It is either used by a PTP slave
instance or a instance using a protocol extension but going into the fallback PTP mode
and with the PTP fallback option active.
A 0 value means that the PPS will be not generated for the considered cases.
When the PPS is generated, it can be also disabled when the offset from master becomes greater
than the threshold value + 20
%
The latest @t
{
CONFIG
_
PPSGEN
_
PTP
_
FALLBACK
}
option, if activated, enables the PPS generation if a slave instance
programmed to use an extension protocol (WR, L1Sync, ...) is falling back
to PTP communication only.
@item CONFIG
_
SNMP
_
TRAPSINK
_
ADDRESS
@itemx CONFIG
_
SNMP
_
TRAP2SINK
_
ADDRESS
@itemx CONFIG
_
SNMP
_
RO
_
COMMUNITY
...
...
@@ -987,6 +1055,36 @@ appropriate way, before the respective service is started.
@c Error if frame rate of any RX priority exceed given value.
@c (currently not implemented)
@item CONFIG
_
SNMP
_
SYSTEM
_
CLOCK
_
MONITOR
_
ENABLED
@itemx CONFIG
_
SNMP
_
SYSTEM
_
CLOCK
_
DRIFT
_
THOLD
@itemx CONFIG
_
SNMP
_
SYSTEM
_
CLOCK
_
UNIT
_
DAYS
@itemx CONFIG
_
SNMP
_
SYSTEM
_
CLOCK
_
UNIT
_
HOURS
@itemx CONFIG
_
SNMP
_
SYSTEM
_
CLOCK
_
UNIT
_
MINUTES
@itemx CONFIG
_
SNMP
_
SYSTEM
_
CLOCK
_
CHECK
_
INTERVAL
_
DAYS
@itemx CONFIG
_
SNMP
_
SYSTEM
_
CLOCK
_
CHECK
_
INTERVAL
_
HOURS
@itemx CONFIG
_
SNMP
_
SYSTEM
_
CLOCK
_
CHECK
_
INTERVAL
_
MINUTES
When @t
{
CONFIG
_
SNMP
_
SYSTEM
_
CLOCK
_
MONITOR
_
ENABLED
}
option is set,
the local system time is compared to the time
returned by the NTP server (@t
{
CONFIG
_
NTP
_
SERVER
}
). If the difference
of time exceed a given threshold (@t
{
CONFIG
_
SNMP
_
SYSTEM
_
CLOCK
_
DRIFT
_
THOLD
}
)
expressed in seconds then an error will be notified to SNMP.
This comparison is done cyclically at a repetition rate expressed either in days
(@t
{
CONFIG
_
SNMP
_
SYSTEM
_
CLOCK
_
UNIT
_
DAYS
}
), in hours (@t
{
CONFIG
_
SNMP
_
SYSTEM
_
CLOCK
_
UNIT
_
HOURS
}
) or
in minutes (@t
{
CONFIG
_
SNMP
_
SYSTEM
_
CLOCK
_
UNIT
_
MINUTES
}
).
According to the selected unit, the repetition rate will be stored in the appropriate location:
@multitable @columnfractions .3 .7
@headitem Unit @tab Storage
@item @t
{
...UNIT
_
DAYS
}
@tab @t
{
...CHECK
_
INTERVAL
_
DAYS
}
@item @t
{
...UNIT
_
HOURS
}
@tab @t
{
...CHECK
_
INTERVAL
_
MINUTES
}
@item @t
{
...UNIT
_
MINUTES
}
@tab @t
{
...CHECK
_
INTERVAL
_
MINUTES
}
@end multitable
The @t
{
CONFIG
_
SNMP
_
SYSTEM
_
CLOCK
_
MONITOR
_
ENABLED
}
option is available only if a
NTP server has been defined (@t
{
CONFIG
_
NTP
_
SERVER
}
).
@item CONFIG
_
WRSAUXCLK
_
FREQ
@itemx CONFIG
_
WRSAUXCLK
_
DUTY
@itemx CONFIG
_
WRSAUXCLK
_
CSHIFT
...
...
@@ -1146,28 +1244,28 @@ appropriate way, before the respective service is started.
Enable VLANs configuration. All below VLAN config options
(@t
{
CONFIG
_
VLANS
_
*
}
) require this filed to be set.
@item CONFIG
_
VLANS
_
PORT
XX
_
MODE
_
ACCESS
@itemx CONFIG
_
VLANS
_
PORT
XX
_
MODE
_
TRUNK
@itemx CONFIG
_
VLANS
_
PORT
XX
_
MODE
_
DISABLED
@itemx CONFIG
_
VLANS
_
PORT
XX
_
MODE
_
UNQUALIFIED
@item CONFIG
_
VLANS
_
PORT
@i
{
xx
}
_
MODE
_
ACCESS
@itemx CONFIG
_
VLANS
_
PORT
@i
{
xx
}
_
MODE
_
TRUNK
@itemx CONFIG
_
VLANS
_
PORT
@i
{
xx
}
_
MODE
_
DISABLED
@itemx CONFIG
_
VLANS
_
PORT
@i
{
xx
}
_
MODE
_
UNQUALIFIED
VLANs port mode configuration for ports 1..18.
It can be one of: Access, Trunk, Disabled or Unqualified.
For details please refer to the @ref
{
VLANs Configuration
}
@item CONFIG
_
VLANS
_
PORT
XX
_
UNTAG
_
ALL
@itemx CONFIG
_
VLANS
_
PORT
XX
_
UNTAG
_
NONE
@item CONFIG
_
VLANS
_
PORT
@i
{
xx
}
_
UNTAG
_
ALL
@itemx CONFIG
_
VLANS
_
PORT
@i
{
xx
}
_
UNTAG
_
NONE
Define whether to remove a VLAN tag from egress frames on port 1..18.
@item CONFIG
_
VLANS
_
PORT
XX
_
PRIO
@item CONFIG
_
VLANS
_
PORT
@i
{
xx
}
_
PRIO
Priority value used when tagging incoming frames or to locally override
the priority (in Unqualified and Disabled modes).
-1 disables the priority overwrite. Valid values are
from -1 to 7.
@item CONFIG
_
VLANS
_
PORT
XX
_
VID
@item CONFIG
_
VLANS
_
PORT
@i
{
xx
}
_
VID
The meaning of this value and whether it is mandatory or optional,
depends on the port mode:
...
...
@@ -1189,7 +1287,7 @@ appropriate way, before the respective service is started.
For details please refer to the @ref
{
VLANs Configuration
}
@item CONFIG
_
VLANS
_
VLAN
XXXX
@item CONFIG
_
VLANS
_
VLAN
@i
{
xxxx
}
Provide a configuration for VLAN from the range 0000-4094.
This option is a comma separated string in the following format:
...
...
@@ -1225,6 +1323,26 @@ appropriate way, before the respective service is started.
For more details about VLANs configuration please refer to the
@ref
{
VLANs Configuration
}
@item CONFIG
_
OPTIMIZATION
_
DEBUGGING
@itemx CONFIG
_
OPTIMIZATION
_
NONE
_
DEBUGGING
@itemx CONFIG
_
OPTIMIZATION
_
SIZE
_
SPEED
@itemx CONFIG
_
OPTIMIZATION
_
SPEED
Compilation options. Chose one of these four choices to control the
compilation flags.
@t
{
CONFIG
_
OPTIMIZATION
_
DEBUGGING
}
: Should be the optimization level choice
for the standard edit-compile-debug cycle.
@t
{
CONFIG
_
OPTIMIZATION
_
NONE
_
DEBUGGING
}
: Compile without optimization and with debug informations
@t
{
CONFIG
_
OPTIMIZATION
_
SIZE
_
SPEED
}
: Optimize for size. Enables all -O2 optimizations except those
that often increase code size.
@t
{
CONFIG
_
OPTIMIZATION
_
SPEED
}
: GCC performs nearly all supported optimizations
that do not involve a space-speed tradeoff.
@end table
@c ==========================================================================
...
...
@@ -1235,15 +1353,34 @@ This section describes how timing configuration works in the switch.
Please note that up to version 4.1 (included) of @t
{
wr-switch-sw
}
things
were different and not really documented.
Timing configuration now depends on three sets of @t
{
dot-config
}
variables: per-port information, per-sfp information and fiber
Similarly, I want to bring to the attention of the reader that since
version @value
{
release
_
version
}
, the configuration of the timing configuration
has considerably evolved.
Timing configuration now depends on four sets of @t
{
dot-config
}
variables: common port information, per-port information, sfp information and fiber
description.
This is, for explanation's sake, an example of such items:
@smallexample
CONFIG
_
PORT09
_
PARAMS="name=wri9,proto=raw,tx=226214,rx=226758,role=slave,fiber=2"
# common port information
PTP
_
OPT
_
EXT
_
PORT
_
CONFIG
_
ENABLED=yes
...
# per-port information
CONFIG
_
PORT09
_
IFACE="wri9"
CONFIG
_
PORT09
_
FIBER=2
CONFIG
_
PORT09
_
INSTANCE
_
COUNT
_
1=yes
CONFIG
_
PORT09
_
INST01
_
PROTOCOL
_
RAW=yes
CONFIG
_
PORT09
_
INST01
_
PROFILE
_
WR=yes
CONFIG
_
PORT09
_
INST01
_
DESIRADE
_
STATE
_
SLAVE=yes
CONFIG
_
PORT09
_
INST01
_
EGRESS
_
LATENCY=226214
CONFIG
_
PORT09
_
INST01
_
INGRESS
_
LATENCY=226758
...
# sfp information
CONFIG
_
SFP00
_
PARAMS="pn=AXGE-1254-0531,tx=0,rx=0,wl
_
txrx=1310+1490"
...
# fiber infomation
CONFIG
_
FIBER02
_
PARAMS="alpha
_
1310
_
1490=2.6787e-04"
@end smallexample
...
...
@@ -1253,13 +1390,16 @@ uses configuration in the following way:
@itemize @bullet
@item The port has known tx and rx delays (around 226ns); the
@item The port has known tx (@t
{
CONFIG
_
PORT09
_
INST01
_
EGRESS
_
LATENCY
}
) and
rx (@t
{
CONFIG
_
PORT09
_
INST01
_
INGRESS
_
LATENCY
}
) delays (around 226ns); the
values depend on trace length and other hardware-specific details
and are determined by a calibration procedure. These values are
used as constant delays in the @i
{
tx
}
and @i
{
rx
}
directions.
@item The port is also configured as WR slave (@i
{
role
}
) using raw whiterabbit
protocol (@i
{
proto
}
) and is deployed using fiber type 2 -- this number
@item The port is also configured as WR slave (@t
{
CONFIG
_
PORT09
_
INST01
_
DESIRADE
_
STATE
_
SLAVE
}
)
using raw Ethernet (@t
{
CONFIG
_
PORT09
_
INST01
_
PROTOCOL
_
RAW
}
) to transport the White-Rabbit protocol
(@t
{
CONFIG
_
PORT09
_
INST01
_
PROFILE
_
WR
}
) and is deployed using fiber type 2
(@t
{
CONFIG
_
PORT09
_
FIBER
}
) -- this number
is just a local enumeration of fiber types; most likely you'll be
using type ``0'' in every port.
...
...
@@ -1279,11 +1419,163 @@ wavelength, and is determined, again, by the calibration procedure.
Please note that only one alpha value is provided, because the
opposite one (@t
{
alpha
_
1490
_
1310
}
) is calculated by software.
@subheading SFP name matching
@subsection Common port information description
The following table give the list of all information common to all port instances of the WR switch.
@table @code
@item CONFIG
_
PTP
_
OPT
_
EXT
_
PORT
_
CONFIG
_
ENABLED
This option is used to force the state of all port instances.
When set, each port instance can be either in the slave, master or passive state.
The BMCA is then disabled.
This option is only available for a boundary clock (@t
{
CONFIG
_
TIME
_
BC
}
).
For more details please refer to the IEEE 1588-2020 (clause 17.6.2)
@item CONFIG
_
PTP
_
SLAVE
_
ONLY
A slaveOnly Ordinary Clock utilizes the slaveOnly state machine
which does not enable transition to MASTER state.
This option is only available if @t
{
PTP
_
OPT
_
EXT
_
PORT
_
CONFIG
_
ENABLED
}
is not used.
For more details please refer to the IEEE 1588-2020 (clause 9.2.2.1)
@end table
@subsection Per-port information description
On each port, many PPSi instances can be instantiated. However only one can be active at
a given time. This possibility is already present but not yet activated to anticipate the
deployment of the High Accuracy (@b
{
HA
}
) profile. It will be used to interconnect WR switches/Nodes
using WR or HA profiles. The active instance will dependent then of the profile used by the peer.
While waiting for the next WR switch release with the HA profile, the number of port instances
must be set to either 1 (@t
{
CONFIG
_
PORT@i
{
xx
}_
INSTANCE
_
COUNT
_
1=yes
}
) or 0
(@t
{
CONFIG
_
PORT@i
{
xx
}_
INSTANCE
_
COUNT
_
0=yes
}
) if the port is not used. @i
{
xx
}
represents
the port number in the range 01 to 18.
@subheading Common instance information description
A set of parameters are only dependent of a port and shared by all instances on this port. The
@i
{
xx
}
value in the parameter name represents the port number.
@table @code
@item CONFIG
_
PORT@i
{
xx
}_
IFACE
Used to set the physical port interface name: "wri[1-18]"
@item CONFIG
_
PORT@i
{
xx
}_
FIBER
Identify the fiber type. This is a number (@i
{
zz
}
) referring to the corresponding
@t
{
CONFIG
_
FIBER@i
{
zz
}_
PARAMS
}
)
@item CONFIG
_
PORT@i
{
xx
}_
CONSTANT
_
ASYMMETRY
Defines a constant asymmetry that is used to compute the value of the delay asymmetry.
@end table
@subheading Instance information description
All port instance parameter will be constructed using the following format : CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
@i
{
pp
}
with
@i
{
xx
}
representing the port number, @i
{
yy
}
representing the instance number (01 to 02) and @i
{
pp
}
a key
describing the parameter itself.
@table @code
@item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
PROTOCOL
_
RAW
@itemx CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
PROTOCOL
_
UDP
_
IPV4
Network protocol. @t
{
CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
PROTOCOL
_
RAW
}
must be set for raw Ethernet and
@t
{
CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
PROTOCOL
_
UDP
_
IPV4
}
for UDP
@item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
PROFILE
_
WR
@itemx CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
PROFILE
_
PTP
Profile selection. @t
{
CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
PROFILE
_
WR
}
must be set to use the White Rabbit profile and
@t
{
CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
PROFILE
_
PTP
}
for pure PTP profile.
@item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
MECHANISM
_
E2E
@itemx CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
MECHANISM
_
P2P
Delay mechanism. @t
{
CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
MECHANISM
_
E2E
}
must be set for 'end-to-end' and
@t
{
CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
MECHANISM
_
P2P
}
for 'peer-to-peer'.
@item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
DESIRADE
_
STATE
_
MASTER
@itemx CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
DESIRADE
_
STATE
_
SLAVE
@itemx CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
DESIRADE
_
STATE
_
PASSIVE
If @t
{
CONFIG
_
PTP
_
OPT
_
EXT
_
PORT
_
CONFIG
_
ENABLED
}
is enabled then the instance state must be defined as follow:
@multitable @columnfractions .2 .8
@headitem State @tab Parameter
@item MASTER @tab @t
{
CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
DESIRADE
_
STATE
_
MASTER
}
@item SLAVE @tab @t
{
CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
DESIRADE
_
STATE
_
SLAVE
}
@item PASSIVE @tab @t
{
CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
DESIRADE
_
STATE
_
PASSIVE
}
@end multitable
@item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
ASYMMETRY
_
CORRECTION
_
ENABLE
This option is only accessible when the PTP profile is selected otherwise this option is enabled by default.
It is used to force the servo to integrate on its calculation the computation of the delay asymmetry.
@item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
BMODE
_
AUTO
@itemx CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
BMODE
_
MASTER
_
ONLY
Indicates the BMCA mode to use. This choice is only available when @t
{
CONFIG
_
PTP
_
OPT
_
EXT
_
PORT
_
CONFIG
_
ENABLED
}
is disable.
@t
{
CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
BMODE
_
AUTO
}
choice indicates to use the BMCA alghorithm and
@t
{
CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
BMODE
_
MASTER
_
ONLY
}
the optional masterOnly feature.
For more details please refer to the IEEE 1588-2020 (clause 9.2.2.2)
@item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
EGRESS
_
LATENCY
@itemx CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
INGRESS
_
LATENCY
Defines the reception (@t
{
CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
INGRESS
_
LATENCY
}
) and transmission
(@t
{
CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
EGRESS
_
LATENCY
}
) constant delays expressed in pico-seconds.
@item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
ANNOUNCE
_
INTERVAL
The mean time interval between transmissions of successive
Announce messages. The value is the logarithm to the base 2.
@item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
ANNOUNCE
_
RECEIPT
_
TIMEOUT
The announceReceiptTimeout specifies the number of announceIntervals
that must pass without receipt of an Announce message before the
occurrence of the event ANNOUNCE
_
RECEIPT
_
TIMEOUT
_
EXPIRES.
The value is the logarithm to the base 2.
@item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
SYNC
_
INTERVAL
The mean time interval between transmission of successive
Sync messages, i.e., the sync-interval, when transmitted
as multicast messages. The value is the logarithm to the base 2.
@item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
MIN
_
DELAY
_
REQ
_
INTERVAL
The minDelayRequestInterval specifies the minimum permitted
mean time interval between successive Delay
_
Req messages.
The value is the logarithm to the base 2.
This option is available when 'end-to-end' delay mechanism is selected
(@t
{
CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
MECHANISM
_
E2E
}
).
@item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
MIN
_
PDELAY
_
REQ
_
INTERVAL
The minPDelayRequestInterval specifies the minimum permitted
mean time interval between successive Pdelay
_
Req messages.
The value is the logarithm to the base 2.
This option is only available when 'peer-to-peer' delay mechanism is selected
(@t
{
CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
MECHANISM
_
P2P
}
).
@item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
MONITOR
Option to disable or enable triggering errors in SNMP on a port.
@c --------------------------
@c Option that will be available whe HA will be deployed
@c @item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
L1SYNC
_
ENABLED
@c @item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
L1SYNC
_
INTERVAL
@c @item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
L1SYNC
_
RECEIPT
_
TIMEOUT
@c @item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
L1SYNC
_
TX
_
COHERENCY
_
IS
_
REQUIRED
@c @item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
L1SYNC
_
RX
_
COHERENCY
_
IS
_
REQUIRED
@c @item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
L1SYNC
_
CONGRUENCY
_
IS
_
REQUIRED
@c @item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
L1SYNC
_
OPT
_
PARAMS
_
ENABLED
@c @item CONFIG
_
PORT@i
{
xx
}_
INST@i
{
yy
}_
L1SYNC
_
OPT
_
PARAMS
_
TS
_
CORRECTED
_
TX
_
ENABLED
@end table
@subsection SFP name matching
SFP matching is based on the vendor name (@i
{
vn
}
), part number (@i
{
pn
}
) and vendor
serial (@i
{
vs
}
). During the matching, SFP parameters are compared with values stored
in @t
{
CONFIG
_
SFP
xx
_
PARAMS
}
.
in @t
{
CONFIG
_
SFP
@i
{
xx
}
_
PARAMS
}
.
The first try is to match all SFP identifiers (@i
{
vn
}
, @i
{
pn
}
and @i
{
vs
}
) with those
stored in @t
{
dot-config
}
. If the match is not successful, @i
{
vn
}
and @i
{
pn
}
of
an SFP are compared only with @t
{
dot-config
}
entries that are without vendor
...
...
@@ -1309,7 +1601,7 @@ CONFIG_SFP02_PARAMS="pn=AXGE-3454-0531,tx=0,rx=0,wl_txrx=1310+1490"
CONFIG
_
SFP02
_
PARAMS will be matched to all SFPs with part number "AXGE-3454-0531",
that were not matched by any of the configs above.
@sub
heading
Other Deployments
@sub
section
Other Deployments
Examples above match the choices we make at CERN, where our
White Rabbit networks are all run with a single mono-modal fiber
...
...
@@ -1319,21 +1611,21 @@ If you are using dual-fiber transceivers, which is acceptable for
short links, you use the same wavelength in both directions, over two
fibers of the same length. In this case you may choose to avoid
writing the @t
{
wl
_
txrx
}
parameter in @sc
{
sfp
}
configuration and the
@t
{
alpha
_
XX
_
XX
}
parameter in fiber configuration. The missing
@t
{
alpha
_
@i
{
xx
}_
@i
{
xx
}
}
parameter in fiber configuration. The missing
parameters will cause warning messages to log destination, but are not
fatal, and a default alpha of 0 is used.
If you are using a pair of transceivers with different wavelengths,
and long fibers, you should provide an appropriate value of alpha,
according to laboratory measures on your fiber type. The
@t
{
CONFIG
_
FIBER
xx
_
PARAMS
}
items are parsed as a list of
@t
{
CONFIG
_
FIBER
@i
{
xx
}
_
PARAMS
}
items are parsed as a list of
comma-separated assignments, so you can specify multiple
wavelength pairs. The accuracy of your value depends on the length
of the fiber link. For a 10km fiber (100us round-trip) you need to know
alpha up to 1e-7 if you want the related uncertainty to be
less than 10ps.
@sub
heading
Calibration
@sub
section
Calibration
Calibration of per-port and per-@sc
{
sfp
}
delays as well as alpha is described in the
White Rabbit Calibration procedure:
...
...
@@ -1462,7 +1754,7 @@ interface. However, as it is in v5.0, the web-interface is not capable to store
VLANs configuration into a @t
{
dot-config
}
.
To have synchronization working with VLANs, the preferred way is to provide proper VIDs to
configuration options like @t
{
CONFIG
_
VLANS
_
PORT
XX
_
VID
}
. As an alternative you can
configuration options like @t
{
CONFIG
_
VLANS
_
PORT
@i
{
xx
}
_
VID
}
. As an alternative you can
write a custom @i
{
PPSi
}
configuration file with VLANs specified per-port.
You can simply copy the file generated in the WRS filesystem
(@i
{
/etc/ppsi.conf
}
) to a central @t
{
tftp
}
/@t
{
http
}
/@t
{
ftp
}
server where
...
...
@@ -1526,10 +1818,38 @@ To configure the switch in the way descibed in the
following config options:
@smallexample
CONFIG
_
PORT01
_
PARAMS="name=wri1,proto=raw,tx=0,rx=0,role=slave,fiber=0"
CONFIG
_
PORT02
_
PARAMS="name=wri2,proto=raw,tx=0,rx=0,role=master,fiber=0"
CONFIG
_
PORT03
_
PARAMS="name=wri3,proto=raw,tx=0,rx=0,role=master,fiber=0"
PTP
_
OPT
_
EXT
_
PORT
_
CONFIG
_
ENABLED=yes
# Port 1 configuration
CONFIG
_
PORT01
_
IFACE="wri1"
CONFIG
_
PORT01
_
FIBER=0
CONFIG
_
PORT01
_
INSTANCE
_
COUNT
_
1=yes
CONFIG
_
PORT01
_
INST01
_
PROTOCOL
_
RAW=yes
CONFIG
_
PORT01
_
INST01
_
PROFILE
_
WR=yes
CONFIG
_
PORT01
_
INST01
_
DESIRADE
_
STATE
_
SLAVE=yes
CONFIG
_
PORT01
_
INST01
_
EGRESS
_
LATENCY=0
CONFIG
_
PORT01
_
INST01
_
INGRESS
_
LATENCY=0
...
# Port 2 configuration
CONFIG
_
PORT02
_
IFACE="wri2"
CONFIG
_
PORT02
_
FIBER=0
CONFIG
_
PORT02
_
INSTANCE
_
COUNT
_
1=yes
CONFIG
_
PORT02
_
INST01
_
PROTOCOL
_
RAW=yes
CONFIG
_
PORT02
_
INST01
_
PROFILE
_
WR=yes
CONFIG
_
PORT02
_
INST01
_
DESIRADE
_
STATE
_
MASTER=yes
CONFIG
_
PORT02
_
INST01
_
EGRESS
_
LATENCY=0
CONFIG
_
PORT02
_
INST01
_
INGRESS
_
LATENCY=0
...
# Port 3 configuration
CONFIG
_
PORT03
_
IFACE="wri3"
CONFIG
_
PORT03
_
FIBER=0
CONFIG
_
PORT03
_
INSTANCE
_
COUNT
_
1=yes
CONFIG
_
PORT03
_
INST01
_
PROTOCOL
_
RAW=yes
CONFIG
_
PORT03
_
INST01
_
PROFILE
_
WR=yes
CONFIG
_
PORT03
_
INST01
_
DESIRADE
_
STATE
_
MASTER=yes
CONFIG
_
PORT03
_
INST01
_
EGRESS
_
LATENCY=0
CONFIG
_
PORT03
_
INST01
_
INGRESS
_
LATENCY=0
...
# Vlans configuration
CONFIG
_
VLANS
_
ENABLE=y
CONFIG
_
VLANS
_
PORT01
_
MODE
_
ACCESS=y
CONFIG
_
VLANS
_
PORT01
_
UNTAG
_
ALL=y
...
...
@@ -1610,7 +1930,7 @@ vlan 2
There are two LEDs on the front panel describing switch status and two LEDs for
each WR port. Each LED can be off, green or orange color, or the
combination of both giving yellow.
For more details please refer to following
the
sections.
For more details please refer to following sections.
@c =-------------------------------------------------------------------------
@node Status LEDs
...
...
@@ -1904,6 +2224,7 @@ The following tools and scripts are provided:
@t
{
on
}
, @t
{
off
}
or @t
{
read
}
.
@item wr
_
date
@anchor
{
wr
_
date
}
The program can read or set the White Rabbit date. When setting,
using ``@t
{
wr
_
date set
}
@i
{
value
}
'' assigns an arbitrary date,
...
...
@@ -1915,6 +2236,8 @@ The following tools and scripts are provided:
run by @t
{
/etc/init.d/wr
_
date
}
-- this script uses NTP
to set host time as a first step, if @t
{
/etc/wr
_
date.conf
}
exists and includes a line of the form @t
{
ntpserver 192.168.16.1
}
.
The file @t
{
/etc/wr
_
date.conf
}
is created at boot time by the script
@t
{
apply
_
dot-config
}
if a NTP server is defined (@t
{
CONFIG
_
NTP
_
SERVER
}
).
With ``@t
{
wr
_
date get
}
'' you can read White Rabbit time, and
by using @t
{
wr
_
date get tohost
}
'' you can set host time from
...
...
@@ -2468,9 +2791,9 @@ some details can be
suboptimal, while some procedures may be tricky and need more explanation.
We are collecting all those issues in our project pages. Please visit:
@itemize
@item Frequently Asked Questions: @url
{
http://www.ohwr.org/project
s
/white-rabbit/wiki/FAQswitch
}
@item Issues for WR Switch SW project: @url
{
http://www.ohwr.org/project
s
/wr-switch-sw/issues
}
@item Issues for WR Switch HDL project: @url
{
http://www.ohwr.org/project
s
/wr-switch-hdl/issues
}
@item Frequently Asked Questions: @url
{
http://www.ohwr.org/project/white-rabbit/wiki/FAQswitch
}
@item Issues for WR Switch SW project: @url
{
http://www.ohwr.org/project/wr-switch-sw/issues
}
@item Issues for WR Switch HDL project: @url
{
http://www.ohwr.org/project/wr-switch-hdl/issues
}
@end itemize
If you have any problem with this firmware and you don't find help in the above links,
feel free to reach us on the @i
{
white-rabbit-dev
}
mailing list.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment
