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 | ||
17 | #include <linux/types.h> | |
1da177e4 LT |
18 | |
19 | struct vc_data; | |
20 | struct console_font_op; | |
21 | struct console_font; | |
22 | struct module; | |
1b135431 | 23 | struct tty_struct; |
1da177e4 LT |
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 | ||
d705ff38 JS |
31 | enum con_scroll { |
32 | SM_UP, | |
33 | SM_DOWN, | |
34 | }; | |
35 | ||
97293de9 JS |
36 | /** |
37 | * struct consw - callbacks for consoles | |
38 | * | |
d705ff38 JS |
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. | |
709280da | 42 | * @con_set_palette: sets the palette of the console to @table (optional) |
97293de9 JS |
43 | * @con_scrolldelta: the contents of the console should be scrolled by @lines. |
44 | * Invoked by user. (optional) | |
45 | */ | |
1da177e4 LT |
46 | struct consw { |
47 | struct module *owner; | |
48 | const char *(*con_startup)(void); | |
49 | void (*con_init)(struct vc_data *, int); | |
50 | void (*con_deinit)(struct vc_data *); | |
51 | void (*con_clear)(struct vc_data *, int, int, int, int); | |
52 | void (*con_putc)(struct vc_data *, int, int, int); | |
53 | void (*con_putcs)(struct vc_data *, const unsigned short *, int, int, int); | |
54 | void (*con_cursor)(struct vc_data *, int); | |
d705ff38 JS |
55 | bool (*con_scroll)(struct vc_data *, unsigned int top, |
56 | unsigned int bottom, enum con_scroll dir, | |
57 | unsigned int lines); | |
1da177e4 LT |
58 | int (*con_switch)(struct vc_data *); |
59 | int (*con_blank)(struct vc_data *, int, int); | |
60 | int (*con_font_set)(struct vc_data *, struct console_font *, unsigned); | |
61 | int (*con_font_get)(struct vc_data *, struct console_font *); | |
62 | int (*con_font_default)(struct vc_data *, struct console_font *, char *); | |
63 | int (*con_font_copy)(struct vc_data *, int); | |
e400b6ec AD |
64 | int (*con_resize)(struct vc_data *, unsigned int, unsigned int, |
65 | unsigned int); | |
709280da JS |
66 | void (*con_set_palette)(struct vc_data *, |
67 | const unsigned char *table); | |
97293de9 | 68 | void (*con_scrolldelta)(struct vc_data *, int lines); |
1da177e4 LT |
69 | int (*con_set_origin)(struct vc_data *); |
70 | void (*con_save_screen)(struct vc_data *); | |
fa6ce9ab | 71 | u8 (*con_build_attr)(struct vc_data *, u8, u8, u8, u8, u8, u8); |
1da177e4 LT |
72 | void (*con_invert_region)(struct vc_data *, u16 *, int); |
73 | u16 *(*con_screen_pos)(struct vc_data *, int); | |
74 | unsigned long (*con_getxy)(struct vc_data *, unsigned long, int *, int *); | |
b45cfba4 JB |
75 | /* |
76 | * Prepare the console for the debugger. This includes, but is not | |
77 | * limited to, unblanking the console, loading an appropriate | |
78 | * palette, and allowing debugger generated output. | |
79 | */ | |
80 | int (*con_debug_enter)(struct vc_data *); | |
81 | /* | |
82 | * Restore the console to its pre-debug state as closely as possible. | |
83 | */ | |
84 | int (*con_debug_leave)(struct vc_data *); | |
1da177e4 LT |
85 | }; |
86 | ||
87 | extern const struct consw *conswitchp; | |
88 | ||
89 | extern const struct consw dummy_con; /* dummy console buffer */ | |
90 | extern const struct consw vga_con; /* VGA text console */ | |
91 | extern const struct consw newport_con; /* SGI Newport console */ | |
92 | extern const struct consw prom_con; /* SPARC PROM console */ | |
93 | ||
3e795de7 | 94 | int con_is_bound(const struct consw *csw); |
e93a9a86 | 95 | int do_unregister_con_driver(const struct consw *csw); |
50e244cc | 96 | int do_take_over_console(const struct consw *sw, int first, int last, int deflt); |
1da177e4 | 97 | void give_up_console(const struct consw *sw); |
9261ec1a | 98 | #ifdef CONFIG_HW_CONSOLE |
b45cfba4 JB |
99 | int con_debug_enter(struct vc_data *vc); |
100 | int con_debug_leave(void); | |
9261ec1a | 101 | #else |
f2f0945e AB |
102 | static inline int con_debug_enter(struct vc_data *vc) |
103 | { | |
104 | return 0; | |
105 | } | |
106 | static inline int con_debug_leave(void) | |
107 | { | |
108 | return 0; | |
109 | } | |
9261ec1a | 110 | #endif |
b45cfba4 | 111 | |
1da177e4 LT |
112 | /* cursor */ |
113 | #define CM_DRAW (1) | |
114 | #define CM_ERASE (2) | |
115 | #define CM_MOVE (3) | |
116 | ||
117 | /* | |
118 | * The interface for a console, or any other device that wants to capture | |
119 | * console messages (printer driver?) | |
120 | * | |
121 | * If a console driver is marked CON_BOOT then it will be auto-unregistered | |
122 | * when the first real console is registered. This is for early-printk drivers. | |
123 | */ | |
124 | ||
125 | #define CON_PRINTBUFFER (1) | |
126 | #define CON_CONSDEV (2) /* Last on the command line */ | |
127 | #define CON_ENABLED (4) | |
128 | #define CON_BOOT (8) | |
76a8ad29 | 129 | #define CON_ANYTIME (16) /* Safe to call when cpu is offline */ |
f7511d5f | 130 | #define CON_BRL (32) /* Used for a braille device */ |
6fe29354 | 131 | #define CON_EXTENDED (64) /* Use the extended output format a la /dev/kmsg */ |
1da177e4 | 132 | |
6ae9200f AM |
133 | struct console { |
134 | char name[16]; | |
1da177e4 LT |
135 | void (*write)(struct console *, const char *, unsigned); |
136 | int (*read)(struct console *, char *, unsigned); | |
137 | struct tty_driver *(*device)(struct console *, int *); | |
138 | void (*unblank)(void); | |
139 | int (*setup)(struct console *, char *); | |
c7cef0a8 | 140 | int (*match)(struct console *, char *name, int idx, char *options); |
1da177e4 LT |
141 | short flags; |
142 | short index; | |
143 | int cflag; | |
144 | void *data; | |
145 | struct console *next; | |
146 | }; | |
147 | ||
a75d946f JS |
148 | /* |
149 | * for_each_console() allows you to iterate on each console | |
150 | */ | |
151 | #define for_each_console(con) \ | |
152 | for (con = console_drivers; con != NULL; con = con->next) | |
153 | ||
9e124fe1 | 154 | extern int console_set_on_cmdline; |
d0380e6c | 155 | extern struct console *early_console; |
9e124fe1 | 156 | |
1da177e4 LT |
157 | extern int add_preferred_console(char *name, int idx, char *options); |
158 | extern void register_console(struct console *); | |
159 | extern int unregister_console(struct console *); | |
160 | extern struct console *console_drivers; | |
ac751efa TH |
161 | extern void console_lock(void); |
162 | extern int console_trylock(void); | |
163 | extern void console_unlock(void); | |
1da177e4 LT |
164 | extern void console_conditional_schedule(void); |
165 | extern void console_unblank(void); | |
8d91f8b1 | 166 | extern void console_flush_on_panic(void); |
1da177e4 LT |
167 | extern struct tty_driver *console_device(int *); |
168 | extern void console_stop(struct console *); | |
169 | extern void console_start(struct console *); | |
170 | extern int is_console_locked(void); | |
f7511d5f ST |
171 | extern int braille_register_console(struct console *, int index, |
172 | char *console_options, char *braille_options); | |
173 | extern int braille_unregister_console(struct console *); | |
4f73bc4d | 174 | #ifdef CONFIG_TTY |
fbc92a34 | 175 | extern void console_sysfs_notify(void); |
4f73bc4d JM |
176 | #else |
177 | static inline void console_sysfs_notify(void) | |
178 | { } | |
179 | #endif | |
90ab5ee9 | 180 | extern bool console_suspend_enabled; |
8f4ce8c3 | 181 | |
557240b4 LT |
182 | /* Suspend and resume console messages over PM events */ |
183 | extern void suspend_console(void); | |
184 | extern void resume_console(void); | |
185 | ||
3cb340ec AB |
186 | int mda_console_init(void); |
187 | void prom_con_init(void); | |
188 | ||
4995f8ef KS |
189 | void vcs_make_sysfs(int index); |
190 | void vcs_remove_sysfs(int index); | |
1b135431 | 191 | |
1da177e4 LT |
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 | ||
f453ba04 DA |
205 | #ifdef CONFIG_VGA_CONSOLE |
206 | extern bool vgacon_text_force(void); | |
44debe7a DV |
207 | #else |
208 | static inline bool vgacon_text_force(void) { return false; } | |
f453ba04 DA |
209 | #endif |
210 | ||
1da177e4 | 211 | #endif /* _LINUX_CONSOLE_H */ |