drivers/accessibility/speakup/speakup_audptr.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * originally written by: Kirk Reiser <kirk@braille.uwo.ca>
   4  * this version considerably modified by David Borowski, david575@rogers.com
   5  *
   6  * Copyright (C) 1998-99  Kirk Reiser.
   7  * Copyright (C) 2003 David Borowski.
   8  *
   9  * specificly written as a driver for the speakup screenreview
  10  * s not a general device driver.
  11  */
  12 #include "spk_priv.h"
  13 #include "speakup.h"
  14
  15 #define DRV_VERSION "2.11"
  16 #define SYNTH_CLEAR 0x18 /* flush synth buffer */
  17 #define PROCSPEECH '\r' /* start synth processing speech char */
  18
  19 static int synth_probe(struct spk_synth *synth);
  20 static void synth_flush(struct spk_synth *synth);
  21
  22 static struct var_t vars[] = {
  23         { CAPS_START, .u.s = {"\x05[f99]" } },
  24         { CAPS_STOP, .u.s = {"\x05[f80]" } },
  25         { RATE, .u.n = {"\x05[r%d]", 10, 0, 20, 100, -10, NULL } },
  26         { PITCH, .u.n = {"\x05[f%d]", 80, 39, 4500, 0, 0, NULL } },
  27         { VOL, .u.n = {"\x05[g%d]", 21, 0, 40, 0, 0, NULL } },
  28         { TONE, .u.n = {"\x05[s%d]", 9, 0, 63, 0, 0, NULL } },
  29         { PUNCT, .u.n = {"\x05[A%c]", 0, 0, 3, 0, 0, "nmsa" } },
  30         { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
  31         V_LAST_VAR
  32 };
  33
  34 /*
  35  * These attributes will appear in /sys/accessibility/speakup/audptr.
  36  */
  37 static struct kobj_attribute caps_start_attribute =
  38         __ATTR(caps_start, 0644, spk_var_show, spk_var_store);
  39 static struct kobj_attribute caps_stop_attribute =
  40         __ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
  41 static struct kobj_attribute pitch_attribute =
  42         __ATTR(pitch, 0644, spk_var_show, spk_var_store);
  43 static struct kobj_attribute punct_attribute =
  44         __ATTR(punct, 0644, spk_var_show, spk_var_store);
  45 static struct kobj_attribute rate_attribute =
  46         __ATTR(rate, 0644, spk_var_show, spk_var_store);
  47 static struct kobj_attribute tone_attribute =
  48         __ATTR(tone, 0644, spk_var_show, spk_var_store);
  49 static struct kobj_attribute vol_attribute =
  50         __ATTR(vol, 0644, spk_var_show, spk_var_store);
  51
  52 static struct kobj_attribute delay_time_attribute =
  53         __ATTR(delay_time, 0644, spk_var_show, spk_var_store);
  54 static struct kobj_attribute direct_attribute =
  55         __ATTR(direct, 0644, spk_var_show, spk_var_store);
  56 static struct kobj_attribute full_time_attribute =
  57         __ATTR(full_time, 0644, spk_var_show, spk_var_store);
  58 static struct kobj_attribute jiffy_delta_attribute =
  59         __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
  60 static struct kobj_attribute trigger_time_attribute =
  61         __ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
  62
  63 /*
  64  * Create a group of attributes so that we can create and destroy them all
  65  * at once.
  66  */
  67 static struct attribute *synth_attrs[] = {
  68         &caps_start_attribute.attr,
  69         &caps_stop_attribute.attr,
  70         &pitch_attribute.attr,
  71         &punct_attribute.attr,
  72         &rate_attribute.attr,
  73         &tone_attribute.attr,
  74         &vol_attribute.attr,
  75         &delay_time_attribute.attr,
  76         &direct_attribute.attr,
  77         &full_time_attribute.attr,
  78         &jiffy_delta_attribute.attr,
  79         &trigger_time_attribute.attr,
  80         NULL,   /* need to NULL terminate the list of attributes */
  81 };
  82
  83 static struct spk_synth synth_audptr = {
  84         .name = "audptr",
  85         .version = DRV_VERSION,
  86         .long_name = "Audapter",
  87         .init = "\x05[D1]\x05[Ol]",
  88         .procspeech = PROCSPEECH,
  89         .clear = SYNTH_CLEAR,
  90         .delay = 400,
  91         .trigger = 50,
  92         .jiffies = 30,
  93         .full = 18000,
  94         .dev_name = SYNTH_DEFAULT_DEV,
  95         .startup = SYNTH_START,
  96         .checkval = SYNTH_CHECK,
  97         .vars = vars,
  98         .io_ops = &spk_ttyio_ops,
  99         .probe = synth_probe,
 100         .release = spk_ttyio_release,
 101         .synth_immediate = spk_ttyio_synth_immediate,
 102         .catch_up = spk_do_catch_up,
 103         .flush = synth_flush,
 104         .is_alive = spk_synth_is_alive_restart,
 105         .synth_adjust = NULL,
 106         .read_buff_add = NULL,
 107         .get_index = NULL,
 108         .indexing = {
 109                 .command = NULL,
 110                 .lowindex = 0,
 111                 .highindex = 0,
 112                 .currindex = 0,
 113         },
 114         .attributes = {
 115                 .attrs = synth_attrs,
 116                 .name = "audptr",
 117         },
 118 };
 119
 120 static void synth_flush(struct spk_synth *synth)
 121 {
 122         synth->io_ops->flush_buffer();
 123         synth->io_ops->send_xchar(SYNTH_CLEAR);
 124         synth->io_ops->synth_out(synth, PROCSPEECH);
 125 }
 126
 127 static void synth_version(struct spk_synth *synth)
 128 {
 129         unsigned char test = 0;
 130         char synth_id[40] = "";
 131
 132         synth->synth_immediate(synth, "\x05[Q]");
 133         synth_id[test] = synth->io_ops->synth_in();
 134         if (synth_id[test] == 'A') {
 135                 do {
 136                         /* read version string from synth */
 137                         synth_id[++test] = synth->io_ops->synth_in();
 138                 } while (synth_id[test] != '\n' && test < 32);
 139                 synth_id[++test] = 0x00;
 140         }
 141         if (synth_id[0] == 'A')
 142                 pr_info("%s version: %s", synth->long_name, synth_id);
 143 }
 144
 145 static int synth_probe(struct spk_synth *synth)
 146 {
 147         int failed;
 148
 149         failed = spk_ttyio_synth_probe(synth);
 150         if (failed == 0)
 151                 synth_version(synth);
 152         synth->alive = !failed;
 153         return 0;
 154 }
 155
 156 module_param_named(ser, synth_audptr.ser, int, 0444);
 157 module_param_named(dev, synth_audptr.dev_name, charp, 0444);
 158 module_param_named(start, synth_audptr.startup, short, 0444);
 159
 160 MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
 161 MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer.");
 162 MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
 163
 164 module_spk_synth(synth_audptr);
 165
 166 MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
 167 MODULE_AUTHOR("David Borowski");
 168 MODULE_DESCRIPTION("Speakup support for Audapter synthesizer");
 169 MODULE_LICENSE("GPL");
 170 MODULE_VERSION(DRV_VERSION);
 171