You are on page 1of 47

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

We have checked that the contents of the technical publication agree with the hardware and software described. Disclaimer Note The performance features described here are binding only if they have been expressly guaranteed in the purchasing agreement. Correct transport. We would furthermore point out that for reasons of simplicity. you can request the necessary information from SoCe . the details in the technical publication are checked regularly. We are grateful for suggestions for improvement. 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. You can find the contact details on the Internet: http://www. Particular attention is to be paid to all warnings and items of information relating to safety. and assembly as well as careful operation and mainte- nance are essential in ensuring safe and reliable operation of this device. Recycling Note After its use. Check whether the package was delivered complete and check the individual parts for transport damage. However.com. it is not possible to rule out deviations completely. Use only undamaged parts! These products are only to be used in the manner indicated in this version of the user guide. However. storage. these operating in- structions cannot describe every conceivable problem associated with the use of this equipment. Any corrections which prove necessary are contained in subsequent editions. v . We reserve the right to make technical modifications. so we are unable to guarantee complete agreement.soc-e. Should you require further information or should particular problems occur which are not treated in sufficient detail in the operating instructions.

. . . . . 26 6. . .2 CLI Configuration Tool Overview . . . . . . . . . . . . . . . . . . . . . .Contents Safety instructions iv 1 Product overview 1 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 vi . . .2 Write Operation Example: HSR and PRP Working Mode Change 27 6. . . . . . 8 3. . . . 5 2. . . . . . .3. . . . . 26 6. . . . 19 5. .1 Hardware Description . . . .4 System updates . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 Password Configuration . . . . . . . . . . . . . . . . . . . . . .2 Alternative Way of the Driver Installation 2 . . . . . . . . . . . . . . . . 24 6. . . . . . . . . . . . . . . . .2 Download . . . . . . . . . . . . . . . . . 15 5. . . . . . .S . . . . . . . . . . . . . . . . . .S . . . . . 18 5. . . . . . . . . . . . . 13 5 Web Configuration 15 5. . . . . .2 Port Configuration . . .1 Web Interface Overview . . . . . . . . . . . . .3 Network Nodes Table . . . . . . . .3. . . . . . . .1 Automatic Installation . . . . . . . . . . . . . .4 Equipment Installation in PCI slot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 4.3 Equipment Installation in PCIe slot . . . . . . . . . . . . . . . 22 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 2 Hardware Setup 3 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2. . . . . . 7 3. . . . . . . . . . . . . . . . 9 4 Start-Up 10 4. . . . . . . . .3 Driver Installation On Windows O. . . . . . . . . . . . . . . . . . . .3. 9 3.4 Driver Installation On Linux O. . . . . . . . . . . . . . . . .1 SSH Connection . . . . . . . . . . .1 Description . . . . .1 Alternative Way of the Driver Installation 1 .2 Configurations Management . . 20 6 CLI Configuration 22 6. . . . . . . . . . . . . 7 3. . . 7 3. . . . . . . . . . . . . . .1 Network Configuration . .1 Read Operation Example: Number of Transmitted Frames of PORT- B . . . . . . . . .3. . . . . . . . . . . . . . .3 Write and Read Operations . . . . . . . . . . . . . . 5 3 Driver Installation 7 3. . . . . .4 Configurations Management . . . . . . . . . . . 3 2. . . . . . . .

. . . .5 Port-Configuraiton Configuration Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 PTP Configuration Fields . . . .7 802. . . . . .6 Statistics Fields . . . . . . . 30 7. . . 36 7. . . . . . . . . . . . . . . . . . . . . . . . . . . 37 vii . . . . . . . .1x Configuration Fields . . . . . . . . . .3 Redundancy Configuration Fields . . . . . . . . . . .2 MES Configuration Fields . . . . . . . . . . . . 35 7. . . . 36 7. . .4 HPS Priority Configuration Fields . . . . . . . . . . . Contents 7 Configuration Fields Description 30 7. . . . 31 7. . . . . . . . . . . . . . . . . . . . . . . 34 7. . . . . . .

