1/* SPDX-License-Identifier: GPL-2.0+ */
2/* spk_priv.h
3 * review functions for the speakup screen review package.
4 * originally written by: Kirk Reiser and Andy Berdan.
5 *
6 * extensively modified by David Borowski.
7 *
8 * Copyright (C) 1998  Kirk Reiser.
9 * Copyright (C) 2003  David Borowski.
10 */
11#ifndef _SPEAKUP_PRIVATE_H
12#define _SPEAKUP_PRIVATE_H
13
14#include <linux/printk.h>
15
16#include "spk_types.h"
17#include "spk_priv_keyinfo.h"
18
19#define V_LAST_VAR { MAXVARS }
20#define SPACE 0x20
21#define SYNTH_CHECK 20030716 /* today's date ought to do for check value */
22/* synth flags, for odd synths */
23#define SF_DEC 1 /* to fiddle puncs in alpha strings so it doesn't spell */
24#ifdef MODULE
25#define SYNTH_START 1
26#else
27#define SYNTH_START 0
28#endif
29
30#define KT_SPKUP 15
31#define SPK_SYNTH_TIMEOUT 100000 /* in micro-seconds */
32#define SYNTH_DEFAULT_DEV "ttyS0"
33#define SYNTH_DEFAULT_SER 0
34
35const struct old_serial_port *spk_serial_init(int index);
36void spk_stop_serial_interrupt(void);
37void spk_serial_release(struct spk_synth *synth);
38void spk_ttyio_release(struct spk_synth *synth);
39void spk_ttyio_register_ldisc(void);
40void spk_ttyio_unregister_ldisc(void);
41
42void synth_buffer_skip_nonlatin1(void);
43u16 synth_buffer_getc(void);
44u16 synth_buffer_peek(void);
45int synth_buffer_empty(void);
46struct var_t *spk_get_var(enum var_id_t var_id);
47ssize_t spk_var_show(struct kobject *kobj, struct kobj_attribute *attr,
48		     char *buf);
49ssize_t spk_var_store(struct kobject *kobj, struct kobj_attribute *attr,
50		      const char *buf, size_t count);
51
52int spk_serial_synth_probe(struct spk_synth *synth);
53int spk_ttyio_synth_probe(struct spk_synth *synth);
54const char *spk_serial_synth_immediate(struct spk_synth *synth,
55				       const char *buff);
56const char *spk_ttyio_synth_immediate(struct spk_synth *synth,
57				      const char *buff);
58void spk_do_catch_up(struct spk_synth *synth);
59void spk_do_catch_up_unicode(struct spk_synth *synth);
60void spk_synth_flush(struct spk_synth *synth);
61unsigned char spk_synth_get_index(struct spk_synth *synth);
62int spk_synth_is_alive_nop(struct spk_synth *synth);
63int spk_synth_is_alive_restart(struct spk_synth *synth);
64__printf(1, 2)
65void synth_printf(const char *buf, ...);
66void synth_putwc(u16 wc);
67void synth_putwc_s(u16 wc);
68void synth_putws(const u16 *buf);
69void synth_putws_s(const u16 *buf);
70int synth_request_region(unsigned long start, unsigned long n);
71int synth_release_region(unsigned long start, unsigned long n);
72int synth_add(struct spk_synth *in_synth);
73void synth_remove(struct spk_synth *in_synth);
74struct spk_synth *synth_current(void);
75
76extern struct speakup_info_t speakup_info;
77
78extern struct var_t synth_time_vars[];
79
80extern struct spk_io_ops spk_serial_io_ops;
81extern struct spk_io_ops spk_ttyio_ops;
82
83#endif
84