Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | ||
56e6c104 | 17 | #include <linux/atomic.h> |
1da177e4 | 18 | #include <linux/types.h> |
1da177e4 LT |
19 | |
20 | struct vc_data; | |
21 | struct console_font_op; | |
22 | struct console_font; | |
23 | struct module; | |
1b135431 | 24 | struct tty_struct; |
83d83beb | 25 | struct notifier_block; |
1da177e4 | 26 | |
d705ff38 JS |
27 | enum con_scroll { |
28 | SM_UP, | |
29 | SM_DOWN, | |
30 | }; | |
31 | ||
b84ae3dc JS |
32 | enum vc_intensity; |
33 | ||
97293de9 JS |
34 | /** |
35 | * struct consw - callbacks for consoles | |
36 | * | |
d705ff38 JS |
37 | * @con_scroll: move lines from @top to @bottom in direction @dir by @lines. |
38 | * Return true if no generic handling should be done. | |
39 | * Invoked by csi_M and printing to the console. | |
709280da | 40 | * @con_set_palette: sets the palette of the console to @table (optional) |
97293de9 JS |
41 | * @con_scrolldelta: the contents of the console should be scrolled by @lines. |
42 | * Invoked by user. (optional) | |
43 | */ | |
1da177e4 LT |
44 | struct consw { |
45 | struct module *owner; | |
46 | const char *(*con_startup)(void); | |
209f668c KC |
47 | void (*con_init)(struct vc_data *vc, int init); |
48 | void (*con_deinit)(struct vc_data *vc); | |
49 | void (*con_clear)(struct vc_data *vc, int sy, int sx, int height, | |
50 | int width); | |
51 | void (*con_putc)(struct vc_data *vc, int c, int ypos, int xpos); | |
52 | void (*con_putcs)(struct vc_data *vc, const unsigned short *s, | |
53 | int count, int ypos, int xpos); | |
54 | void (*con_cursor)(struct vc_data *vc, int mode); | |
55 | bool (*con_scroll)(struct vc_data *vc, unsigned int top, | |
d705ff38 JS |
56 | unsigned int bottom, enum con_scroll dir, |
57 | unsigned int lines); | |
209f668c KC |
58 | int (*con_switch)(struct vc_data *vc); |
59 | int (*con_blank)(struct vc_data *vc, int blank, int mode_switch); | |
60 | int (*con_font_set)(struct vc_data *vc, struct console_font *font, | |
61 | unsigned int flags); | |
62 | int (*con_font_get)(struct vc_data *vc, struct console_font *font); | |
63 | int (*con_font_default)(struct vc_data *vc, | |
64 | struct console_font *font, char *name); | |
65 | int (*con_font_copy)(struct vc_data *vc, int con); | |
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, | |
709280da | 69 | const unsigned char *table); |
209f668c KC |
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); | |
b84ae3dc JS |
73 | u8 (*con_build_attr)(struct vc_data *vc, u8 color, |
74 | enum vc_intensity intensity, | |
77bc14f2 | 75 | bool blink, bool underline, bool reverse, bool italic); |
209f668c KC |
76 | void (*con_invert_region)(struct vc_data *vc, u16 *p, int count); |
77 | u16 *(*con_screen_pos)(struct vc_data *vc, int offset); | |
78 | unsigned long (*con_getxy)(struct vc_data *vc, unsigned long position, | |
79 | int *px, int *py); | |
bcd375f7 MS |
80 | /* |
81 | * Flush the video console driver's scrollback buffer | |
82 | */ | |
209f668c | 83 | void (*con_flush_scrollback)(struct vc_data *vc); |
b45cfba4 JB |
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 | */ | |
209f668c | 89 | int (*con_debug_enter)(struct vc_data *vc); |
b45cfba4 JB |
90 | /* |
91 | * Restore the console to its pre-debug state as closely as possible. | |
92 | */ | |
209f668c | 93 | int (*con_debug_leave)(struct vc_data *vc); |
1da177e4 LT |
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 */ | |
1da177e4 | 101 | |
3e795de7 | 102 | int con_is_bound(const struct consw *csw); |
e93a9a86 | 103 | int do_unregister_con_driver(const struct consw *csw); |
50e244cc | 104 | int do_take_over_console(const struct consw *sw, int first, int last, int deflt); |
1da177e4 | 105 | void give_up_console(const struct consw *sw); |
9261ec1a | 106 | #ifdef CONFIG_HW_CONSOLE |
b45cfba4 JB |
107 | int con_debug_enter(struct vc_data *vc); |
108 | int con_debug_leave(void); | |
9261ec1a | 109 | #else |
f2f0945e AB |
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 | } | |
9261ec1a | 118 | #endif |
b45cfba4 | 119 | |
1da177e4 LT |
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) | |
33225d7b | 134 | #define CON_CONSDEV (2) /* Preferred console, /dev/console */ |
1da177e4 LT |
135 | #define CON_ENABLED (4) |
136 | #define CON_BOOT (8) | |
76a8ad29 | 137 | #define CON_ANYTIME (16) /* Safe to call when cpu is offline */ |
f7511d5f | 138 | #define CON_BRL (32) /* Used for a braille device */ |
6fe29354 | 139 | #define CON_EXTENDED (64) /* Use the extended output format a la /dev/kmsg */ |
1da177e4 | 140 | |
6ae9200f AM |
141 | struct console { |
142 | char name[16]; | |
1da177e4 LT |
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 *); | |
ed31685c | 148 | int (*exit)(struct console *); |
c7cef0a8 | 149 | int (*match)(struct console *, char *name, int idx, char *options); |
1da177e4 LT |
150 | short flags; |
151 | short index; | |
152 | int cflag; | |
153 | void *data; | |
154 | struct console *next; | |
155 | }; | |
156 | ||
a75d946f JS |
157 | /* |
158 | * for_each_console() allows you to iterate on each console | |
159 | */ | |
160 | #define for_each_console(con) \ | |
161 | for (con = console_drivers; con != NULL; con = con->next) | |
162 | ||
9e124fe1 | 163 | extern int console_set_on_cmdline; |
d0380e6c | 164 | extern struct console *early_console; |
9e124fe1 | 165 | |
de6da1e8 FT |
166 | enum con_flush_mode { |
167 | CONSOLE_FLUSH_PENDING, | |
168 | CONSOLE_REPLAY_ALL, | |
169 | }; | |
170 | ||
1da177e4 LT |
171 | extern int add_preferred_console(char *name, int idx, char *options); |
172 | extern void register_console(struct console *); | |
173 | extern int unregister_console(struct console *); | |
174 | extern struct console *console_drivers; | |
ac751efa TH |
175 | extern void console_lock(void); |
176 | extern int console_trylock(void); | |
177 | extern void console_unlock(void); | |
1da177e4 LT |
178 | extern void console_conditional_schedule(void); |
179 | extern void console_unblank(void); | |
de6da1e8 | 180 | extern void console_flush_on_panic(enum con_flush_mode mode); |
1da177e4 LT |
181 | extern struct tty_driver *console_device(int *); |
182 | extern void console_stop(struct console *); | |
183 | extern void console_start(struct console *); | |
184 | extern int is_console_locked(void); | |
f7511d5f ST |
185 | extern int braille_register_console(struct console *, int index, |
186 | char *console_options, char *braille_options); | |
187 | extern int braille_unregister_console(struct console *); | |
4f73bc4d | 188 | #ifdef CONFIG_TTY |
fbc92a34 | 189 | extern void console_sysfs_notify(void); |
4f73bc4d JM |
190 | #else |
191 | static inline void console_sysfs_notify(void) | |
192 | { } | |
193 | #endif | |
90ab5ee9 | 194 | extern bool console_suspend_enabled; |
8f4ce8c3 | 195 | |
557240b4 LT |
196 | /* Suspend and resume console messages over PM events */ |
197 | extern void suspend_console(void); | |
198 | extern void resume_console(void); | |
199 | ||
3cb340ec | 200 | int mda_console_init(void); |
3cb340ec | 201 | |
4995f8ef KS |
202 | void vcs_make_sysfs(int index); |
203 | void vcs_remove_sysfs(int index); | |
1b135431 | 204 | |
1da177e4 | 205 | /* Some debug stub to catch some of the obvious races in the VT code */ |
56e6c104 TZ |
206 | #define WARN_CONSOLE_UNLOCKED() \ |
207 | WARN_ON(!atomic_read(&ignore_console_lock_warning) && \ | |
208 | !is_console_locked() && !oops_in_progress) | |
209 | /* | |
210 | * Increment ignore_console_lock_warning if you need to quiet | |
211 | * WARN_CONSOLE_UNLOCKED() for debugging purposes. | |
212 | */ | |
213 | extern atomic_t ignore_console_lock_warning; | |
1da177e4 LT |
214 | |
215 | /* VESA Blanking Levels */ | |
216 | #define VESA_NO_BLANKING 0 | |
217 | #define VESA_VSYNC_SUSPEND 1 | |
218 | #define VESA_HSYNC_SUSPEND 2 | |
219 | #define VESA_POWERDOWN 3 | |
220 | ||
f453ba04 DA |
221 | #ifdef CONFIG_VGA_CONSOLE |
222 | extern bool vgacon_text_force(void); | |
44debe7a DV |
223 | #else |
224 | static inline bool vgacon_text_force(void) { return false; } | |
f453ba04 DA |
225 | #endif |
226 | ||
0c688614 NP |
227 | extern void console_init(void); |
228 | ||
83d83beb HG |
229 | /* For deferred console takeover */ |
230 | void dummycon_register_output_notifier(struct notifier_block *nb); | |
231 | void dummycon_unregister_output_notifier(struct notifier_block *nb); | |
232 | ||
1da177e4 | 233 | #endif /* _LINUX_CONSOLE_H */ |