tx utilities manual - network fuel®, bordernet sbc

100 Crossing BoulevardFramingham, MA 01702-5406 USA

www.nmscommunications.com

TX Utilities Manual

P/N 9000-6437-17

TX Utilities Manual

2 NMS Communications

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.

© 2005 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, Open Telecommunications, Natural Platforms, NMS HearSay, AccessGate, MyCaller, 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, Solaris, Netra, 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. Linux is a registered trademark of Linus Torvalds. Red Hat is a registered trademark of Red Hat, Inc. All other marks referenced herein are trademarks or service marks of the respective owner(s) of such marks. All other products used as components within this product are the trademarks, service marks, registered trademarks, or registered service marks of their respective owners.

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.

P/N 9000-6437-17

Revision history

Revision Release date Notes

1.0 June, 1998 GG

1.1 November, 1998 MVH

1.2 September, 2000 MCM; Fusion 3.1

1.3 January, 2002 MVH; SS7 3.8

1.4 November, 2003 MCM; SS7 4.0 Beta

1.5 April, 2004 MCM; SS7 4.0

1.6 August, 2004 SRR, SS7 4.1

1.7 April 2005 LBG, SS7 4.2

Last modified: April 13, 2005

Refer to www.nmscommunications.com for product updates and for information about support policies, warranty information, and service offerings.

NMS Communications 3

Table Of Contents

Chapter 1: Introduction .................................................................................5

Chapter 2: TX utilities overview.....................................................................7 TX basic operation utilities ............................................................................ 7 TDM utilities and demonstration programs ...................................................... 8 TX communications processor tasks ............................................................... 9

Chapter 3: TX board management utilities...................................................11 Assigning CP numbers to TX boards: txcpcfg ..................................................11

Obtaining bus and slot information during software installation (UNIX only) .....12 Viewing a list of installed TX boards: cpmodel ................................................13 Viewing EEPROM information: txeeprom ........................................................14 Updating the board flash memory: txflash .....................................................16 Resetting and rebooting from flash: txreset....................................................17 Locating a TX board in a chassis: txlocate......................................................18

Chapter 4: Communications processor utilities ............................................19 Receiving alarms from TX based tasks: txalarm..............................................19 Receiving data traces from TX based tasks: ss7trace.......................................20 Loading tasks to TX boards: cplot .................................................................22 Viewing host driver statistics: txstats ............................................................23 Diagnosing TX boards: txdiag.......................................................................24 Generating a snapshot file: tx32snap and txsnap ............................................26

Generating a snapshot file for TX 3220/C boards: tx32snap...........................26 Generating a snapshot file for TX 4000/C boards: txsnap ..............................26

Analyzing host-CP shared memory: txdump ...................................................27 On-board diagnostic LEDs.........................................................................28

Debugging tasks: txdbg ..............................................................................29 Viewing completion code descriptions: txccode ...............................................29 Obtaining detailed board information: txinfo...................................................30

Chapter 5: Communications processor console utility: cpcon.......................33 Running cpcon ...........................................................................................33

cpcon procedure......................................................................................33 cpcon_ procedure ....................................................................................34

Command set overview...............................................................................35 [cmd] - Console task commands ..................................................................36 [con] - Standard commands ........................................................................37

[con] commands for TX 3220/C boards.......................................................37 [con] commands for TX 4000/C boards.......................................................44

[debug] - System debugger commands .........................................................47 [dec143] - Diagnostic interface to DEC 21143 (Ethernet) chip...........................48 [exc] - Exception handling commands ...........................................................48 [framer] - T1/E1/J1 $framer task information commands.................................49 [gpmem] - GPLIB memory diagnostic commands............................................50

[gpmem] commands for TX 3220/C boards .................................................50 [gpmem] commands for TX 4000/C boards .................................................50

[gt] - GT 64260 control commands ...............................................................51

Table of Contents TX Utilities Manual


[hbus] - Host bus interface commands ..........................................................51 [hbus] commands for TX 3220/C boards .....................................................51 [hbus] commands for TX 4000/C boards .....................................................51

[hdlc] - HDLC protocol control commands ......................................................52 [host] - Host-based tracking into TX memory .................................................52 [ipeth] - IP/Ethernet commands ...................................................................53 [led] - LED control commands......................................................................54

[led] commands for TX 3220/C boards .......................................................54 [led] commands for TX 4000/C boards .......................................................54

[mail] - Mailbox control commands ...............................................................54 [mem] - Memory control commands .............................................................55 [memtest] - Memory test and access functions...............................................55 [mpsc] - MPSC (GT 64260 serial interface) commands.....................................56 [mrg] - Memory region commands................................................................56 [mtp1] - MTP level 1 commands...................................................................56 [mv90] - MVIP common API function testing ..................................................57 [nobj] - Named object commands.................................................................57 [pool] - Pooled memory commands...............................................................57 [quadfalc] - Infineon QuadFALC T1/E1/J1 framer control..................................58 [remote] - Remote connection commands......................................................58 [ser] - Serial I/O pin tests ...........................................................................59 [slog] - System log commands.....................................................................59 [ss7] - SS7 level 1 driver commands.............................................................60 [swi] - H.100/H.110 and local stream switching control ...................................61 [sys] - System information commands ..........................................................62 [t1e1] - T1|E1|J1 control commands.............................................................62

[t1e1] commands for TX 3220/C boards .....................................................62 [t1e1] commands for TX 4000/C boards .....................................................63

[t81] - Diagnostic interface to T8100 chip ......................................................64 [t81] commands for TX 3220/C boards .......................................................64 [t81] commands for TX 4000/C boards .......................................................65 TDM pattern test commands .....................................................................66

[t81-low] - Low-level interface to T8100 chip .................................................68 [t81-low] commands for TX 3220/C boards .................................................68 [t81-low] commands for TX 4000/C boards .................................................69

[task] - Task control commands ...................................................................69 [tdm] - TDM configuration information commands ..........................................70 [timer] - Timer control commands ................................................................70 [vsock] - Virtual socket commands ...............................................................70


11 Introduction The TX Utilities Manual explains how to use the TX basic operation utilities to load and configure a TX board, and to diagnose hardware and software issues.

Note: Before using the TX utilities, ensure that the TX board, the Natural Access software, and the NMS SS7 software are properly installed. Refer to the appropriate installation manual for operating system specific details regarding installation.


22 TX utilities overview TX basic operation utilities

NMS SS7 provides the following TX basic operation utilities. Run these utilities from the \nms\tx\bin directory in Windows or from the /opt/nmstx/bin directory in UNIX.

Utility Description

cpcon Uses Natural Access to manage communication with the TX board. This utility is an operator console run from the command line. cpcon supports Hot Swap.

If you want to bypass the Natural Access environment, use the cpcon_ utility to manage communication with the TX board.

cplot Loads communications processor tasks to TX boards.

cpmodel Displays the board type for each installed TX board.

pcigetcfg Obtains bus and slot information during software installation (UNIX only).

tx32snap Generates a core dump of a TX 3220/C board, creating a snapshot file.

txalarm Uses Natural Access to display and optionally log alarm messages generated by NMS SS7 tasks running on all TX boards. txalarm supports Hot Swap.

If you want to bypass the Natural Access environment, use the txalarm_ utility to display and optionally log alarm messages.

txccode Displays a text description of a completion code (error code) reported by a TX board.

txcpcfg Assigns CP numbers to TX boards based on bus and slot.

txdbg Debugs a task running on a TX 3220/C board.

txdiag Provides diagnostic information about TX boards.

txdump Dumps the contents of the shared memory used for communication between the TX board and the host driver.

txeeprom Displays information stored in the EEPROM.

txflash Updates the TX board firmware.

txinfo Obtains detailed TX 4000/C board information.

txlocate Blinks the end bracket LEDs of a TX 4000/C board to physically locate the board in the chassis.

txreset Resets a TX board's firmware while showing the boot progress through the board's internal bank of diagnostic LEDs.

txsnap Generates a core dump of a TX 4000/C board, creating a snapshot file.

txstats Displays statistics maintained by the TX device driver.

TX utilities overview TX Utilities Manual


TDM utilities and demonstration programs

NMS SS7 provides the following utilities to configure TDM-based interfaces:

Use this utility... To...

tdmcfg Configure TDM based interfaces on TX 3220/C boards.

txconfig Configure TDM based interfaces on TX 4000/C boards. ss7load calls txconfig at board boot time.

Refer to the NMS SS7 Configuration Manual for information about these utilities.

NMS SS7 provides the following programs in compiled and uncompiled form to demonstrate the usage of the TDM libraries:

Program Demonstrates how to...

t1demo Use the T1/E1 and H.100/H.110 library functions and test the effect of the functions on other TX boards in a system.

t1stat Receive unsolicited T1/E1 status messages and performance reports.

txdynamic Dynamically switch SS7 links across TDM channels without rebooting the TX boards.

txsdemo Use the TX SWI library. Use this program as a starting point to control switching on a TX 4000/C board.

Refer to the TDM for SS7 Developer's Reference Manual for information about these demonstration programs.

TX Utilities Manual TX utilities overview


TX communications processor tasks

The following table lists the TX board task executables. The table includes the filename to download, where an extension of .elf specifies a TX 4000/C file and an extension of .lot specifies a TX 3220/C file. The table also includes the priority at which the task executes.

Several downloadable .lot tasks do not have .elf equivalents because the functionality is part of the TX 4000/C firmware.

File Name Priority Description

arp.lot arp 17 Runs the ARP protocol that enables two TX 3220/C boards to operate as a redundant pair.

Internal equivalent: $ipeth task.

debug.elf

debug.lot

debug 11 Low-level debugger.

diag3220.lot or console.lot

console 2 Diagnostic operator console task; works with the host-based cpcon utility. Enables you to view internal system operating parameters.

Internal equivalent: $console task.

etp.lot etp 14 Event tracer program. Enables tasks to write trace records to the computer hard drive.

Internal equivalent: $log task.

inf.lot inf 16 Alarm manager task. Writes alarms generated by protocol tasks to a log file.

Internal equivalent: $log task.

isup.elf

isup.lot

isup 20 SS7 ISUP task.

Stack size: 40960.

mtp.elf

mtp.lot

mtp 19 SS7 MTP layers 1 through 3.

Stack size: 12000.

mvip.lot mvip 4 MVIP configuration and control task.

Internal equivalent: $swi task.

sccp.elf

sccp.lot

sccp 21 SS7 SCCP task.

t1e1mgr.lot t1e1mgr 15 T1 and E1 configuration and control task.

Internal equivalent: $swi task.

tcap.elf

tcap.lot

tcap 23 SS7 TCAP task.

tup.elf

tup.lot

tup 22 SS7 TUP task.

txmon.elf

txmon.lot

txmon 18 TX health monitor task.


33 TX board management utilities Assigning CP numbers to TX boards: txcpcfg

Use txcpcfg to view all detected TX boards in a system and to assign a CP (communications processor) number to a board.

Viewing all detected boards

To view all detected TX boards, run txcpcfg with no parameters: txcpcfg

The following example shows a system with three TX boards where only two boards have assigned CP numbers: txcpcfg Bus Slot CP Number CP Model --- ---- --------- -------- 1 10 1 TX 4000 1 11 2 TX 3220 2 5 UNDEFINED TX 4000

