Documentation for the kernel part of ISDN4BSD.

XXX - needs some work
This commit is contained in:
martin 2001-01-05 15:43:14 +00:00
parent cbf42ca2d1
commit 295d8f125c
9 changed files with 1063 additions and 0 deletions

101
share/man/man4/daic.4 Normal file
View File

@ -0,0 +1,101 @@
.\" Copyright (c) 1997 Martin Husemann <martin@rumolt.teuto.de>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. The name of the author may not be used to endorse or promote products
.\" derived from this software withough specific prior written permission
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $Id: daic.4,v 1.1.1.1 2001/01/05 15:43:14 martin Exp $
.\"
.\" last edit-date: [Tue Dec 14 22:14:17 1999]
.\"
.\" $FreeBSD$
.\"
.\" -mh writing manual pages
.\"
.\"
.Dd January 30, 1998
.Dt DAIC 4
.Os
.Sh NAME
.Nm daic
.Nd isdn4bsd driver for EICON.Diehl active isdn cards
.Pp
The
.Nm
driver supports the old Diehl active cards:
.Em S, SX, SXn, SCOM
and
.Em QUADRO.
.Sh SYNOPSIS
.Pp
Use a config line like this
.Cd "daic0 at isa? iomem 0xd8000 irq 10"
.Pp
For a
.Em QUADRO
card use the same, the driver will detect the board type and use
all four ports, each attached as a controller of its own to the
ISDN4BSD system, which can be listed using the isdnctl utility.
.Sh DESCRIPTION
The
.Nm
driver interfaces the isdn card to the ISDN4BSD kernel subsystem.
All lower layer isdn control is handled by the card. This should
allow you to run any national isdn protocol delivered by EICON.Diehl
for your card, but the driver has only been tested with the DSS1
protocol and some parts of the cards interface are isdn protocol
dependend.
.Pp
The
.Nm
driver is written to conform to the software interface documented
by Diehl in their
.Nm ISDN-Karten Benutzerhandbuch
from 1992.
.Sh MICROCODE DOWNLOAD
Every active card needs its own operating software before it can
work. You have to download this to the card before using it with
ISDN4BSD. Use the isdnctl utility to do this, i.e. call
.Nm "isdnctl -d te_etsi.sx 1"
to download the file
.Nm te_etsi.sx
to controller number 1. Use
.Nm "isdnctl -l"
to list all available controllers (and ports). You have to select the
correct isdn protocol file for your isdn interface, see the Diehl documentation
for details.
.Pp
The cards bootstrap process involves another file, which is independend
of the card type you use and the protocol you run. It is called
.Nm download.bin
in current versions of the Diehl software distribution and has to be
copied to the kernel compile directory under
.Nm dev/ic/microcode/daic
and converted into a header file used when compiling the kernel by running
.Nm make
in that directory. Your kernel compile will fail and remind you of this
if you forget to do this. Due to copright restrictions we cannot distribute
the driver with this file integrated. But if you own a card, you do have
the file (or can get it from the Diehl web server).
.Sh BUGS
The driver is not yet finished. It will only compile on NetBSD and
even there will not work. This should be fixed soon and the driver
will be ported to FreeBSD.
.Sh SEE ALSO
.Xr isdnctl 1

111
share/man/man4/i4b.4 Normal file
View File

