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