The AG configuration file lists the types, locations and roles of each of your AG boards. It also describes what software modules should be loaded to the AG board's memory. The AG board initialization utility agmon interprets this file when it is invoked, and configures your board as described in the file.
This chapter describes how to edit your AG configuration file so agmon configures your boards properly for the AG ISDN software you are using. For more general information on the AG configuration file, see your AG Runtime Configuration and Developer's Manual.
To create an AG configuration file for your setup, modify or combine the example files installed on your system, in one of the following locations:
When you install CT Access or AG Access, a number of sample configuration files are installed. If you install packages for other boards (such as the AG-8), other sample configuration files (such as ag8.cfg) are installed in the same directory. These files contain settings appropriate for the AG boards you install.
Also, a sample configuration file is installed with each AG ISDN software package. (See section 1.3.4 for file naming conventions.) This file contains settings specific to the region the AG ISDN software package is for. The configuration file in each AG ISDN software package is different because the file contains region-specific settings.
The file you create should be named ag.cfg. This is the file name agmon looks for by default. agmon uses the following algorithm to search for this file:
The table below lists AG configuration file statements to configure AG ISDN software installations.
Note that there are other statements that you will need to edit in the AG configuration file to configure your hardware. To learn more about these statements, see the Installation and Developer's Manual for your AG board, the AG Access Installation Manual, and the AG Runtime Configuration and Developer's Manual.
|
Statement |
Description |
|
DspFile |
DspFile lines must appear in your AG configuration file. Each line specifies a DSP program file to be transferred to the AG board by agmon. (For more information about DSP program files, see section 1.4.6.) For all AG ISDN installations, the following lines must appear: DspFile=dtmf.dsp2 (or dtmf_a.dsp for A-law configurations) In addition, to run the demonstration programs supplied with CT Access/AG Access and with your AG ISDN software, the following line must appear: DspFile=voice.dsp (or voice_a.dsp for A-law configurations) |
|
TCP |
You can include multiple TCP statements in your AG configuration file. Each statement specifies a trunk control program (TCP) to be transferred to the AG board by agmon. The setting for this statement differs depending upon at what layer you are configuring AG ISDN to access ISDN services: nocc.tcp is distributed with CT Access and AG Access. It sets up your system so call control is handled by the host application instead of by the TCP. |
|
RunFile |
This statement specifies the runfile to be transferred to the AG board by agmon. This runfile includes the protocol stack. For AG ISDN installations, specify: RunFile=runfile.run ... where runfile is the name of the runfile. (See section 1.3.3.) |
|
DigitalMode |
This statement helps determine how voice and signaling information is routed to and from the T1 or E1 trunks and processing resources. It also determines the "ones density" maintenance method used by default in trunk transmissions. For details, see the Installation and Developer's Manual for your AG board. For AG ISDN installations, specify: DigitalMode=PRI |
Note: (AG Quad boards only) If you include a CCMode statement in your AG configuration file, when you call adiStartProtocol in the application, make sure to change the mediamask parameter passed in the call so the AG Quad board's DSP resources are allocated properly. For more information, see your AG Quad Installation and Developer's Manual, AG ISDN Messaging API Developer's Reference Manual or AG ISDN for Natural Call Control Developer's Manual.
You can find complete documentation of AG configuration file statements and syntax in the AG Access Installation Manual and AG Runtime Configuration and Developer's Manual.
The following are listings of sample ag.cfg files for AG ISDN configurations.
The following sample ag.cfg file describes a single AG-T1 configured for ISDN (USA variant), on a T1 trunk using extended superframe framing (ESF). The application is designed to access ISDN services in NCC configuration (using the Natural Call Control API).
[AGBOARD] |
The AG configuration file must begin with this statement. |
#--- COMMON section --- |
Any statements in this section of the file will apply to all boards listed in the Board x sections below. |
Interrupt = 12 |
The interrupt you specify here will be used by all AG boards in your system. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
DspFile = voice.dsp DspFile = dtmf.dsp DspFile = callp.dsp DspFile = tone.dsp |
These statements install DSP program files. They are installed on all boards listed in this file, since they appear in the COMMON section of this file. For this configuration, you will need at least the statements shown. You can add others also, if you wish. These files are for µ-law encoding. If your setup calls for A-law encoding, add _a to each file name, as shown in the next example. |
RunFile = systius.run |
This line defines the runfile to be used. It is board- and protocol-specific. For AG-T1 boards using ISDN in the US, use systius.run. If you have more than one board, and the AG boards require different runfiles, include this line in a Board x section instead of the COMMON section. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
TCP = isd0.tcp |
This line indicates the TCP to load to the AG board. To configure the software so that call control is accessible directly by the CT Access/AG Access API, specify isd0.tcp. |
#--- BOARDS section --- |
|
Board 0 |
This keyword indicates the beginning of a description of a particular board. The number appearing here will be used to refer to the AG board in software. |
Address = 2C0 |
This is the AG board's I/O address. Each board must have a unique address. The address is set here and on the AG board's face using switches. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
ClockRef = NET1 |
This statement configures the clock. NET1 causes the AG board to derive the local clock using the clock extracted from the T1 or E1 trunk. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
EnableMVIP = NO |
This statement enables or disables MVIP switching. When set to NO, MVIP switching is disabled. Note that certain switch connections are automatically made by default when EnableMVIP=NO, to route voice and signaling information to appropriate on-board resources. For details, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
DigitalMode=PRI |
This statement determines how voice and signaling information is routed to and from the T1 or E1 trunk and processing resources. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
LineCode = B8ZS |
This statement specifies the trunk coding algorithm the AG board is to expect. The setting made here is Binary 8 Zero Suppression (the default for AG-T1 boards when DigitalMode is PRI or RAW). For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
FrameType = ESF |
This statement specifies the framing method the AG board is to expect. The setting made here configures the AG board for Extended SuperFrame for USA. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
End Board |
This keyword indicates the end of the description of Board 0. |
The following sample ag.cfg file describes two AG-E1 boards configured for ISDN (European variant). They are connected to one another over the MVIP bus. The application accesses ISDN services in ACU configuration (using the Messaging API).
[AGBOARD] |
The AG configuration file must begin with this keyword. |
#--- COMMON section --- |
Any statements in this section of the file will apply to all boards listed in the Board x sections below. |
Interrupt = 12 |
The interrupt you specify here will be used by all AG boards in your system. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
DspFile = voice_a.dsp DspFile = dtmf_a.dsp DspFile = callp_a.dsp DspFile = tone_a.dsp |
These statements install DSP program files. They are installed on all boards listed in this file, since they appear in the COMMON section of this file. For this configuration, you will need at least the statements shown. You can add others also, if you wish. The _a following each file name indicates that these files are for A-law encoding. If your setup calls for µ-law encoding, remove the _a from each file name. |
RunFile = systieu.run |
This line defines the runfile to be used. It is board- and protocol-specific. For AG-E1 boards using ISDN in Europe, use systieu.run. If you have more than one board, and the AG boards require different runfiles, include this line in a Board x section instead of the COMMON section. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
TCP = nocc.tcp |
This line indicates the TCP to load to the AG board. When using the ISDN Messaging API, specify nocc.tcp. This TCP file is distributed with CT Access and AG Access. It sets up your system so all call control is handled by the host application instead of the TCP. |
#--- BOARDS section --- |
|
Board 0 |
This keyword indicates the beginning of a description of Board 0, the first AG-E1 board. The number appearing here will be used to refer to the AG board in software. |
Address = 2C0 |
This is the AG board's I/O address. Each board must have a unique address. The address is set here and on the AG board's face using switches. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
ClockRef = NET1 |
This statement configures the clock. NET1 causes the AG board to derive the local clock using the clock extracted from the E1 trunk. This AG-E1 board is the clock master, since its ClockRef is set to NET1, and the other board is set to MVIP. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
EnableMVIP = YES |
This statement enables or disables MVIP switching. When set to YES, MVIP switching is enabled. Note that when EnableMVIP=YES, no switch connections are automatically made to route voice and signaling information to appropriate on-board resources. Your application must make these connections. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
DigitalMode=PRI |
This statement determines how voice and signaling information is routed to and from the T1 or E1 trunk and processing resources. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
LineCode = HDB3 |
The LineCode statement defines the trunk line coding algorithm. The setting made here is high-density bipolar 3, which is the default setting for the AG-E1. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
End Board |
This keyword indicates the end of the description for Board 0. |
Board 1 |
This keyword indicates the beginning of a description of Board 1, the second AG-E1 board. The number appearing here will be used to refer to the AG-E1 board in software. |
Address = 22C0 |
This is the AG board's I/O address. Each board must have a unique address. The address is set here and on the AG board's face using switches. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
ClockRef = MVIP |
This statement configures the clock. MVIP causes the an AG-E1 board to derive the local clock from the MVIP bus. Board 0 is driving the clock in this case, so Board 1 is the clock slave. The other AG-E1 is the clock master, since its ClockRef is set to NET1, and this board is set to MVIP. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual |
EnableMVIP = YES |
This statement enables or disables MVIP switching. When set to YES, MVIP switching is enabled. Note that when EnableMVIP=YES, no switch connections are automatically made to route voice and signaling information to appropriate on-board resources. Your application must make these connections. For details, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
DigitalMode=PRI |
This statement determines how voice and signaling information is routed to and from the T1 or E1 trunk and processing resources. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
LineCode = HDB3 |
The LineCode statement defines the trunk line coding algorithm. The setting made here is "high-density bipolar 3", which is the default setting for the AG-E1. For more information, see your AG-T1 and AG-E1 Installation and Developer's Manual. |
End Board |
This keyword indicates the end of the description for Board 1. |
The following sample ag.cfg file describes a single AG Quad T configured for ISDN (USA variant), on a T1 trunk using extended superframe framing (ESF). The application is designed to access ISDN services in NCC configuration (using the Natural Call Control API)
[AGBOARD] |
The AG configuration file must begin with this keyword. |
#--- COMMON section --- |
Any statements in this section of the file will apply to all boards listed in the Board x sections below. |
DspFile = voice.dsp DspFile = dtmf.dsp DspFile = callp.dsp DspFile = tone.dsp |
These statements install DSP program files. They are installed on all boards listed in this file, since they appear in the COMMON section of this file. For this configuration, you will need at least the statements shown. You can add others also, if you wish. These files are for µ-law encoding. If your setup calls for A-law encoding, add an _a to each file name, as shown in the next example. |
RunFile = systius.run |
This line defines the runfile to be used. It is board- and protocol-specific. For AG Quad T boards using ISDN in the US, use systius.run. If you have more than one board, and the AG boards require different runfiles, include this line in a Board x section instead of the COMMON section. For more information, see your AG Quad Installation and Developer's Manual. |
TCP = isd0.tcp |
This line indicates the TCP to load to the AG board. To configure the software so that call control is accessible directly by the CT Access/AG Access API, specify isd0.tcp. |
#--- BOARDS section --- |
|
Board 0 |
This keyword indicates the beginning of a description of a particular board. The number appearing here will be used to refer to the AG board in software. |
PCIbus = 0 |
This defines the PCI bus location of the AG board. For more information, see your AG Quad Installation and Developer's Manual. |
PCIslot = 1 |
This defines the slot location of the AG board on the PCI bus. For more information, see your AG Quad Installation and Developer's Manual. |
CCMode = HIGH |
This defines the call control resource allocation for the AG Quad. For more information, see your AG Quad Installation and Developer's Manual. |
EnableMVIP = NO |
This statement enables or disables MVIP switching. When set to NO, MVIP switching is disabled. Note that certain switch connections are automatically made by default when EnableMVIP=NO, to route voice and signaling information to appropriate on-board resources. For details, see your AG Quad Installation and Developer's Manual. |
DigitalMode=PRI |
This statement determines how voice and signaling information is routed to and from the T1 or E1 trunk and processing resources. For more information, see your AG Quad Installation and Developer's Manual. |
LineCode = B8ZS |
This statement specifies the trunk coding algorithm the AG board is to expect. The setting made here is binary 8 zero suppression. For more information, see your AG Quad Installation and Developer's Manual. |
FrameType = ESF |
This statement specifies the framing method the AG board is to expect. The setting made here configures the AG board for Extended SuperFrame for USA. For more information, see your AG Quad Installation and Developer's Manual. |
End Board |
This keyword indicates the end of the description of Board 0. |
Natural MicroSystems, Inc.
100 Crossing Boulevard
Framingham, MA 01702
2 Substitute dtmfe.dsp or dtmfe_a.dsp if you are using echo canceling.