[mirror_ubuntu-bionic-kernel.git] / include / linux / console.h

/*
 *  linux/include/linux/console.h
 *
 *  Copyright (C) 1993        Hamish Macdonald
 *
 * This file is subject to the terms and conditions of the GNU General Public
 * License.  See the file COPYING in the main directory of this archive
 * for more details.
 *
 * Changed:
 * 10-Mar-94: Arno Griffioen: Conversion for vt100 emulator port from PC LINUX
 */

#ifndef _LINUX_CONSOLE_H_
#define _LINUX_CONSOLE_H_ 1

#include <linux/types.h>

struct vc_data;
struct console_font_op;
struct console_font;
struct module;
struct tty_struct;

/*
 * this is what the terminal answers to a ESC-Z or csi0c query.
 */
#define VT100ID "\033[?1;2c"
#define VT102ID "\033[?6c"

enum con_scroll {
	SM_UP,
	SM_DOWN,
};

/**
 * struct consw - callbacks for consoles
 *
 * @con_scroll: move lines from @top to @bottom in direction @dir by @lines.
 *		Return true if no generic handling should be done.
 *		Invoked by csi_M and printing to the console.
 * @con_set_palette: sets the palette of the console to @table (optional)
 * @con_scrolldelta: the contents of the console should be scrolled by @lines.
 *		     Invoked by user. (optional)
 */
struct consw {
	struct module *owner;
	const char *(*con_startup)(void);
	void	(*con_init)(struct vc_data *, int);
	void	(*con_deinit)(struct vc_data *);
	void	(*con_clear)(struct vc_data *, int, int, int, int);
	void	(*con_putc)(struct vc_data *, int, int, int);
	void	(*con_putcs)(struct vc_data *, const unsigned short *, int, int, int);
	void	(*con_cursor)(struct vc_data *, int);
	bool	(*con_scroll)(struct vc_data *, unsigned int top,
			unsigned int bottom, enum con_scroll dir,
			unsigned int lines);
	int	(*con_switch)(struct vc_data *);
	int	(*con_blank)(struct vc_data *, int, int);
	int	(*con_font_set)(struct vc_data *, struct console_font *, unsigned);
	int	(*con_font_get)(struct vc_data *, struct console_font *);
	int	(*con_font_default)(struct vc_data *, struct console_font *, char *);
	int	(*con_font_copy)(struct vc_data *, int);
	int     (*con_resize)(struct vc_data *, unsigned int, unsigned int,
			       unsigned int);
	void	(*con_set_palette)(struct vc_data *,
			const unsigned char *table);
	void	(*con_scrolldelta)(struct vc_data *, int lines);
	int	(*con_set_origin)(struct vc_data *);
	void	(*con_save_screen)(struct vc_data *);
	u8	(*con_build_attr)(struct vc_data *, u8, u8, u8, u8, u8, u8);
	void	(*con_invert_region)(struct vc_data *, u16 *, int);
	u16    *(*con_screen_pos)(struct vc_data *, int);
	unsigned long (*con_getxy)(struct vc_data *, unsigned long, int *, int *);
	/*
	 * Flush the video console driver's scrollback buffer
	 */
	void	(*con_flush_scrollback)(struct vc_data *);
	/*
	 * Prepare the console for the debugger.  This includes, but is not
	 * limited to, unblanking the console, loading an appropriate
	 * palette, and allowing debugger generated output.
	 */
	int	(*con_debug_enter)(struct vc_data *);
	/*
	 * Restore the console to its pre-debug state as closely as possible.
	 */
	int	(*con_debug_leave)(struct vc_data *);
};

extern const struct consw *conswitchp;

extern const struct consw dummy_con;	/* dummy console buffer */
extern const struct consw vga_con;	/* VGA text console */
extern const struct consw newport_con;	/* SGI Newport console  */
extern const struct consw prom_con;	/* SPARC PROM console */

int con_is_bound(const struct consw *csw);
int do_unregister_con_driver(const struct consw *csw);
int do_take_over_console(const struct consw *sw, int first, int last, int deflt);
void give_up_console(const struct consw *sw);
#ifdef CONFIG_HW_CONSOLE
int con_debug_enter(struct vc_data *vc);
int con_debug_leave(void);
#else
static inline int con_debug_enter(struct vc_data *vc)
{
	return 0;
}
static inline int con_debug_leave(void)
{
	return 0;
}
#endif

