usr.sbin/i4b/man/i4btel.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 14:14:06 2002]
  28 .\"
  29 .Dd July 28, 2002
  30 .Dt I4BTEL 4
  31 .Os
  32 .Sh NAME
  33 .Nm i4btel
  34 .Nd isdn4bsd ISDN B-channel telephony interface driver
  35 .Sh SYNOPSIS
  36 .Cd device \&"i4btel\&" Op count
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 driver provides an interface to the ISDN B-channel for telephony applications
  41 and is currently used by the
  42 .Xr isdnd 8
  43 for answering machine support.
  44 The driver is part of the isdn4bsd package.
  45 .Pp
  46 The lower six bits of the drivers's minor number is used to specify a
  47 unit number, whereas the upper two bits specify a functionality.
  48 .Pp
  49 Functionality zero is the usual telephony data stream i/o driver.
  50 .Pp
  51 Functionality one is used to enable commands to dial out and hang up and
  52 receive responses about the state of the dial out progress and status.
  53 This commands may change in the future, for details see the file
  54 .Em i4b_tel_ioctl.h
  55 and the
  56 .Xr isdnphone 8
  57 utility.
  58 .Pp
  59 The telephony data stream comes out of the line in a bit-reversed format,
  60 so the
  61 .Nm
  62 driver does the bit-reversion process in any case.
  63 .Pp
  64 Additionally, the user can specify to do A-law to u-law, u-law to A-law
  65 or no conversion at all in the i4btel driver by using the
  66 .Xr isdntelctl 8
  67 utility.
  68 .Pp
  69 The driver is able to process several ioctl's:
  70 .Pp
  71 .Bl -tag -width Ds -compact -offset indent
  72 .It Ar I4B_TEL_GETAUDIOFMT
  73 get currently used audio format conversion.
  74 .It Ar I4B_TEL_SETAUDIOFMT
  75 set currently used audio format conversion.
  76 .It Ar I4B_TEL_EMPTYINPUTQUEUE
  77 clear the input queue.
  78 .El
  79 .Pp
  80 For the I4B_TEL_GETAUDIOFMT and I4B_TEL_SETAUDIOFMT, the following
  81 parameters are available:
  82 .Pp
  83 .Bl -tag -width Ds -compact -offset indent
  84 .It Ar CVT_NONE
  85 do no A-law/u-law audio format conversion.
  86 The conversion path looks like this:
  87 .Pp
  88 USER <--> bitreversing <--> ISDN-line
  89 .Pp
  90 .It Ar CVT_ALAW2ULAW
  91 set set audio format conversion to do an audio conversion from A-law
  92 (on the ISDN line) to u-law (in the userland).
  93 The
  94 .Xr read 2
  95 conversion path looks like this:
  96 .Pp
  97 USER <-- u-law/A-law <-- bitreversing <-- ISDN-line
  98 .Pp
  99 and the
 100 .Xr write 2
 101 conversion path looks like this:
 102 .Pp
 103 USER --> u-law/A-law --> bitreversing --> ISDN-line
 104 .Pp
 105 .It Ar CVT_ULAW2ALAW
 106 set set audio format conversion to do an audio conversion from u-law
 107 (on the ISDN line) to A-law (in the userland).
 108 The
 109 .Xr read 2
 110 conversion path looks like this:
 111 .Pp
 112 USER <-- A-law/u-law <-- bitreversing <-- ISDN-line
 113 .Pp
 114 and the
 115 .Xr write 2
 116 conversion path looks like this:
 117 .Pp
 118 USER --> A-law/u-law --> bitreversing --> ISDN-line
 119 .Pp
 120 .El
 121 .Sh SEE ALSO
 122 .Xr g711conv 1 ,
 123 .Xr isdnd.rc 5 ,
 124 .Xr isdnd 8 ,
 125 .Xr isdnphone 8 ,
 126 .Xr isdntelctl 8
 127 .Sh STANDARDS
 128 A-Law and u-Law are specified in ITU Recommendation G.711.
 129 .Sh AUTHORS
 130 The
 131 .Nm
 132 device driver and this manpage were written by
 133 .An Hellmuth Michaelis Aq hm@FreeBSD.org .