drivers/accessibility/speakup/speakup_bns.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  * this code is specifically written as a driver for the speakup screenreview
  10  * package and is 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
  17 #define PROCSPEECH '\r'
  18
  19
  20 enum default_vars_id {
  21         CAPS_START_ID = 0, CAPS_STOP_ID,
  22         RATE_ID, PITCH_ID,
  23         VOL_ID, TONE_ID,
  24         DIRECT_ID, V_LAST_VAR_ID,
  25         NB_ID
  26 };
  27
  28 static struct var_t vars[NB_ID] = {
  29         [CAPS_START_ID] = { CAPS_START, .u.s = {"\x05\x31\x32P" } },
  30         [CAPS_STOP_ID] = { CAPS_STOP, .u.s = {"\x05\x38P" } },
  31         [RATE_ID] = { RATE, .u.n = {"\x05%dE", 8, 1, 16, 0, 0, NULL } },
  32         [PITCH_ID] = { PITCH, .u.n = {"\x05%dP", 8, 0, 16, 0, 0, NULL } },
  33         [VOL_ID] = { VOL, .u.n = {"\x05%dV", 8, 0, 16, 0, 0, NULL } },
  34         [TONE_ID] = { TONE, .u.n = {"\x05%dT", 8, 0, 16, 0, 0, NULL } },
  35         [DIRECT_ID] = { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
  36         V_LAST_VAR
  37 };
  38
  39 /*
  40  * These attributes will appear in /sys/accessibility/speakup/bns.
  41  */
  42 static struct kobj_attribute caps_start_attribute =
  43         __ATTR(caps_start, 0644, spk_var_show, spk_var_store);
  44 static struct kobj_attribute caps_stop_attribute =
  45         __ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
  46 static struct kobj_attribute pitch_attribute =
  47         __ATTR(pitch, 0644, spk_var_show, spk_var_store);
  48 static struct kobj_attribute rate_attribute =
  49         __ATTR(rate, 0644, spk_var_show, spk_var_store);
  50 static struct kobj_attribute tone_attribute =
  51         __ATTR(tone, 0644, spk_var_show, spk_var_store);
  52 static struct kobj_attribute vol_attribute =
  53         __ATTR(vol, 0644, spk_var_show, spk_var_store);
  54
  55 static struct kobj_attribute delay_time_attribute =
  56         __ATTR(delay_time, 0644, spk_var_show, spk_var_store);
  57 static struct kobj_attribute direct_attribute =
  58         __ATTR(direct, 0644, spk_var_show, spk_var_store);
  59 static struct kobj_attribute full_time_attribute =
  60         __ATTR(full_time, 0644, spk_var_show, spk_var_store);
  61 static struct kobj_attribute jiffy_delta_attribute =
  62         __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
  63 static struct kobj_attribute trigger_time_attribute =
  64         __ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
  65
  66 /*
  67  * Create a group of attributes so that we can create and destroy them all
  68  * at once.
  69  */
  70 static struct attribute *synth_attrs[] = {
  71         &caps_start_attribute.attr,
  72         &caps_stop_attribute.attr,
  73         &pitch_attribute.attr,
  74         &rate_attribute.attr,
  75         &tone_attribute.attr,
  76         &vol_attribute.attr,
  77         &delay_time_attribute.attr,
  78         &direct_attribute.attr,
  79         &full_time_attribute.attr,
  80         &jiffy_delta_attribute.attr,
  81         &trigger_time_attribute.attr,
  82         NULL,   /* need to NULL terminate the list of attributes */
  83 };
  84
  85 static struct spk_synth synth_bns = {
  86         .name = "bns",
  87         .version = DRV_VERSION,
  88         .long_name = "Braille 'N Speak",
  89         .init = "\x05Z\x05\x43",
  90         .procspeech = PROCSPEECH,
  91         .clear = SYNTH_CLEAR,
  92         .delay = 500,
  93         .trigger = 50,
  94         .jiffies = 50,
  95         .full = 40000,
  96         .dev_name = SYNTH_DEFAULT_DEV,
  97         .startup = SYNTH_START,
  98         .checkval = SYNTH_CHECK,
  99         .vars = vars,
 100         .io_ops = &spk_ttyio_ops,
 101         .probe = spk_ttyio_synth_probe,
 102         .release = spk_ttyio_release,
 103         .synth_immediate = spk_ttyio_synth_immediate,
 104         .catch_up = spk_do_catch_up,
 105         .flush = spk_synth_flush,
 106         .is_alive = spk_synth_is_alive_restart,
 107         .synth_adjust = NULL,
 108         .read_buff_add = NULL,
 109         .get_index = NULL,
 110         .indexing = {
 111                 .command = NULL,
 112                 .lowindex = 0,
 113                 .highindex = 0,
 114                 .currindex = 0,
 115         },
 116         .attributes = {
 117                 .attrs = synth_attrs,
 118                 .name = "bns",
 119         },
 120 };
 121
 122 module_param_named(ser, synth_bns.ser, int, 0444);
 123 module_param_named(dev, synth_bns.dev_name, charp, 0444);
 124 module_param_named(start, synth_bns.startup, short, 0444);
 125 module_param_named(rate, vars[RATE_ID].u.n.default_val, int, 0444);
 126 module_param_named(pitch, vars[PITCH_ID].u.n.default_val, int, 0444);
 127 module_param_named(vol, vars[VOL_ID].u.n.default_val, int, 0444);
 128 module_param_named(tone, vars[TONE_ID].u.n.default_val, int, 0444);
 129 module_param_named(direct, vars[DIRECT_ID].u.n.default_val, int, 0444);
 130
 131
 132 MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
 133 MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer.");
 134 MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
 135 MODULE_PARM_DESC(rate, "Set the rate variable on load.");
 136 MODULE_PARM_DESC(pitch, "Set the pitch variable on load.");
 137 MODULE_PARM_DESC(vol, "Set the vol variable on load.");
 138 MODULE_PARM_DESC(tone, "Set the tone variable on load.");
 139 MODULE_PARM_DESC(direct, "Set the direct variable on load.");
 140
 141 module_spk_synth(synth_bns);
 142
 143 MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
 144 MODULE_AUTHOR("David Borowski");
 145 MODULE_DESCRIPTION("Speakup support for Braille 'n Speak synthesizers");
 146 MODULE_LICENSE("GPL");
 147 MODULE_VERSION(DRV_VERSION);
 148