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