ss7 mtp layer 2 developer’s reference manual · ss7 mtp layer 2 developer’s reference manual...

IDX GLSTOC

SS7 MTP Layer 2 Developer’s Reference Manual

P/N 9000-6477-17

Send Feedback to NMS Doc Dept

100 Crossing Boulevard, Framingham, MA 01702-5406 USAwww.nmscommunications.com

http://www.nmscommunications.com

http://www.nmss.com

http://www.nmss.com

mailto:[email protected]

IDX GLSTOC

No part of this document may be reproduced or transmitted in any form or by any means without prior written consent of NMS Communications Corporation.

2002 NMS Communications Corporation. All Rights Reserved.

Alliance Generation is a registered trademark of NMS Communications Corporation or its subsidiaries. NMS Communications, Natural MicroSystems, AG, CG, CX, QX, Convergence Generation, Natural Access, CT Access, Natural Call Control, Natural Media, NaturalFax, NaturalRecognition, NaturalText, Fusion, PacketMedia, Open Telecommunications, Natural Platforms, and HMIC are trademarks or service marks of NMS Communications Corporation or its subsidiaries. Multi-Vendor Integration Protocol (MVIP) is a registered trademark of GO-MVIP, Inc. UNIX is a registered trademark in the United States and other countries, licensed exclusively through X/Open Company, Ltd. Windows NT, MS-DOS, MS Word, Windows 2000, and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Clarent and Clarent ThroughPacket are trademarks of Clarent Corporation. Sun, Sun Microsystems, and the Sun logo are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and/or other countries. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. in the United States and/or other countries. Products bearing SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc. All other marks referenced herein are trademarks or service marks of the respective owner(s) of such marks.

Every effort has been made to ensure the accuracy of this manual. However, due to the ongoing improvements and revisions to our products, NMS Communications cannot guarantee the accuracy of the printed material after the date of publication, or accept responsibility for errors or omissions. Revised manuals and update sheets may be published when deemed necessary by NMS Communications.

Revision History

Refer to the NMS web site (www.nmscommunications.com) for product updates and for information about NMS support policies, warranty information, and service offerings.

Revision Release Date NotesB.1.0 July, 1998 GJG1.1 September 15, 1998 GJG1.2 March, 1999 GJG1.4 November, 2000 GJG; SS7 3.61.5 GJG; SS7 3.611.6 August, 2001 GJG; SS7 3.8 Beta1.7 February, 2002 MVH; SS7 3.8 GA This manual printed: January 31, 2002


http://www.nmss.com


IDX GLSTOC

Table of Contents

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.2 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92.1 Overview of the MTP 2 Installation and Configuration Process . . . . . . . . . 10

2.1.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102.1.2 Configuring TDM Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102.1.3 Configuring MTP 2 Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102.1.4 Downloading the Board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112.1.5 Running a Sample User Application . . . . . . . . . . . . . . . . . . . . . . . . 14

2.2 SS7 Links and MTP Layer 2 Service Users . . . . . . . . . . . . . . . . . . . . . . . . . 152.3 Entity and Instance IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162.4 TX Driver Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172.5 TX Driver Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182.6 Byte Ordering Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192.7 Layer 2 Interface Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

2.7.1 Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202.7.2 Connection Establishment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212.7.3 Data Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222.7.4 Status/Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232.7.5 Connection Clearing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

2.8 MTP 2 Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

3 MTP 2 Management Alphabetical Function Reference . . . . . . . . . . . . . . . . . 273.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Mtp2GetLinkCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Mtp2InitLinkCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Mtp2LinkStats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Mtp2LinkStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Mtp2MgmtCtrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Mtp2MgmtInit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Mtp2MgmtTerm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Mtp2SetLinkCfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

NMS Communications 3



Table of Contents SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

4 MTP 2 Sample Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474.1 The MTP 2 Configuration Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

4.1.1 Using the MTP 2 Configuration Utility. . . . . . . . . . . . . . . . . . . . . . . 484.1.2 The MTP 2 Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524.1.3 MTP2 Configuration Parameter Reference . . . . . . . . . . . . . . . . . . . . 534.1.4 Sample Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

4.2 The MTP 2 Manager Program. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594.2.1 Using the MTP 2 Manager Program . . . . . . . . . . . . . . . . . . . . . . . . . 59

4.3 The Sample Applications - mtp2app and mtp2itu . . . . . . . . . . . . . . . . . . . . . 65

Appendix A MTP 2 Message Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Bind Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Connect Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Connect Confirmation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Data Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Data Confirmation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Data Indication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Disconnect Confirmation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Disconnect Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Disconnect Indication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Disconnect Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Flow Control Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Flow Control Indication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Flow Control Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Status Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Status Confirmation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Status Indication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Status Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

4 NMS Communications



IDX GLSTOC

Chapter 1

Introduction

1.1 Introduction 6

1.2 Overview 6




Chapter 1 Introduction SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

1.1 Introduction

The SS7 MTP Layer 2 Developer’s Reference Manual describes the interface from the host processor to the resident SS7 MTP Layer 2 (link layer), independent of the host operating system and device driver employed.

Subsequent sections of this document describe the general characteristics and operation on the MTP 2 APIs, as well as a detailed specification of the messages and function calls that comprise the APIs.

1.2 Overview

A typical SS7/MTP 2 implementation consists of the following :

Æ The SS7 MTP layer 2 running on the TX communications processor. The MTP2 process provides the signaling link functions defined by the ITU-T (Q.703) and ANSI (T1.111) standards: signal unit delimitation and alignment, error detection and correction, link alignment, link error monitoring, and flow control.

Æ The TX Alarms Manager task. This task collects unsolicited alarms (status changes) generated by the MTP 2 task and forwards them to the host for application-specific alarm processing.

Æ A TX driver for the host operating system which provides low level access to the TX Series from the host PC.

Æ The txalarm application on the host for displaying and optionally saving to disk alarms from the MTP 2 task.

Æ The TX MTP 2 interface is comprised of a set of messages passed between the user application (providing the SS7 MTP layer 3 functionality) and the MTP 2 process on the TX communications processor. These messages allow the (layer 3) application to initialize, transfer data, and exchange status information with layer 2, enabling the (layer 3) application to implement the link and traffic management procedures defined in the relevant standards for layer 3.

Æ The mtp2cfg utility that downloads text file configurations to the MTP 2 task. mtp2cfg is provided in source and executable form.




SS7 MTP 2 Developer’s Reference Manual Overview

IDX GLSTOC

Æ The mtp2mgr utility that allows a user to manage the MTP 2 task. mtp2mgr is provided in source and executable form.

Æ The mtp2app and mtp2itu sample user applications also provided in source and executable form. These sample applications take user commands and send messages to the MTP 2 task.

Æ The MTP 2 Management API that provides a series of calls for managing the MTP 2 task. The mtp2cfg and mtp2mgr both use this API.




Chapter 1 Introduction SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

Figure 1. SS7 System Architecture

Host TX driver

TXcommunications

processor

Host

SS7 MTP Layers 2 & 3Task

SS7 Layer 1 driver

AlarmsManager

task

SS7 SCCPtask

SS7 ISUP/TUPtask

Config. utility

MTP Layers2 & 3

Mgmt. API

Application

MTP Layers2 & 3 API

Txalarm utility Logfile

SS7 TCAPtask




IDX GLSTOC

Chapter 2

Getting Started

2.1 Overview of the MTP 2 Installation and Configuration Process 102.1.1 Installation 102.1.2 Configuring TDM Ports 102.1.3 Configuring MTP 2 Links 102.1.4 Downloading the Board 112.1.5 Running a Sample User Application 14

2.2 SS7 Links and MTP Layer 2 Service Users 15

2.3 Entity and Instance IDs 16

2.4 TX Driver Interface 17

2.5 TX Driver Message Format 18

2.6 Byte Ordering Considerations 19

2.7 Layer 2 Interface Procedures 202.7.1 Binding 202.7.2 Connection Establishment 212.7.3 Data Transfer 222.7.4 Status/Control 232.7.5 Connection Clearing 25

2.8 MTP 2 Messages 25




Chapter 2 Getting Started SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

2.1 Overview of the MTP 2 Installation and Configuration Process

The following sections provide a summary of the steps required to install and configure the MTP layer 2 software.

2.1.1 Installation

First, the TX board needs to be installed properly. Remember which IRQ and memory address the board is set for before installing the card in the PC. See the appropriate installation manual for more information.

Next, the software needs to be installed. Install the TX Base/Device Driver package and then the MTP 2 layer software. See the Installation Instructions in the SS7 CD-ROM booklet for information on the installation of the Base/Device driver package for your operating system.

2.1.2 Configuring TDM Ports

If the TX board which will run the MTP 2 task will be sending and receiving on a T1, E1 or MVIP time slot, see the T1/E1/MVIP Interface Adapters Developer’s Reference Manual for help with setting up TDM ports for use by the MTP 2 task. There are two sample configuration files included with the Base Software: tdmcp1.cfg and tdmcp2.cfg. These two samples will support a back-to-back arrangement of two TX boards using T1’s.

2.1.3 Configuring MTP 2 Links

MTP 2 allows applications to configure the number of links as well as many parameters associated with those links. Four samples are included with MTP 2, two for ANSI and two for ITU-T. These samples are located in \nms\tx\config\ for Windows and /opt/nmstx/etc/ for UNIX. The sample configurations support back-to-back configurations. These examples contain a definition for one TDM port and a “commented-out” V.35 port. If the installation uses V.35 ports, then “comment in” the example serial port definition in the file and “comment out” the TDM port.




SS7 MTP 2 Developer’s Reference Manual Downloading the Board

IDX GLSTOC

2.1.4 Downloading the Board

Once the software and links are set up properly, the TX board can be downloaded with the software and configuration. The mtp2load batch file is included to assist in this action. The mtp2load file accepts one parameter, the board number to load. This loader file downloads the necessary software to the TX board, including the proper kernel, support tasks for alarms and debugging, a console program, the MVIP and T1/E1 managers, and MTP 2 itself. Finally, the configuration for MTP 2 is downloaded.

Here is the Windows NT or Windows 2000 version of mtp2load.bat:

@echo offREMset TXUTIL=c:\nms\tx\binset TXCP=c:\nms\tx\cpset TXCONFIG=c:\nms\tx\configset BRD=1if not "%1"=="" set BRD=%1REMREM TXn000 COMMUNICATIONS PROCESSOR BOOT FILEREMREMREM Execute this file to boot/configure the TXn000 processorREMREMREM Get the model number%TXUTIL%\cpmodel -b %BRD%if errorlevel 3000 goto boot3000if errorlevel 2000 goto boot2000echo ERROR! Check board numbergoto end:boot3000%TXUTIL%\cplot -c %BRD% -f %TXCP%\cpk3000.lo -k -a -u ss7goto loadsw:boot2000%TXUTIL%\cplot -c %BRD% -f %TXCP%\cpk.lo -k -a -u ss7goto loadsw:loadswREM%TXUTIL%\cplot -c %BRD% -f %TXCONFIG%\TDMcp%BRD%.bin -g tdm%TXUTIL%\cplot -c %BRD% -f %TXCP%\nmg.lot -n netmgr -p 5 -a%TXUTIL%\cplot -c %BRD% -f %TXCP%\console.lot -n console -p 2 -a%TXUTIL%\cplot -c %BRD% -f %TXCP%\inf.lot -n inf -p 10 -aREMREM download the MVIP and T1/E1 manager tasks to enable useREM of the MVIP and T1/E1 host APIs; NOTE: if you do notREM use either of these APIs, remove the following 2 lines.





