(Page 1 of 1 in this chapter)


Chapter 2

The AG Configuration File


2.1 Introduction 16

2.2 AG Configuration File Structure 16

2.3 Statement Syntax 17

2.4 Statement Summary 18

2.5 Configuration File Statements by AG Board 23

2.6 Creating an AG Configuration File For Your System 25

2.6.1 Using Multiple AG Boards

2.1 Introduction

The AG configuration file lists the types, locations, and roles of each of the AG boards. It also describes which software modules should be loaded to the board's memory. The AG board initialization utility, agmon, interprets the AG configuration file and configures the boards as described in the file.

Note: On Windows NT systems agmon may also be run as a service. For more information, refer to Section 4.6.

2.2 AG Configuration File Structure

The active region of an AG configuration file begins with the string [AGBOARD] on a line by itself and ends at the end of the file or at another word or phrase in square brackets on a line by itself. Any text outside that region is ignored.

The AG configuration statements are typically grouped into sections which determine their scope. Any statement not part of an explicit section is part of an implicit common section and applies to all AG boards.

Each section has as its scope a set of AG boards. Each statement within that section refers to precisely that set of boards.

A section begins with a Board statement (e.g., Board n or Board All) and is terminated by any of the following:

· An End Board statement

· Another Board statement

Typically, the [AGBOARD] section begins with a common section (starting with a Board All statement) that pertains to all the AG boards in the system, followed by sections for each AG board.

