TCN-GW-ME REF- Programmer’s manual

tcn-gw-me01_ms_en_100

TCN-GW-ME01

MVB/Ethernet gateway

Programmer’s manual

Version 1.00

TCN-GW-ME01

tcn-gw-me01_ms_en_100 2/14

AMiT, spol. s r.o. does not provide any warranty concerning the contents of this publication and reserves the right to change the documentation without obligation to inform any body or authority about it.

This document can be copied and redistributed under following conditions:

1. The whole text (all pages) must be copied without any changes. 2. All redistributed copies must retain the AMiT, spol. s r.o. copyright notice

and any other notices contained in the documentation. 3. This document must not be distributed for purpose making of profit. The names of products and companies used in this document can be trademarks or registered trademarks of their respective owners.

AMiT is a registered trademark

Copyright (c) 2018, AMiT, spol. s r. o. Producer: AMiT, spol. s r. o.

Naskové 3/1100, 150 00 Praha www.amit-transportation.com

Technical support: [email protected]

http://www.amit-transportation.com/

mailto:[email protected]

TCN-GW-ME01

3/14 tcn-gw-me01_ms_en_100

Table of contents

Revision history .............................................................................................. 4 Related documents ......................................................................................... 4

1. Abbreviation used in this document .................................................. 5

2. AMiT MVB device classes ................................................................... 6

3. Introduction .......................................................................................... 7

4. Technical parameters .......................................................................... 8

5. GTWConfigurator ................................................................................. 9

5.1. Scope ............................................................................................................. 9 5.2. Basic concept ................................................................................................. 9 5.3. Description of menu ........................................................................................ 9

5.4. Description of tabs for device TCN-GW-ME01 ............................................. 10 5.4.1 Database definition ....................................................................................... 10 5.4.2 MVB Definition .............................................................................................. 10

General parameters ...................................................................................... 10

Definition of ports .......................................................................................... 11 5.4.3 ETHERNET Definition .................................................................................. 11

General parameters ...................................................................................... 11 Definition of ports .......................................................................................... 11

5.4.4 MVB to ETH mapping ................................................................................... 12

ETH Source Port Definition .......................................................................... 12

Mapping of MVB port onto ETH port ............................................................. 12 5.4.5 ETH to MVB mapping ................................................................................... 12

ETH Sink Port Definition ............................................................................... 13

Mapping of ETH port onto MVB port ............................................................. 13

6. Domains in device ............................................................................. 14

6.1. List of domains ............................................................................................. 14

TCN-GW-ME01


Revision history

Document name: tcn-gw-me01_ms_en_100.pdf

Version Date Author of change Changes

100 17. 08. 2018 M. Tomáš New document.

Related documents

1. RB-RTM/1101 – operational manual file: rb-rtm1b_g_en_xxx.pdf

2. TCN-ETH-PDB – programme’s manual

file: tcn-eth-pdb_ms_en_xxx.pdf

3. ADSManager – user’s manual

file: adsmanager_ms_en_xxx.pdf

4. IEC 61375-3-1 ed1.0:2012 – Multifunction Vehicle Bus (MVB)

5. IEEE 802.3u – IEEE Standards for local and metropolitan area networks

TCN-GW-ME01


1. Abbreviation used in this document

AMiT Domain Services Cyclic Redundancy Check

Ethernet Message Data – data transmitted sporadically over the bus for diagnostics, bus management etc. Multifunction Vehicle Bus – bus used to transfer data within a consist Node Supervisor Data Base – includes configuration data Process Data – data intended for time-critical data exchange Train Communication Network (IEC 61375-1)

ADS

CRC

ETH

MD

MVB

NSDB

PD

TCN

TCN-GW-ME01


2. AMiT MVB device classes

Class SW identification Description

0 TCN-MVB-LG TCN-MVB-AN

Devices which do not participate in the application data exchange. These devices are invisible (transparent) for other MVB devices.

1 TCN-MVB11_XXX

TCN-GW-MC_XXX

TCN-GW-ME01_XXX

MVB slave devices with DS and PD capabilities

2 TCN-MVB12_XXX MVB slave devices with DS, PD and MD capabilities

3 TCN-MVB13_XXX MVB devices with BA, DS and PD capabilities

4 TCN-MVB14_XXX MVB devices with BA, DS, PD and MD capabilities

TCN-GW-ME01


3. Introduction

