1. Manuals
  2. Brands
  3. Dialogic Manuals
  4. Software
  5. Brooktrout Digital Board
  6. Installation and configuration manual

Dialogic Brooktrout Digital Board Installation And Configuration Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Dialogic® Brooktrout® Fax Products SDK
Installation and Configuration Guide
Release 6.6
March 2013
931-131-11
www.dialogic.com

Advertisement

Table of Contents
loading

Related Manuals for Dialogic Brooktrout Digital Board

Summary of Contents for Dialogic Brooktrout Digital Board

  • Page 1 Dialogic® Brooktrout® Fax Products SDK Installation and Configuration Guide Release 6.6 March 2013 931-131-11 www.dialogic.com...
  • Page 2 It is possible that the use or implementation of any one of the concepts, applications, or ideas described in this document, in marketing collateral produced by or on web pages maintained by Dialogic may infringe one or more patents or other intellectual property rights owned by third parties.

  • Page 3: Hardware Limited Warranty

    Refer to the following Dialogic web site for information on hardware warranty information, which applies unless different terms have been agreed to in a signed agreement between yourself and Dialogic Corporation or its subsidiaries. The listed hardware warranty periods and terms are subject to change without notice. For purchases not made directly from Dialogic please contact your direct vendor in connection with the warranty period and terms that they offer.

  • Page 4: Software Developer License Agreement

    1.6. “License Key” means an access code or activation key provided by Dialogic to enable an End User to use the Software. 1.7. “Software” means the software provided to you in the enclosed package, or enabled by the enclosed Developer License Key together with any accompanying documentation.
  • Page 5 End Users for their internal business purposes in connection with Dialogic Hardware. The Software is used in connection with Dialogic Hardware if it is operated only on the central processing unit of a computer served by one or more items of Dialogic Hardware and, where appropriate in connection with such use, it is downloaded into memory located on Dialogic Hardware.
  • Page 6 BE UNINTERRUPTED OR ERROR-FREE, OR THAT IT WILL SATISFY DEVELOPER’S REQUIREMENTS. 4.3. Dialogic will not be responsible to any End User for any warranties made by Developer with respect to any Software beyond the limited warranty described in Exhibit B.
  • Page 7 End Users and Sublicensees are in compliance with the terms of this Agreement. Within five (5) days after termination of this Agreement, you shall return to Dialogic or destroy, at Developer’s expense, the Software, including all copies thereof. Sections 2.3-2.8, 2.10, 3, 4, 5, 6, 7, 8, and 9 of this Agreement shall survive termination of this Agreement.
  • Page 8 EXHIBIT A THIRD PARTY SOFTWARE LICENSES The Software includes object code versions of the following third party software packages which are subject to the terms and conditions of the applicable license agreements found at the websites identified: ACE™ software and TAO™ software are copyrighted by Douglas C. Schmidt and his research group at Washington University, University of California, Irvine, and Vanderbilt University.

  • Page 9: Table Of Contents

    Chapter 1 – Quick Start Steps ......25 This chapter provides a series of steps that you can perform to quickly set up and test your installation of the Dialogic® Brooktrout® software and hardware. Determining the Board Module Number .
  • Page 10 Chapter 2 – Installing the SDK on Red Hat Linux....34 This chapter describes how one can install Dialogic® Brooktrout® software on Red Hat Linux operating systems.
  • Page 11 Chapter 3 – Installing the SDK on Solaris ....54 This chapter describes how one can install Dialogic® Brooktrout® software on Solaris operating systems.
  • Page 12 ........... 110 Dialogic® Brooktrout® Bfv API Libraries and Makefiles .
  • Page 13 Chapter 6 – Configuring Software ......119 This chapter describes how one can configure the Dialogic® Brooktrout® Fax Software for your Dialogic®...
  • Page 14 ......... . 145 Chapter 8 – Using the Dialogic® Brooktrout® TECUpdate Utility 152 This chapter describes how one can use the Dialogic® Brooktrout® Technology Expansion Capability (TEC) utility to display and upgrade the configured feature set on an installed board.
  • Page 15 Class A Statements (for “Class A” products) ......170 Class B Statements (for “Class B” products) .
  • Page 16 Checking the Installation ..........194 Defining Default Symbols .

  • Page 17: Preface

    The Dialogic® Brooktrout® Fax Products SDK Installation and Configuration Guide explains how to install the software (firmware, Dialogic® Brooktrout® Bfv APIs, and driver for the Dialogic® Brooktrout® TR1034/SR140/TruFax® products) on your host system. It also describes how to configure the driver, configure call control, and download the firmware to a Brooktrout module.

  • Page 18: Operating System Support

    License Manager. Operating System Support See the latest Dialogic® Brooktrout® Release Notes for the supported operating systems. A copy of the Dialogic® Brooktrout® Release Notes is found in the Documents directory on the Dialogic®...

  • Page 19: Manual Conventions

    C:>Files installed. The Courier font also denotes programming code, such as C and C++. Programming code appears in program examples. Bold indicates names of variables, Dialogic® Brooktrout® Bfv API functions, dialog boxes, dialog box controls, windows, and menu items. Square brackets [ ] indicate that the information to be typed is optional.

  • Page 20: Related Documents

    These installation cards come with their respective boards: Brooktrout Digital Board (Multiple Spans) Installation describes how to install the Brooktrout Digital Board (Multiple Spans). Brooktrout TR1034 Analog Loop Start Full-sized PCI Fax Board Installation describes how to install the Brooktrout TR1034 Analog Loop Start Full-sized PCI Fax Board.

  • Page 21: Software Documents

    For product information, white papers, FAQs, and more, access the Dialogic web site at www.dialogic.com. These documents come with the Dialogic® Brooktrout® SDK: Brooktrout Fax Products Linux End User Guide is for users running either of the following in a Linux environment: Brooktrout SR140 Fax Software or Brooktrout TR1034 Series and Brooktrout TruFax Boards.

  • Page 22: Getting Technical Support

    Getting Technical Support Getting Technical Support Dialogic provides technical services and support for customers who have purchased hardware or software products from Dialogic. If you purchased products from a reseller, please contact that reseller for technical support. To obtain technical support, please use the web site below: www.dialogic.com/support...

  • Page 23: Updated Terminology

    The current version of this document includes terminology that differs from previous versions. Please note the changes below: Former Terminology Replaced with... Host-based fax Dialogic® Brooktrout® SR140 Fax Software Virtual modules Brooktrout SR140 Fax Software Virtual boards Software modules SR140 Software...
  • Page 24 Getting Technical Support Dialogic® Brooktrout® TR1034 Fax Board Terminology The Dialogic® Brooktrout® TR1034 Fax Board is also referred to herein by one or more of the following terms, or like terms including “TR1034”: Brooktrout TR1034 Fax Board Brooktrout TR1034 Board...

  • Page 25: Chapter 1 – Quick Start Steps

    1 - Quick Start Steps This chapter provides a series of steps that you can perform to quickly set up and test your installation of the Dialogic® Brooktrout® software and hardware. Because the installation and configuration procedures can be quite...

  • Page 26: Determining The Board Module Number

    Using some utilities (refer to Sample Applications and Utilities in the Dialogic® Brooktrout® Fax Products SDK Developer Guide) A module is a unit that communicates on a Dialogic® Brooktrout® TR1034, TruFax®, or Brooktrout SR140 Software. In general, each module corresponds to a control processor on the board. Most Dialogic®...

  • Page 27: Dialogic® Brooktrout® Sr140 Fax Software

    Linux systems only and uses IP-enabled call control through SIP and H.323 stacks. If you have a Dialogic® Brooktrout® SR140 Software license, you must install the Dialogic® Brooktrout® software first. Then you can activate the Dialogic® Brooktrout® SR140 Software using the Dialogic®...

  • Page 28: Quick Start For Windows Systems

    Hardware Do the following to install the Dialogic® Brooktrout® software and hardware: 1. Before you install a Dialogic® Brooktrout® board, install the Brooktrout SDK by inserting the Dialogic® Brooktrout® Fax Products SDK CD-ROM into the CD-ROM drive. Then follow the...

  • Page 29: Step 3: Compile And Run The Sample Application

    Step 2: Configure the Dialogic Brooktrout Software and Hardware Follow the steps below to run the Dialogic® Brooktrout® software and hardware: 1. Run the Dialogic® Brooktrout® Configuration Tool to configure the driver and the call control parameters. See Using the Dialogic®...
  • Page 30 Quick Start for Windows Systems Introduction to the Bfv API describes the Bfv API Debugging describes how to debug your applications Sample Applications and Utilities describes how to compile and use the sample applications March 2013...

  • Page 31: Quick Start For Linux And Solaris Systems

    Follow the steps below to install Dialogic® Brooktrout® software and hardware: 1. Power down the computer and install the Dialogic® Brooktrout® board in your computer chassis. For installation instructions, see the hardware installation card that came with your board.

  • Page 32: Step 2: Configure The Dialogic® Brooktrout® Software And Hardware

    To compile sample applications, refer to Sample Applications and Utilities in the Dialogic® Brooktrout® Fax Products SDK Developer Guide. For information on testing your configuration, refer to the Dialogic® Brooktrout® Fax Products Linux End User Guide. Next Steps...
  • Page 33 Quick Start for Linux and Solaris Systems For more information, see these chapters in the Dialogic® Brooktrout® Fax Products SDK Developer Guide: Introduction to the Bfv API describes the Dialogic® Brooktrout® Bfv API. Debugging describes how to debug your applications.

  • Page 34: Chapter 2 – Installing The Sdk On Red Hat Linux

    2 - Installing the SDK on Red Hat Linux This chapter describes how one can install Dialogic® Brooktrout® software on Red Hat Linux operating systems. This chapter contains the following: Installation Steps on page 35 Configuring the Driver Manually on page 39...

  • Page 35: Installation Steps

    Installation Steps Installation Steps If you have a Dialogic® Brooktrout® SR140 license, you must install the Dialogic® Brooktrout® SDK software first. Then you can turn on SR140 Software by either of the following: Use the interactive web method Create a request for email or fax See Activating Dialogic®...

  • Page 36: Installing The Software

    Installation Steps Installing the Software The Dialogic® Brooktrout® Fax Products SDK CD-ROM comes with an installation program that uses rpm to install the files on your hard drive. To use the program, follow the directions below. You must be logged in as root or su to install/uninstall the software and configure the driver.
  • Page 37 Installation Steps The program then displays: Press ENTER to continue or ’q’ then ENTER to quit setup. 4. The program then displays: Default install directory is /usr/sys/brooktrout Please enter desired install directory or just press ENTER to use default directory. 5.

  • Page 38: Removing The Software

    Installation Steps After installing the software, you must download the firmware. See Downloading Firmware on page 159. Removing the Software When you install the software on Linux, you can choose one or two packages. If you choose to install the “Bfv Binary files,” rpm installs a package called BRKTBOSsetup.

  • Page 39: Configuring The Driver Manually

    Configuring the Driver Manually Configuring the Driver Manually To configure the driver manually, change to the /usr/sys/brooktrout/boston/driver/linux/install directory and run the dinstall program. The configuration dialog is as follows: Installing Brooktrout Boston Device Driver Version 6.0.0 Maximum number of PCI/cPCI hardware modules (default 16): Physical buffer size (default 32768): Application buffer size (default 10240): Machine ID, in hex (default 1):...

  • Page 40: History Logging

    For low-load systems or when debugging, enable history logging. Leave the number of physical and application channel histories at 0 unless you are directed to change this by Dialogic Technical Services and Support. If you change the physical or application buffer size, do not change the value to one smaller than the default.

  • Page 41: Advanced Configuration Parameters

    I2O frames, driver flow control interval, internal memory allocation parameters, module reservations, and test parameters. Do not configure advanced parameters except under the advice of Dialogic Technical Services and Support. Linux Kernel Versions Different versions of Linux have different kernel version numbers, and patches to Linux can also change the kernel version number.

  • Page 42: Using Boston Host Service Under Linux

    Using Boston Host Service Under Linux Boston Host Service (Bostsrv) is used to initialize modules. Upon startup it detects Dialogic® Brooktrout® modules, loads FW and initializes the call control. You must use Boston Host Service to run a multi-process application or to use Brooktrout SR140 Software modules.

  • Page 43: Root Login For Unix

    When you install the Software on a Red Hat Linux operating system, consider the following: PCI Considerations on page 44 Dialogic® Brooktrout® Bfv API Libraries and Makefiles on page 45 Writing Multithreaded Programs on page 45 Warning and Error Messages on page 46...

  • Page 44: Pci Considerations

    Special Considerations PCI Considerations When configuring the device driver, you must select 0 when asked for the number of ISA boards. The operating system and/or system BIOS assigns base addresses and interrupt numbers to the PCI boards, which can change when the system is rebooted, especially if devices are added or moved.

  • Page 45: Writing Multithreaded Programs

    Bfv API. If the stack size is not large enough, unpredictable behavior can result. Dialogic usually finds a stack size of 64K to be sufficient but, depending on the application’s stack allocation demands, more memory might be required.

  • Page 46: Warning And Error Messages

    Special Considerations Warning and Error Messages If the driver has an error or warning to report (often related to driver startup problems), the report always appears on the system console, if such a device exists for that platform. Additionally, a limited amount of messages are sometimes available if you use the crash command and select the panic option.
  • Page 47 Special Considerations Reserved Machine ID Reset option (1 or 0) History Enable History Size 1024000 Num physical histories Num app histories Restrict phys channels (1 or 0) Number of I2O frames Flow control interval Memory alloc minimum Memory alloc quanta Reserved Test parameter 1 Test parameter 2...

  • Page 48: Driver File Locations

    Using these options, the compiler and linker produce object files and executables compatible with the Bfv API library. Dialogic strongly recommends that you use these options for all your Dialogic® Brooktrout® Bfv API applications. But for those who want...

  • Page 49: Message About "Tainted" Kernel

    GNU Public License (GPL) has been loaded. The Dialogic® Brooktrout® driver does not conform to the GPL because it is not distributed in source form. The only option for a driver that does not conform to the GPL is to claim its license type is “Proprietary”, and that causes the message to be logged.

  • Page 50: Selinux

    Special Considerations SELinux SELinux prevents bostlib_mt.so and other Dialogic-supplied shared libraries from loading because they require text relocation, which is very common for third-party shared libraries. Follow one of the methods below to allow shared libraries to load: Disable SELinux as follows: In /etc/selinux/config, set SELINUX to disabled and reboot.

  • Page 51: Recompiling On Linux Platforms

    Use the instructions below to recompile the Dialogic® Brooktrout® driver on supported Linux platforms so that the driver can operate with any kernel patch for supported Linux versions. Dialogic only supports official kernel patches as released by Red Hat. After you...
  • Page 52 Recompiling on Linux Platforms Before building a Dialogic® Brooktrout® driver for a patch version, install the kernel source, the compiler, and other standard development tools on the system. To build a driver for a kernel patch version, enter the following at the command prompt: make -f Makefile.kerndep...

  • Page 53: Bostsrv Port In Use Error

    Additional Packages Required for Red Hat Linux 6.0 x64 Only The following packages are required for the Dialogic Brooktrout SDK to be used on Red Hat Linux 6.0 x64 systems. It does not affect any x86 systems, and it does not affect any versions earlier than 6.0.

  • Page 54: Chapter 3 – Installing The Sdk On Solaris

    3 - Installing the SDK on Solaris This chapter describes how one can install Dialogic® Brooktrout® software on Solaris operating systems. Note: The SR140 is not supported on Solaris operating systems. This chapter has the following sections: Installation Steps on page 55...

  • Page 55: Installation Steps

    The software is for SPARC®. Dialogic supports only official development environments from Sun, such as Sun Workshop, Sun Pro, and Forte. In particular, GNU development environments are not supported.

  • Page 56: Installing The Software

    ./setup.sh The program begins with the following messages: The following packages are available: 1 BOSsetup Dialogic Brooktrout Fax SDK (sparc) 6.4.0 Select package(s) you wish to process (or 'all' to process all packages). (default: all) [?,??,q]: March 2013...
  • Page 57 ***************************************************************** Welcome to the Dialogic Setup Program. Depending on your needs this program will install the Boston API & Driver on your system. Press ENTER to continue or 'q' then ENTER to quit setup.

  • Page 58: Removing The Software

    Installation Steps 9. Please read and accept the license agreement to continue: Press the spacebar to continue or q to quit. (The program named “less” displays the license agreement.) 10. After you choose q to quit out of license agreement you get the following message: Do you accept the above agreement? 11.

  • Page 59: Starting Or Stopping The Driver

    Installation Steps This command removes only the files and directories that the installation procedure placed on the system. Starting or Stopping the Driver Because the driver loads automatically when needed, there are no explicit steps required to load the driver. To stop or shut down the driver, enter: /etc/bostunld -r Reinitializing the Driver...

  • Page 60: Configuring The Driver Manually

    Configuring the Driver Manually Configuring the Driver Manually To configure the driver manually, change to the installation directory and run the dinstall program: The configuration dialog is as follows: Installing Brooktrout Boston Device Driver Version 5.2.0 Maximum number of PCI/cPCI hardware modules (default 16): Physical buffer size (default 32768): Application buffer size (default 10240): Machine ID, in hex (default 1):...

  • Page 61: History Logging

    Leave the number of physical and application channel histories at 0 unless you are directed to change this by Dialogic Technical Services and Support. If you change the physical or application buffer size, do not change the value to one smaller than the default.

  • Page 62: Resource Allocation Failures

    I2O frames, driver flow control interval, internal memory allocation parameters, module reservations, and test parameters. Do not configure advanced parameters except under the advice of Dialogic Technical Services and Support. The driver is configured and ready to be started.

  • Page 63: Root Login For Unix

    Using Boston Host Service Under Solaris cd /usr/sys/brooktrout/boston/bfv.api/solaris/bin/32 Use any of the following command line options: Option Meaning -c <file> Full path to the btcall.cfg file and name of the btcall.cfg file Run as daemon (in background) -f <path> Full path to board firmware Stops the daemon Stops the daemon -stop...

  • Page 64: Dialogic® Brooktrout® Bfv Api Libraries And Makefiles

    On some systems, when certain Dialogic® Brooktrout® boards are installed the system might hang at boot time if the device driver is not already installed. Remove the boards, install the driver, then reinstall the boards.

  • Page 65: Writing Multithreaded Programs

    Bfv API. If the stack size is not large enough, unpredictable behavior can result. Dialogic usually finds a stack size of 64K to be sufficient but, depending on the application stack allocation demands, more memory might be required.

  • Page 66: Memory Allocation Error

    Special Considerations Warning and Error Messages If the driver has an error or warning to report (often related to driver startup problems), the message always appears on the system console if such a device exists for Solaris. In addition, message are available in other ways.

  • Page 67: Command Line Configuration For Dinstall

    Special Considerations Command Line Configuration for dinstall When configuring the device driver using dinstall, you can specify the command line option -c to cause the dinstall program to not prompt you for any parameters. Instead, the dinstall program uses the responses that you supply following the -c option on the command line.

  • Page 68: Structure Packing

    Solaris) seem not to handle packing properly. When using compilers with this problem, the best solution is to write source code modules that use Dialogic® Brooktrout® functions and structures in C. Then, if desired, write other portions in C++.

  • Page 69: Compiler Issues

    To ensure proper functioning of your applications when using an older version of the C compiler, Dialogic recommends that you contact Dialogic Technical Services and Support for the source version of the Bfv API and compile the Bfv API library using the older compiler.

  • Page 70: Reviewing Compiler And Linker Options

    Using these options, the compiler and linker produce object files and executables compatible with the Bfv API library. Dialogic strongly recommends that you use these options for all your Bfv API applications. But for those who want to change the set of options the compiler and linker use, the following is a list of the nonstandard options and their functions.

  • Page 71: Chapter 4 – Installing The Sdk On Windows

    4 - Installing the SDK on Windows This chapter describes how one can install Dialogic® Brooktrout® software on Windows operating systems. This chapter contains the following sections: System Requirements for Installation on page 72 Installing the Dialogic® Brooktrout® SDK on page 74...

  • Page 72: System Requirements For Installation

    System Requirements for Installation System Requirements for Installation When running the installation, you need the following: Administrator privileges Sufficient available disk space on the drive that contains the Windows temp directory to extract the sdk_windows.exe file. By default the Windows operating system sets it to [WINDOWS_VOLUME]\temp, where WINDOWS_VOLUME is the drive where the operating system is installed.

  • Page 73: Installation Packages

    Dialogic® Brooktrout® Runtime Software (boston.msi) This installation package is intended for end users. It contains only the runtime binaries and tools. Refer to the Dialogic® Brooktrout® Fax Products Windows End User Guide for more information. You can also integrate the components into your installation by using the merge modules, provided in the Dialogic®...

  • Page 74: Installing The Dialogic® Brooktrout® Sdk

    Installing the Dialogic® Brooktrout® SDK Installing the Dialogic® Brooktrout® SDK If you do not have the Dialogic® Brooktrout® Fax Products SDK, contact your sales associate. Also, although Dialogic recommends that you install the Brooktrout SDK before you install your Computer Telephony, if you choose to install the boards first, the Found New Hardware Wizard searches for and launches the driver installation.
  • Page 75 Installing the Dialogic® Brooktrout® SDK Follow the steps below to install the Dialogic® Brooktrout® SDK from the CD-ROM: 1. Insert the SDK CD-ROM into a CD drive. The Autorun program starts automatically. If the Autorun program does not start automatically: a.
  • Page 76 Installing the Dialogic® Brooktrout® SDK 5. Click Change to choose a folder or click Next for the default folder, C:\Brooktrout\Boston. In the example, C:\Brooktrout\Boston is the destination folder where the application software installs the Brooktrout SDK contents. If you choose Next , go to Step 7.
  • Page 77 The Installing Dialogic Brooktrout SDK window appears. After the software is installed, the InstallShield Wizard Completed windows appears. The installation program reminds you to activate your Dialogic® Brooktrout® SR140 with the Brooktrout License Manager and to finish configuring using the Brooktrout Configuration Tool.
  • Page 78 Installing the Dialogic® Brooktrout® SDK When the x32 Windows installation finishes, the following InstallShield Wizard InstallShield Wizard Completed window appears: Completed When the x64 Windows installation finishes, the following InstallShield Wizard Completed window appears: On Windows Server 2003 x64 and Windows Server 2008 x64, install the Brooktrout x64 package if you are running a 64-bit applications.
  • Page 79 Brooktrout® license. See the SR140 Fax Software Windows User (SR140 Only) Guide for more information. You must compile the sample applications if you want to use them. Sample Applications See the chapter in the Dialogic® Brooktrout® Fax Products SDK Developer Guide on compiling the sample applications. March 2013...
  • Page 80 Installing the Dialogic® Brooktrout® SDK The InstallShield Wizard does not install the latest Brooktrout Remove Previous Version SDK if you have a previous version of the SDK. You must remove it before installing the latest SDK. Removing or Modifying the Software on page 81...

  • Page 81: Removing Or Modifying The Software

    Dialogic Brooktrout x64 components. Refer to Brooktrout_x64 on page 83 2. Select Dialogic Brooktrout Boston SDK from the program list. If you click Remove, the system asks you if you want to remove the software in the Add/Remove Programs dialog box.
  • Page 82 5. Click Install. The software installs the Dialogic® Brooktrout® SDK. If you choose Repair, the Ready to Repair window appears. 6. Click Install to have the wizard install the Dialogic® Brooktrout® SDK again. Then the InstallShield Wizard Completed window appears after the software is reinstalled to either modify or repair it.

  • Page 83: Bit Windows Api Libraries

    64-bit Windows API Libraries 64-bit Windows API Libraries The 64-bit API libraries allow customers to build 64-bit applications that take full advantage of Windows 64-bit performance on x64 systems. On a 64-bit system, the Brooktrout package installs the 64-bit 64-bit system version of the libraries in the following directory: windows\system32 The 32-bit libraries are installed in the following directory:...

  • Page 84: System Files

    64-bit Windows API Libraries System Files You can install either combination of packages below: sdk_windows.exe and Brooktrout_x64.msi boston.msi and Brooktrout_x64.msi After installing them, the following configuration will be on the 32- and 64-bit operating systems: A 32-bit operating system will have the following files installed in 32-bit operating system the system32 directory: system32\bostdlld.dll...
  • Page 85 64-bit Windows API Libraries All the above files will also be available in the Brooktrout\boston directory. Note: The system32 directory on a 64-bit system is visible only by using 64-bit applications like Explorer. The 32-bit applications are not able to access that location. March 2013...
  • Page 86 5 - Installing the Device Driver on Windows This chapter describes how one can install the device driver on Windows systems. This chapter contains the following: Installing and Configuring Options on page 87 Installing the Plug-and-Play Driver on page 88 Installing and Configuring the Driver using a Command (cmd) Prompt on page 103 Using the Boston Host Service on page 108...

  • Page 87: Installing And Configuring Options

    You must be running on Windows 2000 (or later) to install the driver automatically using the Plug-and-Play (PnP) feature of the operating system. SR140 (virtual module) users can also use the Dialogic® Brooktrout® Configuration Tool to install the driver. Manually running the install program from the command line.

  • Page 88: Installing The Plug-And-Play Driver

    Installing the Plug-and-Play Driver Installing the Plug-and-Play Driver After you have installed your Dialogic® Brooktrout® board the operating system can automatically install the driver for your board. The Microsoft hotfix 909666 is required when running Windows Server 2003 x64. Obtain the hotfix from Microsoft at http://support.microsoft.com/ by referencing the...
  • Page 89 Installing the Plug-and-Play Driver 2. Click Next to continue the device driver installation. The Install Hardware Device Driver window appears. Installing Hardware Device Driver 3. Choose the Search for a suitable driver for my device (recommended) and click Next . The Locate Driver Files window appears so the wizard can search Locating Driver Files for a suitable driver.
  • Page 90 Installing the Plug-and-Play Driver 4. Check Specify a Location and click Next. 5. The following window appears where you can browse to select the Browsing for the trxstream.inf file located in the following folder: .inf File C:\Brooktrout\Boston\driver\winnt\pnp 6. Click OK. The Driver File Search Results window appears.
  • Page 91 Installing the Plug-and-Play Driver 7. The Hardware Co-Installer checks if the Dialogic® Brooktrout® Software is installed on your system. a. Click Next to install the Dialogic® Brooktrout® Software. If you do not have Dialogic® Brooktrout® Software installed, before the Completing the Found New Hardware Wizard window...
  • Page 92 Installing the Plug-and-Play Driver b. The Hardware Co-Installer window and the Dialogic® Brooktrout® Configuration Tool Timer dialog boxes appear. Click the Launch Now button in the Timer Mode dialog box to set a timer that launches the Brooktrout Configuration Tool after a specified amount of time.
  • Page 93 Installing the Plug-and-Play Driver 8. Click Next to the Co-Installer window. The Completing the Found New Hardware Wizard window appears. 9. Click Finish. The Plug-and-Play installation is complete. March 2013...
  • Page 94 Installing the Plug-and-Play Driver Follow the steps below to verify that the Dialogic® Verifying Dialogic® Brooktrout® board is successfully installed on your Brooktrout® system: Board Integration 1. Click one of either: → → Control Panel Administrative Tools Computer Management The Computer Management window appears: →...
  • Page 95 Installing the Plug-and-Play Driver The Device Manager window appears: 2. To view the properties of the Dialogic® Brooktrout® board in your system, double-click the board name in one of the windows shown above. The Brooktrout TRxStream Board Properties dialog box appears.

  • Page 96: Updating Computer Telephony And The Plug-And-Play Driver

    Installing the Plug-and-Play Driver 4. Click the Configure button to use the Dialogic® Brooktrout® Configuration Tool Wizard to configure the device driver as well as other facilities of the board (for example, telephony). For extra help, see Configuring Software on page 119 information about configuring your system.

  • Page 97: Updating Previous Versions Of The Plug-And-Play Driver

    7. Click Finish. 8. Follow Step 1 through Step 6 to remove each Dialogic® Brooktrout® board that is listed as PCI Device (or possibly Network Controller) in the Devices list in the Installed Devices window.
  • Page 98 Installing the Plug-and-Play Driver work. The system uses the old file and location instead of the new one. Delete the old copy of the trxstream.inf file and its Plug-and- Play components before installing the new one. If you do not have the software installed, the Co-Installer provides an option to install the software.

  • Page 99: Removing The Plug-And-Play Driver

    Installing the Plug-and-Play Driver Removing the Plug-and-Play Driver Installing a Dialogic® Brooktrout® device using the Plug-and-Play Manager (Found New Hardware Wizard) creates some backup files and registry entries. The Windows Plug-and-Play Manager uses this information to automatically install the device on rebooting.

  • Page 100: For Driver Version 5.2 (Brooktrout Sdk Version 5.2.0 And Later.)

    Installing the Plug-and-Play Driver 6. Examine the registry value InfPath located under: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control \Class\{50CE2010-E61B-40EF-9EAA-2BCDE74F8C6C}\0000. This value contains the name of the backup copy of the trxstream.inf file, that Windows created during device installation under the C:\WINNT\INF directory. Removing the Plug and Play Driver 7.
  • Page 101 Installing the Plug-and-Play Driver 5. Delete the following files: C:\WINNT\SYSTEM32\DRIVERS\boston.sys C:\WINNT\SYSTEM32\brktBdevpp.dll C:\WINNT\SYSTEM32\brktBdevco.dll 6. Examine the registry value InfPath located under: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control \Class\{8CF4CA66-A2CC-48FA-BC1D-6A64E47F6D27}. Search for the first key which contains the following values: DriverDesc=Brooktrout TRxStream Board This key should contain the name of the backup copy of the trxstream.inf file that Windows created during the device installation under C:\winnt\INF.

  • Page 102: Disabling Plug-And-Play Driver Installation

    Installing the Plug-and-Play Driver Disabling Plug-and-Play Driver Installation After you install a Dialogic® Brooktrout® board, the Windows operating system might display a window stating that a new PCI device was found and offer to detect/install a driver for it. Proceed with the automatic detection.

  • Page 103: Installing And Configuring The Driver Using A Command (Cmd) Prompt

    Installing and Configuring the Driver using a Command (cmd) Prompt Installing and Configuring the Driver using a Command (cmd) Prompt To install and configure the driver manually, change to the [InstallDir]\driver\winnt\install directory and run the install program. You can use this application to install Plug-and-Play drivers.
  • Page 104 Installing and Configuring the Driver using a Command (cmd) Prompt Configuring Boston driver: Phys buf size 32768 App buffer size 10240 Machine ID 1 History size 1024000 Num phys hist bufs 0 Num apl hist bufs 0 Load driver with no devices present? (y or n, default y): When using Boston PCI hardware modules, a system memory adjustment may be required in order to properly access the modules.

  • Page 105: Memory Resources

    For low-load systems or when debugging, enable history logging (1). Leave the number of physical and application channel histories at 0 unless you are directed to change this by Dialogic Technical Services and Support. If you change the physical or application buffer size, do not change the value to one smaller than the default.
  • Page 106 Installing and Configuring the Driver using a Command (cmd) Prompt this type of memory or will in the future, and possibly other factors. If you choose to perform the system memory adjustment, install prompts you for the system memory size. Enter the number of MB of memory in the system[32]? If a memory adjustment has been performed by another program, install prompts you as to how to proceed.

  • Page 107: Removing The Driver With A Command (Cmd) Prompt

    Brooktrout SDK. If you installed the Dialogic® Brooktrout® PnP hardware using some other INF file that registers the Dialogic® Brooktrout® boards under a class other than Computer Telephony, the -r option can fail to completely uninstall this device.

  • Page 108: Using The Boston Host Service

    Using the Boston Host Service The Boston Host Service (Bostsrv) is used to initialize modules. Upon startup it detects Dialogic® Brooktrout® modules, loads FW and initializes the call control. You must use the Boston Host Service to run a multi-process application or to use Dialogic® Brooktrout®...

  • Page 109: Starting Bostsrv

    To set the Boston Host Service to start automatically, set startup mode to Automatic using Windows Services window. This initializes the Dialogic® Brooktrout® modules upon machine starter reboot. You can also perform this step through the Options, Preferences..Boston Host Service in Start Mode in the Brooktrout Configuration Tool.

  • Page 110: Special Considerations

    When you install the device driver on a Windows operating system, consider the following topics: PCI Considerations on page 110 Dialogic® Brooktrout® Bfv API Libraries and Makefiles on page 111 Writing Multithreaded Programs on page 111 Using BOSTDLLD with Debugging Enabled on page 111...

  • Page 111: Using Bostdlld With Debugging Enabled

    Bfv API. If the stack size is not large enough, unpredictable behavior can result. Dialogic usually finds a stack size of 64k to be sufficient but, depending on the application stack allocation demands, more memory might be required.

  • Page 112: Determining Installation Parameters

    To avoid these kinds of pointer problems, the Bfv API provides a set of _dll_… functions. See Volume 1 of the Dialogic® Brooktrout® Bfv APIs Reference Manual. Determining Installation Parameters Any time after the driver has been installed (but not removed), you can determine what installation parameters were used.

  • Page 113: Driver Startup

    Event Log\debugger. Global Variables If you plan to compile your application for use with the Dialogic® Brooktrout® Bfv API library, do not use local variable names that match any of the names of the global variables defined by the Bfv API library.

  • Page 114: Process Priority

    Special Considerations Process Priority The Bfv API automatically raises the priority of any process that calls BfvLineAttach to HIGH_PRIORITY_CLASS. Dialogic recommends using this priority to keep delays to application processes performing fax or speech functions to a minimum. Priority raising occurs the first time the application calls BfvLineAttach only, and is controlled by the global variable _mill_priority, which contains the new priority for the process.
  • Page 115 Special Considerations History Size 1024000 Num physical histories Num app histories Restrict phys channels (1 or 0) Number of I2O frames Flow control interval Memory alloc minimum Memory alloc quanta Reserved Test parameter 1 Test parameter 2 Test parameter 3 Reserved module info module id, module number 0 to terminate...
  • Page 116 Special Considerations not to start at boot 0 no memory adjustments 0 not reboot 0 Enter the following at the command line: install -c p 0 -1 16 32768 10240 0 1 1 1 1024000 0 0 1 0 0 0 0 0 0 0 0 0 y n 1 0 0 0 For more information, see Windows Operating System on page...

  • Page 117: Driver File Locations (Install)

    Special Considerations Driver File Locations (install) When using install to configure the device driver, you do not need all files from the distribution. However, the file locations used by the configuration procedure relative to the directory where install is run must be the same as that in the normal distribution.

  • Page 118: Reviewing Compiler And Linker Options

    Using these options, the compiler and linker produce object files and executables compatible with the Bfv API library. Dialogic strongly recommends that you use these options for all your Bfv API applications. But for those who want to change the set of options the compiler and linker use, the following is a list of the nonstandard options and their functions.

  • Page 119: Chapter 6 – Configuring Software

    6 - Configuring Software This chapter describes how one can configure the Dialogic® Brooktrout® Fax Software for your Dialogic® Brooktrout® boards. Dialogic has created ways to configure the Dialogic® Brooktrout® software including: Using the Dialogic® Brooktrout® Configuration Tool on Windows Systems on page 121 Running the Dialogic®...
  • Page 120 For more information, see: Volume 6, Appendix A in the Dialogic® Brooktrout® Bfv API Reference Manual The Bfv API Function Locator in the Dialogic® Brooktrout® Bfv API Reference Manual March 2013...

  • Page 121: Using The Dialogic® Brooktrout® Configuration Tool On Windows Systems

    Using the Dialogic® Brooktrout® Configuration Tool on Windows Systems Using the Dialogic® Brooktrout® Configuration Tool on Windows Systems When you use one of the Windows operating systems, you can configure your module with the Dialogic® Brooktrout® Configuration Tool for Windows (configtool.exe).
  • Page 122 Using the Dialogic® Brooktrout® Configuration Tool on Windows Systems Requires that you have some knowledge of computer telephony, Advanced Mode communications protocols, and Computer Telephony. The Brooktrout Configuration Tool automatically selects Advanced Mode when there are different types of modules installed or when you...
  • Page 123 Using the Dialogic® Brooktrout® Configuration Tool on Windows Systems Reads configuration files from the location specified at installation Silent Mode (usually C:\Brooktrout\Boston\config), starts the device driver (if necessary). The graphical user interface is not displayed. The Brooktrout Configuration Tool creates a log file (configuration.log) that contains all the actions that it executed and...

  • Page 124: Running The Dialogic® Brooktrout® Configuration Tool

    Enable the debug flag, which initiates writing of the debug information to the configuration.log file. /e (expert) Show all hidden parameters. Use this mode only under the guidance of Dialogic Technical Services and Support personnel. See Getting Technical Support on page /i <INF file location>...
  • Page 125 Running the Dialogic® Brooktrout® Configuration Tool /f <cfgfile> Specify the name and location of the user-defined configuration file <cfgfile> while launching the Brooktrout Configuration Tool. For example: /f C:\Brooktrout\Boston\custom\btcall.cfg Show the Brooktrout Configuration Tool - Preferences dialog Do not display the Brooktrout Configuration Tool - Preferences dialog box.

  • Page 126: Choosing The File Location

    Running the Dialogic® Brooktrout® Configuration Tool Choosing the File Location When you start the Brooktrout Configuration Tool for the first time, you can choose the locations for various files using the Brooktrout Configuration Tool - Preferences dialog box. You might want to set these file locations before you start the Note: Brooktrout Configuration Tool.

  • Page 127: Example Of Settings.cfg File

    Running the Dialogic® Brooktrout® Configuration Tool 2. Launch the Brooktrout Configuration Tool with the /q command line option: C:\Brooktrout\Boston\utils\winnt\bin\configtool.exe /q After launching the Brooktrout Configuration Tool for the first time, you can access the Preferences dialog box only through Advanced...
  • Page 128 Brktcctrace (server) application, and Dialog Box your end user application (client). See the Debugging chapter in your Dialogic® Brooktrout® Fax Products SDK Developer Guide for details about the Brktcctrace application. Server Port: Specifies the server port number.

  • Page 129: Getting Help From The Dialogic® Brooktrout® Configuration Tool

    Running the Dialogic® Brooktrout® Configuration Tool Getting Help From the Dialogic® Brooktrout® Configuration Tool The Brooktrout Configuration Tool provides context sensitive online help for parameters. The Help displays the purpose and description of the parameter including the default value and range, if applicable.
  • Page 130 Running the Dialogic® Brooktrout® Configuration Tool Right-click the parameter drop-down box to get a more complete definition for Brooktrout Configuration Tool parameters. The What’s This? popup menu appears: Left-click the What’s This? popup menu for a definition like the following. You can resize this text box, if necessary.

  • Page 131: Identifying The Model Of The Board

    Running the Dialogic® Brooktrout® Configuration Tool Identifying the Model of the Board When you launch the Brooktrout Configuration Tool and it is unable to automatically identify the board: 1. The Brooktrout Configuration Tool displays a dialog box similar to the following.

  • Page 132: Resolving The Configtool Error Message

    Running the Dialogic® Brooktrout® Configuration Tool Resolving the Configtool Error Message When you launch the Brooktrout Configuration Tool and the tool displays the Configtool Error screen, use the following instructions to eliminate this licensing conflict. This error message displays when you have licenses from other vendors installed in a generic location and not in a vendor specific location.
  • Page 133 Running the Dialogic® Brooktrout® Configuration Tool To resolve this conflict and eliminate the Brooktrout Configuration Tool error message screen: 1. On the Desktop, right-click on My Computer 2. Select: → → Properties Advanced Environment Variables 3. Click New and create an environment variable <VENDOR_NAME>_LICENSE_FILE, replacing <VENDOR_NAME>...

  • Page 134: Configuring In Wizard Mode

    Configuring in Wizard Mode This section describes how to use the Wizard Mode to configure Dialogic® Brooktrout® Fax Software. You can use Wizard Mode to get most typical systems up and running with minimal effort. In Wizard Mode, after you answer the basic questions, the Brooktrout Configuration Tool does the following.

  • Page 135: Advanced Mode

    Advanced Mode Advanced Mode If you have different types of Dialogic® Brooktrout® modules in your system or you want to configure your identical modules differently, you must use Advanced Mode: When the Dialogic® Brooktrout® Configuration Tool detects that you have different modules, it starts in Advanced Mode.

  • Page 136: Offline Mode

    Offline Mode Offline Mode With Offline Mode you can: Create or edit configuration files such as btcall.cfg and callctrl.cfg. Edit the device driver parameters. Add or remove, modules (boards). Offline Mode allows you to create/edit configuration files when no boards are installed. To specify Offline Mode, use command line option /o, for example: C:\Brooktrout\Boston\utils\winnt\bin\configtool.exe /o When you enter Offline Mode, the Brooktrout Configuration Tool -...

  • Page 137: Adding A Module

    Offline Mode Adding a Module Use the right mouse button to add and remove modules. 1. Right-click on Call Control Parameters to add a module. The following right panel information appears when no modules are installed. 2. The Add Module dialog box appears. Select the Module Number and Board Type, then click OK.
  • Page 138 Offline Mode 3. Enter the correct Number of Channels when a SR140 module type is selected, then click OK: 4. Click the General Information tab to see the added information. This example shows information for a SR140 module: Note: For SR140 modules, you can edit the Number of Channels parameter entry of the call control configuration file.

  • Page 139: Removing A Module

    Offline Mode Removing a Module Right-click on a module name to remove it from the configuration. In the left panel, select the Remove Module option to remove the module from the configuration. March 2013...

  • Page 140: Sr140 Modules In Offline Mode

    Offline Mode SR140 Modules in Offline Mode When a SR140 module is detected in Offline Mode, the feature information is unavailable. The following information is displayed in the General Information General Information Tab panel for SR140 modules: for SR140 The Parameters tab displays the editable parameters for the SR140 Parameters Tab module.

  • Page 141: Silent Mode

    Reads the configuration file Boston device driver starts, if stopped Validates data Writes information to the configuration file Boston Host Service starts See Volume 6 in the Dialogic® Brooktrout® Bfv API Reference Manual for information about the configuration files. March 2013...

  • Page 142: Using A Call Control Configuration File

    The callctrl.cfg file replaces the teleph.cfg and ecc.cfg files previously used to define the call control configuration. If you want to configure call control on your Dialogic® Brooktrout® boards, you can create a callctrl.cfg file on all supported operating systems (Linux, Solaris, and Windows).

  • Page 143: Call Control (Callctrl.cfg) File Examples

    Ethernet interface parameters where you can configure modules with multiple interfaces. Call Control (callctrl.cfg) File Examples See Volume 6, Appendix A, in the Dialogic® Brooktrout® Bfv API Reference Manual for configuration file (callctrl.cfg) examples, including (but not limited to) the following port-specific...

  • Page 144: Chapter 7 – Directory Structure

    Some facilities might not be used with your Brooktrout SDK. For information on how to compile sample applications using Windows Developer Studio Project files, Dialogic® Brooktrout® files, and makefiles, refer to the Dialogic® Brooktrout® Fax Products SDK Developer Guide. March 2013...

  • Page 145: Installed Files Directory Structures

    Bfv API library header files bfv.api/misc High-level sample files bfv.api/samples Low-level sample files bfv.api/utils/fonts Font files Runtime executable, libraries, IP call control and Dialogic® Brooktrout® License Manager. bin/x64 64-bit libraries and Dialogic Brooktrout x64 components installation package March 2013...
  • Page 146 Installed Files Directory Structures Table 1. Platform-Independent Files (Continued) Directory Contents bsmi.api Sub-directory for BOSTON Simple Message Interface files bsmi.api/bapp.src BSMI sample source files bsmi.api/inc BSMI library header files including country-specific R2 CAS protocol files config Sub-directory for call control configuration files and protocol variants config/samples.cfg Sample configuration files...
  • Page 147 Installed Files Directory Structures Table 2. Linux-Specific Files Directory Contents bfv.api/linux Sub-directory for Linux-specific compilation areas and utilities for Bfv API bfv.api/linux/app.src Makefile and configuration files for sample applications bfv.api/linux/bapp.src Makefile, configuration files, and compiled executables for BOSTON-specific sample applications Bfv API binary files for Enterprise Linux ES/AS 4.0 bfv.api/linux/bin/3.4 bfv.api/linux/bin/7...
  • Page 148 Installed Files Directory Structures Table 2. Linux-Specific Files (Continued) Directory Contents bsmi.api/linux/lib/7 Compiled library files for BSMI for Enterprise Linux ES/AS 3.0 and earlier bsmi.api/linux/lib/4.1 Compiled 32-bit library files for BSMI for Enterprise Linux 5.0 bsmi.api/linux/lib/4.1/64 Compiled 64-bit library files for BSMI for Enterprise Linux 5.0 bsmi.api/linux/lib/4.4 Compiled 32-bit library files for BSMI for Enterprise...
  • Page 149 Installed Files Directory Structures Table 3. Solaris-Specific Files Directory Contents bfv.api/solaris Sub-directory for Solaris-specific compilation areas, and utilities for Bfv API bfv.api/solaris/app.src Makefile and configuration files bfv.api/solaris/bapp.src Makefile, configuration files, and compiled executables for BOSTON-specific sample applications bfv.api/solaris/bin Bfv API binary files bfv.api/solaris/lib/32 Compiled 32-bit Bfv API libraries for 32-bit systems bfv.api/solaris/lib/64...
  • Page 150 Installed Files Directory Structures Table 3. Solaris-Specific Files (Continued) Directory Contents Solaris SPARC Systems Compiled 64-bit library files for Solaris SPARC V9 usr/lib/sparcv9 operating systems Table 4. Windows-Specific Files Directory Contents Sub-directory for Windows-specific compilation bfv.api\winnt areas and utilities bfv.api\winnt\app.src Makefile, configuration files, and sample application files bfv.api\winnt\bapp.src...
  • Page 151 32-bit system: 32-bit version of the libraries %SYSTEMROOT%\syswow64\ 64-bit system only: 32-bit version of the libraries Runtime executable, libraries, IP call control and Dialogic® Brooktrout® License Manager. bin/x64 64-bit libraries and Dialogic Brooktrout x64 components installation package. Note: %SYSTEMROOT% is usually C:\winnt or C:\windows. March 2013...
  • Page 152 Dialogic. Use the Dialogic® Brooktrout® TECUpdate utility to record the serial number of your board before you contact Dialogic to order the license file. When you receive an email with your updated license file, you can again use the TECUpdate utility to download the license file and expand the functionality of your board.

  • Page 153: Starting Dialogic® Brooktrout® Tecupdate

    Starting Dialogic® Brooktrout® TECUpdate The Dialogic® Brooktrout® TECUpdate utility is installed as a separate software package. For more information: See the chapter on packaging your application in the Dialogic® Brooktrout® Fax Products SDK Developer Guide. Contact your authorized Dialogic reseller or application partner.
  • Page 154 Starting Dialogic® Brooktrout® TECUpdate Following a successful start, the Brooktrout TECUpdate window appears. See Running the Dialogic® Brooktrout® TECUpdate Utility on page 156 for specific steps to obtain module information. March 2013...

  • Page 155: When Errors Occur

    If an error occurs, it is recorded in the error log file (see Error Logging on page 158). Contact Dialogic Technical Services and Support with the error log information if you cannot resolve the problem. If there are firmware or driver errors, the following Error...

  • Page 156: Running The Dialogic® Brooktrout® Tecupdate Utility

    1. Click on a specific module to display its information: The left panel contains the tree for Dialogic® Brooktrout® hardware. All modules installed in your system are shown. The lower left panel contains the TECUpdate Version and Driver Version information.
  • Page 157 Running the Dialogic® Brooktrout® TECUpdate Utility 2. Click Update License to load the license file updates. The Update Module dialog appears: 3. Click Browse to locate the license file (*.lic), then click Update to begin the updating process. 4. Click Yes to begin the download of the license file.

  • Page 158: Error Logging

    TECUpdate version Driver version Diagnostic information Provide the log file to Dialogic Technical Services and Support for more information on solving this error. The ASCII text file is called TECUpdate.log and is stored in the current application working directory. Subsequent errors are appended to this log file.

  • Page 159: Chapter 9 – Downloading Firmware

    9 - Downloading Firmware This chapter describes how one can download the firmware to the board. The chapter includes the following: Introduction on page 160 Firmware Files on page 161 Updating Boot ROM Flash on page 162 Manually Downloading the Firmware on page 163 March 2013...

  • Page 160: Introduction

    For Linux and Solaris operating systems, the procedures for downloading firmware are described here. If your operating system is Windows, you can use the Dialogic® Brooktrout® Configuration Tool to download the firmware and configure the call control parameters.

  • Page 161: Firmware Files

    Firmware Files Firmware Files Table 5 lists the firmware files. See the Dialogic® Brooktrout® Release Notes that came with your software CD for further information. Table 5. Firmware and Flash Update Files File bostvb.dll Firmware for the SR140 virtual module cp.bin...

  • Page 162: Updating Boot Rom Flash

    Boot ROM Flash firmware only when told to do so by a Dialogic Technical Services and Support Representative. The Dialogic® Brooktrout® driver must be running when you update the boot ROM flash. Use the following procedure to update your Boot ROM Flash firmware.

  • Page 163: Manually Downloading The Firmware

    .api/<platform>/bapp.src directory. The firmload program loads the control processor and DSP firmware on all Dialogic® Brooktrout® modules found in the system. The -c option for the firm and firmload commands or the config_spec_value field of BfvFirmwareDownload sets the actual number of channels supported on the module.
  • Page 164 Proper operation is indicated by the module status LED slowly flashing green. See the descriptions of these programs in the Dialogic® Brooktrout® Fax Products SDK Developer Guide chapter about sample applications and utilities.
  • Page 165 Manually Downloading the Firmware For the following situations, restart the driver whenever you want to: 1. Get a continuous assignment of channel numbers after decreasing the channel count on any module. 2. Increase the number of channels above a module’s initial channel count.

  • Page 166: Compliance Information

    Appendix A Compliance Information This appendix describes how the Dialogic® Brooktrout® boards conform to compliance standards. It has the following sections: Electromagnetic Compatibility Statements on page 167 Telecommunications Compliance Statements on page 172 Safety Compliance Statements on page 179 Note to developers and system integrators: The following compliance information and statements must be provided to your customer or end user as part of your system documentation.

  • Page 167: Electromagnetic Compatibility Statements

    Additionally, all computing devices utilizing clock frequencies in excess of 10 kHz must be tested for compliance with RF emission limits set by the FCC and IC. The Dialogic® Brooktrout® board is such a device and must comply with the Class A or Class B regulations as specified below.

  • Page 168: United States Of America

    Electromagnetic Compatibility Statements United States of America Mandatory Statements Changes or modifications to this unit not expressly approved by the party responsible for compliance could void the user’s authority to operate the equipment. You must also add the following paragraph if shielded cables were used when testing your product: In order to maintain compliance with FCC limits, shielded cables must be used with this equipment.

  • Page 169: Class B Statements (For "Class B" Products)

    Electromagnetic Compatibility Statements Class B Statements (for “Class B” products) NOTE: This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to Part 15 of the FCC rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation.

  • Page 170: Canada

    Electromagnetic Compatibility Statements Canada Class A Statements (for “Class A” products) This Class A digital apparatus complies with Canadian ICES-003. Cet appareil numérique de la class A est conforme à la norme NMB-003 du Canada. Class B Statements (for “Class B” products) This Class B digital apparatus complies with Canadian ICES-003.

  • Page 171: Japan

    Electromagnetic Compatibility Statements Japan VCCI Class Statements Class A ITE Class A Statement (For Class A Products). Translation: This is a Class A product based on the standard of the Voluntary Control Council for Interference by Information Technology Equipment (VCCI). If this equipment is used in a domestic environment, radio disturbance may occur, in which case, the user may be required to take corrective actions.

  • Page 172: Telecommunications Compliance Statements

    Telecommunications Compliance Statements Telecommunications Compliance Statements The following customer information must be provided to customers with each unit of approved terminal equipment. The statements provided below should be conspicuously located in the end user system documentation: United States of America Equipment Approved After July 23, 2001 This equipment complies with Part 68 of the FCC rules and the requirements adopted by the ACTA.

  • Page 173: Connection To Telecommunications Networks

    Telecommunications Compliance Statements Connection to Telecommunications Networks A plug and jack used to connect this equipment to the premises wiring and telephone network must comply with the applicable FCC Part 68 rules and requirements adopted by the ACTA. A compliant telephone cord and modular plug is provided with this product.
  • Page 174 You must include facilities in your application to enable the user to enter the required information. Use the BfvFaxHeader function with the Dialogic® Brooktrout® board to place this information on each transmitted page as required. You must also include, in your user manual, instructions for entering this information into your system.

  • Page 175: Fcc Regulations For Connecting To A T1 Interface

    FCC Regulations For Connecting to a T1 Interface The Federal Communications Commission (FCC) has established rules that permit a Dialogic® Brooktrout® board to be directly connected to the telephone network: Standardized jacks are used for connections. This equipment can not be used on coin service provided by the telephone company.
  • Page 176 Before connecting the Dialogic® Brooktrout® board to telephone service, you must give a representative of the local telephone company the following information: The telephone numbers (Port ID) to which the Dialogic® Brooktrout® board is connected. SOC: 6.0P HP02 6.0Y...

  • Page 177: Canada

    Telecommunications Compliance Statements Canada NOTICE: This equipment meets the applicable Industry Canada Terminal Equipment Technical Specifications. This is confirmed by the registration number. On certain products, the abbreviation, IC, before the registration number signifies that registration was performed based on a Declaration of Conformity indicating that Industry Canada technical specifications were met.

  • Page 178: Australia

    Telecommunications Compliance Statements Users should ensure for their own protection that the electrical ground connections of the power utility, telephone lines and internal metallic water pipe system, if present, are connected together. This precaution may be particularly important in rural areas. Users should not attempt to make such connections themselves, but should contact the appropriate electric inspection authority, or electrician, as appropriate.

  • Page 179: Safety Compliance Statements

    This product is listed by Underwriters Laboratories, a Nationally Recognized Test Laboratory (NRTL). The Listing Mark is located on the bottom surface of the board. The Dialogic® Brooktrout® board has been tested and complies with UL 60950 and CAN/CSA-C22.2 No. 60950, Safety of Information Technology Equipment, Including Electrical Business Equipment.
  • Page 180 Safety Compliance Statements Users should ensure for their own protection that the electrical ground connections of the power utility, telephone lines and internal metallic water pipe system, if present, are connected together. This precaution may be particularly important in rural areas. Users should not attempt to make such connections themselves, but should contact the appropriate electric inspection authority, or electrician, as appropriate.

  • Page 181: Installation Program

    Appendix B Configuration from a Custom Installation Program This appendix describes how one can create a custom installation program for manual configuration of the driver. You can find installation structure and functions for the following operating systems: Linux Operating System on page 182 Solaris Operating System on page 186 Windows Operating System on page 190 March 2013...

  • Page 182: Linux Operating System

    Linux Operating System Linux Operating System You can perform configuration from a custom installation program by writing a program that runs dinstall with the -c option, or by writing a Bourne shell script that calls the provided installation functions described below. Only write custom installation programs using one of these two mechanisms.

  • Page 183: Checking The Installation

    Linux Operating System Number of physical histories. num_hists_phy Number of application histories. num_hists_apl Whether to restrict physical histories to admin channels hist_phy_admin_only only. Number of I2O frames per module. num_I2O_frames_per_module Driver flow control interval, in ms. fc_interval Min memory allocated per allocation. mem_drv_alloc_min Unit of allocation increment above min.

  • Page 184: Defining Default Symbols

    Linux Operating System Defining Default Symbols _mill_driver_defaults Defines the symbols that provide defaults for use with getting parameter values. Default starting reserved module DEFAULT_MOD_NUM number. Default application buffer size. DEFAULTAPPBUFSIZE Default ISA interrupt line. Reserved, Reserved no longer in use. Default machine ID.

  • Page 185: Removing The Driver

    Linux Operating System Removing the Driver _mill_driver_remove Input Argument (Optional) The function only performs a partial partial removal. Also used for removal prior to reinstallation . Output Variable Contains displayable error message. err_msg Note: If echo is used to display the contents, it might require the -e option to properly display some of the messages.

  • Page 186: Solaris Operating System

    Solaris Operating System Solaris Operating System You can perform configuration from a custom installation program by writing a program that runs dinstall with the -c option, or by writing a Bourne shell script that calls the provided installation functions described below. Only write custom installation programs using one of these two mechanisms.
  • Page 187 Solaris Operating System Number of physical histories. num_hists_phy Number of application histories. num_hists_apl Whether to restrict physical histories to admin channels only. hist_phy_admin_only num_I2O_frames_per_module Number of I2O frames per module. Driver flow control interval, in ms. fc_interval Min memory allocated per allocation. mem_drv_alloc_min Unit of allocation increment above min.

  • Page 188: Checking The Installation

    Solaris Operating System Checking the Installation _mill_driver_install_check 0 = not installed Exit Code non-0 = installed Defining Default Symbols _mill_driver_defaults Defines the symbols that provide defaults for use with variable values. Default starting reserved module number. DEFAULT_MOD_NUM Default application buffer size. DEFAULTAPPBUFSIZE Default ISA interrupt line.

  • Page 189: Removing The Driver

    Solaris Operating System Removing the Driver _mill_driver_remove Input Argument partial (Optional) The function only performs a partial removal. Also used for removal prior to reinstallation. Output Variable err_msg Contains displayable error message. This variable is not modified except to set to 1 or error message. 0 = success Exit Code 1 = error...

  • Page 190: Chapter 5 – Installing The Device Driver On Windows

    You can perform configuration from a custom installation program by writing a program that runs install with the -c option, or by writing a program that calls the Dialogic-provided installation functions, described below, that can be compiled and linked into the program.

  • Page 191: Installing The Windows Driver

    Windows Operating System Installing the Windows Driver Use the following function to install the Windows PnP driver: int _mill_pnp_driver_install( struct driver_parameters *drv_parm, do_adjustments, already_option, meg_in_system, *mem_adjust_stat, char *inf_file, load_uncond, *reboot_required, char **failed_win32_call, DWORD *win32_err_val, char **other_msg Input Variables Action to take if already adjusted. already_option Application buffer size.
  • Page 192 Windows Operating System Amount of memory in system. meg_in_system Pointer to int variable to contain result of memory mem_adjust_stat adjustment attempt 0 = Memory adjustment not performed 1 = Memory adjustment performed 2 = Previous adjustment detected, action dependent on already_option Min memory allocated per allocation.

  • Page 193: Driver Parameters Structure

    Windows Operating System Driver Parameters Structure Use the driver_parameters structure to install the PnP driver (see Installing the Windows Driver on page 191). For input variable definitions, see Input Variables on page 191. struct driver_parameters reserved; reserved; unsigned reserved; unsigned reserved; unsigned max_pci_hw_modules;...

  • Page 194: Checking The Installation

    Windows Operating System Checking the Installation Verifies that the driver is installed. int _mill_pnp_driver_install_check(void); 0 = not installed Return Value 1 = installed Defining Default Symbols The instlib.h file defines the following symbols that provide defaults for use with getting parameter values. You can find the instlib.h file at the following location: C:\Brooktrout\Boston\driver\winnt\install\ Default starting reserved module number.

  • Page 195: Removing The Driver

    Windows Operating System Minimum allocation of memory. MEM_DRV_ALLOC_MIN Number of allocation of memory. MEM_DRV_ALLOC_QUANTA Minimum number of FC intervals. MIN_FC_INTERVAL Minimum application buffer size. MINAPPBUFSIZE Minimum allowable machine ID. MINMACHINEID Minimum physical buffer size. MINPHYBUFSIZE Default number of application histories. NUM_HISTS_APL_DEF Default number of physical histories.

  • Page 196: Appendix C – Reinitializing The Device Driver

    Appendix C Reinitializing the Device Driver This appendix describes the driver reinitialization utility. This utility is used to return the device driver to a state as close as possible to that of a fresh driver start without stopping the driver. March 2013...

  • Page 197: Introducing The Driver Reinitialization Utility

    Introducing the Driver Reinitialization Utility Introducing the Driver Reinitialization Utility The driver can be reinitialized close to its starting state in terms of channels assigned to modules and module number assignments using the driver_reinit program located in the boston/driver/<platform>/user directory. Use of this program may avoid the need to stop and restart the driver.

  • Page 198: Glossary

    The term lapdid has its origins with the LAP-D protocol used for lapdid call control, but has an extended meaning for Dialogic products. For call control with the ISDN protocol (Q.931), lapdid refers to a trunk-specific HDLC controller (trunk 1 = lapdid 0, trunk 2 = lapdid 2, trunk 3 = lapdid 4 and trunk 4 = lapdid 6).
  • Page 199 APIs without requiring direct use of these addresses. A communicating Boston entity that usually represents a CPU on a Module Dialogic® Brooktrout® board, a host application, a software telephony module (SR140) or the driver. See Determining the Board Module Number on page 26 for more information about modules and module number assignment.
  • Page 200 1. In telephony configuration files and functions, a unit is a Unit number hardware port on a Dialogic® Brooktrout® board and is numbered starting at 0 (to denote a TDM bus); from 1 to n (for a specific T1/E1 interface).

  • Page 201: Index

    Index module ID Symbols status LED Boston Host Service .bin file command line .cfg file installing .exe file 118, Red Hat Linux .inf file 92, 108, troubleshooting .log file 142, Unix login 45, .pnf file 101, Windows BOSTSRV see Boston Host Service Bourne shell script 183, Add/Remove Hardware Wizard Brooktrout board...
  • Page 202 configuring boards Configtool Error callctrl.cfg file configtool.exe file edit Configuration files examples creating 123, troubleshooting editing using reading Channel Configuration Tool actual number supported /a option definition /c option ordinal channel numbers /d option Channel density, upgrading /e option Channel Service Unit (CSU) /f option Class A products /i option...
  • Page 203 Creating Solaris file locations 71, configuration files starting Configuration Tool configuration files starting and stopping, Linux CSU (channel service unit) starting and stopping, Solaris Custom installation starting Windows Linux uninstalling current version of PnP Solaris uninstalling Linux Windows uninstalling previous versions Custom setup, software uninstalling Solaris uninstalling Windows...
  • Page 204 choosing file locations InstallShield cp.bin file completed downloading instlib.obj file downloading (Windows) Interrupted Windows installation files 147, Found New Hardware Wizard Kernel patches for Linux recompiling for new patches Global variables (Windows) Kernel version numbers, Linux Grouping parameters, Advanced Mode Library files Help Linux-specific...
  • Page 205 writing multithreaded programs pkgadd installation program, Solaris Logical channel number definition Plug-and-Play updating driver Windows systems pnplib.obj file Port definition Memory allocation error on Solaris Preferences dialog box modinfo program not showing Module Preferences dialog box, Configuration Tool definition Process priority on Windows selecting number Product identifier, compliance Multithreaded programs...
  • Page 206 voice 31, API source version settings.cfg file error logging settings.cfg file example history logging 42, 63, Shielded cables TECUpdate error log Silent Mode Technology Expansion Capability, see TECUpdate command line option utility configuraiton.log file TECUpdate utility Configuration Tool error logs SR140 module running Software license key...
  • Page 207 Warning and error messages Linux Solaris Windows Autorun program Bfv API libraries and makefiles compiler options driver startup install completed install software installation parameters installing driver manually installing SDK InstallShield installation program limits on open files linker options modifying the software non-Plug and Play file locations PCI considerations uninstalling driver...

This manual is also suitable for:

Brooktrout tr1034 t1Brooktrout tr1034 e1Brooktrout tr1034 ipBrooktrout trufaxBrooktrout tr1034 analog loop startBrooktrout tr1034 bri ... Show all

Table of Contents