xref: /linux/drivers/accessibility/speakup/speakup_audptr.c (revision 7ae9fb1b7ecbb5d85d07857943f677fd1a559b18)
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * originally written by: Kirk Reiser <kirk@braille.uwo.ca>
4  * this version considerably modified by David Borowski, david575@rogers.com
5  *
6  * Copyright (C) 1998-99  Kirk Reiser.
7  * Copyright (C) 2003 David Borowski.
8  *
9  * specifically written as a driver for the speakup screenreview
10  * s not a general device driver.
11  */
12 #include "spk_priv.h"
13 #include "speakup.h"
14 
15 #define DRV_VERSION "2.11"
16 #define SYNTH_CLEAR 0x18 /* flush synth buffer */
17 #define PROCSPEECH '\r' /* start synth processing speech char */
18 
19 static int synth_probe(struct spk_synth *synth);
20 static void synth_flush(struct spk_synth *synth);
21 
22 
23 enum default_vars_id {
24 	CAPS_START_ID = 0, CAPS_STOP_ID,
25 	RATE_ID, PITCH_ID,
26 	VOL_ID, TONE_ID, PUNCT_ID,
27 	DIRECT_ID, V_LAST_VAR_ID,
28 	NB_ID
29 };
30 
31 static struct var_t vars[NB_ID] = {
32 	[CAPS_START_ID] = { CAPS_START, .u.s = {"\x05[f99]" } },
33 	[CAPS_STOP_ID] = { CAPS_STOP, .u.s = {"\x05[f80]" } },
34 	[RATE_ID] = { RATE, .u.n = {"\x05[r%d]", 10, 0, 20, 100, -10, NULL } },
35 	[PITCH_ID] = { PITCH, .u.n = {"\x05[f%d]", 80, 39, 4500, 0, 0, NULL } },
36 	[VOL_ID] = { VOL, .u.n = {"\x05[g%d]", 21, 0, 40, 0, 0, NULL } },
37 	[TONE_ID] = { TONE, .u.n = {"\x05[s%d]", 9, 0, 63, 0, 0, NULL } },
38 	[PUNCT_ID] = { PUNCT, .u.n = {"\x05[A%c]", 0, 0, 3, 0, 0, "nmsa" } },
39 	[DIRECT_ID] = { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
40 	V_LAST_VAR
41 };
42 
43 /*
44  * These attributes will appear in /sys/accessibility/speakup/audptr.
45  */
46 static struct kobj_attribute caps_start_attribute =
47 	__ATTR(caps_start, 0644, spk_var_show, spk_var_store);
48 static struct kobj_attribute caps_stop_attribute =
49 	__ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
50 static struct kobj_attribute pitch_attribute =
51 	__ATTR(pitch, 0644, spk_var_show, spk_var_store);
52 static struct kobj_attribute punct_attribute =
53 	__ATTR(punct, 0644, spk_var_show, spk_var_store);
54 static struct kobj_attribute rate_attribute =
55 	__ATTR(rate, 0644, spk_var_show, spk_var_store);
56 static struct kobj_attribute tone_attribute =
57 	__ATTR(tone, 0644, spk_var_show, spk_var_store);
58 static struct kobj_attribute vol_attribute =
59 	__ATTR(vol, 0644, spk_var_show, spk_var_store);
60 
61 static struct kobj_attribute delay_time_attribute =
62 	__ATTR(delay_time, 0644, spk_var_show, spk_var_store);
63 static struct kobj_attribute direct_attribute =
64 	__ATTR(direct, 0644, spk_var_show, spk_var_store);
65 static struct kobj_attribute full_time_attribute =
66 	__ATTR(full_time, 0644, spk_var_show, spk_var_store);
67 static struct kobj_attribute jiffy_delta_attribute =
68 	__ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
69 static struct kobj_attribute trigger_time_attribute =
70 	__ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
71 
72 /*
73  * Create a group of attributes so that we can create and destroy them all
74  * at once.
75  */
76 static struct attribute *synth_attrs[] = {
77 	&caps_start_attribute.attr,
78 	&caps_stop_attribute.attr,
79 	&pitch_attribute.attr,
80 	&punct_attribute.attr,
81 	&rate_attribute.attr,
82 	&tone_attribute.attr,
83 	&vol_attribute.attr,
84 	&delay_time_attribute.attr,
85 	&direct_attribute.attr,
86 	&full_time_attribute.attr,
87 	&jiffy_delta_attribute.attr,
88 	&trigger_time_attribute.attr,
89 	NULL,	/* need to NULL terminate the list of attributes */
90 };
91 
92 static struct spk_synth synth_audptr = {
93 	.name = "audptr",
94 	.version = DRV_VERSION,
95 	.long_name = "Audapter",
96 	.init = "\x05[D1]\x05[Ol]",
97 	.procspeech = PROCSPEECH,
98 	.clear = SYNTH_CLEAR,
99 	.delay = 400,
100 	.trigger = 50,
101 	.jiffies = 30,
102 	.full = 18000,
103 	.dev_name = SYNTH_DEFAULT_DEV,
104 	.startup = SYNTH_START,
105 	.checkval = SYNTH_CHECK,
106 	.vars = vars,
107 	.io_ops = &spk_ttyio_ops,
108 	.probe = synth_probe,
109 	.release = spk_ttyio_release,
110 	.synth_immediate = spk_ttyio_synth_immediate,
111 	.catch_up = spk_do_catch_up,
112 	.flush = synth_flush,
113 	.is_alive = spk_synth_is_alive_restart,
114 	.synth_adjust = NULL,
115 	.read_buff_add = NULL,
116 	.get_index = NULL,
117 	.indexing = {
118 		.command = NULL,
119 		.lowindex = 0,
120 		.highindex = 0,
121 		.currindex = 0,
122 	},
123 	.attributes = {
124 		.attrs = synth_attrs,
125 		.name = "audptr",
126 	},
127 };
128 
synth_flush(struct spk_synth * synth)129 static void synth_flush(struct spk_synth *synth)
130 {
131 	synth->io_ops->flush_buffer(synth);
132 	synth->io_ops->send_xchar(synth, SYNTH_CLEAR);
133 	synth->io_ops->synth_out(synth, PROCSPEECH);
134 }
135 
synth_version(struct spk_synth * synth)136 static void synth_version(struct spk_synth *synth)
137 {
138 	unsigned i;
139 	char synth_id[33];
140 
141 	synth->synth_immediate(synth, "\x05[Q]");
142 	synth_id[0] = synth->io_ops->synth_in(synth);
143 	if (synth_id[0] != 'A')
144 		return;
145 
146 	for (i = 1; i < sizeof(synth_id) - 1; i++) {
147 		/* read version string from synth */
148 		synth_id[i] = synth->io_ops->synth_in(synth);
149 		if (synth_id[i] == '\n')
150 			break;
151 	}
152 	synth_id[i] = '\0';
153 	pr_info("%s version: %s", synth->long_name, synth_id);
154 }
155 
synth_probe(struct spk_synth * synth)156 static int synth_probe(struct spk_synth *synth)
157 {
158 	int failed;
159 
160 	failed = spk_ttyio_synth_probe(synth);
161 	if (failed == 0)
162 		synth_version(synth);
163 	synth->alive = !failed;
164 	return 0;
165 }
166 
167 module_param_named(ser, synth_audptr.ser, int, 0444);
168 module_param_named(dev, synth_audptr.dev_name, charp, 0444);
169 module_param_named(start, synth_audptr.startup, short, 0444);
170 module_param_named(rate, vars[RATE_ID].u.n.default_val, int, 0444);
171 module_param_named(pitch, vars[PITCH_ID].u.n.default_val, int, 0444);
172 module_param_named(vol, vars[VOL_ID].u.n.default_val, int, 0444);
173 module_param_named(tone, vars[TONE_ID].u.n.default_val, int, 0444);
174 module_param_named(punct, vars[PUNCT_ID].u.n.default_val, int, 0444);
175 module_param_named(direct, vars[DIRECT_ID].u.n.default_val, int, 0444);
176 
177 
178 
179 MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
180 MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer.");
181 MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
182 MODULE_PARM_DESC(rate, "Set the rate variable on load.");
183 MODULE_PARM_DESC(pitch, "Set the pitch variable on load.");
184 MODULE_PARM_DESC(vol, "Set the vol variable on load.");
185 MODULE_PARM_DESC(tone, "Set the tone variable on load.");
186 MODULE_PARM_DESC(punct, "Set the punct variable on load.");
187 MODULE_PARM_DESC(direct, "Set the direct variable on load.");
188 
189 
190 module_spk_synth(synth_audptr);
191 
192 MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
193 MODULE_AUTHOR("David Borowski");
194 MODULE_DESCRIPTION("Speakup support for Audapter synthesizer");
195 MODULE_LICENSE("GPL");
196 MODULE_VERSION(DRV_VERSION);
197 
198