IDX GLSTOC

REM%TXUTIL%\cplot -c %BRD% -f %TXCP%\mvip.lot -n mvip -p 4 -a%TXUTIL%\cplot -c %BRD% -f %TXCP%\t1e1mgr.lot -n t1e1mgr -p 15 -aREMREM Load MTP2 stand alone task REM%TXUTIL%\cplot -c %BRD% -f %TXCP%\mtp2.lot -n mtp -p 10 -a -s 12000%TXUTIL%\mtp2cfg -b %BRD% -f %TXCONFIG%\MTP2cp%BRD%.cfg:endset TXUTIL=set TXCP=set TXCONFIG=

The Unix version of MTP2LOAD looks similar:# Reset board, clear driver stats# load CPK/OS and related tasks,# and configure SS7if [ -z "$TX2BASE" ]then TX2BASE=/usr/lib/txnfiif [ -z "$CONFIGBASE" ]then CONFIGBASE=/etc/txnfi# reset boardcputil -b$1 -R# clear driver statscputil -b$1 -C# get board typeBOARDTYPE=‘cputil -b$1 -i‘case $BOARDTYPE in TX3000) CPK="cpk3000.lo" ;; TX2000) CPK="cpk2000.lo" ;; *) echo "board $1 not available" exit 1 ;;esac# load CPK/OS cplot -c $1 -f $TX2BASE/$CPK -k -u ss7 -a# load Related taskscplot -c $1 -f $TX2BASE/debug.lot -n debug -p 3 -acplot -c $1 -f $TX2BASE/nmg.lot -n netmgr -p 5 -acplot -c $1 -f $TX2BASE/console.lot -n console -p 2 -acplot -c $1 -f $TX2BASE/inf.lot -n inf -p 10 -a




SS7 MTP 2 Developer’s Reference Manual Downloading the Board

IDX GLSTOC

# load TDM configuration - note: remove this line if you use# serial (V.35) ports rather than T1/E1/MVIPcplot -c $1 -f $CONFIGBASE/TDMcp$1.bin -g tdm# load the MVIP and T1/E1 manager tasks to enable use# of the MVIP and T1/E1 host APIs. Note: if you do not# use either of these APIs, remove the following two linescplot -c $1 -f $TX2BASE/mvip.lot -n mvip -p 4 -acplot -c $1 -f $TX2BASE/t1e1mgr.lot -n t1e1mgr -p 15 -a# MTP2 stand alone taskcplot -c $1 -f $TX2BASE/mtp2.lot -n mtp -p 10 -a# MTP2 configuration. mtp2cfg -b $1 -f $CONFIGBASE/MTP2cp$1.cfg

The txalarm application is also included to help debugging the configuration and user applications. The following is a sample output from txalarm when the board is downloaded without sending a new MTP 2 configuration:

<12/05/1997 15:51:58> mtp 1 1 Registering MTP Layer 2<12/05/1997 15:51:58> mtp 1 1 Configuring MTP Layer 1<12/05/1997 15:51:58> mtp 1 1 MTP1 Initializing.<12/05/1997 15:51:58> mtp 1 1 MTP1 General Configuration<12/05/1997 15:51:58> mtp 1 1 MTP1 Configuring link 0: TDM, External<12/05/1997 15:51:58> mtp 1 1 MTP1 Configuring link 1: TDM, External<12/05/1997 15:51:58> mtp 1 1 MTP1 Configuring link 2: TDM, External<12/05/1997 15:51:58> mtp 1 1 MTP1 Configuring link 3: TDM, External<12/05/1997 15:51:58> mtp 1 1 MTP1 Configuration Done<12/05/1997 15:51:58> mtp 1 1 Configuring MTP Layer 2<12/05/1997 15:51:58> mtp 1 1 MTP2: General Configuration<12/05/1997 15:51:58> mtp 1 1 MTP2: Link 0 Configuration<12/05/1997 15:51:58> mtp 1 1 MTP2: Link 1 Configuration<12/05/1997 15:51:58> mtp 1 1 MTP2: Link 2 Configuration<12/05/1997 15:51:58> mtp 1 1 MTP2: Link 3 Configuration





IDX GLSTOC

2.1.5 Running a Sample User Application

When the board has been loaded, one of the sample applications can be started. mtp2app is an ANSI version and mtp2itu is an ITU-T (formerly CCITT) version of the sample application. See Chapter 4 for more details.

If you are using the TX board with test equipment, run an application then hit <RETURN> to get a command prompt. Type connect 0 <ENTER> to ask the board to start the connect procedure on link 0. The txalarm output should look like the following sample if the link aligns properly:

<12/05/1997 15:52:45> mtp 1 1 Flushing Buffers (OPC=0)<12/05/1997 15:52:45> mtp 1 1 Starting Alignment<12/05/1997 15:52:45> mtp 1 1 IAC Rx SIO<12/05/1997 15:52:45> mtp 1 1 IAC Rx SIO<12/05/1997 15:52:45> mtp 1 1 Rx SIN<12/05/1997 15:52:47> mtp 1 1 ALIGN TIMER 4 EXPIRED (Link Aligned)

If you are using two TX boards back-to-back, after downloading each board separately, start an application on each board (mtp2app -b 2 to run on board 2), and type connect 0 on each. The txalarm output should look like the following sample if the link aligns properly:

<12/05/1997 15:52:42> mtp 2 1 Flushing Buffers (OPC=0) (Lnk 0)<12/05/1997 15:52:42> mtp 2 1 Starting Alignment (Lnk 0)<12/05/1997 15:52:45> mtp 1 1 Starting Alignment (Lnk 0)<12/05/1997 15:52:45> mtp 2 1 Received SIOS (Lnk 0)<12/05/1997 15:52:45> mtp 1 1 IAC Rx SIO (Lnk 0)<12/05/1997 15:52:45> mtp 1 1 IAC Rx SIO (Lnk 0)<12/05/1997 15:52:45> mtp 1 1 Rx SIN (Lnk 0)<12/05/1997 15:52:45> mtp 2 1 IAC Rx SIO (Lnk 0)<12/05/1997 15:52:45> mtp 2 1 IAC Rx SIO (Lnk 0)<12/05/1997 15:52:45> mtp 2 1 Rx SIN (Lnk 0)<12/05/1997 15:52:47> mtp 1 1 ALIGN TIMER 4 EXPIRED (Lnk 0)<12/05/1997 15:52:47> mtp 2 1 ALIGN TIMER 4 EXPIRED (Lnk 0)

The middle column that contains 1’s and 2’s identifies which board generated the alarm.




SS7 MTP 2 Developer’s Reference Manual SS7 Links and MTP Layer 2 Service Users

IDX GLSTOC

2.2 SS7 Links and MTP Layer 2 Service Users

A TX communications processor can support up to 16 SS7 links (depending on the board model and hardware configuration), numbered 0 to 15. Additional TX boards can be added for more links.

The MTP Layer 2 interface supports one or more user applications by way of service access points, or SAPs. Each SAP corresponds to a single SS7 link controlled by the MTP 2 process. A user application binds to a particular SAP at initialization time, specifying the link number to which the application wishes to bind (0-15). An application implementing MTP layer 3 would repeat the bind process for every SS7 link on every TX communication processor. Only one process is allowed to bind to each SS7 MTP 2 service access point (link).

Figure 2. MTP 2 Service Access Points (SAPs)

UserMTP 3

SAP 0 SAP 1 SAP n

LINK 0 LINK 1 LINK n

MTP 2 SAPs

Bind

MTP 2LAYER

...

...





IDX GLSTOC

2.3 Entity and Instance IDs

Each application must have a unique entity and instance number, which is used to route messages among the various processes in the system. Entity IDs are single byte values in the range 0x00 to 0x3f, assigned as desired by the application developer. The following entity IDs are reserved:

Instance IDs identify the processor that the entity executes on. The host is always processor zero, so for all host-resident MTP 2 user applications this value should be coded to zero. All tasks on the TX board number one receive an instance ID of one, all tasks on TX board number two receive an instance ID of two, and so on.

Range Usage

0x00 - 0x1F Reserved for use by system utilities, configuration utilities, and management utilities.

0x20 - 0x3F Available for use by applications.




SS7 MTP 2 Developer’s Reference Manual TX Driver Interface

IDX GLSTOC

2.4 TX Driver Interface

The TX device drivers implement a message-passing interface between the host and TX processor (CP). The physical interface between the host and the CP (shared dual-port RAM, or DPR) is subdivided into a set of virtual channels to support communication between processes on the host and processes on the TX board. The channel concept allows multiple process on both the host and TX processor to exchange messages without interfering with each other. The TX board currently supports 256 channels (numbered 0 to 255). Channels 0 to 31 are reserved for use by NMS standard products. Channels 32 to 255 are available for application use.

A process (on either the host or TX processor) wishing to receive messages registers with the driver for a particular channel number. For a host-resident process, the channel registration may be implicit with the device open request, or it may be a separate operation. Channel numbers are assigned statically at compile time. There is no built-in facility to dynamically learn the channel assigned to any particular function. Only one process may receive messages for a particular channel. Each message contains a header, supplied by the sender of the message, to identify the destination board and channel, the source board and channel, and the length of the message.

Each process in an SS7 implementation, both on the CP and on the host, registers for the channel that corresponds to that layer’s (or application’s) entity ID. The MTP 2 layer registers for channel 0x16. To send a message to the MTP 2 layer on board n, the destination channel is set to 0x16, the destination board is set to n, and the source channel and board are set to the sender’s entity ID and board number (the host is board number zero).

The TX driver can be called through the CPI Library. Consult the CPI Library Software Interface Manual for more details. An application should call cpi_init before using any other CPI calls. A call to cpi_open should be issued to each board with which the application wishes to communicate. cpi_send and cpi_get_data are then called to send and retrieve data packets to and from the board.





IDX GLSTOC

2.5 TX Driver Message Format

This section describes the general format of messages passed between the MTP 3 process on the host and the MTP 2 task on the TX CP through the TX driver.

Octet Message Format

0 Source Channel (Source Entity ID)

1 Source Board (Source Instance ID)

2 Destination Channel (Destination Entity ID)

3 Destination Board (Destination Instance ID)

4

5

Message Length (2 octets)

6

7

Message Start Offset (2 octets)

8

9

Message End Offset (2 octets)

10..i Filler

i + 1 Message Type

