xref: /linux/drivers/accessibility/speakup/speakup_dtlk.h (revision 2067fd92d75b6d9085a43caf050bca5d88c491b8)
1*b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
2c6e3fd22SWilliam Hubbs /* speakup_dtlk.h - header file for speakups DoubleTalk driver. */
3c6e3fd22SWilliam Hubbs 
4c6e3fd22SWilliam Hubbs #define SYNTH_IO_EXTENT	0x02
5c6e3fd22SWilliam Hubbs #define SYNTH_CLEAR	0x18		/* stops speech */
6c6e3fd22SWilliam Hubbs 	/* TTS Port Status Flags */
7c6e3fd22SWilliam Hubbs #define TTS_READABLE	0x80	/* mask for bit which is nonzero if a
813d825edSAleksei Fedotov 				 * byte can be read from the TTS port
913d825edSAleksei Fedotov 				 */
10c6e3fd22SWilliam Hubbs #define TTS_SPEAKING	0x40	/* mask for SYNC bit, which is nonzero
1113d825edSAleksei Fedotov 				 * while DoubleTalk is producing
1213d825edSAleksei Fedotov 				 * output with TTS, PCM or CVSD
1313d825edSAleksei Fedotov 				 * synthesizers or tone generators
1413d825edSAleksei Fedotov 				 * (that is, all but LPC)
1513d825edSAleksei Fedotov 				 */
16c6e3fd22SWilliam Hubbs #define TTS_SPEAKING2	0x20	/* mask for SYNC2 bit,
1713d825edSAleksei Fedotov 				 * which falls to zero up to 0.4 sec
1813d825edSAleksei Fedotov 				 * before speech stops
1913d825edSAleksei Fedotov 				 */
20c6e3fd22SWilliam Hubbs #define TTS_WRITABLE	0x10	/* mask for RDY bit, which when set to
2113d825edSAleksei Fedotov 				 * 1, indicates the TTS port is ready
2213d825edSAleksei Fedotov 				 * to accept a byte of data.  The RDY
2313d825edSAleksei Fedotov 				 * bit goes zero 2-3 usec after
2413d825edSAleksei Fedotov 				 * writing, and goes 1 again 180-190
2513d825edSAleksei Fedotov 				 * usec later.
2613d825edSAleksei Fedotov 				 */
27c6e3fd22SWilliam Hubbs #define TTS_ALMOST_FULL	0x08	/* mask for AF bit: When set to 1,
2813d825edSAleksei Fedotov 				 * indicates that less than 300 bytes
2913d825edSAleksei Fedotov 				 * are available in the TTS input
3013d825edSAleksei Fedotov 				 * buffer. AF is always 0 in the PCM,
3113d825edSAleksei Fedotov 				 * TGN and CVSD modes.
3213d825edSAleksei Fedotov 				 */
33c6e3fd22SWilliam Hubbs #define TTS_ALMOST_EMPTY 0x04	/* mask for AE bit: When set to 1,
3413d825edSAleksei Fedotov 				 * indicates that less than 300 bytes
3513d825edSAleksei Fedotov 				 * are remaining in DoubleTalk's input
3613d825edSAleksei Fedotov 				 * (TTS or PCM) buffer. AE is always 1
3713d825edSAleksei Fedotov 				 * in the TGN and CVSD modes.
3813d825edSAleksei Fedotov 				 */
39c6e3fd22SWilliam Hubbs 
40c6e3fd22SWilliam Hubbs 				/* data returned by Interrogate command */
41c6e3fd22SWilliam Hubbs struct synth_settings {
42c6e3fd22SWilliam Hubbs 	u_short serial_number;	/* 0-7Fh:0-7Fh */
43c6e3fd22SWilliam Hubbs 	u_char rom_version[24]; /* null terminated string */
44c6e3fd22SWilliam Hubbs 	u_char mode;		/* 0=Character; 1=Phoneme; 2=Text */
45c6e3fd22SWilliam Hubbs 	u_char punc_level;	/* nB; 0-7 */
46c6e3fd22SWilliam Hubbs 	u_char formant_freq;	/* nF; 0-9 */
47c6e3fd22SWilliam Hubbs 	u_char pitch;		/* nP; 0-99 */
48c6e3fd22SWilliam Hubbs 	u_char speed;		/* nS; 0-9 */
49c6e3fd22SWilliam Hubbs 	u_char volume;		/* nV; 0-9 */
50c6e3fd22SWilliam Hubbs 	u_char tone;		/* nX; 0-2 */
51c6e3fd22SWilliam Hubbs 	u_char expression;	/* nE; 0-9 */
52c6e3fd22SWilliam Hubbs 	u_char ext_dict_loaded; /* 1=exception dictionary loaded */
53c6e3fd22SWilliam Hubbs 	u_char ext_dict_status; /* 1=exception dictionary enabled */
54c6e3fd22SWilliam Hubbs 	u_char free_ram;	/* # pages (truncated) remaining for
5513d825edSAleksei Fedotov 				 * text buffer
5613d825edSAleksei Fedotov 				 */
57c6e3fd22SWilliam Hubbs 	u_char articulation;	/* nA; 0-9 */
58c6e3fd22SWilliam Hubbs 	u_char reverb;		/* nR; 0-9 */
59c6e3fd22SWilliam Hubbs 	u_char eob;		/* 7Fh value indicating end of
6013d825edSAleksei Fedotov 				 * parameter block
6113d825edSAleksei Fedotov 				 */
62c6e3fd22SWilliam Hubbs 	u_char has_indexing;	/* nonzero if indexing is implemented */
63c6e3fd22SWilliam Hubbs };
64