Table of Contents Index NMS Glossary Previous Page Next Page Version


Chapter 8

Other Utilities


8.1 Introduction
8.2 PCI BIOS Test Utility: biostest
8.3 AG Board Locate Utility: blocate
8.4 Hot Swap Manager: hsmgr
8.5 Hot Swap Monitor: hsmon
8.6 Hot Swap Driver Service (UNIX only): hssrv
8.7 Board Locate Utility: pciscan
8.8 Show Switch Connections: showcx95
8.9 Digital Trunk Status Utility: trunkmon

8.1 IntroductionTop of Page

This chapter describes the following programs:
Program

Description

biostest

Verifies that the PCI BIOS is Hot Swap-compatible.

blocate

Identifies a PCI board visually.

hsmgr

Hot Swap Manager.

hsmon

Monitors the Hot Swap Manager.

hssrv

Hot Swap Driver service (UNIX only).

pciscan

Determines PCI and CompactPCI bus and slot locations.

showcx95

Displays switch connections.

trunkmon

Displays the status of digital trunks.

8.2 PCI BIOS Test Utility: biostestTop of Page

Name

biostest

Purpose

Displays information about the system BIOS's compatibility with the Hot Swap specification. Used to verify that a CompactPCI BIOS is Hot Swap-compatible.

Usage

The following table lists valid command line options:
Options

Description

-v

Causes biostest to display all information.

-w

Causes biostest to wait before exiting.

-h

Causes biostest to display its help screen, and terminate.

Description

biostest verifies the BIOS ability to get PCI routing table information and checks routing for compliance with the Compact PCI Hot Swap Specification. It also provides information about PCI-PCI bridges and memory windows behind them. If the utility finds a known PCI interrupt router like INTEL 7000(PIIX3) or 7110(PIIX4) PCI-ISA bridges, it compares the information from PCI BIOS with data from the interrupt router. biostest also provides information about pairs of interrupt lines and IRQs.

Procedure

To run biostest, enter the following:

biostest -v

The following report is displayed:

BIOS Version: 
BIOS Date: 01/22/97

PCI 32 BIOS Interface Level:  2.10 
Last PCI Bus Number: 2 
Config Mechanism # 1 Supported
Special Cycle Support Found via Config Mechanism # 1

Verifying Ability To Obtain PCI Interrupt Routing Information

Checking GET_IRQ_ROUTING_OPTIONS PCI BIOS Function.

Displaying PCI Interrupt Routing Information