Note: TX 3220 refers to either a TX 3220 board or a TX 3220C board. TX 4000 refers to either a TX 4000, TX 4000/20, TX 4000C, or TX 4000/20C board.

Assigning a CP number

To assign a CP number to a TX board at a given PCI bus and slot, enter the following command: txcpcfg bus slot boardnum

where:

Argument Description

bus Bus number of the board that you are configuring.

slot Slot number of the board that you are configuring.

boardnum CP number to assign to the board. Valid CP numbers start at 1 and must be unique. They do not have to be consecutive.

In a Windows system, any changes to the configuration information are automatically saved. In a UNIX system, you must save the configuration changes by editing the cpcfg file, located in /opt/nmstx/bin.

TX board management utilities TX Utilities Manual


Obtaining bus and slot information during software installation (UNIX only)

pcigetcfg is used under UNIX to display information for all TX boards detected on the PCI bus. pcigetcfg assigns a unique number to each detected TX board, starting from 0, and displays the following information for each device:

Field Description

NUMCNTLS Number of TX boards detected.

HWTYPEn Type of TX board (for board n).

SERIALn Serial number of the TX board (for board n).

CPIDn CP number assigned to the TX board (for board n).

BUSn Bus number of the board (for board n).

SLOTn Slot number of the board (for board n).

When the NMS SS7 software is installed, an installation script uses the bus and slot information provided by pcigetcfg to determine the entries to place in the cpcfg script executed at board boot time.

Note: The output of pcigetcfg is designed to assist the installation script rather than to provide well formatted screen output. Use txcpcfg instead of pcigetcfg to view the PCI bus and slot information for all detected TX boards.

TX Utilities Manual TX board management utilities


Viewing a list of installed TX boards: cpmodel

Use cpmodel to display a list of TX boards that are currently known to the system. Each board is listed with a CP (communications processor) number that is used by all other utilities to address a particular board.

Procedure

Run cpmodel according to the following syntax: cpmodel -b boardnum

where boardnum is a valid CP number. The default is 0, which lists all TX boards.

Description

The following example shows a system with four TX boards installed: cpmodel CPMODEL V3.0 Copyright 1998-2003, NMS Communications Board #1 is a TX 4000 Board #2 is a TX 4000 Board #3 is a TX 3220 Board #4 is a TX 3220

Note: The string TX 3220 refers to either a TX 3220 board or a TX 3220C board. The string TX 4000 refers to either a TX 4000, TX 4000/20, TX 4000C, or TX 4000/20C board.



Viewing EEPROM information: txeeprom

Use txeeprom to display the information stored in a TX board EEPROM. The information is determined at TX board manufacturing time and describes the hardware options available on the board. The board serial number is also recorded in the EEPROM.

Procedure

Run txeeprom according to the following syntax: txeeprom -c channelnum -b boardnum -t

where:


-c channelnum DPR channel to use. Default is 246.

-b boardnum Board number to which to attach. Default is 1.

-t Trace program. Default is no tracing.

Description

Most fields in the EEPROM display are static; they do not change from one TX board to another. The following table presents the configurable parameters set at TX board manufacturing time:

Field Description

Serial Number Unique serial number assigned to the TX board. Use this number to track the board.

Ethernet Address1

Ethernet MAC address assigned to the TX 3220/C board if it has an Ethernet LAN adapter.

NIC Addr n Ethernet MAC address assigned to each LAN adapter on TX 4000/C boards.

LAN Adapter

Local area network adapter on TX 3220/C boards. The following values can be returned:

Value Description

NONE No LAN adapter present

ETH Ethernet adapter present

TX 4000/C boards always include LAN adapters.

WAN Adapter

Wide area network adapter on TX 3220/C boards. The following values can be returned:

Value Description

NONE No WAN adapter present

DUAL T1 Dual T1 interface adapter present

DUAL E1 Dual E1 interface adapter present

QUAD V.35 Quad V.35 adapter present

TX 4000/C boards always include a configurable QUAD E1/T1/J1 WAN adapter.



The following example shows the txeeprom display for a TX 3220 or TX 3220C board: PartNumber: TX 3220 Revision: B Serial Number: 00000223 Manufacturer: NMS ROMLevel: A0 FLASHLevel: F0 Ethernet Address1: 0x0020.2220.0223 LAN Adapter: NONE Number of 360s: 4 WAN Adapter: DUAL E1 Layout Flags: NONE Checksum: 0x1E76

The following example shows the txeeprom display for a TX 4000 or TX 4000C board: Family: TX 4000 TestLevel: 0xC7A6 TestLevelRev: 0x01 SoftwareComp: 0x0 MFGYear: 2003 MFGWeek: 45 TETestBit: 0x00 SerialNum: 103437438 AssemblyLevel: 0xC75B AssemblyRev: 256 AssemblyYear: 2003 AssemblyWeek: 43 FlashSize: 2 MB NumEthernet: 2 CPUSpeed: 532 MHz L1ClockDiv: 0 NumTrunks: 4 NumSS7Links: 32 DRAMSize: 128 MB SRAMSize: 2 MB NIC Addr 1: 00:20:22:31:7B:40 NIC Addr 2: 00:20:22:31:7B:41 CPU2Speed: 300 MHz SDRAM2Size: 0 MB SRAM2Size: 64 KB Flash2Size: 0 MB



Updating the board flash memory: txflash

Use txflash to update the TX board firmware. txflash is called as part of a standard load of a TX board using the -s option to synchronize flash image versions. If the version of the kernel image stored on the TX board flash memory is not identical to the version currently installed on the host system, txflash upgrades the flash on the board before performing a reset of the board.

Procedure

Run txflash according to the following syntax: txflash -c channelnum -b boardnum -r readfile -w writefile -t -v -f filename -o -s

where:


-c channelnum

DPR channel to use. Default is 245.


-r readfile File name into which to read flash information. Default is txflash.bin.

Use -r ! to indicate not to read the flash.

-w writefile File name from which to write flash information. Default is not to write information to flash.

-t Trace progress of txflash. Default is no tracing.

-v Show version of kernel on flash. Default is not to show version.

-f filename Show version of kernel file. Default is not to show version.

-o Override version checking. Default is no override.

-s Synchronize flash version. Default is no synchronization.

Description

When a flash update is triggered for a TX 3220/C board, txflash displays the following information: Writing FLASH from cpk3220.bin to board 1... Triggering FLASH BURN... <Programming Flash> <Programming Flash> <Programming Flash> <Programming Flash> <Programming Flash> <Programming Flash> <Programming Flash> FLASH image successfully transferred to CP.



When a flash update is triggered for a TX 4000/C board, txflash displays the following information: Updating FLASH from cpk4000.fls to board 1... Sending image #1 to the board... Sending image #2 to the board... FLASH image successfully transferred to the CP. Triggering Flash BURN... <Erasing Flash> <Erasing Flash> <Erasing Flash> <Erasing Flash> <Erasing Flash> <Erasing Flash> <Erasing Flash> <Programming Flash> <Programming Flash> <Programming Flash> <Programming Flash> <Programming Flash> <Programming Flash> <Programming Flash> <Verifing Flash> FLASH image successfully burned.

After txflash copies a new flash image to the TX board, use txreset to reset the board to boot to the new flash image.

Resetting and rebooting from flash: txreset

Use txreset to reboot a TX board's firmware while showing the boot progress through the board's internal bank of diagnostic LEDs. After the board is reset, it is ready to accept downloads of TX-based tasks.

Procedure

Run txreset according to the following syntax: txreset -c channelnum -b boardnum

where:


-c channelnum DPR channel to use. Default is 244.


Note: You can also reset the board using ss7load. For information, see the NMS SS7 Configuration Manual.



Locating a TX board in a chassis: txlocate

Use txlocate to physically locate a TX 4000 or TX 4000C board in a chassis. Use this utility when:

• Making board cabling changes

• Debugging

• Hot swapping a TX 4000C board

txlocate blinks the end bracket LEDs of the specified board.

Procedure

Run txlocate according to the following syntax: txlocate -b boardnum -h holdtime -p passes

where:


-b boardnum Number of the board for which to blink the LEDs. Default is 1.

-h holdtime Number of milliseconds to hold the LEDs on and off for each toggle. Default is 1000 ms.

-p passes Number of times to toggle the LEDs on and off. Default is 3.

Description

When you run txlocate on a TX 4000 board, all end bracket LEDs blink for the specified holdtime and passes. When you run txlocate on a TX 4000C board, all end bracket LEDs except the green, yellow, and red status LEDs blink for the specified holdtime and passes.

For example, to blink the LEDs for TX board 1 for one minute, enter the following command: txlocate -b 1 -p 30

Note: TX 3220/C boards do not support txlocate. If txlocate is used on a TX 3220/C board, an error message displays.


44 Communications processor utilities

Receiving alarms from TX based tasks: txalarm

Use txalarm under Natural Access to display and optionally log alarm messages generated by NMS SS7 tasks running on all TX boards. txalarm supports Hot Swap.

If you want to bypass the Natural Access environment, use the txalarm_ utility to display and optionally log alarm messages.

Procedure

Run txalarm according to the following syntax: txalarm [-f filename]

where filename specifies the file to which alarms are copied.

Description

The following example is a sample txalarm message: <01/07/2004 16:17:04> mtp 1 18180 MTP3 Link 1 Down

Communications processor utilities TX Utilities Manual


Receiving data traces from TX based tasks: ss7trace

Use ss7trace when monitoring or troubleshooting SS7 signaling.

Purpose

Displays any debug data tracing that is turned on (through MTPMGR, ISUPMGR, or initial configuration) in the MTP or ISUP tasks. It does not accept commands; it only displays the tracing.

Using ss7trace

Enter the following command to start ss7trace: ss7trace

The utility returns the following information: Trace Monitor SS7 V3.8: Hit Enter to exit Copyright 2004, NMS Communications Corporation

Enabling packet tracing in the MTP and ISUP layers

Tracing must be enabled for the SS7 MTP layer, the ISUP layer, or both, to trace all data packets sent and received to the ss7trace utility. Use the following mtpmgr and isupmgr commands to enable and disable tracing:

Utility Command Description

trace on Enable MTP layer packet tracing on all configured links.

trace off Disable MTP layer packet tracing on all links.

link <n> tre Enable MTP layer packet tracing on a specific link.

mtpmgr

link <n> trd Disable MTP layer packet tracing on a specific link.

trace data on Enable ISUP layer packet tracing on all ISUP packets sent and received. isupmgr

trace data off Disable ISUP layer tracing.

Sample output

The following sample illustrates the output generated for a single packet received followed by a single packet transmitted when both MTP and ISUP layer tracing is enabled. Note that these are hexadecimal dumps of the actual packets sent and received, so familiarity with the detailed encodings of ISUP packets, MTP packets, or both is required to decode the trace data. The packets in this example were collected from an ANSI configuration; therefore, the packet contents (for example, the point code length in the routing label) for ITU or Japan protocol variants will be different. 14:46:36.0 MTP3.1 <-- : Link # 1 85 01 00 00 02 00 00 05 06 00 01 00 20 01 0A 03 ............ ... 06 0B 03 C0 90 A2 05 03 10 01 01 01 0A 05 03 10 ................ 04 22 04 00 00 ."... 14:46:36.0 ISUP.1 <-- 0.0.2: 06 00 01 00 20 01 0A 03 06 0B 03 C0 90 A2 05 03 .... ........... 10 01 01 01 0A 05 03 10 04 22 04 00 .........".. 14:46:36.0 ISUP.1 --> 0.0.2: 06 00 06 14 14 00 ...... 14:46:36.0 MTP3.1 --> : Link # 1 85 02 00 00 01 00 00 09 06 00 06 14 14 00 00 ...............

