William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 1 | /* |
| 2 | * originally written by: Kirk Reiser <kirk@braille.uwo.ca> |
| 3 | * this version considerably modified by David Borowski, david575@rogers.com |
| 4 | * |
| 5 | * Copyright (C) 1998-99 Kirk Reiser. |
| 6 | * Copyright (C) 2003 David Borowski. |
| 7 | * |
| 8 | * This program is free software; you can redistribute it and/or modify |
| 9 | * it under the terms of the GNU General Public License as published by |
| 10 | * the Free Software Foundation; either version 2 of the License, or |
| 11 | * (at your option) any later version. |
| 12 | * |
| 13 | * This program is distributed in the hope that it will be useful, |
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | * GNU General Public License for more details. |
| 17 | * |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 18 | * specificly written as a driver for the speakup screenreview |
| 19 | * s not a general device driver. |
| 20 | */ |
| 21 | #include <linux/unistd.h> |
| 22 | #include <linux/proc_fs.h> |
| 23 | #include <linux/jiffies.h> |
| 24 | #include <linux/spinlock.h> |
| 25 | #include <linux/sched.h> |
| 26 | #include <linux/timer.h> |
| 27 | #include <linux/kthread.h> |
| 28 | #include "speakup.h" |
| 29 | #include "spk_priv.h" |
| 30 | #include "serialio.h" |
| 31 | |
| 32 | #define DRV_VERSION "2.20" |
| 33 | #define SYNTH_CLEAR 0x03 |
| 34 | #define PROCSPEECH 0x0b |
Christopher Brannon | 4073f1b | 2010-10-14 19:24:00 -0500 | [diff] [blame] | 35 | static int xoff; |
| 36 | |
| 37 | static inline int synth_full(void) |
| 38 | { |
| 39 | return xoff; |
| 40 | } |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 41 | |
| 42 | static void do_catch_up(struct spk_synth *synth); |
| 43 | static void synth_flush(struct spk_synth *synth); |
| 44 | static void read_buff_add(u_char c); |
| 45 | static unsigned char get_index(void); |
| 46 | |
| 47 | static int in_escape; |
| 48 | static int is_flushing; |
| 49 | |
| 50 | static spinlock_t flush_lock; |
| 51 | static DECLARE_WAIT_QUEUE_HEAD(flush); |
| 52 | |
| 53 | static struct var_t vars[] = { |
Christopher Brannon | 4073f1b | 2010-10-14 19:24:00 -0500 | [diff] [blame] | 54 | { CAPS_START, .u.s = {"[:dv ap 160] " } }, |
| 55 | { CAPS_STOP, .u.s = {"[:dv ap 100 ] " } }, |
| 56 | { RATE, .u.n = {"[:ra %d] ", 180, 75, 650, 0, 0, NULL } }, |
| 57 | { PITCH, .u.n = {"[:dv ap %d] ", 122, 50, 350, 0, 0, NULL } }, |
| 58 | { VOL, .u.n = {"[:dv g5 %d] ", 86, 60, 86, 0, 0, NULL } }, |
| 59 | { PUNCT, .u.n = {"[:pu %c] ", 0, 0, 2, 0, 0, "nsa" } }, |
| 60 | { VOICE, .u.n = {"[:n%c] ", 0, 0, 9, 0, 0, "phfdburwkv" } }, |
| 61 | { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } }, |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 62 | V_LAST_VAR |
| 63 | }; |
| 64 | |
| 65 | /* |
| 66 | * These attributes will appear in /sys/accessibility/speakup/dectlk. |
| 67 | */ |
| 68 | static struct kobj_attribute caps_start_attribute = |
Rusty Russell | d901aaa | 2014-04-24 13:57:49 +0930 | [diff] [blame] | 69 | __ATTR(caps_start, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 70 | static struct kobj_attribute caps_stop_attribute = |
Rusty Russell | d901aaa | 2014-04-24 13:57:49 +0930 | [diff] [blame] | 71 | __ATTR(caps_stop, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 72 | static struct kobj_attribute pitch_attribute = |
Rusty Russell | d901aaa | 2014-04-24 13:57:49 +0930 | [diff] [blame] | 73 | __ATTR(pitch, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 74 | static struct kobj_attribute punct_attribute = |
Rusty Russell | d901aaa | 2014-04-24 13:57:49 +0930 | [diff] [blame] | 75 | __ATTR(punct, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 76 | static struct kobj_attribute rate_attribute = |
Rusty Russell | d901aaa | 2014-04-24 13:57:49 +0930 | [diff] [blame] | 77 | __ATTR(rate, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 78 | static struct kobj_attribute voice_attribute = |
Rusty Russell | d901aaa | 2014-04-24 13:57:49 +0930 | [diff] [blame] | 79 | __ATTR(voice, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 80 | static struct kobj_attribute vol_attribute = |
Rusty Russell | d901aaa | 2014-04-24 13:57:49 +0930 | [diff] [blame] | 81 | __ATTR(vol, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 82 | |
| 83 | static struct kobj_attribute delay_time_attribute = |
Rusty Russell | 22c9bca | 2014-04-01 13:30:05 +1030 | [diff] [blame] | 84 | __ATTR(delay_time, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 85 | static struct kobj_attribute direct_attribute = |
Rusty Russell | d901aaa | 2014-04-24 13:57:49 +0930 | [diff] [blame] | 86 | __ATTR(direct, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 87 | static struct kobj_attribute full_time_attribute = |
Rusty Russell | 22c9bca | 2014-04-01 13:30:05 +1030 | [diff] [blame] | 88 | __ATTR(full_time, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 89 | static struct kobj_attribute jiffy_delta_attribute = |
Rusty Russell | 22c9bca | 2014-04-01 13:30:05 +1030 | [diff] [blame] | 90 | __ATTR(jiffy_delta, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 91 | static struct kobj_attribute trigger_time_attribute = |
Rusty Russell | 22c9bca | 2014-04-01 13:30:05 +1030 | [diff] [blame] | 92 | __ATTR(trigger_time, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 93 | |
| 94 | /* |
| 95 | * Create a group of attributes so that we can create and destroy them all |
| 96 | * at once. |
| 97 | */ |
| 98 | static struct attribute *synth_attrs[] = { |
| 99 | &caps_start_attribute.attr, |
| 100 | &caps_stop_attribute.attr, |
| 101 | &pitch_attribute.attr, |
| 102 | &punct_attribute.attr, |
| 103 | &rate_attribute.attr, |
| 104 | &voice_attribute.attr, |
| 105 | &vol_attribute.attr, |
| 106 | &delay_time_attribute.attr, |
| 107 | &direct_attribute.attr, |
| 108 | &full_time_attribute.attr, |
| 109 | &jiffy_delta_attribute.attr, |
| 110 | &trigger_time_attribute.attr, |
| 111 | NULL, /* need to NULL terminate the list of attributes */ |
| 112 | }; |
| 113 | |
| 114 | static int ap_defaults[] = {122, 89, 155, 110, 208, 240, 200, 106, 306}; |
| 115 | static int g5_defaults[] = {86, 81, 86, 84, 81, 80, 83, 83, 73}; |
| 116 | |
| 117 | static struct spk_synth synth_dectlk = { |
| 118 | .name = "dectlk", |
| 119 | .version = DRV_VERSION, |
| 120 | .long_name = "Dectalk Express", |
| 121 | .init = "[:error sp :name paul :rate 180 :tsr off] ", |
| 122 | .procspeech = PROCSPEECH, |
| 123 | .clear = SYNTH_CLEAR, |
| 124 | .delay = 500, |
| 125 | .trigger = 50, |
| 126 | .jiffies = 50, |
| 127 | .full = 40000, |
| 128 | .startup = SYNTH_START, |
| 129 | .checkval = SYNTH_CHECK, |
| 130 | .vars = vars, |
| 131 | .default_pitch = ap_defaults, |
| 132 | .default_vol = g5_defaults, |
Samuel Thibault | ca2beaf | 2013-01-02 02:37:40 +0100 | [diff] [blame] | 133 | .probe = spk_serial_synth_probe, |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 134 | .release = spk_serial_release, |
| 135 | .synth_immediate = spk_synth_immediate, |
| 136 | .catch_up = do_catch_up, |
| 137 | .flush = synth_flush, |
| 138 | .is_alive = spk_synth_is_alive_restart, |
| 139 | .synth_adjust = NULL, |
| 140 | .read_buff_add = read_buff_add, |
| 141 | .get_index = get_index, |
| 142 | .indexing = { |
| 143 | .command = "[:in re %d ] ", |
| 144 | .lowindex = 1, |
| 145 | .highindex = 8, |
| 146 | .currindex = 1, |
| 147 | }, |
| 148 | .attributes = { |
| 149 | .attrs = synth_attrs, |
| 150 | .name = "dectlk", |
| 151 | }, |
| 152 | }; |
| 153 | |
| 154 | static int is_indnum(u_char *ch) |
| 155 | { |
| 156 | if ((*ch >= '0') && (*ch <= '9')) { |
| 157 | *ch = *ch - '0'; |
| 158 | return 1; |
| 159 | } |
| 160 | return 0; |
| 161 | } |
| 162 | |
Christopher Brannon | 4073f1b | 2010-10-14 19:24:00 -0500 | [diff] [blame] | 163 | static u_char lastind; |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 164 | |
| 165 | static unsigned char get_index(void) |
| 166 | { |
| 167 | u_char rv; |
Domagoj Trsan | 8e69a81 | 2014-09-09 20:04:34 +0200 | [diff] [blame] | 168 | |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 169 | rv = lastind; |
| 170 | lastind = 0; |
| 171 | return rv; |
| 172 | } |
| 173 | |
| 174 | static void read_buff_add(u_char c) |
| 175 | { |
| 176 | static int ind = -1; |
| 177 | |
| 178 | if (c == 0x01) { |
| 179 | unsigned long flags; |
Domagoj Trsan | 8e69a81 | 2014-09-09 20:04:34 +0200 | [diff] [blame] | 180 | |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 181 | spin_lock_irqsave(&flush_lock, flags); |
| 182 | is_flushing = 0; |
| 183 | wake_up_interruptible(&flush); |
| 184 | spin_unlock_irqrestore(&flush_lock, flags); |
| 185 | } else if (c == 0x13) { |
| 186 | xoff = 1; |
| 187 | } else if (c == 0x11) { |
| 188 | xoff = 0; |
| 189 | } else if (is_indnum(&c)) { |
| 190 | if (ind == -1) |
| 191 | ind = c; |
| 192 | else |
| 193 | ind = ind * 10 + c; |
| 194 | } else if ((c > 31) && (c < 127)) { |
| 195 | if (ind != -1) |
| 196 | lastind = (u_char)ind; |
| 197 | ind = -1; |
| 198 | } |
| 199 | } |
| 200 | |
| 201 | static void do_catch_up(struct spk_synth *synth) |
| 202 | { |
Christopher Brannon | 4073f1b | 2010-10-14 19:24:00 -0500 | [diff] [blame] | 203 | int synth_full_val = 0; |
| 204 | static u_char ch; |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 205 | static u_char last = '\0'; |
| 206 | unsigned long flags; |
| 207 | unsigned long jiff_max; |
| 208 | unsigned long timeout = msecs_to_jiffies(4000); |
| 209 | DEFINE_WAIT(wait); |
| 210 | struct var_t *jiffy_delta; |
| 211 | struct var_t *delay_time; |
| 212 | int jiffy_delta_val; |
| 213 | int delay_time_val; |
| 214 | |
Samuel Thibault | ca2beaf | 2013-01-02 02:37:40 +0100 | [diff] [blame] | 215 | jiffy_delta = spk_get_var(JIFFY); |
| 216 | delay_time = spk_get_var(DELAY); |
William Hubbs | 68743d6 | 2013-05-13 00:03:03 -0500 | [diff] [blame] | 217 | spin_lock_irqsave(&speakup_info.spinlock, flags); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 218 | jiffy_delta_val = jiffy_delta->u.n.value; |
William Hubbs | 68743d6 | 2013-05-13 00:03:03 -0500 | [diff] [blame] | 219 | spin_unlock_irqrestore(&speakup_info.spinlock, flags); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 220 | jiff_max = jiffies + jiffy_delta_val; |
| 221 | |
| 222 | while (!kthread_should_stop()) { |
| 223 | /* if no ctl-a in 4, send data anyway */ |
| 224 | spin_lock_irqsave(&flush_lock, flags); |
| 225 | while (is_flushing && timeout) { |
| 226 | prepare_to_wait(&flush, &wait, TASK_INTERRUPTIBLE); |
| 227 | spin_unlock_irqrestore(&flush_lock, flags); |
| 228 | timeout = schedule_timeout(timeout); |
| 229 | spin_lock_irqsave(&flush_lock, flags); |
| 230 | } |
| 231 | finish_wait(&flush, &wait); |
| 232 | is_flushing = 0; |
| 233 | spin_unlock_irqrestore(&flush_lock, flags); |
| 234 | |
William Hubbs | 68743d6 | 2013-05-13 00:03:03 -0500 | [diff] [blame] | 235 | spin_lock_irqsave(&speakup_info.spinlock, flags); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 236 | if (speakup_info.flushing) { |
| 237 | speakup_info.flushing = 0; |
William Hubbs | 68743d6 | 2013-05-13 00:03:03 -0500 | [diff] [blame] | 238 | spin_unlock_irqrestore(&speakup_info.spinlock, flags); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 239 | synth->flush(synth); |
| 240 | continue; |
| 241 | } |
| 242 | if (synth_buffer_empty()) { |
William Hubbs | 68743d6 | 2013-05-13 00:03:03 -0500 | [diff] [blame] | 243 | spin_unlock_irqrestore(&speakup_info.spinlock, flags); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 244 | break; |
| 245 | } |
| 246 | ch = synth_buffer_peek(); |
| 247 | set_current_state(TASK_INTERRUPTIBLE); |
| 248 | delay_time_val = delay_time->u.n.value; |
Christopher Brannon | 4073f1b | 2010-10-14 19:24:00 -0500 | [diff] [blame] | 249 | synth_full_val = synth_full(); |
William Hubbs | 68743d6 | 2013-05-13 00:03:03 -0500 | [diff] [blame] | 250 | spin_unlock_irqrestore(&speakup_info.spinlock, flags); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 251 | if (ch == '\n') |
| 252 | ch = 0x0D; |
Christopher Brannon | 4073f1b | 2010-10-14 19:24:00 -0500 | [diff] [blame] | 253 | if (synth_full_val || !spk_serial_out(ch)) { |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 254 | schedule_timeout(msecs_to_jiffies(delay_time_val)); |
| 255 | continue; |
| 256 | } |
| 257 | set_current_state(TASK_RUNNING); |
William Hubbs | 68743d6 | 2013-05-13 00:03:03 -0500 | [diff] [blame] | 258 | spin_lock_irqsave(&speakup_info.spinlock, flags); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 259 | synth_buffer_getc(); |
William Hubbs | 68743d6 | 2013-05-13 00:03:03 -0500 | [diff] [blame] | 260 | spin_unlock_irqrestore(&speakup_info.spinlock, flags); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 261 | if (ch == '[') |
| 262 | in_escape = 1; |
| 263 | else if (ch == ']') |
| 264 | in_escape = 0; |
| 265 | else if (ch <= SPACE) { |
| 266 | if (!in_escape && strchr(",.!?;:", last)) |
| 267 | spk_serial_out(PROCSPEECH); |
Anil Belur | dd3fde1 | 2014-06-30 18:55:48 +0530 | [diff] [blame] | 268 | if (time_after_eq(jiffies, jiff_max)) { |
Christopher Brannon | 4073f1b | 2010-10-14 19:24:00 -0500 | [diff] [blame] | 269 | if (!in_escape) |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 270 | spk_serial_out(PROCSPEECH); |
Aybuke Ozdemir | 94b9c61 | 2014-03-18 20:45:59 +0200 | [diff] [blame] | 271 | spin_lock_irqsave(&speakup_info.spinlock, |
| 272 | flags); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 273 | jiffy_delta_val = jiffy_delta->u.n.value; |
| 274 | delay_time_val = delay_time->u.n.value; |
Aybuke Ozdemir | 94b9c61 | 2014-03-18 20:45:59 +0200 | [diff] [blame] | 275 | spin_unlock_irqrestore(&speakup_info.spinlock, |
| 276 | flags); |
Christopher Brannon | 4073f1b | 2010-10-14 19:24:00 -0500 | [diff] [blame] | 277 | schedule_timeout(msecs_to_jiffies |
| 278 | (delay_time_val)); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 279 | jiff_max = jiffies + jiffy_delta_val; |
| 280 | } |
| 281 | } |
| 282 | last = ch; |
| 283 | } |
| 284 | if (!in_escape) |
| 285 | spk_serial_out(PROCSPEECH); |
| 286 | } |
| 287 | |
| 288 | static void synth_flush(struct spk_synth *synth) |
| 289 | { |
Shraddha Barke | ca0b6fe | 2015-09-05 18:58:27 +0530 | [diff] [blame] | 290 | if (in_escape) |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 291 | /* if in command output ']' so we don't get an error */ |
| 292 | spk_serial_out(']'); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 293 | in_escape = 0; |
| 294 | is_flushing = 1; |
| 295 | spk_serial_out(SYNTH_CLEAR); |
| 296 | } |
| 297 | |
| 298 | module_param_named(ser, synth_dectlk.ser, int, S_IRUGO); |
| 299 | module_param_named(start, synth_dectlk.startup, short, S_IRUGO); |
| 300 | |
| 301 | MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based)."); |
| 302 | MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded."); |
| 303 | |
Vaishali Thakkar | ae89fac | 2015-03-18 23:13:10 +0530 | [diff] [blame] | 304 | module_spk_synth(synth_dectlk); |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 305 | |
William Hubbs | c6e3fd2 | 2010-10-07 13:20:02 -0500 | [diff] [blame] | 306 | MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>"); |
| 307 | MODULE_AUTHOR("David Borowski"); |
| 308 | MODULE_DESCRIPTION("Speakup support for DECtalk Express synthesizers"); |
| 309 | MODULE_LICENSE("GPL"); |
| 310 | MODULE_VERSION(DRV_VERSION); |
| 311 | |