Staging: Winbond: Fix assorted spacing issues.
[linux-2.6-block.git] / drivers / staging / speakup / speakup_soft.c
CommitLineData
c6e3fd22
WH
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 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 *
21 * this code is specificly written as a driver for the speakup screenreview
22 * package and is not a general device driver. */
23
24#include <linux/unistd.h>
25#include <linux/miscdevice.h> /* for misc_register, and SYNTH_MINOR */
26#include <linux/poll.h> /* for poll_wait() */
27#include <linux/sched.h> /* schedule(), signal_pending(), TASK_INTERRUPTIBLE */
28
29#include "spk_priv.h"
30#include "speakup.h"
31
32#define DRV_VERSION "2.6"
33#define SOFTSYNTH_MINOR 26 /* might as well give it one more than /dev/synth */
34#define PROCSPEECH 0x0d
35#define CLEAR_SYNTH 0x18
36
37static int softsynth_probe(struct spk_synth *synth);
38static void softsynth_release(void);
39static int softsynth_is_alive(struct spk_synth *synth);
40static unsigned char get_index(void);
41
42static struct miscdevice synth_device;
13f1a041 43static int initialized;
c6e3fd22
WH
44static int misc_registered;
45
46static struct var_t vars[] = {
13f1a041
CB
47 { CAPS_START, .u.s = {"\x01+3p" } },
48 { CAPS_STOP, .u.s = {"\x01-3p" } },
49 { RATE, .u.n = {"\x01%ds", 5, 0, 9, 0, 0, NULL } },
50 { PITCH, .u.n = {"\x01%dp", 5, 0, 9, 0, 0, NULL } },
51 { VOL, .u.n = {"\x01%dv", 5, 0, 9, 0, 0, NULL } },
52 { TONE, .u.n = {"\x01%dx", 1, 0, 2, 0, 0, NULL } },
53 { PUNCT, .u.n = {"\x01%db", 0, 0, 2, 0, 0, NULL } },
54 { VOICE, .u.n = {"\x01%do", 0, 0, 7, 0, 0, NULL } },
55 { FREQUENCY, .u.n = {"\x01%df", 5, 0, 9, 0, 0, NULL } },
56 { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
c6e3fd22
WH
57 V_LAST_VAR
58};
59
60/*
61 * These attributes will appear in /sys/accessibility/speakup/soft.
62 */
63static struct kobj_attribute caps_start_attribute =
64 __ATTR(caps_start, USER_RW, spk_var_show, spk_var_store);
65static struct kobj_attribute caps_stop_attribute =
66 __ATTR(caps_stop, USER_RW, spk_var_show, spk_var_store);
67static struct kobj_attribute freq_attribute =
68 __ATTR(freq, USER_RW, spk_var_show, spk_var_store);
c6e3fd22
WH
69static struct kobj_attribute pitch_attribute =
70 __ATTR(pitch, USER_RW, spk_var_show, spk_var_store);
71static struct kobj_attribute punct_attribute =
72 __ATTR(punct, USER_RW, spk_var_show, spk_var_store);
73static struct kobj_attribute rate_attribute =
74 __ATTR(rate, USER_RW, spk_var_show, spk_var_store);
75static struct kobj_attribute tone_attribute =
76 __ATTR(tone, USER_RW, spk_var_show, spk_var_store);
77static struct kobj_attribute voice_attribute =
78 __ATTR(voice, USER_RW, spk_var_show, spk_var_store);
79static struct kobj_attribute vol_attribute =
80 __ATTR(vol, USER_RW, spk_var_show, spk_var_store);
81
13f1a041
CB
82/*
83 * We should uncomment the following definition, when we agree on a
84 * method of passing a language designation to the software synthesizer.
85 * static struct kobj_attribute lang_attribute =
86 * __ATTR(lang, USER_RW, spk_var_show, spk_var_store);
87 */
88
c6e3fd22
WH
89static struct kobj_attribute delay_time_attribute =
90 __ATTR(delay_time, ROOT_W, spk_var_show, spk_var_store);
91static struct kobj_attribute direct_attribute =
92 __ATTR(direct, USER_RW, spk_var_show, spk_var_store);
93static struct kobj_attribute full_time_attribute =
94 __ATTR(full_time, ROOT_W, spk_var_show, spk_var_store);
95static struct kobj_attribute jiffy_delta_attribute =
96 __ATTR(jiffy_delta, ROOT_W, spk_var_show, spk_var_store);
97static struct kobj_attribute trigger_time_attribute =
98 __ATTR(trigger_time, ROOT_W, spk_var_show, spk_var_store);
99
100/*
101 * Create a group of attributes so that we can create and destroy them all
102 * at once.
103 */
104static struct attribute *synth_attrs[] = {
105 &caps_start_attribute.attr,
106 &caps_stop_attribute.attr,
107 &freq_attribute.attr,
13f1a041 108/* &lang_attribute.attr, */
c6e3fd22
WH
109 &pitch_attribute.attr,
110 &punct_attribute.attr,
111 &rate_attribute.attr,
112 &tone_attribute.attr,
113 &voice_attribute.attr,
114 &vol_attribute.attr,
115 &delay_time_attribute.attr,
116 &direct_attribute.attr,
117 &full_time_attribute.attr,
118 &jiffy_delta_attribute.attr,
119 &trigger_time_attribute.attr,
120 NULL, /* need to NULL terminate the list of attributes */
121};
122
123static struct spk_synth synth_soft = {
124 .name = "soft",
125 .version = DRV_VERSION,
126 .long_name = "software synth",
127 .init = "\01@\x01\x31y\n",
128 .procspeech = PROCSPEECH,
129 .delay = 0,
130 .trigger = 0,
131 .jiffies = 0,
132 .full = 0,
133 .startup = SYNTH_START,
134 .checkval = SYNTH_CHECK,
135 .vars = vars,
136 .probe = softsynth_probe,
137 .release = softsynth_release,
138 .synth_immediate = NULL,
139 .catch_up = NULL,
140 .flush = NULL,
141 .is_alive = softsynth_is_alive,
142 .synth_adjust = NULL,
143 .read_buff_add = NULL,
144 .get_index = get_index,
145 .indexing = {
146 .command = "\x01%di",
147 .lowindex = 1,
148 .highindex = 5,
149 .currindex = 1,
150 },
151 .attributes = {
152 .attrs = synth_attrs,
153 .name = "soft",
154 },
155};
156
157static char *get_initstring(void)
158{
159 static char buf[40];
160 char *cp;
161 struct var_t *var;
162
163 memset(buf, 0, sizeof(buf));
164 cp = buf;
165 var = synth_soft.vars;
166 while (var->var_id != MAXVARS) {
167 if (var->var_id != CAPS_START && var->var_id != CAPS_STOP
168 && var->var_id != DIRECT)
13f1a041
CB
169 cp = cp + sprintf(cp, var->u.n.synth_fmt,
170 var->u.n.value);
c6e3fd22
WH
171 var++;
172 }
173 cp = cp + sprintf(cp, "\n");
174 return buf;
175}
176
177static int softsynth_open(struct inode *inode, struct file *fp)
178{
179 unsigned long flags;
180 /*if ((fp->f_flags & O_ACCMODE) != O_RDONLY) */
181 /* return -EPERM; */
182 spk_lock(flags);
183 if (synth_soft.alive) {
184 spk_unlock(flags);
185 return -EBUSY;
186 }
187 synth_soft.alive = 1;
188 spk_unlock(flags);
189 return 0;
190}
191
192static int softsynth_close(struct inode *inode, struct file *fp)
193{
194 unsigned long flags;
195 spk_lock(flags);
196 synth_soft.alive = 0;
197 initialized = 0;
198 spk_unlock(flags);
199 /* Make sure we let applications go before leaving */
200 speakup_start_ttys();
201 return 0;
202}
203
204static ssize_t softsynth_read(struct file *fp, char *buf, size_t count,
205 loff_t *pos)
206{
207 int chars_sent = 0;
208 char *cp;
209 char *init;
210 char ch;
211 int empty;
212 unsigned long flags;
213 DEFINE_WAIT(wait);
214
215 spk_lock(flags);
216 while (1) {
217 prepare_to_wait(&speakup_event, &wait, TASK_INTERRUPTIBLE);
218 if (!synth_buffer_empty() || speakup_info.flushing)
219 break;
220 spk_unlock(flags);
221 if (fp->f_flags & O_NONBLOCK) {
222 finish_wait(&speakup_event, &wait);
223 return -EAGAIN;
224 }
225 if (signal_pending(current)) {
226 finish_wait(&speakup_event, &wait);
227 return -ERESTARTSYS;
228 }
229 schedule();
230 spk_lock(flags);
231 }
232 finish_wait(&speakup_event, &wait);
233
234 cp = buf;
235 init = get_initstring();
236 while (chars_sent < count) {
237 if (speakup_info.flushing) {
238 speakup_info.flushing = 0;
239 ch = '\x18';
240 } else if (synth_buffer_empty()) {
241 break;
13f1a041 242 } else if (!initialized) {
c6e3fd22
WH
243 if (*init) {
244 ch = *init;
245 init++;
246 } else {
247 initialized = 1;
248 }
249 } else {
250 ch = synth_buffer_getc();
251 }
252 spk_unlock(flags);
253 if (copy_to_user(cp, &ch, 1))
254 return -EFAULT;
255 spk_lock(flags);
256 chars_sent++;
257 cp++;
258 }
259 *pos += chars_sent;
260 empty = synth_buffer_empty();
261 spk_unlock(flags);
262 if (empty) {
263 speakup_start_ttys();
264 *pos = 0;
265 }
266 return chars_sent;
267}
268
13f1a041 269static int last_index;
c6e3fd22
WH
270
271static ssize_t softsynth_write(struct file *fp, const char *buf, size_t count,
272 loff_t *pos)
273{
13f1a041
CB
274 unsigned long supplied_index = 0;
275 int converted;
c6e3fd22
WH
276 char indbuf[5];
277 if (count >= sizeof(indbuf))
278 return -EINVAL;
279
280 if (copy_from_user(indbuf, buf, count))
281 return -EFAULT;
13f1a041
CB
282 indbuf[count] = '\0';
283
284 converted = strict_strtoul(indbuf, 0, &supplied_index);
285
286 if (converted < 0)
287 return converted;
c6e3fd22 288
13f1a041 289 last_index = supplied_index;
c6e3fd22
WH
290 return count;
291}
292
293static unsigned int softsynth_poll(struct file *fp,
294 struct poll_table_struct *wait)
295{
296 unsigned long flags;
297 int ret = 0;
298 poll_wait(fp, &speakup_event, wait);
299
300 spk_lock(flags);
13f1a041 301 if (!synth_buffer_empty() || speakup_info.flushing)
c6e3fd22
WH
302 ret = POLLIN | POLLRDNORM;
303 spk_unlock(flags);
304 return ret;
305}
306
307static unsigned char get_index(void)
308{
309 int rv;
310 rv = last_index;
311 last_index = 0;
312 return rv;
313}
314
13f1a041 315static const struct file_operations softsynth_fops = {
c6e3fd22
WH
316 .owner = THIS_MODULE,
317 .poll = softsynth_poll,
318 .read = softsynth_read,
319 .write = softsynth_write,
320 .open = softsynth_open,
321 .release = softsynth_close,
322};
323
324
325static int softsynth_probe(struct spk_synth *synth)
326{
327
328 if (misc_registered != 0)
329 return 0;
330 memset(&synth_device, 0, sizeof(synth_device));
331 synth_device.minor = SOFTSYNTH_MINOR;
332 synth_device.name = "softsynth";
333 synth_device.fops = &softsynth_fops;
334 if (misc_register(&synth_device)) {
335 pr_warn("Couldn't initialize miscdevice /dev/softsynth.\n");
336 return -ENODEV;
337 }
338
339 misc_registered = 1;
340 pr_info("initialized device: /dev/softsynth, node (MAJOR 10, MINOR 26)\n");
341 return 0;
342}
343
344static void softsynth_release(void)
345{
346 misc_deregister(&synth_device);
347 misc_registered = 0;
348 pr_info("unregistered /dev/softsynth\n");
349}
350
351static int softsynth_is_alive(struct spk_synth *synth)
352{
353 if (synth_soft.alive)
354 return 1;
355 return 0;
356}
357
358module_param_named(start, synth_soft.startup, short, S_IRUGO);
359
360MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
361
362
363static int __init soft_init(void)
364{
365 return synth_add(&synth_soft);
366}
367
368static void __exit soft_exit(void)
369{
370 synth_remove(&synth_soft);
371}
372
373module_init(soft_init);
374module_exit(soft_exit);
375MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
376MODULE_DESCRIPTION("Speakup userspace software synthesizer support");
377MODULE_LICENSE("GPL");
378MODULE_VERSION(DRV_VERSION);
379