Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754166AbdCMWKM (ORCPT ); Mon, 13 Mar 2017 18:10:12 -0400 Received: from mail-wm0-f65.google.com ([74.125.82.65]:34076 "EHLO mail-wm0-f65.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752132AbdCMWJe (ORCPT ); Mon, 13 Mar 2017 18:09:34 -0400 Message-Id: <20170313220929.765452810@gmail.com> User-Agent: quilt/0.63-1 Date: Mon, 13 Mar 2017 22:05:54 +0000 From: okash.khawaja@gmail.com To: Greg Kroah-Hartman , Jiri Slaby , Samuel Thibault , linux-kernel@vger.kernel.org Cc: William Hubbs , Chris Brannon , Kirk Reiser , speakup@linux-speakup.org, devel@driverdev.osuosl.org, Okash Khawaja Subject: [patch 3/7] staging: serial: add spk_io_ops struct to spk_synth References: <20170313220551.312820470@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-15 Content-Disposition: inline; filename=03_add_spk_io_ops Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 14832 Lines: 417 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. Starting with this patch set, an alternative tty-based way of communication is being introduced. 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 tty will mean swapping serial spk_io_ops instance with tty spk_io_ops instance, making the migration simpler. At the moment, this struct only contains one method, synth_out but more will be added in future when incorporating inputs in the tty-based comms. Also at the moment, synth_out method has one implementation which uses serial i/o. Later in this patch set, an alternate tty-based implementation will be added. Signed-off-by: Okash Khawaja Reviewed-by: Samuel Thibault Index: linux-4.10.1/drivers/staging/speakup/serialio.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/serialio.c +++ linux-4.10.1/drivers/staging/speakup/serialio.c @@ -24,6 +24,12 @@ 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; @@ -215,7 +221,6 @@ } return 0; } -EXPORT_SYMBOL_GPL(spk_serial_out); void spk_serial_release(void) { Index: linux-4.10.1/drivers/staging/speakup/speakup_acntpc.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/speakup_acntpc.c +++ linux-4.10.1/drivers/staging/speakup/speakup_acntpc.c @@ -113,6 +113,7 @@ .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = synth_probe, .release = accent_release, .synth_immediate = synth_immediate, Index: linux-4.10.1/drivers/staging/speakup/speakup_acntsa.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/speakup_acntsa.c +++ linux-4.10.1/drivers/staging/speakup/speakup_acntsa.c @@ -99,6 +99,7 @@ .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, Index: linux-4.10.1/drivers/staging/speakup/speakup_apollo.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/speakup_apollo.c +++ linux-4.10.1/drivers/staging/speakup/speakup_apollo.c @@ -108,6 +108,7 @@ .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 @@ 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 @@ 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 @@ 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, S_IRUGO); Index: linux-4.10.1/drivers/staging/speakup/speakup_audptr.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/speakup_audptr.c +++ linux-4.10.1/drivers/staging/speakup/speakup_audptr.c @@ -104,6 +104,7 @@ .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 @@ 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) Index: linux-4.10.1/drivers/staging/speakup/speakup_decext.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/speakup_decext.c +++ linux-4.10.1/drivers/staging/speakup/speakup_decext.c @@ -127,6 +127,7 @@ .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 @@ 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 @@ 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 @@ 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) Index: linux-4.10.1/drivers/staging/speakup/speakup_dectlk.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/speakup_dectlk.c +++ linux-4.10.1/drivers/staging/speakup/speakup_dectlk.c @@ -130,6 +130,7 @@ .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 @@ 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 @@ 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 @@ 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, S_IRUGO); Index: linux-4.10.1/drivers/staging/speakup/spk_priv.h =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/spk_priv.h +++ linux-4.10.1/drivers/staging/speakup/spk_priv.h @@ -45,7 +45,6 @@ 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); @@ -78,4 +77,6 @@ extern struct var_t synth_time_vars[]; +extern struct spk_io_ops spk_serial_io_ops; + #endif Index: linux-4.10.1/drivers/staging/speakup/spk_types.h =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/spk_types.h +++ linux-4.10.1/drivers/staging/speakup/spk_types.h @@ -146,6 +146,12 @@ 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 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, Index: linux-4.10.1/drivers/staging/speakup/synth.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/synth.c +++ linux-4.10.1/drivers/staging/speakup/synth.c @@ -120,7 +120,7 @@ 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 @@ 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 @@ 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 @@ 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); Index: linux-4.10.1/drivers/staging/speakup/speakup_bns.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/speakup_bns.c +++ linux-4.10.1/drivers/staging/speakup/speakup_bns.c @@ -96,6 +96,7 @@ .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, Index: linux-4.10.1/drivers/staging/speakup/speakup_decpc.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/speakup_decpc.c +++ linux-4.10.1/drivers/staging/speakup/speakup_decpc.c @@ -220,6 +220,7 @@ .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = synth_probe, .release = dtpc_release, .synth_immediate = synth_immediate, Index: linux-4.10.1/drivers/staging/speakup/speakup_dtlk.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/speakup_dtlk.c +++ linux-4.10.1/drivers/staging/speakup/speakup_dtlk.c @@ -128,6 +128,7 @@ .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = synth_probe, .release = dtlk_release, .synth_immediate = synth_immediate, Index: linux-4.10.1/drivers/staging/speakup/speakup_dummy.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/speakup_dummy.c +++ linux-4.10.1/drivers/staging/speakup/speakup_dummy.c @@ -98,6 +98,7 @@ .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, Index: linux-4.10.1/drivers/staging/speakup/speakup_keypc.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/speakup_keypc.c +++ linux-4.10.1/drivers/staging/speakup/speakup_keypc.c @@ -105,6 +105,7 @@ .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = &spk_serial_io_ops, .probe = synth_probe, .release = keynote_release, .synth_immediate = synth_immediate, Index: linux-4.10.1/drivers/staging/speakup/speakup_ltlk.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/speakup_ltlk.c +++ linux-4.10.1/drivers/staging/speakup/speakup_ltlk.c @@ -111,6 +111,7 @@ .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, Index: linux-4.10.1/drivers/staging/speakup/speakup_soft.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/speakup_soft.c +++ linux-4.10.1/drivers/staging/speakup/speakup_soft.c @@ -131,6 +131,7 @@ .startup = SYNTH_START, .checkval = SYNTH_CHECK, .vars = vars, + .io_ops = NULL, .probe = softsynth_probe, .release = softsynth_release, .synth_immediate = NULL, Index: linux-4.10.1/drivers/staging/speakup/speakup_spkout.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/speakup_spkout.c +++ linux-4.10.1/drivers/staging/speakup/speakup_spkout.c @@ -102,6 +102,7 @@ .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, Index: linux-4.10.1/drivers/staging/speakup/speakup_txprt.c =================================================================== --- linux-4.10.1.orig/drivers/staging/speakup/speakup_txprt.c +++ linux-4.10.1/drivers/staging/speakup/speakup_txprt.c @@ -95,6 +95,7 @@ .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,