PCI Dedicated IRQ Bitmap : 0000


 BUS# : 00 DEV# : 00 SLOT# : 00
 Interrupt A - Link Value : 00 IRQ Bit Map : 0000
 Interrupt B - Link Value : 00 IRQ Bit Map : 0000
 Interrupt C - Link Value : 00 IRQ Bit Map : 0000
 Interrupt D - Link Value : 00 IRQ Bit Map : 0000

 BUS# : 00 DEV# : 02 SLOT# : 00
 Interrupt A - Link Value : 00 IRQ Bit Map : 0000
 Interrupt B - Link Value : 00 IRQ Bit Map : 0000
 Interrupt C - Link Value : 00 IRQ Bit Map : 0000
 Interrupt D - Link Value : 00 IRQ Bit Map : 0000

 BUS# : 00 DEV# : 02 SLOT# : 00
 Interrupt A - Link Value : 00 IRQ Bit Map : 0000
 Interrupt B - Link Value : 00 IRQ Bit Map : 0000
 Interrupt C - Link Value : 00 IRQ Bit Map : 0000
 Interrupt D - Link Value : 00 IRQ Bit Map : 0000

 BUS# : 00 DEV# : 02 SLOT# : 00
 Interrupt A - Link Value : 00 IRQ Bit Map : 0000
 Interrupt B - Link Value : 00 IRQ Bit Map : 0000
 Interrupt C - Link Value : 00 IRQ Bit Map : 0000
 Interrupt D - Link Value : 04 IRQ Bit Map : 0020

 BUS# : 00 DEV# : 04 SLOT# : 01
 Interrupt A - Link Value : 01 IRQ Bit Map : 0200
 Interrupt B - Link Value : 02 IRQ Bit Map : 0400
 Interrupt C - Link Value : 03 IRQ Bit Map : 0800
 Interrupt D - Link Value : 04 IRQ Bit Map : 0020

 BUS# : 00 DEV# : 05 SLOT# : 00
 Interrupt A - Link Value : 02 IRQ Bit Map : 0400
 Interrupt B - Link Value : 00 IRQ Bit Map : 0000
 Interrupt C - Link Value : 00 IRQ Bit Map : 0000
 Interrupt D - Link Value : 00 IRQ Bit Map : 0000

 BUS# : 00 DEV# : 08 SLOT# : 00
 Interrupt A - Link Value : 01 IRQ Bit Map : 0200
 Interrupt B - Link Value : 02 IRQ Bit Map : 0400
 Interrupt C - Link Value : 03 IRQ Bit Map : 0800
 Interrupt D - Link Value : 04 IRQ Bit Map : 0020

 BUS# : 00 DEV# : 0A SLOT# : 02
 Interrupt A - Link Value : 03 IRQ Bit Map : 0800
 Interrupt B - Link Value : 04 IRQ Bit Map : 0020
 Interrupt C - Link Value : 01 IRQ Bit Map : 0200
 Interrupt D - Link Value : 02 IRQ Bit Map : 0400

 BUS# : 00 DEV# : 0C SLOT# : 00
 Interrupt A - Link Value : 01 IRQ Bit Map : 0200
 Interrupt B - Link Value : 02 IRQ Bit Map : 0400
 Interrupt C - Link Value : 03 IRQ Bit Map : 0800
 Interrupt D - Link Value : 04 IRQ Bit Map : 0020

 ====== PCI-PCI BRIDGE INFO ======

PCI-PCI BRIDGE BUS# 00 DEV# 08 FUNC# 00 VEN# 1011 DEV# 0022 SEC BUS# 01
 BRIDGE MEMORY WINDOW  42100000 - 422FFFFF SIZE    2 MB
PCI-PCI BRIDGE BUS# 00 DEV# 0C FUNC# 00 VEN# 1011 DEV# 0022 SEC BUS# 02
 BRIDGE MEMORY WINDOW UNINITIALIZED 

 ====== INTERRUPT LINE INFO ======

 ACCORDING TO PCI ROUTING TABLE
 PIRQA# -> LINK VALUE 01 -> IRQ# UNINITIALIZED 
 PIRQB# -> LINK VALUE 02 -> IRQ# 0A 
 PIRQC# -> LINK VALUE 03 -> IRQ# UNINITIALIZED 
 PIRQD# -> LINK VALUE 04 -> IRQ# 05 

PCI-ISA BRIDGE BUS# 00 DEV# 02 FUNC# 00 VEN# 8086 DEV# 7000 

 ACCORDING TO INTEL PCI-ISA BRIDGE
 PIRQA# -> IRQ# 09 
 PIRQB# -> IRQ# 0A 
 PIRQC# -> IRQ# 0B 
 PIRQD# -> IRQ# 05 

THIS SYSTEM IS HOT SWAP COMPATIBLE

8.3 AG Board Locate Utility: blocateTop of Page

Name

blocate

Purpose

Used to visually identify a PCI board in a system.

Usage

blocate [ options ]

where options are:
Options

Description

pci_bus pci_slot

Specifies the PCI bus and slot location of the board on which to flash an LED.

Description

Displays the PCI bus and PCI slot number for all NMS PCI boards installed in the system. Also, flashes the red alarm LED for trunk 1 on a specified PCI board.

Note: blocate will not run if ctdaemon is running.

Procedure

To run blocate, enter: blocate

The output resembles the following:

Thu Jul 10 15:51:22 There were 1 NMS PCI card(s) detected
BUS SLOT INTERRUPT
00 14 0xf

The board configuration is also logged to an ASCII text file, pci_cfg.txt, with the current date and time. The file is created in the current working directory.