i + 2 ...

... MTP 2 Message Parameters

n ...




SS7 MTP 2 Developer’s Reference Manual Byte Ordering Considerations

IDX GLSTOC

The destination entity/instance IDs and the source entity/instance IDs define the intended recipient and the sender of the message, respectively. The Message Length contains the byte length of the entire message, including headers, filler, and parameters. The Message Start Offset contains the number of octets of filler included following the Message End Offset before the Message Type parameter. It is recommended that at least four bytes of filler are included on messages sent to MTP 2 to guarantee MTP 2 has room to prepend its header to the actual data portion of a message without having to copy the data to a new buffer. On messages received from MTP 2, the layer 3 application must use this parameter to determine where in the buffer the actual message content (the Message Type field) begins (see Section 2.8). Several include files are available with the MTP 2 sample user application code. mtp2app.h or mtp2itu.h along with txcpi.h contain structures for message formats.

2.6 Byte Ordering Considerations

The following byte ordering conventions for 16-bit and 32-bit parameters in the messages to and from MTP 2. This is not the same byte ordering used for short and long integers on Intel 80x86 machines. The host application is responsible for converting between network and host byte order, if necessary, in both the send and receive directions.

Note: The Message Length field is part of the DPR header interface between the host application and the host device driver, and must be passed in host native byte order, not the byte order shown in this section. The Message Start and End offsets, on the other hand, are part of the interface between the host application and the MTP 2 process, and must be passed in the network byte order shown below:

16-Bit Fields:

Address

Low High Order Byte (MSB)

High Low Order Byte (LSB)





IDX GLSTOC

32-Bit Fields:

The following nomenclature is used for data types:

2.7 Layer 2 Interface Procedures

This section describes the procedures (the sequence of messages) used to interface to the SS7 MTP 2 process on the TX board. The SS7 layer 2 interface consists of several distinct phases: binding, connection establishment, data transfer, connection clearing, and status/control.

2.7.1 Binding

The binding phase establishes the host application (MTP layer 3) as the user of the layer 2 interface. Binding consists of a single BIND request from the application to layer 2, for which there is no response. A seperate bind request must be sent to MTP 2 for every link on every TX board that the application wishes to use.

Data Type Description

U8 Unsigned 8-bit quantity

S16 Signed 16-bit quantity

U32 Unsigned 32-bit quantity

Address

Low High Order Word (MSB)

High Order Word (LSB)

Low Order Word (MSB)

High Low Order Word (LSB)




SS7 MTP 2 Developer’s Reference Manual Connection Establishment

IDX GLSTOC

2.7.2 Connection Establishment

MTP layer 2 establishes a connection by sending a CONNECT request packet. This causes MTP layer 2 to attempt to bring up the link and initiate link alignment procedures with the far exchange. Layer 2 sends a CONNECT CONFIRMATION mesage back to the user when link alignment has been successfully established. Connection establishment is requested separately for each SS7 link

Note: No data packets may be transferred until the CONNECT CONFIRMATION message has been received by the user application.

Figure 3. Message Flow for Connection Establishment

MTP 2 Process Far Exchange

Connect Rqst

Connect Cfm

SIN or SIE

FISUs

Begin LinkAlignment

SIO

AlignmentComplete

Application(Layer 3)





IDX GLSTOC

2.7.3 Data Transfer

The data transfer phase is entered on a particular link once the MTP 2 process has returned a CONNECT CONFIRMATION message to the application.

The layer 2 user application requests a SS7 packet to be transmitted on a particular link by sending a DATA REQUEST to layer 2. MTP 2 returns a DATA CONFIRMATION message back to the user application when the message has been acknowledged by the far exchange. The application may send multiple DATA REQUEST(s) to MTP 2 before receiving a DATA CONFIRMATION. The DATA CONFIRMATION message contains a credit field indicating the number of data requests being acknowledged by the data confirm.

Figure 4. Message Flow for an Outgoing Data Transfer

MTP 2 Process

Data Rqst

Data Rqst

Data Confirm

MSU

FSN (1)

FISU

MSU

FSN (2)

BSN (2)


Far Exchange




SS7 MTP 2 Developer’s Reference Manual Status/Control

IDX GLSTOC

Layer 2 notifies the user application of an incoming data packet by sending a DATA INDICATION packet (see Figure 5). There is no response to this packet from the user application back to layer 2.

Figure 5. Notification of an Incoming Data Packet

During data transfer, the user application may request layer 2 to apply flow control to a link (or to stop flow control) by sending a FLOW request. There is no response from layer 2 back to the user application for this request. Layer 2 may also send an unsolicited FLOW INDICATION message to the user application to indicate that congestion has started or ended on a link.

2.7.4 Status/Control

The MTP 2 status request supports a number of functions which help layer 3 implement link and traffic management procedures.The layer 3 application may use the status request to perform the following functions.

Æ Retrieve the current BSN (last acknowledged sequence number) for a link (useful in implementing changeover procedures).

Æ Retrieve all MSUs transmitted on a link but not yet acknowledged (also useful in implementing changeover procedures).

Æ Request MTP 2 to drop all queued messages.

Æ Notify MTP 2 of an emergency on or off condition on a link.

Æ Notify MTP 2 of a local processor up or down condition (passed on to the far exchange).

MTP 2 Process Far Exchange

Data Indication

MSU






IDX GLSTOC

MTP 2 returns a STATUS CONFIRMATION message containing the current BSN (last acknowledged sequence number) for a link to the application in response to a "retrieve BSN" status request. MTP 2 may also return a STATUS CONFIRMATION message in response to a "retrieve messages" status request, but only if there are no unacknowledged messages to be retrieved. If there are unacknowledged messages to be retrieved, a DATA CONFIRMATION indicating a status of "unacknowledged [more|last]" is sent to the application for each message (the last indicates that it is the last). In this case, no STATUS CONFIRMATION message is returned to the application.

Figure 6. Use of "Retrieve" Status Requests to Implement Link Changeover

Disconnect Ind

Status Rqst(Retrieve BSN)

Status Confirm(BSN)

Data Rqst(Changeover Order)

Data Indication(Changeover Ack)

Status Rqst(Retrieve Msgs)

Data Confirm(Unack’d/More)

Data Confirm(Unack’d/Last)

Data Rqst(Resend)

COO

COA

MSU

. . .


MTP 2 SAP(Failed Link)

MTP 2 SAP(Good Link)

Far Exchange




SS7 MTP 2 Developer’s Reference Manual Connection Clearing

IDX GLSTOC

2.7.5 Connection Clearing

The user application may request that the link be disabled by sending a DISCONNECT request to layer 2. There is no response from layer 2 to a DISCONNECT request. Layer 2 may send an unsolicited DISCONNECT INDICATION to the user application to notify it that a link has been disconnected and the reason for the disconnect.

Layer 2 will send unsolicited STATUS INDICATION messages to the user application to notify it of changes in the link status (up or down).

2.8 MTP 2 Messages

The following messages comprise the interface to the SS7 layer 2 task. All messages contain a message type and a link ID in addition to the parameters listed in the following table. Actual message layouts are specified in Appendix A.

Message Direction Parameters Description

BIND REQUEST MTP3 -> MTP2 Service User ID Service Prov. ID User Entity ID User Instance ID

Binds user application as sole user of SS7 layer 2 link.

CONNECT REQUEST

MTP3 -> MTP2 Status Requests layer 2 to bring up a physical link. Status parameter may be used to specify status to bring link up in (for example, normal, emergency, or power on only).

CONNECT

CONFIRM

MTP2 -> MTP3 None Notifies user application that link connect has successfully completed (link is aligned).

DATA REQUEST MTP3 -> MTP2 Data buffer Requests layer 2 to transmit data buffer on a particular link.

DATA CONFIRM MTP2 -> MTP3 Status Credit Acknowledges transmission of a data request back to user application; Status parameter indicates whether more DATA requests may be issued, Credit parameter indicated how many requests are being acknowledged.





IDX GLSTOC

DATA INDICATION MTP2 -> MTP3 Data buffer Indicates received data packet to user application.

DISCONNECT REQUEST

MTP3 -> MTP2 Reason Requests layer 2 to disconnect a link.

DISCONNECT INDICATION

MTP2 -> MTP3 Reason Notifies user application that a link is disconnected.

FLOW REQUEST MTP3 -> MTP2 Action Requests layer 2 to start or stop flow control on a link.

FLOW INDICATION MTP2 -> MTP3 Action Notifies user application that congestion has started or stopped on a link.

STATUS REQUEST MTP3 -> MTP2 Action Status Requests special status/control function.

STATUS CONFIRM MTP2 -> MTP3 Action Status Response to status request for certain status/control functions.

STATUS INDICATION

MTP2 -> MTP3 Status Notifies user application that a link has gone up or come down.

Message Direction Parameters Description




IDX GLSTOC

Chapter 3

MTP 2 Management Alphabetical Function Reference

3.1 Introduction 28Mtp2GetLinkCfg 29Mtp2InitLinkCfg 30Mtp2LinkStats 37Mtp2LinkStatus 39Mtp2MgmtCtrl 42Mtp2MgmtInit 43Mtp2MgmtTerm 44Mtp2SetLinkCfg 45




Chapter 3 MTP 2 Management Alphabetical Function Reference SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

3.1 Introduction

This chapter provides a comprehensive, alphabetically-ordered reference to the MTP 2 management API functions. A prototype of each function is shown with the function description, details of all arguments, and return values. Some of the fields in the function definition include:

Prototype The prototype is shown followed by a listing of the function’s arguments. NMS Communications data types include:

Æ U8Æ S16Æ U32Æ Bool

Æ 8-bit unsignedÆ 16-bit signedÆ 32-bit unsignedÆ 8-bit unsigned

If a function argument is a data structure, the complete data structure is defined.

Return Values

The return value for a function is either MTP2_SUCCESS or an error code. For asynchronous functions, a return value of MTP2_SUCCESS (zero) indicates the function was initiated; subsequent events indicate the status of the operation.




SS7 MTP 2 Developer’s Reference Manual Mtp2GetLinkCfg

IDX GLSTOC

Mtp2GetLinkCfg

Description Obtains the current data link configuration values of the specified link number.

Prototype MTP2_STATUS Mtp2GetLinkCfg (U8 board, MTP2LinkCfg *pLinkCfg,

S16 linkNo)

board The TX board number on which the desired MTP 2 task resides.

pLinkCfg A pointer to an MTP2LinkCfg structure where the data link configuration values will be filled.

linkNo The link number to obtain configuration information for (0 to maximum number of links - 1).

Return Values MTP2_SUCCESS

MTP2_BOARDInvalid board number specified.

MTP2_HANDLEMtp2MgmtInit was never called for specified board.

MTP2_TIMEOUTNo response from board.

Details This function obtains the current data link configuration parameters of the specified link on the specified board. An application must provide a pointer to a buffer large enough for the MTP2LinkCfg structure. This function may be called any time after Mtp2MgmtInit.

