./configure # optional step: select custom configuration: #make menuselect make make install # To install init scripts and config files: #make config
DAHDI stands for Digium Asterisk Hardware Device Interface. This package contains the userspace tools to configure the kernel modules included in the package dahdi-linux.
This package needs the headers from dahdi-linux. Thus you should install dahdi-linux before building dahdi-tools.
gcc and friends. Generally you will need to install the package gcc. There may be cases where you will need a specific version of gcc to build kernel modules.
Some libraries are needed for extra utilities that are provided with DAHDI.
libusb is needed for building fpga_load, needed for firmware loading of the Xorcom Astribank.
libnewt is needed to build the optional but useful utility dahdi_tool.
Note: If using sudo to build/install, you may need to add /sbin to your PATH.
./configure # optional step: select custom configuration: #make menuselect make make install # To install init scripts and config files: #make config
There are some make targets that are provided to build or install just parts of DAHDI:
Build targets:
make: Build DAHDI userspace programs. partial targets of it:
make utilname: builds utilname alone (e.g: make dahdi_diag)
make utils: Build libtonezone.
make libs: Build libtonezone.
Install targets:
make install: Installs user space tools into /usr/sbin/ (TODO - list partial targets)
make config: should be run once to configure
The following may be useful when testing the package or when preparing a package for a binary distribution (such as an rpm package) installing onto a subtree rather than on th real system.
make install DESTDIR=targetdir
This can be useful for any partial install target from the list above.
The configure script various several tests and based on them generates some files ( build_tools/menuselect-deps and makeopts). You can pass it --with options and variable settings, for instance:
./configure --without-ncurses CC="gcc-4.10"
If you just want to recreate the same files without a full detection run, use:
./config.status
To re-run ./configure with the same parameters it was run with last time, use:
./ocnfig.status --recheck
Configuration for DAHDI resides under /etc/dahdi .
The main method to configure DAHDI devices is using the utility dahdi_cfg. dahdi_cfg reads data from the configuration file /etc/dahdi/system.conf , figures out what configuration to send to channels, and send it to the kernel.
A sample annotated system.conf is included in this directory and installed by default. Edit it to suit your configuration. Alternatively use the script dahdi_genconf to generate one that should work with your system.
The configuration file of the dahdi init.d script is /etc/dahdi/init.conf . That file is used to override defaults that are set at the beginning of the init.d script.
DAHDI Configuration File
This file is parsed by the DAHDI Configurator, dahdi_cfg
First come the span definitions, in the format
span=<span num>,<timing source>,<line build out (LBO)>,<framing>,<coding>[,yellow]
All T1/E1/BRI spans generate a clock signal on their transmit side. The <timing source> parameter determines whether the clock signal from the far end of the T1/E1/BRI is used as the master source of clock timing. If it is, our own clock will synchronise to it. T1/E1/BRI connected directly or indirectly to a PSTN provider (telco) should generally be the first choice to sync to. The PSTN will never be a slave to you. You must be a slave to it.
Choose 1 to make the equipment at the far end of the E1/T1/BRI link the preferred source of the master clock. Choose 2 to make it the second choice for the master clock, if the first choice port fails (the far end dies, a cable breaks, or whatever). Choose 3 to make a port the third choice, and so on. If you have, say, 2 ports connected to the PSTN, mark those as 1 and 2. The number used for each port should be different.
If you choose 0, the port will never be used as a source of timing. This is appropriate when you know the far end should always be a slave to you. If the port is connected to a channel bank, for example, you should always be its master. Likewise, BRI TE ports should always be configured as a slave. Any number of ports can be marked as 0.
Incorrect timing sync may cause clicks/noise in the audio, poor quality or failed faxes, unreliable modem operation, and is a general all round bad thing.
The line build-out (or LBO) is an integer, from the following table:
0: 0 db (CSU) / 0-133 feet (DSX-1) 1: 133-266 feet (DSX-1) 2: 266-399 feet (DSX-1) 3: 399-533 feet (DSX-1) 4: 533-655 feet (DSX-1) 5: -7.5db (CSU) 6: -15db (CSU) 7: -22.5db (CSU)
If the span is a BRI port the line build-out is not used and should be set to 0.
one of d4 or esf for T1 or cas or ccs for E1. Use ccs for BRI. d4 could be referred to as sf or superframe
one of ami or b8zs for T1 or ami or hdb3 for E1. Use ami for BRI.
For E1 there is the optional keyword crc4 to enable CRC4 checking.
If the keyword yellow follows, yellow alarm is transmitted when no channels are open.
#span=1,0,0,esf,b8zs #span=2,1,0,esf,b8zs #span=3,0,0,ccs,hdb3,crc4
Next come the dynamic span definitions, in the form:
dynamic=<driver>,<address>,<numchans>,<timing>
Where <driver> is the name of the driver (e.g. eth), <address> is the driver specific address (like a MAC for eth), <numchans> is the number of channels, and <timing> is a timing priority, like for a normal span. use "0" to not use this as a timing source, or prioritize them as primary, secondard, etc. Note that you MUST have a REAL DAHDI device if you are not using external timing.
dynamic=eth,eth0/00:02:b3:35:43:9c,24,0
If a non-zero timing value is used, as above, only the last span should have the non-zero value.
Next come the definitions for using the channels. The format is: <device>=<channel list>
Valid devices are:
Channel(s) are signalled using E&M signalling (specific implementation, such as Immediate, Wink, or Feature Group D are handled by the userspace library).
Channel(s) are signalled using FXS Loopstart protocol.
Channel(s) are signalled using FXS Groundstart protocol.
Channel(s) are signalled using FXS Koolstart protocol.
Channel(s) are signalled using FXO Loopstart protocol.
Channel(s) are signalled using FXO Groundstart protocol.
Channel(s) are signalled using FXO Koolstart protocol.
Channel(s) are signalled using in-band single freq tone. Syntax as follows:
channel# => sf:<rxfreq>,<rxbw>,<rxflag>,<txfreq>,<txlevel>,<txflag>
rxfreq is rx tone freq in Hz, rxbw is rx notch (and decode) bandwith in hz (typically 10.0), rxflag is either 'normal' or 'inverted', txfreq is tx tone freq in hz, txlevel is tx tone level in dbm, txflag is either 'normal' or 'inverted'. Set rxfreq or txfreq to 0.0 if that tone is not desired.
No signalling is performed, each channel in the list remains idle
Channel(s) are bundled into a single span. No conversion or signalling is performed, and raw data is available on the master.
Like clear except all channels are treated individually and are not bundled. inclear is an alias for this.
The DAHDI driver performs HDLC encoding and decoding on the bundle, and the resulting data is communicated via the master device.
The DAHDI driver performs HDLC encoding and decoding on the bundle and also performs incoming and outgoing FCS insertion and verification. fcshdlc is an alias for this.
The hardware driver performs HDLC encoding and decoding on the bundle and also performs incoming and outgoing FCS insertion and verification. Is subject to limitations and support of underlying hardware. BRI spans serviced by the wcb4xxp driver must use hardhdlc channels for the signalling channels.
The DAHDI driver bundles the channels together into an hdlc network device, which in turn can be configured with sethdlc (available separately). In 2.6.x kernels you can also optionally pass the name for the network interface after the channel list. Syntax:
nethdlc=<channel list>[:interface name] Use original names, don't use the names which have been already registered in system e.g eth.
The DAHDI driver cross connects the channels starting at the channel number listed at the end, after a colon
The DAHDI driver cross connects the channels starting at the channel number listed at the end, after a colon and also performs the DACSing of RBS bits
The channel list is a comma-separated list of channels or ranges, for example:
1,3,5 (channels one, three, and five) 16-23, 29 (channels 16 through 23, as well as channel 29)
So, some complete examples are:
e&m=1-12
nethdlc=13-24
fxsls=25,26,27,28
fxols=29-32
An example of BRI port:
span=1,1,0,ccs,ami
bchan=1,2
hardhdlc=3
|
Note
|
When using BRI channels in asterisk, use the bri_cpe, bri_net, or bri_cpe_ptmp (for point to multipoint mode). libpri does not currently support point to multipoint when in NT mode. Otherwise, the bearer channel are configured identically to other DAHDI channels. |
#fxoks=1-24 #bchan=25-47
#dchan=48 #fxols=1-12 #fxols=13-24 #e&m=25-29 #nethdlc=30-33
#clear=44 #clear=45 #clear=46 #clear=47
#fcshdlc=48
#dacs=1-24:48
#dacsrbs=1-24:48
Finally, you can preload some tone zones, to prevent them from getting overwritten by other users (if you allow non-root users to open /dev/dahdi/* interfaces anyway. Also this means they won’t have to be loaded at runtime. The format is "loadzone=<zone>" where the zone is a two letter country code.
You may also specify a default zone with "defaultzone=<zone>" where zone is a two letter country code.
An up-to-date list of the zones can be found in the file zonedata.c
loadzone = us #loadzone = us-old
#loadzone=gr #loadzone=it #loadzone=fr #loadzone=de #loadzone=uk #loadzone=fi #loadzone=jp #loadzone=sp #loadzone=no #loadzone=hu #loadzone=lt #loadzone=pl
defaultzone=us
The PCI Radio Interface card interfaces up to 4 two-way radios (either a base/mobile radio or repeater system) to DAHDI channels. The driver may work either independent of an application, or with it, through the driver;s ioctl() interface. This file gives you access to specify load-time parameters for Radio channels, so that the driver may run by itself, and just act like a generic DAHDI radio interface.
Unlike the rest of this file, you specify a block of parameters, and then the channel(s) to which they apply. CTCSS is specified as a frequency in tenths of hertz, for example 131.8 HZ is specified as 1318. DCS for receive is specified as the code directly, for example 223. DCS for transmit is specified as D and then the code, for example D223.
The hardware supports a "community" CTCSS decoder system that has arbitrary transmit CTCSS or DCS codes associated with them, unlike traditional "community" systems that encode the same tone they decode.
this example is a single tone DCS transmit and receive
specify the transmit tone (in DCS mode this stays constant):
#tx=D371
specify the receive DCS code:
#dcsrx=223
this example is a "community" CTCSS (if you only want a single tone, then only specify 1 in the ctcss list)
specify the default transmit tone (when not receiving):
#tx=1000
Specify the receive freq, the tag (use 0 if none), and the transmit code. The tag may be used by applications to determine classification of tones. The tones are to be specified in order of presedence, most important first. Currently, 15 tones may be specified..
#ctcss=1318,1,1318 #ctcss=1862,1,1862
The following parameters may be omitted if their default value is acceptible
Set the receive debounce time in milliseconds:
#debouncetime=123
set the transmit quiet dropoff burst time in milliseconds:
#bursttime=234
set the COR level threshold (specified in tenths of millivolts) valid values are {3125,6250,9375,12500,15625,18750,21875,25000}
#corthresh=12500
Invert COR signal {y,n}
#invertcor=y
Set the external tone mode; yes, no, internal {y,n,i}
#exttone=y
Now apply the configuration to the specified channels:
We are all done with our channel parameters, so now we specify what channels they apply to
#channels=1-4
Usually the channel driver sets the encoding of the PCM for the channel (mulaw / alaw. That is: g711u or g711a). However there are some cases where you would like to override that. mulaw and alaw set different such encoding. Use them for channels you have already defined with e.g. bchan or fxoks.
#mulaw=1-4
#alaw=1-4
deflaw is similar, but resets the encoding to the channel driver’s default. It must be useful for something, I guess.
#mulaw=1-10
#deflaw=5
DAHDI uses modular echo cancellers that are configured per channel. The echo cancellers are compiled and installed as part of the dahdi-linux package. You can specify in this file the echo canceller to be used for each channel. The default behavior is for there to be NO echo canceller on any channel, so it is very important that you specify one here if you do not have hardware echo cancellers and need echo cancellation.
Valid echo cancellers are: mg2, kb1, sec2, and sec. If compiled, hpec is also a valid echo canceller.
To configure the default echo cancellers, use the format: echocanceller=<echocanceller name>,<channel(s)>
Example: Configure channels 1 through 8 to use the mg2 echo canceller
#echocanceller=mg2,1-8
And change channel 2 to use the kb1 echo canceller.
#echocanceller=kb1,2
Shell settings for Dahdi initialization scripts. This replaces the old/per-platform files (/etc/sysconfig/zaptel, /etc/defaults/zaptel)
The maximal timeout (seconds) to wait for udevd to finish generating device nodes after the modules have loaded and before running dahdi_cfg.
#DAHDI_DEV_TIMEOUT=40
Override settings for xpp_fxloader
#XPP_FIRMWARE_DIR=/usr/share/dahdi
#XPP_HOTPLUG_DISABLED=yes
FIXME: still not properly formatted.
/etc/dahdi/genconf_parameters
This file contains parameters that affect the dahdi_genconf configuration generator.
Syntax: * A comment from # to end of line * Blank lines ignored * Whitespace at end of line trimmed * Single valued items: key <whitespace…> value * List valued items: key <whitespace…>value1 <whitespace…>value2 …
When generating extensions for chan_dahdi.conf or users.conf etc: the extension number will be channel_number+base_exten . The default is:
#base_exten 4000
Make FXS (analog phones) extensions answer immediately (sets immediate = yes for them in chan_dahdi.conf). Don’t enable this before you’re read documentation about this option.
#fxs_immediate yes
For FXS (analog phones) - use KS or LS? ks is the only method for Asterisk to provide disconnect supervision and thus it would normally be preferred and is the default.
#fxs_default_start ls
For FXO (analog lines) - use KS or LS? KS is the default and is normally the better choice as it allows detecting hang-ups on many lines.
#fxo_default_start ls
Set tone zone values. This is used for playing tones (busy, dial-tone and such). The default is us. This sets the value for both loadzone and defaultzone in system.conf .
#lc_country il
The dialplan context into which to send trunks in chan_dahdi.conf or users.conf. The default value is:
#context_lines from-pstn
The dialplan context into which to send extensions in chan_dahdi.conf or users.conf. The default value is:
#context_phones from-internal
Two extra contexts for the input ports and output ports of an Astribank. Default values are:
#context_input astbank-input #context_output astbank-output
A group to put all analog phones in. By default 0, so you can dial to the first phone available using Dahdi/g5 .
#group_phones 5
A group in which to put all the channels belonging to some trunk. Thus you can dial through "some trunk" using Dahdi/G0/NUMBER
#group_lines 0
Channels of digital trunk of span N are also added to group 10+N (that is: 14 for channels of span 4).
Do we want to use PtP (bri) or PtMP (bri_ptmp) for BRI? PtMP allows connecting several CPE devices on the same network device (several BRI phones on the same line, kind of like several analog phones on the same analog line). However it is generally brings unnecessary complexity for a pbx-pbx connection. It is still the default as this is normally what you get for a BRI PSTN connection.
#bri_sig_style bri
If this option is set (that is: not remmed-out), BRI NT ports will also be set as overlap. This is useful if you want to connect ISDN phones.
#brint_overlap
The echo canceler to use. If you have a hardware echo canceler, just leave it be, as this one won’t be used anyway.
The default is mg2, but it may change in the future. E.g: a packager that bundles a better echo canceler may set it as the default, or dahdi_genconf will scan for the "best" echo canceler.
#echo_can hpec #echo_can oslec #echo_can none # to avoid echo canceler altogether
bri_hardhdlc: yes - forces BRI cards to use hardhdlc signalling. no - forces BRI cards to use dchan (an alias for fcshdlc). It is usefull only for dahdi with the bristuff patch.
If it is left out or set to auto: * Information supplied by the driver is used to decide: - Currently implemented for Astribanks. - Taken from /sys/bus/xpds/drivers/bri/dchan_hardhdlc. * Without this info, falls back to hardhdlc.
#bri_hardhdlc auto
For MFC/R2 Support: R2 will make E1 spans CAS and with the r2_idle_bits bit in system.conf . It will also make dahdi_genconf default to generating the channels of this card in unicall.conf rather than in chan_dahdi.conf . The meaning of this may be extended somehow to support R2 through openr2/chan_dahdi later on.
#pri_connection_type R2 #r2_idle_bits 1101
pri_termtype contains a list of settings: Currently the only setting is for TE or NT (the default is TE). This sets two different but normally related configuration items:
A TE span will have *_cpe signalling in Asterisk and will also get timing from the remote party.
A NT span will have *_new signalling in Asterisk and will provide timing to the remote party.
pri_termtype is a list if span specs and configuration (TE/NT) for them. The first spec that matches is used. The matching is of perl regular expressions, but with * and ? have their meaning from basic regular expressions.
#pri_termtype
SPAN/2 NT SPAN/4 NT
#pri_termtype
SPAN/* NT
The file zonedata.c contains the information about the tone zones used in libtonezone (and hence also in ztcfg). Here is a list of those zones:
us United States / North America
au Australia
fr France
nl Netherlands
uk United Kingdom
fi Finland
es Spain
jp Japan
no Norway
at Austria
nz New Zealand
it Italy
us-old United States Circa 1950 / North America
gr Greece
tw Taiwan
cl Chile
se Sweden
be Belgium
sg Singapore
il Israel
br Brazil
hu Hungary
lt Lithuania
pl Poland
za South Africa
pt Portugal
ee Estonia
mx Mexico
in India
de Germany
ch Switzerland
dk Denmark
cz Czech Republic
cn China
ar Argentina
my Malaysia
th Thailand
bg Bulgaria
ve Venezuela
ph Philippines
ru Russian Federation
tr Turkey
The directory xpp has, in addition to helper utilities for the Xorcom Astribank, a collection of perl modules to provide information related to DAHDI. The perl modules themselves are under xpp/perl_modules/ . In xpp/ there are several utilities that use those modules: - xpp-specific: dahdi_registration, xpp_sync, xpp_blink . - General: lsdahdi, dahdi_genconf, dahdi_hardware, dahdi_drivers
The DAHDI perl modules will currently only be automatically installed if you happen to install the xpp directory. Those utilities require the perl modules to be installed, however they will also look for them in the directory perl_modules, and thus can be run directly from the DAHDI source tree. For example:
./xpp/dahdi_hardware -v
To get usage information on a program, you can also use perldoc (sometimes provided in a package separate from perl itself). For instance:
perldoc ./xpp/lsdahdi
Some of them are specific for the Xorcom Astribank and described in its docuemntation. the others are:
A somewhat glorified cat /proc/dahdi/*.
Generates configuration based on the existing DAHDI channels and on /etc/dahdi/genconf_parameters (replaces genzaptelconf as well).
A two-liner script (not installed by default) that simply returns the modules that should be modprobed on this system.
Uses the information from sysfs and its own knowledge to show what PCI/USB DAHDI hardware is connected and if it is currently used by a driver. Shows also some more information for Astribanks from /proc/xpp .
DAHDI digital cards can provide data channels through ppp as point-to-point connections. This requires a plugin to the ppp daemon that is included in the ppp/ subdirectory. To install it:
Make sure you have the PPP source / headers installed. On Debian:
apt-get install ppp-dev
Run make on the ppp subdirectory:
make -C ppp make -C ppp install
Make sure your kernel has support for both PPP (which is common is distribution kernels and for HDLC (much less common) - CONFIG_PPP and CONFIG_HDLC .
Information for upgrading from Zaptel 1.2 or 1.4 to DAHDI 2.0
Upgrading from Zaptel to DAHDI is fairly straightforward; install this package using the installation instructions, and then reconfigure and rebuild Asterisk; Asterisk 1.4 releases later than 1.4.21, and all releases of Asterisk 1.6, will automatically use DAHDI in preference to Zaptel, even if Zaptel is still installed on the system.
Important notes about upgrading:
The Zaptel package, which included both kernel modules and userspace tools for configuring and managing the modules, has been split into two packages:
dahdi-linux: kernel modules
dahdi-tools: userspace tools
In addition, there is a dahdi-linux-complete package that contains both dahdi-linux and dahdi-tools for simplified installation.
|
Note
|
The dahdi-linux and dahdi-tools packages have separate version numbers; they will not be released in sync, and it is perfectly acceptable to use (for example) dahdi-tools 2.0.6 with dahdi-linux 2.0.11. The dahdi-linux-complete package version number will always include both of these version numbers so that you will know what is included in it. |
The primary kernel modules have changed names; the new names are:
zaptel.ko -> dahdi.ko ztd-eth.ko -> dahdi_dynamic_eth.ko ztd-loc.ko -> dahdi_dynamic_loc.ko ztdummy.ko -> dahdi_dummy.ko ztdynamic.ko -> dahdi_dynamic.ko zttranscode.ko -> dahdi_transcode.ko
The kernel modules for card drivers have not changed names, although the wcusb and torisa drivers are no longer included.
This package no longer includes the menuselect utility for choosing which modules to build; all modules that can be built are built automatically.
It is no longer possible and needed to select a software echo canceler at compile time to build into dahdi.ko; all four included echo cancelers (MG2, KB1, SEC and SEC2) are built as loadable modules. If the Digium HPEC binary object file has been placed into the proper directory the HPEC module will be built as well.
Any or all of these modules can be loaded at the same time, and the echo canceler to be used on the system’s channels can be configured using the dahdi_cfg tool from the dahdi-tools package.
|
Important
|
It is mandatory to configure an echo canceler for the system’s channels using dahdi_cfg unless the interface cards in use have echo canceler modules available and enabled. There is no default software echo canceler with DAHDI. See section on echo cancellers in sample system.conf. |
Many tool names have changed:
ztcfg -> dahdi_cfg ztmonitor -> dahdi_monitor ztscan -> dahdi_scan ztspeed -> dahdi_speed zttest -> dahdi_test zttool -> dahdi_tool zapconf -> dahdi_genconf (deprecates genzaptelconf)
The system configuration file has moved from /etc/zaptel.conf to /etc/dahdi/system.conf.
The dahdi_cfg tool can now be used to select an echo canceler on a channel-by-channel basis in the system configuration file; see system.conf.sample for examples of how to do this.
The configuration for XPP init_card_* scripts is done now in /etc/dahdi/xpp.conf and uses a simple syntax (example included). For PRI modules, the pri_protocol setting, determines how to configure it (E1/T1).
In Astribank PRI modules, the LED behaviour represents which ports are CLOCK MASTER (red color) and which are CLOCK SLAVE (green color). Usually (but not always), this corresponds to the NT/TE settings in Asterisk.
The /etc/sysconfig/zaptel (or /etc/default/zaptel file, depending on your distribution) is now split into two separate files: /etc/dahdi/modules control which modules are loaded and module options are set via /etc/modprobe.d/dahdi.
This package is distributed under the terms of the GNU General Public License Version 2, except for some components which are distributed under the terms of the GNU Lesser General Public License Version 2.1. Both licenses are included in this directory, and each file is clearly marked as to which license applies.
If you wish to use the DAHDI drivers in an application for which the license terms are not appropriate (e.g. a proprietary embedded system), licenses under more flexible terms can be readily obtained through Digium, Inc. at reasonable cost.
Please report bug and patches to the Asterisk bug tracker at http://bugs.digium.com/ in the "DAHDI" category.