Intel® Dialogic® System Software Diagnostics Guide September 2006 05-1935-007
INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL® PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT.
Contents Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 About This Publication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 1 Diagnostics Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 1.1 1.2 1.3 2 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . .
Contents 8.4 8.5 8.6 9 Tracing Multiple ISDN Trunks Using Global Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 9.1 9.2 9.3 9.4 9.5 9.6 10 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Guidelines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 DMC Main Window . . . . . . . . . . . . . . . . . . . . . . . .
Contents 18.1 18.2 18.3 18.4 18.5 18.6 19 Getver Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 19.1 19.2 19.3 20 Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Options . . . . . . . . . . . . . . . .
Contents 26.7 27 QScript Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 27.1 27.2 27.3 28 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Installing RTF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 RTF Configuration File . . . . . . . . . . . . . . . . . . . .
Contents Figures 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 PSTN Diagnostics Tool - Board Level View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 PSTN Diagnostics Tool - Outbound Channel (Upper Pane) & Inbound Channel (Lower Pane) 36 PSTN Diagnostics Tool - Making a Call. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 PSTN DIagnostics Tool - Call Completed and Released . . . . . . . . . . . . . . . . . . . . . . .
Contents 8 System Software Diagnostics Guide – September 2006
Contents Tables 1 2 3 Structure of Data - Tracing CAS Signaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Structure of GCEV_TRACEDATA Data for ISDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Log Files Archived by its_sysinfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents 10 System Software Diagnostics Guide – September 2006
Revision History This revision history summarizes the changes made in each published version of this document. Document No. Publication Date Description of Revisions 05-1935-007 September 2006 Diagnostics Overview: Added a new section: Diagnostics Management Console (DMC). System Requirements: New chapter. Includes JRE requirement. Using the Diagnostics Management Console (DMC): New chapter.
Revision History Document No. Publication Date Description of Revisions 05-1935-004 September 2005 Checking all the Boards in a System: A new section in Checking DM3 Architecture Boards. Tracing CAS Signaling Using Global Call: New chapter. Unsupported Boards: New section in Checking DM3 Architecture Boards. DM3post Reference: Added information about the -r (reset) option and about using DM3post to run POST on a chassis level.
About This Publication The following topics provide information about this publication: • Purpose • Intended Audience • How to Use This Publication • Related Information Purpose This guide describes the diagnostic tools included with the Intel® Dialogic® System Software release and explains how to use them.
About This Publication Each of the following chapters discuss diagnostic tasks. Details about the tool used to perform the task are provided in the tool reference chapters that follow these task chapters. This information is cross-referenced between the task and reference chapters.
About This Publication • Chapter 22, “KernelVer Reference” - TheKernelVer tool can be used to verify whether or not a processor has crashed. • Chapter 23, “MercMon Reference” - MercMon provides counter information about DM3 board device drivers (Class Driver and Protocol Drivers). • Chapter 24, “PDK Trace Reference” - The PDK Trace tool allows those who use a DM3 PDK protocol to log specific information related to the operation of the protocol.
About This Publication 16 System Software Diagnostics Guide — September 2006
Diagnostics Overview 1. 1 This chapter presents an overview of the diagnostic tools and the debugging/troubleshooting tasks that can be performed with them. The following topics are included: • Diagnostics Management Console (DMC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 • Common Diagnostic Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 • Tool Classification by Problem Type. . . . . . . . . . . . . . . . . . . . . . . . .
Diagnostics Overview • Section 4.5, “Tracing Firmware”, on page 28 • Chapter 12, “DebugAngel Reference” • Chapter 23, “MercMon Reference” • Chapter 24, “PDK Trace Reference” Diagnosing a Control Processor, Signal Processor or Shared RAM Fault on a Board You can use the dlgsnapshot tool to capture a core dump when a Control Processor (CP), Signal Processor (SP), or Shared RAM (SRAM) fault is detected on a DM3 board. Refer to the following: • Section 4.
Diagnostics Overview started and stopped via Global Call APIs. The trace information collected with this procedure allows developers to determine the root cause of protocol issues in a system that uses Intel NetStructure® DMT160TEC or DMN160TEC digital telephony interface boards. Creating a system configuration archive As part of a quality control effort, you might want to baseline your systems by retrieving all available information using the Intel Telecom Subsystem Summary Tool (its_sysinfo).
Diagnostics Overview • Section 7.
System Requirements 2. 2 This chapter provides information about the hardware/software requirements needed to run the diagnostic tools. Topics include: • Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 • Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 2.
System Requirements 22 System Software Diagnostics Guide — September 2006
Using the Diagnostics Management Console (DMC) 3. 3 This chapter describes how to use the Diagnostics Management Console (DMC) to launch the diagnostic tools supplied with Intel® telecom software and view the log files produced by the tools. The following information is included: • Launching a Diagnostic Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 • Launching a Diagnostic Tool on a Remote Machine. . . . . . . . . . . . . . . . . . . . . . . . . . .
Using the Diagnostics Management Console (DMC) 3.3 Launching a Diagnostic Tool on a Remote Machine To use a diagnostics tool on a remote machine, you must change settings on the DMC Configuration Dialog. 1. Access the DMC Configuration Dialog by selecting Configuration from the Tools menu or pressing F4. 2. Check the box next to Remote Execution of CLI Tools. 3. Enter the Remote Machine Name. 4. Enter the Remote Login UserName. 5.
Using the Diagnostics Management Console (DMC) Configuration from the Tools menu or pressing F4. A Browse button allows you to select a directory for the Log File Directory field. Note: If the user-defined variable is empty or not valid, the DMC will use the environment variable set up during installation of the Intel telecom software: INTEL_DIALOGIC_DIR/log. For more information about the DMC’s list of log files, refer to Section 13.3.3, “Log File Panel”, on page 73.
Using the Diagnostics Management Console (DMC) 26 System Software Diagnostics Guide — September 2006
Checking DM3 Architecture Boards 4. 4 This chapter provides procedures for checking the Intel NetStructure® on DM3 architecture hardware and firmware in your system. • Preparations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 • Checking an Individual Board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 • Checking all the Boards in a System . . . . . . . . . . . . . . . . . . . . . . . . .
Checking DM3 Architecture Boards 3. You will get the following response: Do you wish to continue (y/n)? If you answer Y, the following will be printed to the screen: dm3post processing... The success/failure message will be printed to the screen when POST is complete. 4.3 Checking all the Boards in a System The DM3post diagnostic utility provides an option to run POST on a chassis level.
Checking DM3 Architecture Boards 2. When you need to refer to the firmware trace log, look in the log directory: • On a Windows system, information is logged to the file DebugAngel.log in the %INTEL_DIALOGIC_DIR%\log directory. • On a Linux system, information is logged to the file debugangel.log in the ${INTEL_DIALOGIC_DIR}/log directory. Command line options and configuration options for DebugAngel are provided in Chapter 12, “DebugAngel Reference”. 4.
Checking DM3 Architecture Boards 30 System Software Diagnostics Guide — September 2006
Diagnosing First Call Issues 5. 5 This chapter describes how to use the PSTN Diagnostics tool (pstndiag) to determine what is preventing your system from successfully completing the first call. • Preparation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 • Monitoring the Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 • Monitoring the Status of Alarms . . . . . . . . . . .
Diagnosing First Call Issues Figure 1. PSTN Diagnostics Tool - Board Level View 2. In the board level view, check that the Signal indicator is green for each trunk. The color green indicates a connection between the trunk and another device. The color grey indicates no connection exists. (The various indicators for each trunk, Red, Yellow, Signal, and Loopback, mimic the indicators on the physical board.) 3.
Diagnosing First Call Issues 5.3 Monitoring the Status of Alarms After determining that the Signal indicator for all boards in your system is green as described in Section 5.2, “Monitoring the Signal”, on page 31, check the status of alarms on each trunk.
Diagnosing First Call Issues 34 System Software Diagnostics Guide — September 2006
Diagnosing PSTN Protocol Issues 6. 6 This chapter describes how to check the protocol configuration using the PSTN Diagnostics (pstndiag) tool. • Preparation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 • Checking the Protocol Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 For more information about the pstndiag tool, refer to Chapter 26, “PSTN Diagnostics Tool Reference”. 6.
Diagnosing PSTN Protocol Issues 2. Shift-double-click on a channel (for example, Chan 0.1.1) to display the channel in the lower pane. This channel will be the transmitting (outbound) channel. 3. Shift-double-click on a channel in another trunk (for example, Chan 0.2.1) to display the channel in the lower pane. This channel will be the receiving (inbound) channel. 4. To view both inbound and outbound channels on your screen, click on the “1 System” button (upper pane button) and select “Chan 0.1.
Diagnosing PSTN Protocol Issues Note: The Call Progress, CallId, and ConCallId fields are not typically used and should not be modified. The Call Progress field specifies the level of call progress analysis on the line. The CallId and ConCallId fields contain internal values used by the firmware to keep track of call information. Figure 3. PSTN Diagnostics Tool - Making a Call 8. For the outbound channel (upper pane), click the MakeCall Parameters button to view options, and select the CallInfo button. 9.
Diagnosing PSTN Protocol Issues 13. Click the MakeCall button to start the call. Notice that the CallInfo fields are updated after a call is made, enabling you to monitor the state of the call. For example, the Called ID (DNIS) field shows the telephone number dialed by a caller. The Caller ID (ANI) field shows the telephone number of the incoming call.
Diagnosing PSTN Protocol Issues Figure 4.
Diagnosing PSTN Protocol Issues 40 System Software Diagnostics Guide — September 2006
Debugging Software 7. 7 This chapter provides several procedures that can be useful for general software debugging: • Troubleshooting Runtime Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 • Collecting System Data to Diagnose an Application Failure or Crash . . . . . . . . . . . . . 44 • Creating a System Configuration Archive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 7.
Debugging Software 3. Start your application. As your application runs, RTF will trace the runtime libraries according to RTF configuration file settings that you created using the RTFManager GUI. Refer to the individual entries in the log file or debug stream to review the trace statements generated by the runtime libraries. 4. If you wish to dynamically edit the RTF trace levels while your application runs, it is not necessary to stop the RTF. Instead, perform the following: 1. Start RTFManager. 2.
Debugging Software configuration file. The RTF tracing capabilities are turned on by default. Refer to Section 28.3.1, “RTFConfig Tag”, on page 143 for complete information about the RTFConfig tag. The RTFConfig tag includes the following child tags: • Logfile: This is the first child tag of the RTFConfig tag. The Logfile tag’s attributes set the parameters for the RTF logfile output. This tag is an optional part of the RTF configuration file. Refer to Section 28.3.
Debugging Software 7.2 Collecting System Data to Diagnose an Application Failure or Crash This section describes how to use the Intel® Telecom Subsystem Summary Tool (its_sysinfo) to collect the system data you will need to send to Intel’s Support Services to troubleshoot an application failure or crash. Here are two sample scenarios in which you might use the its_sysinfo tool to gather system data: • A telephony application you are running exits or gets terminated unexpectedly.
Debugging Software use it as a point of comparison to any system that exhibits erroneous behavior. This would provide you with a means of performing an initial cause/effect analysis when you troubleshoot the problem. To familiarize yourself with the Intel Telecom Subsystem Summary Tool (its_sysinfo) and all the data it collects, refer to Chapter 21, “Intel Telecom Subsystem Summary Tool Reference”. Follow this procedure to use its_sysinfo to create a system configuration archive: 1. Start the tool.
Debugging Software 46 System Software Diagnostics Guide — September 2006
Tracing CAS Signaling Using Global Call 8. 8 This chapter describes how to trace CAS signaling in systems with Intel NetStructure® DMT160TEC digital telephony interface boards using Global Call APIs and a Global Call event. The following information is provided: • Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 • Requirements and Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tracing CAS Signaling Using Global Call • Trace newly deployed spans to make sure there are no protocol issues: A new platform consisting of 32 E1s is deployed. All spans are turned up at about the same time. All active spans are traced for up to the first minute of operation to determine if there are any protocol issues. 8.
Tracing CAS Signaling Using Global Call LINEDEV bdev; int rc; int value; GC_INFO gc_error_info; char devname[30]; /* /* /* /* /* board level device number */ Return code */ value to be for specified parameter */ GlobalCall error information data */ Board/Trunk device name */ main() { /* Open a trunk device */ sprintf(dename, ":N_dtiB1:P_pdk_ar_r2_io"); if(gc_OpenEx(&bdev, devname, EV_SYNC, &ldev) != GC_SUCCESS) { /* Process the error as decided earlier */ gc_ErrorInfo( &gc_error_info ); printf ("Error:
Tracing CAS Signaling Using Global Call #include #include #include #include LINEDEV bdev; int rc; int value; GC_INFO gc_error_info; char devname[30]; /* /* /* /* /* board level device number */ Return code */ value to be for specified parameter */ GlobalCall error information data */ Board/Trunk device name */ main() { /* Open a trunk device */ /* Start Tracing */ . . /* Call Control activity, tracing captured */ . . .
Tracing CAS Signaling Using Global Call A new result value GCRV_QUEUE_OVERFLOW associated with GCEV_TRACEDATA event is defined in gcerr.
Tracing CAS Signaling Using Global Call 8.6 Setting the Trace Queue Size Using gc_SetConfigData( ) The gc_SetConfigData( ) API is used for setting the size of the trace buffer in the host DM3 call control library if overruns (overflow) occur. If the trace data queue in the host DM3 cclib overflows, the data at the front of the queue will get overwritten and the cause value associated with that data will be set to GCRV_QUEUE_OVERFLOW. Notes: 1.
Tracing CAS Signaling Using Global Call gc_SetConfigData(GCTGT_CCLIB_NETIF, bdev, ParmBlkp, 0, GCUPDATE_IMMEDIATE, &id, EV_ASYNC); gc_util_delete_parm_blk(ParmBlkp); if (sr_waitevt(-1) >= 0) { METAEVENT meta; gc_GetMetaEvent(&meta); switch(sr_getevttype()) { case GCEV_SETCONFIGDATA: printf("Received event GCEV_SETCONFIGDATA(ReqID=%d) on device %s \n",((GC_RTCM_EVTDATA *)(meta.
Tracing CAS Signaling Using Global Call 54 System Software Diagnostics Guide — September 2006
Tracing Multiple ISDN Trunks Using Global Call 9. 9 This section describes how to collect ISDN D-channel trace information on multiple trunks. • Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 • Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 • Enabling Tracing Using gc_StartTrace( ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tracing Multiple ISDN Trunks Using Global Call 9.2 Requirements This feature is only supported on Intel NetStructure® DMT160TEC and DMN160TEC boards. Caution: Do not permanently enable ISDN tracing on a large number of trunks in a production environment or the call performance will be severely degraded.
Tracing Multiple ISDN Trunks Using Global Call #include #include #include #include
Tracing Multiple ISDN Trunks Using Global Call Sample application code Note: The following sample code was written for an application running on a system in which an Intel NetStructure DMT160TEC board was used as the network interface, an Intel NetStructure DMV2400A board was used as a play/record resource board, and the boards were connected via a CT Bus. #include #include #include #include
Tracing Multiple ISDN Trunks Using Global Call typedef struct { unsigned long seq_no; unsigned short data_size; char data_buf[GCVAL_TRACEDATA_SIZE]; } GC_TRACEDATA, * GC_TRACEDTAP; /* the sequence number of tracing data*/ /* the size of tracing data */ /* memory buffer for tracing data */ A new result value GCRV_QUEUE_OVERFLOW associated with GCEV_TRACEDATA event is defined in gcerr.
Tracing Multiple ISDN Trunks Using Global Call 9.6 Setting the Trace Queue Size Using gc_SetConfigData( ) The gc_SetConfigData( ) API is used for setting the size of the trace buffer in the host DM3 call control library if overruns (overflow) occur. If the trace data queue in the host DM3 cclib overflows, the data at the front of the queue will get overwritten and the cause value associated with that data will be set to GCRV_QUEUE_OVERFLOW. Notes: 1.
Tracing Multiple ISDN Trunks Using Global Call gc_SetConfigData(GCTGT_CCLIB_NETIF, bdev, ParmBlkp, 0, GCUPDATE_IMMEDIATE, &id, EV_ASYNC); gc_util_delete_parm_blk(ParmBlkp); if (sr_waitevt(-1) >= 0) { METAEVENT meta; gc_GetMetaEvent(&meta); switch(sr_getevttype()) { case GCEV_SETCONFIGDATA: printf("Received event GCEV_SETCONFIGDATA(ReqID=%d) on device %s \n",((GC_RTCM_EVTDATA *)(meta.
Tracing Multiple ISDN Trunks Using Global Call 62 System Software Diagnostics Guide — September 2006
CallInfo Reference 10. 10 This chapter provides reference information about the CallInfo tool. The following topics are included: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 • Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 • Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CallInfo Reference 10.3 Options The CallInfo tool uses the following command line options: -board Logical ID of board (required).Use the listboards utility (Linux) or the Configuration Manager (DCM) (Windows) to obtain the board’s logical ID. Note: The listboards utility is described in the Administration Guide for the release and the Configuration Manager is described in the Configuration Guides for the (Windows) release. -line Line number that the tool will monitor (optional).
CAS Trace Reference 11. 11 This chapter provides reference information about the CAS Trace tool.The following topics are included: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 • Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 • Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CAS Trace Reference -line Line number that the tool will monitor (optional). The default value is 1. -k Size of each file to create in kilobytes (optional). If this option is not present the file size will be infinite. -# The number of files to trace to in a circular fashion. Each file will be the size specified with -k (optional). The default is a single file. -f This will be the base filename.
CAS Trace Reference The output is separated into the following columns: • Timestamp - the time at which the event is received down to msec • B## - the board’s logical ID • L## - the line number • T## - the timeslot • Rx=ABCD - the state of the Receive bits • Tx=ABCD - the state of the Transmit bits • Delta - the time between the last transition in msec (if this is blank, it is the initial bit state) System Software Diagnostics Guide — September 2006 67
CAS Trace Reference 68 System Software Diagnostics Guide — September 2006
DebugAngel Reference 12. 12 This chapter provides reference information about the DebugAngel tool. The following topics are included: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 • Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 • Command Line Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DebugAngel Reference -manual Changes the service startup mode to manual. -auto Changes the service startup mode to automatic (default). -remove Removes the service (and stops it if it was started). -status Shows the service status. 12.4 Additional Configuration Options Additional configuration options for DebugAngel are available under the Windows registry key HKEY_LOCAL_MACHINE\SOFTWARE\Dialogic\DebugAngel.
Diagnostics Management Console (DMC) Reference 13. 13 This chapter describes the Diagnostics Management Console (DMC) GUI. The following information is included: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 • Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 • DMC Main Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Diagnostics Management Console (DMC) Reference 13.2 Guidelines When you launch the DMC, you will see a list of the available diagnostic tools and log files. The DMC provides an easy means of accessing the tools and log files from one central location, but you must know what you want to do with a given tool or log file and how to use it. Information about diagnostic tasks and tools is provided in this Diagnostics Guide. 13.
Diagnostics Management Console (DMC) Reference 13.3.1 Menu Bar The main window of the DMC has a menu bar along the top part of the window. This menu bar allows you to access several drop-down menus. Most actions on these menus can also be performed using shortcut keys. The menus, menu items, and shortcut keys are as follows: File • Open log file (CTRL+O) - Opens the log file that is selected (highlighted) in the log file panel.
Diagnostics Management Console (DMC) Reference Viewing a log file To view a log file, locate the file you want in the log file list, click on it to highlight it, and then press Enter or select Open log file from the File menu or use the CTRL+O shortcut. You can also double-click on the log file name to view it. The viewer that is associated with a given log file and located on the local machine will be used to view the log file.
Diagnostics Management Console (DMC) Reference Figure 6. DMC Configuration Dialog You can modify the following settings using the DMC Configuration Dialog: • Log File Directory: This field shows the location where the DMC will search for log files. If this field is empty or invalid, the DMC will use the environment variable INTEL_DIALOGIC_LOG to specify the log file directory. This field is read-only by default. A Browse button allows you to select a directory for this field.
Diagnostics Management Console (DMC) Reference The DMC configuration settings are stored in a dmc.properties file even when the DMC is shut down. When you start the DMC, it will reload the settings from this file. If this file is not found or cannot be read for any reason, the DMC will use default values hard coded in the application. If there is an error in saving the file for any reason (for example, unavailable disk space or I/O errors of any kind), the DMC will notify you and abort saving the values.
DigitDetector Reference 14. 14 This chapter provides reference information about the DigitDetector tool.The following topics are included: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 • Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 • Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DigitDetector Reference digitdetector -board 0 -line 1 -chan 1 78 System Software Diagnostics Guide — September 2006
Dlgsnapshot Reference 15. 15 This chapter provides reference information about the Dlgsnapshot tool. The following topics are included: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 • Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 • Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Dlgsnapshot Reference When boards are downloaded and you run Dlgsnapshot manually, a question is posed about running diagnostic firmware. You must confirm that you want Dlgsnapshot to stop the running board and download diagnostic firmware. Each core dump file is named according to the type of fault detected and the date/time the fault occurred.
Dlgsnapshot Reference [DM3] ;DETECTOR_AGENT = libdlgdm3detectoragent FAULTDETECTOR_AGENT = libdlgdm3faultdetectoragent ;INITIALIZER_AGENT = libdlgdm3initializeragent ;CLOCKING_AGENT = libdlgdm3clockagent ;DIAGNOSTIC_AGENT = libdlgdm3diagagent You must change it to the following (bold text shows the changed line): [DM3] ;DETECTOR_AGENT = libdlgdm3detectoragent FAULTDETECTOR_AGENT = libdlgdm3faultdetectoragent ;INITIALIZER_AGENT = libdlgdm3initializeragent ;CLOCKING_AGENT = libdlgdm3clockagent DIAGNOSTIC_AG
Dlgsnapshot Reference -p Dumps the print buffer of the processor specified with the -r option on the board with the given physical bus number. -b -s Dumps the print buffer of the processor with the -r option on the board with the given PCI bus number and given PCI slot number. -h Displays the help screen. -v Displays the version number of Dlgsnapshot.
16 DM3Insight Reference 16. This chapter provides information about the DM3Insight tool. DM3Insight is a tool used to capture message and stream traffic from the DM3 device driver.
DM3Insight Reference 84 System Software Diagnostics Guide — September 2006
DM3post Reference 17. 17 This chapter provides reference information about the DM3post tool. The following topics are included: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 • Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 • Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DM3post Reference 17.3 Options The following command line options are used with the DM3post tool: -s slot number (required). On Windows systems, use Use the Configuration Manager (DCM) to obtain the board’s slot number. On Linux systems, use the listboards utility, which is described in the Administration Guide for the software release.
DM3post Reference Example 2: Dm3 post run with the reset option on a board in slot 17, bus 0 The following example runs DM3post with the reset option on a board in slot 17, bus 0: dm3post -s17 -b0 -r You will get the following response: You have chosen to run diagnostics on the board in slot 17, bus 0. Do you wish to continue (y/n)? If you answer Y, the following will be printed to the screen: dm3post processing... The success/failure message will be printed to the screen when POST is complete.
DM3post Reference 88 System Software Diagnostics Guide — September 2006
GCEV_TRACEDATA Reference 18. 18 This chapter describes the data layout in the GCEV_TRACEDATA event so that a parser can be designed. This chapter also provides a sample parser and sample output. This information is provided in the following sections: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 • Structure of Data - Tracing CAS Signaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
GCEV_TRACEDATA Reference Table 1. Structure of Data - Tracing CAS Signaling Field Size of Field Data Type 1 Timestamp 4 Length of Payload / Channel Number* 2 Payload N Data Type 1 Timestamp 4 Length of Payload / Channel Number 2 Payload N ... ... ... *The most significant 5 bits represent the channel number and the least significant 11 bits represent the length of the payload.
GCEV_TRACEDATA Reference 18.3 Structure of Data - Tracing ISDN Trunks Table 2 shows the structure of the data, listing the fields and size of each field. A description of the fields follows the table. Table 2. Structure of GCEV_TRACEDATA Data for ISDN Field Size of Field Send/Receive Flag 4 Timestamp 4 Payload N Following are descriptions of the fields listed in Table 1-3: Send/Receive Flag When this field has a value of 01, it indicates a frame sent by the firmware to the network.
GCEV_TRACEDATA Reference CAS Data (data type field = 02H) This data type represents an event indicating a raw transition detected by the firmware. The structure of the payload is as follows: struct CAS_Transition { unsigned int32 unsigned int8 unsigned int8 unsigned int32 unsigned int32 }; Label; PreTransitionCode; PostTransitionCode; Direction; Timestamp; Terms in the above payload structure are defined as follows: Label Label is significant to the firmware only.
GCEV_TRACEDATA Reference SigDet ON Data (data type field = 08H) This data type represents an MF or DTMF signal ON condition in the firmware Signal Detector, and is represented by the following structure: struct SigDet_ON unsigned unsigned unsigned unsigned unsigned unsigned unsigned unsigned unsigned }; { int32 int32 int8 int8 int8 int16 int16 int32 int32 EventLabel; SignalId; SignalLabel[4]; LabelSize; RepCount; Freq1; Freq2; OnTime; OffTime; Terms in the above structure are defined as follows: EventLa
GCEV_TRACEDATA Reference unsigned int8 LabelSize; }; Terms in the above structure are defined as follows: EventLabel EventLabel is significant to the firmware only. It can be ignored by the host application receiving the GCEV_TRACEDATA event. SignalID SignalID identifies the signal that triggered. SignalLabel An array of bytes that identifies the signal that triggered. LabelSize The number of valid unsigned int8's in SignalLabel. 18.4.
GCEV_TRACEDATA Reference // // // // // // TraceData->seq_no TraceData->data_size TraceData->data_buf (unsigned long) (unsigned short) (char[data_size]) Ideally allow selective output on a per timeslot basis #include #include #include #include #include
GCEV_TRACEDATA Reference return; } printf("Seq# Bytes\n"); // get seq while(fread(&iSeq, sizeof(unsigned long), 1, hInFile) == 1) { // get size of payload if(fread(&iSize, sizeof(unsigned short), 1, hInFile) != 1) { mdfReadError("Payload Size"); } printf("%3u %4u\n", iSeq, iSize); fprintf(hOutFile, "# Timestamp Chan TxABCD RxABCD TxR2 RxR2 Sequence No.
GCEV_TRACEDATA Reference unsigned long Timestamp; // read all the 'parts' from the file // [Tried using a structure but always read the wrong size??] if(fread(&LenChan, sizeof(unsigned short), 1, hInFile) != 1) { mdfReadError("CAS LenChan"); } if(fread(&Label, sizeof(unsigned long), 1, hInFile) != 1) { mdfReadError("CAS Label"); } if(fread(&PreCode, sizeof(unsigned char), 1, hInFile) != 1) { mdfReadError("CAS PreCode"); } if(fread(&PostCode, sizeof(unsigned char), 1, hInFile) != 1) { mdfReadError("CAS Po
GCEV_TRACEDATA Reference if(fread(&ToneID, sizeof(unsigned char), 1, hInFile) != 1) { mdfReadError("R2MF ToneID"); } // Timeslot is in Most Significant 5 bits fprintf(hOutFile, "%02d ", (LenChan & 0xF800) >> 11); fprintf(hOutFile, "%s", ((ToneID & 0x80) >> 7) ? " " : " "); fprintf(hOutFile, "%2d", ToneID & 0x7F); // // ", // // // fprintf(hOutFile, "%s%2d%s", ((ToneID & 0x80) >> 7) ? " ToneID & 0x7F, ((ToneID & 0x80) >> 7) ? " fprintf(hOutFile, "%s", mdfByte2Bin(ToneID)); " : " " : " "); fprintf(hOu
GCEV_TRACEDATA Reference if(fread(&Freq1, sizeof(unsigned short), 1, hInFile) != 1) { mdfReadError("ToneOn Freq1"); } if(fread(&Freq2, sizeof(unsigned short), 1, hInFile) != 1) { mdfReadError("ToneOn Freq2"); } if(fread(&OnTime, sizeof(unsigned long), 1, hInFile) != 1) { mdfReadError("ToneOn OnTime"); } if(fread(&OffTime, sizeof(unsigned long), 1, hInFile) != 1) { mdfReadError("ToneOn OffTime"); } // Timeslot is in Most Significant 5 bits fprintf(hOutFile, "%02d ", (LenChan & 0xF800) >> 11); fprintf(hOutFi
GCEV_TRACEDATA Reference { mdfReadError("ToneOff SigLabel"); } if(fread(&LabelSize, sizeof(unsigned char), 1, hInFile) != 1) { mdfReadError("ToneOff LabelSize"); } // Timeslot is in fprintf(hOutFile, fprintf(hOutFile, // fprintf(hOutFile, fprintf(hOutFile, // fprintf(hOutFile, // fprintf(hOutFile, // fprintf(hOutFile, // fprintf(hOutFile, fprintf(hOutFile, SigLabel[4]); fprintf(hOutFile, fprintf(hOutFile, } Most Significant 5 bits "%02d ", (LenChan & 0xF800) >> 11); "SIG_OFF"); " EvtLabel:0x%x", EvtLabel)
GCEV_TRACEDATA Reference char* mdfLsNibble2Bin(unsigned char Code) { static char sTemp[5]; sTemp[0] sTemp[1] sTemp[2] sTemp[3] sTemp[4] = = = = = ((Code & 0x08) >> 3) ? '1' : '0'; ((Code & 0x04) >> 2) ? '1' : '0'; ((Code & 0x02) >> 1) ? '1' : '0'; (Code & 0x01) ? '1' : '0'; '\0'; return sTemp; } char* mdfMsNibble2Bin(unsigned char Code) { static char sTemp[5]; sTemp[0] sTemp[1] sTemp[2] sTemp[3] sTemp[4] = = = = = ((Code & 0x80) >> 3) ? '1' : '0'; ((Code & 0x40) >> 2) ? '1' : '0'; ((Code & 0x20) >> 1)
GCEV_TRACEDATA Reference 18.6 Sample Parser Output Following is sample parser output from one complete CAS call (this does not apply to ISDN). # Timestamp Chan TxABCD RxABCD TxR2 RxR2 0:09:14.124 01 1001 0:09:14.220 01 0001 0:09:14.400 01 1101 0:09:14.508 01 10 0:09:14.632 01 1 0:09:14.692 01 1 0:09:14.812 01 1 0:09:14.872 01 7 0:09:14.996 01 1 0:09:15.056 01 7 0:09:15.176 01 5 0:09:15.236 01 1 0:09:15.360 01 5 0:09:15.420 01 10 0:09:15.604 01 5 0:09:15.604 01 1 0:09:15.784 01 5 0:09:15.784 01 8 0:09:15.
Getver Reference 19. 19 This chapter provides reference information about the getver tool. • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 • Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 • Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 19.
Getver Reference • -CPU is a case-sensitive option argument to be used for srec files only if getver fails. Some possible values are PPC, ONYX, and C6X. Note: 19.3 You must specify the path to the file if you do not execute getver from the directory in which the file is located (in this case, the data directory). Output Getver will print the version string of the specified file to the screen unless it encounters an unknown versioning format.
ISDN Trace Reference 20. 20 This chapter provides reference information about the ISDNtrace tool.The following topics are included: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 • Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 • Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ISDN Trace Reference The following example runs the ISDNtrace tool on board 0, D-channel 1 and prints the output to a trace.txt file: isdntrace -b0 -d1 -f trace.
Intel Telecom Subsystem Summary Tool Reference 21. 21 This chapter describes the Intel® Telecom Subsystem Summary Tool (its_sysinfo) and the information it collects. This chapter contains the following information about its_sysinfo: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 • Command Line Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Intel Telecom Subsystem Summary Tool Reference and compress it into the zip file. If you do not specify any filename, then the information gets compressed in a zip file with the default name its_sysinfo.zip. 21.3 Graphical User Interface (Windows only) On a Windows system, you can use a GUI to run its_sysinfo as follows: 1. Click on its_sysinfo.exe in %INTEL_DIALOGIC_DIR%\bin. 2. Click the Generate button.
Intel Telecom Subsystem Summary Tool Reference information about CONFIG files, refer to the configuration guide(s) for the system release. – Global Call Configuration – its_sysinfo collects information about the Global Call PDK subsystem configuration, which is contained in the pdk.cfg file. This file specifies the Global Call protocol modules and the country dependent parameter settings downloaded to each device.
Intel Telecom Subsystem Summary Tool Reference Table 3. Log Files Archived by its_sysinfo (Continued) Log Files RTF log Files Windows Linux /rtflog*.txt /rtflog*.txt found in $(INTEL_DIALOGIC_DIR)\cfg\RtfConfigwin.xml or $(DLCFGPATH)\rtfconfig.xml specified in $(INTEL_DIALOGIC_DIR)/cfg/RtfConfigLinux.xml /rtflog.txt /rtflog*.txt specified in specified in $(DLCFGPATH)\rtfconfig.
Intel Telecom Subsystem Summary Tool Reference • 0 or more files as attachments. The HTML file will contain links and explanations of the attachments. • An application operation log file generated the during data collecting process. • The operation log files and attachments will be put in the compressed zip file.
Intel Telecom Subsystem Summary Tool Reference 112 System Software Diagnostics Guide — September 2006
KernelVer Reference 22. 22 This chapter provides reference information about the kernelver tool. The following topics are provided: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 • Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 22.
KernelVer Reference 114 System Software Diagnostics Guide — September 2006
MercMon Reference 23. 23 This chapter provides reference information about the MercMon tool.The following topics are included: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 • Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 • Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MercMon Reference NumCanTakes returns the number of “can takes” received for that board NumReads returns the total number of read requests sent down to the protocol driver NumSends returns the total number of messages sent down to the protocol driver NumWrites returns the total number of write requests sent down to the protocol driver NumWriteSplit returns the number of write requests, which were split for that board NumOpenedStreams returns the number of open streams on that board at any given time NumClo
MercMon Reference MsgsOutPerSramSession returns the number of messages written to the SRAM in one session NoInDataDPCisr returns the number of times when we received an interrupt but there was no data transfer between the SRAM and the HOST StrmsOutPerSramSession returns the number of streams written to the SRAM in one session (i.e., number of data blocks written) StrmsInPerSramSession returns the number of streams read from the SRAM in one session (i.e.
MercMon Reference TotalFatSramBlocks returns the number of times the system received a “CHAINED” data block (i.e., the data blocks are linked together) TotalIrpsCancelled returns the total number of cancelled requests in any queue TotalMsgInQ returns the number of requests in the Message In Queue, which are awaiting a reply from a board TotalMsgInQDone returns the number of requests completed from the Message In Queue (i.e.
MercMon Reference TotalSramGrantInterrupts returns the number of “HOST SRAM PENDING” interrupts TotalSramGrantLost not used TotalSramInterrupts returns the total number of “NORMAL” interrupts received from the board (e.g.
MercMon Reference /t display timer. The time interval (in milliseconds) between each screen refresh (default is 1000). /l logging interval. The time interval (in seconds) between each log file update (default is 600). /w enable/disable logging to a file (default is enabled) /? displays the help screen The following example enables logging to the mercmon.
PDK Trace Reference 24. 24 This chapter provides reference information about the PDK Trace tool. The following topics are included: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 • Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 • Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PDK Trace Reference 24.3 Options The PDK Trace tool uses the following command line options: -b# This required option specifies the logical board ID of the board to trace. Example: pdktrace -b0 where 0 is the logical board ID of the destination board. -l[#] or -l[#-#] Specify which trunk(s) the channels to be traced are located on. The default value is 1 (trunk 1).
PDK Trace Reference Scenario 2: For board 0, trace channels 10-20 on trunk 1 pdktrace -b0 -c[10-20] pdktrace -b0 -l[1] -c[10-20] Scenario 3: For board 0, trace channel 1 on trunks 1-4 pdktrace -b0 -l[1-4] pdktrace -b0 -l[1-4] -c[1] Scenario 4: For board 0, trace channels 1-24 on trunks 1-4 pdktrace -b0 -l[1-4] -c[1-24] Note: If any of the above scenarios were being executed on a board for the first time after it was downloaded, the -i command line option should also be used as follows: pdktrace -b0 -l[
PDK Trace Reference 124 System Software Diagnostics Guide — September 2006
Phone Reference 25. 25 This chapter provides reference information about the Phone tool. The following topics are included: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 • Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 • Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Phone Reference 126 System Software Diagnostics Guide — September 2006
PSTN Diagnostics Tool Reference 26. 26 This chapter provides the following reference information about the PSTN Diagnostics tool (pstndiag): • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 • Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 • Preparing to Run the PSTN Diagnostics Tool . . . . . . . . . . . . . . . . . . . . . . . . . . .
PSTN Diagnostics Tool Reference 26.2 Guidelines The following restrictions apply to the pstndiag tool: • The tool is not supported on boards based on Springware architecture. • It is recommended that you view or monitor no more than 8 channels in your system at one time. Viewing more than 8 channels at one time may negatively impact system performance. • The pstndiag tool will only identify and list boards with PSTN front-end interfaces.
PSTN Diagnostics Tool Reference To start the pstndiag tool in Linux, type pstndiag from the command line of a cmd prompt. No arguments are required because the path is set by the install of the Intel Dialogic System Release software. Notes: 1. You can specify options at the command line. For more information on these options, see Section 26.7, “PSTN Diagnostics Command Line Options”, on page 137. 2.
PSTN Diagnostics Tool Reference The numbering convention, x.y.z, is used to identify a component in the tree, for example “Channel 0.2.1”, where: • x is an integer that represents the board logical ID, in this example 0 • y is an integer that represents the trunk on that board, in this example 2 • z is an integer that represents the channel number on that trunk, in this example 1 If only one number is used in the identifier, this number represents the board, such as Board 0 and Board 1.
PSTN Diagnostics Tool Reference ResetLineDevice.. button in Figure 9 toggles between setting a channel in service and out of service. Figure 9. Toggle Command Buttons Examples of command buttons that issue a command directly are the MakeCall, DialDigits, Drop, and Release buttons in a channel level view shown in Figure 10. Click on a button to issue a command. Figure 10. Direct Command Buttons Following is a list of the option buttons.
PSTN Diagnostics Tool Reference Drop Delete a call DialDigits Generate signals for selecting and establishing a connection Release Release the active call on the channel. Figure 12.
PSTN Diagnostics Tool Reference The commands under this button are as follows: HoldCall Place a call on hold. A call that is on hold is disconnected from the external receive and transmit data streams that are associated with the Telephony Service Channel (TSC) instance. Once the call is on hold, the client is free to establish a new call, either by making an outbound call, or by receiving an inbound call. RetrieveCall Retrieve a call that is on hold, and bring it to the active state.
PSTN Diagnostics Tool Reference Figure 15. Call Transfer Command Buttons SendISDN Command Note: The following command is an advanced function for technical support use only. The command under this button is as follows: SendISDN Sends an arbitrary call-associated Q.931 ISDN Message. Figure 16. SendISDN Command Button Misc. Commands Note: The following commands are advanced functions for technical support use only.
PSTN Diagnostics Tool Reference External Applications The Audio command is not functional. Figure 18. External Application Command Button 26.4.5 Keyboard Navigation You can use the following keyboard keys to navigate through the pstndiag tool: Up Arrow/Down Arrow Scrolls through devices in the tree. Left Arrow/Right Arrow Collapses or expands a level in the tree. Return or Double-click When a component is highlighted, creates a view for this component in the upper pane.
PSTN Diagnostics Tool Reference The log file generated by the pstndiag tool captures all events associated with your use of this tool. There are two types of events: application events (AppEvent) and message events (MsgEvent). The application events are generated as actions occur in the pstndiag tool; for example, line out of service. Message events are messages from the firmware in response to application events or asynchronous events; for example, trunk active.
PSTN Diagnostics Tool Reference 26.6.3 View menu The View menu contains the following menu options: Open system view Opens a system level view. Open new view Opens a board, trunk, or channel level view. 26.6.4 Help menu The Help menu contains the following menu options: About Displays the version number of the pstndiag tool as well as copyright information. Command line Displays information about command line options. General information Displays information about menus, menu options, and views. 26.
PSTN Diagnostics Tool Reference -help Displays help information for the tool. -logto Saves log information from open views to the specified file name. -nolog Does not automatically log events for open views. -noscan Does not perform an initial system scan to determine available resources. All views must be opened manually in this mode. Using this option can reduce the time it takes for the tool to start. -openlog Starts by displaying the specified log file. The log file extension is .
QScript Reference 27. 27 This chapter provides information about QScript utilities, which are a subset of the diagnostic utilities. • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 • File Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 • QScript Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QScript Reference 27.3 QScript Environment Variables This section describes the QScript environment variables: • INTEL_DIALOGIC_QSCRIPT Environment Variable • Single Session Variable INTEL_DIALOGIC_QSCRIPT Environment Variable In a Windows environment, this variable is set during software installation. Single Session Variable Set the variable for a single session using the set command.
Runtime Trace Facility (RTF) Reference 28. 28 This chapter provides an overview of the Runtime Trace Facility (RTF), including information about editing the RTF configuration file (RtfConfigLinux.xml for Linux* and RtfConfigWin.xml for Windows*) file to set tracing configuration options. Reference information about the RTF command line options is also included. This chapter contains the following subsections: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Runtime Trace Facility (RTF) Reference • Utility program (rtftool.exe for Windows, rtftool for Linux): Command line application that allows you to execute RTF functionality from command line or shell scripts. • Utility program (RtfTrace.exe): Command line application that allows you to execute RTF functionality from command line or shell scripts. This is provided for backward compatibility only. All of this utility’s functionality is covered in rtftool.exe. 28.
Runtime Trace Facility (RTF) Reference 1 when a 1 appears next to a configuration item in the RTF configuration file, it indicates that the configuration item is enabled. The RTF configuration file’s top-level document tag is the RTFConfig tag. The following three tags are child tags of the RTFConfig tag: 1. Logfile 2. Global 3. Module Figure 19 shows the XML tag structure and tag attributes of the RTF configuration file: Figure 19.
Runtime Trace Facility (RTF) Reference The RTFConfig tag includes the following attributes: trace This attribute is used to enable or disable the RTF tracing capabilities. Valid values are as follows: 0 RTF tracing is disabled. 1 RTF tracing is enabled. This is the default setting.
Runtime Trace Facility (RTF) Reference – LabelWidth number - Allows you to customize the number of characters that appear in the Label column. The default setting is 10.There is no maximum setting. 2. Using the ALIGN setting makes the log file easier to read but it does not make efficient use of hard drive space. This inefficiency is exacerbated as the log file grows. The UNALIGN format is separated by commas so it can be parsed by a spreadsheet or database program to make the file easier to read. 28.3.
Runtime Trace Facility (RTF) Reference Notes: 1. Due to the internal buffers used by RTF, the actual size of the log file may be up to 1 MB larger than the size attribute’s value. For example, if the size attribute is set to 1000 KB, the actual log file may grow up to 2000 KB. 2. This attribute is only applicable when RTF preservation mode is turned OFF. When RTF preservation mode is ON, the preserve_size attribute determines the size of the log file. Refer to Section 28.5.
Runtime Trace Facility (RTF) Reference preserve_maxbackups Indicates the maximum number of backup log files the RTF creates when the RTF is run with preservation mode turned ON. If this attribute is set to 0, all trace information is written to one log file. If this attribute is set to 1 or greater, all trace information is initially written to one log file.
Runtime Trace Facility (RTF) Reference or the Global tag can have GLabel and/or GClient child tags. There are no attributes associated with the Global tag. 28.3.4 GLabel Tag The GLabel tag is a child tag of the Global tag; it is used to configure global labels. If a label is defined at the GLabel level then all module and client behavior will be governed by this configuration (unless overridden for a given module at the MLabel level).
Runtime Trace Facility (RTF) Reference state Specifies the state of the label. Valid values are as follows: 1 Label is enabled at the global level. All trace messages associated with this label will be sent to the trace output. This is the default value. 0 Label is disabled at the global level. Trace messages associated with this label will not be sent to the trace output. 28.3.5 GClient Tag The GClient tag is a child tag of the Global tag; it is used to configure global clients (devices).
Runtime Trace Facility (RTF) Reference name Indicates the name of a client label to be configured. You must define the name of the client label; there is no default value. Examples of possible client labels include: • “Error” • “Warning” • “Entry” Note: Refer to the default RTF configuration file’s MLabel name attributes. These default entries are for the Intel Dialogic runtime libraries. Any of these runtime library label names can be included in a GClientLabel tag.
Runtime Trace Facility (RTF) Reference The Module tag includes the following attributes: name Indicates the name of a module to be configured. Intel Dialogic runtime libraries have module names in the default RTF configuration file. Example module names in the RTF configuration file include: • “gc” • “libsrl” • “spwrdevmgmt” state Specifies the state of the module. Valid values are as follows: 1 Module is enabled. Trace messages associated with this label will be sent to the trace output.
Runtime Trace Facility (RTF) Reference 0 Label is disabled. Trace messages associated with this label will not be sent to the trace output. Note: 28.3.9 When the state attribute is not included or not defined, the default value is 1. However, the Intel Dialogic runtime library module labels that exist in the default RTF configuration file have their state attribute initially set to 0. MClient Tag The MClient tag is a child tag of the Module tag; it is used to configure a specific client for the module.
Runtime Trace Facility (RTF) Reference • “DEBG” • “WARN” Note: A complete list of labels for a given library can be found in the RTF configuration file. state Specifies the state of the label. Valid values are as follows: 1 Label is enabled. Trace messages associated with this label will be sent to the trace output. This is the default value. 0 Label is disabled. Trace messages associated with this label will not be sent to the trace output. 28.3.
Runtime Trace Facility (RTF) Reference 28.4 Restrictions and Limitations Keep the following restrictions and limitations in mind when using RTF: • If you run full RTF logging on high-density systems, you may experience I/O throughput degradation. It is recommended that you do not run RTF with full logging on high-density systems or any field-deployed systems. Instead, use just the default error-enabled logging.
Runtime Trace Facility (RTF) Reference • rtflog--hm.s.txt when preservation mode is OFF. • rtflog--hm.s_p.txt when preservation mode is turned ON. 4. The Global configuration section can only appear one time in the RTF configuration file. 5.
Runtime Trace Facility (RTF) Reference 28.5 rtftool Command This section explains the rtftool command, which is used to control RTF and modify the trace output. The rtftool command is issued from the command line. The rtftool command can be issued from any directory. 28.5.1 Pausing and Reloading RTF RTF tracing is enabled by default. Use the rtftool command to pause, resume and reload the RTF’s tracing capabilities.
Runtime Trace Facility (RTF) Reference 28.6 Example RTF Configuration Files This section provides a number of example RtfConfig*.xml files along with a brief explanation of how the file settings affect the RTF trace output. Note that the same rules/examples covered in this section apply to both the RtfConfigWin.xml and RftConfigLinux.xml file. 28.6.1 Example 1: Tracing disabled - RtfConfigWin.xml
Runtime Trace Facility (RTF) Reference MLabel name="ERR1" state = "1"/> MLabel name="WARN" state = "1"/> Explanation The RTFConfig tag’s trace attribute is set to 1 so tracing is enabled. The Global tag is empty, so there is no global configuration. For this example, tracing is only configured at the module level. The path for the log file is $(INTEL_DIALOGIC_DIR)/log.
Runtime Trace Facility (RTF) Reference /MClient> Explanation The trace attribute of the RTFConfig tag is set to 1 so tracing is enabled.
Runtime Trace Facility (RTF) Reference The dtintf module is configured to trace “Entry” (from the global section). “dxxxB1C2” in dtintf is configured to trace “Entry” (from the global section) and “Exit” (from the global client). The other client “dxxxB2C1” is configured to trace “Entry” (from the global configuration) and “EXCE” (from the module client section). All other clients of this module are configured to trace “Entry” (from the global section) since these labels are configured for the module. 28.
Runtime Trace Facility (RTF) Reference Figure 20. RTF Configuration File Edited to Configure the Client System 28.7.3 Configuring the Server System To configure the server system, edit the RTF configuration file (RtfConfigLinux.xml for Linux and RtfConfigWin.xml for Windows) as follows: 1. Locate the line containing the tag Network mode= and set its value to "server". The value of server_name= must be 127.0.0.1. 2.
Runtime Trace Facility (RTF) Reference 28.7.5 Disabling Remote Logging To disable remote logging, set the value of Network mode= to "off". The Intel® Dialogic® system release software ships with remote logging disabled.
RTFManager Reference 29. 29 This chapter describes how to use the Runtime Trace Facility Manager GUI (RTFManager) to configure the trace levels and output of the Runtime Trace Facility (RTF) utility. This chapter contains the following information: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 • Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RTFManager Reference • filter trace data, allowing you to customize the trace output so that only certain trace statements are stored • customize the format, readability, and location of the log files • limit the size of the log files • define the number of rolling backup log files to keep. 29.2 Guidelines Guidelines applicable to RTFManager can also be found in Section 28.4, “Restrictions and Limitations”, on page 154.
RTFManager Reference • Edit • Tools • Help 29.4.1 File The File menu contains options for working with the log files. The File menu contains the following options: Open Opens a previously saved log file. Close Closes the open log file. Save Saves the open log file. Save As Saves a copy of the log file under a different name or in a different location. Exit Closes the Runtime Trace Facility Manager. 29.4.
RTFManager Reference Select All Selects all text in the log file. 29.4.3 Tools The Tools menu contains options for filtering the log file that is displayed in the Runtime Trace Facility Manager main window and configuring the RTF trace capabilities. The Tools menu contains the following options: Filter... Launches the Filters dialog box. The Filters dialog box allows you to selectively display certain trace statements in the log file. Refer to Section 29.
RTFManager Reference The general tab contains the following settings: Enable Global Tracing? This check box is used to enable or disable the RTF tracing capabilities. If the box is checked, RTF tracing is enabled. If the box is not checked, RTF tracing is disabled. Note: Enable/disable means RTFManager will modify the RTF configuration file to change certain values to enable/disable a group of modules. RTFManager will reload the RTF to let the change take effect.
RTFManager Reference • 1 or greater - Backup log files will be created. All trace information is initially written to one log file. When the size of this log file reaches the threshold defined in the Logfile Size attribute, the initial log file is saved and the trace data is written to a second log file. This sequence occurs until the threshold is reached. Note: There is no limit to the maximum backups imposed by the RTF itself.
RTFManager Reference Figure 22. RTFManager Filtering Tab The following procedure describes how to use the Runtime Trace Facility Manager Configuration window’s Filtering tab: 1. The top row of check boxes represents several Intel® telecom product families (DM3, Springware, Host Media Processing). To trace a library that runs on a given product family, you must populate the check box for the product family.
RTFManager Reference • Errors - Traces the following labels: ERR1, ERR2, EXCE, and EINF. This is the lowest slider setting, so these tags are always traced. • Warnings - Traces the WARN label in addition to the Error labels. • Program Flow - Traces the INTF, INFO, and APPL labels in addition to the Warning and Error labels. • Debugging - Traces the DEBG label in addition to the Program Flow, Warning, and Error labels. All trace labels are enabled at this level.
RTFManager Reference 29.8 Advanced Tab The Advanced tab is not recommended for most users. Most users should only adjust settings using the Filtering Tab and General Tab as described above. Those using the Advanced tab must obtain specific directions on which settings to use. The Advanced tab should primarily be used by Intel developers to modify a custom RTF configuration file. These custom configuration files are used for specific troubleshooting purposes.
RTFManager Reference 172 System Software Diagnostics Guide — September 2006
Status Monitor Reference 30. 30 This chapter provides reference information about the Status Monitor tool. This chapter contains the following information: • Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 • Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 • Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Status Monitor Reference Figure 23. Example of Status Monitor Output The following numbered list corresponds to the labels in Figure 23. 1. You can toggle between monitored boards by clicking on the tab that represents the board ID. 2. This part of the display shows the current alarm state on the trunk (red, yellow, or green). 3. Use this button to invoke the Lineadmin tool to view and set additional alarms. 4. This part of the display allows you to monitor the call state for each line on the board. 5.
Glossary ANI: Automatic Number Identification. A telephone service that provides the telephone number of an incoming call. ANI is also known as Caller ID. Automatic Number Identification: See ANI. B channel: A bearer channel that carries the main data. bit oriented : Communications protocols in which control information may be coded in a single bit. CAS: Channel Associated Signaling.
metallic circuit: A circuit in which metallic conductors are used and in which the ground or earth forms no part. metallic loopback: Metallic loopback loops the data back to the network at the physical port on the back card of a service module, whereas local loopback loops the data back to the network through the framer in the service module. OSD: Operating System Distribution.
Index A ALIGNED 144 APPL 170 application failure or crash 44 archiving system configuration 44 B Binary 167 board, checking 27 board, processor or SRAM fault on 29 C CallInfo tool 63 CAS bit transitions/states 47 CAS data 92 CAS signaling 89 CAS Trace tool 65 check network connection 31 checking an individual DM3 architecture board 27 checking the protocol configuration 35 class driver counters 115 client 142 Client Width 168 ClientWidth 144 collecting the system data 44 command line options pstndiag tool
GLabel tag 148 Global Call 15, 56, 125 Global tag 147 I INFO 170 Intel Telecom Subsystem Summary Tool 44 INTF 170 IPT 169 ISDN D-channel 105 ISDN D-channel trace 55 ISDN payload format 94 ISDN trunks 91 ISDN-related messages 63 ISDNtrace tool 105 its_sysinfo 44 Media 169 menu bar of DMC 73 mercmon class driver counters 115 protocol driver counters 116 MLabel 150 MLabel tag 151 module 142 Module Width 168 ModuleWidth 144 N network connection, checking 31 O OAM 169 K P KernelVer tool 113 path 145 PDK
RtfConfigWin.
