LXR linux/include/linux/console.h

   1/*
   2 *  linux/include/linux/console.h
   3 *
   4 *  Copyright (C) 1993        Hamish Macdonald
   5 *
   6 * This file is subject to the terms and conditions of the GNU General Public
   7 * License.  See the file COPYING in the main directory of this archive
   8 * for more details.
   9 *
  10 * Changed:
  11 * 10-Mar-94: Arno Griffioen: Conversion for vt100 emulator port from PC LINUX
  12 */
  13
  14#ifndef _LINUX_CONSOLE_H_
  15#define _LINUX_CONSOLE_H_ 1
  16
  17#include <linux/types.h>
  18
  19struct vc_data;
  20struct console_font_op;
  21struct console_font;
  22struct module;
  23struct tty_struct;
  24
  25/*
  26 * this is what the terminal answers to a ESC-Z or csi0c query.
  27 */
  28#define VT100ID "\033[?1;2c"
  29#define VT102ID "\033[?6c"
  30
  31struct consw {
  32        struct module *owner;
  33        const char *(*con_startup)(void);
  34        void    (*con_init)(struct vc_data *, int);
  35        void    (*con_deinit)(struct vc_data *);
  36        void    (*con_clear)(struct vc_data *, int, int, int, int);
  37        void    (*con_putc)(struct vc_data *, int, int, int);
  38        void    (*con_putcs)(struct vc_data *, const unsigned short *, int, int, int);
  39        void    (*con_cursor)(struct vc_data *, int);
  40        int     (*con_scroll)(struct vc_data *, int, int, int, int);
  41        void    (*con_bmove)(struct vc_data *, int, int, int, int, int, int);
  42        int     (*con_switch)(struct vc_data *);
  43        int     (*con_blank)(struct vc_data *, int, int);
  44        int     (*con_font_set)(struct vc_data *, struct console_font *, unsigned);
  45        int     (*con_font_get)(struct vc_data *, struct console_font *);
  46        int     (*con_font_default)(struct vc_data *, struct console_font *, char *);
  47        int     (*con_font_copy)(struct vc_data *, int);
  48        int     (*con_resize)(struct vc_data *, unsigned int, unsigned int,
  49                               unsigned int);
  50        int     (*con_set_palette)(struct vc_data *, unsigned char *);
  51        int     (*con_scrolldelta)(struct vc_data *, int);
  52        int     (*con_set_origin)(struct vc_data *);
  53        void    (*con_save_screen)(struct vc_data *);
  54        u8      (*con_build_attr)(struct vc_data *, u8, u8, u8, u8, u8, u8);
  55        void    (*con_invert_region)(struct vc_data *, u16 *, int);
  56        u16    *(*con_screen_pos)(struct vc_data *, int);
  57        unsigned long (*con_getxy)(struct vc_data *, unsigned long, int *, int *);
  58        /*
  59         * Prepare the console for the debugger.  This includes, but is not
  60         * limited to, unblanking the console, loading an appropriate
  61         * palette, and allowing debugger generated output.
  62         */
  63        int     (*con_debug_enter)(struct vc_data *);
  64        /*
  65         * Restore the console to its pre-debug state as closely as possible.
  66         */
  67        int     (*con_debug_leave)(struct vc_data *);
  68};
  69
  70extern const struct consw *conswitchp;
  71
  72extern const struct consw dummy_con;    /* dummy console buffer */
  73extern const struct consw vga_con;      /* VGA text console */
  74extern const struct consw newport_con;  /* SGI Newport console  */
  75extern const struct consw prom_con;     /* SPARC PROM console */
  76
  77int con_is_bound(const struct consw *csw);
  78int do_unregister_con_driver(const struct consw *csw);
  79int do_take_over_console(const struct consw *sw, int first, int last, int deflt);
  80void give_up_console(const struct consw *sw);
  81#ifdef CONFIG_HW_CONSOLE
  82int con_debug_enter(struct vc_data *vc);
  83int con_debug_leave(void);
  84#else
  85static inline int con_debug_enter(struct vc_data *vc)
  86{
  87        return 0;
  88}
  89static inline int con_debug_leave(void)
  90{
  91        return 0;
  92}
  93#endif
  94
  95/* scroll */
  96#define SM_UP       (1)
  97#define SM_DOWN     (2)
  98
  99/* cursor */
 100#define CM_DRAW     (1)
 101#define CM_ERASE    (2)
 102#define CM_MOVE     (3)
 103
 104/*
 105 * The interface for a console, or any other device that wants to capture
 106 * console messages (printer driver?)
 107 *
 108 * If a console driver is marked CON_BOOT then it will be auto-unregistered
 109 * when the first real console is registered.  This is for early-printk drivers.
 110 */
 111
 112#define CON_PRINTBUFFER (1)
 113#define CON_CONSDEV     (2) /* Last on the command line */
 114#define CON_ENABLED     (4)
 115#define CON_BOOT        (8)
 116#define CON_ANYTIME     (16) /* Safe to call when cpu is offline */
 117#define CON_BRL         (32) /* Used for a braille device */
 118#define CON_EXTENDED    (64) /* Use the extended output format a la /dev/kmsg */
 119
 120struct console {
 121        char    name[16];
 122        void    (*write)(struct console *, const char *, unsigned);
 123        int     (*read)(struct console *, char *, unsigned);
 124        struct tty_driver *(*device)(struct console *, int *);
 125        void    (*unblank)(void);
 126        int     (*setup)(struct console *, char *);
 127        int     (*match)(struct console *, char *name, int idx, char *options);
 128        short   flags;
 129        short   index;
 130        int     cflag;
 131        void    *data;
 132        struct   console *next;
 133};
 134
 135/*
 136 * for_each_console() allows you to iterate on each console
 137 */
 138#define for_each_console(con) \
 139        for (con = console_drivers; con != NULL; con = con->next)
 140
 141extern int console_set_on_cmdline;
 142extern struct console *early_console;
 143
 144extern int add_preferred_console(char *name, int idx, char *options);
 145extern void register_console(struct console *);
 146extern int unregister_console(struct console *);
 147extern struct console *console_drivers;
 148extern void console_lock(void);
 149extern int console_trylock(void);
 150extern void console_unlock(void);
 151extern void console_conditional_schedule(void);
 152extern void console_unblank(void);
 153extern void console_flush_on_panic(void);
 154extern struct tty_driver *console_device(int *);
 155extern void console_stop(struct console *);
 156extern void console_start(struct console *);
 157extern int is_console_locked(void);
 158extern int braille_register_console(struct console *, int index,
 159                char *console_options, char *braille_options);
 160extern int braille_unregister_console(struct console *);
 161#ifdef CONFIG_TTY
 162extern void console_sysfs_notify(void);
 163#else
 164static inline void console_sysfs_notify(void)
 165{ }
 166#endif
 167extern bool console_suspend_enabled;
 168
 169/* Suspend and resume console messages over PM events */
 170extern void suspend_console(void);
 171extern void resume_console(void);
 172
 173int mda_console_init(void);
 174void prom_con_init(void);
 175
 176void vcs_make_sysfs(int index);
 177void vcs_remove_sysfs(int index);
 178
 179/* Some debug stub to catch some of the obvious races in the VT code */
 180#if 1
 181#define WARN_CONSOLE_UNLOCKED() WARN_ON(!is_console_locked() && !oops_in_progress)
 182#else
 183#define WARN_CONSOLE_UNLOCKED()
 184#endif
 185
 186/* VESA Blanking Levels */
 187#define VESA_NO_BLANKING        0
 188#define VESA_VSYNC_SUSPEND      1
 189#define VESA_HSYNC_SUSPEND      2
 190#define VESA_POWERDOWN          3
 191
 192#ifdef CONFIG_VGA_CONSOLE
 193extern bool vgacon_text_force(void);
 194#endif
 195
 196#endif /* _LINUX_CONSOLE_H */
 197