isdn4k-utils/hisax/hisaxctrl.man.in

158 lines
3.5 KiB
Groff

.\" Process this file with
.\" groff -man -Tascii hisaxctrl.1 for ASCII output, or
.\" groff -man -Tps hisaxctrl.1 for PostScript output
.\"
.TH HISAXCTRL 8 "August 2001" isdn4k-utils-@I4LVERSION@ "Linux System Administration"
.SH NAME
hisaxctrl \- configure HiSax-Module
.SH SYNOPSIS
.B hisaxctrl
.I DriverId command parameters
.SH DESCRIPTION
.B hisaxctrl
is used to setup the HiSax-ISDN device driver.
All logging-output is sent to the device /dev/isdnctrl. So you can show it
by executing
.BR "cat /dev/isdnctrl" .
.br
.B NOTE:
for
.I devfs
systems, the program will automatically use /dev/isdn/isdnctrl if available.
.LP
The use of
.I hisaxctrl
only makes sense if you are using the HiSax driver.
.LP
.SH OPTIONS
.TP
.I DriverId
is used to identify the card when using more than one passive card. While
loading the hisax module with
.IR insmod ", or " modprobe
the DriverId is set by appending
.BI id= idstring1 % idstring2 %...
to the commandline.
.LP
.TP
.I command
is an integer selecting the setup category. The following values are
defined for setting the logging-level of the HiSax-ISDN device driver:
.LP
.RS
.BR " 0" " reports card status infos."
.br
.BR " 1" " selects generic debugging."
.br
.BR 11 " selects layer 1 development debugging."
.br
.BR 13 " selects layer 3 development debugging."
.br
.RE
.LP
the following commands are used to enable special features during runtime
of the HiSax-ISDN device driver.
.LP
.RS
.BR " 2" " set B-channel ON delay to parameter (in ms)"
.br
.BR " 5" " set B-channel in leased mode"
.br
.BR " 6" " set B-channel in TESTLOOP mode"
.br
.BR " 7" " set/reset card in Point To Point mode"
.br
.BR " 8" " set card in FIXED TEI mode "
.br
.BR " 9" " load firmware for DSP cards"
.br
.BR "10" " set B-channel usage limit to 1 or 2 channels"
.br
.BR "12" " set echo logging mode (only for some cards)"
.br
.BR " " " B-channel usage limit needs to be 1 if enabled"
.br
.RE
.TP
.I parameter
If the command is
.BR 9
then the parameter is the full pathname to the file containing the firmware.
For debug settings this is an integer representing a bitmask. Every bit in
this mask switches a debug facility on or off. Depending on the selected
category, the following values are defined:
.LP
.RS
.RB With " generic debugging " selected
.br
(command \fB1\fR):
.LP
.BR 0x001 " Link-level <--> hardware-level communication"
.br
.BR 0x002 " Top state machine"
.br
.BR 0x004 " D-Channel Q.931 (call control messages)"
.br
.BR 0x008 " D-Channel Q.921"
.br
.BR 0x010 " B-Channel X.75"
.br
.BR 0x020 " D-Channel l2"
.br
.BR 0x040 " B-Channel l2"
.br
.BR 0x080 " D-Channel link state debugging"
.br
.BR 0x100 " B-Channel link state debugging"
.br
.BR 0x200 " TEI debug"
.br
.BR 0x400 " LOCK debug in callc.c"
.br
.BR 0x800 " More debug in callc.c (not for normal use)"
.br
.LP
.RB With " layer 1 development debugging " selected
.br
(command \fB11\fR):
.LP
.BR 0x001 " Warnings (default: on)"
.br
.BR 0x002 " IRQ status"
.br
.BR 0x004 " ISAC"
.br
.BR 0x008 " ISAC FIFO"
.br
.BR 0x010 " HSCX"
.br
.BR 0x020 " HSCX FIFO (attention: full B-Channel output!)"
.br
.BR 0x040 " D-Channel LAPD frame types"
.br
.LP
.RB With " layer 3 development debugging " selected
.br
(command \fB13\fR):
.LP
.BR 0x001 " Warnings (default: on)"
.br
.BR 0x002 " l3 protocol discriptor errors"
.br
.BR 0x004 " l3 state machine"
.br
.BR 0x008 " charge info debugging (1TR6)"
.br
.RE
.LP
.SH EXAMPLE
.TP
.BI hisaxctrl " HiSax 1 0x3ff"
enables full generic debugging.
.SH AUTHOR
\(co 2000 by Karsten Keil <kkeil@suse.de>
.LP
.SH SEE ALSO
.BR isdnctrl "(8), " isdn_cause "(7), " isdninfo (4).