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