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 struct consw {
32 	struct module *owner;
33 	const char *(*con_startup)(void);
34 	void	(*con_init)(struct vc_data *, int);
35 	void	(*con_deinit)(struct vc_data *);
36 	void	(*con_clear)(struct vc_data *, int, int, int, int);
37 	void	(*con_putc)(struct vc_data *, int, int, int);
38 	void	(*con_putcs)(struct vc_data *, const unsigned short *, int, int, int);
39 	void	(*con_cursor)(struct vc_data *, int);
40 	int	(*con_scroll)(struct vc_data *, int, int, int, int);
41 	void	(*con_bmove)(struct vc_data *, int, int, int, int, int, int);
42 	int	(*con_switch)(struct vc_data *);
43 	int	(*con_blank)(struct vc_data *, int, int);
44 	int	(*con_font_set)(struct vc_data *, struct console_font *, unsigned);
45 	int	(*con_font_get)(struct vc_data *, struct console_font *);
46 	int	(*con_font_default)(struct vc_data *, struct console_font *, char *);
47 	int	(*con_font_copy)(struct vc_data *, int);
48 	int     (*con_resize)(struct vc_data *, unsigned int, unsigned int,
49 			       unsigned int);
50 	int	(*con_set_palette)(struct vc_data *, unsigned char *);
51 	int	(*con_scrolldelta)(struct vc_data *, int);
52 	int	(*con_set_origin)(struct vc_data *);
53 	void	(*con_save_screen)(struct vc_data *);
54 	u8	(*con_build_attr)(struct vc_data *, u8, u8, u8, u8, u8, u8);
55 	void	(*con_invert_region)(struct vc_data *, u16 *, int);
56 	u16    *(*con_screen_pos)(struct vc_data *, int);
57 	unsigned long (*con_getxy)(struct vc_data *, unsigned long, int *, int *);
58 	/*
59 	 * Prepare the console for the debugger.  This includes, but is not
60 	 * limited to, unblanking the console, loading an appropriate
61 	 * palette, and allowing debugger generated output.
62 	 */
63 	int	(*con_debug_enter)(struct vc_data *);
64 	/*
65 	 * Restore the console to its pre-debug state as closely as possible.
66 	 */
67 	int	(*con_debug_leave)(struct vc_data *);
68 };
69 
70 extern const struct consw *conswitchp;
71 
72 extern const struct consw dummy_con;	/* dummy console buffer */
73 extern const struct consw vga_con;	/* VGA text console */
74 extern const struct consw newport_con;	/* SGI Newport console  */
75 extern const struct consw prom_con;	/* SPARC PROM console */
76 
77 int con_is_bound(const struct consw *csw);
78 int register_con_driver(const struct consw *csw, int first, int last);
79 int unregister_con_driver(const struct consw *csw);
80 int do_unregister_con_driver(const struct consw *csw);
81 int take_over_console(const struct consw *sw, int first, int last, int deflt);
82 int do_take_over_console(const struct consw *sw, int first, int last, int deflt);
83 void give_up_console(const struct consw *sw);
84 #ifdef CONFIG_HW_CONSOLE
85 int con_debug_enter(struct vc_data *vc);
86 int con_debug_leave(void);
87 #else
88 #define con_debug_enter(vc) (0)
89 #define con_debug_leave() (0)
90 #endif
91 
92 /* scroll */
93 #define SM_UP       (1)
94 #define SM_DOWN     (2)
95 
96 /* cursor */
97 #define CM_DRAW     (1)
98 #define CM_ERASE    (2)
99 #define CM_MOVE     (3)
100 
101 /*
102  * The interface for a console, or any other device that wants to capture
103  * console messages (printer driver?)
104  *
105  * If a console driver is marked CON_BOOT then it will be auto-unregistered
106  * when the first real console is registered.  This is for early-printk drivers.
107  */
108 
109 #define CON_PRINTBUFFER	(1)
110 #define CON_CONSDEV	(2) /* Last on the command line */
111 #define CON_ENABLED	(4)
112 #define CON_BOOT	(8)
113 #define CON_ANYTIME	(16) /* Safe to call when cpu is offline */
114 #define CON_BRL		(32) /* Used for a braille device */
115 
116 struct console {
117 	char	name[16];
118 	void	(*write)(struct console *, const char *, unsigned);
119 	int	(*read)(struct console *, char *, unsigned);
120 	struct tty_driver *(*device)(struct console *, int *);
121 	void	(*unblank)(void);
122 	int	(*setup)(struct console *, char *);
123 	int	(*early_setup)(void);
124 	short	flags;
125 	short	index;
126 	int	cflag;
127 	void	*data;
128 	struct	 console *next;
129 };
130 
131 /*
132  * for_each_console() allows you to iterate on each console
133  */
134 #define for_each_console(con) \
135 	for (con = console_drivers; con != NULL; con = con->next)
136 
137 extern int console_set_on_cmdline;
138 
139 extern int add_preferred_console(char *name, int idx, char *options);
140 extern int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options);
141 extern void register_console(struct console *);
142 extern int unregister_console(struct console *);
143 extern struct console *console_drivers;
144 extern void console_lock(void);
145 extern int console_trylock(void);
146 extern void console_unlock(void);
147 extern void console_conditional_schedule(void);
148 extern void console_unblank(void);
149 extern struct tty_driver *console_device(int *);
150 extern void console_stop(struct console *);
151 extern void console_start(struct console *);
152 extern int is_console_locked(void);
153 extern int braille_register_console(struct console *, int index,
154 		char *console_options, char *braille_options);
155 extern int braille_unregister_console(struct console *);
156 extern void console_sysfs_notify(void);
157 extern bool console_suspend_enabled;
158 
159 /* Suspend and resume console messages over PM events */
160 extern void suspend_console(void);
161 extern void resume_console(void);
162 
163 int mda_console_init(void);
164 void prom_con_init(void);
165 
166 void vcs_make_sysfs(int index);
167 void vcs_remove_sysfs(int index);
168 
169 /* Some debug stub to catch some of the obvious races in the VT code */
170 #if 1
171 #define WARN_CONSOLE_UNLOCKED()	WARN_ON(!is_console_locked() && !oops_in_progress)
172 #else
173 #define WARN_CONSOLE_UNLOCKED()
174 #endif
175 
176 /* VESA Blanking Levels */
177 #define VESA_NO_BLANKING        0
178 #define VESA_VSYNC_SUSPEND      1
179 #define VESA_HSYNC_SUSPEND      2
180 #define VESA_POWERDOWN          3
181 
182 #ifdef CONFIG_VGA_CONSOLE
183 extern bool vgacon_text_force(void);
184 #endif
185 
186 #endif /* _LINUX_CONSOLE_H */
187