SoCe

System-on-Chip engineering

SMARTZynq PCIe HSR/PRP/PTP

Quick Start Guide

- Confidential -

Doc: 160902
This page has been intentionally left blank

ii
Copyright reminder
Copyright 2016
c by System-on-Chip engineering S.L. All rights are reserved.

Unauthorized duplication of this document, in whole or in part, by any means is pro-

hibited without the prior written permission of SoCe S.L.

Although SoCe S.L. believes that the information included in this publication is cor-
rect as of the date of publication, SoCe S.L. reserves the right to make changes at any
time without notice.

All information in this document is strictly confidential and may only be published
by SoCe S.L.

All referenced trademarks are the property of their respective owners.

Revision History

Rev. Date Author Description

160804 16/08/04 SoCe Released
160902 16/09/09 SoCe Web configuration added

iii
Safety instructions
This chapter includes some instructions which must be observed to ensure your own
personal safety and to avoid damage to devices and machinery.

Please observe the following warnings and recommendations:

The device may only be employed for the purposes described in the user guide and
technical description, and only in conjunction with external devices and compo-
nents recommended or approved by SoCe .

The product can only be operated correctly and safely if it is transported, stored,
installed and assembled properly and correctly. Furthermore, it must be operated
and serviced carefully.

This device is electrically operated. Adhere strictly to the safety requirements

relating to voltages applied to the device.

Beware of possible short circuits when connecting a cable section with conductive
shielding braiding.

Make sure that the electrical installation meets local or nationally applicable safety
regulations.

Never insert pointed objects (thin screwdrivers, wires, etc.) into the inside of the
boards. Failure to observe this point may result in injuries caused by electric
shocks.

The device may only be operated in an ambient temperature range from -40 C to
+ 85 C and at relative air humidity up to 95 % (non-condensing). The installation
location is to be selected so as to ensure compliance with these climatic limits. The
storage temperature should not exceed the limits in the range from -45 C to +
90 C.

Failure to observe the information given in these warnings could result in serious in-
jury and/or major damage.

Only personnel that have received appropriate training should operate this device or
work in its immediate vicinity. The personnel must be fully familiar with all of the
warnings and maintenance measures in these operating instructions.

iv
 Correct transport, storage, and assembly as well as careful operation and mainte-
nance are essential in ensuring safe and reliable operation of this device. Check whether
the package was delivered complete and check the individual parts for transport damage.

Use only undamaged parts!

These products are only to be used in the manner indicated in this version of the
user guide. Particular attention is to be paid to all warnings and items of information
relating to safety.

Recycling Note
After its use, this product has to be processed as electronic scrap and disposed of accord-
ing to the prevailing waste disposal regulations of your community / district / country
/ state.

Disclaimer Note
The performance features described here are binding only if they have been expressly
guaranteed in the purchasing agreement. We have checked that the contents of the
technical publication agree with the hardware and software described. However, it is
not possible to rule out deviations completely, so we are unable to guarantee complete
agreement. However, the details in the technical publication are checked regularly. Any
corrections which prove necessary are contained in subsequent editions. We reserve the
right to make technical modifications.

We would furthermore point out that for reasons of simplicity, these operating in-
structions cannot describe every conceivable problem associated with the use of this
equipment. Should you require further information or should particular problems occur
which are not treated in sufficient detail in the operating instructions, you can request
the necessary information from SoCe . You can find the contact details on the Internet:
http://www.soc-e.com.

We are grateful for suggestions for improvement.

v
Contents

Safety instructions iv

1 Product overview 1
1.1 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

2 Hardware Setup 3
2.1 Hardware Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.2 Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.3 Equipment Installation in PCIe slot . . . . . . . . . . . . . . . . . . . . . 5
2.4 Equipment Installation in PCI slot . . . . . . . . . . . . . . . . . . . . . 5

3 Driver Installation 7
3.1 Automatic Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.2 Download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.3 Driver Installation On Windows O.S . . . . . . . . . . . . . . . . . . . . 7
3.3.1 Alternative Way of the Driver Installation 1 . . . . . . . . . . . . 8
3.3.2 Alternative Way of the Driver Installation 2 . . . . . . . . . . . . 9
3.4 Driver Installation On Linux O.S . . . . . . . . . . . . . . . . . . . . . . 9

4 Start-Up 10
4.1 Network Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.2 Password Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

5 Web Configuration 15
5.1 Web Interface Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
5.2 Configurations Management . . . . . . . . . . . . . . . . . . . . . . . . . 18
5.3 Network Nodes Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
5.4 System updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

6 CLI Configuration 22
6.1 SSH Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.2 CLI Configuration Tool Overview . . . . . . . . . . . . . . . . . . . . . . 24
6.3 Write and Read Operations . . . . . . . . . . . . . . . . . . . . . . . . . 26
6.3.1 Read Operation Example: Number of Transmitted Frames of PORT-
B . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
6.3.2 Write Operation Example: HSR and PRP Working Mode Change 27
6.4 Configurations Management . . . . . . . . . . . . . . . . . . . . . . . . . 28

vi
 Contents

7 Configuration Fields Description 30

