[linux-2.6-block.git] / drivers / staging / speakup / speakup_decpc.c

/*
 * 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.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
#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 bit mask 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(void);
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 } },
	{ 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, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
static struct kobj_attribute caps_stop_attribute =
	__ATTR(caps_stop, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
static struct kobj_attribute pitch_attribute =
	__ATTR(pitch, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
static struct kobj_attribute punct_attribute =
	__ATTR(punct, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
static struct kobj_attribute rate_attribute =
	__ATTR(rate, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
static struct kobj_attribute voice_attribute =
	__ATTR(voice, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
static struct kobj_attribute vol_attribute =
	__ATTR(vol, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);

static struct kobj_attribute delay_time_attribute =
	__ATTR(delay_time, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
static struct kobj_attribute direct_attribute =
	__ATTR(direct, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
static struct kobj_attribute full_time_attribute =
	__ATTR(full_time, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
static struct kobj_attribute jiffy_delta_attribute =
	__ATTR(jiffy_delta, S_IWUSR|S_IRUGO, spk_var_show, spk_var_store);
static struct kobj_attribute trigger_time_attribute =
	__ATTR(trigger_time, S_IWUSR|S_IRUGO, 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,
	&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,
	.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;
		}
		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(void)
{
	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, S_IRUGO);

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