To flash an LED on a specific NMS PCI board, call blocate and specify the PCI bus and PCI slot locations as command-line arguments. For example:

blocate 0 14


The following is displayed:

Flashing LED for NMS PCI board on bus 0 slot 14


A board locator LED on the specified board end bracket flashes. To learn which LED flashes on your board model, refer to the board documentation.

8.4 Hot Swap Manager: hsmgrTop of Page

Name

hsmgr

Purpose

Starts the Hot Swap Manager.

Usage

hsmgr [ options ]

The options are:
Options

Description

-h, -?

Prints usage.

-b | -m

Indicates the Hot Swap Manager state diagram: board driven or management driven. Default: board driven.

-o log_file

Specifies an output log file for messages instead of writing to standard output.

-n

Disables display of messages and states.

Windows NT Options

Description

-i

Installs the Hot Swap Manager as a Windows NT service. This is done during CT Access installation.

-c

Starts the Hot Swap Manager as a console application.

-u

Uninstalls the Hot Swap Manager Windows NT service. This is done by removing CT Access.

Unix Options

Description

-k

Kills previous instance of the daemon.

-d

Starts the Hot Swap Manager as a daemon.

Description

When debugging Hot Swap applications, use hsmgr to run the Hot Swap Manager in console mode to see Hot Swap Manager messages.

The Hot Swap Manager must be running in order to use the Hot Swap service. When CT Access is installed, the Hot Swap Manager is installed as a Windows NT service. The Hot Swap Manager Windows NT service is configured to be started manually.

Procedure

      1. Stop hsmgr:

        
        Under Windows NT:
        Select Services from the Windows NT Control Panel.

        
        
        Highlight Hot Swap.

        
        
        Stop the Hot Swap Manager by selecting Stop.

        
        Under Unix:
        Run the Hot Swap Manager with the option -k, to stop any previous instance of the manager:

        
        
        hsmgr -k

        
        
      2. Start the Hot Swap Manager in console mode by entering:

        
        hsmgr -c
        Note: If you are running the Hot Swap Manager in console mode, ensure that the Hot Swap driver is running, otherwise startup will fail.
    If the print option is on (default), messages are displayed as boards are inserted and extracted. Each message is displayed in the following format:

    direction destination pci_bus, pci_slot hsmessage
    Field

    Description

    direction

    Indicates direction of message:

    · > indicates an output message

    · < indicates an input message.

    destination

    Label given to an application (for example, hsmon) or the label for querying a board (for example, QSlotI).

    pci_bus, pci_slot

    The CompactPCI bus and slot location.

    hsmmessge

    Hot swap Manager message indicating the hot swap state or message.

    
    
    For example:

    >QSlotI   0,9 HSM_REPLY_SLOT_BY_IDENT_DATA
    <QSlotI   0,0 HSM_OPEN_CONNECTION
    <QSlotI   0,0 HSM_QUERY_SLOT_BY_IDENT_DATA
    >QSlotI   0,9 HSM_REPLY_SLOT_BY_IDENT_DATA
    <QSlotI   0,0 HSM_CLOSE_CONNECTION
    <QState   0,0 HSM_OPEN_CONNECTION
    <QState   0,9 HSM_QUERY_HSM_STATE
    >QState   0,9 HSM_REPLY_HSM_STATE  status HSMS_P0
    <QState   0,0 HSM_CLOSE_CONNECTION
    <OAM      0,0 HSM_OPEN_CONNECTION
    <OAM      0,0 HSM_CLOSE_CONNECTION
    <HSMON    0,0 HSM_OPEN_CONNECTION
    <HSMON    0,0 HSM_OPEN_CONNECTION
    <HSMON    0,9 HSM_QUERY_HSM_STATE
    >HSMON    0,9 HSM_REPLY_HSM_STATE  status HSMS_P0
    <HSMON    0,0 HSM_CLOSE_CONNECTION
    <HSMON    0,0 HSM_OPEN_CONNECTION
    <HSMON    0,9 HSM_QUERY_SLOT_INFO
    >HSMON    0,9 HSM_REPLY_SLOT_INFO
    <HSMON    0,0 HSM_CLOSE_CONNECTION
    
    
    
    The following error messages may also be displayed:
    Error Message

    Description

    Error: Can't create 'hsmgr_hsd' event object

    The Hot Swap Manager cannot create the hsmgr_hsd event object. Check system resources.

    Error: Can't create 'hsmgr_hsf' event object

    The Hot Swap Manager cannot create the hsmgr_hsf event object. Check system resources.

    HSMgr: initialization error

    This message usually follows other error messages. Check to see if another copy of the Hot Swap Manager is running.

    <pci bus, slot> HSMgr internal error: Wrong transition from <old state> to <new state>

    The Hot Swap Manager encountered an error transitioning between states.

    <pci bus, slot> Skipped HSM_BOARD_CONFIGURED message

    A board preparation application sent an unexpected message.

    The following informational messages may also be displayed:
    Informational Message

    Description

    Use statediagram diagram

    On startup, the Hot Swap Manager displays the state diagram it is using.

    Changed from oldstatediagram to newstatediagram diagram

    If the state diagram changes, the Hot Swap Manager displays the new diagram information.