7.1 PTP Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . 30
7.2 MES Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . 31
7.3 Redundancy Configuration Fields . . . . . . . . . . . . . . . . . . . . . . 34
7.4 HPS Priority Configuration Fields . . . . . . . . . . . . . . . . . . . . . . 35
7.5 Port-Configuraiton Configuration Fields . . . . . . . . . . . . . . . . . . 36
7.6 Statistics Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
7.7 802.1x Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . 37

vii
List of Figures
1.1 SMARTZynq PCIe HSR/PRP/PTP . . . . . . . . . . . . . . . . . . . . . . 1

2.1 Top View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2.2 Front view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.3 Front View Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.4 SMARTZynq PCIe HSR/PRP/PTP with PCI-PCIe adapter . . . . . . . . . 6

3.1 Windows Device Manager Before Driver Installation . . . . . . . . . . . . 7

3.2 Windows Device Manager After Driver Installation . . . . . . . . . . . . 8

4.1 Local Network Connection Configuration . . . . . . . . . . . . . . . . . . 10

4.2 Web Interface User / Password . . . . . . . . . . . . . . . . . . . . . . . 11
4.3 Web Interface Basic / Advanced Modes . . . . . . . . . . . . . . . . . . . 12
4.4 Web Interface IP Configuration Menu Option . . . . . . . . . . . . . . . 12
4.5 Web Interface IP Configuration . . . . . . . . . . . . . . . . . . . . . . . 13
4.6 Web Interface Password Configuration Menu Option . . . . . . . . . . . . 14
4.7 Web Interface Password Configuration . . . . . . . . . . . . . . . . . . . 14

5.1 Web Interface Main Page . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

5.2 Web Interface HW Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . 16
5.3 Web Interface Functionalities . . . . . . . . . . . . . . . . . . . . . . . . 17
5.4 Web Interface Right Menu . . . . . . . . . . . . . . . . . . . . . . . . . . 18
5.5 Web Interface Configurations Management . . . . . . . . . . . . . . . . . 19
5.6 Web Interface Network Nodes . . . . . . . . . . . . . . . . . . . . . . . . 20
5.7 Web Interface Firmware Updates . . . . . . . . . . . . . . . . . . . . . . 20

6.1 SSH Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

6.2 Security Warning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
6.3 SSH Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
6.4 Console appearance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
6.5 Changing the password . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
6.6 Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
6.7 Design Functionalities . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
6.8 Design Functionalities . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
6.9 Read Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
6.10 Write Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
6.11 Configuration Files List . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

viii
 List of Figures

6.12 Save New Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

6.13 Load a Saved Configuration . . . . . . . . . . . . . . . . . . . . . . . . . 29

ix
List of Tables
2.1 Port Assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

7.1 PTP Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . 30

7.2 PTP Configuration Fields for Port[0,1,2,A,B] . . . . . . . . . . . . . . . . 30
7.3 MES Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . 31
7.4 Redundancy Configuration Fields . . . . . . . . . . . . . . . . . . . . . . 34
7.5 HPS Priority Configuration Fields . . . . . . . . . . . . . . . . . . . . . . 36
7.6 Port-Configuration Configuration Fields . . . . . . . . . . . . . . . . . . 36
7.7 Statistics Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
7.8 802.1x Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . 37

x
1 Product overview
1.1 Description
SMARTZynq PCIe HSR/PRP/PTP is a networking card compliant with HSR and PRP v3
Redundant Ethernet protocols (IEC 62439 clause 5 and 4) . These protocols ensure high
availability for the networking on critical infrastructures offering zero-delay recovering
time and no frame lost in case of a network failure. The board attaches the Industrial
PC to the redundant network, and additionally, it supports RedBox mode of operation
for external regular Ethernet equipment through a third port.

This board can be delivered with an Out-of-the-Box configuration of a combined Dual-

Attached-Node (DAN) and embedded RedBox operation. Therefore, the SCADA or PC
system is a DAN for the PRP or HSR network. The addtional SFP port is able to
switch Ethernet traffic directly by hardware to the High-Availability Network without
introducing this traffic into the server.

IEEE 1588v2 Power-Utility Profile Transparent Clock operation is suportted by de-

fault in all the switching ports of the board. Ordinary Clock or Boundary Clock mode of
operations can be included in the board to run autonomously from the Server or SCADA
system.

Figure 1.1: SMARTZynq PCIe HSR/PRP/PTP

SoCe Doc: 160902 1 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Functional Features:

Dual-Attached Node (DAN): 2x Tri-speed redundant ports (SFP cages Port

A and Port B) are used for a IEEE1588v2 aware HSR/PRP network.

Redundancy Box (RedBox): 1x Tri-speed redundant ports (SFP cages Port

C) is used for IEEE1588 aware tri-speed Ethernet link.

1x Gigabit Ethernet (PCIe Port D) communicates with the PC/SCADA system.

1x Gigabit Ethernet (Port E) communicates with the internal CPU integrated in

the networking card.

Port A, B, C, D and E are switched by hardware.

Autonomous IEEE 1588v2 Ordinary Clock and Boundary Clock operation.

General Key Features:

3x SFP cages for 10/100/1000BaseT-X; 100BaseFX.

2x SMA outputs for PPS, IRIG-B, etc.