@ -0,0 +1,111 @@
.\"
.\" Copyright (c) 1997, 1999 Hellmuth Michaelis. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: i4b.4,v 1.1.1.1 2001/01/05 15:43:14 martin Exp $
.\"
.\" $FreeBSD$
.\"
.\" last edit-date: [Mon Dec 13 23:09:12 1999]
.\"
.Dd February 3, 1998
.Dt I4B 4
.Os
.Sh NAME
.Nm i4b
.Nd isdn4bsd call control ISDN driver
.Sh FreeBSD SYNOPSIS
.Cd pseudo-device \&"i4b\&"
.Sh NetBSD SYNOPSIS
none
.Sh DESCRIPTION
The
.Nm
device driver is used by the
.Xr isdnd 8
daemon to exchange messages with the isdn4bsd kernel part for the purpose
of call establishment, control and disconnection and to access various
control and status informations.
.Pp
The messages and message parameters are documented in the include
file
.Em /usr/include/machine/i4b_ioctl.h .
.Pp
The available ioctl's are:
.Pp
.Bl -tag -width Ds -compact -offset indent
.It Ar I4B_CDID_REQ
Request a unique Call Description IDentifier (cdid) which identifies
uniquely a single interaction of the local D channel with the exchange.
.It Ar I4B_CONNECT_REQ
Actively request a call setup to a remote ISDN subscriber.
.It Ar I4B_CONNECT_RESP
Respond to an incoming call, either accept, reject or ignore it.
.It Ar I4B_DISCONNECT_REQ
Actively terminate a connection.
.It Ar I4B_CTRL_INFO_REQ
Request information about an installed ISDN controller card.
.It Ar I4B_DIALOUT_RESP
Give information about call setup to driver who requested dialing out.
.It Ar I4B_TIMEOUT_UPD
Update the kernels timeout value(s) in case of dynamically calculated
shorthold mode timing changes.
.It Ar I4B_UPDOWN_IND
Inform the kernel userland drivers about interface soft up/down status
changes.
.It Ar I4B_CTRL_DOWNLOAD
Download firmware to active card(s).
.It Ar I4B_ACTIVE_DIAGNOSTIC
Return diagnostic information from active cards.
.El
.Pp
Status and event messages available from the kernel are:
.Pp
.Bl -tag -width Ds -compact -offset indent
.It Ar MSG_CONNECT_IND
An incoming call from a remote ISDN user is indicated.
.It Ar MSG_CONNECT_ACTIVE_IND
After an incoming call has been accepted locally or an outgoing call has
been accepted by a remote, the exchange signaled an active connection
and the corresponding B-channel is switched through.
.It Ar MSG_DISCONNECT_IND
A call was terminated.
.It Ar MSG_DIALOUT_IND
A userland interface driver requests the daemon to dial out (typically a
network interface when a packet arrives in its send queue).
.It Ar MSG_IDLE_TIMEOUT_IND
A call was terminated by the isdn4bsd kernel driver because a B-channel
idle timeout occurred.
.It Ar MSG_ACCT_IND
Accounting information from a network driver.
.It Ar MSG_CHARGING_IND
Charging information from the kernel.
.El
.Pp
.Sh SEE ALSO
.Xr isdnd 8
.Sh AUTHOR
The
.Nm
device driver and this manpage were written by
.An Hellmuth Michaelis Aq hm@kts.org .

53
share/man/man4/i4bctl.4 Normal file
View File

@ -0,0 +1,53 @@
.\"
.\" Copyright (c) 1997, 1999 Hellmuth Michaelis. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: i4bctl.4,v 1.1.1.1 2001/01/05 15:43:14 martin Exp $
.\"
.\" $FreeBSD$
.\"
.\" last edit-date: [Mon Dec 13 23:09:46 1999]
.\"
.Dd February 3, 1998
.Dt I4BCTL 4
.Os
.Sh NAME
.Nm i4bctl
.Nd control device for the isdn4bsd kernel part
.Sh FreeBSD SYNOPSIS
.Cd pseudo-device \&"i4bctl\&"
.Sh NetBSD SYNOPSIS
none
.Sh DESCRIPTION
.Nm
is used by the
.Xr isdndebug 8
utility to get and set the current debugging level and other information
of the isdn4bsd package kernel ISDN handling layers.
.Sh SEE ALSO
.Xr isdndebug 8
.Sh AUTHOR
The
.Nm
device driver and this manpage were written by
.An Hellmuth Michaelis Aq hm@kts.org .

101
share/man/man4/i4bipr.4 Normal file
View File

