1 // SPDX-License-Identifier: GPL-2.0+
3 * originally written by: Kirk Reiser <kirk@braille.uwo.ca>
4 * this version considerably modified by David Borowski, david575@rogers.com
6 * Copyright (C) 1998-99 Kirk Reiser.
7 * Copyright (C) 2003 David Borowski.
9 * specificly written as a driver for the speakup screenreview
10 * s not a general device driver.
12 #include <linux/unistd.h>
13 #include <linux/proc_fs.h>
14 #include <linux/jiffies.h>
15 #include <linux/spinlock.h>
16 #include <linux/sched.h>
17 #include <linux/timer.h>
18 #include <linux/kthread.h>
22 #define DRV_VERSION "2.20"
23 #define SYNTH_CLEAR 0x03
24 #define PROCSPEECH 0x0b
27 static inline int synth_full(void)
32 static void do_catch_up(struct spk_synth *synth);
33 static void synth_flush(struct spk_synth *synth);
34 static void read_buff_add(u_char c);
35 static unsigned char get_index(struct spk_synth *synth);
38 static int is_flushing;
40 static spinlock_t flush_lock;
41 static DECLARE_WAIT_QUEUE_HEAD(flush);
43 static struct var_t vars[] = {
44 { CAPS_START, .u.s = {"[:dv ap 160] " } },
45 { CAPS_STOP, .u.s = {"[:dv ap 100 ] " } },
46 { RATE, .u.n = {"[:ra %d] ", 180, 75, 650, 0, 0, NULL } },
47 { PITCH, .u.n = {"[:dv ap %d] ", 122, 50, 350, 0, 0, NULL } },
48 { VOL, .u.n = {"[:dv g5 %d] ", 86, 60, 86, 0, 0, NULL } },
49 { PUNCT, .u.n = {"[:pu %c] ", 0, 0, 2, 0, 0, "nsa" } },
50 { VOICE, .u.n = {"[:n%c] ", 0, 0, 9, 0, 0, "phfdburwkv" } },
51 { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
56 * These attributes will appear in /sys/accessibility/speakup/dectlk.
58 static struct kobj_attribute caps_start_attribute =
59 __ATTR(caps_start, 0644, spk_var_show, spk_var_store);
60 static struct kobj_attribute caps_stop_attribute =
61 __ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
62 static struct kobj_attribute pitch_attribute =
63 __ATTR(pitch, 0644, spk_var_show, spk_var_store);
64 static struct kobj_attribute punct_attribute =
65 __ATTR(punct, 0644, spk_var_show, spk_var_store);
66 static struct kobj_attribute rate_attribute =
67 __ATTR(rate, 0644, spk_var_show, spk_var_store);
68 static struct kobj_attribute voice_attribute =
69 __ATTR(voice, 0644, spk_var_show, spk_var_store);
70 static struct kobj_attribute vol_attribute =
71 __ATTR(vol, 0644, spk_var_show, spk_var_store);
73 static struct kobj_attribute delay_time_attribute =
74 __ATTR(delay_time, 0644, spk_var_show, spk_var_store);
75 static struct kobj_attribute direct_attribute =
76 __ATTR(direct, 0644, spk_var_show, spk_var_store);
77 static struct kobj_attribute full_time_attribute =
78 __ATTR(full_time, 0644, spk_var_show, spk_var_store);
79 static struct kobj_attribute jiffy_delta_attribute =
80 __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
81 static struct kobj_attribute trigger_time_attribute =
82 __ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
85 * Create a group of attributes so that we can create and destroy them all
88 static struct attribute *synth_attrs[] = {
89 &caps_start_attribute.attr,
90 &caps_stop_attribute.attr,
91 &pitch_attribute.attr,
92 &punct_attribute.attr,
94 &voice_attribute.attr,
96 &delay_time_attribute.attr,
97 &direct_attribute.attr,
98 &full_time_attribute.attr,
99 &jiffy_delta_attribute.attr,
100 &trigger_time_attribute.attr,
101 NULL, /* need to NULL terminate the list of attributes */
104 static int ap_defaults[] = {122, 89, 155, 110, 208, 240, 200, 106, 306};
105 static int g5_defaults[] = {86, 81, 86, 84, 81, 80, 83, 83, 73};
107 static struct spk_synth synth_dectlk = {
109 .version = DRV_VERSION,
110 .long_name = "Dectalk Express",
111 .init = "[:error sp :name paul :rate 180 :tsr off] ",
112 .procspeech = PROCSPEECH,
113 .clear = SYNTH_CLEAR,
118 .dev_name = SYNTH_DEFAULT_DEV,
119 .startup = SYNTH_START,
120 .checkval = SYNTH_CHECK,
122 .default_pitch = ap_defaults,
123 .default_vol = g5_defaults,
124 .io_ops = &spk_ttyio_ops,
125 .probe = spk_ttyio_synth_probe,
126 .release = spk_ttyio_release,
127 .synth_immediate = spk_ttyio_synth_immediate,
128 .catch_up = do_catch_up,
129 .flush = synth_flush,
130 .is_alive = spk_synth_is_alive_restart,
131 .synth_adjust = NULL,
132 .read_buff_add = read_buff_add,
133 .get_index = get_index,
135 .command = "[:in re %d ] ",
141 .attrs = synth_attrs,
146 static int is_indnum(u_char *ch)
148 if ((*ch >= '0') && (*ch <= '9')) {
155 static u_char lastind;
157 static unsigned char get_index(struct spk_synth *synth)
166 static void read_buff_add(u_char c)
173 spin_lock_irqsave(&flush_lock, flags);
175 wake_up_interruptible(&flush);
176 spin_unlock_irqrestore(&flush_lock, flags);
177 } else if (c == 0x13) {
179 } else if (c == 0x11) {
181 } else if (is_indnum(&c)) {
186 } else if ((c > 31) && (c < 127)) {
188 lastind = (u_char)ind;
193 static void do_catch_up(struct spk_synth *synth)
195 int synth_full_val = 0;
197 static u_char last = '\0';
199 unsigned long jiff_max;
200 unsigned long timeout = msecs_to_jiffies(4000);
202 struct var_t *jiffy_delta;
203 struct var_t *delay_time;
207 jiffy_delta = spk_get_var(JIFFY);
208 delay_time = spk_get_var(DELAY);
209 spin_lock_irqsave(&speakup_info.spinlock, flags);
210 jiffy_delta_val = jiffy_delta->u.n.value;
211 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
212 jiff_max = jiffies + jiffy_delta_val;
214 while (!kthread_should_stop()) {
215 /* if no ctl-a in 4, send data anyway */
216 spin_lock_irqsave(&flush_lock, flags);
217 while (is_flushing && timeout) {
218 prepare_to_wait(&flush, &wait, TASK_INTERRUPTIBLE);
219 spin_unlock_irqrestore(&flush_lock, flags);
220 timeout = schedule_timeout(timeout);
221 spin_lock_irqsave(&flush_lock, flags);
223 finish_wait(&flush, &wait);
225 spin_unlock_irqrestore(&flush_lock, flags);
227 spin_lock_irqsave(&speakup_info.spinlock, flags);
228 if (speakup_info.flushing) {
229 speakup_info.flushing = 0;
230 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
234 synth_buffer_skip_nonlatin1();
235 if (synth_buffer_empty()) {
236 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
239 ch = synth_buffer_peek();
240 set_current_state(TASK_INTERRUPTIBLE);
241 delay_time_val = delay_time->u.n.value;
242 synth_full_val = synth_full();
243 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
246 if (synth_full_val || !synth->io_ops->synth_out(synth, ch)) {
247 schedule_timeout(msecs_to_jiffies(delay_time_val));
250 set_current_state(TASK_RUNNING);
251 spin_lock_irqsave(&speakup_info.spinlock, flags);
253 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
256 } else if (ch == ']') {
258 } else if (ch <= SPACE) {
259 if (!in_escape && strchr(",.!?;:", last))
260 synth->io_ops->synth_out(synth, PROCSPEECH);
261 if (time_after_eq(jiffies, jiff_max)) {
263 synth->io_ops->synth_out(synth,
265 spin_lock_irqsave(&speakup_info.spinlock,
267 jiffy_delta_val = jiffy_delta->u.n.value;
268 delay_time_val = delay_time->u.n.value;
269 spin_unlock_irqrestore(&speakup_info.spinlock,
271 schedule_timeout(msecs_to_jiffies
273 jiff_max = jiffies + jiffy_delta_val;
279 synth->io_ops->synth_out(synth, PROCSPEECH);
282 static void synth_flush(struct spk_synth *synth)
285 /* if in command output ']' so we don't get an error */
286 synth->io_ops->synth_out(synth, ']');
289 synth->io_ops->flush_buffer();
290 synth->io_ops->synth_out(synth, SYNTH_CLEAR);
293 module_param_named(ser, synth_dectlk.ser, int, 0444);
294 module_param_named(dev, synth_dectlk.dev_name, charp, 0444);
295 module_param_named(start, synth_dectlk.startup, short, 0444);
297 MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
298 MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer.");
299 MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
301 module_spk_synth(synth_dectlk);
303 MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
304 MODULE_AUTHOR("David Borowski");
305 MODULE_DESCRIPTION("Speakup support for DECtalk Express synthesizers");
306 MODULE_LICENSE("GPL");
307 MODULE_VERSION(DRV_VERSION);