12067fd92SSamuel Thibault // SPDX-License-Identifier: GPL-2.0+
22067fd92SSamuel Thibault /*
32067fd92SSamuel Thibault * originally written by: Kirk Reiser <kirk@braille.uwo.ca>
42067fd92SSamuel Thibault * this version considerably modified by David Borowski, david575@rogers.com
52067fd92SSamuel Thibault *
62067fd92SSamuel Thibault * Copyright (C) 1998-99 Kirk Reiser.
72067fd92SSamuel Thibault * Copyright (C) 2003 David Borowski.
82067fd92SSamuel Thibault *
90b4efcb1STom Rix * specifically written as a driver for the speakup screenreview
102067fd92SSamuel Thibault * s not a general device driver.
112067fd92SSamuel Thibault */
122067fd92SSamuel Thibault #include "speakup.h"
132067fd92SSamuel Thibault #include "spk_priv.h"
142067fd92SSamuel Thibault #include "speakup_dtlk.h" /* local header file for LiteTalk values */
152067fd92SSamuel Thibault
162067fd92SSamuel Thibault #define DRV_VERSION "2.11"
172067fd92SSamuel Thibault #define PROCSPEECH 0x0d
182067fd92SSamuel Thibault
192067fd92SSamuel Thibault static int synth_probe(struct spk_synth *synth);
202067fd92SSamuel Thibault
21*88dce45bSOsama Muhammad
22*88dce45bSOsama Muhammad enum default_vars_id {
23*88dce45bSOsama Muhammad CAPS_START_ID = 0, CAPS_STOP_ID,
24*88dce45bSOsama Muhammad RATE_ID, PITCH_ID,
25*88dce45bSOsama Muhammad VOL_ID, TONE_ID, PUNCT_ID,
26*88dce45bSOsama Muhammad VOICE_ID, FREQUENCY_ID,
27*88dce45bSOsama Muhammad DIRECT_ID, V_LAST_VAR_ID,
28*88dce45bSOsama Muhammad NB_ID
29*88dce45bSOsama Muhammad };
30*88dce45bSOsama Muhammad
31*88dce45bSOsama Muhammad
32*88dce45bSOsama Muhammad static struct var_t vars[NB_ID] = {
33*88dce45bSOsama Muhammad [CAPS_START_ID] = { CAPS_START, .u.s = {"\x01+35p" } },
34*88dce45bSOsama Muhammad [CAPS_STOP_ID] = { CAPS_STOP, .u.s = {"\x01-35p" } },
35*88dce45bSOsama Muhammad [RATE_ID] = { RATE, .u.n = {"\x01%ds", 8, 0, 9, 0, 0, NULL } },
36*88dce45bSOsama Muhammad [PITCH_ID] = { PITCH, .u.n = {"\x01%dp", 50, 0, 99, 0, 0, NULL } },
37*88dce45bSOsama Muhammad [VOL_ID] = { VOL, .u.n = {"\x01%dv", 5, 0, 9, 0, 0, NULL } },
38*88dce45bSOsama Muhammad [TONE_ID] = { TONE, .u.n = {"\x01%dx", 1, 0, 2, 0, 0, NULL } },
39*88dce45bSOsama Muhammad [PUNCT_ID] = { PUNCT, .u.n = {"\x01%db", 7, 0, 15, 0, 0, NULL } },
40*88dce45bSOsama Muhammad [VOICE_ID] = { VOICE, .u.n = {"\x01%do", 0, 0, 7, 0, 0, NULL } },
41*88dce45bSOsama Muhammad [FREQUENCY_ID] = { FREQUENCY, .u.n = {"\x01%df", 5, 0, 9, 0, 0, NULL } },
42*88dce45bSOsama Muhammad [DIRECT_ID] = { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
432067fd92SSamuel Thibault V_LAST_VAR
442067fd92SSamuel Thibault };
452067fd92SSamuel Thibault
462067fd92SSamuel Thibault /*
472067fd92SSamuel Thibault * These attributes will appear in /sys/accessibility/speakup/ltlk.
482067fd92SSamuel Thibault */
492067fd92SSamuel Thibault static struct kobj_attribute caps_start_attribute =
502067fd92SSamuel Thibault __ATTR(caps_start, 0644, spk_var_show, spk_var_store);
512067fd92SSamuel Thibault static struct kobj_attribute caps_stop_attribute =
522067fd92SSamuel Thibault __ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
532067fd92SSamuel Thibault static struct kobj_attribute freq_attribute =
542067fd92SSamuel Thibault __ATTR(freq, 0644, spk_var_show, spk_var_store);
552067fd92SSamuel Thibault static struct kobj_attribute pitch_attribute =
562067fd92SSamuel Thibault __ATTR(pitch, 0644, spk_var_show, spk_var_store);
572067fd92SSamuel Thibault static struct kobj_attribute punct_attribute =
582067fd92SSamuel Thibault __ATTR(punct, 0644, spk_var_show, spk_var_store);
592067fd92SSamuel Thibault static struct kobj_attribute rate_attribute =
602067fd92SSamuel Thibault __ATTR(rate, 0644, spk_var_show, spk_var_store);
612067fd92SSamuel Thibault static struct kobj_attribute tone_attribute =
622067fd92SSamuel Thibault __ATTR(tone, 0644, spk_var_show, spk_var_store);
632067fd92SSamuel Thibault static struct kobj_attribute voice_attribute =
642067fd92SSamuel Thibault __ATTR(voice, 0644, spk_var_show, spk_var_store);
652067fd92SSamuel Thibault static struct kobj_attribute vol_attribute =
662067fd92SSamuel Thibault __ATTR(vol, 0644, spk_var_show, spk_var_store);
672067fd92SSamuel Thibault
682067fd92SSamuel Thibault static struct kobj_attribute delay_time_attribute =
692067fd92SSamuel Thibault __ATTR(delay_time, 0644, spk_var_show, spk_var_store);
702067fd92SSamuel Thibault static struct kobj_attribute direct_attribute =
712067fd92SSamuel Thibault __ATTR(direct, 0644, spk_var_show, spk_var_store);
722067fd92SSamuel Thibault static struct kobj_attribute full_time_attribute =
732067fd92SSamuel Thibault __ATTR(full_time, 0644, spk_var_show, spk_var_store);
742067fd92SSamuel Thibault static struct kobj_attribute jiffy_delta_attribute =
752067fd92SSamuel Thibault __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
762067fd92SSamuel Thibault static struct kobj_attribute trigger_time_attribute =
772067fd92SSamuel Thibault __ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
782067fd92SSamuel Thibault
792067fd92SSamuel Thibault /*
802067fd92SSamuel Thibault * Create a group of attributes so that we can create and destroy them all
812067fd92SSamuel Thibault * at once.
822067fd92SSamuel Thibault */
832067fd92SSamuel Thibault static struct attribute *synth_attrs[] = {
842067fd92SSamuel Thibault &caps_start_attribute.attr,
852067fd92SSamuel Thibault &caps_stop_attribute.attr,
862067fd92SSamuel Thibault &freq_attribute.attr,
872067fd92SSamuel Thibault &pitch_attribute.attr,
882067fd92SSamuel Thibault &punct_attribute.attr,
892067fd92SSamuel Thibault &rate_attribute.attr,
902067fd92SSamuel Thibault &tone_attribute.attr,
912067fd92SSamuel Thibault &voice_attribute.attr,
922067fd92SSamuel Thibault &vol_attribute.attr,
932067fd92SSamuel Thibault &delay_time_attribute.attr,
942067fd92SSamuel Thibault &direct_attribute.attr,
952067fd92SSamuel Thibault &full_time_attribute.attr,
962067fd92SSamuel Thibault &jiffy_delta_attribute.attr,
972067fd92SSamuel Thibault &trigger_time_attribute.attr,
982067fd92SSamuel Thibault NULL, /* need to NULL terminate the list of attributes */
992067fd92SSamuel Thibault };
1002067fd92SSamuel Thibault
1012067fd92SSamuel Thibault static struct spk_synth synth_ltlk = {
1022067fd92SSamuel Thibault .name = "ltlk",
1032067fd92SSamuel Thibault .version = DRV_VERSION,
1042067fd92SSamuel Thibault .long_name = "LiteTalk",
1052067fd92SSamuel Thibault .init = "\01@\x01\x31y\n\0",
1062067fd92SSamuel Thibault .procspeech = PROCSPEECH,
1072067fd92SSamuel Thibault .clear = SYNTH_CLEAR,
1082067fd92SSamuel Thibault .delay = 500,
1092067fd92SSamuel Thibault .trigger = 50,
1102067fd92SSamuel Thibault .jiffies = 50,
1112067fd92SSamuel Thibault .full = 40000,
1122067fd92SSamuel Thibault .dev_name = SYNTH_DEFAULT_DEV,
1132067fd92SSamuel Thibault .startup = SYNTH_START,
1142067fd92SSamuel Thibault .checkval = SYNTH_CHECK,
1152067fd92SSamuel Thibault .vars = vars,
1162067fd92SSamuel Thibault .io_ops = &spk_ttyio_ops,
1172067fd92SSamuel Thibault .probe = synth_probe,
1182067fd92SSamuel Thibault .release = spk_ttyio_release,
1192067fd92SSamuel Thibault .synth_immediate = spk_ttyio_synth_immediate,
1202067fd92SSamuel Thibault .catch_up = spk_do_catch_up,
1212067fd92SSamuel Thibault .flush = spk_synth_flush,
1222067fd92SSamuel Thibault .is_alive = spk_synth_is_alive_restart,
1232067fd92SSamuel Thibault .synth_adjust = NULL,
1242067fd92SSamuel Thibault .read_buff_add = NULL,
1252067fd92SSamuel Thibault .get_index = spk_synth_get_index,
1262067fd92SSamuel Thibault .indexing = {
1272067fd92SSamuel Thibault .command = "\x01%di",
1282067fd92SSamuel Thibault .lowindex = 1,
1292067fd92SSamuel Thibault .highindex = 5,
1302067fd92SSamuel Thibault .currindex = 1,
1312067fd92SSamuel Thibault },
1322067fd92SSamuel Thibault .attributes = {
1332067fd92SSamuel Thibault .attrs = synth_attrs,
1342067fd92SSamuel Thibault .name = "ltlk",
1352067fd92SSamuel Thibault },
1362067fd92SSamuel Thibault };
1372067fd92SSamuel Thibault
1382067fd92SSamuel Thibault /* interrogate the LiteTalk and print its settings */
synth_interrogate(struct spk_synth * synth)1392067fd92SSamuel Thibault static void synth_interrogate(struct spk_synth *synth)
1402067fd92SSamuel Thibault {
1412067fd92SSamuel Thibault unsigned char *t, i;
1422067fd92SSamuel Thibault unsigned char buf[50], rom_v[20];
1432067fd92SSamuel Thibault
1442067fd92SSamuel Thibault synth->synth_immediate(synth, "\x18\x01?");
1452067fd92SSamuel Thibault for (i = 0; i < 50; i++) {
1461941ab1dSSamuel Thibault buf[i] = synth->io_ops->synth_in(synth);
1472067fd92SSamuel Thibault if (i > 2 && buf[i] == 0x7f)
1482067fd92SSamuel Thibault break;
1492067fd92SSamuel Thibault }
1502067fd92SSamuel Thibault t = buf + 2;
1512067fd92SSamuel Thibault for (i = 0; *t != '\r'; t++) {
1522067fd92SSamuel Thibault rom_v[i] = *t;
1532067fd92SSamuel Thibault if (++i >= 19)
1542067fd92SSamuel Thibault break;
1552067fd92SSamuel Thibault }
1562067fd92SSamuel Thibault rom_v[i] = 0;
1572067fd92SSamuel Thibault pr_info("%s: ROM version: %s\n", synth->long_name, rom_v);
1582067fd92SSamuel Thibault }
1592067fd92SSamuel Thibault
synth_probe(struct spk_synth * synth)1602067fd92SSamuel Thibault static int synth_probe(struct spk_synth *synth)
1612067fd92SSamuel Thibault {
1622067fd92SSamuel Thibault int failed = 0;
1632067fd92SSamuel Thibault
1642067fd92SSamuel Thibault failed = spk_ttyio_synth_probe(synth);
1652067fd92SSamuel Thibault if (failed == 0)
1662067fd92SSamuel Thibault synth_interrogate(synth);
1672067fd92SSamuel Thibault synth->alive = !failed;
1682067fd92SSamuel Thibault return failed;
1692067fd92SSamuel Thibault }
1702067fd92SSamuel Thibault
1712067fd92SSamuel Thibault module_param_named(ser, synth_ltlk.ser, int, 0444);
1722067fd92SSamuel Thibault module_param_named(dev, synth_ltlk.dev_name, charp, 0444);
1732067fd92SSamuel Thibault module_param_named(start, synth_ltlk.startup, short, 0444);
174*88dce45bSOsama Muhammad module_param_named(rate, vars[RATE_ID].u.n.default_val, int, 0444);
175*88dce45bSOsama Muhammad module_param_named(pitch, vars[PITCH_ID].u.n.default_val, int, 0444);
176*88dce45bSOsama Muhammad module_param_named(vol, vars[VOL_ID].u.n.default_val, int, 0444);
177*88dce45bSOsama Muhammad module_param_named(tone, vars[TONE_ID].u.n.default_val, int, 0444);
178*88dce45bSOsama Muhammad module_param_named(punct, vars[PUNCT_ID].u.n.default_val, int, 0444);
179*88dce45bSOsama Muhammad module_param_named(voice, vars[VOICE_ID].u.n.default_val, int, 0444);
180*88dce45bSOsama Muhammad module_param_named(frequency, vars[FREQUENCY_ID].u.n.default_val, int, 0444);
181*88dce45bSOsama Muhammad module_param_named(direct, vars[DIRECT_ID].u.n.default_val, int, 0444);
182*88dce45bSOsama Muhammad
183*88dce45bSOsama Muhammad
184*88dce45bSOsama Muhammad
1852067fd92SSamuel Thibault
1862067fd92SSamuel Thibault MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
1872067fd92SSamuel Thibault MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer.");
1882067fd92SSamuel Thibault MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
189*88dce45bSOsama Muhammad MODULE_PARM_DESC(rate, "Set the rate variable on load.");
190*88dce45bSOsama Muhammad MODULE_PARM_DESC(pitch, "Set the pitch variable on load.");
191*88dce45bSOsama Muhammad MODULE_PARM_DESC(vol, "Set the vol variable on load.");
192*88dce45bSOsama Muhammad MODULE_PARM_DESC(tone, "Set the tone variable on load.");
193*88dce45bSOsama Muhammad MODULE_PARM_DESC(punct, "Set the punct variable on load.");
194*88dce45bSOsama Muhammad MODULE_PARM_DESC(voice, "Set the voice variable on load.");
195*88dce45bSOsama Muhammad MODULE_PARM_DESC(frequency, "Set the frequency variable on load.");
196*88dce45bSOsama Muhammad MODULE_PARM_DESC(direct, "Set the direct variable on load.");
197*88dce45bSOsama Muhammad
1982067fd92SSamuel Thibault
1992067fd92SSamuel Thibault module_spk_synth(synth_ltlk);
2002067fd92SSamuel Thibault
2012067fd92SSamuel Thibault MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
2022067fd92SSamuel Thibault MODULE_AUTHOR("David Borowski");
2032067fd92SSamuel Thibault MODULE_DESCRIPTION("Speakup support for DoubleTalk LT/LiteTalk synthesizers");
2042067fd92SSamuel Thibault MODULE_LICENSE("GPL");
2052067fd92SSamuel Thibault MODULE_VERSION(DRV_VERSION);
2062067fd92SSamuel Thibault
207