@ -0,0 +1,101 @@
.\"
.\" Copyright (c) 1997, 1999 Hellmuth Michaelis. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: i4bipr.4,v 1.1.1.1 2001/01/05 15:43:17 martin Exp $
.\"
.\" $FreeBSD$
.\"
.\" last edit-date: [Mon Dec 13 23:10:25 1999]
.\"
.Dd July 6, 1998
.Dt I4BIPR 4
.Os
.Sh NAME
.Nm i4bipr
.Nd isdn4bsd IP over ISDN B-channel network driver
.Sh FreeBSD SYNOPSIS
.Cd pseudo-device \&"i4bipr\&" Op count
.Sh NetBSD SYNOPSIS
none
.Sh DESCRIPTION
The
.Nm
driver interfaces the IP subsystem of the operating system with the
isdn4bsd package so that transport of IP packets over an ISDN link
is possible.
.Pp
The driver just packs IP packets without anything appended or prepended
into raw HDLC packets on the B channel and transfers them to a remote site.
IP packets received from the remote site are queued into the local IP
protocol stack.
.Pp
The format of the resulting packet on the B channel is:
.Pp
.Dl (HDLC opening flag) (IP-packet) (CRC) (HDLC closing flag)
.Pp
In the case where an IP packet for a remote site arrives in the driver and no
connection has been established yet, the driver communicates with the
.Xr isdnd 8
daemon to establish a connection.
.Pp
The driver has support for interfacing to the
.Xr bpf 4
subsystem for using
.Xr tcpdump 1
with the
.Nm ipr
interfaces.
.Pp
The driver optionally (when compiled with the IPR_VJ option) provides Van
Jacobsen header compression, under control of the link0 and link1 options to
.Xr ifconfig 8
:
.Pp
.Bl -tag -width 15n -offset indent -compact
.It link0
Apply VJ compression to outgoing packets on this interface, and assume that
incoming packets require decompression.
.It link1
Check incoming packets for Van Jacobsen compression; if they appear to be
compressed, automatically set link0.
.El
.Pp
The default values are
.Em on
for
.Em link1
and
.Em off
for
.Em link0 .
.Sh SEE ALSO
.Xr isdnd 8
.Xr isdnd.rc 5
.Xr bpf 4
.Xr tcpdump 1
.Sh AUTHOR
The
.Nm
device driver and this manpage were written by
.An Hellmuth Michaelis Aq hm@kts.org .

129
share/man/man4/i4bisp.4 Normal file
View File

