vt.h revision 257966 
1/*-
2 * Copyright (c) 2009, 2013 The FreeBSD Foundation
3 * All rights reserved.
4 *
5 * This software was developed by Ed Schouten under sponsorship from the
6 * FreeBSD Foundation.
7 *
8 * Portions of this software were developed by Oleksandr Rybalko
9 * under sponsorship from the FreeBSD Foundation.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 *    notice, this list of conditions and the following disclaimer in the
18 *    documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 * $FreeBSD: user/ed/newcons/sys/dev/vt/vt.h 257966 2013-11-11 11:30:47Z ray $
33 */
34
35#ifndef _DEV_VT_VT_H_
36#define	_DEV_VT_VT_H_
37
38#include <sys/param.h>
39#include <sys/_lock.h>
40#include <sys/_mutex.h>
41#include <sys/callout.h>
42#include <sys/condvar.h>
43#include <sys/consio.h>
44#include <sys/kbio.h>
45#include <sys/terminal.h>
46#include <sys/sysctl.h>
47
48#include "opt_syscons.h"
49
50#ifndef	VT_MAXWINDOWS
51#ifdef	MAXCONS
52#define	VT_MAXWINDOWS	MAXCONS
53#else
54#define	VT_MAXWINDOWS	12
55#endif
56#endif
57
58#define	VT_CONSWINDOW	0
59
60#if defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE)
61#define VT_MOUSE_PASTEBUTTON	MOUSE_BUTTON3DOWN	/* right button */
62#define VT_MOUSE_EXTENDBUTTON	MOUSE_BUTTON2DOWN	/* not really used */
63#else
64#define VT_MOUSE_PASTEBUTTON	MOUSE_BUTTON2DOWN	/* middle button */
65#define VT_MOUSE_EXTENDBUTTON	MOUSE_BUTTON3DOWN	/* right button */
66#endif /* defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) */
67
68#define	SC_DRIVER_NAME	"vt"
69#define	DPRINTF(_l, ...)	if (vt_debug > (_l)) printf( __VA_ARGS__ )
70#define	ISSIGVALID(sig)	((sig) > 0 && (sig) < NSIG)
71
72#define	VT_SYSCTL_INT(_name, _default, _descr)				\
73static int vt_##_name = _default;					\
74SYSCTL_INT(_kern_vt, OID_AUTO, _name, CTLFLAG_RW, &vt_##_name, _default,\
75		_descr);						\
76TUNABLE_INT("kern.vt." #_name, &vt_##_name);
77
78struct vt_driver;
79
80void vt_allocate(struct vt_driver *, void *);
81void vt_resume(void);
82void vt_suspend(void);
83
84typedef unsigned int 	vt_axis_t;
85
86/*
87 * List of locks
88 * (d)	locked by vd_lock
89 * (b)	locked by vb_lock
90 * (G)	locked by Giant
91 * (u)	unlocked, locked by higher levels
92 * (c)	const until freeing
93 * (?)	yet to be determined
94 */
95
96/*
97 * Per-device datastructure.
98 */
99
100struct vt_device {
101	struct vt_window	*vd_windows[VT_MAXWINDOWS]; /* (c) Windows. */
102	struct vt_window	*vd_curwindow;	/* (d) Current window. */
103	struct vt_window	*vd_savedwindow;/* (?) Saved for suspend. */
104	const struct vt_driver	*vd_driver;	/* (c) Graphics driver. */
105	void			*vd_softc;	/* (u) Driver data. */
106	vt_axis_t		 vd_width;	/* (?) Screen width. */
107	vt_axis_t		 vd_height;	/* (?) Screen height. */
108	struct mtx		 vd_lock;	/* Per-device lock. */
109	struct cv		 vd_winswitch;	/* (d) Window switch notify. */
110	struct callout		 vd_timer;	/* (d) Display timer. */
111	int			 vd_flags;	/* (d) Device flags. */
112#define	VDF_TEXTMODE	0x01	/* Do text mode rendering. */
113#define	VDF_SPLASH	0x02	/* Splash screen active. */
114#define	VDF_ASYNC	0x04	/* vt_timer() running. */
115#define	VDF_INVALID	0x08	/* Entire screen should be re-rendered. */
116#define	VDF_DEAD	0x10	/* Early probing found nothing. */
117#define	VDF_INITIALIZED	0x20	/* vtterm_cnprobe already done. */
118	int			 vd_keyboard;	/* (G) Keyboard index. */
119	unsigned int		 vd_unit;	/* (c) Device unit. */
120};
121
122/*
123 * Per-window terminal screen buffer.
124 *
125 * Because redrawing is performed asynchronously, the buffer keeps track
126 * of a rectangle that needs to be redrawn (vb_dirtyrect).  Because this
127 * approach seemed to cause suboptimal performance (when the top left
128 * and the bottom right of the screen are modified), it also uses a set
129 * of bitmasks to keep track of the rows and columns (mod 64) that have
130 * been modified.
131 */
132
133struct vt_bufmask {
134	uint64_t		 vbm_row, vbm_col;
135#define	VBM_DIRTY		UINT64_MAX
136};
137
138struct vt_buf {
139	struct mtx		 vb_lock;	/* Buffer lock. */
140	term_pos_t		 vb_scr_size;	/* (b) Screen dimensions. */
141	int			 vb_flags;	/* (b) Flags. */
142#define	VBF_CURSOR	0x1	/* Cursor visible. */
143#define	VBF_STATIC	0x2	/* Buffer is statically allocated. */
144#define	VBF_MTX_INIT	0x4	/* Mutex initialized. */
145#define	VBF_SCROLL	0x8	/* scroll locked mode. */
146#define	VBF_HISTORY_FULL 0x10	/* All rows filled. */
147	int			 vb_history_size;
148#define	VBF_DEFAULT_HISTORY_SIZE	500
149	int			 vb_roffset;	/* (b) History rows offset. */
150	int			 vb_curroffset;	/* (b) Saved rows offset. */
151	term_pos_t		 vb_cursor;	/* (u) Cursor position. */
152	term_rect_t		 vb_dirtyrect;	/* (b) Dirty rectangle. */
153	struct vt_bufmask	 vb_dirtymask;	/* (b) Dirty bitmasks. */
154	term_char_t		*vb_buffer;	/* (u) Data buffer. */
155	term_char_t		**vb_rows;	/* (u) Array of rows */
156};
157
158void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *);
159void vtbuf_fill_locked(struct vt_buf *, const term_rect_t *, term_char_t);
160void vtbuf_init_early(struct vt_buf *);
161void vtbuf_init(struct vt_buf *, const term_pos_t *);
162void vtbuf_grow(struct vt_buf *, const term_pos_t *, int);
163void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t);
164void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *);
165void vtbuf_cursor_visibility(struct vt_buf *, int);
166void vtbuf_undirty(struct vt_buf *, term_rect_t *, struct vt_bufmask *);
167void vtbuf_sethistory_size(struct vt_buf *, int);
168
169#define	VTBUF_SLCK_ENABLE(vb)	(vb)->vb_flags |= VBF_SCROLL
170#define	VTBUF_SLCK_DISABLE(vb)	(vb)->vb_flags &= ~VBF_SCROLL
171
172#define	VTBUF_MAX_HEIGHT(vb) \
173	((vb)->vb_history_size)
174#define	VTBUF_GET_ROW(vb, r) \
175	((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)])
176#define	VTBUF_GET_FIELD(vb, r, c) \
177	((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
178#define	VTBUF_FIELD(vb, r, c) \
179	((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
180#define	VTBUF_ISCURSOR(vb, r, c) \
181	((vb)->vb_flags & VBF_CURSOR && \
182	(vb)->vb_cursor.tp_row == (r) && (vb)->vb_cursor.tp_col == (c))
183#define	VTBUF_DIRTYROW(mask, row) \
184	((mask)->vbm_row & ((uint64_t)1 << ((row) % 64)))
185#define	VTBUF_DIRTYCOL(mask, col) \
186	((mask)->vbm_col & ((uint64_t)1 << ((col) % 64)))
187#define	VTBUF_SPACE_CHAR	(' ' | TC_WHITE << 26 | TC_BLACK << 29)
188
189#define	VHS_SET	0
190#define	VHS_CUR	1
191#define	VHS_END	2
192int vthistory_seek(struct vt_buf *, int offset, int whence);
193void vthistory_addlines(struct vt_buf *vb, int offset);
194void vthistory_getpos(const struct vt_buf *, unsigned int *offset);
195
196/*
197 * Per-window datastructure.
198 */
199
200struct vt_window {
201	struct vt_device	*vw_device;	/* (c) Device. */
202	struct terminal		*vw_terminal;	/* (c) Terminal. */
203	struct vt_buf		 vw_buf;	/* (u) Screen buffer. */
204	struct vt_font		*vw_font;	/* (d) Graphical font. */
205	unsigned int		 vw_number;	/* (c) Window number. */
206	int			 vw_kbdmode;	/* (?) Keyboard mode. */
207	char			*vw_kbdsq;	/* Escape sequence queue*/
208	unsigned int		 vw_flags;	/* (d) Per-window flags. */
209#define	VWF_BUSY	0x1	/* Busy reconfiguring device. */
210#define	VWF_OPENED	0x2	/* TTY in use. */
211#define	VWF_SCROLL	0x4	/* Keys influence scrollback. */
212#define	VWF_CONSOLE	0x8	/* Kernel message console window. */
213#define	VWF_VTYLOCK	0x10	/* Prevent window switch. */
214#define	VWF_SWWAIT_REL	0x10000	/* Program wait for VT acquire is done. */
215#define	VWF_SWWAIT_ACQ	0x20000	/* Program wait for VT release is done. */
216	pid_t			 vw_pid;	/* Terminal holding process */
217	struct proc		*vw_proc;
218	struct vt_mode		 vw_smode;	/* switch mode */
219	struct callout		 vw_proc_dead_timer;
220	struct vt_window	*vw_switch_to;
221};
222
223#define	VT_AUTO		0		/* switching is automatic */
224#define	VT_PROCESS	1		/* switching controlled by prog */
225#define	VT_KERNEL	255		/* switching controlled in kernel */
226
227#define	IS_VT_PROC_MODE(vw)	((vw)->vw_smode.mode == VT_PROCESS)
228
229/*
230 * Per-device driver routines.
231 *
232 * vd_bitbltchr is used when the driver operates in graphics mode, while
233 * vd_putchar is used when the driver operates in text mode
234 * (VDF_TEXTMODE).
235 */
236
237typedef int vd_init_t(struct vt_device *vd);
238typedef void vd_postswitch_t(struct vt_device *vd);
239typedef void vd_blank_t(struct vt_device *vd, term_color_t color);
240typedef void vd_bitbltchr_t(struct vt_device *vd, const uint8_t *src,
241    vt_axis_t top, vt_axis_t left, unsigned int width, unsigned int height,
242    term_color_t fg, term_color_t bg);
243typedef void vd_putchar_t(struct vt_device *vd, term_char_t,
244    vt_axis_t top, vt_axis_t left, term_color_t fg, term_color_t bg);
245
246struct vt_driver {
247	/* Console attachment. */
248	vd_init_t	*vd_init;
249
250	/* Drawing. */
251	vd_blank_t	*vd_blank;
252	vd_bitbltchr_t	*vd_bitbltchr;
253
254	/* Text mode operation. */
255	vd_putchar_t	*vd_putchar;
256
257	/* Update display setting on vt switch. */
258	vd_postswitch_t	*vd_postswitch;
259
260	/* Priority to know which one can override */
261	int		vd_priority;
262#define	VD_PRIORITY_DUMB	10
263#define	VD_PRIORITY_GENERIC	100
264#define	VD_PRIORITY_SPECIFIC	1000
265};
266
267/*
268 * Console device madness.
269 *
270 * Utility macro to make early vt(4) instances work.
271 */
272
273extern const struct terminal_class vt_termclass;
274void vt_upgrade(struct vt_device *vd);
275
276#define	PIXEL_WIDTH(w)	((w) / 8)
277#define	PIXEL_HEIGHT(h)	((h) / 16)
278
279#ifndef VT_FB_DEFAULT_WIDTH
280#define	VT_FB_DEFAULT_WIDTH	640
281#endif
282#ifndef VT_FB_DEFAULT_HEIGHT
283#define	VT_FB_DEFAULT_HEIGHT	480
284#endif
285
286#define	VT_CONSDEV_DECLARE(driver, width, height, softc)		\
287static struct terminal	driver ## _consterm;				\
288static struct vt_window	driver ## _conswindow;				\
289static struct vt_device	driver ## _consdev = {				\
290	.vd_driver = &driver,						\
291	.vd_softc = (softc),						\
292	.vd_flags = VDF_INVALID,					\
293	.vd_windows = { [VT_CONSWINDOW] =  &driver ## _conswindow, },	\
294	.vd_curwindow = &driver ## _conswindow,				\
295};									\
296static term_char_t	driver ## _constextbuf[(width) * 		\
297	    (VBF_DEFAULT_HISTORY_SIZE)];				\
298static term_char_t	*driver ## _constextbufrows[			\
299	    VBF_DEFAULT_HISTORY_SIZE];					\
300static struct vt_window	driver ## _conswindow = {			\
301	.vw_number = VT_CONSWINDOW,					\
302	.vw_flags = VWF_CONSOLE,					\
303	.vw_buf = {							\
304		.vb_buffer = driver ## _constextbuf,			\
305		.vb_rows = driver ## _constextbufrows,			\
306		.vb_history_size = VBF_DEFAULT_HISTORY_SIZE,		\
307		.vb_curroffset = 0,					\
308		.vb_roffset = 0,					\
309		.vb_flags = VBF_STATIC,					\
310		.vb_scr_size = {					\
311			.tp_row = height,				\
312			.tp_col = width,				\
313		},							\
314	},								\
315	.vw_device = &driver ## _consdev,				\
316	.vw_terminal = &driver ## _consterm,				\
317	.vw_kbdmode = K_XLATE,						\
318};									\
319TERMINAL_DECLARE_EARLY(driver ## _consterm, vt_termclass,		\
320    &driver ## _conswindow);						\
321SYSINIT(vt_early_cons, SI_SUB_INT_CONFIG_HOOKS, SI_ORDER_ANY,		\
322    vt_upgrade, &driver ## _consdev)
323
324/*
325 * Fonts.
326 *
327 * Remapping tables are used to map Unicode points to glyphs.  They need
328 * to be sorted, because vtfont_lookup() performs a binary search.  Each
329 * font has two remapping tables, for normal and bold.  When a character
330 * is not present in bold, it uses a normal glyph.  When no glyph is
331 * available, it uses glyph 0, which is normally equal to U+FFFD.
332 */
333
334struct vt_font_map {
335	uint32_t		 vfm_src;
336	uint16_t		 vfm_dst;
337	uint16_t		 vfm_len;
338};
339
340struct vt_font {
341	struct vt_font_map	*vf_bold;
342	struct vt_font_map	*vf_normal;
343	uint8_t			*vf_bytes;
344	unsigned int		 vf_height, vf_width,
345				 vf_normal_length, vf_bold_length;
346	unsigned int		 vf_refcount;
347};
348
349const uint8_t	*vtfont_lookup(const struct vt_font *vf, term_char_t c);
350struct vt_font	*vtfont_ref(struct vt_font *vf);
351void		 vtfont_unref(struct vt_font *vf);
352int		 vtfont_load(vfnt_t *f, struct vt_font **ret);
353
354/* Sysmouse. */
355void sysmouse_process_event(mouse_info_t *mi);
356
357#endif /* !_DEV_VT_VT_H_ */
358