Refer to the MTP2LinkCfg structure in the Mtp2InitLinkCfg reference for more information about its fields.




Mtp2InitLinkCfg SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

Mtp2InitLinkCfg

Description Initializes the data link configuration structure provided with default values and the link number and link type specified.

Prototype MTP2_STATUS Mtp2InitLinkCfg (U8 board, MTP2LinkCfg *pLinkCfg, S16 linkNo, U8 linkType)


pLinkCfg A pointer to the MTP2LinkCfg structure to be initialized.

linkNo The link number to assign to this data link. This value must be from 0 to the maximum number of links-1 (Depends on hardware configuration).

linkType The type of link. This is one of: MTP2LNK_ANSI MTP2LNK_ANSI88 MTP2LNK_CCITT


MTP2_LNKTYPEInvalid link type specified.

Details This function is provided as a quick way for an application to initialize an MTP2LinkCfg structure before calling Mtp2SetLinkCfg to set the data link configuration parameters. Mtp2InitLinkCfg sets the link number and link type as specified and initializes all other fields in the Mtp2SetLinkCfg structure to their defaults.




SS7 MTP 2 Developer’s Reference Manual Mtp2InitLinkCfg

IDX GLSTOC

The following structures are used for individual data link configuration in the MTP 2 task. Typically, a pointer to an MTP2LinkCfg structure is passed to Mtp2InitLinkCfg where default values are set. These defaults are specified in the following table. If there is no default, the field is either unused or its value is passed as a parameter to Mtp2InitLinkCfg. In the latter case, the parameter name is specified in the table. After initialization, an application may override zero to all of these values and then pass the pointer to Mtp2SetLinkCfg, which actually sets the configuration.

Most of the default values provided by Mtp2InitLinkCfg will be adequate for most applications.

typedef struct _MTP2LinkCfg /* MTP level 2 data link SAP configuration */{ MemoryId mem; /* memory region and pool id */ MemoryId memMac; /* memory region and pool id for MAC */ S16 swtch; /* protocol type */ U8 priorDl; /* priority for data link layer */ U8 routeDl; /* route for data link layer */ U8 selectorDl; /* upper interface selector */ U8 entMac; /* entity for MAC */ U8 instMac; /* instance for MAC */ U8 priorMac; /* priority for MAC layer */ U8 routeMac; /* route for MAC layer */ U8 selectorMac; /* lower interface selector */ U8 maxOutsFrms; /* maximum outstanding frames */ Bool errType; /* cyclical or normal error checking */ TimerCfg t1; /* timer 1 configuration structure */ TimerCfg t2; /* timer 2 configuration structure */ TimerCfg t3; /* timer 3 configuration structure */ TimerCfg t5; /* timer 5 configuration structure */ TimerCfg t6; /* timer 6 configuration structure */ TimerCfg t7; /* timer 7 configuration structure */ TimerCfg t10; /* timer 10 configuration structure */ TimerCfg t11; /* timer 11 configuration structure */ TimerCfg t12; /* timer 12 configuration structure */ TimerCfg t13; /* timer 13 configuration structure */ TimerCfg congTmr; /* congestion timer configuration structure */ U16 provEmrgcy; /* emergency proving period */ U16 provNormal; /* normal proving period */ U8 lssuLen; /* one or two byte LSSU length */ U8 align1; /* alignment byte */ U16 maxFrmLen; /* max frame length for MSU */ U8 cfmType; /* when to send connect confirm */ Bool congDisc; /* congestion discard TRUE or FALSE */ U16 sdD; /* Error count decrement rate <JMP> */ U8 sdT; /* SUERM error rate threshold */ U8 sdTie; /* AERM emergency error rate threshold */ U8 sdTin; /* AERM normal error rate threshold */





IDX GLSTOC

U8 sdN1; /* maximum number of MSUs for retransmission */ U16 sdN2; /* maximum number of MSU octets for retrans */ U8 sdCp; /* maximum number of alignment attempts */ U8 align2; /* alignment byte */ S16 spIdSE; /* service provider id */ U16 dstProcId; /* processor id */ U16 isoThresh; /* Number of packets to queue before sending * SIPOs */ U16 txqThresh1; /* Threshold level one on MTP2’s Tx Queue */ U16 txqThresh1Abate; /* Abatement threshold for level two on * MTP2’s Tx Queue */ U16 txqThresh2; /* Threshold level two on MTP2’s Tx Queue */ U16 txqThresh2Abate; /* Abatement threshold for level two on * MTP2’s Tx Queue */ U16 sapThresh; /* Threshold level on MTP2’s upward bound * SAP queue */ U16 sapThreshAbate; /* Abatement threshold level for MTP2’s * SAP Queue */ /* MTP level 1 parameters <JMP> */ S16 baud; /* baud rate (4.8, 9.6, 19.2, 28.8, 38.4, * 56, 64) */ U8 portNum; /* port number */ U8 portType; /* port type */ S16 physIntType; /* Physical interface type (DCE/DTE) */ U8 dataEncoding; /* Data encoding (NRZ/NRZI) */ U8 flgShare; /* Share flags ? */ U8 flgIdle; /* Use idles (True) or flags (False) */ U8 numFlg; /* Number of additional flag chars /* between frames */ U32 idleFreq; /* Transmit frequency of FISU’s when done by */ /* software (in ms). Done at config */ U32 rtFreq; /* Retransmit frequency of other SU’s when */ /* done by software (in ms). Done at transmit */

} MTP2LinkCfg;





IDX GLSTOC

Fields that do not appear in the following table are either unused or for internal use only. Those fields should not be modified by the user. Unless otherwise specified, the timer names correspond to the CCITT specification. Differences from the ANSI and/or CCITT specification are noted in parentheses in the description.

Note: All timer values are specified in tenths of a second.

Field Name Default Range Description

swtch linkTypeparameter

MTP2LNK_ANSI, MTP2LNK_ANSI88, or MTP2LNK_CCITT

Protocol type.

maxOutsFrm 2 Maximum outstanding frames to layer MTP 1.

errType ERR_NRM ERR_NRM or ERR_CYC

Normal or cyclical (for PCR) error checking.

t1 130 (ANSI)400 (ITU)

1 to 65535 Timer aligned/ready.

t2 115 (ANSI)100 (ITU)

1 to 65535 Timer not aligned.

t3 115 (ANSI)15 (ITU)

1 to 65535 Timer aligned.

t5 1 1 to 65535 Timer sending SIB.

t6 60 1 to 65535 Timer remote congestion.

t7 20 1 to 65535 Timer excessive delay of acknowledgement.

t10 30 1 to 65535 Amount of time MTP 2 can be isolated from a remote MTP 3 before sending processor outage (SIPO).

t11 20 1 to 65535 Time to wait for a flow control acknowledgement from MTP 3 before sending another flow control indication.





IDX GLSTOC

t12 20 1 to 65535 Time to wait for a status confirmation from MTP 3 before sending another status indication.

t13 20 1 to 65535 Time to wait for a disconnect confirmation from MTP 3 before sending another disconnect indication.

provNormal 23 (ANSI)82 (ITU)

1 to 65535 Normal proving period.

provEmrgcy 6 (ANSI)5 (ITU)

1 to 65535 Emergency proving period.

lssuLen 2 1 or 2 One or two byte LSSU length.

maxFrmLen 272 64 to 1024 Max frame length for MSU.

congDisc FALSE TRUE | FALSE Congestion discard.

sdT 64 1 to 255 SUERM error rate threshold.

sdD 256 1 to 65535 SUERM decrement rate.

sdTie 1 1 to 255 AERM emergency error rate threshold.

sdTin 4 1 to 255 AERM normal error rate threshold.

sdN1 30 1 to 255 Max # of MSUs for retransmission (when using PCR).

sdN2 220 1 to 65535 Max # of MSUs octets for retrans (when using PCR).

sdCp 5 1 to 255 Maximum # of proving failures.






IDX GLSTOC

baud BD_56000 BD_4800, BD_9600, BD_19200, BD_28800, BD_38400, BD_48000, BD_56000, BD_64000

Baud rate (4.8, 9.6, 19.2, 28.8, 38.4, 48, 56, or 64).

physIntType INT_DTE INT_DTE | INT_DCE |

INT_DTE_MODEM |INT_DCE_MODEM

Physical interface type (DCE/DTE) with or without modem signal detection. Modem signal usage is the only way to assure detection of connection loss and re-establishment.

Note: Modem signal detection requires an additional pod jumper on the DCE side connecting DSR and CD.

dataEncoding DAT_NRZ DAT_NRZ | DAT_NRZ1 Data encoding (NRZ/NRZI).

flgShare FLAG_SHARE FLAG_SHARE | NO_FLAG_SHARE

Share flags between frames.

FlgIdle FALSE TRUE | FALSE Use idles (True) or flags (False).

numFlg 0 0 to 15 Number of additional flag chars between frames.

isoThresh 1000 1 to 65535 Number of messages queued to MTP 3 while isolated that will cause MTP 2 to begin processor outage (SIPOs).

txqThresh1 50 1 to 65535 Transmission queue length at which the outbound flow control level is raised to one.

txqThresh1Abate 20 1 to 65535 Transmission queue length at which the outbound flow control level is lowered to zero.






IDX GLSTOC

txqThresh2 200 1 to 65535 Transmission queue length at which the outbound flow control level is raised to two. The subsequent indication causes MTP 3 to cease all transmission to MTP 2 until the flow control level returns to one or zero.

txqThresh2Abate 100 1 to 65535 Transmission queue length at which the outbound flow control level is lowered to one.

sapThresh 500 1 to 65535 Number of messages queued to MTP 3 while inbound flow control is in effect that will cause MTP 2 to send busy indications (SIBs).

sapThreshAbate 100 1 to 65535 Number of messages queued to MTP 3 while inbound flow control is in effect that will cause MTP 2 to stop sending busy indications (SIBs).

idleFreq 0 1 to 65535 Transmit frequency of FISU’s when done by software (in ms).

rtFreq 0 1 to 65535 Retransmit frequency of other SU’s when done by software (in ms).





SS7 MTP 2 Developer’s Reference Manual Mtp2LinkStats

IDX GLSTOC

Mtp2LinkStats

Description Obtains (and potentially resets) data link statistical information about the specified link number.

Prototype MTP2_STATUS Mtp2LinkStats (U8 board, S16 linkNo,

MTP2LinkStats *pStats, BOOL bReset)


linkNo The link number to obtain statistical information about. The link number must have been previously defined through the Mtp2SetLinkCfg function.

pStats A pointer to a buffer provided by the application where the requested statistical information will be returned. Refer to the MTP2LinkStats structure.

bReset If true (non-zero), the statistics are reset (set to zero) after returning the current values. If false (zero) no reset is performed.







Mtp2LinkStats SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

Details There are a large number of link statistics. They include counts for the various message types and their acknowledgments both transmitted and received. All counts are U32 fields. Refer to the following MTP2LinkStats structure.

