[^minicom]:In Debian-like distribution you can install minicom by executing
[^minicom]:In Debian-like distribution you can install minicom by executing
`sudo apt-get install minicom`.
`sudo apt-get install minicom`.
> ***Note***: ttyUSB0 and ttyUSB1 usally correspond respectively to FGPA and ARM UART.
> ***Note***: ttyUSB0 and ttyUSB1 usually correspond respectively to FGPA and ARM UART.
However this order can change dependably on how you plug the cable.
However this order can change dependably on how you plug the cable.
Login via USB
Login via USB
...
@@ -347,28 +408,9 @@ instead of the ARM UART.
...
@@ -347,28 +408,9 @@ instead of the ARM UART.
minicom -D /dev/ttyACM0 -b 115200
minicom -D /dev/ttyACM0 -b 115200
~~~~~~~~~~
~~~~~~~~~~
The ARM UART is usually employed during development and monitoring because
The ARM UART is usually employed for development or monitoring because
the kernel and daemons messages are sent to this console.
the log messages are usually printed to this console.
Login via SSH
--------------
The Ethernet management port automatically obtains its IP using the DHCP
protocol. If you don't have any DHCP router/server in your network please
refer to the [non-DHCP](#non-dhcp-user) section.
To obtain the IP of the [WRS] you can connect to your DHCP server interface
and retrieve the IP, or [connect to ttyACM0](#login-via-usb) to retrieve the
IP (`ipconfig eth0`).
If the [WRS] IP is for example `192.168.1.50` you might connect using:
ssh root@192.168.1.50
And press enter when requesting the password.
Login using Windows
Login using Windows
...
@@ -398,130 +440,137 @@ by the one in your subnetwork.
...
@@ -398,130 +440,137 @@ by the one in your subnetwork.
![Putty - SSH connection](putty-SSH.png)
![Putty - SSH connection](putty-SSH.png)
Login using the Web Management Interface (WMI)
-----------------------
If you want to access and manage the [WRS] using the web interface, it is necessary to connect the [WRS] manager ethernet port to
your local network and obtain the IP as explained in [login via SSH](#login-via-ssh).
The access should be carried out by a network browser (Mozilla Firefox and Google Chrome supported) as it follows:
1. Open your browser and type the IP address (i.e. 192.168.1.50) of the [WRS]. By default, the network IP configuration
is provided by the DHCP server in the same network and can be retrieved from it.
![Web Management Interface - Login](wwwlogin.png)
2. After accessing the **WMI**, you should enter the web interface user and password, which is not
same for the SSH connection, otherwise you will be only able to see the Dashboard info.
By default the user is **admin** with no password. For this reason it is strongly recommended to change the password.
In order to change the **WMI** password you just need to click on "**User: admin**" on the left side of the webpage.
You have to enter your username (**admin**), old password, new password and repeat the new password.
Configurations
Once you submit the new password you will be redirected to the main screen and logged out.
==================
We strongly suggest you to configure the switch using the Web Management Interface.
Web Management Interface Features:
Web Management Interface Features:
-------------------
-------------------
**WMI** is a web interface that allows the [WRS] management from a web browser. It displays the main configuration and status of the main services and programms that are available for the switch, such as endpoints' mode and calibration status, SFP calibration, PTP, SNMP, VLANs, etc. It acts as an abstraction layer between the back-end scritps and programs in */wr/bin/* folder, making the WR switch management easier for the user.
**WMI** is a web interface that allows the [WRS] management from a web browser.
It displays the configuration and status of the main services and programs
List of all the actions that can be performed by using the **WMI**:
List of all the actions that can be performed by using the **WMI**:
- Display info: HW information, services status and main configuration.
-**Dashboard** : Display info about the WRS such as HW information, services status and main configuration.
- Stop/run services: PPSi, WRSW_HAL, NTP.
-**Network Setup**: Configuration of the ethernet management port (DHCP, Static, etc.)
- NTP server setup.
-**WR-PPSi Setup**: Configuration about the timing network: WR mode, NTP server, PPSi clock class, etc.
- Modify endpoint wr_master/wr_slave mode.
-**Endpoint Mode**: Modify the mode for each port (wr_master/wr_slave/auto/none).
- VLAN setup.
-**VLAN setup** : Let the user configure specific VLANs for different ports.
- White-Rabbit timing.
-**Switch Managment**: Let the user load/backup a specific configuration, reboot switch, disable system monitor.
- Modify maximum filesize of uploaded files to the switch.
-**Advanced Tab** :
- PPSi daemon configuration: clock class, clock accuracy, etc.
- Calibrate the SFP
- Terminal simulation avoiding SSH connections.
- Configure the endpoint
- Login system.
- Calibrate the endpoint
- Modify login password.
- Load lm32 and FPGA binaries into the switch.
- Load lm32 and FPGA binaries into the switch.
- Configure the files for the login system.
- Switch reboot.
- Open a virtual console that emulate a terminal connection.
- Backup and restore configuration files for services (PPSi, HAL, SNMP, etc).
-**Flash a new firmware**
- Restore configuration files from tarball.
- Flash firmware.
- Backup firmware.
> **Notes**: If you want to know more about each section you can click the help icon
If you want to know more about each section you can click the help icon
that you will find on the top-right corner of each page.
that you will find on the top-right corner of each page.
Console tools:
GrandMaster mode
-------------------
-----------------
Once you are logged via a terminal you can use various tools to monitor the [WRS].
![White Rabbit Network](wr_network2.jpg)
All these tools are found in `/wr/bin/` which is included in the `$PATH`.
The following list resumes the most interesting commands:
In a White Rabbit network, almost all the switches are configured as boundary clock (a.k.a Simple Master)
which is the default configuration. They receive a clock from an upper layer, and transmit it to other switches or nodes (lower layer).
However the "top" switch connected to the GPS signal is called the **GrandMaster**
and is configured in a specific way.
*`wrs_version`: Print information about the SW & HW version of the [WRS].
First you need to connect the 10MHz and PPS from a clock source to the switch SMC inputs.
*`rtu_stat`: Routing Table Unit Statistic, returns the routing table information where we can find which MAC needs to be forwarded to which port. It also allows to add and delete entries.
Please consult the [wr_external_reference.pdf] document to understand what kind and shape
*`wr_mon`: WR Switch Sync Monitor, outputs information about the state of WR syncrhonisation such as Phase Tracking, Master-Slave delay, link asymmetry, etc...
of signals is needed as input for grand master mode.
*`wrs_vlans`: Creation and configuration of VLANs.
> ***Note:*** More information about the tools are explained in the [wrs-user-manual.pdf] or can be obtain using the embedded help argument: `--help`, `-h` or `help`.
Then to configure a [WRS] as GrandMaster you must:
#### Warning:
### Using the web-interface
The SFP ports are labeled from 1 to 18 on the front panel but their corresponding
network interface are named from `wr0` to `wr17`.
You can find the option to select the switch in grandmaster mode in the configuration panel under the **WR-PPSi** tab.
Once you have change the option, you should click on *Save new configuration*, and
We strongly suggest you to configure the switch using the Web Management Interface.
> **Notes**: A NTP server should be provided for the grandmaster switch
However if you prefer to configure it using a terminal just follow some examples below.
so that we can distribute the current TAI seconds to the whole WR network
### By editing the dot-config file in a terminal
Booting
If you prefer to configure the [WRS] using a terminal you should open the `dot-config` file
------------
After 10 seconds, the bootloader automatically loads the [WRS] firmware
~~~~{.C}
from the Flash NAND memory of the switch. If you connect to the ARM debug
nano /wr/etc/dot-config
port you might see the following message:
~~~~~~~~
And replace the following lines:
~~~~~{.bash}
~~~~{.Haskell}
Welcome on WRSv3 Boot Sequence
# CONFIG_TIME_GM is not set
1: boot from nand (default)
# CONFIG_TIME_FM is not set
2: boot from TFTP script
CONFIG_TIME_BC=y
3: edit config
~~~~~~
4: exit to shell
5: reboot
by
~~~~~~~~~~~~~~~~~~~
~~~~~~{.config}
CONFIG_TIME_GM=y
# CONFIG_TIME_FM is not set
# CONFIG_TIME_BC is not set
~~~~~~~
and finally you need to `reboot` the switch.
> ***Note:*** If you want to change how
the [WRS] is booted you can place a `wrboot` script in your TFTP root
folder and select the second option or you can edit the configuration
(third option). Please find more explanations in the
[wrs-user-manual.pdf]
Non-DHCP user
Non-DHCP user
---------------
---------------
If you have no DHCP server in your network you must connect to the [WRS]
If you have no DHCP server in your network you must connect to the [WRS]
using the [login via USB method](#login-via-usb) and then edit the
using the [login via USB method](#login-via-usb) and edit the `dot-config` file:
`interfaces` file:
~~~~{.bash}
~~~~{.bash}
vi /etc/network/interfaces
nano /wr/etc/dot-config
~~~~~~~~~~~
~~~~~~~~~~~
for example, in a `192.168.1.x` subnetwork you might replace the
for example, in a `192.168.1.x` subnetwork you might replace the
`iface eth0 inet dhcp` by
`CONFIG_ETH0_DHCP=y` by
~~~~~{.bash}
~~~~~{.bash}
iface eth0 inet static
#
address 192.168.1.10
# Local Network Configuration
netmask 255.255.255.0
#
network 192.168.1.0
# CONFIG_ETH0_DHCP is not set
broadcast 192.168.1.255
# CONFIG_ETH0_DHCP_ONCE is not set
gateway 192.168.1.1
CONFIG_ETH0_STATIC=y
#
# Management port (eth0) Address
#
CONFIG_ETH0_IP="192.168.1.254"
CONFIG_ETH0_MASK="255.255.255.0"
CONFIG_ETH0_NETWORK="192.168.1.0"
CONFIG_ETH0_BROADCAST="192.168.1.255"
CONFIG_ETH0_GATEWAY="192.168.1.1"
~~~~~~~~~~~~~~
~~~~~~~~~~~~~~
...
@@ -529,38 +578,25 @@ iface eth0 inet static
...
@@ -529,38 +578,25 @@ iface eth0 inet static
must also statically set the IP in the bootloader configuration.
must also statically set the IP in the bootloader configuration.
GrandMaster mode
-----------------
![White Rabbit Network](wr_network2.jpg)
In a White Rabbit network, almost all the switches are configured as master (a.k.a SimpleMaster)
(default configuration). They transmit the clock signal that cames from other switches.
However the "top" switch connected to the GPS signal is called the **GrandMaster**
and is configured in a specific way.
To configure a switch as GrandMaster you must edit[^viedit] the `wrsw_hal.conf` file
~~~~{.C}
vi /wr/etc/wrsw_hal.conf
~~~~~~~~
And uncommenting the timing.mode value the line below:
Console tools:
-------------------
~~~~{.Haskell}
If you are logged via a terminal you can use various tools to monitor/configure the [WRS].
timing = {
All these tools are found in `/wr/bin/` which is included in the `$PATH`.
-- other values
mode = "GrandMaster"; -- grand-master with external reference
};
~~~~~~
Finally you need to connect the 10MHz and PPS from a clock source to the switch SMC inputs, and reboot the switch.
The following list resumes the most interesting commands:
For a more detailed explanation on how to configure and connect the switch as GrandMaster, please consult the
*`wrs_version -t`: Print information about the SW & HW version of the [WRS].
[wr_external_reference.pdf] document.
*`rtu_stat`: Routing Table Unit Statistic, returns the routing table information where we can find which MAC needs to be forwarded to which port. It also allows to add and delete entries.
*`wr_mon`: WR Switch Sync Monitor, outputs information about the state of WR syncrhonisation such as Phase Tracking, Master-Slave delay, link asymmetry, etc...
*`wrs_vlans`: Creation and configuration of VLANs.
> ***Note:*** More information about the tools are explained in the [wrs-user-manual.pdf] or can be obtain using the embedded help argument: `--help`, `-h` or `help`.
[^viedit]: To edit in `vi`: `Ins` Insert text; `Esc` back to normal mode; `:wq` Save and Exit
#### Warning:
The SFP ports are labeled from 1 to 18 on the front panel but their corresponding
network interface are named from `wr0` to `wr17`.
Firmware updates
Firmware updates
...
@@ -569,7 +605,7 @@ Firmware updates
...
@@ -569,7 +605,7 @@ Firmware updates
Since the firmware v4.1 we have improved the update procedure and the
Since the firmware v4.1 we have improved the update procedure and the
switch is able to upgrade by itself.
switch is able to upgrade by itself.
Just copy the firmware you have donwload to the `/update` folder of the switch.
Just copy the firmware you have downloaded to the `/update/wrs-firmware.tar` in the [WRS] switch.