8.5 Hot Swap Monitor: hsmonTop of Page

Name

hsmon

Purpose

Monitors the Hot Swap Manager.

Usage

hsmon

The available commands are:
Commands

Description

s

Starts and stops the Hot Swap monitor.

i bus,slot

Insert board. Initiates management-driven insertion.

e bus,slot

Extract board. Initiates management-driven extraction.

g bus,slot

Gets the state of the specified slot.

q

Causes hsmon to terminate.

?

Causes hsmon to display its help screen, and terminate.

Description

Traces all messages from the Hot Swap Manager. Used for installation verification and diagnostics.

Procedure

      1. Make sure the Hot Swap Manager and Hot Swap driver are running.

        
        
      2. To launch the Hot Swap monitor, enter: hsmon

        
        Hot Swap Manager messages are displayed, in this format:
        < destination pci_bus, pci_slot hsmessage
        Field

        Description

        direction

        > indicates an output message and < indicates an input message.

        destination

        Label given to an application (e.g., hsmon) or the label for querying a board (e.g., QSlotI).

        pci_bus, pci_slot

        pci_bus and pci_slot are the CompactPCI bus and slot location.

        hsmmessge

        Hot Swap Manager message indicating the Hot Swap state or message.

      3. Insert a board. The following messages are displayed:

        
        < 1,12 HSM_BOARD_CONFIGURED
        < 1,12 HSM_S0_S1 Board is configured
        < 1,12 HSM_S1_S1I Device instance is created
        < 1,12 HSM_PREPARE_BOARD
        < 1,12 HSM_S1I_S1B Board preparation requested
        < 1,12 HSM_S1B_S2 Board is ready
        < 1,12 HSM_BOARD_READY
      4. Enter s to stop the Hot Swap monitor. The following messages are displayed:

        
        Stopping monitor...
        monitor stopped.
      5. Enter q to quit.

8.6 Hot Swap Driver Service (UNIX only): hssrv Top of Page

Name

hssrv

Purpose

Starts and coordinates the set of Hot Swap drivers.

Usage

hssrv [ options ]

The options are:
Options

Description

-h, -?

Prints usage.

-mc

Prints configuration related messages.

-mi

Prints information messages.

-me

Prints warnings and error messages.

-ma

Prints all messages.

-c

Starts the Hot Swap Driver service as a console application (default).

-d

Starts the Hot Swap Driver service as a daemon.

-k

Kills any previous instance of the daemon.

Description

The Hot Swap driver is comprised of a set of drivers that are coordinated by a user level application called the Hot Swap Driver service.

The Hot Swap Driver service must be running in order to use Hot Swap. When CT Access is installed, the Hot Swap Driver service is placed in the /opt/nms/hotswap/bin directory. You can start the service as a daemon or as a console application. To run the service at the boot time (recommended), add information about the program to the /etc/inittab file. For more information, see your UNIX administrator manual.

