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

// SPDX-License-Identifier: GPL-2.0+
/*
 * This is the DECtalk PC speakup driver
 *
 * Some constants from DEC's DOS driver:
 *      Copyright (c) by Digital Equipment Corp.
 *
 * 386BSD DECtalk PC driver:
 *      Copyright (c) 1996 Brian Buhrow <buhrow@lothlorien.nfbcal.org>
 *
 * Linux DECtalk PC driver:
 *      Copyright (c) 1997 Nicolas Pitre <nico@cam.org>
 *
 * speakup DECtalk PC Internal driver:
 *      Copyright (c) 2003 David Borowski <david575@golden.net>
 *
 * All rights reserved.
 */
#include <linux/jiffies.h>
#include <linux/sched.h>
#include <linux/timer.h>
#include <linux/kthread.h>

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

#define	MODULE_init		0x0dec	/* module in boot code */
#define	MODULE_self_test	0x8800	/* module in self-test */
#define	MODULE_reset		0xffff	/* reinit the whole module */

#define	MODE_mask		0xf000	/* mode bits in high nibble */
#define	MODE_null		0x0000
#define	MODE_test		0x2000	/* in testing mode */
#define	MODE_status		0x8000
#define	STAT_int		0x0001	/* running in interrupt mode */
#define	STAT_tr_char		0x0002	/* character data to transmit */
#define	STAT_rr_char		0x0004	/* ready to receive char data */
#define	STAT_cmd_ready		0x0008	/* ready to accept commands */
#define	STAT_dma_ready		0x0010	/* dma command ready */
#define	STAT_digitized		0x0020	/* spc in digitized mode */
#define	STAT_new_index		0x0040	/* new last index ready */
#define	STAT_new_status		0x0080	/* new status posted */
#define	STAT_dma_state		0x0100	/* dma state toggle */
#define	STAT_index_valid	0x0200	/* indexs are valid */
#define	STAT_flushing		0x0400	/* flush in progress */
#define	STAT_self_test		0x0800	/* module in self test */
#define	MODE_ready		0xc000	/* module ready for next phase */
#define	READY_boot		0x0000
#define	READY_kernel		0x0001
#define	MODE_error		0xf000

#define	CMD_mask		0xf000	/* mask for command nibble */
#define	CMD_null		0x0000	/* post status */
#define	CMD_control		0x1000	/* hard control command */
#define	CTRL_mask		0x0F00	/* mask off control nibble */
#define	CTRL_data		0x00FF	/* mask to get data byte */
#define	CTRL_null		0x0000	/* null control */
#define	CTRL_vol_up		0x0100	/* increase volume */
#define	CTRL_vol_down		0x0200	/* decrease volume */
#define	CTRL_vol_set		0x0300	/* set volume */
#define	CTRL_pause		0x0400	/* pause spc */
#define	CTRL_resume		0x0500	/* resume spc clock */
#define	CTRL_resume_spc		0x0001	/* resume spc soft pause */
#define	CTRL_flush		0x0600	/* flush all buffers */
#define	CTRL_int_enable		0x0700	/* enable status change ints */
#define	CTRL_buff_free		0x0800	/* buffer remain count */
#define	CTRL_buff_used		0x0900	/* buffer in use */
#define	CTRL_speech		0x0a00	/* immediate speech change */
#define	CTRL_SP_voice		0x0001	/* voice change */
#define	CTRL_SP_rate		0x0002	/* rate change */
#define	CTRL_SP_comma		0x0003	/* comma pause change */
#define	CTRL_SP_period		0x0004	/* period pause change */
#define	CTRL_SP_rate_delta	0x0005	/* delta rate change */
#define	CTRL_SP_get_param	0x0006	/* return the desired parameter */
#define	CTRL_last_index		0x0b00	/* get last index spoken */
#define	CTRL_io_priority	0x0c00	/* change i/o priority */
#define	CTRL_free_mem		0x0d00	/* get free paragraphs on module */
#define	CTRL_get_lang		0x0e00	/* return bitmask of loaded languages */
#define	CMD_test		0x2000	/* self-test request */
#define	TEST_mask		0x0F00	/* isolate test field */
#define	TEST_null		0x0000	/* no test requested */
#define	TEST_isa_int		0x0100	/* assert isa irq */
#define	TEST_echo		0x0200	/* make data in == data out */
#define	TEST_seg		0x0300	/* set peek/poke segment */
#define	TEST_off		0x0400	/* set peek/poke offset */
#define	TEST_peek		0x0500	/* data out == *peek */
#define	TEST_poke		0x0600	/* *peek == data in */
#define	TEST_sub_code		0x00FF	/* user defined test sub codes */
#define	CMD_id			0x3000	/* return software id */
#define	ID_null			0x0000	/* null id */
#define	ID_kernel		0x0100	/* kernel code executing */
#define	ID_boot			0x0200	/* boot code executing */
#define	CMD_dma			0x4000	/* force a dma start */
#define	CMD_reset		0x5000	/* reset module status */
#define	CMD_sync		0x6000	/* kernel sync command */
#define	CMD_char_in		0x7000	/* single character send */
#define	CMD_char_out		0x8000	/* single character get */
#define	CHAR_count_1		0x0100	/* one char in cmd_low */
#define	CHAR_count_2		0x0200	/* the second in data_low */
#define	CHAR_count_3		0x0300	/* the third in data_high */
#define	CMD_spc_mode		0x9000	/* change spc mode */
#define	CMD_spc_to_text		0x0100	/* set to text mode */
#define	CMD_spc_to_digit	0x0200	/* set to digital mode */
#define	CMD_spc_rate		0x0400	/* change spc data rate */
#define	CMD_error		0xf000	/* severe error */

