2 * originally written by: Kirk Reiser <kirk@braille.uwo.ca>
3 * this version considerably modified by David Borowski, david575@rogers.com
5 * Copyright (C) 1998-99 Kirk Reiser.
6 * Copyright (C) 2003 David Borowski.
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.
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.
18 * specificly written as a driver for the speakup screenreview
19 * s not a general device driver.
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>
31 #define DRV_VERSION "2.20"
32 #define SYNTH_CLEAR 0x03
33 #define PROCSPEECH 0x0b
36 static inline int synth_full(void)
41 static void do_catch_up(struct spk_synth *synth);
42 static void synth_flush(struct spk_synth *synth);
43 static void read_buff_add(u_char c);
44 static unsigned char get_index(struct spk_synth *synth);
47 static int is_flushing;
49 static DEFINE_SPINLOCK(flush_lock);
50 static DECLARE_WAIT_QUEUE_HEAD(flush);
52 static struct var_t vars[] = {
53 { CAPS_START, .u.s = {"[:dv ap 160] " } },
54 { CAPS_STOP, .u.s = {"[:dv ap 100 ] " } },
55 { RATE, .u.n = {"[:ra %d] ", 180, 75, 650, 0, 0, NULL } },
56 { PITCH, .u.n = {"[:dv ap %d] ", 122, 50, 350, 0, 0, NULL } },
57 { VOL, .u.n = {"[:dv g5 %d] ", 86, 60, 86, 0, 0, NULL } },
58 { PUNCT, .u.n = {"[:pu %c] ", 0, 0, 2, 0, 0, "nsa" } },
59 { VOICE, .u.n = {"[:n%c] ", 0, 0, 9, 0, 0, "phfdburwkv" } },
60 { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
65 * These attributes will appear in /sys/accessibility/speakup/dectlk.
67 static struct kobj_attribute caps_start_attribute =
68 __ATTR(caps_start, 0644, spk_var_show, spk_var_store);
69 static struct kobj_attribute caps_stop_attribute =
70 __ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
71 static struct kobj_attribute pitch_attribute =
72 __ATTR(pitch, 0644, spk_var_show, spk_var_store);
73 static struct kobj_attribute punct_attribute =
74 __ATTR(punct, 0644, spk_var_show, spk_var_store);
75 static struct kobj_attribute rate_attribute =
76 __ATTR(rate, 0644, spk_var_show, spk_var_store);
77 static struct kobj_attribute voice_attribute =
78 __ATTR(voice, 0644, spk_var_show, spk_var_store);
79 static struct kobj_attribute vol_attribute =
80 __ATTR(vol, 0644, spk_var_show, spk_var_store);
82 static struct kobj_attribute delay_time_attribute =
83 __ATTR(delay_time, 0644, spk_var_show, spk_var_store);
84 static struct kobj_attribute direct_attribute =
85 __ATTR(direct, 0644, spk_var_show, spk_var_store);
86 static struct kobj_attribute full_time_attribute =
87 __ATTR(full_time, 0644, spk_var_show, spk_var_store);
88 static struct kobj_attribute jiffy_delta_attribute =
89 __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
90 static struct kobj_attribute trigger_time_attribute =
91 __ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
94 * Create a group of attributes so that we can create and destroy them all
97 static struct attribute *synth_attrs[] = {
98 &caps_start_attribute.attr,
99 &caps_stop_attribute.attr,
100 &pitch_attribute.attr,
101 &punct_attribute.attr,
102 &rate_attribute.attr,
103 &voice_attribute.attr,
105 &delay_time_attribute.attr,
106 &direct_attribute.attr,
107 &full_time_attribute.attr,
108 &jiffy_delta_attribute.attr,
109 &trigger_time_attribute.attr,
110 NULL, /* need to NULL terminate the list of attributes */
113 static int ap_defaults[] = {122, 89, 155, 110, 208, 240, 200, 106, 306};
114 static int g5_defaults[] = {86, 81, 86, 84, 81, 80, 83, 83, 73};
116 static struct spk_synth synth_dectlk = {
118 .version = DRV_VERSION,
119 .long_name = "Dectalk Express",
120 .init = "[:error sp :name paul :rate 180 :tsr off] ",
121 .procspeech = PROCSPEECH,
122 .clear = SYNTH_CLEAR,
127 .dev_name = SYNTH_DEFAULT_DEV,
128 .startup = SYNTH_START,
129 .checkval = SYNTH_CHECK,
131 .default_pitch = ap_defaults,
132 .default_vol = g5_defaults,
133 .io_ops = &spk_ttyio_ops,
134 .probe = spk_ttyio_synth_probe,
135 .release = spk_ttyio_release,
136 .synth_immediate = spk_ttyio_synth_immediate,
137 .catch_up = do_catch_up,
138 .flush = synth_flush,
139 .is_alive = spk_synth_is_alive_restart,
140 .synth_adjust = NULL,
141 .read_buff_add = read_buff_add,
142 .get_index = get_index,
144 .command = "[:in re %d ] ",
150 .attrs = synth_attrs,
155 static int is_indnum(u_char *ch)
157 if ((*ch >= '0') && (*ch <= '9')) {
164 static u_char lastind;
166 static unsigned char get_index(struct spk_synth *synth)
175 static void read_buff_add(u_char c)
182 spin_lock_irqsave(&flush_lock, flags);
184 wake_up_interruptible(&flush);
185 spin_unlock_irqrestore(&flush_lock, flags);
186 } else if (c == 0x13) {
188 } else if (c == 0x11) {
190 } else if (is_indnum(&c)) {
195 } else if ((c > 31) && (c < 127)) {
197 lastind = (u_char)ind;
202 static void do_catch_up(struct spk_synth *synth)
204 int synth_full_val = 0;
206 static u_char last = '\0';
208 unsigned long jiff_max;
209 unsigned long timeout = msecs_to_jiffies(4000);
211 struct var_t *jiffy_delta;
212 struct var_t *delay_time;
216 jiffy_delta = spk_get_var(JIFFY);
217 delay_time = spk_get_var(DELAY);
218 spin_lock_irqsave(&speakup_info.spinlock, flags);
219 jiffy_delta_val = jiffy_delta->u.n.value;
220 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
221 jiff_max = jiffies + jiffy_delta_val;
223 while (!kthread_should_stop()) {
224 /* if no ctl-a in 4, send data anyway */
225 spin_lock_irqsave(&flush_lock, flags);
226 while (is_flushing && timeout) {
227 prepare_to_wait(&flush, &wait, TASK_INTERRUPTIBLE);
228 spin_unlock_irqrestore(&flush_lock, flags);
229 timeout = schedule_timeout(timeout);
230 spin_lock_irqsave(&flush_lock, flags);
232 finish_wait(&flush, &wait);
234 spin_unlock_irqrestore(&flush_lock, flags);
236 spin_lock_irqsave(&speakup_info.spinlock, flags);
237 if (speakup_info.flushing) {
238 speakup_info.flushing = 0;
239 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
243 synth_buffer_skip_nonlatin1();
244 if (synth_buffer_empty()) {
245 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
248 ch = synth_buffer_peek();
249 set_current_state(TASK_INTERRUPTIBLE);
250 delay_time_val = delay_time->u.n.value;
251 synth_full_val = synth_full();
252 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
255 if (synth_full_val || !synth->io_ops->synth_out(synth, ch)) {
256 schedule_timeout(msecs_to_jiffies(delay_time_val));
259 set_current_state(TASK_RUNNING);
260 spin_lock_irqsave(&speakup_info.spinlock, flags);
262 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
265 } else if (ch == ']') {
267 } else if (ch <= SPACE) {
268 if (!in_escape && strchr(",.!?;:", last))
269 synth->io_ops->synth_out(synth, PROCSPEECH);
270 if (time_after_eq(jiffies, jiff_max)) {
272 synth->io_ops->synth_out(synth, PROCSPEECH);
273 spin_lock_irqsave(&speakup_info.spinlock,
275 jiffy_delta_val = jiffy_delta->u.n.value;
276 delay_time_val = delay_time->u.n.value;
277 spin_unlock_irqrestore(&speakup_info.spinlock,
279 schedule_timeout(msecs_to_jiffies
281 jiff_max = jiffies + jiffy_delta_val;
287 synth->io_ops->synth_out(synth, PROCSPEECH);
290 static void synth_flush(struct spk_synth *synth)
293 /* if in command output ']' so we don't get an error */
294 synth->io_ops->synth_out(synth, ']');
297 synth->io_ops->flush_buffer();
298 synth->io_ops->synth_out(synth, SYNTH_CLEAR);
301 module_param_named(ser, synth_dectlk.ser, int, 0444);
302 module_param_named(dev, synth_dectlk.dev_name, charp, S_IRUGO);
303 module_param_named(start, synth_dectlk.startup, short, 0444);
305 MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
306 MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer.");
307 MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
309 module_spk_synth(synth_dectlk);
311 MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
312 MODULE_AUTHOR("David Borowski");
313 MODULE_DESCRIPTION("Speakup support for DECtalk Express synthesizers");
314 MODULE_LICENSE("GPL");
315 MODULE_VERSION(DRV_VERSION);