PCIex1.

1x power indicator led and 3x activity indicator leds (1x per SFP port).

Software drivers: Windows, Linux.

User-friendly configuration tool.

SoCe Doc: 160902 2 / 37

2 Hardware Setup
2.1 Hardware Description

PCIe x1

Figure 2.1: Top View

SoCe Doc: 160902 3 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

PORT-2

PORT-1

PORT-0

POWER

PORT-0 PORT-1 PORT-2 SMA-1 SMA-2

Figure 2.2: Front view

2.2 Port Configuration

For the current application, the ports and connectors configuration is shown in the table
2.1 and the figure 2.3:

Port No. Functionality

PORT-0 Interlink Port
PORT-1 Redundant Port A
PORT-2 Redundant Port B
SMA-1 PPS
SMA-2 IRIG-B

Table 2.1: Port Assignment

SoCe Doc: 160902 4 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

PORT-2

PORT-1

PORT-0

POWER

PORT-0 PORT-1 PORT-2 SMA-1 SMA-2

Figure 2.3: Front View Functionality

2.3 Equipment Installation in PCIe slot

SMARTZynq PCIe HSR/PRP/PTP must be connected into a PCIe slot through the PCIex1
connector shown in the figure 2.1.

In case of not having PCIex1 slot, SMARTZynq PCIe HSR/PRP/PTP is also compatible
with PCIex4, PCIex8 and PCIex16 slots.

2.4 Equipment Installation in PCI slot

SMARTZynq PCIe HSR/PRP/PTP could be also connected into a PCI slot using one of
the PCI-PCIe adapters available in the market. SoCe has tested the following one:

Startech PCI to PCI Express Adapter Card

The figure 2.4 shows the SMARTZynq PCIe HSR/PRP/PTP connected to the PCI-PCIe
adapter:

SoCe Doc: 160902 5 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Figure 2.4: SMARTZynq PCIe HSR/PRP/PTP with PCI-PCIe adapter

SoCe Doc: 160902 6 / 37

3 Driver Installation
3.1 Automatic Installation
Driver installation might be automatically launched by the computer both on Windows
and on Linux. If not, read the next sections.

3.2 Download
SMARTZynq PCIe HSR/PRP/PTP uses Intel I210 controller in order to provide PCIe in-
terface and network adapter driver installation may be required. It can be dowloaded
for any O.S from the Intel official website:

https://downloadcenter.intel.com/product/64400/Intel-Ethernet-Controller-I210-AT

3.3 Driver Installation On Windows O.S

If driver has not been automatically installed, once the SMARTZynq PCIe HSR/PRP/PTP is
plugged in the PC, the Windows Device Manager should detect it as a generic ethernet
controller as shown in the figure 3.1.

Figure 3.1: Windows Device Manager Before Driver Installation

SoCe Doc: 160902 7 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

After downloading ProWin32.exe or ProWin64.exe driver file, the user should execute
it and follow the installation wizard. Once the installation is finished, PC reboot could
be required. Now, the network adapter should appear in the Windows Device Manager
as shown in the figure 3.2.

Figure 3.2: Windows Device Manager After Driver Installation

3.3.1 Alternative Way of the Driver Installation 1

In case of finding any problem at the moment of the driver installation, the user could
install it manually following these steps:

Unzip ProWin32.exe or ProWin64.exe driver file.

Open Device Manager.

Choose the Network Adapater (if detected), or the generic Ethernet Controller of
the figure 3.1.

Right Click on the mouse and choose properties.

Controller tab.

Update Controller.

Choose Browse my computer for driver software.

User must browse the directory where the driver has been unzipped.

SoCe Doc: 160902 8 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

3.3.2 Alternative Way of the Driver Installation 2

In case of finding any problem in any of the previous ways, the user could follow these
steps:

Unzip ProWin32.exe or ProWin64.exe driver file.

Browse to PROWinx64/APPS/SETUP/SETUPBD/Winx64

Execute SetupBD.exe to launch the driver installation.

3.4 Driver Installation On Linux O.S

If driver has not been automatically installed, the igb Linux driver should be downloaded
from the Intel official website. Once downloaded it should be unzipped and follow the
instructions of the readme.txt file:

For the build to work properly, the currently running kernel MUST match the
version and configuration of the installed kernel sources. If user has just recompiled
the kernel reboot the system before building.

Move the base driver tar file to the directory of your choice. For example, use
/home/username/igb or /usr/local/src/igb.

Untar/unzip the archive, where <x.x.x> is the version number for the driver tar
file:
tar zxf igb-<x.x.x>.tar.gz

Compile the driver module:

make install
The binary will be installed as:
/lib/modules/<KERNEL VERSION>/updates/drivers/net/ethernet/intel/igb/igb.ko
The install location listed above is the default location. This may differ for various
Linux distributions.

Reboot the computer.

Additional information could be found in the mentioned readme.txt file.

SoCe Doc: 160902 9 / 37

4 Start-Up
4.1 Network Configuration
Once the driver is successfully installed, further configuration is needed to start working
with SMARTZynq PCIe HSR/PRP/PTP .

