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