(Page 1 of 1 in this chapter)

Chapter 4

Editing AG Configuration Files

4.1 Introduction

4.2 Customizing the AG Configuration File

: 4.2.1 Protocol-Specific Settings

4.3 Sample AG Configuration Files

: 4.3.1 AG-E1 Board: MFC-R2 Protocol
: 4.3.2 AG-E1 and AG-8 Boards: Pulsed E and M Protocol
: 4.3.3 AG Quad Board: IWK Protocol

4.1 Introduction

The AG configuration file lists the types, locations and roles of each AG board on a PC chassis. It also specifies what software modules are loaded to each board's memory. When you invoke agmon it interprets the AG configuration file and configures the AG boards accordingly.
This chapter: Describes how to edit the AG configuration file so that agmon configures your boards properly for the protocol software you are using Provides sample ag.cfg files for various boards and TCPs

4.2 Customizing the AG Configuration File

The easiest way to create an AG configuration file for your setup is to modify or combine the contents of the example files installed on your system. One or more sample configuration file is installed with each protocol software package (and also with other NMS products). This file contains settings specific to country and protocol software.
Configuration files installed with each protocol software packages are country-dependent, and have at least one IdleCode statement that changes depending on the country of use.
Use a text editor to edit your existing AG configuration file. Include any entries from the appropriate sample configuration files included with the protocol software. 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: UNIX: agmon searches in the current working directory, and then in the directory /opt/nms/ag/cfg. Windows NT and OS/2: agmon searches in the current working directory, and then in the directories specified in the AGLOAD environment variable. Note: Several configuration files also reside in the same directory as ag.cfg. These are installed with AG or CT Access to accommodate different types of configurations.

4.2.1 Protocol-Specific Settings

