usr.sbin/i4b/man/i4b.4

   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 $
  28 .\" $DragonFly: src/usr.sbin/i4b/man/i4b.4,v 1.5 2007/08/08 01:43:37 swildner Exp $
  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 SYNOPSIS
  39 .Cd pseudo-device \&"i4b\&"
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 device driver is used by the
  44 .Xr isdnd 8
  45 daemon to exchange messages with the isdn4bsd kernel part for the purpose
  46 of call establishment, control and disconnection and to access various
  47 control and status information.
  48 .Pp
  49 The messages and message parameters are documented in the include
  50 file
  51 .In i4b_machine/i4b_ioctl.h .
  52 .Pp
  53 The available ioctl's are:
  54 .Pp
  55 .Bl -tag -width Ds -compact -offset indent
  56 .It Dv I4B_CDID_REQ
  57 Request a unique Call Description IDentifier (cdid) which identifies
  58 uniquely a single interaction of the local D channel with the exchange.
  59 .It Dv I4B_CONNECT_REQ
  60 Actively request a call setup to a remote ISDN subscriber.
  61 .It Dv I4B_CONNECT_RESP
  62 Respond to an incoming call, either accept, reject or ignore it.
  63 .It Dv I4B_DISCONNECT_REQ
  64 Actively terminate a connection.
  65 .It Dv I4B_CTRL_INFO_REQ
  66 Request information about an installed ISDN controller card.
  67 .It Dv I4B_DIALOUT_RESP
  68 Give information about call setup to driver who requested dialing out.
  69 .It Dv I4B_TIMEOUT_UPD
  70 Update the kernels timeout value(s) in case of dynamically calculated
  71 shorthold mode timing changes.
  72 .It Dv I4B_UPDOWN_IND
  73 Inform the kernel userland drivers about interface soft up/down status
  74 changes.
  75 .It Dv I4B_CTRL_DOWNLOAD
  76 Download firmware to active card(s).
  77 .It Dv I4B_ACTIVE_DIAGNOSTIC
  78 Return diagnostic information from active cards.
  79 .El
  80 .Pp
  81 Status and event messages available from the kernel are:
  82 .Pp
  83 .Bl -tag -width Ds -compact -offset indent
  84 .It Ar MSG_CONNECT_IND
  85 An incoming call from a remote ISDN user is indicated.
  86 .It Ar MSG_CONNECT_ACTIVE_IND
  87 After an incoming call has been accepted locally or an outgoing call has
  88 been accepted by a remote, the exchange signaled an active connection
  89 and the corresponding B-channel is switched through.
  90 .It Ar MSG_DISCONNECT_IND
  91 A call was terminated.
  92 .It Ar MSG_DIALOUT_IND
  93 A userland interface driver requests the daemon to dial out (typically a
  94 network interface when a packet arrives in its send queue).
  95 .It Ar MSG_IDLE_TIMEOUT_IND
  96 A call was terminated by the isdn4bsd kernel driver because a B-channel
  97 idle timeout occurred.
  98 .It Ar MSG_ACCT_IND
  99 Accounting information from a network driver.
 100 .It Ar MSG_CHARGING_IND
 101 Charging information from the kernel.
 102 .El
 103 .Sh SEE ALSO
 104 .Xr isdnd 8
 105 .Sh AUTHORS
 106 The
 107 .Nm
 108 device driver and this manpage were written by
 109 .An Hellmuth Michaelis Aq hm@kts.org .