TX Utilities Manual Communications processor utilities


The heading for each message shows the time the packet is sent or received, the layer generating the trace, and the direction of the message ( --> transmitted packets, <-- received packets). The MTP heading also indicates the link number the packet is sent or received on. The ISUP header indicates the destination point code that the packet is sent to or received from.

The MTP packet trace contains the content of the packet starting with the service information octet (SIO), followed by the routing label (DPC, OPC, and SLS) and packet data.

The ISUP packet trace contains the ISUP portion of the packet being sent or received starting with the circuit identification code (CIC), followed by the message type and parameters.



Loading tasks to TX boards: cplot

Use cplot to dynamically load communications processor tasks to TX boards. Tasks must be compiled into the object files (*.lot files for TX 3220/C boards, *.elf files for TX 4000/C boards) before they can be loaded onto the communications processor.

Procedure

Run cplot according to the following syntax: cplot argument argument

where:


-a Automatically starts the communications processor task specified by the -n option. By default, the communications processor does not automatically start a download task.

This argument is valid only for tasks loaded to TX 3220/C boards. Tasks loaded to TX 4000/C boards always automatically start.

-b boardnum TX board number to which to load the task. The default is 1.

-f filename Object file for cplot to load. This argument is required. The file must be an SDSI-type object file (*.lot) for TX 3220/C boards, and an ELF object file (*.elf) for TX 4000/C boards.

-g tdm Load TDM configuration file output (tdm) from tdmcfg. When the –g tdm option is specified, the –f option specifies the tdmcfg binary file to be loaded to the board.

Valid only for tasks loaded to TX 3220/C boards.

-l cmd_line Command line string enclosed in double quotes.

Valid only for tasks loaded to TX 4000/C boards.

-n taskname Communications processor task to load. When used with the -f option, cplot requests a communications processor task to be created with the given task name. The program object file is then loaded as the program for the new communications processor task. This argument is required. The task name can have a maximum of eight characters.

-o options Options to use when executing the communications processor task. options is task specific and can use hexadecimal notation by prepending the entry with 0x. Default is 0.

-p priority Priority of the communications processor task. Valid priority levels are 0 through 31, with 0 being the highest priority and 31 being the lowest priority. By default, the created communications processor task has a priority of 30.

-s size Stack size of the communications processor task. By default, the communications processor task stack size is 4096 bytes. Hexadecimal notation can be used by prepending a 0x.

-t tracelevel Level of tracing information displayed by cplot while downloading a task. The default is 0 (no tracing).

-v Version and build date of a downloadable task (.elf or .lot file).



Viewing host driver statistics: txstats

Use txstats to view statistics maintained by the TX driver for a particular board or for all known boards. This information is used when analyzing data flow problems between the host and the TX board.

Procedure

Run txstats according to the following syntax: txstats -b boardnum -a appchan -d drvchan -p period -m statname -x maxvalue -o options -l -z -q

where:


-b boardnum TX board number or 0 to view all board statistics.

-a appchan CPI channel held by an application. Default is 0 (not applicable).

-d drvchan CPI channel used to access the driver. Default is 254.

-p period Interval (in ms) between periodic statistics requests.

-m statname Monitors statistics in histogram format. Use –m ? to view a list of available statistics.

-x maxvalue Maximum value for -m display range.

-o options Specifies options directly. See txstats.h for details.

-l Displays layer-specific statistics extension. Default is view common statistics.

-z Zeros statistics after displaying current values.

-q Does not display statistics as part of operations.



Diagnosing TX boards: txdiag

Use txdiag to perform board level diagnostic tests on any TX board and to test communications between the host driver and the board.

Caution: Running txdiag terminates any functions that are still executing. After running txdiag, reload the TX board to return it to a normal state.

Procedure

Run txdiag according to the following syntax: txdiag -b boardnum -c channelnum -a -f filename -h testname

where:


-b boardnum TX board number to diagnose. Default is 1.

-c channelnum DPR channel number. Default is 249.

-a Performs tests on all boards.

-f filename Reads parameter values from this text file.

-h Shows usage.

testname Diagnostic test to perform. Default is ALL.

txdiag diagnostic tests

You can run the following txdiag diagnostic tests:

Run this test...

To...

MEMSWEEP Verify that the SDRAM memory space can be accessed.

SPACCESS Verify that the scratch pad registers can be accessed.

INTR Verify that the host and CP can generate and receive interrupts.

NMI Verify that the host is able to assert the non-maskable interrupt.

READLED Read the current status of LEDs.

MEMSP Verify that the SDRAM can be accessed with scratch pad registers. Use if MEMSWEEP fails.

ALL Execute all tests except MEMSP in the order shown in this table.

When you specify ALL, txdiag performs each test regardless of the results of the previous test. Examine the results of each test individually to verify its success or failure before assuming that all tests successfully executed.



Description

The following example shows output from txdiag when the -b argument is used: > txdiag -b 1 TXDIAG V1.0: Copyright 2000-2001, NMS Communications CP 1:MEMORY SWEEP TEST- Starting test... CP 1:MEMORY SWEEP TEST- Successfully executed CP 1:SP ACCESS TEST- Starting test... CP 1:SP ACCESS TEST- Successfully executed CP 1:INTERRUPT VERIFICATION TEST- Starting test... CP 1:INTERRUPT VERIFICATION TEST- Successfully executed CP 1:NMI VERIFICATION TEST- Starting test... CP 1:NMI VERIFICATION TEST- Successfully executed CP 1:READ LED - Starting test... CP 1:READ LED - RED status LEDs: $02 CP 1:READ LED - GREEN status LEDs: $00 CP 1:READ LED - RED boot LEDs: $00 CP 1:READ LED - GREEN boot LEDs: $FF CP 1:READ LED - Successfully executed



Generating a snapshot file: tx32snap and txsnap

Take a snapshot of the board to diagnose some TX-based problems. A snapshot file contains an image of the board memory space. Use a snapshot to view the system as it was at the time the snapshot was taken. By default, the snapshot file is created in the current directory and is named cpsnap.dmp.

This topic presents:

• Generating a snapshot file for TX 3220/C boards: tx32snap

• Generating a snapshot file for TX 4000/C boards: txsnap

Generating a snapshot file for TX 3220/C boards: tx32snap

To generate a snapshot file for TX 3220/C boards, run tx32snap according to the following syntax: tx32snap -b boardnum -p -r -f filename

where:


-b boardnum TX board number for which to generate a snapshot file. Default is 1.

-p Snaps only PCI-mapped memory.

-r Creates a raw memory snapshot file without headers.

-f filename File to which to write the TX board information. Default is cpsnap.dmp.

tx32snap is generally run with the -b argument only.

Generating a snapshot file for TX 4000/C boards: txsnap

To generate a snapshot file for TX 4000/C boards, run txsnap according to the following syntax: txsnap -b boardnum -p -r -f filename

where:


-b boardnum TX board number for which to generate a snapshot file. Default is 1.

-p Snaps only PCI-mapped memory.

-r Creates a raw memory snapshot file without headers.

-f filename File to which to write the TX board information. Default is cpsnap.dmp.

txsnap is generally run with the -b argument only. Because the resulting snapshot file is greater than 128 Mb, zip the snapshot file before transferring it.



Analyzing host-CP shared memory: txdump

Use txdump to dump a hexadecimal/ASCII display of the shared memory used by the host driver to communicate with the TX board.

Procedure

Run txdump according to the following syntax: txdump-c channelnum -b boardnum -o offset -l bytelength -s

where:


-c channelnum

DPR channel number. Default is 247.

-b boardnum Board number to dump. Default is 1.

-o offset Offset from which to dump. Default is 0.

-l bytelength Byte length to dump. Default is 2048.

-s Dump status registers. Also shows the current values of the on-board diagnostic LEDs. An asterisk (*) indicates that an LED is ON and a dash (-) indicates that an LED is OFF. See On-board diagnostic LEDs on page 28.

Description

The following example shows txdump when the -s argument is used: >txdump -s TX Memory Dump Utility V3.0 Copyright 1997-2003, NMS Communications CP #1 Status / Control Register Set: Serial Number: 223 CP Number: 1 DIAG LEDs: [B:*] [H:*] [T:-] [L:-] [P:-] [r:-] [t:-] [F:-] Status Register [0]: $000000DF Status Register [1]: $0000D801 Status Register [2]: $00000000 Status Register [3]: $00000023 Status Register [4]: $11881188 Status Register [5]: $00000021 Status Register [6]: $00000000 Status Register [7]: $00000000

The example shows that diagnostic LEDs B and H are on, and that all other LEDs are off.



On-board diagnostic LEDs

The following table describes the LEDs that display when the -s option is used:

LED letter

TX board types

Description

B TX 3220/C Board successfully booted.

H All TX boards Idle task-controlled heartbeat. Toggles unless the TX board is at 100% utilization.

T All TX boards Timer interrupt-controlled heartbeat. Toggles to indicate that timer interrupts are being serviced.

L All TX boards Log error detected by kernel. Use cpcon log command to view information stored in the board log.

P All TX boards Error in communication over PCI bus with host driver.

r N/A Not used.

t N/A Not used.

F All TX boards Memory full condition occurred.

S TX 4000/C Snapshot requested, placing board in non-maskable interrupt service routine.

X TX 4000/C Unexpected exception occurred.



Debugging tasks: txdbg

Use txdbg to debug tasks running on TX 3220/C boards. Run txdbg according to the following syntax: txdbg -f config_filename

where:


-f config_filename

A configuration file name. Default is txdbg.cfg. A sample txdbg.cfg is provided in the NMS SS7 installation.

To debug tasks running on TX 4000/C boards, run the communications processor console utility, cpcon, and enter [debug] to view all debugging commands.

Viewing completion code descriptions: txccode

Use txccode for a description of a completion code (error code) reported by a TX board.

Run txccode according to the following syntax: txccode ccode

where:


ccode Completion code to be described. Valid values:

a = display all current error codes l = display TX 3220/C error codes

When specifying a particular error code, begin the code with 0x to indicate a hexadecimal error code (otherwise decimal is assumed).

Description

The following example shows output of txccode: > txccode 0xE000010 Error Code: 0xE000010 (SCCSWI_INVALID_TIMESLOT) - invalid timeslot provided



Obtaining detailed board information: txinfo

Use txinfo to obtain detailed TX 4000/C board information.

Run txinfo according to the following syntax: txinfo -b boardnum

where:


-b boardnum TX board number from which to obtain information. Default is 1.

Description

txinfo issues a request for system information to the manager task executing as part of the TX firmware. The manager task responds to the request by providing a copy of its system information block. Upon receipt of the system information, txinfo displays select information.

The system information structure is defined in the cosinfo.h include file.