@ -0,0 +1,129 @@
.\"
.\" Copyright (c) 1997, 2000 Hellmuth Michaelis. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: i4bisp.4,v 1.1.1.1 2001/01/05 15:43:17 martin Exp $
.\"
.\" $FreeBSD$
.\"
.\" last edit-date: [Thu Aug 31 10:40:17 2000]
.\"
.Dd August 31, 2000
.Dt I4BISPPP 4
.Os
.Sh NAME
.Nm i4bisppp
.Nd isdn4bsd synchronous PPP over ISDN B-channel network driver
.Sh FreeBSD SYNOPSIS
.Cd pseudo-device \&"i4bisppp\&" Op count
.Sh NetBSD SYNOPSIS
none
.Sh DESCRIPTION
The
.Nm
driver interfaces the IP subsystem of the operating system with the
isdn4bsd package so that a transport of IP packets over an ISDN link
is possible.
.Pp
The driver is just a glue layer between Serge Vakulenko's sppp
backend and the ISDN4BSD package.
.Pp
Beginning with i4b version 0.95 (and only for FreeBSD), the sppp
subsystem was integrated into the
.Nm
driver to support more i4b/ISDN specific options. As a consequence it is no
longer necessary to add a "options sppp" to your kernel
.Xr config 8
file. For configuration of the i4bsppp driver, either the
.Xr ispppcontrol 8
utility is used or it is configured via
.Xr isdnd 1
and its associated
.Xr isdnd.rc 5
file.
.Pp
In case an IP packet for a remote side arrives in the driver and no
connection is established yet, the driver communicates with the
.Xr isdnd 8
daemon to establish a connection.
.Pp
The driver has support for interfacing to the
.Xr bpf 4
subsystem for using
.Xr tcpdump 1
with the
.Nm isp
interfaces.
.Pp
The
.Xr ispppcontrol 8
utility is used to configure all aspects of PPP required to connect to a
remote site.
.Sh LINK0 and LINK1
The
.Em link0
and
.Em link1
flags given as parameters to
.Xr ifconfig 8
have the following meaning for the
.Nm isp
devices:
.Bl -tag -width link0 -compact
.Pp
.It Li link0
wait passively for connection
.Pp
.It Li link1
auto-dial on output
.El
.Pp
The
.Em link0
and
.Em link1
flags are set to
.Em off
by default.
.Pp
See
.Xr sppp 4
for a more detailed discussion of the flags,
.Pp
.Sh SEE ALSO
.Xr isdnd 8
.Xr isdnd.rc 5
.Xr ispppcontrol 8
.Xr sppp 4
.Xr bpf 4
.Xr tcpdump 1
.Sh AUTHOR
The
.Nm
device driver was written by
.An Joerg Wunsch Aq joerg@freebsd.org
and then added to ISDN4BSD by
.An Gary Jennejohn Aq gary@freebsd.org .
.Pp
This manpage was written by
.An Hellmuth Michaelis Aq hm@kts.org .

53
share/man/man4/i4brbch.4 Normal file
View File

@ -0,0 +1,53 @@
.\"
.\" Copyright (c) 1997, 1999 Hellmuth Michaelis. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: i4brbch.4,v 1.1.1.1 2001/01/05 15:43:17 martin Exp $
.\"
.\" $FreeBSD$
.\"
.\" last edit-date: [Mon Dec 13 23:13:04 1999]
.\"
.Dd February 3, 1998
.Dt I4BRBCH 4
.Os
.Sh NAME
.Nm i4brbch
.Nd isdn4bsd ISDN Raw B-CHannel access driver
.Sh FreeBSD SYNOPSIS
.Cd pseudo-device \&"i4brbch\&" Op count
.Sh NetBSD SYNOPSIS
none
.Sh DESCRIPTION
The
.Nm
driver provides an interface to the raw untranslated B-channel. It is
part of the isdn4bsd package.
.Sh SEE ALSO
.Xr isdnd 8
.Xr isdnd.rc 5
.Sh AUTHOR
The
.Nm
device driver and this manpage were written by
.An Hellmuth Michaelis Aq hm@kts.org .

136
share/man/man4/i4btel.4 Normal file
View File

