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/jiffies.h> 13 #include <linux/sched.h> 14 #include <linux/timer.h> 15 #include <linux/kthread.h> 16 17 #include "spk_priv.h" 18 #include "speakup.h" 19 20 #define DRV_VERSION "2.14" 21 #define SYNTH_CLEAR 0x03 22 #define PROCSPEECH 0x0b 23 24 static volatile unsigned char last_char; 25 26 static void read_buff_add(u_char ch) 27 { 28 last_char = ch; 29 } 30 31 static inline bool synth_full(void) 32 { 33 return last_char == 0x13; 34 } 35 36 static void do_catch_up(struct spk_synth *synth); 37 static void synth_flush(struct spk_synth *synth); 38 39 static int in_escape; 40 41 static struct var_t vars[] = { 42 { CAPS_START, .u.s = {"[:dv ap 222]" } }, 43 { CAPS_STOP, .u.s = {"[:dv ap 100]" } }, 44 { RATE, .u.n = {"[:ra %d]", 7, 0, 9, 150, 25, NULL } }, 45 { PITCH, .u.n = {"[:dv ap %d]", 100, 0, 100, 0, 0, NULL } }, 46 { INFLECTION, .u.n = {"[:dv pr %d] ", 100, 0, 10000, 0, 0, NULL } }, 47 { VOL, .u.n = {"[:dv gv %d]", 13, 0, 16, 0, 5, NULL } }, 48 { PUNCT, .u.n = {"[:pu %c]", 0, 0, 2, 0, 0, "nsa" } }, 49 { VOICE, .u.n = {"[:n%c]", 0, 0, 9, 0, 0, "phfdburwkv" } }, 50 { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } }, 51 V_LAST_VAR 52 }; 53 54 /* 55 * These attributes will appear in /sys/accessibility/speakup/decext. 56 */ 57 static struct kobj_attribute caps_start_attribute = 58 __ATTR(caps_start, 0644, spk_var_show, spk_var_store); 59 static struct kobj_attribute caps_stop_attribute = 60 __ATTR(caps_stop, 0644, spk_var_show, spk_var_store); 61 static struct kobj_attribute pitch_attribute = 62 __ATTR(pitch, 0644, spk_var_show, spk_var_store); 63 static struct kobj_attribute inflection_attribute = 64 __ATTR(inflection, 0644, spk_var_show, spk_var_store); 65 static struct kobj_attribute punct_attribute = 66 __ATTR(punct, 0644, spk_var_show, spk_var_store); 67 static struct kobj_attribute rate_attribute = 68 __ATTR(rate, 0644, spk_var_show, spk_var_store); 69 static struct kobj_attribute voice_attribute = 70 __ATTR(voice, 0644, spk_var_show, spk_var_store); 71 static struct kobj_attribute vol_attribute = 72 __ATTR(vol, 0644, spk_var_show, spk_var_store); 73 74 static struct kobj_attribute delay_time_attribute = 75 __ATTR(delay_time, 0644, spk_var_show, spk_var_store); 76 static struct kobj_attribute direct_attribute = 77 __ATTR(direct, 0644, spk_var_show, spk_var_store); 78 static struct kobj_attribute full_time_attribute = 79 __ATTR(full_time, 0644, spk_var_show, spk_var_store); 80 static struct kobj_attribute jiffy_delta_attribute = 81 __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store); 82 static struct kobj_attribute trigger_time_attribute = 83 __ATTR(trigger_time, 0644, spk_var_show, spk_var_store); 84 85 /* 86 * Create a group of attributes so that we can create and destroy them all 87 * at once. 88 */ 89 static struct attribute *synth_attrs[] = { 90 &caps_start_attribute.attr, 91 &caps_stop_attribute.attr, 92 &pitch_attribute.attr, 93 &inflection_attribute.attr, 94 &punct_attribute.attr, 95 &rate_attribute.attr, 96 &voice_attribute.attr, 97 &vol_attribute.attr, 98 &delay_time_attribute.attr, 99 &direct_attribute.attr, 100 &full_time_attribute.attr, 101 &jiffy_delta_attribute.attr, 102 &trigger_time_attribute.attr, 103 NULL, /* need to NULL terminate the list of attributes */ 104 }; 105 106 static struct spk_synth synth_decext = { 107 .name = "decext", 108 .version = DRV_VERSION, 109 .long_name = "Dectalk External", 110 .init = "[:pe -380]", 111 .procspeech = PROCSPEECH, 112 .clear = SYNTH_CLEAR, 113 .delay = 500, 114 .trigger = 50, 115 .jiffies = 50, 116 .full = 40000, 117 .flags = SF_DEC, 118 .dev_name = SYNTH_DEFAULT_DEV, 119 .startup = SYNTH_START, 120 .checkval = SYNTH_CHECK, 121 .vars = vars, 122 .io_ops = &spk_ttyio_ops, 123 .probe = spk_ttyio_synth_probe, 124 .release = spk_ttyio_release, 125 .synth_immediate = spk_ttyio_synth_immediate, 126 .catch_up = do_catch_up, 127 .flush = synth_flush, 128 .is_alive = spk_synth_is_alive_restart, 129 .synth_adjust = NULL, 130 .read_buff_add = read_buff_add, 131 .get_index = NULL, 132 .indexing = { 133 .command = NULL, 134 .lowindex = 0, 135 .highindex = 0, 136 .currindex = 0, 137 }, 138 .attributes = { 139 .attrs = synth_attrs, 140 .name = "decext", 141 }, 142 }; 143 144 static void do_catch_up(struct spk_synth *synth) 145 { 146 u_char ch; 147 static u_char last = '\0'; 148 unsigned long flags; 149 unsigned long jiff_max; 150 struct var_t *jiffy_delta; 151 struct var_t *delay_time; 152 int jiffy_delta_val = 0; 153 int delay_time_val = 0; 154 155 jiffy_delta = spk_get_var(JIFFY); 156 delay_time = spk_get_var(DELAY); 157 158 spin_lock_irqsave(&speakup_info.spinlock, flags); 159 jiffy_delta_val = jiffy_delta->u.n.value; 160 spin_unlock_irqrestore(&speakup_info.spinlock, flags); 161 jiff_max = jiffies + jiffy_delta_val; 162 163 while (!kthread_should_stop()) { 164 spin_lock_irqsave(&speakup_info.spinlock, flags); 165 if (speakup_info.flushing) { 166 speakup_info.flushing = 0; 167 spin_unlock_irqrestore(&speakup_info.spinlock, flags); 168 synth->flush(synth); 169 continue; 170 } 171 synth_buffer_skip_nonlatin1(); 172 if (synth_buffer_empty()) { 173 spin_unlock_irqrestore(&speakup_info.spinlock, flags); 174 break; 175 } 176 ch = synth_buffer_peek(); 177 set_current_state(TASK_INTERRUPTIBLE); 178 delay_time_val = delay_time->u.n.value; 179 spin_unlock_irqrestore(&speakup_info.spinlock, flags); 180 if (ch == '\n') 181 ch = 0x0D; 182 if (synth_full() || !synth->io_ops->synth_out(synth, ch)) { 183 schedule_timeout(msecs_to_jiffies(delay_time_val)); 184 continue; 185 } 186 set_current_state(TASK_RUNNING); 187 spin_lock_irqsave(&speakup_info.spinlock, flags); 188 synth_buffer_getc(); 189 spin_unlock_irqrestore(&speakup_info.spinlock, flags); 190 if (ch == '[') { 191 in_escape = 1; 192 } else if (ch == ']') { 193 in_escape = 0; 194 } else if (ch <= SPACE) { 195 if (!in_escape && strchr(",.!?;:", last)) 196 synth->io_ops->synth_out(synth, PROCSPEECH); 197 if (time_after_eq(jiffies, jiff_max)) { 198 if (!in_escape) 199 synth->io_ops->synth_out(synth, 200 PROCSPEECH); 201 spin_lock_irqsave(&speakup_info.spinlock, 202 flags); 203 jiffy_delta_val = jiffy_delta->u.n.value; 204 delay_time_val = delay_time->u.n.value; 205 spin_unlock_irqrestore(&speakup_info.spinlock, 206 flags); 207 schedule_timeout(msecs_to_jiffies 208 (delay_time_val)); 209 jiff_max = jiffies + jiffy_delta_val; 210 } 211 } 212 last = ch; 213 } 214 if (!in_escape) 215 synth->io_ops->synth_out(synth, PROCSPEECH); 216 } 217 218 static void synth_flush(struct spk_synth *synth) 219 { 220 in_escape = 0; 221 synth->io_ops->flush_buffer(synth); 222 synth->synth_immediate(synth, "\033P;10z\033\\"); 223 } 224 225 module_param_named(ser, synth_decext.ser, int, 0444); 226 module_param_named(dev, synth_decext.dev_name, charp, 0444); 227 module_param_named(start, synth_decext.startup, short, 0444); 228 229 MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based)."); 230 MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer."); 231 MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded."); 232 233 module_spk_synth(synth_decext); 234 235 MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>"); 236 MODULE_AUTHOR("David Borowski"); 237 MODULE_DESCRIPTION("Speakup support for DECtalk External synthesizers"); 238 MODULE_LICENSE("GPL"); 239 MODULE_VERSION(DRV_VERSION); 240 241