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 "spk_priv.h"
132067fd92SSamuel Thibault #include "speakup.h"
142067fd92SSamuel Thibault
152067fd92SSamuel Thibault #define DRV_VERSION "2.11"
162067fd92SSamuel Thibault #define SYNTH_CLEAR 0x18 /* flush synth buffer */
172067fd92SSamuel Thibault #define PROCSPEECH '\r' /* start synth processing speech char */
182067fd92SSamuel Thibault
192067fd92SSamuel Thibault static int synth_probe(struct spk_synth *synth);
202067fd92SSamuel Thibault static void synth_flush(struct spk_synth *synth);
212067fd92SSamuel Thibault
22*d5dab7ffSOsama Muhammad
23*d5dab7ffSOsama Muhammad enum default_vars_id {
24*d5dab7ffSOsama Muhammad CAPS_START_ID = 0, CAPS_STOP_ID,
25*d5dab7ffSOsama Muhammad RATE_ID, PITCH_ID,
26*d5dab7ffSOsama Muhammad VOL_ID, TONE_ID, PUNCT_ID,
27*d5dab7ffSOsama Muhammad DIRECT_ID, V_LAST_VAR_ID,
28*d5dab7ffSOsama Muhammad NB_ID
29*d5dab7ffSOsama Muhammad };
30*d5dab7ffSOsama Muhammad
31*d5dab7ffSOsama Muhammad static struct var_t vars[NB_ID] = {
32*d5dab7ffSOsama Muhammad [CAPS_START_ID] = { CAPS_START, .u.s = {"\x05[f99]" } },
33*d5dab7ffSOsama Muhammad [CAPS_STOP_ID] = { CAPS_STOP, .u.s = {"\x05[f80]" } },
34*d5dab7ffSOsama Muhammad [RATE_ID] = { RATE, .u.n = {"\x05[r%d]", 10, 0, 20, 100, -10, NULL } },
35*d5dab7ffSOsama Muhammad [PITCH_ID] = { PITCH, .u.n = {"\x05[f%d]", 80, 39, 4500, 0, 0, NULL } },
36*d5dab7ffSOsama Muhammad [VOL_ID] = { VOL, .u.n = {"\x05[g%d]", 21, 0, 40, 0, 0, NULL } },
37*d5dab7ffSOsama Muhammad [TONE_ID] = { TONE, .u.n = {"\x05[s%d]", 9, 0, 63, 0, 0, NULL } },
38*d5dab7ffSOsama Muhammad [PUNCT_ID] = { PUNCT, .u.n = {"\x05[A%c]", 0, 0, 3, 0, 0, "nmsa" } },
39*d5dab7ffSOsama Muhammad [DIRECT_ID] = { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
402067fd92SSamuel Thibault V_LAST_VAR
412067fd92SSamuel Thibault };
422067fd92SSamuel Thibault
432067fd92SSamuel Thibault /*
442067fd92SSamuel Thibault * These attributes will appear in /sys/accessibility/speakup/audptr.
452067fd92SSamuel Thibault */
462067fd92SSamuel Thibault static struct kobj_attribute caps_start_attribute =
472067fd92SSamuel Thibault __ATTR(caps_start, 0644, spk_var_show, spk_var_store);
482067fd92SSamuel Thibault static struct kobj_attribute caps_stop_attribute =
492067fd92SSamuel Thibault __ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
502067fd92SSamuel Thibault static struct kobj_attribute pitch_attribute =
512067fd92SSamuel Thibault __ATTR(pitch, 0644, spk_var_show, spk_var_store);
522067fd92SSamuel Thibault static struct kobj_attribute punct_attribute =
532067fd92SSamuel Thibault __ATTR(punct, 0644, spk_var_show, spk_var_store);
542067fd92SSamuel Thibault static struct kobj_attribute rate_attribute =
552067fd92SSamuel Thibault __ATTR(rate, 0644, spk_var_show, spk_var_store);
562067fd92SSamuel Thibault static struct kobj_attribute tone_attribute =
572067fd92SSamuel Thibault __ATTR(tone, 0644, spk_var_show, spk_var_store);
582067fd92SSamuel Thibault static struct kobj_attribute vol_attribute =
592067fd92SSamuel Thibault __ATTR(vol, 0644, spk_var_show, spk_var_store);
602067fd92SSamuel Thibault
612067fd92SSamuel Thibault static struct kobj_attribute delay_time_attribute =
622067fd92SSamuel Thibault __ATTR(delay_time, 0644, spk_var_show, spk_var_store);
632067fd92SSamuel Thibault static struct kobj_attribute direct_attribute =
642067fd92SSamuel Thibault __ATTR(direct, 0644, spk_var_show, spk_var_store);
652067fd92SSamuel Thibault static struct kobj_attribute full_time_attribute =
662067fd92SSamuel Thibault __ATTR(full_time, 0644, spk_var_show, spk_var_store);
672067fd92SSamuel Thibault static struct kobj_attribute jiffy_delta_attribute =
682067fd92SSamuel Thibault __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
692067fd92SSamuel Thibault static struct kobj_attribute trigger_time_attribute =
702067fd92SSamuel Thibault __ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
712067fd92SSamuel Thibault
722067fd92SSamuel Thibault /*
732067fd92SSamuel Thibault * Create a group of attributes so that we can create and destroy them all
742067fd92SSamuel Thibault * at once.
752067fd92SSamuel Thibault */
762067fd92SSamuel Thibault static struct attribute *synth_attrs[] = {
772067fd92SSamuel Thibault &caps_start_attribute.attr,
782067fd92SSamuel Thibault &caps_stop_attribute.attr,
792067fd92SSamuel Thibault &pitch_attribute.attr,
802067fd92SSamuel Thibault &punct_attribute.attr,
812067fd92SSamuel Thibault &rate_attribute.attr,
822067fd92SSamuel Thibault &tone_attribute.attr,
832067fd92SSamuel Thibault &vol_attribute.attr,
842067fd92SSamuel Thibault &delay_time_attribute.attr,
852067fd92SSamuel Thibault &direct_attribute.attr,
862067fd92SSamuel Thibault &full_time_attribute.attr,
872067fd92SSamuel Thibault &jiffy_delta_attribute.attr,
882067fd92SSamuel Thibault &trigger_time_attribute.attr,
892067fd92SSamuel Thibault NULL, /* need to NULL terminate the list of attributes */
902067fd92SSamuel Thibault };
912067fd92SSamuel Thibault
922067fd92SSamuel Thibault static struct spk_synth synth_audptr = {
932067fd92SSamuel Thibault .name = "audptr",
942067fd92SSamuel Thibault .version = DRV_VERSION,
952067fd92SSamuel Thibault .long_name = "Audapter",
962067fd92SSamuel Thibault .init = "\x05[D1]\x05[Ol]",
972067fd92SSamuel Thibault .procspeech = PROCSPEECH,
982067fd92SSamuel Thibault .clear = SYNTH_CLEAR,
992067fd92SSamuel Thibault .delay = 400,
1002067fd92SSamuel Thibault .trigger = 50,
1012067fd92SSamuel Thibault .jiffies = 30,
1022067fd92SSamuel Thibault .full = 18000,
1032067fd92SSamuel Thibault .dev_name = SYNTH_DEFAULT_DEV,
1042067fd92SSamuel Thibault .startup = SYNTH_START,
1052067fd92SSamuel Thibault .checkval = SYNTH_CHECK,
1062067fd92SSamuel Thibault .vars = vars,
1072067fd92SSamuel Thibault .io_ops = &spk_ttyio_ops,
1082067fd92SSamuel Thibault .probe = synth_probe,
1092067fd92SSamuel Thibault .release = spk_ttyio_release,
1102067fd92SSamuel Thibault .synth_immediate = spk_ttyio_synth_immediate,
1112067fd92SSamuel Thibault .catch_up = spk_do_catch_up,
1122067fd92SSamuel Thibault .flush = synth_flush,
1132067fd92SSamuel Thibault .is_alive = spk_synth_is_alive_restart,
1142067fd92SSamuel Thibault .synth_adjust = NULL,
1152067fd92SSamuel Thibault .read_buff_add = NULL,
1162067fd92SSamuel Thibault .get_index = NULL,
1172067fd92SSamuel Thibault .indexing = {
1182067fd92SSamuel Thibault .command = NULL,
1192067fd92SSamuel Thibault .lowindex = 0,
1202067fd92SSamuel Thibault .highindex = 0,
1212067fd92SSamuel Thibault .currindex = 0,
1222067fd92SSamuel Thibault },
1232067fd92SSamuel Thibault .attributes = {
1242067fd92SSamuel Thibault .attrs = synth_attrs,
1252067fd92SSamuel Thibault .name = "audptr",
1262067fd92SSamuel Thibault },
1272067fd92SSamuel Thibault };
1282067fd92SSamuel Thibault
synth_flush(struct spk_synth * synth)1292067fd92SSamuel Thibault static void synth_flush(struct spk_synth *synth)
1302067fd92SSamuel Thibault {
1311941ab1dSSamuel Thibault synth->io_ops->flush_buffer(synth);
1321941ab1dSSamuel Thibault synth->io_ops->send_xchar(synth, SYNTH_CLEAR);
1332067fd92SSamuel Thibault synth->io_ops->synth_out(synth, PROCSPEECH);
1342067fd92SSamuel Thibault }
1352067fd92SSamuel Thibault
synth_version(struct spk_synth * synth)1362067fd92SSamuel Thibault static void synth_version(struct spk_synth *synth)
1372067fd92SSamuel Thibault {
138353b940cSSamuel Thibault unsigned i;
139353b940cSSamuel Thibault char synth_id[33];
1402067fd92SSamuel Thibault
1412067fd92SSamuel Thibault synth->synth_immediate(synth, "\x05[Q]");
142353b940cSSamuel Thibault synth_id[0] = synth->io_ops->synth_in(synth);
143353b940cSSamuel Thibault if (synth_id[0] != 'A')
144353b940cSSamuel Thibault return;
145353b940cSSamuel Thibault
146353b940cSSamuel Thibault for (i = 1; i < sizeof(synth_id) - 1; i++) {
1472067fd92SSamuel Thibault /* read version string from synth */
148353b940cSSamuel Thibault synth_id[i] = synth->io_ops->synth_in(synth);
149353b940cSSamuel Thibault if (synth_id[i] == '\n')
150353b940cSSamuel Thibault break;
1512067fd92SSamuel Thibault }
152353b940cSSamuel Thibault synth_id[i] = '\0';
1532067fd92SSamuel Thibault pr_info("%s version: %s", synth->long_name, synth_id);
1542067fd92SSamuel Thibault }
1552067fd92SSamuel Thibault
synth_probe(struct spk_synth * synth)1562067fd92SSamuel Thibault static int synth_probe(struct spk_synth *synth)
1572067fd92SSamuel Thibault {
1582067fd92SSamuel Thibault int failed;
1592067fd92SSamuel Thibault
1602067fd92SSamuel Thibault failed = spk_ttyio_synth_probe(synth);
1612067fd92SSamuel Thibault if (failed == 0)
1622067fd92SSamuel Thibault synth_version(synth);
1632067fd92SSamuel Thibault synth->alive = !failed;
1642067fd92SSamuel Thibault return 0;
1652067fd92SSamuel Thibault }
1662067fd92SSamuel Thibault
1672067fd92SSamuel Thibault module_param_named(ser, synth_audptr.ser, int, 0444);
1682067fd92SSamuel Thibault module_param_named(dev, synth_audptr.dev_name, charp, 0444);
1692067fd92SSamuel Thibault module_param_named(start, synth_audptr.startup, short, 0444);
170*d5dab7ffSOsama Muhammad module_param_named(rate, vars[RATE_ID].u.n.default_val, int, 0444);
171*d5dab7ffSOsama Muhammad module_param_named(pitch, vars[PITCH_ID].u.n.default_val, int, 0444);
172*d5dab7ffSOsama Muhammad module_param_named(vol, vars[VOL_ID].u.n.default_val, int, 0444);
173*d5dab7ffSOsama Muhammad module_param_named(tone, vars[TONE_ID].u.n.default_val, int, 0444);
174*d5dab7ffSOsama Muhammad module_param_named(punct, vars[PUNCT_ID].u.n.default_val, int, 0444);
175*d5dab7ffSOsama Muhammad module_param_named(direct, vars[DIRECT_ID].u.n.default_val, int, 0444);
176*d5dab7ffSOsama Muhammad
177*d5dab7ffSOsama Muhammad
1782067fd92SSamuel Thibault
1792067fd92SSamuel Thibault MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
1802067fd92SSamuel Thibault MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer.");
1812067fd92SSamuel Thibault MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
182*d5dab7ffSOsama Muhammad MODULE_PARM_DESC(rate, "Set the rate variable on load.");
183*d5dab7ffSOsama Muhammad MODULE_PARM_DESC(pitch, "Set the pitch variable on load.");
184*d5dab7ffSOsama Muhammad MODULE_PARM_DESC(vol, "Set the vol variable on load.");
185*d5dab7ffSOsama Muhammad MODULE_PARM_DESC(tone, "Set the tone variable on load.");
186*d5dab7ffSOsama Muhammad MODULE_PARM_DESC(punct, "Set the punct variable on load.");
187*d5dab7ffSOsama Muhammad MODULE_PARM_DESC(direct, "Set the direct variable on load.");
188*d5dab7ffSOsama Muhammad
1892067fd92SSamuel Thibault
1902067fd92SSamuel Thibault module_spk_synth(synth_audptr);
1912067fd92SSamuel Thibault
1922067fd92SSamuel Thibault MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
1932067fd92SSamuel Thibault MODULE_AUTHOR("David Borowski");
1942067fd92SSamuel Thibault MODULE_DESCRIPTION("Speakup support for Audapter synthesizer");
1952067fd92SSamuel Thibault MODULE_LICENSE("GPL");
1962067fd92SSamuel Thibault MODULE_VERSION(DRV_VERSION);
1972067fd92SSamuel Thibault
198