2 * linux/include/linux/console.h
4 * Copyright (C) 1993 Hamish Macdonald
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
11 * 10-Mar-94: Arno Griffioen: Conversion for vt100 emulator port from PC LINUX
14 #ifndef _LINUX_CONSOLE_H_
15 #define _LINUX_CONSOLE_H_ 1
17 #include <linux/types.h>
20 struct console_font_op;
26 * this is what the terminal answers to a ESC-Z or csi0c query.
28 #define VT100ID "\033[?1;2c"
29 #define VT102ID "\033[?6c"
32 * struct consw - callbacks for consoles
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)
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 void (*con_bmove)(struct vc_data *, int, int, int, int, int, int);
49 int (*con_switch)(struct vc_data *);
50 int (*con_blank)(struct vc_data *, int, int);
51 int (*con_font_set)(struct vc_data *, struct console_font *, unsigned);
52 int (*con_font_get)(struct vc_data *, struct console_font *);
53 int (*con_font_default)(struct vc_data *, struct console_font *, char *);
54 int (*con_font_copy)(struct vc_data *, int);
55 int (*con_resize)(struct vc_data *, unsigned int, unsigned int,
57 void (*con_set_palette)(struct vc_data *,
58 const unsigned char *table);
59 void (*con_scrolldelta)(struct vc_data *, int lines);
60 int (*con_set_origin)(struct vc_data *);
61 void (*con_save_screen)(struct vc_data *);
62 u8 (*con_build_attr)(struct vc_data *, u8, u8, u8, u8, u8, u8);
63 void (*con_invert_region)(struct vc_data *, u16 *, int);
64 u16 *(*con_screen_pos)(struct vc_data *, int);
65 unsigned long (*con_getxy)(struct vc_data *, unsigned long, int *, int *);
67 * Prepare the console for the debugger. This includes, but is not
68 * limited to, unblanking the console, loading an appropriate
69 * palette, and allowing debugger generated output.
71 int (*con_debug_enter)(struct vc_data *);
73 * Restore the console to its pre-debug state as closely as possible.
75 int (*con_debug_leave)(struct vc_data *);
78 extern const struct consw *conswitchp;
80 extern const struct consw dummy_con; /* dummy console buffer */
81 extern const struct consw vga_con; /* VGA text console */
82 extern const struct consw newport_con; /* SGI Newport console */
83 extern const struct consw prom_con; /* SPARC PROM console */
85 int con_is_bound(const struct consw *csw);
86 int do_unregister_con_driver(const struct consw *csw);
87 int do_take_over_console(const struct consw *sw, int first, int last, int deflt);
88 void give_up_console(const struct consw *sw);
89 #ifdef CONFIG_HW_CONSOLE
90 int con_debug_enter(struct vc_data *vc);
91 int con_debug_leave(void);
93 static inline int con_debug_enter(struct vc_data *vc)
97 static inline int con_debug_leave(void)
113 * The interface for a console, or any other device that wants to capture
114 * console messages (printer driver?)
116 * If a console driver is marked CON_BOOT then it will be auto-unregistered
117 * when the first real console is registered. This is for early-printk drivers.
120 #define CON_PRINTBUFFER (1)
121 #define CON_CONSDEV (2) /* Last on the command line */
122 #define CON_ENABLED (4)
124 #define CON_ANYTIME (16) /* Safe to call when cpu is offline */
125 #define CON_BRL (32) /* Used for a braille device */
126 #define CON_EXTENDED (64) /* Use the extended output format a la /dev/kmsg */
130 void (*write)(struct console *, const char *, unsigned);
131 int (*read)(struct console *, char *, unsigned);
132 struct tty_driver *(*device)(struct console *, int *);
133 void (*unblank)(void);
134 int (*setup)(struct console *, char *);
135 int (*match)(struct console *, char *name, int idx, char *options);
140 struct console *next;
144 * for_each_console() allows you to iterate on each console
146 #define for_each_console(con) \
147 for (con = console_drivers; con != NULL; con = con->next)
149 extern int console_set_on_cmdline;
150 extern struct console *early_console;
152 extern int add_preferred_console(char *name, int idx, char *options);
153 extern void register_console(struct console *);
154 extern int unregister_console(struct console *);
155 extern struct console *console_drivers;
156 extern void console_lock(void);
157 extern int console_trylock(void);
158 extern void console_unlock(void);
159 extern void console_conditional_schedule(void);
160 extern void console_unblank(void);
161 extern void console_flush_on_panic(void);
162 extern struct tty_driver *console_device(int *);
163 extern void console_stop(struct console *);
164 extern void console_start(struct console *);
165 extern int is_console_locked(void);
166 extern int braille_register_console(struct console *, int index,
167 char *console_options, char *braille_options);
168 extern int braille_unregister_console(struct console *);
170 extern void console_sysfs_notify(void);
172 static inline void console_sysfs_notify(void)
175 extern bool console_suspend_enabled;
177 /* Suspend and resume console messages over PM events */
178 extern void suspend_console(void);
179 extern void resume_console(void);
181 int mda_console_init(void);
182 void prom_con_init(void);
184 void vcs_make_sysfs(int index);
185 void vcs_remove_sysfs(int index);
187 /* Some debug stub to catch some of the obvious races in the VT code */
189 #define WARN_CONSOLE_UNLOCKED() WARN_ON(!is_console_locked() && !oops_in_progress)
191 #define WARN_CONSOLE_UNLOCKED()
194 /* VESA Blanking Levels */
195 #define VESA_NO_BLANKING 0
196 #define VESA_VSYNC_SUSPEND 1
197 #define VESA_HSYNC_SUSPEND 2
198 #define VESA_POWERDOWN 3
200 #ifdef CONFIG_VGA_CONSOLE
201 extern bool vgacon_text_force(void);
203 static inline bool vgacon_text_force(void) { return false; }
206 #endif /* _LINUX_CONSOLE_H */