When debugging Hot Swap applications, use hssrv to run the Hot Swap Driver service in console mode to see Hot Swap Driver service messages.

Procedure

To run the Hot Swap Driver service:

  1. Stop OAM and any CT Access applications.

    
    
  2. Stop hsmgr.

    
    
  3. Run the Hot Swap Driver service with the option -k, to stop any previous instance of the service:

    
    hssrv -k
  4. Reboot the system.

    
    
  5. Start the Hot Swap Driver service in console mode by entering:

    
    hssrv -c
If the print option is on (-m[message_type]), messages are displayed as boards are inserted and extracted.

Messages are divided into three groups:

Configuration messages (messages related to a device configuration process):

hssrv: EXT ACK (1:9:0) -> S0E
hssrv: Remove 40100000-4011FFFF
hssrv: Remove 40120000-4013FFFF
hssrv: Connected through bridge (0:8)
hssrv: BASE 0 32 bit - 128.00 KB - Configure as 40100000-4011FFFF
hssrv: BASE 1 32 bit - 128.00 KB - Configure as 40120000-4013FFFF
hssrv: Assign IRQ for (1: 9)
hssrv: RT (2) - (0:5:0)
hssrv: IRQ10 configured.
hssrv: aghw - [AG PCI Board]

Error and warning messages:

hssrv: Device is not in RT table.
hssrv: Warning - SetHWInt is not supported
hssrv:         - Assuming that IRQ is preconfigured

Information messages:

hssrv: - hsbios (PCI BIOS Interface)             - Loaded.
hssrv: - hsrmgr (Resource Manager Interface)     - Loaded.
hssrv: - hshw   (CompactPCI Hardware Interface)  - Loaded.
hssrv: PCI BIOS found. 3 bus(es)
hssrv: IRQ routing table - 9 record(s)
hssrv: Check for reserved resource manager keys
hssrv: - 14 reserved key(s)
hssrv: Get current system configuration
hssrv: PCI IDE - Mark IRQ14 (Primary channel is in compatibility mode)
hssrv: PCI IDE - Mark IRQ15 (Secondary channel is in compatibility mode)
hssrv: - 8 PCI device(s) were found
hssrv: - IRQs ( 7 6 8 1 4 3 10 11 5 14 5 11 10 )
hssrv: - 16.93 MB allocated by devices
hssrv: Search for PCI2PCI bridges
hssrv: - PCI2PCI bridge at (0: 8) #0 -> #1
hssrv: - Memory window - 40100000-401FFFFF,  1 MB
hssrv: - PCI2PCI bridge at (0:12) #0 -> #2
hssrv: - Memory window - 40200000-402FFFFF,  1 MB
hssrv: Shared resources 00000001 / 0000000D
hssrv: 24 Software driver(s) configured

8.7 Board Locate Utility: pciscanTop of Page

Name

pciscan

Purpose

Determines the PCI bus and slot assignments for all NMS PCI boards installed in the system.

Usage

pciscan [ pci_bus pci_slot] [-a] [-l]

If you invoke pciscan without any command line options, it returns the locations of all NMS PCI boards in the system.

If you invoke pciscan with command-line arguments, the specified Hot Swap board flashes its Hot Swap LED.

The following table lists valid command line options:
Options

Description

pci_bus pci_slot

Specifies the PCI bus and slot location of the board on which to flash an LED.

-h, -?

Causes pciscan to show help screen, and terminate.

-a

Causes pciscan to return the locations for all PCI devices in the system, including NMS PCI boards.

-l

Causes pciscan to log output to a file, named pci_cfg.txt.

-r

Causes pciscan to show five PCI memory addresses.

-v

Causes pciscan to show register values for NMS boards.

Description

Displays the PCI bus and PCI slot number for all NMS PCI boards installed in the system. Also, flashes the LED on a specified CompactPCI board.

Procedure

To run pciscan, enter: pciscan

pciscan displays output similar to the following:

