GNU Linux-libre 4.14.290-gnu1
[releases.git] / drivers / staging / speakup / speakup_txprt.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  * specificly written as a driver for the speakup screenreview
19  * s not a general device driver.
20  */
21 #include "spk_priv.h"
22 #include "speakup.h"
23
24 #define DRV_VERSION "2.11"
25 #define SYNTH_CLEAR 0x18
26 #define PROCSPEECH '\r' /* process speech char */
27
28 static struct var_t vars[] = {
29         { CAPS_START, .u.s = {"\x05P8" } },
30         { CAPS_STOP, .u.s = {"\x05P5" } },
31         { RATE, .u.n = {"\x05R%d", 5, 0, 9, 0, 0, NULL } },
32         { PITCH, .u.n = {"\x05P%d", 5, 0, 9, 0, 0, NULL } },
33         { VOL, .u.n = {"\x05V%d", 5, 0, 9, 0, 0, NULL } },
34         { TONE, .u.n = {"\x05T%c", 12, 0, 25, 61, 0, NULL } },
35         { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
36         V_LAST_VAR
37          };
38
39 /* These attributes will appear in /sys/accessibility/speakup/txprt. */
40
41 static struct kobj_attribute caps_start_attribute =
42         __ATTR(caps_start, 0644, spk_var_show, spk_var_store);
43 static struct kobj_attribute caps_stop_attribute =
44         __ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
45 static struct kobj_attribute pitch_attribute =
46         __ATTR(pitch, 0644, spk_var_show, spk_var_store);
47 static struct kobj_attribute rate_attribute =
48         __ATTR(rate, 0644, spk_var_show, spk_var_store);
49 static struct kobj_attribute tone_attribute =
50         __ATTR(tone, 0644, spk_var_show, spk_var_store);
51 static struct kobj_attribute vol_attribute =
52         __ATTR(vol, 0644, spk_var_show, spk_var_store);
53
54 static struct kobj_attribute delay_time_attribute =
55         __ATTR(delay_time, 0644, spk_var_show, spk_var_store);
56 static struct kobj_attribute direct_attribute =
57         __ATTR(direct, 0644, spk_var_show, spk_var_store);
58 static struct kobj_attribute full_time_attribute =
59         __ATTR(full_time, 0644, spk_var_show, spk_var_store);
60 static struct kobj_attribute jiffy_delta_attribute =
61         __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
62 static struct kobj_attribute trigger_time_attribute =
63         __ATTR(trigger_time, 0644, spk_var_show, spk_var_store);
64
65 /*
66  * Create a group of attributes so that we can create and destroy them all
67  * at once.
68  */
69 static struct attribute *synth_attrs[] = {
70         &caps_start_attribute.attr,
71         &caps_stop_attribute.attr,
72         &pitch_attribute.attr,
73         &rate_attribute.attr,
74         &tone_attribute.attr,
75         &vol_attribute.attr,
76         &delay_time_attribute.attr,
77         &direct_attribute.attr,
78         &full_time_attribute.attr,
79         &jiffy_delta_attribute.attr,
80         &trigger_time_attribute.attr,
81         NULL,   /* need to NULL terminate the list of attributes */
82 };
83
84 static struct spk_synth synth_txprt = {
85         .name = "txprt",
86         .version = DRV_VERSION,
87         .long_name = "Transport",
88         .init = "\x05N1",
89         .procspeech = PROCSPEECH,
90         .clear = SYNTH_CLEAR,
91         .delay = 500,
92         .trigger = 50,
93         .jiffies = 50,
94         .full = 40000,
95         .dev_name = SYNTH_DEFAULT_DEV,
96         .startup = SYNTH_START,
97         .checkval = SYNTH_CHECK,
98         .vars = vars,
99         .io_ops = &spk_ttyio_ops,
100         .probe = spk_ttyio_synth_probe,
101         .release = spk_ttyio_release,
102         .synth_immediate = spk_ttyio_synth_immediate,
103         .catch_up = spk_do_catch_up,
104         .flush = spk_synth_flush,
105         .is_alive = spk_synth_is_alive_restart,
106         .synth_adjust = NULL,
107         .read_buff_add = NULL,
108         .get_index = NULL,
109         .indexing = {
110                 .command = NULL,
111                 .lowindex = 0,
112                 .highindex = 0,
113                 .currindex = 0,
114         },
115         .attributes = {
116                 .attrs = synth_attrs,
117                 .name = "txprt",
118         },
119 };
120
121 module_param_named(ser, synth_txprt.ser, int, 0444);
122 module_param_named(dev, synth_txprt.dev_name, charp, S_IRUGO);
123 module_param_named(start, synth_txprt.startup, short, 0444);
124
125 MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
126 MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer.");
127 MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
128
129 module_spk_synth(synth_txprt);
130
131 MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
132 MODULE_AUTHOR("David Borowski");
133 MODULE_DESCRIPTION("Speakup support for Transport synthesizers");
134 MODULE_LICENSE("GPL");
135 MODULE_VERSION(DRV_VERSION);
136