[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"

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);
	int	(*con_scroll)(struct vc_data *, int, int, int, int);
	void	(*con_bmove)(struct vc_data *, int, int, int, int, int, int);
	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);
	int	(*con_set_palette)(struct vc_data *, unsigned char *);
	int	(*con_scrolldelta)(struct vc_data *, int);
	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 *);
	/*
	 * 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 register_con_driver(const struct consw *csw, int first, int last);
int unregister_con_driver(const struct consw *csw);
int take_over_console(const struct consw *sw, int first, int last, int deflt);
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

/* scroll */
#define SM_UP       (1)
#define SM_DOWN     (2)

/* 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 */

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	(*early_setup)(void);
	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 int add_preferred_console(char *name, int idx, char *options);
extern int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, 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 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 *);
extern void console_sysfs_notify(void);
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);
#endif

#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
	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);
e400b6ec AD	48	int (con_resize)(struct vc_data , unsigned int, unsigned int,
e400b6ec AD	49	unsigned int);
1da177e4 LT	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 );
fa6ce9ab	54	u8 (con_build_attr)(struct vc_data , u8, u8, u8, u8, u8, u8);
1da177e4 LT	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 );
b45cfba4 JB	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 );
1da177e4 LT	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
3e795de7 AD	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);
1da177e4	80	int take_over_console(const struct consw *sw, int first, int last, int deflt);
50e244cc	81	int do_take_over_console(const struct consw *sw, int first, int last, int deflt);
1da177e4	82	void give_up_console(const struct consw *sw);
9261ec1a	83	#ifdef CONFIG_HW_CONSOLE
b45cfba4 JB	84	int con_debug_enter(struct vc_data *vc);
b45cfba4 JB	85	int con_debug_leave(void);
9261ec1a	86	#else
f2f0945e AB	87	static inline int con_debug_enter(struct vc_data *vc)
	88	{
	89	return 0;
	90	}
	91	static inline int con_debug_leave(void)
	92	{
	93	return 0;
	94	}
9261ec1a	95	#endif
b45cfba4	96
1da177e4 LT	97	/* scroll */
	98	#define SM_UP (1)
	99	#define SM_DOWN (2)
	100
	101	/* cursor */
	102	#define CM_DRAW (1)
	103	#define CM_ERASE (2)
	104	#define CM_MOVE (3)
	105
	106	/*
	107	* The interface for a console, or any other device that wants to capture
	108	* console messages (printer driver?)
	109	*
	110	* If a console driver is marked CON_BOOT then it will be auto-unregistered
	111	* when the first real console is registered. This is for early-printk drivers.
	112	*/
	113
	114	#define CON_PRINTBUFFER (1)
	115	#define CON_CONSDEV (2) /* Last on the command line */
	116	#define CON_ENABLED (4)
	117	#define CON_BOOT (8)
76a8ad29	118	#define CON_ANYTIME (16) /* Safe to call when cpu is offline */
f7511d5f	119	#define CON_BRL (32) /* Used for a braille device */
1da177e4	120
6ae9200f AM	121	struct console {
6ae9200f AM	122	char name[16];
1da177e4 LT	123	void (write)(struct console , const char *, unsigned);
	124	int (read)(struct console , char *, unsigned);
	125	struct tty_driver (device)(struct console , int );
	126	void (*unblank)(void);
	127	int (setup)(struct console , char *);
18a8bd94	128	int (*early_setup)(void);
1da177e4 LT	129	short flags;
	130	short index;
	131	int cflag;
	132	void *data;
	133	struct console *next;
	134	};
	135
a75d946f JS	136	/*
	137	* for_each_console() allows you to iterate on each console
	138	*/
	139	#define for_each_console(con) \
	140	for (con = console_drivers; con != NULL; con = con->next)
	141
9e124fe1 MA	142	extern int console_set_on_cmdline;
9e124fe1 MA	143
1da177e4	144	extern int add_preferred_console(char name, int idx, char options);
18a8bd94	145	extern int update_console_cmdline(char name, int idx, char name_new, int idx_new, char *options);
1da177e4 LT	146	extern void register_console(struct console *);
	147	extern int unregister_console(struct console *);
	148	extern struct console *console_drivers;
ac751efa TH	149	extern void console_lock(void);
	150	extern int console_trylock(void);
	151	extern void console_unlock(void);
1da177e4 LT	152	extern void console_conditional_schedule(void);
	153	extern void console_unblank(void);
	154	extern struct tty_driver console_device(int );
	155	extern void console_stop(struct console *);
	156	extern void console_start(struct console *);
	157	extern int is_console_locked(void);
f7511d5f ST	158	extern int braille_register_console(struct console *, int index,
	159	char console_options, char braille_options);
	160	extern int braille_unregister_console(struct console *);
fbc92a34	161	extern void console_sysfs_notify(void);
90ab5ee9	162	extern bool console_suspend_enabled;
8f4ce8c3	163
557240b4 LT	164	/* Suspend and resume console messages over PM events */
	165	extern void suspend_console(void);
	166	extern void resume_console(void);
	167
3cb340ec AB	168	int mda_console_init(void);
	169	void prom_con_init(void);
	170
4995f8ef KS	171	void vcs_make_sysfs(int index);
4995f8ef KS	172	void vcs_remove_sysfs(int index);
1b135431	173
1da177e4 LT	174	/* Some debug stub to catch some of the obvious races in the VT code */
	175	#if 1
	176	#define WARN_CONSOLE_UNLOCKED() WARN_ON(!is_console_locked() && !oops_in_progress)
	177	#else
	178	#define WARN_CONSOLE_UNLOCKED()
	179	#endif
	180
	181	/* VESA Blanking Levels */
	182	#define VESA_NO_BLANKING 0
	183	#define VESA_VSYNC_SUSPEND 1
	184	#define VESA_HSYNC_SUSPEND 2
	185	#define VESA_POWERDOWN 3
	186
f453ba04 DA	187	#ifdef CONFIG_VGA_CONSOLE
	188	extern bool vgacon_text_force(void);
	189	#endif
	190
1da177e4	191	#endif /* _LINUX_CONSOLE_H */