. . . . . . . . . 5 2. . . . 14 5.List of Figures 1. . . . . . . . 4 2. . . . . . . . . . . . . . . . .4 SMARTZynq PCIe HSR/PRP/PTP with PCI-PCIe adapter . . . . . . . . . . . . . . 20 6.4 Console appearance . . . . .3 SSH Authentication . 25 6. . .4 Web Interface Right Menu . . .6 Web Interface Network Nodes . . . . . . . . .1 Local Network Connection Configuration . . . . . . . . . . 13 4. . . . . . . 8 4. . . . . . . . . 28 viii . . . 23 6. . . . . . . . . . . . . . . . . . . .5 Web Interface Configurations Management . . . . . 27 6. . . . . . 15 5. . . . . .2 Web Interface User / Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 Web Interface IP Configuration Menu Option . . .9 Read Operation . . . . . . . . . . . . . . . . . . . . . . 6 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 Configuration Files List . . . . . . . . . . . .8 Design Functionalities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 Web Interface Basic / Advanced Modes . . . . .1 SMARTZynq PCIe HSR/PRP/PTP . . . . . . .7 Web Interface Firmware Updates . . . . 26 6. 25 6. . . . . . . 24 6. . . . . . . 12 4. . . . 14 4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 Windows Device Manager After Driver Installation . . . . . . . . . . . . . . . . . .5 Web Interface IP Configuration . . . . .2 Security Warning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 4. . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 Web Interface HW Blocks . . . . . . .10 Write Operation .1 Top View .1 Web Interface Main Page . . . . . . . . . . 18 5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 4. . . . . . . . . . . . . 3 2.1 SSH Connection . .6 Help Menu . . . . . . . . .5 Changing the password . . . . . . . . . 16 5. . . . . . . . . . . . . . . . . . . . . . . . .3 Web Interface Functionalities . .3 Front View Functionality . . . . . . . . . . . 20 5. . . . . . . . 23 6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 Design Functionalities . . . . . . 19 5. . . . . . . . . . . . . . . . . . . . . . .6 Web Interface Password Configuration Menu Option . . .1 Windows Device Manager Before Driver Installation . . . . . . . 17 5. . . . . . 7 3. . . . . . . 28 6. . . . . . . . 12 4. . . . . . .7 Web Interface Password Configuration . . . . . . . . . . . . . . . 22 6. . . . . . . . . .2 Front view . . . . 24 6. . . . . . . . . . . 1 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . 29 ix . . . . . . . . 29 6. . . . . .12 Save New Configuration . . . . . . . . . . . . List of Figures 6. . . . . . . . . . . . . . .13 Load a Saved Configuration . . . . . .

. . . . . . . . . .1 Port Assignment . 36 7. . . . . . . . . . . . . . . . . . . . . . . . . .1.1 PTP Configuration Fields . .8 802. . . . . .1x Configuration Fields . . . . . . . . . . . . . . . . . . . . 30 7. . . . . . . . . 37 x . . .B] . . . . . . . . . . . . . . . . . . 31 7. .5 HPS Priority Configuration Fields .6 Port-Configuration Configuration Fields . . 34 7. . . .4 Redundancy Configuration Fields . . . . . . . . . . . . . . . .List of Tables 2. . . . . . . . . . .7 Statistics Fields . . . . . .3 MES Configuration Fields . . 30 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 PTP Configuration Fields for Port[0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 7. . . 36 7. . . 36 7. . . . . . . .2. . . . .A. .

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. it supports RedBox mode of operation for external regular Ethernet equipment through a third port. the SCADA or PC system is a DAN for the PRP or HSR network.1: SMARTZynq PCIe HSR/PRP/PTP SoCe Doc: 160902 1 / 37 . 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. and additionally.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) . Figure 1. This board can be delivered with an Out-of-the-Box configuration of a combined Dual- Attached-Node (DAN) and embedded RedBox operation. Therefore.1 Product overview 1. 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. The board attaches the Industrial PC to the redundant network.

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. • User-friendly configuration tool. • 1x Gigabit Ethernet (Port E) communicates with the internal CPU integrated in the networking card. General Key Features: • 3x SFP cages for 10/100/1000BaseT-X. • Software drivers: Windows. IRIG-B. • Port A. D and E are switched by hardware. 100BaseFX. C. SoCe Doc: 160902 2 / 37 . • Autonomous IEEE 1588v2 Ordinary Clock and Boundary Clock operation. • 1x Gigabit Ethernet (PCIe Port D) communicates with the PC/SCADA system. • 1x power indicator led and 3x activity indicator leds (1x per SFP port). • PCIex1. • 2x SMA outputs for PPS. • Redundancy Box (RedBox): 1x Tri-speed redundant ports (SFP cages Port C) is used for IEEE1588 aware tri-speed Ethernet link. Linux. B. etc.

