vt.h revision 330897
1/*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2009, 2013 The FreeBSD Foundation 5 * All rights reserved. 6 * 7 * This software was developed by Ed Schouten under sponsorship from the 8 * FreeBSD Foundation. 9 * 10 * Portions of this software were developed by Oleksandr Rybalko 11 * under sponsorship from the FreeBSD Foundation. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 1. Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * $FreeBSD: stable/11/sys/dev/vt/vt.h 330897 2018-03-14 03:19:51Z eadler $ 35 */ 36 37#ifndef _DEV_VT_VT_H_ 38#define _DEV_VT_VT_H_ 39 40#include <sys/param.h> 41#include <sys/_lock.h> 42#include <sys/_mutex.h> 43#include <sys/callout.h> 44#include <sys/condvar.h> 45#include <sys/conf.h> 46#include <sys/consio.h> 47#include <sys/kbio.h> 48#include <sys/mouse.h> 49#include <sys/terminal.h> 50#include <sys/sysctl.h> 51 52#include "opt_syscons.h" 53#include "opt_splash.h" 54 55#ifndef VT_MAXWINDOWS 56#ifdef MAXCONS 57#define VT_MAXWINDOWS MAXCONS 58#else 59#define VT_MAXWINDOWS 12 60#endif 61#endif 62 63#ifndef VT_ALT_TO_ESC_HACK 64#define VT_ALT_TO_ESC_HACK 1 65#endif 66 67#define VT_CONSWINDOW 0 68 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 */ 72#else 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) */ 76 77#define SC_DRIVER_NAME "vt" 78#ifdef VT_DEBUG 79#define DPRINTF(_l, ...) if (vt_debug > (_l)) printf( __VA_ARGS__ ) 80#define VT_CONSOLECTL_DEBUG 81#define VT_SYSMOUSE_DEBUG 82#else 83#define DPRINTF(_l, ...) do {} while (0) 84#endif 85#define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG) 86 87#define VT_SYSCTL_INT(_name, _default, _descr) \ 88int vt_##_name = (_default); \ 89SYSCTL_INT(_kern_vt, OID_AUTO, _name, CTLFLAG_RWTUN, &vt_##_name, 0, _descr) 90 91struct vt_driver; 92 93void vt_allocate(const struct vt_driver *, void *); 94void vt_deallocate(const struct vt_driver *, void *); 95 96typedef unsigned int vt_axis_t; 97 98/* 99 * List of locks 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 106 */ 107 108/* 109 * Per-device datastructure. 110 */ 111 112#ifndef SC_NO_CUTPASTE 113struct vt_mouse_cursor; 114#endif 115 116struct vt_pastebuf { 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. */ 120}; 121 122struct vt_device { 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_pastebuf vd_pastebuf; /* (?) Copy/paste buf. */ 127 const struct vt_driver *vd_driver; /* (c) Graphics driver. */ 128 void *vd_softc; /* (u) Driver data. */ 129 const struct vt_driver *vd_prev_driver;/* (?) Previous driver. */ 130 void *vd_prev_softc; /* (?) Previous driver data. */ 131 device_t vd_video_dev; /* (?) Video adapter. */ 132#ifndef SC_NO_CUTPASTE 133 struct vt_mouse_cursor *vd_mcursor; /* (?) Cursor bitmap. */ 134 term_color_t vd_mcursor_fg; /* (?) Cursor fg color. */ 135 term_color_t vd_mcursor_bg; /* (?) Cursor bg color. */ 136 vt_axis_t vd_mx_drawn; /* (?) Mouse X and Y */ 137 vt_axis_t vd_my_drawn; /* as of last redraw. */ 138 int vd_mshown; /* (?) Mouse shown during */ 139#endif /* last redrawn. */ 140 uint16_t vd_mx; /* (?) Current mouse X. */ 141 uint16_t vd_my; /* (?) current mouse Y. */ 142 uint32_t vd_mstate; /* (?) Mouse state. */ 143 vt_axis_t vd_width; /* (?) Screen width. */ 144 vt_axis_t vd_height; /* (?) Screen height. */ 145 size_t vd_transpose; /* (?) Screen offset in FB */ 146 struct mtx vd_lock; /* Per-device lock. */ 147 struct cv vd_winswitch; /* (d) Window switch notify. */ 148 struct callout vd_timer; /* (d) Display timer. */ 149 volatile unsigned int vd_timer_armed;/* (?) Display timer started.*/ 150 int vd_flags; /* (d) Device flags. */ 151#define VDF_TEXTMODE 0x01 /* Do text mode rendering. */ 152#define VDF_SPLASH 0x02 /* Splash screen active. */ 153#define VDF_ASYNC 0x04 /* vt_timer() running. */ 154#define VDF_INVALID 0x08 /* Entire screen should be re-rendered. */ 155#define VDF_DEAD 0x10 /* Early probing found nothing. */ 156#define VDF_INITIALIZED 0x20 /* vtterm_cnprobe already done. */ 157#define VDF_MOUSECURSOR 0x40 /* Mouse cursor visible. */ 158#define VDF_QUIET_BELL 0x80 /* Disable bell. */ 159#define VDF_DOWNGRADE 0x8000 /* The driver is being downgraded. */ 160 int vd_keyboard; /* (G) Keyboard index. */ 161 unsigned int vd_kbstate; /* (?) Device unit. */ 162 unsigned int vd_unit; /* (c) Device unit. */ 163 int vd_altbrk; /* (?) Alt break seq. state */ 164}; 165 166#define VD_PASTEBUF(vd) ((vd)->vd_pastebuf.vpb_buf) 167#define VD_PASTEBUFSZ(vd) ((vd)->vd_pastebuf.vpb_bufsz) 168#define VD_PASTEBUFLEN(vd) ((vd)->vd_pastebuf.vpb_len) 169 170#define VT_LOCK(vd) mtx_lock(&(vd)->vd_lock) 171#define VT_UNLOCK(vd) mtx_unlock(&(vd)->vd_lock) 172#define VT_LOCK_ASSERT(vd, what) mtx_assert(&(vd)->vd_lock, what) 173 174void vt_resume(struct vt_device *vd); 175void vt_resume_flush_timer(struct vt_device *vd, int ms); 176void vt_suspend(struct vt_device *vd); 177 178/* 179 * Per-window terminal screen buffer. 180 * 181 * Because redrawing is performed asynchronously, the buffer keeps track 182 * of a rectangle that needs to be redrawn (vb_dirtyrect). Because this 183 * approach seemed to cause suboptimal performance (when the top left 184 * and the bottom right of the screen are modified), it also uses a set 185 * of bitmasks to keep track of the rows and columns (mod 64) that have 186 * been modified. 187 */ 188 189struct vt_buf { 190 struct mtx vb_lock; /* Buffer lock. */ 191 term_pos_t vb_scr_size; /* (b) Screen dimensions. */ 192 int vb_flags; /* (b) Flags. */ 193#define VBF_CURSOR 0x1 /* Cursor visible. */ 194#define VBF_STATIC 0x2 /* Buffer is statically allocated. */ 195#define VBF_MTX_INIT 0x4 /* Mutex initialized. */ 196#define VBF_SCROLL 0x8 /* scroll locked mode. */ 197#define VBF_HISTORY_FULL 0x10 /* All rows filled. */ 198 unsigned int vb_history_size; 199 unsigned int vb_roffset; /* (b) History rows offset. */ 200 unsigned int vb_curroffset; /* (b) Saved rows offset. */ 201 term_pos_t vb_cursor; /* (u) Cursor position. */ 202 term_pos_t vb_mark_start; /* (b) Copy region start. */ 203 term_pos_t vb_mark_end; /* (b) Copy region end. */ 204 int vb_mark_last; /* Last mouse event. */ 205 term_rect_t vb_dirtyrect; /* (b) Dirty rectangle. */ 206 term_char_t *vb_buffer; /* (u) Data buffer. */ 207 term_char_t **vb_rows; /* (u) Array of rows */ 208}; 209 210#ifdef SC_HISTORY_SIZE 211#define VBF_DEFAULT_HISTORY_SIZE SC_HISTORY_SIZE 212#else 213#define VBF_DEFAULT_HISTORY_SIZE 500 214#endif 215 216void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *); 217void vtbuf_fill_locked(struct vt_buf *, const term_rect_t *, term_char_t); 218void vtbuf_init_early(struct vt_buf *); 219void vtbuf_init(struct vt_buf *, const term_pos_t *); 220void vtbuf_grow(struct vt_buf *, const term_pos_t *, unsigned int); 221void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t); 222void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *); 223void vtbuf_scroll_mode(struct vt_buf *vb, int yes); 224void vtbuf_dirty(struct vt_buf *vb, const term_rect_t *area); 225void vtbuf_undirty(struct vt_buf *, term_rect_t *); 226void vtbuf_sethistory_size(struct vt_buf *, unsigned int); 227int vtbuf_iscursor(const struct vt_buf *vb, int row, int col); 228void vtbuf_cursor_visibility(struct vt_buf *, int); 229#ifndef SC_NO_CUTPASTE 230int vtbuf_set_mark(struct vt_buf *vb, int type, int col, int row); 231int vtbuf_get_marked_len(struct vt_buf *vb); 232void vtbuf_extract_marked(struct vt_buf *vb, term_char_t *buf, int sz); 233#endif 234 235#define VTB_MARK_NONE 0 236#define VTB_MARK_END 1 237#define VTB_MARK_START 2 238#define VTB_MARK_WORD 3 239#define VTB_MARK_ROW 4 240#define VTB_MARK_EXTEND 5 241#define VTB_MARK_MOVE 6 242 243#define VTBUF_SLCK_ENABLE(vb) vtbuf_scroll_mode((vb), 1) 244#define VTBUF_SLCK_DISABLE(vb) vtbuf_scroll_mode((vb), 0) 245 246#define VTBUF_MAX_HEIGHT(vb) \ 247 ((vb)->vb_history_size) 248#define VTBUF_GET_ROW(vb, r) \ 249 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)]) 250#define VTBUF_GET_FIELD(vb, r, c) \ 251 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 252#define VTBUF_FIELD(vb, r, c) \ 253 ((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 254#define VTBUF_ISCURSOR(vb, r, c) \ 255 vtbuf_iscursor((vb), (r), (c)) 256#define VTBUF_DIRTYROW(mask, row) \ 257 ((mask)->vbm_row & ((uint64_t)1 << ((row) % 64))) 258#define VTBUF_DIRTYCOL(mask, col) \ 259 ((mask)->vbm_col & ((uint64_t)1 << ((col) % 64))) 260#define VTBUF_SPACE_CHAR(attr) (' ' | (attr)) 261 262#define VHS_SET 0 263#define VHS_CUR 1 264#define VHS_END 2 265int vthistory_seek(struct vt_buf *, int offset, int whence); 266void vthistory_addlines(struct vt_buf *vb, int offset); 267void vthistory_getpos(const struct vt_buf *, unsigned int *offset); 268 269/* 270 * Per-window datastructure. 271 */ 272 273struct vt_window { 274 struct vt_device *vw_device; /* (c) Device. */ 275 struct terminal *vw_terminal; /* (c) Terminal. */ 276 struct vt_buf vw_buf; /* (u) Screen buffer. */ 277 struct vt_font *vw_font; /* (d) Graphical font. */ 278 term_rect_t vw_draw_area; /* (?) Drawable area. */ 279 unsigned int vw_number; /* (c) Window number. */ 280 int vw_kbdmode; /* (?) Keyboard mode. */ 281 int vw_prev_kbdmode;/* (?) Previous mode. */ 282 int vw_kbdstate; /* (?) Keyboard state. */ 283 int vw_grabbed; /* (?) Grab count. */ 284 char *vw_kbdsq; /* Escape sequence queue*/ 285 unsigned int vw_flags; /* (d) Per-window flags. */ 286 int vw_mouse_level;/* Mouse op mode. */ 287#define VWF_BUSY 0x1 /* Busy reconfiguring device. */ 288#define VWF_OPENED 0x2 /* TTY in use. */ 289#define VWF_SCROLL 0x4 /* Keys influence scrollback. */ 290#define VWF_CONSOLE 0x8 /* Kernel message console window. */ 291#define VWF_VTYLOCK 0x10 /* Prevent window switch. */ 292#define VWF_MOUSE_HIDE 0x20 /* Disable mouse events processing. */ 293#define VWF_READY 0x40 /* Window fully initialized. */ 294#define VWF_GRAPHICS 0x80 /* Window in graphics mode (KDSETMODE). */ 295#define VWF_SWWAIT_REL 0x10000 /* Program wait for VT acquire is done. */ 296#define VWF_SWWAIT_ACQ 0x20000 /* Program wait for VT release is done. */ 297 pid_t vw_pid; /* Terminal holding process */ 298 struct proc *vw_proc; 299 struct vt_mode vw_smode; /* switch mode */ 300 struct callout vw_proc_dead_timer; 301 struct vt_window *vw_switch_to; 302}; 303 304#define VT_AUTO 0 /* switching is automatic */ 305#define VT_PROCESS 1 /* switching controlled by prog */ 306#define VT_KERNEL 255 /* switching controlled in kernel */ 307 308#define IS_VT_PROC_MODE(vw) ((vw)->vw_smode.mode == VT_PROCESS) 309 310/* 311 * Per-device driver routines. 312 */ 313 314typedef int vd_init_t(struct vt_device *vd); 315typedef int vd_probe_t(struct vt_device *vd); 316typedef void vd_fini_t(struct vt_device *vd, void *softc); 317typedef void vd_postswitch_t(struct vt_device *vd); 318typedef void vd_blank_t(struct vt_device *vd, term_color_t color); 319typedef void vd_bitblt_text_t(struct vt_device *vd, const struct vt_window *vw, 320 const term_rect_t *area); 321typedef void vd_bitblt_bmp_t(struct vt_device *vd, const struct vt_window *vw, 322 const uint8_t *pattern, const uint8_t *mask, 323 unsigned int width, unsigned int height, 324 unsigned int x, unsigned int y, term_color_t fg, term_color_t bg); 325typedef int vd_fb_ioctl_t(struct vt_device *, u_long, caddr_t, struct thread *); 326typedef int vd_fb_mmap_t(struct vt_device *, vm_ooffset_t, vm_paddr_t *, int, 327 vm_memattr_t *); 328typedef void vd_drawrect_t(struct vt_device *, int, int, int, int, int, 329 term_color_t); 330typedef void vd_setpixel_t(struct vt_device *, int, int, term_color_t); 331typedef void vd_suspend_t(struct vt_device *); 332typedef void vd_resume_t(struct vt_device *); 333 334struct vt_driver { 335 char vd_name[16]; 336 /* Console attachment. */ 337 vd_probe_t *vd_probe; 338 vd_init_t *vd_init; 339 vd_fini_t *vd_fini; 340 341 /* Drawing. */ 342 vd_blank_t *vd_blank; 343 vd_drawrect_t *vd_drawrect; 344 vd_setpixel_t *vd_setpixel; 345 vd_bitblt_text_t *vd_bitblt_text; 346 vd_bitblt_bmp_t *vd_bitblt_bmp; 347 348 /* Framebuffer ioctls, if present. */ 349 vd_fb_ioctl_t *vd_fb_ioctl; 350 351 /* Framebuffer mmap, if present. */ 352 vd_fb_mmap_t *vd_fb_mmap; 353 354 /* Update display setting on vt switch. */ 355 vd_postswitch_t *vd_postswitch; 356 357 /* Suspend/resume handlers. */ 358 vd_suspend_t *vd_suspend; 359 vd_resume_t *vd_resume; 360 361 /* Priority to know which one can override */ 362 int vd_priority; 363#define VD_PRIORITY_DUMB 10 364#define VD_PRIORITY_GENERIC 100 365#define VD_PRIORITY_SPECIFIC 1000 366}; 367 368/* 369 * Console device madness. 370 * 371 * Utility macro to make early vt(4) instances work. 372 */ 373 374extern struct vt_device vt_consdev; 375extern struct terminal vt_consterm; 376extern const struct terminal_class vt_termclass; 377void vt_upgrade(struct vt_device *vd); 378 379#define PIXEL_WIDTH(w) ((w) / 8) 380#define PIXEL_HEIGHT(h) ((h) / 16) 381 382#ifndef VT_FB_MAX_WIDTH 383#define VT_FB_MAX_WIDTH 4096 384#endif 385#ifndef VT_FB_MAX_HEIGHT 386#define VT_FB_MAX_HEIGHT 2400 387#endif 388 389/* name argument is not used yet. */ 390#define VT_DRIVER_DECLARE(name, drv) DATA_SET(vt_drv_set, drv) 391 392/* 393 * Fonts. 394 * 395 * Remapping tables are used to map Unicode points to glyphs. They need 396 * to be sorted, because vtfont_lookup() performs a binary search. Each 397 * font has two remapping tables, for normal and bold. When a character 398 * is not present in bold, it uses a normal glyph. When no glyph is 399 * available, it uses glyph 0, which is normally equal to U+FFFD. 400 */ 401 402struct vt_font_map { 403 uint32_t vfm_src; 404 uint16_t vfm_dst; 405 uint16_t vfm_len; 406}; 407 408struct vt_font { 409 struct vt_font_map *vf_map[VFNT_MAPS]; 410 uint8_t *vf_bytes; 411 unsigned int vf_height, vf_width; 412 unsigned int vf_map_count[VFNT_MAPS]; 413 unsigned int vf_refcount; 414}; 415 416#ifndef SC_NO_CUTPASTE 417struct vt_mouse_cursor { 418 uint8_t map[64 * 64 / 8]; 419 uint8_t mask[64 * 64 / 8]; 420 uint8_t width; 421 uint8_t height; 422}; 423#endif 424 425const uint8_t *vtfont_lookup(const struct vt_font *vf, term_char_t c); 426struct vt_font *vtfont_ref(struct vt_font *vf); 427void vtfont_unref(struct vt_font *vf); 428int vtfont_load(vfnt_t *f, struct vt_font **ret); 429 430/* Sysmouse. */ 431void sysmouse_process_event(mouse_info_t *mi); 432#ifndef SC_NO_CUTPASTE 433void vt_mouse_event(int type, int x, int y, int event, int cnt, int mlevel); 434void vt_mouse_state(int show); 435#endif 436#define VT_MOUSE_SHOW 1 437#define VT_MOUSE_HIDE 0 438 439/* Utilities. */ 440void vt_compute_drawable_area(struct vt_window *); 441void vt_determine_colors(term_char_t c, int cursor, 442 term_color_t *fg, term_color_t *bg); 443int vt_is_cursor_in_area(const struct vt_device *vd, 444 const term_rect_t *area); 445void vt_termsize(struct vt_device *, struct vt_font *, term_pos_t *); 446void vt_winsize(struct vt_device *, struct vt_font *, struct winsize *); 447 448/* Logos-on-boot. */ 449#define VT_LOGOS_DRAW_BEASTIE 0 450#define VT_LOGOS_DRAW_ALT_BEASTIE 1 451#define VT_LOGOS_DRAW_ORB 2 452 453extern int vt_draw_logo_cpus; 454extern int vt_splash_cpu; 455extern int vt_splash_ncpu; 456extern int vt_splash_cpu_style; 457extern int vt_splash_cpu_duration; 458 459extern const unsigned int vt_logo_sprite_height; 460extern const unsigned int vt_logo_sprite_width; 461 462void vtterm_draw_cpu_logos(struct vt_device *); 463 464#endif /* !_DEV_VT_VT_H_ */ 465 466