2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2009, 2013 The FreeBSD Foundation
6 * This software was developed by Ed Schouten under sponsorship from the
9 * Portions of this software were developed by Oleksandr Rybalko
10 * under sponsorship from the FreeBSD Foundation.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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
39 #include <sys/param.h>
40 #include <sys/_lock.h>
41 #include <sys/_mutex.h>
42 #include <sys/callout.h>
43 #include <sys/condvar.h>
45 #include <sys/consio.h>
47 #include <sys/mouse.h>
48 #include <sys/terminal.h>
49 #include <sys/sysctl.h>
52 #include "opt_syscons.h"
53 #include "opt_splash.h"
57 #define VT_MAXWINDOWS MAXCONS
59 #define VT_MAXWINDOWS 12
63 #ifndef VT_ALT_TO_ESC_HACK
64 #define VT_ALT_TO_ESC_HACK 1
67 #define VT_CONSWINDOW 0
69 #if defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE)
70 #define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON3DOWN /* right button */
71 #define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON2DOWN /* not really used */
73 #define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON2DOWN /* middle button */
74 #define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON3DOWN /* right button */
75 #endif /* defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) */
77 #define SC_DRIVER_NAME "vt"
79 #define DPRINTF(_l, ...) if (vt_debug > (_l)) printf( __VA_ARGS__ )
80 #define VT_CONSOLECTL_DEBUG
81 #define VT_SYSMOUSE_DEBUG
83 #define DPRINTF(_l, ...) do {} while (0)
85 #define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG)
87 #define VT_SYSCTL_INT(_name, _default, _descr) \
88 int vt_##_name = (_default); \
89 SYSCTL_INT(_kern_vt, OID_AUTO, _name, CTLFLAG_RWTUN, &vt_##_name, 0, _descr)
93 void vt_allocate(const struct vt_driver *, void *);
94 void vt_deallocate(const struct vt_driver *, void *);
96 typedef unsigned int vt_axis_t;
100 * (d) locked by vd_lock
101 * (b) locked by vb_lock
102 * (G) locked by Giant
103 * (u) unlocked, locked by higher levels
104 * (c) const until freeing
105 * (?) yet to be determined
109 * Per-device datastructure.
112 #ifndef SC_NO_CUTPASTE
113 struct vt_mouse_cursor;
117 term_char_t *vpb_buf; /* Copy-paste buffer. */
118 unsigned int vpb_bufsz; /* Buffer size. */
119 unsigned int vpb_len; /* Length of a last selection. */
123 struct vt_window *vd_windows[VT_MAXWINDOWS]; /* (c) Windows. */
124 struct vt_window *vd_curwindow; /* (d) Current window. */
125 struct vt_window *vd_savedwindow;/* (?) Saved for suspend. */
126 struct vt_window *vd_grabwindow; /* (?) Saved before cngrab. */
127 struct vt_pastebuf vd_pastebuf; /* (?) Copy/paste buf. */
128 const struct vt_driver *vd_driver; /* (c) Graphics driver. */
129 void *vd_softc; /* (u) Driver data. */
130 const struct vt_driver *vd_prev_driver;/* (?) Previous driver. */
131 void *vd_prev_softc; /* (?) Previous driver data. */
132 device_t vd_video_dev; /* (?) Video adapter. */
133 #ifndef SC_NO_CUTPASTE
134 struct vt_mouse_cursor *vd_mcursor; /* (?) Cursor bitmap. */
135 term_color_t vd_mcursor_fg; /* (?) Cursor fg color. */
136 term_color_t vd_mcursor_bg; /* (?) Cursor bg color. */
137 vt_axis_t vd_mx_drawn; /* (?) Mouse X and Y */
138 vt_axis_t vd_my_drawn; /* as of last redraw. */
139 int vd_mshown; /* (?) Mouse shown during */
140 #endif /* last redrawn. */
141 uint16_t vd_mx; /* (?) Current mouse X. */
142 uint16_t vd_my; /* (?) current mouse Y. */
143 uint32_t vd_mstate; /* (?) Mouse state. */
144 vt_axis_t vd_width; /* (?) Screen width. */
145 vt_axis_t vd_height; /* (?) Screen height. */
146 size_t vd_transpose; /* (?) Screen offset in FB */
147 struct mtx vd_lock; /* Per-device lock. */
148 struct cv vd_winswitch; /* (d) Window switch notify. */
149 struct callout vd_timer; /* (d) Display timer. */
150 volatile unsigned int vd_timer_armed;/* (?) Display timer started.*/
151 int vd_flags; /* (d) Device flags. */
152 #define VDF_TEXTMODE 0x01 /* Do text mode rendering. */
153 #define VDF_SPLASH 0x02 /* Splash screen active. */
154 #define VDF_ASYNC 0x04 /* vt_timer() running. */
155 #define VDF_INVALID 0x08 /* Entire screen should be re-rendered. */
156 #define VDF_DEAD 0x10 /* Early probing found nothing. */
157 #define VDF_INITIALIZED 0x20 /* vtterm_cnprobe already done. */
158 #define VDF_MOUSECURSOR 0x40 /* Mouse cursor visible. */
159 #define VDF_QUIET_BELL 0x80 /* Disable bell. */
160 #define VDF_SUSPENDED 0x100 /* Device has been suspended. */
161 #define VDF_DOWNGRADE 0x8000 /* The driver is being downgraded. */
162 struct keyboard *vd_keyboard; /* (G) Keyboard. */
163 unsigned int vd_kbstate; /* (?) Device unit. */
164 unsigned int vd_unit; /* (c) Device unit. */
165 int vd_altbrk; /* (?) Alt break seq. state */
166 term_char_t *vd_drawn; /* (?) Most recent char drawn. */
167 term_color_t *vd_drawnfg; /* (?) Most recent fg color drawn. */
168 term_color_t *vd_drawnbg; /* (?) Most recent bg color drawn. */
171 #define VD_PASTEBUF(vd) ((vd)->vd_pastebuf.vpb_buf)
172 #define VD_PASTEBUFSZ(vd) ((vd)->vd_pastebuf.vpb_bufsz)
173 #define VD_PASTEBUFLEN(vd) ((vd)->vd_pastebuf.vpb_len)
175 #define VT_LOCK(vd) mtx_lock(&(vd)->vd_lock)
176 #define VT_UNLOCK(vd) mtx_unlock(&(vd)->vd_lock)
177 #define VT_LOCK_ASSERT(vd, what) mtx_assert(&(vd)->vd_lock, what)
179 void vt_resume(struct vt_device *vd);
180 void vt_resume_flush_timer(struct vt_window *vw, int ms);
181 void vt_suspend(struct vt_device *vd);
184 * Per-window terminal screen buffer.
186 * Because redrawing is performed asynchronously, the buffer keeps track
187 * of a rectangle that needs to be redrawn (vb_dirtyrect). Because this
188 * approach seemed to cause suboptimal performance (when the top left
189 * and the bottom right of the screen are modified), it also uses a set
190 * of bitmasks to keep track of the rows and columns (mod 64) that have
195 struct mtx vb_lock; /* Buffer lock. */
196 struct terminal *vb_terminal;
197 term_pos_t vb_scr_size; /* (b) Screen dimensions. */
198 int vb_flags; /* (b) Flags. */
199 #define VBF_CURSOR 0x1 /* Cursor visible. */
200 #define VBF_STATIC 0x2 /* Buffer is statically allocated. */
201 #define VBF_MTX_INIT 0x4 /* Mutex initialized. */
202 #define VBF_SCROLL 0x8 /* scroll locked mode. */
203 #define VBF_HISTORY_FULL 0x10 /* All rows filled. */
204 unsigned int vb_history_size;
205 unsigned int vb_roffset; /* (b) History rows offset. */
206 unsigned int vb_curroffset; /* (b) Saved rows offset. */
207 term_pos_t vb_cursor; /* (u) Cursor position. */
208 term_pos_t vb_mark_start; /* (b) Copy region start. */
209 term_pos_t vb_mark_end; /* (b) Copy region end. */
210 int vb_mark_last; /* Last mouse event. */
211 term_rect_t vb_dirtyrect; /* (b) Dirty rectangle. */
212 term_char_t *vb_buffer; /* (u) Data buffer. */
213 term_char_t **vb_rows; /* (u) Array of rows */
216 #ifdef SC_HISTORY_SIZE
217 #define VBF_DEFAULT_HISTORY_SIZE SC_HISTORY_SIZE
219 #define VBF_DEFAULT_HISTORY_SIZE 500
222 void vtbuf_lock(struct vt_buf *);
223 void vtbuf_unlock(struct vt_buf *);
224 void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *);
225 void vtbuf_fill(struct vt_buf *, const term_rect_t *, term_char_t);
226 void vtbuf_init_early(struct vt_buf *);
227 void vtbuf_init(struct vt_buf *, const term_pos_t *);
228 void vtbuf_grow(struct vt_buf *, const term_pos_t *, unsigned int);
229 void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t);
230 void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *);
231 void vtbuf_scroll_mode(struct vt_buf *vb, int yes);
232 void vtbuf_dirty(struct vt_buf *vb, const term_rect_t *area);
233 void vtbuf_undirty(struct vt_buf *, term_rect_t *);
234 void vtbuf_sethistory_size(struct vt_buf *, unsigned int);
235 void vtbuf_clearhistory(struct vt_buf *);
236 int vtbuf_iscursor(const struct vt_buf *vb, int row, int col);
237 void vtbuf_cursor_visibility(struct vt_buf *, int);
238 #ifndef SC_NO_CUTPASTE
239 int vtbuf_set_mark(struct vt_buf *vb, int type, int col, int row);
240 int vtbuf_get_marked_len(struct vt_buf *vb);
241 void vtbuf_extract_marked(struct vt_buf *vb, term_char_t *buf, int sz);
244 #define VTB_MARK_NONE 0
245 #define VTB_MARK_END 1
246 #define VTB_MARK_START 2
247 #define VTB_MARK_WORD 3
248 #define VTB_MARK_ROW 4
249 #define VTB_MARK_EXTEND 5
250 #define VTB_MARK_MOVE 6
252 #define VTBUF_SLCK_ENABLE(vb) vtbuf_scroll_mode((vb), 1)
253 #define VTBUF_SLCK_DISABLE(vb) vtbuf_scroll_mode((vb), 0)
255 #define VTBUF_MAX_HEIGHT(vb) \
256 ((vb)->vb_history_size)
257 #define VTBUF_GET_ROW(vb, r) \
258 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)])
259 #define VTBUF_GET_FIELD(vb, r, c) \
260 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
261 #define VTBUF_FIELD(vb, r, c) \
262 ((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
263 #define VTBUF_ISCURSOR(vb, r, c) \
264 vtbuf_iscursor((vb), (r), (c))
265 #define VTBUF_DIRTYROW(mask, row) \
266 ((mask)->vbm_row & ((uint64_t)1 << ((row) % 64)))
267 #define VTBUF_DIRTYCOL(mask, col) \
268 ((mask)->vbm_col & ((uint64_t)1 << ((col) % 64)))
269 #define VTBUF_SPACE_CHAR(attr) (' ' | (attr))
274 int vthistory_seek(struct vt_buf *, int offset, int whence);
275 void vthistory_addlines(struct vt_buf *vb, int offset);
276 void vthistory_getpos(const struct vt_buf *, unsigned int *offset);
279 * Per-window datastructure.
283 struct vt_device *vw_device; /* (c) Device. */
284 struct terminal *vw_terminal; /* (c) Terminal. */
285 struct vt_buf vw_buf; /* (u) Screen buffer. */
286 struct vt_font *vw_font; /* (d) Graphical font. */
287 term_rect_t vw_draw_area; /* (?) Drawable area. */
288 unsigned int vw_number; /* (c) Window number. */
289 int vw_kbdmode; /* (?) Keyboard mode. */
290 int vw_prev_kbdmode;/* (?) Previous mode. */
291 int vw_kbdstate; /* (?) Keyboard state. */
292 int vw_grabbed; /* (?) Grab count. */
293 char *vw_kbdsq; /* Escape sequence queue*/
294 unsigned int vw_flags; /* (d) Per-window flags. */
295 int vw_mouse_level;/* Mouse op mode. */
296 #define VWF_BUSY 0x1 /* Busy reconfiguring device. */
297 #define VWF_OPENED 0x2 /* TTY in use. */
298 #define VWF_SCROLL 0x4 /* Keys influence scrollback. */
299 #define VWF_CONSOLE 0x8 /* Kernel message console window. */
300 #define VWF_VTYLOCK 0x10 /* Prevent window switch. */
301 #define VWF_MOUSE_HIDE 0x20 /* Disable mouse events processing. */
302 #define VWF_READY 0x40 /* Window fully initialized. */
303 #define VWF_GRAPHICS 0x80 /* Window in graphics mode (KDSETMODE). */
304 #define VWF_SWWAIT_REL 0x10000 /* Program wait for VT acquire is done. */
305 #define VWF_SWWAIT_ACQ 0x20000 /* Program wait for VT release is done. */
306 pid_t vw_pid; /* Terminal holding process */
307 struct proc *vw_proc;
308 struct vt_mode vw_smode; /* switch mode */
309 struct callout vw_proc_dead_timer;
310 struct vt_window *vw_switch_to;
311 int vw_bell_pitch; /* (?) Bell pitch */
312 sbintime_t vw_bell_duration; /* (?) Bell duration */
315 #define VT_AUTO 0 /* switching is automatic */
316 #define VT_PROCESS 1 /* switching controlled by prog */
317 #define VT_KERNEL 255 /* switching controlled in kernel */
319 #define IS_VT_PROC_MODE(vw) ((vw)->vw_smode.mode == VT_PROCESS)
322 * Per-device driver routines.
325 typedef int vd_init_t(struct vt_device *vd);
326 typedef int vd_probe_t(struct vt_device *vd);
327 typedef void vd_fini_t(struct vt_device *vd, void *softc);
328 typedef void vd_postswitch_t(struct vt_device *vd);
329 typedef void vd_blank_t(struct vt_device *vd, term_color_t color);
330 typedef void vd_bitblt_text_t(struct vt_device *vd, const struct vt_window *vw,
331 const term_rect_t *area);
332 typedef void vd_invalidate_text_t(struct vt_device *vd,
333 const term_rect_t *area);
334 typedef void vd_bitblt_bmp_t(struct vt_device *vd, const struct vt_window *vw,
335 const uint8_t *pattern, const uint8_t *mask,
336 unsigned int width, unsigned int height,
337 unsigned int x, unsigned int y, term_color_t fg, term_color_t bg);
338 typedef int vd_fb_ioctl_t(struct vt_device *, u_long, caddr_t, struct thread *);
339 typedef int vd_fb_mmap_t(struct vt_device *, vm_ooffset_t, vm_paddr_t *, int,
341 typedef void vd_drawrect_t(struct vt_device *, int, int, int, int, int,
343 typedef void vd_setpixel_t(struct vt_device *, int, int, term_color_t);
344 typedef void vd_suspend_t(struct vt_device *);
345 typedef void vd_resume_t(struct vt_device *);
349 /* Console attachment. */
350 vd_probe_t *vd_probe;
355 vd_blank_t *vd_blank;
356 vd_drawrect_t *vd_drawrect;
357 vd_setpixel_t *vd_setpixel;
358 vd_bitblt_text_t *vd_bitblt_text;
359 vd_invalidate_text_t *vd_invalidate_text;
360 vd_bitblt_bmp_t *vd_bitblt_bmp;
362 /* Framebuffer ioctls, if present. */
363 vd_fb_ioctl_t *vd_fb_ioctl;
365 /* Framebuffer mmap, if present. */
366 vd_fb_mmap_t *vd_fb_mmap;
368 /* Update display setting on vt switch. */
369 vd_postswitch_t *vd_postswitch;
371 /* Suspend/resume handlers. */
372 vd_suspend_t *vd_suspend;
373 vd_resume_t *vd_resume;
375 /* Priority to know which one can override */
377 #define VD_PRIORITY_DUMB 10
378 #define VD_PRIORITY_GENERIC 100
379 #define VD_PRIORITY_SPECIFIC 1000
383 * Console device madness.
385 * Utility macro to make early vt(4) instances work.
388 extern struct vt_device vt_consdev;
389 extern struct terminal vt_consterm;
390 extern const struct terminal_class vt_termclass;
391 void vt_upgrade(struct vt_device *vd);
393 #define PIXEL_WIDTH(w) ((w) / 8)
394 #define PIXEL_HEIGHT(h) ((h) / 16)
396 #ifndef VT_FB_MAX_WIDTH
397 #define VT_FB_MAX_WIDTH 4096
399 #ifndef VT_FB_MAX_HEIGHT
400 #define VT_FB_MAX_HEIGHT 2400
403 /* name argument is not used yet. */
404 #define VT_DRIVER_DECLARE(name, drv) DATA_SET(vt_drv_set, drv)
406 #ifndef SC_NO_CUTPASTE
407 struct vt_mouse_cursor {
408 uint8_t map[64 * 64 / 8];
409 uint8_t mask[64 * 64 / 8];
415 const uint8_t *vtfont_lookup(const struct vt_font *vf, term_char_t c);
416 struct vt_font *vtfont_ref(struct vt_font *vf);
417 void vtfont_unref(struct vt_font *vf);
418 int vtfont_load(vfnt_t *f, struct vt_font **ret);
421 void sysmouse_process_event(mouse_info_t *mi);
422 #ifndef SC_NO_CUTPASTE
423 void vt_mouse_event(int type, int x, int y, int event, int cnt, int mlevel);
424 void vt_mouse_state(int show);
426 #define VT_MOUSE_SHOW 1
427 #define VT_MOUSE_HIDE 0
430 void vt_compute_drawable_area(struct vt_window *);
431 void vt_determine_colors(term_char_t c, int cursor,
432 term_color_t *fg, term_color_t *bg);
433 int vt_is_cursor_in_area(const struct vt_device *vd,
434 const term_rect_t *area);
435 void vt_termsize(struct vt_device *, struct vt_font *, term_pos_t *);
436 void vt_winsize(struct vt_device *, struct vt_font *, struct winsize *);
439 #define VT_LOGOS_DRAW_BEASTIE 0
440 #define VT_LOGOS_DRAW_ALT_BEASTIE 1
441 #define VT_LOGOS_DRAW_ORB 2
443 extern int vt_draw_logo_cpus;
444 extern int vt_splash_cpu;
445 extern int vt_splash_ncpu;
446 extern int vt_splash_cpu_style;
447 extern int vt_splash_cpu_duration;
449 extern const unsigned int vt_logo_sprite_height;
450 extern const unsigned int vt_logo_sprite_width;
452 void vtterm_draw_cpu_logos(struct vt_device *);
454 #endif /* !_DEV_VT_VT_H_ */