Configuring the boards

Specify configuration information for all boards in the system in an OAM system configuration file and in board keyword files. These files reference managed components that specify whether a board performs CT bus switching, which board is the CT bus clock master, which software modules to transfer to the board's memory on startup (including which TCPs to load), and other settings.

This topic provides the following sample NaturalAccess OAM API configuration files:

Run oamsys to configure the boards based on the information in the OAM API configuration file. oamsys transfers all software modules specified in the file to each board, and performs any other configuration activities needed. You should also start oammon, which monitors the boards for errors and other events. Use oamcfg to change system information or board parameters after the system is running.

oamsys, oamcfg, and oammon are installed with NaturalAccess. oamsys.cfg is the system configuration file that contains information about the boards in the system and specifies which configuration files to load. For more information, see the Dialogic® NaturalAccess™ OAM System Developer’s Manual.

The following table lists the sample OAM board keyword files installed with the CAS API (where prt indicates the protocol and cty indicates the country where used):

File

Location

Description

a2piprt.cfg

Windows: \nms\ag\cfg

UNIX: /opt/nms/ag/cfg

For AG Series boards.

Default example board keyword file to configure one board with all the modules and settings to run protocol prt. It reflects the last country installed in the system for the protocol prt.

a2piprtcty.cfg

Windows: \nms\ag\cfg\country

UNIX: /opt/nms/ag/cfg/country

For AG Series boards.

Example board keyword file to configure one board with all the modules and settings to run the protocol prt in the country cty. A different file is installed for each country.

c6prtcty.cfg

Windows: \nms\cg\cfg\country

UNIX: /opt/nms/cg/cfg/country

For CG Series boards.

Example CG board keyword file to configure one board with all the modules and settings to run the protocol prt in the country cty. A different file is installed for each country.


AG Series board: Loop start protocol

The following sample OAM board keyword file describes an AG Series board using loop start protocol (LPS) in the USA with 8 ports with 600 ohm network line impedance. The board is configured to run as a stand alone unit. CAS protocol-specific items are bold.

Board keyword file sample

Description

TCPFiles[0] = nocc.tcp  
TCPFiles[1] = lps0.tcp

Indicates which TCP to load to the board. This setting is protocol-specific.

The first statement loads the no call control protocol. The second statement loads the loop start protocol.

XLaw = mu-LAW

Defines voice signaling bit patterns sent to the network when the TCP is not active. This is country-specific.

mu-law is a companding algorithm used for digital trunks. AG 2000 boards need to know the originating companding law to generate an analog voice signal.

DLMFiles[0] = gtp.leo
DLMFiles[1] = voice.leo
DLMFiles[2] = svc.leo

Specifies optional runtime components to be transferred to the coprocessor on the board (leo files are loadable executable objects).

The first statement loads the trunk protocol engine. The second one loads the play and record manager. The third one loads the DSP function manager.

NetworkInterface.Analog[0..7].ConfigFile =
a2usals6.slc

Specifies the AG 2000 board with loop start signaling type and 600 ohm line impedance. Country-specific settings.

Clocking.HBus.ClockSource = OSC

Specifies the source from which this board derives its timing. Setting OSC defines the board as a clock master.

Clocking.HBus.ClockMode = STANDALONE

Specifies the CT bus clock that the board drives. Set a board in standalone mode so the board references its own clocking information.

DSP.C5x.DSPFiles[0] = signal
DSP.C5x.DSPFiles[1] = tone
DSP.C5x.DSPFiles[2] = dtmf
DSP.C5x.DSPFiles[3] = mf
DSP.C5x.DSPFiles[4] = callp
DSP.C5x.DSPFiles[5] = ptf
DSP.C5x.DSPFiles[6] = echo.m54
DSP.C5x.DSPFiles[7] = oki.m54
DSP.C5x.DSPFiles[8] = rvoice.m54
DSP.C5x.DSPFiles[9] = voice.m54
DSP.C5x.DSPFiles[10] = wave.m54

Installs DSP program files. For this configuration, you need at least the statements shown.

The following DSP functionality is defined by this configuration:

  • Out-of-band channel associated signaling

  • Beep, tone generation, dial

  • DTMF and silence/energy detectors

  • MF detection

  • Call progress detection

  • Pure tone filters

  • Echo cancellation

  • OKI-style play, record

  • RAW voice

  • NMS ADPCM play and record

  • WAVE-style play, record


