linux/drivers/staging/speakup/synth.c
<<
>>
Prefs
   1#include <linux/types.h>
   2#include <linux/ctype.h>        /* for isdigit() and friends */
   3#include <linux/fs.h>
   4#include <linux/mm.h>           /* for verify_area */
   5#include <linux/errno.h>        /* for -EBUSY */
   6#include <linux/ioport.h>       /* for check_region, request_region */
   7#include <linux/interrupt.h>
   8#include <linux/delay.h>        /* for loops_per_sec */
   9#include <linux/kmod.h>
  10#include <linux/jiffies.h>
  11#include <linux/uaccess.h> /* for copy_from_user */
  12#include <linux/sched.h>
  13#include <linux/timer.h>
  14#include <linux/kthread.h>
  15
  16#include "spk_priv.h"
  17#include "speakup.h"
  18#include "serialio.h"
  19
  20#define MAXSYNTHS       16      /* Max number of synths in array. */
  21static struct spk_synth *synths[MAXSYNTHS];
  22struct spk_synth *synth;
  23char spk_pitch_buff[32] = "";
  24static int module_status;
  25bool spk_quiet_boot;
  26
  27struct speakup_info_t speakup_info = {
  28        /*
  29         * This spinlock is used to protect the entire speakup machinery, and
  30         * must be taken at each kernel->speakup transition and released at
  31         * each corresponding speakup->kernel transition.
  32         *
  33         * The progression thread only interferes with the speakup machinery through
  34         * the synth buffer, so only needs to take the lock while tinkering with
  35         * the buffer.
  36         *
  37         * We use spin_lock/trylock_irqsave and spin_unlock_irqrestore with this
  38         * spinlock because speakup needs to disable the keyboard IRQ.
  39         */
  40        .spinlock = __SPIN_LOCK_UNLOCKED(speakup_info.spinlock),
  41        .flushing = 0,
  42};
  43EXPORT_SYMBOL_GPL(speakup_info);
  44
  45static int do_synth_init(struct spk_synth *in_synth);
  46
  47int spk_serial_synth_probe(struct spk_synth *synth)
  48{
  49        const struct old_serial_port *ser;
  50        int failed = 0;
  51
  52        if ((synth->ser >= SPK_LO_TTY) && (synth->ser <= SPK_HI_TTY)) {
  53                ser = spk_serial_init(synth->ser);
  54                if (ser == NULL) {
  55                        failed = -1;
  56                } else {
  57                        outb_p(0, ser->port);
  58                        mdelay(1);
  59                        outb_p('\r', ser->port);
  60                }
  61        } else {
  62                failed = -1;
  63                pr_warn("ttyS%i is an invalid port\n", synth->ser);
  64        }
  65        if (failed) {
  66                pr_info("%s: not found\n", synth->long_name);
  67                return -ENODEV;
  68        }
  69        pr_info("%s: ttyS%i, Driver Version %s\n",
  70                        synth->long_name, synth->ser, synth->version);
  71        synth->alive = 1;
  72        return 0;
  73}
  74EXPORT_SYMBOL_GPL(spk_serial_synth_probe);
  75
  76/* Main loop of the progression thread: keep eating from the buffer
  77 * and push to the serial port, waiting as needed
  78 *
  79 * For devices that have a "full" notification mechanism, the driver can
  80 * adapt the loop the way they prefer.
  81 */
  82void spk_do_catch_up(struct spk_synth *synth)
  83{
  84        u_char ch;
  85        unsigned long flags;
  86        unsigned long jiff_max;
  87        struct var_t *delay_time;
  88        struct var_t *full_time;
  89        struct var_t *jiffy_delta;
  90        int jiffy_delta_val;
  91        int delay_time_val;
  92        int full_time_val;
  93
  94        jiffy_delta = spk_get_var(JIFFY);
  95        full_time = spk_get_var(FULL);
  96        delay_time = spk_get_var(DELAY);
  97
  98        spin_lock_irqsave(&speakup_info.spinlock, flags);
  99        jiffy_delta_val = jiffy_delta->u.n.value;
 100        spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 101
 102        jiff_max = jiffies + jiffy_delta_val;
 103        while (!kthread_should_stop()) {
 104                spin_lock_irqsave(&speakup_info.spinlock, flags);
 105                if (speakup_info.flushing) {
 106                        speakup_info.flushing = 0;
 107                        spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 108                        synth->flush(synth);
 109                        continue;
 110                }
 111                if (synth_buffer_empty()) {
 112                        spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 113                        break;
 114                }
 115                ch = synth_buffer_peek();
 116                set_current_state(TASK_INTERRUPTIBLE);
 117                full_time_val = full_time->u.n.value;
 118                spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 119                if (ch == '\n')
 120                        ch = synth->procspeech;
 121                if (!spk_serial_out(ch)) {
 122                        schedule_timeout(msecs_to_jiffies(full_time_val));
 123                        continue;
 124                }
 125                if ((jiffies >= jiff_max) && (ch == SPACE)) {
 126                        spin_lock_irqsave(&speakup_info.spinlock, flags);
 127                        jiffy_delta_val = jiffy_delta->u.n.value;
 128                        delay_time_val = delay_time->u.n.value;
 129                        full_time_val = full_time->u.n.value;
 130                        spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 131                        if (spk_serial_out(synth->procspeech))
 132                                schedule_timeout(
 133                                        msecs_to_jiffies(delay_time_val));
 134                        else
 135                                schedule_timeout(
 136                                        msecs_to_jiffies(full_time_val));
 137                        jiff_max = jiffies + jiffy_delta_val;
 138                }
 139                set_current_state(TASK_RUNNING);
 140                spin_lock_irqsave(&speakup_info.spinlock, flags);
 141                synth_buffer_getc();
 142                spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 143        }
 144        spk_serial_out(synth->procspeech);
 145}
 146EXPORT_SYMBOL_GPL(spk_do_catch_up);
 147
 148const char *spk_synth_immediate(struct spk_synth *synth, const char *buff)
 149{
 150        u_char ch;
 151        while ((ch = *buff)) {
 152                if (ch == '\n')
 153                        ch = synth->procspeech;
 154                if (spk_wait_for_xmitr())
 155                        outb(ch, speakup_info.port_tts);
 156                else
 157                        return buff;
 158                buff++;
 159        }
 160        return NULL;
 161}
 162EXPORT_SYMBOL_GPL(spk_synth_immediate);
 163
 164void spk_synth_flush(struct spk_synth *synth)
 165{
 166        spk_serial_out(synth->clear);
 167}
 168EXPORT_SYMBOL_GPL(spk_synth_flush);
 169
 170int spk_synth_is_alive_nop(struct spk_synth *synth)
 171{
 172        synth->alive = 1;
 173        return 1;
 174}
 175EXPORT_SYMBOL_GPL(spk_synth_is_alive_nop);
 176
 177int spk_synth_is_alive_restart(struct spk_synth *synth)
 178{
 179        if (synth->alive)
 180                return 1;
 181        if (!synth->alive && spk_wait_for_xmitr() > 0) {
 182                /* restart */
 183                synth->alive = 1;
 184                synth_printf("%s", synth->init);
 185                return 2; /* reenabled */
 186        }
 187        pr_warn("%s: can't restart synth\n", synth->long_name);
 188        return 0;
 189}
 190EXPORT_SYMBOL_GPL(spk_synth_is_alive_restart);
 191
 192static void thread_wake_up(u_long data)
 193{
 194        wake_up_interruptible_all(&speakup_event);
 195}
 196
 197static DEFINE_TIMER(thread_timer, thread_wake_up, 0, 0);
 198
 199void synth_start(void)
 200{
 201        struct var_t *trigger_time;
 202
 203        if (!synth->alive) {
 204                synth_buffer_clear();
 205                return;
 206        }
 207        trigger_time = spk_get_var(TRIGGER);
 208        if (!timer_pending(&thread_timer))
 209                mod_timer(&thread_timer, jiffies +
 210                        msecs_to_jiffies(trigger_time->u.n.value));
 211}
 212
 213void spk_do_flush(void)
 214{
 215        speakup_info.flushing = 1;
 216        synth_buffer_clear();
 217        if (synth->alive) {
 218                if (spk_pitch_shift) {
 219                        synth_printf("%s", spk_pitch_buff);
 220                        spk_pitch_shift = 0;
 221                }
 222        }
 223        wake_up_interruptible_all(&speakup_event);
 224        wake_up_process(speakup_task);
 225}
 226
 227void synth_write(const char *buf, size_t count)
 228{
 229        while (count--)
 230                synth_buffer_add(*buf++);
 231        synth_start();
 232}
 233
 234void synth_printf(const char *fmt, ...)
 235{
 236        va_list args;
 237        unsigned char buf[160], *p;
 238        int r;
 239
 240        va_start(args, fmt);
 241        r = vsnprintf(buf, sizeof(buf), fmt, args);
 242        va_end(args);
 243        if (r > sizeof(buf) - 1)
 244                r = sizeof(buf) - 1;
 245
 246        p = buf;
 247        while (r--)
 248                synth_buffer_add(*p++);
 249        synth_start();
 250}
 251EXPORT_SYMBOL_GPL(synth_printf);
 252
 253static int index_count;
 254static int sentence_count;
 255
 256void spk_reset_index_count(int sc)
 257{
 258        static int first = 1;
 259        if (first)
 260                first = 0;
 261        else
 262                synth->get_index();
 263        index_count = 0;
 264        sentence_count = sc;
 265}
 266
 267int synth_supports_indexing(void)
 268{
 269        if (synth->get_index != NULL)
 270                return 1;
 271        return 0;
 272}
 273
 274void synth_insert_next_index(int sent_num)
 275{
 276        int out;
 277        if (synth->alive) {
 278                if (sent_num == 0) {
 279                        synth->indexing.currindex++;
 280                        index_count++;
 281                        if (synth->indexing.currindex >
 282                                        synth->indexing.highindex)
 283                                synth->indexing.currindex =
 284                                        synth->indexing.lowindex;
 285                }
 286
 287                out = synth->indexing.currindex * 10 + sent_num;
 288                synth_printf(synth->indexing.command, out, out);
 289        }
 290}
 291
 292void spk_get_index_count(int *linecount, int *sentcount)
 293{
 294        int ind = synth->get_index();
 295        if (ind) {
 296                sentence_count = ind % 10;
 297
 298                if ((ind / 10) <= synth->indexing.currindex)
 299                        index_count = synth->indexing.currindex-(ind/10);
 300                else
 301                        index_count = synth->indexing.currindex
 302                                -synth->indexing.lowindex
 303                                + synth->indexing.highindex-(ind/10)+1;
 304
 305        }
 306        *sentcount = sentence_count;
 307        *linecount = index_count;
 308}
 309
 310static struct resource synth_res;
 311
 312int synth_request_region(unsigned long start, unsigned long n)
 313{
 314        struct resource *parent = &ioport_resource;
 315        memset(&synth_res, 0, sizeof(synth_res));
 316        synth_res.name = synth->name;
 317        synth_res.start = start;
 318        synth_res.end = start + n - 1;
 319        synth_res.flags = IORESOURCE_BUSY;
 320        return request_resource(parent, &synth_res);
 321}
 322EXPORT_SYMBOL_GPL(synth_request_region);
 323
 324int synth_release_region(unsigned long start, unsigned long n)
 325{
 326        return release_resource(&synth_res);
 327}
 328EXPORT_SYMBOL_GPL(synth_release_region);
 329
 330struct var_t synth_time_vars[] = {
 331        { DELAY, .u.n = {NULL, 100, 100, 2000, 0, 0, NULL } },
 332        { TRIGGER, .u.n = {NULL, 20, 10, 2000, 0, 0, NULL } },
 333        { JIFFY, .u.n = {NULL, 50, 20, 200, 0, 0, NULL } },
 334        { FULL, .u.n = {NULL, 400, 200, 60000, 0, 0, NULL } },
 335        V_LAST_VAR
 336};
 337
 338/* called by: speakup_init() */
 339int synth_init(char *synth_name)
 340{
 341        int i;
 342        int ret = 0;
 343        struct spk_synth *synth = NULL;
 344
 345        if (synth_name == NULL)
 346                return 0;
 347
 348        if (strcmp(synth_name, "none") == 0) {
 349                mutex_lock(&spk_mutex);
 350                synth_release();
 351                mutex_unlock(&spk_mutex);
 352                return 0;
 353        }
 354
 355        mutex_lock(&spk_mutex);
 356        /* First, check if we already have it loaded. */
 357        for (i = 0; i < MAXSYNTHS && synths[i] != NULL; i++)
 358                if (strcmp(synths[i]->name, synth_name) == 0)
 359                        synth = synths[i];
 360
 361        /* If we got one, initialize it now. */
 362        if (synth)
 363                ret = do_synth_init(synth);
 364        else
 365                ret = -ENODEV;
 366        mutex_unlock(&spk_mutex);
 367
 368        return ret;
 369}
 370
 371/* called by: synth_add() */
 372static int do_synth_init(struct spk_synth *in_synth)
 373{
 374        struct var_t *var;
 375
 376        synth_release();
 377        if (in_synth->checkval != SYNTH_CHECK)
 378                return -EINVAL;
 379        synth = in_synth;
 380        synth->alive = 0;
 381        pr_warn("synth probe\n");
 382        if (synth->probe(synth) < 0) {
 383                pr_warn("%s: device probe failed\n", in_synth->name);
 384                synth = NULL;
 385                return -ENODEV;
 386        }
 387        synth_time_vars[0].u.n.value =
 388                synth_time_vars[0].u.n.default_val = synth->delay;
 389        synth_time_vars[1].u.n.value =
 390                synth_time_vars[1].u.n.default_val = synth->trigger;
 391        synth_time_vars[2].u.n.value =
 392                synth_time_vars[2].u.n.default_val = synth->jiffies;
 393        synth_time_vars[3].u.n.value =
 394                synth_time_vars[3].u.n.default_val = synth->full;
 395        synth_printf("%s", synth->init);
 396        for (var = synth->vars;
 397                (var->var_id >= 0) && (var->var_id < MAXVARS); var++)
 398                speakup_register_var(var);
 399        if (!spk_quiet_boot)
 400                synth_printf("%s found\n", synth->long_name);
 401        if (synth->attributes.name
 402        && sysfs_create_group(speakup_kobj, &(synth->attributes)) < 0)
 403                return -ENOMEM;
 404        synth_flags = synth->flags;
 405        wake_up_interruptible_all(&speakup_event);
 406        if (speakup_task)
 407                wake_up_process(speakup_task);
 408        return 0;
 409}
 410
 411void synth_release(void)
 412{
 413        struct var_t *var;
 414        unsigned long flags;
 415
 416        if (synth == NULL)
 417                return;
 418        spin_lock_irqsave(&speakup_info.spinlock, flags);
 419        pr_info("releasing synth %s\n", synth->name);
 420        synth->alive = 0;
 421        del_timer(&thread_timer);
 422        spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 423        if (synth->attributes.name)
 424                sysfs_remove_group(speakup_kobj, &(synth->attributes));
 425        for (var = synth->vars; var->var_id != MAXVARS; var++)
 426                speakup_unregister_var(var->var_id);
 427        spk_stop_serial_interrupt();
 428        synth->release();
 429        synth = NULL;
 430}
 431
 432/* called by: all_driver_init() */
 433int synth_add(struct spk_synth *in_synth)
 434{
 435        int i;
 436        int status = 0;
 437        mutex_lock(&spk_mutex);
 438        for (i = 0; i < MAXSYNTHS && synths[i] != NULL; i++)
 439                /* synth_remove() is responsible for rotating the array down */
 440                if (in_synth == synths[i]) {
 441                        mutex_unlock(&spk_mutex);
 442                        return 0;
 443                }
 444        if (i == MAXSYNTHS) {
 445                pr_warn("Error: attempting to add a synth past end of array\n");
 446                mutex_unlock(&spk_mutex);
 447                return -1;
 448        }
 449        synths[i++] = in_synth;
 450        synths[i] = NULL;
 451        if (in_synth->startup)
 452                status = do_synth_init(in_synth);
 453        mutex_unlock(&spk_mutex);
 454        return status;
 455}
 456EXPORT_SYMBOL_GPL(synth_add);
 457
 458void synth_remove(struct spk_synth *in_synth)
 459{
 460        int i;
 461        mutex_lock(&spk_mutex);
 462        if (synth == in_synth)
 463                synth_release();
 464        for (i = 0; synths[i] != NULL; i++) {
 465                if (in_synth == synths[i])
 466                        break;
 467        }
 468        for ( ; synths[i] != NULL; i++) /* compress table */
 469                synths[i] = synths[i+1];
 470        module_status = 0;
 471        mutex_unlock(&spk_mutex);
 472}
 473EXPORT_SYMBOL_GPL(synth_remove);
 474
 475short spk_punc_masks[] = { 0, SOME, MOST, PUNC, PUNC|B_SYM };
 476