88121166d7153b35babc6f7be0768b33746ecf29
[linux-3.10.git] / include / linux / ixjuser.h
1 #ifndef __LINUX_IXJUSER_H
2 #define __LINUX_IXJUSER_H
3
4 /******************************************************************************
5  *
6  *    ixjuser.h
7  *
8  * Device Driver for Quicknet Technologies, Inc.'s Telephony cards
9  * including the Internet PhoneJACK, Internet PhoneJACK Lite,
10  * Internet PhoneJACK PCI, Internet LineJACK, Internet PhoneCARD and
11  * SmartCABLE
12  *
13  *    (c) Copyright 1999-2001  Quicknet Technologies, Inc.
14  *
15  *    This program is free software; you can redistribute it and/or
16  *    modify it under the terms of the GNU General Public License
17  *    as published by the Free Software Foundation; either version
18  *    2 of the License, or (at your option) any later version.
19  *
20  * Author:          Ed Okerson, <eokerson@quicknet.net>
21  *    
22  * Contributors:    Greg Herlein, <gherlein@quicknet.net>
23  *                  David W. Erhart, <derhart@quicknet.net>
24  *                  John Sellers, <jsellers@quicknet.net>
25  *                  Mike Preston, <mpreston@quicknet.net>
26  *
27  * More information about the hardware related to this driver can be found
28  * at our website:    http://www.quicknet.net
29  *
30  * Fixes:
31  *
32  * IN NO EVENT SHALL QUICKNET TECHNOLOGIES, INC. BE LIABLE TO ANY PARTY FOR
33  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
34  * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF QUICKNET
35  * TECHNOLOGIES, INC.HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  *
37  * QUICKNET TECHNOLOGIES, INC. SPECIFICALLY DISCLAIMS ANY WARRANTIES,
38  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
39  * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
40  * ON AN "AS IS" BASIS, AND QUICKNET TECHNOLOGIES, INC. HAS NO OBLIGATION 
41  * TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
42  *
43  *****************************************************************************/
44
45 static char ixjuser_h_rcsid[] = "$Id: ixjuser.h,v 4.1 2001/08/05 00:17:37 craigs Exp $";
46
47 #include <linux/telephony.h>
48
49
50 /******************************************************************************
51 *
52 * IOCTL's used for the Quicknet Telephony Cards
53 *
54 * If you use the IXJCTL_TESTRAM command, the card must be power cycled to
55 * reset the SRAM values before futher use.
56 *
57 ******************************************************************************/
58
59 #define IXJCTL_DSP_RESET                _IO  ('q', 0xC0)
60
61 #define IXJCTL_RING                     PHONE_RING
62 #define IXJCTL_HOOKSTATE                PHONE_HOOKSTATE
63 #define IXJCTL_MAXRINGS                 PHONE_MAXRINGS
64 #define IXJCTL_RING_CADENCE             PHONE_RING_CADENCE
65 #define IXJCTL_RING_START               PHONE_RING_START
66 #define IXJCTL_RING_STOP                PHONE_RING_STOP
67
68 #define IXJCTL_CARDTYPE                 _IOR ('q', 0xC1, int)
69 #define IXJCTL_SERIAL                   _IOR ('q', 0xC2, int)
70 #define IXJCTL_DSP_TYPE                 _IOR ('q', 0xC3, int)
71 #define IXJCTL_DSP_VERSION              _IOR ('q', 0xC4, int)
72 #define IXJCTL_VERSION                  _IOR ('q', 0xDA, char *)
73 #define IXJCTL_DSP_IDLE                 _IO  ('q', 0xC5)
74 #define IXJCTL_TESTRAM                  _IO  ('q', 0xC6)
75
76 /******************************************************************************
77 *
78 * This group of IOCTLs deal with the record settings of the DSP
79 *
80 * The IXJCTL_REC_DEPTH command sets the internal buffer depth of the DSP.
81 * Setting a lower depth reduces latency, but increases the demand of the
82 * application to service the driver without frame loss.  The DSP has 480
83 * bytes of physical buffer memory for the record channel so the true
84 * maximum limit is determined by how many frames will fit in the buffer.
85 *
86 * 1 uncompressed (480 byte) 16-bit linear frame.
87 * 2 uncompressed (240 byte) 8-bit A-law/mu-law frames.
88 * 15 TrueSpeech 8.5 frames.
89 * 20 TrueSpeech 6.3,5.3,4.8 or 4.1 frames.
90 *
91 * The default in the driver is currently set to 2 frames.
92 *
93 * The IXJCTL_REC_VOLUME and IXJCTL_PLAY_VOLUME commands both use a Q8
94 * number as a parameter, 0x100 scales the signal by 1.0, 0x200 scales the
95 * signal by 2.0, 0x80 scales the signal by 0.5.  No protection is given
96 * against over-scaling, if the multiplication factor times the input
97 * signal exceeds 16 bits, overflow distortion will occur.  The default
98 * setting is 0x100 (1.0).
99 *
100 * The IXJCTL_REC_LEVEL returns the average signal level (not r.m.s.) on
101 * the most recently recorded frame as a 16 bit value.
102 ******************************************************************************/
103
104 #define IXJCTL_REC_CODEC                PHONE_REC_CODEC
105 #define IXJCTL_REC_START                PHONE_REC_START
106 #define IXJCTL_REC_STOP                 PHONE_REC_STOP
107 #define IXJCTL_REC_DEPTH                PHONE_REC_DEPTH
108 #define IXJCTL_FRAME                    PHONE_FRAME
109 #define IXJCTL_REC_VOLUME               PHONE_REC_VOLUME
110 #define IXJCTL_REC_LEVEL                PHONE_REC_LEVEL
111
112 typedef enum {
113         f300_640 = 4, f300_500, f1100, f350, f400, f480, f440, f620, f20_50,
114         f133_200, f300, f300_420, f330, f300_425, f330_440, f340, f350_400,
115         f350_440, f350_450, f360, f380_420, f392, f400_425, f400_440, f400_450,
116         f420, f425, f425_450, f425_475, f435, f440_450, f440_480, f445, f450,
117         f452, f475, f480_620, f494, f500, f520, f523, f525, f540_660, f587,
118         f590, f600, f660, f700, f740, f750, f750_1450, f770, f800, f816, f850,
119         f857_1645, f900, f900_1300, f935_1215, f941_1477, f942, f950, f950_1400,
120         f975, f1000, f1020, f1050, f1100_1750, f1140, f1200, f1209, f1330, f1336,
121         lf1366, f1380, f1400, f1477, f1600, f1633_1638, f1800, f1860
122 } IXJ_FILTER_FREQ;
123
124 typedef struct {
125         unsigned int filter;
126         IXJ_FILTER_FREQ freq;
127         char enable;
128 } IXJ_FILTER;
129
130 typedef struct {
131         char enable;
132         char en_filter;
133         unsigned int filter;
134         unsigned int on1;
135         unsigned int off1;
136         unsigned int on2;
137         unsigned int off2;
138         unsigned int on3;
139         unsigned int off3;
140 } IXJ_FILTER_CADENCE;
141
142 #define IXJCTL_SET_FILTER               _IOW ('q', 0xC7, IXJ_FILTER *)
143 #define IXJCTL_SET_FILTER_RAW           _IOW ('q', 0xDD, IXJ_FILTER_RAW *)
144 #define IXJCTL_GET_FILTER_HIST          _IOW ('q', 0xC8, int)
145 #define IXJCTL_FILTER_CADENCE           _IOW ('q', 0xD6, IXJ_FILTER_CADENCE *)
146 #define IXJCTL_PLAY_CID                 _IO  ('q', 0xD7)
147 /******************************************************************************
148 *
149 * This IOCTL allows you to reassign values in the tone index table.  The
150 * tone table has 32 entries (0 - 31), but the driver only allows entries
151 * 13 - 27 to be modified, entry 0 is reserved for silence and 1 - 12 are
152 * the standard DTMF digits and 28 - 31 are the DTMF tones for A, B, C & D.
153 * The positions used internally for Call Progress Tones are as follows:
154 *    Dial Tone   - 25
155 *    Ring Back   - 26
156 *    Busy Signal - 27
157 *
158 * The freq values are calculated as:
159 * freq = cos(2 * PI * frequency / 8000)
160 *
161 * The most commonly needed values are already calculated and listed in the
162 * enum IXJ_TONE_FREQ.  Each tone index can have two frequencies with
163 * different gains, if you are only using a single frequency set the unused
164 * one to 0.
165 *
166 * The gain values range from 0 to 15 indicating +6dB to -24dB in 2dB
167 * increments.
168 *
169 ******************************************************************************/
170
171 typedef enum {
172         hz20 = 0x7ffa,
173         hz50 = 0x7fe5,
174         hz133 = 0x7f4c,
175         hz200 = 0x7e6b,
176         hz261 = 0x7d50,         /* .63 C1  */
177         hz277 = 0x7cfa,         /* .18 CS1 */
178         hz293 = 0x7c9f,         /* .66 D1  */
179         hz300 = 0x7c75,
180         hz311 = 0x7c32,         /* .13 DS1 */
181         hz329 = 0x7bbf,         /* .63 E1  */
182         hz330 = 0x7bb8,
183         hz340 = 0x7b75,
184         hz349 = 0x7b37,         /* .23 F1  */
185         hz350 = 0x7b30,
186         hz360 = 0x7ae9,
187         hz369 = 0x7aa8,         /* .99 FS1 */
188         hz380 = 0x7a56,
189         hz392 = 0x79fa,         /* .00 G1  */
190         hz400 = 0x79bb,
191         hz415 = 0x7941,         /* .30 GS1 */
192         hz420 = 0x7918,
193         hz425 = 0x78ee,
194         hz435 = 0x7899,
195         hz440 = 0x786d,         /* .00 A1  */
196         hz445 = 0x7842,
197         hz450 = 0x7815,
198         hz452 = 0x7803,
199         hz466 = 0x7784,         /* .16 AS1 */
200         hz475 = 0x7731,
201         hz480 = 0x7701,
202         hz493 = 0x7685,         /* .88 B1  */
203         hz494 = 0x767b,
204         hz500 = 0x7640,
205         hz520 = 0x7578,
206         hz523 = 0x7559,         /* .25 C2  */
207         hz525 = 0x7544,
208         hz540 = 0x74a7,
209         hz554 = 0x7411,         /* .37 CS2 */
210         hz587 = 0x72a1,         /* .33 D2  */
211         hz590 = 0x727f,
212         hz600 = 0x720b,
213         hz620 = 0x711e,
214         hz622 = 0x7106,         /* .25 DS2 */
215         hz659 = 0x6f3b,         /* .26 E2  */
216         hz660 = 0x6f2e,
217         hz698 = 0x6d3d,         /* .46 F2  */
218         hz700 = 0x6d22,
219         hz739 = 0x6b09,         /* .99 FS2 */
220         hz740 = 0x6afa,
221         hz750 = 0x6a6c,
222         hz770 = 0x694b,
223         hz783 = 0x688b,         /* .99 G2  */
224         hz800 = 0x678d,
225         hz816 = 0x6698,
226         hz830 = 0x65bf,         /* .61 GS2 */
227         hz850 = 0x6484,
228         hz857 = 0x6414,
229         hz880 = 0x629f,         /* .00 A2  */
230         hz900 = 0x6154,
231         hz932 = 0x5f35,         /* .33 AS2 */
232         hz935 = 0x5f01,
233         hz941 = 0x5e9a,
234         hz942 = 0x5e88,
235         hz950 = 0x5dfd,
236         hz975 = 0x5c44,
237         hz1000 = 0x5a81,
238         hz1020 = 0x5912,
239         hz1050 = 0x56e2,
240         hz1100 = 0x5320,
241         hz1140 = 0x5007,
242         hz1200 = 0x4b3b,
243         hz1209 = 0x4a80,
244         hz1215 = 0x4a02,
245         hz1250 = 0x471c,
246         hz1300 = 0x42e0,
247         hz1330 = 0x4049,
248         hz1336 = 0x3fc4,
249         hz1366 = 0x3d22,
250         hz1380 = 0x3be4,
251         hz1400 = 0x3a1b,
252         hz1450 = 0x3596,
253         hz1477 = 0x331c,
254         hz1500 = 0x30fb,
255         hz1600 = 0x278d,
256         hz1633 = 0x2462,
257         hz1638 = 0x23e7,
258         hz1645 = 0x233a,
259         hz1750 = 0x18f8,
260         hz1800 = 0x1405,
261         hz1860 = 0xe0b,
262         hz2100 = 0xf5f6,
263         hz2130 = 0xf2f5,
264         hz2450 = 0xd3b3,
265         hz2750 = 0xb8e4
266 } IXJ_FREQ;
267
268 typedef enum {
269         C1 = hz261,
270         CS1 = hz277,
271         D1 = hz293,
272         DS1 = hz311,
273         E1 = hz329,
274         F1 = hz349,
275         FS1 = hz369,
276         G1 = hz392,
277         GS1 = hz415,
278         A1 = hz440,
279         AS1 = hz466,
280         B1 = hz493,
281         C2 = hz523,
282         CS2 = hz554,
283         D2 = hz587,
284         DS2 = hz622,
285         E2 = hz659,
286         F2 = hz698,
287         FS2 = hz739,
288         G2 = hz783,
289         GS2 = hz830,
290         A2 = hz880,
291         AS2 = hz932,
292 } IXJ_NOTE;
293
294 typedef struct {
295         int tone_index;
296         int freq0;
297         int gain0;
298         int freq1;
299         int gain1;
300 } IXJ_TONE;
301
302 #define IXJCTL_INIT_TONE                _IOW ('q', 0xC9, IXJ_TONE *)
303
304 /******************************************************************************
305 *
306 * The IXJCTL_TONE_CADENCE ioctl defines tone sequences used for various
307 * Call Progress Tones (CPT).  This is accomplished by setting up an array of
308 * IXJ_CADENCE_ELEMENT structures that sequentially define the states of
309 * the tone sequence.  The tone_on_time and tone_off time are in
310 * 250 microsecond intervals.  A pointer to this array is passed to the
311 * driver as the ce element of an IXJ_CADENCE structure.  The elements_used
312 * must be set to the number of IXJ_CADENCE_ELEMENTS in the array.  The
313 * termination variable defines what to do at the end of a cadence, the
314 * options are to play the cadence once and stop, to repeat the last
315 * element of the cadence indefinitely, or to repeat the entire cadence
316 * indefinitely.  The ce variable is a pointer to the array of IXJ_TONE
317 * structures.  If the freq0 variable is non-zero, the tone table contents
318 * for the tone_index are updated to the frequencies and gains defined.  It
319 * should be noted that DTMF tones cannot be reassigned, so if DTMF tone
320 * table indexs are used in a cadence the frequency and gain variables will
321 * be ignored.
322 *
323 * If the array elements contain frequency parameters the driver will
324 * initialize the needed tone table elements and begin playing the tone,
325 * there is no preset limit on the number of elements in the cadence.  If
326 * there is more than one frequency used in the cadence, sequential elements
327 * of different frequencies MUST use different tone table indexes.  Only one
328 * cadence can be played at a time.  It is possible to build complex
329 * cadences with multiple frequencies using 2 tone table indexes by
330 * alternating between them.
331 *
332 ******************************************************************************/
333
334 typedef struct {
335         int index;
336         int tone_on_time;
337         int tone_off_time;
338         int freq0;
339         int gain0;
340         int freq1;
341         int gain1;
342 } IXJ_CADENCE_ELEMENT;
343
344 typedef enum {
345         PLAY_ONCE,
346         REPEAT_LAST_ELEMENT,
347         REPEAT_ALL
348 } IXJ_CADENCE_TERM;
349
350 typedef struct {
351         int elements_used;
352         IXJ_CADENCE_TERM termination;
353         IXJ_CADENCE_ELEMENT __user *ce;
354 } IXJ_CADENCE;
355
356 #define IXJCTL_TONE_CADENCE             _IOW ('q', 0xCA, IXJ_CADENCE *)
357 /******************************************************************************
358 *
359 * This group of IOCTLs deal with the playback settings of the DSP
360 *
361 ******************************************************************************/
362
363 #define IXJCTL_PLAY_CODEC               PHONE_PLAY_CODEC
364 #define IXJCTL_PLAY_START               PHONE_PLAY_START
365 #define IXJCTL_PLAY_STOP                PHONE_PLAY_STOP
366 #define IXJCTL_PLAY_DEPTH               PHONE_PLAY_DEPTH
367 #define IXJCTL_PLAY_VOLUME              PHONE_PLAY_VOLUME
368 #define IXJCTL_PLAY_LEVEL               PHONE_PLAY_LEVEL
369
370 /******************************************************************************
371 *
372 * This group of IOCTLs deal with the Acoustic Echo Cancellation settings
373 * of the DSP
374 *
375 * Issuing the IXJCTL_AEC_START command with a value of AEC_OFF has the
376 * same effect as IXJCTL_AEC_STOP.  This is to simplify slider bar
377 * controls.  IXJCTL_AEC_GET_LEVEL returns the current setting of the AEC.
378 ******************************************************************************/
379 #define IXJCTL_AEC_START                _IOW ('q', 0xCB, int)
380 #define IXJCTL_AEC_STOP                 _IO  ('q', 0xCC)
381 #define IXJCTL_AEC_GET_LEVEL            _IO  ('q', 0xCD)
382
383 #define AEC_OFF   0
384 #define AEC_LOW   1
385 #define AEC_MED   2
386 #define AEC_HIGH  3
387 #define AEC_AUTO  4
388 #define AEC_AGC   5
389 /******************************************************************************
390 *
391 * Call Progress Tones, DTMF, etc.
392 * IXJCTL_DTMF_OOB determines if DTMF signaling is sent as Out-Of-Band
393 * only.  If you pass a 1, DTMF is suppressed from the audio stream.
394 * Tone on and off times are in 250 microsecond intervals so
395 * ioctl(ixj1, IXJCTL_SET_TONE_ON_TIME, 360);
396 * will set the tone on time of board ixj1 to 360 * 250us = 90ms
397 * the default values of tone on and off times is 840 or 210ms
398 ******************************************************************************/
399
400 #define IXJCTL_DTMF_READY               PHONE_DTMF_READY
401 #define IXJCTL_GET_DTMF                 PHONE_GET_DTMF
402 #define IXJCTL_GET_DTMF_ASCII           PHONE_GET_DTMF_ASCII
403 #define IXJCTL_DTMF_OOB                 PHONE_DTMF_OOB
404 #define IXJCTL_EXCEPTION                PHONE_EXCEPTION
405 #define IXJCTL_PLAY_TONE                PHONE_PLAY_TONE
406 #define IXJCTL_SET_TONE_ON_TIME         PHONE_SET_TONE_ON_TIME
407 #define IXJCTL_SET_TONE_OFF_TIME        PHONE_SET_TONE_OFF_TIME
408 #define IXJCTL_GET_TONE_ON_TIME         PHONE_GET_TONE_ON_TIME
409 #define IXJCTL_GET_TONE_OFF_TIME        PHONE_GET_TONE_OFF_TIME
410 #define IXJCTL_GET_TONE_STATE           PHONE_GET_TONE_STATE
411 #define IXJCTL_BUSY                     PHONE_BUSY
412 #define IXJCTL_RINGBACK                 PHONE_RINGBACK
413 #define IXJCTL_DIALTONE                 PHONE_DIALTONE
414 #define IXJCTL_CPT_STOP                 PHONE_CPT_STOP
415
416 /******************************************************************************
417 * LineJACK specific IOCTLs
418 *
419 * The lsb 4 bits of the LED argument represent the state of each of the 4
420 * LED's on the LineJACK
421 ******************************************************************************/
422
423 #define IXJCTL_SET_LED                  _IOW ('q', 0xCE, int)
424 #define IXJCTL_MIXER                    _IOW ('q', 0xCF, int)
425
426 /******************************************************************************
427
428 * The master volume controls use attenuation with 32 levels from 0 to -62dB
429 * with steps of 2dB each, the defines should be OR'ed together then sent
430 * as the parameter to the mixer command to change the mixer settings.
431
432 ******************************************************************************/
433 #define MIXER_MASTER_L          0x0000
434 #define MIXER_MASTER_R          0x0100
435 #define ATT00DB                 0x00
436 #define ATT02DB                 0x01
437 #define ATT04DB                 0x02
438 #define ATT06DB                 0x03
439 #define ATT08DB                 0x04
440 #define ATT10DB                 0x05
441 #define ATT12DB                 0x06
442 #define ATT14DB                 0x07
443 #define ATT16DB                 0x08
444 #define ATT18DB                 0x09
445 #define ATT20DB                 0x0A
446 #define ATT22DB                 0x0B
447 #define ATT24DB                 0x0C
448 #define ATT26DB                 0x0D
449 #define ATT28DB                 0x0E
450 #define ATT30DB                 0x0F
451 #define ATT32DB                 0x10
452 #define ATT34DB                 0x11
453 #define ATT36DB                 0x12
454 #define ATT38DB                 0x13
455 #define ATT40DB                 0x14
456 #define ATT42DB                 0x15
457 #define ATT44DB                 0x16
458 #define ATT46DB                 0x17
459 #define ATT48DB                 0x18
460 #define ATT50DB                 0x19
461 #define ATT52DB                 0x1A
462 #define ATT54DB                 0x1B
463 #define ATT56DB                 0x1C
464 #define ATT58DB                 0x1D
465 #define ATT60DB                 0x1E
466 #define ATT62DB                 0x1F
467 #define MASTER_MUTE             0x80
468
469 /******************************************************************************
470
471 * The input volume controls use gain with 32 levels from +12dB to -50dB
472 * with steps of 2dB each, the defines should be OR'ed together then sent
473 * as the parameter to the mixer command to change the mixer settings.
474
475 ******************************************************************************/
476 #define MIXER_PORT_CD_L         0x0600
477 #define MIXER_PORT_CD_R         0x0700
478 #define MIXER_PORT_LINE_IN_L    0x0800
479 #define MIXER_PORT_LINE_IN_R    0x0900
480 #define MIXER_PORT_POTS_REC     0x0C00
481 #define MIXER_PORT_MIC          0x0E00
482
483 #define GAIN12DB                0x00
484 #define GAIN10DB                0x01
485 #define GAIN08DB                0x02
486 #define GAIN06DB                0x03
487 #define GAIN04DB                0x04
488 #define GAIN02DB                0x05
489 #define GAIN00DB                0x06
490 #define GAIN_02DB               0x07
491 #define GAIN_04DB               0x08
492 #define GAIN_06DB               0x09
493 #define GAIN_08DB               0x0A
494 #define GAIN_10DB               0x0B
495 #define GAIN_12DB               0x0C
496 #define GAIN_14DB               0x0D
497 #define GAIN_16DB               0x0E
498 #define GAIN_18DB               0x0F
499 #define GAIN_20DB               0x10
500 #define GAIN_22DB               0x11
501 #define GAIN_24DB               0x12
502 #define GAIN_26DB               0x13
503 #define GAIN_28DB               0x14
504 #define GAIN_30DB               0x15
505 #define GAIN_32DB               0x16
506 #define GAIN_34DB               0x17
507 #define GAIN_36DB               0x18
508 #define GAIN_38DB               0x19
509 #define GAIN_40DB               0x1A
510 #define GAIN_42DB               0x1B
511 #define GAIN_44DB               0x1C
512 #define GAIN_46DB               0x1D
513 #define GAIN_48DB               0x1E
514 #define GAIN_50DB               0x1F
515 #define INPUT_MUTE              0x80
516
517 /******************************************************************************
518
519 * The POTS volume control use attenuation with 8 levels from 0dB to -28dB
520 * with steps of 4dB each, the defines should be OR'ed together then sent
521 * as the parameter to the mixer command to change the mixer settings.
522
523 ******************************************************************************/
524 #define MIXER_PORT_POTS_PLAY    0x0F00
525
526 #define POTS_ATT_00DB           0x00
527 #define POTS_ATT_04DB           0x01
528 #define POTS_ATT_08DB           0x02
529 #define POTS_ATT_12DB           0x03
530 #define POTS_ATT_16DB           0x04
531 #define POTS_ATT_20DB           0x05
532 #define POTS_ATT_24DB           0x06
533 #define POTS_ATT_28DB           0x07
534 #define POTS_MUTE               0x80
535
536 /******************************************************************************
537
538 * The DAA controls the interface to the PSTN port.  The driver loads the
539 * US coefficients by default, so if you live in a different country you
540 * need to load the set for your countries phone system.
541
542 ******************************************************************************/
543 #define IXJCTL_DAA_COEFF_SET            _IOW ('q', 0xD0, int)
544
545 #define DAA_US          1       /*PITA 8kHz */
546 #define DAA_UK          2       /*ISAR34 8kHz */
547 #define DAA_FRANCE      3       /* */
548 #define DAA_GERMANY     4
549 #define DAA_AUSTRALIA   5
550 #define DAA_JAPAN       6
551
552 /******************************************************************************
553
554 * Use IXJCTL_PORT to set or query the port the card is set to.  If the
555 * argument is set to PORT_QUERY, the return value of the ioctl will
556 * indicate which port is currently in use, otherwise it will change the
557 * port.
558
559 ******************************************************************************/
560 #define IXJCTL_PORT                     _IOW ('q', 0xD1, int)
561
562 #define PORT_QUERY      0
563 #define PORT_POTS       1
564 #define PORT_PSTN       2
565 #define PORT_SPEAKER    3
566 #define PORT_HANDSET    4
567
568 #define IXJCTL_PSTN_SET_STATE           PHONE_PSTN_SET_STATE
569 #define IXJCTL_PSTN_GET_STATE           PHONE_PSTN_GET_STATE
570
571 #define PSTN_ON_HOOK    0
572 #define PSTN_RINGING    1
573 #define PSTN_OFF_HOOK   2
574 #define PSTN_PULSE_DIAL 3
575
576 /******************************************************************************
577
578 * The DAA Analog GAIN sets 2 parameters at one time, the receive gain (AGRR), 
579 * and the transmit gain (AGX).  OR together the components and pass them
580 * as the parameter to IXJCTL_DAA_AGAIN.  The default setting is both at 0dB.
581
582 ******************************************************************************/
583 #define IXJCTL_DAA_AGAIN                _IOW ('q', 0xD2, int)
584
585 #define AGRR00DB        0x00    /* Analog gain in receive direction 0dB */
586 #define AGRR3_5DB       0x10    /* Analog gain in receive direction 3.5dB */
587 #define AGRR06DB        0x30    /* Analog gain in receive direction 6dB */
588
589 #define AGX00DB         0x00    /* Analog gain in transmit direction 0dB */
590 #define AGX_6DB         0x04    /* Analog gain in transmit direction -6dB */
591 #define AGX3_5DB        0x08    /* Analog gain in transmit direction 3.5dB */
592 #define AGX_2_5B        0x0C    /* Analog gain in transmit direction -2.5dB */
593
594 #define IXJCTL_PSTN_LINETEST            _IO  ('q', 0xD3)
595
596 #define IXJCTL_CID                      _IOR ('q', 0xD4, PHONE_CID *)
597 #define IXJCTL_VMWI                     _IOR ('q', 0xD8, int)
598 #define IXJCTL_CIDCW                    _IOW ('q', 0xD9, PHONE_CID *)
599 /******************************************************************************
600
601 * The wink duration is tunable with this ioctl.  The default wink duration  
602 * is 320ms.  You do not need to use this ioctl if you do not require a
603 * different wink duration.
604
605 ******************************************************************************/
606 #define IXJCTL_WINK_DURATION            PHONE_WINK_DURATION
607
608 /******************************************************************************
609
610 * This ioctl will connect the POTS port to the PSTN port on the LineJACK
611 * In order for this to work properly the port selection should be set to
612 * the PSTN port with IXJCTL_PORT prior to calling this ioctl.  This will
613 * enable conference calls between PSTN callers and network callers.
614 * Passing a 1 to this ioctl enables the POTS<->PSTN connection while
615 * passing a 0 turns it back off.
616
617 ******************************************************************************/
618 #define IXJCTL_POTS_PSTN                _IOW ('q', 0xD5, int)
619
620 /******************************************************************************
621 *
622 * IOCTLs added by request.
623 *
624 * IXJCTL_HZ sets the value your Linux kernel uses for HZ as defined in
625 *           /usr/include/asm/param.h, this determines the fundamental
626 *           frequency of the clock ticks on your Linux system.  The kernel
627 *           must be rebuilt if you change this value, also all modules you
628 *           use (except this one) must be recompiled.  The default value
629 *           is 100, and you only need to use this IOCTL if you use some
630 *           other value.
631 *
632 *
633 * IXJCTL_RATE sets the number of times per second that the driver polls
634 *             the DSP.  This value cannot be larger than HZ.  By
635 *             increasing both of these values, you may be able to reduce
636 *             latency because the max hang time that can exist between the
637 *             driver and the DSP will be reduced.
638 *
639 ******************************************************************************/
640
641 #define IXJCTL_HZ                       _IOW ('q', 0xE0, int)
642 #define IXJCTL_RATE                     _IOW ('q', 0xE1, int)
643 #define IXJCTL_FRAMES_READ              _IOR ('q', 0xE2, unsigned long)
644 #define IXJCTL_FRAMES_WRITTEN           _IOR ('q', 0xE3, unsigned long)
645 #define IXJCTL_READ_WAIT                _IOR ('q', 0xE4, unsigned long)
646 #define IXJCTL_WRITE_WAIT               _IOR ('q', 0xE5, unsigned long)
647 #define IXJCTL_DRYBUFFER_READ           _IOR ('q', 0xE6, unsigned long)
648 #define IXJCTL_DRYBUFFER_CLEAR          _IO  ('q', 0xE7)
649 #define IXJCTL_DTMF_PRESCALE            _IOW ('q', 0xE8, int)
650
651 /******************************************************************************
652 *
653 * This ioctl allows the user application to control what events the driver
654 * will send signals for, and what signals it will send for which event.
655 * By default, if signaling is enabled, all events will send SIGIO when
656 * they occur.  To disable signals for an event set the signal to 0.
657 *
658 ******************************************************************************/
659 typedef enum {
660         SIG_DTMF_READY,
661         SIG_HOOKSTATE,
662         SIG_FLASH,
663         SIG_PSTN_RING,
664         SIG_CALLER_ID,
665         SIG_PSTN_WINK,
666         SIG_F0, SIG_F1, SIG_F2, SIG_F3,
667         SIG_FC0, SIG_FC1, SIG_FC2, SIG_FC3,
668         SIG_READ_READY = 33,
669         SIG_WRITE_READY = 34
670 } IXJ_SIGEVENT;
671
672 typedef struct {
673         unsigned int event;
674         int signal;
675 } IXJ_SIGDEF;
676
677 #define IXJCTL_SIGCTL                   _IOW ('q', 0xE9, IXJ_SIGDEF *)
678
679 /******************************************************************************
680 *
681 * These ioctls allow the user application to change the gain in the 
682 * Smart Cable of the Internet Phone Card.  Sending -1 as a value will cause
683 * return value to be the current setting.  Valid values to set are 0x00 - 0x1F
684 *
685 * 11111 = +12 dB
686 * 10111 =   0 dB
687 * 00000 = -34.5 dB
688 *
689 * IXJCTL_SC_RXG sets the Receive gain
690 * IXJCTL_SC_TXG sets the Transmit gain
691 *
692 ******************************************************************************/
693 #define IXJCTL_SC_RXG                   _IOW ('q', 0xEA, int)
694 #define IXJCTL_SC_TXG                   _IOW ('q', 0xEB, int)
695
696 /******************************************************************************
697 *
698 * The intercom IOCTL's short the output from one card to the input of the
699 * other and vice versa (actually done in the DSP read function).  It is only
700 * necessary to execute the IOCTL on one card, but it is necessary to have
701 * both devices open to be able to detect hook switch changes.  The record
702 * codec and rate of each card must match the playback codec and rate of
703 * the other card for this to work properly.
704 *
705 ******************************************************************************/
706
707 #define IXJCTL_INTERCOM_START           _IOW ('q', 0xFD, int)
708 #define IXJCTL_INTERCOM_STOP            _IOW ('q', 0xFE, int)
709
710 /******************************************************************************
711  *
712  * new structure for accessing raw filter information
713  *
714  ******************************************************************************/
715
716 typedef struct {
717         unsigned int filter;
718         char enable;
719         unsigned int coeff[19];
720 } IXJ_FILTER_RAW;
721
722 #endif