// SPDX-License-Identifier: GPL-2.0+
/*
 * originally written by: Kirk Reiser <kirk@braille.uwo.ca>
 * this version considerably modified by David Borowski, david575@rogers.com
 *
 * Copyright (C) 1998-99  Kirk Reiser.
 * Copyright (C) 2003 David Borowski.
 *
 * specifically written as a driver for the speakup screenreview
 * s not a general device driver.
 */
#include "speakup.h"
#include "spk_priv.h"
#include "speakup_dtlk.h" /* local header file for LiteTalk values */

#define DRV_VERSION "2.11"
#define PROCSPEECH 0x0d

static int synth_probe(struct spk_synth *synth);


enum default_vars_id {
        CAPS_START_ID = 0, CAPS_STOP_ID,
        RATE_ID, PITCH_ID,
        VOL_ID, TONE_ID, PUNCT_ID,
        VOICE_ID, FREQUENCY_ID,
        DIRECT_ID, V_LAST_VAR_ID,
        NB_ID
};


static struct var_t vars[NB_ID] = {
        [CAPS_START_ID] = { CAPS_START, .u.s = {"\x01+35p" } },
        [CAPS_STOP_ID] = { CAPS_STOP, .u.s = {"\x01-35p" } },
        [RATE_ID] = { RATE, .u.n = {"\x01%ds", 8, 0, 9, 0, 0, NULL } },
        [PITCH_ID] = { PITCH, .u.n = {"\x01%dp", 50, 0, 99, 0, 0, NULL } },
        [VOL_ID] = { VOL, .u.n = {"\x01%dv", 5, 0, 9, 0, 0, NULL } },
        [TONE_ID] = { TONE, .u.n = {"\x01%dx", 1, 0, 2, 0, 0, NULL } },
        [PUNCT_ID] = { PUNCT, .u.n = {"\x01%db", 7, 0, 15, 0, 0, NULL } },
        [VOICE_ID] = { VOICE, .u.n = {"\x01%do", 0, 0, 7, 0, 0, NULL } },
        [FREQUENCY_ID] = { FREQUENCY, .u.n = {"\x01%df", 5, 0, 9, 0, 0, NULL } },
        [DIRECT_ID] = { DIRECT, .u.n = {NULL, 0, 0, 1, 0, 0, NULL } },
        V_LAST_VAR
};

/*
 * These attributes will appear in /sys/accessibility/speakup/ltlk.
 */
