speakup_decext.c

Go to the documentation of this file.

/*
 * originally written by: Kirk Reiser <[email protected]>
* this version considerably modified by David Borowski, [email protected]
 *
 * Copyright (C) 1998-99  Kirk Reiser.
 * Copyright (C) 2003 David Borowski.
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * 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 "serialio.h"
#include "speakup.h"

#define DRV_VERSION "2.14"
#define SYNTH_CLEAR 0x03
#define PROCSPEECH 0x0b
static unsigned char last_char;

static inline u_char get_last_char(void)
{
    u_char avail = inb_p(speakup_info.port_tts + UART_LSR) & UART_LSR_DR;
    if (avail)
        last_char = inb_p(speakup_info.port_tts + UART_RX);
    return last_char;
}

static inline bool synth_full(void)
{
    return get_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 } },
    { 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, USER_RW, spk_var_show, spk_var_store);
static struct kobj_attribute caps_stop_attribute =
    __ATTR(caps_stop, USER_RW, spk_var_show, spk_var_store);
static struct kobj_attribute pitch_attribute =
    __ATTR(pitch, USER_RW, spk_var_show, spk_var_store);
static struct kobj_attribute punct_attribute =
    __ATTR(punct, USER_RW, spk_var_show, spk_var_store);
static struct kobj_attribute rate_attribute =
    __ATTR(rate, USER_RW, spk_var_show, spk_var_store);
static struct kobj_attribute voice_attribute =
    __ATTR(voice, USER_RW, spk_var_show, spk_var_store);
static struct kobj_attribute vol_attribute =
    __ATTR(vol, USER_RW, spk_var_show, spk_var_store);

static struct kobj_attribute delay_time_attribute =
    __ATTR(delay_time, ROOT_W, spk_var_show, spk_var_store);
static struct kobj_attribute direct_attribute =
    __ATTR(direct, USER_RW, spk_var_show, spk_var_store);
static struct kobj_attribute full_time_attribute =
    __ATTR(full_time, ROOT_W, spk_var_show, spk_var_store);
static struct kobj_attribute jiffy_delta_attribute =
    __ATTR(jiffy_delta, ROOT_W, spk_var_show, spk_var_store);
static struct kobj_attribute trigger_time_attribute =
    __ATTR(trigger_time, ROOT_W, 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_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,
    .startup = SYNTH_START,
    .checkval = SYNTH_CHECK,
    .vars = vars,
    .probe = serial_synth_probe,
    .release = spk_serial_release,
    .synth_immediate = spk_synth_immediate,
    .catch_up = do_catch_up,
    .flush = synth_flush,
    .is_alive = spk_synth_is_alive_restart,
    .synth_adjust = NULL,
    .read_buff_add = NULL,
    .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 = get_var(JIFFY);
    delay_time = get_var(DELAY);

    spk_lock(flags);
    jiffy_delta_val = jiffy_delta->u.n.value;
    spk_unlock(flags);
    jiff_max = jiffies + jiffy_delta_val;

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

static void synth_flush(struct spk_synth *synth)
{
    in_escape = 0;
    spk_synth_immediate(synth, "\033P;10z\033\\");
}

module_param_named(ser, synth_decext.ser, int, S_IRUGO);
module_param_named(start, synth_decext.startup, short, S_IRUGO);

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

static int __init decext_init(void)
{
    return synth_add(&synth_decext);
}

static void __exit decext_exit(void)
{
    synth_remove(&synth_decext);
}

module_init(decext_init);
module_exit(decext_exit);
MODULE_AUTHOR("Kirk Reiser <[email protected]>");
MODULE_AUTHOR("David Borowski");
MODULE_DESCRIPTION("Speakup support for DECtalk External synthesizers");
MODULE_LICENSE("GPL");
MODULE_VERSION(DRV_VERSION);