/* cursor */
#define CM_DRAW     (1)
#define CM_ERASE    (2)
#define CM_MOVE     (3)

/*
 * The interface for a console, or any other device that wants to capture
 * console messages (printer driver?)
 *
 * If a console driver is marked CON_BOOT then it will be auto-unregistered
 * when the first real console is registered.  This is for early-printk drivers.
 */

#define CON_PRINTBUFFER	(1)
#define CON_CONSDEV	(2) /* Last on the command line */
#define CON_ENABLED	(4)
#define CON_BOOT	(8)
#define CON_ANYTIME	(16) /* Safe to call when cpu is offline */
#define CON_BRL		(32) /* Used for a braille device */
#define CON_EXTENDED	(64) /* Use the extended output format a la /dev/kmsg */

struct console {
	char	name[16];
	void	(*write)(struct console *, const char *, unsigned);
	int	(*read)(struct console *, char *, unsigned);
	struct tty_driver *(*device)(struct console *, int *);
	void	(*unblank)(void);
	int	(*setup)(struct console *, char *);
	int	(*match)(struct console *, char *name, int idx, char *options);
	short	flags;
	short	index;
	int	cflag;
	void	*data;
	struct	 console *next;
};

/*
 * for_each_console() allows you to iterate on each console
 */
#define for_each_console(con) \
	for (con = console_drivers; con != NULL; con = con->next)

extern int console_set_on_cmdline;
extern struct console *early_console;

extern int add_preferred_console(char *name, int idx, char *options);
extern void register_console(struct console *);
extern int unregister_console(struct console *);
extern struct console *console_drivers;
extern void console_lock(void);
extern int console_trylock(void);
extern void console_unlock(void);
extern void console_conditional_schedule(void);
extern void console_unblank(void);
extern void console_flush_on_panic(void);
extern struct tty_driver *console_device(int *);
extern void console_stop(struct console *);
extern void console_start(struct console *);
extern int is_console_locked(void);
extern int braille_register_console(struct console *, int index,
		char *console_options, char *braille_options);
extern int braille_unregister_console(struct console *);
#ifdef CONFIG_TTY
extern void console_sysfs_notify(void);
#else
static inline void console_sysfs_notify(void)
{ }
#endif
extern bool console_suspend_enabled;

/* Suspend and resume console messages over PM events */
extern void suspend_console(void);
extern void resume_console(void);

int mda_console_init(void);
void prom_con_init(void);

void vcs_make_sysfs(int index);
void vcs_remove_sysfs(int index);

/* Some debug stub to catch some of the obvious races in the VT code */
#if 1
#define WARN_CONSOLE_UNLOCKED()	WARN_ON(!is_console_locked() && !oops_in_progress)
#else
#define WARN_CONSOLE_UNLOCKED()
#endif

/* VESA Blanking Levels */
#define VESA_NO_BLANKING        0
#define VESA_VSYNC_SUSPEND      1
#define VESA_HSYNC_SUSPEND      2
#define VESA_POWERDOWN          3

#ifdef CONFIG_VGA_CONSOLE
extern bool vgacon_text_force(void);
#else
static inline bool vgacon_text_force(void) { return false; }
#endif

extern void console_init(void);

#endif /* _LINUX_CONSOLE_H */
Commit	Line	Data
1da177e4 LT	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>
1da177e4 LT	18
	19	struct vc_data;
	20	struct console_font_op;
	21	struct console_font;
	22	struct module;
1b135431	23	struct tty_struct;
1da177e4 LT	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
d705ff38 JS	31	enum con_scroll {
	32	SM_UP,
	33	SM_DOWN,
	34	};
	35
97293de9 JS	36	/**
	37	* struct consw - callbacks for consoles
	38	*
d705ff38 JS	39	* @con_scroll: move lines from @top to @bottom in direction @dir by @lines.
	40	* Return true if no generic handling should be done.
	41	* Invoked by csi_M and printing to the console.
709280da	42	* @con_set_palette: sets the palette of the console to @table (optional)
97293de9 JS	43	* @con_scrolldelta: the contents of the console should be scrolled by @lines.
	44	* Invoked by user. (optional)
	45	*/
