vt.h revision 257972 
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 257972 2013-11-11 11:53:08Z 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_pos_t		 vb_mark_start;	/* (b) Copy region start. */
153	term_pos_t		 vb_mark_end;	/* (b) Copy region end. */
154	term_rect_t		 vb_dirtyrect;	/* (b) Dirty rectangle. */
155	struct vt_bufmask	 vb_dirtymask;	/* (b) Dirty bitmasks. */
156	term_char_t		*vb_buffer;	/* (u) Data buffer. */
157	term_char_t		**vb_rows;	/* (u) Array of rows */
158};
159
160void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *);
161void vtbuf_fill_locked(struct vt_buf *, const term_rect_t *, term_char_t);
162void vtbuf_init_early(struct vt_buf *);
163void vtbuf_init(struct vt_buf *, const term_pos_t *);
164void vtbuf_grow(struct vt_buf *, const term_pos_t *, int);
165void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t);
166void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *);
167void vtbuf_cursor_visibility(struct vt_buf *, int);
168void vtbuf_undirty(struct vt_buf *, term_rect_t *, struct vt_bufmask *);
169void vtbuf_sethistory_size(struct vt_buf *, int);
170
171#define	VTBUF_SLCK_ENABLE(vb)	(vb)->vb_flags |= VBF_SCROLL
172#define	VTBUF_SLCK_DISABLE(vb)	(vb)->vb_flags &= ~VBF_SCROLL
173
174#define	VTBUF_MAX_HEIGHT(vb) \
175	((vb)->vb_history_size)
176#define	VTBUF_GET_ROW(vb, r) \
177	((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)])
178#define	VTBUF_GET_FIELD(vb, r, c) \
179	((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
180#define	VTBUF_FIELD(vb, r, c) \
181	((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
182#define	VTBUF_ISCURSOR(vb, r, c) \
183	((vb)->vb_flags & VBF_CURSOR && \
184	(vb)->vb_cursor.tp_row == (r) && (vb)->vb_cursor.tp_col == (c))
185#define	VTBUF_DIRTYROW(mask, row) \
186	((mask)->vbm_row & ((uint64_t)1 << ((row) % 64)))
187#define	VTBUF_DIRTYCOL(mask, col) \
188	((mask)->vbm_col & ((uint64_t)1 << ((col) % 64)))
189#define	VTBUF_SPACE_CHAR	(' ' | TC_WHITE << 26 | TC_BLACK << 29)
190
191#define	VHS_SET	0
192#define	VHS_CUR	1
193#define	VHS_END	2
194int vthistory_seek(struct vt_buf *, int offset, int whence);
195void vthistory_addlines(struct vt_buf *vb, int offset);
196void vthistory_getpos(const struct vt_buf *, unsigned int *offset);
197
198/*
199 * Per-window datastructure.
200 */
201
202struct vt_window {
203	struct vt_device	*vw_device;	/* (c) Device. */
204	struct terminal		*vw_terminal;	/* (c) Terminal. */
205	struct vt_buf		 vw_buf;	/* (u) Screen buffer. */
206	struct vt_font		*vw_font;	/* (d) Graphical font. */
207	unsigned int		 vw_number;	/* (c) Window number. */
208	int			 vw_kbdmode;	/* (?) Keyboard mode. */
209	char			*vw_kbdsq;	/* Escape sequence queue*/
210	unsigned int		 vw_flags;	/* (d) Per-window flags. */
211#define	VWF_BUSY	0x1	/* Busy reconfiguring device. */
212#define	VWF_OPENED	0x2	/* TTY in use. */
213#define	VWF_SCROLL	0x4	/* Keys influence scrollback. */
214#define	VWF_CONSOLE	0x8	/* Kernel message console window. */
215#define	VWF_VTYLOCK	0x10	/* Prevent window switch. */
216#define	VWF_SWWAIT_REL	0x10000	/* Program wait for VT acquire is done. */
217#define	VWF_SWWAIT_ACQ	0x20000	/* Program wait for VT release is done. */
218	pid_t			 vw_pid;	/* Terminal holding process */
219	struct proc		*vw_proc;
220	struct vt_mode		 vw_smode;	/* switch mode */
221	struct callout		 vw_proc_dead_timer;
222	struct vt_window	*vw_switch_to;
223};
224
225#define	VT_AUTO		0		/* switching is automatic */
226#define	VT_PROCESS	1		/* switching controlled by prog */
227#define	VT_KERNEL	255		/* switching controlled in kernel */
228
229#define	IS_VT_PROC_MODE(vw)	((vw)->vw_smode.mode == VT_PROCESS)
230
231/*
232 * Per-device driver routines.
233 *
234 * vd_bitbltchr is used when the driver operates in graphics mode, while
235 * vd_putchar is used when the driver operates in text mode
236 * (VDF_TEXTMODE).
237 */
238
239typedef int vd_init_t(struct vt_device *vd);
240typedef void vd_postswitch_t(struct vt_device *vd);
241typedef void vd_blank_t(struct vt_device *vd, term_color_t color);
242typedef void vd_bitbltchr_t(struct vt_device *vd, const uint8_t *src,
243    vt_axis_t top, vt_axis_t left, unsigned int width, unsigned int height,
244    term_color_t fg, term_color_t bg);
245typedef void vd_putchar_t(struct vt_device *vd, term_char_t,
246    vt_axis_t top, vt_axis_t left, term_color_t fg, term_color_t bg);
247
248struct vt_driver {
249	/* Console attachment. */
250	vd_init_t	*vd_init;
251
252	/* Drawing. */
253	vd_blank_t	*vd_blank;
254	vd_bitbltchr_t	*vd_bitbltchr;
255
256	/* Text mode operation. */
257	vd_putchar_t	*vd_putchar;
258
259	/* Update display setting on vt switch. */
260	vd_postswitch_t	*vd_postswitch;
261
262	/* Priority to know which one can override */
263	int		vd_priority;
264#define	VD_PRIORITY_DUMB	10
265#define	VD_PRIORITY_GENERIC	100
266#define	VD_PRIORITY_SPECIFIC	1000
267};
268
269/*
270 * Console device madness.
271 *
272 * Utility macro to make early vt(4) instances work.
273 */
274
275extern const struct terminal_class vt_termclass;
276void vt_upgrade(struct vt_device *vd);
277
278#define	PIXEL_WIDTH(w)	((w) / 8)
279#define	PIXEL_HEIGHT(h)	((h) / 16)
280
281#ifndef VT_FB_DEFAULT_WIDTH
282#define	VT_FB_DEFAULT_WIDTH	640
283#endif
284#ifndef VT_FB_DEFAULT_HEIGHT
285#define	VT_FB_DEFAULT_HEIGHT	480
286#endif
287
288#define	VT_CONSDEV_DECLARE(driver, width, height, softc)		\
289static struct terminal	driver ## _consterm;				\
290static struct vt_window	driver ## _conswindow;				\
291static struct vt_device	driver ## _consdev = {				\
292	.vd_driver = &driver,						\
293	.vd_softc = (softc),						\
294	.vd_flags = VDF_INVALID,					\
295	.vd_windows = { [VT_CONSWINDOW] =  &driver ## _conswindow, },	\
296	.vd_curwindow = &driver ## _conswindow,				\
297};									\
298static term_char_t	driver ## _constextbuf[(width) * 		\
299	    (VBF_DEFAULT_HISTORY_SIZE)];				\
300static term_char_t	*driver ## _constextbufrows[			\
301	    VBF_DEFAULT_HISTORY_SIZE];					\
302static struct vt_window	driver ## _conswindow = {			\
303	.vw_number = VT_CONSWINDOW,					\
304	.vw_flags = VWF_CONSOLE,					\
305	.vw_buf = {							\
306		.vb_buffer = driver ## _constextbuf,			\
307		.vb_rows = driver ## _constextbufrows,			\
308		.vb_history_size = VBF_DEFAULT_HISTORY_SIZE,		\
309		.vb_curroffset = 0,					\
310		.vb_roffset = 0,					\
311		.vb_flags = VBF_STATIC,					\
312		.vb_mark_start = {					\
313			.tp_row = 0,					\
314			.tp_col = 0,					\
315		},							\
316		.vb_mark_end = {					\
317			.tp_row = 0,					\
318			.tp_col = 0,					\
319		},							\
320		.vb_scr_size = {					\
321			.tp_row = height,				\
322			.tp_col = width,				\
323		},							\
324	},								\
325	.vw_device = &driver ## _consdev,				\
326	.vw_terminal = &driver ## _consterm,				\
327	.vw_kbdmode = K_XLATE,						\
328};									\
329TERMINAL_DECLARE_EARLY(driver ## _consterm, vt_termclass,		\
330    &driver ## _conswindow);						\
331SYSINIT(vt_early_cons, SI_SUB_INT_CONFIG_HOOKS, SI_ORDER_ANY,		\
332    vt_upgrade, &driver ## _consdev)
333
334/*
335 * Fonts.
336 *
337 * Remapping tables are used to map Unicode points to glyphs.  They need
338 * to be sorted, because vtfont_lookup() performs a binary search.  Each
339 * font has two remapping tables, for normal and bold.  When a character
340 * is not present in bold, it uses a normal glyph.  When no glyph is
341 * available, it uses glyph 0, which is normally equal to U+FFFD.
342 */
343
344struct vt_font_map {
345	uint32_t		 vfm_src;
346	uint16_t		 vfm_dst;
347	uint16_t		 vfm_len;
348};
349
350struct vt_font {
351	struct vt_font_map	*vf_bold;
352	struct vt_font_map	*vf_normal;
353	uint8_t			*vf_bytes;
354	unsigned int		 vf_height, vf_width,
355				 vf_normal_length, vf_bold_length;
356	unsigned int		 vf_refcount;
357};
358
359struct mouse_cursor {
360	uint8_t map[64 * 64 / 8];
361	uint8_t mask[64 * 64 / 8];
362	uint8_t w;
363	uint8_t h;
364};
365
366const uint8_t	*vtfont_lookup(const struct vt_font *vf, term_char_t c);
367struct vt_font	*vtfont_ref(struct vt_font *vf);
368void		 vtfont_unref(struct vt_font *vf);
369int		 vtfont_load(vfnt_t *f, struct vt_font **ret);
370
371/* Sysmouse. */
372void sysmouse_process_event(mouse_info_t *mi);
373
374#endif /* !_DEV_VT_VT_H_ */
375