summaryrefslogtreecommitdiff
path: root/README
blob: 764e76edc9d42e819f2afd21990f928bb6252aab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
Zapata Telephony Interface Driver

Note:
See
http://www.voip-info.org/tiki-index.php?page=Asterisk%20Zaptel%20Installation
for more verbose and updated version of this document.

Requirements:
	Some of the testing programs still require the zapata library
	The zttool program requires libnewt

To install:
	check zconfig.h for any specific configuration changes
	make
	make install

Here is a list of what module to use with what hardware

Module Name	Hardware
===========     ========
pciradio        PCI Radio Card Zaptel

tor2		T400P - Quad Span T1 Card
		E400P - Quad Span E1 Card

torisa		Old Tormenta1 ISA Card

wct4xxp		TE405P - Quad Span T1/E1 Card (5v version)
		TE410P - Quad Span T1/E1 Card (3.3v version)

wct1xxp		T100P - Single Span T1 Card
		E100P - Single Span E1 Card

wcte11xp	TE110P - Single Span T1/E1 Card

wcfxo		X100P - Single port FXO interface
		X101P - Single port FXO interface 

wctdm   	TDM400P - Modular FXS/FXO interface (1-4 ports)

wctdm24xxp      TDM800P -  Modular FXS/FXO interface (up to 8 ports)
                TDM2400P - Modular FXS/FXO interface (up to 24 ports)

wcusb   	S100U - Single port FXS USB Interface

xpp             the Astribank USB channel bank

ztd-eth         TDM-over-ethernet

ztd-loc         Dynamic local spans

ztdummy		Zaptel Timing Only Interface


The module "zaptel" is required by all others. "ztdynamic" is required by 
ztd-eth and by ztd-loc.

Helper Utilities
================
This directory includes many helper utilities. Some of them are more 
useful for debugging. The more useful ones of them:

ztcfg       Configure zaptel spans / channels.
zttool      Watch and monitor zaptel spans (also: cat /proc/zaptel/* ).
ztmonitor   Monitor (visually or to the speaker) or record a zaptel channel.
zttest      Test the zaptel timing source.
fxotune     Tune some characteristics of the FXO chip to reduce generated echo.
torisatool  A tool to configure the old torisa cards. Others don't need it.


What is the license for the zaptel driver?
===================================================
libpri is distributed under the terms of the GNU General Public License, 
which permit its use and linking with other GPL'd software only.  
The GNU GPL is included in the file LICENSE in this directory.

If you wish to use the zaptel drivers in an application for which the 
GPL is not appropriate (e.g. a proprietary embedded system), licenses
under more flexible terms can be readily obtained through Digium, Inc. 
at reasonable cost.


Brief F.A.Q
===========

Q. Zaptel compiled with no errors but when I try to modprobe zaptel I
receive "FATAL: Error insering zaptel (/lib/modules/2.6.x.x/misc/zaptel.ko):
Unknown symol in module or unknown parameter (see dmesg)

A. You need to recompile your kernel with CONFIG_CRC_CCITT=y or
CONFIG_CRC_CCITT=m. To do this, run 'make menuconfig' and change it under 
'Library Routines -> CRC-CCIT functions'. If you compiled it as a module,
load it, otherwise reboot.

Q. Do I need to set up the symbolic link /usr/src/linux ?
A. That depends.

* On Debian Sarge: apt-get install kernel-headers-`uname -r`
* On Ubuntu and newer Debian: apt-get install linux-headers-`uname -r`
* On Redhat, Fedora, Centos: install the package  'kernel-devel' or 
  'kernel-smp-devel' (depending on your kernel versions).
* If you have just installed a kernel.org kernel from source, chances
  are also that things will Just Work[tm].

This is because the build process checks for /lib/modules/`uname -r`/build
before /usr/src/linux . This linux will also be valid if you installed a 
non-ancient kernel from source, and haven't reconfigured the source tree.

How do I report bugs or contribute?
===================================
Please report bug and patches to the Asterisk.org bug tracker at
http://bugs.digium.com in the "zaptel" category.

Does anything use this library so far?
======================================
Yes, the Asterisk Open Source PBX does. http://www.asterisk.org