12067fd92SSamuel Thibault // SPDX-License-Identifier: GPL-2.0+
22067fd92SSamuel Thibault /*
32067fd92SSamuel Thibault * originally written by: Kirk Reiser <kirk@braille.uwo.ca>
42067fd92SSamuel Thibault * this version considerably modified by David Borowski, david575@rogers.com
52067fd92SSamuel Thibault *
62067fd92SSamuel Thibault * Copyright (C) 1998-99 Kirk Reiser.
72067fd92SSamuel Thibault * Copyright (C) 2003 David Borowski.
82067fd92SSamuel Thibault *
90b4efcb1STom Rix * specifically written as a driver for the speakup screenreview
102067fd92SSamuel Thibault * s not a general device driver.
112067fd92SSamuel Thibault */
122067fd92SSamuel Thibault #include <linux/jiffies.h>
132067fd92SSamuel Thibault #include <linux/sched.h>
142067fd92SSamuel Thibault #include <linux/timer.h>
152067fd92SSamuel Thibault #include <linux/kthread.h>
162067fd92SSamuel Thibault
172067fd92SSamuel Thibault #include "spk_priv.h"
182067fd92SSamuel Thibault #include "speakup.h"
192067fd92SSamuel Thibault
202067fd92SSamuel Thibault #define DRV_VERSION "2.14"
212067fd92SSamuel Thibault #define SYNTH_CLEAR 0x03
222067fd92SSamuel Thibault #define PROCSPEECH 0x0b
232067fd92SSamuel Thibault
242067fd92SSamuel Thibault static volatile unsigned char last_char;
252067fd92SSamuel Thibault
read_buff_add(u_char ch)262067fd92SSamuel Thibault static void read_buff_add(u_char ch)
272067fd92SSamuel Thibault {
282067fd92SSamuel Thibault last_char = ch;
292067fd92SSamuel Thibault }
302067fd92SSamuel Thibault
synth_full(void)312067fd92SSamuel Thibault static inline bool synth_full(void)
322067fd92SSamuel Thibault {
332067fd92SSamuel Thibault return last_char == 0x13;
342067fd92SSamuel Thibault }
352067fd92SSamuel Thibault
362067fd92SSamuel Thibault static void do_catch_up(struct spk_synth *synth);
372067fd92SSamuel Thibault static void synth_flush(struct spk_synth *synth);
382067fd92SSamuel Thibault
392067fd92SSamuel Thibault static int in_escape;
402067fd92SSamuel Thibault
41*f613f00eSOsama Muhammad
42*f613f00eSOsama Muhammad enum default_vars_id {
43*f613f00eSOsama Muhammad CAPS_START_ID = 0, CAPS_STOP_ID,
44*f613f00eSOsama Muhammad RATE_ID, PITCH_ID, INFLECTION_ID,
45*f613f00eSOsama Muhammad VOL_ID, PUNCT_ID, VOICE_ID,
46*f613f00eSOsama Muhammad DIRECT_ID, V_LAST_ID,
47*f613f00eSOsama Muhammad NB_ID,
48*f613f00eSOsama Muhammad };
49*f613f00eSOsama Muhammad
50*f613f00eSOsama Muhammad static struct var_t vars[NB_ID] = {
51*f613f00eSOsama Muhammad [CAPS_START_ID] = { CAPS_START, .u.s = {"[:dv ap 222]" } },
52*f613f00eSOsama Muhammad [CAPS_STOP_ID] = { CAPS_STOP, .u.s = {"[:dv ap 100]" } },
53*f613f00eSOsama Muhammad [RATE_ID] = { RATE, .u.n = {"[:ra %d]", 7, 0, 9, 150, 25, NULL } },
54*f613f00eSOsama Muhammad [PITCH_ID] = { PITCH, .u.n = {"[:dv ap %d]", 100, 0, 100, 0, 0, NULL } },
55*f613f00eSOsama Muhammad [INFLECTION_ID] = { INFLECTION, .u.n = {"[:dv pr %d] ", 100, 0, 10000, 0, 0, NULL } },
56*f613f00eSOsama Muhammad [VOL_ID] = { VOL, .u.n = {"[:dv gv %d]", 13, 0, 16, 0, 5, NULL } },
57*f613f00eSOsama Muhammad [PUNCT_ID] = { PUNCT, .u.n = {"[:pu %c]", 0, 0, 2, 0, 0, "nsa" } },
58*f613f00eSOsama Muhammad [VOICE_ID] = { VOICE, .u.n = {"[:n%c]", 0, 0, 9, 0, 0, "phfdburwkv" } },
59*f613f00eSOsama Muhammad [DIRECT_ID] = { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
602067fd92SSamuel Thibault V_LAST_VAR
612067fd92SSamuel Thibault };
622067fd92SSamuel Thibault
632067fd92SSamuel Thibault /*
642067fd92SSamuel Thibault * These attributes will appear in /sys/accessibility/speakup/decext.
652067fd92SSamuel Thibault */
662067fd92SSamuel Thibault static struct kobj_attribute caps_start_attribute =
672067fd92SSamuel Thibault __ATTR(caps_start, 0644, spk_var_show, spk_var_store);
682067fd92SSamuel Thibault static struct kobj_attribute caps_stop_attribute =
692067fd92SSamuel Thibault __ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
702067fd92SSamuel Thibault static struct kobj_attribute pitch_attribute =
712067fd92SSamuel Thibault __ATTR(pitch, 0644, spk_var_show, spk_var_store);
722067fd92SSamuel Thibault static struct kobj_attribute inflection_attribute =
732067fd92SSamuel Thibault __ATTR(inflection, 0644, spk_var_show, spk_var_store);
742067fd92SSamuel Thibault static struct kobj_attribute punct_attribute =
752067fd92SSamuel Thibault __ATTR(punct, 0644, spk_var_show, spk_var_store);
762067fd92SSamuel Thibault static struct kobj_attribute rate_attribute =
772067fd92SSamuel Thibault __ATTR(rate, 0644, spk_var_show, spk_var_store);
782067fd92SSamuel Thibault static struct kobj_attribute voice_attribute =
792067fd92SSamuel Thibault __ATTR(voice, 0644, spk_var_show, spk_var_store);
802067fd92SSamuel Thibault static struct kobj_attribute vol_attribute =
812067fd92SSamuel Thibault __ATTR(vol, 0644, spk_var_show, spk_var_store);
822067fd92SSamuel Thibault
832067fd92SSamuel Thibault static struct kobj_attribute delay_time_attribute =
842067fd92SSamuel Thibault __ATTR(delay_time, 0644, spk_var_show, spk_var_store);
852067fd92SSamuel Thibault static struct kobj_attribute direct_attribute =
862067fd92SSamuel Thibault __ATTR(direct, 0644, spk_var_show, spk_var_store);
872067fd92SSamuel Thibault static struct kobj_attribute full_time_attribute =
882067fd92SSamuel Thibault __ATTR(full_time, 0644, spk_var_show, spk_var_store);
892067fd92SSamuel Thibault static struct kobj_attribute jiffy_delta_attribute =
902067fd92SSamuel Thibault __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
912067fd92SSamuel Thibault static struct kobj_attribute trigger_time_attribute =
922067fd92SSamuel Thibault __ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
932067fd92SSamuel Thibault
942067fd92SSamuel Thibault /*
952067fd92SSamuel Thibault * Create a group of attributes so that we can create and destroy them all
962067fd92SSamuel Thibault * at once.
972067fd92SSamuel Thibault */
982067fd92SSamuel Thibault static struct attribute *synth_attrs[] = {
992067fd92SSamuel Thibault &caps_start_attribute.attr,
1002067fd92SSamuel Thibault &caps_stop_attribute.attr,
1012067fd92SSamuel Thibault &pitch_attribute.attr,
1022067fd92SSamuel Thibault &inflection_attribute.attr,
1032067fd92SSamuel Thibault &punct_attribute.attr,
1042067fd92SSamuel Thibault &rate_attribute.attr,
1052067fd92SSamuel Thibault &voice_attribute.attr,
1062067fd92SSamuel Thibault &vol_attribute.attr,
1072067fd92SSamuel Thibault &delay_time_attribute.attr,
1082067fd92SSamuel Thibault &direct_attribute.attr,
1092067fd92SSamuel Thibault &full_time_attribute.attr,
1102067fd92SSamuel Thibault &jiffy_delta_attribute.attr,
1112067fd92SSamuel Thibault &trigger_time_attribute.attr,
1122067fd92SSamuel Thibault NULL, /* need to NULL terminate the list of attributes */
1132067fd92SSamuel Thibault };
1142067fd92SSamuel Thibault
1152067fd92SSamuel Thibault static struct spk_synth synth_decext = {
1162067fd92SSamuel Thibault .name = "decext",
1172067fd92SSamuel Thibault .version = DRV_VERSION,
1182067fd92SSamuel Thibault .long_name = "Dectalk External",
1192067fd92SSamuel Thibault .init = "[:pe -380]",
1202067fd92SSamuel Thibault .procspeech = PROCSPEECH,
1212067fd92SSamuel Thibault .clear = SYNTH_CLEAR,
1222067fd92SSamuel Thibault .delay = 500,
1232067fd92SSamuel Thibault .trigger = 50,
1242067fd92SSamuel Thibault .jiffies = 50,
1252067fd92SSamuel Thibault .full = 40000,
1262067fd92SSamuel Thibault .flags = SF_DEC,
1272067fd92SSamuel Thibault .dev_name = SYNTH_DEFAULT_DEV,
1282067fd92SSamuel Thibault .startup = SYNTH_START,
1292067fd92SSamuel Thibault .checkval = SYNTH_CHECK,
1302067fd92SSamuel Thibault .vars = vars,
1312067fd92SSamuel Thibault .io_ops = &spk_ttyio_ops,
1322067fd92SSamuel Thibault .probe = spk_ttyio_synth_probe,
1332067fd92SSamuel Thibault .release = spk_ttyio_release,
1342067fd92SSamuel Thibault .synth_immediate = spk_ttyio_synth_immediate,
1352067fd92SSamuel Thibault .catch_up = do_catch_up,
1362067fd92SSamuel Thibault .flush = synth_flush,
1372067fd92SSamuel Thibault .is_alive = spk_synth_is_alive_restart,
1382067fd92SSamuel Thibault .synth_adjust = NULL,
1392067fd92SSamuel Thibault .read_buff_add = read_buff_add,
1402067fd92SSamuel Thibault .get_index = NULL,
1412067fd92SSamuel Thibault .indexing = {
1422067fd92SSamuel Thibault .command = NULL,
1432067fd92SSamuel Thibault .lowindex = 0,
1442067fd92SSamuel Thibault .highindex = 0,
1452067fd92SSamuel Thibault .currindex = 0,
1462067fd92SSamuel Thibault },
1472067fd92SSamuel Thibault .attributes = {
1482067fd92SSamuel Thibault .attrs = synth_attrs,
1492067fd92SSamuel Thibault .name = "decext",
1502067fd92SSamuel Thibault },
1512067fd92SSamuel Thibault };
1522067fd92SSamuel Thibault
do_catch_up(struct spk_synth * synth)1532067fd92SSamuel Thibault static void do_catch_up(struct spk_synth *synth)
1542067fd92SSamuel Thibault {
1552067fd92SSamuel Thibault u_char ch;
1562067fd92SSamuel Thibault static u_char last = '\0';
1572067fd92SSamuel Thibault unsigned long flags;
1582067fd92SSamuel Thibault unsigned long jiff_max;
1592067fd92SSamuel Thibault struct var_t *jiffy_delta;
1602067fd92SSamuel Thibault struct var_t *delay_time;
1612067fd92SSamuel Thibault int jiffy_delta_val = 0;
1622067fd92SSamuel Thibault int delay_time_val = 0;
1632067fd92SSamuel Thibault
1642067fd92SSamuel Thibault jiffy_delta = spk_get_var(JIFFY);
1652067fd92SSamuel Thibault delay_time = spk_get_var(DELAY);
1662067fd92SSamuel Thibault
1672067fd92SSamuel Thibault spin_lock_irqsave(&speakup_info.spinlock, flags);
1682067fd92SSamuel Thibault jiffy_delta_val = jiffy_delta->u.n.value;
1692067fd92SSamuel Thibault spin_unlock_irqrestore(&speakup_info.spinlock, flags);
1702067fd92SSamuel Thibault jiff_max = jiffies + jiffy_delta_val;
1712067fd92SSamuel Thibault
1722067fd92SSamuel Thibault while (!kthread_should_stop()) {
1732067fd92SSamuel Thibault spin_lock_irqsave(&speakup_info.spinlock, flags);
1742067fd92SSamuel Thibault if (speakup_info.flushing) {
1752067fd92SSamuel Thibault speakup_info.flushing = 0;
1762067fd92SSamuel Thibault spin_unlock_irqrestore(&speakup_info.spinlock, flags);
1772067fd92SSamuel Thibault synth->flush(synth);
1782067fd92SSamuel Thibault continue;
1792067fd92SSamuel Thibault }
1802067fd92SSamuel Thibault synth_buffer_skip_nonlatin1();
1812067fd92SSamuel Thibault if (synth_buffer_empty()) {
1822067fd92SSamuel Thibault spin_unlock_irqrestore(&speakup_info.spinlock, flags);
1832067fd92SSamuel Thibault break;
1842067fd92SSamuel Thibault }
1852067fd92SSamuel Thibault ch = synth_buffer_peek();
1862067fd92SSamuel Thibault set_current_state(TASK_INTERRUPTIBLE);
1872067fd92SSamuel Thibault delay_time_val = delay_time->u.n.value;
1882067fd92SSamuel Thibault spin_unlock_irqrestore(&speakup_info.spinlock, flags);
1892067fd92SSamuel Thibault if (ch == '\n')
1902067fd92SSamuel Thibault ch = 0x0D;
1912067fd92SSamuel Thibault if (synth_full() || !synth->io_ops->synth_out(synth, ch)) {
1922067fd92SSamuel Thibault schedule_timeout(msecs_to_jiffies(delay_time_val));
1932067fd92SSamuel Thibault continue;
1942067fd92SSamuel Thibault }
1952067fd92SSamuel Thibault set_current_state(TASK_RUNNING);
1962067fd92SSamuel Thibault spin_lock_irqsave(&speakup_info.spinlock, flags);
1972067fd92SSamuel Thibault synth_buffer_getc();
1982067fd92SSamuel Thibault spin_unlock_irqrestore(&speakup_info.spinlock, flags);
1992067fd92SSamuel Thibault if (ch == '[') {
2002067fd92SSamuel Thibault in_escape = 1;
2012067fd92SSamuel Thibault } else if (ch == ']') {
2022067fd92SSamuel Thibault in_escape = 0;
2032067fd92SSamuel Thibault } else if (ch <= SPACE) {
2042067fd92SSamuel Thibault if (!in_escape && strchr(",.!?;:", last))
2052067fd92SSamuel Thibault synth->io_ops->synth_out(synth, PROCSPEECH);
2062067fd92SSamuel Thibault if (time_after_eq(jiffies, jiff_max)) {
2072067fd92SSamuel Thibault if (!in_escape)
2082067fd92SSamuel Thibault synth->io_ops->synth_out(synth,
2092067fd92SSamuel Thibault PROCSPEECH);
2102067fd92SSamuel Thibault spin_lock_irqsave(&speakup_info.spinlock,
2112067fd92SSamuel Thibault flags);
2122067fd92SSamuel Thibault jiffy_delta_val = jiffy_delta->u.n.value;
2132067fd92SSamuel Thibault delay_time_val = delay_time->u.n.value;
2142067fd92SSamuel Thibault spin_unlock_irqrestore(&speakup_info.spinlock,
2152067fd92SSamuel Thibault flags);
2162067fd92SSamuel Thibault schedule_timeout(msecs_to_jiffies
2172067fd92SSamuel Thibault (delay_time_val));
2182067fd92SSamuel Thibault jiff_max = jiffies + jiffy_delta_val;
2192067fd92SSamuel Thibault }
2202067fd92SSamuel Thibault }
2212067fd92SSamuel Thibault last = ch;
2222067fd92SSamuel Thibault }
2232067fd92SSamuel Thibault if (!in_escape)
2242067fd92SSamuel Thibault synth->io_ops->synth_out(synth, PROCSPEECH);
2252067fd92SSamuel Thibault }
2262067fd92SSamuel Thibault
synth_flush(struct spk_synth * synth)2272067fd92SSamuel Thibault static void synth_flush(struct spk_synth *synth)
2282067fd92SSamuel Thibault {
2292067fd92SSamuel Thibault in_escape = 0;
2301941ab1dSSamuel Thibault synth->io_ops->flush_buffer(synth);
2312067fd92SSamuel Thibault synth->synth_immediate(synth, "\033P;10z\033\\");
2322067fd92SSamuel Thibault }
2332067fd92SSamuel Thibault
2342067fd92SSamuel Thibault module_param_named(ser, synth_decext.ser, int, 0444);
2352067fd92SSamuel Thibault module_param_named(dev, synth_decext.dev_name, charp, 0444);
2362067fd92SSamuel Thibault module_param_named(start, synth_decext.startup, short, 0444);
237*f613f00eSOsama Muhammad module_param_named(rate, vars[RATE_ID].u.n.default_val, int, 0444);
238*f613f00eSOsama Muhammad module_param_named(pitch, vars[PITCH_ID].u.n.default_val, int, 0444);
239*f613f00eSOsama Muhammad module_param_named(inflection, vars[INFLECTION_ID].u.n.default_val, int, 0444);
240*f613f00eSOsama Muhammad module_param_named(vol, vars[VOL_ID].u.n.default_val, int, 0444);
241*f613f00eSOsama Muhammad module_param_named(punct, vars[PUNCT_ID].u.n.default_val, int, 0444);
242*f613f00eSOsama Muhammad module_param_named(voice, vars[VOICE_ID].u.n.default_val, int, 0444);
243*f613f00eSOsama Muhammad module_param_named(direct, vars[DIRECT_ID].u.n.default_val, int, 0444);
244*f613f00eSOsama Muhammad
2452067fd92SSamuel Thibault
2462067fd92SSamuel Thibault MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
2472067fd92SSamuel Thibault MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer.");
2482067fd92SSamuel Thibault MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
249*f613f00eSOsama Muhammad MODULE_PARM_DESC(rate, "Set the rate variable on load.");
250*f613f00eSOsama Muhammad MODULE_PARM_DESC(pitch, "Set the pitch variable on load.");
251*f613f00eSOsama Muhammad MODULE_PARM_DESC(inflection, "Set the inflection variable on load.");
252*f613f00eSOsama Muhammad MODULE_PARM_DESC(vol, "Set the vol variable on load.");
253*f613f00eSOsama Muhammad MODULE_PARM_DESC(punct, "Set the punct variable on load.");
254*f613f00eSOsama Muhammad MODULE_PARM_DESC(voice, "Set the voice variable on load.");
255*f613f00eSOsama Muhammad MODULE_PARM_DESC(direct, "Set the direct variable on load.");
2562067fd92SSamuel Thibault
2572067fd92SSamuel Thibault module_spk_synth(synth_decext);
2582067fd92SSamuel Thibault
2592067fd92SSamuel Thibault MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
2602067fd92SSamuel Thibault MODULE_AUTHOR("David Borowski");
2612067fd92SSamuel Thibault MODULE_DESCRIPTION("Speakup support for DECtalk External synthesizers");
2622067fd92SSamuel Thibault MODULE_LICENSE("GPL");
2632067fd92SSamuel Thibault MODULE_VERSION(DRV_VERSION);
2642067fd92SSamuel Thibault
265