include/linux/dtlk.h

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