Table of Contents NMS Glossary Previous Page Next Page Version


Chapter 4

Virtual Port Configuration Utility: vpdcfg


4.1 Running vpdcfg
4.2 Example
4.2.1 Setting MVIP and T1/E1 Clocking
4.2.2 Defining Resources
4.2.3 Defining Virtual Ports
4.2.4 Example Virtual Port Configuration File

4.1 Running vpdcfgTop of Page

Name

vpdcfg

Purpose

Reads a text file listing the commands to perform, and issues requests to configure virtual ports on the specified TX board.

Usage

vpdcfg -I input file -c TXn000 CP -t trace level

Valid options include:
Option

Use this option to specify...

-I input file

The ASCII text file containing the Virtual Port API commands.

-c TXn000 CP

The communications processor (board) number that the commands are to be directed to (1..8). (Default =1)

-t trace level

The amount of tracing vpdcfg should apply while processing the input file.

Description

vpdcfg communicates through the Virtual API with a KERNEL task (internal operating system application) named $vpd. Requests are issued as the file is parsed. The utility waits up to 3 seconds for a response from $vpd. If the response is received, the utility checks for and reports any error. Timeouts are also reported.

Note: vpdcfg uses the Virtual Port API to perform all communication with the communication processor. This API can also be called from other host applications. Refer to the TX Series Virtual Port Developer's Reference Manual for further details on the Virtual Port API.

Tracing Levels

vpdcfg supports the following tracing levels. The default level (level 2) provides the most common trace features. For applications where screen output is not desired, a lower trace value should be used. For problem diagnosis, a higher value should be used.
Tracing Mode

Description

0

Quiet mode (no output). No report file is generated and no text is sent to standard output.

1

No output to screen. A report file is generated, but no text is sent to standard output.

2

Minimal screen output. Report file generated and limited output to standard output (vpdcfg version, results of parsing, etc.). (Default)

3

Detailed tracing; tracing level for diagnosing problems with configuration files. A detailed description of the actions of vpdcfg is sent to both the report file and to standard output. Message tracing is also activated in each request passed to the communications processor. This causes the KERNEL $vpd task to log the receipt (and response) of each request.

Use the cpcon utility's LOG command to view this output.

4

Do not actually access communications processor (syntax checking only). This level is provided for verifying the syntax of a configuration file. Detailed output is passed to standard out and to the report file, but no requests are passed to the communications processor. The vpdcfg utility displays the Virtual Port API functions (with all parameter values shown as raw values) that would be called if trace mode were less than 4.

Reports

If a report file is indicated (all trace modes but level 0), vpdcfg creates a report file that displays each line parsed, as well as any requests/responses issued to/received from the communications.

The format for a trace line is as follows:

Line #dddd:a entry

where each line contains the following fields:
Field

Description

dddd

The line number in the configuration file of the line being processed

a

Symbol Description

D Diagnostic assistance.

<space> Informational.

! Error indication.

? Internal error in vpdcfg.

entry

The actual log entry.

Procedure

To run vpdcfg:

  1. From the command line, navigate to the directory nms\tektx\soft\util.

    
    
  2. Enter the following at the command line:

    
    vpdcfg -I input file -c TXn000 CP -t trace level

4.2 Example Top of Page

The following sample code shows an example configuration file for vpdcfg. The configuration file sets the following definitions.

4.2.1 Setting MVIP and T1/E1 ClockingTop of Page

MVIP clocking is set up as master reference to the T1A adapter. SEC8K clocking is not active.

The two T1 adapters (A and B) are configured independently.

4.2.2 Defining ResourcesTop of Page

Three resources are defined :

4.2.3 Defining Virtual PortsTop of Page

Four virtual ports are defined in the following way:

4.2.4 Example Virtual Port Configuration FileTop of Page

