1 /*
2 * 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 * this code is specificly written as a driver for the speakup screenreview
18 * package and is not a general device driver.
19 * This driver is for the Aicom Acent PC internal synthesizer.
20 */
21
22 #include <linux/jiffies.h>
23 #include <linux/sched.h>
24 #include <linux/timer.h>
25 #include <linux/kthread.h>
26
27 #include "spk_priv.h"
28 #include "serialio.h"
29 #include "speakup.h"
30 #include "speakup_acnt.h" /* local header file for Accent values */
31
32 #define DRV_VERSION "2.10"
33 #define PROCSPEECH '\r'
34
35 static int synth_probe(struct spk_synth *synth);
36 static void accent_release(void);
37 static const char *synth_immediate(struct spk_synth *synth, const char *buf);
38 static void do_catch_up(struct spk_synth *synth);
39 static void synth_flush(struct spk_synth *synth);
40
41 static int synth_port_control;
42 static int port_forced;
43 static unsigned int synth_portlist[] = { 0x2a8, 0 };
44
45 static struct var_t vars[] = {
46 { CAPS_START, .u.s = {"\033P8" } },
47 { CAPS_STOP, .u.s = {"\033P5" } },
48 { RATE, .u.n = {"\033R%c", 9, 0, 17, 0, 0, "0123456789abcdefgh" } },
49 { PITCH, .u.n = {"\033P%d", 5, 0, 9, 0, 0, NULL } },
50 { VOL, .u.n = {"\033A%d", 5, 0, 9, 0, 0, NULL } },
51 { TONE, .u.n = {"\033V%d", 5, 0, 9, 0, 0, NULL } },
52 { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
53 V_LAST_VAR
54 };
55
56 /*
57 * These attributes will appear in /sys/accessibility/speakup/acntpc.
58 */
59 static struct kobj_attribute caps_start_attribute =
60 __ATTR(caps_start, 0644, spk_var_show, spk_var_store);
61 static struct kobj_attribute caps_stop_attribute =
62 __ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
63 static struct kobj_attribute pitch_attribute =
64 __ATTR(pitch, 0644, spk_var_show, spk_var_store);
65 static struct kobj_attribute rate_attribute =
66 __ATTR(rate, 0644, spk_var_show, spk_var_store);
67 static struct kobj_attribute tone_attribute =
68 __ATTR(tone, 0644, spk_var_show, spk_var_store);
69 static struct kobj_attribute vol_attribute =
70 __ATTR(vol, 0644, spk_var_show, spk_var_store);
71
72 static struct kobj_attribute delay_time_attribute =
73 __ATTR(delay_time, 0644, spk_var_show, spk_var_store);
74 static struct kobj_attribute direct_attribute =
75 __ATTR(direct, 0644, spk_var_show, spk_var_store);
76 static struct kobj_attribute full_time_attribute =
77 __ATTR(full_time, 0644, spk_var_show, spk_var_store);
78 static struct kobj_attribute jiffy_delta_attribute =
79 __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
80 static struct kobj_attribute trigger_time_attribute =
81 __ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
82
83 /*
84 * Create a group of attributes so that we can create and destroy them all
85 * at once.
86 */
87 static struct attribute *synth_attrs[] = {
88 &caps_start_attribute.attr,
89 &caps_stop_attribute.attr,
90 &pitch_attribute.attr,
91 &rate_attribute.attr,
92 &tone_attribute.attr,
93 &vol_attribute.attr,
94 &delay_time_attribute.attr,
95 &direct_attribute.attr,
96 &full_time_attribute.attr,
97 &jiffy_delta_attribute.attr,
98 &trigger_time_attribute.attr,
99 NULL, /* need to NULL terminate the list of attributes */
100 };
101
102 static struct spk_synth synth_acntpc = {
103 .name = "acntpc",
104 .version = DRV_VERSION,
105 .long_name = "Accent PC",
106 .init = "\033=X \033Oi\033T2\033=M\033N1\n",
107 .procspeech = PROCSPEECH,
108 .clear = SYNTH_CLEAR,
109 .delay = 500,
110 .trigger = 50,
111 .jiffies = 50,
112 .full = 1000,
113 .startup = SYNTH_START,
114 .checkval = SYNTH_CHECK,
115 .vars = vars,
116 .io_ops = &spk_serial_io_ops,
117 .probe = synth_probe,
118 .release = accent_release,
119 .synth_immediate = synth_immediate,
120 .catch_up = do_catch_up,
121 .flush = synth_flush,
122 .is_alive = spk_synth_is_alive_nop,
123 .synth_adjust = NULL,
124 .read_buff_add = NULL,
125 .get_index = NULL,
126 .indexing = {
127 .command = NULL,
128 .lowindex = 0,
129 .highindex = 0,
130 .currindex = 0,
131 },
132 .attributes = {
133 .attrs = synth_attrs,
134 .name = "acntpc",
135 },
136 };
137
synth_writable(void)138 static inline bool synth_writable(void)
139 {
140 return inb_p(synth_port_control) & SYNTH_WRITABLE;
141 }
142
synth_full(void)143 static inline bool synth_full(void)
144 {
145 return inb_p(speakup_info.port_tts + UART_RX) == 'F';
146 }
147
synth_immediate(struct spk_synth * synth,const char * buf)148 static const char *synth_immediate(struct spk_synth *synth, const char *buf)
149 {
150 u_char ch;
151
152 while ((ch = *buf)) {
153 int timeout = SPK_XMITR_TIMEOUT;
154
155 if (ch == '\n')
156 ch = PROCSPEECH;
157 if (synth_full())
158 return buf;
159 while (synth_writable()) {
160 if (!--timeout)
161 return buf;
162 udelay(1);
163 }
164 outb_p(ch, speakup_info.port_tts);
165 buf++;
166 }
167 return NULL;
168 }
169
do_catch_up(struct spk_synth * synth)170 static void do_catch_up(struct spk_synth *synth)
171 {
172 u_char ch;
173 unsigned long flags;
174 unsigned long jiff_max;
175 int timeout;
176 int delay_time_val;
177 int jiffy_delta_val;
178 int full_time_val;
179 struct var_t *delay_time;
180 struct var_t *full_time;
181 struct var_t *jiffy_delta;
182
183 jiffy_delta = spk_get_var(JIFFY);
184 delay_time = spk_get_var(DELAY);
185 full_time = spk_get_var(FULL);
186
187 spin_lock_irqsave(&speakup_info.spinlock, flags);
188 jiffy_delta_val = jiffy_delta->u.n.value;
189 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
190
191 jiff_max = jiffies + jiffy_delta_val;
192 while (!kthread_should_stop()) {
193 spin_lock_irqsave(&speakup_info.spinlock, flags);
194 if (speakup_info.flushing) {
195 speakup_info.flushing = 0;
196 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
197 synth->flush(synth);
198 continue;
199 }
200 synth_buffer_skip_nonlatin1();
201 if (synth_buffer_empty()) {
202 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
203 break;
204 }
205 set_current_state(TASK_INTERRUPTIBLE);
206 full_time_val = full_time->u.n.value;
207 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
208 if (synth_full()) {
209 schedule_timeout(msecs_to_jiffies(full_time_val));
210 continue;
211 }
212 set_current_state(TASK_RUNNING);
213 timeout = SPK_XMITR_TIMEOUT;
214 while (synth_writable()) {
215 if (!--timeout)
216 break;
217 udelay(1);
218 }
219 spin_lock_irqsave(&speakup_info.spinlock, flags);
220 ch = synth_buffer_getc();
221 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
222 if (ch == '\n')
223 ch = PROCSPEECH;
224 outb_p(ch, speakup_info.port_tts);
225 if (time_after_eq(jiffies, jiff_max) && ch == SPACE) {
226 timeout = SPK_XMITR_TIMEOUT;
227 while (synth_writable()) {
228 if (!--timeout)
229 break;
230 udelay(1);
231 }
232 outb_p(PROCSPEECH, speakup_info.port_tts);
233 spin_lock_irqsave(&speakup_info.spinlock, flags);
234 jiffy_delta_val = jiffy_delta->u.n.value;
235 delay_time_val = delay_time->u.n.value;
236 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
237 schedule_timeout(msecs_to_jiffies(delay_time_val));
238 jiff_max = jiffies + jiffy_delta_val;
239 }
240 }
241 timeout = SPK_XMITR_TIMEOUT;
242 while (synth_writable()) {
243 if (!--timeout)
244 break;
245 udelay(1);
246 }
247 outb_p(PROCSPEECH, speakup_info.port_tts);
248 }
249
synth_flush(struct spk_synth * synth)250 static void synth_flush(struct spk_synth *synth)
251 {
252 outb_p(SYNTH_CLEAR, speakup_info.port_tts);
253 }
254
synth_probe(struct spk_synth * synth)255 static int synth_probe(struct spk_synth *synth)
256 {
257 unsigned int port_val = 0;
258 int i = 0;
259
260 pr_info("Probing for %s.\n", synth->long_name);
261 if (port_forced) {
262 speakup_info.port_tts = port_forced;
263 pr_info("probe forced to %x by kernel command line\n",
264 speakup_info.port_tts);
265 if (synth_request_region(speakup_info.port_tts - 1,
266 SYNTH_IO_EXTENT)) {
267 pr_warn("sorry, port already reserved\n");
268 return -EBUSY;
269 }
270 port_val = inw(speakup_info.port_tts - 1);
271 synth_port_control = speakup_info.port_tts - 1;
272 } else {
273 for (i = 0; synth_portlist[i]; i++) {
274 if (synth_request_region(synth_portlist[i],
275 SYNTH_IO_EXTENT)) {
276 pr_warn
277 ("request_region: failed with 0x%x, %d\n",
278 synth_portlist[i], SYNTH_IO_EXTENT);
279 continue;
280 }
281 port_val = inw(synth_portlist[i]) & 0xfffc;
282 if (port_val == 0x53fc) {
283 /* 'S' and out&input bits */
284 synth_port_control = synth_portlist[i];
285 speakup_info.port_tts = synth_port_control + 1;
286 break;
287 }
288 }
289 }
290 port_val &= 0xfffc;
291 if (port_val != 0x53fc) {
292 /* 'S' and out&input bits */
293 pr_info("%s: not found\n", synth->long_name);
294 synth_release_region(synth_port_control, SYNTH_IO_EXTENT);
295 synth_port_control = 0;
296 return -ENODEV;
297 }
298 pr_info("%s: %03x-%03x, driver version %s,\n", synth->long_name,
299 synth_port_control, synth_port_control + SYNTH_IO_EXTENT - 1,
300 synth->version);
301 synth->alive = 1;
302 return 0;
303 }
304
accent_release(void)305 static void accent_release(void)
306 {
307 spk_stop_serial_interrupt();
308 if (speakup_info.port_tts)
309 synth_release_region(speakup_info.port_tts-1, SYNTH_IO_EXTENT);
310 speakup_info.port_tts = 0;
311 }
312
313 module_param_hw_named(port, port_forced, int, ioport, 0444);
314 module_param_named(start, synth_acntpc.startup, short, 0444);
315
316 MODULE_PARM_DESC(port, "Set the port for the synthesizer (override probing).");
317 MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
318
319 module_spk_synth(synth_acntpc);
320
321 MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
322 MODULE_AUTHOR("David Borowski");
323 MODULE_DESCRIPTION("Speakup support for Accent PC synthesizer");
324 MODULE_LICENSE("GPL");
325 MODULE_VERSION(DRV_VERSION);
326
327