[mirror_ubuntu-jammy-kernel.git] / drivers / accessibility / speakup / speakup_decext.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * originally written by: Kirk Reiser <kirk@braille.uwo.ca>
 * this version considerably modified by David Borowski, david575@rogers.com
 *
 * Copyright (C) 1998-99  Kirk Reiser.
 * Copyright (C) 2003 David Borowski.
 *
 * specificly written as a driver for the speakup screenreview
 * s not a general device driver.
 */
#include <linux/jiffies.h>
#include <linux/sched.h>
#include <linux/timer.h>
#include <linux/kthread.h>

#include "spk_priv.h"
#include "speakup.h"

#define DRV_VERSION "2.14"
#define SYNTH_CLEAR 0x03
#define PROCSPEECH 0x0b

static volatile unsigned char last_char;

static void read_buff_add(u_char ch)
{
	last_char = ch;
}

static inline bool synth_full(void)
{
	return last_char == 0x13;
}

static void do_catch_up(struct spk_synth *synth);
static void synth_flush(struct spk_synth *synth);

static int in_escape;

static struct var_t vars[] = {
	{ CAPS_START, .u.s = {"[:dv ap 222]" } },
	{ CAPS_STOP, .u.s = {"[:dv ap 100]" } },
	{ RATE, .u.n = {"[:ra %d]", 7, 0, 9, 150, 25, NULL } },
	{ PITCH, .u.n = {"[:dv ap %d]", 100, 0, 100, 0, 0, NULL } },
	{ INFLECTION, .u.n = {"[:dv pr %d] ", 100, 0, 10000, 0, 0, NULL } },
	{ VOL, .u.n = {"[:dv gv %d]", 13, 0, 16, 0, 5, NULL } },
	{ PUNCT, .u.n = {"[:pu %c]", 0, 0, 2, 0, 0, "nsa" } },
	{ VOICE, .u.n = {"[:n%c]", 0, 0, 9, 0, 0, "phfdburwkv" } },
	{ DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
	V_LAST_VAR
};

/*
 * These attributes will appear in /sys/accessibility/speakup/decext.
 */
static struct kobj_attribute caps_start_attribute =
	__ATTR(caps_start, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute caps_stop_attribute =
	__ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute pitch_attribute =
	__ATTR(pitch, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute inflection_attribute =
	__ATTR(inflection, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute punct_attribute =
	__ATTR(punct, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute rate_attribute =
	__ATTR(rate, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute voice_attribute =
	__ATTR(voice, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute vol_attribute =
	__ATTR(vol, 0644, spk_var_show, spk_var_store);

static struct kobj_attribute delay_time_attribute =
	__ATTR(delay_time, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute direct_attribute =
	__ATTR(direct, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute full_time_attribute =
	__ATTR(full_time, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute jiffy_delta_attribute =
	__ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute trigger_time_attribute =
	__ATTR(trigger_time, 0644, spk_var_show, spk_var_store);

/*
 * Create a group of attributes so that we can create and destroy them all
 * at once.
 */
static struct attribute *synth_attrs[] = {
	&caps_start_attribute.attr,
	&caps_stop_attribute.attr,
	&pitch_attribute.attr,
	&inflection_attribute.attr,
	&punct_attribute.attr,
	&rate_attribute.attr,
	&voice_attribute.attr,
	&vol_attribute.attr,
	&delay_time_attribute.attr,
	&direct_attribute.attr,
	&full_time_attribute.attr,
	&jiffy_delta_attribute.attr,
	&trigger_time_attribute.attr,
	NULL,	/* need to NULL terminate the list of attributes */
};

static struct spk_synth synth_decext = {
	.name = "decext",
	.version = DRV_VERSION,
	.long_name = "Dectalk External",
	.init = "[:pe -380]",
	.procspeech = PROCSPEECH,
	.clear = SYNTH_CLEAR,
	.delay = 500,
	.trigger = 50,
	.jiffies = 50,
	.full = 40000,
	.flags = SF_DEC,
	.dev_name = SYNTH_DEFAULT_DEV,
	.startup = SYNTH_START,
	.checkval = SYNTH_CHECK,
	.vars = vars,
	.io_ops = &spk_ttyio_ops,
	.probe = spk_ttyio_synth_probe,
	.release = spk_ttyio_release,
	.synth_immediate = spk_ttyio_synth_immediate,
	.catch_up = do_catch_up,
	.flush = synth_flush,
	.is_alive = spk_synth_is_alive_restart,
	.synth_adjust = NULL,
	.read_buff_add = read_buff_add,
	.get_index = NULL,
	.indexing = {
		.command = NULL,
		.lowindex = 0,
		.highindex = 0,
		.currindex = 0,
	},
	.attributes = {
		.attrs = synth_attrs,
		.name = "decext",
	},
};

static void do_catch_up(struct spk_synth *synth)
{
	u_char ch;
	static u_char last = '\0';
	unsigned long flags;
	unsigned long jiff_max;
	struct var_t *jiffy_delta;
	struct var_t *delay_time;
	int jiffy_delta_val = 0;
	int delay_time_val = 0;

	jiffy_delta = spk_get_var(JIFFY);
	delay_time = spk_get_var(DELAY);

	spin_lock_irqsave(&speakup_info.spinlock, flags);
	jiffy_delta_val = jiffy_delta->u.n.value;
	spin_unlock_irqrestore(&speakup_info.spinlock, flags);
	jiff_max = jiffies + jiffy_delta_val;

	while (!kthread_should_stop()) {
		spin_lock_irqsave(&speakup_info.spinlock, flags);
		if (speakup_info.flushing) {
			speakup_info.flushing = 0;
			spin_unlock_irqrestore(&speakup_info.spinlock, flags);
			synth->flush(synth);
			continue;
		}
		synth_buffer_skip_nonlatin1();
		if (synth_buffer_empty()) {
			spin_unlock_irqrestore(&speakup_info.spinlock, flags);
			break;
		}
		ch = synth_buffer_peek();
		set_current_state(TASK_INTERRUPTIBLE);
		delay_time_val = delay_time->u.n.value;
		spin_unlock_irqrestore(&speakup_info.spinlock, flags);
		if (ch == '\n')
			ch = 0x0D;
		if (synth_full() || !synth->io_ops->synth_out(synth, ch)) {
			schedule_timeout(msecs_to_jiffies(delay_time_val));
			continue;
		}
		set_current_state(TASK_RUNNING);
		spin_lock_irqsave(&speakup_info.spinlock, flags);
		synth_buffer_getc();
		spin_unlock_irqrestore(&speakup_info.spinlock, flags);
		if (ch == '[') {
			in_escape = 1;
		} else if (ch == ']') {
			in_escape = 0;
		} else if (ch <= SPACE) {
			if (!in_escape && strchr(",.!?;:", last))
				synth->io_ops->synth_out(synth, PROCSPEECH);
			if (time_after_eq(jiffies, jiff_max)) {
				if (!in_escape)
					synth->io_ops->synth_out(synth,
								 PROCSPEECH);
				spin_lock_irqsave(&speakup_info.spinlock,
						  flags);
				jiffy_delta_val = jiffy_delta->u.n.value;
				delay_time_val = delay_time->u.n.value;
				spin_unlock_irqrestore(&speakup_info.spinlock,
						       flags);
				schedule_timeout(msecs_to_jiffies
						 (delay_time_val));
				jiff_max = jiffies + jiffy_delta_val;
			}
		}
		last = ch;
	}
	if (!in_escape)
		synth->io_ops->synth_out(synth, PROCSPEECH);
}

static void synth_flush(struct spk_synth *synth)
{
	in_escape = 0;
	synth->io_ops->flush_buffer(synth);
	synth->synth_immediate(synth, "\033P;10z\033\\");
}

module_param_named(ser, synth_decext.ser, int, 0444);
module_param_named(dev, synth_decext.dev_name, charp, 0444);
module_param_named(start, synth_decext.startup, short, 0444);

MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer.");
MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");

module_spk_synth(synth_decext);

MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
MODULE_AUTHOR("David Borowski");
MODULE_DESCRIPTION("Speakup support for DECtalk External synthesizers");
MODULE_LICENSE("GPL");
MODULE_VERSION(DRV_VERSION);
Commit	Line	Data
64969228	1	// SPDX-License-Identifier: GPL-2.0+
c6e3fd22 WH	2	/*
c6e3fd22 WH	3	* originally written by: Kirk Reiser <kirk@braille.uwo.ca>
4d0bdcb1	4	* this version considerably modified by David Borowski, david575@rogers.com
c6e3fd22 WH	5	*
	6	* Copyright (C) 1998-99 Kirk Reiser.
	7	* Copyright (C) 2003 David Borowski.
	8	*
c6e3fd22 WH	9	* specificly written as a driver for the speakup screenreview
	10	* s not a general device driver.
	11	*/
	12	#include <linux/jiffies.h>
	13	#include <linux/sched.h>
	14	#include <linux/timer.h>
	15	#include <linux/kthread.h>
	16
	17	#include "spk_priv.h"
c6e3fd22 WH	18	#include "speakup.h"
	19
	20	#define DRV_VERSION "2.14"
	21	#define SYNTH_CLEAR 0x03
	22	#define PROCSPEECH 0x0b
470790ee	23
ca693dcd	24	static volatile unsigned char last_char;
3d4f7eaf	25
ca693dcd	26	static void read_buff_add(u_char ch)
3d4f7eaf	27	{
ca693dcd	28	last_char = ch;
3d4f7eaf CB	29	}
	30
	31	static inline bool synth_full(void)
	32	{
ca693dcd	33	return last_char == 0x13;
3d4f7eaf	34	}
c6e3fd22 WH	35
	36	static void do_catch_up(struct spk_synth *synth);
	37	static void synth_flush(struct spk_synth *synth);
	38
	39	static int in_escape;
	40
	41	static struct var_t vars[] = {
3d4f7eaf CB	42	{ CAPS_START, .u.s = {"[:dv ap 222]" } },
	43	{ CAPS_STOP, .u.s = {"[:dv ap 100]" } },
	44	{ RATE, .u.n = {"[:ra %d]", 7, 0, 9, 150, 25, NULL } },
	45	{ PITCH, .u.n = {"[:dv ap %d]", 100, 0, 100, 0, 0, NULL } },
d97a9d7a	46	{ INFLECTION, .u.n = {"[:dv pr %d] ", 100, 0, 10000, 0, 0, NULL } },
3d4f7eaf CB	47	{ VOL, .u.n = {"[:dv gv %d]", 13, 0, 16, 0, 5, NULL } },
	48	{ PUNCT, .u.n = {"[:pu %c]", 0, 0, 2, 0, 0, "nsa" } },
	49	{ VOICE, .u.n = {"[:n%c]", 0, 0, 9, 0, 0, "phfdburwkv" } },
	50	{ DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
c6e3fd22 WH	51	V_LAST_VAR
	52	};
	53
	54	/*
	55	* These attributes will appear in /sys/accessibility/speakup/decext.
	56	*/
	57	static struct kobj_attribute caps_start_attribute =
73c3700e	58	__ATTR(caps_start, 0644, spk_var_show, spk_var_store);
c6e3fd22	59	static struct kobj_attribute caps_stop_attribute =
73c3700e	60	__ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
c6e3fd22	61	static struct kobj_attribute pitch_attribute =
73c3700e	62	__ATTR(pitch, 0644, spk_var_show, spk_var_store);
d97a9d7a ST	63	static struct kobj_attribute inflection_attribute =
d97a9d7a ST	64	__ATTR(inflection, 0644, spk_var_show, spk_var_store);
c6e3fd22	65	static struct kobj_attribute punct_attribute =
73c3700e	66	__ATTR(punct, 0644, spk_var_show, spk_var_store);
c6e3fd22	67	static struct kobj_attribute rate_attribute =
73c3700e	68	__ATTR(rate, 0644, spk_var_show, spk_var_store);
c6e3fd22	69	static struct kobj_attribute voice_attribute =
73c3700e	70	__ATTR(voice, 0644, spk_var_show, spk_var_store);
c6e3fd22	71	static struct kobj_attribute vol_attribute =
73c3700e	72	__ATTR(vol, 0644, spk_var_show, spk_var_store);
c6e3fd22 WH	73
c6e3fd22 WH	74	static struct kobj_attribute delay_time_attribute =
73c3700e	75	__ATTR(delay_time, 0644, spk_var_show, spk_var_store);
c6e3fd22	76	static struct kobj_attribute direct_attribute =
73c3700e	77	__ATTR(direct, 0644, spk_var_show, spk_var_store);
c6e3fd22	78	static struct kobj_attribute full_time_attribute =
73c3700e	79	__ATTR(full_time, 0644, spk_var_show, spk_var_store);
c6e3fd22	80	static struct kobj_attribute jiffy_delta_attribute =
73c3700e	81	__ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
c6e3fd22	82	static struct kobj_attribute trigger_time_attribute =
73c3700e	83	__ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
c6e3fd22 WH	84
	85	/*
	86	* Create a group of attributes so that we can create and destroy them all
	87	* at once.
	88	*/
	89	static struct attribute *synth_attrs[] = {
	90	&caps_start_attribute.attr,
	91	&caps_stop_attribute.attr,
	92	&pitch_attribute.attr,
d97a9d7a	93	&inflection_attribute.attr,
c6e3fd22 WH	94	&punct_attribute.attr,
	95	&rate_attribute.attr,
	96	&voice_attribute.attr,
	97	&vol_attribute.attr,
	98	&delay_time_attribute.attr,
	99	&direct_attribute.attr,
	100	&full_time_attribute.attr,
	101	&jiffy_delta_attribute.attr,
	102	&trigger_time_attribute.attr,
	103	NULL, /* need to NULL terminate the list of attributes */
	104	};
	105
	106	static struct spk_synth synth_decext = {
	107	.name = "decext",
	108	.version = DRV_VERSION,
	109	.long_name = "Dectalk External",
	110	.init = "[:pe -380]",
	111	.procspeech = PROCSPEECH,
	112	.clear = SYNTH_CLEAR,
	113	.delay = 500,
	114	.trigger = 50,
	115	.jiffies = 50,
	116	.full = 40000,
	117	.flags = SF_DEC,
8a21ff77	118	.dev_name = SYNTH_DEFAULT_DEV,
c6e3fd22 WH	119	.startup = SYNTH_START,
	120	.checkval = SYNTH_CHECK,
	121	.vars = vars,
470790ee OK	122	.io_ops = &spk_ttyio_ops,
	123	.probe = spk_ttyio_synth_probe,
	124	.release = spk_ttyio_release,
	125	.synth_immediate = spk_ttyio_synth_immediate,
c6e3fd22 WH	126	.catch_up = do_catch_up,
	127	.flush = synth_flush,
	128	.is_alive = spk_synth_is_alive_restart,
	129	.synth_adjust = NULL,
ca693dcd	130	.read_buff_add = read_buff_add,
c6e3fd22 WH	131	.get_index = NULL,
	132	.indexing = {
	133	.command = NULL,
	134	.lowindex = 0,
	135	.highindex = 0,
	136	.currindex = 0,
	137	},
	138	.attributes = {
	139	.attrs = synth_attrs,
	140	.name = "decext",
	141	},
	142	};
	143
	144	static void do_catch_up(struct spk_synth *synth)
	145	{
	146	u_char ch;
	147	static u_char last = '\0';
	148	unsigned long flags;
	149	unsigned long jiff_max;
	150	struct var_t *jiffy_delta;
	151	struct var_t *delay_time;
	152	int jiffy_delta_val = 0;
	153	int delay_time_val = 0;
	154
ca2beaf8 ST	155	jiffy_delta = spk_get_var(JIFFY);
ca2beaf8 ST	156	delay_time = spk_get_var(DELAY);
c6e3fd22	157
b4b93e32	158	spin_lock_irqsave(&speakup_info.spinlock, flags);
c6e3fd22	159	jiffy_delta_val = jiffy_delta->u.n.value;
b4b93e32	160	spin_unlock_irqrestore(&speakup_info.spinlock, flags);
c6e3fd22 WH	161	jiff_max = jiffies + jiffy_delta_val;
	162
	163	while (!kthread_should_stop()) {
b4b93e32	164	spin_lock_irqsave(&speakup_info.spinlock, flags);
c6e3fd22 WH	165	if (speakup_info.flushing) {
c6e3fd22 WH	166	speakup_info.flushing = 0;
b4b93e32	167	spin_unlock_irqrestore(&speakup_info.spinlock, flags);
c6e3fd22 WH	168	synth->flush(synth);
	169	continue;
	170	}
89fc2ae8	171	synth_buffer_skip_nonlatin1();
c6e3fd22	172	if (synth_buffer_empty()) {
b4b93e32	173	spin_unlock_irqrestore(&speakup_info.spinlock, flags);
c6e3fd22 WH	174	break;
	175	}
	176	ch = synth_buffer_peek();
	177	set_current_state(TASK_INTERRUPTIBLE);
	178	delay_time_val = delay_time->u.n.value;
b4b93e32	179	spin_unlock_irqrestore(&speakup_info.spinlock, flags);
c6e3fd22 WH	180	if (ch == '\n')
c6e3fd22 WH	181	ch = 0x0D;
1e441594	182	if (synth_full() \|\| !synth->io_ops->synth_out(synth, ch)) {
c6e3fd22 WH	183	schedule_timeout(msecs_to_jiffies(delay_time_val));
	184	continue;
	185	}
	186	set_current_state(TASK_RUNNING);
b4b93e32	187	spin_lock_irqsave(&speakup_info.spinlock, flags);
c6e3fd22	188	synth_buffer_getc();
b4b93e32	189	spin_unlock_irqrestore(&speakup_info.spinlock, flags);
0dcb2124	190	if (ch == '[') {
c6e3fd22	191	in_escape = 1;
0dcb2124	192	} else if (ch == ']') {
c6e3fd22	193	in_escape = 0;
0dcb2124	194	} else if (ch <= SPACE) {
c6e3fd22	195	if (!in_escape && strchr(",.!?;:", last))
1e441594	196	synth->io_ops->synth_out(synth, PROCSPEECH);
89021ecc	197	if (time_after_eq(jiffies, jiff_max)) {
3d4f7eaf	198	if (!in_escape)
e2d55017 BD	199	synth->io_ops->synth_out(synth,
e2d55017 BD	200	PROCSPEECH);
63b8ebe4	201	spin_lock_irqsave(&speakup_info.spinlock,
f239d3db	202	flags);
c6e3fd22 WH	203	jiffy_delta_val = jiffy_delta->u.n.value;
c6e3fd22 WH	204	delay_time_val = delay_time->u.n.value;
63b8ebe4	205	spin_unlock_irqrestore(&speakup_info.spinlock,
f239d3db	206	flags);
3d4f7eaf CB	207	schedule_timeout(msecs_to_jiffies
3d4f7eaf CB	208	(delay_time_val));
c6e3fd22 WH	209	jiff_max = jiffies + jiffy_delta_val;
	210	}
	211	}
	212	last = ch;
	213	}
	214	if (!in_escape)
1e441594	215	synth->io_ops->synth_out(synth, PROCSPEECH);
c6e3fd22 WH	216	}
	217
	218	static void synth_flush(struct spk_synth *synth)
	219	{
	220	in_escape = 0;
1941ab1d	221	synth->io_ops->flush_buffer(synth);
98c1fda7	222	synth->synth_immediate(synth, "\033P;10z\033\\");
c6e3fd22 WH	223	}
c6e3fd22 WH	224
73c3700e	225	module_param_named(ser, synth_decext.ser, int, 0444);
b5a603de	226	module_param_named(dev, synth_decext.dev_name, charp, 0444);
73c3700e	227	module_param_named(start, synth_decext.startup, short, 0444);
c6e3fd22 WH	228
c6e3fd22 WH	229	MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
8a21ff77	230	MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer.");
c6e3fd22 WH	231	MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
c6e3fd22 WH	232
ae89facc	233	module_spk_synth(synth_decext);
c6e3fd22	234
c6e3fd22 WH	235	MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
	236	MODULE_AUTHOR("David Borowski");
	237	MODULE_DESCRIPTION("Speakup support for DECtalk External synthesizers");
	238	MODULE_LICENSE("GPL");
	239	MODULE_VERSION(DRV_VERSION);
	240