Dialogic® DSI SS7HD Network Interface Boards Programmer's Manual April 2012 05-2063-11 www.dialogic.
Copyright and Legal Notice Copyright © 2003-2012 Dialogic Inc. All Rights Reserved. You may not reproduce this document in whole or in part without permission in writing from Dialogic Inc. at the address provided below. All contents of this document are furnished for informational use only and are subject to change without notice and do not represent a commitment on the part of Dialogic Inc. and its affiliates or subsidiaries (“Dialogic”).
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Contents 1 Introduction ....................................................................................................... 7 1.1 Related Information ................................................................................................................ 7 2 Specification ....................................................................................................... 9 2.1 2.6 2.7 Product Identifiers ...
Contents 3.7 3.4.2 Switching Model ........................................................................................................35 3.4.3 Static Initialization ....................................................................................................36 3.4.4 Dynamic Operation....................................................................................................37 3.4.5 Example Code for Building and Sending MVD_MSG_SC_LISTEN ......................................37 3.4.
® Dialogic Appendix A. A.1 A.2 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Protocol Configuration Using Discrete Messages ............................. 119 Protocol Configuration Using Individual Messages .................................................................... 119 Monitoring Configuration Using Individual Messages ................................................................ 122 Glossary ...............................................................................
1 Introduction Revision History Issue Note: 6 Date Description 11 April 2012 Re-structured manual. Configuration and installation details moved to DSI Software Environment Programmer’s Manual. 10 February 2010 Updates for changes to Windows® driver support 9 September 2009 Updates for Solaris and Windows® timestamping support. 8 February 2008 Minor updates and corrections. 7 December 2007 Updates for the “Additions for PCI Express board support”.
® Dialogic 1 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Introduction Dialogic® DSI SS7HD Network Interface Boards include specialized T1/E1/J1 SS7 signaling boards for use in PCI, CompactPCI and PCI Express systems. The boards offer a common software API to the application that enables applications to be ported easily between hardware architectures. The high density SS7 boards include PCI, CompactPCI and PCI Express form factors.
1 Introduction • Dialogic® SS7HDC Regulatory Notices • Dialogic® SS7HDE Regulatory Notices • Dialogic® Distributed Signaling Interface Components - Software Environment Programmer's Manual • Dialogic® SS7 Protocols MTP2 Programmer’s Manual • Dialogic® SS7 Protocols MTP3 Programmer’s Manual • Dialogic® SS7 Protocols ISUP Programmer’s Manual • Dialogic® SS7 Protocols TUP Programmer’s Manual • Dialogic® SS7 Protocols SCCP Programmer’s Manual • Dialogic® SS7 Protocols TCAP Programmer’s Manual
® Dialogic 2 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Specification This section provides information about: • Product Identifiers • Dialogic® DSI SS7HDP Network Interface Board - PCI Form Factor Products • Dialogic® DSI SS7HDC Network Interface Board - CompactPCI Form Factor Products • Dialogic® DSI SS7HDE Network Interface Board - PCI Express Form Factor Products License Buttons 2.
2 Specification A CompactPCI line interface board providing 16 T1/E1/J1 ports (provided by a companion Rear Transition Module). The number of signaling processors supported on each board determines the maximum number of links that can be supported. The signaling processor CPU controls Message Transfer Part 2 (MTP2) protocol operation of the board. Each board also contains a main CPU that handles the board management and monitoring functions.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Dialogic® DSI SS7HDP Network Interface Board - PCI Form Factor Products 2.2 The DSI SS7HDP board (SS7HDPD4TEW) is a full-length universal expansion PCI board that supports 3.3V/5V signaling environments, a 64/32-bit bus width, and a bus speed of 66/33 MHz. Features of the DSI SS7HDP board are described in the following topics: 2.2.
2 Specification 2.2.2 Host Interface DSI SS7HDP boards support the PCI operation modes given in Table 1. Table 1. PCI Operation Modes Supported by Dialogic® DSI SS7HDP Network Interface Boards Signaling Environment Bus Width Bus Clock Rate 3.3 V 5V 32-bit 33 MHz Yes Yes 32-bit 66 MHz Yes No 64-bit 33 MHz Yes Yes DSI SS7HDP boards are compatible with the PCISIG PCI Local Bus Specification Revision 2.2. 2.2.
® Dialogic • DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Line codes HDB3, AMI (ZCS), AMI, B8ZS • Connector type RJ-45 2.2.4 Protocol Resource Support When used in a signaling node, the DSI SS7HDP board (SS7HDPD4TEW) supports the Message Transfer Part (MTP) running on the board (with support for up to 64 links or two HSL links) and optionally other protocols including ISUP, TUP, SCCP, TCAP, MAP, INAP and IS41 running on the board or the host.
2 Specification Dimensions Board Length 312 mm (12.283 inches) – excludes ISA Retainer Height 106.68 mm (4.20 inches) Packaged Length 406 mm ( 15.98 inches) Width 220 mm (8.66 inches) Height 45 mm (1.77 inches) Weight 2.2.
® Dialogic • DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Country-Specific Approvals See the Global Product Approvals list at http://www.dialogic.com/declarations. Alternatively, contact your Dialogic technical sales representative for more information. 2.2.10 Reliability Product reliability is described by: • MTBF Predication 135,000 hours as per the Bellcore method @ 40°C • Warranty See Dialogic® Telecom Products Warranty Information at http://www.dialogic.com/warranties.
2 Specification Dialogic® DSI SS7HDC Network Interface Board CompactPCI Form Factor Products 2.3 DSI SS7HDC boards are high-density, high performance, multi-port, SS7 signaling interface boards designed for use in telecommunications environments. The boards have quad, dual, single or no signal processor(s) and support multiple HDLC-based signaling channels, including up to 128 SS7 links that can operate at 64, 56, and 48 kbits/s.
® Dialogic • DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 SS7 protocols MTP2 runs on the board. MTP3, ISUP, TUP, SCCP, TCAP, MAP, INAP and IS41 can be configured to run on the board or on the host. • TDM bus H.110 CT Bus compliant with ECTF H.110 Hardware Compatibility Specification: CT Bus, Rev. 1.0. • 2.3.2 Processors — Network: Intel 80200 processor — Signaling: Intel 80321 I/O processor On SS7HDCD16W boards, dual Intel 80321 I/O processors.
2 Specification • • • Data rate — T1: 1544 kbits/s ± 50 ppm — E1: 2048 kbits/s ± 50 ppm Frame format — T1: D4, ESF, and ESF-CRC6 — E1: E1 and E1-CRC4 Line codes — HDB3, AMI (ZCS), AMI, B8ZS • Connector type The connector type is determined by the RTM used, as defined in Section 2.3.4, “Rear Transition Modules” on page 18. 2.3.3.2 V.11 Interface Properties The properties of the V.11 interfaces are described as follows: • Standard Eight V.
® Dialogic 2.3.5 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Protocol Resource Support When used in a signaling node, the DSI SS7HDC boards support the Message Transfer Part (MTP) running on the board and optionally other protocols including ISUP, TUP, SCCP, TCAP, MAP, INAP and IS41 running on the board or the host. The protocols are enabled by a range of license buttons engraved with the codes BC, BD, BE and BF. See Section 2.5, “License Buttons” on page 27.
2 Specification Table 3. Dialogic® DSI SS7HDC Network Interface Boards Port Status Indications Green 2.3.7 Yellow Red Condition On Off Off Normal operation Off Off On Loss of Signal (LOS) On Off On Red alarm On On Off Yellow Alarm/Remote Alarm Indicator (RAI) On On On Alarm Indicator Signal (AIS) Power Requirements Power requirements for DSI SS7HDC boards are described in the following table Table 4.
® Dialogic • DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Humidity 5 to 85% non-condensing • Altitude 197 ft (60 m) below sea level to 5,905 ft (1800 m) above sea level • Vibration 0.1 g, 5 to 100 Hz • Shock Packaged equipment drop test 29.5 in (750 mm) 2.3.
2 Specification See Dialogic® Telecom Products Warranty Information at http://www.dialogic.com/warranties.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Dialogic® DSI SS7HDE Network Interface Board - PCI Express Form Factor Products 2.4 The DSI SS7HDE board (SS7HDED4TEQ) is a PCI Express form factor, x4 link width, standard height, full length board. Features of the DSI SS7HDE board are described in the following topics: 2.4.
2 Specification 2.4.3 Physical Interfaces The DSI SS7HDE board (SS7HDED4TEQ) supports the following physical interfaces: Note: 2.4.3.1 • Four T1/E1/J1 digital trunk interfaces. See Section 2.4.3.1 below for more detail. • One 10/100Base-TX Ethernet interface (RJ-45 port) • H.100 CT Bus interface. See Section 3.4.1 for details on the correct termination of the CT Bus. The 10/100Base-TX Ethernet interface is currently not supported.
® Dialogic 2.4.5 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Visual Indicators The DSI SS7HDE board (SS7HDPD4TEW) includes the following visual indicators: • Note: Two LEDs that are integrated into the Ethernet RJ-45 port: 2.4.6 Ethernet Port Integrity (Green) — Ethernet Port Activity (Amber) The 10/100Base-TX Ethernet interface is currently not supported.
2 Specification — • Storage temperature range — • 0.1 g, 5 to 100 Hz Shock — 2.4.9 197 ft (60 m) below sea level to 5,905 ft (1800 m) above sea level Vibration — • 5 to 85% non-condensing Altitude — • -20° C to +40° C Humidity — • +5°C to +40°C Packaged equipment drop test 29.
® Dialogic 2.5 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 License Buttons The DSI SS7HD code file supports different protocol module combinations that are enabled by fitting the correct License button on the board. Each license button is engraved with a two-letter code that is used for identification. The following table shows Item Market Names (IMNs) for the currently available license buttons and the two-letter code corresponding to each IMN. Table 5.
2 Specification Table 6.
® Dialogic 2.5.2 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Run Modes and Protocol Dimensions The combination of the run mode and board type determines how many SS7 links can be supported by the board. The SS7HDCQ8 board with four signaling processors can support twice the number of links of the other boards, which contain two signaling processors. The number of circuits and dialogs that can be supported by a board depends only on the run mode and not on the DSI SS7HD board variant.
2 Specification Table 7. Protocol Dimensioning Supported by V5.
® Dialogic 2.6 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 SNMP Support The Dialogic® Distributed Structured Management Information (DSMI) Simple Network Management Protocol (SNMP) Agent provides SNMP monitoring functionality for the Dialogic® DSI SS7 Development Package.
3 SS7HD Board Product Specific Configuration and Operation 3 SS7HD Board Product Specific Configuration and Operation Before attempting software configuration, you should gain an appreciation of the flexibility of the protocol stack, the run-time options that exist and the mechanisms that are used to select specific features.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 As an alternative to using s7_mgt, users can build their own configuration utilities using messaged-based configuration. In this case users should refer to the definitions of individual messages in Section 4, Message Reference on page 47. The Code File contains the operating firmware for the board which is downloaded to the board at run-time by the ssdh binary.
3 SS7HD Board Product Specific Configuration and Operation 3.3.1 Configuration The user needs to set up the configuration for the T1/E1/J1 interface and the operating parameters for each link to be monitored. This can all be achieved using the config.txt file in conjunction with the s7_mgt configuration utility. Users wishing to use discrete message-based configuration should refer to Section A.2, “Monitoring Configuration Using Individual Messages” on page 122 of this manual. 3.3.
® Dialogic 3.4.1 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Termination of the CT Bus Dialogic® DSI SS7HDP Network Interface Boards - PCI Form Factor Products and Dialogic® DSI SS7HDE Network Interface Boards - PCI Express Form Factor Products must have their CT Bus termination parameter configured according to their position on the CT Bus cable. The connectors at the two ends of the CT Bus cable must not be left disconnected.
3 SS7HD Board Product Specific Configuration and Operation Figure 1. CT Bus Connections When a call clears, the application needs to initiate generation of the fixed Idle pattern towards the network operation and may wish to connect an Idle pattern to the resource board. 3.4.3 Static Initialization Static initialization is handled by the s7_mgt protocol configuration utility. For each T1/E1/J1 Line Interface Unit (LIU), the user should include an LIU_SC_DRIVE command in the config.
® Dialogic LIU_SC_DRIVE LIU_SC_DRIVE LIU_SC_DRIVE LIU_SC_DRIVE LIU_SC_DRIVE LIU_SC_DRIVE LIU_SC_DRIVE LIU_SC_DRIVE 3.4.
3 SS7HD Board Product Specific Configuration and Operation * Function to drive an SCbus / CT Bus timeslot * onto a timeslot on a PCM port: */ int listen_to_scbus(board_id, liu_id, timeslot, sc_channel) int board_id; /* board_id (0, 1, 2 ...) */ int liu_id; /* PCM port id (0 .. one less than no. of LIUs) */ int timeslot; /* Timeslot on the PCM port (1 ..
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 An example of an s7_mgt configuration file to connect a signaling link to an LIU timeslot on another board is shown below: SS7_BOARD SS7_BOARD 0 SS7HDC 0x0043 1 SS7HDC 0x00c2 ss7.dc4 ss7.
3 SS7HD Board Product Specific Configuration and Operation Note: 3.4.7 All 32 signaling links from board 1, signaling processor 0, are driven up to CT Bus channels 0x0100 to 0x0120. Interconnecting LIUs using STREAM_XCON Interconnection of two Line Interface Units (LIUs) on the board is also supported through the STREAM_XCON command which controls the cross connect switch on the signaling board, enabling the cross connection of timeslots between any two LIUs within the board.
® Dialogic 3.5 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Received Message Timestamping When used with the board and monitored links, this functionality can be used to provide a timestamp of the time a message is received by the board, to a resolution of 1ms. Individual boards maintain time by synchronizing with the host time. The following table provides details of the expected timestamp accuracy between boards, in a multi board system: Operating System 3.5.
3 SS7HD Board Product Specific Configuration and Operation MONITOR_LINK 0 0 0-0 0 1 0xef 7 0x01 0xff 4. Note: 3.5.2 Configure the s7_log utility to display board and/or host timestamp information. See “s7_log” in the Software Environment Programmer's Manual for more information on the command line options for timestamping. To use the s7_log utility to display timestamps, monitoring messages must be redirected to the s7_log module ID in the MONITOR_LINK command.
® Dialogic 3.6 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Hot Swap Operation Hot Swap operation is supported on SS7HDP, SS7HDC and SS7HDE boards for Linux and Windows® operating systems on suitable hardware. Caution: See the Dialogic® SS7HDC Boards Installation Guide (supplied with the board) for the correct handling procedure that must be observed when hot swapping a board. 3.6.1 Supported System Configurations 3.6.1.
3 SS7HD Board Product Specific Configuration and Operation Hot replacement operation is handled by the ssdh module and device driver. This mode of operation is only suitable for the replacement of SS7HDC boards and is a proprietary mechanism which should only be used when no operating system support is available for the hot replacement of boards. This option is not supported on other SS7HD board types. • -s2 Full Hot Swap operation as handled by the operating system or the HSK.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 #!/bin/sh if [ ! -d /lib/modules/`uname -r`/misc ]; then mkdir /lib/modules/`uname -r`/misc fi cp ss7hd.
3 SS7HD Board Product Specific Configuration and Operation • The second message has the status code set to SSDSI_FAILURE (0x62). If geographic addressing is being used, the SSDSI_BRD_RMVD message will use the physical board ID in the board_id field, and the SSDSI_FAILURE message will use the same logical board ID in the board_id field. If PCI addressing is being used, the board_ids will be the same for both messages. The application should note that the board has been disabled.
® Dialogic 4 4.1 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Message Reference Overview This section describes the individual messages that may be sent to or received from a Dialogic® SS7HD board. Some messages are sent by the user's application software, while others are sent by utility programs such as the s7_mgt protocol configuration utility.
4 Message Reference Message Type 0x0f1d 48 Mnemonic MGT_MSG_NTP_SYNC Description Timestamping Resynchronization Indication 0x1213 Confirmation of SS7_MSG_TRACE_MASK* 0x1e37 Confirmation of LIU_MSG_R_CONFIG 0x1e38 Confirmation of LIU_MSG_R_CONTROL 0x1e39 Confirmation of LIU_MSG_R_STATE 0x2214 Confirmation of SS7_MSG_R_STATS* 0x2215 Confirmation of SS7_MSG_R_STATE* 0x3200 Confirmation of SS7_MSG_RESET* 0x3203 Confirmation of SS7_MSG_CONFIG 0x3312 Confirmation of MTP_MSG_CNF_ROUTE 0x36
® Dialogic Message Type DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Mnemonic Description 0x5213 SS7_MSG_TRACE_MASK* Set Trace Mask Request* 0x5e36 LIU_MSG_R_STATS LIU Read Statistics Request 0x5e37 LIU_MSG_R_CONFIG LIU Read Configuration Request 0x5e38 LIU_MSG_R_CONTROL LIU Read Control Request 0x5e39 LIU_MSG_R_STATE LIU Read State Request 0x6136 DVR_MSG_R_L1_STATS Link Statistics Request 0x6214 SS7_MSG_R_STATS* MTP2 Link Statistics Request* 0x6215 SS7_MSG_R_S
4 Message Reference Message Type Mnemonic Description 0x7e34 LIU_MSG_CONFIG LIU Configuration Request 0x7e35 LIU_MSG_CONTROL LIU Control Request 0x7f0d MGT_MSG_NTP_CONFIG Network Time Configuration 0x7f10 MGT_MSG_CONFIG0 Board Configuration Request 0x7f17 MGT_MSG_L1_CONFIG Layer 1 Configuration Request 0x7f18 MGT_MSG_L1_END Layer 1 Configuration End 0x830a Confirmation of MTP_MSG_ACT_SL 0x830b Confirmation of MTP_MSG_DEACT_SL 0x8403 MTP_MSG_PAUSE* MTP Pause Indication 0x8404 MT
® Dialogic Mnemonic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Value Description SS7_SP0_TASK_ID † 0x81 Signaling Processor # 0 MTP2 module SS7_SP1_TASK_ID † 0x91 Signaling Processor # 1 MTP2 module SS7_SP2_TASK_ID † 0xe1 Signaling Processor # 2 MTP2 module SS7_SP3_TASK_ID † 0xf1 Signaling Processor # 3 MTP2 module MGMT_SP0_TASK_ID † 0xce Signaling Processor # 0 Onboard Management module MGMT_SP1_TASK_ID † 0xde Signaling Processor # 1 Onboard Management module MG
4 Message Reference 4.1.3 Message Status Summary The following table shows the valid responses when a response request (rsp_req) is requested in a message. Table 11.
® Dialogic 4.2 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 General Configuration Messages General configuration messages are typically issued by the s7_mgt protocol configuration utility, in which case they need not, and should not, be generated by any user application software.
4 Message Reference 4.2.1 SSD_MSG_RESET - SSD Reset Request Synopsis Sets up ssd module run-time options at initialization time. Note: When using the s7_mgt protocol configuration utility, this message is generated by s7_mgt and should not be generated by the user. Format MESSAGE HEADER Field Name Meaning type id src dst rsp_req hclass status err_info len SSD_MSG_RESET (0x7680) 0 Sending module ID SSD_module_ID Used to request a confirmation.
® Dialogic 4.2.2 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 SSD_MSG_RST_BOARD - Board Reset Request Synopsis Reset a single board and download a code file. Note: When using the s7_mgt protocol configuration utility, this message is generated by s7_mgt and should not be generated by the user.
4 Message Reference code_file Null terminated string giving the filename of the code file to be downloaded to the board. run_mode The protocols to be run. The following table shows the permitted values and their meanings. Value 56 Run Mode Protocols Selected to Run on the Board 1 DTI Digital trunk interface only; no protocol software. This mode does not require the use of a software license button. 17 MON Monitoring of MTP2 messages in receive only operation.
® Dialogic Value Note: Run Mode DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Protocols Selected to Run on the Board 13 TCAP-ISUP Supports both TCAP and ISUP protocol operation and the appropriate supporting modules. 22 MAP-ISUP Supports both MAP and ISUP protocol operation and the appropriate supporting modules. 23 MAP-TUP Supports both MAP and TUP protocol operation and the appropriate supporting modules.
4 Message Reference 4.2.3 SSD_MSG_BOARD_INFO - Board Information Request Synopsis Retrieves information about an SS7HD board. Format MESSAGE HEADER Field Name Meaning type id src dst rsp_req hclass status err_info len SSD_MSG_BOARD_INFO (0x7689) board_id Sending module ID SSD_module_ID Used to request a confirmation. 0 0 0 38 PARAMETER AREA Offset 0 4 6 10 12 16 36 Size 4 2 4 2 4 20 2 Name ssdmode btype addrsw numsp subsysid sernum Reserved. Set to 0.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 — 1: PCI address mode — 2: H.110 address mode — 3: ADDR switch address mode — 4: PICMG 2.0 address mode. Refer to the Software Environment Programmer’s Manual for information about ssdh parameters. btype The board type. For SS7HD boards, this parameter is set to 3. addrsw The board address value.
4 Message Reference 4.2.4 MGT_MSG_CONFIG0 - Board Configuration Request Synopsis Message sent to a board immediately after starting the code running to provide physical configuration parameters. Note: When using the s7_mgt protocol configuration utility, this message is generated by s7_mgt and should not be generated by the user.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Set to 3 when using an SS7HD board. A separate link layer configuration message should be sent for each link using the MGT_MSG_L1_CONFIG message. Note: For backwards compatibility reasons, config_type can also be set to 2, but only when using four links or less. flags Global flags with the following bit significance: — Bit 15 is set to 1 for diagnostic purposes to cause the results of board configuration to be passed to the host.
4 Message Reference 62 — Bit 9 - in general configurations, this should be set to 0. In dual fault tolerant configurations, Board A must set bit 9 to 0 while Board B must set bit 9 to 1. For further information, refer to the Dialogic® DSI Signaling Servers Manual - 05-2302-xxx - Appendix A. — Bit 13 causes the board to drive the CT_NETREF1 clocks on the CT Bus when set to 1. The highest priority in-sync line interface is used as a clock source.
® Dialogic 4.2.5 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 MGT_MSG_L1_CONFIG - Layer 1 Configuration Request Synopsis Message sent to a board after successful processing of the MGT_MSG_CONFIG0 message to configure the layer 1 links. Note: When using the s7_mgt protocol configuration utility, this message is generated by s7_mgt and should not be generated by the user.
4 Message Reference sp_id Signaling processor ID. This is the logical identifier of the signaling processor on the board that handles the link. Possible values are 0 to one less than the number of signaling processors. For example, the SS7HDP4TE board has two signaling processors so the value or this parameter can be 0 or 1. sp_channel The logical ID of the channel on the signaling processor. This value should be unique for each channel on the same board and signaling processor.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Value Clocking serial port 0 Internal, using data rate 1 External source 2 Co-directional link_stream Signaling stream. This parameter is only valid when link_source is set to 0. It is the logical identity of the T1/E1/J1 line interface containing the signaling link. The value range is 0 to one less than the number of LIUs. link_timeslot Signaling timeslot.
4 Message Reference Value 4.2.6 Description 0xffffffff unstructured E1 HSL 0x01ffffff unstructured T1 HSL 0xfffffffe structured E1 HSL, 31 slots (1 to 31) 0x01fffffe structured T1 HSL, 24 slots (1 to 24) 0xfffefffe structured E1 HSL, 30 slots (1 to 15,17 to 31) MGT_MSG_L1_END - Layer 1 Configuration End Synopsis Message sent to a board to remove an existing layer 1 link that was previously configured by sending an MGT_MSG_L1_CONFIG message.
® Dialogic 4.2.7 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 MGT_MSG_NTP_CONFIG - Network Time Configuration Synopsis Configures network-specific time parameters.
4 Message Reference 4.3 Hardware Control Messages Hardware control messages are used to control various hardware devices on the board including the T1/E1/J1 Line Interface Units (LIUs), the digital cross connect switches and the clocking mode for the board. In a static configuration, all these hardware blocks can be set up using the s7_mgt protocol configuration utility along with the appropriate commands in the config.txt protocol configuration file.
® Dialogic 4.3.1 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 LIU_MSG_CONFIG - LIU Configuration Request Synopsis Message sent by the application to establish the operating mode for a Line Interface Unit (LIU). Note: When using the s7_mgt protocol configuration utility, this message is generated by s7_mgt as a result of the LIU_CONFIG command. It therefore need not be generated by the user.
4 Message Reference Parameters A description of the permitted parameter values are given below. When the board is initially configured, all the LIUs are initialized to a disabled condition. The LIU_MSG_CONFIG message includes the following parameters: liu_type The physical interface type. The preferred method for configuring an E1 interface is to set a value of 5. The following table shows the permitted values and their meanings. Value Description 1 Disabled (used to deactivate a LIU).
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 crc_mode The CRC mode. The following table shows the permitted values and their meanings. Value Description 1 CRC generation disabled 2 CRC4 enabled (frame_format must be set to 2) NOTE: Out of CRC4-multiframe E-Bits are transmitted as ones. 3 CRC4 compatibility mode (frame_format must be set to 2) 4 CRC6 enabled (frame_format must be set to 7 or 8) 5 CRC4 G.
4 Message Reference nfaw The 8-bit value to be used for any E1 non-frame alignment word bit positions that are not modified by other options. Normally, this parameter should be set to 0x9f for E1 operation and set to 0 for T1. When using unstructured frame format, this parameter should be set to 0. ais_gen The (initial) mode used to generate the Alarm Indication Signal (Blue alarm). The user may subsequently modify the setting of the outgoing signal using the LIU_MSG_CONTROL message.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Value 4.3.2 Description 1 Terminated; normal impedance presented on the line 2 High Impedance; set the LIU to high impedance for monitoring LIU_MSG_CONTROL - LIU Control Request Synopsis Message sent by the application to dynamically control operation for a Line Interface Unit (LIU). Allows setting of outgoing alarms and diagnostic loopbacks.
4 Message Reference Description This message is sent to the board to perform dynamic changes to the operation of the LIU. It allows the user to control the generation of AIS (Blue alarm) and RAI (Yellow alarm) and to activate various diagnostic loopback modes. It also allows the configuration of PRBS test sequences. The confirmation message (if requested) indicates success with a status value of 0.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Value Description 0 Do not change diagnostic loopback mode 1 Disabled - remove any diagnostic loop 2 Payload loopback 3 Remote loopback 4 Local loopback prbs_gen The Pseudo Random Bit Sequence (PRBS) generation mode. The following table shows the permitted values and their meanings.
4 Message Reference 4.3.3 LIU_MSG_R_CONFIG - LIU Read Configuration Request Synopsis Message sent by the application to read back the current Line Interface Unit (LIU) configuration from the board. Format MESSAGE HEADER Field Name Meaning type id src dst rsp_req hclass status err_info len LIU_MSG_R_CONFIG (0x5e37) liu_id (in the range 0 to one less than the number of LIUs) Sending module ID MVD_module_ID Used to request a confirmation.
® Dialogic 4.3.4 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 LIU_MSG_R_CONTROL - LIU Read Control Request Synopsis Message sent by the application to read back the current Line Interface Unit (LIU) control options from the board. Format MESSAGE HEADER Field Name Meaning type id src dst rsp_req hclass status err_info len LIU_MSG_R_CONTROL (0x5e38) liu_id (in the range 0 to one less than the number of LIUs) Sending module ID MVD_module_ID Used to request a confirmation.
4 Message Reference 4.3.5 MVD_MSG_SC_DRIVE_LIU - LIU CT Bus Initialization Request Synopsis Sets up a static switch path through the board between the Line Interface Unit (LIU) and the CT Bus.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 sc_channel The channel number of the first channel to be used on the CT Bus. This should be in the range from 0 to one less than the total number of channels on the CT Bus. ts_mask A 32-bit timeslot mask where each bit position is set to 1 if the corresponding timeslot on the T1/E1/J1 interface is required to be connected to the CT Bus. The least significant bit (bit 0) represents timeslot 0.
4 Message Reference 4.3.6 MVD_MSG_SC_LISTEN - CT Bus Listen Request Synopsis Message sent to the board to establish a connection from the CT Bus to an outgoing timeslot on a T1/E1/J1 Line Interface Unit (LIU).
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 liu_id The identifier of the T1/E1/J1 LIU in the range 0 to one less than the number of LIUs. This parameter can also be set to one of the special values (0x90, 0x91, 0x92 or 0x93) to select one of the signaling processors instead of an LIU. These values identify processors 0 to 3 respectively. In this case, timeslots 0 to 31 correspond to a timeslot on the signaling processor.
4 Message Reference Parameters The MVD_MSG_SC_FIXDATA message includes the following parameters: liu_id The identifier of the T1/E1/J1 Line Interface Unit in the range 0 to one less than the number of LIUs. timeslot The timeslot number on the T1/E1/J1 LIU on which the fixed data will be transmitted. The valid ranges are: — For an E1 interface: 1 to 31 — For a T1 interface: 1 to 24 pattern The value of the fixed data to be generated in the range 0 to 255. Typical values are: 4.3.
® Dialogic 4.3.9 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 MVD_MSG_SC_CONNECT - CT Bus Connect Request Synopsis Message sent to the board to control the switch path through the CT Bus switch. Note: This message provides an alternative approach for controlling the switching through the CT Bus switch allowing connections to the CT Bus to be utilized only as required, rather than being set up at initialization time.
4 Message Reference Parameters The MVD_MSG_SC_CONNECT message can include different parameters depending on the mode. The following table depicts the parameters that are required for each possible mode.
® Dialogic Value DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Meaning 1 Make a simplex connection from a timeslot on the CT Bus to a timeslot on the local bus. Use the local_stream, local_slot, source_stream and source_slot parameters to specify the local and CT Bus timeslots respectively. 2 Make a simplex connection from a timeslot on the local bus to a timeslot on the CT Bus.
4 Message Reference dest_slot The destination slot references the CT Bus timeslot to which a local stream timeslot can be connected or disconnected. The destination slot values are in the range 0 to 127. pattern The value of the fixed data to be generated. The value should be in the range 0 to 255. Typical values are: 4.3.10 — 0x2a is the ITU-T idle pattern, and is appropriate for signaling (D) channel. — 0x55 is appropriate for A-law bearer channels (0x55 or 0xd5 are A-law silence).
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Description This message is sent to the board in order to control the configuration of the CT switch device for more complex configurations. Parameters The MVD_MSG_SC_MULTI_CONNECT message includes the following parameters: local_stream The logical reference of the local stream that the message relates to, that is, 0 to one less than the number LIUs corresponding to the liu_id.
4 Message Reference 4.3.11 MVD_MSG_CNFCLOCK - Configure Clock Request Synopsis Message sent to an SS7HD board to configure or reconfigure the clocking mode for the board. It is not necessary to send this message for single board systems or systems where the CT Bus is not used. In these cases, the options in the MGT_MSG_CONFIG0 message are sufficient.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Value Bus speed 0 No change 3 8.192 MHz clk_mode Determines the clocking mode for the board. The following table shows the permitted values and their meanings.
4 Message Reference Value PLL clock source 7 NETREF 1 8 NETREF 2 (CompactPCI only) The PLL clock is used as the reference when acting as CT Bus Primary Master. If the clock is to be recovered from one of the line interfaces, the highest-priority in sync line interface is used as the reference. Each line interface is assigned a priority: by default liu_id=0 is the highest priority and liu_id=one less than the number of LIUs, is the lowest.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Value NETREF_2 clock mode 1 Drive NETREF_2 using clock recovered from highest priority line interface 6 Tristate (that is, not driven) When the NETREF_2 signal is being driven, the clock source is the highest priority line interface. If no interface is available for clock recovery, no signal is driven onto the bus. Driving the NETREF_2 signal is independent of the clk_mode and pll_clk_src settings for this board.
4 Message Reference 4.3.12 MVD_MSG_CLOCK_PRI - Configure Clock Priority Request Synopsis Message sent to an SS7HD board to configure the clock recovery priority order.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Parameters The MVD_MSG_CLOCK_PRI message includes the following parameters: liun_pri The relative priority for each LIU. The following table shows the permitted values and their meanings. Value 4.3.13 Meaning 0 No change to the interface’s priority. 1 to 32 New priority value for the line interface. The value 1 indicates highest priority, 32 the lowest priority.
4 Message Reference Parameters The MVD_MSG_LED_CTRL message includes the following parameters: led_n_state Specifies the state of the user LED. The following table shows the possible values and their meanings. Value 94 Meaning 0 Do not change the LED state. 1 Turn the LED off. 2 Turn the LED on.
® Dialogic 4.4 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 MTP Interface Messages MTP interface messages allow signaling links to be activated and deactivated by the user and provide a mechanism for communication between the MTP3 module and the user part module (for example, ISUP, TUP or SCCP). In many cases, the user part module is an Dialogic® SS7 Protocol so the user does not need to handle the MTP primitives as they pass directly between MTP3 and the user part module.
4 Message Reference Signaling Unit Data The SU data in binary format, excluding the Flags and Checksum, commencing with the Backwards Sequence Number (BSN).
® Dialogic 4.4.2 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 API_MSG_RX_INDT - Timestamped Incoming Signaling Unit Indication Synopsis Message generated by MTP2 when operating in monitoring mode conveying the Signaling Unit and its time of reception on the board.
4 Message Reference 4.4.3 API_MSG_TX_REQ - MTP2 Transmission Request Synopsis Message issued to the board by MTP3, containing an SS7 Message Signal Unit (MSU) for transmission on the specified link. Format MESSAGE HEADER Field Name Meaning type id src dst rsp_req hclass status err_info len API_MSG_TX_REQ (0xcf00) l2_llid Sending module ID MTP2 module ID Sending layers bit set if response is required. 0 0 0 Number of octets in the Signaling Unit.
® Dialogic 4.5 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Event Indication Messages Event indication messages are the mechanism by which protocol and software error events are reported to the application. These messages are generated asynchronously by different modules within the stack. The messages in the event indication category include: 4.5.
4 Message Reference Value 100 Mnemonic id Description 0x34 S7E_TX_FAIL l2_llid Failed to send LSSU/FISU to driver. 0x35 S7E_HDR_ERR l2_llid No room to add MTP2 header, SU not transmitted. 0x36 S7E_LEN_ERR l2_llid Length error, SU not transmitted. 0x37 S7E_MSU_SEND l2_llid Failed to send SU to lower layer, protocol should handle retransmission. 0x39 S7E_BAD_PRIM l2_llid MTP2 unable to accept primitive. 0x3a S7E_BAD_LLID l2_llid Invalid l2_llid in HDR structure.
® Dialogic Value 4.5.2 Mnemonic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 id Description 0x68 MTP_FLUSH_FAIL link_id MTP3 failed to receive Flush Ack from MTP2. 0x69 MTP_FLUSH_L2 link_id MTP2 transmission buffers flushed (due to RPO). SSD_MSG_STATE_IND - Board Status Indication Synopsis Message sent to the application on completion of the reset and download sequence or on detection of a board status event.
4 Message Reference Value Meaning 0x66 License validation failure 0x67 License appears corrupt 0x70 Message congestion towards board cleared 0x71 Message congestion towards board onset 0x72 Message discard towards board cleared 0x73 Message discard towards board onset 0x74 Excessive message congestion towards board – board failed If the system is configured in PCI addressing mode, the SSD_MSG_STATE_IND message for statuses 0x64 and 0x65 are generated using a unique logical ID number for the
® Dialogic 4.5.3 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 MVD_MSG_CLK_IND - Clock Event Indication Synopsis Message issued by the board to indicate on-board clocking related events. Format MESSAGE HEADER Field Name type id src dst rsp_req hclass status err_info len Meaning MVD_MSG_CLK_IND (0x0e23) 0 MVD_TASK_ID MGMT_TASK_ID 0 0 event_id 0 0 The MVD_MSG_CLK_IND message header uses the following parameter: event_id Specifies the event that caused the indication to be generated.
4 Message Reference 4.5.4 MVD_MSG_LIU_STATUS - LIU Status Indication Synopsis Message issued by the board to provide notification of changes in LIU status. Format MESSAGE HEADER Field Name Meaning type id src dst rsp_req hclass status err_info len MVD_MSG_LIU_STATUS (0x0e01) liu_id (in the range 0 to one less than the number of LIUs) MVD_module_ID MGMT_module_ID 0 0 liu_status (see below) Reserved for future use.
® Dialogic Value 4.5.5 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Mnemonic State 26 LIUS_BER5_CLRD BER5 cleared 27 LIUS_BER3_OCRD BER > 1 in 1,000 28 LIUS_BER3_CLRD BER3 cleared MGT_MSG_NTP_SYNC - Timestamping Resynchronization Indication Synopsis Message sent if a significant time difference between the board and the host is detected. This message is generated only if received message timestamping is configured. See Section 3.
4 Message Reference 4.5.6 MGT_MSG_DIAG_IND - Management Diagnostic Indication Synopsis Message sent by a module to a management entity to convey extended diagnostic information. Format MESSAGE HEADER Field Name Meaning type id src dst rsp_req hclass status err_info len MGT_MSG_DIAG_IND (0x0f1f) board_id SSD module id mgmt_id 0 0 0 0 6 PARAMETER AREA Offset 0 1 2 4 Size 1 1 2 2 Name diag_src Reserved. Set to zero.
® Dialogic 4.6 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Status Request Messages Status request messages can be used to poll the status of modules or systems running on the board. The messages in the status request category include: 4.6.
4 Message Reference state The current state of the LIU. The following table shows the permitted values and their meanings.
® Dialogic 4.6.2 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 LIU_MSG_R_STATS - LIU Read Statistics Request Synopsis Message used to read back performance statistics associated with an LIU. Format MESSAGE HEADER Field Name Meaning type id src dst rsp_req hclass status LIU_MSG_R_STATS (0x5e36) liu_id (in the range 0 to one less than the number of LIUs) Sending module ID MVD_module_ID Used to request a confirmation.
4 Message Reference Typically, a managing application would be set up to periodically (for example, hourly or daily) read and reset the statistics and store the resulting information so that it can be accessed later for generation of performance reports for the line interface. This message is now version 2; it contains Pseudo Random Bit Sequence (PRBS) statistics. The old message (version 1) continues to be supported by the software.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 prbs_status The status of Pseudo Random Bit Sequence (PRBS) indications. Possible values are: — 1 - PRBS is valid, the counts are correct. — 2 - PRBS counters have overrun. — 3 - PRBS sequence is not synchronized. prbs_error_count A count of the number of times the PRBS mechanism detected an error. prbs_bit_count A count of the bits that the PRBS unit has received. This parameter can be used to calculate the error rate. 4.
4 Message Reference Description This message is sent to the board to read the current clocking state. The user should always request a confirmation message. The confirmation message indicates success with a status value of 0 and contains the current state in the parameter area of the message. Parameters The MVD_MSG_R_CLK_STATUS message includes the following parameters: clk_mode Indicates the current clock mode for the board.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Value Description 0 Configured as CT Bus slave, PLL not used 1 Recovering from LIU specified in liu_rec parameter 5 Local reference oscillator 7 NETREF_1 8 NETREF_2 9 PLL in holdover mode liu_rec If the PLL is recovering the clock from a line interface, this parameter indicates the liu_id (in the range 0 to one less than the number of LIUs) of the LIU being used as a reference.
4 Message Reference 4.6.4 MGT_MSG_R_BRDINFO - Read Board Info Request Synopsis Message used to request basic board information. The message can be sent to all SS7HD board types, but some parameters may not be appropriate or produced for either board type.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Parameters The MGT_MSG_R_BRDINFO message includes the following parameters: board_type The board type. The following table shows the possible values and their meanings. Value Meaning 3 SS7HDP 4 SS7HDC 6 SS7HDE board_rev The board revision number. rtb_type The Rear Transition Board (RTB) type. Applies to SS7HDC boards only. The following table shows the possible values and their meanings.
4 Message Reference esn Electronic serial number. lsn License serial number. This is the serial number of the fitted license button. dram_size DRAM size in bytes. bsn The board’s production serial number (ASCII characters, null terminated). lictype The board’s license button code. The following table shows the possible values and their meanings.
® Dialogic 4.6.5 DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 DVR_MSG_R_L1_STATS - Link Statistics Request Synopsis Retrieve link statistics.
4 Message Reference duration Duration in tenths of a second since the statistic counters were last reset. abort_cnt The number of aborts received on the link. CRC_errs Number of CRC errors received on the link. misaligned_frames The number of misaligned frames (that is, frames that are not an integer multiple of 8 octets) received on the link. length_errs The number of received frames that were designated as either too long or too short for a configured protocol.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Appendix A. Protocol Configuration Using Discrete Messages This appendix provides guidelines for protocol configuration using individual messages. A.1 Protocol Configuration Using Individual Messages As an alternative to using the s7_mgt protocol configuration utility it is possible to perform protocol configuration by building and sending messages directly to the board.
4 Message Reference 5. Build and send a Layer 1 Configuration Request (MGT_MSG_L1_CONFIG) to set up the physical configuration parameters for the link. This message should be sent to the onboard management module. Wait for the confirmation message and check the status. 6. Build and send an MTP2 Link Configuration Request (SS7_MSG_CONF) to set up the MTP2 configuration parameters. See the MTP2 Programmer’s Manual for the message definition. Wait for the confirmation message and check the status. 7.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Figure 3.
4 Message Reference A.2 Monitoring Configuration Using Individual Messages To configure the board for monitoring it using individual messages, proceed as follows: 1. Build and send an SSD Reset Request to the SSD module. This contains the parameters to initialize the SSD module. 2. Build and send a Board Reset Request for each board in the system. This message contains the address (or identifier) of the board and the name of the code file. It causes the board to be reset and the code file downloaded.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 Glossary AIS Alarm Indication Signal (Blue alarm). config.txt A text file used for protocol configuration. CT Bus A time division multiplex (TDM) bus that provides 1024, 2048, or 4096 time slots for exchanging voice, fax, or other network resources on a PCI or PCI Express (H.100), or CompactPCI (H.110) backplane. The Enterprise Computer Telephony Forum (ECTF) developed the H.
4 Message Reference 124 MSU Message Signal Unit. A data unit that carries signaling information for call control, transaction processing, network management and maintenance. Typically, the MSU is carried in the Signaling Information Field (SIF) of SS7 messages. MTP Message Transfer Part. Layers 1 to 3 of the SS7 protocol stack broadly equivalent to the Physical, Data Link and Network layers in the OSI protocol stack. See also MTP1, MTP2, and MTP3. MTP1 Message Transfer Part Level 1.
® Dialogic DSI SS7HD Network Interface Boards Programmer's Manual Issue 11 SLS Signaling Link Selection field. A field in the MTP3 routing label used to determine the selection of an outgoing link for messages being routed to another point code. SS7 Signaling System Number 7 SS7 Protocol Stack A set of software modules that implement the various layers of the SS7 protocol stack. SS7HD An identifier for the family of Dialogic® High Density SS7 boards.
