[deliverable/linux.git] / include / linux / console_struct.h

/*
 * console_struct.h
 *
 * Data structure describing single virtual console except for data
 * used by vt.c.
 *
 * Fields marked with [#] must be set by the low-level driver.
 * Fields marked with [!] can be changed by the low-level driver
 * to achieve effects such as fast scrolling by changing the origin.
 */

#ifndef _LINUX_CONSOLE_STRUCT_H
#define _LINUX_CONSOLE_STRUCT_H

#include <linux/wait.h>
#include <linux/vt.h>
#include <linux/workqueue.h>

struct vt_struct;
struct uni_pagedir;

#define NPAR 16

struct vc_data {
	struct tty_port port;			/* Upper level data */

	unsigned short	vc_num;			/* Console number */
	unsigned int	vc_cols;		/* [#] Console size */
	unsigned int	vc_rows;
	unsigned int	vc_size_row;		/* Bytes per row */
	unsigned int	vc_scan_lines;		/* # of scan lines */
	unsigned long	vc_origin;		/* [!] Start of real screen */
	unsigned long	vc_scr_end;		/* [!] End of real screen */
	unsigned long	vc_visible_origin;	/* [!] Top of visible window */
	unsigned int	vc_top, vc_bottom;	/* Scrolling region */
	const struct consw *vc_sw;
	unsigned short	*vc_screenbuf;		/* In-memory character/attribute buffer */
	unsigned int	vc_screenbuf_size;
	unsigned char	vc_mode;		/* KD_TEXT, ... */
	/* attributes for all characters on screen */
	unsigned char	vc_attr;		/* Current attributes */
	unsigned char	vc_def_color;		/* Default colors */
	unsigned char	vc_color;		/* Foreground & background */
	unsigned char	vc_s_color;		/* Saved foreground & background */
	unsigned char	vc_ulcolor;		/* Color for underline mode */
	unsigned char   vc_itcolor;
	unsigned char	vc_halfcolor;		/* Color for half intensity mode */
	/* cursor */
	unsigned int	vc_cursor_type;
	unsigned short	vc_complement_mask;	/* [#] Xor mask for mouse pointer */
	unsigned short	vc_s_complement_mask;	/* Saved mouse pointer mask */
	unsigned int	vc_x, vc_y;		/* Cursor position */
	unsigned int	vc_saved_x, vc_saved_y;
	unsigned long	vc_pos;			/* Cursor address */
	/* fonts */	
	unsigned short	vc_hi_font_mask;	/* [#] Attribute set for upper 256 chars of font or 0 if not supported */
	struct console_font vc_font;		/* Current VC font set */
	unsigned short	vc_video_erase_char;	/* Background erase character */
	/* VT terminal data */
	unsigned int	vc_state;		/* Escape sequence parser state */
	unsigned int	vc_npar,vc_par[NPAR];	/* Parameters of current escape sequence */
	/* data for manual vt switching */
	struct vt_mode	vt_mode;
	struct pid 	*vt_pid;
	int		vt_newvt;
	wait_queue_head_t paste_wait;
	/* mode flags */
	unsigned int	vc_charset	: 1;	/* Character set G0 / G1 */
	unsigned int	vc_s_charset	: 1;	/* Saved character set */
	unsigned int	vc_disp_ctrl	: 1;	/* Display chars < 32? */
	unsigned int	vc_toggle_meta	: 1;	/* Toggle high bit? */
	unsigned int	vc_decscnm	: 1;	/* Screen Mode */
	unsigned int	vc_decom	: 1;	/* Origin Mode */
	unsigned int	vc_decawm	: 1;	/* Autowrap Mode */
	unsigned int	vc_deccm	: 1;	/* Cursor Visible */
	unsigned int	vc_decim	: 1;	/* Insert Mode */
	unsigned int	vc_deccolm	: 1;	/* 80/132 Column Mode */
	/* attribute flags */
	unsigned int	vc_intensity	: 2;	/* 0=half-bright, 1=normal, 2=bold */
	unsigned int    vc_italic:1;
	unsigned int	vc_underline	: 1;
	unsigned int	vc_blink	: 1;
	unsigned int	vc_reverse	: 1;
	unsigned int	vc_s_intensity	: 2;	/* saved rendition */
	unsigned int    vc_s_italic:1;
	unsigned int	vc_s_underline	: 1;
	unsigned int	vc_s_blink	: 1;
	unsigned int	vc_s_reverse	: 1;
	/* misc */
	unsigned int	vc_ques		: 1;
	unsigned int	vc_need_wrap	: 1;
	unsigned int	vc_can_do_color	: 1;
	unsigned int	vc_report_mouse : 2;
	unsigned char	vc_utf		: 1;	/* Unicode UTF-8 encoding */
	unsigned char	vc_utf_count;
		 int	vc_utf_char;
	unsigned int	vc_tab_stop[8];		/* Tab stops. 256 columns. */
	unsigned char   vc_palette[16*3];       /* Colour palette for VGA+ */
	unsigned short * vc_translate;
	unsigned char 	vc_G0_charset;
	unsigned char 	vc_G1_charset;
	unsigned char 	vc_saved_G0;
	unsigned char 	vc_saved_G1;
	unsigned int    vc_resize_user;         /* resize request from user */
	unsigned int	vc_bell_pitch;		/* Console bell pitch */
	unsigned int	vc_bell_duration;	/* Console bell duration */
	unsigned short	vc_cur_blink_ms;	/* Cursor blink duration */
	struct vc_data **vc_display_fg;		/* [!] Ptr to var holding fg console for this display */
	struct uni_pagedir *vc_uni_pagedir;
	struct uni_pagedir **vc_uni_pagedir_loc; /* [!] Location of uni_pagedir variable for this console */
	bool vc_panic_force_write; /* when oops/panic this VC can accept forced output/blanking */
	/* additional information is in vt_kern.h */
};