Gateway TCN-GW-ME01 serves as a communication interface between MVB and Ethernet networks. Gateway enables the bi-directional transfer of process data and message data. Transfer of process data (PD) between MVB and Ethernet is performed through mapping of sink MVB ports to source Ethernet ports in one direction and mapping of sink Ethernet ports into source MVB ports in opposite direction. TCN-ETH-PDB proprietary protocol is used for transferring PD over Ethernet. Transfer of message data (MD) between MVB and Ethernet is provided by mapping TCN messages into UDP datagrams and vice versa. One UDP datagram always contains one (full) TCN message. TCN-ETH-MD proprietary protocol is used for transferring MD over Ethernet. Gateway TCN-GW-ME01 provides the PD capability on the MVB interface (MVB class 1). Gateway parameters including the mapping of PD parameters are configurable. The configuration is created on PC using the application GTWConfigurator. GTWConfigurator application provides the NSDB domain configuration as output file. This file can be downloaded to the gateway using PC application ADSManager.

TCN-GW-ME01


4. Technical parameters

Compatibility IEC 61375-3-1 ed1.0:2012

Process data Yes

Message data No

Bus administrator No

Class 1

Compatibility IEEE 802.3u

Process data Yes, TCN-ETH-PDB protocol

Message data No, TCN-ETH-MD protocol

NSDB Yes

NSDB creation/editing GTWConfigurator

Configuration download ADSManager connected on Ethernet

MVB/Ethernet gateway (router) RB-RTM/1B011

MVB

Ethernet

Configuration

Target device

TCN-GW-ME01


5. GTWConfigurator

5.1. Scope

This PC application is used for configuration of MVB and ETH parameters, and mapping between MVB ports and ETH ports. The output of this application is configuration file (NSDB) with extension .dom. This file can be loaded in gateway using ADSManager. Following chapters describe the GTWConfigurator application user interface.

5.2. Basic concept

Gateway configuration procedure is as follows:

1. Database creation

2. Setting parameters

3. Uploading NSDB file into converter User shall configure following parameters:

Converter parameters on MVB bus

Converter parameters on ETH process data

Mapping of ETH ports on MVB and vice versa

5.3. Description of menu

File:

New – Creation of new configuration. This action deletes the actual configuration and allows user to create the new one.

Load – Loads configuration from file

Save – Saves configuration with actual name. Unless the configuration has been saved, the user is prompted to entitle the file and select location for saving.

Save As – Saves configuration with new name

Exit – Program termination

Configuration:

Validate – Validation of configuration created by user Options:

Preferences – Selection of default folder for saving / loading of configuration files

Help:

About – Shows information about program

TCN-GW-ME01


5.4. Description of tabs for device TCN-GW-ME01

User interface is divided into five tabs, where user defines parameters of each part of NSDB:

Database definition

MVB definition

ETHERNET Definition

Mapping ETH to MVB

Mapping MVB to ETH

Error List

5.4.1 Database definition

User defines identifying characteristics of NSDB in this tab:

Database Name – Database user name. Maximum 31 characters long (independent on filename).

User Type – Database user type. Maximum 31 characters long (without influence to functionality).

Date – Database creation date. Actual date is used upon database creation. User can change the date arbitrarily. Subsequently, the entered date appears in domain parameters.

User Version – Database user version. Version number subsequently appears in domain version.

Following three items are read only and filled automatically by application:

Database Identifier – Database numerical identifier.

Format Version – Database version. It has no relation to User Version.

32-bit CRC – CRC code calculated over the whole NSDB.

Created by GTWConfigurator – version of the tool created by the NSDB.

5.4.2 MVB Definition

User defines MVB parameters and ports in this tab:

General parameters

Parameter Meaning

Device Address Device address on MVB bus.

Reply Timeout Time in which must be received the slave frame: 0 = default time 42.7 µs 1 = 10.7 µs, 2 = 21.4 µs 3 = 32 µs, 4 = 42.7 µs, 5 = 53.4 µs 6 = 64 µs, 7 = 74.7 µs, 8 = 85.4 µs

MD Priority Priority (Low/High) of MVB messages

Freshness Limit Time in (ms) which determines the interval after elapsing of whose the data in port are considered to be invalid.

TCN-GW-ME01


Definition of ports

User defines the individual MVB ports in ports-table.

Each port is defined by following parameters:

Address Unique 12-bit number which identifies the port address. The limit values (0, 4095) are reserved and must not be assigned to any port.

Source Port is configured as producer; data from port are transmitted to MVB bus.

Sink Port is configured as consumer; data are received into port from MVB bus.

Fcode Size of port in bits. Minimum 16 bits and maximum 256 bits

At least one MVB port must be defined. User cannot save configuration, where the ports-table does not contain any port.

Two MVB ports with the same port address can be configured as source and as sink as well.

5.4.3 ETHERNET Definition

User defines Ethernet parameters and ports in this tab:

General parameters

Type of process data transmission:

Subnet Broadcast – Data will be sent with network broadcast address (Ex. If subnet mask = 255.255.255.0 IP equals xxx.yyy.zzz.255).

