[linux-2.6-block.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>
#include <linux/spinlock.h>

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

/*
 * 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);
	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);
	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 *);
};

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);
void give_up_console(const struct consw *sw);
/* 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 */

struct console
{
	char	name[8];
	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 *);
	short	flags;
	short	index;
	int	cflag;
	void	*data;
	struct	 console *next;
};

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 acquire_console_sem(void);
extern int try_acquire_console_sem(void);
extern void release_console_sem(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);

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

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

#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>
	18	#include <linux/spinlock.h>
	19
	20	struct vc_data;
	21	struct console_font_op;
	22	struct console_font;
	23	struct module;
	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	int (con_set_palette)(struct vc_data , unsigned char *);
	50	int (con_scrolldelta)(struct vc_data , int);
	51	int (con_set_origin)(struct vc_data );
	52	void (con_save_screen)(struct vc_data );
	53	u8 (con_build_attr)(struct vc_data , u8, u8, u8, u8, u8);
	54	void (con_invert_region)(struct vc_data , u16 *, int);
	55	u16 (con_screen_pos)(struct vc_data *, int);
	56	unsigned long (con_getxy)(struct vc_data , unsigned long, int , int );
	57	};
	58
	59	extern const struct consw *conswitchp;
	60
	61	extern const struct consw dummy_con; /* dummy console buffer */
	62	extern const struct consw vga_con; /* VGA text console */
	63	extern const struct consw newport_con; /* SGI Newport console */
	64	extern const struct consw prom_con; /* SPARC PROM console */
65
3e795de7 AD	66	int con_is_bound(const struct consw *csw);
	67	int register_con_driver(const struct consw *csw, int first, int last);
	68	int unregister_con_driver(const struct consw *csw);
1da177e4 LT	69	int take_over_console(const struct consw *sw, int first, int last, int deflt);
1da177e4 LT	70	void give_up_console(const struct consw *sw);
1da177e4 LT	71	/* scroll */
	72	#define SM_UP (1)
	73	#define SM_DOWN (2)
	74
	75	/* cursor */
	76	#define CM_DRAW (1)
	77	#define CM_ERASE (2)
	78	#define CM_MOVE (3)
	79
	80	/*
	81	* The interface for a console, or any other device that wants to capture
	82	* console messages (printer driver?)
	83	*
	84	* If a console driver is marked CON_BOOT then it will be auto-unregistered
	85	* when the first real console is registered. This is for early-printk drivers.
	86	*/
	87
	88	#define CON_PRINTBUFFER (1)
	89	#define CON_CONSDEV (2) /* Last on the command line */
	90	#define CON_ENABLED (4)
	91	#define CON_BOOT (8)
76a8ad29	92	#define CON_ANYTIME (16) /* Safe to call when cpu is offline */
1da177e4 LT	93
	94	struct console
	95	{
	96	char name[8];
	97	void (write)(struct console , const char *, unsigned);
	98	int (read)(struct console , char *, unsigned);
	99	struct tty_driver (device)(struct console , int );
	100	void (*unblank)(void);
	101	int (setup)(struct console , char *);
	102	short flags;
	103	short index;
	104	int cflag;
	105	void *data;
	106	struct console *next;
	107	};
	108
	109	extern int add_preferred_console(char name, int idx, char options);
	110	extern void register_console(struct console *);
	111	extern int unregister_console(struct console *);
	112	extern struct console *console_drivers;
	113	extern void acquire_console_sem(void);
	114	extern int try_acquire_console_sem(void);
	115	extern void release_console_sem(void);
	116	extern void console_conditional_schedule(void);
	117	extern void console_unblank(void);
	118	extern struct tty_driver console_device(int );
	119	extern void console_stop(struct console *);
	120	extern void console_start(struct console *);
	121	extern int is_console_locked(void);
	122
557240b4 LT	123	/* Suspend and resume console messages over PM events */
	124	extern void suspend_console(void);
	125	extern void resume_console(void);
	126
1da177e4 LT	127	/* Some debug stub to catch some of the obvious races in the VT code */
	128	#if 1
	129	#define WARN_CONSOLE_UNLOCKED() WARN_ON(!is_console_locked() && !oops_in_progress)
	130	#else
	131	#define WARN_CONSOLE_UNLOCKED()
	132	#endif
	133
	134	/* VESA Blanking Levels */
	135	#define VESA_NO_BLANKING 0
	136	#define VESA_VSYNC_SUSPEND 1
	137	#define VESA_HSYNC_SUSPEND 2
	138	#define VESA_POWERDOWN 3
	139
	140	#endif /* _LINUX_CONSOLE_H */