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