1/****************************************************************************** 2 * 3 * telephony.h 4 * 5 * Basic Linux Telephony Interface 6 * 7 * (c) Copyright 1999-2001 Quicknet Technologies, Inc. 8 * 9 * This program is free software; you can redistribute it and/or 10 * modify it under the terms of the GNU General Public License 11 * as published by the Free Software Foundation; either version 12 * 2 of the License, or (at your option) any later version. 13 * 14 * Authors: Ed Okerson, <eokerson@quicknet.net> 15 * Greg Herlein, <gherlein@quicknet.net> 16 * 17 * Contributors: Alan Cox, <alan@redhat.com> 18 * David W. Erhart, <derhart@quicknet.net> 19 * 20 * IN NO EVENT SHALL QUICKNET TECHNOLOGIES, INC. BE LIABLE TO ANY PARTY FOR 21 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT 22 * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF QUICKNET 23 * TECHNOLOGIES, INC. HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 24 * 25 * QUICKNET TECHNOLOGIES, INC. SPECIFICALLY DISCLAIMS ANY WARRANTIES, 26 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 27 * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS 28 * ON AN "AS IS" BASIS, AND QUICKNET TECHNOLOGIES, INC. HAS NO OBLIGATION 29 * TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. 30 * 31 * Version: $Revision: 4.2 $ 32 * 33 * $Id: telephony.h,v 4.2 2001/08/06 07:09:43 craigs Exp $ 34 * 35 *****************************************************************************/ 36 37#ifndef TELEPHONY_H 38#define TELEPHONY_H 39 40#define TELEPHONY_VERSION 3013 41 42#define PHONE_VENDOR_IXJ 1 43#define PHONE_VENDOR_QUICKNET PHONE_VENDOR_IXJ 44#define PHONE_VENDOR_VOICETRONIX 2 45#define PHONE_VENDOR_ACULAB 3 46#define PHONE_VENDOR_DIGI 4 47#define PHONE_VENDOR_FRANKLIN 5 48 49/****************************************************************************** 50 * Vendor Summary Information Area 51 * 52 * Quicknet Technologies, Inc. - makes low density analog telephony cards 53 * with audio compression, POTS and PSTN interfaces (www.quicknet.net) 54 * 55 * (other vendors following this API shuld add a short description of 56 * the telephony products they support under Linux) 57 * 58 *****************************************************************************/ 59#define QTI_PHONEJACK 100 60#define QTI_LINEJACK 300 61#define QTI_PHONEJACK_LITE 400 62#define QTI_PHONEJACK_PCI 500 63#define QTI_PHONECARD 600 64 65/****************************************************************************** 66* 67* The capabilities ioctls can inform you of the capabilities of each phone 68* device installed in your system. The PHONECTL_CAPABILITIES ioctl 69* returns an integer value indicating the number of capabilities the 70* device has. The PHONECTL_CAPABILITIES_LIST will fill an array of 71* capability structs with all of its capabilities. The 72* PHONECTL_CAPABILITIES_CHECK takes a single capability struct and returns 73* a TRUE if the device has that capability, otherwise it returns false. 74* 75******************************************************************************/ 76typedef enum { 77 vendor = 0, 78 device, 79 port, 80 codec, 81 dsp 82} phone_cap; 83 84struct phone_capability { 85 char desc[80]; 86 phone_cap captype; 87 int cap; 88 int handle; 89}; 90 91typedef enum { 92 pots = 0, 93 pstn, 94 handset, 95 speaker 96} phone_ports; 97 98#define PHONE_CAPABILITIES _IO ('q', 0x80) 99#define PHONE_CAPABILITIES_LIST _IOR ('q', 0x81, struct phone_capability *) 100#define PHONE_CAPABILITIES_CHECK _IOW ('q', 0x82, struct phone_capability *) 101 102typedef struct { 103 char month[3]; 104 char day[3]; 105 char hour[3]; 106 char min[3]; 107 int numlen; 108 char number[11]; 109 int namelen; 110 char name[80]; 111} PHONE_CID; 112 113#define PHONE_RING _IO ('q', 0x83) 114#define PHONE_HOOKSTATE _IO ('q', 0x84) 115#define PHONE_MAXRINGS _IOW ('q', 0x85, char) 116#define PHONE_RING_CADENCE _IOW ('q', 0x86, short) 117#define OLD_PHONE_RING_START _IO ('q', 0x87) 118#define PHONE_RING_START _IOW ('q', 0x87, PHONE_CID *) 119#define PHONE_RING_STOP _IO ('q', 0x88) 120 121#define USA_RING_CADENCE 0xC0C0 122 123#define PHONE_REC_CODEC _IOW ('q', 0x89, int) 124#define PHONE_REC_START _IO ('q', 0x8A) 125#define PHONE_REC_STOP _IO ('q', 0x8B) 126#define PHONE_REC_DEPTH _IOW ('q', 0x8C, int) 127#define PHONE_FRAME _IOW ('q', 0x8D, int) 128#define PHONE_REC_VOLUME _IOW ('q', 0x8E, int) 129#define PHONE_REC_VOLUME_LINEAR _IOW ('q', 0xDB, int) 130#define PHONE_REC_LEVEL _IO ('q', 0x8F) 131 132#define PHONE_PLAY_CODEC _IOW ('q', 0x90, int) 133#define PHONE_PLAY_START _IO ('q', 0x91) 134#define PHONE_PLAY_STOP _IO ('q', 0x92) 135#define PHONE_PLAY_DEPTH _IOW ('q', 0x93, int) 136#define PHONE_PLAY_VOLUME _IOW ('q', 0x94, int) 137#define PHONE_PLAY_VOLUME_LINEAR _IOW ('q', 0xDC, int) 138#define PHONE_PLAY_LEVEL _IO ('q', 0x95) 139#define PHONE_DTMF_READY _IOR ('q', 0x96, int) 140#define PHONE_GET_DTMF _IOR ('q', 0x97, int) 141#define PHONE_GET_DTMF_ASCII _IOR ('q', 0x98, int) 142#define PHONE_DTMF_OOB _IOW ('q', 0x99, int) 143#define PHONE_EXCEPTION _IOR ('q', 0x9A, int) 144#define PHONE_PLAY_TONE _IOW ('q', 0x9B, char) 145#define PHONE_SET_TONE_ON_TIME _IOW ('q', 0x9C, int) 146#define PHONE_SET_TONE_OFF_TIME _IOW ('q', 0x9D, int) 147#define PHONE_GET_TONE_ON_TIME _IO ('q', 0x9E) 148#define PHONE_GET_TONE_OFF_TIME _IO ('q', 0x9F) 149#define PHONE_GET_TONE_STATE _IO ('q', 0xA0) 150#define PHONE_BUSY _IO ('q', 0xA1) 151#define PHONE_RINGBACK _IO ('q', 0xA2) 152#define PHONE_DIALTONE _IO ('q', 0xA3) 153#define PHONE_CPT_STOP _IO ('q', 0xA4) 154 155#define PHONE_PSTN_SET_STATE _IOW ('q', 0xA4, int) 156#define PHONE_PSTN_GET_STATE _IO ('q', 0xA5) 157 158#define PSTN_ON_HOOK 0 159#define PSTN_RINGING 1 160#define PSTN_OFF_HOOK 2 161#define PSTN_PULSE_DIAL 3 162 163/****************************************************************************** 164* 165* The wink duration is tunable with this ioctl. The default wink duration 166* is 320ms. You do not need to use this ioctl if you do not require a 167* different wink duration. 168* 169******************************************************************************/ 170#define PHONE_WINK_DURATION _IOW ('q', 0xA6, int) 171#define PHONE_WINK _IOW ('q', 0xAA, int) 172 173/****************************************************************************** 174* 175* Codec Definitions 176* 177******************************************************************************/ 178typedef enum { 179 G723_63 = 1, 180 G723_53 = 2, 181 TS85 = 3, 182 TS48 = 4, 183 TS41 = 5, 184 G728 = 6, 185 G729 = 7, 186 ULAW = 8, 187 ALAW = 9, 188 LINEAR16 = 10, 189 LINEAR8 = 11, 190 WSS = 12, 191 G729B = 13 192} phone_codec; 193 194struct phone_codec_data 195{ 196 phone_codec type; 197 unsigned short buf_min, buf_opt, buf_max; 198}; 199 200#define PHONE_QUERY_CODEC _IOWR ('q', 0xA7, struct phone_codec_data *) 201#define PHONE_PSTN_LINETEST _IO ('q', 0xA8) 202 203/****************************************************************************** 204* 205* This controls the VAD/CNG functionality of G.723.1. The driver will 206* always pass full size frames, any unused bytes will be padded with zeros, 207* and frames passed to the driver should also be padded with zeros. The 208* frame type is encoded in the least significant two bits of the first 209* WORD of the frame as follows: 210* 211* bits 1-0 Frame Type Data Rate Significant Words 212* 00 0 G.723.1 6.3 12 213* 01 1 G.723.1 5.3 10 214* 10 2 VAD/CNG 2 215* 11 3 Repeat last CNG 2 bits 216* 217******************************************************************************/ 218#define PHONE_VAD _IOW ('q', 0xA9, int) 219 220 221/****************************************************************************** 222* 223* The exception structure allows us to multiplex multiple events onto the 224* select() exception set. If any of these flags are set select() will 225* return with a positive indication on the exception set. The dtmf_ready 226* bit indicates if there is data waiting in the DTMF buffer. The 227* hookstate bit is set if there is a change in hookstate status, it does not 228* indicate the current state of the hookswitch. The pstn_ring bit 229* indicates that the DAA on a LineJACK card has detected ring voltage on 230* the PSTN port. The caller_id bit indicates that caller_id data has been 231* received and is available. The pstn_wink bit indicates that the DAA on 232* the LineJACK has received a wink from the telco switch. The f0, f1, f2 233* and f3 bits indicate that the filter has been triggered by detecting the 234* frequency programmed into that filter. 235* 236* The remaining bits should be set to zero. They will become defined over time 237* for other interface cards and their needs. 238* 239******************************************************************************/ 240struct phone_except 241{ 242 unsigned int dtmf_ready:1; 243 unsigned int hookstate:1; 244 unsigned int pstn_ring:1; 245 unsigned int caller_id:1; 246 unsigned int pstn_wink:1; 247 unsigned int f0:1; 248 unsigned int f1:1; 249 unsigned int f2:1; 250 unsigned int f3:1; 251 unsigned int flash:1; 252 unsigned int fc0:1; 253 unsigned int fc1:1; 254 unsigned int fc2:1; 255 unsigned int fc3:1; 256 unsigned int reserved:18; 257}; 258 259union telephony_exception { 260 struct phone_except bits; 261 unsigned int bytes; 262}; 263 264 265#endif /* TELEPHONY_H */ 266 267