2 Hardware Setup 2.1: Top View SoCe Doc: 160902 3 / 37 .1 Hardware Description PCIe x1 Figure 2.

2 Port Configuration For the current application. 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: Port No.1 and the figure 2. the ports and connectors configuration is shown in the table 2.2: Front view 2.

1.3: Front View Functionality 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. 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 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. PCIex8 and PCIex16 slots.4 shows the SMARTZynq PCIe HSR/PRP/PTP connected to the PCI-PCIe adapter: SoCe Doc: 160902 5 / 37 . In case of not having PCIex1 slot. 2. SoCe has tested the following one: Startech PCI to PCI Express Adapter Card The figure 2. SMARTZynq PCIe HSR/PRP/PTP is also compatible with PCIex4.

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 .

intel.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. once the SMARTZynq PCIe HSR/PRP/PTP is plugged in the PC.1 Automatic Installation Driver installation might be automatically launched by the computer both on Windows and on Linux. It can be dowloaded for any O. the Windows Device Manager should detect it as a generic ethernet controller as shown in the figure 3.3 Driver Installation 3. Figure 3.S If driver has not been automatically installed. read the next sections.1: Windows Device Manager Before Driver Installation SoCe Doc: 160902 7 / 37 .S from the Intel official website: https://downloadcenter. If not.3 Driver Installation On Windows O. 3.1.com/product/64400/Intel-Ethernet-Controller-I210-AT 3.

the user could install it manually following these steps: • Unzip ProWin32. • Right Click on the mouse and choose properties. • Controller tab. Once the installation is finished. or the generic Ethernet Controller of the figure 3. SoCe Doc: 160902 8 / 37 . Now.exe or ProWin64. PC reboot could be required.2.2: Windows Device Manager After Driver Installation 3.1 Alternative Way of the Driver Installation 1 In case of finding any problem at the moment of the driver installation. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide After downloading ProWin32. • Choose the Network Adapater (if detected). • Update Controller. the network adapter should appear in the Windows Device Manager as shown in the figure 3. the user should execute it and follow the installation wizard. • Choose Browse my computer for driver software.exe driver file.3.exe or ProWin64. • Open Device Manager.exe driver file.1. Figure 3. • User must browse the directory where the driver has been unzipped.

• Move the base driver tar file to the directory of your choice. the user could follow these steps: • Unzip ProWin32. • Untar/unzip the archive. Once downloaded it should be unzipped and follow the instructions of the readme. For example. • Additional information could be found in the mentioned readme. • Browse to PROWinx64/APPS/SETUP/SETUPBD/Winx64 • Execute SetupBD. If user has just recompiled the kernel reboot the system before building. use ’/home/username/igb’ or ’/usr/local/src/igb’. 3.ko The install location listed above is the default location.gz • Compile the driver module: make install The binary will be installed as: /lib/modules/<KERNEL VERSION>/updates/drivers/net/ethernet/intel/igb/igb.x. • Reboot the computer.exe or ProWin64.3. the currently running kernel MUST match the version and configuration of the installed kernel sources.4 Driver Installation On Linux O. SoCe Doc: 160902 9 / 37 . SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide 3.exe driver file.exe to launch the driver installation.S If driver has not been automatically installed.2 Alternative Way of the Driver Installation 2 In case of finding any problem in any of the previous ways. the igb Linux driver should be downloaded from the Intel official website.x.txt file: • For the build to work properly.x>. where <x.txt file. This may differ for various Linux distributions.x> is the version number for the driver tar file: tar zxf igb-<x.tar.

1 Network Configuration Once the driver is successfully installed. 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. First of all.64) and the IP address of any other equip- ment connected to the local network.2.168.1: Local Network Connection Configuration Finally. Figure 4.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 .2.168. a static IP address in the range of the subnet 192. further configuration is needed to start working with SMARTZynq PCIe HSR/PRP/PTP .4 Start-Up 4. After that. the web interface provided by the NIC will be accessed and a new IP address SoCe Doc: 160902 10 / 37 .

