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