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