1. • Setup local network connection in the computer. • Install the driver. Figure 4.2. Press that button and the color of the web will change to red indicating you are now in advanced configuration mode.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.2. See figure 4. Summarizing. • Disconnect any ethernet cable from the computer. Once the initial communication has been checked.168. SoCe Doc: 160902 11 / 37 .64 ” in the address bar.64) to check if communication has been successfully established.3. these are the steps to follow before accessing the web interface: • Install SMARTZynq PCIe HSR/PRP/PTP in the computer. A user name and pasword will be requested by the web application. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide corresponding to your own subnet will be assigned to the internal CPU of the NIC.168. See figure 4. • Ping to the IP address assigned by default to the internal CPU of the NIC (192.2. See figure 4. open your web browser and type ”http://192.

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 . SoCe Doc: 160902 12 / 37 . From that menu select the IP configuration entry. because you need to know the address to access the configuration of the SMARTZynq PCIe HSR/PRP/PTP . Figure 4.5. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide Figure 4. See figure 4. This IP address should be a static address provided by the network administrator. See figure 4.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. This is the reason for not using DHCP assigned addresses.

”normal ” users (username: user ) and ”advanced ” users (username: admin). you can use the ”Reboot” configuration entry avalaible through the right side device configuration menu for changes to take effect. By default. ”soce2016 ”.2 Password Configuration In order to secure the access to the configuration of the SMARTZynq PCIe HSR/PRP/PTP . both types of users have assigned the same pasword. See figure 4. Some of the configuration options are restricted to ”advanced ” users. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide Figure 4. 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. 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. The web interface can be used by two types of users. SoCe Doc: 160902 13 / 37 .5: Web Interface IP Configuration After changing the IP address. 4. 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. you should change the default password assigned to the different roles supported by the tool.6.

SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide Figure 4. 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).7. SoCe Doc: 160902 14 / 37 .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. See figure 4.

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).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. At the centre of the page there is a block diagram that makes easier to the user understanding the design implemented in the NIC.1: Web Interface Main Page In this page we can distinguish several elements: 1. 5. you can see a page similar to that of the figure 5. 2. Figure 5.1. 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. 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. 3. 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. 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. Functions is a drop down menu which lists the functionalities implemented in the NIC. the list of all the HW blocks appear at the left side of the page to make easier browse between blocks. While you are viewing the configuration fields of a functionality.2). When you enter a text in that box SoCe Doc: 160902 16 / 37 . the list of all the HW blocks appear at the left side of the page to make easier browse between blocks. Figure 5. While you are viewing the configuration fields of a HW block.3).2: Web Interface HW Blocks 4. so the configuration fields are filtered by functionality and also by HW block. Each box corresponds to a HW block. 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. and it is using the search box at the left side of the page (just above the basic / advanced mode button). HW Blocks is a drop down menu which lists the different functional blocks com- posing the system in the NIC. the colors used by the web pages change between green and red. Depending on the access mode selected. There is another way to filter and show to the user only part of the available configuration fields. 5.

