README
Created 23/8/99
Voicetronix Voice Processing Board (VPB) Driver Software
www.voicetronix.com

Copyright (C) 1999-2003 Voicetronix www.voicetronix.com

LICENSE
-------

This software is a mixture of LGPL and non-LGPL software, see COPYING for 
details.

NOTES
-----

1) This file describes installation of the Linux version of the driver:
   - Please see Readme.win32.txt for installing under Windows.
   - Pleasee see README.FreeBSD for installing under FreeBSD.

2) There is API documentation in html format in the doc/vpb-doc directory.
   The index is doc/vpb-doc/vpb-doc.html.  Also included is information on 
   tone detection, and the use of the automated tone trainer utility.

3) If you encounter compile problems please see FAQ.

4) For several steps below you will need to be logged in as root.

5) If installing an OpenSwitch card, please see README.OpenSwitch12

QUICKSTART
----------

1) edit src/vpbreg.cpp "STATICS" section:

a) If your card is an OpenLine4 (V4PCI):
static char *vpb_firmware_file = FIRMWARE_FILE_PCI;
static int vpb_model = VPB_V4PCI;

b) If your card is an OpenLine4i (VPB4):
static char *vpb_firmware_file = FIRMWARE_FILE_ISA;
static int vpb_model = VPB_VPB4;

c) If your card is an OpenLog8i (VPB8L):
static char *vpb_firmware_file = FIRMWARE_FILE_ISA_VPB8L;
static int vpb_model = VPB_VPB8L;

d) If your card is an OpenLog4 (V4LOG):
static char *vpb_firmware_file = FIRMWARE_FILE_PCI;
static int vpb_model = VPB_V4LOG;

Note: For ISA cards, also set default I/O base address #define BASE_ADDRESS.

Linux:
------

1) Check /usr/src there should either be a directory 'Linux' or a
   symbolic link of the same name. If not create a symbolic link to 
   your current version of linux ie. linux -> linux-2.4:

2) make

3) make install

4) Insert the module by using the command 'insmod vpb'

5) If you dont see anything printed out after 'insmod vpb', type 'dmesg',
and look for the 'major number'.

6) 'mknod /dev/vpb0 c 254 0' - note this example assumes the major number was 
254.

7) chmod a+w /dev/vpb0 (allows all users to use vpb-driver)

8) cd to unittest, 'make' to build unittest programs

9) try ./echo (OpenLine4) - see echo.cpp for instructions
   try ./tvpb8l (Openlog8i) - see tvpb8l.cpp 
   try ./tv4log (OpenLog4) - see tv4log.cpp

FreeBSD:
--------

See README.FreeBSD

ALTERNATE WAY TO CONFIGURE DRIVER FOR DIFFERENT CARDS
-----------------------------------------------------

Environment variables can also be used to configure the driver for different
cards, as an alternative to compile-time mods to vpbreg.cpp.  All of the
environment variables are optional, if you specify none the compile time 
defaults will be used.  If you just specify one, defaults will be used for
the other parameters.

VPB_MODEL    [VPB4 | VPB8L | V4PCI | V4LOG]
VPB_FIRMWARE [e.g. /etc/vpb/vpbmain_pci.out]
VPB_BASE     [hex base address for ISA cards only, e.g. 0x310]
VPB_TONE     [see below]

e.g. (bash shell) place the following in your ~/.bash_profile:

VPB_MODEL=V4PCI
export VPB_MODEL


