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$ 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) \ 88 int vt_##_name = (_default); \ 89 SYSCTL_INT(_kern_vt, OID_AUTO, _name, CTLFLAG_RWTUN, &vt_##_name, 0, _descr) 90 91 struct vt_driver; 92 93 void vt_allocate(const struct vt_driver *, void *); 94 void vt_deallocate(const struct vt_driver *, void *); 95 96 typedef 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 113 struct vt_mouse_cursor; 114 #endif 115 116 struct 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 122 struct 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_SUSPENDED 0x100 /* Device has been suspended. */ 160 #define VDF_DOWNGRADE 0x8000 /* The driver is being downgraded. */ 161 int vd_keyboard; /* (G) Keyboard index. */ 162 unsigned int vd_kbstate; /* (?) Device unit. */ 163 unsigned int vd_unit; /* (c) Device unit. */ 164 int vd_altbrk; /* (?) Alt break seq. state */ 165 term_char_t *vd_drawn; /* (?) Most recent char drawn. */ 166 term_color_t *vd_drawnfg; /* (?) Most recent fg color drawn. */ 167 term_color_t *vd_drawnbg; /* (?) Most recent bg color drawn. */ 168 }; 169 170 #define VD_PASTEBUF(vd) ((vd)->vd_pastebuf.vpb_buf) 171 #define VD_PASTEBUFSZ(vd) ((vd)->vd_pastebuf.vpb_bufsz) 172 #define VD_PASTEBUFLEN(vd) ((vd)->vd_pastebuf.vpb_len) 173 174 #define VT_LOCK(vd) mtx_lock(&(vd)->vd_lock) 175 #define VT_UNLOCK(vd) mtx_unlock(&(vd)->vd_lock) 176 #define VT_LOCK_ASSERT(vd, what) mtx_assert(&(vd)->vd_lock, what) 177 178 void vt_resume(struct vt_device *vd); 179 void vt_resume_flush_timer(struct vt_window *vw, int ms); 180 void vt_suspend(struct vt_device *vd); 181 182 /* 183 * Per-window terminal screen buffer. 184 * 185 * Because redrawing is performed asynchronously, the buffer keeps track 186 * of a rectangle that needs to be redrawn (vb_dirtyrect). Because this 187 * approach seemed to cause suboptimal performance (when the top left 188 * and the bottom right of the screen are modified), it also uses a set 189 * of bitmasks to keep track of the rows and columns (mod 64) that have 190 * been modified. 191 */ 192 193 struct vt_buf { 194 struct mtx vb_lock; /* Buffer lock. */ 195 term_pos_t vb_scr_size; /* (b) Screen dimensions. */ 196 int vb_flags; /* (b) Flags. */ 197 #define VBF_CURSOR 0x1 /* Cursor visible. */ 198 #define VBF_STATIC 0x2 /* Buffer is statically allocated. */ 199 #define VBF_MTX_INIT 0x4 /* Mutex initialized. */ 200 #define VBF_SCROLL 0x8 /* scroll locked mode. */ 201 #define VBF_HISTORY_FULL 0x10 /* All rows filled. */ 202 unsigned int vb_history_size; 203 unsigned int vb_roffset; /* (b) History rows offset. */ 204 unsigned int vb_curroffset; /* (b) Saved rows offset. */ 205 term_pos_t vb_cursor; /* (u) Cursor position. */ 206 term_pos_t vb_mark_start; /* (b) Copy region start. */ 207 term_pos_t vb_mark_end; /* (b) Copy region end. */ 208 int vb_mark_last; /* Last mouse event. */ 209 term_rect_t vb_dirtyrect; /* (b) Dirty rectangle. */ 210 term_char_t *vb_buffer; /* (u) Data buffer. */ 211 term_char_t **vb_rows; /* (u) Array of rows */ 212 }; 213 214 #ifdef SC_HISTORY_SIZE 215 #define VBF_DEFAULT_HISTORY_SIZE SC_HISTORY_SIZE 216 #else 217 #define VBF_DEFAULT_HISTORY_SIZE 500 218 #endif 219 220 void vtbuf_lock(struct vt_buf *); 221 void vtbuf_unlock(struct vt_buf *); 222 void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *); 223 void vtbuf_fill(struct vt_buf *, const term_rect_t *, term_char_t); 224 void vtbuf_init_early(struct vt_buf *); 225 void vtbuf_init(struct vt_buf *, const term_pos_t *); 226 void vtbuf_grow(struct vt_buf *, const term_pos_t *, unsigned int); 227 void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t); 228 void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *); 229 void vtbuf_scroll_mode(struct vt_buf *vb, int yes); 230 void vtbuf_dirty(struct vt_buf *vb, const term_rect_t *area); 231 void vtbuf_undirty(struct vt_buf *, term_rect_t *); 232 void vtbuf_sethistory_size(struct vt_buf *, unsigned int); 233 int vtbuf_iscursor(const struct vt_buf *vb, int row, int col); 234 void vtbuf_cursor_visibility(struct vt_buf *, int); 235 #ifndef SC_NO_CUTPASTE 236 int vtbuf_set_mark(struct vt_buf *vb, int type, int col, int row); 237 int vtbuf_get_marked_len(struct vt_buf *vb); 238 void vtbuf_extract_marked(struct vt_buf *vb, term_char_t *buf, int sz); 239 #endif 240 241 #define VTB_MARK_NONE 0 242 #define VTB_MARK_END 1 243 #define VTB_MARK_START 2 244 #define VTB_MARK_WORD 3 245 #define VTB_MARK_ROW 4 246 #define VTB_MARK_EXTEND 5 247 #define VTB_MARK_MOVE 6 248 249 #define VTBUF_SLCK_ENABLE(vb) vtbuf_scroll_mode((vb), 1) 250 #define VTBUF_SLCK_DISABLE(vb) vtbuf_scroll_mode((vb), 0) 251 252 #define VTBUF_MAX_HEIGHT(vb) \ 253 ((vb)->vb_history_size) 254 #define VTBUF_GET_ROW(vb, r) \ 255 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)]) 256 #define VTBUF_GET_FIELD(vb, r, c) \ 257 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 258 #define VTBUF_FIELD(vb, r, c) \ 259 ((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 260 #define VTBUF_ISCURSOR(vb, r, c) \ 261 vtbuf_iscursor((vb), (r), (c)) 262 #define VTBUF_DIRTYROW(mask, row) \ 263 ((mask)->vbm_row & ((uint64_t)1 << ((row) % 64))) 264 #define VTBUF_DIRTYCOL(mask, col) \ 265 ((mask)->vbm_col & ((uint64_t)1 << ((col) % 64))) 266 #define VTBUF_SPACE_CHAR(attr) (' ' | (attr)) 267 268 #define VHS_SET 0 269 #define VHS_CUR 1 270 #define VHS_END 2 271 int vthistory_seek(struct vt_buf *, int offset, int whence); 272 void vthistory_addlines(struct vt_buf *vb, int offset); 273 void vthistory_getpos(const struct vt_buf *, unsigned int *offset); 274 275 /* 276 * Per-window datastructure. 277 */ 278 279 struct vt_window { 280 struct vt_device *vw_device; /* (c) Device. */ 281 struct terminal *vw_terminal; /* (c) Terminal. */ 282 struct vt_buf vw_buf; /* (u) Screen buffer. */ 283 struct vt_font *vw_font; /* (d) Graphical font. */ 284 term_rect_t vw_draw_area; /* (?) Drawable area. */ 285 unsigned int vw_number; /* (c) Window number. */ 286 int vw_kbdmode; /* (?) Keyboard mode. */ 287 int vw_prev_kbdmode;/* (?) Previous mode. */ 288 int vw_kbdstate; /* (?) Keyboard state. */ 289 int vw_grabbed; /* (?) Grab count. */ 290 char *vw_kbdsq; /* Escape sequence queue*/ 291 unsigned int vw_flags; /* (d) Per-window flags. */ 292 int vw_mouse_level;/* Mouse op mode. */ 293 #define VWF_BUSY 0x1 /* Busy reconfiguring device. */ 294 #define VWF_OPENED 0x2 /* TTY in use. */ 295 #define VWF_SCROLL 0x4 /* Keys influence scrollback. */ 296 #define VWF_CONSOLE 0x8 /* Kernel message console window. */ 297 #define VWF_VTYLOCK 0x10 /* Prevent window switch. */ 298 #define VWF_MOUSE_HIDE 0x20 /* Disable mouse events processing. */ 299 #define VWF_READY 0x40 /* Window fully initialized. */ 300 #define VWF_GRAPHICS 0x80 /* Window in graphics mode (KDSETMODE). */ 301 #define VWF_SWWAIT_REL 0x10000 /* Program wait for VT acquire is done. */ 302 #define VWF_SWWAIT_ACQ 0x20000 /* Program wait for VT release is done. */ 303 pid_t vw_pid; /* Terminal holding process */ 304 struct proc *vw_proc; 305 struct vt_mode vw_smode; /* switch mode */ 306 struct callout vw_proc_dead_timer; 307 struct vt_window *vw_switch_to; 308 }; 309 310 #define VT_AUTO 0 /* switching is automatic */ 311 #define VT_PROCESS 1 /* switching controlled by prog */ 312 #define VT_KERNEL 255 /* switching controlled in kernel */ 313 314 #define IS_VT_PROC_MODE(vw) ((vw)->vw_smode.mode == VT_PROCESS) 315 316 /* 317 * Per-device driver routines. 318 */ 319 320 typedef int vd_init_t(struct vt_device *vd); 321 typedef int vd_probe_t(struct vt_device *vd); 322 typedef void vd_fini_t(struct vt_device *vd, void *softc); 323 typedef void vd_postswitch_t(struct vt_device *vd); 324 typedef void vd_blank_t(struct vt_device *vd, term_color_t color); 325 typedef void vd_bitblt_text_t(struct vt_device *vd, const struct vt_window *vw, 326 const term_rect_t *area); 327 typedef void vd_invalidate_text_t(struct vt_device *vd, 328 const term_rect_t *area); 329 typedef void vd_bitblt_bmp_t(struct vt_device *vd, const struct vt_window *vw, 330 const uint8_t *pattern, const uint8_t *mask, 331 unsigned int width, unsigned int height, 332 unsigned int x, unsigned int y, term_color_t fg, term_color_t bg); 333 typedef int vd_fb_ioctl_t(struct vt_device *, u_long, caddr_t, struct thread *); 334 typedef int vd_fb_mmap_t(struct vt_device *, vm_ooffset_t, vm_paddr_t *, int, 335 vm_memattr_t *); 336 typedef void vd_drawrect_t(struct vt_device *, int, int, int, int, int, 337 term_color_t); 338 typedef void vd_setpixel_t(struct vt_device *, int, int, term_color_t); 339 typedef void vd_suspend_t(struct vt_device *); 340 typedef void vd_resume_t(struct vt_device *); 341 342 struct vt_driver { 343 char vd_name[16]; 344 /* Console attachment. */ 345 vd_probe_t *vd_probe; 346 vd_init_t *vd_init; 347 vd_fini_t *vd_fini; 348 349 /* Drawing. */ 350 vd_blank_t *vd_blank; 351 vd_drawrect_t *vd_drawrect; 352 vd_setpixel_t *vd_setpixel; 353 vd_bitblt_text_t *vd_bitblt_text; 354 vd_invalidate_text_t *vd_invalidate_text; 355 vd_bitblt_bmp_t *vd_bitblt_bmp; 356 357 /* Framebuffer ioctls, if present. */ 358 vd_fb_ioctl_t *vd_fb_ioctl; 359 360 /* Framebuffer mmap, if present. */ 361 vd_fb_mmap_t *vd_fb_mmap; 362 363 /* Update display setting on vt switch. */ 364 vd_postswitch_t *vd_postswitch; 365 366 /* Suspend/resume handlers. */ 367 vd_suspend_t *vd_suspend; 368 vd_resume_t *vd_resume; 369 370 /* Priority to know which one can override */ 371 int vd_priority; 372 #define VD_PRIORITY_DUMB 10 373 #define VD_PRIORITY_GENERIC 100 374 #define VD_PRIORITY_SPECIFIC 1000 375 }; 376 377 /* 378 * Console device madness. 379 * 380 * Utility macro to make early vt(4) instances work. 381 */ 382 383 extern struct vt_device vt_consdev; 384 extern struct terminal vt_consterm; 385 extern const struct terminal_class vt_termclass; 386 void vt_upgrade(struct vt_device *vd); 387 388 #define PIXEL_WIDTH(w) ((w) / 8) 389 #define PIXEL_HEIGHT(h) ((h) / 16) 390 391 #ifndef VT_FB_MAX_WIDTH 392 #define VT_FB_MAX_WIDTH 4096 393 #endif 394 #ifndef VT_FB_MAX_HEIGHT 395 #define VT_FB_MAX_HEIGHT 2400 396 #endif 397 398 /* name argument is not used yet. */ 399 #define VT_DRIVER_DECLARE(name, drv) DATA_SET(vt_drv_set, drv) 400 401 /* 402 * Fonts. 403 * 404 * Remapping tables are used to map Unicode points to glyphs. They need 405 * to be sorted, because vtfont_lookup() performs a binary search. Each 406 * font has two remapping tables, for normal and bold. When a character 407 * is not present in bold, it uses a normal glyph. When no glyph is 408 * available, it uses glyph 0, which is normally equal to U+FFFD. 409 */ 410 411 struct vt_font_map { 412 uint32_t vfm_src; 413 uint16_t vfm_dst; 414 uint16_t vfm_len; 415 }; 416 417 struct vt_font { 418 struct vt_font_map *vf_map[VFNT_MAPS]; 419 uint8_t *vf_bytes; 420 unsigned int vf_height, vf_width; 421 unsigned int vf_map_count[VFNT_MAPS]; 422 unsigned int vf_refcount; 423 }; 424 425 #ifndef SC_NO_CUTPASTE 426 struct vt_mouse_cursor { 427 uint8_t map[64 * 64 / 8]; 428 uint8_t mask[64 * 64 / 8]; 429 uint8_t width; 430 uint8_t height; 431 }; 432 #endif 433 434 const uint8_t *vtfont_lookup(const struct vt_font *vf, term_char_t c); 435 struct vt_font *vtfont_ref(struct vt_font *vf); 436 void vtfont_unref(struct vt_font *vf); 437 int vtfont_load(vfnt_t *f, struct vt_font **ret); 438 439 /* Sysmouse. */ 440 void sysmouse_process_event(mouse_info_t *mi); 441 #ifndef SC_NO_CUTPASTE 442 void vt_mouse_event(int type, int x, int y, int event, int cnt, int mlevel); 443 void vt_mouse_state(int show); 444 #endif 445 #define VT_MOUSE_SHOW 1 446 #define VT_MOUSE_HIDE 0 447 448 /* Utilities. */ 449 void vt_compute_drawable_area(struct vt_window *); 450 void vt_determine_colors(term_char_t c, int cursor, 451 term_color_t *fg, term_color_t *bg); 452 int vt_is_cursor_in_area(const struct vt_device *vd, 453 const term_rect_t *area); 454 void vt_termsize(struct vt_device *, struct vt_font *, term_pos_t *); 455 void vt_winsize(struct vt_device *, struct vt_font *, struct winsize *); 456 457 /* Logos-on-boot. */ 458 #define VT_LOGOS_DRAW_BEASTIE 0 459 #define VT_LOGOS_DRAW_ALT_BEASTIE 1 460 #define VT_LOGOS_DRAW_ORB 2 461 462 extern int vt_draw_logo_cpus; 463 extern int vt_splash_cpu; 464 extern int vt_splash_ncpu; 465 extern int vt_splash_cpu_style; 466 extern int vt_splash_cpu_duration; 467 468 extern const unsigned int vt_logo_sprite_height; 469 extern const unsigned int vt_logo_sprite_width; 470 471 void vtterm_draw_cpu_logos(struct vt_device *); 472 473 #endif /* !_DEV_VT_VT_H_ */ 474 475