First of all, the computer should be disconnected from LAN in order not to have any
conflict between the default IP address assigned to the internal CPU integrated in the
SMARTZynq PCIe HSR/PRP/PTP (192.168.2.64) and the IP address of any other equip-
ment connected to the local network.

After that, a static IP address in the range of the subnet 192.168.2.0 must be assigned
in the computer to the connection with the NIC to be able to connect to the internal
CPU of the SMARTZynq PCIe HSR/PRP/PTP .

Figure 4.1: Local Network Connection Configuration

Finally, the web interface provided by the NIC will be accessed and a new IP address

SoCe Doc: 160902 10 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

corresponding to your own subnet will be assigned to the internal CPU of the NIC.

Summarizing, these are the steps to follow before accessing the web interface:
Install SMARTZynq PCIe HSR/PRP/PTP in the computer.

Install the driver.

Disconnect any ethernet cable from the computer.

Setup local network connection in the computer. See figure 4.1.

Ping to the IP address assigned by default to the internal CPU of the NIC
(192.168.2.64) to check if communication has been successfully established.

Once the initial communication has been checked, open your web browser and type
http://192.168.2.64 in the address bar. A user name and pasword will be requested
by the web application. See figure 4.2.

Figure 4.2: Web Interface User / Password

Enter the default credentials:

User: admin

Password: soce2016

At the left side of the page there is a button that let the user change between basic
and advanced configuration. Press that button and the color of the web will change to
red indicating you are now in advanced configuration mode. See figure 4.3.

SoCe Doc: 160902 11 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Figure 4.3: Web Interface Basic / Advanced Modes

At the top right corner of the page there is an icon that let the user view a menu with
the device configuration options. From that menu select the IP configuration entry. See
figure 4.4.

Figure 4.4: Web Interface IP Configuration Menu Option

A new page is open which let the user assign a new IP address to the internal CPU
integrated in the SMARTZynq PCIe HSR/PRP/PTP . See figure 4.5. This IP address
should be a static address provided by the network administrator, because you need to
know the address to access the configuration of the SMARTZynq PCIe HSR/PRP/PTP .
This is the reason for not using DHCP assigned addresses.

SoCe Doc: 160902 12 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Figure 4.5: Web Interface IP Configuration

After changing the IP address, you can use the Reboot configuration entry avalaible
through the right side device configuration menu for changes to take effect. Wait for
the system integrated in the SMARTZynq PCIe HSR/PRP/PTP finish rebooting (around
1 minute) and type the new IP address in the address bar of your web browser.

4.2 Password Configuration

In order to secure the access to the configuration of the SMARTZynq PCIe HSR/PRP/PTP ,
you should change the default password assigned to the different roles supported by the
tool.

The web interface can be used by two types of users, normal users (username: user )
and advanced users (username: admin). By default, both types of users have assigned
the same pasword, soce2016 . If you enter the web as a normal user and try to
change to advanced configuration mode the web will request the administrator creden-
tials at that moment. Some of the configuration options are restricted to advanced
users.

To change the password assigned to the different roles supported by the tool you must
use the Account configuration entry avalaible through the right side device configura-
tion menu. See figure 4.6.

SoCe Doc: 160902 13 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Figure 4.6: Web Interface Password Configuration Menu Option

In the new page that will be open you must first select the type of user whose password
want to change and then type the new password (twice). See figure 4.7.

Figure 4.7: Web Interface Password Configuration

Once you have finish using the web interface you should use the Logout configuration
entry avalaible through the right side device configuration menu to avoid unauthorized
accesses from your browser.

SoCe Doc: 160902 14 / 37

5 Web Configuration
This chapter shows how to access and modify the different configuration fields of the
SMARTZynq PCIe HSR/PRP/PTP using the web interface.

5.1 Web Interface Overview

When you enter the web interface to configure the SMARTZynq PCIe HSR/PRP/PTP (just
after typing user name and password), you can see a page similar to that of the figure
5.1.

Figure 5.1: Web Interface Main Page

In this page we can distinguish several elements:

1. At the centre of the page there is a block diagram that makes easier to the user
understanding the design implemented in the NIC.

2. At the left side of the page there is a switch button that can be used to change
between Basic / Advanced Access Modes. Some configuration options can only

SoCe Doc: 160902 15 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

be accessed in advanced mode. Depending on the access mode selected, the colors
used by the web pages change between green and red.

3. HW Blocks is a drop down menu which lists the different functional blocks com-
posing the system in the NIC. Selecting one of these blocks will cause that all the
configuration fields associated with it appear in a box at the centre of the page
(see figure 5.2). While you are viewing the configuration fields of a HW block, the
list of all the HW blocks appear at the left side of the page to make easier browse
between blocks. You can edit the value of different writable parameters and apply
the changes using a button available at the botton right corner of the box.

Figure 5.2: Web Interface HW Blocks

4. Functions is a drop down menu which lists the functionalities implemented in

the NIC. Selecting one of these functionalities will cause that all the configuration
fields associated with it appear in boxes at the centre of the page (see figure 5.3).
Each box corresponds to a HW block, so the configuration fields are filtered by
functionality and also by HW block. While you are viewing the configuration fields
of a functionality, the list of all the HW blocks appear at the left side of the page
to make easier browse between blocks. You can edit the value of different writable
parameters and apply the changes using a button available at the botton right
corner of each box.