typedef struct _Mtp2LinkStats /* MTP Level 2 link statistics */{ U32 inService; /* start of in-service */ U32 lclBusy; /* duration of local-busy */ U32 slFailAll; /* all reasons for a signaling link * failure */ U32 slFailAb; /* Abnormal FIBR/BSNR link failure */ U32 slFailAck; /* delay of acknowledgment link * failure */ U32 slFailErr; /* excessive error rate link failure */ U32 slFailCong; /* excessive congestion link failure */ U32 slFailAlign; /* alignment link failure */ U32 slNSUErr; /* number of signal units in error */ U32 slNegAck; /* number of negative acknowledgments */ U32 nSifSioTx; /* number of SIF/SIO packets * transmitted */ U32 nRetrans; /* number of octets transmitted */ U32 mTx; /* information frames transmitted */ U32 lTx; /* receive ready frames transmitted */ U32 fTx; /* receive not ready frames * transmitted */ U32 nSifSioRx; /* number of SIF/SIO packets received */ U32 mRx; /* information frames received */ U32 lRx; /* receive ready frames received */ U32 fRx; /* receive not ready frames received */ U16 txCnt; /* Number of messages on the transmit */ /* queue */ U16 hiTxCnt; /* Hiqh water number of messages on */ /* the transmit queue */ U16 rtbCnt; /* Number of messages on the */ /* retransmit queue */ U16 hiRtbCnt; /* Hiqh water number of messages on */ /* the retransmit queue */ U16 ltxCnt; /* Number of messages on the lower */ /* transmit queue */ U16 hiLtxCnt; /* Hiqh water number of messages on */ /* the lower transmit queue */ U16 sapCnt; /* Number of messages on the inbound */ /* sap queue */ U16 hiSapCnt; /* Hiqh water number of messages on */ /* the inbound sap queue */

} MTP2LinkStats;




SS7 MTP 2 Developer’s Reference Manual Mtp2LinkStatus

IDX GLSTOC

Mtp2LinkStatus

Description Obtains data link status information about the specified link number.

Prototype MTP2_STATUS Mtp2LinkStatus (U8 board, S16 linkNo,

MTP2LinkStatus *pStatus)


linkNo The link number to obtain status information about. The link number must have been previously defined through the Mtp2SetLinkCfg function.

pStatus A pointer to a buffer provided by the application where the requested status information will be returned. Refer to the MTP2LinkStatus structure.




Details This function obtains link status information about the specified link number. This information includes the link state, flow control state, queue sizes, and busy states. Refer to the following MTP2LinkStatus structure for detailed information:




Mtp2LinkStatus SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

This structure is filled by the MTP 2 task in response to an Mtp2LinkStatus request.

typedef struct _Mtp2LinkStatus /* MTP Level 2 - signaling link status */{ DateTime DT; /* Date / time stamp */ U8 hlSt; /* sap state */ U8 psOutsFrm; /* outstanding frames to MAC */ S16 cntMaDrop; /* frames dropped by MAC */ U8 llSt; /* link level matrix state */ U8 lclBsy; /* local busy */ Bool remBsy; /* remote busy */ U8 fsn; /* forward sequence number */ U8 bsn; /* backward sequence number */ U8 flcSt; /* flow control state */

} MTP2LinkStatus;

Field Name Possible values Description

hlSt ST_UNBOUND, ST_CONFIGURED, ST_BND_DISABLED, or ST_BND_ENABLED

Sap State

psOutsFrm 0 to 0xFF Outstanding frames to MAC.

cntMaDrop 0 to 0xFFFF Frames dropped by MAC.

llSt ST_UNUSED, ST_OUT_OF_SERVICE, ST_INITIAL_ALIGNMENT, ST_ALIGNED_READY, ST_ALIGNED_NOT_READY, ST_PROC_OUT, ST_IN_SERVICE, ST_IDLE, ST_NOT_ALIGNED, ST_IS_ALIGNED, ST_PROVING, ST_LOCAL_PROC_OUT, ST_REMOTE_PROC_OUT, ST_BOTH_PROC_OUT, ST_MONITORING, ST_CONGESTION, or ST_POWER_OFF

Link level matrix state.

lclBsy TRUE | FALSE Indicates whether the local MTP2 is sending SIB’s.

remBsy TRUE | FALSE Indicates whether the remote MTP2 is sending SIB’s.

fsn 0 to 127 Last forward sequence number sent.




SS7 MTP 2 Developer’s Reference Manual Mtp2LinkStatus

IDX GLSTOC

bsn 0 to 127 Backward sequence number to send next.

flcSt 0 to 2 Outbound flow control level (2 = congested).

Field Name Possible values Description




Mtp2MgmtCtrl SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

Mtp2MgmtCtrl

Description Sends a control request to the MTP 2 task.

Prototype MTP2_STATUS Mtp2MgmtCtrl (U8 board, S16 entity, U8 action)

board The TX board number on which the desired MTP2 task resides.

entity Reserved for future use.action The action to take on the entity specified,

where action is one of the following:

MTP2_CTRL_FLOWCTL_ONSets ALL links to the congested state (see Congestion Control section).

MTP2_CTRL_FLOWCTL_OFFReturns all links to the non-congested state.




MTP2_PARAMInvalid action specified.

Details There is currently one classification: flow control requests.




SS7 MTP 2 Developer’s Reference Manual Mtp2MgmtInit

IDX GLSTOC

Mtp2MgmtInit

Description Initializes internal structures and opens communication with the MTP 2 process on the TX board.

Prototype MTP2_STATUS Mtp2MgmtInit (U8 board, U8 srcEnt, U8 srcInst)

board The TX board number.srcEnt The source entity ID.srcInst The source instance ID.



MTP2_DRIVERLow level driver returned an error trying to open the specified dual port RAM channel. srcEnt should be from 0x20 to 0x31 and cannot be in use by another application.

Details This function must be called before any other management primitive can be used. Source entity must be unique for each application accessing the MTP 2 (or other) task.

Note: An application that opens both the management and data APIs must use different entity IDs for the Mtp2MgmtInit and Data Bind Request calls.




Mtp2MgmtTerm SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

Mtp2MgmtTerm

Description Terminates the dual-port RAM channel binding, specified in Mtp2MgmtInit, for this application.

Prototype MTP2_STATUS Mtp2MgmtTerm (U8 board)

board The TX board number with which to terminate communication.




Details This function should be called when an application terminates or finishes communication with the MTP 2 task to free up resources.




SS7 MTP 2 Developer’s Reference Manual Mtp2SetLinkCfg

IDX GLSTOC

Mtp2SetLinkCfg

Description Configures the MTP 2 task with the data link configuration values contained in the MTP2LinkCfg structure provided.

Prototype MTP2_STATUS Mtp2SetLinkCfg (U8 board, MTP2LinkCfg *pLinkCfg)


pLinkCfg A pointer to the MTP2LinkCfg structure containing the data link configuration values.




MTP2_TIMEOUTNo response from the board.

Details This function sets the data link configuration parameters of the MTP 2 task on the specified board. An application must set the field values in the MTP2LinkCfg structure before calling this function. This can be done by calling Mtp2InitLinkCfg, by setting each field from within the application, or with a combination of the two (such as, calling Mtp2InitLinkCfg and then overriding specific fields before passing the MTP2LinkCfg structure to this function).

This function will typically be called multiple times, once for each configured link. Refer to the MTP2LinkCfg structure for more information about its fields and their default values.




Mtp2SetLinkCfg SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC




IDX GLSTOC

Chapter 4

MTP 2 Sample Applications

4.1 The MTP 2 Configuration Utility 484.1.1 Using the MTP 2 Configuration Utility 484.1.2 The MTP 2 Configuration File 524.1.3 MTP2 Configuration Parameter Reference 534.1.4 Sample Configuration Files 57

4.2 The MTP 2 Manager Program 594.2.1 Using the MTP 2 Manager Program 59

4.3 The Sample Applications - mtp2app and mtp2itu 65




Chapter 4 MTP 2 Sample Applications SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

4.1 The MTP 2 Configuration Utility

The MTP 2 Configuration (mtp2cfg) utility scans the MTP 2 configuration text file (see Section 4.1.2) and download the configuration to the MTP 2 task on the TX board.

4.1.1 Using the MTP 2 Configuration Utility

Name mtp2cfg

Purpose Downloads the MTP 2 configuration to the TX board at boot time.

Usage mtp2cfg options

Prerequisites Requires a single computer with a TX 2000, TX 3000, TX 3220, orTX 3220C board installed, in addition to the following software:

Æ Windows NT 4.0, Windows 2000, Intel Solaris 2.6 or 7, SPARC Solaris 26, or 7, or UnixWare.

Æ Natural Access 1999-4

Procedure To run mtp2cfg:

1. From the command line prompt, enter the following:

mtp2cfg options

where options include:

2. The MTP 2 Configuration utility scans the information in the ASCII file (specified with the -f option) and downloads the information to the task on the TX board.

Parameter Description

-b board Board number to which the MTP 2 configuration is downloaded (default = 1).

-f filename Name and location of the MTP 2 configuration file to be downloaded.




SS7 MTP 2 Developer’s Reference Manual Using the MTP 2 Configuration Utility

IDX GLSTOC

Notes The following tables show the default assignment of ports to SS7 links for various board hardware configurations. In these tables, the following nomenclature is used:

Æ S1, S2, …, Sn refer to ports 1, 2, …, n on the serial port adapter pod (V.35 or V.24/RS232).

Æ T1, T2, …, T16 refer to the Port1, Port2, …, Port16 entries defined in the TDM configuration file for T1/E1/MVIP/H.100/H.110 channel timeslots assigned as SS7 links.

Figure 7. TX 2000 Default Port Assignments

Figure 8. TX 3000 Default Port Assignments

Link (SAP)Slave-68360

DaughterCard

Serial PortAdapter? 0 1 2 3

Yes S1 S2 S3 T1Single 68360

No T1 T2 T3 T4Yes S1 S2 S3

NoneNo T1 T2 T3 T4

Link (SAP)Slave-68360

DaughterCard

Serial PortAdapter?

0 1 2 3 4 5 6 7 8 … 14 15

Yes1 S1 S2 S3None

No T1 T2 T3 T4Single68360

Yes1 S1 S2 S3 T1 T2 T3 T4

No T1 T2 T3 T4 T5 T6 T7 T8Triple68360

Yes1 S1 S2 S3 T1 T2 T3 T4 T5 T6 … T12

No T1 T2 T3 T4 T5 T6 T7 T8 T9 … T15 T16

1 When using 3 port serial adapters, the fourth serial communication controlleron the main 68360 is NOT available for a TDM type port.





IDX GLSTOC

The following table shows the default attributes assigned to each link by theMTP 2 task at download time. If the default port assignments and link attributes are correct for your application, you need not run the mtp2cfg program at load time; otherwise, you must create a text configuration file and run the mtp2cfg utility to override these defaults.

Attribute Default Value Description

