- Uniformly use .In for header file references.
[dragonfly.git] / usr.sbin / i4b / man / i4b.4
CommitLineData
984263bc
MD
1.\"
2.\" Copyright (c) 1997, 1999 Hellmuth Michaelis. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $Id: i4b.4,v 1.9 1999/12/13 22:11:55 hm Exp $
26.\"
27.\" $FreeBSD: src/usr.sbin/i4b/man/i4b.4,v 1.7.2.4 2001/08/01 17:45:09 obrien Exp $
44cb301e 28.\" $DragonFly: src/usr.sbin/i4b/man/i4b.4,v 1.3 2006/05/26 19:39:40 swildner Exp $
984263bc
MD
29.\"
30.\" last edit-date: [Mon Dec 13 23:09:12 1999]
31.\"
32.Dd February 3, 1998
33.Dt I4B 4
34.Os
35.Sh NAME
36.Nm i4b
37.Nd isdn4bsd call control ISDN driver
38.Sh FreeBSD SYNOPSIS
39.Cd pseudo-device \&"i4b\&"
40.Sh NetBSD SYNOPSIS
41none
42.Sh DESCRIPTION
43The
44.Nm
45device driver is used by the
46.Xr isdnd 8
47daemon to exchange messages with the isdn4bsd kernel part for the purpose
48of call establishment, control and disconnection and to access various
49control and status informations.
50.Pp
51The messages and message parameters are documented in the include
52file
44cb301e 53.In i4b_machine/i4b_ioctl.h .
984263bc
MD
54.Pp
55The available ioctl's are:
56.Pp
57.Bl -tag -width Ds -compact -offset indent
58.It Ar I4B_CDID_REQ
59Request a unique Call Description IDentifier (cdid) which identifies
60uniquely a single interaction of the local D channel with the exchange.
61.It Ar I4B_CONNECT_REQ
62Actively request a call setup to a remote ISDN subscriber.
63.It Ar I4B_CONNECT_RESP
64Respond to an incoming call, either accept, reject or ignore it.
65.It Ar I4B_DISCONNECT_REQ
66Actively terminate a connection.
67.It Ar I4B_CTRL_INFO_REQ
68Request information about an installed ISDN controller card.
69.It Ar I4B_DIALOUT_RESP
70Give information about call setup to driver who requested dialing out.
71.It Ar I4B_TIMEOUT_UPD
72Update the kernels timeout value(s) in case of dynamically calculated
73shorthold mode timing changes.
74.It Ar I4B_UPDOWN_IND
75Inform the kernel userland drivers about interface soft up/down status
76changes.
77.It Ar I4B_CTRL_DOWNLOAD
78Download firmware to active card(s).
79.It Ar I4B_ACTIVE_DIAGNOSTIC
80Return diagnostic information from active cards.
81.El
82.Pp
83Status and event messages available from the kernel are:
84.Pp
85.Bl -tag -width Ds -compact -offset indent
86.It Ar MSG_CONNECT_IND
87An incoming call from a remote ISDN user is indicated.
88.It Ar MSG_CONNECT_ACTIVE_IND
89After an incoming call has been accepted locally or an outgoing call has
90been accepted by a remote, the exchange signaled an active connection
91and the corresponding B-channel is switched through.
92.It Ar MSG_DISCONNECT_IND
93A call was terminated.
94.It Ar MSG_DIALOUT_IND
95A userland interface driver requests the daemon to dial out (typically a
96network interface when a packet arrives in its send queue).
97.It Ar MSG_IDLE_TIMEOUT_IND
98A call was terminated by the isdn4bsd kernel driver because a B-channel
99idle timeout occurred.
100.It Ar MSG_ACCT_IND
101Accounting information from a network driver.
102.It Ar MSG_CHARGING_IND
103Charging information from the kernel.
104.El
105.Sh SEE ALSO
106.Xr isdnd 8
107.Sh AUTHORS
108The
109.Nm
110device driver and this manpage were written by
111.An Hellmuth Michaelis Aq hm@kts.org .