[CONNECTOR]: Update documentation to match reality.
[linux-2.6/verdex.git] / include / linux / dtlk.h
blob2896d90118a9cebda7c78f0e5f0941b4aa580d23
1 #if 0
3 #define TRACE_TXT(text) \
4 { \
5 if(dtlk_trace) \
6 { \
7 console_print(text); \
8 console_print("\n"); \
9 } \
12 #define TRACE_CHR(chr) \
13 { \
14 if(dtlk_trace) \
15 console_print(chr); \
16 } \
18 #endif
20 #define DTLK_MINOR 0
21 #define DTLK_IO_EXTENT 0x02
23 /* ioctl's use magic number of 0xa3 */
24 #define DTLK_INTERROGATE 0xa390 /* get settings from the DoubleTalk */
25 #define DTLK_STATUS 0xa391 /* get status from the DoubleTalk */
28 #define DTLK_CLEAR 0x18 /* stops speech */
30 #define DTLK_MAX_RETRIES (loops_per_jiffy/(10000/HZ))
32 /* TTS Port Status Flags */
33 #define TTS_READABLE 0x80 /* mask for bit which is nonzero if a
34 byte can be read from the TTS port */
35 #define TTS_SPEAKING 0x40 /* mask for SYNC bit, which is nonzero
36 while DoubleTalk is producing
37 output with TTS, PCM or CVSD
38 synthesizers or tone generators
39 (that is, all but LPC) */
40 #define TTS_SPEAKING2 0x20 /* mask for SYNC2 bit,
41 which falls to zero up to 0.4 sec
42 before speech stops */
43 #define TTS_WRITABLE 0x10 /* mask for RDY bit, which when set to
44 1, indicates the TTS port is ready
45 to accept a byte of data. The RDY
46 bit goes zero 2-3 usec after
47 writing, and goes 1 again 180-190
48 usec later. */
49 #define TTS_ALMOST_FULL 0x08 /* mask for AF bit: When set to 1,
50 indicates that less than 300 free
51 bytes are available in the TTS
52 input buffer. AF is always 0 in the
53 PCM, TGN and CVSD modes. */
54 #define TTS_ALMOST_EMPTY 0x04 /* mask for AE bit: When set to 1,
55 indicates that less than 300 bytes
56 of data remain in DoubleTalk's
57 input (TTS or PCM) buffer. AE is
58 always 1 in the TGN and CVSD
59 modes. */
61 /* LPC speak commands */
62 #define LPC_5220_NORMAL 0x60 /* 5220 format decoding table, normal rate */
63 #define LPC_5220_FAST 0x64 /* 5220 format decoding table, fast rate */
64 #define LPC_D6_NORMAL 0x20 /* D6 format decoding table, normal rate */
65 #define LPC_D6_FAST 0x24 /* D6 format decoding table, fast rate */
67 /* LPC Port Status Flags (valid only after one of the LPC
68 speak commands) */
69 #define LPC_SPEAKING 0x80 /* mask for TS bit: When set to 1,
70 indicates the LPC synthesizer is
71 producing speech.*/
72 #define LPC_BUFFER_LOW 0x40 /* mask for BL bit: When set to 1,
73 indicates that the hardware LPC
74 data buffer has less than 30 bytes
75 remaining. (Total internal buffer
76 size = 4096 bytes.) */
77 #define LPC_BUFFER_EMPTY 0x20 /* mask for BE bit: When set to 1,
78 indicates that the LPC data buffer
79 ran out of data (error condition if
80 TS is also 1). */
82 /* data returned by Interrogate command */
83 struct dtlk_settings
85 unsigned short serial_number; /* 0-7Fh:0-7Fh */
86 unsigned char rom_version[24]; /* null terminated string */
87 unsigned char mode; /* 0=Character; 1=Phoneme; 2=Text */
88 unsigned char punc_level; /* nB; 0-7 */
89 unsigned char formant_freq; /* nF; 0-9 */
90 unsigned char pitch; /* nP; 0-99 */
91 unsigned char speed; /* nS; 0-9 */
92 unsigned char volume; /* nV; 0-9 */
93 unsigned char tone; /* nX; 0-2 */
94 unsigned char expression; /* nE; 0-9 */
95 unsigned char ext_dict_loaded; /* 1=exception dictionary loaded */
96 unsigned char ext_dict_status; /* 1=exception dictionary enabled */
97 unsigned char free_ram; /* # pages (truncated) remaining for
98 text buffer */
99 unsigned char articulation; /* nA; 0-9 */
100 unsigned char reverb; /* nR; 0-9 */
101 unsigned char eob; /* 7Fh value indicating end of
102 parameter block */
103 unsigned char has_indexing; /* nonzero if indexing is implemented */