@ -0,0 +1,136 @@
.\"
.\" Copyright (c) 1997, 1999 Hellmuth Michaelis. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: i4btel.4,v 1.1.1.1 2001/01/05 15:43:17 martin Exp $
.\"
.\" $FreeBSD$
.\"
.\" last edit-date: [Mon Dec 13 23:13:39 1999]
.\"
.Dd April 21, 1999
.Dt I4BTEL 4
.Os
.Sh NAME
.Nm i4btel
.Nd isdn4bsd ISDN B-channel telephony interface driver
.Sh FreeBSD SYNOPSIS
.Cd pseudo-device \&"i4btel\&" Op count
.Sh NetBSD SYNOPSIS
none
.Sh DESCRIPTION
The
.Nm
driver provides an interface to the B-channel for telephony applications
and is currently used by the
.Xr isdnd 8
for answering machine support. The driver is part of the isdn4bsd package.
.Pp
The lower six bits of the drivers's minor number is used to specify a
unit number, wheras the upper two bits specify a functionality.
.Pp
Functionality zero is the usual telephony data stream i/o driver.
.Pp
Functionality one is used to enable commands to dial out and hang up and
receive responses about the state of the dial out progress and status.
This commands may change in the future, for details see the file
.Em i4b_tel_ioctl.h
and the
.Xr isdnphone 1
utility.
.Pp
The telephony data stream comes out of the line in a bit-reversed format,
so the
.Nm
driver does the bit-reversion process in any case.
.Pp
Additionally, the user can specify to do A-law to u-law, u-law to A-law
or no conversion at all in the i4btel driver by using the
.Xr isdntelctl 8
utility.
.Pp
The driver is able to process several ioctl's:
.Pp
.Bl -tag -width Ds -compact -offset indent
.It Ar I4B_TEL_GETAUDIOFMT
get currently used audio format conversion.
.It Ar I4B_TEL_SETAUDIOFMT
set currently used audio format conversion.
.It Ar I4B_TEL_EMPTYINPUTQUEUE
clear the input queue.
.El
.Pp
For the I4B_TEL_GETAUDIOFMT and I4B_TEL_SETAUDIOFMT, the following
parameters are available:
.Pp
.Bl -tag -width Ds -compact -offset indent
.It Ar CVT_NONE
do no A-law/u-law audio format conversion. The conversion path looks like
this:
.Pp
USER <--> bitreversing <--> ISDN-line
.Pp
.It Ar CVT_ALAW2ULAW
set set audio format conversion to do an audio conversion from A-law
(on the ISDN line) to u-law (in the userland).
The
.Xr read 2
conversion path looks like this:
.Pp
USER <-- u-law/A-law <-- bitreversing <-- ISDN-line
.Pp
and the
.Xr write 2
conversion path looks like this:
.Pp
USER --> u-law/A-law --> bitreversing --> ISDN-line
.Pp
.It Ar CVT_ULAW2ALAW
set set audio format conversion to do an audio conversion from u-law
(on the ISDN line) to A-law (in the userland).
The
.Xr read 2
conversion path looks like this:
.Pp
USER <-- A-law/u-law <-- bitreversing <-- ISDN-line
.Pp
and the
.Xr write 2
conversion path looks like this:
.Pp
USER --> A-law/u-law --> bitreversing --> ISDN-line
.Pp
.El
.Sh STANDARDS
A-Law and u-Law are specified in ITU Recommendation G.711.
.Sh SEE ALSO
.Xr isdntelctl 8
.Xr g711conv 1
.Xr isdnphone 1
.Xr isdnd 8
.Xr isdnd.rc 5
.Sh AUTHOR
The
.Nm
device driver and this manpage were written by
.An Hellmuth Michaelis Aq hm@kts.org .

55
share/man/man4/i4btrc.4 Normal file
View File

@ -0,0 +1,55 @@
.\"
.\" Copyright (c) 1997, 1999 Hellmuth Michaelis. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: i4btrc.4,v 1.1.1.1 2001/01/05 15:43:17 martin Exp $
.\"
.\" $FreeBSD$
.\"
.\" last edit-date: [Mon Dec 13 23:14:19 1999]
.\"
.Dd July 30, 1999
.Dt I4BTRC 4
.Os
.Sh NAME
.Nm i4btrc
.Nd isdn4bsd ISDN interface driver for D and B channel tracing
.Sh FreeBSD SYNOPSIS
.Cd pseudo-device \&"i4btrc\&" Op count
.Sh NetBSD SYNOPSIS
none
.Sh DESCRIPTION
The
.Nm
driver is used to add a header to the data got from the D and/or B channel
and queues it to be read and further processed by the
.Xr isdntrace 8
utility.
.Sh SEE ALSO
.Xr isdnd 8
.Xr isdntrace 8
.Sh AUTHOR
The
.Nm
device driver and this manpage were written by
.An Hellmuth Michaelis Aq hm@kts.org .

324
share/man/man4/isic.4 Normal file
View File

