GNU Linux-libre 4.14.328-gnu1
[releases.git] / drivers / staging / speakup / speakup_acntsa.c
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  * 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 "spk_priv.h"
23 #include "speakup.h"
24 #include "speakup_acnt.h" /* local header file for Accent values */
25
26 #define DRV_VERSION "2.11"
27 #define PROCSPEECH '\r'
28
29 static int synth_probe(struct spk_synth *synth);
30
31 static struct var_t vars[] = {
32         { CAPS_START, .u.s = {"\033P8" } },
33         { CAPS_STOP, .u.s = {"\033P5" } },
34         { RATE, .u.n = {"\033R%c", 9, 0, 17, 0, 0, "0123456789abcdefgh" } },
35         { PITCH, .u.n = {"\033P%d", 5, 0, 9, 0, 0, NULL } },
36         { VOL, .u.n = {"\033A%d", 9, 0, 9, 0, 0, NULL } },
37         { TONE, .u.n = {"\033V%d", 5, 0, 9, 0, 0, NULL } },
38         { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
39         V_LAST_VAR
40 };
41
42 /*
43  * These attributes will appear in /sys/accessibility/speakup/acntsa.
44  */
45 static struct kobj_attribute caps_start_attribute =
46         __ATTR(caps_start, 0644, spk_var_show, spk_var_store);
47 static struct kobj_attribute caps_stop_attribute =
48         __ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
49 static struct kobj_attribute pitch_attribute =
50         __ATTR(pitch, 0644, spk_var_show, spk_var_store);
51 static struct kobj_attribute rate_attribute =
52         __ATTR(rate, 0644, spk_var_show, spk_var_store);
53 static struct kobj_attribute tone_attribute =
54         __ATTR(tone, 0644, spk_var_show, spk_var_store);
55 static struct kobj_attribute vol_attribute =
56         __ATTR(vol, 0644, spk_var_show, spk_var_store);
57
58 static struct kobj_attribute delay_time_attribute =
59         __ATTR(delay_time, 0644, spk_var_show, spk_var_store);
60 static struct kobj_attribute direct_attribute =
61         __ATTR(direct, 0644, spk_var_show, spk_var_store);
62 static struct kobj_attribute full_time_attribute =
63         __ATTR(full_time, 0644, spk_var_show, spk_var_store);
64 static struct kobj_attribute jiffy_delta_attribute =
65         __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
66 static struct kobj_attribute trigger_time_attribute =
67         __ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
68
69 /*
70  * Create a group of attributes so that we can create and destroy them all
71  * at once.
72  */
73 static struct attribute *synth_attrs[] = {
74         &caps_start_attribute.attr,
75         &caps_stop_attribute.attr,
76         &pitch_attribute.attr,
77         &rate_attribute.attr,
78         &tone_attribute.attr,
79         &vol_attribute.attr,
80         &delay_time_attribute.attr,
81         &direct_attribute.attr,
82         &full_time_attribute.attr,
83         &jiffy_delta_attribute.attr,
84         &trigger_time_attribute.attr,
85         NULL,   /* need to NULL terminate the list of attributes */
86 };
87
88 static struct spk_synth synth_acntsa = {
89         .name = "acntsa",
90         .version = DRV_VERSION,
91         .long_name = "Accent-SA",
92         .init = "\033T2\033=M\033Oi\033N1\n",
93         .procspeech = PROCSPEECH,
94         .clear = SYNTH_CLEAR,
95         .delay = 400,
96         .trigger = 50,
97         .jiffies = 30,
98         .full = 40000,
99         .dev_name = SYNTH_DEFAULT_DEV,
100         .startup = SYNTH_START,
101         .checkval = SYNTH_CHECK,
102         .vars = vars,
103         .io_ops = &spk_ttyio_ops,
104         .probe = synth_probe,
105         .release = spk_ttyio_release,
106         .synth_immediate = spk_ttyio_synth_immediate,
107         .catch_up = spk_do_catch_up,
108         .flush = spk_synth_flush,
109         .is_alive = spk_synth_is_alive_restart,
110         .synth_adjust = NULL,
111         .read_buff_add = NULL,
112         .get_index = NULL,
113         .indexing = {
114                 .command = NULL,
115                 .lowindex = 0,
116                 .highindex = 0,
117                 .currindex = 0,
118         },
119         .attributes = {
120                 .attrs = synth_attrs,
121                 .name = "acntsa",
122         },
123 };
124
125 static int synth_probe(struct spk_synth *synth)
126 {
127         int failed;
128
129         failed = spk_ttyio_synth_probe(synth);
130         if (failed == 0) {
131                 synth->synth_immediate(synth, "\033=R\r");
132                 mdelay(100);
133         }
134         synth->alive = !failed;
135         return failed;
136 }
137
138 module_param_named(ser, synth_acntsa.ser, int, 0444);
139 module_param_named(dev, synth_acntsa.dev_name, charp, S_IRUGO);
140 module_param_named(start, synth_acntsa.startup, short, 0444);
141
142 MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
143 MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer.");
144 MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
145
146 module_spk_synth(synth_acntsa);
147
148 MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
149 MODULE_AUTHOR("David Borowski");
150 MODULE_DESCRIPTION("Speakup support for Accent SA synthesizer");
151 MODULE_LICENSE("GPL");
152 MODULE_VERSION(DRV_VERSION);
153