Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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
19struct vc_data;
20struct console_font_op;
21struct console_font;
22struct module;
23struct 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
31struct 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
70extern const struct consw *conswitchp;
71
72extern const struct consw dummy_con; /* dummy console buffer */
73extern const struct consw vga_con; /* VGA text console */
74extern const struct consw newport_con; /* SGI Newport console */
75extern const struct consw prom_con; /* SPARC PROM console */
76
77int con_is_bound(const struct consw *csw);
78int register_con_driver(const struct consw *csw, int first, int last);
79int unregister_con_driver(const struct consw *csw);
80int do_unregister_con_driver(const struct consw *csw);
81int take_over_console(const struct consw *sw, int first, int last, int deflt);
82int do_take_over_console(const struct consw *sw, int first, int last, int deflt);
83void give_up_console(const struct consw *sw);
84#ifdef CONFIG_HW_CONSOLE
85int con_debug_enter(struct vc_data *vc);
86int con_debug_leave(void);
87#else
88static inline int con_debug_enter(struct vc_data *vc)
89{
90 return 0;
91}
92static inline int con_debug_leave(void)
93{
94 return 0;
95}
96#endif
97
98/* scroll */
99#define SM_UP (1)
100#define SM_DOWN (2)
101
102/* cursor */
103#define CM_DRAW (1)
104#define CM_ERASE (2)
105#define CM_MOVE (3)
106
107/*
108 * The interface for a console, or any other device that wants to capture
109 * console messages (printer driver?)
110 *
111 * If a console driver is marked CON_BOOT then it will be auto-unregistered
112 * when the first real console is registered. This is for early-printk drivers.
113 */
114
115#define CON_PRINTBUFFER (1)
116#define CON_CONSDEV (2) /* Last on the command line */
117#define CON_ENABLED (4)
118#define CON_BOOT (8)
119#define CON_ANYTIME (16) /* Safe to call when cpu is offline */
120#define CON_BRL (32) /* Used for a braille device */
121
122struct console {
123 char name[16];
124 void (*write)(struct console *, const char *, unsigned);
125 int (*read)(struct console *, char *, unsigned);
126 struct tty_driver *(*device)(struct console *, int *);
127 void (*unblank)(void);
128 int (*setup)(struct console *, char *);
129 int (*early_setup)(void);
130 short flags;
131 short index;
132 int cflag;
133 void *data;
134 struct console *next;
135};
136
137/*
138 * for_each_console() allows you to iterate on each console
139 */
140#define for_each_console(con) \
141 for (con = console_drivers; con != NULL; con = con->next)
142
143extern int console_set_on_cmdline;
144
145extern int add_preferred_console(char *name, int idx, char *options);
146extern int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options);
147extern void register_console(struct console *);
148extern int unregister_console(struct console *);
149extern struct console *console_drivers;
150extern void console_lock(void);
151extern int console_trylock(void);
152extern void console_unlock(void);
153extern void console_conditional_schedule(void);
154extern void console_unblank(void);
155extern struct tty_driver *console_device(int *);
156extern void console_stop(struct console *);
157extern void console_start(struct console *);
158extern int is_console_locked(void);
159extern int braille_register_console(struct console *, int index,
160 char *console_options, char *braille_options);
161extern int braille_unregister_console(struct console *);
162#ifdef CONFIG_TTY
163extern void console_sysfs_notify(void);
164#else
165static inline void console_sysfs_notify(void)
166{ }
167#endif
168extern bool console_suspend_enabled;
169
170/* Suspend and resume console messages over PM events */
171extern void suspend_console(void);
172extern void resume_console(void);
173
174int mda_console_init(void);
175void prom_con_init(void);
176
177void vcs_make_sysfs(int index);
178void vcs_remove_sysfs(int index);
179
180/* Some debug stub to catch some of the obvious races in the VT code */
181#if 1
182#define WARN_CONSOLE_UNLOCKED() WARN_ON(!is_console_locked() && !oops_in_progress)
183#else
184#define WARN_CONSOLE_UNLOCKED()
185#endif
186
187/* VESA Blanking Levels */
188#define VESA_NO_BLANKING 0
189#define VESA_VSYNC_SUSPEND 1
190#define VESA_HSYNC_SUSPEND 2
191#define VESA_POWERDOWN 3
192
193#ifdef CONFIG_VGA_CONSOLE
194extern bool vgacon_text_force(void);
195#endif
196
197#endif /* _LINUX_CONSOLE_H */