White space, such as indentation and space around an equals sign, is ignored, but is useful for clarity. Case is ignored for Windows NT. Case is important for file names for UNIX operating systems. The pound sign (#) and semicolon (;) are both comment delimiters. agmon ignores any text that follows a comment delimiter character on the same line.

Later statements override the values set by earlier statements. You can define a default setting for all boards in the common section, then specify a different setting for a specific board(s) later in the configuration file.

2.3 Statement Syntax

This section provides detailed information about the statements in an AG configuration file. An AG configuration file statement has the general syntax:

keyword = value

In the description of AG configuration file keywords, brackets ([ ]) are used to signify that a value is optional and a vertical bar ( | ) signifies that there is more than one option. Keywords and values are not case-sensitive.

A typical AG configuration file looks like the following:
[AGBOARD]

# Start of active region

Board All

LineCode = AMI

End Board

# Start of common section (optional)

# Common statements

# End of section (optional)

Board 0..1

Interrupt = 7

End Board

# Start of a range-specific section

# Range-specific statements

# End of section (optional)

Board 0

Address = 2C0

End Board

# Start of a board-specific section for board 0

# Board-specific statements

# End of section (optional)

Board 1

Address = 2A0

End Board

# Start of a board-specific section for board 1

# Board-specific statements

# End of section (optional)

Board 2

PCIbus = 0

PCIslot = 1

Trunk 1

LineLength = DSX1

End Board

# Start of a board-specific section for board 2

# Board-specific statements

# Start of a trunk-specific section for trunk 1

# Trunk-specific statements

# End of section (optional)

# EOF

# End of active region

2.4 Statement Summary

The following table summarizes the AG configuration file statements.
Keyword

Allowed Values

Description

When Required

Address

base

Provides the base address of board on the ISA bus.

For ISA boards only

AG2DSP_Lib

[dsp0[..dspn]] = filename

Specifies a pre-linked DSP image file for AG 2000 and AG 4000 boards.

Fusion and fax on AG 2000 and AG 4000 boards

AG2DSP_Lib

filename

Specifies DSP library files for AG 2000 and AG 4000 boards.

AG2DSP_Loader

filename

Specifies module to load DSP functions for AG 2000 and AG 4000 boards.

AG2DSP_OS

[dsp1[..dspn]] = filename

Defines DSP operating system used for
AG 2000 and AG 4000 boards.

AG2DSPFile

filename

Installs a DSP file for
AG 2000 and AG 4000 boards.

Fusion on
AG 2000 and AG 4000 boards.

AG2TaskProcessor

[dsp0..[dspn]] = dsp_func1, dsp_func2, ...

Configures DSPs on
AG 2000 and AG 4000 boards.

Board

boardnum [..endboard] | ALL

Signifies the beginning of a section defining configuration of one or more boards.

All AG boards

Buffer

buffercount

Specifies the number of buffers available for play and record.

ISDN, some Fusion configurations

BufferSize

size

Specifies the size, in bytes, of buffers.

ISDN, some Fusion configurations

CCMode

HIGH | MEDIUM | LOW | NONE

Defines the call control resource allocation for AG Quad and CompactPCI AG Quad boards.

ClockRef

MVIP | H100 | OSC | NET1 | NET2 | NET3 | NET4 | SEC8K

Configures telephony bus clocking.

When EnableMVIP, DriveSec8K, or MVIPslot statements are present.

ConnectMode

FRAMED | UNFRAMED

Specifies HMIC switch connect mode.

D_channel

YES|NO

Specifies the trunk that will carry the D-channel for an NFAS group.

When NFAS_Group statement is present (specific to ISDN).

Diagnostics

level

Determines diagnostics level
(0 - 3) at board initialization time.

DigitalMode

CAS | PRI | RAW

Determines how voice and signaling information is routed to and from a T1 or E1 trunk.

ISDN

Diva

filename

Specifies a DSP file to download to a Diva daughterboard.

Diva board present

DriveSec8K

NET1 | NET2 | NET3 | NET4 | NONE

Configures the T1 or E1 clock to drive the backup network reference (Sec8k or CT_NETREF).

Multichassis MC1-based systems

DSP_OS

filename

Defines DSP operating system to use on the board.

AG-RT,
AG-RT/2

DSPfile

filename

Installs a DSP function module.

EnableMVIP

YES | NO

Determines whether board is electrically connected to the MVIP-90 bus or the H.100 bus.

End Board

Ends section defining the configuration of one or more boards.

FrameType

D4 | ESF | CEPT

Specifies T1 or E1 trunk framing format.

HybridConfig

list

Directly specifies the analog line interface configuration in systems that use the Enhanced Loop Start (ELS) signaling protocol.

IdleCode

MU-LAW | A-LAW | voicecode [,signalcode]

Defines bit to transmit on an MVIP timeslot when not under a TCP's control.

CAS protocols

Interrupt

vector

Defines IRQ shared by all AG boards on the ISA bus. This entry is located in the Common section
(default is 7).

ISA boards

LineCode

AMI | B8ZS | AMI_ZCS | AMI_BELL | AMI_DDS | AMI_GTE | HDB3

Defines T1 or E1 trunk line encoding algorithm.

LineLength

length

Specifies length (in feet) of cable connecting
AG-T1, AG-E1, AG Quad, or CompactPCI AG Quad boards to the telephone network.

LineType

LOOPSTART | LOOP | E&M | E&M1A | DID

Configures analog telephone line interfaces on AG-8 boards.

LoadFile

filename

Specifies boot loader. Default is mother.lod except for Quad boards where default is father.lod.

MaxChannels

channelcount

Specifies the maximum number of channels to allocate on the board (i.e., the maximum number of DSP resources that can be opened at once.

If this statement is omitted, agmon assigns an appropriate value for the board type.

ISDN

MVIPslot

stream: timeslot [..endslot] [,idlecode]

Defines a range of MVIP timeslots driven by DSP resources on AG boards that use the MVIP-90 switch model.

AG 24/30/
48/60 boards

MVIP95slot

stream: timeslot [..endslot] [,idlecode]

Defines a range of MVIP timeslots driven by DSP resources on the AG board, using the MVIP-95 switch model.

NAI

nai

Specifies the network access identifier (NAI) of a trunk. Include in the Trunk section of the ag.cfg file.

When NFAS_Group statement is present

NFAS_Group

group_no

Assigns a trunk to an NFAS group. Include in the Trunk section of the ag.cfg file.

Quad boards and NFAS

PCIbus

busnum

Defines the PCI bus location of the board.

PCI boards

PCIslot

slotnum

Defines the slot location of the board on the PCI bus.

PCI boards

Qslac

[m[..n]] = filename.slc

Specifies country-specific configuration file for line interfaces for AG 2000 boards.

Mandatory outside the United States.

ReportFile

filename

Defines the configuration log file name.

RunFile

filename

Specifies the software to be transferred to the board.

All configurations except
AG 2000 boards and
AG 4000 boards

RunModule

filename

Specifies an optional runtime component to be transferred to the board.

Fax and ISDN on AG 2000 boards and
AG 4000 boards

SmallBuffers

buffercount

Configures the number of "small" (approximately 100 byte) buffers allocated by the run time software. These are mainly used for dynamically allocated control structures.

Fusion

TaskProcessor

dspfile [+limit] [,dspfile [+limit] ...][,-listsize]

Defines the type, number of instances, and amount of task list memory allocated for DSP programs running on NMS boards.

Fusion, Fax

TCP

filename

Installs a Trunk Control Program (TCP).

Required to run particular CAS protocols.

Trunk

trunknum [..lasttrunk ] | ALL

Beginning of section defining configuration of one or more trunks for AG Quad, CompactPCI AG Quad, AG Dual, and AG 4000 boards (trunks are numbered from 0).

2.5 Configuration File Statements by AG Board

The following table lists the appropriate configuration file statements for switching, PC bus, DSP configuration, and board-specific features for AG-8,
AG-24/30/48/60, AG T1/E1, AG Quad, AG 2000, and AG 4000 boards. Specific values for these keywords, and telephony bus clock assignments are listed when applicable. For additional details about a specific board, see the corresponding installation and developer's manual.
Board

Switch and Clocking (FMIC or HMIC)

Location

DSP Configuration and Runtime Software

Board-Specific

(such as line configuration)

AG-8

Clock master:

ClockRef= OSC

EnableMVIP = YES

Clock slave:

ClockRef=MVIP

EnableMVIP= YES

Interrupt

Address

DSP_OS

DSPfile

Runfile

Runmodule

TaskProcessor

Diva

LineType

AG-24/30/48/60

Clock slave only:

ClockRef=MVIP

MVIPslot

MVIP95slot

Interrupt

Address

DSP_OS

DSPfile

Runfile

Runmodule

AG-T1/E1

Clock master:

ClockRef=OSC| NET1

EnableMVIP= YES|NO

Clock slave:

ClockRef=MVIP

EnableMVIP= YES

Interrupt

Address

DSP_OS

DSPfile

Runfile

Runmodule

D_channel

DigitalMode

FrameType

LineCode

LineLength

NAI

NFAS_Group

AG Quad, AG Dual T and E, and AG Quad CompactPCI

Clock master:

ClockRef=OSC| NET1| NET2| NET3| NET4 | SEC8K

EnableMVIP = YES| NO

Clock slave:

ClockRef= MVIP| h100

EnableMVIP=YES

PCIbus

PCIslot

CCMode

DSP_OS

DSPfile

Runfile

Runmodule

D_channel

DigitalMode

FrameType

LineCode

LineLength

NAI

NFAS_Group

Trunk

CCMode

AG 2000

Clock master:

ClockRef=OSC|SEC8K

EnableMVIP= YES|NO

Clock slave:

ClockRef=H100

EnableMVIP=YES

PCIbus

PCIslot

Sec8K

AG2DSPImage

AG2DSP_Lib

AG2DSP_Loader

AG2DSP_OS

AG2DSPFile

AG2TaskProcessor

Runfile

Runmodule

Qslac

AG 4000

Clock master:

ClockRef=OSC| NET1| NET2| NET3| NET4 | SEC8K

EnableMVIP= YES|NO

Clock slave:

ClockRef

EnableMVIP=YES

PCIbus

PCIslot

AG2DSPImage

AG2DSP_Lib

AG2DSP_Loader

AG2DSP_OS

AG2DSPFile

AG2TaskProcessor

Runfile

Runmodule

D_channel

DigitalMode

FrameType

LineCode

LineLength

NAI

NFAS_Group

Trunk

Note: The Interrupt keyword is in the Common section, (not the Board section)

2.6 Creating an AG Configuration File For Your System

The easiest way to create an AG configuration file for your system is to modify and/or combine the contents of the sample files installed with CT Access. These files are installed in one of the following directories:

The sample configuration files are:
Sample File

Description

ag8.cfg

AG-8 board running µ-law

ag8a.cfg

AG-8 board running A-Law

ag8did.cfg

AG-8 DID board

ag24.cfg

AG-24 board and AG-24+ board

ag30.cfg

AG-30 board

ag48.cfg

AG-48 board

ag60.cfg

AG-60 board

age1test.cfg

AG-E1 board

agt1.cfg

AG-T1 board

agqt1.cfg

AG Quad T board, CompactPCI AG Quad T

agqe1.cfg

AG Quad E board, CompactPCI AG Quad E

agdt1.cfg

AG Dual T board

agde1.cfg

AG Dual E board

ag2000.cfg

AG 2000 board

ag4000.cfg

AG 4000 board

The file you create should be named ag.cfg. This is the filename agmon looks for by default.

2.6.1 Using Multiple AG Boards

If you have two or more different AG boards, you can combine the sample configuration files. For example, if you are using an AG-8 board and an AG-T1 board, begin with the ag8.cfg and agt1.cfg files.

To merge configuration files, group the statements into three categories: common, range-specific, and board-specific.

Common statements (such as Interrupt and ReportFile) are those intended to apply uniformly to all boards. These traditionally come at the beginning of the AGBOARD section.

Range-specific statements (such as DSPfile, TCP, and RunFile) are those intended to apply to a range of boards. Each range of boards requires a corresponding section. Alternatively, the boards in a range may be treated individually, with statements duplicated in each board-specific section.

Board-specific statements (such as Address) are those intended to apply to one specific board. These must fall within appropriate board-specific sections.

Some categories are flexible. For example, one could assign a different diagnostics level to each board (putting Diagnostics in the board-specific category), but it is more common to use the same level for all boards (putting it in the common category). Not all statements have this flexibility, however. In particular, Interrupt is always common and Address is always board-specific.

Note that, since each configuration file for an AG board on the ISA bus must contain an Interrupt statement, there must be a common section. In addition, each ISA board must have an Address statement and each PCI board must have PCIbus and PCIslot statements, so there must also be a board-specific section for each board.

Finally, while some statements (such as Address) may occur only once for each board, others (such as DSPfile) may be repeated with different arguments for each board.



(Page 1 of 1 in this chapter)


tech_support@nmss.com
Copyright © 1999, Natural MicroSystems, Inc. All rights reserved.