struct vc {
	struct vc_data *d;
	struct work_struct SAK_work;

	/* might add  scrmem, vt_struct, kbd  at some time,
	   to have everything in one place - the disadvantage
	   would be that vc_cons etc can no longer be static */
};

extern struct vc vc_cons [MAX_NR_CONSOLES];
extern void vc_SAK(struct work_struct *work);

#define CUR_DEF		0
#define CUR_NONE	1
#define CUR_UNDERLINE	2
#define CUR_LOWER_THIRD	3
#define CUR_LOWER_HALF	4
#define CUR_TWO_THIRDS	5
#define CUR_BLOCK	6
#define CUR_HWMASK	0x0f
#define CUR_SWMASK	0xfff0

#define CUR_DEFAULT CUR_UNDERLINE

#define CON_IS_VISIBLE(conp) (*conp->vc_display_fg == conp)

#endif /* _LINUX_CONSOLE_STRUCT_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* console_struct.h
	3	*
	4	* Data structure describing single virtual console except for data
	5	* used by vt.c.
	6	*
	7	* Fields marked with [#] must be set by the low-level driver.
	8	* Fields marked with [!] can be changed by the low-level driver
	9	* to achieve effects such as fast scrolling by changing the origin.
	10	*/
	11
217397d7 RD	12	#ifndef _LINUX_CONSOLE_STRUCT_H
	13	#define _LINUX_CONSOLE_STRUCT_H
	14
a8f340e3	15	#include <linux/wait.h>
e07dea98	16	#include <linux/vt.h>
8b6312f4	17	#include <linux/workqueue.h>
e07dea98	18
1da177e4	19	struct vt_struct;
e4bdab70	20	struct uni_pagedir;
1da177e4 LT	21
	22	#define NPAR 16
	23
	24	struct vc_data {
ff917ba4 AC	25	struct tty_port port; /* Upper level data */
ff917ba4 AC	26
1da177e4 LT	27	unsigned short vc_num; /* Console number */
	28	unsigned int vc_cols; /* [#] Console size */
	29	unsigned int vc_rows;
	30	unsigned int vc_size_row; /* Bytes per row */
	31	unsigned int vc_scan_lines; /* # of scan lines */
	32	unsigned long vc_origin; /* [!] Start of real screen */
	33	unsigned long vc_scr_end; /* [!] End of real screen */
	34	unsigned long vc_visible_origin; /* [!] Top of visible window */
	35	unsigned int vc_top, vc_bottom; /* Scrolling region */
	36	const struct consw *vc_sw;
	37	unsigned short vc_screenbuf; / In-memory character/attribute buffer */
	38	unsigned int vc_screenbuf_size;
	39	unsigned char vc_mode; /* KD_TEXT, ... */
	40	/* attributes for all characters on screen */
	41	unsigned char vc_attr; /* Current attributes */
	42	unsigned char vc_def_color; /* Default colors */
	43	unsigned char vc_color; /* Foreground & background */
	44	unsigned char vc_s_color; /* Saved foreground & background */
	45	unsigned char vc_ulcolor; /* Color for underline mode */
fa6ce9ab	46	unsigned char vc_itcolor;
1da177e4 LT	47	unsigned char vc_halfcolor; /* Color for half intensity mode */
	48	/* cursor */
	49	unsigned int vc_cursor_type;
	50	unsigned short vc_complement_mask; /* [#] Xor mask for mouse pointer */
	51	unsigned short vc_s_complement_mask; /* Saved mouse pointer mask */
	52	unsigned int vc_x, vc_y; /* Cursor position */
	53	unsigned int vc_saved_x, vc_saved_y;
	54	unsigned long vc_pos; /* Cursor address */
	55	/* fonts */
	56	unsigned short vc_hi_font_mask; /* [#] Attribute set for upper 256 chars of font or 0 if not supported */
	57	struct console_font vc_font; /* Current VC font set */
	58	unsigned short vc_video_erase_char; /* Background erase character */
	59	/* VT terminal data */
	60	unsigned int vc_state; /* Escape sequence parser state */
	61	unsigned int vc_npar,vc_par[NPAR]; /* Parameters of current escape sequence */
1da177e4 LT	62	/* data for manual vt switching */
1da177e4 LT	63	struct vt_mode vt_mode;
bde0d2c9	64	struct pid *vt_pid;
1da177e4 LT	65	int vt_newvt;
	66	wait_queue_head_t paste_wait;
	67	/* mode flags */
	68	unsigned int vc_charset : 1; /* Character set G0 / G1 */
	69	unsigned int vc_s_charset : 1; /* Saved character set */
	70	unsigned int vc_disp_ctrl : 1; /* Display chars < 32? */
	71	unsigned int vc_toggle_meta : 1; /* Toggle high bit? */
	72	unsigned int vc_decscnm : 1; /* Screen Mode */
	73	unsigned int vc_decom : 1; /* Origin Mode */
	74	unsigned int vc_decawm : 1; /* Autowrap Mode */
	75	unsigned int vc_deccm : 1; /* Cursor Visible */
	76	unsigned int vc_decim : 1; /* Insert Mode */
	77	unsigned int vc_deccolm : 1; /* 80/132 Column Mode */
	78	/* attribute flags */
	79	unsigned int vc_intensity : 2; /* 0=half-bright, 1=normal, 2=bold */
fa6ce9ab	80	unsigned int vc_italic:1;
1da177e4 LT	81	unsigned int vc_underline : 1;
	82	unsigned int vc_blink : 1;
	83	unsigned int vc_reverse : 1;
	84	unsigned int vc_s_intensity : 2; /* saved rendition */
fa6ce9ab	85	unsigned int vc_s_italic:1;
1da177e4 LT	86	unsigned int vc_s_underline : 1;
	87	unsigned int vc_s_blink : 1;
	88	unsigned int vc_s_reverse : 1;
	89	/* misc */
	90	unsigned int vc_ques : 1;
	91	unsigned int vc_need_wrap : 1;
	92	unsigned int vc_can_do_color : 1;
	93	unsigned int vc_report_mouse : 2;
1da177e4 LT	94	unsigned char vc_utf : 1; /* Unicode UTF-8 encoding */
	95	unsigned char vc_utf_count;
	96	int vc_utf_char;
	97	unsigned int vc_tab_stop[8]; /* Tab stops. 256 columns. */
	98	unsigned char vc_palette[163]; / Colour palette for VGA+ */
	99	unsigned short * vc_translate;
	100	unsigned char vc_G0_charset;
	101	unsigned char vc_G1_charset;
	102	unsigned char vc_saved_G0;
	103	unsigned char vc_saved_G1;
e400b6ec	104	unsigned int vc_resize_user; /* resize request from user */
1da177e4 LT	105	unsigned int vc_bell_pitch; /* Console bell pitch */
1da177e4 LT	106	unsigned int vc_bell_duration; /* Console bell duration */
bd63364c	107	unsigned short vc_cur_blink_ms; /* Cursor blink duration */
1da177e4	108	struct vc_data *vc_display_fg; / [!] Ptr to var holding fg console for this display */
e4bdab70 TI	109	struct uni_pagedir *vc_uni_pagedir;
e4bdab70 TI	110	struct uni_pagedir *vc_uni_pagedir_loc; / [!] Location of uni_pagedir variable for this console */
8fd4bd22	111	bool vc_panic_force_write; /* when oops/panic this VC can accept forced output/blanking */
1da177e4 LT	112	/* additional information is in vt_kern.h */
	113	};
	114
	115	struct vc {
	116	struct vc_data *d;
8b6312f4	117	struct work_struct SAK_work;
1da177e4 LT	118
	119	/* might add scrmem, vt_struct, kbd at some time,
	120	to have everything in one place - the disadvantage
	121	would be that vc_cons etc can no longer be static */
	122	};
	123
	124	extern struct vc vc_cons [MAX_NR_CONSOLES];
8b6312f4	125	extern void vc_SAK(struct work_struct *work);
1da177e4 LT	126
	127	#define CUR_DEF 0
	128	#define CUR_NONE 1
	129	#define CUR_UNDERLINE 2
	130	#define CUR_LOWER_THIRD 3
	131	#define CUR_LOWER_HALF 4
	132	#define CUR_TWO_THIRDS 5
	133	#define CUR_BLOCK 6
	134	#define CUR_HWMASK 0x0f
	135	#define CUR_SWMASK 0xfff0
	136
	137	#define CUR_DEFAULT CUR_UNDERLINE
	138
	139	#define CON_IS_VISIBLE(conp) (*conp->vc_display_fg == conp)
217397d7 RD	140
217397d7 RD	141	#endif /* _LINUX_CONSOLE_STRUCT_H */