5. There is another way to filter and show to the user only part of the available
configuration fields, and it is using the search box at the left side of the page
(just above the basic / advanced mode button). When you enter a text in that box

SoCe Doc: 160902 16 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

and click on the search button, all the configuration fields containing the provided
text in its name will be shown in boxes at the centre of the page.

Figure 5.3: Web Interface Functionalities

6. Configurations is a drop down menu which lists the different configurations saved
in files and also provides access to the page that let the user add or delete new
configurations. See chapter 5.2 for a detailed description of this option.
7. Network Nodes provides access to the page that let the user view a table of
the nodes detected in your network. The table is created using the information
extracted from the HSR/PRP supervision messages. See chapter 5.3 for a detailed
description of this option.
8. The SoCe logo at the top left corner of the page can be clicked to return to the
main page at any time.
9. The icon at the top right corner of the page can be used to show / hide the right
side device configuration menu (see figure 5.4). This menu contain the options
described below:
Account: Change the password assigned to the different roles supported by
the tool (see chapter 4.2).
Logout: Exit the web configuration interface.
IP address: Change the IP address assigned to the internal CPU of the
SMARTZynq PCIe HSR/PRP/PTP (see chapter 4.1).
System: View the logs and system information.

SoCe Doc: 160902 17 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Downloads: Download links to files stored at the NIC that can be usefull
for the user. For example, you can download from here the MIB definition
needed to access the configuration fields using SNMP.
Language: Upload to the NIC new translations files used by the web inter-
face.
Firmware: Upload system updates to the NIC (see chapter 5.4).
Language: Upload to the NIC a new block diagram (schematic) shown by
the web interface at the centre of the main page.
Reboot: Reboot the system of the SMARTZynq PCIe HSR/PRP/PTP .

Figure 5.4: Web Interface Right Menu

5.2 Configurations Management

The web interface can be used to save at any moment the values of all the configuration
fields in a configuration file, and apply that configuration file to the system when we
want.

At the top of the page there is a drop down menu identified as Configurations.
This menu shows the list of the previouly saved configurations. Clicking on any of these
configuration names will cause the configuration to be applied to the system and a con-
firmation message will be displayed if the configuration has been applied without errors.
As stated in this message, you may need to reload the page to see the changes.

SoCe Doc: 160902 18 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

The Default configuration name is special, because this is the configuration that
the system applies to the HW blocks each time it is booted.

The first option of the drop down menu is not a configration name but an access to
the page that let the user save the current configuration to a file, or delete previously
saved configurations (see figure 5.5). To save the current configuration we only have
to type a name and click the send button. If no name is given, it will be saved as
Default configuration. To delete an existing configuration click on the trash icon at
the right of its name.

Figure 5.5: Web Interface Configurations Management

5.3 Network Nodes Table

When using the redundant protocols HSR/PRP, supervision relies on each Redbox and
DAN sending periodically supervision frames that allows checking the integrity of the
network and the presence of the nodes. At the same time, these frames allow checking
which devices are Redboxes, DAN, or VDAN, the MAC addresses they use and which
operating mode they support.

The internal CPU of the SMARTZynq PCIe HSR/PRP/PTP is continuously capturing

HSR/PRP supervision frames and with the information contained in this messages builds
a network nodes table. The health status of the LAN and its attached devices (nodes
and switches) is monitored.

SoCe Doc: 160902 19 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Figure 5.6: Web Interface Network Nodes

5.4 System updates

The web interface can be used to update the system integrated in the NIC (software
tools, FPGA bitstreams...), in order to add new functionalities or fix errors. The system
updates are provided by SoCe in a unique file. Once you have this file in the computer
that is being used to access the web interface, you only have to click on the Firmware
configuration entry avalaible through the right side device configuration menu, and fol-
low the given instructions (see figure 5.7). You need to be in advanced access mode to
see the Firmware configuration option.

Figure 5.7: Web Interface Firmware Updates

SoCe Doc: 160902 20 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Inside the Firmware updates page you have to click on the button labelled as
Choose..., and using the file selection dialog select the file provided by SoCe . Af-
ter that you have to click on the button labelled as SEND and wait for the file to be
upload and the patch applied. In some cases a reboot of the system could be needed.

SoCe Doc: 160902 21 / 37

6 CLI Configuration
This chapter shows how to access and modify the different configuration fields of the
SMARTZynq PCIe HSR/PRP/PTP using the Command Line Interface tools.

6.1 SSH Connection

An SSH connection to the SMARTZynq PCIe HSR/PRP/PTP can be made through the
PCIe interface once connected to the computer, or additionally through any of the Eth-
ernet SFP ports. A terminal emulation program like HyperTerminal or Tera Term is
required. The figures shown in this document have been obtained using Tera Term ver-
sion 4.88. The appearance in your computer may differ if you use another program.

The ethernet device interface is identified as /dev/eth0 by the Operating System run-
ning inside the SMARTZynq PCIe HSR/PRP/PTP .

Below, the steps to follow for connecting to the SMARTZynq PCIe HSR/PRP/PTP are
explained.