The following example shows sample output from txinfo: --------------------------------- TX board 1 System Information: --------------------------------- UTIL: idle_count: 11454, idle_peak: 39545288 TIME: boot_msecs: 32317, epoch_secs: 1081789483 12/4/2004 17:5:15 (+317 msecs) CPU: idle_delay: 8388608, extraneous_int: 0 GEN: cpnum: 1, sys_id: TX 4000 (serial number 4102011234) sdram_size: 128, num_ss7_links: 32, eth_count: 2 KERN: kernel_ver: 10, kernel_rev: 0 FLASH: size: 4096, symtab_addr: 0xFFCB36BC, symsize: 56184 EEPROM: NMS SerialNum: 4102011234, CPUSpeed: 532 NumTrunks: 4, NumSS7Links: 32, SDRAMSize: 128, SRAMSize: 2 LAYOUT: pci: 0x1, networks: 4, ls_framers: 0x4 CLOCKS: intern_osc: 16384000, netref_freq: 8000, main_fsc: 0, netref_fsc: 0 network clock (trunk 1): sig_dir = OUTPUT, speed = 1.544 MHz network clock (trunk 2): sig_dir = OUTPUT, speed = 1.544 MHz network clock (trunk 3): sig_dir = OUTPUT, speed = 1.544 MHz network clock (trunk 4): sig_dir = OUTPUT, speed = 1.544 MHz System information consists of the following information:

Section Description Fields

UTIL System utilization area. Used for computing TX processor load.

idle_count = Counter maintained by $idle task (for computing CPU utilization).

idle_peak = Peak value that idle_count has ever reached.

TIME Time handing area (the time since the TX board was booted and the current time of day).

boot_msecs = Number of milliseconds since boot.

epoch_secs = Number of seconds since epoch.

systime = System time in timestamp format.

CPU TX board processor (CPU) description.

idle_delay = Delay to approximately .5 seconds of counting.

extraneous_int = Count of extraneous interrupts.



Section Description Fields

GEN General system-level information, including the specific TX board type and serial number.

cpnum = CP number.

sys_id = Specific type of TX board identifier.

sdram_size = Size of SDRAM in megabytes.

num_ss7_links = Number of SS7 links.

eth_count = Number of Ethernet interfaces on the board.

KERN Kernel (TX operating system) information, including the version or revision of the TX operating system.

kernel_ver = Kernel version.

kernel_rev = Kernel revision.

FLASH TX board flash contents information.

size = Flash size in KB.

symtab_addr = Address of kernel symbol table in flash.

symsize = Size of kernel symbol table.

EEPROM Information stored in the TX board EEPROM.

NMS SerialNum = Serial number.

CPUSpeed = CPU speed in MHz.

NumTrunks = Number of T1/E1 trunks.

NumSS7Links = Number of SS7 links supported.

SDRAMSize = Size of SDRAM in MB.

SRAMSize = Size of SRAM in MB.

LAYOUT TX board hardware layout information.

pci = PCI type information flags (CompactPCI or PCI, and whether or not a rear I/O is present (CompactPCI only)).

networks = Number of network (T1/E1) interfaces.

ls_framers = Mask indicating local streams that map to framers.

CLOCKS TX board system-level TDM clocking control information.

intern_osc = Internal oscillator frequency (in Hz).

netref_freq = Frequency (in Hz) of NETREF signals, when known.

main_fsc = Network number providing 8 kHz frame synchronization.

netref_fsc = Network number providing 8 kHz frame synchronization.

signal = Direction and speed for all clocking signals.

Note: txinfo is also provided as a sample application to easily obtain information such as the specific TX board type, the TX board serial number, and the number of available SS7 links. The sample application uses the CPI library functions cpi_mgr_msg and cpi_mgr_rx. See the CPI Library Developer's Reference Manual for a detailed description of these functions.


55 Communications processor console utility: cpcon

Running cpcon

Use cpcon under Natural Access to manage communication with the TX board. This utility is an operator console run from the command line. cpcon supports Hot Swap.

To bypass the Natural Access environment, use cpcon_ to manage communication with the TX board.

cpcon command sets enables you to monitor and control different aspects of a TX board. For more information, see Command set overview on page 35.

cpcon procedure

Complete the following steps to run cpcon:

Step Action

1

Start cpcon by entering the following command at the prompt:

cpcon -b boardnum -c channelnum

where:


-b boardnum TX board number. Valid values are 1 through 16. The default is 1.

-c channelnum DPR channel number. The default is 144.

2 Specify a command set by entering the command set name enclosed in square brackets. Use the [?] command to view all command sets.

The cpcon prompt returns the TX board number (or communications processor number) and the currently selected command set. For example:

(1) [hbus] >

3 Use the ? command to view all commands in the current command set.

4 To change to a different board number, exit the program and run cpcon again with a different board number.

Communications processor console utility: cpcon TX Utilities Manual


cpcon_ procedure

Complete the following steps to run cpcon_:

Step Action

1

Start cpcon_ by entering the following command at the prompt:

cpcon_ -b boardnum -c channelnum - p portnum -v -m where:


-b boardnum TX board number. Valid values are 1 through 16. The default is 1.

-c channelnum DPR channel number. The default is 144.

-p portnum Sets the board port number to pass requests to. The default is 6.

-v Activates verbose tracing during board initialization.

-m Stops output when a full screen of information displays.

2 Specify a command set by entering the command set name enclosed in square brackets. Use the [?] command to view all command sets.

The cpcon_ prompt returns the TX board number (or communications processor number) and the currently selected command set. For example:

(1) [hbus] >

3 Use the ? command to view all commands in the current command set.

4 To change to a different board number, use the command cp boardnum, where boardnum is a valid TX board number. Use the cp ? command to determine the board number currently in use.

TX Utilities Manual Communications processor console utility: cpcon


Command set overview

The cpcon command sets monitor and control different aspects of a TX board. After starting cpcon, select a command set by entering the command set name enclosed in square brackets.

Use the [?] command (with brackets) to view all command sets. Use the ? command (without brackets) to view all commands in the current command set.

The following table describes the cpcon command sets:

Command set

Description

[cmd] Console task commands for TX 4000/C boards.

[con] Standard operator console commands.

[debug] System debugger for TX 4000/C boards. To use [debug], download the debug task (debug.elf) to the board. By default, debug.elf is commented out in the ss7load script. Uncomment the line and run ss7load to boot the board and download the task.

[dec143] IP over Ethernet commands for TX 3220/C boards.

[exc] Exception information commands for TX 3220/C boards.

[framer] T1/E1/J1 $framer task information commands for TX 4000/C boards.

[gpmem] GPLIB memory diagnostic commands.

[gt] GT 64260 controller commands for TX 4000/C boards.

[hbus] Host bus interface commands.

[hdlc] HDLC protocol control commands for TX 4000/C boards. Available only when the board is booted in hardware test mode. For more information, see the board installation manual.

[host] Host-based tracking into TX memory for TX 3220/C boards.

[ipeth] IP over Ethernet commands for TX 4000/C boards.

[led] LED control commands.

[mail] Mailbox communication commands for TX 4000/C boards.

[mem] Memory control commands for TX 3220/C boards.

[memtest] Memory test and access functions for TX 3220/C boards.

[mpsc] MPSC (GT 64260 serial interface) commands for TX 4000/C boards.

[mrg] Memory region commands for TX 4000/C boards.

[mtp1] MTP 1 (SS7 level 1) commands for TX 4000/C boards.

[mv90] MVIP common API function testing for TX 3220/C boards.

[nobj] Named object commands for TX 4000/C boards.

[pool] Pooled memory commands for TX 3220/C boards.

[quadfalc] Infineon QuadFalc T1/E1/J1 framer control for TX 4000/C boards.

[remote] Remote connection commands for TX 3220/C boards.

[ser] Serial I/O pin tests for TX 3220/C boards.



Command set

Description

[slog] System log commands for TX 4000/C boards.

[ss7] SS7 level 1 driver commands for TX 3220/C boards.

[swi] H.100/H.110 and local stream switching control for TX 4000/C boards.

[sys] System information commands.

[t1e1] T1/E1/J1 control commands.

[t81] Diagnostic interface to the T8100 (H.100/H.110) chip.

[t81-low] Low-level interface to the T8100 (H.100/H.110) chip.

[task] Task control commands.

[tdm] TDM configuration commands for TX 3220/C boards.

[timer] Timer control commands for TX 4000/C boards.

[vsock] Virtual socket commands for TX 4000/C boards.

[cmd] - Console task commands

Use [cmd] commands to perform basic TX 4000/C operations through the operator console task. The following table lists the [cmd] commands:

[cmd] commands Description

case Toggles whether or not the command parser is case-sensitive.

change Changes the value of a byte of memory.

dump Displays a hex/ASCII dump of the specified address (256 bytes shown).

log Displays all entries in the kernel error log.

outlines Displays the number of output lines specified.

setinfo Displays command set information.

snap Toggles between snapshot mode and normal mode.



[con] - Standard commands


• [con] commands for TX 3220/C boards

• [con] commands for TX 4000/C boards

[con] commands for TX 3220/C boards

[con] commands Description

date Provides current date (as viewed by the CP).

dpr Provides information about the dual port RAM interface, including:

• Size Errors: Error counts related to the size of transfers.

• PCI Context: Address of PCI control context.

• HBUS Context: Address of host bus control context.

• Flags: PCI-related control flags.

• Dec/QSpan CSR: Mapped memory addresses of status registers.

• FIFOs: Address of memory area for com FIFOs.

• PCIMem: Address of memory space shared over PCI bus.

• Head/Tail: Current head and tail values for the inbound and outbound free and post lists.

• Msg Statistics: Breakdown of all PCI traffic by message type.

dump Displays hex/ASCII dump of the specified memory address (256 bytes display).

eth Provides Ethernet information, including:

• Context: Address of Ethernet control context.

• Adp#: Ethernet adapter number (1-based).

• Ethernet Addr: Ethernet MAC address.

• Mode: Operating mode (10BT or 100BT).

• Duplex: Duplex mode (FULL or HALF).

• State: Overall state of Ethernet interface.

• Statistics: Breakdown of level-1 Ethernet statistics.

• Packet Rates: Current and average pkt/sec rates.

help Displays the full command set or details for a specified command name.




if Lists all currently defined interfaces. Information includes:

• Res#: Resource number associated with the interface.

• HW: Hardware type for given interface. Possible values are:

• DPR: Dual port RAM interface.

• PCI: Host bus interface (PCI).

• SCC: Serial communications controller.

• ETH: Ethernet controller.

• QCH: QUICC32 channel.

• SFT: Software interface (no physical hardware).

• Type: Type of usage. Possible values are:

• SER: Serial.

• ETH: Ethernet.

• TDM: Time division multiplexed.

• Port: Physical port number associated with the interface.

• Max Tx: Maximum number of pending transmits.

kernel Provides information from the main kernel control structure. Information includes:

• Context: Memory address of kernel context block.

• Unused RGDs: Number of region descriptors.

• Shift: Number of bits shifts to compute region size.

• Current: Information about the current task.

• Memory: Information about total system memory.

• Msg: Message handing key and message errors.

• Tcb: Task control block key and errors.

• Tmr: Timer control key and queuing errors.

• Levels: Exceptions and critical code errors.

• Semaphore: Saved SR (due to critical code) and state of DMA semaphore.

• Sys info: Memory address of the system information block.

• Idle peak: Counter used for determining CPU utilization.

• Vector Table: Address of exception vector table.

lfd Lists all open files (logical file descriptors). Information includes:

• Name: Unique name identifying the file.

• State: Either pending (open is not complete) or live.

• Task: Name of the task that owns the file (issued the open).

• IAddr: Internal address associated with the open.