static struct kobj_attribute caps_start_attribute =
        __ATTR(caps_start, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute caps_stop_attribute =
        __ATTR(caps_stop, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute freq_attribute =
        __ATTR(freq, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute pitch_attribute =
        __ATTR(pitch, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute punct_attribute =
        __ATTR(punct, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute rate_attribute =
        __ATTR(rate, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute tone_attribute =
        __ATTR(tone, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute voice_attribute =
        __ATTR(voice, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute vol_attribute =
        __ATTR(vol, 0644, spk_var_show, spk_var_store);

static struct kobj_attribute delay_time_attribute =
        __ATTR(delay_time, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute direct_attribute =
        __ATTR(direct, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute full_time_attribute =
        __ATTR(full_time, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute jiffy_delta_attribute =
        __ATTR(jiffy_delta, 0644, spk_var_show, spk_var_store);
static struct kobj_attribute trigger_time_attribute =
        __ATTR(trigger_time, 0644, spk_var_show, spk_var_store);

/*
 * Create a group of attributes so that we can create and destroy them all
 * at once.
 */
static struct attribute *synth_attrs[] = {
        &caps_start_attribute.attr,
        &caps_stop_attribute.attr,
        &freq_attribute.attr,
        &pitch_attribute.attr,
        &punct_attribute.attr,
        &rate_attribute.attr,
        &tone_attribute.attr,
        &voice_attribute.attr,
        &vol_attribute.attr,
        &delay_time_attribute.attr,
        &direct_attribute.attr,
        &full_time_attribute.attr,
        &jiffy_delta_attribute.attr,
        &trigger_time_attribute.attr,
        NULL,   /* need to NULL terminate the list of attributes */
};

static struct spk_synth synth_ltlk = {
        .name = "ltlk",
        .version = DRV_VERSION,
        .long_name = "LiteTalk",
        .init = "\01@\x01\x31y\n\0",
        .procspeech = PROCSPEECH,
        .clear = SYNTH_CLEAR,
        .delay = 500,
        .trigger = 50,
        .jiffies = 50,
        .full = 40000,
        .dev_name = SYNTH_DEFAULT_DEV,
        .startup = SYNTH_START,
        .checkval = SYNTH_CHECK,
        .vars = vars,
        .io_ops = &spk_ttyio_ops,
        .probe = synth_probe,
        .release = spk_ttyio_release,
        .synth_immediate = spk_ttyio_synth_immediate,
        .catch_up = spk_do_catch_up,
        .flush = spk_synth_flush,
        .is_alive = spk_synth_is_alive_restart,
        .synth_adjust = NULL,
        .read_buff_add = NULL,
        .get_index = spk_synth_get_index,
        .indexing = {
                .command = "\x01%di",
                .lowindex = 1,
                .highindex = 5,
                .currindex = 1,
        },
        .attributes = {
                .attrs = synth_attrs,
                .name = "ltlk",
        },
};

/* interrogate the LiteTalk and print its settings */
static void synth_interrogate(struct spk_synth *synth)
{
        unsigned char *t, i;
        unsigned char buf[50], rom_v[20];

        synth->synth_immediate(synth, "\x18\x01?");
        for (i = 0; i < 50; i++) {
                buf[i] = synth->io_ops->synth_in(synth);
                if (i > 2 && buf[i] == 0x7f)
                        break;
        }
        t = buf + 2;
        for (i = 0; *t != '\r'; t++) {
                rom_v[i] = *t;
                if (++i >= 19)
                        break;
        }
        rom_v[i] = 0;
        pr_info("%s: ROM version: %s\n", synth->long_name, rom_v);
}

static int synth_probe(struct spk_synth *synth)
{
        int failed = 0;

        failed = spk_ttyio_synth_probe(synth);
        if (failed == 0)
                synth_interrogate(synth);
        synth->alive = !failed;
        return failed;
}

module_param_named(ser, synth_ltlk.ser, int, 0444);
module_param_named(dev, synth_ltlk.dev_name, charp, 0444);
module_param_named(start, synth_ltlk.startup, short, 0444);
module_param_named(rate, vars[RATE_ID].u.n.default_val, int, 0444);
module_param_named(pitch, vars[PITCH_ID].u.n.default_val, int, 0444);
module_param_named(vol, vars[VOL_ID].u.n.default_val, int, 0444);
module_param_named(tone, vars[TONE_ID].u.n.default_val, int, 0444);
module_param_named(punct, vars[PUNCT_ID].u.n.default_val, int, 0444);
module_param_named(voice, vars[VOICE_ID].u.n.default_val, int, 0444);
module_param_named(frequency, vars[FREQUENCY_ID].u.n.default_val, int, 0444);
module_param_named(direct, vars[DIRECT_ID].u.n.default_val, int, 0444);




MODULE_PARM_DESC(ser, "Set the serial port for the synthesizer (0-based).");
MODULE_PARM_DESC(dev, "Set the device e.g. ttyUSB0, for the synthesizer.");
MODULE_PARM_DESC(start, "Start the synthesizer once it is loaded.");
MODULE_PARM_DESC(rate, "Set the rate variable on load.");
MODULE_PARM_DESC(pitch, "Set the pitch variable on load.");
MODULE_PARM_DESC(vol, "Set the vol variable on load.");
MODULE_PARM_DESC(tone, "Set the tone variable on load.");
MODULE_PARM_DESC(punct, "Set the punct variable on load.");
MODULE_PARM_DESC(voice, "Set the voice variable on load.");
MODULE_PARM_DESC(frequency, "Set the frequency variable on load.");
MODULE_PARM_DESC(direct, "Set the direct variable on load.");


module_spk_synth(synth_ltlk);

MODULE_AUTHOR("Kirk Reiser <kirk@braille.uwo.ca>");
MODULE_AUTHOR("David Borowski");
MODULE_DESCRIPTION("Speakup support for DoubleTalk LT/LiteTalk synthesizers");
MODULE_LICENSE("GPL");
MODULE_VERSION(DRV_VERSION);