Step 1: Open a new connection in the terminal emulation program and select the
option TCP/IP. Write the IP address of the device (192.168.2.64 by default) and
select SSH (version 2). Click OK.

Figure 6.1: SSH Connection

SoCe Doc: 160902 22 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Step 2: A window with a security warning will probably appear. Click Continue.

Figure 6.2: Security Warning

Step 3: Now you will be asked to authenticate with a user name and a password.
The default login for the SMARTZynq PCIe HSR/PRP/PTP is:
User name: linaro
Password: linaro

Figure 6.3: SSH Authentication

SoCe Doc: 160902 23 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Step 4: The console prompt should now appear.

Figure 6.4: Console appearance

Step 5: Once you have accessed with the default password, you can change it by
using the following Linux command:

sudo passwd linaro

and then typing twice the wanted password.

Figure 6.5: Changing the password

6.2 CLI Configuration Tool Overview

The CLI configuration tool soce config reg let the user list the names of all the config-
uration fields in the system (filtered by functionalities), and read or write any of these
configuration fields.

The tool can also be used to save at any moment the values of all the configuration
fields in a configuration file, and apply that configuration file to the system when we
want.

A first step to understand the tool can be to get the help using soce config reg -h
command. Figure 6.6 shows the help menu.

SoCe Doc: 160902 24 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Figure 6.6: Help Menu

One of the main options is to list the design functionalities as it will let the user to
filter the number of registers to be shown. Figure 6.7 shows the different functionalites
once executed soce config reg -l command.

Figure 6.7: Design Functionalities

These are the listed functionalities by default in the SMARTZynq PCIe HSR/PRP/PTP :

reg. It shows the raw registers map (32-bit values).

ptp. It shows PTP configuration fields.
mes. It shows configuration fields related to ethernet switching functionality.
redundancy. It shows configuration fields related to redundancy protocols.

SoCe Doc: 160902 25 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

hps prio. It allows to configure the priorities functionality of the HSR/PRP.

port conf. It shows some configuration fields related to ethernet ports that dont
fit in other categories.

stats. It shows the traffic statistics of each ethernet port.

8021x. It shows configuration fields related to 802.1x functionality.

For instance, in order to access to the redundancy functionality fields the command
would be soce config reg -m redundancy. The listed fields are shown in the figure 6.8

Figure 6.8: Design Functionalities

6.3 Write and Read Operations

As stated in the help, to read or write configuration fields the user must use -r or -w
data command line options. These options must be used along with the -f command
line option followed by a configuration field identifier. Each configuration field identifier
has the format below:

<HW Block Name>:<Field Name>

6.3.1 Read Operation Example: Number of Transmitted Frames of

PORT-B
In the following example, the number of transmitted frames in PORT-B will be read.

First of all, different statistics fields are listed using the command below:
soce config reg -m stats

SoCe Doc: 160902 26 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Then, tx frames field is read using:

soce config reg -f HPS-MES-PB:tx frames -r.

Figure 6.9 shows the execution of both commands.

Figure 6.9: Read Operation

6.3.2 Write Operation Example: HSR and PRP Working Mode

Change
In the following example, HSR and PRP working mode will be changed writing in the
corresponding configuration field.

First of all, redundancy configuration fields are displayed using the command below:
soce config reg -m redundancy.

SoCe Doc: 160902 27 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Then, working mode is changed writing a 0 (for PRP) or 1 (for HSR) in the hsr prp
field using:
soce config reg -f HPS-MES:hsr prp -w 0.

Data can be written both in decimal (1) or in hexadecimal (0x1). Figure 6.10 shows
the execution of both commands.

Figure 6.10: Write Operation

6.4 Configurations Management

SMARTZynq PCIe HSR/PRP/PTP loads a default configuration when it starts up. Once
the user has modified some of the configuration fields, the new configuration can be
saved as the default configuration or as an additional configuration.

The available configurations can be listed using the command below (see figure 6.11):
soce config reg -z

Figure 6.11: Configuration Files List

SoCe Doc: 160902 28 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

After the system configuration has been modified, the new configuration can be saved
using the command: soce config reg -s <Config Name>.

The figure 6.12 shows how to save a new configuration as Config3. It also shows the
updated configuration files list.

Figure 6.12: Save New Configuration

If user wants these changes to be loaded when the systems is rebooted, the
new configuration must be saved with the name Default.

At any moment the user can apply to the system a previously saved configuration
executing: soce config reg -a <Config Name>.

Figure 6.13 shows how to load config3 configuration.

Figure 6.13: Load a Saved Configuration

SoCe Doc: 160902 29 / 37

7 Configuration Fields Description
7.1 PTP Configuration Fields
Table 7.1 shows the generic configuration fields for the PTP functionality.

Table 7.1: PTP Configuration Fields

FIELD DESCRIPTION R/W WIDTH
timer addend Timer addend, subnanosecond adjust R/W 32
timer period Timer period R/W 32
timer offset lo Low 32 bits timer offset value R/W 32
timer offset hi High 32 bits timer offset value R/W 32
timer set val lo Low 32 bits timer value to be set R/W 32
timer set val hi High 32 bits timer value to be set R/W 32
timer set alrm lo Low 32 bits alarm value R/W 32
timer set alrm hi High 32 bits alarm value R/W 32
timer current val lo Low 32 bits timer current value R 32
timer current val hi High 32 bits timer current value R 32

