2 * written by David Borowski
4 * Copyright (C) 2003 David Borowski.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * specificly written as a driver for the speakup screenreview
21 * package it's not a general device driver.
22 * This driver is for the Keynote Gold internal synthesizer.
24 #include <linux/jiffies.h>
25 #include <linux/sched.h>
26 #include <linux/timer.h>
27 #include <linux/kthread.h>
28 #include <linux/serial_reg.h>
33 #define DRV_VERSION "2.10"
34 #define SYNTH_IO_EXTENT 0x04
35 #define SWAIT udelay(70)
36 #define PROCSPEECH 0x1f
37 #define SYNTH_CLEAR 0x03
39 static int synth_probe(struct spk_synth *synth);
40 static void keynote_release(void);
41 static const char *synth_immediate(struct spk_synth *synth, const char *buf);
42 static void do_catch_up(struct spk_synth *synth);
43 static void synth_flush(struct spk_synth *synth);
45 static int synth_port;
46 static int port_forced;
47 static unsigned int synth_portlist[] = { 0x2a8, 0 };
49 static struct var_t vars[] = {
50 { CAPS_START, .u.s = {"[f130]" } },
51 { CAPS_STOP, .u.s = {"[f90]" } },
52 { RATE, .u.n = {"\04%c ", 8, 0, 10, 81, -8, NULL } },
53 { PITCH, .u.n = {"[f%d]", 5, 0, 9, 40, 10, NULL } },
54 { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
59 * These attributes will appear in /sys/accessibility/speakup/keypc.
61 static struct kobj_attribute caps_start_attribute =
62 __ATTR(caps_start, USER_RW, spk_var_show, spk_var_store);
63 static struct kobj_attribute caps_stop_attribute =
64 __ATTR(caps_stop, USER_RW, spk_var_show, spk_var_store);
65 static struct kobj_attribute pitch_attribute =
66 __ATTR(pitch, USER_RW, spk_var_show, spk_var_store);
67 static struct kobj_attribute rate_attribute =
68 __ATTR(rate, USER_RW, spk_var_show, spk_var_store);
70 static struct kobj_attribute delay_time_attribute =
71 __ATTR(delay_time, ROOT_W, spk_var_show, spk_var_store);
72 static struct kobj_attribute direct_attribute =
73 __ATTR(direct, USER_RW, spk_var_show, spk_var_store);
74 static struct kobj_attribute full_time_attribute =
75 __ATTR(full_time, ROOT_W, spk_var_show, spk_var_store);
76 static struct kobj_attribute jiffy_delta_attribute =
77 __ATTR(jiffy_delta, ROOT_W, spk_var_show, spk_var_store);
78 static struct kobj_attribute trigger_time_attribute =
79 __ATTR(trigger_time, ROOT_W, spk_var_show, spk_var_store);
82 * Create a group of attributes so that we can create and destroy them all
85 static struct attribute *synth_attrs[] = {
86 &caps_start_attribute.attr,
87 &caps_stop_attribute.attr,
88 &pitch_attribute.attr,
90 &delay_time_attribute.attr,
91 &direct_attribute.attr,
92 &full_time_attribute.attr,
93 &jiffy_delta_attribute.attr,
94 &trigger_time_attribute.attr,
95 NULL, /* need to NULL terminate the list of attributes */
98 static struct spk_synth synth_keypc = {
100 .version = DRV_VERSION,
101 .long_name = "Keynote PC",
102 .init = "[t][n7,1][n8,0]",
103 .procspeech = PROCSPEECH,
104 .clear = SYNTH_CLEAR,
109 .startup = SYNTH_START,
110 .checkval = SYNTH_CHECK,
112 .probe = synth_probe,
113 .release = keynote_release,
114 .synth_immediate = synth_immediate,
115 .catch_up = do_catch_up,
116 .flush = synth_flush,
117 .is_alive = spk_synth_is_alive_nop,
118 .synth_adjust = NULL,
119 .read_buff_add = NULL,
128 .attrs = synth_attrs,
133 static inline bool synth_writable(void)
135 return (inb_p(synth_port + UART_RX) & 0x10) != 0;
138 static inline bool synth_full(void)
140 return (inb_p(synth_port + UART_RX) & 0x80) == 0;
143 static char *oops(void)
146 s1 = inb_p(synth_port);
147 s2 = inb_p(synth_port+1);
148 s3 = inb_p(synth_port+2);
149 s4 = inb_p(synth_port+3);
150 pr_warn("synth timeout %d %d %d %d\n", s1, s2, s3, s4);
154 static const char *synth_immediate(struct spk_synth *synth, const char *buf)
158 while ((ch = *buf)) {
164 while (synth_writable())
167 outb_p(ch, synth_port);
174 static void do_catch_up(struct spk_synth *synth)
179 unsigned long jiff_max;
180 struct var_t *jiffy_delta;
181 struct var_t *delay_time;
182 struct var_t *full_time;
187 jiffy_delta = spk_get_var(JIFFY);
188 delay_time = spk_get_var(DELAY);
189 full_time = spk_get_var(FULL);
190 spin_lock_irqsave(&speakup_info.spinlock, flags);
191 jiffy_delta_val = jiffy_delta->u.n.value;
192 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
194 jiff_max = jiffies + jiffy_delta_val;
195 while (!kthread_should_stop()) {
196 spin_lock_irqsave(&speakup_info.spinlock, flags);
197 if (speakup_info.flushing) {
198 speakup_info.flushing = 0;
199 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
203 if (synth_buffer_empty()) {
204 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
207 set_current_state(TASK_INTERRUPTIBLE);
208 full_time_val = full_time->u.n.value;
209 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
211 schedule_timeout(msecs_to_jiffies(full_time_val));
214 set_current_state(TASK_RUNNING);
216 while (synth_writable())
223 spin_lock_irqsave(&speakup_info.spinlock, flags);
224 ch = synth_buffer_getc();
225 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
228 outb_p(ch, synth_port);
230 if ((jiffies >= jiff_max) && (ch == SPACE)) {
232 while (synth_writable())
239 outb_p(PROCSPEECH, synth_port);
240 spin_lock_irqsave(&speakup_info.spinlock, flags);
241 jiffy_delta_val = jiffy_delta->u.n.value;
242 delay_time_val = delay_time->u.n.value;
243 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
244 schedule_timeout(msecs_to_jiffies(delay_time_val));
245 jiff_max = jiffies+jiffy_delta_val;
249 while (synth_writable())
255 outb_p(PROCSPEECH, synth_port);
258 static void synth_flush(struct spk_synth *synth)
260 outb_p(SYNTH_CLEAR, synth_port);
263 static int synth_probe(struct spk_synth *synth)
265 unsigned int port_val = 0;
267 pr_info("Probing for %s.\n", synth->long_name);
269 synth_port = port_forced;
270 pr_info("probe forced to %x by kernel command line\n",
272 if (synth_request_region(synth_port-1, SYNTH_IO_EXTENT)) {
273 pr_warn("sorry, port already reserved\n");
276 port_val = inb(synth_port);
278 for (i = 0; synth_portlist[i]; i++) {
279 if (synth_request_region(synth_portlist[i],
282 ("request_region: failed with 0x%x, %d\n",
283 synth_portlist[i], SYNTH_IO_EXTENT);
286 port_val = inb(synth_portlist[i]);
287 if (port_val == 0x80) {
288 synth_port = synth_portlist[i];
293 if (port_val != 0x80) {
294 pr_info("%s: not found\n", synth->long_name);
295 synth_release_region(synth_port, SYNTH_IO_EXTENT);
299 pr_info("%s: %03x-%03x, driver version %s,\n", synth->long_name,
300 synth_port, synth_port+SYNTH_IO_EXTENT-1,
306 static void keynote_release(void)
309 synth_release_region(synth_port, SYNTH_IO_EXTENT);
313 module_param_named(port, port_forced, int, S_IRUGO);
314 module_param_named(start, synth_keypc.startup, short, S_IRUGO);
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.");
319 static int __init keypc_init(void)
321 return synth_add(&synth_keypc);
324 static void __exit keypc_exit(void)
326 synth_remove(&synth_keypc);
329 module_init(keypc_init);
330 module_exit(keypc_exit);
331 MODULE_AUTHOR("David Borowski");
332 MODULE_DESCRIPTION("Speakup support for Keynote Gold PC synthesizers");
333 MODULE_LICENSE("GPL");
334 MODULE_VERSION(DRV_VERSION);