• Server: Name of the task that serviced the open.

• IO Outst: Count of I/O requests issued by owner and not yet responded to.

• Status: CLOSING indicates that a close was issued. CLOSED indicates that the server responded to a close request.


mem Displays total amount of memory in use and available.




memreg Provides assignments for all memory regions, including:

• Owner: Name of task owning the memory region. *KERNEL if no task.

• Name: Name of memory region (or address if not named).

• Start: Starting memory address of region.

• End: Address of last byte in memory region.

• Size: Total number of bytes in region.

• Access: Memory access flags.

mvip Lists all current MVIP stream/timeslot assignments. Information includes:

• Status/Map: Status of FMIC and frame B value.

• Clocking: Clock source for master, Sec8K, and T1/E1.

• Current FMIC Map: Output destination where connection is directed (MVIP or LOCAL stream/timeslot).

• Stream: MVIP stream number (output and source).

• TS: MVIP timeslot number (output and source).

• Pat: Pattern being generated when in pattern mode.

• Mode: FMIC mode for connection (NORMAL, PATTERN, or REVERSE).

• Conn: One of the following connection indications:

• <--> Full duplex. Connect points to each other.

• <--- Connect points to entry with NULL connection.

• ---- Connect of NULL when Mode = PATTERN.

• !!!! Connect of NULL when Mode != PATTERN.

• ???? Connect points to entry without connect back.

names Displays all named objects defined in the system, including:

• Type: Type of named object.

• Name: ASCII name of object.

• Pointer: Pointer associated with object.

• ID: Associated object identifier.

pmem Displays percentage of memory assigned to each task.

q32 Provides information about each 360 operating in QUICC32 mode (not used with SS7 protocols). Information includes:

• 360 #: Number identifying the 360 that is in QUICC32 mode (0 = MAIN).

• context: Memory address of context block controlling QUICC32.

• IMPBASE: Base address of QUICC32 360 chip.

• Level 1: Level 1 driver context block assigned to each QUICC32 channel.

• ctrlbase: Control base address for SCC3 and SCC4 (channels split between).

• prbase: Parameter ram base address (SCC3 and SCC4).




qprio Lists all priority message queues for the specified task. Information includes:

• Num: Number of priority queue. 0 = lowest; 7 = highest.

• Priority: Name indicating priority level of message queue.

• Head: Message on the head of the given priority queue.

• Tail: Message on the tail of the given priority queue.

• Count: Total number of messages on the priority queue.

• Peak: Maximum messages that have been on the queue.

• Max: Maximum allowed messages. 0 = no maximum.

• OFlow: Messages dropped due to queue overflow.

• Total: Total number of times message written to queue.

ques Lists priority queues (tasks waiting to execute).

res Lists all currently defined resources. Information includes:

• Res #: Physical resource number.

• HW: Hardware type indicator Possible values are:







• Type: Type of usage for hardware.

• Port: Low-level hardware port number.

• Lvl1 Key: Level 1 driver key.

• Protocol: Type of messaging protocol in use.

• Vports: Number of virtual ports attached to resource.

• TxQued: Number of transmits queued to resource.

• TxPost: Number of transmits currently posted.

• Users: Number of users registered with resource.

• Rx Drops: Number of received packets not routed.

resdet Lists detailed resource display functions.




scc Lists information for each serial communications controller, including:

• Type: Serial communications controller (SCC) usage. Possible values:

• SCC: Physical SCC port (POD port).

• ETH: Physical Ethernet port.

• MVIP: MVIP bus connection.

• Chl #: Channel number associated with the serial communications controller.

• SCC #: Physical serial communications controller number of the processor indicated.

• IMPBase: Memory address of base of serial communications controller processor.

• CTLBase: Control base address for serial communications controller.

• PRamBase: Parameter RAM base address for serial communications controller.

• Tx/Rx: Average (over the last 10 seconds) transmit and receive packet counts.

t1cfg Displays T1/E1 configuration. Information includes:

• Framing: Type of framing (T1 or E1) in use. Possible values are:

• D4: D4 (193S) framing (T1).

• ESF: Extended superframe format (T1).

• CCS: Common channel signaling (E1).

• CAS: Channel associated signaling (E1).

• CCS/CRC: CCS with CRC4 (E1).

• CAS/CRC: CAS with CRC4 (E1).

• Encoding: Type of encoding (T1 or E1) in use. Possible values are:

• NONE: No encoding.

• AMI: AMI encoding with no zero suppression.

• B7ZS: Bit 7 stuffing (T1).

• B8ZS: Bipolar eight zero substitution (T1).

• HDB3: High density bipolar order 3 (E1).

• Build Out: Measure of build out. T1 in feet, E1 as ohm description.

• Robbed Bit: (T1 only) Either blank (not active) or robbed bit.

• Loop Master: Either blank (not master) or loop master.

t1stat Displays T1/E1 statistics information.




tasks Displays all created tasks. Information includes:

• Name: Name of the given task. A leading \$\ indicates kernel task.

• Prior: Priority of task. 1 = highest priority. 31 = lowest.

• State: Current state of task. Valid states include:

• Created: Task was created but never executed.

• Stalled: Kernel detected invalid instruction (usually breakpoint during debug session).

• Waiting: Task is asleep and waiting for work.

• Blocked: Higher priority task currently blocking.

• Running: Task is executing.

• Holding: Invalid kernel service requested.

• Ready: Task is ready to be executed.

• Msgs: Number of messages queued to task.

• Peak: Maximum number of messages ever queued to task.

• Ovfl: Messages dropped due to queue overflow.

• Total: Total number of messages processed by task.

• TCB Addr: Task control block address.

• Stk Depth: Maximum stack depth used by task.

time Provides current time (as viewed by the CP).

timers Displays all timers on the system, including:

• Owner: Name of task that created the timer.

• Name: Address of timer control block.

• Period: Number of milliseconds between timer ticks.

• Init: Initial number of milliseconds waited.

• Value: Number of milliseconds remaining before timer fires.

• User Key: Key provided by the application.

• User Pkt: Timer control packet provided by user.

• Status: Current status of timer (running or stopped).

• Granularity: Tick interval used to advance timers.

tmem Provides all memory regions assigned to the specified task, including:

• Owner: Name of task. *KERNEL if no task is specified.

• Name: Name of memory region or address if not named.




• Access: Memory access flag.

util Provides current and average system utilization.




vol Lists all volumes (mounted tasks, I/O accessible). Information includes:

• Name: Name of the mounted volume.

• Devtype: Device type used on the mount.

• Task: Name of the task that has been mounted. Mount Pending indicates that the mount is not complete.

vport Provides detailed information for the specified virtual port, including:

• Vport: Virtual port number.

• Owner: Task attached to virtual port.

• AtchKey: Task-supplied key associated with the attach.

• Addr1..4: Receive addresses associated with port (up to 4, all Fs = ALL).

• FrmSize: Maximum receive frame size.

• State: Current state of the virtual port. Possible values are:

• FREE: No task attached to virtual port.

• DISABLED: Task attached but virtual port not enabled.

• IDLE: Virtual port enabled but not transmitting.

• FULL: Transmitting all allowed for transmit window.

• DISABLING: Bringing down an enabled virtual port.

• Free/Pend: Number of transmit requests available (free) and in progress (pend).

• Tx/Rx Stats: Counts of frames/bytes transmitted and received.

• Tx / Rx Fails: Counts of Tx and Rx failures with last error code reported.

• Rx Pri0: Mapping of priority queue selected based on Rx packet priority

• Resource: Resource number to which to attach the virtual port.

• HW: Hardware interface. Possible values are:







• Type: Type of hardware interface.

• Port: Low-level hardware port number.

• Lvl1 Key: Level 1 driver key.

• Protocol: Type of messaging protocol in use.




vports Lists all currently defined virtual ports. Information includes:

• Vport: Virtual port number.

• ..Vport: Top of virtual port range when range is in use.

• Owner: Task that owns virtual port (or NONE).

• HW: Type of hardware virtual port interface. Possible values are:







[con] commands for TX 4000/C boards


avail Shows the total amount of memory in use and available.

change Changes the value of a byte of memory.

channels Lists all defined TDM channels.

dump Displays a hex/ASCII dump of the specified memory address (256 bytes display).

frcfg Displays the configuration of each framer trunk (T1/E1/J1).

frstats Displays statistics for each framer trunk (T1/E1/J1).

frstatus Displays the status of each framer trunk (T1/E1/J1).


mem Displays total amount of memory in use and available.

names Displays all named objects defined in the system, including:

• Type: Type of named object.

• Name: ASCII name of object.

• Pointer: Pointer associated with object.

• ID: Associated object identifier.

pmem Displays percentage of memory assigned to each task.

pools Displays all memory pools on the system, including:

• Pool Name: Name describing the purpose of the memory pool.

• Free: Number of buffers assigned to the pool but not currently allocated.

• State: Memory depletion state (for limited pools).

• Curr: Number of buffers currently allocated from the pool.

• Max: Maximum number of buffers ever allocated (maximum value of Curr).

• Total: Total number of buffer allocations made using the pool.

• Failed: Number of times an allocation attempt from the pool failed.




ress Displays summary information for all resources, including:

• Res Type: Type of resource identifier.

• Name: Name of the resource.

• TX Frames: Total number of packets transmitted over the resource.

• TX Fails: Total number of failed transmit attempts over the resource.

• RX Frames: Total number of packets received over the resource.

• RX Drops: Total number of receive indications that the resource dropped.

• Last Error: Error code identifying the reason for the last error the resource detected.

• MaxTX Time: Maximum number of milliseconds that the resource held a transmit packet.

• MaxRX Time: Maximum number of milliseconds that the resource held a receive packet.

task Displays detailed information about the given task.

tasks Displays all created tasks. Information includes:

• Name: Name of the given task. A leading \$\ indicates kernel task.

• Prior: Priority of task. 1 = highest priority. 31 = lowest.

• State: Current state of task. Valid states include:

• Created: Task was created but never executed.

• Stalled: Kernel detected invalid instruction (usually breakpoint during debug session).

• Waiting: Task is asleep and waiting for work.

• Blocked: Higher priority task currently blocking.

• Running: Task is executing.

• Holding: Invalid kernel service requested.

• Msgs: Number of messages queued to task.

• Peak: Maximum number of messages ever queued to task.

• Ovfl: Messages dropped due to queue overflow.

• Total: Total number of messages processed by task.

• TCB Addr: Task control block address.

• Stk Depth: Maximum stack depth used by task.

• Cmd Opts: Command options provided to task.

time Provides current date and time (as viewed by the communications processor).




timers Displays all timers on the system, including:

• Owner: Name of task that created the timer.

• Name: Address of timer control block.

• Period: Number of milliseconds between timer ticks.

• Init: Initial number of milliseconds waited.

• Value: Number of milliseconds remaining before timer fires.

• User Key: Key provided by the application.

• User Pkt: Timer control packet provided by user.

• Status: Current status of timer (running or stopped).

• Granularity: The tick interval used to advance timers.

tmem Provides all memory regions assigned to the specified task, including:

• Owner: Name of task. *KERNEL if no task is specified.

• Name: Name of memory region or address if not named.




• Access: Memory access flag.

usage Shows limited pool memory usage.

util Provides current and average system utilization.

vsocks Displays summary information for all VSOCKs, including:

• VSOCK Address: Memory address for the VSOCK control context.

• Owner: Name of the task that owns the VSOCK.

• Res Type: Type of resource to which VSOCK is attached.

• TX Pnd: Count of the currently pending transmits over the VSOCK.

• TX Frames: Total number of packets transmitted over the VSOCK.

• TX Fails: Total number of failed transmit attempts over the VSOCK.

• RX Frames: Total number of packets received over the VSOCK.

• RX Fails: Total number of receive indications with errors detected.

• Last Error: Error code identifying the reason for the last error that VSOCK detected.

• MaxTX Time: Maximum number of milliseconds to TX over the VSOCK.

• MaxRX Time: Maximum number of milliseconds for any RX over the VSOCK.



[debug] - System debugger commands

Use [debug] commands to debug a TX 4000/C-based task. To use [debug], download the debug task (debug.elf) to the board. By default, debug.elf is commented out in the ss7load script. Uncomment the line and run the modified ss7load to boot the board and download the task.

The following table lists the [debug] commands:

[debug] commands Description

asm Displays area indicated as PowerPC ASM instructions.

break Sets a breakpoint at the indicated symbol location or address.

breaks Lists all of the currently defined breakpoints for the selected task.

clear Removes a breakpoint at the indicated symbol location or address.

clearall Removes all breakpoints for a particular task.

clrmon Clears the selected area for monitoring.

dstack Dumps the stack of the currently selected task as raw hexadecimal data.

info Displays information about the debug session.

kdstack Dumps the kernel stack as raw hexadecimal data.

kregs Displays the kernel registers.

kstack Dumps the kernel call stack.

ksym Displays kernel symbol information.

mon Monitors the indicated area for changes.

regs Displays registers for the currently selected task or live registers.

regset Sets the given register to the specified value.

run Runs the currently selected task.

stack Dumps the selected task call stack.

s Steps through the currently selected task (default is step over).

si Steps into every instruction.

stop Stops the currently selected task.

sym Displays symbol information (name, address).

symset Sets the value of memory at the symbol location indicated.

symshow Displays the value of memory at the symbol location indicated.

task Sets the current debug task.

Note: Use the [exc] command set for TX 3220/C boards.



[dec143] - Diagnostic interface to DEC 21143 (Ethernet) chip

DEC 21143 is the Ethernet chip used on TX 3220/C boards. The [dec143] command set provides a direct interface to the Ethernet control module. Use these commands when diagnosing Ethernet communication problems between a TX board and its redundant mate. The following table lists the [dec143] commands:

[dec143] commands Description

csr0 Shows the CSR0 register.

csr5 Shows the CSR5 register.

csrs Shows the CSRS register.

ctx Shows the Ethernet control context.

iface Shows the DEC interface statistics.

initchip Initializes the chip.

log Shows the DEC interface state change log.

pkts Shows TX and RX packets per second.

rxlist Shows part of the RX list.

stats Shows the Ethernet statistics.

txlist Shows part of the TX list.

Note: Use the [ipeth] command set for TX 4000/C boards.

[exc] - Exception handling commands

Use the exception command set to view information about any unexpected exception that occurred on a TX 3220/C board, or to manually trigger a shutdown of all functions registered for the non-maskable interrupt exception. The following table lists the [exc] commands:

[exc] commands Description

frame Shows saved exception stack frame.

shutdown Shuts down all functions registered for [NMI] shutdown.

Note: Use the [debug] command set for TX 4000/C boards.



[framer] - T1/E1/J1 $framer task information commands

Use [framer] commands on TX 4000/C boards to display control information managed by the internal kernel task $framer. The $framer task services all interrupts generated by the framer chips on the board. The following table lists the [framer] commands:

[framer] commands Description

15min Displays 15-minute performance statistics.

24hr Displays 24-hour performance statistics.

ctx Displays $framer task top-level control context.

ring Displays entries from event information ring.

stats Displays statistics maintained by $framer task.

status Displays line status as seen by $framer task.

zstats Displays ZERO statistics maintained by $framer task.



[gpmem] - GPLIB memory diagnostic commands

GPLIB (general purpose library) memory diagnostic commands provide a detailed breakdown of all memory currently allocated on the TX board. The TX kernel GPLIB manages all memory control on the board. Use the GPLIB memory diagnostic commands to identify memory corruption issues.

[gpmem] commands for TX 3220/C boards

[gpmem] commands Description

findpools Finds all GPLIB pools. Checks the following:

[l]: Lists [P]: BKs [z]: Zero-fill

gplib Displays memory as a !LIB (general purpose library context).

listchk Writes a list verifying list consistency. [v] = verbose.

mbk Displays memory area as a !mbk (memory block).

mrg Displays memory area as a !mrg (memory region).

pbk Displays memory area as a !pbk (pooled memory block).

poo Displays memory area as a !poo (pooled memory descriptor).

prg Displays memory area as a !prg (pooled memory region).

tcb Displays a !tcb (task control block) for the named task or address.

[gpmem] commands for TX 4000/C boards

[gpmem] commands Description

cfg Displays pool configuration settings.

listchk Traverses a list verifying list consistency. [v] = verbose.

chkpools Finds all GPLIB pools. Checks the following:

[l]: Lists [P]: BKs [z]: Zero-fill

mem Shows memory usage.

pbk Displays memory area as a !pbk (pooled memory block).

pool Displays memory area as a !poo (pooled memory descriptor).

pools Displays all memory pools on the system.

prg Displays memory area as a !prg (pooled memory region).

usage Displays limited pool memory usage.



[gt] - GT 64260 control commands

The [gt] commands provide a low-level interface to the GT 64260 chip (main controller) on TX 4000/C boards. The following table lists the [gt] commands:

[gt] commands Description

gtread Displays the contents of the register at GT_BASE+offset.

gtwrite Writes the value to the specified GT register at GT_BASE+offset.

info Displays general GT 64260 information.

[hbus] - Host bus interface commands

Host bus interface commands provide detailed information about packet flows between the TX board and the host system. Use this information when debugging communication problems between host-based applications and TX-based tasks.

[hbus] commands for TX 3220/C boards

[hbus] commands Description

rxchan Shows receive routing information (per de-multiplexing channel).

spadread Reads the scratch pad registers.

[hbus] commands for TX 4000/C boards

[hbus] commands Description

lev1ctx Displays level 1 driver context information.

pcidev Shows all local PCI devices.

pciread Reads a U32 from PCI configuration space.

pciwrite Writes a U32 to PCI configuration space.

pldread Reads a byte from PLD (programmable logic device) global registers.

pldwrite Writes a byte to PLD global registers.

res Displays resource information.

restats Displays Hbus resource statistics.

rxchan Shows receive routing information (per de-multiplexing channel).

stats Displays Hbus statistics.

vsock Displays vsock information.



[hdlc] - HDLC protocol control commands

Use [hdlc] commands to monitor TX 4000/C board use of the HDLC protocol. The [hdlc] command set is not part of the standard commands provided by TX 4000/C boards because the HDLC protocol is not used for standard SS7 communication. The board uses HDLC only to perform hardware verification testing (which can be activated using the on-board DIP switches).

The following table lists the [hdlc] commands:

[hdlc] commands Description

chan Displays MCC channel-specific information.

info Displays global HDLC MCC information.

mcc Displays MCC-specific information.

res Displays a list of resources.


[host] - Host-based tracking into TX memory

Use host-based tracking commands to track problems in driver behavior on TX 3220/C boards that cannot be easily tracked on the host system. A host-based driver must be built with TX tracking enabled in order to use this tracking mechanism. The following table lists the [host] commands:

[host] commands Description

track Shows all tracking entries (host driver tracking into TX memory).

tracklog Shows tracking log (host driver tracking into TX memory).



[ipeth] - IP/Ethernet commands

Use [ipeth] commands to monitor TX 4000/C board usage of the IP protocol over its Ethernet interfaces. The following table lists the [ipeth] commands:

[ipeth] commands Description

i82551 Displays Ethernet control information for the Intel 82551 chip.

i82551bds Displays Ethernet (type Intel 82551) RX and TX BD tables.

arp Displays the IPv4 ARP table.

dhcp Displays the IPv4 DHCP table.

eth Displays Ethernet interface information.

ethctx Displays an Ethernet control context.

forward Enables IPv4 forwarding.

ipv6 Displays the IPv6 configuration.

ipv6if Displays the IPv6 interfaces.

ipv6nd Displays IPv6 neighbor discovery information.

netinfo Displays NetInfo data structure contents.


route Manages the IPv4 routing table.

vsock Displays a list of vsocks.

Note: Use the [dec143] command set for TX 3220/C boards.



[led] - LED control commands

LED control commands change the mapping of events managed by the TX kernel to the available LEDs on the TX board. The usage of all on-board LEDs is fixed for all TX products and should not be changed by operators. Use these commands to troubleshoot problems.

[led] commands for TX 3220/C boards

[led] commands Description

appclr Turns off an application LED.

appset Turns on an application LED.

clr Turns off an LED.

map Sets the LED map.

pclr Calls low-level function to turn off an LED.

pset Calls a low-level function to turn on an LED.

set Turns on an LED.

[led] commands for TX 4000/C boards

[led] commands Description

all Sets value of all LEDs.

ledlog Shows last value written as led log (or log specified code/loc).

mode Shows or sets LED operating mode.

names Shows names of LEDs.

set Shows or changes current LED setting.

[mail] - Mailbox control commands

TX-based tasks use mailbox messages to perform all inter process communications (IPC). Use [mail] commands to monitor all TX 4000/C board mailbox communications. The following table lists the [mail] commands:

[mail] commands Description


vsock Displays a list of vsocks.



[mem] - Memory control commands

Use [mem] commands on TX 3220/C boards to identify potential memory leaks. The TX kernel breaks all memory into memory regions (RGDs). Use the rgdhide command to hide all currently allocated memory from the rgdshow output. Then run the test in which a memory leak is suspected. After the test, use the rgdshow command to show only the memory allocated since the test executed. This test often identifies the source of a given memory leak. The following table lists the [mem] commands:

[mem] commands Description

rgdhide Hides currently allocated RGDs.

rgdshow Shows memory distribution (RGD level).

rgdunhide Shows all RGDs marked hidden.

Note: Use the [mrg] command set for TX 4000/C boards.

[memtest] - Memory test and access functions

Memory test commands test memory access on TX 3220/C boards. Use these low-level commands to diagnose hardware-level connection issues. The following table lists the [memtest] commands:

[memtest] commands Description

lastacc Displays details on the last memory access.

memr360 Reads a memory location in a 360 address space.

memw360 Writes a memory location in a 360 address space.

memr Reads a memory location.

memw Writes a memory location.

regr360 Reads a 360 register.

regw360 Writes a 360 register.

sireg Displays the SI registers.

tdtest Tests the TDM streams between the T8100 and a 360.

tdtestall Tests all TDM streams between the T8100 and all 360s.

Note: Use txdiag to test memory access on TX 4000/C boards.



[mpsc] - MPSC (GT 64260 serial interface) commands

The GT 64260 controller chip on TX 4000/C boards provides a serial interface. Use [mpsc] commands to monitor this interface. The following table lists the [mpsc] commands:

[mpsc] commands Description

info Displays MPSCInfo data structure contents.



[mrg] - Memory region commands

Use [mrg] commands to display information about memory usage on TX 4000/C boards. All memory is managed using memory region descriptors (RGDs). The following table lists the [mrg] commands:

