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