blob: 7453cfd593c813632c3cf103ea918c471266613e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
19struct vc_data;
20struct console_font_op;
21struct console_font;
22struct module;
Adrian Bunk1b135432007-02-10 01:45:02 -080023struct tty_struct;
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
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);
Antonino A. Daplase400b6e2007-10-16 01:29:35 -070048 int (*con_resize)(struct vc_data *, unsigned int, unsigned int,
49 unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 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 *);
Jan Engelhardtfa6ce9a2007-05-08 00:38:04 -070054 u8 (*con_build_attr)(struct vc_data *, u8, u8, u8, u8, u8, u8);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 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 *);
Jesse Barnesb45cfba2010-08-05 09:22:30 -050058 /*
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 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068};
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
Antonino A. Daplas3e795de2006-06-26 00:27:08 -070077int 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080int take_over_console(const struct consw *sw, int first, int last, int deflt);
81void give_up_console(const struct consw *sw);
Jason Wessel9261ec12010-08-06 15:36:47 -050082#ifdef CONFIG_HW_CONSOLE
Jesse Barnesb45cfba2010-08-05 09:22:30 -050083int con_debug_enter(struct vc_data *vc);
84int con_debug_leave(void);
Jason Wessel9261ec12010-08-06 15:36:47 -050085#else
86#define con_debug_enter(vc) (0)
87#define con_debug_leave() (0)
88#endif
Jesse Barnesb45cfba2010-08-05 09:22:30 -050089
Linus Torvalds1da177e2005-04-16 15:20:36 -070090/* 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)
Michael Ellerman76a8ad22006-06-25 05:47:40 -0700111#define CON_ANYTIME (16) /* Safe to call when cpu is offline */
Samuel Thibaultf7511d52008-04-30 00:54:51 -0700112#define CON_BRL (32) /* Used for a braille device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Andrew Morton6ae92002007-05-08 00:26:47 -0700114struct console {
115 char name[16];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 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 *);
Yinghai Lu18a8bd92007-07-15 23:37:59 -0700121 int (*early_setup)(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 short flags;
123 short index;
124 int cflag;
125 void *data;
126 struct console *next;
127};
128
Jiri Slabya75d9462010-11-04 16:20:20 +0100129/*
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
Markus Armbruster9e124fe2008-05-26 23:31:07 +0100135extern int console_set_on_cmdline;
136
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137extern int add_preferred_console(char *name, int idx, char *options);
Yinghai Lu18a8bd92007-07-15 23:37:59 -0700138extern int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139extern void register_console(struct console *);
140extern int unregister_console(struct console *);
141extern struct console *console_drivers;
Torben Hohnac751ef2011-01-25 15:07:35 -0800142extern void console_lock(void);
143extern int console_trylock(void);
144extern void console_unlock(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145extern void console_conditional_schedule(void);
146extern void console_unblank(void);
147extern struct tty_driver *console_device(int *);
148extern void console_stop(struct console *);
149extern void console_start(struct console *);
150extern int is_console_locked(void);
Samuel Thibaultf7511d52008-04-30 00:54:51 -0700151extern int braille_register_console(struct console *, int index,
152 char *console_options, char *braille_options);
153extern int braille_unregister_console(struct console *);
Kay Sieversfbc92a32010-12-01 18:51:05 +0100154extern void console_sysfs_notify(void);
Andres Salomon8f4ce8c2007-10-18 03:04:50 -0700155extern int console_suspend_enabled;
156
Linus Torvalds557240b2006-06-19 18:16:01 -0700157/* Suspend and resume console messages over PM events */
158extern void suspend_console(void);
159extern void resume_console(void);
160
Adrian Bunk3cb340e2006-10-03 01:15:06 -0700161int mda_console_init(void);
162void prom_con_init(void);
163
Kay Sievers4995f8e2009-03-09 14:18:52 +0100164void vcs_make_sysfs(int index);
165void vcs_remove_sysfs(int index);
Adrian Bunk1b135432007-02-10 01:45:02 -0800166
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167/* 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
Dave Airlief453ba02008-11-07 14:05:41 -0800180#ifdef CONFIG_VGA_CONSOLE
181extern bool vgacon_text_force(void);
182#endif
183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184#endif /* _LINUX_CONSOLE_H */