[mrg] commands Description

allmem Displays assignments for all memory regions.

avail Displays total amount of memory in use and available.

full Displays control information at the time of the first full indication.

info Displays top-level region information.

pmem Displays the percentage of memory assigned to each task.

rgd Displays a memory area as an RGD ( memory region descriptor).

rgdwalk Traverses an RGD list and displays each region descriptor (RGD).

tmem Displays all memory regions assigned to the specified task.

Note: Use the [mem] command set for TX 3220/C boards.

[mtp1] - MTP level 1 commands

Use [mtp1] commands to monitor the SS7 level 1 interface provided by the TX kernel on TX 4000/C boards. The following table lists the [mtp1] commands:

[mtp1] commands Description

chan Displays MCC channel-specific information.

info Displays MTP1Info data structure contents.

lvl1 Displays MTP1 level 1 layer information.

mcc Displays MCC-specific information.

pstats Displays SS7 protocol-specific statistics.



Note: Use the [ss7] command set for TX 3220/C boards.



[mv90] - MVIP common API function testing

Use the [mv90] commands on TX 3220/C boards to perform operations described by the MVIP-90 interface. These commands enable testing of clocking configurations. The following table lists the [mv90] commands:

[mv90] commands Description

cfgclk Configures clocking for MVIP.

chconn Makes or breaks MVIP switch connections.

chstatus Gets information on MVIP switch connections.

ctlsw Resets, enables, or disables the MVIP switch.

querysw Queries MVIP capabilities.

swstatus Gets current switch status information.

Note: Use the [swi] command set for TX 4000/C boards.

[nobj] - Named object commands

Use [nobj] commands on TX 4000/C boards to display named objects. The following table lists the [nobj] commands:

[nobj] commands Description

info Shows top-level named object information.

names Shows named objects of a specific type.

[pool] - Pooled memory commands

Use pooled memory commands on TX 3220/C boards to display usage information based on memory pools. Memory pools are created on the TX board any time a task needs to manage a set of same-sized buffers. By tracking pool usage, operators can see when memory pools are becoming depleted. Use this information to manage traffic loads.

The following table lists the [pool] commands:

[pool] commands Description

cfg Shows pool configuration settings.

names Shows named pools.

stats Shows pool statistics.

usage Shows limited pool memory usage.

Note: Use the [gpmem] command set for TX 4000/C boards.



[quadfalc] - Infineon QuadFALC T1/E1/J1 framer control

Use [quadfalc] commands to communicate directly with the T1/E1/J1 framer chips on TX 4000/C boards. The following table lists the [quadfalc] commands:

[quadfalc] commands Description

get Retrieves the contents of a register.

names Displays the names of registers for a given framer type.

regs Displays all framer registers.

rres Resets the receiver.

set Sets the contents of a register.

sres Resets the signaling transmitter.

xres Resets the transmitter.

[remote] - Remote connection commands

Use remote connection commands to issue cpcon commands to a remote TX 3220/C board through the TX board Ethernet interface. The remote interface is useful when investigating system crashes and lockups in which the host system is down but the TX board is still operational. When a remote session is in use, the prompt displays as shown in the following example: ~cpnum~ [cmdset] >

To exit the remote session, enter a caret (^).

The following table lists the [remote] commands:

[remote] commands Description

connect Connects to the TX board by entering pass-through mode.

hello Broadcasts a HELLO message to locate other TX boards.



[ser] - Serial I/O pin tests

Use the serial I/O commands on TX 3220/C boards to exercise raw control of the I/O pins that carry the signals used for serial (V.35) interfaces. These commands are used for connectivity testing and for V.35 hardware verification. The following table lists the [ser] commands:

[ser] commands Description

bounce Bounces a serial I/O pin (0 to 1 to 0, and so on).

getreg Displays values of serial I/O pins.

getser Reads the value of a serial I/O pin.

manuf Manufacturing test function.

serstat Serial port signal status report.

setdir Sets the direction of a serial I/O pin. 0 = output; 1 = input.

setscc Sets up the signal for standard SCC control.

setser Sets a serial I/O pin to a value (0 or 1).

signames Displays signal names for the given pod port.

[slog] - System log commands

The TX 4000/C system log provides the following types of logging: alarms, printf, and trace. Each type of logging is managed separately. Log records are stored on the TX board until they are forwarded to a host-based collection utility. The txalarm utility collects alarm logs. The printf and trace log entries are used only during development.

The following table lists the [slog] commands:

[slog] commands Description

alarm Displays all alarm logs.

info Displays logging control information.

printf Displays all printf logs.

ring Displays ring information.

stalog Displays ring state/event log.

stats Displays statistics and optionally zeros them.

trace Displays all trace logs.



[ss7] - SS7 level 1 driver commands

Use SS7 level 1 driver commands on TX 3220/C boards to communicate directly with the level 1 driver that handles all SS7 packet transmission and reception. The MTP task sits above the SS7 level 1 driver for all SS7 links. You can also diagnose certain low-level communication problems by using the SS7 level 1 driver commands.

Each SS7 level 1 driver command, with the exception of rev and init, provides summary output (one line per link) and detailed output (a full screen of information for a particular link). To view summary information, enter the command with no parameters. To view detailed information, enter the command followed by the type (for example, Tdm or Serial [V.35]) and the port number for the given link.

The following table lists the [ss7] commands:

[ss7] commands Description

bounce Detaches and enables SS7 ports.

conf Shows configuration information for SS7 ports.

ctx Shows information from the main control context of SS7 ports.

init Reinitializes the SS7 microcode for one processor or all 360 processors.

lvl1 Shows common level 1 driver header information for SS7 ports.

ports Shows all ports configured as SS7 of the type specified.

pram Shows the current parameter RAM settings for SS7 ports.

rev Shows the revision level of 360 processors.

stats Shows statistics for SS7 ports.

suf Shows SS7 SU frequency parameters for the specified ports.

trace Shows the SS7 log report for the specified ports.

Note: Use the [mtp1] command set for TX 4000/C boards.



[swi] - H.100/H.110 and local stream switching control

Use [swi] commands to manually control TX 4000/C switching. Many of the commands correspond to functions in the host-based TX SWI library. The following table lists the [swi] commands and the corresponding TX SWI functions:

[swi] commands Description TX SWI library functions

bdinfo Displays TX board information. No equivalent.

break Breaks a half-duplex connection. txswiDisableOutput

caps Queries the H.100/H.110 switch capabilities. txswiGetSwitchCaps

channels Displays all defined channel connections. txswiGetOutputState

clock Sets the H.100/H.110 clock registers. txswiConfigBoardClock

connect Makes a half-duplex connection. txswiMakeConnection

disable Disables the H.100/H.110 switch. No equivalent.

enable Enables the H.100/H.110 switch. No equivalent.

getclock Retrieves the current clocking configuration. txswiGetBoardClock

netref Sets the H.100/H.110 NETREF signal. txswiConfigNetrefClock

pattern Issues a repeating character pattern. txswiSendPattern

pmatch Displays all connections outputting a pattern. txswiGetOutputState

port Makes a full-duplex connection. txswiConfigLocalTimeslot

ports Displays all defined communications ports. txswiGetLocalStreamInfo

query Queries the output connection configuration. txswiGetOutputState

reset Resets the H.100/H.110 switch. txswiResetSwitch

sample Displays a data sample from the connection source.

txswiSampleInput

speed Adjusts the speed of the local communications port.

txswiConfigLocalTimeslot

status Displays the current status of the switch. No equivalent.

You can also use the host-based utility txconfig to control switching. For more information, see the NMS SS7 Configuration Manual. For more information on the TX SWI library, see the TDM for SS7 Developer's Reference Manual.

Note: Use the [mv90] and [tdm] command sets for TX 3220/C boards.



[sys] - System information commands

Board [sys] commands Description

TX 3220/C info Displays system information (SysInfo) block.

clock Shows clock information.

dip Shows the current settings of the DIP switches.

eeprom Shows the EEPROM contents.

flash Shows flash information.

info Displays system information (SysInfo) block.

time Shows the date and time.

TX 4000/C

util Shows CPU utilization.

[t1e1] - T1|E1|J1 control commands

For TX 3220/C boards, the [t1e1] command set provides a direct interface to the framer chips used to configure T1 or E1 signaling on the TX board. For TX 4000/C boards, the [t1e1] command set provides full control of all T1/E1/J1 capabilities on the board. Use these commands to diagnose TDM communication problems on the T1, E1, or J1 interfaces.

[t1e1] commands for TX 3220/C boards

[t1e1] commands Description

ctlnames Displays the names of all the T1/E1 control lines.

getallctl Displays the values of all the T1/E1 control lines.

getallreg Displays the contents of all the T1/E1 registers.

getctl Displays the value of a T1/E1 control line.

getreg Displays the contents of a T1/E1 register.

regnames Displays the names of all the T1/E1 registers.

setctl Sets the value of a T1/E1 control line.

setreg Writes the contents of a T1/E1 register.



[t1e1] commands for TX 4000/C boards

[t1e1] commands Description

ais Transmits an alarm indication signal.

chanloop Places a single framer channel in loop mode.

ctx Displays the T1/E1/J1 top-level control context.

defect Inserts single bit defects.

disable Disables the framer.

e1cfg Configures the framer as E1 mode.

e1opt Sets the E1 configuration option.

enable Enables the framer.

frcfg Shows the current framer configuration.

frstats Shows statistics for the framer.

frstatus Shows the current framer status.

info Displays top-level information for each framer.

j1cfg Configures the framer as J1 mode.

j1opt Sets the J1 configuration option.

llbdown Transmits a line loopback deactivate code.

llbup Transmits a line loopback activate code.

loop Places the entire framer in loop mode.

prbs Transmits a pseudo-random bit sequence.

ra Transmits a remote alarm.

resync Forces framer resynchronization.

sim Initiates an alarm simulation or advances to the next test.

t1cfg Configures the framer as T1 mode.

t1opt Sets the T1 configuration option.



[t81] - Diagnostic interface to T8100 chip

T8100 commands provide a direct interface to the H.100/H.110 switching hardware, which is controlled through the T8100 chip on the TX board. These commands help you analyze TDM connections established with the tdmcfg utility, the txconfig utility, the TX SWI library, and the TDM libraries, including commands entered through the t1demo application.


• [t81] commands for TX 3220/C boards

• [t81] commands for TX 4000/C boards

• TDM pattern test commands

[t81] commands for TX 3220/C boards

[t81] commands Description

bkcx Breaks the CAM (content addressable memory) connection.

break Breaks the connection.

cfgclk Configures the main clocking mode.

cfgnetref Configures the clocking network reference.

clock Sets the clock registers for H.100/H.110 slave or master mode.

conndb Displays connections on the T8100.

connect Makes a half-duplex connection.

ctldb Displays the Ctrl db.

dmdb Displays the DM db.

init Reinitializes the entire T8100.

mkcx Makes the CAM connection (local or Hbus to CAM data memory).

pattern Sends a pattern by issuing a repeating character pattern.

query Queries the output configuration and shows how the output connection is configured.

results Obtains the status of the last function call, optionally clearing the call first.

sample Samples the connection and displays a data sample from the connection source.

showcam Displays the details of a CAM.

showregs Displays the status of all registers.

stats Displays statistics on the T8100.