1da177e4 LT	46	struct consw {
	47	struct module *owner;
	48	const char (con_startup)(void);
	49	void (con_init)(struct vc_data , int);
	50	void (con_deinit)(struct vc_data );
	51	void (con_clear)(struct vc_data , int, int, int, int);
	52	void (con_putc)(struct vc_data , int, int, int);
	53	void (con_putcs)(struct vc_data , const unsigned short *, int, int, int);
	54	void (con_cursor)(struct vc_data , int);
d705ff38 JS	55	bool (con_scroll)(struct vc_data , unsigned int top,
	56	unsigned int bottom, enum con_scroll dir,
	57	unsigned int lines);
1da177e4 LT	58	int (con_switch)(struct vc_data );
	59	int (con_blank)(struct vc_data , int, int);
	60	int (con_font_set)(struct vc_data , struct console_font *, unsigned);
	61	int (con_font_get)(struct vc_data , struct console_font *);
	62	int (con_font_default)(struct vc_data , struct console_font , char );
	63	int (con_font_copy)(struct vc_data , int);
e400b6ec AD	64	int (con_resize)(struct vc_data , unsigned int, unsigned int,
e400b6ec AD	65	unsigned int);
709280da JS	66	void (con_set_palette)(struct vc_data ,
709280da JS	67	const unsigned char *table);
97293de9	68	void (con_scrolldelta)(struct vc_data , int lines);
1da177e4 LT	69	int (con_set_origin)(struct vc_data );
1da177e4 LT	70	void (con_save_screen)(struct vc_data );
fa6ce9ab	71	u8 (con_build_attr)(struct vc_data , u8, u8, u8, u8, u8, u8);
1da177e4 LT	72	void (con_invert_region)(struct vc_data , u16 *, int);
	73	u16 (con_screen_pos)(struct vc_data *, int);
	74	unsigned long (con_getxy)(struct vc_data , unsigned long, int , int );
bcd375f7 MS	75	/*
	76	* Flush the video console driver's scrollback buffer
	77	*/
	78	void (con_flush_scrollback)(struct vc_data );
b45cfba4 JB	79	/*
	80	* Prepare the console for the debugger. This includes, but is not
	81	* limited to, unblanking the console, loading an appropriate
	82	* palette, and allowing debugger generated output.
	83	*/
	84	int (con_debug_enter)(struct vc_data );
	85	/*
	86	* Restore the console to its pre-debug state as closely as possible.
	87	*/
	88	int (con_debug_leave)(struct vc_data );
1da177e4 LT	89	};
	90
	91	extern const struct consw *conswitchp;
	92
	93	extern const struct consw dummy_con; /* dummy console buffer */
	94	extern const struct consw vga_con; /* VGA text console */
	95	extern const struct consw newport_con; /* SGI Newport console */
	96	extern const struct consw prom_con; /* SPARC PROM console */
	97
3e795de7	98	int con_is_bound(const struct consw *csw);
e93a9a86	99	int do_unregister_con_driver(const struct consw *csw);
50e244cc	100	int do_take_over_console(const struct consw *sw, int first, int last, int deflt);
1da177e4	101	void give_up_console(const struct consw *sw);
9261ec1a	102	#ifdef CONFIG_HW_CONSOLE
b45cfba4 JB	103	int con_debug_enter(struct vc_data *vc);
b45cfba4 JB	104	int con_debug_leave(void);
9261ec1a	105	#else
f2f0945e AB	106	static inline int con_debug_enter(struct vc_data *vc)
	107	{
	108	return 0;
	109	}
	110	static inline int con_debug_leave(void)
	111	{
	112	return 0;
	113	}
9261ec1a	114	#endif
b45cfba4	115
1da177e4 LT	116	/* cursor */
	117	#define CM_DRAW (1)
	118	#define CM_ERASE (2)
	119	#define CM_MOVE (3)
	120
	121	/*
	122	* The interface for a console, or any other device that wants to capture
	123	* console messages (printer driver?)
	124	*
	125	* If a console driver is marked CON_BOOT then it will be auto-unregistered
	126	* when the first real console is registered. This is for early-printk drivers.
	127	*/
	128
	129	#define CON_PRINTBUFFER (1)
	130	#define CON_CONSDEV (2) /* Last on the command line */
	131	#define CON_ENABLED (4)
	132	#define CON_BOOT (8)
