linux/drivers/accessibility/speakup/speakup_dectlk.c
<<
>>
Prefs
   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 <linux/unistd.h>
  13#include <linux/proc_fs.h>
  14#include <linux/jiffies.h>
  15#include <linux/spinlock.h>
  16#include <linux/sched.h>
  17#include <linux/timer.h>
  18#include <linux/kthread.h>
  19#include "speakup.h"
  20#include "spk_priv.h"
  21
  22#define DRV_VERSION "2.20"
  23#define SYNTH_CLEAR 0x03
  24#define PROCSPEECH 0x0b
  25static int xoff;
  26
  27static inline int synth_full(void)
  28{
  29        return xoff;
  30}
  31
  32static void do_catch_up(struct spk_synth *synth);
  33static void synth_flush(struct spk_synth *synth);
  34static void read_buff_add(u_char c);
  35static unsigned char get_index(struct spk_synth *synth);
  36
  37static int in_escape;
  38static int is_flushing;
  39
  40static DEFINE_SPINLOCK(flush_lock);
  41static DECLARE_WAIT_QUEUE_HEAD(flush);
  42
  43static struct var_t vars[] = {
  44        { CAPS_START, .u.s = {"[:dv ap 160] " } },
  45        { CAPS_STOP, .u.s = {"[:dv ap 100 ] " } },
  46        { RATE, .u.n = {"[:ra %d] ", 180, 75, 650, 0, 0, NULL } },
  47        { INFLECTION, .u.n = {"[:dv pr %d] ", 100, 0, 10000, 0, 0, NULL } },
  48        { VOL, .u.n = {"[:dv g5 %d] ", 86, 60, 86, 0, 0, NULL } },
  49        { PUNCT, .u.n = {"[:pu %c] ", 0, 0, 2, 0, 0, "nsa" } },
  50        { VOICE, .u.n = {"[:n%c] ", 0, 0, 9, 0, 0, "phfdburwkv" } },
  51        { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
  52        V_LAST_VAR
  53};
  54
  55/*
  56 * These attributes will appear in /sys/accessibility/speakup/dectlk.
  57 */
  58static struct kobj_attribute caps_start_attribute =
  59        __ATTR(caps_start, 0644, spk_var_show, spk_var_store);
  60static struct kobj_attribute caps_stop_attribute =
  61        __ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
  62static struct kobj_attribute pitch_attribute =
  63        __ATTR(pitch, 0644, spk_var_show, spk_var_store);
  64static struct kobj_attribute inflection_attribute =
  65        __ATTR(inflection, 0644, spk_var_show, spk_var_store);
  66static struct kobj_attribute punct_attribute =
  67        __ATTR(punct, 0644, spk_var_show, spk_var_store);
  68static struct kobj_attribute rate_attribute =
  69        __ATTR(rate, 0644, spk_var_show, spk_var_store);
  70static struct kobj_attribute voice_attribute =
  71        __ATTR(voice, 0644, spk_var_show, spk_var_store);
  72static struct kobj_attribute vol_attribute =
  73        __ATTR(vol, 0644, spk_var_show, spk_var_store);
  74
  75static struct kobj_attribute delay_time_attribute =
  76        __ATTR(delay_time, 0644, spk_var_show, spk_var_store);
  77static struct kobj_attribute direct_attribute =
  78        __ATTR(direct, 0644, spk_var_show, spk_var_store);
  79static struct kobj_attribute full_time_attribute =
  80        __ATTR(full_time, 0644, spk_var_show, spk_var_store);
  81static struct kobj_attribute flush_time_attribute =
  82        __ATTR(flush_time, 0644, spk_var_show, spk_var_store);
  83static struct kobj_attribute jiffy_delta_attribute =
  84        __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
  85static struct kobj_attribute trigger_time_attribute =
  86        __ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
  87
  88/*
  89 * Create a group of attributes so that we can create and destroy them all
  90 * at once.
  91 */
  92static struct attribute *synth_attrs[] = {
  93        &caps_start_attribute.attr,
  94        &caps_stop_attribute.attr,
  95        &pitch_attribute.attr,
  96        &inflection_attribute.attr,
  97        &punct_attribute.attr,
  98        &rate_attribute.attr,
  99        &voice_attribute.attr,
 100        &vol_attribute.attr,
 101        &delay_time_attribute.attr,
 102        &direct_attribute.attr,
 103        &full_time_attribute.attr,
 104        &flush_time_attribute.attr,
 105        &jiffy_delta_attribute.attr,
 106        &trigger_time_attribute.attr,
 107        NULL,   /* need to NULL terminate the list of attributes */
 108};
 109
 110static int ap_defaults[] = {122, 89, 155, 110, 208, 240, 200, 106, 306};
 111static int g5_defaults[] = {86, 81, 86, 84, 81, 80, 83, 83, 73};
 112
 113static struct spk_synth synth_dectlk = {
 114        .name = "dectlk",
 115        .version = DRV_VERSION,
 116        .long_name = "Dectalk Express",
 117        .init = "[:error sp :name paul :rate 180 :tsr off] ",
 118        .procspeech = PROCSPEECH,
 119        .clear = SYNTH_CLEAR,
 120        .delay = 500,
 121        .trigger = 50,
 122        .jiffies = 50,
 123        .full = 40000,
 124        .flush_time = 4000,
 125        .dev_name = SYNTH_DEFAULT_DEV,
 126        .startup = SYNTH_START,
 127        .checkval = SYNTH_CHECK,
 128        .vars = vars,
 129        .default_pitch = ap_defaults,
 130        .default_vol = g5_defaults,
 131        .io_ops = &spk_ttyio_ops,
 132        .probe = spk_ttyio_synth_probe,
 133        .release = spk_ttyio_release,
 134        .synth_immediate = spk_ttyio_synth_immediate,
 135        .catch_up = do_catch_up,
 136        .flush = synth_flush,
 137        .is_alive = spk_synth_is_alive_restart,
 138        .synth_adjust = NULL,
 139        .read_buff_add = read_buff_add,
 140        .get_index = get_index,
 141        .indexing = {
 142                .command = "[:in re %d ] ",
 143                .lowindex = 1,
 144                .highindex = 8,
 145                .currindex = 1,
 146        },
 147        .attributes = {
 148                .attrs = synth_attrs,
 149                .name = "dectlk",
 150        },
 151};
 152
 153static int is_indnum(u_char *ch)
 154{
 155        if ((*ch >= '0') && (*ch <= '9')) {
 156                *ch = *ch - '0';
 157                return 1;
 158        }
 159        return 0;
 160}
 161
 162static u_char lastind;
 163
 164static unsigned char get_index(struct spk_synth *synth)
 165{
 166        u_char rv;
 167
 168        rv = lastind;
 169        lastind = 0;
 170        return rv;
 171}
 172
 173static void read_buff_add(u_char c)
 174{
 175        static int ind = -1;
 176
 177        if (c == 0x01) {
 178                unsigned long flags;
 179
 180                spin_lock_irqsave(&flush_lock, flags);
 181                is_flushing = 0;
 182                wake_up_interruptible(&flush);
 183                spin_unlock_irqrestore(&flush_lock, flags);
 184        } else if (c == 0x13) {
 185                xoff = 1;
 186        } else if (c == 0x11) {
 187                xoff = 0;
 188        } else if (is_indnum(&c)) {
 189                if (ind == -1)
 190                        ind = c;
 191                else
 192                        ind = ind * 10 + c;
 193        } else if ((c > 31) && (c < 127)) {
 194                if (ind != -1)
 195                        lastind = (u_char)ind;
 196                ind = -1;
 197        }
 198}
 199
 200static void do_catch_up(struct spk_synth *synth)
 201{
 202        int synth_full_val = 0;
 203        static u_char ch;
 204        static u_char last = '\0';
 205        unsigned long flags;
 206        unsigned long jiff_max;
 207        unsigned long timeout;
 208        DEFINE_WAIT(wait);
 209        struct var_t *jiffy_delta;
 210        struct var_t *delay_time;
 211        struct var_t *flush_time;
 212        int jiffy_delta_val;
 213        int delay_time_val;
 214        int timeout_val;
 215
 216        jiffy_delta = spk_get_var(JIFFY);
 217        delay_time = spk_get_var(DELAY);
 218        flush_time = spk_get_var(FLUSH);
 219        spin_lock_irqsave(&speakup_info.spinlock, flags);
 220        jiffy_delta_val = jiffy_delta->u.n.value;
 221        timeout_val = flush_time->u.n.value;
 222        spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 223        timeout = msecs_to_jiffies(timeout_val);
 224        jiff_max = jiffies + jiffy_delta_val;
 225
 226        while (!kthread_should_stop()) {
 227                /* if no ctl-a in 4, send data anyway */
 228                spin_lock_irqsave(&flush_lock, flags);
 229                while (is_flushing && timeout) {
 230                        prepare_to_wait(&flush, &wait, TASK_INTERRUPTIBLE);
 231                        spin_unlock_irqrestore(&flush_lock, flags);
 232                        timeout = schedule_timeout(timeout);
 233                        spin_lock_irqsave(&flush_lock, flags);
 234                }
 235                finish_wait(&flush, &wait);
 236                is_flushing = 0;
 237                spin_unlock_irqrestore(&flush_lock, flags);
 238
 239                spin_lock_irqsave(&speakup_info.spinlock, flags);
 240                if (speakup_info.flushing) {
 241                        speakup_info.flushing = 0;
 242                        spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 243                        synth->flush(synth);
 244                        continue;
 245                }
 246                synth_buffer_skip_nonlatin1();
 247                if (synth_buffer_empty()) {
 248                        spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 249                        break;
 250                }
 251                ch = synth_buffer_peek();
 252                set_current_state(TASK_INTERRUPTIBLE);
 253                delay_time_val = delay_time->u.n.value;
 254                synth_full_val = synth_full();
 255                spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 256                if (ch == '\n')
 257                        ch = 0x0D;
 258                if (synth_full_val || !synth->io_ops->synth_out(synth, ch)) {
 259                        schedule_timeout(msecs_to_jiffies(delay_time_val));
 260                        continue;
 261                }
 262                set_current_state(TASK_RUNNING);
 263                spin_lock_irqsave(&speakup_info.spinlock, flags);
 264                synth_buffer_getc();
 265                spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 266                if (ch == '[') {
 267                        in_escape = 1;
 268                } else if (ch == ']') {
 269                        in_escape = 0;
 270                } else if (ch <= SPACE) {
 271                        if (!in_escape && strchr(",.!?;:", last))
 272                                synth->io_ops->synth_out(synth, PROCSPEECH);
 273                        if (time_after_eq(jiffies, jiff_max)) {
 274                                if (!in_escape)
 275                                        synth->io_ops->synth_out(synth,
 276                                                                 PROCSPEECH);
 277                                spin_lock_irqsave(&speakup_info.spinlock,
 278                                                  flags);
 279                                jiffy_delta_val = jiffy_delta->u.n.value;
 280                                delay_time_val = delay_time->u.n.value;
 281                                spin_unlock_irqrestore(&speakup_info.spinlock,
 282                                                       flags);
 283                                schedule_timeout(msecs_to_jiffies
 284                                                 (delay_time_val));
 285                                jiff_max = jiffies + jiffy_delta_val;
 286                        }
 287                }
 288                last = ch;
 289        }
 290        if (!in_escape)
 291                synth->io_ops->synth_out(synth, PROCSPEECH);
 292}
 293
 294static void synth_flush(struct spk_synth *synth)
 295{
 296        if (in_escape)
 297                /* if in command output ']' so we don't get an error */
 298                synth->io_ops->synth_out(synth, ']');
 299        in_escape = 0;
 300        is_flushing = 1;
 301        synth->io_ops->flush_buffer(synth);
 302        synth->io_ops->synth_out(synth, SYNTH_CLEAR);
 303}
 304
 305module_param_named(ser, synth_dectlk.ser, int, 0444);
 306module_param_named(dev, synth_dectlk.dev_name, charp, 0444);
 307module_param_named(start, synth_dectlk.startup, short, 0444);
 308
 309MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
 310MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer.");
 311MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
 312
 313module_spk_synth(synth_dectlk);
 314
 315MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
 316MODULE_AUTHOR("David Borowski");
 317MODULE_DESCRIPTION("Speakup support for DECtalk Express synthesizers");
 318MODULE_LICENSE("GPL");
 319MODULE_VERSION(DRV_VERSION);
 320
 321