stream Performs a stream-wide operation (Hbus or local).



[t81] commands for TX 4000/C boards

[t81] commands Description

check Checks received patterns across the stream range. Used to test H.100/H.110 or T1/E1 connectivity to another TX 4000/C board. See TDM pattern test commands on page 66.

ctldb Displays the Ctrl db.

fallback Forces into clock fallback mode or returns to normal.

info Displays top-level T8100 control information.

local Displays all currently defined local connections.

looptrunks Loops all T1/E1 trunks back on themselves.

reflect Reflects timeslots across a given stream range. Used to test H.100/H.110 or T1/E1 connectivity to another TX 4000/C board. See TDM pattern test commands on page 66.

spread Spreads patterns across a stream range. Used to test H.100/H.110 or T1/E1 connectivity to another TX 4000/C board. See TDM pattern test commands on page 66.

stats Displays statistics on the T8100.

status Displays the current status of the T8100.

vreflect Verifies CAM (content addressable memory) definitions (reflecting timeslots). Used to test H.100/H.110 or T1/E1 connectivity to another TX 4000/C board. See TDM pattern test commands on page 66.

vspread Verifies CAM definitions (spreading patterns). Used to test H.100/H.110 or T1/E1 connectivity to another TX 4000/C board. See TDM pattern test commands on page 66.



TDM pattern test commands

Use the following [t81] commands to verify TDM (H.100/H.110 or T1/E1 connectivity) between two TX 4000 /C boards:

Command Description

check Checks received patterns across a stream range.

Syntax:

check bus min stream [max stream [ts delta [pattern]]]

reflect Reflects timeslots across a stream range.

Syntax:

reflect bus min stream [max stream [ts delta]]

spread Spreads patterns across a stream range.

Syntax:

spread bus min stream [max stream [ts delta [pattern]]]

vreflect Verifies CAM definitions (reflecting timeslots).

Syntax:

vreflect bus min stream [max stream [ts delta]]

vspread Verifies CAM definitions (spreading patterns).

Syntax:

vspread bus min stream [max stream [ts delta [pattern]]]

The following parameters apply to each command:

Parameter Description

bus Valid values:

H = H.100/H.110 bus (resource direction). N = H.100/H.110 bus (network direction). L = LOCAL bus.

min stream Minimum stream number (paired with min+1 for H.100/H.110 bus).

max stream Maximum stream number (paired with max-1 for H.100/H.110 bus). Default: min stream+1.

ts delta Delta used to reach next timeslot. Default: 1.

Note: Each time the stream is incremented (by 2), the next timeslot is reset to 0.

pattern Constant pattern to send or expect. If not specified, then a range of patterns is used.



Follow this procedure to use the pattern test commands:

Step Action

1 Connect two TX 4000/C boards with either an H.100/H.110 cable or a T1/E1 crossover cable.

2 Download a TDM configuration file to each board specifying TDM clocking configuration (and T1 or E1 configuration if testing T1/E1).

3 On one TX board, use the reflect command to define a set of connections that reflect patterns received over H.100/H.110 (or T1/E1) and transmitted over H.100/H.110 (or T1/E1).

4 On the other board, use the spread command to spread a set of outbound patterns over the interface being tested.

5 Use the check command on the same TX board that the spread command was entered on to verify that the proper reflected patterns are received.

6 Use the vreflect and vspread commands to verify that all connections made using the corresponding command (reflect or spread) are actually in the TDM switching control database.



[t81-low] - Low-level interface to T8100 chip

T8100 low-level interface commands perform low-level manipulations to the T8100 chip, which is used for H.100 and H.110 switching control. Use these low-level commands to test and analyze the internal behavior of the T8100 interface.

[t81-low] commands for TX 3220/C boards

[t81-low] commands Description

camdm Displays the entire contents of CAM DM 1.

clrclkerr Clears the clock error registers.

clrdms Zeros the CAM DM.

ctlreg Reads a value from the given control register.

ctlregs Displays all the control registers.

disable Disables the T8100 outputs.

enable Enables the T8100 outputs.

errregs Displays the error registers.

locdm Displays the entire contents of local DM 1.

mainregs Displays the main registers.

ramr Reads the value in the AMR (address mode register).

rateregs Displays the stream rate registers (LCE, LBE, and HBE].

reset Performs a software reset of the T8100.

ridr Reads the value in the IDR (indirect data register).

rlar Reads the value in the LAR (lower address register).

rmcr Reads the value in the MCR (master control register).

wamr Writes a value to the AMR register.

wctlreg Writes a value to the given control register.

widr Writes a value to the IDR register.

wlar Writes a value to the LAR register.

wmcr Writes a value to the MCR register.



[t81-low] commands for TX 4000/C boards

[t81-low] commands Description

ramr Reads the value in the AMR (address mode register).

ridr Reads the value in the IDR (indirect data register).

rlar Reads the value in the LAR (lower address register).

rmcr Reads the value in the MCR (master control register).

showregs Displays the status of all registers.

wamr Writes a value to the AMR register.

wctlreg Writes a value to the given control register.

widr Writes a value to the IDR register.

wlar Writes a value to the LAR register.

wmcr Writes a value to the MCR register.

[task] - Task control commands

Board [task] commands Description

TX 3220/C stop Stops the specified task (issues a TASK/HOLD). Reboot the TX board to restart the task. Use the stop command to simulate task failure for redundancy recovery testing or to test whether a given task is associated with suspicious behavior.

info Shows top-level task control information.

rings Lists tasks (head and tail) on each task priority ring.

sqe Displays a memory area as a task SQE (service queue element).

task Shows detailed information about the named task.

tasks Shows a list of currently defined tasks.

TX 4000/C

tcb Displays a memory area as a TCB (task control block).

Note: Use the [debug] command set to stop a task on a TX 4000/C board.



[tdm] - TDM configuration information commands

Use TDM commands on TX 3220/C boards to display information about the mapping between TDM connections and internal TX board resources. This information is used when debugging problems related to TDM data flows.

The following table lists the [tdm] commands:

[tdm] commands Description

cpmreg Displays CPM registers.

help Shows the details of a specified command.

shconn Displays MVIP connections.

siram Displays SI RAM.

tdmcfg Displays TDM configuration.

Note: Use the [swi] command set for TX 4000/C boards.

[timer] - Timer control commands

Use [timer] commands to view all timers used on TX 4000 /C boards. The following table lists the [timer] commands:

[timer] commands Description

active Shows all active timers.

gpt Shows detailed information for the specified timer.

info Shows top-level timer control information.

timers Shows all timers, or all for a specific task.

[vsock] - Virtual socket commands

The TX 4000/C boards use virtual sockets (vsocks) as the standard communication interface between protocol layers. Use the [vsock] command to view the vsocks currently defined on the board. The following table lists the [vsock] command:

[vsock] command Description

info Displays VSOCK top-level information.

resctx Displays a memory area as a resource context (RESCTX).

ress Displays summary information for all resources.

rxtxd Displays a memory area as an RX/TX descriptor (RXTXD).

txpend Displays all transmits currently pending for the given VSOCK.

vsockctx Displays a memory area as a VSOCK control context (VSOCKCTX).

vsocks Displays summary information for all VSOCKs.


Index

A

alarm messages 19

arp.lot 9

assigning CP numbers 11

B

board diagnostics 24, 26

board information 30

board locate 18

C

cmd 36

command sets 35

cmd 36

con 37

debug 47

dec143 48

exc 48

framer 49

gpmem 50

gt 51

hbus 51

hdlc 52

ipeth 53

led 54

mail 54

mem 55

memtest 55

mpsc 56

mrg 56

mtp1 56

mv90 57

nobj 57

pool 57

quadfalc 58

remote 58

ser 59

slog 59

ss7 60

swi 61

sys 62

t1e1 62

t81 64

t81-low 68

task 69

tdm 70

timer 70

vosock 70

communications processor tasks 22

communications processor utilities 7

analyzing shared memory 27

debugging tasks 29

displaying alarm messages 19

displaying board information 30

displaying diagnostic information 24

generating a snapshot 26

loading tasks 22

receiving data traces 20

viewing completion code descriptions 29

viewing statistics 23

completion codes 29

con 37

console utility 7

communicating with TX boards 33

selecting a command set 35

console.lot 9

cosinfo.h include file 30

CP numbers 11, 13

cpcfg 11

Index TX Utilities Manual


cpcon 33

cpcon_ 33

cplot 22

cpmodel 13

D

data tracing 20

debug 18, 29, 47, 48, 51

debug.elf 9

debug.lot 9

dec143 48

demonstration programs 8

diag3220.lot 9

diagnostic tests 18, 24, 26

E

EEPROM 14

elf files 9

error codes 29

Ethernet 37, 48, 53

etp.lot 9

exc 48

F

firmware 16, 17

flash memory 16, 17

framer 49

G

GPLIB 50

gpmem 50

GT 64260 51, 56

H

hbus 51

hdlc 52

host 52

host driver 23, 27

Hot Swap 18, 19, 33

I

inf.lot 9

installed boards 13

ipeth 53

IPv4 53

IPv6 53

K

kernel 16, 37, 62

L

LED 18, 27, 54

log records 59

lot files 9

M

mail 54

managing TX boards 7

assigning CP numbers 11

listing installed TX boards 13

locating a TX board 18

rebooting a TX board 17

resetting a TX board 17

updating flash memory 16

viewing EEPROM information 14

mem 55

memory control 50, 55

memory dump 27

memory pools 37, 57

memory regions 37, 55, 56

memtest 55

mpsc 56

mrg 56

mtp.elf 9

mtp.lot 9

mtp1 56

mv90 57

MVIP streams/timeslots 37

mvip.lot 9

N

named objects 37, 57

nobj 57

O

operator console commands 35

operator console utilities 33

TX Utilities Manual Index


P

PCI bus and slot 11

pcigetcfg 12

pooled memory 57

priority queues 37, 69

Q

quadfalc 58

QUICC32 mode 37

R

remote 58

resources 37, 51, 52, 53, 54, 56, 56

S

sccp.elf 9

sccp.lot 9

ser 59

serial communications controller 37, 52, 56

serial I/O 59

serial number 14

shared memory 27

slog 59

snapshot file 26

ss7 60

ss7trace 20

stream/timeslot assignments 37, 61

swi 61

switching 57, 61, 64, 68, 70

sys 62

system debugger 47, 48

system information 62

system log 59

system utilization 37

T

T1/E1/J1 $framer 49

T1/E1/J1 information 37, 62

t1demo 8

t1e1 62

t1e1mgr.lot 9

t1stat 8

t81 64

T8100 64, 68

t81-low 68

task 69

tcap.elf 9

tcap.lot 9

tdm 70

TDM interfaces 8

TDM libraries 8

tdmcfg 8

timer 70

tracing 20

tup.elf 9

tup.lot 9

TX SWI library 61

tx32snap 26

txalarm 19

txalarm_ 19

txccode 29

txconfig 8

txcpcfg 11

txdbg 29

txdiag 24

txdump 27

txdynamic 8

txeeprom 14

txflash 16

txinfo 30

txlocate 18

txmon.elf 9

txmon.lot 9

txreset 17

txsdemo 8

txsnap 26

txstats 23

U

utilities 7

Index TX Utilities Manual


V

virtual ports 37

virtual sockets 70

vsock 70

tx utilities manual - network fuel®, bordernet sbc

Documents