include/linux/dtlk.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 #define DTLK_MINOR  0
0003 #define DTLK_IO_EXTENT  0x02
0004
0005     /* ioctl's use magic number of 0xa3 */
0006 #define DTLK_INTERROGATE 0xa390 /* get settings from the DoubleTalk */
0007 #define DTLK_STATUS 0xa391  /* get status from the DoubleTalk */
0008
0009
0010 #define DTLK_CLEAR 0x18     /* stops speech */
0011
0012 #define DTLK_MAX_RETRIES (loops_per_jiffy/(10000/HZ))
0013
0014     /* TTS Port Status Flags */
0015 #define TTS_READABLE     0x80   /* mask for bit which is nonzero if a
0016                    byte can be read from the TTS port */
0017 #define TTS_SPEAKING     0x40   /* mask for SYNC bit, which is nonzero
0018                    while DoubleTalk is producing
0019                    output with TTS, PCM or CVSD
0020                    synthesizers or tone generators
0021                    (that is, all but LPC) */
0022 #define TTS_SPEAKING2    0x20   /* mask for SYNC2 bit,
0023                    which falls to zero up to 0.4 sec
0024                    before speech stops */
0025 #define TTS_WRITABLE     0x10   /* mask for RDY bit, which when set to
0026                            1, indicates the TTS port is ready
0027                            to accept a byte of data.  The RDY
0028                            bit goes zero 2-3 usec after
0029                            writing, and goes 1 again 180-190
0030                            usec later. */
0031 #define TTS_ALMOST_FULL  0x08   /* mask for AF bit: When set to 1,
0032                    indicates that less than 300 free
0033                    bytes are available in the TTS
0034                    input buffer. AF is always 0 in the
0035                    PCM, TGN and CVSD modes. */
0036 #define TTS_ALMOST_EMPTY 0x04   /* mask for AE bit: When set to 1,
0037                    indicates that less than 300 bytes
0038                    of data remain in DoubleTalk's
0039                    input (TTS or PCM) buffer. AE is
0040                    always 1 in the TGN and CVSD
0041                    modes. */
0042
0043     /* LPC speak commands */
0044 #define LPC_5220_NORMAL 0x60    /* 5220 format decoding table, normal rate */
0045 #define LPC_5220_FAST 0x64  /* 5220 format decoding table, fast rate */
0046 #define LPC_D6_NORMAL 0x20  /* D6 format decoding table, normal rate */
0047 #define LPC_D6_FAST 0x24    /* D6 format decoding table, fast rate */
0048
0049     /* LPC Port Status Flags (valid only after one of the LPC
0050            speak commands) */
0051 #define LPC_SPEAKING     0x80   /* mask for TS bit: When set to 1,
0052                    indicates the LPC synthesizer is
0053                    producing speech.*/
0054 #define LPC_BUFFER_LOW   0x40   /* mask for BL bit: When set to 1,
0055                    indicates that the hardware LPC
0056                    data buffer has less than 30 bytes
0057                    remaining. (Total internal buffer
0058                    size = 4096 bytes.) */
0059 #define LPC_BUFFER_EMPTY 0x20   /* mask for BE bit: When set to 1,
0060                    indicates that the LPC data buffer
0061                    ran out of data (error condition if
0062                    TS is also 1).  */
0063
0064                 /* data returned by Interrogate command */
0065 struct dtlk_settings
0066 {
0067   unsigned short serial_number; /* 0-7Fh:0-7Fh */
0068   unsigned char rom_version[24]; /* null terminated string */
0069   unsigned char mode;       /* 0=Character; 1=Phoneme; 2=Text */
0070   unsigned char punc_level; /* nB; 0-7 */
0071   unsigned char formant_freq;   /* nF; 0-9 */
0072   unsigned char pitch;      /* nP; 0-99 */
0073   unsigned char speed;      /* nS; 0-9 */
0074   unsigned char volume;     /* nV; 0-9 */
0075   unsigned char tone;       /* nX; 0-2 */
0076   unsigned char expression; /* nE; 0-9 */
0077   unsigned char ext_dict_loaded; /* 1=exception dictionary loaded */
0078   unsigned char ext_dict_status; /* 1=exception dictionary enabled */
0079   unsigned char free_ram;   /* # pages (truncated) remaining for
0080                                    text buffer */
0081   unsigned char articulation;   /* nA; 0-9 */
0082   unsigned char reverb;     /* nR; 0-9 */
0083   unsigned char eob;        /* 7Fh value indicating end of
0084                                    parameter block */
0085   unsigned char has_indexing;   /* nonzero if indexing is implemented */
0086 };