drivers/staging/speakup/spk_priv.h

   1 /* spk_priv.h
   2    review functions for the speakup screen review package.
   3    originally written by: Kirk Reiser and Andy Berdan.
   4
   5   extensively modified by David Borowski.
   6
   7     Copyright (C) 1998  Kirk Reiser.
   8     Copyright (C) 2003  David Borowski.
   9
  10     This program is free software; you can redistribute it and/or modify
  11     it under the terms of the GNU General Public License as published by
  12     the Free Software Foundation; either version 2 of the License, or
  13     (at your option) any later version.
  14
  15     This program is distributed in the hope that it will be useful,
  16     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18     GNU General Public License for more details.
  19
  20     You should have received a copy of the GNU General Public License
  21     along with this program; if not, write to the Free Software
  22     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23 */
  24 #ifndef _SPEAKUP_PRIVATE_H
  25 #define _SPEAKUP_PRIVATE_H
  26
  27 #include "spk_types.h"
  28 #include "spk_priv_keyinfo.h"
  29
  30 #ifndef pr_warn
  31 #define pr_warn(fmt, arg...) printk(KERN_WARNING fmt, ##arg)
  32 #endif
  33
  34 #define V_LAST_VAR { MAXVARS }
  35 #define SPACE 0x20
  36 #define SYNTH_CHECK 20030716 /* today's date ought to do for check value */
  37 /* synth flags, for odd synths */
  38 #define SF_DEC 1 /* to fiddle puncs in alpha strings so it doesn't spell */
  39 #ifdef MODULE
  40 #define SYNTH_START 1
  41 #else
  42 #define SYNTH_START 0
  43 #endif
  44
  45 #define KT_SPKUP 15
  46
  47 extern struct serial_state *spk_serial_init(int index);
  48 extern void stop_serial_interrupt(void);
  49 extern int wait_for_xmitr(void);
  50 extern unsigned char spk_serial_in(void);
  51 extern unsigned char spk_serial_in_nowait(void);
  52 extern int spk_serial_out(const char ch);
  53 extern void spk_serial_release(void);
  54
  55 extern char synth_buffer_getc(void);
  56 extern char synth_buffer_peek(void);
  57 extern int synth_buffer_empty(void);
  58 extern struct var_t *get_var(enum var_id_t var_id);
  59 extern ssize_t spk_var_show(struct kobject *kobj, struct kobj_attribute *attr,
  60         char *buf);
  61 extern ssize_t spk_var_store(struct kobject *kobj, struct kobj_attribute *attr,
  62         const char *buf, size_t count);
  63
  64 extern int serial_synth_probe(struct spk_synth *synth);
  65 extern const char *spk_synth_immediate(struct spk_synth *synth, const char *buff);
  66 extern void spk_do_catch_up(struct spk_synth *synth);
  67 extern void spk_synth_flush(struct spk_synth *synth);
  68 extern int spk_synth_is_alive_nop(struct spk_synth *synth);
  69 extern int spk_synth_is_alive_restart(struct spk_synth *synth);
  70 extern void synth_printf(const char *buf, ...);
  71 extern int synth_request_region(u_long, u_long);
  72 extern int synth_release_region(u_long, u_long);
  73 extern int synth_add(struct spk_synth *in_synth);
  74 extern void synth_remove(struct spk_synth *in_synth);
  75
  76 extern struct speakup_info_t speakup_info;
  77
  78 extern struct var_t synth_time_vars[];
  79
  80 /* Protect the whole speakup machinery, must be taken at each kernel->speakup
  81  * transition and released at all corresponding speakup->kernel transitions
  82  * (flags must be the same variable between lock/trylock and unlock).
  83  *
  84  * The progression thread only interferes with the speakup machinery through
  85  * the synth buffer, and so only needs to take the lock while tinkering with
  86  * it.
  87  */
  88 /* Speakup needs to disable the keyboard IRQ, hence _irqsave/restore */
  89 #define spk_lock(flags) spin_lock_irqsave(&speakup_info.spinlock, flags)
  90 #define spk_trylock(flags) spin_trylock_irqsave(&speakup_info.spinlock, flags)
  91 #define spk_unlock(flags) spin_unlock_irqrestore(&speakup_info.spinlock, flags)
  92
  93 #endif