vt.h revision 267985
1105197Ssam/*- 2105197Ssam * Copyright (c) 2009, 2013 The FreeBSD Foundation 3105197Ssam * All rights reserved. 4139823Simp * 5105197Ssam * This software was developed by Ed Schouten under sponsorship from the 6105197Ssam * FreeBSD Foundation. 7105197Ssam * 8105197Ssam * Portions of this software were developed by Oleksandr Rybalko 9105197Ssam * under sponsorship from the FreeBSD Foundation. 10105197Ssam * 11105197Ssam * Redistribution and use in source and binary forms, with or without 12105197Ssam * modification, are permitted provided that the following conditions 13105197Ssam * are met: 14105197Ssam * 1. Redistributions of source code must retain the above copyright 15105197Ssam * notice, this list of conditions and the following disclaimer. 16105197Ssam * 2. Redistributions in binary form must reproduce the above copyright 17105197Ssam * notice, this list of conditions and the following disclaimer in the 18105197Ssam * documentation and/or other materials provided with the distribution. 19105197Ssam * 20105197Ssam * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 21105197Ssam * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22105197Ssam * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23105197Ssam * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 24105197Ssam * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25105197Ssam * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26105197Ssam * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27105197Ssam * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28105197Ssam * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29105197Ssam * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30105197Ssam * SUCH DAMAGE. 31105197Ssam * 32105197Ssam * $FreeBSD: head/sys/dev/vt/vt.h 267985 2014-06-27 22:05:21Z gjb $ 33105197Ssam */ 34105197Ssam 35105197Ssam#ifndef _DEV_VT_VT_H_ 36105197Ssam#define _DEV_VT_VT_H_ 37105197Ssam 38105197Ssam#include <sys/param.h> 39105197Ssam#include <sys/_lock.h> 40105197Ssam#include <sys/_mutex.h> 41105197Ssam#include <sys/callout.h> 42105197Ssam#include <sys/condvar.h> 43105197Ssam#include <sys/conf.h> 44195699Srwatson#include <sys/consio.h> 45207369Sbz#include <sys/kbio.h> 46207369Sbz#include <sys/mouse.h> 47207369Sbz#include <sys/terminal.h> 48207369Sbz#include <sys/sysctl.h> 49207369Sbz 50207369Sbz#include "opt_syscons.h" 51195727Srwatson#include "opt_splash.h" 52195727Srwatson 53195727Srwatson#ifndef VT_MAXWINDOWS 54195727Srwatson#ifdef MAXCONS 55195727Srwatson#define VT_MAXWINDOWS MAXCONS 56195727Srwatson#else 57105197Ssam#define VT_MAXWINDOWS 12 58105197Ssam#endif 59105197Ssam#endif 60105197Ssam 61105197Ssam#ifndef VT_ALT_TO_ESC_HACK 62105197Ssam#define VT_ALT_TO_ESC_HACK 1 63105197Ssam#endif 64105197Ssam 65105197Ssam#define VT_CONSWINDOW 0 66105197Ssam 67105197Ssam#if defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) 68105197Ssam#define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON3DOWN /* right button */ 69105197Ssam#define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON2DOWN /* not really used */ 70105197Ssam#else 71105197Ssam#define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON2DOWN /* middle button */ 72105197Ssam#define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON3DOWN /* right button */ 73105197Ssam#endif /* defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) */ 74105197Ssam 75105197Ssam#define SC_DRIVER_NAME "vt" 76105197Ssam#ifdef VT_DEBUG 77105197Ssam#define DPRINTF(_l, ...) if (vt_debug > (_l)) printf( __VA_ARGS__ ) 78105197Ssam#define VT_CONSOLECTL_DEBUG 79#define VT_SYSMOUSE_DEBUG 80#else 81#define DPRINTF(_l, ...) do {} while (0) 82#endif 83#define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG) 84 85#define VT_SYSCTL_INT(_name, _default, _descr) \ 86static int vt_##_name = _default; \ 87SYSCTL_INT(_kern_vt, OID_AUTO, _name, CTLFLAG_RW, &vt_##_name, _default,\ 88 _descr); \ 89TUNABLE_INT("kern.vt." #_name, &vt_##_name); 90 91struct vt_driver; 92 93void vt_allocate(struct vt_driver *, void *); 94void vt_resume(void); 95void vt_suspend(void); 96 97typedef unsigned int vt_axis_t; 98 99/* 100 * List of locks 101 * (d) locked by vd_lock 102 * (b) locked by vb_lock 103 * (G) locked by Giant 104 * (u) unlocked, locked by higher levels 105 * (c) const until freeing 106 * (?) yet to be determined 107 */ 108 109/* 110 * Per-device datastructure. 111 */ 112 113struct vt_device { 114 struct vt_window *vd_windows[VT_MAXWINDOWS]; /* (c) Windows. */ 115 struct vt_window *vd_curwindow; /* (d) Current window. */ 116 struct vt_window *vd_savedwindow;/* (?) Saved for suspend. */ 117 struct vt_window *vd_markedwin; /* (?) Copy/paste buf owner. */ 118 const struct vt_driver *vd_driver; /* (c) Graphics driver. */ 119 void *vd_softc; /* (u) Driver data. */ 120 uint16_t vd_mx; /* (?) Mouse X. */ 121 uint16_t vd_my; /* (?) Mouse Y. */ 122 vt_axis_t vd_mdirtyx; /* (?) Screen width. */ 123 vt_axis_t vd_mdirtyy; /* (?) Screen height. */ 124 uint32_t vd_mstate; /* (?) Mouse state. */ 125 term_pos_t vd_offset; /* (?) Pixel offset. */ 126 vt_axis_t vd_width; /* (?) Screen width. */ 127 vt_axis_t vd_height; /* (?) Screen height. */ 128 struct mtx vd_lock; /* Per-device lock. */ 129 struct cv vd_winswitch; /* (d) Window switch notify. */ 130 struct callout vd_timer; /* (d) Display timer. */ 131 int vd_flags; /* (d) Device flags. */ 132#define VDF_TEXTMODE 0x01 /* Do text mode rendering. */ 133#define VDF_SPLASH 0x02 /* Splash screen active. */ 134#define VDF_ASYNC 0x04 /* vt_timer() running. */ 135#define VDF_INVALID 0x08 /* Entire screen should be re-rendered. */ 136#define VDF_DEAD 0x10 /* Early probing found nothing. */ 137#define VDF_INITIALIZED 0x20 /* vtterm_cnprobe already done. */ 138#define VDF_MOUSECURSOR 0x40 /* Mouse cursor visible. */ 139#define VDF_QUIET_BELL 0x80 /* Disable bell. */ 140 int vd_keyboard; /* (G) Keyboard index. */ 141 unsigned int vd_kbstate; /* (?) Device unit. */ 142 unsigned int vd_unit; /* (c) Device unit. */ 143}; 144 145/* 146 * Per-window terminal screen buffer. 147 * 148 * Because redrawing is performed asynchronously, the buffer keeps track 149 * of a rectangle that needs to be redrawn (vb_dirtyrect). Because this 150 * approach seemed to cause suboptimal performance (when the top left 151 * and the bottom right of the screen are modified), it also uses a set 152 * of bitmasks to keep track of the rows and columns (mod 64) that have 153 * been modified. 154 */ 155 156struct vt_bufmask { 157 uint64_t vbm_row, vbm_col; 158#define VBM_DIRTY UINT64_MAX 159}; 160 161struct vt_buf { 162 struct mtx vb_lock; /* Buffer lock. */ 163 term_pos_t vb_scr_size; /* (b) Screen dimensions. */ 164 int vb_flags; /* (b) Flags. */ 165#define VBF_CURSOR 0x1 /* Cursor visible. */ 166#define VBF_STATIC 0x2 /* Buffer is statically allocated. */ 167#define VBF_MTX_INIT 0x4 /* Mutex initialized. */ 168#define VBF_SCROLL 0x8 /* scroll locked mode. */ 169#define VBF_HISTORY_FULL 0x10 /* All rows filled. */ 170 int vb_history_size; 171#define VBF_DEFAULT_HISTORY_SIZE 500 172 int vb_roffset; /* (b) History rows offset. */ 173 int vb_curroffset; /* (b) Saved rows offset. */ 174 term_pos_t vb_cursor; /* (u) Cursor position. */ 175 term_pos_t vb_mark_start; /* (b) Copy region start. */ 176 term_pos_t vb_mark_end; /* (b) Copy region end. */ 177 int vb_mark_last; /* Last mouse event. */ 178 term_rect_t vb_dirtyrect; /* (b) Dirty rectangle. */ 179 struct vt_bufmask vb_dirtymask; /* (b) Dirty bitmasks. */ 180 term_char_t *vb_buffer; /* (u) Data buffer. */ 181 term_char_t **vb_rows; /* (u) Array of rows */ 182}; 183 184void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *); 185void vtbuf_fill_locked(struct vt_buf *, const term_rect_t *, term_char_t); 186void vtbuf_init_early(struct vt_buf *); 187void vtbuf_init(struct vt_buf *, const term_pos_t *); 188void vtbuf_grow(struct vt_buf *, const term_pos_t *, int); 189void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t); 190void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *); 191void vtbuf_scroll_mode(struct vt_buf *vb, int yes); 192void vtbuf_undirty(struct vt_buf *, term_rect_t *, struct vt_bufmask *); 193void vtbuf_sethistory_size(struct vt_buf *, int); 194int vtbuf_iscursor(struct vt_buf *vb, int row, int col); 195void vtbuf_cursor_visibility(struct vt_buf *, int); 196#ifndef SC_NO_CUTPASTE 197void vtbuf_mouse_cursor_position(struct vt_buf *vb, int col, int row); 198int vtbuf_set_mark(struct vt_buf *vb, int type, int col, int row); 199int vtbuf_get_marked_len(struct vt_buf *vb); 200void vtbuf_extract_marked(struct vt_buf *vb, term_char_t *buf, int sz); 201#endif 202 203#define VTB_MARK_NONE 0 204#define VTB_MARK_END 1 205#define VTB_MARK_START 2 206#define VTB_MARK_WORD 3 207#define VTB_MARK_ROW 4 208#define VTB_MARK_EXTEND 5 209#define VTB_MARK_MOVE 6 210 211#define VTBUF_SLCK_ENABLE(vb) vtbuf_scroll_mode((vb), 1) 212#define VTBUF_SLCK_DISABLE(vb) vtbuf_scroll_mode((vb), 0) 213 214#define VTBUF_MAX_HEIGHT(vb) \ 215 ((vb)->vb_history_size) 216#define VTBUF_GET_ROW(vb, r) \ 217 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)]) 218#define VTBUF_GET_FIELD(vb, r, c) \ 219 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 220#define VTBUF_FIELD(vb, r, c) \ 221 ((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 222#define VTBUF_ISCURSOR(vb, r, c) \ 223 vtbuf_iscursor((vb), (r), (c)) 224#define VTBUF_DIRTYROW(mask, row) \ 225 ((mask)->vbm_row & ((uint64_t)1 << ((row) % 64))) 226#define VTBUF_DIRTYCOL(mask, col) \ 227 ((mask)->vbm_col & ((uint64_t)1 << ((col) % 64))) 228#define VTBUF_SPACE_CHAR(attr) (' ' | (attr)) 229 230#define VHS_SET 0 231#define VHS_CUR 1 232#define VHS_END 2 233int vthistory_seek(struct vt_buf *, int offset, int whence); 234void vthistory_addlines(struct vt_buf *vb, int offset); 235void vthistory_getpos(const struct vt_buf *, unsigned int *offset); 236 237/* 238 * Per-window datastructure. 239 */ 240 241struct vt_window { 242 struct vt_device *vw_device; /* (c) Device. */ 243 struct terminal *vw_terminal; /* (c) Terminal. */ 244 struct vt_buf vw_buf; /* (u) Screen buffer. */ 245 struct vt_font *vw_font; /* (d) Graphical font. */ 246 unsigned int vw_number; /* (c) Window number. */ 247 int vw_kbdmode; /* (?) Keyboard mode. */ 248 char *vw_kbdsq; /* Escape sequence queue*/ 249 unsigned int vw_flags; /* (d) Per-window flags. */ 250 int vw_mouse_level;/* Mouse op mode. */ 251#define VWF_BUSY 0x1 /* Busy reconfiguring device. */ 252#define VWF_OPENED 0x2 /* TTY in use. */ 253#define VWF_SCROLL 0x4 /* Keys influence scrollback. */ 254#define VWF_CONSOLE 0x8 /* Kernel message console window. */ 255#define VWF_VTYLOCK 0x10 /* Prevent window switch. */ 256#define VWF_MOUSE_HIDE 0x20 /* Disable mouse events processing. */ 257#define VWF_READY 0x40 /* Window fully initialized. */ 258#define VWF_SWWAIT_REL 0x10000 /* Program wait for VT acquire is done. */ 259#define VWF_SWWAIT_ACQ 0x20000 /* Program wait for VT release is done. */ 260 pid_t vw_pid; /* Terminal holding process */ 261 struct proc *vw_proc; 262 struct vt_mode vw_smode; /* switch mode */ 263 struct callout vw_proc_dead_timer; 264 struct vt_window *vw_switch_to; 265}; 266 267#define VT_AUTO 0 /* switching is automatic */ 268#define VT_PROCESS 1 /* switching controlled by prog */ 269#define VT_KERNEL 255 /* switching controlled in kernel */ 270 271#define IS_VT_PROC_MODE(vw) ((vw)->vw_smode.mode == VT_PROCESS) 272 273/* 274 * Per-device driver routines. 275 * 276 * vd_bitbltchr is used when the driver operates in graphics mode, while 277 * vd_putchar is used when the driver operates in text mode 278 * (VDF_TEXTMODE). 279 */ 280 281typedef int vd_init_t(struct vt_device *vd); 282typedef int vd_probe_t(struct vt_device *vd); 283typedef void vd_postswitch_t(struct vt_device *vd); 284typedef void vd_blank_t(struct vt_device *vd, term_color_t color); 285typedef void vd_bitbltchr_t(struct vt_device *vd, const uint8_t *src, 286 const uint8_t *mask, int bpl, vt_axis_t top, vt_axis_t left, 287 unsigned int width, unsigned int height, term_color_t fg, term_color_t bg); 288typedef void vd_maskbitbltchr_t(struct vt_device *vd, const uint8_t *src, 289 const uint8_t *mask, int bpl, vt_axis_t top, vt_axis_t left, 290 unsigned int width, unsigned int height, term_color_t fg, term_color_t bg); 291typedef void vd_putchar_t(struct vt_device *vd, term_char_t, 292 vt_axis_t top, vt_axis_t left, term_color_t fg, term_color_t bg); 293typedef int vd_fb_ioctl_t(struct vt_device *, u_long, caddr_t, struct thread *); 294typedef int vd_fb_mmap_t(struct vt_device *, vm_ooffset_t, vm_paddr_t *, int, 295 vm_memattr_t *); 296typedef void vd_drawrect_t(struct vt_device *, int, int, int, int, int, 297 term_color_t); 298typedef void vd_setpixel_t(struct vt_device *, int, int, term_color_t); 299 300struct vt_driver { 301 char vd_name[16]; 302 /* Console attachment. */ 303 vd_probe_t *vd_probe; 304 vd_init_t *vd_init; 305 306 /* Drawing. */ 307 vd_blank_t *vd_blank; 308 vd_bitbltchr_t *vd_bitbltchr; 309 vd_maskbitbltchr_t *vd_maskbitbltchr; 310 vd_drawrect_t *vd_drawrect; 311 vd_setpixel_t *vd_setpixel; 312 313 /* Framebuffer ioctls, if present. */ 314 vd_fb_ioctl_t *vd_fb_ioctl; 315 316 /* Framebuffer mmap, if present. */ 317 vd_fb_mmap_t *vd_fb_mmap; 318 319 /* Text mode operation. */ 320 vd_putchar_t *vd_putchar; 321 322 /* Update display setting on vt switch. */ 323 vd_postswitch_t *vd_postswitch; 324 325 /* Priority to know which one can override */ 326 int vd_priority; 327#define VD_PRIORITY_DUMB 10 328#define VD_PRIORITY_GENERIC 100 329#define VD_PRIORITY_SPECIFIC 1000 330}; 331 332/* 333 * Console device madness. 334 * 335 * Utility macro to make early vt(4) instances work. 336 */ 337 338extern const struct terminal_class vt_termclass; 339void vt_upgrade(struct vt_device *vd); 340 341#define PIXEL_WIDTH(w) ((w) / 8) 342#define PIXEL_HEIGHT(h) ((h) / 16) 343 344#ifndef VT_FB_DEFAULT_WIDTH 345#define VT_FB_DEFAULT_WIDTH 2048 346#endif 347#ifndef VT_FB_DEFAULT_HEIGHT 348#define VT_FB_DEFAULT_HEIGHT 1200 349#endif 350 351#define VT_CONSDEV_DECLARE(driver, width, height, softc) \ 352static struct terminal driver ## _consterm; \ 353static struct vt_window driver ## _conswindow; \ 354static struct vt_device driver ## _consdev = { \ 355 .vd_driver = &driver, \ 356 .vd_softc = (softc), \ 357 .vd_flags = VDF_INVALID, \ 358 .vd_windows = { [VT_CONSWINDOW] = &driver ## _conswindow, }, \ 359 .vd_curwindow = &driver ## _conswindow, \ 360 .vd_markedwin = NULL, \ 361 .vd_kbstate = 0, \ 362}; \ 363static term_char_t driver ## _constextbuf[(width) * \ 364 (VBF_DEFAULT_HISTORY_SIZE)]; \ 365static term_char_t *driver ## _constextbufrows[ \ 366 VBF_DEFAULT_HISTORY_SIZE]; \ 367static struct vt_window driver ## _conswindow = { \ 368 .vw_number = VT_CONSWINDOW, \ 369 .vw_flags = VWF_CONSOLE, \ 370 .vw_buf = { \ 371 .vb_buffer = driver ## _constextbuf, \ 372 .vb_rows = driver ## _constextbufrows, \ 373 .vb_history_size = VBF_DEFAULT_HISTORY_SIZE, \ 374 .vb_curroffset = 0, \ 375 .vb_roffset = 0, \ 376 .vb_flags = VBF_STATIC, \ 377 .vb_mark_start = { \ 378 .tp_row = 0, \ 379 .tp_col = 0, \ 380 }, \ 381 .vb_mark_end = { \ 382 .tp_row = 0, \ 383 .tp_col = 0, \ 384 }, \ 385 .vb_scr_size = { \ 386 .tp_row = height, \ 387 .tp_col = width, \ 388 }, \ 389 }, \ 390 .vw_device = &driver ## _consdev, \ 391 .vw_terminal = &driver ## _consterm, \ 392 .vw_kbdmode = K_XLATE, \ 393}; \ 394TERMINAL_DECLARE_EARLY(driver ## _consterm, vt_termclass, \ 395 &driver ## _conswindow); \ 396SYSINIT(vt_early_cons, SI_SUB_INT_CONFIG_HOOKS, SI_ORDER_ANY, \ 397 vt_upgrade, &driver ## _consdev) 398 399/* name argument is not used yet. */ 400#define VT_DRIVER_DECLARE(name, drv) DATA_SET(vt_drv_set, drv) 401 402/* 403 * Fonts. 404 * 405 * Remapping tables are used to map Unicode points to glyphs. They need 406 * to be sorted, because vtfont_lookup() performs a binary search. Each 407 * font has two remapping tables, for normal and bold. When a character 408 * is not present in bold, it uses a normal glyph. When no glyph is 409 * available, it uses glyph 0, which is normally equal to U+FFFD. 410 */ 411 412struct vt_font_map { 413 uint32_t vfm_src; 414 uint16_t vfm_dst; 415 uint16_t vfm_len; 416}; 417 418struct vt_font { 419 struct vt_font_map *vf_map[VFNT_MAPS]; 420 uint8_t *vf_bytes; 421 unsigned int vf_height, vf_width; 422 unsigned int vf_map_count[VFNT_MAPS]; 423 unsigned int vf_refcount; 424}; 425 426#ifndef SC_NO_CUTPASTE 427struct mouse_cursor { 428 uint8_t map[64 * 64 / 8]; 429 uint8_t mask[64 * 64 / 8]; 430 uint8_t w; 431 uint8_t h; 432}; 433#endif 434 435const uint8_t *vtfont_lookup(const struct vt_font *vf, term_char_t c); 436struct vt_font *vtfont_ref(struct vt_font *vf); 437void vtfont_unref(struct vt_font *vf); 438int vtfont_load(vfnt_t *f, struct vt_font **ret); 439 440/* Sysmouse. */ 441void sysmouse_process_event(mouse_info_t *mi); 442#ifndef SC_NO_CUTPASTE 443void vt_mouse_event(int type, int x, int y, int event, int cnt, int mlevel); 444void vt_mouse_state(int show); 445#endif 446#define VT_MOUSE_SHOW 1 447#define VT_MOUSE_HIDE 0 448 449#endif /* !_DEV_VT_VT_H_ */ 450 451