LINK_TYPE ANSI (1992) Protocol variant.

ERR_TYPE Normal Error correction method: Normal.

TIMER_T1 13.0 seconds T1 Timer aligned/ready.

TIMER_T2 11.5 seconds T2 Timer not aligned.

TIMER_T3 11.5 seconds T3 Timer aligned.

TIMER_T4_N 2.3 seconds Normal proving period.

TIMER_T4_E 0.6 seconds Emergency proving period.

TIMER_T5 0.1 seconds T5 Timer sending SIB.

TIMER_T6 6.0 seconds T6 Timer remote congestion.

TIMER_T7 2.0 seconds T7 Timer excessive delay of acknowledgment.

TIMER_T10 3.0 seconds Maximum isolation time before sending SIPO.

TIMER_T11 2.0 seconds Time to wait for a flow control acknowledgement.

TIMER_T12 2.0 seconds Time to wait for a status confirmation.

TIMER_T13 2.0 seconds Time to wait for a disconnect response.

LSSU_LEN 2 LSSU length.

MAX_FRAME 272 Maximum frame length for MSU.

SUERM_THRESH 64 Signal unit error rate monitor threshold (bad frames).

SUERM_D_RATE 256 Signal unit error rate monitor decrement rate (frames).

AERM_THRESH_E 1 Alignment error rate monitor error rate threshold (emergency alignment).

AERM_THRESH_N 4 Alignment error rate monitor error rate threshold (normal alignment).




SS7 MTP 2 Developer’s Reference Manual Using the MTP 2 Configuration Utility

IDX GLSTOC

MAX_RTB_MSGS 30 Max # of MSUs for retransmission (when using PCR error correction only).

MAX_RTB_OCTETS 220 Max # of MSUs octets for retransmission (when using PCR error correction only).

MAX_PROV_ABORT 5 Maximum # of proving failures.

BAUD 56 Kbps Baud rate for serial ports only.

INT_TYPE DTE Interface type (DCE/DTE) for serial ports.

DATA_ENC NRZ Data encoding (NRZ/NRZI).

SHARE_FLAGS TRUE Allow single flag to be shared between frames.

USE_FLAGS TRUE Use flags (True) or idles (False) between frames.

MIN_FLAGS 0 Minimum number of additional flags between frames (in addition to shared flag).

ISO_THRESH 1000 Maximum messages queued before sending SIPO.

TXQ_THRESH1 50 TX queue threshold where flow control level 1 is reached.

TXQ_THRESH1_A 20 TX queue threshold where flow control level decreases to 0.

TXQ_THRESH2 200 TX queue threshold where flow control level 2 is reached.

TXQ_THRESH2_A 100 TX queue threshold where flow control level descreases to 1.

SAP_THRESH 500 Messages queued to MTP3 that will cause SIBs to be sent.

SAP_THRESHA 100 Messages queued to MTP3 that will cause SIBs to stop being sent.

IDLE_FREQ 0 Frequency at which FISUs are sent (in ms).

RT_FREQ 0 Frequency at which other retransmitted SU’s are sent (in ms).

Attribute Default Value Description





IDX GLSTOC

4.1.2 The MTP 2 Configuration File

The MTP 2 configuration file is a simple text file with the following general format:

LINK <port ID> # link 0 definitionPARAMETER_ KEYWORD <value> # comment…PARAMETER_ KEYWORD <value> # commentEND # end link 0 definition...LINK <port ID> # link N definitionPARAMETER_ KEYWORD <value> # comment…PARAMETER_ KEYWORD <value> # commentEND # end link 0 definition

The first link defined in the MTP 2 configuration file is always link zero, the second is always link one, and so on.




SS7 MTP 2 Developer’s Reference Manual MTP2 Configuration Parameter Reference

IDX GLSTOC

4.1.3 MTP2 Configuration Parameter Reference

The following table lists the available MTP 2 link configuration parameters, their default values, and allowed range. All parameters are optional (default values shown below) except the LINK keyword/port assignment and the terminating END statement.

Note: All timer values are in tenths of seconds (130 = 13.0 seconds).

Keyword Default Range Description

LINK none S1-S4, T1-T16 Starts link definition, assigns port to link.

LINK_TYPE ANSI ANSI, ANSI88, or CCITT

Protocol variant.

ERR_TYPE NORMAL NORMAL or PCR Error correction method: Normal or Preventive Cyclic Retransmission.

L2_T1 130 (ANSI)400 (CCITT)

1 to 65535 T1 Timer aligned/ready.


1 to 65535 T2 Timer not aligned.


1 to 65535 T3 Timer aligned.

L2_T4_N 23 (ANSI)82 (CCITT)

1 to 65535 Normal proving period.

L2_T4_E 6 (ANSI)5 (CCITT)

1 to 65535 Emergency proving period.

L2_T5 1 1 to 65535 T5 Timer sending SIB.

L2_T6 60 1 to 65535 T6 Timer remote congestion.

L2_T7 20 1 to 65535 T7 Timer excessive delay of acknowledgment.

L2_T10 30 1 to 65535 Time MTP2 can be isolated from a remote MTP3 before sending processor outage (SIPO).





IDX GLSTOC

L2_T11 20 1 to 65535 Time to wait for a flow control acknowledgement from MTP3 before resending a flow control indication.

L2_T12 20 1 to 65535 Time to wait for a status confirmation from MTP3 before resending a status indication.

L2_T13 20 1 to 65535 Time to wait for a disconnect response before resending a disconnect indication.

LSSU_LEN 2 1 or 2 LSSU length.

MAX_FRAME 272 64 to 1024 Maximum frame length for MSU.

SUERM_THRESH 64 1 to 255 Signal unit error rate monitor threshold (bad frames).

SUERM_D_RATE 256 1 to 65535 Signal unit error rate monitor decrement rate (frames).

AERM_THRESH_E 1 1 to 255 Alignment error rate monitor error rate threshold (emergency alignment).

AERM_THRESH_N 4 1 to 255 Alignment error rate monitor error rate threshold (normal alignment).

MAX_RTB_MSGS 30 1 to 255 Max # of MSUs for retransmission (when using PCR error correction only).

MAX_RTB_OCTETS 220 1 to 65535 Max # of MSUs octets for retransmission (when using PCR error correction only).

MAX_PROV_ABORT 5 1 to 255 Maximum # of proving failures.

BAUD 56000 4800, 9600, 19200, 28800, 38400, 48000, 56000, 64000

Baud rate for serial ports only (in bits per second).





SS7 MTP 2 Developer’s Reference Manual MTP2 Configuration Parameter Reference

IDX GLSTOC

INT_TYPE DTE DTE | DCE | DTE_MODEM | DCE_MODEM

Interface type for serial ports only. Use of modem signals is the only way to detect loss of connection.

Note: Modem signal detection requires an additional pod jumper on the DCE side connecting DSR and CD.

DATA_ENC NRZ NRZ or NRZI Data encoding (NRZ or NRZ inverted).

SHARE_FLAGS TRUE TRUE/FALSE Allow single flag to be shared between frames.

USE_FLAGS TRUE TRUE/FALSE Use flags (True) or idles (False) between frames.

MIN_FLAGS 0 0 to 15 Minimum number of additional flags between frames (in addition to shared flag).

ISO_THRESH 1000 1 to 65535 Number of messages queued to MTP3 while isolated that will cause MTP2 to begin processor outage (SIPO).

L2_TXQ_THRESH1 50 1 to 65535 Transmission queue length at which the outbound flow control level is raised to one.

L2_TXQ_THRESH1_A 20 1 to 65535 Transmission queue length at which the outbound flow control level is lowered to zero.

L2_TXQ_THRESH2 200 1 to 65535 Transmission queue length at which the outbound flow control level is raised to two. The subsequent indication causes MTP3 to cease all transmission to MTP2 until the level returns to one or zero.

L2_TXQ_THRESH2_A 100 1 to 65535 Transmission queue length at which the outbound flow control level is lowered to one.






IDX GLSTOC

L2_SAP_THRESH 500 1 to 65535 Number of messages queued to MTP3 while inbound flow control is in effect that will cause MTP2 to send busy indications (SIBs).

L2_SAP_THRESH_A 100 1 to 65535 Number of messages queued to MTP3 while inbound flow control is in effect that will cause MTP2 to stop sending busy indications (SIBs).

IDLE_FREQ 0 1 to 65535 Frequency at which FISUs are sent by the software (in ms). Zero specifies that the hardware constantly retransmits duplicate FISUs as is the norm. Non-zero frequencies can be used by switches which process all FISU’s, including duplicates, in the software.

RT_FREQ 0 1 to 65535 Frequency at which other retransmitted SU’s (specifically LSSUs) are sent by the software (in ms). Zero specifies that hardware constantly retransmits duplicate LSSUs as is the norm. Non-zero frequencies can be used by switches which process all LSSU’s, including duplicates, in the software.





SS7 MTP 2 Developer’s Reference Manual Sample Configuration Files

IDX GLSTOC

4.1.4 Sample Configuration Files

A sample ANSI configuration file for a two-link configuration is shown below. For illustration, the sample configuration file (and those with the distribution software) shows all relevant parameters listed, even those for which the default values are not changed. A more typical configuration file would list only those parameters whose values are being changed from the defaults.

##--- MTP 2 link parameters#===========================# Link 0 - serial (v.35)#===========================

LINK S1 # V.35 Serial Port 1LINK_TYPE ANSIERR_TYPE NORMALL2_T1 130L2_T2 115L2_T3 115L2_T4_N 23L2_T4_E 6L2_T5 1L2_T6 60L2_T7 20LSSU_LEN 2MAX_FRAME 272SUERM_D_RATE 256SUERM_THRESH 64AERM_THRESH_N 4AERM_THRESH_E 1MAX_PROV_ABORT 5

#--- MTP 1 link parametersBAUD 64000INT_TYPE DCEDATA_ENC NRZUSE_FLAGS TRUEMIN_FLAGS 0SHARE_FLAGS TRUEEND





IDX GLSTOC

#========================================# Link 1 - TDM (from T1/E1 daughter card#========================================

LINK T1 # Port1 from TDM cfg fileLINK_TYPE ANSIERR_TYPE NORMALL2_T1 130L2_T2 115L2_T3 115L2_T4_N 23L2_T4_E 6L2_T5 1L2_T6 60L2_T7 20LSSU_LEN 2MAX_FRAME 272SUERM_D_RATE 256SUERM_THRESH 64AERM_THRESH_N 4AERM_THRESH_E 1MAX_PROV_ABORT 5

#--- MTP1 link parametersUSE_FLAGS TRUEMIN_FLAGS 0SHARE_FLAGS TRUEEND




SS7 MTP 2 Developer’s Reference Manual The MTP 2 Manager Program

IDX GLSTOC

4.2 The MTP 2 Manager Program

After downloading the MTP 2 configuration to the TX board with mtp2cfg, run the MTP 2 Manager (mtp2mgr) program to monitor the status of the MTP 2 layer. The MTP 2 Manager provides a command line interface from which statistics can be viewed.