Bus Slot  NMS ID
--- ---- ------
2 11 0x50d AG CPCI Quad T1
2 13 0x6000 CG 6000
2 14 0
--- ---- -- ----------------
There were 3 NMS PCI board(s) detected
If the -l option is specified, the board configuration is also logged to an ASCII text file with the current date and time. The log is created in a file named pci_cfg.txt, in the current working directory.

Note: If the Hot Swap driver is running, the pciscan output displays additional information such as the address and interrupt assignments. If the Hot Swap driver is not running and a board is inserted, the address and interrupt values are shown as 0 for this board.

To flash the Hot Swap LED on a specific CompactPCI board, run pciscan with the PCI bus and PCI slot locations. For example:

pciscan 0 14

The Hot Swap LED on the board will flash.

8.8 Show Switch Connections: showcx95Top of Page

Name

showcx95

Purpose

Displays switch connections.

Usage

showcx95 [switching_driver]

Description

Displays the switch connections for all boards by board number. If a pattern is being sent on a timeslot, the pattern value displays.

Example

To run showcx95 for AG or CG boards, enter:

showcx95 agsw


The following example message would be displayed for an AG Quad board configured as board 0, with trunk channel 1 connected to local DSP resources (both voice and signaling):

agsw 0
L-17:00..23 <- L-00:00..23
L-01:00..23 <- L-16:00..23
L-19:00..23 <- L-02:00..23
L-03:00..23 <- L-18:00..23

In the showcx95 output, M indicates MVIP bus and L indicates Local bus.

The showcx95 output shows three types of connections:

8.9 Digital Trunk Status Utility: trunkmonTop of Page

Name

trunkmon

Purpose

Utility to display the status of digital trunks.

Usage

trunkmon [ options ]

where options are:
Option

Description

-b board

Specifies the board to monitor. Default = 0.

-?

Causes trunkmon to display its usage screen, and terminate.

Description

Displays the status of all trunks connected to the specified board. trunkmon continuously monitors the status of the trunks and updates the display if the data changes. When an alarm transition occurs, trunkmon beeps.

Procedure

To run trunkmon for board number 0:

Enter:

trunkmon


The output resembles the following:

              Digital Trunk Monitor Natural MicroSystems Ver 1.1 Sep 21 1999
Press F3 or ESC to exit)
BOARD # 0
-----------------------------------------------------------
Board start time: Wed Sep 21 14:02:46 1999

Trunk 0 Trunk 1 Trunk 2 Trunk 3
----------------------------------------------------------
Alarm NO_FRM NO_FRM NONE NONE
Remote alarm NONE NONE NONE NONE
Errored seconds: 59 59 21 59
Failed seconds: 56 56 57 57
Code Violations: 0 0 2 7
Slips: 0 0 2 7
Frame sync: No Sgnl No Sgnl OK OK
trunkmon displays the following for T1 and E1 trunks:
trunkmon Display

Description

Alarm (T1)

RED

BLUE

NONE

Red alarm or loss of frame

Blue alarm or AIS alarm

No alarm

Alarm (E1)

AIS

NO_FRM

16 AIS

NONE

All ones alarm

Loss of frame

All ones in timeslot 16

No alarm

Remote Alarm (T1)

YELLOW

NONE

Remote loss of frame

No alarm

Remote Alarm (E1)

FAULT

NO_SMF

NONE

Remote loss of frame

Remote loss of signaling multiframe

No alarm

Errored seconds

One second intervals containing one or more errors

Failed seconds

T1 trunks: one second intervals which were preceded by 10 consecutive Failed seconds

E1 trunks: one second intervals where loss of signal occurred, out-of-frame occurred, or excessive bit error rate was detected

Code Violations

Line code violations

Slips

Slips accumulator

Frame sync

OK

NoSignl

No Frm

No MF

NoCRCF

??????

Proper frame sync to the trunk

Loss of signal

Loss of frame

Loss of signaling multiframe

No CRC frame sync

Unknown framing error



Table of Contents Index NMS Glossary Previous Page Next Page Version


Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2000, Natural MicroSystems, Inc. All rights reserved.