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>
32 #define DRV_VERSION "2.20"
33 #define SYNTH_CLEAR 0x03
34 #define PROCSPEECH 0x0b
37 static inline int synth_full(void)
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);
48 static int is_flushing;
50 static spinlock_t flush_lock;
51 static DECLARE_WAIT_QUEUE_HEAD(flush);
53 static struct var_t vars[] = {
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 } },
66 * These attributes will appear in /sys/accessibility/speakup/dectlk.
68 static struct kobj_attribute caps_start_attribute =
69 __ATTR(caps_start, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
70 static struct kobj_attribute caps_stop_attribute =
71 __ATTR(caps_stop, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
72 static struct kobj_attribute pitch_attribute =
73 __ATTR(pitch, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
74 static struct kobj_attribute punct_attribute =
75 __ATTR(punct, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
76 static struct kobj_attribute rate_attribute =
77 __ATTR(rate, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
78 static struct kobj_attribute voice_attribute =
79 __ATTR(voice, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
80 static struct kobj_attribute vol_attribute =
81 __ATTR(vol, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
83 static struct kobj_attribute delay_time_attribute =
84 __ATTR(delay_time, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
85 static struct kobj_attribute direct_attribute =
86 __ATTR(direct, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
87 static struct kobj_attribute full_time_attribute =
88 __ATTR(full_time, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
89 static struct kobj_attribute jiffy_delta_attribute =
90 __ATTR(jiffy_delta, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
91 static struct kobj_attribute trigger_time_attribute =
92 __ATTR(trigger_time, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
95 * Create a group of attributes so that we can create and destroy them all
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,
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 */
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};
117 static struct spk_synth synth_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,
128 .startup = SYNTH_START,
129 .checkval = SYNTH_CHECK,
131 .default_pitch = ap_defaults,
132 .default_vol = g5_defaults,
133 .probe = spk_serial_synth_probe,
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,
143 .command = "[:in re %d ] ",
149 .attrs = synth_attrs,
154 static int is_indnum(u_char *ch)
156 if ((*ch >= '0') && (*ch <= '9')) {
163 static u_char lastind;
165 static unsigned char get_index(void)
174 static void read_buff_add(u_char c)
181 spin_lock_irqsave(&flush_lock, flags);
183 wake_up_interruptible(&flush);
184 spin_unlock_irqrestore(&flush_lock, flags);
185 } else if (c == 0x13) {
187 } else if (c == 0x11) {
189 } else if (is_indnum(&c)) {
194 } else if ((c > 31) && (c < 127)) {
196 lastind = (u_char)ind;
201 static void do_catch_up(struct spk_synth *synth)
203 int synth_full_val = 0;
205 static u_char last = '\0';
207 unsigned long jiff_max;
208 unsigned long timeout = msecs_to_jiffies(4000);
210 struct var_t *jiffy_delta;
211 struct var_t *delay_time;
215 jiffy_delta = spk_get_var(JIFFY);
216 delay_time = spk_get_var(DELAY);
217 spin_lock_irqsave(&speakup_info.spinlock, flags);
218 jiffy_delta_val = jiffy_delta->u.n.value;
219 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
220 jiff_max = jiffies + jiffy_delta_val;
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);
231 finish_wait(&flush, &wait);
233 spin_unlock_irqrestore(&flush_lock, flags);
235 spin_lock_irqsave(&speakup_info.spinlock, flags);
236 if (speakup_info.flushing) {
237 speakup_info.flushing = 0;
238 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
242 if (synth_buffer_empty()) {
243 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
246 ch = synth_buffer_peek();
247 set_current_state(TASK_INTERRUPTIBLE);
248 delay_time_val = delay_time->u.n.value;
249 synth_full_val = synth_full();
250 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
253 if (synth_full_val || !spk_serial_out(ch)) {
254 schedule_timeout(msecs_to_jiffies(delay_time_val));
257 set_current_state(TASK_RUNNING);
258 spin_lock_irqsave(&speakup_info.spinlock, flags);
260 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
265 else if (ch <= SPACE) {
266 if (!in_escape && strchr(",.!?;:", last))
267 spk_serial_out(PROCSPEECH);
268 if (time_after_eq(jiffies, jiff_max)) {
270 spk_serial_out(PROCSPEECH);
271 spin_lock_irqsave(&speakup_info.spinlock,
273 jiffy_delta_val = jiffy_delta->u.n.value;
274 delay_time_val = delay_time->u.n.value;
275 spin_unlock_irqrestore(&speakup_info.spinlock,
277 schedule_timeout(msecs_to_jiffies
279 jiff_max = jiffies + jiffy_delta_val;
285 spk_serial_out(PROCSPEECH);
288 static void synth_flush(struct spk_synth *synth)
291 /* if in command output ']' so we don't get an error */
295 spk_serial_out(SYNTH_CLEAR);
298 module_param_named(ser, synth_dectlk.ser, int, S_IRUGO);
299 module_param_named(start, synth_dectlk.startup, short, S_IRUGO);
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.");
304 module_spk_synth(synth_dectlk);
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);