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