Table 7.2 shows the configuration fields for the PTP functionality of Port[0,1,2,A,B].

Table 7.2: PTP Configuration Fields for Port[0,1,2,A,B]

FIELD DESCRIPTION R/W WIDTH
p2p vlan tag VLAN tag for Peer-to-peer messages R/W 16
SourcePortID field for Peer-to-peer
p2p src port id R/W 8
messages
Number of Pdelay req messages per
p2p msg per sec R/W 4
second
Enable VLAN tag insertion in
p2p vlan en R/W 1
Peer-to-peer messages
ptp p2p en Enable Peer-to-peer delay mechanism R/W 1
latency rx 10 Latency in RX 10Mbps R/W 16
latency tx 10 Latency in TX 10Mbps R/W 16
Next Page

SoCe Doc: 160902 30 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Table 7.2 From Previous Page

FIELD DESCRIPTION R/W WIDTH
latency rx 100 Latency in RX 100Mbps R/W 16
latency tx 100 Latency in TX 100Mbps R/W 16
latency rx 1000 Latency in RX 1000Mbps R/W 16
latency tx 1000 Latency in TX 1000Mbps R/W 16
Calculated Path delay (in
nanoseconds) using Peer-to-peer
calc path dly R 32
mechanism for PTP Transparent
Clock

7.2 MES Configuration Fields

Table 7.3 shows the configuration fields for the MES functionality.

Table 7.3: MES Configuration Fields

FIELD DESCRIPTION R/W WIDTH
Determine the work mode of each
port.
0: Access mode
mes forward port mode 1: Trunk mode R/W 8
This configuration only has efect when
Port-based Virtual VLAN mask is
enabled.
mes switching portmask Enable Switching Portmask R/W 1
mes port based virtual Enable port-based virtual VLAN R/W 1
Vlan
mes vlan filter eth R/W 2
ltering is applied to all frames
Write: 1
mes vlan wr R/W 1
Read: 0
mes vlan id VLAN ID value of the port R/W 12
Select the port whose native VLAN
mes vlan port sel R/W 4
ID is going to be changed or read
Write: 1
mes vlan mask wr R/W 1
Read: 0
Which ports belong to the given
mes vlan mask ports R/W 8
VLAN ID
VLAN ID value that is going to be
mes vlan mask id R/W 12
looked up
Next Page

SoCe Doc: 160902 31 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Table 7.3 From Previous Page

FIELD DESCRIPTION R/W WIDTH
Write: 1
mes switching mask wr R/W 1
Read: 0
Switching mask value.
1: A frame can go through that port
mes switching mask R/W 8
0: A frame cannot go through that
port
Select the port whose native switching
mes switching mask port R/W 4
mask is going to be changed or read
mes mac table clear 1: Flushes MAC Table R/W 1
00: Discarding
mes rstp port 0 status 01: Learning R/W 2
11: Forwarding
00: Discarding
mes rstp port 1 status 01: Learning R/W 2
11: Forwarding
00: Discarding
mes rstp port 2 status 01: Learning R/W 2
11: Forwarding
00: Discarding
mes rstp port 3 status 01: Learning R/W 2
11: Forwarding
00: Discarding
mes rstp port 4 status 01: Learning R/W 2
11: Forwarding
00: Discarding
mes rstp port 5 status 01: Learning R/W 2
11: Forwarding
00: Discarding
mes rstp port 6 status 01: Learning R/W 2
11: Forwarding
00: Discarding
mes rstp port 7 status 01: Learning R/W 2
11: Forwarding
00: Discarding
mes rstp port 8 status 01: Learning R/W 2
11: Forwarding
00: Discarding
mes rstp port 9 status 01: Learning R/W 2
11: Forwarding
Next Page

SoCe Doc: 160902 32 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Table 7.3 From Previous Page

FIELD DESCRIPTION R/W WIDTH
00: Discarding
mes rstp port 10 status 01: Learning R/W 2
11: Forwarding
mes aging time Aging time represented in minutes R/W 4
Priority mode internal description.
mes prio ethertype R/W 16
Determines the Ethertype
Determines the priority queue in
mes prio buffer which frames with the specified R/W 4
Ethertype are going to be stored
mes prio no data It says if there is more data to be read R/W 1
Write: 1
mes prio mode wr R/W 1
Read: 0
When Ethertype based priority is
mes prio mode clr enabled, it clears all previous con R/W 1
guration
It is used to start a new reading
process of the set configuration. When
mes prio mode new rd R/W 1
it is asserted, the data on the first
position is read
Select the QoS scheme. 00: PCP
based
mes prio type R/W 2
01: DSCP TOS based
10: Ethertype based
Select the port in which the priority
mes prio mode port mode and its configuration are going R/W 5
to be set
Output port by Ethertype internal
mes out ethertype R/W 16
description. Determines the Ethertype
Select the output ports through which
mes out ports frames with the speci R/W 15
ed Ethertype can be transmitted
mes out no data It says if there is more data to be read R/W 1
Switching ethertype control internal
description.
mes switching ether wr R/W 1
Write: 1
Read: 0
It enables the Ethertype based
mes switching ether act R/W 1
switching
Next Page

