[dahdi-commits] fjoe: freebsd/trunk r10541 - in /freebsd/trunk: README README.FreeBSD
SVN commits to the DAHDI project
dahdi-commits at lists.digium.com
Mon Mar 19 11:28:18 CDT 2012
Author: fjoe
Date: Mon Mar 19 11:28:14 2012
New Revision: 10541
URL: http://svnview.digium.com/svn/dahdi?view=rev&rev=10541
Log:
Move FreeBSD notes to separate file.
Added:
freebsd/trunk/README.FreeBSD
- copied, changed from r10471, freebsd/trunk/README
Modified:
freebsd/trunk/README
Modified: freebsd/trunk/README
URL: http://svnview.digium.com/svn/dahdi/freebsd/trunk/README?view=diff&rev=10541&r1=10540&r2=10541
==============================================================================
--- freebsd/trunk/README (original)
+++ freebsd/trunk/README Mon Mar 19 11:28:14 2012
@@ -7,52 +7,6 @@
This package contains the kernel modules for DAHDI. For the required
userspace tools see the package dahdi-tools.
-
-FreeBSD Notes
--------------
-
-FreeBSD port is maintained by Max Khon <fjoe at FreeBSD.org>
-
-Drop me an e-mail if you have hardware that is supported by dahdi-linux
-but is not supported on FreeBSD.
-
-Building
-~~~~~~~~
-
-Run "make", then "make install" in the root directory.
-
-Supported drivers
-~~~~~~~~~~~~~~~~~
-The following drivers are currently supported on FreeBSD:
-- main DAHDI driver
-- dahdi_echocan_jpah
-- dahdi_echocan_kb1
-- dahdi_echocan_mg2
-- dahdi_echocan_sec
-- dahdi_echocan_sec2
-- dahdi_dummy
-- dahdi_dynamic
-- dahdi_dynamic_loc
-- dahdi_dynamic_eth and dahdi_dynamic_ethmf
-- wcb4xxp
-- wcfxo
-- wct4xxp, including HW echo cancellation support (Octasic)
-- wctdm
-- wctdm24xxp
-- wcte11xp
-- wcte12xp
-
-Additional notes
-~~~~~~~~~~~~~~~~
-
-TDMoE (dahdi_dynamic_eth and dahdi_dynamic_ethmf) drivers require ng_ether kernel module
-to be loaded.
-
-Credits
-~~~~~~~
-
-main DAHDI driver and wcb4xxp FreeBSD port sponsored by Ethon Technologies GmbH, http://ethon.de/
-dahdi_dynamic and eth/ethmf FreeBSD port sponsored by Redfone Communications, LLC, http://red-fone.com/
Supported Hardware
------------------
@@ -63,6 +17,7 @@
* Digium TE405P/TE407P/TE410P/TE412P: PCI quad-port T1/E1/J1
* Digium TE220: PCI-Express dual-port T1/E1/J1
* Digium TE420: PCI-Express quad-port T1/E1/J1
+ * Digium TE820: PCI-Express eight-port T1/E1/J1
- wcte12xp:
* Digium TE120P: PCI single-port T1/E1/J1
* Digium TE121: PCI-Express single-port T1/E1/J1
@@ -97,8 +52,6 @@
- wctc4xxp: Digium hardware transcoder cards (also need dahdi_transcode)
- dahdi_dynamic_eth: TDM over Ethernet (TDMoE) driver. Requires dahdi_dynamic
- dahdi_dynamic_loc: Mirror a local span. Requires dahdi_dynamic
-- dahdi_dummy: A dummy driver that only provides a DAHDI timing source.
-
Installation
------------
@@ -135,9 +88,9 @@
- If you use a kernel from your distribution you will typically have a
package with all the files required to build a kernel modules for your
kernel image.
- * On Debian Etch and Ubuntu this is
+ * On Debian and Ubuntu this is
+++ linux-headers-`uname -r` +++
- * On Fedora, RHEL and compatibles (e.g. CentOS) and in SUSE this is
+ * On Fedora, RHEL and compatibles (e.g. CentOS) and SUSE this is
the kernel-devel package. Or if you run kernel-smp or kernel-xen,
you need kernel-smp-devel or kernel-xen-devel, respectively.
* In some distributions (e.g.: in RHEL/CentOS, Fedora, Ubuntu) the
@@ -154,6 +107,19 @@
make KSRC=/home/tzafrir/kernels/linus
+Kernel Configuration
+^^^^^^^^^^^^^^^^^^^^
+If you build a custom kernel, note the following configuration items:
+
+- CONFIG_CRC_CCITT must be enabled ('y' or 'm'). On 2.6 kernels this can
+ be selected These can be selected from the "Library Routines" submenu
+ during kernel configuration via "make menuconfig".
+- DAHDI will work if you disable module unloading. But you may need
+ extra reboots.
+- DAHDI needs the BKL (Big Kernel Lock). This may be annoying in
+ >=2.6.37 kernels. Make sure you enable CONFIG_BKL on those kernels.
+
+
Installing to a Subtree
~~~~~~~~~~~~~~~~~~~~~~~
The following may be useful when testing the package or when preparing a
@@ -195,6 +161,24 @@
to the script:
./build_tools/make_static_devs -d tmp/newroot/dev/dahdi
+
+
+DKMS
+----
+DKMS, Dynamic Kernel Module Support, is a framework for building Linux
+kernel modules. It is used, among others, by several distributions that
+package the DAHDI kernel modules.
+
+DKMS is designed to provide updates over drivers installed from original
+kernel modules tree. Thus it installed modules into /lib/modules/updates
+or /lib/modules/VERSION/updates . This is generally not an issue on
+normal operation. However if you try to install DAHDI from source on
+a system with DAHDI installed from DKMS this way (potentially of an
+older version), be sure to remove the DKMS-installed modules from the
+updates directory. If you're not sure, the following command will give
+you a clue of the versions installed:
+
+ find /lib/modules -name dahdi.ko
Installing the B410P drivers with mISDN
@@ -246,13 +230,10 @@
this is where the oslec code lies. If it is elsewhere you'll need to fix
the #include line.
-Thus for the moment, the simplest way to build OSLEC with dahdi is:
-
-1. Copy the directory `drivers/staging/echo` from a recent kernel tree
- (at least 2.6.28-rc1) to the a subdirectory with the same name in the
- dahdi-linux tree.
-
-2. Edit drivers/dahdi/Kbuild and uncomment the two lines related to OSLEC.
+Thus for the moment, the simplest way to build OSLEC with dahdi is to
+copy the directory `drivers/staging/echo` from a recent kernel tree (at
+least 2.6.28-rc1) to the a subdirectory with the same name in the
+dahdi-linux tree.
After doing that, you'll see the following when building (running
'make')
@@ -415,6 +396,20 @@
recursively. The default is 'dahdi'. You may also want to have 'oslec'
or 'hpec' there if you use them.
+===== KVERS
+If you want to build DAHDI for a different kernel version than the one
+currently running on the system (mostly useful for a remote install).
+Note that you will normally need to export this, in order for this to
+take effect on the 'make' command. In live/live.conf itself have the line:
+
+ export KVERS="2.6.39-local"
+
+===== KSRC
+Alternatively, if you want to point to an exact kernel source tree,
+set it with KSRC. Just like KVERS above, it needs to be explicitly exported.
+
+ export KSRC="/usr/src/tree/linux"
+
Module Parameters
-----------------
@@ -452,9 +447,6 @@
+
Some modules have "debugging flags" bits - the value of debug is a
bitmask and several messages are printed if some bits are set:
- - dahdi_dummy:
- * 1: DEBUG_GENERAL - general error messages.
- * 2: DEBUG_TICKS - Show that the module is alive :-)
- wctdm24xxp:
* 1: DEBUG_CARD
* 2: DEBUG_ECHOCAN
@@ -488,6 +480,11 @@
different default size. So normally setting this doesn't change
anything.
+max_pseudo_channels (dahdi)::
+ The maximum number of pseudo channels that dahdi will allow userspace to
+ create. Pseudo channels are used when conferencing channels together.
+ The default is 512.
+
To get a list of parameters supported by a module, use
modinfo module_name
@@ -545,9 +542,9 @@
cards are also capable of providing timing from a clock on card. Cheap x100P
clone cards are sometimes used for that purpose.
-If all the above fail, you can use the module dahdi_dummy to provide timing
-alone without needing any DAHDI hardware. It will work with most systems and
-kernels.
+If a hardware timing source either cannot be found or stops providing timing
+during runtime, DAHDI will automatically use the host timer in order provide
+timing.
You can check the DAHDI timing source with dahdi_test, which is a small
utility that is included with DAHDI. It runs in cycles. In each such cycle it
@@ -557,12 +554,6 @@
give you in each cycle the percent of how close it was. Also try running it
with the option -v for a verbose output.
-To check the clock source that is built into dahdi_dummy, you can either look
-at title of its span in /proc/dahdi file for a "source:" in the description.
-Or even run:
-
- strings dahdi.ko | grep source:
-
Spans and Channels
~~~~~~~~~~~~~~~~~~
@@ -581,6 +572,81 @@
There are up to 128 spans and 1024 channels. This is a hard-wired limit
(see dahdi/user.h . Several places throuout the code assume a channel
number fits in a 16 bits number). Channel and span numbers start at 1.
+
+
+Span Assignments
+~~~~~~~~~~~~~~~~
+A DAHDI device (e.g. a PCI card) is represented within the DAHDI drivers
+as a 'DAHDI device'. Normally (with auto_assign_spans=1 in the module
+dahdi, which is the default), when a device is discovered and loaded,
+it registers with the DAHDI core and its spans automatically become
+available. However if you have more than one device, you may be
+interested to set explicit spans and channels numbers for them. To use
+manual span assigment, set 'auto_assign_spans' to 0 . e.g. in a file
+under /etc/modprobe.d/ include the following line:
+
+ options dahdi auto_assign_spans=0
+
+You will then need to assign the spans manually at device startup. You
+will need to assign a span number and channel numbers for each
+available span on the system. On my test system I have one BRI PCI card
+and one Astribank BRI+FXS:
+
+ # grep . /sys/bus/dahdi_devices/devices/*/spantype
+ /sys/bus/dahdi_devices/devices/astribanks:xbus-00/spantype:1:BRI
+ /sys/bus/dahdi_devices/devices/astribanks:xbus-00/spantype:2:BRI
+ /sys/bus/dahdi_devices/devices/astribanks:xbus-00/spantype:3:BRI
+ /sys/bus/dahdi_devices/devices/astribanks:xbus-00/spantype:4:BRI
+ /sys/bus/dahdi_devices/devices/astribanks:xbus-00/spantype:5:BRI
+ /sys/bus/dahdi_devices/devices/astribanks:xbus-00/spantype:6:BRI
+ /sys/bus/dahdi_devices/devices/astribanks:xbus-00/spantype:7:BRI
+ /sys/bus/dahdi_devices/devices/astribanks:xbus-00/spantype:8:BRI
+ /sys/bus/dahdi_devices/devices/astribanks:xbus-00/spantype:9:FXS
+ /sys/bus/dahdi_devices/devices/pci:0000:00:09.0/spantype:1:TE
+ /sys/bus/dahdi_devices/devices/pci:0000:00:09.0/spantype:2:TE
+ /sys/bus/dahdi_devices/devices/pci:0000:00:09.0/spantype:3:NT
+ /sys/bus/dahdi_devices/devices/pci:0000:00:09.0/spantype:4:NT
+
+All spans here, except the FXS one, are BRI spans with 3 channels per span.
+
+In order to assign a span, we write three numbers separated by colns to
+the file 'assign_span' in the SysFS node
+
+ local_num:span_num:base_chan_num
+
+Thus:
+
+ echo 9:5:10 >/sys/bus/dahdi_devices/devices/astribanks:xbus-00/assign_span
+ echo 2:8:40 >/sys/bus/dahdi_devices/devices/pci:0000:00:09.0/assign_span
+ echo 1:1:1 >/sys/bus/dahdi_devices/devices/astribanks:xbus-00/assign_span
+ echo 4:6:20 >/sys/bus/dahdi_devices/devices/pci:0000:00:09.0/assign_span
+ echo 3:2:5 >/sys/bus/dahdi_devices/devices/astribanks:xbus-00/assign_span
+
+As you can see, the order of span numbers or local span number is
+insignificant. However the order of channel numbers must be the same as
+that of span numbers.
+
+Which indeed produced:
+
+ # head -n3 -q /proc/dahdi/*
+ Span 1: XBUS-00/XPD-00 "Xorcom XPD [usb:LAB-0003].1: BRI_NT"
+
+ 1 XPP_BRI_NT/00/00/0
+ Span 2: XBUS-00/XPD-02 "Xorcom XPD [usb:LAB-0003].3: BRI_TE"
+
+ 5 XPP_BRI_TE/00/02/0
+ Span 5: XBUS-00/XPD-10 "Xorcom XPD [usb:LAB-0003].9: FXS" (MASTER)
+
+ 10 XPP_FXS/00/10/0
+ Span 6: B4/0/4 "B4XXP (PCI) Card 0 Span 4" RED
+
+ 23 B4/0/4/1 YELLOW
+ Span 8: B4/0/2 "B4XXP (PCI) Card 0 Span 2" RED
+
+ 40 B4/0/2/1 RED
+
+Likewise spans can be unassigned by writing to the 'unassign-span'
+"file".
Dynamic Spans
@@ -668,6 +734,109 @@
see an extra '(In use)':
2 XPP_FXS/0/0/1 FXOLS (In use)
+
+
+SysFS Interface
+~~~~~~~~~~~~~~~
+DAHDI exposes several interfaces under the SysFS virtual file system.
+SysFS represents kernel objects in nodes - directories. There properties
+are often files. They may also contain other nodes or include symlinks
+to other nodes.
+
+Class DAHDI
+^^^^^^^^^^^
+under /sys/class/dadhi there exists a node for each DAHDI device file
+under /dev/dahdi. The name is 'dahdi!foo' for the file '/dev/dahdi/foo'
+(udev translates exclamation marks to slashes). Those nodes are not, for
+the most part, proper SysFS nodes, and don't include any interesting
+properties.
+
+
+Devices Bus
+^^^^^^^^^^^
+Each DAHDI device (a physical device, such as a PCI card) is represented
+by a node under /sys/bus/dahdi_devices/devices named with the name of
+its device.
+
+Its attributes include:
+
+===== /sys/bus/dahdi_devices/devices/DEVICE/assgin-span
+Write-only attribute: this device's spans should now be assigned
+("registered"). See section about <<_span_assignments>>.
+
+===== /sys/bus/dahdi_devices/devices/DEVICE/auto-assign
+Write-only attribute. Spans in the device auto-assign ("register" as in
+the original interface). See section about <<_span_assignments>>.
+
+===== /sys/bus/dahdi_devices/devices/DEVICE/hardware_id
+A unique hardware-level identifier (e.g. serial number), if available.
+
+===== /sys/bus/dahdi_devices/devices/DEVICE/manufacturer
+The name of the manufacturer. Freeform-string.
+
+===== /sys/bus/dahdi_devices/devices/DEVICE/spantype
+A line for each available span: <num>:<type>. This has to be provided
+here as in the case of manual assignment, userspace may need to know
+it before span nodes are created.
+
+===== /sys/bus/dahdi_devices/devices/DEVICE/spantype
+Device type.
+
+===== /sys/bus/dahdi_devices/devices/DEVICE/unassign-span
+Write-only attribute: the span whose device-local number is written
+should now be unassigned ("unregistered"). See section about
+<<_span_assignments>>.
+
+
+Spans Bus
+^^^^^^^^^
+Each DAHDI span is represented by a node under
+/sys/bus/dahdi_spans/devices with the name 'span-N' (where N is the
+number of the span). Spans of each device also reside under the node of
+the device.
+
+Useful attributes in the span node:
+
+===== /sys/bus/dahdi_spans/devices/span-N/alarms
+The alarms of the span. Currently this is a numeric representation.
+This may change in the future.
+
+===== /sys/bus/dahdi_spans/devices/span-N/basechan
+The channel number of the first channel. The channel numbers of the
+following channels are guaranteed to follow it.
+
+===== /sys/bus/dahdi_spans/devices/span-N/channels
+The number of the channels in the span.
+
+===== /sys/bus/dahdi_spans/devices/span-N/desc
+A free-form description of the span.
+
+===== /sys/bus/dahdi_spans/devices/span-N/is_digital
+1 if the span is digital, 0 if it isn't.
+
+===== /sys/bus/dahdi_spans/devices/span-N/is_sync_master
+1 if the span is the sync master, 0 if it isn't.
+
+===== /sys/bus/dahdi_spans/devices/span-N/lbo
+LBO setting for the channel.
+
+===== /sys/bus/dahdi_spans/devices/span-N/lineconfig
+The framing and coding of the span, for a digital span. Textual
+represenation:
+
+<B8ZS|AMI|HDB3>/<D4|ESF|CCS>[/CRC4]
+
+===== /sys/bus/dahdi_spans/devices/span-N/local_spanno
+The number of the span within the DAHDI device.
+
+===== /sys/bus/dahdi_spans/devices/span-N/name
+A concise name for this span.
+
+===== /sys/bus/dahdi_spans/devices/span-N/spantype
+A very short type string.
+
+===== /sys/bus/dahdi_spans/devices/span-N/syncsrc
+Current sync source.
User-space Interface
@@ -702,8 +871,6 @@
When a span is registered, it is considered "unconfigured". Only after
dahdi_cfg has been run to apply configuration, the span is ready to run.
-The only exception to that is 'dahdi_dummy', which does not need any
-configuration.
Some of the configuration is handled by the DAHDI core. Some of it is
handled by callbacks, which are function pointers in the `struct
@@ -749,7 +916,7 @@
Low-Level Drivers
~~~~~~~~~~~~~~~~~
Low-level drivers create spans ('struct dahdi_span'). They register the
-spans with the DAHDI core using 'dahdi_register()'.
+spans with the DAHDI core using 'dahdi_device_register()'.
'struct dahdi_span' has a number of informative members that are updated
solely by the low-level driver:
Copied: freebsd/trunk/README.FreeBSD (from r10471, freebsd/trunk/README)
URL: http://svnview.digium.com/svn/dahdi/freebsd/trunk/README.FreeBSD?view=diff&rev=10541&p1=freebsd/trunk/README&r1=10471&p2=freebsd/trunk/README.FreeBSD&r2=10541
==============================================================================
--- freebsd/trunk/README (original)
+++ freebsd/trunk/README.FreeBSD Mon Mar 19 11:28:14 2012
@@ -1,13 +1,3 @@
-DAHDI Telephony Interface Driver
-=================================
-Asterisk Development Team <asteriskteam at digium.com>
-$Revision$, $Date$
-
-DAHDI stands for Digium Asterisk Hardware Device Interface.
-
-This package contains the kernel modules for DAHDI. For the required
-userspace tools see the package dahdi-tools.
-
FreeBSD Notes
-------------
@@ -53,1011 +43,4 @@
main DAHDI driver and wcb4xxp FreeBSD port sponsored by Ethon Technologies GmbH, http://ethon.de/
dahdi_dynamic and eth/ethmf FreeBSD port sponsored by Redfone Communications, LLC, http://red-fone.com/
-
-Supported Hardware
-------------------
-Digital Cards
-~~~~~~~~~~~~~
-- wct4xxp:
- * Digium TE205P/TE207P/TE210P/TE212P: PCI dual-port T1/E1/J1
- * Digium TE405P/TE407P/TE410P/TE412P: PCI quad-port T1/E1/J1
- * Digium TE220: PCI-Express dual-port T1/E1/J1
- * Digium TE420: PCI-Express quad-port T1/E1/J1
-- wcte12xp:
- * Digium TE120P: PCI single-port T1/E1/J1
- * Digium TE121: PCI-Express single-port T1/E1/J1
- * Digium TE122: PCI single-port T1/E1/J1
-- wcte11xp:
- * Digium TE110P: PCI single-port T1/E1/J1
-- wct1xxp:
- * Digium T100P: PCI single-port T1
- * Digium E100P: PCI single-port E1
-- wcb4xxp:
- * Digium B410: PCI quad-port BRI
-- tor2: Tormenta quad-span T1/E1 card from the Zapata Telephony project
-
-
-Analog Cards
-~~~~~~~~~~~~
-- wctdm24xxp:
- * Digium TDM2400P/AEX2400: up to 24 analog ports
- * Digium TDM800P/AEX800: up to 8 analog ports
- * Digium TDM410P/AEX410: up to 4 analog ports
- * Digium Hx8 Series: Up to 8 analog or BRI ports
-- wctdm:
- * Digium TDM400P: up to 4 analog ports
-- xpp: Xorcom Astribank: a USB connected unit of up to 32 ports
- (including the digital BRI and E1/T1 modules)
-- wcfxo: X100P, similar and clones. A simple single-port FXO card
-
-
-Other Drivers
-~~~~~~~~~~~~~
-- pciradio: Zapata Telephony PCI Quad Radio Interface
-- wctc4xxp: Digium hardware transcoder cards (also need dahdi_transcode)
-- dahdi_dynamic_eth: TDM over Ethernet (TDMoE) driver. Requires dahdi_dynamic
-- dahdi_dynamic_loc: Mirror a local span. Requires dahdi_dynamic
-- dahdi_dummy: A dummy driver that only provides a DAHDI timing source.
-
-
-Installation
-------------
-If all is well, you just need to run the following:
-
- make
- make install
-
-You'll need the utilities provided in the package dahdi-tools to
-configure DAHDI devices on your system.
-
-If using `sudo` to build/install, you may need to add /sbin to your PATH.
-
-If you still have problems, read further.
-
-
-Build Requirements
-~~~~~~~~~~~~~~~~~~
-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.
-
-Kernel Source / "Headers"
-^^^^^^^^^^^^^^^^^^^^^^^^^
-- Building DAHDI-linux requires a kernel build tree.
-- This should basically be at least a partial kernel source tree and
- most importantly, the exact kernel .config file used for the build as
- well as several files generated at kernel build time.
-- KERNEL_VERSION is the output of the command `uname -r`
-- If you build your own kernel, you need to point to the exact kernel
- build tree. Luckily for you, this will typically be pointed by the
- symbolic link /lib/modules/KERNEL_VERSION/build which is the location
- zaptel checks by default.
-- If you use a kernel from your distribution you will typically have a
- package with all the files required to build a kernel modules for your
- kernel image.
- * On Debian Etch and Ubuntu this is
- +++ linux-headers-`uname -r` +++
- * On Fedora, RHEL and compatibles (e.g. CentOS) and in SUSE this is
- the kernel-devel package. Or if you run kernel-smp or kernel-xen,
- you need kernel-smp-devel or kernel-xen-devel, respectively.
- * In some distributions (e.g.: in RHEL/CentOS, Fedora, Ubuntu) the
- installation of the kernel-devel / kernel-headers package will
- be of a version that is newer than the one you currently run. In
- such a case you may need to upgrade the kernel package itself as
- well and reboot.
-- To point explicitly to a different build tree: set KSRC to the kernel
- source tree or KVERS to the exact kernel version (if "headers" are
- available for a different version). This parameter must be run on
- every calls to 'make' (e.g.: 'make clean', 'make install').
-
- make KVERS=2.6.18.Custom
- make KSRC=/home/tzafrir/kernels/linus
-
-
-Installing to a Subtree
-~~~~~~~~~~~~~~~~~~~~~~~
-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 the real system.
-
- make install DESTDIR=targetdir
-
-This can be useful for any partial install target of the above (e.g:
-install-modules or install-programs).
-
-the targetdir must be an absolute path, at least if you install the
-modules. To install to a relative path you can use something like:
-
- make install-modules DESTDIR=$PWD/target
-
-
-Extra Modules
-~~~~~~~~~~~~~
-To build extra modules / modules directory not included in the DAHDI
-distribution, use the optional variables MODULES_EXTRA and
-SUBDIRS_EXTRA:
-
- make MODULES_EXTRA="mod1 mod2"
- make MODULES_EXTRA="mod1 mod2" SUBDIRS_EXTRA="subdir1/ subdir1/"
-
-
-Static Device Files
-~~~~~~~~~~~~~~~~~~~
-Userspace programs communicate with the DAHDI modules through special
-device files under /dev/dahdi . Those are normally created by udev, but
-if you use an embedded-type system and don't wish to use udev, you can
-generate them with the following script, from the source directory:
-
- ./build_tools/make_static_devs
-
-This will generate the device files under /dev/dahdi . If you need to
-generate them elsewhere (e.g. `tmp/newroot/dev/dahdi`) use the option -d
-to the script:
-
- ./build_tools/make_static_devs -d tmp/newroot/dev/dahdi
-
-
-Installing the B410P drivers with mISDN
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-DAHDI includes the wcb4xxp driver for the B410P, however, support for the
-B410P was historically provided by mISDN. If you would like to use the mISDN
-driver with the B410P, please comment out the wcb4xxp line in /etc/dahdi/modules.
-This will prevent DAHDI from loading wcb4xxp which will conflict with the mISDN
-driver.
-
-To install the mISDN driver for the B410P, please see http://www.misdn.org for
-more information, but the following sequence of steps is roughly equivalent to
-'make b410p' from previous releases.
-
- wget http://www.misdn.org/downloads/releases/mISDN-1_1_8.tar.gz
- wget http://www.misdn.org/downloads/releases/mISDNuser-1_1_8.tar.gz
- tar xfz mISDN-1_1_8.tar.gz
- tar xfz mISDNuser-1_1_8.tar.gz
- pushd mISDN-1_1_8
- make install
- popd
- pushd mISDNuser-1_1_8
- make install
- popd
- /usr/sbin/misdn-init config
-
-You will then also want to make sure /etc/init.d/misdn-init is started
-automatically with either 'chkconfig --add misdn-init' or 'update-rc.d
-misdn-init defaults 15 30' depending on your distribution.
-
-NOTE: At the time this was written, misdn-1.1.8 is not compatible the
-2.6.25 kernel. Please use a kernel version 2.6.25 or earlier.
-
-
-OSLEC
-~~~~~
-http://www.rowetel.com/ucasterisk/oslec.html[OSLEC] is an
-Open Source Line Echo Canceller. It is currently in the staging subtree
-of the mainline kernel and will hopefully be fully merged at around
-version 2.6.29. The echo canceller module dahdi_echocan_oslec
-provides a DAHDI echo canceller module that uses the code from OSLEC. As
-OSLEC has not been accepted into mainline yet, its interface is not set
-in stone and thus this driver may need to change. Thus it is not
-built by default.
-
-Luckily the structure of the dahdi-linux tree matches that of the kernel
-tree. Hence you can basically copy drivers/staging/echo and place it
-under driver/staging/echo . In fact, dahdi_echocan_oslec assumes that
-this is where the oslec code lies. If it is elsewhere you'll need to fix
-the #include line.
-
-Thus for the moment, the simplest way to build OSLEC with dahdi is:
-
-1. Copy the directory `drivers/staging/echo` from a recent kernel tree
- (at least 2.6.28-rc1) to the a subdirectory with the same name in the
- dahdi-linux tree.
-
-2. Edit drivers/dahdi/Kbuild and uncomment the two lines related to OSLEC.
-
-After doing that, you'll see the following when building (running
-'make')
-
- ...
- CC [M] /home/tzafrir/dahdi-linux/drivers/dahdi/dahdi_echocan_oslec.o
- CC [M] /home/tzafrir/dahdi-linux/drivers/dahdi/../staging/echo/echo.o
- ...
-
-As this is an experimental driver, problems building and using it should
-be reported on the
-https://lists.sourceforge.net/lists/listinfo/freetel-oslec[OSLEC mailing
-list].
-
-Live Install
-~~~~~~~~~~~~
-In many cases you already have DAHDI installed on your system but would
-like to try a different version. E.g. in order to check if the latest
-version fixes a bug that your current system happens to have.
-
-DAHDI-linux includes a script to automate the task of installing DAHDI
-to a subtree and using it instead of the system copy. Module loading
-through modprobe cannot be used. Thus the script pre-loads the required
-modules with insmod (which requires some quesswork as for which modules
-to load). It also sets PATH and other environment variables to make all
-the commands do the right thing.
-
-There is an extra mode of operation to copy all the required files to a
-remote host and run things there, for those who don't like to test code
-on thir build system.
-
-Live Install: The Basics
-^^^^^^^^^^^^^^^^^^^^^^^^
-Basic operation is through running
-
- ./build_tools/live_dahdi
-
-from the root directory of the dahdi-linux tree. Using DAHDI requires
-dahdi-tools as well, and the script builds and installs dahdi-tools. By
-default it assumes the tree of dahdi-tools is in the directory
-'dahdi-tools' alongside the dahdi-linux tree. If you want to checkout
-the trunks from SVN, use:
-
- svn checkout http://svn.asterisk.org/svn/dahdi/linux/trunk dahdi-linux
- svn checkout http://svn.asterisk.org/svn/dahdi/tools/trunk dahdi-tools
- cd dahdi-linux
-
-If the tools directory resides elsewhere, you'll need to edit
-live/live.conf (see later on). The usage message of live_dahdi:
-
- Usage: equivalent of:
- live_dahdi configure ./configure
- live_dahdi install make install
- live_dahdi config make config
- live_dahdi unload /etc/init.d/dahdi stop
- live_dahdi load /etc/init.d/dahdi start
- live_dahdi reload /etc/init.d/dahdi restart
- live_dahdi xpp-firm (Reset and load xpp firmware)
- live_dahdi rsync TARGET (copy filea to /tmp/live in host TARGET)
- live_dahdi exec COMMAND (Run COMMAND in 'live' environment)
-
-Normally you should run:
-
- ./build_tools/live_dahdi configure
- ./build_tools/live_dahdi install
- ./build_tools/live_dahdi config
-
-to build and install everything. Up until now no real change was done.
-This could actually be run by a non-root user. All files are installed
-under the subdirectory live/ .
-
-Reloading the modules (and restarting Asterisk) is done by:
-
- ./build_tools/live_dahdi reload
-
-Note: this stops Asterisk, unloads the DAHDI modules, loads the DAHDI
-modules from the live/ subdirectory, configures the system and re-starts
-Asterisk. This *can* do damage to your system. Furthermore, the DAHDI
-configuration is generated by dahdi_genconf. It can be influenced by
-a genconf_parameters file. But it may or may not be what you want.
-
-If you want to run a command in the environment of the live system, use
-the command 'exec':
-
- ./build_tools/live_dahdi lsdahdi
- ./build_tools/live_dahdi dahdi_hardware -v
-
-Note however:
-
- ./build_tools/live_dahdi dahdi_cfg -c live/etc/dahdi/system.conf
-
-Live Install Remote
-^^^^^^^^^^^^^^^^^^^
-As mentioned above, live_dahdi can also copy all the live system files
-to a remote system and run from there. This requires rsync installed on
-both system and assumes you can connect to the remove system through
-ssh.
-
- tzafrir at hilbert $ ./build_tools/live_dahdi rsync root at david
- root at david's password:
- <f+++++++++ live_dahdi
- cd+++++++++ live/
- <f+++++++++ live/live.conf
- cd+++++++++ live/dev/
- cd+++++++++ live/dev/dahdi/
- cd+++++++++ live/etc/
- cd+++++++++ live/etc/asterisk/
- cd+++++++++ live/etc/dahdi/
- <f+++++++++ live/etc/dahdi/genconf_parameters
- <f+++++++++ live/etc/dahdi/init.conf
- ...
-
-As you can see, it copies the script itselfand the whole live/
-subdirectory. The target directory is /tmp/live on the target directory
-(changing it should probably be simple, but I never needed that).
-
-Then, on the remove computer:
-
- root at david:/tmp# ./live_dahdi reload
-
-
-Configuring a Live Install
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-The live_dahdi script reads a configuration file in 'live/live.conf' if
-it exists. This file has the format of a shell script snippet:
-
- var1=value # a '#' sign begins a comment
- var2='value'
-
- # comments and empty lines are ignored
- var3="value"
-
-The variables below can also be overriden from the environment:
-
- var1='value' ./build_tools/live_dahdi
-
-===== LINUX_DIR
-The relative path to the dahdi-linux tree. The default is '.' and normally
-there's no reason to override it.
-
-===== TOOLS_DIR
-The relative path to the dahdi-tools tree. The default is 'dahdi-tools'.
-
-===== XPP_SYNC
-Set a syncing astribank. See xpp_sync(8). Default is 'auto'.
-
-===== AST_SCRIPT
-The command for an init.d script to start/stop Asterisk. Should accept
-'start' and 'stop' commands. Use 'true' if you want to make that a
-no-op. Defaults to '/etc/init.d/asterisk' .
-
-===== MODULES_LOAD
-Manual list of modules. They will be loaded by insmod. If reside in a
-subdir, add it explicitly. Modules for the drivers that are detected on
-the system will be added by the script. Default: 'dahdi
-dahdi_echocan_mg2'
-
-===== REMOVE_MODULES
-A list of modules to remove when unloading. Will be resolved
-recursively. The default is 'dahdi'. You may also want to have 'oslec'
-or 'hpec' there if you use them.
-
-
-Module Parameters
------------------
-The kernel modules can be configured through module parameters. Module
-parameters can optionally be set at load time. They are normally set (if
-needed) by a line in a file under /etc/modprobe.d/ or in the file
-/etc/modprobe.conf.
-
-Example line:
-
- options dahdi debug=1
-
-The module parameters can normally be modified at runtime through sysfs:
-
- pungenday:~# cat /sys/module/dahdi/parameters/debug
- 0
- pungenday:~# echo 1 >/sys/module/dahdi/parameters/debug
- pungenday:~# cat /sys/module/dahdi/parameters/debug
- 1
-
-Viewing and setting parameters that way is possible as of kernel 2.6 .
-In kernels older than 2.6.10, the sysfs "files" for the parameters
-reside directly under /sys/module/'module_name' .
-
-Useful module parameters:
-
-debug (most modules)::
- Sets debug mode / debug level. With most modules 'debug' can be either
- disabled (0, the default value) or enabled (any other value).
- +
- +
- wctdm and wcte1xp print several extra debugging messages if the value
- of debug is more than 1.
- +
- +
- Some modules have "debugging flags" bits - the value of debug is a
- bitmask and several messages are printed if some bits are set:
- - dahdi_dummy:
- * 1: DEBUG_GENERAL - general error messages.
- * 2: DEBUG_TICKS - Show that the module is alive :-)
- - wctdm24xxp:
- * 1: DEBUG_CARD
- * 2: DEBUG_ECHOCAN
- - wct4xxp:
- * 1: DEBUG_MAIN
- * 2: DEBUG_DTMF
- * 4: DEBUG_REGS
- * 8: DEBUG_TSI
- * 16: DEBUG_ECHOCAN
- * 32: DEBUG_RBS
- * 64: DEBUG_FRAMER
- - xpp: See also README.Astribank:
- * 1: GENERAL - General debug comments.
- * 2: PCM - PCM-related messages. Tend to flood logs.
- * 4: LEDS - Anything related to the LEDs status control. The driver
- produces a lot of messages when the option is enabled.
- * 8: SYNC - Synchronization related messages.
- * 16: SIGNAL - DAHDI signalling related messages.
- * 32: PROC - Messages related to the procfs interface.
- * 64: REGS - Reading and writing to chip registers. Tends to flood
- logs.
- * 128: DEVICES - Device instantiation, destruction and such.
- * 256 - COMMANDS - Protocol commands. Tends to flood logs.
-
-deftaps (dahdi)::
- The default size for the echo canceller. The number is in "taps", that
- is "samples", 1/8 ms. The default is 64 - for a tail size of 8 ms.
- +
- +
- Asterisk's chan_dahdi tends to pass its own value anyway, with a
- different default size. So normally setting this doesn't change
- anything.
-
-To get a list of parameters supported by a module, use
-
- modinfo module_name
-
-Or, for a module you have just built:
-
- modinfo ./module_name.ko
-
-For the xpp modules this will also include the description and default
-value of the module. You can find a list of useful xpp module parameters
-in README.Astribank .
-
-
-Internals
----------
-DAHDI Device Files
-~~~~~~~~~~~~~~~~~~
-Userspace programs will usually interact with DAHDI through device
-files under the /dev/dahdi directory (pedantically: character device files
-with major number 196) . Those device files can be generated statically
-or dynamically through the udev system.
-
-* /dev/dahdi/ctl (196:0) - a general device file for various information and
- control operations on the DAHDI channels.
-* /dev/dahdi/NNN (196:NNN) - for NNN in the range 1-249. A device file for
- DAHDI channel NNN. It can be used to read data from the channel
- and write data to the channel.
-* /dev/dahdi/transcode (196:250) - Used to connect to a DAHDI transcoding
- device.
-* /dev/dahdi/timer (196:253) - Allows setting timers. Used anywhere?
-* /dev/dahdi/channel (196:254) - Can be used to open an arbitrary DAHDI
- channel. This is an alternative to /dev/dahdi/NNN that is not limited to
- 249 channels.
-* /dev/dahdi/pseudo (196:255) - A timing-only device. Every time you open
- it, a new DAHDI channel is created. That DAHDI channel is "pseudo" -
- DAHDI receives no data in it, and only sends garbage data with the
- same timing as the DAHDI timing master device.
-
-
-DAHDI Timing
-~~~~~~~~~~~~
-A PBX system should generally have a single clock. If you are connected to a
-telephony provider via a digital interface (e.g: E1, T1) you should also
-typically use the provider's clock (as you get through the interface). Hence
-one important job of Asterisk is to provide timing to the PBX.
-
-DAHDI "ticks" once per millisecond (1000 times per second). On each tick every
-active DAHDI channel reads and 8 bytes of data. Asterisk also uses this for
-timing, through a DAHDI pseudo channel it opens.
-
-However, not all PBX systems are connected to a telephony provider via a T1 or
-similar connection. With an analog connection you are not synced to the other
-party. And some systems don't have DAHDI hardware at all. Even a digital card
-may be used for other uses or is simply not connected to a provider. DAHDI
-cards are also capable of providing timing from a clock on card. Cheap x100P
-clone cards are sometimes used for that purpose.
-
-If all the above fail, you can use the module dahdi_dummy to provide timing
-alone without needing any DAHDI hardware. It will work with most systems and
-kernels.
-
-You can check the DAHDI timing source with dahdi_test, which is a small
-utility that is included with DAHDI. It runs in cycles. In each such cycle it
-tries to read 8192 bytes, and sees how long it takes. If DAHDI is not loaded
-or you don't have the device files, it will fail immediately. If you lack a
-timing device it will hang forever in the first cycle. Otherwise it will just
-give you in each cycle the percent of how close it was. Also try running it
-with the option -v for a verbose output.
-
-To check the clock source that is built into dahdi_dummy, you can either look
-at title of its span in /proc/dahdi file for a "source:" in the description.
-Or even run:
-
- strings dahdi.ko | grep source:
-
-
-Spans and Channels
-~~~~~~~~~~~~~~~~~~
-DAHDI provides telephony *channels* to the userspace applications.
-Those channels are channels are incorporated into logical units called
-*spans*.
-
-With digital telephony adapters (e.g: E1 or T1), a span normally
-represents a single port. With analog telephony a span typically
-represents a PCI adapter or a similar logical unit.
-
-Both channels and spans are identified by enumerating numbers (beginning
-with 1). The number of the channel is the lowest unused one when it is
-generated, and ditto for spans.
-
-There are up to 128 spans and 1024 channels. This is a hard-wired limit
-(see dahdi/user.h . Several places throuout the code assume a channel
-number fits in a 16 bits number). Channel and span numbers start at 1.
-
-
-Dynamic Spans
-~~~~~~~~~~~~~
-Dynamic spans are spans that are not represented by real hardware.
-Currently there are two types of them:
-
-tdmoe::
- TDM over Ethernet. A remote span is identified by an ethernet (MAC)
- address.
-
-local::
- Generates a span that is actually a loopback to a different local
- span.
-
-Modules that support the dynamic spans are typically loaded at the time
-the ioctl DAHDI_DYNAMIC_CREATE is called. This is typically called by
-dahdi_cfg when it has a line such as:
-
- dynamic,somename,params
-
-in /etc/dahdi/system.conf . In that case it will typically try to load
-(through modprobe) the modules dahdi_dynamic and
-dahdi_dynamic_'somename'. It will then pass 'params' to it.
-
-Dynamic spans are known to be tricky and are some of the least-tested
-parts of DAHDI.
-
-
-Echo Cancellers
-~~~~~~~~~~~~~~~
-(To be documented later)
-
-
-Tone Zones
-~~~~~~~~~~
-(To be documented later)
-
-
-PROCFS Interface: /proc/dahdi
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-A simple way to get the current list of spans and channels each span contains
-is the files under /proc/dahdi . /proc/dahdi is generated by DAHDI as it
-loads. As each span registers to DAHDI, a file under /proc/dahdi is created
-for it. The name of that file is the number of that span.
-
-Each file has a 1-line title for the span followed by a few optional
-general counter lines, an empty line and then a line for each channel of
-the span.
-
-The title line shows the number of the span, its name and title, and
-(potentially) the alarms in which it is.
-
-The title shows the span number and name, followed by any alarms the
-span may have: For example, here is the first span in my system (with no
-alarms):
-
- Span 1: XBUS-00/XPD-00 "Xorcom XPD #0/0: FXS"
-
-There are several extra optional keywords that may be added there:
-
-(Master)::
- This span is the master span. See <<_dahdi_timing,DAHDI Timing>>.
-ClockSource::
- The clock source among several spans that belong to a single E1/J1/T1
- card.
-RED/YELLOW/RED/NOTOPEN/LOOP/RECOVERING::
- The span is in alarm
-
-Following that line there may be some optional lines about IRQ misses,
-timing slips and such, if there are any.
-
-The channel line for each channel shows its channel number, name and the
-actual signalling assigned to it through dahdi_cfg. Before being configured by
-dahdi_cfg: This is DAHDI channel 2, whose name is 'XPP_FXS/0/0/1'.
-
- 2 XPP_FXS/0/0/1
-
-After being configured by dahdi_cfg: the signalling 'FXOLS' was added. FXS
-channels have FXO signalling and vice versa:
-
- 2 XPP_FXS/0/0/1 FXOLS
-
-If the channel is in use (typically opened by Asterisk) then you will
-see an extra '(In use)':
-
[... 396 lines stripped ...]
More information about the dahdi-commits
mailing list