Broadcast – Data will be sent with broadcast address (IP: 255.255.255.255).

Multicast – Data will be sent with multicast address.

Destination IP Address – Data will be sent on destination IP Address.

Parameter Meaning

Freshness Limit Time in (ms) which determines the interval after elapsing of whose the data in port are considered to be invalid.

Definition of ports

User defines the individual ETH ports in ports-table.

Each port is defined by following parameters:

Address Unique 12-bit number which identifies the port address. The limit values (0, 4095) are reserved and must not be assigned to any port.

Period Period with which is the source port transmitted to the network, for sink port only informative.

Source Port is configured as producer; data from port are transmitted to ETH.

Sink Port is configured as consumer; data are received into port from ETH.

Fcode Size of port in bits. Minimum 16 bits and maximum 256 bits

At least one ETH port must be defined. User cannot save configuration, where the ports-table does not contain any port.

Note:

Note:

TCN-GW-ME01


5.4.4 MVB to ETH mapping

User defines mapping of MVB ports to ETH ports in this tab. Sink MVB ports are mapped into ETH source ports.

One or more of MVB sink ports can map their data onto ETH source ports.

ETH Source Port Definition

Address – Address of ETH source port

FCode – Bit length of port (16-256)

Period – Period with which is the port transmitted to the network

Mapping of MVB port onto ETH port

Port Address – Mapped port address

FCode – Bit length of defined port

Src Byte Offset – Byte offset in MVB port

Src Bit Offset – Bit offset in the port Src Byte

Dst Byte Offset – Byte offset in ETH port

Dst Bit Offset – Bit offset in Dst Byte

Bit Len – Number of transferred bits

Copy Type – PD copying method

Data/Status – Port data or information about freshness, status etc. Data can be copied from MVB port to ETH port in the four following ways:

CopyType Description

map_byte Whole bytes are copied. Copy length in bits (Bit Len) is automatically rounded to the nearest higher multiple of eight.

map_bit Bitwise copy

map_inv_byte Inverse byte copy (order of bytes is reverted).

map_inv_bit Inverse bitwise copy (order of bites is reverted).

It defines the meaning of the transferred data. Except process data, it is also possible to map information about MVB port freshness. Process data is a default value.

Data – Process data

Freshness – 16-bit value of port freshness

5.4.5 ETH to MVB mapping

User defines mapping of ETH ports to MVB ports in this tab. Sink ETH ports are mapped into MVB source ports.

One or more of ETH sink ports can map their data onto MVB source ports.

Copy Type

Data/Status

TCN-GW-ME01


ETH Sink Port Definition

Address – Address of ETH sink port

FCode – Bit length of port (16-256)

Period – Period with which the ports are transmitted to the network

Mapping of ETH port onto MVB port

Mapping of ETH port onto port(s) is determined by following items:

Port Address – Destination MVB port address

FCode – Bit length of defined port

Src Byte Offset – Byte offset in source ETH port

Src Bit Offset – Bit offset in Src Byte

Redundancy Control – Internal destination item for control MVB bus.

Dst Byte Offset – Destination byte in MVB port

Dst Bit Offset – Bit offset in Dst Byte

Bit Len – Number of transferred bits Copy Type – PD copying method (see table Copy Type in the chapter

Mapping of MVB port onto ETH port)

Control of TCN-GW-ME01 using gateway control structure is possible from only Ethernet bus:

Title Type Length Description

Redundancy Control

Enum8 8 bit Requested control state 0 = control is not defined 1 = standby state of MVB bus 2 = active state of MVB bus

If item is not mapped, the default control is 2 (active).

If item is mapped, the default control is 1 (standby).

Internal Control

TCN-GW-ME01


6. Domains in device

This chapter specifies list of domains and names of the files. In each domain it is specified if domain is fixed or upgradable.

6.1. List of domains

TCN-GW-ME01 on the target device includes following domains:

Domain Status from production

Description / Upgrade

Loader Loaded Device loader Upgrade No

Controller safe Loaded Safe FPGA Upgrade No

Controller Loaded FPGA Upgrade Yes

Safe Application Loaded Safe application Ugrade Yes

Executed Application Loaded Currently running application Only informative

Application Update Free New application for updating Ugrade Yes

Journal Loaded Operating journal Upgrade No

NSDB Free Configuration database Created by user Upgrade: Yes

All domains are provided by AMiT company. Current versions it is possible to download from:

http://imp.amit.cz/www/mvb/tcn-gw-me01_04/index.htm

It is possible to download only correct file into the domain. The file with incorrect content (e.g. another domain file) is impossible to download.

http://imp.amit.cz/www/mvb/tcn-gw-me01_04/index.htm

Documents

TCN-GW-ME REF- Programmer’s manual