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 #ifndef _DEV_VT_VT_H_ 35 #define _DEV_VT_VT_H_ 36 37 #include <sys/param.h> 38 #include <sys/_lock.h> 39 #include <sys/_mutex.h> 40 #include <sys/callout.h> 41 #include <sys/condvar.h> 42 #include <sys/conf.h> 43 #include <sys/consio.h> 44 #include <sys/kbio.h> 45 #include <sys/mouse.h> 46 #include <sys/terminal.h> 47 #include <sys/sysctl.h> 48 #include <sys/font.h> 49 #include <sys/taskqueue.h> 50 51 #include "opt_syscons.h" 52 #include "opt_splash.h" 53 54 #ifndef VT_MAXWINDOWS 55 #ifdef MAXCONS 56 #define VT_MAXWINDOWS MAXCONS 57 #else 58 #define VT_MAXWINDOWS 12 59 #endif 60 #endif 61 62 #ifndef VT_ALT_TO_ESC_HACK 63 #define VT_ALT_TO_ESC_HACK 1 64 #endif 65 66 #define VT_CONSWINDOW 0 67 68 #if defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) 69 #define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON3DOWN /* right button */ 70 #define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON2DOWN /* not really used */ 71 #else 72 #define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON2DOWN /* middle button */ 73 #define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON3DOWN /* right button */ 74 #endif /* defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) */ 75 76 #define SC_DRIVER_NAME "vt" 77 #ifdef VT_DEBUG 78 #define DPRINTF(_l, ...) if (vt_debug > (_l)) printf( __VA_ARGS__ ) 79 #define VT_CONSOLECTL_DEBUG 80 #define VT_SYSMOUSE_DEBUG 81 #else 82 #define DPRINTF(_l, ...) do {} while (0) 83 #endif 84 #define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG) 85 86 #define VT_SYSCTL_INT(_name, _default, _descr) \ 87 int vt_##_name = (_default); \ 88 SYSCTL_INT(_kern_vt, OID_AUTO, _name, CTLFLAG_RWTUN, &vt_##_name, 0, _descr) 89 90 struct vt_driver; 91 92 int vt_allocate(const struct vt_driver *, void *); 93 int vt_deallocate(const struct vt_driver *, void *); 94 95 typedef unsigned int vt_axis_t; 96 97 /* 98 * List of locks 99 * (d) locked by vd_lock 100 * (b) locked by vb_lock 101 * (G) locked by Giant 102 * (u) unlocked, locked by higher levels 103 * (c) const until freeing 104 * (?) yet to be determined 105 */ 106 107 /* 108 * Per-device datastructure. 109 */ 110 111 #ifndef SC_NO_CUTPASTE 112 struct vt_mouse_cursor; 113 #endif 114 115 struct vt_pastebuf { 116 term_char_t *vpb_buf; /* Copy-paste buffer. */ 117 unsigned int vpb_bufsz; /* Buffer size. */ 118 unsigned int vpb_len; /* Length of a last selection. */ 119 }; 120 121 struct vt_device { 122 struct vt_window *vd_windows[VT_MAXWINDOWS]; /* (c) Windows. */ 123 struct vt_window *vd_curwindow; /* (d) Current window. */ 124 struct vt_window *vd_savedwindow;/* (?) Saved for suspend. */ 125 struct vt_window *vd_grabwindow; /* (?) Saved before cngrab. */ 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 struct keyboard *vd_keyboard; /* (G) Keyboard. */ 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 struct terminal *vb_terminal; 196 term_pos_t vb_scr_size; /* (b) Screen dimensions. */ 197 int vb_flags; /* (b) Flags. */ 198 #define VBF_CURSOR 0x1 /* Cursor visible. */ 199 #define VBF_STATIC 0x2 /* Buffer is statically allocated. */ 200 #define VBF_MTX_INIT 0x4 /* Mutex initialized. */ 201 #define VBF_SCROLL 0x8 /* scroll locked mode. */ 202 #define VBF_HISTORY_FULL 0x10 /* All rows filled. */ 203 unsigned int vb_history_size; 204 unsigned int vb_roffset; /* (b) History rows offset. */ 205 unsigned int vb_curroffset; /* (b) Saved rows offset. */ 206 term_pos_t vb_cursor; /* (u) Cursor position. */ 207 term_pos_t vb_mark_start; /* (b) Copy region start. */ 208 term_pos_t vb_mark_end; /* (b) Copy region end. */ 209 int vb_mark_last; /* Last mouse event. */ 210 term_rect_t vb_dirtyrect; /* (b) Dirty rectangle. */ 211 term_char_t *vb_buffer; /* (u) Data buffer. */ 212 term_char_t **vb_rows; /* (u) Array of rows */ 213 }; 214 215 #ifdef SC_HISTORY_SIZE 216 #define VBF_DEFAULT_HISTORY_SIZE SC_HISTORY_SIZE 217 #else 218 #define VBF_DEFAULT_HISTORY_SIZE 500 219 #endif 220 221 void vtbuf_lock(struct vt_buf *); 222 void vtbuf_unlock(struct vt_buf *); 223 void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *); 224 void vtbuf_fill(struct vt_buf *, const term_rect_t *, term_char_t); 225 void vtbuf_init_early(struct vt_buf *); 226 void vtbuf_init(struct vt_buf *, const term_pos_t *); 227 void vtbuf_grow(struct vt_buf *, const term_pos_t *, unsigned int); 228 void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t); 229 void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *); 230 void vtbuf_scroll_mode(struct vt_buf *vb, int yes); 231 void vtbuf_dirty(struct vt_buf *vb, const term_rect_t *area); 232 void vtbuf_undirty(struct vt_buf *, term_rect_t *); 233 void vtbuf_sethistory_size(struct vt_buf *, unsigned int); 234 void vtbuf_clearhistory(struct vt_buf *); 235 int vtbuf_iscursor(const struct vt_buf *vb, int row, int col); 236 void vtbuf_cursor_visibility(struct vt_buf *, int); 237 #ifndef SC_NO_CUTPASTE 238 int vtbuf_set_mark(struct vt_buf *vb, int type, int col, int row); 239 int vtbuf_get_marked_len(struct vt_buf *vb); 240 void vtbuf_extract_marked(struct vt_buf *vb, term_char_t *buf, int sz, int mark); 241 #endif 242 243 #define VTB_MARK_NONE 0 244 #define VTB_MARK_END 1 245 #define VTB_MARK_START 2 246 #define VTB_MARK_WORD 3 247 #define VTB_MARK_ROW 4 248 #define VTB_MARK_EXTEND 5 249 #define VTB_MARK_MOVE 6 250 251 #define VTBUF_SLCK_ENABLE(vb) vtbuf_scroll_mode((vb), 1) 252 #define VTBUF_SLCK_DISABLE(vb) vtbuf_scroll_mode((vb), 0) 253 254 #define VTBUF_MAX_HEIGHT(vb) \ 255 ((vb)->vb_history_size) 256 #define VTBUF_GET_ROW(vb, r) \ 257 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)]) 258 #define VTBUF_GET_FIELD(vb, r, c) \ 259 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 260 #define VTBUF_FIELD(vb, r, c) \ 261 ((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 262 #define VTBUF_ISCURSOR(vb, r, c) \ 263 vtbuf_iscursor((vb), (r), (c)) 264 #define VTBUF_DIRTYROW(mask, row) \ 265 ((mask)->vbm_row & ((uint64_t)1 << ((row) % 64))) 266 #define VTBUF_DIRTYCOL(mask, col) \ 267 ((mask)->vbm_col & ((uint64_t)1 << ((col) % 64))) 268 #define VTBUF_SPACE_CHAR(attr) (' ' | (attr)) 269 270 #define VHS_SET 0 271 #define VHS_CUR 1 272 #define VHS_END 2 273 int vthistory_seek(struct vt_buf *, int offset, int whence); 274 void vthistory_addlines(struct vt_buf *vb, int offset); 275 void vthistory_getpos(const struct vt_buf *, unsigned int *offset); 276 277 /* 278 * Per-window datastructure. 279 */ 280 281 struct vt_window { 282 struct vt_device *vw_device; /* (c) Device. */ 283 struct terminal *vw_terminal; /* (c) Terminal. */ 284 struct vt_buf vw_buf; /* (u) Screen buffer. */ 285 struct vt_font *vw_font; /* (d) Graphical font. */ 286 term_rect_t vw_draw_area; /* (?) Drawable area. */ 287 unsigned int vw_number; /* (c) Window number. */ 288 int vw_kbdmode; /* (?) Keyboard mode. */ 289 int vw_prev_kbdmode;/* (?) Previous mode. */ 290 int vw_kbdstate; /* (?) Keyboard state. */ 291 int vw_grabbed; /* (?) Grab count. */ 292 char *vw_kbdsq; /* Escape sequence queue*/ 293 unsigned int vw_flags; /* (d) Per-window flags. */ 294 int vw_mouse_level;/* Mouse op mode. */ 295 #define VWF_BUSY 0x1 /* Busy reconfiguring device. */ 296 #define VWF_OPENED 0x2 /* TTY in use. */ 297 #define VWF_SCROLL 0x4 /* Keys influence scrollback. */ 298 #define VWF_CONSOLE 0x8 /* Kernel message console window. */ 299 #define VWF_VTYLOCK 0x10 /* Prevent window switch. */ 300 #define VWF_MOUSE_HIDE 0x20 /* Disable mouse events processing. */ 301 #define VWF_READY 0x40 /* Window fully initialized. */ 302 #define VWF_GRAPHICS 0x80 /* Window in graphics mode (KDSETMODE). */ 303 #define VWF_SWWAIT_REL 0x10000 /* Program wait for VT acquire is done. */ 304 #define VWF_SWWAIT_ACQ 0x20000 /* Program wait for VT release is done. */ 305 pid_t vw_pid; /* Terminal holding process */ 306 struct proc *vw_proc; 307 struct vt_mode vw_smode; /* switch mode */ 308 struct timeout_task vw_timeout_task_dead; 309 struct vt_window *vw_switch_to; 310 int vw_bell_pitch; /* (?) Bell pitch */ 311 sbintime_t vw_bell_duration; /* (?) Bell duration */ 312 }; 313 314 #define VT_AUTO 0 /* switching is automatic */ 315 #define VT_PROCESS 1 /* switching controlled by prog */ 316 #define VT_KERNEL 255 /* switching controlled in kernel */ 317 318 #define IS_VT_PROC_MODE(vw) ((vw)->vw_smode.mode == VT_PROCESS) 319 320 /* 321 * Per-device driver routines. 322 */ 323 324 typedef int vd_init_t(struct vt_device *vd); 325 typedef int vd_probe_t(struct vt_device *vd); 326 typedef void vd_fini_t(struct vt_device *vd, void *softc); 327 typedef void vd_postswitch_t(struct vt_device *vd); 328 typedef void vd_blank_t(struct vt_device *vd, term_color_t color); 329 typedef void vd_bitblt_text_t(struct vt_device *vd, const struct vt_window *vw, 330 const term_rect_t *area); 331 typedef void vd_invalidate_text_t(struct vt_device *vd, 332 const term_rect_t *area); 333 typedef void vd_bitblt_bmp_t(struct vt_device *vd, const struct vt_window *vw, 334 const uint8_t *pattern, const uint8_t *mask, 335 unsigned int width, unsigned int height, 336 unsigned int x, unsigned int y, term_color_t fg, term_color_t bg); 337 typedef int vd_fb_ioctl_t(struct vt_device *, u_long, caddr_t, struct thread *); 338 typedef int vd_fb_mmap_t(struct vt_device *, vm_ooffset_t, vm_paddr_t *, int, 339 vm_memattr_t *); 340 typedef void vd_drawrect_t(struct vt_device *, int, int, int, int, int, 341 term_color_t); 342 typedef void vd_setpixel_t(struct vt_device *, int, int, term_color_t); 343 typedef void vd_suspend_t(struct vt_device *); 344 typedef void vd_resume_t(struct vt_device *); 345 346 struct vt_driver { 347 char vd_name[16]; 348 /* Console attachment. */ 349 vd_probe_t *vd_probe; 350 vd_init_t *vd_init; 351 vd_fini_t *vd_fini; 352 353 /* Drawing. */ 354 vd_blank_t *vd_blank; 355 vd_drawrect_t *vd_drawrect; 356 vd_setpixel_t *vd_setpixel; 357 vd_bitblt_text_t *vd_bitblt_text; 358 vd_invalidate_text_t *vd_invalidate_text; 359 vd_bitblt_bmp_t *vd_bitblt_bmp; 360 361 /* Framebuffer ioctls, if present. */ 362 vd_fb_ioctl_t *vd_fb_ioctl; 363 364 /* Framebuffer mmap, if present. */ 365 vd_fb_mmap_t *vd_fb_mmap; 366 367 /* Update display setting on vt switch. */ 368 vd_postswitch_t *vd_postswitch; 369 370 /* Suspend/resume handlers. */ 371 vd_suspend_t *vd_suspend; 372 vd_resume_t *vd_resume; 373 374 /* Priority to know which one can override */ 375 int vd_priority; 376 #define VD_PRIORITY_DUMB 10 377 #define VD_PRIORITY_GENERIC 100 378 #define VD_PRIORITY_SPECIFIC 1000 379 }; 380 381 /* 382 * Console device madness. 383 * 384 * Utility macro to make early vt(4) instances work. 385 */ 386 387 extern struct vt_device vt_consdev; 388 void vt_upgrade(struct vt_device *vd); 389 390 #define PIXEL_WIDTH(w) ((w) / 8) 391 #define PIXEL_HEIGHT(h) ((h) / 16) 392 393 #ifndef VT_FB_MAX_WIDTH 394 #define VT_FB_MAX_WIDTH 4096 395 #endif 396 #ifndef VT_FB_MAX_HEIGHT 397 #define VT_FB_MAX_HEIGHT 2400 398 #endif 399 400 /* name argument is not used yet. */ 401 #define VT_DRIVER_DECLARE(name, drv) DATA_SET(vt_drv_set, drv) 402 403 #ifndef SC_NO_CUTPASTE 404 struct vt_mouse_cursor { 405 uint8_t map[64 * 64 / 8]; 406 uint8_t mask[64 * 64 / 8]; 407 uint8_t width; 408 uint8_t height; 409 }; 410 #endif 411 412 const uint8_t *vtfont_lookup(const struct vt_font *vf, term_char_t c); 413 struct vt_font *vtfont_ref(struct vt_font *vf); 414 void vtfont_unref(struct vt_font *vf); 415 int vtfont_load(vfnt_t *f, struct vt_font **ret); 416 417 /* Sysmouse. */ 418 void sysmouse_process_event(mouse_info_t *mi); 419 #ifndef SC_NO_CUTPASTE 420 void vt_mouse_event(int type, int x, int y, int event, int cnt, int mlevel); 421 void vt_mouse_state(int show); 422 #endif 423 #define VT_MOUSE_SHOW 1 424 #define VT_MOUSE_HIDE 0 425 426 /* Utilities. */ 427 void vt_compute_drawable_area(struct vt_window *); 428 void vt_determine_colors(term_char_t c, int cursor, 429 term_color_t *fg, term_color_t *bg); 430 int vt_is_cursor_in_area(const struct vt_device *vd, 431 const term_rect_t *area); 432 void vt_termsize(struct vt_device *, struct vt_font *, term_pos_t *); 433 void vt_winsize(struct vt_device *, struct vt_font *, struct winsize *); 434 435 /* Logos-on-boot. */ 436 #define VT_LOGOS_DRAW_BEASTIE 0 437 #define VT_LOGOS_DRAW_ALT_BEASTIE 1 438 #define VT_LOGOS_DRAW_ORB 2 439 440 extern int vt_draw_logo_cpus; 441 extern int vt_splash_cpu; 442 extern int vt_splash_ncpu; 443 extern int vt_splash_cpu_style; 444 extern int vt_splash_cpu_duration; 445 446 extern const unsigned int vt_logo_sprite_height; 447 extern const unsigned int vt_logo_sprite_width; 448 449 void vtterm_draw_cpu_logos(struct vt_device *); 450 451 #endif /* !_DEV_VT_VT_H_ */ 452