The table below lists settings that must appear in your AG configuration file to configure AG boards for digital CAS protocol software installations.
Note that you must also include other AG configuration file statements to configure your hardware. Refer to the AG-T1 and AG-E1 Installation and Developer's Manual, AG Quad Installation and Developer's Manual, and the AG Runtime Configuration and Developers Manual for more information about these statements. Statement Set To DspFile DspFile lines must appear in your AG configuration file. Each line specifies a DSP program file to be transferred to the board by agmon. (For more information about DSP program files, see Section 1.5.4, About DSP Program Files.) The following lines must appear: DspFile=dtmf.dsp*(or dtmf_a.dsp for A-law configurations) DspFile=callp.dsp (or callp_a.dsp for A-law configurations) DspFile=tone.dsp (or tone_a.dsp for A-law configurations) DspFile=signal.dsp (or signal_a.dsp for A-law configurations (does not apply to SS5 protocol) With most international protocols the following DspFile line must also appear in order for an AG-T1 or AG-E1 to support CAS call control operations: DspFile=mf.dsp (or mf_a.dsp for A-law configurations) IdleCode This statement specifies the bit pattern to transmit on an MVIP stream when it is not under a TCP's control. This statement is mandatory for CAS protocol software applications. The Idlecode setting used differs from country to country and from protocol to protocol. To learn the setting appropriate for your country, refer to the sample AG configuration file automatically installed with the digital CAS protocol software package for that country. Depending on the protocol, the value of this statement will instruct the board to output an idle bit code or a blocking bit code to the line. If the bit code is idle, when the TCP is not active, the line can be seized by the near end switch, but all calls will time out. If the code is blocking, the near end switch will be prevented from presenting calls when the TCP is not active (this may seem like a better option, but it is typically illegal for outgoing trunks).
* Substitute dtmfe.dsp or dtmfe_a.dsp if you are using echo canceling.

Statement	Set To
`DspFile`	`DspFile` lines must appear in your AG configuration file. Each line specifies a DSP program file to be transferred to the board by `agmon`. (For more information about DSP program files, see Section 1.5.4, About DSP Program Files.) The following lines must appear: `DspFile=dtmf.dsp`*(or `dtmf_a.dsp` for A-law configurations) `DspFile=callp.dsp` (or `callp_a.dsp` for A-law configurations) `DspFile=tone.dsp` (or `tone_a.dsp` for A-law configurations) `DspFile=signal.dsp` (or `signal_a.dsp` for A-law configurations (does not apply to SS5 protocol) With most international protocols the following `DspFile` line must also appear in order for an AG-T1 or AG-E1 to support CAS call control operations: `DspFile=mf.dsp` (or `mf_a.dsp` for A-law configurations)
`IdleCode`	This statement specifies the bit pattern to transmit on an MVIP stream when it is not under a TCP's control. This statement is mandatory for CAS protocol software applications. The `Idlecode` setting used differs from country to country and from protocol to protocol. To learn the setting appropriate for your country, refer to the sample AG configuration file automatically installed with the digital CAS protocol software package for that country. Depending on the protocol, the value of this statement will instruct the board to output an idle bit code or a blocking bit code to the line. If the bit code is `idle`, when the TCP is not active, the line can be seized by the near end switch, but all calls will time out. If the code is blocking, the near end switch will be prevented from presenting calls when the TCP is not active (this may seem like a better option, but it is typically illegal for outgoing trunks).

4.3 Sample AG Configuration Files

The following sections show sample ag.cfg files for digital CAS protocol applications on various hardware configurations. CAS protocol-specific items appear shaded.

4.3.1 AG-E1 Board: MFC-R2 Protocol

This sample file describes one AG-E1 at I/O address 2C0, IRQ 12, running an MFC-R2 TCP specific to the People's Republic of China.
Shaded statements are settings specific to the MFC-R2 TCP. For more information about board-specific entries, refer to the AG-T1 and AG-E1 Installation and Developer's Manual or AG Quad Installation and Developer's Manual. [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. DspFile = voice_a.dsp DspFile = signal_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 mu-law encoding, remove the _a from each file name. DspFile = mf_a.dsp RunFile = systn.run This line defines the coprocessor software to be used. It is board- and protocol-specific. For AG-T1 and AG-E1 boards with digital CAS protocol software, use systn.run. If you have more than one board, and the boards require different runfiles, include this line in a "Board x" section instead of the COMMON section. #--- BOARDS section --- Board 0 This statement indicates the beginning of a description of a particular board. The number appearing here will be used to refer to the board in software. Address = 2C0 This is the board's I/O address. Each board must have a unique address. The address is set here and on the board's face using switches. TCP = mfc0.tcp This statement indicates the TCP to load to the board. The setting here is protocol-specific. For MFC-R2 under CT Access, specify mfc0.tcp. IdleCode = 0xD5,0xB This statement defines the bit pattern transmitted on an MVIP timeslot when it is not under a TCP's control. The setting of this line is country-specific. The setting shown here is specific to the People's Republic of China. the first hexadecimal number represents the digital pattern to be output on the voice channels of the E1 trunk. 0xD5 is the "silence" pattern for the A-law companding law. The second number is the value of the signalling bit associated with each voice channel. 0xB (ABCD = 1011) is the MFC-R2 idle signalling code in the PRC. CLOCKREF = NET1 This statement configures the clock. NET1 causes the board to derive the local clock using the extracted clock from the T1 or E1 line. ENABLEMVIP = NO Set to YES to enable MVIP switching. 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. End Board This statement indicates the end of the description for board 0.

`[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.
`DspFile = voice_a.dsp` `DspFile = signal_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 mu-law encoding, remove the _a from each file name.
`DspFile = mf_a.dsp`
`RunFile = systn.run`	This line defines the coprocessor software to be used. It is board- and protocol-specific. For AG-T1 and AG-E1 boards with digital CAS protocol software, use `systn.run`. If you have more than one board, and the boards require different runfiles, include this line in a "Board x" section instead of the `COMMON` section.
`#--- BOARDS section ---`
`Board 0`	This statement indicates the beginning of a description of a particular board. The number appearing here will be used to refer to the board in software.
`Address = 2C0`	This is the board's I/O address. Each board must have a unique address. The address is set here and on the board's face using switches.
`TCP = mfc0.tcp`	This statement indicates the TCP to load to the board. The setting here is protocol-specific. For MFC-R2 under CT Access, specify `mfc0.tcp`.
`IdleCode = 0xD5,0xB`	This statement defines the bit pattern transmitted on an MVIP timeslot when it is not under a TCP's control. The setting of this line is country-specific. The setting shown here is specific to the People's Republic of China. the first hexadecimal number represents the digital pattern to be output on the voice channels of the E1 trunk. 0xD5 is the "silence" pattern for the A-law companding law. The second number is the value of the signalling bit associated with each voice channel. 0xB (ABCD = 1011) is the MFC-R2 idle signalling code in the PRC.
`CLOCKREF = NET1`	This statement configures the clock. NET1 causes the board to derive the local clock using the extracted clock from the T1 or E1 line.
`ENABLEMVIP = NO`	Set to YES to enable MVIP switching.
`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.
`End Board`	This statement indicates the end of the description for board 0.

4.3.2 AG-E1 and AG-8 Boards: Pulsed E and M Protocol

The following sample AG configuration file describes one AG-E1 board set up at I/O address 2C0, IRQ 12, using a Pulsed E and M (EAM) TCP specific to Brazil, and one AG-8 board at I/O address 22C0. The boards are connected through the MVIP bus.
Shaded items are settings specific to the Pulsed E and M TCP. For more information about board specific entries, refer to the AG-T1 and AG-E1 Installation and Developer's Manual or AG Quad Installation and Developer's Manual. [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. DspFile = voice_a.dsp DspFile = signal_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 mu-law encoding, remove the _a from each file name. DspFile = mf_a.dsp #--- BOARDS section --- Board 0 This statement indicates the beginning of a description of board 0, the AG-E1 board. The number appearing here will be used to refer to the board in software. RunFile = systn.run This statement defines the coprocessor software to be used. It is board- and protocol-specific. In CT Access for AG-T1 and AG-E1 boards with digital CAS protocol software, use systn.run. Since there is more than one board in this setup, and the boards require different runfiles, this line is included in a "Board x" section instead of the COMMON section. Address = 2C0 This is the board's I/O address. Each board must have a unique address. The address is set here and on the board's face using switches. TCP = eam0.tcp This statement indicates the TCP to load to the board. The setting here is protocol-specific. For Pulsed E and M under CT Access, use eam0.tcp. IdleCode = 0xD5,0xb This statement defines the bit pattern transmitted on an MVIP stream when it is not under a TCP's control. The setting of this line is country-specific. The setting shown here is specific to Brazil and the Pulsed E and M protocol. CLOCKREF = NET1 This statement configures the clock. NET1 causes an AG-T1 or AG-E1 board to drive the MVIP clock using the clock extracted from the T1 or E1 line. ENABLEMVIP = YES MVIP switching is enabled. The AG-E1 is the clock master, since its ClockRef is set to NET1, and the AG-8's is set to MVIP. 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. End Board This statement indicates the end of the description for board 0. Board 1 This statement indicates the beginning of a description of board 1, the AG-8. The number appearing here will be used to refer to the board in software. RunFile = sysan.run This statement defines the coprocessor software to be used. sysan.run is the runfile for analog trunk interface boards such as the AG-8. Since there is more than one board in this setup, and the boards require different runfiles, this line is included in a "Board x" section instead of the COMMON section. Address = 22C0 This is the board's I/O address. Each board must have a unique address. The address is set here and on the board's face using switches. TCP = lps0.tcp This line indicates the TCP to load to the board. lps0.tcp is the loop start TCP. IdleCode = A-LAW This statement defines the internal voice companding law (voice only for analog boards). CLOCKREF = MVIP This statement configures the clock. MVIP causes the AG-8 board to derive the local clock from the MVIP bus. The AG-E1 is driving the clock in this case, so the AG-8 is the clock slave. ENABLEMVIP = YES MVIP switching is enabled. The AG-E1 is the clock master, since its ClockRef is set to NET1, and the AG-8's is set to MVIP. End Board This statement indicates the end of the description for board 1.

`[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.
`DspFile = voice_a.dsp` `DspFile = signal_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 mu-law encoding, remove the `_a` from each file name.
`DspFile = mf_a.dsp`
`#--- BOARDS section ---`
`Board 0`	This statement indicates the beginning of a description of board 0, the AG-E1 board. The number appearing here will be used to refer to the board in software.
`RunFile = systn.run`	This statement defines the coprocessor software to be used. It is board- and protocol-specific. In CT Access for AG-T1 and AG-E1 boards with digital CAS protocol software, use `systn.run`. Since there is more than one board in this setup, and the boards require different runfiles, this line is included in a "Board x" section instead of the `COMMON` section.
`Address = 2C0`	This is the board's I/O address. Each board must have a unique address. The address is set here and on the board's face using switches.
`TCP = eam0.tcp`	This statement indicates the TCP to load to the board. The setting here is protocol-specific. For Pulsed E and M under CT Access, use `eam0.tcp`.
`IdleCode = 0xD5,0xb`	This statement defines the bit pattern transmitted on an MVIP stream when it is not under a TCP's control. The setting of this line is country-specific. The setting shown here is specific to Brazil and the Pulsed E and M protocol.
`CLOCKREF = NET1`	This statement configures the clock. `NET1` causes an AG-T1 or AG-E1 board to drive the MVIP clock using the clock extracted from the T1 or E1 line.
`ENABLEMVIP = YES`	MVIP switching is enabled. The AG-E1 is the clock master, since its `ClockRef` is set to `NET1`, and the AG-8's is set to `MVIP`.
`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.
`End Board`	This statement indicates the end of the description for board 0.
`Board 1`	This statement indicates the beginning of a description of board 1, the AG-8. The number appearing here will be used to refer to the board in software.
`RunFile = sysan.run`	This statement defines the coprocessor software to be used. `sysan.run` is the runfile for analog trunk interface boards such as the AG-8. Since there is more than one board in this setup, and the boards require different runfiles, this line is included in a "Board x" section instead of the `COMMON` section.
`Address = 22C0`	This is the board's I/O address. Each board must have a unique address. The address is set here and on the board's face using switches.
`TCP = lps0.tcp`	This line indicates the TCP to load to the board. `lps0.tcp` is the loop start TCP.
`IdleCode = A-LAW`	This statement defines the internal voice companding law (voice only for analog boards).
`CLOCKREF = MVIP`	This statement configures the clock. `MVIP` causes the AG-8 board to derive the local clock from the MVIP bus. The AG-E1 is driving the clock in this case, so the AG-8 is the clock slave.
`ENABLEMVIP = YES`	MVIP switching is enabled. The AG-E1 is the clock master, since its `ClockRef` is set to NET1, and the AG-8's is set to MVIP.
`End Board`	This statement indicates the end of the description for board 1.

4.3.3 AG Quad Board: IWK Protocol

The following sample AG configuration file describes one AG Quad board set up using an International Wink Start TCP for Hong Kong. The following AG configuration file describes a single AG Quad T1 board: [AGBOARD} #---COMMON section--- Any statements in this section of the file will apply to all boards. DspFile = dtmf.dsp DspFile = voice.dsp DspFile = callp.dsp DspFile = tone.dsp These statements install the DSP files. They are installed on all boards, since they appear in the COMMON section. TCP = iwk0.tcp This statement indicates the TCP to load to the board. The setting here is protocol-specific. For International Wink Start under CT Access, specify iwk0.tcp. IdleCode = MU-LAW #IdleCode = 0x7f, 0xa Default for Hong Kong. Change to this setting if the protocol uses a pulse-on-idle signaling polarity. RunFile = sysqn.run This line defines the runfile software to be loaded to the board. #--- BOARDS section --- Board 0 The beginning of the configuration for a specific board. PCIbus = 0 PCIslot = 1 CCMode = HIGH EnableMVIP = NO DigitalMode=CAS LineLength = 100 Applies to all trunks, since it is outside of the Trunk section (run the blocate utility to find the correct PCI bus and slot) Trunk 0 Beginning of description for Trunk 0 FrameType = D4 LineCode = AMI End Trunk Trunk 1..3 Beginning of description for Trunks 1, 2, and 3. LineCode = AMI_ZCS End Trunk End Board End of configuration for Board 0.

`[AGBOARD}`
`#---COMMON section---`	Any statements in this section of the file will apply to all boards.
`DspFile = dtmf.dsp DspFile = voice.dsp DspFile = callp.dsp DspFile = tone.dsp`	These statements install the DSP files. They are installed on all boards, since they appear in the COMMON section.
`TCP = iwk0.tcp`	This statement indicates the TCP to load to the board. The setting here is protocol-specific. For International Wink Start under CT Access, specify `iwk0.tcp`.
`IdleCode = MU-LAW` `#IdleCode = 0x7f, 0xa`	Default for Hong Kong. Change to this setting if the protocol uses a pulse-on-idle signaling polarity.
`RunFile = sysqn.run`	This line defines the runfile software to be loaded to the board.
`#--- BOARDS section ---`
`Board 0`	The beginning of the configuration for a specific board.
`PCIbus = 0 PCIslot = 1 CCMode = HIGH EnableMVIP = NO DigitalMode=CAS LineLength = 100`	Applies to all trunks, since it is outside of the `Trunk` section (run the `blocate` utility to find the correct PCI bus and slot)
`Trunk 0`	Beginning of description for Trunk 0
`FrameType = D4 LineCode = AMI`
`End Trunk`
`Trunk 1..3`	Beginning of description for Trunks 1, 2, and 3.
`LineCode = AMI_ZCS`
`End Trunk`
`End Board`	End of configuration for Board 0.

(Page 1 of 1 in this chapter)

tech_support@nmss.com