^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0+
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * originally written by: Kirk Reiser <kirk@braille.uwo.ca>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * this version considerably modified by David Borowski, david575@rogers.com
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Copyright (C) 1998-99 Kirk Reiser.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * Copyright (C) 2003 David Borowski.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) * this code is specificly written as a driver for the speakup screenreview
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) * package and is not a general device driver.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #include <linux/jiffies.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #include <linux/sched.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include <linux/timer.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #include <linux/kthread.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #include <linux/serial_reg.h> /* for UART_MCR* constants */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #include "spk_priv.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #include "speakup.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #define DRV_VERSION "2.21"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #define SYNTH_CLEAR 0x18
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #define PROCSPEECH '\r'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) static void do_catch_up(struct spk_synth *synth);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) static struct var_t vars[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) { CAPS_START, .u.s = {"cap, " } },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) { CAPS_STOP, .u.s = {"" } },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) { RATE, .u.n = {"@W%d", 6, 1, 9, 0, 0, NULL } },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) { PITCH, .u.n = {"@F%x", 10, 0, 15, 0, 0, NULL } },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) { VOL, .u.n = {"@A%x", 10, 0, 15, 0, 0, NULL } },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) { VOICE, .u.n = {"@V%d", 1, 1, 6, 0, 0, NULL } },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) { LANG, .u.n = {"@=%d,", 1, 1, 4, 0, 0, NULL } },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) V_LAST_VAR
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) * These attributes will appear in /sys/accessibility/speakup/apollo.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) static struct kobj_attribute caps_start_attribute =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) __ATTR(caps_start, 0644, spk_var_show, spk_var_store);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) static struct kobj_attribute caps_stop_attribute =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) __ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) static struct kobj_attribute lang_attribute =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) __ATTR(lang, 0644, spk_var_show, spk_var_store);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) static struct kobj_attribute pitch_attribute =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) __ATTR(pitch, 0644, spk_var_show, spk_var_store);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) static struct kobj_attribute rate_attribute =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) __ATTR(rate, 0644, spk_var_show, spk_var_store);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) static struct kobj_attribute voice_attribute =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) __ATTR(voice, 0644, spk_var_show, spk_var_store);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) static struct kobj_attribute vol_attribute =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) __ATTR(vol, 0644, spk_var_show, spk_var_store);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) static struct kobj_attribute delay_time_attribute =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) __ATTR(delay_time, 0644, spk_var_show, spk_var_store);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) static struct kobj_attribute direct_attribute =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) __ATTR(direct, 0644, spk_var_show, spk_var_store);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) static struct kobj_attribute full_time_attribute =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) __ATTR(full_time, 0644, spk_var_show, spk_var_store);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) static struct kobj_attribute jiffy_delta_attribute =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) static struct kobj_attribute trigger_time_attribute =
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) __ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) * Create a group of attributes so that we can create and destroy them all
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) * at once.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) static struct attribute *synth_attrs[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) &caps_start_attribute.attr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) &caps_stop_attribute.attr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) &lang_attribute.attr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) &pitch_attribute.attr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) &rate_attribute.attr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) &voice_attribute.attr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) &vol_attribute.attr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) &delay_time_attribute.attr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) &direct_attribute.attr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) &full_time_attribute.attr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) &jiffy_delta_attribute.attr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) &trigger_time_attribute.attr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) NULL, /* need to NULL terminate the list of attributes */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) static struct spk_synth synth_apollo = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) .name = "apollo",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) .version = DRV_VERSION,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) .long_name = "Apollo",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) .init = "@R3@D0@K1\r",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) .procspeech = PROCSPEECH,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) .clear = SYNTH_CLEAR,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) .delay = 500,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) .trigger = 50,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) .jiffies = 50,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) .full = 40000,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) .dev_name = SYNTH_DEFAULT_DEV,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) .startup = SYNTH_START,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) .checkval = SYNTH_CHECK,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) .vars = vars,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) .io_ops = &spk_ttyio_ops,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) .probe = spk_ttyio_synth_probe,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) .release = spk_ttyio_release,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) .synth_immediate = spk_ttyio_synth_immediate,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) .catch_up = do_catch_up,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) .flush = spk_synth_flush,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) .is_alive = spk_synth_is_alive_restart,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) .synth_adjust = NULL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) .read_buff_add = NULL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) .get_index = NULL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) .indexing = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) .command = NULL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) .lowindex = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) .highindex = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) .currindex = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) .attributes = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) .attrs = synth_attrs,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) .name = "apollo",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) static void do_catch_up(struct spk_synth *synth)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) u_char ch;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) unsigned long flags;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) unsigned long jiff_max;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) struct var_t *jiffy_delta;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) struct var_t *delay_time;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) struct var_t *full_time;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) int full_time_val = 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) int delay_time_val = 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) int jiffy_delta_val = 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) jiffy_delta = spk_get_var(JIFFY);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) delay_time = spk_get_var(DELAY);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) full_time = spk_get_var(FULL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) spin_lock_irqsave(&speakup_info.spinlock, flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) jiffy_delta_val = jiffy_delta->u.n.value;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) spin_unlock_irqrestore(&speakup_info.spinlock, flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) jiff_max = jiffies + jiffy_delta_val;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) while (!kthread_should_stop()) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) spin_lock_irqsave(&speakup_info.spinlock, flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) jiffy_delta_val = jiffy_delta->u.n.value;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) full_time_val = full_time->u.n.value;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) delay_time_val = delay_time->u.n.value;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) if (speakup_info.flushing) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) speakup_info.flushing = 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) spin_unlock_irqrestore(&speakup_info.spinlock, flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) synth->flush(synth);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) continue;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) synth_buffer_skip_nonlatin1();
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) if (synth_buffer_empty()) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) spin_unlock_irqrestore(&speakup_info.spinlock, flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) ch = synth_buffer_peek();
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) set_current_state(TASK_INTERRUPTIBLE);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) full_time_val = full_time->u.n.value;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) spin_unlock_irqrestore(&speakup_info.spinlock, flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) if (!synth->io_ops->synth_out(synth, ch)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) synth->io_ops->tiocmset(0, UART_MCR_RTS);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) synth->io_ops->tiocmset(UART_MCR_RTS, 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) schedule_timeout(msecs_to_jiffies(full_time_val));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) continue;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) if (time_after_eq(jiffies, jiff_max) && (ch == SPACE)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) spin_lock_irqsave(&speakup_info.spinlock, flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) jiffy_delta_val = jiffy_delta->u.n.value;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) full_time_val = full_time->u.n.value;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) delay_time_val = delay_time->u.n.value;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) spin_unlock_irqrestore(&speakup_info.spinlock, flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) if (synth->io_ops->synth_out(synth, synth->procspeech))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) schedule_timeout(msecs_to_jiffies
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) (delay_time_val));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) schedule_timeout(msecs_to_jiffies
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) (full_time_val));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) jiff_max = jiffies + jiffy_delta_val;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) set_current_state(TASK_RUNNING);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) spin_lock_irqsave(&speakup_info.spinlock, flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) synth_buffer_getc();
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) spin_unlock_irqrestore(&speakup_info.spinlock, flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) synth->io_ops->synth_out(synth, PROCSPEECH);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) module_param_named(ser, synth_apollo.ser, int, 0444);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) module_param_named(dev, synth_apollo.dev_name, charp, 0444);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) module_param_named(start, synth_apollo.startup, short, 0444);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer.");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) module_spk_synth(synth_apollo);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) MODULE_AUTHOR("David Borowski");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) MODULE_DESCRIPTION("Speakup support for Apollo II synthesizer");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) MODULE_LICENSE("GPL");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) MODULE_VERSION(DRV_VERSION);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208)