From 1e441594e509c35a222e397d224de17cee103740 Mon Sep 17 00:00:00 2001 From: Okash Khawaja Date: Tue, 14 Mar 2017 13:41:53 +0000 Subject: [PATCH] staging: speakup: add spk_io_ops struct to spk_synth This patch adds spk_io_ops struct which contain those methods whose job is to communicate with synth device. Currently, all comms with external synth device use raw serial i/o. The idea is to group all methods which do the actual communication with external device into this new struct. Then migrating a serial-based synth over to an alternative to raw serial i/o will mean swapping serial spk_io_ops instance with the io_ops instance of the new method, making the migration simpler. At the moment, this struct only contains one method, synth_out but more will be added in future when migrating synths which require input functionality. Also at the moment, synth_out method has one implementation which uses serial i/o. Plan is to add an alternative. Signed-off-by: Okash Khawaja Reviewed-by: Samuel Thibault Signed-off-by: Greg Kroah-Hartman --- drivers/staging/speakup/serialio.c | 7 ++++++- drivers/staging/speakup/speakup_acntpc.c | 1 + drivers/staging/speakup/speakup_acntsa.c | 1 + drivers/staging/speakup/speakup_apollo.c | 7 ++++--- drivers/staging/speakup/speakup_audptr.c | 3 ++- drivers/staging/speakup/speakup_bns.c | 1 + drivers/staging/speakup/speakup_decext.c | 9 +++++---- drivers/staging/speakup/speakup_decpc.c | 1 + drivers/staging/speakup/speakup_dectlk.c | 13 +++++++------ drivers/staging/speakup/speakup_dtlk.c | 1 + drivers/staging/speakup/speakup_dummy.c | 1 + drivers/staging/speakup/speakup_keypc.c | 1 + drivers/staging/speakup/speakup_ltlk.c | 1 + drivers/staging/speakup/speakup_soft.c | 1 + drivers/staging/speakup/speakup_spkout.c | 1 + drivers/staging/speakup/speakup_txprt.c | 1 + drivers/staging/speakup/spk_priv.h | 3 ++- drivers/staging/speakup/spk_types.h | 7 +++++++ drivers/staging/speakup/synth.c | 8 ++++---- 19 files changed, 48 insertions(+), 20 deletions(-) diff --git a/drivers/staging/speakup/serialio.c b/drivers/staging/speakup/serialio.c index f51ab5c25b49..d7736f7a35fe 100644 --- a/drivers/staging/speakup/serialio.c +++ b/drivers/staging/speakup/serialio.c @@ -24,6 +24,12 @@ static const struct old_serial_port rs_table[] = { static const struct old_serial_port *serstate; static int timeouts; +static int spk_serial_out(struct spk_synth *in_synth, const char ch); +struct spk_io_ops spk_serial_io_ops = { + .synth_out = spk_serial_out, +}; +EXPORT_SYMBOL_GPL(spk_serial_io_ops); + const struct old_serial_port *spk_serial_init(int index) { int baud = 9600, quot = 0; @@ -214,7 +220,6 @@ int spk_serial_out(struct spk_synth *in_synth, const char ch) } return 0; } -EXPORT_SYMBOL_GPL(spk_serial_out); void spk_serial_release(void) { diff --git a/drivers/staging/speakup/speakup_acntpc.c b/drivers/staging/speakup/speakup_acntpc.c index 56ece087ff88..81dd0c0917dc 100644 --- a/drivers/staging/speakup/speakup_acntpc.c +++ b/drivers/staging/speakup/speakup_acntpc.c @@ -113,6 +113,7 @@ static struct spk_synth synth_acntpc = { .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = synth_probe, .release = accent_release, .synth_immediate = synth_immediate, diff --git a/drivers/staging/speakup/speakup_acntsa.c b/drivers/staging/speakup/speakup_acntsa.c index b2e352712766..6a66801f9eba 100644 --- a/drivers/staging/speakup/speakup_acntsa.c +++ b/drivers/staging/speakup/speakup_acntsa.c @@ -99,6 +99,7 @@ static struct spk_synth synth_acntsa = { .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = synth_probe, .release = spk_serial_release, .synth_immediate = spk_synth_immediate, diff --git a/drivers/staging/speakup/speakup_apollo.c b/drivers/staging/speakup/speakup_apollo.c index 07149b0b03bb..c78a2ffb13bd 100644 --- a/drivers/staging/speakup/speakup_apollo.c +++ b/drivers/staging/speakup/speakup_apollo.c @@ -108,6 +108,7 @@ static struct spk_synth synth_apollo = { .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = spk_serial_synth_probe, .release = spk_serial_release, .synth_immediate = spk_synth_immediate, @@ -169,7 +170,7 @@ static void do_catch_up(struct spk_synth *synth) set_current_state(TASK_INTERRUPTIBLE); full_time_val = full_time->u.n.value; spin_unlock_irqrestore(&speakup_info.spinlock, flags); - if (!spk_serial_out(synth, ch)) { + if (!synth->io_ops->synth_out(synth, ch)) { outb(UART_MCR_DTR, speakup_info.port_tts + UART_MCR); outb(UART_MCR_DTR | UART_MCR_RTS, speakup_info.port_tts + UART_MCR); @@ -182,7 +183,7 @@ static void do_catch_up(struct spk_synth *synth) full_time_val = full_time->u.n.value; delay_time_val = delay_time->u.n.value; spin_unlock_irqrestore(&speakup_info.spinlock, flags); - if (spk_serial_out(synth, synth->procspeech)) + if (synth->io_ops->synth_out(synth, synth->procspeech)) schedule_timeout(msecs_to_jiffies (delay_time_val)); else @@ -195,7 +196,7 @@ static void do_catch_up(struct spk_synth *synth) synth_buffer_getc(); spin_unlock_irqrestore(&speakup_info.spinlock, flags); } - spk_serial_out(synth, PROCSPEECH); + synth->io_ops->synth_out(synth, PROCSPEECH); } module_param_named(ser, synth_apollo.ser, int, 0444); diff --git a/drivers/staging/speakup/speakup_audptr.c b/drivers/staging/speakup/speakup_audptr.c index 31dcd4ec25c6..76e21f69e769 100644 --- a/drivers/staging/speakup/speakup_audptr.c +++ b/drivers/staging/speakup/speakup_audptr.c @@ -104,6 +104,7 @@ static struct spk_synth synth_audptr = { .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = synth_probe, .release = spk_serial_release, .synth_immediate = spk_synth_immediate, @@ -135,7 +136,7 @@ static void synth_flush(struct spk_synth *synth) udelay(1); } outb(SYNTH_CLEAR, speakup_info.port_tts); - spk_serial_out(synth, PROCSPEECH); + synth->io_ops->synth_out(synth, PROCSPEECH); } static void synth_version(struct spk_synth *synth) diff --git a/drivers/staging/speakup/speakup_bns.c b/drivers/staging/speakup/speakup_bns.c index da158c968e7c..6c46f670fef7 100644 --- a/drivers/staging/speakup/speakup_bns.c +++ b/drivers/staging/speakup/speakup_bns.c @@ -96,6 +96,7 @@ static struct spk_synth synth_bns = { .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = spk_serial_synth_probe, .release = spk_serial_release, .synth_immediate = spk_synth_immediate, diff --git a/drivers/staging/speakup/speakup_decext.c b/drivers/staging/speakup/speakup_decext.c index 8ac833e82580..4cf038457c1a 100644 --- a/drivers/staging/speakup/speakup_decext.c +++ b/drivers/staging/speakup/speakup_decext.c @@ -127,6 +127,7 @@ static struct spk_synth synth_decext = { .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = spk_serial_synth_probe, .release = spk_serial_release, .synth_immediate = spk_synth_immediate, @@ -186,7 +187,7 @@ static void do_catch_up(struct spk_synth *synth) spin_unlock_irqrestore(&speakup_info.spinlock, flags); if (ch == '\n') ch = 0x0D; - if (synth_full() || !spk_serial_out(synth, ch)) { + if (synth_full() || !synth->io_ops->synth_out(synth, ch)) { schedule_timeout(msecs_to_jiffies(delay_time_val)); continue; } @@ -200,10 +201,10 @@ static void do_catch_up(struct spk_synth *synth) in_escape = 0; else if (ch <= SPACE) { if (!in_escape && strchr(",.!?;:", last)) - spk_serial_out(synth, PROCSPEECH); + synth->io_ops->synth_out(synth, PROCSPEECH); if (time_after_eq(jiffies, jiff_max)) { if (!in_escape) - spk_serial_out(synth, PROCSPEECH); + synth->io_ops->synth_out(synth, PROCSPEECH); spin_lock_irqsave(&speakup_info.spinlock, flags); jiffy_delta_val = jiffy_delta->u.n.value; @@ -218,7 +219,7 @@ static void do_catch_up(struct spk_synth *synth) last = ch; } if (!in_escape) - spk_serial_out(synth, PROCSPEECH); + synth->io_ops->synth_out(synth, PROCSPEECH); } static void synth_flush(struct spk_synth *synth) diff --git a/drivers/staging/speakup/speakup_decpc.c b/drivers/staging/speakup/speakup_decpc.c index 4cd9730ee03d..a4c5807b38de 100644 --- a/drivers/staging/speakup/speakup_decpc.c +++ b/drivers/staging/speakup/speakup_decpc.c @@ -218,6 +218,7 @@ static struct spk_synth synth_dec_pc = { .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = synth_probe, .release = dtpc_release, .synth_immediate = synth_immediate, diff --git a/drivers/staging/speakup/speakup_dectlk.c b/drivers/staging/speakup/speakup_dectlk.c index 8cdf197d6800..f36d579015f0 100644 --- a/drivers/staging/speakup/speakup_dectlk.c +++ b/drivers/staging/speakup/speakup_dectlk.c @@ -130,6 +130,7 @@ static struct spk_synth synth_dectlk = { .vars = vars, .default_pitch = ap_defaults, .default_vol = g5_defaults, + .io_ops = &spk_serial_io_ops, .probe = spk_serial_synth_probe, .release = spk_serial_release, .synth_immediate = spk_synth_immediate, @@ -251,7 +252,7 @@ static void do_catch_up(struct spk_synth *synth) spin_unlock_irqrestore(&speakup_info.spinlock, flags); if (ch == '\n') ch = 0x0D; - if (synth_full_val || !spk_serial_out(synth, ch)) { + if (synth_full_val || !synth->io_ops->synth_out(synth, ch)) { schedule_timeout(msecs_to_jiffies(delay_time_val)); continue; } @@ -265,10 +266,10 @@ static void do_catch_up(struct spk_synth *synth) in_escape = 0; else if (ch <= SPACE) { if (!in_escape && strchr(",.!?;:", last)) - spk_serial_out(synth, PROCSPEECH); + synth->io_ops->synth_out(synth, PROCSPEECH); if (time_after_eq(jiffies, jiff_max)) { if (!in_escape) - spk_serial_out(synth, PROCSPEECH); + synth->io_ops->synth_out(synth, PROCSPEECH); spin_lock_irqsave(&speakup_info.spinlock, flags); jiffy_delta_val = jiffy_delta->u.n.value; @@ -283,17 +284,17 @@ static void do_catch_up(struct spk_synth *synth) last = ch; } if (!in_escape) - spk_serial_out(synth, PROCSPEECH); + synth->io_ops->synth_out(synth, PROCSPEECH); } static void synth_flush(struct spk_synth *synth) { if (in_escape) /* if in command output ']' so we don't get an error */ - spk_serial_out(synth, ']'); + synth->io_ops->synth_out(synth, ']'); in_escape = 0; is_flushing = 1; - spk_serial_out(synth, SYNTH_CLEAR); + synth->io_ops->synth_out(synth, SYNTH_CLEAR); } module_param_named(ser, synth_dectlk.ser, int, 0444); diff --git a/drivers/staging/speakup/speakup_dtlk.c b/drivers/staging/speakup/speakup_dtlk.c index de67288beb25..e5a434376d35 100644 --- a/drivers/staging/speakup/speakup_dtlk.c +++ b/drivers/staging/speakup/speakup_dtlk.c @@ -128,6 +128,7 @@ static struct spk_synth synth_dtlk = { .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = synth_probe, .release = dtlk_release, .synth_immediate = synth_immediate, diff --git a/drivers/staging/speakup/speakup_dummy.c b/drivers/staging/speakup/speakup_dummy.c index cb7cef30c124..8d64dd84c079 100644 --- a/drivers/staging/speakup/speakup_dummy.c +++ b/drivers/staging/speakup/speakup_dummy.c @@ -98,6 +98,7 @@ static struct spk_synth synth_dummy = { .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = spk_serial_synth_probe, .release = spk_serial_release, .synth_immediate = spk_synth_immediate, diff --git a/drivers/staging/speakup/speakup_keypc.c b/drivers/staging/speakup/speakup_keypc.c index 7c24e088549c..9eb9352e5db7 100644 --- a/drivers/staging/speakup/speakup_keypc.c +++ b/drivers/staging/speakup/speakup_keypc.c @@ -105,6 +105,7 @@ static struct spk_synth synth_keypc = { .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = synth_probe, .release = keynote_release, .synth_immediate = synth_immediate, diff --git a/drivers/staging/speakup/speakup_ltlk.c b/drivers/staging/speakup/speakup_ltlk.c index 9d22198a0339..ca4c0484a806 100644 --- a/drivers/staging/speakup/speakup_ltlk.c +++ b/drivers/staging/speakup/speakup_ltlk.c @@ -111,6 +111,7 @@ static struct spk_synth synth_ltlk = { .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = synth_probe, .release = spk_serial_release, .synth_immediate = spk_synth_immediate, diff --git a/drivers/staging/speakup/speakup_soft.c b/drivers/staging/speakup/speakup_soft.c index 1f99ce912ab9..e454f5685f70 100644 --- a/drivers/staging/speakup/speakup_soft.c +++ b/drivers/staging/speakup/speakup_soft.c @@ -131,6 +131,7 @@ static struct spk_synth synth_soft = { .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = NULL, .probe = softsynth_probe, .release = softsynth_release, .synth_immediate = NULL, diff --git a/drivers/staging/speakup/speakup_spkout.c b/drivers/staging/speakup/speakup_spkout.c index 143fadabfe6c..8faeca4f050e 100644 --- a/drivers/staging/speakup/speakup_spkout.c +++ b/drivers/staging/speakup/speakup_spkout.c @@ -102,6 +102,7 @@ static struct spk_synth synth_spkout = { .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = spk_serial_synth_probe, .release = spk_serial_release, .synth_immediate = spk_synth_immediate, diff --git a/drivers/staging/speakup/speakup_txprt.c b/drivers/staging/speakup/speakup_txprt.c index aa2f338d15d8..75364c816800 100644 --- a/drivers/staging/speakup/speakup_txprt.c +++ b/drivers/staging/speakup/speakup_txprt.c @@ -95,6 +95,7 @@ static struct spk_synth synth_txprt = { .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = spk_serial_synth_probe, .release = spk_serial_release, .synth_immediate = spk_synth_immediate, diff --git a/drivers/staging/speakup/spk_priv.h b/drivers/staging/speakup/spk_priv.h index 170599c48155..7e12fecf9380 100644 --- a/drivers/staging/speakup/spk_priv.h +++ b/drivers/staging/speakup/spk_priv.h @@ -45,7 +45,6 @@ void spk_stop_serial_interrupt(void); int spk_wait_for_xmitr(struct spk_synth *in_synth); unsigned char spk_serial_in(void); unsigned char spk_serial_in_nowait(void); -int spk_serial_out(struct spk_synth *in_synth, const char ch); void spk_serial_release(void); void synth_buffer_skip_nonlatin1(void); @@ -79,4 +78,6 @@ extern struct speakup_info_t speakup_info; extern struct var_t synth_time_vars[]; +extern struct spk_io_ops spk_serial_io_ops; + #endif diff --git a/drivers/staging/speakup/spk_types.h b/drivers/staging/speakup/spk_types.h index 9541b9e65840..a446064b6c91 100644 --- a/drivers/staging/speakup/spk_types.h +++ b/drivers/staging/speakup/spk_types.h @@ -146,6 +146,12 @@ struct synth_indexing { unsigned char currindex; }; +struct spk_synth; + +struct spk_io_ops { + int (*synth_out)(struct spk_synth *synth, const char ch); +}; + struct spk_synth { const char *name; const char *version; @@ -164,6 +170,7 @@ struct spk_synth { struct var_t *vars; int *default_pitch; int *default_vol; + struct spk_io_ops *io_ops; int (*probe)(struct spk_synth *synth); void (*release)(void); const char *(*synth_immediate)(struct spk_synth *synth, diff --git a/drivers/staging/speakup/synth.c b/drivers/staging/speakup/synth.c index 41967c9e5003..72d4f027e40a 100644 --- a/drivers/staging/speakup/synth.c +++ b/drivers/staging/speakup/synth.c @@ -120,7 +120,7 @@ void spk_do_catch_up(struct spk_synth *synth) spin_unlock_irqrestore(&speakup_info.spinlock, flags); if (ch == '\n') ch = synth->procspeech; - if (!spk_serial_out(synth, ch)) { + if (!synth->io_ops->synth_out(synth, ch)) { schedule_timeout(msecs_to_jiffies(full_time_val)); continue; } @@ -130,7 +130,7 @@ void spk_do_catch_up(struct spk_synth *synth) delay_time_val = delay_time->u.n.value; full_time_val = full_time->u.n.value; spin_unlock_irqrestore(&speakup_info.spinlock, flags); - if (spk_serial_out(synth, synth->procspeech)) + if (synth->io_ops->synth_out(synth, synth->procspeech)) schedule_timeout( msecs_to_jiffies(delay_time_val)); else @@ -143,7 +143,7 @@ void spk_do_catch_up(struct spk_synth *synth) synth_buffer_getc(); spin_unlock_irqrestore(&speakup_info.spinlock, flags); } - spk_serial_out(synth, synth->procspeech); + synth->io_ops->synth_out(synth, synth->procspeech); } EXPORT_SYMBOL_GPL(spk_do_catch_up); @@ -166,7 +166,7 @@ EXPORT_SYMBOL_GPL(spk_synth_immediate); void spk_synth_flush(struct spk_synth *synth) { - spk_serial_out(synth, synth->clear); + synth->io_ops->synth_out(synth, synth->clear); } EXPORT_SYMBOL_GPL(spk_synth_flush); -- 2.30.2