#############################################################
# exampcfg.txt
#
# Natural MicroSystems TXn000 Virtual Port configuration file
#
# This file contains a set of Virtual Resource definitions/configurations
# as well as a set of Virtual Port assignments that reference these 
# resources.
# The file also contains entries that set the MVIP timing and # T1/E1 configuration. # # All physical ports on the TXn000 Communications Processor (CP) are # accessed via Virtual Ports (VPORTs). A Virtual Resource defines the # usage of a physical port. If a Virtual Resource is defined as SHARED, # a number of VPORTs can be defined that all share this resource (i.e.
# port).
# # After the TXn000 CP has completed the loading of the KERNEL, a default # set of Virtual Resources and VPORTs will exist on the CP. These will all # be NON-SHARED. # # By running the Virtual Port Configuration utility, # any of the pre-defined Virtual Resources or VPORTs can be re-defined # and any new resources or VPORTs can be added. # # Use the command: # vpdcfg -i <config filename> -c <CP #> # ######################################################### # ------------------------------------------------------------------------- # MVIP TIMING CONFIGURATION: # # CLOCK:<main mode> SEC8K:<sec8k mode> [<network T1/E1>] # # where # <main mode> = MASTER - MVIP Timing Master reference Internal Oscillator # BUS - This TX2000 will get MVIP timing from the MVIP bus # SEC8K - MVIP Timing Master reference MVIP SEC8K Signal # NET - MVIP Timing Master reference T1/E1 * # # <sec8k mode> = MASTER - SEC8K Timing Master reference Internal Oscillator # NET - SEC8K Timing Master reference T1/E1 * # NONE - SEC8K Not Driven ## *<netwotk T1/E1> = A|B (required if <main mode> = NET or <sec8k mode> = # NET) # ------------------------------------------------------------------------- CLOCK:NET SEC8K:NONE A # ------------------------------------------------------------------------- # T1/E1 CONFIGURATION: # # <T1/E1> <Framing> <Encoding> <Buildout> <Robbed Bit> <Loop Master> # # where <T1/E1> = T1A|T1B|E1A|E1B # # <Framing> = NONE|D4|ESF|CCS|CAS|CCSCRC|CASCRC # NONE - Do not configure T1/E1 interface # D4 - D4 (193S) Framing (T1) # ESF - Extended Superframe Format (T1) # CCS - Common Channel Signaling (E1) # CAS - Channel Associated Signaling (E1) # CCSCRC - CCS with CRC4 (E1) # CASCRC - CAS with CRC4 (E1) # # <Encoding> = NONE|NOZCS|B7ZS|B8ZS|HDB3 # NONE - No encoding # NOZCS - AMI encoding with no Zero suppression # B7ZS - Bit 7 Stuffing (T1) # B8ZS - Bipolar Eight Zero Substitution (T1) # HDB3 - High Density Bipolar Order 3 (E1) # # <Buildout> = 0-4 (T1) # 0 - 0 to 133 Feet # 1 - 133 to 266 Feet # 2 - 266 to 399 Feet # 3 - 399 to 533 Feet # 4 - 533 to 655 Feet # # 1,3,5,7 (E1) # 1 - 120 Ohm Normal # 3 - 120 Ohm with Protection Resisters (Default) # 5 - 120 Ohm with 14dB Return Loss # 7 - 120 Ohm with 27dB Return Loss # # <Robbed Bit> = TRUE|FALSE (Ignored for E1) # <Loop Master> = TRUE|FALSE #-------------------------------------------------------------------------- #-------------------------------------------------------------------------- # DEFINE RESOURCES: # RES <res #> <hw type> <hw #> [SHARED] <prot> <rxfrm> # <conn> [<conn-specific params>] # # where <res #> = resource number being defined # <hw type> = SCC|DPR|ATM... # <hw #> = number identifying specific hardware selection (e.g. SCC #) # SHARED = Multiplexing/Demultiplexing based on address sets # <prot> = ETH|HDLC|SS7|ASY # <rxfrm> = max RX frame size for all sharing resource # <conn> = ETH|SERIAL|TDM # ETH: no conn-specific params # # SERIAL: <baud> [IDLEFL] # <baud> = internal clocking (bits/sec) [0 = external clocking] # <flags> = any combination of flags listed below ('|' separated) # IDLEFL - idle in flags # # TDM: <st>:<ts>[..<tsend>] # <st> = TDM stream # <ts> = TDM time slot # <tsend> = TDM time slot (hyper channel) end # #--------------------------------------------------------------------------

# -------------------------------------------------------------------------
# DEFINE VIRTUAL PORTS:
# VPORT <vport #> RES <res #> <prio> [<flags>] <addrs>
#
# where <vport #> = virtual port number being defined
#       <res #>   = resource number of resource virtual port is assoc'd with
#       <prio>    = priority of virtual port (H=high, M=medium, L=low)
#       <flags>   = optional control flags:
#               OW = Overwrite address field on TX requests with 1st addr
#       <addrs>   = 1..4 addresses that virtual port attaches to (/ separated)
#--------------------------------------------------------------------------
Note: The # character denotes a comment line. Lines of complete white space are tolerated.



Table of Contents 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.