See chapter 5. 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.2). Figure 5. 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. • Logout: Exit the web configuration interface.2 for a detailed description of this option. • System: View the logs and system information. See chapter 5. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide and click on the search button. SoCe Doc: 160902 17 / 37 .3: Web Interface Functionalities 6. The table is created using the information extracted from the HSR/PRP supervision messages. 7.4). The SoCe logo at the top left corner of the page can be clicked to return to the main page at any time. • IP address: Change the IP address assigned to the internal CPU of the SMARTZynq PCIe HSR/PRP/PTP (see chapter 4. all the configuration fields containing the provided text in its name will be shown in boxes at the centre of the page. Network Nodes provides access to the page that let the user view a table of the nodes detected in your network. 8. This menu contain the options described below: • Account: Change the password assigned to the different roles supported by the tool (see chapter 4. 9.3 for a detailed description of this option.1).

SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide • Downloads: Download links to files stored at the NIC that can be usefull for the user.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. For example. • Reboot: Reboot the system of the SMARTZynq PCIe HSR/PRP/PTP . you may need to reload the page to see the changes. you can download from here the MIB definition needed to access the configuration fields using SNMP. As stated in this message. • Language: Upload to the NIC a new block diagram (schematic) shown by the web interface at the centre of the main page. Figure 5.4). and apply that configuration file to the system when we want.4: Web Interface Right Menu 5. • Language: Upload to the NIC new translations files used by the web inter- face. 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. • Firmware: Upload system updates to the NIC (see chapter 5. At the top of the page there is a drop down menu identified as ”Configurations”. SoCe Doc: 160902 18 / 37 .

To save the current configuration we only have to type a name and click the ”send ” button. 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. DAN. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide The ”Default” configuration name is special. or delete previously saved configurations (see figure 5.5). To delete an existing configuration click on the trash icon at the right of its name.5: Web Interface Configurations Management 5. Figure 5. SoCe Doc: 160902 19 / 37 . If no name is given. 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. because this is the configuration that the system applies to the HW blocks each time it is booted. or VDAN. these frames allow checking which devices are Redboxes.3 Network Nodes Table When using the redundant protocols HSR/PRP. At the same time. it will be saved as ”Default” configuration. The health status of the LAN and its attached devices (nodes and switches) is monitored. the MAC addresses they use and which operating mode they support. 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.

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. Once you have this file in the computer that is being used to access the web interface. Figure 5. you only have to click on the ”Firmware” configuration entry avalaible through the right side device configuration menu. The system updates are provided by SoCe in a unique file.7). and fol- low the given instructions (see figure 5. in order to add new functionalities or fix errors. FPGA bitstreams. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide Figure 5. You need to be in advanced access mode to see the ”Firmware” configuration option.7: Web Interface Firmware Updates SoCe Doc: 160902 20 / 37 .)..

. 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. and using the file selection dialog select the file provided by SoCe .”. In some cases a reboot of the system could be needed.. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide Inside the ”Firmware” updates page you have to click on the button labelled as ”Choose. SoCe Doc: 160902 21 / 37 .

The ethernet device interface is identified as /dev/eth0 by the Operating System run- ning inside the SMARTZynq PCIe HSR/PRP/PTP . 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. • Step 1: Open a new connection in the terminal emulation program and select the option TCP/IP. the steps to follow for connecting to the SMARTZynq PCIe HSR/PRP/PTP are explained.2.1: SSH Connection SoCe Doc: 160902 22 / 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.168.64 by default) and select SSH (version 2). Click OK. The appearance in your computer may differ if you use another program. Below.88. 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. Figure 6. Write the IP address of the device (192.

Figure 6.2: Security Warning • Step 3: Now you will be asked to authenticate with a user name and a password.3: SSH Authentication SoCe Doc: 160902 23 / 37 . The default login for the SMARTZynq PCIe HSR/PRP/PTP is: – User name: linaro – Password: linaro Figure 6. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide • Step 2: A window with a security warning will probably appear. Click Continue.

SoCe Doc: 160902 24 / 37 .6 shows the help menu. Figure 6. and apply that configuration file to the system when we want. you can change it by using the following Linux command: sudo passwd linaro and then typing twice the wanted password.5: Changing the password 6. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide • Step 4: The console prompt should now appear. Figure 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). Figure 6. The tool can also be used to save at any moment the values of all the configuration fields in a configuration file. A first step to understand the tool can be to get the help using soce config reg -h command.4: Console appearance • Step 5: Once you have accessed with the default password. and read or write any of these configuration fields.

It shows the raw registers map (32-bit values). • mes. • redundancy. It shows configuration fields related to redundancy protocols.7 shows the different functionalites once executed soce config reg -l command. • ptp.7: Design Functionalities These are the listed functionalities by default in the SMARTZynq PCIe HSR/PRP/PTP : • reg. SoCe Doc: 160902 25 / 37 . It shows configuration fields related to ethernet switching functionality. 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. Figure 6. It shows PTP configuration fields.

• port conf. to read or write configuration fields the user must use ”-r” or ”-w data” command line options. • 8021x. different statistics fields are listed using the command below: soce config reg -m stats SoCe Doc: 160902 26 / 37 . the number of transmitted frames in PORT-B will be read.8: Design Functionalities 6. in order to access to the redundancy functionality fields the command would be soce config reg -m redundancy. It shows some configuration fields related to ethernet ports that don’t fit in other categories. It allows to configure the priorities functionality of the HSR/PRP.3 Write and Read Operations As stated in the help. For instance. These options must be used along with the ”-f” command line option followed by a configuration field identifier.8 Figure 6.1x functionality. • stats. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide • hps prio. The listed fields are shown in the figure 6. It shows the traffic statistics of each ethernet port. Each configuration field identifier has the format below: <HW Block Name>:<Field Name> 6. It shows configuration fields related to 802.3. First of all.1 Read Operation Example: Number of Transmitted Frames of PORT-B In the following example.

SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide Then. Figure 6.9: Read Operation 6. Figure 6. First of all.3. tx frames field is read using: soce config reg -f HPS-MES-PB:tx frames -r. SoCe Doc: 160902 27 / 37 .9 shows the execution of both commands. HSR and PRP working mode will be changed writing in the corresponding configuration field. redundancy configuration fields are displayed using the command below: soce config reg -m redundancy.2 Write Operation Example: HSR and PRP Working Mode Change In the following example.

Figure 6.10 shows the execution of both commands.11): soce config reg -z Figure 6. The available configurations can be listed using the command below (see figure 6. 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.10: Write Operation 6. Data can be written both in decimal (1) or in hexadecimal (0x1). Once the user has modified some of the configuration fields.4 Configurations Management SMARTZynq PCIe HSR/PRP/PTP loads a default configuration when it starts up. Figure 6. the new configuration can be saved as the default configuration or as an additional configuration.11: Configuration Files List SoCe Doc: 160902 28 / 37 . SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide Then.

Figure 6.12 shows how to save a new configuration as Config3. the new configuration can be saved using the command: soce config reg -s <Config Name>. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide After the system configuration has been modified. Figure 6.13: Load a Saved Configuration SoCe Doc: 160902 29 / 37 . The figure 6. It also shows the updated configuration files list. At any moment the user can apply to the system a previously saved configuration executing: soce config reg -a <Config Name>. the new configuration must be saved with the name Default.12: Save New Configuration If user wants these changes to be loaded when the systems is rebooted.13 shows how to load config3 configuration. Figure 6.

2 shows the configuration fields for the PTP functionality of Port[0.2. 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.A.2.2: PTP Configuration Fields for Port[0.1 PTP Configuration Fields Table 7. Table 7.1.1 shows the generic configuration fields for the PTP functionality.7 Configuration Fields Description 7.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 .A.1. Table 7.B].1: PTP Configuration Fields FIELD DESCRIPTION R/W WIDTH timer addend Timer addend.

SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide Table 7.3: MES Configuration Fields FIELD DESCRIPTION R/W WIDTH Determine the work mode of each port. 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 . Table 7.3 shows the configuration fields for the MES functionality.2 MES Configuration Fields 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. 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.

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 .

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 .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. 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. the data on the first position is read Select the QoS scheme. When mes prio mode new rd R/W 1 it is asserted. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide Table 7. 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.

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.4 shows the configuration fields for the redundancy functionality. When mes switching ether new R/W 1 it is asserted. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide 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 . 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. Table 7. mes broadcast prot limit Maximum number of broadcast frame.3 Redundancy Configuration Fields Table 7. 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.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.

A or B.4 HPS Priority Configuration Fields Table 7. 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. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide Table 7.5 shows the configuration fields for the HPS priority functionality. 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 – From Previous Page FIELD DESCRIPTION R/W WIDTH In PRP – 000: Duplicate discard mode 001: Duplicate accept mode. SoCe Doc: 160902 35 / 37 .

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.6 Statistics Fields Table 7.6: Port-Configuration Configuration Fields FIELD DESCRIPTION R/W WIDTH PHY speed measured using speedometer module.7 shows the fields for the statistics functionality. Table 7.6 shows the configuration fields for the Port-Configuration functionality.5 Port-Configuraiton Configuration Fields Table 7. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide Table 7. phy speed calc 11: GMII (base1000) R 2 10: MII (base100) 01: MII (base10) 7. 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 .

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.8 shows the fields for the 802. Table 7. SMARTZynq PCIe HSR/PRP/PTP Quick Start Guide 7.1x functionality. bits 31 to 0 R/W 32 8021x mac hi Valid MAC address.8: 802.1x Configuration Fields Table 7.7 802. bits 47 to 32 R/W 16 SoCe Doc: 160902 37 / 37 .