CG Series board: MFC-R2 protocol

The following sample board keyword file describes a CG Series board using an MFC-R2 protocol. For more information about board-specific entries, refer to the documentation for the board. CAS protocol-specific items are bold.

Board keyword file sample

Description

Clocking.HBus.ClockSource = OSC  
Clocking.HBus.ClockSourceNetwork = 1

Specifies the source from which this board derives its timing. Settings OSC define the board as a clock master.

Clocking.HBus.ClockMode = STANDALONE

Specifies the CT bus clock that the board drives.

Sets a board in standalone mode so the board references its own clocking information.

TCPFiles = mfc0.tcp

Indicates the TCP to load to the board. The setting here is protocol-specific.

The statement loads the MFC-R2 TCP.

DSPStream.VoiceIdleCode[0..3] = 0xd5
DSPStream.SignalIdleCode[0..3] = 0x9

Defines the voice signaling bit pattern sent to the network when the TCP is not active. This is country-specific. Specifies the A-Law silence, idle code pattern.

NetworkInterface.T1E1[0..3].Type = E1

Specifies the trunk type for each trunk on the board.

NetworkInterface.T1E1[0..3].Impedance = G703_120_OHM

Specifies the type of cable connecting to the telephone network.

NetworkInterface.T1E1[0..3].SignalingType = CAS

Determines how voice and signaling information is routed to and from the E1 or T1 trunk and DSP resources.

NetworkInterface.T1E1[0..3].FrameType = CEPT

Defines the framing format for the current board or trunk.

NetworkInterface.T1E1[0..3].LineCode = HDB3

Specifies the ones density maintenance method used on the trunk line to maintain a clear channel transmission.

DLMFiles[0] = cg6krun

Specifies an optional runtime component (modular extension to the core file) to be transferred to the board by the configuration file.

DSP.C5x[0..31].Libs[0] = cg6kliba

Specifies the DSP library file name.

DSP.C5x[0..31].XLaw = A_LAW

Determines the DSP hardware companding mode.

Note: All DSPs must have the same value.

DSP.C5x[0].Files = qtsignal callp tone \
dtmf ptf mf echo
DSP.C5x[1..31].Files = voice tone dtmf \
echo rvoice callp ptf wave oki ima gsm_ms g726 mf

Specifies digital signal processor function modules (DPFs) loaded to board DSPs for applications to use on a per-call/channel basis.

Resource[0].Definitions = ( dtmf.det_all & \
echo.ln20_apt25 & ptf.det_2f & \
tone.gen & \callp.gnc & ptf.det_4f & \
( (rvoice.rec_mulaw & rvoice.play_mulaw) | \
(rvoice.rec_alaw & rvoice.play_alaw) | \
(rvoice.rec_lin & rvoice.play_lin) | \
(voice.rec_16 & (voice.play_16_100 | \
voice.play_16_150 | voice.play_16_200)) | \
(voice.rec_24 & (voice.play_24_100 | \
voice.play_24_150 | voice.play_24_200)) | \
(voice.rec_32 & (voice.play_32_100 | \
voice.play_32_150 | voice.play_32_200)) | \
(voice.rec_64 & (voice.play_64_100 | \
voice.play_64_150 | voice.play_64_200)) | \
(wave.rec_11_16b & wave.play_11_16b) | \
(wave.rec_11_8b & wave.play_11_8b) | \
(oki.rec_24 & (oki.play_24_100 | \
oki.play_24_150 | oki.play_24_200)) | \
(oki.rec_32 & (oki.play_32_100 | \
oki.play_32_150 | oki.play_32_200)) | \
(ima.rec_24 & ima.play_24) | \
(ima.rec_32 & ima.play_32) | \
(gsm_ms.frgsm_rec & gsm_ms.frgsm_play) | \
g726.rec_32 | g726.play_32) )

Provides a relational string of DPFs that describes the functionality that can occur on a single port, and describes how the functions execute in relation to each other. The DPFs in this string specify the functions that execute on the DSPs and whether they execute simultaneously.

Resource[x].Definitions specifies the processing functions that are available to applications during the life of a call or channel. For example, if you expect to run echo cancellation at any time on the board, an echo DPF must be specified in this keyword. Since echo runs at the same time as the decoder and encoder in the universal ports full duplex implementation, the Resource string must combine echo (using the AND operator) with the decoder and the encoder.

DebugMask = 0x0

Specifies the type and level of tracing that the board performs.