table of contents
| man(8) | synce4l man page | man(8) |
NAME¶
synce4l - Synchronous Ethernet (SyncE) controller application
SYNOPSIS¶
synce4l -f [file] [-l <num>] [-m] [-q] [-v] [-h]
DESCRIPTION¶
synce4l is an implementation of the Synchronous Ethernet (SyncE) protocol according to ITU-T Rec. G.8264. The design goal is to provide logic to supported hardware by processing Ethernet Synchronization Messaging Channel (ESMC) and control Ethernet Equipment Clock (EEC) on Network Card Interface (NIC).
Application can operate in two mutually exclusive modes: line or external.
- External input mode
- If `synce4l` is configured to run in external input mode then EEC needs to have external 1PPS source attached (GPS or other generator). In this scenario `synce4l` always broadcasts clock quality level (QL) defined in configuration file. Additionally, for external input mode incoming SyncE frames do not participate in best source selection algorithm for EEC.
- Line input mode
- In line input mode incoming SyncE frames are processed and best clock source is extracted from the link having the best quality level. `synce4l` configures such "best quality" port as a source to recover clock for EEC. The recovered QL is broadcasted to all other interfaces then. An external clock source cannot be used in this mode.
OPTIONS¶
- -f [file]
- read configuration from 'file' (config file takes precedence over command line arguments)
- -l [num]
- set the logging level to 'num' (0: least detailed, 7: most detailed)
- -m
- print messages to stdout
- -q
- do not print messages to the syslog
- -v
- print synce4l version and exit
- -h
- print this message and exit
CONFIGURATION FILE¶
Configuration file contains three sections:
- -
- global,
- -
- device,
- -
- port.
Global section¶
This section starts with `[global]` keyword. It sets the logging options.
- logging_level
- Minimum log level required to appear in a log.
- message_tag
- Tag reported in a log.
- use_syslog
- Set to 1 if `syslog` should be used.
- verbose
- Set to 1 to log extra information.
Device section¶
This section specifies the configuration of a one logical device e.g. 'synce1'. The name is defined by the user. The name has no impact for any functionality except traces. The name must be enclosed in extra angle bracket when defining new device section e.g. [<synce1>]. All ports defined by port sections after the device section will create one SyncE device (until next device section).
- input_mode
- Set to "line" to enable line input mode, set "external" for external input mode.
- external_input_QL
- Quality Level (QL) for "external input" mode.
- external_input_ext_QL
- Extended Quality Level for "external input" mode.
- extended_tlv
- Set to 1 to enable extended QL.
- network_option
- Network option according to T-REC-G.8264. All devices in SyncE domain should have the same option configured.
- recover_time
- Seconds indicating the minimum time to recover from the QL-failed state on the port.
- get_eec_state_cmd
- Defines a shell command which will be executed by synce4l to acquire current state of a SyncE EEC on the device. Separated command must be provided by the user for each device confgured for frequency synchronization. The command shall output current state of EEC to stdout, expected values are defined (also by the user) with following configuration items: eec_holdover_value, eec_locked_ho_value, eec_locked_value, eec_freerun_value, eec_invalid_value.
- eec_holdover_value
- Defines a string value expected on stdout stream when EEC is in HOLDOVER state.
- eec_locked_ho_value
- Defines a string value expected on stdout stream when EEC is in LOCKED HOLDOVER state.
- eec_locked_value
- Defines a string value expected on stdout stream when EEC is in LOCKED state.
- eec_freerun_value
- Defines a string value expected on stdout stream when EEC is in FREERUN state.
- eec_invalid_value
- Defines a string value expected on stdout stream when EEC is in INVALID state.
Port section¶
Any other section not starting with `<` (e.g. [eth0]) is the port section. Multiple port sections are allowed. Each port participates in SyncE communication.
- tx_heartbeat_msec
- Interval between consecutive SyncE frame transmissions (1000ms recommended).
- rx_heartbeat_msec
- Interval between consecutive SyncE socket polls (frame receive).
- recover_clock_enable_cmd
- A shell command which enables PHY port pointed by this Port section as a source of frequency for the SyncE EEC on this device (required only in "internal input" mode).
- recover_clock_disable_cmd
- A shell command which disables PHY port pointed by this Port section as a source of frequency for the SyncE EEC on this device (required only in "internal input" mode).
- allowed_qls
- List of integers containing allowed SSM QLs separated by comma (`,`), other received ones would be discarded. If parameter is not provided, all QLs will be accepted.
- allowed_ext_qls
- List of integers containing allowed extended SSM QLs separated by comma (`,`), other received ones would be discarded. If parameter is not provided, all QLs will be accepted.
BUGS¶
No known bugs.
AUTHOR¶
Arkadiusz Kubalewski <arkadiusz.kubalewski@intel.com>
Michal Michalik <michal.michalik@intel.com>
| 27 Oct 2022 | 1.0 |