xref: /freebsd/sys/dev/vt/vt_core.c (revision d1854272b646306de6546f8e5702e8072051d7f6)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2009, 2013 The FreeBSD Foundation
5  *
6  * This software was developed by Ed Schouten under sponsorship from the
7  * FreeBSD Foundation.
8  *
9  * Portions of this software were developed by Oleksandr Rybalko
10  * under sponsorship from the FreeBSD Foundation.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 
34 #include <sys/param.h>
35 #include <sys/consio.h>
36 #include <sys/devctl.h>
37 #include <sys/eventhandler.h>
38 #include <sys/fbio.h>
39 #include <sys/font.h>
40 #include <sys/kbio.h>
41 #include <sys/kdb.h>
42 #include <sys/kernel.h>
43 #include <sys/linker.h>
44 #include <sys/lock.h>
45 #include <sys/malloc.h>
46 #include <sys/mutex.h>
47 #include <sys/splash.h>
48 #include <sys/power.h>
49 #include <sys/priv.h>
50 #include <sys/proc.h>
51 #include <sys/random.h>
52 #include <sys/reboot.h>
53 #include <sys/sbuf.h>
54 #include <sys/systm.h>
55 #include <sys/terminal.h>
56 
57 #include <dev/kbd/kbdreg.h>
58 #include <dev/vt/vt.h>
59 
60 #if defined(__i386__) || defined(__amd64__)
61 #include <machine/psl.h>
62 #include <machine/frame.h>
63 #endif
64 
65 static int vtterm_cngrab_noswitch(struct vt_device *, struct vt_window *);
66 static int vtterm_cnungrab_noswitch(struct vt_device *, struct vt_window *);
67 
68 static tc_bell_t	vtterm_bell;
69 static tc_cursor_t	vtterm_cursor;
70 static tc_putchar_t	vtterm_putchar;
71 static tc_fill_t	vtterm_fill;
72 static tc_copy_t	vtterm_copy;
73 static tc_pre_input_t	vtterm_pre_input;
74 static tc_post_input_t	vtterm_post_input;
75 static tc_param_t	vtterm_param;
76 static tc_done_t	vtterm_done;
77 
78 static tc_cnprobe_t	vtterm_cnprobe;
79 static tc_cngetc_t	vtterm_cngetc;
80 
81 static tc_cngrab_t	vtterm_cngrab;
82 static tc_cnungrab_t	vtterm_cnungrab;
83 
84 static tc_opened_t	vtterm_opened;
85 static tc_ioctl_t	vtterm_ioctl;
86 static tc_mmap_t	vtterm_mmap;
87 
88 static const struct terminal_class vt_termclass = {
89 	.tc_bell	= vtterm_bell,
90 	.tc_cursor	= vtterm_cursor,
91 	.tc_putchar	= vtterm_putchar,
92 	.tc_fill	= vtterm_fill,
93 	.tc_copy	= vtterm_copy,
94 	.tc_pre_input	= vtterm_pre_input,
95 	.tc_post_input	= vtterm_post_input,
96 	.tc_param	= vtterm_param,
97 	.tc_done	= vtterm_done,
98 
99 	.tc_cnprobe	= vtterm_cnprobe,
100 	.tc_cngetc	= vtterm_cngetc,
101 
102 	.tc_cngrab	= vtterm_cngrab,
103 	.tc_cnungrab	= vtterm_cnungrab,
104 
105 	.tc_opened	= vtterm_opened,
106 	.tc_ioctl	= vtterm_ioctl,
107 	.tc_mmap	= vtterm_mmap,
108 };
109 
110 /*
111  * Use a constant timer of 25 Hz to redraw the screen.
112  *
113  * XXX: In theory we should only fire up the timer when there is really
114  * activity. Unfortunately we cannot always start timers. We really
115  * don't want to process kernel messages synchronously, because it
116  * really slows down the system.
117  */
118 #define	VT_TIMERFREQ	25
119 
120 /* Bell pitch/duration. */
121 #define	VT_BELLDURATION	(SBT_1S / 20)
122 #define	VT_BELLPITCH	800
123 
124 #define	VT_UNIT(vw)	((vw)->vw_device->vd_unit * VT_MAXWINDOWS + \
125 			(vw)->vw_number)
126 
127 static SYSCTL_NODE(_kern, OID_AUTO, vt, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
128     "vt(4) parameters");
129 static VT_SYSCTL_INT(enable_altgr, 1, "Enable AltGr key (Do not assume R.Alt as Alt)");
130 static VT_SYSCTL_INT(enable_bell, 0, "Enable bell");
131 static VT_SYSCTL_INT(debug, 0, "vt(4) debug level");
132 static VT_SYSCTL_INT(deadtimer, 15, "Time to wait busy process in VT_PROCESS mode");
133 static VT_SYSCTL_INT(suspendswitch, 1, "Switch to VT0 before suspend");
134 
135 /* Slow down and dont rely on timers and interrupts */
136 static VT_SYSCTL_INT(slow_down, 0, "Non-zero make console slower and synchronous.");
137 
138 /* Allow to disable some keyboard combinations. */
139 static VT_SYSCTL_INT(kbd_halt, 1, "Enable halt keyboard combination.  "
140     "See kbdmap(5) to configure.");
141 static VT_SYSCTL_INT(kbd_poweroff, 1, "Enable Power Off keyboard combination.  "
142     "See kbdmap(5) to configure.");
143 static VT_SYSCTL_INT(kbd_reboot, 1, "Enable reboot keyboard combination.  "
144     "See kbdmap(5) to configure (typically Ctrl-Alt-Delete).");
145 static VT_SYSCTL_INT(kbd_debug, 1, "Enable key combination to enter debugger.  "
146     "See kbdmap(5) to configure (typically Ctrl-Alt-Esc).");
147 static VT_SYSCTL_INT(kbd_panic, 0, "Enable request to panic.  "
148     "See kbdmap(5) to configure.");
149 
150 /* Used internally, not a tunable. */
151 int vt_draw_logo_cpus;
152 VT_SYSCTL_INT(splash_cpu, 0, "Show logo CPUs during boot");
153 VT_SYSCTL_INT(splash_ncpu, 0, "Override number of logos displayed "
154     "(0 = do not override)");
155 VT_SYSCTL_INT(splash_cpu_style, 2, "Draw logo style "
156     "(0 = Alternate beastie, 1 = Beastie, 2 = Orb)");
157 VT_SYSCTL_INT(splash_cpu_duration, 10, "Hide logos after (seconds)");
158 
159 static unsigned int vt_unit = 0;
160 static MALLOC_DEFINE(M_VT, "vt", "vt device");
161 struct vt_device *main_vd = &vt_consdev;
162 
163 /* Boot logo. */
164 extern unsigned int vt_logo_width;
165 extern unsigned int vt_logo_height;
166 extern unsigned int vt_logo_depth;
167 extern unsigned char vt_logo_image[];
168 #ifndef DEV_SPLASH
169 #define	vtterm_draw_cpu_logos(...)	do {} while (0)
170 const unsigned int vt_logo_sprite_height;
171 #endif
172 
173 /*
174  * Console font. vt_font_loader will be filled with font data passed
175  * by loader. If there is no font passed by boot loader, we use built in
176  * default.
177  */
178 extern struct vt_font vt_font_default;
179 static struct vt_font vt_font_loader;
180 static struct vt_font *vt_font_assigned = &vt_font_default;
181 
182 #ifndef SC_NO_CUTPASTE
183 extern struct vt_mouse_cursor vt_default_mouse_pointer;
184 #endif
185 
186 static int signal_vt_rel(struct vt_window *);
187 static int signal_vt_acq(struct vt_window *);
188 static int finish_vt_rel(struct vt_window *, int, int *);
189 static int finish_vt_acq(struct vt_window *);
190 static int vt_window_switch(struct vt_window *);
191 static int vt_late_window_switch(struct vt_window *);
192 static int vt_proc_alive(struct vt_window *);
193 static void vt_resize(struct vt_device *);
194 static void vt_update_static(void *);
195 #ifndef SC_NO_CUTPASTE
196 static void vt_mouse_paste(void);
197 #endif
198 static void vt_suspend_handler(void *priv, enum power_stype stype);
199 static void vt_resume_handler(void *priv, enum power_stype stype);
200 
201 SET_DECLARE(vt_drv_set, struct vt_driver);
202 
203 #define	_VTDEFH	MAX(100, PIXEL_HEIGHT(VT_FB_MAX_HEIGHT))
204 #define	_VTDEFW	MAX(200, PIXEL_WIDTH(VT_FB_MAX_WIDTH))
205 
206 static struct terminal	vt_consterm;
207 static struct vt_window	vt_conswindow;
208 static term_char_t vt_consdrawn[PIXEL_HEIGHT(VT_FB_MAX_HEIGHT) * PIXEL_WIDTH(VT_FB_MAX_WIDTH)];
209 static term_color_t vt_consdrawnfg[PIXEL_HEIGHT(VT_FB_MAX_HEIGHT) * PIXEL_WIDTH(VT_FB_MAX_WIDTH)];
210 static term_color_t vt_consdrawnbg[PIXEL_HEIGHT(VT_FB_MAX_HEIGHT) * PIXEL_WIDTH(VT_FB_MAX_WIDTH)];
211 static bool vt_cons_pos_to_flush[PIXEL_HEIGHT(VT_FB_MAX_HEIGHT) * PIXEL_WIDTH(VT_FB_MAX_WIDTH)];
212 struct vt_device	vt_consdev = {
213 	.vd_driver = NULL,
214 	.vd_softc = NULL,
215 	.vd_prev_driver = NULL,
216 	.vd_prev_softc = NULL,
217 	.vd_flags = VDF_INVALID,
218 	.vd_windows = { [VT_CONSWINDOW] =  &vt_conswindow, },
219 	.vd_curwindow = &vt_conswindow,
220 	.vd_kbstate = 0,
221 
222 #ifndef SC_NO_CUTPASTE
223 	.vd_pastebuf = {
224 		.vpb_buf = NULL,
225 		.vpb_bufsz = 0,
226 		.vpb_len = 0
227 	},
228 	.vd_mcursor = &vt_default_mouse_pointer,
229 	.vd_mcursor_fg = TC_WHITE,
230 	.vd_mcursor_bg = TC_BLACK,
231 #endif
232 
233 	.vd_drawn = vt_consdrawn,
234 	.vd_drawnfg = vt_consdrawnfg,
235 	.vd_drawnbg = vt_consdrawnbg,
236 
237 	.vd_pos_to_flush = vt_cons_pos_to_flush,
238 };
239 static term_char_t vt_constextbuf[(_VTDEFW) * (VBF_DEFAULT_HISTORY_SIZE)];
240 static term_char_t *vt_constextbufrows[VBF_DEFAULT_HISTORY_SIZE];
241 static struct vt_window	vt_conswindow = {
242 	.vw_number = VT_CONSWINDOW,
243 	.vw_flags = VWF_CONSOLE,
244 	.vw_buf = {
245 		.vb_buffer = &vt_constextbuf[0],
246 		.vb_rows = &vt_constextbufrows[0],
247 		.vb_history_size = VBF_DEFAULT_HISTORY_SIZE,
248 		.vb_curroffset = 0,
249 		.vb_roffset = 0,
250 		.vb_flags = VBF_STATIC,
251 		.vb_mark_start = {.tp_row = 0, .tp_col = 0,},
252 		.vb_mark_end = {.tp_row = 0, .tp_col = 0,},
253 		.vb_scr_size = {
254 			.tp_row = _VTDEFH,
255 			.tp_col = _VTDEFW,
256 		},
257 	},
258 	.vw_device = &vt_consdev,
259 	.vw_terminal = &vt_consterm,
260 	.vw_kbdmode = K_XLATE,
261 	.vw_grabbed = 0,
262 	.vw_bell_pitch = VT_BELLPITCH,
263 	.vw_bell_duration = VT_BELLDURATION,
264 };
265 
266 /* Add to set of consoles. */
267 TERMINAL_DECLARE_EARLY(vt_consterm, vt_termclass, &vt_conswindow);
268 
269 /*
270  * Right after kmem is done to allow early drivers to use locking and allocate
271  * memory.
272  */
273 SYSINIT(vt_update_static, SI_SUB_KMEM, SI_ORDER_ANY, vt_update_static,
274     &vt_consdev);
275 /* Delay until all devices attached, to not waste time. */
276 SYSINIT(vt_early_cons, SI_SUB_INT_CONFIG_HOOKS, SI_ORDER_ANY, vt_upgrade,
277     &vt_consdev);
278 
279 static bool inside_vt_flush = false;
280 static bool inside_vt_window_switch = false;
281 
282 /* Initialize locks/mem depended members. */
283 static void
vt_update_static(void * dummy)284 vt_update_static(void *dummy)
285 {
286 
287 	if (!vty_enabled(VTY_VT))
288 		return;
289 	if (main_vd->vd_driver != NULL)
290 		printf("VT(%s): %s %ux%u\n", main_vd->vd_driver->vd_name,
291 		    (main_vd->vd_flags & VDF_TEXTMODE) ? "text" : "resolution",
292 		    main_vd->vd_width, main_vd->vd_height);
293 	else
294 		printf("VT: init without driver.\n");
295 
296 	mtx_init(&main_vd->vd_lock, "vtdev", NULL, MTX_DEF);
297 	mtx_init(&main_vd->vd_flush_lock, "vtdev flush", NULL, MTX_DEF);
298 	cv_init(&main_vd->vd_winswitch, "vtwswt");
299 }
300 
301 static void
vt_schedule_flush(struct vt_device * vd,int ms)302 vt_schedule_flush(struct vt_device *vd, int ms)
303 {
304 
305 	if (ms <= 0)
306 		/* Default to initial value. */
307 		ms = 1000 / VT_TIMERFREQ;
308 
309 	callout_schedule(&vd->vd_timer, hz / (1000 / ms));
310 }
311 
312 void
vt_resume_flush_timer(struct vt_window * vw,int ms)313 vt_resume_flush_timer(struct vt_window *vw, int ms)
314 {
315 	struct vt_device *vd = vw->vw_device;
316 
317 	if (vd->vd_curwindow != vw)
318 		return;
319 
320 	if (!(vd->vd_flags & VDF_ASYNC) ||
321 	    !atomic_cmpset_int(&vd->vd_timer_armed, 0, 1))
322 		return;
323 
324 	vt_schedule_flush(vd, ms);
325 }
326 
327 static void
vt_suspend_flush_timer(struct vt_device * vd)328 vt_suspend_flush_timer(struct vt_device *vd)
329 {
330 	/*
331 	 * As long as this function is called locked, callout_stop()
332 	 * has the same effect like callout_drain() with regard to
333 	 * preventing the callback function from executing.
334 	 */
335 	VT_LOCK_ASSERT(vd, MA_OWNED);
336 
337 	if (!(vd->vd_flags & VDF_ASYNC) ||
338 	    !atomic_cmpset_int(&vd->vd_timer_armed, 1, 0))
339 		return;
340 
341 	callout_stop(&vd->vd_timer);
342 }
343 
344 static void
vt_switch_timer(void * arg,int pending)345 vt_switch_timer(void *arg, int pending)
346 {
347 
348 	(void)vt_late_window_switch((struct vt_window *)arg);
349 }
350 
351 static int
vt_save_kbd_mode(struct vt_window * vw,keyboard_t * kbd)352 vt_save_kbd_mode(struct vt_window *vw, keyboard_t *kbd)
353 {
354 	int mode, ret;
355 
356 	mode = 0;
357 	ret = kbdd_ioctl(kbd, KDGKBMODE, (caddr_t)&mode);
358 	if (ret == ENOIOCTL)
359 		ret = ENODEV;
360 	if (ret != 0)
361 		return (ret);
362 
363 	vw->vw_kbdmode = mode;
364 
365 	return (0);
366 }
367 
368 static int
vt_update_kbd_mode(struct vt_window * vw,keyboard_t * kbd)369 vt_update_kbd_mode(struct vt_window *vw, keyboard_t *kbd)
370 {
371 	int ret;
372 
373 	ret = kbdd_ioctl(kbd, KDSKBMODE, (caddr_t)&vw->vw_kbdmode);
374 	if (ret == ENOIOCTL)
375 		ret = ENODEV;
376 
377 	return (ret);
378 }
379 
380 static int
vt_save_kbd_state(struct vt_window * vw,keyboard_t * kbd)381 vt_save_kbd_state(struct vt_window *vw, keyboard_t *kbd)
382 {
383 	int state, ret;
384 
385 	state = 0;
386 	ret = kbdd_ioctl(kbd, KDGKBSTATE, (caddr_t)&state);
387 	if (ret == ENOIOCTL)
388 		ret = ENODEV;
389 	if (ret != 0)
390 		return (ret);
391 
392 	vw->vw_kbdstate &= ~LOCK_MASK;
393 	vw->vw_kbdstate |= state & LOCK_MASK;
394 
395 	return (0);
396 }
397 
398 static int
vt_update_kbd_state(struct vt_window * vw,keyboard_t * kbd)399 vt_update_kbd_state(struct vt_window *vw, keyboard_t *kbd)
400 {
401 	int state, ret;
402 
403 	state = vw->vw_kbdstate & LOCK_MASK;
404 	ret = kbdd_ioctl(kbd, KDSKBSTATE, (caddr_t)&state);
405 	if (ret == ENOIOCTL)
406 		ret = ENODEV;
407 
408 	return (ret);
409 }
410 
411 static int
vt_save_kbd_leds(struct vt_window * vw,keyboard_t * kbd)412 vt_save_kbd_leds(struct vt_window *vw, keyboard_t *kbd)
413 {
414 	int leds, ret;
415 
416 	leds = 0;
417 	ret = kbdd_ioctl(kbd, KDGETLED, (caddr_t)&leds);
418 	if (ret == ENOIOCTL)
419 		ret = ENODEV;
420 	if (ret != 0)
421 		return (ret);
422 
423 	vw->vw_kbdstate &= ~LED_MASK;
424 	vw->vw_kbdstate |= leds & LED_MASK;
425 
426 	return (0);
427 }
428 
429 static int
vt_update_kbd_leds(struct vt_window * vw,keyboard_t * kbd)430 vt_update_kbd_leds(struct vt_window *vw, keyboard_t *kbd)
431 {
432 	int leds, ret;
433 
434 	leds = vw->vw_kbdstate & LED_MASK;
435 	ret = kbdd_ioctl(kbd, KDSETLED, (caddr_t)&leds);
436 	if (ret == ENOIOCTL)
437 		ret = ENODEV;
438 
439 	return (ret);
440 }
441 
442 static int
vt_window_preswitch(struct vt_window * vw,struct vt_window * curvw)443 vt_window_preswitch(struct vt_window *vw, struct vt_window *curvw)
444 {
445 
446 	DPRINTF(40, "%s\n", __func__);
447 	curvw->vw_switch_to = vw;
448 	/* Set timer to allow switch in case when process hang. */
449 	taskqueue_enqueue_timeout(taskqueue_thread, &vw->vw_timeout_task_dead, hz * vt_deadtimer);
450 	/* Notify process about vt switch attempt. */
451 	DPRINTF(30, "%s: Notify process.\n", __func__);
452 	signal_vt_rel(curvw);
453 
454 	return (0);
455 }
456 
457 static int
vt_window_postswitch(struct vt_window * vw)458 vt_window_postswitch(struct vt_window *vw)
459 {
460 
461 	signal_vt_acq(vw);
462 	return (0);
463 }
464 
465 /* vt_late_window_switch will do VT switching for regular case. */
466 static int
vt_late_window_switch(struct vt_window * vw)467 vt_late_window_switch(struct vt_window *vw)
468 {
469 	struct vt_window *curvw;
470 	int ret;
471 
472 	taskqueue_cancel_timeout(taskqueue_thread, &vw->vw_timeout_task_dead, NULL);
473 
474 	ret = vt_window_switch(vw);
475 	if (ret != 0) {
476 		/*
477 		 * If the switch hasn't happened, then return the VT
478 		 * to the current owner, if any.
479 		 */
480 		curvw = vw->vw_device->vd_curwindow;
481 		if (curvw->vw_smode.mode == VT_PROCESS)
482 			(void)vt_window_postswitch(curvw);
483 		return (ret);
484 	}
485 
486 	/* Notify owner process about terminal availability. */
487 	if (vw->vw_smode.mode == VT_PROCESS) {
488 		ret = vt_window_postswitch(vw);
489 	}
490 	return (ret);
491 }
492 
493 /* Switch window. */
494 static int
vt_proc_window_switch(struct vt_window * vw)495 vt_proc_window_switch(struct vt_window *vw)
496 {
497 	struct vt_window *curvw;
498 	struct vt_device *vd;
499 	int ret;
500 
501 	/* Prevent switching to NULL */
502 	if (vw == NULL) {
503 		DPRINTF(30, "%s: Cannot switch: vw is NULL.", __func__);
504 		return (EINVAL);
505 	}
506 	vd = vw->vw_device;
507 	curvw = vd->vd_curwindow;
508 
509 	/* Check if virtual terminal is locked */
510 	if (curvw->vw_flags & VWF_VTYLOCK)
511 		return (EBUSY);
512 
513 	/* Check if switch already in progress */
514 	if (curvw->vw_flags & VWF_SWWAIT_REL) {
515 		/* Check if switching to same window */
516 		if (curvw->vw_switch_to == vw) {
517 			DPRINTF(30, "%s: Switch in progress to same vw.", __func__);
518 			return (0);	/* success */
519 		}
520 		DPRINTF(30, "%s: Switch in progress to different vw.", __func__);
521 		return (EBUSY);
522 	}
523 
524 	/* Avoid switching to already selected window */
525 	if (vw == curvw) {
526 		DPRINTF(30, "%s: Cannot switch: vw == curvw.", __func__);
527 		return (0);	/* success */
528 	}
529 
530 	/*
531 	 * Early check for an attempt to switch to a non-functional VT.
532 	 * The same check is done in vt_window_switch(), but it's better
533 	 * to fail as early as possible to avoid needless pre-switch
534 	 * actions.
535 	 */
536 	VT_LOCK(vd);
537 	if ((vw->vw_flags & (VWF_OPENED|VWF_CONSOLE)) == 0) {
538 		VT_UNLOCK(vd);
539 		return (EINVAL);
540 	}
541 	VT_UNLOCK(vd);
542 
543 	/* Ask current process permission to switch away. */
544 	if (curvw->vw_smode.mode == VT_PROCESS) {
545 		DPRINTF(30, "%s: VT_PROCESS ", __func__);
546 		if (vt_proc_alive(curvw) == FALSE) {
547 			DPRINTF(30, "Dead. Cleaning.");
548 			/* Dead */
549 		} else {
550 			DPRINTF(30, "%s: Signaling process.\n", __func__);
551 			/* Alive, try to ask him. */
552 			ret = vt_window_preswitch(vw, curvw);
553 			/* Wait for process answer or timeout. */
554 			return (ret);
555 		}
556 		DPRINTF(30, "\n");
557 	}
558 
559 	ret = vt_late_window_switch(vw);
560 	return (ret);
561 }
562 
563 /* Switch window ignoring process locking. */
564 static int
vt_window_switch(struct vt_window * vw)565 vt_window_switch(struct vt_window *vw)
566 {
567 	struct vt_device *vd = vw->vw_device;
568 	struct vt_window *curvw = vd->vd_curwindow;
569 	keyboard_t *kbd;
570 
571 	if (inside_vt_window_switch && KERNEL_PANICKED())
572 		return (0);
573 
574 	inside_vt_window_switch = true;
575 
576 	if (kdb_active) {
577 		/*
578 		 * When grabbing the console for the debugger, avoid
579 		 * locks as that can result in deadlock.  While this
580 		 * could use try locks, that wouldn't really make a
581 		 * difference as there are sufficient barriers in
582 		 * debugger entry/exit to be equivalent to
583 		 * successfully try-locking here.
584 		 */
585 		if (!(vw->vw_flags & (VWF_OPENED|VWF_CONSOLE))) {
586 			inside_vt_window_switch = false;
587 			return (EINVAL);
588 		}
589 
590 		vd->vd_curwindow = vw;
591 		vd->vd_flags |= VDF_INVALID;
592 		if (vd->vd_driver->vd_postswitch)
593 			vd->vd_driver->vd_postswitch(vd);
594 		inside_vt_window_switch = false;
595 		return (0);
596 	}
597 
598 	VT_LOCK(vd);
599 	if (curvw == vw) {
600 		/*
601 		 * Nothing to do, except ensure the driver has the opportunity to
602 		 * switch to console mode when panicking, making sure the panic
603 		 * is readable (even when a GUI was using ttyv0).
604 		 */
605 		if ((kdb_active || KERNEL_PANICKED()) &&
606 		    vd->vd_driver->vd_postswitch)
607 			vd->vd_driver->vd_postswitch(vd);
608 		inside_vt_window_switch = false;
609 		VT_UNLOCK(vd);
610 		return (0);
611 	}
612 	if (!(vw->vw_flags & (VWF_OPENED|VWF_CONSOLE))) {
613 		inside_vt_window_switch = false;
614 		VT_UNLOCK(vd);
615 		return (EINVAL);
616 	}
617 
618 	vt_suspend_flush_timer(vd);
619 
620 	vd->vd_curwindow = vw;
621 	vd->vd_flags |= VDF_INVALID;
622 	cv_broadcast(&vd->vd_winswitch);
623 	VT_UNLOCK(vd);
624 
625 	if (vd->vd_driver->vd_postswitch)
626 		vd->vd_driver->vd_postswitch(vd);
627 
628 	vt_resume_flush_timer(vw, 0);
629 
630 	/* Restore per-window keyboard mode. */
631 	mtx_lock(&Giant);
632 	if ((kbd = vd->vd_keyboard) != NULL) {
633 		if (curvw->vw_kbdmode == K_XLATE)
634 			vt_save_kbd_state(curvw, kbd);
635 
636 		vt_update_kbd_mode(vw, kbd);
637 		vt_update_kbd_state(vw, kbd);
638 	}
639 	mtx_unlock(&Giant);
640 	DPRINTF(10, "%s(ttyv%d) done\n", __func__, vw->vw_number);
641 
642 	inside_vt_window_switch = false;
643 	return (0);
644 }
645 
646 void
vt_termsize(struct vt_device * vd,struct vt_font * vf,term_pos_t * size)647 vt_termsize(struct vt_device *vd, struct vt_font *vf, term_pos_t *size)
648 {
649 
650 	size->tp_row = vd->vd_height;
651 	if (vt_draw_logo_cpus)
652 		size->tp_row -= vt_logo_sprite_height;
653 	size->tp_col = vd->vd_width;
654 	if (vf != NULL) {
655 		size->tp_row = MIN(size->tp_row / vf->vf_height,
656 		    PIXEL_HEIGHT(VT_FB_MAX_HEIGHT));
657 		size->tp_col = MIN(size->tp_col / vf->vf_width,
658 		    PIXEL_WIDTH(VT_FB_MAX_WIDTH));
659 	}
660 }
661 
662 static inline void
vt_termrect(struct vt_device * vd,struct vt_font * vf,term_rect_t * rect)663 vt_termrect(struct vt_device *vd, struct vt_font *vf, term_rect_t *rect)
664 {
665 
666 	rect->tr_begin.tp_row = rect->tr_begin.tp_col = 0;
667 	if (vt_draw_logo_cpus)
668 		rect->tr_begin.tp_row = vt_logo_sprite_height;
669 
670 	rect->tr_end.tp_row = vd->vd_height;
671 	rect->tr_end.tp_col = vd->vd_width;
672 
673 	if (vf != NULL) {
674 		rect->tr_begin.tp_row =
675 		    howmany(rect->tr_begin.tp_row, vf->vf_height);
676 
677 		rect->tr_end.tp_row = MIN(rect->tr_end.tp_row / vf->vf_height,
678 		    PIXEL_HEIGHT(VT_FB_MAX_HEIGHT));
679 		rect->tr_end.tp_col = MIN(rect->tr_end.tp_col / vf->vf_width,
680 		    PIXEL_WIDTH(VT_FB_MAX_WIDTH));
681 	}
682 }
683 
684 void
vt_winsize(struct vt_device * vd,struct vt_font * vf,struct winsize * size)685 vt_winsize(struct vt_device *vd, struct vt_font *vf, struct winsize *size)
686 {
687 
688 	size->ws_ypixel = vd->vd_height;
689 	if (vt_draw_logo_cpus)
690 		size->ws_ypixel -= vt_logo_sprite_height;
691 	size->ws_row = size->ws_ypixel;
692 	size->ws_col = size->ws_xpixel = vd->vd_width;
693 	if (vf != NULL) {
694 		size->ws_row = MIN(size->ws_row / vf->vf_height,
695 		    PIXEL_HEIGHT(VT_FB_MAX_HEIGHT));
696 		size->ws_col = MIN(size->ws_col / vf->vf_width,
697 		    PIXEL_WIDTH(VT_FB_MAX_WIDTH));
698 	}
699 }
700 
701 void
vt_compute_drawable_area(struct vt_window * vw)702 vt_compute_drawable_area(struct vt_window *vw)
703 {
704 	struct vt_device *vd;
705 	struct vt_font *vf;
706 	vt_axis_t height;
707 
708 	vd = vw->vw_device;
709 
710 	if (vw->vw_font == NULL) {
711 		vw->vw_draw_area.tr_begin.tp_col = 0;
712 		vw->vw_draw_area.tr_begin.tp_row = 0;
713 		if (vt_draw_logo_cpus)
714 			vw->vw_draw_area.tr_begin.tp_row = vt_logo_sprite_height;
715 		vw->vw_draw_area.tr_end.tp_col = vd->vd_width;
716 		vw->vw_draw_area.tr_end.tp_row = vd->vd_height;
717 		return;
718 	}
719 
720 	vf = vw->vw_font;
721 
722 	/*
723 	 * Compute the drawable area, so that the text is centered on
724 	 * the screen.
725 	 */
726 
727 	height = vd->vd_height;
728 	if (vt_draw_logo_cpus)
729 		height -= vt_logo_sprite_height;
730 	vw->vw_draw_area.tr_begin.tp_col = (vd->vd_width % vf->vf_width) / 2;
731 	vw->vw_draw_area.tr_begin.tp_row = (height % vf->vf_height) / 2;
732 	if (vt_draw_logo_cpus)
733 		vw->vw_draw_area.tr_begin.tp_row += vt_logo_sprite_height;
734 	vw->vw_draw_area.tr_end.tp_col = vw->vw_draw_area.tr_begin.tp_col +
735 	    rounddown(vd->vd_width, vf->vf_width);
736 	vw->vw_draw_area.tr_end.tp_row = vw->vw_draw_area.tr_begin.tp_row +
737 	    rounddown(height, vf->vf_height);
738 }
739 
740 static void
vt_scroll(struct vt_window * vw,int offset,int whence)741 vt_scroll(struct vt_window *vw, int offset, int whence)
742 {
743 	int diff;
744 	term_pos_t size;
745 
746 	if ((vw->vw_flags & VWF_SCROLL) == 0)
747 		return;
748 
749 	vt_termsize(vw->vw_device, vw->vw_font, &size);
750 
751 	diff = vthistory_seek(&vw->vw_buf, offset, whence);
752 	if (diff)
753 		vw->vw_device->vd_flags |= VDF_INVALID;
754 	vt_resume_flush_timer(vw, 0);
755 }
756 
757 static int
vt_machine_kbdevent(struct vt_device * vd,int c)758 vt_machine_kbdevent(struct vt_device *vd, int c)
759 {
760 
761 	switch (c) {
762 	case SPCLKEY | DBG: /* kbdmap(5) keyword `debug`. */
763 		if (vt_kbd_debug) {
764 			kdb_enter(KDB_WHY_BREAK, "manual escape to debugger");
765 #if VT_ALT_TO_ESC_HACK
766 			/*
767 			 * There's an unfortunate conflict between SPCLKEY|DBG
768 			 * and VT_ALT_TO_ESC_HACK.  Just assume they didn't mean
769 			 * it if we got to here.
770 			 */
771 			vd->vd_kbstate &= ~ALKED;
772 #endif
773 		}
774 		return (1);
775 	case SPCLKEY | HALT: /* kbdmap(5) keyword `halt`. */
776 		if (vt_kbd_halt)
777 			shutdown_nice(RB_HALT);
778 		return (1);
779 	case SPCLKEY | PASTE: /* kbdmap(5) keyword `paste`. */
780 #ifndef SC_NO_CUTPASTE
781 		/* Insert text from cut-paste buffer. */
782 		vt_mouse_paste();
783 #endif
784 		break;
785 	case SPCLKEY | PDWN: /* kbdmap(5) keyword `pdwn`. */
786 		if (vt_kbd_poweroff)
787 			shutdown_nice(RB_HALT|RB_POWEROFF);
788 		return (1);
789 	case SPCLKEY | PNC: /* kbdmap(5) keyword `panic`. */
790 		/*
791 		 * Request to immediate panic if sysctl
792 		 * kern.vt.enable_panic_key allow it.
793 		 */
794 		if (vt_kbd_panic)
795 			panic("Forced by the panic key");
796 		return (1);
797 	case SPCLKEY | RBT: /* kbdmap(5) keyword `boot`. */
798 		if (vt_kbd_reboot)
799 			shutdown_nice(RB_AUTOBOOT);
800 		return (1);
801 	case SPCLKEY | SPSC: /* kbdmap(5) keyword `spsc`. */
802 		/* Force activatation/deactivation of the screen saver. */
803 		/* TODO */
804 		return (1);
805 	case SPCLKEY | STBY: /* XXX Not present in kbdcontrol parser. */
806 		/* Put machine into Stand-By mode. */
807 		power_pm_suspend(POWER_SSTATE_TRANSITION_STANDBY);
808 		return (1);
809 	case SPCLKEY | SUSP: /* kbdmap(5) keyword `susp`. */
810 		/* Suspend machine. */
811 		power_pm_suspend(POWER_SSTATE_TRANSITION_SUSPEND);
812 		return (1);
813 	}
814 
815 	return (0);
816 }
817 
818 static void
vt_scrollmode_kbdevent(struct vt_window * vw,int c,int console)819 vt_scrollmode_kbdevent(struct vt_window *vw, int c, int console)
820 {
821 	struct vt_device *vd;
822 	term_pos_t size;
823 
824 	vd = vw->vw_device;
825 	/* Only special keys handled in ScrollLock mode */
826 	if ((c & SPCLKEY) == 0)
827 		return;
828 
829 	c &= ~SPCLKEY;
830 
831 	if (console == 0) {
832 		if (c >= F_SCR && c <= MIN(L_SCR, F_SCR + VT_MAXWINDOWS - 1)) {
833 			vw = vd->vd_windows[c - F_SCR];
834 			vt_proc_window_switch(vw);
835 			return;
836 		}
837 		VT_LOCK(vd);
838 	}
839 
840 	switch (c) {
841 	case SLK: {
842 		/* Turn scrolling off. */
843 		vt_scroll(vw, 0, VHS_END);
844 		VTBUF_SLCK_DISABLE(&vw->vw_buf);
845 		vw->vw_flags &= ~VWF_SCROLL;
846 		break;
847 	}
848 	case FKEY | F(49): /* Home key. */
849 		vt_scroll(vw, 0, VHS_SET);
850 		break;
851 	case FKEY | F(50): /* Arrow up. */
852 		vt_scroll(vw, -1, VHS_CUR);
853 		break;
854 	case FKEY | F(51): /* Page up. */
855 		vt_termsize(vd, vw->vw_font, &size);
856 		vt_scroll(vw, -size.tp_row, VHS_CUR);
857 		break;
858 	case FKEY | F(57): /* End key. */
859 		vt_scroll(vw, 0, VHS_END);
860 		break;
861 	case FKEY | F(58): /* Arrow down. */
862 		vt_scroll(vw, 1, VHS_CUR);
863 		break;
864 	case FKEY | F(59): /* Page down. */
865 		vt_termsize(vd, vw->vw_font, &size);
866 		vt_scroll(vw, size.tp_row, VHS_CUR);
867 		break;
868 	}
869 
870 	if (console == 0)
871 		VT_UNLOCK(vd);
872 }
873 
874 static int
vt_processkey(keyboard_t * kbd,struct vt_device * vd,int c)875 vt_processkey(keyboard_t *kbd, struct vt_device *vd, int c)
876 {
877 	struct vt_window *vw = vd->vd_curwindow;
878 
879 #ifdef RANDOM_ENABLE_KBD
880 	random_harvest_queue(&c, sizeof(c), RANDOM_KEYBOARD);
881 #endif
882 #if VT_ALT_TO_ESC_HACK
883 	if (c & RELKEY) {
884 		switch (c & ~RELKEY) {
885 		case (SPCLKEY | RALT):
886 			if (vt_enable_altgr != 0)
887 				break;
888 		case (SPCLKEY | LALT):
889 			vd->vd_kbstate &= ~ALKED;
890 		}
891 		/* Other keys ignored for RELKEY event. */
892 		return (0);
893 	} else {
894 		switch (c & ~RELKEY) {
895 		case (SPCLKEY | RALT):
896 			if (vt_enable_altgr != 0)
897 				break;
898 		case (SPCLKEY | LALT):
899 			vd->vd_kbstate |= ALKED;
900 		}
901 	}
902 #else
903 	if (c & RELKEY)
904 		/* Other keys ignored for RELKEY event. */
905 		return (0);
906 #endif
907 
908 	if (vt_machine_kbdevent(vd, c))
909 		return (0);
910 
911 	if (vw->vw_flags & VWF_SCROLL) {
912 		vt_scrollmode_kbdevent(vw, c, 0/* Not a console */);
913 		/* Scroll mode keys handled, nothing to do more. */
914 		return (0);
915 	}
916 
917 	if (c & SPCLKEY) {
918 		c &= ~SPCLKEY;
919 
920 		if (c >= F_SCR && c <= MIN(L_SCR, F_SCR + VT_MAXWINDOWS - 1)) {
921 			vw = vd->vd_windows[c - F_SCR];
922 			vt_proc_window_switch(vw);
923 			return (0);
924 		}
925 
926 		switch (c) {
927 		case NEXT:
928 			/* Switch to next VT. */
929 			c = (vw->vw_number + 1) % VT_MAXWINDOWS;
930 			vw = vd->vd_windows[c];
931 			vt_proc_window_switch(vw);
932 			return (0);
933 		case PREV:
934 			/* Switch to previous VT. */
935 			c = (vw->vw_number + VT_MAXWINDOWS - 1) % VT_MAXWINDOWS;
936 			vw = vd->vd_windows[c];
937 			vt_proc_window_switch(vw);
938 			return (0);
939 		case SLK: {
940 			vt_save_kbd_state(vw, kbd);
941 			VT_LOCK(vd);
942 			if (vw->vw_kbdstate & SLKED) {
943 				/* Turn scrolling on. */
944 				vw->vw_flags |= VWF_SCROLL;
945 				VTBUF_SLCK_ENABLE(&vw->vw_buf);
946 			} else {
947 				/* Turn scrolling off. */
948 				vw->vw_flags &= ~VWF_SCROLL;
949 				VTBUF_SLCK_DISABLE(&vw->vw_buf);
950 				vt_scroll(vw, 0, VHS_END);
951 			}
952 			VT_UNLOCK(vd);
953 			break;
954 		}
955 		case BKEY | BTAB: /* Back tab (usually, shift+tab). */
956 			terminal_input_special(vw->vw_terminal, TKEY_BTAB);
957 			break;
958 		case FKEY | F(1):  case FKEY | F(2):  case FKEY | F(3):
959 		case FKEY | F(4):  case FKEY | F(5):  case FKEY | F(6):
960 		case FKEY | F(7):  case FKEY | F(8):  case FKEY | F(9):
961 		case FKEY | F(10): case FKEY | F(11): case FKEY | F(12):
962 			/* F1 through F12 keys. */
963 			terminal_input_special(vw->vw_terminal,
964 			    TKEY_F1 + c - (FKEY | F(1)));
965 			break;
966 		case FKEY | F(49): /* Home key. */
967 			terminal_input_special(vw->vw_terminal, TKEY_HOME);
968 			break;
969 		case FKEY | F(50): /* Arrow up. */
970 			terminal_input_special(vw->vw_terminal, TKEY_UP);
971 			break;
972 		case FKEY | F(51): /* Page up. */
973 			terminal_input_special(vw->vw_terminal, TKEY_PAGE_UP);
974 			break;
975 		case FKEY | F(53): /* Arrow left. */
976 			terminal_input_special(vw->vw_terminal, TKEY_LEFT);
977 			break;
978 		case FKEY | F(55): /* Arrow right. */
979 			terminal_input_special(vw->vw_terminal, TKEY_RIGHT);
980 			break;
981 		case FKEY | F(57): /* End key. */
982 			terminal_input_special(vw->vw_terminal, TKEY_END);
983 			break;
984 		case FKEY | F(58): /* Arrow down. */
985 			terminal_input_special(vw->vw_terminal, TKEY_DOWN);
986 			break;
987 		case FKEY | F(59): /* Page down. */
988 			terminal_input_special(vw->vw_terminal, TKEY_PAGE_DOWN);
989 			break;
990 		case FKEY | F(60): /* Insert key. */
991 			terminal_input_special(vw->vw_terminal, TKEY_INSERT);
992 			break;
993 		case FKEY | F(61): /* Delete key. */
994 			terminal_input_special(vw->vw_terminal, TKEY_DELETE);
995 			break;
996 		}
997 	} else if (KEYFLAGS(c) == 0) {
998 		/* Don't do UTF-8 conversion when doing raw mode. */
999 		if (vw->vw_kbdmode == K_XLATE) {
1000 #if VT_ALT_TO_ESC_HACK
1001 			if (vd->vd_kbstate & ALKED) {
1002 				/*
1003 				 * Prepend ESC sequence if one of ALT keys down.
1004 				 */
1005 				terminal_input_char(vw->vw_terminal, 0x1b);
1006 			}
1007 #endif
1008 #if defined(KDB)
1009 			kdb_alt_break(c, &vd->vd_altbrk);
1010 #endif
1011 			terminal_input_char(vw->vw_terminal, KEYCHAR(c));
1012 		} else
1013 			terminal_input_raw(vw->vw_terminal, c);
1014 	}
1015 	return (0);
1016 }
1017 
1018 static int
vt_kbdevent(keyboard_t * kbd,int event,void * arg)1019 vt_kbdevent(keyboard_t *kbd, int event, void *arg)
1020 {
1021 	struct vt_device *vd = arg;
1022 	int c;
1023 
1024 	switch (event) {
1025 	case KBDIO_KEYINPUT:
1026 		break;
1027 	case KBDIO_UNLOADING:
1028 		mtx_lock(&Giant);
1029 		vd->vd_keyboard = NULL;
1030 		kbd_release(kbd, (void *)vd);
1031 		mtx_unlock(&Giant);
1032 		return (0);
1033 	default:
1034 		return (EINVAL);
1035 	}
1036 
1037 	while ((c = kbdd_read_char(kbd, 0)) != NOKEY)
1038 		vt_processkey(kbd, vd, c);
1039 
1040 	return (0);
1041 }
1042 
1043 static int
vt_allocate_keyboard(struct vt_device * vd)1044 vt_allocate_keyboard(struct vt_device *vd)
1045 {
1046 	int		 grabbed, i, idx0, idx;
1047 	keyboard_t	*k0, *k;
1048 	keyboard_info_t	 ki;
1049 
1050 	/*
1051 	 * If vt_upgrade() happens while the console is grabbed, we are
1052 	 * potentially going to switch keyboard devices while the keyboard is in
1053 	 * use. Unwind the grabbing of the current keyboard first, then we will
1054 	 * re-grab the new keyboard below, before we return.
1055 	 */
1056 	if (vd->vd_curwindow == &vt_conswindow) {
1057 		grabbed = vd->vd_curwindow->vw_grabbed;
1058 		for (i = 0; i < grabbed; ++i)
1059 			vtterm_cnungrab_noswitch(vd, vd->vd_curwindow);
1060 	}
1061 
1062 	idx0 = kbd_allocate("kbdmux", -1, vd, vt_kbdevent, vd);
1063 	if (idx0 >= 0) {
1064 		DPRINTF(20, "%s: kbdmux allocated, idx = %d\n", __func__, idx0);
1065 		k0 = kbd_get_keyboard(idx0);
1066 
1067 		for (idx = kbd_find_keyboard2("*", -1, 0);
1068 		     idx != -1;
1069 		     idx = kbd_find_keyboard2("*", -1, idx + 1)) {
1070 			k = kbd_get_keyboard(idx);
1071 
1072 			if (idx == idx0 || KBD_IS_BUSY(k))
1073 				continue;
1074 
1075 			bzero(&ki, sizeof(ki));
1076 			strncpy(ki.kb_name, k->kb_name, sizeof(ki.kb_name));
1077 			ki.kb_name[sizeof(ki.kb_name) - 1] = '\0';
1078 			ki.kb_unit = k->kb_unit;
1079 
1080 			kbdd_ioctl(k0, KBADDKBD, (caddr_t) &ki);
1081 		}
1082 	} else {
1083 		DPRINTF(20, "%s: no kbdmux allocated\n", __func__);
1084 		idx0 = kbd_allocate("*", -1, vd, vt_kbdevent, vd);
1085 		if (idx0 < 0) {
1086 			DPRINTF(10, "%s: No keyboard found.\n", __func__);
1087 			return (-1);
1088 		}
1089 		k0 = kbd_get_keyboard(idx0);
1090 	}
1091 	vd->vd_keyboard = k0;
1092 	DPRINTF(20, "%s: vd_keyboard = %d\n", __func__,
1093 	    vd->vd_keyboard->kb_index);
1094 
1095 	if (vd->vd_curwindow == &vt_conswindow) {
1096 		for (i = 0; i < grabbed; ++i)
1097 			vtterm_cngrab_noswitch(vd, vd->vd_curwindow);
1098 	}
1099 
1100 	return (idx0);
1101 }
1102 
1103 #define DEVCTL_LEN 64
1104 static void
vtterm_devctl(bool enabled,bool hushed,int hz,sbintime_t duration)1105 vtterm_devctl(bool enabled, bool hushed, int hz, sbintime_t duration)
1106 {
1107 	struct sbuf sb;
1108 	char *buf;
1109 
1110 	buf = malloc(DEVCTL_LEN, M_VT, M_NOWAIT);
1111 	if (buf == NULL)
1112 		return;
1113 	sbuf_new(&sb, buf, DEVCTL_LEN, SBUF_FIXEDLEN);
1114 	sbuf_printf(&sb, "enabled=%s hushed=%s hz=%d duration_ms=%d",
1115 	    enabled ? "true" : "false", hushed ? "true" : "false",
1116 	    hz, (int)(duration / SBT_1MS));
1117 	sbuf_finish(&sb);
1118 	if (sbuf_error(&sb) == 0)
1119 		devctl_notify("VT", "BELL", "RING", sbuf_data(&sb));
1120 	sbuf_delete(&sb);
1121 	free(buf, M_VT);
1122 }
1123 
1124 static void
vtterm_bell(struct terminal * tm)1125 vtterm_bell(struct terminal *tm)
1126 {
1127 	struct vt_window *vw = tm->tm_softc;
1128 	struct vt_device *vd = vw->vw_device;
1129 
1130 	vtterm_devctl(vt_enable_bell, vd->vd_flags & VDF_QUIET_BELL,
1131 	    vw->vw_bell_pitch, vw->vw_bell_duration);
1132 
1133 	if (!vt_enable_bell)
1134 		return;
1135 
1136 	if (vd->vd_flags & VDF_QUIET_BELL)
1137 		return;
1138 
1139 	if (vw->vw_bell_pitch == 0 ||
1140 	    vw->vw_bell_duration == 0)
1141 		return;
1142 
1143 	sysbeep(vw->vw_bell_pitch, vw->vw_bell_duration);
1144 }
1145 
1146 /*
1147  * Beep with user-provided frequency and duration as specified by a KDMKTONE
1148  * ioctl (compatible with Linux).  The frequency is specified as a 8254 PIT
1149  * divisor for a 1.19MHz clock.
1150  *
1151  * See https://tldp.org/LDP/lpg/node83.html.
1152  */
1153 static void
vtterm_beep(struct terminal * tm,u_int param)1154 vtterm_beep(struct terminal *tm, u_int param)
1155 {
1156 	u_int freq;
1157 	sbintime_t period;
1158 	struct vt_window *vw = tm->tm_softc;
1159 	struct vt_device *vd = vw->vw_device;
1160 
1161 	if ((param == 0) || ((param & 0xffff) == 0)) {
1162 		vtterm_bell(tm);
1163 		return;
1164 	}
1165 
1166 	/* XXX period unit is supposed to be "timer ticks." */
1167 	period = ((param >> 16) & 0xffff) * SBT_1MS;
1168 	freq = 1193182 / (param & 0xffff);
1169 
1170 	vtterm_devctl(vt_enable_bell, vd->vd_flags & VDF_QUIET_BELL,
1171 	    freq, period);
1172 
1173 	if (!vt_enable_bell)
1174 		return;
1175 
1176 	sysbeep(freq, period);
1177 }
1178 
1179 static void
vtterm_cursor(struct terminal * tm,const term_pos_t * p)1180 vtterm_cursor(struct terminal *tm, const term_pos_t *p)
1181 {
1182 	struct vt_window *vw = tm->tm_softc;
1183 
1184 	vtbuf_cursor_position(&vw->vw_buf, p);
1185 }
1186 
1187 static void
vtterm_putchar(struct terminal * tm,const term_pos_t * p,term_char_t c)1188 vtterm_putchar(struct terminal *tm, const term_pos_t *p, term_char_t c)
1189 {
1190 	struct vt_window *vw = tm->tm_softc;
1191 
1192 	vtbuf_putchar(&vw->vw_buf, p, c);
1193 }
1194 
1195 static void
vtterm_fill(struct terminal * tm,const term_rect_t * r,term_char_t c)1196 vtterm_fill(struct terminal *tm, const term_rect_t *r, term_char_t c)
1197 {
1198 	struct vt_window *vw = tm->tm_softc;
1199 
1200 	vtbuf_fill(&vw->vw_buf, r, c);
1201 }
1202 
1203 static void
vtterm_copy(struct terminal * tm,const term_rect_t * r,const term_pos_t * p)1204 vtterm_copy(struct terminal *tm, const term_rect_t *r,
1205     const term_pos_t *p)
1206 {
1207 	struct vt_window *vw = tm->tm_softc;
1208 
1209 	vtbuf_copy(&vw->vw_buf, r, p);
1210 }
1211 
1212 static void
vtterm_param(struct terminal * tm,int cmd,unsigned int arg)1213 vtterm_param(struct terminal *tm, int cmd, unsigned int arg)
1214 {
1215 	struct vt_window *vw = tm->tm_softc;
1216 
1217 	switch (cmd) {
1218 	case TP_SETLOCALCURSOR:
1219 		/*
1220 		 * 0 means normal (usually block), 1 means hidden, and
1221 		 * 2 means blinking (always block) for compatibility with
1222 		 * syscons.  We don't support any changes except hiding,
1223 		 * so must map 2 to 0.
1224 		 */
1225 		arg = (arg == 1) ? 0 : 1;
1226 		/* FALLTHROUGH */
1227 	case TP_SHOWCURSOR:
1228 		vtbuf_cursor_visibility(&vw->vw_buf, arg);
1229 		vt_resume_flush_timer(vw, 0);
1230 		break;
1231 	case TP_MOUSE:
1232 		vw->vw_mouse_level = arg;
1233 		break;
1234 	case TP_SETBELLPD:
1235 		vw->vw_bell_pitch = TP_SETBELLPD_PITCH(arg);
1236 		vw->vw_bell_duration =
1237 		    TICKS_2_MSEC(TP_SETBELLPD_DURATION(arg)) * SBT_1MS;
1238 		break;
1239 	}
1240 }
1241 
1242 void
vt_determine_colors(term_char_t c,int cursor,term_color_t * fg,term_color_t * bg)1243 vt_determine_colors(term_char_t c, int cursor,
1244     term_color_t *fg, term_color_t *bg)
1245 {
1246 	term_color_t tmp;
1247 	int invert;
1248 
1249 	invert = 0;
1250 
1251 	*fg = TCHAR_FGCOLOR(c);
1252 	if (TCHAR_FORMAT(c) & TF_BOLD)
1253 		*fg = TCOLOR_LIGHT(*fg);
1254 	*bg = TCHAR_BGCOLOR(c);
1255 	if (TCHAR_FORMAT(c) & TF_BLINK)
1256 		*bg = TCOLOR_LIGHT(*bg);
1257 
1258 	if (TCHAR_FORMAT(c) & TF_REVERSE)
1259 		invert ^= 1;
1260 	if (cursor)
1261 		invert ^= 1;
1262 
1263 	if (invert) {
1264 		tmp = *fg;
1265 		*fg = *bg;
1266 		*bg = tmp;
1267 	}
1268 }
1269 
1270 #ifndef SC_NO_CUTPASTE
1271 int
vt_is_cursor_in_area(const struct vt_device * vd,const term_rect_t * area)1272 vt_is_cursor_in_area(const struct vt_device *vd, const term_rect_t *area)
1273 {
1274 	unsigned int mx, my;
1275 
1276 	/*
1277 	 * We use the cursor position saved during the current refresh,
1278 	 * in case the cursor moved since.
1279 	 */
1280 	mx = vd->vd_mx_drawn + vd->vd_curwindow->vw_draw_area.tr_begin.tp_col;
1281 	my = vd->vd_my_drawn + vd->vd_curwindow->vw_draw_area.tr_begin.tp_row;
1282 
1283 	if (mx >= area->tr_end.tp_col ||
1284 	    mx + vd->vd_mcursor->width <= area->tr_begin.tp_col ||
1285 	    my >= area->tr_end.tp_row ||
1286 	    my + vd->vd_mcursor->height <= area->tr_begin.tp_row)
1287 		return (0);
1288 	return (1);
1289 }
1290 
1291 static void
vt_mark_mouse_position_as_dirty(struct vt_device * vd,int locked)1292 vt_mark_mouse_position_as_dirty(struct vt_device *vd, int locked)
1293 {
1294 	term_rect_t area;
1295 	struct vt_window *vw;
1296 	struct vt_font *vf;
1297 	int x, y;
1298 
1299 	vw = vd->vd_curwindow;
1300 	vf = vw->vw_font;
1301 
1302 	x = vd->vd_mx_drawn;
1303 	y = vd->vd_my_drawn;
1304 
1305 	if (vf != NULL) {
1306 		area.tr_begin.tp_col = x / vf->vf_width;
1307 		area.tr_begin.tp_row = y / vf->vf_height;
1308 		area.tr_end.tp_col =
1309 		    ((x + vd->vd_mcursor->width) / vf->vf_width) + 1;
1310 		area.tr_end.tp_row =
1311 		    ((y + vd->vd_mcursor->height) / vf->vf_height) + 1;
1312 	} else {
1313 		/*
1314 		 * No font loaded (ie. vt_vga operating in textmode).
1315 		 *
1316 		 * FIXME: This fake area needs to be revisited once the
1317 		 * mouse cursor is supported in vt_vga's textmode.
1318 		 */
1319 		area.tr_begin.tp_col = x;
1320 		area.tr_begin.tp_row = y;
1321 		area.tr_end.tp_col = x + 2;
1322 		area.tr_end.tp_row = y + 2;
1323 	}
1324 
1325 	if (!locked)
1326 		vtbuf_lock(&vw->vw_buf);
1327 	if (vd->vd_driver->vd_invalidate_text)
1328 		vd->vd_driver->vd_invalidate_text(vd, &area);
1329 	vtbuf_dirty(&vw->vw_buf, &area);
1330 	if (!locked)
1331 		vtbuf_unlock(&vw->vw_buf);
1332 }
1333 #endif
1334 
1335 static void
vt_set_border(struct vt_device * vd,const term_rect_t * area,term_color_t c)1336 vt_set_border(struct vt_device *vd, const term_rect_t *area,
1337     term_color_t c)
1338 {
1339 	vd_drawrect_t *drawrect = vd->vd_driver->vd_drawrect;
1340 
1341 	if (drawrect == NULL)
1342 		return;
1343 
1344 	/* Top bar */
1345 	if (area->tr_begin.tp_row > 0)
1346 		drawrect(vd, 0, 0, vd->vd_width - 1,
1347 		    area->tr_begin.tp_row - 1, 1, c);
1348 
1349 	/* Left bar */
1350 	if (area->tr_begin.tp_col > 0)
1351 		drawrect(vd, 0, area->tr_begin.tp_row,
1352 		    area->tr_begin.tp_col - 1, area->tr_end.tp_row - 1, 1, c);
1353 
1354 	/* Right bar */
1355 	if (area->tr_end.tp_col < vd->vd_width)
1356 		drawrect(vd, area->tr_end.tp_col, area->tr_begin.tp_row,
1357 		    vd->vd_width - 1, area->tr_end.tp_row - 1, 1, c);
1358 
1359 	/* Bottom bar */
1360 	if (area->tr_end.tp_row < vd->vd_height)
1361 		drawrect(vd, 0, area->tr_end.tp_row, vd->vd_width - 1,
1362 		    vd->vd_height - 1, 1, c);
1363 }
1364 
1365 static void
vt_flush_to_buffer(struct vt_device * vd,const struct vt_window * vw,const term_rect_t * area)1366 vt_flush_to_buffer(struct vt_device *vd,
1367     const struct vt_window *vw, const term_rect_t *area)
1368 {
1369 	unsigned int col, row;
1370 	term_char_t c;
1371 	term_color_t fg, bg;
1372 	size_t z;
1373 
1374 	for (row = area->tr_begin.tp_row; row < area->tr_end.tp_row; ++row) {
1375 		for (col = area->tr_begin.tp_col; col < area->tr_end.tp_col;
1376 		    ++col) {
1377 			z = row * PIXEL_WIDTH(VT_FB_MAX_WIDTH) + col;
1378 			if (z >= PIXEL_HEIGHT(VT_FB_MAX_HEIGHT) *
1379 			    PIXEL_WIDTH(VT_FB_MAX_WIDTH))
1380 				continue;
1381 
1382 			c = VTBUF_GET_FIELD(&vw->vw_buf, row, col);
1383 			vt_determine_colors(c,
1384 			    VTBUF_ISCURSOR(&vw->vw_buf, row, col), &fg, &bg);
1385 
1386 			if (vd->vd_drawn && (vd->vd_drawn[z] == c) &&
1387 			    vd->vd_drawnfg && (vd->vd_drawnfg[z] == fg) &&
1388 			    vd->vd_drawnbg && (vd->vd_drawnbg[z] == bg)) {
1389 				vd->vd_pos_to_flush[z] = false;
1390 				continue;
1391 			}
1392 
1393 			vd->vd_pos_to_flush[z] = true;
1394 
1395 			if (vd->vd_drawn)
1396 				vd->vd_drawn[z] = c;
1397 			if (vd->vd_drawnfg)
1398 				vd->vd_drawnfg[z] = fg;
1399 			if (vd->vd_drawnbg)
1400 				vd->vd_drawnbg[z] = bg;
1401 		}
1402 	}
1403 }
1404 
1405 static void
vt_bitblt_buffer(struct vt_device * vd,const struct vt_window * vw,const term_rect_t * area)1406 vt_bitblt_buffer(struct vt_device *vd, const struct vt_window *vw,
1407     const term_rect_t *area)
1408 {
1409 	unsigned int col, row, x, y;
1410 	struct vt_font *vf;
1411 	term_char_t c;
1412 	term_color_t fg, bg;
1413 	const uint8_t *pattern;
1414 	size_t z;
1415 
1416 	vf = vw->vw_font;
1417 
1418 	for (row = area->tr_begin.tp_row; row < area->tr_end.tp_row; ++row) {
1419 		for (col = area->tr_begin.tp_col; col < area->tr_end.tp_col;
1420 		    ++col) {
1421 			x = col * vf->vf_width +
1422 			    vw->vw_draw_area.tr_begin.tp_col;
1423 			y = row * vf->vf_height +
1424 			    vw->vw_draw_area.tr_begin.tp_row;
1425 
1426 			z = row * PIXEL_WIDTH(VT_FB_MAX_WIDTH) + col;
1427 			if (z >= PIXEL_HEIGHT(VT_FB_MAX_HEIGHT) *
1428 			    PIXEL_WIDTH(VT_FB_MAX_WIDTH))
1429 				continue;
1430 			if (!vd->vd_pos_to_flush[z])
1431 				continue;
1432 
1433 			c = vd->vd_drawn[z];
1434 			fg = vd->vd_drawnfg[z];
1435 			bg = vd->vd_drawnbg[z];
1436 
1437 			pattern = vtfont_lookup(vf, c);
1438 			vd->vd_driver->vd_bitblt_bmp(vd, vw,
1439 			    pattern, NULL, vf->vf_width, vf->vf_height,
1440 			    x, y, fg, bg);
1441 		}
1442 	}
1443 
1444 #ifndef SC_NO_CUTPASTE
1445 	if (!vd->vd_mshown)
1446 		return;
1447 
1448 	term_rect_t drawn_area;
1449 
1450 	drawn_area.tr_begin.tp_col = area->tr_begin.tp_col * vf->vf_width;
1451 	drawn_area.tr_begin.tp_row = area->tr_begin.tp_row * vf->vf_height;
1452 	drawn_area.tr_end.tp_col = area->tr_end.tp_col * vf->vf_width;
1453 	drawn_area.tr_end.tp_row = area->tr_end.tp_row * vf->vf_height;
1454 
1455 	if (vt_is_cursor_in_area(vd, &drawn_area)) {
1456 		vd->vd_driver->vd_bitblt_bmp(vd, vw,
1457 		    vd->vd_mcursor->map, vd->vd_mcursor->mask,
1458 		    vd->vd_mcursor->width, vd->vd_mcursor->height,
1459 		    vd->vd_mx_drawn + vw->vw_draw_area.tr_begin.tp_col,
1460 		    vd->vd_my_drawn + vw->vw_draw_area.tr_begin.tp_row,
1461 		    vd->vd_mcursor_fg, vd->vd_mcursor_bg);
1462 	}
1463 #endif
1464 }
1465 
1466 static void
vt_draw_decorations(struct vt_device * vd)1467 vt_draw_decorations(struct vt_device *vd)
1468 {
1469 	struct vt_window *vw;
1470 	const teken_attr_t *a;
1471 
1472 	vw = vd->vd_curwindow;
1473 
1474 	a = teken_get_curattr(&vw->vw_terminal->tm_emulator);
1475 	vt_set_border(vd, &vw->vw_draw_area, a->ta_bgcolor);
1476 
1477 	if (vt_draw_logo_cpus)
1478 		vtterm_draw_cpu_logos(vd);
1479 }
1480 
1481 static int
vt_flush(struct vt_device * vd)1482 vt_flush(struct vt_device *vd)
1483 {
1484 	struct vt_window *vw;
1485 	struct vt_font *vf;
1486 	term_rect_t tarea;
1487 #ifndef SC_NO_CUTPASTE
1488 	int cursor_was_shown, cursor_moved;
1489 #endif
1490 	bool needs_refresh;
1491 
1492 	if (inside_vt_flush && KERNEL_PANICKED())
1493 		return (0);
1494 
1495 	vw = vd->vd_curwindow;
1496 	if (vw == NULL)
1497 		return (0);
1498 
1499 	if (vd->vd_flags & VDF_SPLASH || vw->vw_flags & VWF_BUSY)
1500 		return (0);
1501 
1502 	vf = vw->vw_font;
1503 	if (((vd->vd_flags & VDF_TEXTMODE) == 0) && (vf == NULL))
1504 		return (0);
1505 
1506 	VT_FLUSH_LOCK(vd);
1507 
1508 	vtbuf_lock(&vw->vw_buf);
1509 	inside_vt_flush = true;
1510 
1511 #ifndef SC_NO_CUTPASTE
1512 	cursor_was_shown = vd->vd_mshown;
1513 	cursor_moved = (vd->vd_mx != vd->vd_mx_drawn ||
1514 	    vd->vd_my != vd->vd_my_drawn);
1515 
1516 	/* Check if the cursor should be displayed or not. */
1517 	if ((vd->vd_flags & VDF_MOUSECURSOR) && /* Mouse support enabled. */
1518 	    !(vw->vw_flags & VWF_MOUSE_HIDE) && /* Cursor displayed.      */
1519 	    !kdb_active && !KERNEL_PANICKED()) {  /* DDB inactive.          */
1520 		vd->vd_mshown = 1;
1521 	} else {
1522 		vd->vd_mshown = 0;
1523 	}
1524 
1525 	/*
1526 	 * If the cursor changed display state or moved, we must mark
1527 	 * the old position as dirty, so that it's erased.
1528 	 */
1529 	if (cursor_was_shown != vd->vd_mshown ||
1530 	    (vd->vd_mshown && cursor_moved))
1531 		vt_mark_mouse_position_as_dirty(vd, true);
1532 
1533 	/*
1534          * Save position of the mouse cursor. It's used by backends to
1535          * know where to draw the cursor and during the next refresh to
1536          * erase the previous position.
1537 	 */
1538 	vd->vd_mx_drawn = vd->vd_mx;
1539 	vd->vd_my_drawn = vd->vd_my;
1540 
1541 	/*
1542 	 * If the cursor is displayed and has moved since last refresh,
1543 	 * mark the new position as dirty.
1544 	 */
1545 	if (vd->vd_mshown && cursor_moved)
1546 		vt_mark_mouse_position_as_dirty(vd, true);
1547 #endif
1548 
1549 	vtbuf_undirty(&vw->vw_buf, &tarea);
1550 
1551 	/* Force a full redraw when the screen contents might be invalid. */
1552 	needs_refresh = false;
1553 	if (vd->vd_flags & (VDF_INVALID | VDF_SUSPENDED)) {
1554 		needs_refresh = true;
1555 		vd->vd_flags &= ~VDF_INVALID;
1556 
1557 		vt_termrect(vd, vf, &tarea);
1558 		if (vd->vd_driver->vd_invalidate_text)
1559 			vd->vd_driver->vd_invalidate_text(vd, &tarea);
1560 	}
1561 
1562 	if (tarea.tr_begin.tp_col < tarea.tr_end.tp_col) {
1563 		if (vd->vd_driver->vd_bitblt_after_vtbuf_unlock) {
1564 			/*
1565 			 * When `vd_bitblt_after_vtbuf_unlock` is set to true,
1566 			 * we first remember the characters to redraw. They are
1567 			 * already copied to the `vd_drawn` arrays.
1568 			 *
1569 			 * We then unlock vt_buf and proceed with the actual
1570 			 * drawing using the backend driver.
1571 			 */
1572 			vt_flush_to_buffer(vd, vw, &tarea);
1573 			vtbuf_unlock(&vw->vw_buf);
1574 			vt_bitblt_buffer(vd, vw, &tarea);
1575 
1576 			if (needs_refresh)
1577 				vt_draw_decorations(vd);
1578 
1579 			/*
1580 			 * We can reset `inside_vt_flush` after unlocking vtbuf
1581 			 * here because we also hold vt_flush_lock in this code
1582 			 * path.
1583 			 */
1584 			inside_vt_flush = false;
1585 		} else {
1586 			/*
1587 			 * When `vd_bitblt_after_vtbuf_unlock` is false, we use
1588 			 * the backend's `vd_bitblt_text` callback directly.
1589 			 */
1590 			vd->vd_driver->vd_bitblt_text(vd, vw, &tarea);
1591 
1592 			if (needs_refresh)
1593 				vt_draw_decorations(vd);
1594 
1595 			inside_vt_flush = false;
1596 			vtbuf_unlock(&vw->vw_buf);
1597 		}
1598 
1599 		VT_FLUSH_UNLOCK(vd);
1600 
1601 		return (1);
1602 	}
1603 
1604 	inside_vt_flush = false;
1605 	vtbuf_unlock(&vw->vw_buf);
1606 
1607 	VT_FLUSH_UNLOCK(vd);
1608 
1609 	return (0);
1610 }
1611 
1612 static void
vt_timer(void * arg)1613 vt_timer(void *arg)
1614 {
1615 	struct vt_device *vd;
1616 	int changed;
1617 
1618 	vd = arg;
1619 	/* Update screen if required. */
1620 	changed = vt_flush(vd);
1621 
1622 	/* Schedule for next update. */
1623 	if (changed)
1624 		vt_schedule_flush(vd, 0);
1625 	else
1626 		vd->vd_timer_armed = 0;
1627 }
1628 
1629 static void
vtterm_pre_input(struct terminal * tm)1630 vtterm_pre_input(struct terminal *tm)
1631 {
1632 	struct vt_window *vw = tm->tm_softc;
1633 
1634 	if (inside_vt_flush && KERNEL_PANICKED())
1635 		return;
1636 
1637 	vtbuf_lock(&vw->vw_buf);
1638 }
1639 
1640 static void
vtterm_post_input(struct terminal * tm)1641 vtterm_post_input(struct terminal *tm)
1642 {
1643 	struct vt_window *vw = tm->tm_softc;
1644 
1645 	if (inside_vt_flush && KERNEL_PANICKED())
1646 		return;
1647 
1648 	vtbuf_unlock(&vw->vw_buf);
1649 	vt_resume_flush_timer(vw, 0);
1650 }
1651 
1652 static void
vtterm_done(struct terminal * tm)1653 vtterm_done(struct terminal *tm)
1654 {
1655 	struct vt_window *vw = tm->tm_softc;
1656 	struct vt_device *vd = vw->vw_device;
1657 
1658 	if (kdb_active || KERNEL_PANICKED()) {
1659 		/* Switch to the debugger. */
1660 		if (vd->vd_curwindow != vw) {
1661 			vd->vd_curwindow = vw;
1662 			vd->vd_flags |= VDF_INVALID;
1663 			if (vd->vd_driver->vd_postswitch)
1664 				vd->vd_driver->vd_postswitch(vd);
1665 		}
1666 		vd->vd_flags &= ~VDF_SPLASH;
1667 		vt_flush(vd);
1668 	} else if (vt_slow_down > 0) {
1669 		int i, j;
1670 		for (i = 0; i < vt_slow_down; i++) {
1671 			for (j = 0; j < 1000; j++)
1672 				vt_flush(vd);
1673 		}
1674 	} else if (!(vd->vd_flags & VDF_ASYNC)) {
1675 		vt_flush(vd);
1676 	}
1677 }
1678 
1679 #ifdef DEV_SPLASH
1680 static void
vtterm_splash(struct vt_device * vd)1681 vtterm_splash(struct vt_device *vd)
1682 {
1683 	struct splash_info *si;
1684 	uintptr_t image;
1685 	vt_axis_t top, left;
1686 
1687 	if ((vd->vd_flags & VDF_TEXTMODE) != 0 || (boothowto & RB_MUTE) == 0)
1688 		return;
1689 
1690 	si = MD_FETCH(preload_kmdp, rebooting == 1 ? MODINFOMD_SHTDWNSPLASH :
1691 	    MODINFOMD_SPLASH, struct splash_info *);
1692 	if (si == NULL) {
1693 		if (vd->vd_driver->vd_bitblt_bmp == NULL)
1694 			return;
1695 	} else if (vd->vd_driver->vd_bitblt_argb == NULL)
1696 		return;
1697 
1698 	if (rebooting == 1) {
1699 		if (vd->vd_driver->vd_blank == NULL)
1700 			return;
1701 		vd->vd_driver->vd_blank(vd, TC_BLACK);
1702 	}
1703 
1704 	if (si == NULL) {
1705 		top = (vd->vd_height - vt_logo_height) / 2;
1706 		left = (vd->vd_width - vt_logo_width) / 2;
1707 		vd->vd_driver->vd_bitblt_bmp(vd,
1708 		    vd->vd_curwindow, vt_logo_image, NULL, vt_logo_width,
1709 		    vt_logo_height, left, top, TC_WHITE, TC_BLACK);
1710 	} else {
1711 		if (si->si_depth != 4)
1712 			return;
1713 		image = (uintptr_t)si + sizeof(struct splash_info);
1714 		image = roundup2(image, 8);
1715 		top = (vd->vd_height - si->si_height) / 2;
1716 		left = (vd->vd_width - si->si_width) / 2;
1717 		vd->vd_driver->vd_bitblt_argb(vd, vd->vd_curwindow,
1718 		    (unsigned char *)image, si->si_width, si->si_height,
1719 		    left, top);
1720 	}
1721 	vd->vd_flags |= VDF_SPLASH;
1722 }
1723 #endif
1724 
1725 static struct vt_font *
parse_font_info_static(struct font_info * fi)1726 parse_font_info_static(struct font_info *fi)
1727 {
1728 	struct vt_font *vfp;
1729 	uintptr_t ptr;
1730 	uint32_t checksum;
1731 
1732 	if (fi == NULL)
1733 		return (NULL);
1734 
1735 	ptr = (uintptr_t)fi;
1736 	/*
1737 	 * Compute and verify checksum. The total sum of all the fields
1738 	 * must be 0.
1739 	 */
1740 	checksum = fi->fi_width;
1741 	checksum += fi->fi_height;
1742 	checksum += fi->fi_bitmap_size;
1743 	for (unsigned i = 0; i < VFNT_MAPS; i++)
1744 		checksum += fi->fi_map_count[i];
1745 
1746 	if (checksum + fi->fi_checksum != 0)
1747 		return (NULL);
1748 
1749 	ptr += sizeof(struct font_info);
1750 	ptr = roundup2(ptr, 8);
1751 
1752 	vfp = &vt_font_loader;
1753 	vfp->vf_height = fi->fi_height;
1754 	vfp->vf_width = fi->fi_width;
1755 	/* This is default font, set refcount 1 to disable removal. */
1756 	vfp->vf_refcount = 1;
1757 	for (unsigned i = 0; i < VFNT_MAPS; i++) {
1758 		if (fi->fi_map_count[i] == 0)
1759 			continue;
1760 		vfp->vf_map_count[i] = fi->fi_map_count[i];
1761 		vfp->vf_map[i] = (vfnt_map_t *)ptr;
1762 		ptr += (fi->fi_map_count[i] * sizeof(vfnt_map_t));
1763 		ptr = roundup2(ptr, 8);
1764 	}
1765 	vfp->vf_bytes = (uint8_t *)ptr;
1766 	return (vfp);
1767 }
1768 
1769 /*
1770  * Set up default font with allocated data structures.
1771  * However, we can not set refcount here, because it is already set and
1772  * incremented in vtterm_cnprobe() to avoid being released by font load from
1773  * userland.
1774  */
1775 static struct vt_font *
parse_font_info(struct font_info * fi)1776 parse_font_info(struct font_info *fi)
1777 {
1778 	struct vt_font *vfp;
1779 	uintptr_t ptr;
1780 	uint32_t checksum;
1781 	size_t size;
1782 
1783 	if (fi == NULL)
1784 		return (NULL);
1785 
1786 	ptr = (uintptr_t)fi;
1787 	/*
1788 	 * Compute and verify checksum. The total sum of all the fields
1789 	 * must be 0.
1790 	 */
1791 	checksum = fi->fi_width;
1792 	checksum += fi->fi_height;
1793 	checksum += fi->fi_bitmap_size;
1794 	for (unsigned i = 0; i < VFNT_MAPS; i++)
1795 		checksum += fi->fi_map_count[i];
1796 
1797 	if (checksum + fi->fi_checksum != 0)
1798 		return (NULL);
1799 
1800 	ptr += sizeof(struct font_info);
1801 	ptr = roundup2(ptr, 8);
1802 
1803 	vfp = &vt_font_loader;
1804 	vfp->vf_height = fi->fi_height;
1805 	vfp->vf_width = fi->fi_width;
1806 	for (unsigned i = 0; i < VFNT_MAPS; i++) {
1807 		if (fi->fi_map_count[i] == 0)
1808 			continue;
1809 		vfp->vf_map_count[i] = fi->fi_map_count[i];
1810 		size = fi->fi_map_count[i] * sizeof(vfnt_map_t);
1811 		vfp->vf_map[i] = malloc(size, M_VT, M_WAITOK | M_ZERO);
1812 		bcopy((vfnt_map_t *)ptr, vfp->vf_map[i], size);
1813 		ptr += size;
1814 		ptr = roundup2(ptr, 8);
1815 	}
1816 	vfp->vf_bytes = malloc(fi->fi_bitmap_size, M_VT, M_WAITOK | M_ZERO);
1817 	bcopy((uint8_t *)ptr, vfp->vf_bytes, fi->fi_bitmap_size);
1818 	return (vfp);
1819 }
1820 
1821 static void
vt_init_font(void * arg)1822 vt_init_font(void *arg)
1823 {
1824 	struct font_info *fi;
1825 	struct vt_font *font;
1826 
1827 	fi = MD_FETCH(preload_kmdp, MODINFOMD_FONT, struct font_info *);
1828 
1829 	font = parse_font_info(fi);
1830 	if (font != NULL)
1831 		vt_font_assigned = font;
1832 }
1833 
1834 SYSINIT(vt_init_font, SI_SUB_KMEM, SI_ORDER_ANY, vt_init_font, &vt_consdev);
1835 
1836 static void
vt_init_font_static(void)1837 vt_init_font_static(void)
1838 {
1839 	struct font_info *fi;
1840 	struct vt_font *font;
1841 
1842 	fi = MD_FETCH(preload_kmdp, MODINFOMD_FONT, struct font_info *);
1843 
1844 	font = parse_font_info_static(fi);
1845 	if (font != NULL)
1846 		vt_font_assigned = font;
1847 }
1848 
1849 #ifdef DEV_SPLASH
1850 static int
vt_shutdown_splash(struct vt_window * vw)1851 vt_shutdown_splash(struct vt_window *vw)
1852 {
1853 	vtterm_splash(vw->vw_device);
1854 	return (0);
1855 }
1856 #endif
1857 
1858 static void
vtterm_cnprobe(struct terminal * tm,struct consdev * cp)1859 vtterm_cnprobe(struct terminal *tm, struct consdev *cp)
1860 {
1861 	struct vt_driver *vtd, **vtdlist, *vtdbest = NULL;
1862 	struct vt_window *vw = tm->tm_softc;
1863 	struct vt_device *vd = vw->vw_device;
1864 	struct winsize wsz;
1865 	const term_attr_t *a;
1866 
1867 	if (!vty_enabled(VTY_VT))
1868 		return;
1869 
1870 	if (vd->vd_flags & VDF_INITIALIZED)
1871 		/* Initialization already done. */
1872 		return;
1873 
1874 	SET_FOREACH(vtdlist, vt_drv_set) {
1875 		vtd = *vtdlist;
1876 		if (vtd->vd_probe == NULL)
1877 			continue;
1878 		if (vtd->vd_probe(vd) == CN_DEAD)
1879 			continue;
1880 		if ((vtdbest == NULL) ||
1881 		    (vtd->vd_priority > vtdbest->vd_priority))
1882 			vtdbest = vtd;
1883 	}
1884 	if (vtdbest == NULL) {
1885 		cp->cn_pri = CN_DEAD;
1886 		vd->vd_flags |= VDF_DEAD;
1887 	} else {
1888 		vd->vd_driver = vtdbest;
1889 		cp->cn_pri = vd->vd_driver->vd_init(vd);
1890 	}
1891 
1892 	/* Check if driver's vt_init return CN_DEAD. */
1893 	if (cp->cn_pri == CN_DEAD) {
1894 		vd->vd_flags |= VDF_DEAD;
1895 	}
1896 
1897 	/* Initialize any early-boot keyboard drivers */
1898 	kbd_configure(KB_CONF_PROBE_ONLY);
1899 
1900 	vd->vd_unit = atomic_fetchadd_int(&vt_unit, 1);
1901 	vd->vd_windows[VT_CONSWINDOW] = vw;
1902 	sprintf(cp->cn_name, "ttyv%r", VT_UNIT(vw));
1903 
1904 	vt_init_font_static();
1905 
1906 	/* Attach default font if not in TEXTMODE. */
1907 	if ((vd->vd_flags & VDF_TEXTMODE) == 0) {
1908 		vw->vw_font = vtfont_ref(vt_font_assigned);
1909 		vt_compute_drawable_area(vw);
1910 	}
1911 
1912 	/*
1913 	 * The original screen size was faked (_VTDEFW x _VTDEFH). Now
1914 	 * that we have the real viewable size, fix it in the static
1915 	 * buffer.
1916 	 */
1917 	if (vd->vd_width != 0 && vd->vd_height != 0)
1918 		vt_termsize(vd, vw->vw_font, &vw->vw_buf.vb_scr_size);
1919 
1920 	/* We need to access terminal attributes from vtbuf */
1921 	vw->vw_buf.vb_terminal = tm;
1922 	vtbuf_init_early(&vw->vw_buf);
1923 	vt_winsize(vd, vw->vw_font, &wsz);
1924 	a = teken_get_curattr(&tm->tm_emulator);
1925 	terminal_set_winsize_blank(tm, &wsz, 1, a);
1926 
1927 	if (vtdbest != NULL) {
1928 #ifdef DEV_SPLASH
1929 		if (!vt_splash_cpu)
1930 			vtterm_splash(vd);
1931 #endif
1932 		vd->vd_flags |= VDF_INITIALIZED;
1933 	}
1934 }
1935 
1936 static int
vtterm_cngetc(struct terminal * tm)1937 vtterm_cngetc(struct terminal *tm)
1938 {
1939 	struct vt_window *vw = tm->tm_softc;
1940 	struct vt_device *vd = vw->vw_device;
1941 	keyboard_t *kbd;
1942 	u_int c;
1943 
1944 	if (vw->vw_kbdsq && *vw->vw_kbdsq)
1945 		return (*vw->vw_kbdsq++);
1946 
1947 	/* Make sure the splash screen is not there. */
1948 	if (vd->vd_flags & VDF_SPLASH) {
1949 		/* Remove splash */
1950 		vd->vd_flags &= ~VDF_SPLASH;
1951 		/* Mark screen as invalid to force update */
1952 		vd->vd_flags |= VDF_INVALID;
1953 		vt_flush(vd);
1954 	}
1955 
1956 	/* Stripped down keyboard handler. */
1957 	if ((kbd = vd->vd_keyboard) == NULL)
1958 		return (-1);
1959 
1960 	/* Force keyboard input mode to K_XLATE */
1961 	vw->vw_kbdmode = K_XLATE;
1962 	vt_update_kbd_mode(vw, kbd);
1963 
1964 	/* Switch the keyboard to polling to make it work here. */
1965 	kbdd_poll(kbd, TRUE);
1966 	c = kbdd_read_char(kbd, 0);
1967 	kbdd_poll(kbd, FALSE);
1968 	if (c & RELKEY)
1969 		return (-1);
1970 
1971 	if (vw->vw_flags & VWF_SCROLL) {
1972 		vt_scrollmode_kbdevent(vw, c, 1/* Console mode */);
1973 		vt_flush(vd);
1974 		return (-1);
1975 	}
1976 
1977 	/* Stripped down handling of vt_kbdevent(), without locking, etc. */
1978 	if (c & SPCLKEY) {
1979 		switch (c) {
1980 		case SPCLKEY | SLK:
1981 			vt_save_kbd_state(vw, kbd);
1982 			if (vw->vw_kbdstate & SLKED) {
1983 				/* Turn scrolling on. */
1984 				vw->vw_flags |= VWF_SCROLL;
1985 				VTBUF_SLCK_ENABLE(&vw->vw_buf);
1986 			} else {
1987 				/* Turn scrolling off. */
1988 				vt_scroll(vw, 0, VHS_END);
1989 				vw->vw_flags &= ~VWF_SCROLL;
1990 				VTBUF_SLCK_DISABLE(&vw->vw_buf);
1991 			}
1992 			break;
1993 		case SPCLKEY | BTAB: /* Back tab (usually, shift+tab). */
1994 			vw->vw_kbdsq = "\x1b[Z";
1995 			break;
1996 		/* XXX: KDB can handle history. */
1997 		case SPCLKEY | FKEY | F(50): /* Arrow up. */
1998 			vw->vw_kbdsq = "\x1b[A";
1999 			break;
2000 		case SPCLKEY | FKEY | F(58): /* Arrow down. */
2001 			vw->vw_kbdsq = "\x1b[B";
2002 			break;
2003 		case SPCLKEY | FKEY | F(55): /* Arrow right. */
2004 			vw->vw_kbdsq = "\x1b[C";
2005 			break;
2006 		case SPCLKEY | FKEY | F(53): /* Arrow left. */
2007 			vw->vw_kbdsq = "\x1b[D";
2008 			break;
2009 		}
2010 
2011 		/* Force refresh to make scrollback work. */
2012 		vt_flush(vd);
2013 	} else if (KEYFLAGS(c) == 0) {
2014 		return (KEYCHAR(c));
2015 	}
2016 
2017 	if (vw->vw_kbdsq && *vw->vw_kbdsq)
2018 		return (*vw->vw_kbdsq++);
2019 
2020 	return (-1);
2021 }
2022 
2023 /*
2024  * These two do most of what we want to do in vtterm_cnungrab, but without
2025  * actually switching windows.  This is necessary for, e.g.,
2026  * vt_allocate_keyboard() to get the current keyboard into the state it needs to
2027  * be in without damaging the device's window state.
2028  *
2029  * Both return the current grab count, though it's only used in vtterm_cnungrab.
2030  */
2031 static int
vtterm_cngrab_noswitch(struct vt_device * vd,struct vt_window * vw)2032 vtterm_cngrab_noswitch(struct vt_device *vd, struct vt_window *vw)
2033 {
2034 	keyboard_t *kbd;
2035 
2036 	if (vw->vw_grabbed++ > 0)
2037 		return (vw->vw_grabbed);
2038 
2039 	if ((kbd = vd->vd_keyboard) == NULL)
2040 		return (1);
2041 
2042 	/*
2043 	 * Make sure the keyboard is accessible even when the kbd device
2044 	 * driver is disabled.
2045 	 */
2046 	kbdd_enable(kbd);
2047 
2048 	/* We shall always use the keyboard in the XLATE mode here. */
2049 	vw->vw_prev_kbdmode = vw->vw_kbdmode;
2050 	vw->vw_kbdmode = K_XLATE;
2051 	vt_update_kbd_mode(vw, kbd);
2052 
2053 	kbdd_poll(kbd, TRUE);
2054 	return (1);
2055 }
2056 
2057 static int
vtterm_cnungrab_noswitch(struct vt_device * vd,struct vt_window * vw)2058 vtterm_cnungrab_noswitch(struct vt_device *vd, struct vt_window *vw)
2059 {
2060 	keyboard_t *kbd;
2061 
2062 	if (--vw->vw_grabbed > 0)
2063 		return (vw->vw_grabbed);
2064 
2065 	if ((kbd = vd->vd_keyboard) == NULL)
2066 		return (0);
2067 
2068 	kbdd_poll(kbd, FALSE);
2069 
2070 	vw->vw_kbdmode = vw->vw_prev_kbdmode;
2071 	vt_update_kbd_mode(vw, kbd);
2072 	kbdd_disable(kbd);
2073 	return (0);
2074 }
2075 
2076 static void
vtterm_cngrab(struct terminal * tm)2077 vtterm_cngrab(struct terminal *tm)
2078 {
2079 	struct vt_device *vd;
2080 	struct vt_window *vw;
2081 
2082 	vw = tm->tm_softc;
2083 	vd = vw->vw_device;
2084 
2085 	/* To be restored after we ungrab. */
2086 	if (vd->vd_grabwindow == NULL)
2087 		vd->vd_grabwindow = vd->vd_curwindow;
2088 
2089 	if (!cold)
2090 		vt_window_switch(vw);
2091 
2092 	vtterm_cngrab_noswitch(vd, vw);
2093 }
2094 
2095 static void
vtterm_cnungrab(struct terminal * tm)2096 vtterm_cnungrab(struct terminal *tm)
2097 {
2098 	struct vt_device *vd;
2099 	struct vt_window *vw, *grabwindow;
2100 
2101 	vw = tm->tm_softc;
2102 	vd = vw->vw_device;
2103 
2104 	MPASS(vd->vd_grabwindow != NULL);
2105 	if (vtterm_cnungrab_noswitch(vd, vw) != 0)
2106 		return;
2107 
2108 	/*
2109 	 * We set `vd_grabwindow` to NULL before calling vt_window_switch()
2110 	 * because it allows the underlying vt(4) backend to distinguish a
2111 	 * "grab" from an "ungrab" of the console.
2112 	 *
2113 	 * This is used by `vt_drmfb` in drm-kmod to call either
2114 	 * fb_debug_enter() or fb_debug_leave() appropriately.
2115 	 */
2116 	grabwindow = vd->vd_grabwindow;
2117 	vd->vd_grabwindow = NULL;
2118 
2119 	if (!cold)
2120 		vt_window_switch(grabwindow);
2121 }
2122 
2123 static void
vtterm_opened(struct terminal * tm,int opened)2124 vtterm_opened(struct terminal *tm, int opened)
2125 {
2126 	struct vt_window *vw = tm->tm_softc;
2127 	struct vt_device *vd = vw->vw_device;
2128 
2129 	VT_LOCK(vd);
2130 	vd->vd_flags &= ~VDF_SPLASH;
2131 	if (opened)
2132 		vw->vw_flags |= VWF_OPENED;
2133 	else {
2134 		vw->vw_flags &= ~VWF_OPENED;
2135 		/* TODO: finish ACQ/REL */
2136 	}
2137 	VT_UNLOCK(vd);
2138 }
2139 
2140 static int
vt_change_font(struct vt_window * vw,struct vt_font * vf)2141 vt_change_font(struct vt_window *vw, struct vt_font *vf)
2142 {
2143 	struct vt_device *vd = vw->vw_device;
2144 	struct terminal *tm = vw->vw_terminal;
2145 	term_pos_t size;
2146 	struct winsize wsz;
2147 
2148 	/*
2149 	 * Changing fonts.
2150 	 *
2151 	 * Changing fonts is a little tricky.  We must prevent
2152 	 * simultaneous access to the device, so we must stop
2153 	 * the display timer and the terminal from accessing.
2154 	 * We need to switch fonts and grow our screen buffer.
2155 	 *
2156 	 * XXX: Right now the code uses terminal_mute() to
2157 	 * prevent data from reaching the console driver while
2158 	 * resizing the screen buffer.  This isn't elegant...
2159 	 */
2160 
2161 	VT_LOCK(vd);
2162 	if (vw->vw_flags & VWF_BUSY) {
2163 		/* Another process is changing the font. */
2164 		VT_UNLOCK(vd);
2165 		return (EBUSY);
2166 	}
2167 	vw->vw_flags |= VWF_BUSY;
2168 	VT_UNLOCK(vd);
2169 
2170 	vt_termsize(vd, vf, &size);
2171 	vt_winsize(vd, vf, &wsz);
2172 
2173 	/* Grow the screen buffer and terminal. */
2174 	terminal_mute(tm, 1);
2175 	vtbuf_grow(&vw->vw_buf, &size, vw->vw_buf.vb_history_size);
2176 	terminal_set_winsize_blank(tm, &wsz, 0, NULL);
2177 	terminal_set_cursor(tm, &vw->vw_buf.vb_cursor);
2178 	terminal_mute(tm, 0);
2179 
2180 	/* Actually apply the font to the current window. */
2181 	VT_LOCK(vd);
2182 	if (vw->vw_font != vf && vw->vw_font != NULL && vf != NULL) {
2183 		/*
2184 		 * In case vt_change_font called to update size we don't need
2185 		 * to update font link.
2186 		 */
2187 		vtfont_unref(vw->vw_font);
2188 		vw->vw_font = vtfont_ref(vf);
2189 	}
2190 
2191 	/*
2192 	 * Compute the drawable area and move the mouse cursor inside
2193 	 * it, in case the new area is smaller than the previous one.
2194 	 */
2195 	vt_compute_drawable_area(vw);
2196 	vd->vd_mx = min(vd->vd_mx,
2197 	    vw->vw_draw_area.tr_end.tp_col -
2198 	    vw->vw_draw_area.tr_begin.tp_col - 1);
2199 	vd->vd_my = min(vd->vd_my,
2200 	    vw->vw_draw_area.tr_end.tp_row -
2201 	    vw->vw_draw_area.tr_begin.tp_row - 1);
2202 
2203 	/* Force a full redraw the next timer tick. */
2204 	if (vd->vd_curwindow == vw) {
2205 		vd->vd_flags |= VDF_INVALID;
2206 		vt_resume_flush_timer(vw, 0);
2207 	}
2208 	vw->vw_flags &= ~VWF_BUSY;
2209 	VT_UNLOCK(vd);
2210 	return (0);
2211 }
2212 
2213 static int
vt_proc_alive(struct vt_window * vw)2214 vt_proc_alive(struct vt_window *vw)
2215 {
2216 	struct proc *p;
2217 
2218 	if (vw->vw_smode.mode != VT_PROCESS)
2219 		return (FALSE);
2220 
2221 	if (vw->vw_proc) {
2222 		if ((p = pfind(vw->vw_pid)) != NULL)
2223 			PROC_UNLOCK(p);
2224 		if (vw->vw_proc == p)
2225 			return (TRUE);
2226 		vw->vw_proc = NULL;
2227 		vw->vw_smode.mode = VT_AUTO;
2228 		DPRINTF(1, "vt controlling process %d died\n", vw->vw_pid);
2229 		vw->vw_pid = 0;
2230 	}
2231 	return (FALSE);
2232 }
2233 
2234 static int
signal_vt_rel(struct vt_window * vw)2235 signal_vt_rel(struct vt_window *vw)
2236 {
2237 
2238 	if (vw->vw_smode.mode != VT_PROCESS)
2239 		return (FALSE);
2240 	if (vw->vw_proc == NULL || vt_proc_alive(vw) == FALSE) {
2241 		vw->vw_proc = NULL;
2242 		vw->vw_pid = 0;
2243 		return (TRUE);
2244 	}
2245 	vw->vw_flags |= VWF_SWWAIT_REL;
2246 	PROC_LOCK(vw->vw_proc);
2247 	kern_psignal(vw->vw_proc, vw->vw_smode.relsig);
2248 	PROC_UNLOCK(vw->vw_proc);
2249 	DPRINTF(1, "sending relsig to %d\n", vw->vw_pid);
2250 	return (TRUE);
2251 }
2252 
2253 static int
signal_vt_acq(struct vt_window * vw)2254 signal_vt_acq(struct vt_window *vw)
2255 {
2256 
2257 	if (vw->vw_smode.mode != VT_PROCESS)
2258 		return (FALSE);
2259 	if (vw == vw->vw_device->vd_windows[VT_CONSWINDOW])
2260 		cnavailable(vw->vw_terminal->consdev, FALSE);
2261 	if (vw->vw_proc == NULL || vt_proc_alive(vw) == FALSE) {
2262 		vw->vw_proc = NULL;
2263 		vw->vw_pid = 0;
2264 		return (TRUE);
2265 	}
2266 	vw->vw_flags |= VWF_SWWAIT_ACQ;
2267 	PROC_LOCK(vw->vw_proc);
2268 	kern_psignal(vw->vw_proc, vw->vw_smode.acqsig);
2269 	PROC_UNLOCK(vw->vw_proc);
2270 	DPRINTF(1, "sending acqsig to %d\n", vw->vw_pid);
2271 	return (TRUE);
2272 }
2273 
2274 static int
finish_vt_rel(struct vt_window * vw,int release,int * s)2275 finish_vt_rel(struct vt_window *vw, int release, int *s)
2276 {
2277 
2278 	if (vw->vw_flags & VWF_SWWAIT_REL) {
2279 		vw->vw_flags &= ~VWF_SWWAIT_REL;
2280 		if (release) {
2281 			taskqueue_drain_timeout(taskqueue_thread, &vw->vw_timeout_task_dead);
2282 			(void)vt_late_window_switch(vw->vw_switch_to);
2283 		}
2284 		return (0);
2285 	}
2286 	return (EINVAL);
2287 }
2288 
2289 static int
finish_vt_acq(struct vt_window * vw)2290 finish_vt_acq(struct vt_window *vw)
2291 {
2292 
2293 	if (vw->vw_flags & VWF_SWWAIT_ACQ) {
2294 		vw->vw_flags &= ~VWF_SWWAIT_ACQ;
2295 		return (0);
2296 	}
2297 	return (EINVAL);
2298 }
2299 
2300 #ifndef SC_NO_CUTPASTE
2301 static void
vt_mouse_terminput_button(struct vt_device * vd,int button)2302 vt_mouse_terminput_button(struct vt_device *vd, int button)
2303 {
2304 	struct vt_window *vw;
2305 	struct vt_font *vf;
2306 	char mouseb[6] = "\x1B[M";
2307 	int i, x, y;
2308 
2309 	vw = vd->vd_curwindow;
2310 	vf = vw->vw_font;
2311 
2312 	/* Translate to char position. */
2313 	x = vd->vd_mx / vf->vf_width;
2314 	y = vd->vd_my / vf->vf_height;
2315 	/* Avoid overflow. */
2316 	x = MIN(x, 255 - '!');
2317 	y = MIN(y, 255 - '!');
2318 
2319 	mouseb[3] = ' ' + button;
2320 	mouseb[4] = '!' + x;
2321 	mouseb[5] = '!' + y;
2322 
2323 	for (i = 0; i < sizeof(mouseb); i++)
2324 		terminal_input_char(vw->vw_terminal, mouseb[i]);
2325 }
2326 
2327 static void
vt_mouse_terminput(struct vt_device * vd,int type,int x,int y,int event,int cnt)2328 vt_mouse_terminput(struct vt_device *vd, int type, int x, int y, int event,
2329     int cnt)
2330 {
2331 
2332 	switch (type) {
2333 	case MOUSE_BUTTON_EVENT:
2334 		if (cnt > 0) {
2335 			/* Mouse button pressed. */
2336 			if (event & MOUSE_BUTTON1DOWN)
2337 				vt_mouse_terminput_button(vd, 0);
2338 			if (event & MOUSE_BUTTON2DOWN)
2339 				vt_mouse_terminput_button(vd, 1);
2340 			if (event & MOUSE_BUTTON3DOWN)
2341 				vt_mouse_terminput_button(vd, 2);
2342 		} else {
2343 			/* Mouse button released. */
2344 			vt_mouse_terminput_button(vd, 3);
2345 		}
2346 		break;
2347 #ifdef notyet
2348 	case MOUSE_MOTION_EVENT:
2349 		if (mouse->u.data.z < 0) {
2350 			/* Scroll up. */
2351 			sc_mouse_input_button(vd, 64);
2352 		} else if (mouse->u.data.z > 0) {
2353 			/* Scroll down. */
2354 			sc_mouse_input_button(vd, 65);
2355 		}
2356 		break;
2357 #endif
2358 	}
2359 }
2360 
2361 static void
vt_mouse_paste(void)2362 vt_mouse_paste(void)
2363 {
2364 	term_char_t *buf;
2365 	int i, len;
2366 
2367 	len = VD_PASTEBUFLEN(main_vd);
2368 	buf = VD_PASTEBUF(main_vd);
2369 	len /= sizeof(term_char_t);
2370 	for (i = 0; i < len; i++) {
2371 		if (TCHAR_CHARACTER(buf[i]) == '\0')
2372 			continue;
2373 		terminal_input_char(main_vd->vd_curwindow->vw_terminal,
2374 		    buf[i]);
2375 	}
2376 }
2377 
2378 void
vt_mouse_event(int type,int x,int y,int event,int cnt,int mlevel)2379 vt_mouse_event(int type, int x, int y, int event, int cnt, int mlevel)
2380 {
2381 	struct vt_device *vd;
2382 	struct vt_window *vw;
2383 	struct vt_font *vf;
2384 	term_pos_t size;
2385 	int len, mark;
2386 
2387 	vd = main_vd;
2388 	vw = vd->vd_curwindow;
2389 	vf = vw->vw_font;
2390 
2391 	if (vw->vw_flags & (VWF_MOUSE_HIDE | VWF_GRAPHICS))
2392 		/*
2393 		 * Either the mouse is disabled, or the window is in
2394 		 * "graphics mode". The graphics mode is usually set by
2395 		 * an X server, using the KDSETMODE ioctl.
2396 		 */
2397 		return;
2398 
2399 	if (vf == NULL)	/* Text mode. */
2400 		return;
2401 
2402 	/*
2403 	 * TODO: add flag about pointer position changed, to not redraw chars
2404 	 * under mouse pointer when nothing changed.
2405 	 */
2406 
2407 	if (vw->vw_mouse_level > 0)
2408 		vt_mouse_terminput(vd, type, x, y, event, cnt);
2409 
2410 	switch (type) {
2411 	case MOUSE_ACTION:
2412 	case MOUSE_MOTION_EVENT:
2413 		/* Movement */
2414 		x += vd->vd_mx;
2415 		y += vd->vd_my;
2416 
2417 		vt_termsize(vd, vf, &size);
2418 
2419 		/* Apply limits. */
2420 		x = MAX(x, 0);
2421 		y = MAX(y, 0);
2422 		x = MIN(x, (size.tp_col * vf->vf_width) - 1);
2423 		y = MIN(y, (size.tp_row * vf->vf_height) - 1);
2424 
2425 		vd->vd_mx = x;
2426 		vd->vd_my = y;
2427 		if (vd->vd_mstate & (MOUSE_BUTTON1DOWN | VT_MOUSE_EXTENDBUTTON))
2428 			vtbuf_set_mark(&vw->vw_buf, VTB_MARK_MOVE,
2429 			    vd->vd_mx / vf->vf_width,
2430 			    vd->vd_my / vf->vf_height);
2431 
2432 		vt_resume_flush_timer(vw, 0);
2433 		return; /* Done */
2434 	case MOUSE_BUTTON_EVENT:
2435 		/* Buttons */
2436 		break;
2437 	default:
2438 		return; /* Done */
2439 	}
2440 
2441 	switch (event) {
2442 	case MOUSE_BUTTON1DOWN:
2443 		switch (cnt % 4) {
2444 		case 0:	/* up */
2445 			mark = VTB_MARK_END;
2446 			break;
2447 		case 1: /* single click: start cut operation */
2448 			mark = VTB_MARK_START;
2449 			break;
2450 		case 2:	/* double click: cut a word */
2451 			mark = VTB_MARK_WORD;
2452 			break;
2453 		default:	/* triple click: cut a line */
2454 			mark = VTB_MARK_ROW;
2455 			break;
2456 		}
2457 		break;
2458 	case VT_MOUSE_PASTEBUTTON:
2459 		switch (cnt) {
2460 		case 0:	/* up */
2461 			break;
2462 		default:
2463 			vt_mouse_paste();
2464 			/* clear paste buffer selection after paste */
2465 			vtbuf_set_mark(&vw->vw_buf, VTB_MARK_START,
2466 			    vd->vd_mx / vf->vf_width,
2467 			    vd->vd_my / vf->vf_height);
2468 			break;
2469 		}
2470 		return; /* Done */
2471 	case VT_MOUSE_EXTENDBUTTON:
2472 		switch (cnt) {
2473 		case 0:	/* up */
2474 			if (!(vd->vd_mstate & MOUSE_BUTTON1DOWN))
2475 				mark = VTB_MARK_EXTEND;
2476 			else
2477 				mark = VTB_MARK_NONE;
2478 			break;
2479 		default:
2480 			mark = VTB_MARK_EXTEND;
2481 			break;
2482 		}
2483 		break;
2484 	default:
2485 		return; /* Done */
2486 	}
2487 
2488 	/* Save buttons state. */
2489 	if (cnt > 0)
2490 		vd->vd_mstate |= event;
2491 	else
2492 		vd->vd_mstate &= ~event;
2493 
2494 	if (vtbuf_set_mark(&vw->vw_buf, mark, vd->vd_mx / vf->vf_width,
2495 	    vd->vd_my / vf->vf_height) == 1) {
2496 		/*
2497 		 * We have something marked to copy, so update pointer to
2498 		 * window with selection.
2499 		 */
2500 		vt_resume_flush_timer(vw, 0);
2501 
2502 		switch (mark) {
2503 		case VTB_MARK_END:
2504 		case VTB_MARK_WORD:
2505 		case VTB_MARK_ROW:
2506 		case VTB_MARK_EXTEND:
2507 			break;
2508 		default:
2509 			/* Other types of mark do not require to copy data. */
2510 			return;
2511 		}
2512 
2513 		/* Get current selection size in bytes. */
2514 		len = vtbuf_get_marked_len(&vw->vw_buf);
2515 		if (len <= 0)
2516 			return;
2517 
2518 		/* Reallocate buffer only if old one is too small. */
2519 		if (len > VD_PASTEBUFSZ(vd)) {
2520 			VD_PASTEBUF(vd) = realloc(VD_PASTEBUF(vd), len, M_VT,
2521 			    M_WAITOK | M_ZERO);
2522 			/* Update buffer size. */
2523 			VD_PASTEBUFSZ(vd) = len;
2524 		}
2525 		/* Request copy/paste buffer data, no more than `len' */
2526 		vtbuf_extract_marked(&vw->vw_buf, VD_PASTEBUF(vd), len, mark);
2527 
2528 		VD_PASTEBUFLEN(vd) = len;
2529 
2530 		/* XXX VD_PASTEBUF(vd) have to be freed on shutdown/unload. */
2531 	}
2532 }
2533 
2534 void
vt_mouse_state(int show)2535 vt_mouse_state(int show)
2536 {
2537 	struct vt_device *vd;
2538 	struct vt_window *vw;
2539 
2540 	vd = main_vd;
2541 	vw = vd->vd_curwindow;
2542 
2543 	switch (show) {
2544 	case VT_MOUSE_HIDE:
2545 		vw->vw_flags |= VWF_MOUSE_HIDE;
2546 		break;
2547 	case VT_MOUSE_SHOW:
2548 		vw->vw_flags &= ~VWF_MOUSE_HIDE;
2549 		break;
2550 	}
2551 
2552 	/* Mark mouse position as dirty. */
2553 	vt_mark_mouse_position_as_dirty(vd, false);
2554 	vt_resume_flush_timer(vw, 0);
2555 }
2556 #endif
2557 
2558 static int
vtterm_mmap(struct terminal * tm,vm_ooffset_t offset,vm_paddr_t * paddr,int nprot,vm_memattr_t * memattr)2559 vtterm_mmap(struct terminal *tm, vm_ooffset_t offset, vm_paddr_t * paddr,
2560     int nprot, vm_memattr_t *memattr)
2561 {
2562 	struct vt_window *vw = tm->tm_softc;
2563 	struct vt_device *vd = vw->vw_device;
2564 
2565 	if (vd->vd_driver->vd_fb_mmap)
2566 		return (vd->vd_driver->vd_fb_mmap(vd, offset, paddr, nprot,
2567 		    memattr));
2568 
2569 	return (ENXIO);
2570 }
2571 
2572 static int
vtterm_ioctl(struct terminal * tm,u_long cmd,caddr_t data,struct thread * td)2573 vtterm_ioctl(struct terminal *tm, u_long cmd, caddr_t data,
2574     struct thread *td)
2575 {
2576 	struct vt_window *vw = tm->tm_softc;
2577 	struct vt_device *vd = vw->vw_device;
2578 	keyboard_t *kbd;
2579 	int error, i, s;
2580 #if defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD5) || \
2581     defined(COMPAT_FREEBSD4) || defined(COMPAT_43)
2582 	int ival;
2583 
2584 	switch (cmd) {
2585 	case _IO('v', 4):
2586 		cmd = VT_RELDISP;
2587 		break;
2588 	case _IO('v', 5):
2589 		cmd = VT_ACTIVATE;
2590 		break;
2591 	case _IO('v', 6):
2592 		cmd = VT_WAITACTIVE;
2593 		break;
2594 	case _IO('K', 20):
2595 		cmd = KDSKBSTATE;
2596 		break;
2597 	case _IO('K', 67):
2598 		cmd = KDSETRAD;
2599 		break;
2600 	case _IO('K', 7):
2601 		cmd = KDSKBMODE;
2602 		break;
2603 	case _IO('K', 8):
2604 		cmd = KDMKTONE;
2605 		break;
2606 	case _IO('K', 10):
2607 		cmd = KDSETMODE;
2608 		break;
2609 	case _IO('K', 13):
2610 		cmd = KDSBORDER;
2611 		break;
2612 	case _IO('K', 63):
2613 		cmd = KIOCSOUND;
2614 		break;
2615 	case _IO('K', 66):
2616 		cmd = KDSETLED;
2617 		break;
2618 	case _IO('c', 104):
2619 		cmd = CONS_SETWINORG;
2620 		break;
2621 	case _IO('c', 110):
2622 		cmd = CONS_SETKBD;
2623 		break;
2624 	default:
2625 		goto skip_thunk;
2626 	}
2627 	ival = IOCPARM_IVAL(data);
2628 	data = (caddr_t)&ival;
2629 skip_thunk:
2630 #endif
2631 
2632 	switch (cmd) {
2633 	case KDSETRAD:		/* set keyboard repeat & delay rates (old) */
2634 		if (*(int *)data & ~0x7f)
2635 			return (EINVAL);
2636 		/* FALLTHROUGH */
2637 	case GIO_KEYMAP:
2638 	case PIO_KEYMAP:
2639 	case GIO_DEADKEYMAP:
2640 	case PIO_DEADKEYMAP:
2641 #ifdef COMPAT_FREEBSD13
2642 	case OGIO_DEADKEYMAP:
2643 	case OPIO_DEADKEYMAP:
2644 #endif /* COMPAT_FREEBSD13 */
2645 	case GETFKEY:
2646 	case SETFKEY:
2647 	case KDGKBINFO:
2648 	case KDGKBTYPE:
2649 	case KDGETREPEAT:	/* get keyboard repeat & delay rates */
2650 	case KDSETREPEAT:	/* set keyboard repeat & delay rates (new) */
2651 	case KBADDKBD:		/* add keyboard to mux */
2652 	case KBRELKBD: {	/* release keyboard from mux */
2653 		error = 0;
2654 
2655 		mtx_lock(&Giant);
2656 		if ((kbd = vd->vd_keyboard) != NULL)
2657 			error = kbdd_ioctl(kbd, cmd, data);
2658 		mtx_unlock(&Giant);
2659 		if (error == ENOIOCTL) {
2660 			if (cmd == KDGKBTYPE) {
2661 				/* always return something? XXX */
2662 				*(int *)data = 0;
2663 			} else {
2664 				return (ENODEV);
2665 			}
2666 		}
2667 		return (error);
2668 	}
2669 	case KDGKBSTATE: {	/* get keyboard state (locks) */
2670 		error = 0;
2671 
2672 		if (vw == vd->vd_curwindow) {
2673 			mtx_lock(&Giant);
2674 			if ((kbd = vd->vd_keyboard) != NULL)
2675 				error = vt_save_kbd_state(vw, kbd);
2676 			mtx_unlock(&Giant);
2677 
2678 			if (error != 0)
2679 				return (error);
2680 		}
2681 
2682 		*(int *)data = vw->vw_kbdstate & LOCK_MASK;
2683 
2684 		return (error);
2685 	}
2686 	case KDSKBSTATE: {	/* set keyboard state (locks) */
2687 		int state;
2688 
2689 		state = *(int *)data;
2690 		if (state & ~LOCK_MASK)
2691 			return (EINVAL);
2692 
2693 		vw->vw_kbdstate &= ~LOCK_MASK;
2694 		vw->vw_kbdstate |= state;
2695 
2696 		error = 0;
2697 		if (vw == vd->vd_curwindow) {
2698 			mtx_lock(&Giant);
2699 			if ((kbd = vd->vd_keyboard) != NULL)
2700 				error = vt_update_kbd_state(vw, kbd);
2701 			mtx_unlock(&Giant);
2702 		}
2703 
2704 		return (error);
2705 	}
2706 	case KDGETLED: {	/* get keyboard LED status */
2707 		error = 0;
2708 
2709 		if (vw == vd->vd_curwindow) {
2710 			mtx_lock(&Giant);
2711 			if ((kbd = vd->vd_keyboard) != NULL)
2712 				error = vt_save_kbd_leds(vw, kbd);
2713 			mtx_unlock(&Giant);
2714 
2715 			if (error != 0)
2716 				return (error);
2717 		}
2718 
2719 		*(int *)data = vw->vw_kbdstate & LED_MASK;
2720 
2721 		return (error);
2722 	}
2723 	case KDSETLED: {	/* set keyboard LED status */
2724 		int leds;
2725 
2726 		leds = *(int *)data;
2727 		if (leds & ~LED_MASK)
2728 			return (EINVAL);
2729 
2730 		vw->vw_kbdstate &= ~LED_MASK;
2731 		vw->vw_kbdstate |= leds;
2732 
2733 		error = 0;
2734 		if (vw == vd->vd_curwindow) {
2735 			mtx_lock(&Giant);
2736 			if ((kbd = vd->vd_keyboard) != NULL)
2737 				error = vt_update_kbd_leds(vw, kbd);
2738 			mtx_unlock(&Giant);
2739 		}
2740 
2741 		return (error);
2742 	}
2743 	case KDGETMODE:
2744 		*(int *)data = (vw->vw_flags & VWF_GRAPHICS) ?
2745 		    KD_GRAPHICS : KD_TEXT;
2746 		return (0);
2747 	case KDGKBMODE: {
2748 		error = 0;
2749 
2750 		if (vw == vd->vd_curwindow) {
2751 			mtx_lock(&Giant);
2752 			if ((kbd = vd->vd_keyboard) != NULL)
2753 				error = vt_save_kbd_mode(vw, kbd);
2754 			mtx_unlock(&Giant);
2755 
2756 			if (error != 0)
2757 				return (error);
2758 		}
2759 
2760 		*(int *)data = vw->vw_kbdmode;
2761 
2762 		return (error);
2763 	}
2764 	case KDSKBMODE: {
2765 		int mode;
2766 
2767 		mode = *(int *)data;
2768 		switch (mode) {
2769 		case K_XLATE:
2770 		case K_RAW:
2771 		case K_CODE:
2772 			vw->vw_kbdmode = mode;
2773 
2774 			error = 0;
2775 			if (vw == vd->vd_curwindow) {
2776 				mtx_lock(&Giant);
2777 				if ((kbd = vd->vd_keyboard) != NULL)
2778 					error = vt_update_kbd_mode(vw, kbd);
2779 				mtx_unlock(&Giant);
2780 			}
2781 
2782 			return (error);
2783 		default:
2784 			return (EINVAL);
2785 		}
2786 	}
2787 	case FBIOGTYPE:
2788 	case FBIO_GETWINORG:	/* get frame buffer window origin */
2789 	case FBIO_GETDISPSTART:	/* get display start address */
2790 	case FBIO_GETLINEWIDTH:	/* get scan line width in bytes */
2791 	case FBIO_BLANK:	/* blank display */
2792 	case FBIO_GETRGBOFFS:	/* get RGB offsets */
2793 		if (vd->vd_driver->vd_fb_ioctl)
2794 			return (vd->vd_driver->vd_fb_ioctl(vd, cmd, data, td));
2795 		break;
2796 	case CONS_BLANKTIME:
2797 		/* XXX */
2798 		return (0);
2799 	case CONS_HISTORY:
2800 		if (*(int *)data < 0)
2801 			return EINVAL;
2802 		if (*(int *)data != vw->vw_buf.vb_history_size)
2803 			vtbuf_sethistory_size(&vw->vw_buf, *(int *)data);
2804 		return (0);
2805 	case CONS_CLRHIST:
2806 		vtbuf_clearhistory(&vw->vw_buf);
2807 		/*
2808 		 * Invalidate the entire visible window; it is not guaranteed
2809 		 * that this operation will be immediately followed by a scroll
2810 		 * event, so it would otherwise be possible for prior artifacts
2811 		 * to remain visible.
2812 		 */
2813 		VT_LOCK(vd);
2814 		if (vw == vd->vd_curwindow) {
2815 			vd->vd_flags |= VDF_INVALID;
2816 			vt_resume_flush_timer(vw, 0);
2817 		}
2818 		VT_UNLOCK(vd);
2819 		return (0);
2820 	case CONS_GET:
2821 		/* XXX */
2822 		*(int *)data = M_CG640x480;
2823 		return (0);
2824 	case CONS_BELLTYPE:	/* set bell type sound */
2825 		if ((*(int *)data) & CONS_QUIET_BELL)
2826 			vd->vd_flags |= VDF_QUIET_BELL;
2827 		else
2828 			vd->vd_flags &= ~VDF_QUIET_BELL;
2829 		return (0);
2830 	case CONS_GETINFO: {
2831 		vid_info_t *vi = (vid_info_t *)data;
2832 		if (vi->size != sizeof(struct vid_info))
2833 			return (EINVAL);
2834 
2835 		if (vw == vd->vd_curwindow) {
2836 			mtx_lock(&Giant);
2837 			if ((kbd = vd->vd_keyboard) != NULL)
2838 				vt_save_kbd_state(vw, kbd);
2839 			mtx_unlock(&Giant);
2840 		}
2841 
2842 		vi->m_num = vd->vd_curwindow->vw_number + 1;
2843 		vi->mk_keylock = vw->vw_kbdstate & LOCK_MASK;
2844 		/* XXX: other fields! */
2845 		return (0);
2846 	}
2847 	case CONS_GETVERS:
2848 		*(int *)data = 0x200;
2849 		return (0);
2850 	case CONS_MODEINFO:
2851 		/* XXX */
2852 		return (0);
2853 	case CONS_MOUSECTL: {
2854 		mouse_info_t *mouse = (mouse_info_t*)data;
2855 
2856 		/*
2857 		 * All the commands except MOUSE_SHOW nd MOUSE_HIDE
2858 		 * should not be applied to individual TTYs, but only to
2859 		 * consolectl.
2860 		 */
2861 		switch (mouse->operation) {
2862 		case MOUSE_HIDE:
2863 			if (vd->vd_flags & VDF_MOUSECURSOR) {
2864 				vd->vd_flags &= ~VDF_MOUSECURSOR;
2865 #ifndef SC_NO_CUTPASTE
2866 				vt_mouse_state(VT_MOUSE_HIDE);
2867 #endif
2868 			}
2869 			return (0);
2870 		case MOUSE_SHOW:
2871 			if (!(vd->vd_flags & VDF_MOUSECURSOR)) {
2872 				vd->vd_flags |= VDF_MOUSECURSOR;
2873 				vd->vd_mx = vd->vd_width / 2;
2874 				vd->vd_my = vd->vd_height / 2;
2875 #ifndef SC_NO_CUTPASTE
2876 				vt_mouse_state(VT_MOUSE_SHOW);
2877 #endif
2878 			}
2879 			return (0);
2880 		default:
2881 			return (EINVAL);
2882 		}
2883 	}
2884 	case PIO_VFONT: {
2885 		struct vt_font *vf;
2886 
2887 		if (vd->vd_flags & VDF_TEXTMODE)
2888 			return (ENOTSUP);
2889 
2890 		error = vtfont_load((void *)data, &vf);
2891 		if (error != 0)
2892 			return (error);
2893 
2894 		error = vt_change_font(vw, vf);
2895 		vtfont_unref(vf);
2896 		return (error);
2897 	}
2898 	case PIO_VFONT_DEFAULT: {
2899 		/* Reset to default font. */
2900 		error = vt_change_font(vw, vt_font_assigned);
2901 		return (error);
2902 	}
2903 	case GIO_SCRNMAP: {
2904 		scrmap_t *sm = (scrmap_t *)data;
2905 
2906 		/* We don't have screen maps, so return a handcrafted one. */
2907 		for (i = 0; i < 256; i++)
2908 			sm->scrmap[i] = i;
2909 		return (0);
2910 	}
2911 	case KDSETMODE:
2912 		/*
2913 		 * FIXME: This implementation is incomplete compared to
2914 		 * syscons.
2915 		 */
2916 		switch (*(int *)data) {
2917 		case KD_TEXT:
2918 		case KD_TEXT1:
2919 		case KD_PIXEL:
2920 			vw->vw_flags &= ~VWF_GRAPHICS;
2921 			break;
2922 		case KD_GRAPHICS:
2923 			vw->vw_flags |= VWF_GRAPHICS;
2924 			break;
2925 		}
2926 		return (0);
2927 	case KDENABIO:		/* allow io operations */
2928 		error = priv_check(td, PRIV_IO);
2929 		if (error != 0)
2930 			return (error);
2931 		error = securelevel_gt(td->td_ucred, 0);
2932 		if (error != 0)
2933 			return (error);
2934 #if defined(__i386__)
2935 		td->td_frame->tf_eflags |= PSL_IOPL;
2936 #elif defined(__amd64__)
2937 		td->td_frame->tf_rflags |= PSL_IOPL;
2938 #endif
2939 		return (0);
2940 	case KDDISABIO:		/* disallow io operations (default) */
2941 #if defined(__i386__)
2942 		td->td_frame->tf_eflags &= ~PSL_IOPL;
2943 #elif defined(__amd64__)
2944 		td->td_frame->tf_rflags &= ~PSL_IOPL;
2945 #endif
2946 		return (0);
2947 	case KDMKTONE:		/* sound the bell */
2948 		vtterm_beep(tm, *(u_int *)data);
2949 		return (0);
2950 	case KIOCSOUND:		/* make tone (*data) hz */
2951 		/* TODO */
2952 		return (0);
2953 	case CONS_SETKBD:	/* set the new keyboard */
2954 		mtx_lock(&Giant);
2955 		error = 0;
2956 		if (vd->vd_keyboard == NULL ||
2957 		    vd->vd_keyboard->kb_index != *(int *)data) {
2958 			kbd = kbd_get_keyboard(*(int *)data);
2959 			if (kbd == NULL) {
2960 				mtx_unlock(&Giant);
2961 				return (EINVAL);
2962 			}
2963 			i = kbd_allocate(kbd->kb_name, kbd->kb_unit,
2964 			    (void *)vd, vt_kbdevent, vd);
2965 			if (i >= 0) {
2966 				if ((kbd = vd->vd_keyboard) != NULL) {
2967 					vt_save_kbd_state(vd->vd_curwindow, kbd);
2968 					kbd_release(kbd, (void *)vd);
2969 				}
2970 				kbd = vd->vd_keyboard = kbd_get_keyboard(i);
2971 
2972 				vt_update_kbd_mode(vd->vd_curwindow, kbd);
2973 				vt_update_kbd_state(vd->vd_curwindow, kbd);
2974 			} else {
2975 				error = EPERM;	/* XXX */
2976 			}
2977 		}
2978 		mtx_unlock(&Giant);
2979 		return (error);
2980 	case CONS_RELKBD:	/* release the current keyboard */
2981 		mtx_lock(&Giant);
2982 		error = 0;
2983 		if ((kbd = vd->vd_keyboard) != NULL) {
2984 			vt_save_kbd_state(vd->vd_curwindow, kbd);
2985 			error = kbd_release(kbd, (void *)vd);
2986 			if (error == 0) {
2987 				vd->vd_keyboard = NULL;
2988 			}
2989 		}
2990 		mtx_unlock(&Giant);
2991 		return (error);
2992 	case VT_ACTIVATE: {
2993 		int win;
2994 		win = *(int *)data - 1;
2995 		DPRINTF(5, "%s%d: VT_ACTIVATE ttyv%d ", SC_DRIVER_NAME,
2996 		    VT_UNIT(vw), win);
2997 		if ((win >= VT_MAXWINDOWS) || (win < 0))
2998 			return (EINVAL);
2999 		return (vt_proc_window_switch(vd->vd_windows[win]));
3000 	}
3001 	case VT_GETACTIVE:
3002 		*(int *)data = vd->vd_curwindow->vw_number + 1;
3003 		return (0);
3004 	case VT_GETINDEX:
3005 		*(int *)data = vw->vw_number + 1;
3006 		return (0);
3007 	case VT_LOCKSWITCH:
3008 		/* TODO: Check current state, switching can be in progress. */
3009 		if ((*(int *)data) == 0x01)
3010 			vw->vw_flags |= VWF_VTYLOCK;
3011 		else if ((*(int *)data) == 0x02)
3012 			vw->vw_flags &= ~VWF_VTYLOCK;
3013 		else
3014 			return (EINVAL);
3015 		return (0);
3016 	case VT_OPENQRY:
3017 		VT_LOCK(vd);
3018 		for (i = 0; i < VT_MAXWINDOWS; i++) {
3019 			vw = vd->vd_windows[i];
3020 			if (vw == NULL)
3021 				continue;
3022 			if (!(vw->vw_flags & VWF_OPENED)) {
3023 				*(int *)data = vw->vw_number + 1;
3024 				VT_UNLOCK(vd);
3025 				return (0);
3026 			}
3027 		}
3028 		VT_UNLOCK(vd);
3029 		return (EINVAL);
3030 	case VT_WAITACTIVE: {
3031 		unsigned int idx;
3032 
3033 		error = 0;
3034 
3035 		idx = *(unsigned int *)data;
3036 		if (idx > VT_MAXWINDOWS)
3037 			return (EINVAL);
3038 		if (idx > 0)
3039 			vw = vd->vd_windows[idx - 1];
3040 
3041 		VT_LOCK(vd);
3042 		while (vd->vd_curwindow != vw && error == 0)
3043 			error = cv_wait_sig(&vd->vd_winswitch, &vd->vd_lock);
3044 		VT_UNLOCK(vd);
3045 		return (error);
3046 	}
3047 	case VT_SETMODE: {	/* set screen switcher mode */
3048 		struct vt_mode *mode;
3049 		struct proc *p1;
3050 
3051 		mode = (struct vt_mode *)data;
3052 		DPRINTF(5, "%s%d: VT_SETMODE ", SC_DRIVER_NAME, VT_UNIT(vw));
3053 		if (vw->vw_smode.mode == VT_PROCESS) {
3054 			p1 = pfind(vw->vw_pid);
3055 			if (vw->vw_proc == p1 && vw->vw_proc != td->td_proc) {
3056 				if (p1)
3057 					PROC_UNLOCK(p1);
3058 				DPRINTF(5, "error EPERM\n");
3059 				return (EPERM);
3060 			}
3061 			if (p1)
3062 				PROC_UNLOCK(p1);
3063 		}
3064 		if (mode->mode == VT_AUTO) {
3065 			vw->vw_smode.mode = VT_AUTO;
3066 			vw->vw_proc = NULL;
3067 			vw->vw_pid = 0;
3068 			DPRINTF(5, "VT_AUTO, ");
3069 			if (vw == vw->vw_device->vd_windows[VT_CONSWINDOW])
3070 				cnavailable(vw->vw_terminal->consdev, TRUE);
3071 			/* were we in the middle of the vty switching process? */
3072 			if (finish_vt_rel(vw, TRUE, &s) == 0)
3073 				DPRINTF(5, "reset WAIT_REL, ");
3074 			if (finish_vt_acq(vw) == 0)
3075 				DPRINTF(5, "reset WAIT_ACQ, ");
3076 			return (0);
3077 		} else if (mode->mode == VT_PROCESS) {
3078 			if (!(_SIG_VALID(mode->relsig) &&
3079 			    _SIG_VALID(mode->acqsig) &&
3080 			    (mode->frsig == 0 || _SIG_VALID(mode->frsig)))) {
3081 				DPRINTF(5, "error EINVAL\n");
3082 				return (EINVAL);
3083 			}
3084 			DPRINTF(5, "VT_PROCESS %d, ", td->td_proc->p_pid);
3085 			bcopy(data, &vw->vw_smode, sizeof(struct vt_mode));
3086 			vw->vw_proc = td->td_proc;
3087 			vw->vw_pid = vw->vw_proc->p_pid;
3088 			if (vw == vw->vw_device->vd_windows[VT_CONSWINDOW])
3089 				cnavailable(vw->vw_terminal->consdev, FALSE);
3090 		} else {
3091 			DPRINTF(5, "VT_SETMODE failed, unknown mode %d\n",
3092 			    mode->mode);
3093 			return (EINVAL);
3094 		}
3095 		DPRINTF(5, "\n");
3096 		return (0);
3097 	}
3098 	case VT_GETMODE:	/* get screen switcher mode */
3099 		bcopy(&vw->vw_smode, data, sizeof(struct vt_mode));
3100 		return (0);
3101 
3102 	case VT_RELDISP:	/* screen switcher ioctl */
3103 		/*
3104 		 * This must be the current vty which is in the VT_PROCESS
3105 		 * switching mode...
3106 		 */
3107 		if ((vw != vd->vd_curwindow) || (vw->vw_smode.mode !=
3108 		    VT_PROCESS)) {
3109 			return (EINVAL);
3110 		}
3111 		/* ...and this process is controlling it. */
3112 		if (vw->vw_proc != td->td_proc) {
3113 			return (EPERM);
3114 		}
3115 		error = EINVAL;
3116 		switch(*(int *)data) {
3117 		case VT_FALSE:	/* user refuses to release screen, abort */
3118 			if ((error = finish_vt_rel(vw, FALSE, &s)) == 0)
3119 				DPRINTF(5, "%s%d: VT_RELDISP: VT_FALSE\n",
3120 				    SC_DRIVER_NAME, VT_UNIT(vw));
3121 			break;
3122 		case VT_TRUE:	/* user has released screen, go on */
3123 			/* finish_vt_rel(..., TRUE, ...) should not be locked */
3124 			if (vw->vw_flags & VWF_SWWAIT_REL) {
3125 				if ((error = finish_vt_rel(vw, TRUE, &s)) == 0)
3126 					DPRINTF(5, "%s%d: VT_RELDISP: VT_TRUE\n",
3127 					    SC_DRIVER_NAME, VT_UNIT(vw));
3128 			} else {
3129 				error = EINVAL;
3130 			}
3131 			return (error);
3132 		case VT_ACKACQ:	/* acquire acknowledged, switch completed */
3133 			if ((error = finish_vt_acq(vw)) == 0)
3134 				DPRINTF(5, "%s%d: VT_RELDISP: VT_ACKACQ\n",
3135 				    SC_DRIVER_NAME, VT_UNIT(vw));
3136 			break;
3137 		default:
3138 			break;
3139 		}
3140 		return (error);
3141 	}
3142 
3143 	return (ENOIOCTL);
3144 }
3145 
3146 static struct vt_window *
vt_allocate_window(struct vt_device * vd,unsigned int window)3147 vt_allocate_window(struct vt_device *vd, unsigned int window)
3148 {
3149 	struct vt_window *vw;
3150 	struct terminal *tm;
3151 	term_pos_t size;
3152 	struct winsize wsz;
3153 
3154 	vw = malloc(sizeof *vw, M_VT, M_WAITOK|M_ZERO);
3155 	vw->vw_device = vd;
3156 	vw->vw_number = window;
3157 	vw->vw_kbdmode = K_XLATE;
3158 
3159 	if ((vd->vd_flags & VDF_TEXTMODE) == 0) {
3160 		vw->vw_font = vtfont_ref(vt_font_assigned);
3161 		vt_compute_drawable_area(vw);
3162 	}
3163 
3164 	vt_termsize(vd, vw->vw_font, &size);
3165 	vt_winsize(vd, vw->vw_font, &wsz);
3166 	tm = vw->vw_terminal = terminal_alloc(&vt_termclass, vw);
3167 	vw->vw_buf.vb_terminal = tm;	/* must be set before vtbuf_init() */
3168 	vtbuf_init(&vw->vw_buf, &size);
3169 
3170 	terminal_set_winsize(tm, &wsz);
3171 	vd->vd_windows[window] = vw;
3172 	TIMEOUT_TASK_INIT(taskqueue_thread, &vw->vw_timeout_task_dead, 0, &vt_switch_timer, vw);
3173 
3174 	return (vw);
3175 }
3176 
3177 void
vt_upgrade(struct vt_device * vd)3178 vt_upgrade(struct vt_device *vd)
3179 {
3180 	struct vt_window *vw;
3181 	unsigned int i;
3182 	int register_handlers;
3183 
3184 	if (!vty_enabled(VTY_VT))
3185 		return;
3186 	if (main_vd->vd_driver == NULL)
3187 		return;
3188 
3189 	for (i = 0; i < VT_MAXWINDOWS; i++) {
3190 		vw = vd->vd_windows[i];
3191 		if (vw == NULL) {
3192 			/* New window. */
3193 			vw = vt_allocate_window(vd, i);
3194 		}
3195 		if (!(vw->vw_flags & VWF_READY)) {
3196 			TIMEOUT_TASK_INIT(taskqueue_thread, &vw->vw_timeout_task_dead, 0, &vt_switch_timer, vw);
3197 			terminal_maketty(vw->vw_terminal, "v%r", VT_UNIT(vw));
3198 			vw->vw_flags |= VWF_READY;
3199 			if (vw->vw_flags & VWF_CONSOLE) {
3200 				/* For existing console window. */
3201 				EVENTHANDLER_REGISTER(shutdown_pre_sync,
3202 				    vt_window_switch, vw, SHUTDOWN_PRI_DEFAULT);
3203 #ifdef DEV_SPLASH
3204 				EVENTHANDLER_REGISTER(shutdown_pre_sync,
3205 				    vt_shutdown_splash, vw, SHUTDOWN_PRI_DEFAULT + 1);
3206 #endif
3207 			}
3208 		}
3209 	}
3210 	VT_LOCK(vd);
3211 	if (vd->vd_curwindow == NULL)
3212 		vd->vd_curwindow = vd->vd_windows[VT_CONSWINDOW];
3213 
3214 	register_handlers = 0;
3215 	if (!(vd->vd_flags & VDF_ASYNC)) {
3216 		/* Attach keyboard. */
3217 		vt_allocate_keyboard(vd);
3218 
3219 		/* Init 25 Hz timer. */
3220 		callout_init_mtx(&vd->vd_timer, &vd->vd_lock, 0);
3221 
3222 		/*
3223 		 * Start timer when everything ready.
3224 		 * Note that the operations here are purposefully ordered.
3225 		 * We need to ensure vd_timer_armed is non-zero before we set
3226 		 * the VDF_ASYNC flag. That prevents this function from
3227 		 * racing with vt_resume_flush_timer() to update the
3228 		 * callout structure.
3229 		 */
3230 		atomic_add_acq_int(&vd->vd_timer_armed, 1);
3231 		vd->vd_flags |= VDF_ASYNC;
3232 		callout_reset(&vd->vd_timer, hz / VT_TIMERFREQ, vt_timer, vd);
3233 		register_handlers = 1;
3234 	}
3235 
3236 	VT_UNLOCK(vd);
3237 
3238 	/* Refill settings with new sizes. */
3239 	vt_resize(vd);
3240 
3241 	if (register_handlers) {
3242 		/* Register suspend/resume handlers. */
3243 		EVENTHANDLER_REGISTER(power_suspend_early, vt_suspend_handler,
3244 		    vd, EVENTHANDLER_PRI_ANY);
3245 		EVENTHANDLER_REGISTER(power_resume, vt_resume_handler, vd,
3246 		    EVENTHANDLER_PRI_ANY);
3247 	}
3248 }
3249 
3250 static void
vt_resize(struct vt_device * vd)3251 vt_resize(struct vt_device *vd)
3252 {
3253 	struct vt_window *vw;
3254 	int i;
3255 
3256 	for (i = 0; i < VT_MAXWINDOWS; i++) {
3257 		vw = vd->vd_windows[i];
3258 		VT_LOCK(vd);
3259 		/* Assign default font to window, if not textmode. */
3260 		if (!(vd->vd_flags & VDF_TEXTMODE) && vw->vw_font == NULL)
3261 			vw->vw_font = vtfont_ref(vt_font_assigned);
3262 		VT_UNLOCK(vd);
3263 
3264 		/* Resize terminal windows */
3265 		while (vt_change_font(vw, vw->vw_font) == EBUSY) {
3266 			DPRINTF(100, "%s: vt_change_font() is busy, "
3267 			    "window %d\n", __func__, i);
3268 		}
3269 	}
3270 }
3271 
3272 static void
vt_replace_backend(const struct vt_driver * drv,void * softc)3273 vt_replace_backend(const struct vt_driver *drv, void *softc)
3274 {
3275 	struct vt_device *vd;
3276 
3277 	vd = main_vd;
3278 
3279 	if (vd->vd_flags & VDF_ASYNC) {
3280 		/* Stop vt_flush periodic task. */
3281 		VT_LOCK(vd);
3282 		vt_suspend_flush_timer(vd);
3283 		VT_UNLOCK(vd);
3284 		/*
3285 		 * Mute current terminal until we done. vt_change_font (called
3286 		 * from vt_resize) will unmute it.
3287 		 */
3288 		terminal_mute(vd->vd_curwindow->vw_terminal, 1);
3289 	}
3290 
3291 	/*
3292 	 * Reset VDF_TEXTMODE flag, driver who require that flag (vt_vga) will
3293 	 * set it.
3294 	 */
3295 	VT_LOCK(vd);
3296 	vd->vd_flags &= ~VDF_TEXTMODE;
3297 
3298 	if (drv != NULL) {
3299 		/*
3300 		 * We want to upgrade from the current driver to the
3301 		 * given driver.
3302 		 */
3303 
3304 		vd->vd_prev_driver = vd->vd_driver;
3305 		vd->vd_prev_softc = vd->vd_softc;
3306 		vd->vd_driver = drv;
3307 		vd->vd_softc = softc;
3308 
3309 		vd->vd_driver->vd_init(vd);
3310 	} else if (vd->vd_prev_driver != NULL && vd->vd_prev_softc != NULL) {
3311 		/*
3312 		 * No driver given: we want to downgrade to the previous
3313 		 * driver.
3314 		 */
3315 		const struct vt_driver *old_drv;
3316 		void *old_softc;
3317 
3318 		old_drv = vd->vd_driver;
3319 		old_softc = vd->vd_softc;
3320 
3321 		vd->vd_driver = vd->vd_prev_driver;
3322 		vd->vd_softc = vd->vd_prev_softc;
3323 		vd->vd_prev_driver = NULL;
3324 		vd->vd_prev_softc = NULL;
3325 
3326 		vd->vd_flags |= VDF_DOWNGRADE;
3327 
3328 		vd->vd_driver->vd_init(vd);
3329 
3330 		if (old_drv->vd_fini)
3331 			old_drv->vd_fini(vd, old_softc);
3332 
3333 		vd->vd_flags &= ~VDF_DOWNGRADE;
3334 	}
3335 
3336 	VT_UNLOCK(vd);
3337 
3338 	/* Update windows sizes and initialize last items. */
3339 	vt_upgrade(vd);
3340 
3341 	/*
3342 	 * Give a chance to the new backend to run the post-switch code, for
3343 	 * instance to refresh the screen.
3344 	 */
3345 	if (vd->vd_driver->vd_postswitch)
3346 		vd->vd_driver->vd_postswitch(vd);
3347 
3348 #ifdef DEV_SPLASH
3349 	if (vd->vd_flags & VDF_SPLASH)
3350 		vtterm_splash(vd);
3351 #endif
3352 
3353 	if (vd->vd_flags & VDF_ASYNC) {
3354 		/* Allow to put chars now. */
3355 		terminal_mute(vd->vd_curwindow->vw_terminal, 0);
3356 		/* Rerun timer for screen updates. */
3357 		vt_resume_flush_timer(vd->vd_curwindow, 0);
3358 	}
3359 
3360 	/*
3361 	 * Register as console. If it already registered, cnadd() will ignore
3362 	 * it.
3363 	 */
3364 	termcn_cnregister(vd->vd_windows[VT_CONSWINDOW]->vw_terminal);
3365 }
3366 
3367 static void
vt_suspend_handler(void * priv,enum power_stype stype)3368 vt_suspend_handler(void *priv, enum power_stype stype)
3369 {
3370 	struct vt_device *vd;
3371 
3372 	vd = priv;
3373 	vd->vd_flags |= VDF_SUSPENDED;
3374 	if (vd->vd_driver != NULL && vd->vd_driver->vd_suspend != NULL)
3375 		vd->vd_driver->vd_suspend(vd);
3376 }
3377 
3378 static void
vt_resume_handler(void * priv,enum power_stype stype)3379 vt_resume_handler(void *priv, enum power_stype stype)
3380 {
3381 	struct vt_device *vd;
3382 
3383 	vd = priv;
3384 	if (vd->vd_driver != NULL && vd->vd_driver->vd_resume != NULL)
3385 		vd->vd_driver->vd_resume(vd);
3386 	vd->vd_flags &= ~VDF_SUSPENDED;
3387 }
3388 
3389 int
vt_allocate(const struct vt_driver * drv,void * softc)3390 vt_allocate(const struct vt_driver *drv, void *softc)
3391 {
3392 
3393 	if (!vty_enabled(VTY_VT))
3394 		return (EINVAL);
3395 
3396 	if (main_vd->vd_driver == NULL) {
3397 		main_vd->vd_driver = drv;
3398 		printf("VT: initialize with new VT driver \"%s\".\n",
3399 		    drv->vd_name);
3400 	} else {
3401 		/*
3402 		 * Check if have rights to replace current driver. For example:
3403 		 * it is bad idea to replace KMS driver with generic VGA one.
3404 		 */
3405 		if (drv->vd_priority <= main_vd->vd_driver->vd_priority) {
3406 			printf("VT: Driver priority %d too low. Current %d\n ",
3407 			    drv->vd_priority, main_vd->vd_driver->vd_priority);
3408 			return (EEXIST);
3409 		}
3410 		printf("VT: Replacing driver \"%s\" with new \"%s\".\n",
3411 		    main_vd->vd_driver->vd_name, drv->vd_name);
3412 	}
3413 
3414 	vt_replace_backend(drv, softc);
3415 
3416 	return (0);
3417 }
3418 
3419 int
vt_deallocate(const struct vt_driver * drv,void * softc)3420 vt_deallocate(const struct vt_driver *drv, void *softc)
3421 {
3422 
3423 	if (!vty_enabled(VTY_VT))
3424 		return (EINVAL);
3425 
3426 	if (main_vd->vd_prev_driver == NULL ||
3427 	    main_vd->vd_driver != drv ||
3428 	    main_vd->vd_softc != softc)
3429 		return (EPERM);
3430 
3431 	printf("VT: Switching back from \"%s\" to \"%s\".\n",
3432 	    main_vd->vd_driver->vd_name, main_vd->vd_prev_driver->vd_name);
3433 
3434 	vt_replace_backend(NULL, NULL);
3435 
3436 	return (0);
3437 }
3438 
3439 void
vt_suspend(struct vt_device * vd)3440 vt_suspend(struct vt_device *vd)
3441 {
3442 	int error;
3443 
3444 	if (vt_suspendswitch == 0)
3445 		return;
3446 	/* Save current window. */
3447 	vd->vd_savedwindow = vd->vd_curwindow;
3448 	/* Ask holding process to free window and switch to console window */
3449 	vt_proc_window_switch(vd->vd_windows[VT_CONSWINDOW]);
3450 
3451 	/* Wait for the window switch to complete. */
3452 	error = 0;
3453 	VT_LOCK(vd);
3454 	while (vd->vd_curwindow != vd->vd_windows[VT_CONSWINDOW] && error == 0)
3455 		error = cv_wait_sig(&vd->vd_winswitch, &vd->vd_lock);
3456 	VT_UNLOCK(vd);
3457 }
3458 
3459 void
vt_resume(struct vt_device * vd)3460 vt_resume(struct vt_device *vd)
3461 {
3462 
3463 	if (vt_suspendswitch == 0)
3464 		return;
3465 	/* Switch back to saved window, if any */
3466 	vt_proc_window_switch(vd->vd_savedwindow);
3467 	vd->vd_savedwindow = NULL;
3468 }
3469