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 * specificly written as a driver for the speakup screenreview
17 * package it's not a general device driver.
18 * This driver is for the Keynote Gold internal synthesizer.
20 #include <linux/jiffies.h>
21 #include <linux/sched.h>
22 #include <linux/timer.h>
23 #include <linux/kthread.h>
24 #include <linux/serial_reg.h>
29 #define DRV_VERSION "2.10"
30 #define SYNTH_IO_EXTENT 0x04
31 #define SWAIT udelay(70)
32 #define PROCSPEECH 0x1f
33 #define SYNTH_CLEAR 0x03
35 static int synth_probe(struct spk_synth *synth);
36 static void keynote_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);
41 static int synth_port;
42 static int port_forced;
43 static unsigned int synth_portlist[] = { 0x2a8, 0 };
45 static struct var_t vars[] = {
46 { CAPS_START, .u.s = {"[f130]" } },
47 { CAPS_STOP, .u.s = {"[f90]" } },
48 { RATE, .u.n = {"\04%c ", 8, 0, 10, 81, -8, NULL } },
49 { PITCH, .u.n = {"[f%d]", 5, 0, 9, 40, 10, NULL } },
50 { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
55 * These attributes will appear in /sys/accessibility/speakup/keypc.
57 static struct kobj_attribute caps_start_attribute =
58 __ATTR(caps_start, 0644, spk_var_show, spk_var_store);
59 static struct kobj_attribute caps_stop_attribute =
60 __ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
61 static struct kobj_attribute pitch_attribute =
62 __ATTR(pitch, 0644, spk_var_show, spk_var_store);
63 static struct kobj_attribute rate_attribute =
64 __ATTR(rate, 0644, spk_var_show, spk_var_store);
66 static struct kobj_attribute delay_time_attribute =
67 __ATTR(delay_time, 0644, spk_var_show, spk_var_store);
68 static struct kobj_attribute direct_attribute =
69 __ATTR(direct, 0644, spk_var_show, spk_var_store);
70 static struct kobj_attribute full_time_attribute =
71 __ATTR(full_time, 0644, spk_var_show, spk_var_store);
72 static struct kobj_attribute jiffy_delta_attribute =
73 __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
74 static struct kobj_attribute trigger_time_attribute =
75 __ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
78 * Create a group of attributes so that we can create and destroy them all
81 static struct attribute *synth_attrs[] = {
82 &caps_start_attribute.attr,
83 &caps_stop_attribute.attr,
84 &pitch_attribute.attr,
86 &delay_time_attribute.attr,
87 &direct_attribute.attr,
88 &full_time_attribute.attr,
89 &jiffy_delta_attribute.attr,
90 &trigger_time_attribute.attr,
91 NULL, /* need to NULL terminate the list of attributes */
94 static struct spk_synth synth_keypc = {
96 .version = DRV_VERSION,
97 .long_name = "Keynote PC",
98 .init = "[t][n7,1][n8,0]",
99 .procspeech = PROCSPEECH,
100 .clear = SYNTH_CLEAR,
105 .startup = SYNTH_START,
106 .checkval = SYNTH_CHECK,
108 .probe = synth_probe,
109 .release = keynote_release,
110 .synth_immediate = synth_immediate,
111 .catch_up = do_catch_up,
112 .flush = synth_flush,
113 .is_alive = spk_synth_is_alive_nop,
114 .synth_adjust = NULL,
115 .read_buff_add = NULL,
124 .attrs = synth_attrs,
129 static inline bool synth_writable(void)
131 return (inb_p(synth_port + UART_RX) & 0x10) != 0;
134 static inline bool synth_full(void)
136 return (inb_p(synth_port + UART_RX) & 0x80) == 0;
139 static char *oops(void)
143 s1 = inb_p(synth_port);
144 s2 = inb_p(synth_port+1);
145 s3 = inb_p(synth_port+2);
146 s4 = inb_p(synth_port+3);
147 pr_warn("synth timeout %d %d %d %d\n", s1, s2, s3, s4);
151 static const char *synth_immediate(struct spk_synth *synth, const char *buf)
156 while ((ch = *buf)) {
162 while (synth_writable())
165 outb_p(ch, synth_port);
172 static void do_catch_up(struct spk_synth *synth)
177 unsigned long jiff_max;
178 struct var_t *jiffy_delta;
179 struct var_t *delay_time;
180 struct var_t *full_time;
185 jiffy_delta = spk_get_var(JIFFY);
186 delay_time = spk_get_var(DELAY);
187 full_time = spk_get_var(FULL);
188 spin_lock_irqsave(&speakup_info.spinlock, flags);
189 jiffy_delta_val = jiffy_delta->u.n.value;
190 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
192 jiff_max = jiffies + jiffy_delta_val;
193 while (!kthread_should_stop()) {
194 spin_lock_irqsave(&speakup_info.spinlock, flags);
195 if (speakup_info.flushing) {
196 speakup_info.flushing = 0;
197 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
201 if (synth_buffer_empty()) {
202 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
205 set_current_state(TASK_INTERRUPTIBLE);
206 full_time_val = full_time->u.n.value;
207 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
209 schedule_timeout(msecs_to_jiffies(full_time_val));
212 set_current_state(TASK_RUNNING);
214 while (synth_writable())
221 spin_lock_irqsave(&speakup_info.spinlock, flags);
222 ch = synth_buffer_getc();
223 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
226 outb_p(ch, synth_port);
228 if (time_after_eq(jiffies, jiff_max) && (ch == SPACE)) {
230 while (synth_writable())
237 outb_p(PROCSPEECH, synth_port);
238 spin_lock_irqsave(&speakup_info.spinlock, flags);
239 jiffy_delta_val = jiffy_delta->u.n.value;
240 delay_time_val = delay_time->u.n.value;
241 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
242 schedule_timeout(msecs_to_jiffies(delay_time_val));
243 jiff_max = jiffies+jiffy_delta_val;
247 while (synth_writable())
253 outb_p(PROCSPEECH, synth_port);
256 static void synth_flush(struct spk_synth *synth)
258 outb_p(SYNTH_CLEAR, synth_port);
261 static int synth_probe(struct spk_synth *synth)
263 unsigned int port_val = 0;
266 pr_info("Probing for %s.\n", synth->long_name);
268 synth_port = port_forced;
269 pr_info("probe forced to %x by kernel command line\n",
271 if (synth_request_region(synth_port-1, SYNTH_IO_EXTENT)) {
272 pr_warn("sorry, port already reserved\n");
275 port_val = inb(synth_port);
277 for (i = 0; synth_portlist[i]; i++) {
278 if (synth_request_region(synth_portlist[i],
281 ("request_region: failed with 0x%x, %d\n",
282 synth_portlist[i], SYNTH_IO_EXTENT);
285 port_val = inb(synth_portlist[i]);
286 if (port_val == 0x80) {
287 synth_port = synth_portlist[i];
292 if (port_val != 0x80) {
293 pr_info("%s: not found\n", synth->long_name);
294 synth_release_region(synth_port, SYNTH_IO_EXTENT);
298 pr_info("%s: %03x-%03x, driver version %s,\n", synth->long_name,
299 synth_port, synth_port+SYNTH_IO_EXTENT-1,
305 static void keynote_release(void)
308 synth_release_region(synth_port, SYNTH_IO_EXTENT);
312 module_param_named(port, port_forced, int, 0444);
313 module_param_named(start, synth_keypc.startup, short, 0444);
315 MODULE_PARM_DESC(port, "Set the port for the synthesizer (override probing).");
316 MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
318 module_spk_synth(synth_keypc);
320 MODULE_AUTHOR("David Borowski");
321 MODULE_DESCRIPTION("Speakup support for Keynote Gold PC synthesizers");
322 MODULE_LICENSE("GPL");
323 MODULE_VERSION(DRV_VERSION);