SoCe Doc: 160902 33 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Table 7.3 From Previous Page

FIELD DESCRIPTION R/W WIDTH
It clears all previous con
mes switching ether clr R/W 1
guration
It is used to start a new reading
process of the set configuration. When
mes switching ether new R/W 1
it is asserted, the data on the first
position is read
select the port in which Ethertype
mes switching ether port R/W 5
based switching is going to be set
Write: 1
mes broadcast prot wr R/W 1
Read: 0
Enables the broadcast protection
mes broadcast prot act R/W 1
functionality in the specified port.
mes broadcast prot limit Maximum number of broadcast frame. R/W 15
These bits are used to select the port
mes broadcast prot port in which broadcast protection is going R/W 5
to be enabled
Write: 1
mes multicast filter wr R/W 1
Read: 0
Enables the multicast
mes multicast filter enable R/W 1
ltering functionality
mes multicast table clr Clear the multicast table R/W 1
Position to write/read multicast
mes multicast table addr R/W 4
address
Ports through multicast frames can be
mes multicast valid ports R/W 16
transmitted
mes multicast addr hi Multicast MAC address, bits 47 to 32 R/W 16
mes multicast addr lo Multicast MAC address, bits 31 to 0 R/W 32
mes core version Core Version R 32

7.3 Redundancy Configuration Fields

Table 7.4 shows the configuration fields for the redundancy functionality.

Table 7.4: Redundancy Configuration Fields

FIELD DESCRIPTION R/W WIDTH
1: HSR
hsr prp R/W 1
0: PRP
Next Page

SoCe Doc: 160902 34 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Table 7.4 From Previous Page

FIELD DESCRIPTION R/W WIDTH
In PRP 000: Duplicate discard mode
001: Duplicate accept mode. In HSR
000: Mode H
hps work mode 001: Mode N R/W 3
010: Mode T
100: Mode U
101: Mode X
0: No transparent reception
hps transparent rec 1: It does not discard duplicate frames R/W 1
and does not erase RTC
001: HSR-SAN
hps coupling mode 010: HSR-HSR R/W 3
100: HSR-PRP
Identify the Redbox lan ID, A or B,
hps lan id R/W 1
which is used in HSR-PRP mode
Identification number of the ring net
hps net id R/W 3
in which the node is connected
Determine the Vlan ID in which
hps vlan id R/W 12
Redbox node is
hps forget time Time after a node entry is forgotten R/W 10
super tx Enable supervision frame transmission R/W 1
Enable passing supervision frames to
super to interlink R/W 1
the interlink port
Enable HSR tag or PRP trailer
super tag remove removal to supervision frames when R/W 1
passing to the interlink port
Enable VLAN addition to supervision
super vlan R/W 1
frames
hps core version HPS Core Version R 24
hps protocol version HPS Protocol Version R 8

7.4 HPS Priority Configuration Fields

Table 7.5 shows the configuration fields for the HPS priority functionality.

SoCe Doc: 160902 35 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

Table 7.5: HPS Priority Configuration Fields

FIELD DESCRIPTION R/W WIDTH
0: PCP based
hps prio mode R/W 1
1: Ethertype based
The Ethertype which is going to be
hps prio ethrtype 1 R/W 16
prioritized
The priority level associated to the
hps prio level 1 R/W 3
Ethertype
The Ethertype which is going to be
hps prio ethrtype 2 R/W 16
prioritized
The priority level associated to the
hps prio level 2 R/W 3
Ethertype

7.5 Port-Configuraiton Configuration Fields

Table 7.6 shows the configuration fields for the Port-Configuration functionality.

Table 7.6: Port-Configuration Configuration Fields

FIELD DESCRIPTION R/W WIDTH
PHY speed measured using
speedometer module.
phy speed calc 11: GMII (base1000) R 2
10: MII (base100)
01: MII (base10)

7.6 Statistics Fields

Table 7.7 shows the fields for the statistics functionality.

Table 7.7: Statistics Fields

FIELD DESCRIPTION R/W WIDTH
rx frames Number of received frames R 32
tx frames Number of transmitted frames R 32
crc err frames Number of frames with CRC error R 32
lanid err frames Number of frames with LAN ID error R 32

SoCe Doc: 160902 36 / 37

 SMARTZynq PCIe HSR/PRP/PTP
Quick Start Guide

7.7 802.1x Configuration Fields

Table 7.8 shows the fields for the 802.1x functionality.

Table 7.8: 802.1x Configuration Fields

FIELD DESCRIPTION R/W WIDTH
1: Blocks port
8021x blocking en R/W 1
0: Disables port blocking
1: Blocks port based on valid MAC
8021x mac en address R/W 1
0: Disables MAC address blocking
8021x mac lo Valid MAC address, bits 31 to 0 R/W 32
8021x mac hi Valid MAC address, bits 47 to 32 R/W 16

SoCe Doc: 160902 37 / 37