enum {	PRIMARY_DIC	= 0, USER_DIC, COMMAND_DIC, ABBREV_DIC };

#define	DMA_single_in		0x01
#define	DMA_single_out		0x02
#define	DMA_buff_in		0x03
#define	DMA_buff_out		0x04
#define	DMA_control		0x05
#define	DT_MEM_ALLOC		0x03
#define	DT_SET_DIC		0x04
#define	DT_START_TASK		0x05
#define	DT_LOAD_MEM		0x06
#define	DT_READ_MEM		0x07
#define	DT_DIGITAL_IN		0x08
#define	DMA_sync		0x06
#define	DMA_sync_char		0x07

#define DRV_VERSION "2.12"
#define PROCSPEECH 0x0b
#define SYNTH_IO_EXTENT 8

static int synth_probe(struct spk_synth *synth);
static void dtpc_release(struct spk_synth *synth);
static const char *synth_immediate(struct spk_synth *synth, const char *buf);
static void do_catch_up(struct spk_synth *synth);
static void synth_flush(struct spk_synth *synth);

static int synth_portlist[] = { 0x340, 0x350, 0x240, 0x250, 0 };
static int in_escape, is_flushing;
static int dt_stat, dma_state;

static struct var_t vars[] = {
	{ CAPS_START, .u.s = {"[:dv ap 200]" } },
	{ CAPS_STOP, .u.s = {"[:dv ap 100]" } },
	{ RATE, .u.n = {"[:ra %d]", 9, 0, 18, 150, 25, NULL } },
	{ PITCH, .u.n = {"[:dv ap %d]", 80, 0, 100, 20, 0, NULL } },
	{ INFLECTION, .u.n = {"[:dv pr %d] ", 100, 0, 10000, 0, 0, NULL } },
	{ VOL, .u.n = {"[:vo se %d]", 5, 0, 9, 5, 10, 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/decpc.
 */
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_dec_pc = {
	.name = "decpc",
	.version = DRV_VERSION,
	.long_name = "Dectalk PC",
	.init = "[:pe -380]",
	.procspeech = PROCSPEECH,
	.delay = 500,
	.trigger = 50,
	.jiffies = 50,
	.full = 1000,
	.flags = SF_DEC,
	.startup = SYNTH_START,
	.checkval = SYNTH_CHECK,
	.vars = vars,
	.io_ops = &spk_serial_io_ops,
	.probe = synth_probe,
	.release = dtpc_release,
	.synth_immediate = synth_immediate,
	.catch_up = do_catch_up,
	.flush = synth_flush,
	.is_alive = spk_synth_is_alive_nop,
	.synth_adjust = NULL,
	.read_buff_add = NULL,
	.get_index = NULL,
	.indexing = {
		.command = NULL,
		.lowindex = 0,
		.highindex = 0,
		.currindex = 0,
	},
	.attributes = {
		.attrs = synth_attrs,
		.name = "decpc",
	},
};

static int dt_getstatus(void)
{
	dt_stat = inb_p(speakup_info.port_tts) |
		 (inb_p(speakup_info.port_tts + 1) << 8);
	return dt_stat;
}

static void dt_sendcmd(u_int cmd)
{
	outb_p(cmd & 0xFF, speakup_info.port_tts);
	outb_p((cmd >> 8) & 0xFF, speakup_info.port_tts + 1);
}

static int dt_waitbit(int bit)
{
	int timeout = 100;

	while (--timeout > 0) {
		if ((dt_getstatus() & bit) == bit)
			return 1;
		udelay(50);
	}
	return 0;
}

static int dt_wait_dma(void)
{
	int timeout = 100, state = dma_state;

	if (!dt_waitbit(STAT_dma_ready))
		return 0;
	while (--timeout > 0) {
		if ((dt_getstatus() & STAT_dma_state) == state)
			return 1;
		udelay(50);
	}
	dma_state = dt_getstatus() & STAT_dma_state;
	return 1;
}

static int dt_ctrl(u_int cmd)
{
	int timeout = 10;

	if (!dt_waitbit(STAT_cmd_ready))
		return -1;
	outb_p(0, speakup_info.port_tts + 2);
	outb_p(0, speakup_info.port_tts + 3);
	dt_getstatus();
	dt_sendcmd(CMD_control | cmd);
	outb_p(0, speakup_info.port_tts + 6);
	while (dt_getstatus() & STAT_cmd_ready) {
		udelay(20);
		if (--timeout == 0)
			break;
	}
	dt_sendcmd(CMD_null);
	return 0;
}

static void synth_flush(struct spk_synth *synth)
{
	int timeout = 10;

	if (is_flushing)
		return;
	is_flushing = 4;
	in_escape = 0;
	while (dt_ctrl(CTRL_flush)) {
		if (--timeout == 0)
			break;
		udelay(50);
	}
	for (timeout = 0; timeout < 10; timeout++) {
		if (dt_waitbit(STAT_dma_ready))
			break;
		udelay(50);
	}
	outb_p(DMA_sync, speakup_info.port_tts + 4);
	outb_p(0, speakup_info.port_tts + 4);
	udelay(100);
	for (timeout = 0; timeout < 10; timeout++) {
		if (!(dt_getstatus() & STAT_flushing))
			break;
		udelay(50);
	}
	dma_state = dt_getstatus() & STAT_dma_state;
	dma_state ^= STAT_dma_state;
	is_flushing = 0;
}

static int dt_sendchar(char ch)
{
	if (!dt_wait_dma())
		return -1;
	if (!(dt_stat & STAT_rr_char))
		return -2;
	outb_p(DMA_single_in, speakup_info.port_tts + 4);
	outb_p(ch, speakup_info.port_tts + 4);
	dma_state ^= STAT_dma_state;
	return 0;
}

static int testkernel(void)
{
	int status = 0;

	if (dt_getstatus() == 0xffff) {
		status = -1;
		goto oops;
	}
	dt_sendcmd(CMD_sync);
	if (!dt_waitbit(STAT_cmd_ready))
		status = -2;
	else if (dt_stat & 0x8000)
		return 0;
	else if (dt_stat == 0x0dec)
		pr_warn("dec_pc at 0x%x, software not loaded\n",
			speakup_info.port_tts);
	status = -3;
oops:	synth_release_region(speakup_info.port_tts, SYNTH_IO_EXTENT);
	speakup_info.port_tts = 0;
	return status;
}

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

	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 (dt_sendchar(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))
				dt_sendchar(PROCSPEECH);
			if (time_after_eq(jiffies, jiff_max)) {
				if (!in_escape)
					dt_sendchar(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;
		ch = 0;
	}
	if (!in_escape)
		dt_sendchar(PROCSPEECH);
}

static const char *synth_immediate(struct spk_synth *synth, const char *buf)
{
	u_char ch;

	while ((ch = *buf)) {
		if (ch == '\n')
			ch = PROCSPEECH;
		if (dt_sendchar(ch))
			return buf;
		buf++;
	}
	return NULL;
}

static int synth_probe(struct spk_synth *synth)
{
	int i = 0, failed = 0;

	pr_info("Probing for %s.\n", synth->long_name);
	for (i = 0; synth_portlist[i]; i++) {
		if (synth_request_region(synth_portlist[i], SYNTH_IO_EXTENT)) {
			pr_warn("request_region: failed with 0x%x, %d\n",
				synth_portlist[i], SYNTH_IO_EXTENT);
			continue;
		}
		speakup_info.port_tts = synth_portlist[i];
		failed = testkernel();
		if (failed == 0)
			break;
	}
	if (failed) {
		pr_info("%s: not found\n", synth->long_name);
		return -ENODEV;
	}
	pr_info("%s: %03x-%03x, Driver Version %s,\n", synth->long_name,
		speakup_info.port_tts, speakup_info.port_tts + 7,
		synth->version);
	synth->alive = 1;
	return 0;
}

static void dtpc_release(struct spk_synth *synth)
{
	spk_stop_serial_interrupt();
	if (speakup_info.port_tts)
		synth_release_region(speakup_info.port_tts, SYNTH_IO_EXTENT);
	speakup_info.port_tts = 0;
}

module_param_named(start, synth_dec_pc.startup, short, 0444);

MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");

module_spk_synth(synth_dec_pc);

MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
MODULE_AUTHOR("David Borowski");
MODULE_DESCRIPTION("Speakup support for DECtalk PC synthesizers");
MODULE_LICENSE("GPL");
MODULE_VERSION(DRV_VERSION);
Commit	Line	Data
64969228	1	// SPDX-License-Identifier: GPL-2.0+
c6e3fd22 WH	2	/*
	3	* This is the DECtalk PC speakup driver
	4	*
	5	* Some constants from DEC's DOS driver:
	6	* Copyright (c) by Digital Equipment Corp.
	7	*
	8	* 386BSD DECtalk PC driver:
	9	* Copyright (c) 1996 Brian Buhrow <buhrow@lothlorien.nfbcal.org>
	10	*
	11	* Linux DECtalk PC driver:
	12	* Copyright (c) 1997 Nicolas Pitre <nico@cam.org>
	13	*
	14	* speakup DECtalk PC Internal driver:
	15	* Copyright (c) 2003 David Borowski <david575@golden.net>
	16	*
	17	* All rights reserved.
c6e3fd22 WH	18	*/
	19	#include <linux/jiffies.h>
	20	#include <linux/sched.h>
	21	#include <linux/timer.h>
	22	#include <linux/kthread.h>
	23
	24	#include "spk_priv.h"
	25	#include "speakup.h"
	26
8c7049eb TR	27	#define MODULE_init 0x0dec /* module in boot code */
	28	#define MODULE_self_test 0x8800 /* module in self-test */
	29	#define MODULE_reset 0xffff /* reinit the whole module */
c6e3fd22	30
8c7049eb	31	#define MODE_mask 0xf000 /* mode bits in high nibble */
c6e3fd22	32	#define MODE_null 0x0000
8c7049eb	33	#define MODE_test 0x2000 /* in testing mode */
c6e3fd22	34	#define MODE_status 0x8000
8c7049eb	35	#define STAT_int 0x0001 /* running in interrupt mode */
c6e3fd22 WH	36	#define STAT_tr_char 0x0002 /* character data to transmit */
	37	#define STAT_rr_char 0x0004 /* ready to receive char data */
	38	#define STAT_cmd_ready 0x0008 /* ready to accept commands */
	39	#define STAT_dma_ready 0x0010 /* dma command ready */
	40	#define STAT_digitized 0x0020 /* spc in digitized mode */
	41	#define STAT_new_index 0x0040 /* new last index ready */
	42	#define STAT_new_status 0x0080 /* new status posted */
	43	#define STAT_dma_state 0x0100 /* dma state toggle */
	44	#define STAT_index_valid 0x0200 /* indexs are valid */
	45	#define STAT_flushing 0x0400 /* flush in progress */
	46	#define STAT_self_test 0x0800 /* module in self test */
	47	#define MODE_ready 0xc000 /* module ready for next phase */
	48	#define READY_boot 0x0000
	49	#define READY_kernel 0x0001
	50	#define MODE_error 0xf000
	51
	52	#define CMD_mask 0xf000 /* mask for command nibble */
	53	#define CMD_null 0x0000 /* post status */
	54	#define CMD_control 0x1000 /* hard control command */
8c7049eb TR	55	#define CTRL_mask 0x0F00 /* mask off control nibble */
	56	#define CTRL_data 0x00FF /* mask to get data byte */
	57	#define CTRL_null 0x0000 /* null control */
	58	#define CTRL_vol_up 0x0100 /* increase volume */
	59	#define CTRL_vol_down 0x0200 /* decrease volume */
	60	#define CTRL_vol_set 0x0300 /* set volume */
	61	#define CTRL_pause 0x0400 /* pause spc */
	62	#define CTRL_resume 0x0500 /* resume spc clock */
	63	#define CTRL_resume_spc 0x0001 /* resume spc soft pause */
	64	#define CTRL_flush 0x0600 /* flush all buffers */
	65	#define CTRL_int_enable 0x0700 /* enable status change ints */
	66	#define CTRL_buff_free 0x0800 /* buffer remain count */
	67	#define CTRL_buff_used 0x0900 /* buffer in use */
	68	#define CTRL_speech 0x0a00 /* immediate speech change */
	69	#define CTRL_SP_voice 0x0001 /* voice change */
	70	#define CTRL_SP_rate 0x0002 /* rate change */
	71	#define CTRL_SP_comma 0x0003 /* comma pause change */
	72	#define CTRL_SP_period 0x0004 /* period pause change */
	73	#define CTRL_SP_rate_delta 0x0005 /* delta rate change */
	74	#define CTRL_SP_get_param 0x0006 /* return the desired parameter */
	75	#define CTRL_last_index 0x0b00 /* get last index spoken */
	76	#define CTRL_io_priority 0x0c00 /* change i/o priority */
	77	#define CTRL_free_mem 0x0d00 /* get free paragraphs on module */
6bbd04c6	78	#define CTRL_get_lang 0x0e00 /* return bitmask of loaded languages */
8c7049eb	79	#define CMD_test 0x2000 /* self-test request */
c6e3fd22 WH	80	#define TEST_mask 0x0F00 /* isolate test field */
	81	#define TEST_null 0x0000 /* no test requested */
	82	#define TEST_isa_int 0x0100 /* assert isa irq */
	83	#define TEST_echo 0x0200 /* make data in == data out */
	84	#define TEST_seg 0x0300 /* set peek/poke segment */
	85	#define TEST_off 0x0400 /* set peek/poke offset */
	86	#define TEST_peek 0x0500 /* data out == peek /
	87	#define TEST_poke 0x0600 /* peek == data in /
	88	#define TEST_sub_code 0x00FF /* user defined test sub codes */
	89	#define CMD_id 0x3000 /* return software id */
	90	#define ID_null 0x0000 /* null id */
	91	#define ID_kernel 0x0100 /* kernel code executing */
	92	#define ID_boot 0x0200 /* boot code executing */
8c7049eb TR	93	#define CMD_dma 0x4000 /* force a dma start */
	94	#define CMD_reset 0x5000 /* reset module status */
	95	#define CMD_sync 0x6000 /* kernel sync command */
	96	#define CMD_char_in 0x7000 /* single character send */
	97	#define CMD_char_out 0x8000 /* single character get */
	98	#define CHAR_count_1 0x0100 /* one char in cmd_low */
	99	#define CHAR_count_2 0x0200 /* the second in data_low */
	100	#define CHAR_count_3 0x0300 /* the third in data_high */
	101	#define CMD_spc_mode 0x9000 /* change spc mode */
	102	#define CMD_spc_to_text 0x0100 /* set to text mode */
	103	#define CMD_spc_to_digit 0x0200 /* set to digital mode */
	104	#define CMD_spc_rate 0x0400 /* change spc data rate */
	105	#define CMD_error 0xf000 /* severe error */
c6e3fd22 WH	106
	107	enum { PRIMARY_DIC = 0, USER_DIC, COMMAND_DIC, ABBREV_DIC };
	108
	109	#define DMA_single_in 0x01
	110	#define DMA_single_out 0x02
	111	#define DMA_buff_in 0x03
	112	#define DMA_buff_out 0x04
	113	#define DMA_control 0x05
	114	#define DT_MEM_ALLOC 0x03
	115	#define DT_SET_DIC 0x04
	116	#define DT_START_TASK 0x05
	117	#define DT_LOAD_MEM 0x06
	118	#define DT_READ_MEM 0x07
	119	#define DT_DIGITAL_IN 0x08
	120	#define DMA_sync 0x06
	121	#define DMA_sync_char 0x07
	122
	123	#define DRV_VERSION "2.12"
	124	#define PROCSPEECH 0x0b
	125	#define SYNTH_IO_EXTENT 8
	126
	127	static int synth_probe(struct spk_synth *synth);
1941ab1d	128	static void dtpc_release(struct spk_synth *synth);
c6e3fd22 WH	129	static const char synth_immediate(struct spk_synth synth, const char *buf);
	130	static void do_catch_up(struct spk_synth *synth);
	131	static void synth_flush(struct spk_synth *synth);
	132
	133	static int synth_portlist[] = { 0x340, 0x350, 0x240, 0x250, 0 };
	134	static int in_escape, is_flushing;
	135	static int dt_stat, dma_state;
	136
	137	static struct var_t vars[] = {
227e18d6 CB	138	{ CAPS_START, .u.s = {"[:dv ap 200]" } },
	139	{ CAPS_STOP, .u.s = {"[:dv ap 100]" } },
	140	{ RATE, .u.n = {"[:ra %d]", 9, 0, 18, 150, 25, NULL } },
	141	{ PITCH, .u.n = {"[:dv ap %d]", 80, 0, 100, 20, 0, NULL } },
d97a9d7a	142	{ INFLECTION, .u.n = {"[:dv pr %d] ", 100, 0, 10000, 0, 0, NULL } },
227e18d6 CB	143	{ VOL, .u.n = {"[:vo se %d]", 5, 0, 9, 5, 10, NULL } },
	144	{ PUNCT, .u.n = {"[:pu %c]", 0, 0, 2, 0, 0, "nsa" } },
	145	{ VOICE, .u.n = {"[:n%c]", 0, 0, 9, 0, 0, "phfdburwkv" } },
	146	{ DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
c6e3fd22 WH	147	V_LAST_VAR
	148	};
	149
	150	/*
	151	* These attributes will appear in /sys/accessibility/speakup/decpc.
	152	*/
	153	static struct kobj_attribute caps_start_attribute =
73c3700e	154	__ATTR(caps_start, 0644, spk_var_show, spk_var_store);
c6e3fd22	155	static struct kobj_attribute caps_stop_attribute =
73c3700e	156	__ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
c6e3fd22	157	static struct kobj_attribute pitch_attribute =
73c3700e	158	__ATTR(pitch, 0644, spk_var_show, spk_var_store);
d97a9d7a ST	159	static struct kobj_attribute inflection_attribute =
d97a9d7a ST	160	__ATTR(inflection, 0644, spk_var_show, spk_var_store);
c6e3fd22	161	static struct kobj_attribute punct_attribute =
73c3700e	162	__ATTR(punct, 0644, spk_var_show, spk_var_store);
c6e3fd22	163	static struct kobj_attribute rate_attribute =
73c3700e	164	__ATTR(rate, 0644, spk_var_show, spk_var_store);
c6e3fd22	165	static struct kobj_attribute voice_attribute =
73c3700e	166	__ATTR(voice, 0644, spk_var_show, spk_var_store);
c6e3fd22	167	static struct kobj_attribute vol_attribute =
73c3700e	168	__ATTR(vol, 0644, spk_var_show, spk_var_store);
c6e3fd22 WH	169
c6e3fd22 WH	170	static struct kobj_attribute delay_time_attribute =
73c3700e	171	__ATTR(delay_time, 0644, spk_var_show, spk_var_store);
c6e3fd22	172	static struct kobj_attribute direct_attribute =
73c3700e	173	__ATTR(direct, 0644, spk_var_show, spk_var_store);
c6e3fd22	174	static struct kobj_attribute full_time_attribute =
73c3700e	175	__ATTR(full_time, 0644, spk_var_show, spk_var_store);
c6e3fd22	176	static struct kobj_attribute jiffy_delta_attribute =
73c3700e	177	__ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
c6e3fd22	178	static struct kobj_attribute trigger_time_attribute =
73c3700e	179	__ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
c6e3fd22 WH	180
	181	/*
	182	* Create a group of attributes so that we can create and destroy them all
	183	* at once.
	184	*/
	185	static struct attribute *synth_attrs[] = {
	186	&caps_start_attribute.attr,
	187	&caps_stop_attribute.attr,
	188	&pitch_attribute.attr,
d97a9d7a	189	&inflection_attribute.attr,
c6e3fd22 WH	190	&punct_attribute.attr,
	191	&rate_attribute.attr,
	192	&voice_attribute.attr,
	193	&vol_attribute.attr,
	194	&delay_time_attribute.attr,
	195	&direct_attribute.attr,
	196	&full_time_attribute.attr,
	197	&jiffy_delta_attribute.attr,
	198	&trigger_time_attribute.attr,
	199	NULL, /* need to NULL terminate the list of attributes */
	200	};
	201
	202	static struct spk_synth synth_dec_pc = {
	203	.name = "decpc",
	204	.version = DRV_VERSION,
	205	.long_name = "Dectalk PC",
	206	.init = "[:pe -380]",
	207	.procspeech = PROCSPEECH,
	208	.delay = 500,
	209	.trigger = 50,
	210	.jiffies = 50,
	211	.full = 1000,
	212	.flags = SF_DEC,
	213	.startup = SYNTH_START,
	214	.checkval = SYNTH_CHECK,
	215	.vars = vars,
1e441594	216	.io_ops = &spk_serial_io_ops,
c6e3fd22 WH	217	.probe = synth_probe,
	218	.release = dtpc_release,
	219	.synth_immediate = synth_immediate,
	220	.catch_up = do_catch_up,
	221	.flush = synth_flush,
	222	.is_alive = spk_synth_is_alive_nop,
	223	.synth_adjust = NULL,
	224	.read_buff_add = NULL,
	225	.get_index = NULL,
	226	.indexing = {
	227	.command = NULL,
	228	.lowindex = 0,
	229	.highindex = 0,
	230	.currindex = 0,
	231	},
	232	.attributes = {
	233	.attrs = synth_attrs,
	234	.name = "decpc",
	235	},
	236	};
	237
	238	static int dt_getstatus(void)
	239	{
	240	dt_stat = inb_p(speakup_info.port_tts) \|
	241	(inb_p(speakup_info.port_tts + 1) << 8);
	242	return dt_stat;
	243	}
	244
	245	static void dt_sendcmd(u_int cmd)
	246	{
	247	outb_p(cmd & 0xFF, speakup_info.port_tts);
205931ea	248	outb_p((cmd >> 8) & 0xFF, speakup_info.port_tts + 1);
c6e3fd22 WH	249	}
	250
	251	static int dt_waitbit(int bit)
	252	{
	253	int timeout = 100;
8e69a811	254
c6e3fd22 WH	255	while (--timeout > 0) {
	256	if ((dt_getstatus() & bit) == bit)
	257	return 1;
	258	udelay(50);
	259	}
	260	return 0;
	261	}
	262
	263	static int dt_wait_dma(void)
	264	{
	265	int timeout = 100, state = dma_state;
8e69a811	266
c6e3fd22 WH	267	if (!dt_waitbit(STAT_dma_ready))
	268	return 0;
	269	while (--timeout > 0) {
50d280f3	270	if ((dt_getstatus() & STAT_dma_state) == state)
c6e3fd22 WH	271	return 1;
	272	udelay(50);
	273	}
	274	dma_state = dt_getstatus() & STAT_dma_state;
	275	return 1;
	276	}
	277
	278	static int dt_ctrl(u_int cmd)
	279	{
	280	int timeout = 10;
8e69a811	281
c6e3fd22 WH	282	if (!dt_waitbit(STAT_cmd_ready))
c6e3fd22 WH	283	return -1;
205931ea AS	284	outb_p(0, speakup_info.port_tts + 2);
205931ea AS	285	outb_p(0, speakup_info.port_tts + 3);
c6e3fd22	286	dt_getstatus();
205931ea AS	287	dt_sendcmd(CMD_control \| cmd);
205931ea AS	288	outb_p(0, speakup_info.port_tts + 6);
c6e3fd22 WH	289	while (dt_getstatus() & STAT_cmd_ready) {
	290	udelay(20);
	291	if (--timeout == 0)
	292	break;
	293	}
	294	dt_sendcmd(CMD_null);
	295	return 0;
	296	}
	297
	298	static void synth_flush(struct spk_synth *synth)
	299	{
	300	int timeout = 10;
8e69a811	301
c6e3fd22 WH	302	if (is_flushing)
	303	return;
	304	is_flushing = 4;
	305	in_escape = 0;
	306	while (dt_ctrl(CTRL_flush)) {
	307	if (--timeout == 0)
	308	break;
d427e60a	309	udelay(50);
c6e3fd22 WH	310	}
	311	for (timeout = 0; timeout < 10; timeout++) {
	312	if (dt_waitbit(STAT_dma_ready))
	313	break;
d427e60a	314	udelay(50);
c6e3fd22	315	}
205931ea AS	316	outb_p(DMA_sync, speakup_info.port_tts + 4);
205931ea AS	317	outb_p(0, speakup_info.port_tts + 4);
c6e3fd22 WH	318	udelay(100);
	319	for (timeout = 0; timeout < 10; timeout++) {
	320	if (!(dt_getstatus() & STAT_flushing))
	321	break;
d427e60a	322	udelay(50);
c6e3fd22 WH	323	}
	324	dma_state = dt_getstatus() & STAT_dma_state;
	325	dma_state ^= STAT_dma_state;
	326	is_flushing = 0;
	327	}
	328
	329	static int dt_sendchar(char ch)
	330	{
	331	if (!dt_wait_dma())
	332	return -1;
	333	if (!(dt_stat & STAT_rr_char))
	334	return -2;
205931ea AS	335	outb_p(DMA_single_in, speakup_info.port_tts + 4);
205931ea AS	336	outb_p(ch, speakup_info.port_tts + 4);
c6e3fd22 WH	337	dma_state ^= STAT_dma_state;
	338	return 0;
	339	}
	340
	341	static int testkernel(void)
	342	{
	343	int status = 0;
8e69a811	344
c6e3fd22 WH	345	if (dt_getstatus() == 0xffff) {
	346	status = -1;
	347	goto oops;
	348	}
	349	dt_sendcmd(CMD_sync);
	350	if (!dt_waitbit(STAT_cmd_ready))
	351	status = -2;
205931ea	352	else if (dt_stat & 0x8000)
c6e3fd22 WH	353	return 0;
	354	else if (dt_stat == 0x0dec)
	355	pr_warn("dec_pc at 0x%x, software not loaded\n",
accb9343	356	speakup_info.port_tts);
c6e3fd22 WH	357	status = -3;
	358	oops: synth_release_region(speakup_info.port_tts, SYNTH_IO_EXTENT);
	359	speakup_info.port_tts = 0;
	360	return status;
	361	}
	362
	363	static void do_catch_up(struct spk_synth *synth)
	364	{
	365	u_char ch;
227e18d6	366	static u_char last;
c6e3fd22 WH	367	unsigned long flags;
	368	unsigned long jiff_max;
	369	struct var_t *jiffy_delta;
	370	struct var_t *delay_time;
	371	int jiffy_delta_val;
	372	int delay_time_val;
	373
ca2beaf8 ST	374	jiffy_delta = spk_get_var(JIFFY);
ca2beaf8 ST	375	delay_time = spk_get_var(DELAY);
4d888b29	376	spin_lock_irqsave(&speakup_info.spinlock, flags);
c6e3fd22	377	jiffy_delta_val = jiffy_delta->u.n.value;
4d888b29	378	spin_unlock_irqrestore(&speakup_info.spinlock, flags);
c6e3fd22 WH	379	jiff_max = jiffies + jiffy_delta_val;
	380
	381	while (!kthread_should_stop()) {
4d888b29	382	spin_lock_irqsave(&speakup_info.spinlock, flags);
c6e3fd22 WH	383	if (speakup_info.flushing) {
c6e3fd22 WH	384	speakup_info.flushing = 0;
4d888b29	385	spin_unlock_irqrestore(&speakup_info.spinlock, flags);
c6e3fd22 WH	386	synth->flush(synth);
	387	continue;
	388	}
89fc2ae8	389	synth_buffer_skip_nonlatin1();
c6e3fd22	390	if (synth_buffer_empty()) {
4d888b29	391	spin_unlock_irqrestore(&speakup_info.spinlock, flags);
c6e3fd22 WH	392	break;
	393	}
	394	ch = synth_buffer_peek();
	395	set_current_state(TASK_INTERRUPTIBLE);
	396	delay_time_val = delay_time->u.n.value;
4d888b29	397	spin_unlock_irqrestore(&speakup_info.spinlock, flags);
c6e3fd22 WH	398	if (ch == '\n')
	399	ch = 0x0D;
	400	if (dt_sendchar(ch)) {
	401	schedule_timeout(msecs_to_jiffies(delay_time_val));
	402	continue;
	403	}
	404	set_current_state(TASK_RUNNING);
4d888b29	405	spin_lock_irqsave(&speakup_info.spinlock, flags);
c6e3fd22	406	synth_buffer_getc();
4d888b29	407	spin_unlock_irqrestore(&speakup_info.spinlock, flags);
0dcb2124	408	if (ch == '[') {
c6e3fd22	409	in_escape = 1;
0dcb2124	410	} else if (ch == ']') {
c6e3fd22	411	in_escape = 0;
0dcb2124	412	} else if (ch <= SPACE) {
c6e3fd22 WH	413	if (!in_escape && strchr(",.!?;:", last))
c6e3fd22 WH	414	dt_sendchar(PROCSPEECH);
89021ecc	415	if (time_after_eq(jiffies, jiff_max)) {
c6e3fd22 WH	416	if (!in_escape)
c6e3fd22 WH	417	dt_sendchar(PROCSPEECH);
63b8ebe4	418	spin_lock_irqsave(&speakup_info.spinlock,
accb9343	419	flags);
c6e3fd22 WH	420	jiffy_delta_val = jiffy_delta->u.n.value;
c6e3fd22 WH	421	delay_time_val = delay_time->u.n.value;
63b8ebe4	422	spin_unlock_irqrestore(&speakup_info.spinlock,
accb9343	423	flags);
227e18d6 CB	424	schedule_timeout(msecs_to_jiffies
227e18d6 CB	425	(delay_time_val));
c6e3fd22 WH	426	jiff_max = jiffies + jiffy_delta_val;
	427	}
	428	}
	429	last = ch;
	430	ch = 0;
	431	}
	432	if (!in_escape)
	433	dt_sendchar(PROCSPEECH);
	434	}
	435
	436	static const char synth_immediate(struct spk_synth synth, const char *buf)
	437	{
	438	u_char ch;
8e69a811	439
c6e3fd22 WH	440	while ((ch = *buf)) {
	441	if (ch == '\n')
	442	ch = PROCSPEECH;
	443	if (dt_sendchar(ch))
	444	return buf;
	445	buf++;
	446	}
6eb178ce	447	return NULL;
c6e3fd22 WH	448	}
	449
	450	static int synth_probe(struct spk_synth *synth)
	451	{
	452	int i = 0, failed = 0;
8e69a811	453
c6e3fd22 WH	454	pr_info("Probing for %s.\n", synth->long_name);
	455	for (i = 0; synth_portlist[i]; i++) {
	456	if (synth_request_region(synth_portlist[i], SYNTH_IO_EXTENT)) {
	457	pr_warn("request_region: failed with 0x%x, %d\n",
	458	synth_portlist[i], SYNTH_IO_EXTENT);
	459	continue;
	460	}
	461	speakup_info.port_tts = synth_portlist[i];
	462	failed = testkernel();
	463	if (failed == 0)
	464	break;
	465	}
	466	if (failed) {
	467	pr_info("%s: not found\n", synth->long_name);
	468	return -ENODEV;
	469	}
	470	pr_info("%s: %03x-%03x, Driver Version %s,\n", synth->long_name,
	471	speakup_info.port_tts, speakup_info.port_tts + 7,
	472	synth->version);
	473	synth->alive = 1;
	474	return 0;
	475	}
	476
1941ab1d	477	static void dtpc_release(struct spk_synth *synth)
c6e3fd22	478	{
a50ef316	479	spk_stop_serial_interrupt();
c6e3fd22 WH	480	if (speakup_info.port_tts)
	481	synth_release_region(speakup_info.port_tts, SYNTH_IO_EXTENT);
	482	speakup_info.port_tts = 0;
	483	}
	484
73c3700e	485	module_param_named(start, synth_dec_pc.startup, short, 0444);
c6e3fd22 WH	486
	487	MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
	488
ae89facc	489	module_spk_synth(synth_dec_pc);
c6e3fd22	490
c6e3fd22 WH	491	MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
	492	MODULE_AUTHOR("David Borowski");
	493	MODULE_DESCRIPTION("Speakup support for DECtalk PC synthesizers");
	494	MODULE_LICENSE("GPL");
	495	MODULE_VERSION(DRV_VERSION);