875cfb1c8132feb7fcd29d038c596cba133be829
[linux-2.6.git] / include / linux / console.h
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 take_over_console(const struct consw *sw, int first, int last, int deflt);
81 void give_up_console(const struct consw *sw);
82 #ifdef CONFIG_HW_CONSOLE
83 int con_debug_enter(struct vc_data *vc);
84 int con_debug_leave(void);
85 #else
86 #define con_debug_enter(vc) (0)
87 #define con_debug_leave() (0)
88 #endif
89
90 /* scroll */
91 #define SM_UP       (1)
92 #define SM_DOWN     (2)
93
94 /* cursor */
95 #define CM_DRAW     (1)
96 #define CM_ERASE    (2)
97 #define CM_MOVE     (3)
98
99 /*
100  * The interface for a console, or any other device that wants to capture
101  * console messages (printer driver?)
102  *
103  * If a console driver is marked CON_BOOT then it will be auto-unregistered
104  * when the first real console is registered.  This is for early-printk drivers.
105  */
106
107 #define CON_PRINTBUFFER (1)
108 #define CON_CONSDEV     (2) /* Last on the command line */
109 #define CON_ENABLED     (4)
110 #define CON_BOOT        (8)
111 #define CON_ANYTIME     (16) /* Safe to call when cpu is offline */
112 #define CON_BRL         (32) /* Used for a braille device */
113
114 struct console {
115         char    name[16];
116         void    (*write)(struct console *, const char *, unsigned);
117         int     (*read)(struct console *, char *, unsigned);
118         struct tty_driver *(*device)(struct console *, int *);
119         void    (*unblank)(void);
120         int     (*setup)(struct console *, char *);
121         int     (*early_setup)(void);
122         short   flags;
123         short   index;
124         int     cflag;
125         void    *data;
126         struct   console *next;
127 };
128
129 /*
130  * for_each_console() allows you to iterate on each console
131  */
132 #define for_each_console(con) \
133         for (con = console_drivers; con != NULL; con = con->next)
134
135 extern int console_set_on_cmdline;
136
137 extern int add_preferred_console(char *name, int idx, char *options);
138 extern int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options);
139 extern void register_console(struct console *);
140 extern int unregister_console(struct console *);
141 extern struct console *console_drivers;
142 extern void acquire_console_sem(void);
143 extern int try_acquire_console_sem(void);
144 extern void release_console_sem(void);
145 extern void console_conditional_schedule(void);
146 extern void console_unblank(void);
147 extern struct tty_driver *console_device(int *);
148 extern void console_stop(struct console *);
149 extern void console_start(struct console *);
150 extern int is_console_locked(void);
151 extern int braille_register_console(struct console *, int index,
152                 char *console_options, char *braille_options);
153 extern int braille_unregister_console(struct console *);
154
155 extern int console_suspend_enabled;
156
157 /* Suspend and resume console messages over PM events */
158 extern void suspend_console(void);
159 extern void resume_console(void);
160
161 int mda_console_init(void);
162 void prom_con_init(void);
163
164 void vcs_make_sysfs(int index);
165 void vcs_remove_sysfs(int index);
166
167 /* Some debug stub to catch some of the obvious races in the VT code */
168 #if 1
169 #define WARN_CONSOLE_UNLOCKED() WARN_ON(!is_console_locked() && !oops_in_progress)
170 #else
171 #define WARN_CONSOLE_UNLOCKED()
172 #endif
173
174 /* VESA Blanking Levels */
175 #define VESA_NO_BLANKING        0
176 #define VESA_VSYNC_SUSPEND      1
177 #define VESA_HSYNC_SUSPEND      2
178 #define VESA_POWERDOWN          3
179
180 #ifdef CONFIG_VGA_CONSOLE
181 extern bool vgacon_text_force(void);
182 #endif
183
184 #endif /* _LINUX_CONSOLE_H */