diff options
| -rw-r--r-- | README | 12 | ||||
| -rw-r--r-- | doc/patgen.8 | 42 | ||||
| -rw-r--r-- | doc/pattest.8 | 48 | ||||
| -rw-r--r-- | doc/ztdiag.8 | 52 |
4 files changed, 150 insertions, 4 deletions
@@ -96,16 +96,20 @@ 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". -- If you don't have any zaptel hardware, you need ztdummy. +- If you don't have any zaptel hardware, you need ztdummy. ztdummy takes + its timing from the kernel. It can use either of the following: * ztdummy on i386/x86_64 with kernels >= 2.6.22 can (and should) use high resolution times (CONFIG_HIGH_RES_TIMERS), and (if available, - the system HPET. + the system HPET. This shows as "source: HRTimer". This is + recommended. * ztdummy on i386/x86_64 and later kernels (>= 2.6.15) can use the - system's RTC (Real Time Clock). + system's RTC (Real Time Clock). This shows as "source: RTC". + * Failing that, on Linux 2.6 kernels with HZ=1000 (was the default + before 2.6.13). This shows as "source: Linux26". * Alternatives to that for ztdummy are a UHCI USB controller (USB controllers made by Intel or VIA) or a kernel that has HZ=1000 (default on kernels 2.6.0-2.6.12, optional on newer kernels. Not - possible on 2.4). + possible on 2.4). This shows as: "source: UHCI". A Build System diff --git a/doc/patgen.8 b/doc/patgen.8 new file mode 100644 index 0000000..b92bb6e --- /dev/null +++ b/doc/patgen.8 @@ -0,0 +1,42 @@ +.TH patgen 8 "2008-01-08" +.SH NAME +patgen \(em Generates a Pattern for a Zaptel Clear Channel Test +.SH SYNOPSIS +.B patgen +.I zap-device + +.SH DESCRIPTION +.B patgen +Sends test data to a Zaptel channel. The channel should be of CLEAR +signalling (e.g: B channel of a PRI line). pattest(8) is used to test +the data at the other side. See its manual for more information. + +.B patgen +Must be able to write to the channel. Hence this cannot be used for a +channel used by Asterisk. + +.SH OPTIONS +.I zap-device +.RS +A Zaptel device file. +.RE + +.SH EXAMPLE + patgen /dev/zap/5 + +.SH BUGS +Will not work with channels whose number > 249 as they don't have device +files. For a simple workaround, see ztdiag.c . + +.SH SEE ALSO +pattest(8), ztcfg(8), asterisk(8). + +.SH AUTHOR + +This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> +Permission is granted to copy, distribute and/or modify this document under +the terms of the GNU General Public License, Version 2 any +later version published by the Free Software Foundation. + +On Debian systems, the complete text of the GNU General Public +License can be found in /usr/share/common-licenses/GPL. diff --git a/doc/pattest.8 b/doc/pattest.8 new file mode 100644 index 0000000..c0d14bb --- /dev/null +++ b/doc/pattest.8 @@ -0,0 +1,48 @@ +.TH pattest 8 "2008-01-08" +.SH NAME +pattest \(em Tests a Pattern for a Zaptel Clear Channel Test +.SH SYNOPSIS +.B pattest +.I zap-device + +.SH DESCRIPTION +.B pattest +Recieves test data from a Zaptel channel and checks if it matches the +test pattern. The channel should be of CLEAR signalling (e.g: B channel +of a PRI line). patgen(8) is used to generate the data at the other side. + +.B pattest +Must be able to read from the channel. Hence this cannot be used for a +channel used by Asterisk. + +The pattern is a simple series of values from 0 to 255. Hence it takes +at most one sample to get in sync with the other side. If there is no +output, all is well. Output is an error message. + +.SH OPTIONS +.I zap-device +.RS +A Zaptel device file. +.RE + +.SH EXAMPLE + pattest /dev/zap/5 + +.SH BUGS +Will not work with channels whose number > 249 as they don't have device +files. For a simple workaround, see ztdiag.c . + +Gives way too many errors when does not get any input. + +.SH SEE ALSO +patgen(8), ztcfg(8), asterisk(8). + +.SH AUTHOR + +This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> +Permission is granted to copy, distribute and/or modify this document under +the terms of the GNU General Public License, Version 2 any +later version published by the Free Software Foundation. + +On Debian systems, the complete text of the GNU General Public +License can be found in /usr/share/common-licenses/GPL. diff --git a/doc/ztdiag.8 b/doc/ztdiag.8 new file mode 100644 index 0000000..bdcb480 --- /dev/null +++ b/doc/ztdiag.8 @@ -0,0 +1,52 @@ +.TH ztdiag 8 "2008-01-07" +.SH NAME +ztdiag \(em Dump Zaptel channel parameters +.SH SYNOPSIS +.B ztdiag +.I channel + +.SH DESCRIPTION +.B ztdiag +asks the kernel to dump parameters for Zaptel channel no. +.I channel +to the kernel logs. You will be able to see them using, e.g. dmesg(1). + + +.SH OPTIONS +.I channel +.RS +The number of the Zaptel channel whose parammeters should be dumped. +May be any Zaptel channel (even if it is open). +.RE + +.SH EXAMPLE + + # /tmp/ztdiag 5 + # dmesg | tail -n 15 + Dump of Zaptel Channel 5 (XPP_BRI_TE/00/01/1,5,2): + + flags: 501 hex, writechunk: c5190948, readchunk: c5190954 + rxgain: ccad2e80, txgain: ccad2e80, gainalloc: 0 + span: c48a900c, sig: 80 hex, sigcap: 80 hex + inreadbuf: -1, outreadbuf: 0, inwritebuf: 0, outwritebuf: -1 + blocksize: 160, numbufs: 4, txbufpolicy: 0, txbufpolicy: 0 + txdisable: 0, rxdisable: 0, iomask: 0 + curzone: c78e7000, tonezone: 0, curtone: 00000000, tonep: 0 + digitmode: 0, txdialbuf: , dialing: 0, aftdialtimer: 0, cadpos. 0 + confna: 0, confn: 0, confmode: 0, confmute: 0 + ec: 00000000, echocancel: 0, deflaw: 0, xlaw: ccab5e80 + echostate: 00, echotimer: 0, echolastupdate: 0 + itimer: 0, otimer: 0, ringdebtimer: 0 + +.SH SEE ALSO +ztcfg(8), asterisk(8), dmesg(1). + +.SH AUTHOR + +This manual page was written by Tzafrir Cohen <tzafrir.cohen@xorcom.com> +Permission is granted to copy, distribute and/or modify this document under +the terms of the GNU General Public License, Version 2 any +later version published by the Free Software Foundation. + +On Debian systems, the complete text of the GNU General Public +License can be found in /usr/share/common-licenses/GPL. |