[mirror_ubuntu-bionic-kernel.git] / include / linux / dtlk.h

#define DTLK_MINOR	0
#define DTLK_IO_EXTENT	0x02

	/* ioctl's use magic number of 0xa3 */
#define DTLK_INTERROGATE 0xa390	/* get settings from the DoubleTalk */
#define DTLK_STATUS 0xa391	/* get status from the DoubleTalk */


#define DTLK_CLEAR 0x18		/* stops speech */

#define DTLK_MAX_RETRIES (loops_per_jiffy/(10000/HZ))

	/* TTS Port Status Flags */
#define TTS_READABLE     0x80	/* mask for bit which is nonzero if a
				   byte can be read from the TTS port */
#define TTS_SPEAKING     0x40	/* mask for SYNC bit, which is nonzero
				   while DoubleTalk is producing
				   output with TTS, PCM or CVSD
				   synthesizers or tone generators
				   (that is, all but LPC) */
#define TTS_SPEAKING2    0x20	/* mask for SYNC2 bit,
				   which falls to zero up to 0.4 sec
				   before speech stops */
#define TTS_WRITABLE     0x10	/* mask for RDY bit, which when set to
             			   1, indicates the TTS port is ready
             			   to accept a byte of data.  The RDY
             			   bit goes zero 2-3 usec after
             			   writing, and goes 1 again 180-190
             			   usec later. */
#define TTS_ALMOST_FULL  0x08	/* mask for AF bit: When set to 1,
				   indicates that less than 300 free
				   bytes are available in the TTS
				   input buffer. AF is always 0 in the
				   PCM, TGN and CVSD modes. */
#define TTS_ALMOST_EMPTY 0x04	/* mask for AE bit: When set to 1,
				   indicates that less than 300 bytes
				   of data remain in DoubleTalk's
				   input (TTS or PCM) buffer. AE is
				   always 1 in the TGN and CVSD
				   modes. */

	/* LPC speak commands */
#define LPC_5220_NORMAL 0x60	/* 5220 format decoding table, normal rate */
#define LPC_5220_FAST 0x64	/* 5220 format decoding table, fast rate */
#define LPC_D6_NORMAL 0x20	/* D6 format decoding table, normal rate */
#define LPC_D6_FAST 0x24	/* D6 format decoding table, fast rate */

	/* LPC Port Status Flags (valid only after one of the LPC
           speak commands) */
#define LPC_SPEAKING     0x80	/* mask for TS bit: When set to 1,
				   indicates the LPC synthesizer is
				   producing speech.*/
#define LPC_BUFFER_LOW   0x40	/* mask for BL bit: When set to 1,
				   indicates that the hardware LPC
				   data buffer has less than 30 bytes
				   remaining. (Total internal buffer
				   size = 4096 bytes.) */
#define LPC_BUFFER_EMPTY 0x20	/* mask for BE bit: When set to 1,
				   indicates that the LPC data buffer
				   ran out of data (error condition if
				   TS is also 1).  */

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