usr.sbin/i4b/man/i4b.4

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