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/atomic.h>
  18 #include <linux/types.h>
  19
  20 struct vc_data;
  21 struct console_font_op;
  22 struct console_font;
  23 struct module;
  24 struct tty_struct;
  25 struct notifier_block;
  26
  27 /*
  28  * this is what the terminal answers to a ESC-Z or csi0c query.
  29  */
  30 #define VT100ID "\033[?1;2c"
  31 #define VT102ID "\033[?6c"
  32
  33 enum con_scroll {
  34         SM_UP,
  35         SM_DOWN,
  36 };
  37
  38 /**
  39  * struct consw - callbacks for consoles
  40  *
  41  * @con_scroll: move lines from @top to @bottom in direction @dir by @lines.
  42  *              Return true if no generic handling should be done.
  43  *              Invoked by csi_M and printing to the console.
  44  * @con_set_palette: sets the palette of the console to @table (optional)
  45  * @con_scrolldelta: the contents of the console should be scrolled by @lines.
  46  *                   Invoked by user. (optional)
  47  */
  48 struct consw {
  49         struct module *owner;
  50         const char *(*con_startup)(void);
  51         void    (*con_init)(struct vc_data *vc, int init);
  52         void    (*con_deinit)(struct vc_data *vc);
  53         void    (*con_clear)(struct vc_data *vc, int sy, int sx, int height,
  54                         int width);
  55         void    (*con_putc)(struct vc_data *vc, int c, int ypos, int xpos);
  56         void    (*con_putcs)(struct vc_data *vc, const unsigned short *s,
  57                         int count, int ypos, int xpos);
  58         void    (*con_cursor)(struct vc_data *vc, int mode);
  59         bool    (*con_scroll)(struct vc_data *vc, unsigned int top,
  60                         unsigned int bottom, enum con_scroll dir,
  61                         unsigned int lines);
  62         int     (*con_switch)(struct vc_data *vc);
  63         int     (*con_blank)(struct vc_data *vc, int blank, int mode_switch);
  64         int     (*con_font_set)(struct vc_data *vc, struct console_font *font,
  65                         unsigned int flags);
  66         int     (*con_font_get)(struct vc_data *vc, struct console_font *font);
  67         int     (*con_font_default)(struct vc_data *vc,
  68                         struct console_font *font, char *name);
  69         int     (*con_font_copy)(struct vc_data *vc, int con);
  70         int     (*con_resize)(struct vc_data *vc, unsigned int width,
  71                         unsigned int height, unsigned int user);
  72         void    (*con_set_palette)(struct vc_data *vc,
  73                         const unsigned char *table);
  74         void    (*con_scrolldelta)(struct vc_data *vc, int lines);
  75         int     (*con_set_origin)(struct vc_data *vc);
  76         void    (*con_save_screen)(struct vc_data *vc);
  77         u8      (*con_build_attr)(struct vc_data *vc, u8 color, u8 intensity,
  78                         u8 blink, u8 underline, u8 reverse, u8 italic);
  79         void    (*con_invert_region)(struct vc_data *vc, u16 *p, int count);
  80         u16    *(*con_screen_pos)(struct vc_data *vc, int offset);
  81         unsigned long (*con_getxy)(struct vc_data *vc, unsigned long position,
  82                         int *px, int *py);
  83         /*
  84          * Flush the video console driver's scrollback buffer
  85          */
  86         void    (*con_flush_scrollback)(struct vc_data *vc);
  87         /*
  88          * Prepare the console for the debugger.  This includes, but is not
  89          * limited to, unblanking the console, loading an appropriate
  90          * palette, and allowing debugger generated output.
  91          */
  92         int     (*con_debug_enter)(struct vc_data *vc);
  93         /*
  94          * Restore the console to its pre-debug state as closely as possible.
  95          */
  96         int     (*con_debug_leave)(struct vc_data *vc);
  97 };
  98
  99 extern const struct consw *conswitchp;
 100
 101 extern const struct consw dummy_con;    /* dummy console buffer */
 102 extern const struct consw vga_con;      /* VGA text console */
 103 extern const struct consw newport_con;  /* SGI Newport console  */
 104
 105 int con_is_bound(const struct consw *csw);
 106 int do_unregister_con_driver(const struct consw *csw);
 107 int do_take_over_console(const struct consw *sw, int first, int last, int deflt);
 108 void give_up_console(const struct consw *sw);
 109 #ifdef CONFIG_HW_CONSOLE
 110 int con_debug_enter(struct vc_data *vc);
 111 int con_debug_leave(void);
 112 #else
 113 static inline int con_debug_enter(struct vc_data *vc)
 114 {
 115         return 0;
 116 }
 117 static inline int con_debug_leave(void)
 118 {
 119         return 0;
 120 }
 121 #endif
 122
 123 /* cursor */
 124 #define CM_DRAW     (1)
 125 #define CM_ERASE    (2)
 126 #define CM_MOVE     (3)
 127
 128 /*
 129  * The interface for a console, or any other device that wants to capture
 130  * console messages (printer driver?)
 131  *
 132  * If a console driver is marked CON_BOOT then it will be auto-unregistered
 133  * when the first real console is registered.  This is for early-printk drivers.
 134  */
 135
 136 #define CON_PRINTBUFFER (1)
 137 #define CON_CONSDEV     (2) /* Last on the command line */
 138 #define CON_ENABLED     (4)
 139 #define CON_BOOT        (8)
 140 #define CON_ANYTIME     (16) /* Safe to call when cpu is offline */
 141 #define CON_BRL         (32) /* Used for a braille device */
 142 #define CON_EXTENDED    (64) /* Use the extended output format a la /dev/kmsg */
 143
 144 struct console {
 145         char    name[16];
 146         void    (*write)(struct console *, const char *, unsigned);
 147         int     (*read)(struct console *, char *, unsigned);
 148         struct tty_driver *(*device)(struct console *, int *);
 149         void    (*unblank)(void);
 150         int     (*setup)(struct console *, char *);
 151         int     (*match)(struct console *, char *name, int idx, char *options);
 152         short   flags;
 153         short   index;
 154         int     cflag;
 155         void    *data;
 156         struct   console *next;
 157 };
 158
 159 /*
 160  * for_each_console() allows you to iterate on each console
 161  */
 162 #define for_each_console(con) \
 163         for (con = console_drivers; con != NULL; con = con->next)
 164
 165 extern int console_set_on_cmdline;
 166 extern struct console *early_console;
 167
 168 enum con_flush_mode {
 169         CONSOLE_FLUSH_PENDING,
 170         CONSOLE_REPLAY_ALL,
 171 };
 172
 173 extern int add_preferred_console(char *name, int idx, char *options);
 174 extern void register_console(struct console *);
 175 extern int unregister_console(struct console *);
 176 extern struct console *console_drivers;
 177 extern void console_lock(void);
 178 extern int console_trylock(void);
 179 extern void console_unlock(void);
 180 extern void console_conditional_schedule(void);
 181 extern void console_unblank(void);
 182 extern void console_flush_on_panic(enum con_flush_mode mode);
 183 extern struct tty_driver *console_device(int *);
 184 extern void console_stop(struct console *);
 185 extern void console_start(struct console *);
 186 extern int is_console_locked(void);
 187 extern int braille_register_console(struct console *, int index,
 188                 char *console_options, char *braille_options);
 189 extern int braille_unregister_console(struct console *);
 190 #ifdef CONFIG_TTY
 191 extern void console_sysfs_notify(void);
 192 #else
 193 static inline void console_sysfs_notify(void)
 194 { }
 195 #endif
 196 extern bool console_suspend_enabled;
 197
 198 /* Suspend and resume console messages over PM events */
 199 extern void suspend_console(void);
 200 extern void resume_console(void);
 201
 202 int mda_console_init(void);
 203
 204 void vcs_make_sysfs(int index);
 205 void vcs_remove_sysfs(int index);
 206
 207 /* Some debug stub to catch some of the obvious races in the VT code */
 208 #define WARN_CONSOLE_UNLOCKED()                                         \
 209         WARN_ON(!atomic_read(&ignore_console_lock_warning) &&           \
 210                 !is_console_locked() && !oops_in_progress)
 211 /*
 212  * Increment ignore_console_lock_warning if you need to quiet
 213  * WARN_CONSOLE_UNLOCKED() for debugging purposes.
 214  */
 215 extern atomic_t ignore_console_lock_warning;
 216
 217 /* VESA Blanking Levels */
 218 #define VESA_NO_BLANKING        0
 219 #define VESA_VSYNC_SUSPEND      1
 220 #define VESA_HSYNC_SUSPEND      2
 221 #define VESA_POWERDOWN          3
 222
 223 #ifdef CONFIG_VGA_CONSOLE
 224 extern bool vgacon_text_force(void);
 225 #else
 226 static inline bool vgacon_text_force(void) { return false; }
 227 #endif
 228
 229 extern void console_init(void);
 230
 231 /* For deferred console takeover */
 232 void dummycon_register_output_notifier(struct notifier_block *nb);
 233 void dummycon_unregister_output_notifier(struct notifier_block *nb);
 234
 235 #endif /* _LINUX_CONSOLE_H */