4.2.1 Using the MTP 2 Manager Program

Name mtp2mgr

Purpose Monitors and manages the status of the MTP 2 layer.

Usage mtp2mgr -b board

Prerequisites Requires a single computer with a TX 2000, TX 3000, TX 3220, orTX 3220C board installed, in addition to the following software:

Æ Windows NT 4.0, Windows 2000, Intel Solaris 2.6 or 7, SPARC Solaris 26, or 7, or UnixWare.

Æ Natural Access 1999-4

Procedure To run mtp2mgr:

1. From the command line prompt, enter the following:

mtp2mgr -b board

where board is the TX board number to open.





IDX GLSTOC

2. The mtp2mgr program supports the following commands:

Notes Here are sample outputs from mtp2mgr sessions:

mtp2mgr[1]>stats link 0 Board 1, Link 0 MTP2 Stats:

inService = 1037 lclBusy = 0 slFailAll = 1 slFailAb = 0 slFailAck = 0 slFailErr = 1 slFailCong = 0 slFailAlign = 0 slNSUErr = 0 slNegAck = 0 nRetrans = 0

Msg: Rx Tx Msg: Rx Tx --- -- -- ----- ----- ----- SIF/SIO 3 2 MSU 417 413 LSSU* 12 12 FISU* 37984 37497 * LSSU & FISU counts do not include those filtered by the firmware

Current High ------- ----Tx Queue: 0 270 Rtb Queue: 0 4 lTx Queue: 0 125 Sap Queue: 0 0

A description of each of the statistics follows:

Command Description

STATS link Retrieves the statistics for the specified link.

STATUS link Retrieves status information for the specified link.

MTP2FLOW ON | OFF Turns MTP 2 flow control on or off.

BOARD board Switches to a new target board.

Q Quits the application.

? command Lists available commands or parameters of a specified command.

Statistic Description

inService The amount of time (in 1/10’s of a second) that the link has been in service (aligned).

lclBusy The amount of time (in 1/10’s of a second) that the link has been in congestion.




SS7 MTP 2 Developer’s Reference Manual Using the MTP 2 Manager Program

IDX GLSTOC

slFailAb The number of bad sequence numbers in received frames.

slFailAck The number of times an acknowledgment was not received within the T7 timeout.

slFailErr The number of link failures due to the SUERM threshold being reached.

slFailCong The number of link failures due to the T5 congestion timer expiring.

slFailAlign The number of alignment failures due to T2 expiration.

slFailAll The total number of link failures due to the above link failure reasons.

slNSUErr Not used.

slNegAck The number of negative acknowledgments received.

nRetrans The number of retransmissions performed.

SIF/SIO Tx The number of SIO frames sent during alignment (normal error checking).

SIF/SIO Rx The number of SIO frames received during alignment (both normal and PCR error checking).

MSU Tx/Rx The number of message signal units transmitted and received.

LSSU Tx/Rx The number of LSSU’s transmitted and received. Counts do not include frames filtered by the firmware.

FISU Tx/Rx The number of FISU’s transmitted and received. Counts do not include frames filtered by the firmware.

Tx Queue Current count and high water mark of the number of messages queued on the transmit queue waiting to be sent out the network.

RtbQueue Current count and high water mark of the number of messages queued on the retransmission queue. These are messages that have been transmitted but not yet acknowledged by the remote side.






IDX GLSTOC

mtp2mgr[1]>status link 0Board 1, Link 0 MTP2 Status:

High lvl state = ENABLED Frames out = 1 Frames dropped = 0 Low lvl state = IN_SERVICE

---- Current Link (0) Layer 2 configuration ----

Link Name = T1 maxFrmLen = 272 congDisc = FALSE errType = NORMAL lssuLen = 2 SUERMD rate = 256 SUERM Thrsh= 64 AERM Thrsh N= 4 AERM Thrsh E= 1 Max RTB Msg= 127 Max RTB Oct = 34544 Max Prov Abt= 5IsoThresh = 1000 TxqThresh1 = 50 TxqThresh1A = 20TxqThresh2 = 200 TxqThresh2A = 100 SapThresh = 500SapThreshA = 100

----- Layer 2 Timers (in tenths/sec) -----L2 t1 = 400 L2 t2 = 100 L2 t3 = 15 L2 t4 norm = 82 L2 t4 emrg = 5 L2 t5 = 1 L2 t6 = 60 L2 t7 = 20 L2 t10 = 30L2 t11 = 20 L2 t12 = 20 L2 t13 = 20

lTx Queue Current count and high water mark of the number of messages queued on the lower transmit queue. These are messages that were taken off the TxQueue to be sent but could not be because layer 1 was busy at the time.

Sap Queue Current count and high water mark of the number of messages queued on the inbound sap queue waiting to be sent to MTP3.





SS7 MTP 2 Developer’s Reference Manual Using the MTP 2 Manager Program

IDX GLSTOC

A description of the status fields is provided:

High lvl state is one of the following:

Low lvl state is one of the following:

Field Description

UNBOUND Initial state.

CONFIGURED Link has been configured. Still unbound.

DISABLED Upper layer (MTP 3) has bound but not connected.

ENABLED Upper layer (MTP 3) has bound and connected successfully to a peer MTP 2.

Field Description

UNUSED Default to unused.

OUT_OF_SERVICE Link out of service.

INITIAL_ALIGNMENT Link in initial alignment.

ALIGNED_READY Link aligned and ready.

ALIGNED_NOT_READY Link aligning and not ready.

PROC_OUT Processor outage detected.

IN_SERVICE Link in service - data state.

IDLE Link idling - data state.

NOT_ALIGNED Link not yet aligned.

IS_ALIGNED Link is aligned.

PROVING Link is in initial proving phase.

LOCAL_PROC_OUT Local processor outage - level 3.

REMOTE_PROC_OUT Remote processor outage - level 3.

BOTH_PROC_OUT Both processors outage - level 3.

MONITORING Link monitoring.

CONGESTION Link congested - level 2.

POWER_OFF Power off state.





IDX GLSTOC

Frames out Number of frames outstanding to layer 1 (transmission not yet complete by layer 1).

Frames dropped Number of transmitted frames dropped due to level 1 transmit errors.

Refer to Mtp2InitLinkCfg for a description of all configuration parameters.




SS7 MTP 2 Developer’s Reference Manual The Sample Applications - mtp2app and mtp2itu

IDX GLSTOC

4.3 The Sample Applications - mtp2app and mtp2itu

There are sample applications that illustrate use of the MTP 2 standalone task. Both programs exercise the MTP 2 task on the TX board. mtp2app is for ANSI links, and mtp2itu is for ITU-T links.

There are several command line parameters for the sample applications:

At startup, the sample applications attempt to bind to links zero through three. If some of these fail, the programs will still execute properly on the available links. The programs start in monitor mode, printing out to the screen whenever anMTP 2 event is received. In monitor mode, if a SLTM is received, a SLTA is transmitted automatically. Also in monitor mode, if links zero and one are connected and a disconnect indication is received for one of those links, then a changeover is performed automatically to the other link.

In order to enter command mode in these programs, press ENTER to display the following prompt:

Command?>

Parameter DescriptionDefault ITU

Default ANSI

-s sio Service Information Octet for sent SLTM’s

0xb1 0xb2

-b board Board number. 1 1

-o opc Local point code. 1 1.1.1

-d dpc Adjacent point code. 2 1.1.2





IDX GLSTOC

Press ENTER again to exit command mode and enter back into monitor mode. Both applications support identical commands:

Command?>connect 0 Link 0:Connecting Link 0:Disconnect Indication received - reason 2 Command?>connect 0 Link 0:Connecting Link 0:Connect Confirmation received Link 0:Received SLTM, sending SLTA in response Link 0:Data Confirmation received acking 1 messages Command?>send 0 Link 0:Sending a SLTM Link 0:Data Confirmation received acking 1 messages Link 0:Received a correct SLTA Command?>q

The sample applications attempt to bind with four links. If you have less than four links defined, the application will still execute properly on the existing links. However, the following alarm will be visible in txalarm output:

<12/05/1997 15:51:58> mtp 1 13191 Internal Error [4]

Command Description

connect link Connects normal mode: levels 1+2.

econn link Connects emergency mode: levels 1+2.

powconn link Places link in power-on state.

disconn link Disconnects the link.

send link Sends an SLTM on the link.

status link [start | end | up | down] Sets status conditions on the specified link. Options include:

Æ start - Start emergency state

Æ end - End emergency state

Æ up - Local processor up

Æ down - Local processor down

flow link [on | off ] Turns MTP 2 flow control for specified link on or off.

Q Quits the MTP 2 sample application.

? Lists the commands supported.




IDX GLSTOC

Appendix A

MTP 2 Message Reference

Introduction 68Bind Request 69Connect Request 70Connect Confirmation 71Data Request 72Data Confirmation 73Data Indication 75Disconnect Confirmation 76Disconnect Request 77Disconnect Indication 78Disconnect Response 79Flow Control Request 80Flow Control Indication 81Flow Control Response 82Status Request 83Status Confirmation 85Status Indication 87Status Response 88




Appendix A MTP 2 Message Reference SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

Introduction

This section specifies the layout of all messages between the MTP layer 2 process and the application (layer 3). The overall message layouts are slightly different depending on whether the message is being read/written directly from/to the TX Series driver or whether its being read from the IPC queue. The following sections define the structure of each message beginning with the MTP 2 message type and including all parameters of the message.




SS7 MTP 2 Developer’s Reference Manual Bind Request

IDX GLSTOC

Bind Request

Direction Layer 3 -> MTP 2

Description The BIND REQUEST message establishes the sender as the user of a SS7 data link. It is the first message sent from the layer 3 application to MTP 2 and is sent once for every link (on every TX board) that the application uses. There is no response from MTP 2 to the bind request.

Format

Service Provider ID MTP 2’s reference number for this link on this TX board. Must be 0 to 15.

Service User ID Application’s reference number for this link (typically a link number global to all links known by layer 3). MTP 2 will pass this number in all messages to the application associated with this link.

Source Entity ID Application’s entity ID.Source Instance ID Application’s instance ID.

Type

U8 Msg Type 0x04

S16 Service Provider ID

S16 Service User ID

U8 Source Entity ID

U8 Source Instance ID




Connect Request SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

Connect Request


Description The CONNECT REQUEST message causes MTP 2 to bring up the associated link and start alignment procedures. The application must send a connect request and wait for a connect confirmation fromMTP 2 for each link before data may be sent over the link.

Format


Status The requested connection mode; possible values are: 0 Connect level 1 only 1 Connect level 2 with emergency status 2 Connect level 2 with normal status 3 Connect levels 1 & 2 with emergency status 4 Connect levels 1 & 2 with normal status 5 Power on start only 6 Send a start after a power on

Type

U8 Msg Type 0x0C


U8 Status




