f26e09d301614cc6578cc87564d50914d4549555
[dahdi/tools.git] / UPGRADE.txt
1 Upgrade Notes
2 -------------
3
4 Information for upgrading from Zaptel 1.2 or 1.4 to DAHDI 2.0
5
6 Upgrading from Zaptel to DAHDI is fairly straightforward; install this
7 package using the installation instructions, and then reconfigure and
8 rebuild Asterisk; Asterisk 1.4 releases later than 1.4.21, and all
9 releases of Asterisk 1.6, will automatically use DAHDI in preference
10 to Zaptel, even if Zaptel is still installed on the system.
11
12 Important notes about upgrading:
13
14 The Zaptel package, which included both kernel modules and userspace
15 tools for configuring and managing the modules, has been split into
16 two packages:
17
18 * dahdi-linux: kernel modules
19 * dahdi-tools: userspace tools
20
21 In addition, there is a dahdi-linux-complete package that contains both
22 dahdi-linux and dahdi-tools for simplified installation.
23
24 NOTE: The dahdi-linux and dahdi-tools packages have *separate*
25 version numbers; they will not be released 'in sync', and it is
26 perfectly acceptable to use (for example) dahdi-tools 2.0.6 with
27 dahdi-linux 2.0.11. The dahdi-linux-complete package version number will
28 always include *both* of these version numbers so that you will know
29 what is included in it.
30
31
32 DAHDI-Linux
33 ~~~~~~~~~~~
34 Module Names
35 ^^^^^^^^^^^^
36 The primary kernel modules have changed names; the new names are:
37
38       zaptel.ko      ->      dahdi.ko
39       ztd-eth.ko     ->      dahdi_dynamic_eth.ko
40       ztd-loc.ko     ->      dahdi_dynamic_loc.ko
41       ztdummy.ko     ->      dahdi_dummy.ko
42       ztdynamic.ko   ->      dahdi_dynamic.ko
43       zttranscode.ko ->      dahdi_transcode.ko
44
45 * The kernel modules for card drivers have *not* changed names,
46   although the wcusb and torisa drivers are no longer included.
47
48 * This package no longer includes the 'menuselect' utility for
49   choosing which modules to build; all modules that can be built are
50   built automatically.
51
52
53 Echo Canceller Modules
54 ^^^^^^^^^^^^^^^^^^^^^^
55 It is no longer possible and needed to select a software echo canceler 
56 at compile time to build into dahdi.ko; all four included echo
57 cancelers (MG2, KB1, SEC and SEC2) are built as loadable modules.
58 If the Digium HPEC binary object file has been placed into the
59 proper directory the HPEC module will be built as well. 
60
61 Any or all of these modules can be loaded at the same time, and the echo
62 canceler to be used on the system's channels can be configured using
63 the dahdi_cfg tool from the dahdi-tools package.
64
65 IMPORTANT: It is *mandatory* to configure an echo canceler for the
66 system's channels using dahdi_cfg unless the interface cards in use
67 have echo canceler modules available and enabled. There is *no*
68 default software echo canceler with DAHDI. See
69 <<_echo_cancellers,section on echo cancellers>> in sample system.conf.
70
71
72 DAHDI-Tools
73 ~~~~~~~~~~~
74 Many tool names have changed:
75
76       ztcfg      ->  dahdi_cfg
77       ztmonitor  ->  dahdi_monitor
78       ztscan     ->  dahdi_scan
79       ztspeed    ->  dahdi_speed
80       zttest     ->  dahdi_test
81       zttool     ->  dahdi_tool
82       zapconf    ->  dahdi_genconf (deprecates genzaptelconf)
83
84 * The system configuration file has moved from /etc/zaptel.conf to
85   <<_sample_system_conf,/etc/dahdi/system.conf>>.
86
87 * The dahdi_cfg tool can now be used to select an echo canceler on a
88   channel-by-channel basis in the system configuration file; see
89   system.conf.sample for examples of how to do this.
90
91 * The configuration for XPP init_card_* scripts is done now
92   in /etc/dahdi/xpp.conf and uses a simple syntax (example included).
93   For PRI modules, the 'pri_protocol' setting, determines how
94   to configure it (E1/T1).
95
96 * In Astribank PRI modules, the LED behaviour represents which ports
97   are *CLOCK MASTER* (red color) and which are *CLOCK SLAVE* (green color).
98   Usually (but not always), this corresponds to the NT/TE settings in Asterisk.
99
100 * The /etc/sysconfig/zaptel (or /etc/default/zaptel file, depending
101   on your distribution) is now split into two separate files:
102   /etc/dahdi/modules control which modules are loaded and module options are
103   set via /etc/modprobe.d/dahdi.