drivers/staging/speakup/speakup_soft.c

   1 /* speakup_soft.c - speakup driver to register and make available
   2  * a user space device for software synthesizers.  written by: Kirk
   3  * Reiser <kirk@braille.uwo.ca>
   4  *
   5  * Copyright (C) 2003  Kirk Reiser.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  *
  18  * this code is specificly written as a driver for the speakup screenreview
  19  * package and is not a general device driver.
  20  */
  21
  22 #include <linux/unistd.h>
  23 #include <linux/miscdevice.h>   /* for misc_register, and SYNTH_MINOR */
  24 #include <linux/poll.h>         /* for poll_wait() */
  25 #include <linux/sched/signal.h> /* schedule(), signal_pending(), TASK_INTERRUPTIBLE */
  26
  27 #include "spk_priv.h"
  28 #include "speakup.h"
  29
  30 #define DRV_VERSION "2.6"
  31 #define SOFTSYNTH_MINOR 26 /* might as well give it one more than /dev/synth */
  32 #define SOFTSYNTHU_MINOR 27 /* might as well give it one more than /dev/synth */
  33 #define PROCSPEECH 0x0d
  34 #define CLEAR_SYNTH 0x18
  35
  36 static int softsynth_probe(struct spk_synth *synth);
  37 static void softsynth_release(void);
  38 static int softsynth_is_alive(struct spk_synth *synth);
  39 static unsigned char get_index(struct spk_synth *synth);
  40
  41 static struct miscdevice synth_device, synthu_device;
  42 static int init_pos;
  43 static int misc_registered;
  44
  45 static struct var_t vars[] = {
  46         { CAPS_START, .u.s = {"\x01+3p" } },
  47         { CAPS_STOP, .u.s = {"\x01-3p" } },
  48         { RATE, .u.n = {"\x01%ds", 2, 0, 9, 0, 0, NULL } },
  49         { PITCH, .u.n = {"\x01%dp", 5, 0, 9, 0, 0, NULL } },
  50         { VOL, .u.n = {"\x01%dv", 5, 0, 9, 0, 0, NULL } },
  51         { TONE, .u.n = {"\x01%dx", 1, 0, 2, 0, 0, NULL } },
  52         { PUNCT, .u.n = {"\x01%db", 0, 0, 2, 0, 0, NULL } },
  53         { VOICE, .u.n = {"\x01%do", 0, 0, 7, 0, 0, NULL } },
  54         { FREQUENCY, .u.n = {"\x01%df", 5, 0, 9, 0, 0, NULL } },
  55         { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
  56         V_LAST_VAR
  57 };
  58
  59 /* These attributes will appear in /sys/accessibility/speakup/soft. */
  60
  61 static struct kobj_attribute caps_start_attribute =
  62         __ATTR(caps_start, 0644, spk_var_show, spk_var_store);
  63 static struct kobj_attribute caps_stop_attribute =
  64         __ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
  65 static struct kobj_attribute freq_attribute =
  66         __ATTR(freq, 0644, spk_var_show, spk_var_store);
  67 static struct kobj_attribute pitch_attribute =
  68         __ATTR(pitch, 0644, spk_var_show, spk_var_store);
  69 static struct kobj_attribute punct_attribute =
  70         __ATTR(punct, 0644, spk_var_show, spk_var_store);
  71 static struct kobj_attribute rate_attribute =
  72         __ATTR(rate, 0644, spk_var_show, spk_var_store);
  73 static struct kobj_attribute tone_attribute =
  74         __ATTR(tone, 0644, spk_var_show, spk_var_store);
  75 static struct kobj_attribute voice_attribute =
  76         __ATTR(voice, 0644, spk_var_show, spk_var_store);
  77 static struct kobj_attribute vol_attribute =
  78         __ATTR(vol, 0644, spk_var_show, spk_var_store);
  79
  80 /*
  81  * We should uncomment the following definition, when we agree on a
  82  * method of passing a language designation to the software synthesizer.
  83  * static struct kobj_attribute lang_attribute =
  84  *      __ATTR(lang, 0644, spk_var_show, spk_var_store);
  85  */
  86
  87 static struct kobj_attribute delay_time_attribute =
  88         __ATTR(delay_time, 0644, spk_var_show, spk_var_store);
  89 static struct kobj_attribute direct_attribute =
  90         __ATTR(direct, 0644, spk_var_show, spk_var_store);
  91 static struct kobj_attribute full_time_attribute =
  92         __ATTR(full_time, 0644, spk_var_show, spk_var_store);
  93 static struct kobj_attribute jiffy_delta_attribute =
  94         __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
  95 static struct kobj_attribute trigger_time_attribute =
  96         __ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
  97
  98 /*
  99  * Create a group of attributes so that we can create and destroy them all
 100  * at once.
 101  */
 102 static struct attribute *synth_attrs[] = {
 103         &caps_start_attribute.attr,
 104         &caps_stop_attribute.attr,
 105         &freq_attribute.attr,
 106 /*      &lang_attribute.attr, */
 107         &pitch_attribute.attr,
 108         &punct_attribute.attr,
 109         &rate_attribute.attr,
 110         &tone_attribute.attr,
 111         &voice_attribute.attr,
 112         &vol_attribute.attr,
 113         &delay_time_attribute.attr,
 114         &direct_attribute.attr,
 115         &full_time_attribute.attr,
 116         &jiffy_delta_attribute.attr,
 117         &trigger_time_attribute.attr,
 118         NULL,   /* need to NULL terminate the list of attributes */
 119 };
 120
 121 static struct spk_synth synth_soft = {
 122         .name = "soft",
 123         .version = DRV_VERSION,
 124         .long_name = "software synth",
 125         .init = "\01@\x01\x31y\n",
 126         .procspeech = PROCSPEECH,
 127         .delay = 0,
 128         .trigger = 0,
 129         .jiffies = 0,
 130         .full = 0,
 131         .startup = SYNTH_START,
 132         .checkval = SYNTH_CHECK,
 133         .vars = vars,
 134         .io_ops = NULL,
 135         .probe = softsynth_probe,
 136         .release = softsynth_release,
 137         .synth_immediate = NULL,
 138         .catch_up = NULL,
 139         .flush = NULL,
 140         .is_alive = softsynth_is_alive,
 141         .synth_adjust = NULL,
 142         .read_buff_add = NULL,
 143         .get_index = get_index,
 144         .indexing = {
 145                 .command = "\x01%di",
 146                 .lowindex = 1,
 147                 .highindex = 5,
 148                 .currindex = 1,
 149         },
 150         .attributes = {
 151                 .attrs = synth_attrs,
 152                 .name = "soft",
 153         },
 154 };
 155
 156 static char *get_initstring(void)
 157 {
 158         static char buf[40];
 159         char *cp;
 160         struct var_t *var;
 161
 162         memset(buf, 0, sizeof(buf));
 163         cp = buf;
 164         var = synth_soft.vars;
 165         while (var->var_id != MAXVARS) {
 166                 if (var->var_id != CAPS_START && var->var_id != CAPS_STOP &&
 167                     var->var_id != DIRECT)
 168                         cp = cp + sprintf(cp, var->u.n.synth_fmt,
 169                                           var->u.n.value);
 170                 var++;
 171         }
 172         cp = cp + sprintf(cp, "\n");
 173         return buf;
 174 }
 175
 176 static int softsynth_open(struct inode *inode, struct file *fp)
 177 {
 178         unsigned long flags;
 179         /*if ((fp->f_flags & O_ACCMODE) != O_RDONLY) */
 180         /*      return -EPERM; */
 181         spin_lock_irqsave(&speakup_info.spinlock, flags);
 182         if (synth_soft.alive) {
 183                 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 184                 return -EBUSY;
 185         }
 186         synth_soft.alive = 1;
 187         spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 188         return 0;
 189 }
 190
 191 static int softsynth_close(struct inode *inode, struct file *fp)
 192 {
 193         unsigned long flags;
 194
 195         spin_lock_irqsave(&speakup_info.spinlock, flags);
 196         synth_soft.alive = 0;
 197         init_pos = 0;
 198         spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 199         /* Make sure we let applications go before leaving */
 200         speakup_start_ttys();
 201         return 0;
 202 }
 203
 204 static ssize_t softsynthx_read(struct file *fp, char __user *buf, size_t count,
 205                                loff_t *pos, int unicode)
 206 {
 207         int chars_sent = 0;
 208         char __user *cp;
 209         char *init;
 210         size_t bytes_per_ch = unicode ? 3 : 1;
 211         u16 ch;
 212         int empty;
 213         unsigned long flags;
 214         DEFINE_WAIT(wait);
 215
 216         if (count < bytes_per_ch)
 217                 return -EINVAL;
 218
 219         spin_lock_irqsave(&speakup_info.spinlock, flags);
 220         while (1) {
 221                 prepare_to_wait(&speakup_event, &wait, TASK_INTERRUPTIBLE);
 222                 if (!unicode)
 223                         synth_buffer_skip_nonlatin1();
 224                 if (!synth_buffer_empty() || speakup_info.flushing)
 225                         break;
 226                 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 227                 if (fp->f_flags & O_NONBLOCK) {
 228                         finish_wait(&speakup_event, &wait);
 229                         return -EAGAIN;
 230                 }
 231                 if (signal_pending(current)) {
 232                         finish_wait(&speakup_event, &wait);
 233                         return -ERESTARTSYS;
 234                 }
 235                 schedule();
 236                 spin_lock_irqsave(&speakup_info.spinlock, flags);
 237         }
 238         finish_wait(&speakup_event, &wait);
 239
 240         cp = buf;
 241         init = get_initstring();
 242
 243         /* Keep 3 bytes available for a 16bit UTF-8-encoded character */
 244         while (chars_sent <= count - bytes_per_ch) {
 245                 if (speakup_info.flushing) {
 246                         speakup_info.flushing = 0;
 247                         ch = '\x18';
 248                 } else if (init[init_pos]) {
 249                         ch = init[init_pos++];
 250                 } else {
 251                         if (!unicode)
 252                                 synth_buffer_skip_nonlatin1();
 253                         if (synth_buffer_empty())
 254                                 break;
 255                         ch = synth_buffer_getc();
 256                 }
 257                 spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 258
 259                 if ((!unicode && ch < 0x100) || (unicode && ch < 0x80)) {
 260                         u_char c = ch;
 261
 262                         if (copy_to_user(cp, &c, 1))
 263                                 return -EFAULT;
 264
 265                         chars_sent++;
 266                         cp++;
 267                 } else if (unicode && ch < 0x800) {
 268                         u_char s[2] = {
 269                                 0xc0 | (ch >> 6),
 270                                 0x80 | (ch & 0x3f)
 271                         };
 272
 273                         if (copy_to_user(cp, s, sizeof(s)))
 274                                 return -EFAULT;
 275
 276                         chars_sent += sizeof(s);
 277                         cp += sizeof(s);
 278                 } else if (unicode) {
 279                         u_char s[3] = {
 280                                 0xe0 | (ch >> 12),
 281                                 0x80 | ((ch >> 6) & 0x3f),
 282                                 0x80 | (ch & 0x3f)
 283                         };
 284
 285                         if (copy_to_user(cp, s, sizeof(s)))
 286                                 return -EFAULT;
 287
 288                         chars_sent += sizeof(s);
 289                         cp += sizeof(s);
 290                 }
 291
 292                 spin_lock_irqsave(&speakup_info.spinlock, flags);
 293         }
 294         *pos += chars_sent;
 295         empty = synth_buffer_empty();
 296         spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 297         if (empty) {
 298                 speakup_start_ttys();
 299                 *pos = 0;
 300         }
 301         return chars_sent;
 302 }
 303
 304 static ssize_t softsynth_read(struct file *fp, char __user *buf, size_t count,
 305                               loff_t *pos)
 306 {
 307         return softsynthx_read(fp, buf, count, pos, 0);
 308 }
 309
 310 static ssize_t softsynthu_read(struct file *fp, char __user *buf, size_t count,
 311                                loff_t *pos)
 312 {
 313         return softsynthx_read(fp, buf, count, pos, 1);
 314 }
 315
 316 static int last_index;
 317
 318 static ssize_t softsynth_write(struct file *fp, const char __user *buf,
 319                                size_t count, loff_t *pos)
 320 {
 321         unsigned long supplied_index = 0;
 322         int converted;
 323
 324         converted = kstrtoul_from_user(buf, count, 0, &supplied_index);
 325
 326         if (converted < 0)
 327                 return converted;
 328
 329         last_index = supplied_index;
 330         return count;
 331 }
 332
 333 static unsigned int softsynth_poll(struct file *fp, struct poll_table_struct *wait)
 334 {
 335         unsigned long flags;
 336         int ret = 0;
 337
 338         poll_wait(fp, &speakup_event, wait);
 339
 340         spin_lock_irqsave(&speakup_info.spinlock, flags);
 341         if (!synth_buffer_empty() || speakup_info.flushing)
 342                 ret = POLLIN | POLLRDNORM;
 343         spin_unlock_irqrestore(&speakup_info.spinlock, flags);
 344         return ret;
 345 }
 346
 347 static unsigned char get_index(struct spk_synth *synth)
 348 {
 349         int rv;
 350
 351         rv = last_index;
 352         last_index = 0;
 353         return rv;
 354 }
 355
 356 static const struct file_operations softsynth_fops = {
 357         .owner = THIS_MODULE,
 358         .poll = softsynth_poll,
 359         .read = softsynth_read,
 360         .write = softsynth_write,
 361         .open = softsynth_open,
 362         .release = softsynth_close,
 363 };
 364
 365 static const struct file_operations softsynthu_fops = {
 366         .owner = THIS_MODULE,
 367         .poll = softsynth_poll,
 368         .read = softsynthu_read,
 369         .write = softsynth_write,
 370         .open = softsynth_open,
 371         .release = softsynth_close,
 372 };
 373
 374 static int softsynth_probe(struct spk_synth *synth)
 375 {
 376         if (misc_registered != 0)
 377                 return 0;
 378         memset(&synth_device, 0, sizeof(synth_device));
 379         synth_device.minor = SOFTSYNTH_MINOR;
 380         synth_device.name = "softsynth";
 381         synth_device.fops = &softsynth_fops;
 382         if (misc_register(&synth_device)) {
 383                 pr_warn("Couldn't initialize miscdevice /dev/softsynth.\n");
 384                 return -ENODEV;
 385         }
 386
 387         memset(&synthu_device, 0, sizeof(synthu_device));
 388         synthu_device.minor = SOFTSYNTHU_MINOR;
 389         synthu_device.name = "softsynthu";
 390         synthu_device.fops = &softsynthu_fops;
 391         if (misc_register(&synthu_device)) {
 392                 pr_warn("Couldn't initialize miscdevice /dev/softsynth.\n");
 393                 return -ENODEV;
 394         }
 395
 396         misc_registered = 1;
 397         pr_info("initialized device: /dev/softsynth, node (MAJOR 10, MINOR 26)\n");
 398         pr_info("initialized device: /dev/softsynthu, node (MAJOR 10, MINOR 27)\n");
 399         return 0;
 400 }
 401
 402 static void softsynth_release(void)
 403 {
 404         misc_deregister(&synth_device);
 405         misc_deregister(&synthu_device);
 406         misc_registered = 0;
 407         pr_info("unregistered /dev/softsynth\n");
 408         pr_info("unregistered /dev/softsynthu\n");
 409 }
 410
 411 static int softsynth_is_alive(struct spk_synth *synth)
 412 {
 413         if (synth_soft.alive)
 414                 return 1;
 415         return 0;
 416 }
 417
 418 module_param_named(start, synth_soft.startup, short, 0444);
 419
 420 MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
 421
 422 module_spk_synth(synth_soft);
 423
 424 MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
 425 MODULE_DESCRIPTION("Speakup userspace software synthesizer support");
 426 MODULE_LICENSE("GPL");
 427 MODULE_VERSION(DRV_VERSION);