LXR linux/drivers/staging/speakup/speakup

   1/*
   2 * originally written by: Kirk Reiser <kirk@braille.uwo.ca>
   3* this version considerably modified by David Borowski, david575@rogers.com
   4 *
   5 * Copyright (C) 1998-99  Kirk Reiser.
   6 * Copyright (C) 2003 David Borowski.
   7 *
   8 * This program is free software; you can redistribute it and/or modify
   9 * it under the terms of the GNU General Public License as published by
  10 * the Free Software Foundation; either version 2 of the License, or
  11 * (at your option) any later version.
  12 *
  13 * This program is distributed in the hope that it will be useful,
  14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 * GNU General Public License for more details.
  17 *
  18 * You should have received a copy of the GNU General Public License
  19 * along with this program; if not, write to the Free Software
  20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21 *
  22 * specificly written as a driver for the speakup screenreview
  23 * s not a general device driver.
  24 */
  25#include "spk_priv.h"
  26#include "speakup.h"
  27#include "serialio.h"
  28
  29#define DRV_VERSION "2.11"
  30#define SYNTH_CLEAR 0x18
  31#define PROCSPEECH '\r'
  32
  33static void synth_flush(struct spk_synth *synth);
  34
  35static struct var_t vars[] = {
  36        { CAPS_START, .u.s = {"\x05P+" } },
  37        { CAPS_STOP, .u.s = {"\x05P-" } },
  38        { RATE, .u.n = {"\x05R%d", 7, 0, 9, 0, 0, NULL } },
  39        { PITCH, .u.n = {"\x05P%d", 3, 0, 9, 0, 0, NULL } },
  40        { VOL, .u.n = {"\x05V%d", 9, 0, 9, 0, 0, NULL } },
  41        { TONE, .u.n = {"\x05T%c", 8, 0, 25, 65, 0, NULL } },
  42        { PUNCT, .u.n = {"\x05M%c", 0, 0, 3, 0, 0, "nsma" } },
  43        { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
  44        V_LAST_VAR
  45};
  46
  47/*
  48 * These attributes will appear in /sys/accessibility/speakup/spkout.
  49 */
  50static struct kobj_attribute caps_start_attribute =
  51        __ATTR(caps_start, USER_RW, spk_var_show, spk_var_store);
  52static struct kobj_attribute caps_stop_attribute =
  53        __ATTR(caps_stop, USER_RW, spk_var_show, spk_var_store);
  54static struct kobj_attribute pitch_attribute =
  55        __ATTR(pitch, USER_RW, spk_var_show, spk_var_store);
  56static struct kobj_attribute punct_attribute =
  57        __ATTR(punct, USER_RW, spk_var_show, spk_var_store);
  58static struct kobj_attribute rate_attribute =
  59        __ATTR(rate, USER_RW, spk_var_show, spk_var_store);
  60static struct kobj_attribute tone_attribute =
  61        __ATTR(tone, USER_RW, spk_var_show, spk_var_store);
  62static struct kobj_attribute vol_attribute =
  63        __ATTR(vol, USER_RW, spk_var_show, spk_var_store);
  64
  65static struct kobj_attribute delay_time_attribute =
  66        __ATTR(delay_time, ROOT_W, spk_var_show, spk_var_store);
  67static struct kobj_attribute direct_attribute =
  68        __ATTR(direct, USER_RW, spk_var_show, spk_var_store);
  69static struct kobj_attribute full_time_attribute =
  70        __ATTR(full_time, ROOT_W, spk_var_show, spk_var_store);
  71static struct kobj_attribute jiffy_delta_attribute =
  72        __ATTR(jiffy_delta, ROOT_W, spk_var_show, spk_var_store);
  73static struct kobj_attribute trigger_time_attribute =
  74        __ATTR(trigger_time, ROOT_W, spk_var_show, spk_var_store);
  75
  76/*
  77 * Create a group of attributes so that we can create and destroy them all
  78 * at once.
  79 */
  80static struct attribute *synth_attrs[] = {
  81        &caps_start_attribute.attr,
  82        &caps_stop_attribute.attr,
  83        &pitch_attribute.attr,
  84        &punct_attribute.attr,
  85        &rate_attribute.attr,
  86        &tone_attribute.attr,
  87        &vol_attribute.attr,
  88        &delay_time_attribute.attr,
  89        &direct_attribute.attr,
  90        &full_time_attribute.attr,
  91        &jiffy_delta_attribute.attr,
  92        &trigger_time_attribute.attr,
  93        NULL,   /* need to NULL terminate the list of attributes */
  94};
  95
  96static struct spk_synth synth_spkout = {
  97        .name = "spkout",
  98        .version = DRV_VERSION,
  99        .long_name = "Speakout",
 100        .init = "\005W1\005I2\005C3",
 101        .procspeech = PROCSPEECH,
 102        .clear = SYNTH_CLEAR,
 103        .delay = 500,
 104        .trigger = 50,
 105        .jiffies = 50,
 106        .full = 40000,
 107        .startup = SYNTH_START,
 108        .checkval = SYNTH_CHECK,
 109        .vars = vars,
 110        .probe = serial_synth_probe,
 111        .release = spk_serial_release,
 112        .synth_immediate = spk_synth_immediate,
 113        .catch_up = spk_do_catch_up,
 114        .flush = synth_flush,
 115        .is_alive = spk_synth_is_alive_restart,
 116        .synth_adjust = NULL,
 117        .read_buff_add = NULL,
 118        .get_index = spk_serial_in_nowait,
 119        .indexing = {
 120                .command = "\x05[%c",
 121                .lowindex = 1,
 122                .highindex = 5,
 123                .currindex = 1,
 124        },
 125        .attributes = {
 126                .attrs = synth_attrs,
 127                .name = "spkout",
 128        },
 129};
 130
 131static void synth_flush(struct spk_synth *synth)
 132{
 133        int timeout = SPK_XMITR_TIMEOUT;
 134        while (spk_serial_tx_busy()) {
 135                if (!--timeout)
 136                        break;
 137                udelay(1);
 138        }
 139        outb(SYNTH_CLEAR, speakup_info.port_tts);
 140}
 141
 142module_param_named(ser, synth_spkout.ser, int, S_IRUGO);
 143module_param_named(start, synth_spkout.startup, short, S_IRUGO);
 144
 145MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
 146MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
 147
 148static int __init spkout_init(void)
 149{
 150        return synth_add(&synth_spkout);
 151}
 152
 153static void __exit spkout_exit(void)
 154{
 155        synth_remove(&synth_spkout);
 156}
 157
 158module_init(spkout_init);
 159module_exit(spkout_exit);
 160MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
 161MODULE_AUTHOR("David Borowski");
 162MODULE_DESCRIPTION("Speakup support for Speak Out synthesizers");
 163MODULE_LICENSE("GPL");
 164MODULE_VERSION(DRV_VERSION);
 165
 166