76a8ad29	133	#define CON_ANYTIME (16) /* Safe to call when cpu is offline */
f7511d5f	134	#define CON_BRL (32) /* Used for a braille device */
6fe29354	135	#define CON_EXTENDED (64) /* Use the extended output format a la /dev/kmsg */
1da177e4	136
6ae9200f AM	137	struct console {
6ae9200f AM	138	char name[16];
1da177e4 LT	139	void (write)(struct console , const char *, unsigned);
	140	int (read)(struct console , char *, unsigned);
	141	struct tty_driver (device)(struct console , int );
	142	void (*unblank)(void);
	143	int (setup)(struct console , char *);
c7cef0a8	144	int (match)(struct console , char name, int idx, char options);
1da177e4 LT	145	short flags;
	146	short index;
	147	int cflag;
	148	void *data;
	149	struct console *next;
	150	};
	151
a75d946f JS	152	/*
	153	* for_each_console() allows you to iterate on each console
	154	*/
	155	#define for_each_console(con) \
	156	for (con = console_drivers; con != NULL; con = con->next)
	157
9e124fe1	158	extern int console_set_on_cmdline;
d0380e6c	159	extern struct console *early_console;
9e124fe1	160
1da177e4 LT	161	extern int add_preferred_console(char name, int idx, char options);
	162	extern void register_console(struct console *);
	163	extern int unregister_console(struct console *);
	164	extern struct console *console_drivers;
ac751efa TH	165	extern void console_lock(void);
	166	extern int console_trylock(void);
	167	extern void console_unlock(void);
1da177e4 LT	168	extern void console_conditional_schedule(void);
1da177e4 LT	169	extern void console_unblank(void);
8d91f8b1	170	extern void console_flush_on_panic(void);
1da177e4 LT	171	extern struct tty_driver console_device(int );
	172	extern void console_stop(struct console *);
	173	extern void console_start(struct console *);
	174	extern int is_console_locked(void);
f7511d5f ST	175	extern int braille_register_console(struct console *, int index,
	176	char console_options, char braille_options);
	177	extern int braille_unregister_console(struct console *);
4f73bc4d	178	#ifdef CONFIG_TTY
fbc92a34	179	extern void console_sysfs_notify(void);
4f73bc4d JM	180	#else
	181	static inline void console_sysfs_notify(void)
	182	{ }
	183	#endif
90ab5ee9	184	extern bool console_suspend_enabled;
8f4ce8c3	185
557240b4 LT	186	/* Suspend and resume console messages over PM events */
	187	extern void suspend_console(void);
	188	extern void resume_console(void);
	189
3cb340ec AB	190	int mda_console_init(void);
	191	void prom_con_init(void);
	192
4995f8ef KS	193	void vcs_make_sysfs(int index);
4995f8ef KS	194	void vcs_remove_sysfs(int index);
1b135431	195
1da177e4 LT	196	/* Some debug stub to catch some of the obvious races in the VT code */
	197	#if 1
	198	#define WARN_CONSOLE_UNLOCKED() WARN_ON(!is_console_locked() && !oops_in_progress)
	199	#else
	200	#define WARN_CONSOLE_UNLOCKED()
	201	#endif
	202
	203	/* VESA Blanking Levels */
	204	#define VESA_NO_BLANKING 0
	205	#define VESA_VSYNC_SUSPEND 1
	206	#define VESA_HSYNC_SUSPEND 2
	207	#define VESA_POWERDOWN 3
	208
f453ba04 DA	209	#ifdef CONFIG_VGA_CONSOLE
f453ba04 DA	210	extern bool vgacon_text_force(void);
44debe7a DV	211	#else
44debe7a DV	212	static inline bool vgacon_text_force(void) { return false; }
f453ba04 DA	213	#endif
f453ba04 DA	214
0c688614 NP	215	extern void console_init(void);
0c688614 NP	216
1da177e4	217	#endif /* _LINUX_CONSOLE_H */