SS7 MTP 2 Developer’s Reference Manual Connect Confirmation

IDX GLSTOC

Connect Confirmation

Direction MTP 2 -> Layer 3

Description The CONNECT CONFIRMATION message notifies the layer 3 application that the specified link is aligned and is ready to transfer data. The application must wait for this confirmation from MTP 2 after sending a connect request before data may be sent over the link.

Format

Service User ID Application’s reference number for this link (from Bind Request).

Type

U8 Msg Type 0x0D

S16 Service User ID




Data Request SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

Data Request


Description The DATA REQUEST message asks MTP 2 to transmit a Message Signal Unit (MSU) on the specified data link.

Format


Data The contents of the MSU to transmit. The first byte of data is typically the Service Information Octet (SIO), followed by the routing label and protocol dependent data. Layer 2 inserts the flag(s), sequence number, length indicator, and frame check sequence. The maximum length of the data field is 274 octets (including the SIO). There is no field to specify the length of the data field. MTP 2 derives the length of the data from the message start and end offsets in the message.

Type

U8 Msg Type 0x14


Var. Data

...




SS7 MTP 2 Developer’s Reference Manual Data Confirmation

IDX GLSTOC

Data Confirmation


Description The DATA CONFIRMATION message notifies the layer 3 application that one or more transmitted MSUs have been acknowledged by the far end.

This message is also sent in response to an application status request to retrieve unacknowledged messages. In this case the status field indicates that this is unacknowledged and whether there are more unacknowledged messages coming or whether this is the last. One data confirmation is returned for each unacknowledged message.

Format


Status The status of this confirmation: 0 Unacknowledged message, more to follow 1 Unacknowledged message, last 2 Message(s) acknowledged by far end (Credit contains number of messages acknowledged, data field not present)

Type

U8 Msg Type 0x15

S16 Service User ID

U8 Status

U8 Credit

Var. Data

...




Data Confirmation SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

Credit The number of messages acknowledged, when status equals two.

Data The contents of the unacknowledged message (present only when status equals zero or one).




SS7 MTP 2 Developer’s Reference Manual Data Indication

IDX GLSTOC

Data Indication


Description The DATA INDICATION notifies the layer 3 application of a Message Signal Unit (MSU) received on the specified data link.

Format


Data The contents of the received MSU. The first byte of data is typically the Service Information Octet (SIO), followed by the routing label and protocol dependent data. Layer 2 strips the flag(s), sequence number, length indicator, and frame check sequence. The maximum length of the data field is 274 octets (including the SIO). There is no field to specify the length of the data field. The application derives the length of the data from the message start and end offsets in the message.

Type

U8 Msg Type 0x16

S16 Service User ID

Var. Data

...




Disconnect Confirmation SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

Disconnect Confirmation


Description The DISCONNECT CONFIRMATION notifies MTP3 that the disconnect request was received and does not have to be retransmitted.

Format


Type

U8 Msg Type 0x11

S16 Service User ID




SS7 MTP 2 Developer’s Reference Manual Disconnect Request

IDX GLSTOC

Disconnect Request


Description The DISCONNECT REQUEST causes MTP 2 to bring down the associated link, which will result in the loss of data.

Format


Reason The reason for the disconnect. Possible values are: 0 Management request (drops layer 2 only) 10 Disconnect level 1 also (may drop modem signals, reset transmitter and receiver, etc.)

Type

U8 Msg Type 0x10


S16 Reason




Disconnect Indication SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

Disconnect Indication


Description The DISCONNECT INDICATION notifies the application (layer 3) that a link has been disconnected.

Format


Reason The reason for the disconnect. Possible values are: 0 Layer Manager request

Type

U8 Msg Type 0x12

S16 Service User ID

S16 Reason




SS7 MTP 2 Developer’s Reference Manual Disconnect Response

IDX GLSTOC

Disconnect Response


Description The DISCONNECT RESPONSE notifies MTP2 that the disconnect indication was received and does not have to be retransmitted. Timer T13 is stopped.

Format


Type

U8 Msg Type 0x13

S16 Service User ID




Flow Control Request SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

Flow Control Request


Description The FLOW CONTROL REQUEST causes MTP 2 to start or stop flow control on the specified link. This request has minimal impact and is not typically needed.

Format


Action The action to take. Possible values are: 0 Start flow control 1 Stop flow control

Type

U8 Msg Type 0x28


S16 Action




SS7 MTP 2 Developer’s Reference Manual Flow Control Indication

IDX GLSTOC

Flow Control Indication


Description Notifies the application that a congestion or congestion abatement condition has occurred. These conditions are caused by the transmit queue length crossing configurable thresholds.

Format


Action Always DL_FLC_SETLVL.FlcLevel Expected values are 0, 1, or 2 where 2

indicates severe congestion and 0 indicates no congestion. NMS advises that applications send normally at 0, reduce traffic at 1, and cease traffic at 2.

FlcLevel

Type

U8 Msg Type 0x2A

S16 Service User ID

S16 Action

U8




Flow Control Response SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

Flow Control Response


Description Confirms that the Flow Control Indication was received by layer 3 and does not need to be retransmitted. Timer T11 is stopped if this contains the same action and FlcLevel as was in the Flow Control Indication.

Format


Action Always DL_FLC_SETLVL.FlcLevel 0, 1, or 2 matching that in flow control

indication.

FlcLevel

Type

U8 Msg Type 0x2B

S16 Service User ID

S16 Action

U8




SS7 MTP 2 Developer’s Reference Manual Status Request

IDX GLSTOC

Status Request


Description Request one of a number of special functions supported by the MTP 2 layer.

Format


Action The action to take. Possible values are: 0 No Action; indicate change in status to MTP 2 as specified in status field 1 Retrieve backward sequence number 2 Retrieve unacknowledged messages 3 Drop all queued transmit messages

Status The status change being indicated to MTP 2, relevant if action is 0 or 2.When Action = 0, possible values are: 0 Local processor is down 1 Local processor is up 2 Emergency condition 3 Emergency ceases

Type

U8 Msg Type 0x78


S16 Action

U32 Status




Status Request SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

When Action = 2, the only possible value is: Starting sequence number, usually retrieved from an MTP3 COO or COA, to retrieve unacknowledged messages from the board

Details The following special functions supported by the MTP 2 layer:

Æ Retrieve the current BSN (last acknowledged sequence number) for a link (useful in implementing changeover procedures).

Æ Retrieve all MSUs transmitted on a link but not yet acknowledged (also useful in implementing changeover procedures) starting from a particular sequence number.

Æ Request MTP 2 to drop all queued messages.

Æ Notify MTP 2 of an emergency on or off condition on a link.

Æ Notify MTP 2 of a local processor up or down condition (passed on to far exchange).

MTP 2 returns a STATUS CONFIRM message containing the current BSN (last acknowledged sequence number) for a link to the application in response to a "retrieve BSN" status request. MTP 2 may also return a STATUS CONFIRM message in response to a "retrieve messages" status request, but only if there are no unacknowledged messages to be retrieved. If there are unacknowledged messages to be retrieved, a DATA CONFIRM indicating a status of "unacknowledged [more | last]" is sent to the application for each message (the last indicates that it is the last). In this case, no STATUS CONFIRM is returned to the application.




SS7 MTP 2 Developer’s Reference Manual Status Confirmation

IDX GLSTOC

Status Confirmation


Description The STATUS CONFIRMATION is sent to the application in response to a "retrieve BSN" status request. MTP 2 may also return a STATUS CONFIRM message in response to a "retrieve messages" status request, but only if there are no unacknowledged messages to be retrieved. If there are unacknowledged messages to be retrieved, one or more DATA CONFIRMATION messages are returned to the application instead.

All other status requests are unconfirmed.

Format

Type

U8 Msg Type 0x79

S16 Service User ID

S16 Action

U32 Status




Status Confirmation SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC


Action The action being reported in this confirmation: 1 Response to retrieve backwards sequence number status request; Status field contains BSN. 3 Response to retrieve messages status request; no unacknowledged messages to retrieve

Status The current value of the backwards sequence number for this link when Action = 1.




SS7 MTP 2 Developer’s Reference Manual Status Indication

IDX GLSTOC

Status Indication


Description The STATUS INDICATION notifies the application that a processor up or down event has occurred, or that level 1 buffer depletion has occurred. Level 1 buffer depletion indicates that incoming traffic has exceeded the layer 3’s ability to read it. The application may or may not be able to do anything to slow the incoming traffic, such as requeting that the other side’s layer 3 to slow down. A STATUS RESPONSE is not required for the buffer depletion indication.

Format


Status The condition being reported. Possible values are: 0 Remote processor down 1 Remote processor up 2 Level 1 buffer depletion

Value Buffer depletion level. Unused for processor status notifications.

Type

U8 Msg Type 0x7A

S16 Service User ID

U8 Status

U8 Value




Status Response SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

Status Response


Description Confirms that a STATUS INDICATION was received by layer 3 and does not need to be retransmitted. Timer T12 is stopped if this contains the same action and FlcLevel as was in the Flow Control Indication. Layer 3 is not required to send a Status Response for a buffer depletion status indication.

Format


Status The condition being reported. Possible values are: 0 Remote processor down 1 Remote processor up

Type

U8 Msg Type 0x7B

S16 Service User ID

U8 Status




IDX GLSTOC

Index

Aapplications

sample user 14

Bbind request 69binding 20byte ordering 19–20

Cconfiguration

TDM ports 10configuration files 57–58connect confirmation 71connect request 70connection clearing 25connection establishment 21

Ddata confirmation 73–74data indication 75data request 72data transfer 22–23disconnect confirmation 76disconnect indication 78disconnect request 77disconnect response 79driver interface 17

Eentity ID 16

Fflow control indication 81flow control request 80flow control response 82

NMS Communications

Send Feedback to NMS

Iinstance ID 16

Llink configuration 10links

SS7 15

MMTP 2

installation 10link configuration 10message reference 25–26overview 6–7sample configuration files 57–58

MTP2_SUCCESS 28mtp2cfg utility 48–51Mtp2GetLinkCfg 29Mtp2InitLinkCfg 30–36Mtp2LinkStats 37–38Mtp2LinkStatus 39–41Mtp2MgmtCtrl 42Mtp2MgmtInit 43Mtp2MgmtTerm 44mtp2mgr utility 59–64Mtp2SetLinkCfg 45

Ooverview

MTP 2 6–7

Ssample user applications 14SS7 architecture 8SS7 links 15status confirmation 85–86status indication 87

89

Doc Dept


Index SS7 MTP 2 Developer’s Reference Manual

IDX GLSTOC

status request 83–84status response 88

TTDM configuration 10TX driver 17

Uutilities

mtp2app and mtp2itu 65–66mtp2cfg 48–51mtp2mgr 59–64

90

Send Feedb

NMS Communications

ack to NMS Doc Dept


ss7 mtp layer 2 developer’s reference manual · ss7 mtp layer 2 developer’s reference manual...

Documents