@ -0,0 +1,324 @@
.\"
.\" Copyright (c) 1997, 2000 Hellmuth Michaelis. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: isic.4,v 1.1.1.1 2001/01/05 15:43:18 martin Exp $
.\"
.\" $FreeBSD$
.\"
.\" last edit-date: [Thu Mar 16 16:21:45 2000]
.\"
.Dd March 16, 2000
.Dt ISIC 4
.Os
.Sh NAME
.Nm isic
.Nd isdn4bsd Siemens ISDN Chipset device driver
.Sh SYNOPSIS
On the ISA bus:
.Pp
Teles S0/8 or Niccy 1008 card:
.Cd options \&"ISICISA_TEL_S0_8\&"
.Cd "isic0 at isa? iomem 0xd0000 irq 5"
.Pp
Teles S0/16 or Creatix ISDN-S0 or Niccy 1016 card:
.Cd options \&"ISICISA_TEL_S0_16\&"
.Cd "isic0 at isa? port 0xd80 iomem 0xd0000 irq 5"
.Pp
Teles S0/16.3 card:
.Cd options \&"ISICISA_TEL_S0_16_3\&"
.Cd "isic0 at isa? port 0xd80 irq 5"
.Pp
AVM A1 or AVM Fritz card:
.Cd options \&"ISICISA_AVM_A1\&"
.Cd "isic0 at isa? port 0x340 irq 5"
.Pp
USRobotics Sportster ISDN TA internal or Stollmann Tina-pp card:
.Cd options \&"ISICISA_USR_STI\&"
.Cd "isic0 at isa? port 0x268 irq 5"
.Pp
ITK ix1 micro card:
.Cd options \&"ISICISA_ITKIX1\&"
.Cd "isic0 at isa? port 0x398 irq 10"
.Pp
On the ISAPNP bus:
.Pp
Teles S0/16.3 PnP card
.Cd options \&"ISICPNP_TEL_S0_16_3_P\&"
.Cd "isic* at isapnp?"
.Pp
Creatix ISDN-S0 P&P card
.Cd options \&"ISICPNP_CRTX_S0_P\&"
.Cd "isic* at isapnp?"
.Pp
Dr. Neuhaus Niccy GO@
.Cd options \&"ISICPNP_DRN_NGO\&"
.Cd "isic* at isapnp?"
.Pp
ELSA QuickStep 1000pro (ISA version):
.Cd options \&"ISICPNP_ELSA_QS1ISA\&"
.Cd "isic* at isapnp?"
.Pp
Sedlbauer WinSpeed:
.Cd options \&"ISICPNP_SEDLBAUER\&"
.Cd "isic* at isapnp?"
.Pp
Dynalink IS64PH:
.Cd options \&"ISICPNP_DYNALINK\&"
.Cd "isic* at isapnp?"
.Pp
Cards on the PCI bus:
.Pp
ELSA QuickStep 1000pro (PCI version)
.Cd options \&"ISICPCI_ELSA_QS1PCI\&"
.Cd "isic* at pci?"
.Pp
Cards on the PCMCIA or PCCARD bus:
.Pp
AVM Fritz!Card PCMCIA
.Cd options \&"ISICPCMCIA_AVM_A1\&"
.Cd "isic* at pcmcia? function ?"
.Pp
ELSA MicroLink ISDN/MC
.Cd options \&"ISICPCMCIA_ELSA_ISDNMC\&"
.Cd "isic* at pcmcia? function ?"
.Pp
ELSA MicroLink MC/all
.Cd options \&"ICISPCMCIA_ELSA_MCALL\&"
.Cd "isic* at pcmcia? function ?"
.Pp
Cards on the Amiga Zorro bus:
.Pp
BSC/ITH ISDN Master, ITH ISDN MasterII or VMC ISDN Blaster
.Cd "aster* at zbus?"
.Cd "isic* at aster? port ?"
.Pp
.Sh DESCRIPTION
The
.Nm
driver provides D-channel layer 1 supports as specified in ITU Recommendation
I.430 and layer 1 support for the B-channel.
.Pp
The driver supports several 8 and 16bit passive ISDN cards from various
manufacturers which are all based upon the popular Siemens ISDN chipset
consisting of the ISDN Subscriber Access Controller ISAC (such as the
PEB2085 or PSB 2186) and the High-Level Serial Communications Controller
Extended HSCX (such as the SAB82525 or PSB21525). The newer IPAC chip
(which integrates an ISAC and a HSCX in one chip, with the added benefit
of larger FIFO buffers) is also supported.
.Pp
.Sh SUPPORTED CARDS
.Pp
.Bl -tag -width Ds -compact
.It Ar Teles S0/8, Dr. Neuhaus Niccy 1008, Creatix ISDN-S0/8
.Pp
The required (optional for NetBSD)
.Em flag
value is 1.
.Pp
Notice that this cards must not have a
.Em port
value in the config line.
.Pp
Valid interrupts are 2, 3, 4, 5, 6 and 7.
.Pp
The i/o ports are memory mapped and the memory start address may
be in the range 0xA0000 to 0xDF000 and uses 4kB of memory.
.Pp
.It Ar Teles S0/16, Creatix ISDN-S0, Dr. Neuhaus Niccy 1016
.Pp
The required (optional under NetBSD)
.Em flag
value is 2.
.Pp
These boards have a jumper which specifies an i/o base address of either
0xd80, 0xe80 or 0xf80. The remaining necessary configuration values are then
programmed at run time by accessing this i/o port.
.Pp
Valid interrupts are 2, 3, 4, 5, 10, 11, 12 or 15.
.Pp
Valid memory start
addresses are 0xC0000, 0xC2000, 0xC4000, 0xC6000, 0xC8000, 0xCA000, 0xCC000,
0xCE000, 0xD0000, 0xD2000, 0xD4000, 0xD6000, 0xD8000, 0xDA000, 0xDC000 and
0xDE000.
.Pp
Notice: Although the Jumpers are labeled 0xd80, 0xe80 or 0xf80, they
also require i/o space at addresses 0x180, 0x280 or 0x380.
.Pp
.It Ar Teles S0/16.3
.Pp
The required (optional under NetBSD)
.Em flag
value is 3.
.Pp
This card is completely i/o mapped and must not have an
.Em iomem
statement in the config line.
.Pp
Valid interrupts are 2, 5, 9, 10, 12 or 15.
.Pp
Notice: Although the switch positions are labeled 0x180, 0x280 and 0x380,
the card is to be configured at 0xd80, 0xe80 or 0xf80 respectively!
.Pp
.It Ar AVM A1, AVM Fritz!Card
.Pp
The required (optional under NetBSD)
.Em flag
value is 4.
.Pp
These boards have a jumper which specifies an i/o base address of either
0x200, 0x240, 0x300 or 0x340.
.Pp
Valid interrupt configurations are 3, 4, 5, 6, 7, 10, 11, 12 or 15.
.Pp
Older Versions of the AVM A1 also require setting of an IRQ jumper, newer
versions of this and the Fritz!Card only have an i/o base jumper and the
interrupt is setup at runtime by reprogramming a register.
.Pp
This card is completely i/o mapped and must not have an
.Em iomem
statement in the config line.
.Pp
.It Ar Teles S0/16.3 PnP
.Pp
Possible i/o port values are 0x580, 0x500 and 0x680.
Possible interrupt configurations are 3, 5, 7, 10, 11 and 12.
.Pp
The the card is auto-configured by the PnP kernel subsystem.
.Pp
.It Ar Creatix ISDN-S0 P&P
.Pp
Valid i/o port values are 0x120, 0x180 and 0x100.
.Pp
Valid interrupt configurations are 3, 5, 7, 10, 11 and 12.
.Pp
The card is auto-configured by the PnP kernel subsystem.
.Pp
.It Ar "3Com USRobotics Sportster ISDN TA intern and Stollmann Tina pp"
.Pp
The required (optional for NetBSD)
.Em flag
value is 7.
.Pp
Valid i/o port values are 0x200, 0x208, 0x210, 0x218, 0x220, 0x228, 0x230,
0x238, 0x240, 0x248, 0x250, 0x258, 0x260, 0x268, 0x270 and 0x278.
.Pp
Valid interrupt configurations are 5, 7, 10, 11, 12, 14, 15.
.Pp
Notice: this card has a strange address decoding scheme resulting in 64
windows of some bytes length. Anyway, support for this card is good because
the manufacturer gave out technical docs for this card!
.Pp
.Pp
.It Ar "Dr. Neuhaus Niccy Go@"
.Pp
Valid i/o port values must be in the range 0x200 ... 0x3e0.
.Pp
Valid interrupt configurations are 3, 4, 5, 9, 10, 11, 12, 15.
.Pp
The card is auto-configured by the PnP kernel subsystem.
.Pp
.It Ar "Sedlbauer Win Speed"
.Pp
Valid i/o port values must be in the range 0x100 ... 0x3f0. (alignment 0x8,
len 0x8)
.Pp
Valid interrupt configurations are 3, 4, 5, 7, 10, 11, 12, 13, 15.
.Pp
The card is auto-configured by the PnP kernel subsystem.
.Pp
.It Ar "ELSA QuickStep 1000pro (ISA)"
.Pp
I/O port in the range 0x160 ... 0x360 (occupies 8 bytes).
.Pp
Valid interrupt configurations are 3, 4, 5, 7, 10, 11, 12, 15.
.Pp
The card is auto-configured by the PnP kernel subsystem.
.Pp
.Pp
.It Ar "ELSA QuickStep 1000pro-PCI"
.Pp
The card is auto-configured by the PCI kernel subsystem.
.Pp
.Pp
.It Ar "ITK ix1 micro"
.Pp
The required (optional under NetBSD)
.Em flag
value is 18.
.Pp
Valid i/o port values must be in the range (<unknown>).
.Pp
Valid interrupt configurations are (<unknown>).
.Pp
.It Ar "BSC ISDN Master"
.It Ar "ITH ISDN MasterII"
.It Ar "VMC ISDN Blaster"
.Pp
The card addresses are auto-configured by the Zorro bus kernel subsystem.
The ISDN functions of the boards are at known (to the driver) relative
addresses.
.Pp
Note that currently, you have to jumper the card interupt for
.Em IPL 2
instead of IPL 6 (which is used by most AmigaOS software).
.Pp
Note that the ITH ISDN MasterII doesn't work in the DraCo Zorro bus. This
is no NetBSD problem, but general.
.El
.Pp
.Sh CAVEATS
Note that all of the boards with I/O ports actually use several ranges
of port addresses; Teles happen to refer to the 0xd80 range in their
documentation (the board also uses 0x180 etc.), while AVM happen to refer
to the 0x200 range in their documentation (the board also uses 0x600 etc.)
The driver matches the manufacturers' description for the purposes of
configuration, but of course makes use of all the ports in order to
operate the card.
.Pp
.Sh BUGS
Since there is no hardware documentation available from several manufacturers
for their boards, it is likely that there are many, many bugs left.
.Sh STANDARDS
CCITT Recommendation I.430
.Sh SEE ALSO
.Xr isdn 8
.Sh AUTHOR
The
.Nm
driver and this manpage were written by
.An Hellmuth Michaelis Aq hm@kts.org .
It is based on earlier work of
.An Arne Helme ,
.An Andrew Gordon
and
.An Gary Jennejohn .
.Pp
The complete porting to and maintenance of NetBSD was done by
.An Martin Husemann Aq martin@netbsd.de .
.Pp
The NetBSD/Amiga ISDN Blaster/Master/MasterII driver was written by
.An Ignatios Souvatzis Aq is@netbsd.org .