Beruflich Dokumente
Kultur Dokumente
Proprietary Information
Aculab Plc makes every effort to ensure that the information in this document is correct at the
time of publication. Aculab does not, however, accept responsibility for any errors or omissions.
Aculab has a policy of continuous product introduction and improvement. Please check
documentation and product versions to ensure accuracy of information.
IBM and PC/AT are registered trademarks of International Business Machines Corporation.
MVIP is a trademark of GO MVIP Inc.
All other trademarks are recognised and acknowledged. Aculab Plc reserves the right to change
or amend specification without notice.
© Copyright Aculab Plc 2004:All rights reserved
RECORD OF REVISION
Rev Date By Detail
6.0 06.12.02 CJL Interim release
6.1.0A 19.06.03 DJL Controlled release of initial revision 6 software
6.1.0 15.01.04 DJL updated installation and configuration tools
6.1.1 18.06.04 DJL Review updates
6.2.2 07.09.04 DJL Beta release
6.2.2 15.09.04 DJL Full release
6.2.3 28.10.04 DJL Updates for Linux
6.2.4 12.11.04 DJL Addition of SS7 signalling link and ISUP bearer ACT info.
6.3.0 24.12.04 DJL Various updates including support for new hardware
6.3.1 26.01.05 DJL Corrections to appendix B
6.3.2 10.02.05 DJL Removal of Solaris restrictions
6.3.3 22.02.05 DJL Addition of Linux/Solaris configuration notes
6.3.4 19.04.05 DJL Correction of typological errors
6.3.5 26.05.05 DJL Review of ACT functions
6.4.0 03.11.05 DJL Updates for V6.4 release
6.4.1 18.01.06 DJL Correction of ACT images/definitions
6.4.2 10.04.06 DJL Review updates — small changes
6.4.3 06.07.06 DJL Update to document cross reference descriptions
6.4.4 15.08.06 DJL Update to Prosody X information
6.4.5 21.08.06 DJL New example added - installing a Prosody X card.
6.4.6 05.10.06 DJL Updates to Linux installation example
6.4.7 14.12.06 DJL Updates to include Solaris specific information
2
Call, switch, and speech, telephony software installation guide
Contents
1 Getting started.................................................................................................................................................... 5
1.1 Introduction ...................................................................................................................... 5
2 Installation process overview................................................................................................................... 6
2.1 Install the Aculab hardware .............................................................................................. 6
2.2 Host system startup. .......................................................................................................... 6
2.2.1 E1/T1 trunk and Prosody PCI and cPCI cards ........................................................ 6
2.2.2 E1/T1 16 trunk cPCI card ...................................................................................... 6
2.2.3 IP telephony PCI and Prosody X PCI, cPCI and PCIe cards .................................... 6
2.2.3.1 Pre Prosody X (IP Telephony PCI) ............................................................... 7
2.2.3.2 Prosody X ................................................................................................... 7
2.3 Dowloading and installing the V6 telephony software ...................................................... 9
2.4 Configuring the Aculab Telephony Software ..................................................................... 9
2.5 Aculab example code ....................................................................................................... 9
3 Example card installation and configuration for a windows environment............. 10
3.1 Installing the Prosody X card hardware. .......................................................................... 10
3.2 Starting the Prosody X card host system. ......................................................................... 10
3.3 Download and install of the Aculab telephony-software. ................................................ 11
3.4 Adding the card to the Aculab card list (Prosody X only)................................................. 15
3.4.1 Setting up the Ethernet TCP/IP card address ........................................................ 15
3.4.2 Updating the Aculab card list.............................................................................. 15
3.5 Configuring the Aculab telephony-software. ................................................................... 18
3.5.1 Special consideration - using CAS and SS7 ISUP protocols on PMXC modules ... 18
3.5.2 Card Details ........................................................................................................ 18
3.5.3 Clocking settings ................................................................................................. 21
3.5.4 IP Settings............................................................................................................ 22
3.5.5 TiNG Settings ...................................................................................................... 23
3.5.6 Applying the configuration.................................................................................. 24
4 Example installation and configuration for a non-windows environment. ............ 26
4.1 Telephony-software download and installation............................................................... 26
4.2 Linux/Solaris drivers ........................................................................................................ 27
4.2.1 Pre-requisites....................................................................................................... 27
4.2.2 Making Libraries and Supporting Utilities............................................................ 27
4.2.3 Building, and Configuring, the Driver.................................................................. 27
4.2.4 Creating the Driver.............................................................................................. 28
4.2.5 Creating the Prosody X NIC Driver on Linux ....................................................... 28
4.2.6 Installing the Prosody X NIC Driver on Solaris .................................................... 28
4.2.7 Configuring the Driver......................................................................................... 28
4.2.8 Loading and Unloading the Driver ...................................................................... 28
4.2.9 Automatic Loading of the Driver ......................................................................... 29
4.2.10 Removing the Driver ........................................................................................... 29
4.2.11 Setting up Prosody X Card IP Address on Linux................................................... 29
4.2.12 Setting up Prosody X Card IP Address on Solaris ................................................. 29
4.3 Managing Prosody X cards.............................................................................................. 30
4.3.1 Distinguishing Prosody X cards on Linux ............................................................ 30
4.3.1.1 How it works............................................................................................ 30
4.3.1.2 Simple use................................................................................................ 30
4.3.1.3 Speeding up the process........................................................................... 30
4.3.2 Adding a Remote Prosody X card ........................................................................ 31
4.3.3 Adding a Local Prosody X Card........................................................................... 32
4.3.4 Listing installed Prosody X cards ......................................................................... 32
4.3.5 Obtaining information for an installed Prosody X card ........................................ 32
4.3.6 Removing a Prosody X card ................................................................................ 32
4.4 Card configuration files ................................................................................................... 33
4.4.1 Creating configuration files ................................................................................. 33
4.4.2 Per-card configuration file description................................................................. 35
4.4.3 Example configuration files ................................................................................. 39
4.4.4 Configuration file updates ................................................................................... 41
3
Call, switch, and speech, telephony software installation guide
4
Call, switch, and speech, telephony software installation guide
1 Getting started
1.1 Introduction
This document is a guide to the installation procedure for the Aculab telephony software
components; as required by Aculab digital access & Prosody PCI, cPCI, and PCIe format cards.
It provides an overview of the download, installation, and configuration of the call, switch, and
speech drivers, the signalling protocol firmware, and rich media speech processing firmware,
(Aculab telephony software).
It does not cover the regulatory requirements and hardware installation of the cards. Please refer
to the appropriate hardware installation guides for further details.
Aculab supports many popular operating systems and numerous signalling systems for use with
the E1/T1 primary rate modules (PM/PMX/PMXC). Precise details of the installation of the Aculab
telephony software are dependent on the operating system and signalling system(s) being used.
ASCII text files are used to configure clocking, protocol firmware, DSP firmware, and Prosody
firmware as appropriate for each card. These text files can be created/edited either by using a
text editor or by running the Aculab configuration tool (ACT).
The V6 telephony software Aculab configuration tool (ACT) supports the following operating
systems:
Windows 2000 with service pack 2 or later
Windows XP with service pack 1 or later
Linux/Solaris (Please check with Aculab for confirmation of the supported distributions)
CAUTION All earlier versions of the Aculab Configuration Tool should be un-installed before loading a new version. As a precaution, double
check that all earlier versions of library and configuration files have also been deleted before proceeding.
5
Call, switch, and speech, telephony software installation guide
Note Please refer to the ‘card boot & discovery’ section of the ‘Prosody X administration guide’ for further guidance on Prosody X boot-up
and network configuration considerations.
1. Install the cards into the required system as detailed in the appropriate hardware
manuals.
2. Power up the system
4. Once Windows has started, the system will auto-detect the new hardware as an Ethernet
card. As the card’s driver is an Aculab specific driver, it will not be available until you
have downloaded the Aculab telephony software, in this instance select Cancel.
6
Call, switch, and speech, telephony software installation guide
DSP resources
NIC B
TCP/IP network
PCI/cPCI connection
The Aculab IP telephony PCI card resources are managed through the standard PCI/cPCI bus
interface, however management of IP Telephony on early cards required a communication path
from NIC B to the host system via NIC A. Since V6.4, and the introduction of the cross bus
driver, this communication path is no longer required.
Configuration of NIC A is via the host system; for example, using Microsoft Windows network
connections.
Configuration of NIC B is via either the ACT for windows or the prosody_ip_card_mgr
command.
2.2.3.2 Prosody X
Ethernet
NIC B
Switch
NIC C
TCP/IP network
PCI/cPCI connection
The Prosody X card is detected by the host system as a network interface card (shown as NIC C).
Communication with the Prosody X card media DSP and PMX/PMXC card resources is also via
an Ethernet connection (shown as NIC B).
Configuration of NIC C is via the host system; for example, using Microsoft Windows network
connections.
7
Call, switch, and speech, telephony software installation guide
Configuration of NIC B is via either the ACT for windows or the prosody_ip_card_mgr
command.
The Prosody X card contains an Ethernet switch, which connects NIC B with both the local host
system via NIC C, and a TCP/IP network via the cards Ethernet port. Management of the Prosody
X card resources can therefore be carried out either by the local host via NIC C, or by a remote
host via the TCP/IP network Ethernet port.
Note As Windows recognises the Prosody X card as a network adapter (NIC) and not an Aculab Computer Telephony device, it will not
appear automatically in the ACT card list. It must be manually added to the list before it can be configured.
To achieve this, a new option has been added to the ACT card list dialog called Prosody X cards…
This option will open a dialog that allows you to enter the serial numbers of Prosody X cards,
and to assign IP address (NIC B) to each card for communication with the DSP and PMX/PMXC
resources. A command line option is also available.
8
Call, switch, and speech, telephony software installation guide
Sections 3 and 4 of this document provide examples of a typical Aculab card installation and
configuration.
9
Call, switch, and speech, telephony software installation guide
CAUTION In order to retain a good earth connection to the card, it is important that you ensure that the card retaining screw, as detailed in step
5 above, is securely fitted.
11. As the Aculab cards driver is Aculab specific, it will not be available until you have
downloaded the Aculab telephony software, therefore select Cancel.
For further guidance, please refer to the boot & discovery section of the Prosody X
administration guide.
10
Call, switch, and speech, telephony software installation guide
You will be presented with the options to; download the Aculab installation tool - FTP downloads utility
guide.pdf,read the release note, and download the AculabInstaller.msi application. Along with
Instructions regarding the AIT application’s password requirements.
12. As required, using standard Windows process, download and run the AculabInstaller.msi
application.
Providing you accept the defaults, the Aculab installer tool (AIT) application will have been
installed in C:/Program Files/Aculab/Installer, and an Aculab – AIT entry will have
been added to your Windows Start - programs shortcut menu.
13. Either from the Windows Start menu, or by double clicking on the file, run the
installer.exe
If the AIT can not see the Internet, for example, access is via a secure proxy server, you will
presented with the following message:
Please refer to the AIT user guide Connection options – server settings section for details of how to
set up any required proxy settings.
Providing the AIT can connect to the Internet, you will be presented with a Login dialog:
14. Enter valid Username and Password details then select OK to continue.
The login details will be either the unique customer details provided to you by Aculab
support, or the generic login details obtained from the Aculab web site.
Once you have logged in successfully, you will be presented with the New Package dialog.
15. Select the required distribution from the pull down menu, in our example we have chosen
the Windows distribution.
16. Enter a unique distribution package local name, for example, we have used Test
installation, then select Ok to continue.
11
Call, switch, and speech, telephony software installation guide
You will now be presented with the AIT primary dialog displaying your selected distribution
package. Select the distribution tree + symbol to see the distribution package key
components.
Note Components such as Switch, Resource_Management, Call_Control, and V6_Base are common
requirements (interdependencies) and will be downloaded and installed automatically when you install one of the key components
such as TiNG.
In our example, we will not be using the SS7, 3rd_Party, and Prosody S Software
components. These can be removed from the distribution.
17. Right click on any non-required components in turn and select Remove from ‘Test installation’
package.
18. Right click on the New or Updated Components on… entry and then select Install, this will start the
download and installation process for the remaining distribution components.
12
Call, switch, and speech, telephony software installation guide
During the process, should you receive a licence agreement dialog prompt:
During the process, after all the hardware drivers have been installed, the AIT will check for
any new hardware, detect, and then install the drivers for the new Prosody X PCI card. An
entry will then be added to the Windows Network and Dial-up Connections dialog (default - DHCP).
13
Call, switch, and speech, telephony software installation guide
Once the AIT has successfully downloaded and installed the selected distribution
components, you will be prompted to re-boot the host system.
The primary AIT dialog will now show the Installed components.
21. Select the File – Exit menu option to close the AIT.
14
Call, switch, and speech, telephony software installation guide
3.4 Adding the card to the Aculab card list (Prosody X only).
As previously mentioned, the Prosody X card is recognised by the host system as a network
interface card (NIC) and not an Aculab resource card. Before you can configure the Prosody X
card resources, you must first make it known to the Aculab card list, which is referenced by the
Aculab configuration tool (ACT). The ACT has an option to add Prosody X cards to the card list
using the cards IP address and card serial number.
For further guidance, please refer to the boot & discovery section of the Prosody X card
Administration guide for the booting and discovery of cards.
3.4.1 Setting up the Ethernet TCP/IP card address
For guidance on choosing an IP address, plus clarification on other issues such as network
connectivity, network bandwidth, and fragmentation, please refer to the network setup
considerations section of the Prosody X card Administration guide.
For this example, we will assume that we are not using DHCP, and that a range of IP addresses
(192.168.1.40 to 49) within a network have been reserved for use by IP gateways, such as our
Prosody X card. We will use the first of these addresses, (192.168.1.40) for the NIC and the next
address (192.168.1.41) for the Prosody X card resources.
23. To set the static IP address, use the standard Windows Network and Dial-up Connection properties
dialogs:
24. To open the ACT, select Start – programs – Aculab – V6 – ACT, or run the C:/Program
Files/Aculab/V6/ACT.exe application, then select the Card List view.
The card list view will not show the Prosody X card until it has been added to the Aculab
card list using the Prosody X view functions.
15
Call, switch, and speech, telephony software installation guide
25. To add the Prosody X card to the Card List, first select the Prosody X view.
Note Under certain conditions, the Prosody X cards may appear in the list but will not show an IP Address or active Status. In these
instances you should select the card entry followed by Edit. Otherwise:
26. Select Add
If the card is to be configured from another system, you only need to add the Serial Number and IP
Address. If the card is to be booted and configured by the local host, you must select Boot Card to
enable entry of the required parameter.
16
Call, switch, and speech, telephony software installation guide
27. Select Boot Card then enter the appropriate Serial Number, IP Address and Netmask parameters.
28. Enter a unique Security Key, or select Generate Key, to create a key for the card. This key is used
to restrict access to the card from approved hosts. For further details, please see the ACT and
Prosody X card administration guides.
29. Select Add followed by OK for the Register Remote Card dialog prompt. The card will go through
various Diagnostics and Status changes prior to being added to the Prosody X page list.
30. Selecting the Card List view dialog should now shoe the Prosody X card.
Note It can take some time for the card to appear in the card list. If the card fails to appear, try closing down and restarting the ACT
Note The DSPs on a PMXC are used for CAS and SS7 only and are automatically configured when CAS or SS7 protocols are selected for a
port. Unlike earlier PMs, these DSPs will not appear as available resources in the Card List, (DSPs column shows 0).
17
Call, switch, and speech, telephony software installation guide
32. In the Port Protocols field, select the first port entry followed by Port Details, or double
click on the first port entry, to open the Port * Protocol Selections dialog.
18
Call, switch, and speech, telephony software installation guide
33. In the Protocol Selection List, select R2T1 PMX. Then select Protocol Options to open the
R2T1 PMX Switch Options dialog.
The Available Switches pull down menu details the available options for the selected protocol.
The Switch Description field displays details for a selected switch. To browse the options, select
options as you scroll up or down the list.
34. Select a required option from the Available Switches field followed by Add Switch.
35. Repeat for all required options
36. For configurable switches, select the required Selected Switches entry then use the Switch
Configuration tab to set the required value.
37. Once you have completed the setting up of your required switch options, Select Ok to close
the Switch Options dialog and return to the Protocol Selection dialog. Then select OK to implement
your Protocol Selections and return to the Card Details Page dialog.
38. You will be presented with an option to set ‘All ports on the card set the same as this one’, Ignore this
option and select ‘Just set the current port to this protocol’ followed by Continue.
19
Call, switch, and speech, telephony software installation guide
39. Repeat steps 31 to 37 for each port. In the following example, we have set the first four ports
for R2T1 and the second four ports for ETS300, both network and user end types.
40. Select OK to close the Card Details Page dialog and return to the Card List primary dialog.
20
Call, switch, and speech, telephony software installation guide
42. From the Clock Source pull down menu, set the source to Port 0.
43. Now select Bus Master followed by Ok to complete the clocking settings and return to the
Clocking Settings primary dialog.
21
Call, switch, and speech, telephony software installation guide
3.5.4 IP Settings
This option allows you to set specific SIP and H.323 port parameters as well as generic card
details. For further details on setting these parameters, please refer to the
Aculab_configuration_tool (ACT) user guide, available from the support area of the company
web site at www.aculab.com. For our example, we will accept the default values.
Other than when using enhanced SIP, using SIP or H.323 on a Prosody X card requires the use
of the TiNG resource manager (TRM). Please see the TiNG resource API guide for further details.
44. Select the IP Settings view.
45. Select the Prosody X card entry, then check the Enable H.323 and Enable SIP options. The Use
Aculab supplied ONCRPC portmapper should have been selected by default.
22
Call, switch, and speech, telephony software installation guide
47. Select the Prosody X card entry, then select Card Details to open the TiNG Firmware Selection
dialog. By default, Module 0 will be selected.
48. Scroll down the Available Firmware list, selecting and adding the required firmwares, for
example, select datafeed followed by Add Firmware to add datafeed to the Added Firmwares
list.
23
Call, switch, and speech, telephony software installation guide
49. Once you have made all the required selections, select Add to All Modules. You will then be
asked to confirm your selection.
50. Select Yes to close the prompt, then select OK to close the TiNG Firmware Selection dialog and
return to the primary TiNG Settings dialog.
53. Select OK. You will now be presented with a Close option
24
Call, switch, and speech, telephony software installation guide
54. Select Close to close the dialog and exit the ACT.
Note You should now be ready to use the Application Programming Interface (API) functions to interface between your application and the
Prosody X card resources. If you are unfamiliar with the Aculab APIs, the AIT packages contain some code examples that may be of
assistance.
25
Call, switch, and speech, telephony software installation guide
Note As with the AIT GUI, you don’t need to run instcmd –download followed by instcmd –install, you can just run
instcmd –install.
26
Call, switch, and speech, telephony software installation guide
Note See $ACULAB_ROOT/driver/readme.install for distribution-specific information before building the Aculab drivers on Linux.
Note Many of the scripts listed in this section appear in $ACULAB_ROOT/driver/install on Solaris instead of $ACULAB_ROOT/driver
Note Aculab currently supply only 64 bit Solaris kernel drivers with 32 and 64 bit userspace libraries
Note Linux installation scripts are kept in $ACULAB_ROOT/driver, Solaris scripts are kept in $ACULAB_ROOT/driver/install
4.2.2 Making Libraries and Supporting Utilities
Newer TiNG distributions are supplied with a pre-built shared object as well as the source code.
This section is applicable only if you would like to link your applications against a static TiNG
library.
If a static TiNG library is needed, then the $ACULAB_ROOT/driver/makelibs script file must be run
before building the driver. This creates the appropriate supporting utilities to build and run the
Prosody 2 (TiNG) driver component. makelibs libonly may be run to build only libTiNG.a and
not the assorted test tools that are not needed for every-day operation. This will greatly reduce
the time taken to build TiNG.
4.2.3 Building, and Configuring, the Driver
If Prosody X or 16-port trunk cards are being used in the system, then the distribution’s kernel
source package must be installed. Consult the distribution’s documentation for information on
this.
ACULAB_ROOT must be set to the root directory of the Aculab distribution (e.g.,
/usr/local/aculab/v6). setV6.sh is a script that will set the all of the environment variables
correctly. To run:
source setV6.sh
This file may also be modified and copied into /etc/profile.d to ensure settings are loaded
for each bash shell.
Before the driver can be loaded, it has to be fully built. Due to the many variations of Linux and
Solaris distributions, there cannot be a "one binary for all" situation. To cope with this, the driver
kit contains precompiled objects with the final compilation of the kernel-specific code and the
linking together of the loadable module, completed on the host machine. The script files
dacpinst for Linux and solinst.pl for solaris, are used to automate this process and
configure the driver to your needs.
To avoid compilation errors, Please ensure that the sources for the intended kernel have been
installed, prior to building the driver. For most distributions, this required package would be
called kernel-source.
27
Call, switch, and speech, telephony software installation guide
28
Call, switch, and speech, telephony software installation guide
aculab_dacp also creates the device nodes (in /dev) required for correct operation.
The command for Solaris aculab_v6 are as for aculab_dacp. Simply replace any instance, in
the above example, of aculab_dacp with aculab_v6.
4.2.9 Automatic Loading of the Driver
The aculab_dacp and aculab_v6 script files can be used to automatically load the driver at the
boot-up sequence of Linux. For example, if you are defaulting to using Linux runlevel 5 (usually
boots up to X-Windows in Redhat), then you can symbolically link aculab_dacp into
/etc/rc.d/rc5.d using similar superuser commands to:
cd /etc/rc.d/rc5.d
ln -s /usr/local/aculab/v6/install/aculab_dacp ./S91aculab_dacp
29
Call, switch, and speech, telephony software installation guide
After a while (about six minutes - see the next section, speeding up the process), if this interface
is a Prosody X card, the serial number of the card will be printed out (on stdout), for example:
perl findprosodyx.pl eth2
123456 is the serial number of Prosody X card eth2
In normal use you will see more output, because there is some sent to standard error by the
utility tcpdump, which the script uses to listen for Ethernet traffic, for example:
perl findprosodyx.pl eth2
tcpdump: listening on eth2, link-type EN10MB (Ethernet), capture size 1500
bytes
101 packets captured
101 packets received by filter
0 packets dropped by kernel
123456 is the serial number of Prosody X card eth2
If there is a network cable connected to the card, and there are other Prosody X cards on the
same segment, the script may receive broadcasts from them, for example:
perl findprosodyx.pl eth2
# Saw other card: 654321 (00:02:1f:00:0a:9d) while looking for
00:02:1f:00:05:aa
123456 is the serial number of Prosody X card eth2
Note If eth2 is not a Prosody X card, or if the Prosody X card is not waiting to be configured, the script will wait forever.
4.3.1.3 Speeding up the process
The simplest way to use this script results in a long delay while it listens for Ethernet traffic. This
is caused by the way in which tcpdump passes on the traffic. It buffers it into blocks, and the
script gets nothing until a whole block is available. Since the periodic broadcasts are only sent
about every four seconds and are quite short, this causes a long delay.
There are two ways of speeding this up, which are mutually incompatible.
30
Call, switch, and speech, telephony software installation guide
However, if there is other traffic, tcmpdump may stop before the broadcast from the Prosody X
card has been seen. This makes it fail, for example, like this:
perl findprosodyx.pl -p 10 eth2
tcpdump: listening on eth2, link-type EN10MB (Ethernet), capture size
1500 bytes
10 packets captured
10 packets received by filter
0 packets dropped by kernel
Error: EOF from tcpdump
If there is a lot of traffic on the Ethernet, then you can tell the script to make tcpdump ignore
anything which could not be the broadcast from a Prosody X card. This is done using the -x
option, for example:
perl findprosodyx.pl -p 10 -x eth2
The disadvantage of this option is that tcpdump does not pass on packet capture data as often,
since there is less of it. In particular, it means that the trick of using ping to add traffic, as
described above, no longer works.
4.3.2 Adding a Remote Prosody X card
If the Prosody X card is installed in a machine other than the machine on which the Aculab
software is running, or is installed in the same machine but the host NIC has not been assigned
an IP address, as in sections 4.2.9 or 3.4, then the card is a remote card. To add a card use one
of the following commands:
prosody_ip_card_mgr add <serial_no> <card_key> <ip_address_of_card> <netmask>
<gateway_address>
For example, If you want to give your Prosody X card (serial number 179779, card key theKey),
an IP address of 192.168.1.42 and there's no gateway, you would use:
prosody_ip_card_mgr add 179119 theKey 192.168.1.42 255.255.255.0
31
Call, switch, and speech, telephony software installation guide
This will return the serial number and IP address of any cards, (this example is for a single card):
1 Prosody IP cards registered on this system:
179779 (192.168.1.42)
For example, to obtain information for card serial number 179779, use the following:
prosody_ip_card_mgr info 179779
Device 1:
Model: AC5400 PMX
Serial number: 180227
Version: 1.1
Bootloader: Prosody-X-U-Boot 0.4.0-Oct 18 2005
Firmware: Aculab Prosody IP Firmware 0.0.20
3.3V: 3.266V
5V: 4.766V
Temperature 0: 71C
Temperature 1: 57C
32
Call, switch, and speech, telephony software installation guide
The above example will create a file with the file name 131865.cfg
This will not be a fully configured file; certain fields have been left blank for the user to edit
using a standard ASCII text editor. For example, the call section will have no firmware selected
for either the call ports or the DSP 32/65s. Also the Speech section will not have any TiNG
firmware specified.
Example of running the application
The following is an example run on a Windows system. There are no differences in executing
the tool on Windows, Linux or Solaris.
Run cfgtemplates 131865
If the card is already in the system, you will be asked if you wish to automatically detect the card
type.
You will then be asked to specify the bus mode; MVIP, SCBus or H100 (for cPCI select H100).
Next you will be asked if the card is a "Bus Master" i.e. is this card to supply the clock source.
If yes, then the clock source will be requested. If No, the card will take the CTBus Mode as the
clock source.
Now you will be asked to confirm if the card is to be bus terminated (at either end of the CTBus).
If the card is not in the system, you will be asked to specify the card type. This will be followed
by a series of questions relating to the number of ports, SHARCs and so on as appropriate.
Note If you are configuring an IP Telephony card, you will also be asked if you wish to use the IP Telephony services. If you select yes, an
additional configuration file called voip_rm.cfg, containing your selections, will be created. This file must also be copied into
ACULAB_ROOT/cfg
Once all the questions have been answered, the file will be written to the directory that the
application was executed in. You can now manually add any firmwares to the file as required
and copy the file into ACULAB_ROOT/cfg.
33
Call, switch, and speech, telephony software installation guide
[Switch]
CtBusTermination=FALSE
CtBus=SWMODE_CTBUS_H100
H100Mode=H100_SLAVE
Network=0
Source=H100_SOURCE_H100_A
AutoFallBack=H100_FALLBACK_DISABLED
NetRefClockSpeed=H100_NETREF_8KHZ
[EndSwitch]
34
Call, switch, and speech, telephony software installation guide
Note Only the general, call and switch options are common to all cards, speech and VoIP are optional.
The general component fields
This component contains a single field, CardName. The field value should contain the serial
number of the card.
[General]
CardName=Card<128483>
[EndGeneral]
CtBus: This setting controls the bus that the card will use. For H.100use:
SWMODE_CTBUS_H100 - H.100 mode (the default)
Note Changing this setting requires a restart of the drivers for the card. This will only occur the first time this setting is applied to a card -
upon subsequent reboots the card will start in the correct mode."
35
Call, switch, and speech, telephony software installation guide
Source - controls the source of the card's clock. This can be one of the following:
H100_SOURCE_INTERNAL - generate a clock on board and provide it to the CT bus
H100_SOURCE_NETWORK - use the port specified in the network field as the clock
H100_SOURCE_H100_A - take the clock from the H.100 clock master A
H100_SOURCE_H100_B - take the clock from the H.100 clock master B
Network - controls the network port that is used as a clock reference if Source is set to
H100_SOURCE_NETWORK. The network port index is the physical index of the port on the card.
Remember that for the Switch API, ports are numbered from 1.
H100Mode - controls whether the card is an H.100 primary or secondary master or a clock slave.
The possible values for this field are:
H100_SLAVE - card will be a slave on the H.100 bus (Source must be one of
H100_SOURCE_H100_A or H100_SOURCE_H100_B)
H100_MASTER_A - card will drive the A clock on the H.100 bus (Source must be one of
H100_SOURCE_INTERNAL or H100_SOURCE_NETWORK).
H100_MASTER_B - card will drive the B clock on the H.100 bus (Source must be one of
H100_SOURCE_INTERNAL or H100_SOURCE_NETWORK).
AutoFallBack - This field determines the card's behavior when an H.100 clock failure occurs.
This field can contain one of the following values:
H100_FALLBACK_DISABLED
H100_FALLBACK_ENABLED
H100_AUTO_RETURN
H100_CHANGEOVER_TO_NETWORK
See the description of the auto_fall_back field in the documentation for the
sw_h100_config_board_clock() function for an explanation of how these fields apply.
NetRefClockSpeed - This field is used to tell the card the speed of the CT_NETREF fallback
clock. See the description of the netref_clock_speed field in the documentation for the
sw_h100_config_board_clock() function for further details.
CtBus: This setting controls the bus that the card will use. The possible legacy values are:
SWMODE_CTBUS_MVIP - MVIP mode
SWMODE_CTBUS_SCBUS - SC-BUS mode
Mode: Used in legacy mode only, this setting controls the clocking behaviour of the card. It can
take one of the following values:
CLOCK_REF_NET1 - drive bus, take clock from network port 0
CLOCK_REF_NET2 - drive bus, take clock from network port 1
CLOCK_REF_NET3 - drive bus, take clock from network port 2
CLOCK_REF_NET4 - drive bus, take clock from network port 3
CLOCK_REF_MVIP - take clock from MVIP bus
CLOCK_REF_LOCAL - drive bus, generate clock locally
CLOCK_REF_SCBUS - take clock from SC-BUS
Note When using Linux or Solaris, the CT bus mode must match the CT bus mode selected when building/configuring the drivers.
Note Changing bus mode will trigger a restart of the driver for this card. This will only happen the first time the card is put into legacy
mode - upon subsequent reboots it will start in the correct mode.
36
Call, switch, and speech, telephony software installation guide
CtLimitOverride: When in MVIP or SCBUS mode, Aculab PCI cards restrict their switching
capacity in order to better operate with substandard competitor’s cards. There is a method to
enable the card’s full capacity for when you know that the cards it is interfacing with can cope
with it.
The possible values for this entry can be:
TRUE
FALSE
Note Changing this setting requires a restart of the drivers for the card. This will only occur the first time this setting is applied to a card -
upon subsequent reboots the card will start in the correct mode.
Note This setting only applies to SCBUS and MVIP modes.
The call component fields
The following fields are requires in the call section for each port.
Port=
PortName=
Firmware=
Config=
DSPA=
DSPB=
PortInit=
The following definitions apply:
Port
Is the port number starting at 0, if you have four ports then they are numbered 0-3.
PortName
Is a user defined 16 character text string, for example:
Portname=London Port1.
Firmware
The location from ACULAB_ROOT of the call firmware file, for example:
Firmware=/firmware/ETS_SUPN.upr
Config
The firmware switch to applied at download time, for example:
-CNE (ETS300 network side).
For details of available/valid firmware switches, please read the associated
$ACULAB_ROOT/firmware/*_switches.txt file. For example, for ETS this would be the
ets_switches.txt file.
PortInit
Can be either TRUE to perform PortInit, or FALSE to not perform PortInit. For example:
PortInit=TRUE
A typical configuration for a revision 2 PM4 would be as follows:
[Call]
Port=0
PortName=Port 0
Firmware=/Firmware/ETS_SUPN.upr
Config=-cNE
DSPA=/DSP/cpdtmf.bin
DSPB=
PortInit=TRUE
Port=1
PortName=Port 1
Firmware=/Firmware/ETS_SUPU.upr
37
Call, switch, and speech, telephony software installation guide
Config=
DSPA=/DSP/ddtmf.bin
DSPB=
PortInit=TRUE
Port=2
PortName=Port 2
Firmware=/Firmware/ETS_SUPN.upr
Config=-cNE
DSPA=
DSPB=
PortInit=TRUE
Port=3
PortName=Port 3
Firmware=/Firmware/ETS_SUPU.upr
Config=
DSPA=
DSPB=
PortInit=TRUE
[EndCall]
For further information of the available firmwares, please see the TiNG browser documentation
at either:
$ACULAB_ROOT/TiNG/pubdocs/softmodindex.html
or
http://www.aculab.com/support/ting/softmodindex.html
Note In addition to any other firmwares chosen, Prosody X will require the datafeed.elf firmware.
IP telephony
Each IP Telephony card should contain a card specific voip section detailing the settings for that
card.
[VoIP]
IPAddress=192.168.20.14
SubnetMask=255.255.255.0
Gateway=0.0.0.0
EncodeGain=8192
DecodeGain=8192
RTP_TOS=0x0
RTCP_TOS=0x0
Def_Jitter=30
Max_Jitter=150
Max_Jitter_Buffer=250
TDMEncoding=TDM_ULAW
38
Call, switch, and speech, telephony software installation guide
EchoCancel=EC_G165
EchoSpan=16
EchoSuppression=ES_OFF
DTMFDetect=0
[EndVoIP]
Note Prosody X cards do not use the IPAddress, SubnetMask or Gateway fields. These should be set to 0.0.0.0 to allow the config tool to
parse the files correctly.
Another .cfg file (voip_rm.cfg) is generated for the configuration of the shared IP Telephony
services, for example:
[H323Service]
USE=TRUE
H245_Tunneling=IPT_ENABLED
FastStart=IPT_ENABLED
EARLYMEDIA=IPT_ENABLED
[EndH323Service]
[SIPService]
USE=TRUE
AddressHold=IPT_ENABLED
EarlyMedia=IPT_ENABLED
[EndSIPService]
[PortmapService]
USE=TRUE
[EndPortmapService]
39
Call, switch, and speech, telephony software installation guide
PortInit=TRUE
Port=3
PortName=Port 3
Firmware=/Firmware/ETS_SUPU.p4r
Config=
DSPA=conbeepu.bin
DSPB=
PortInit=TRUE
[EndCall]
[Speech]
[EndSpeech]
Note Although the E1/T1 card does not contain and speech (Prosody) modules, for consistency, the configuration file still shows a blank
speech component.
Prosody configuration file example
The following example configuration file is for a Prosody PCI card with a 4 port E1 LIM, two
prosody modules (0 and 1) and a DSP.
[General]
CardName=Card<193>
[EndGeneral]
[Switch]
CtBusTermination=TRUE
CtBus=SWMODE_CTBUS_H100
Source=H100_SOURCE_INTERNAL
Network=0
H100Mode=H100_SLAVE
AutoFallBack=H100_FALLBACK_DISABLED
NetRefClockSpeed=H100_NETREF_8KHZ
[EndSwitch]
[Call]
Port=0
PortName=Port 0
Firmware=/Firmware/ETS_SUPN.p4r
Config=-cNE
DSPA=ddtmf.bin
DSPB=
PortInit=TRUE
Port=1
PortName=Port 1
Firmware=/Firmware/ETS_SUPU.p4r
Config=
DSPA=dconf2u.bin
DSPB=
PortInit=TRUE
Port=2
PortName=Port 2
Firmware=/Firmware/ETS_SUPN.p4r
Config=-cNE
DSPA=ddtmf.bin
DSPB=
PortInit=TRUE
Port=3
PortName=Port 3
Firmware=/Firmware/ETS_SUPU.p4r
Config=
DSPA=cngdet.bin
DSPB=
PortInit=TRUE
[EndCall]
[Speech]
Module=0
Firmwares=inchan.elf recmu.elf
Module=1
Firmwares=inchan.elf recmu.elf
40
Call, switch, and speech, telephony software installation guide
[EndSpeech]
Where:
<serial number> is the serial number of the card, for example, 248 for file 248.cfg
<switches> are the following:
This example will download firmware to ports 0 — 3 & modules 0 —1, reset clocking, and run
verbose.
41
Call, switch, and speech, telephony software installation guide
Note On most cards, the DSP firmware refers to the optional Lucent/AT&T DSP or SHARC ADSP 21065 modules. cPCI E1/T1 cards and DSP65
modules have ADSP 21065 DSPs fitted, and should not be confused with the Prosody ADSP 21065 DSP firmware.
Usage for fwdspldr is as follows:
fwdspldr [-dspa <filename>] <serial_no> <portnum> <filename> <config>
Where:
-dspa Is used to specify which Lucent/AT&T or SHARC ADSP 21065 DSP to
download firmware to. (not applicable to BR4/8 cards).
<serial_no> Is the serial number of the card to download firmware to.
<portnumber> Is the port on the card to download the firmware to.
<filename> Is the DSP or signalling protocol firmware file to download.
<config> Is used to specify any configuration switches to be passed to the signalling
protocol firmware.
Note The filename suffix is subject to the type or revision of the primary rate module (PM). A pre revision 2 PM has a file suffix of .P4R, a
revision 2 PM has a file suffix of .UPR, and a PMX has a file suffix of .PMX
Download Examples
The following example downloads firmware to the first port of a pre revision 2 PM4 module on a
PCI/cPCI Prosody card fitted with a Lucent/AT&T DSP32 module.
fwdspldr -dspa cpdtmf.bin 12345 0 qsig_sup.p4r -cQMA
The following example downloads firmware to the first port of a pre revision 2 PM4 module on
an E1/T1 cPCI card fitted with a ADSP 21065 DSP65 module.
fwdspldr -dspa cpdtmf.b65 145678 0 ets_supn.p4r -s99,255 -cne
The following example downloads firmware to the first two ports of a revision 2 PM4 module on
an E1/T1 PCI card fitted with a ADSP 21065 DSP65 module. The first line downloads a DTMF
tone generation firmware to DSP65 position A, the second line doesn't download any DSP
firmware.
fwdspldr -dspa cpdtmf.b65 12345 0 ets_supn.upr -s99,255 -cne
fwdspldr 12345 1 ets_supu.upr
For more information on the configuration switches available for a specific signalling firmware,
see the release note text files associated with that firmware.
42
Call, switch, and speech, telephony software installation guide
If the E1/T1 PCI Primary Rate Trunk card is in the middle of a ‘chain’ of CTBus devices, then the
termination function is not used. See the ‘E1/T1 PCI Primary Rate Trunk card Installation Guide’ for
the position of the CTBus termination indicator LED. This LED can be used to identify the
terminated cards in a system.
43
Call, switch, and speech, telephony software installation guide
Only the key switches are listed, this is especially the case for ISUP, which has an extensive list.
For further details, check the associated text file for the firmware, which are available from the
Aculab web site download area.
44
Call, switch, and speech, telephony software installation guide
Incorrect setting of the A/B bits will result in an inactive DPNSS layer 2.
B.2.2 –cBBY Backbusy control (CAS only)
Instructs the CAS driver (and signalling system) to use ‘backbusy’:
-cBBY configure all timeslots all ports
-cBBY, xxxxxxxx configure all timeslots indicated in the mask xxxxxxxx
The mask is an 8 digit hexadecimal representation of a 32bit value where each bit indicates the
busy mode. A bit set to 1 will enable backbusy. A bit reset to 0 will disable backbusy. Bit 0 of
the 32bit value controls timeslot 0 and bit 31 controls timeslot 31.
B.2.3 -cCA connect acknowledgement (ETS300 only)
Some equipment require a CONNECT_ACKNOWLEDGE from the user end of the protocol after
receipt of a CONNECT message. This configuration switch provides for this behaviour.
B.2.4 –cCICnnnn circuit identification codes (ISUP only)
-cCICnnnn
-cCICnnnn,aaaaaaaa
-cCICnnnn,aaaaaaaa,bbbbbbbb
Where nnnn is a decimal number of 1 to 4 digits that will be the CIC assigned to the first bearer
timeslot, with subsequent CICs allocated sequentially (including any timeslot used for signalling,
although this CIC will never be used). The OPC and DPC assigned to the ISUP circuits will be
the most recent values preceding the –cSLC parameter itself.
If specified, aaaaaaaa is a CIC MAP, which allows the user to define which timeslots have CICs
assigned to them. It is specified as a 32bit number expressed in hexadecimal, where bit zero
corresponds to timeslot zero etc. If not specified, a value of fffffffe is assumed.
If specified, bbbbbbbb is a Circuit MAP, which allows the user to define which timeslots have
may be used for ISUP call control. It is specified as a 32bit number expressed in hexadecimal,
where bit zero corresponds to timeslot zero etc. If not specified, a value of fffffffe is
assumed Any timeslots which are in use for signalling are automatically excluded from ISUP call
setup, regardless of whether this is explicitly shown in the circuit map.
If –cCICnnnn is not specified, ISUP will not be available for call setup on the timeslots of that
port.
B.2.5 -cCn number of CLI digits (CAS only)
It is necessary for the device driver and signalling system firmware to know the number CLI
digits supported by the trunk. The driver configuration switch available for this purpose is –cCn,
where n is a one or two digit decimal value of the number of digits required.
The -cCn option specifies the number of CLI digits expected by the system, for example, -cC4
instructs the driver/signalling system to expect 4 CLI digits
It is important that this initial configuration is correct or unexpected behaviour may result.
45
Call, switch, and speech, telephony software installation guide
2. CURRENCY - The second method is CURRENCY. When this type of information is used by the
protocol the transmitted value is the accumulated cost of the call up to that point. This
information is passed to the driver in the "charge" field of put_charge_xparms. The format of
this string is an ASCII representation of the numeric value. Example : To send the value of 100
the three ASCII characters necessary to encode 100 as a string would be used. Printing this string
to the screen should show '100' (without quotes).
Codes For Different Countries (n)
n=1 Switzerland/CURRENCY Charging will use Facility information elements based on ETS300
182. A charging string in put_charge_xparms() is required.
n=2 Germany/UNITS Charging will use Facility information elements based on ETS300 182. The
charging string in put_charge_xparms() is ignored.
n=3 Holland/UNITS Charging will use Display information elements based on a country Specific
specification. The charging string in put_charge_xparms() should be left blank.
n=4 Switzerland/CURRENCY Charging will use Display information elements based
on a country Specific specification. A charging string in put_charge_xparms()
is required.
n=5 Austria/CURRENCY Charging will use Facility information elements based on
ETS300 182. A charging string in put_charge_xparms() is required.
n=6 Norway/CURRENCY Charging will use Facility information elements based on
ETS300 182. A charging string in put_charge_xparms() is required.
n=7 Sweden/CURRENCY Charging will use Facility information elements based on
ETS300 182. A charging string in put_charge_xparms() is required.
n=99 Disable Charging
46
Call, switch, and speech, telephony software installation guide
B.2.15 -cIMP75
Sets line impedance to 75 ohms (default is 120 ohms).
B.2.16 –cME
If an outbound DASS/DPNSS call is made with the sending complete flag set, then an ISRMC is
used, otherwise an ISRMI will be sent. If the -cMC switch is applied an ISRMC will be used for
all outbound calls, regardless of whether the sending complete flag is set.
47
Call, switch, and speech, telephony software installation guide
B.2.19 –cNE network end configuration (DASS, ETS300, FETEX, AT&T, and NI2)
Default setting: User end
Network end configuration, sets up the device driver for network end working
-cNE configure port for network end
This switch applies to signalling systems with the exception of CAS, DPNSS, QSIG and ISUP.
Note For correct network end operation, you will require the network end firmware for that signalling system.
One end must be set to be master and the other end must be set to be slave. Incorrect setting of
these bits will result in an inactive QSIG layer 2. The default configuration for QSIG is –cQSB.
This option allows the default clearing cause to be configured, where n is a one or two digit
hexadecimal value of the required clearing cause and must be a correct value supported by the
signalling system.
48
Call, switch, and speech, telephony software installation guide
49
Call, switch, and speech, telephony software installation guide
Appendix C: Troubleshooting
C.1 Call Driver and Signalling Firmware Problems
Device Driver Error Message
C.1.1 Firmware Download Errors
The restart or FWDSPLDR utility is used to download the signalling system firmware to a Digital
Access card. This may produce many errors. This section covers the more common errors.
Bad Systat from Downloaded Signalling System
This is an indication that the download signalling system has detected an error or cannot start.
This may occur for example if a ‘tone based’ signalling system could not find the DSP daughter
card, or the clock is not set correctly for that card.
Device driver does not support the download Signalling system
Ensure that you are specifying the correct firmware file (.UPR .P4R) file for the device driver
that you have installed. If you are trying to download ‘network end’ firmware ensure that you
have set the -cNE configuration switch on the call driver or on the command line when using
restart.
Downloaded signalling system failed to start
The downloaded firmware is not executing. Ensure that you have specified the correct firmware
file for the installed device driver.
Note Ensure that the firmware file is the latest available from Aculab.
50