vt.h revision 267007
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: head/sys/dev/vt/vt.h 267007 2014-06-03 13:33:43Z ray $ 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#ifdef VT_DEBUG 82#define DPRINTF(_l, ...) if (vt_debug > (_l)) printf( __VA_ARGS__ ) 83#define VT_CONSOLECTL_DEBUG 84#define VT_SYSMOUSE_DEBUG 85#else 86#define DPRINTF(_l, ...) do {} while (0) 87#endif 88#define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG) 89 90#define VT_SYSCTL_INT(_name, _default, _descr) \ 91static int vt_##_name = _default; \ 92SYSCTL_INT(_kern_vt, OID_AUTO, _name, CTLFLAG_RW, &vt_##_name, _default,\ 93 _descr); \ 94TUNABLE_INT("kern.vt." #_name, &vt_##_name); 95 96struct vt_driver; 97 98void vt_allocate(struct vt_driver *, void *); 99void vt_resume(void); 100void vt_suspend(void); 101 102typedef unsigned int vt_axis_t; 103 104/* 105 * List of locks 106 * (d) locked by vd_lock 107 * (b) locked by vb_lock 108 * (G) locked by Giant 109 * (u) unlocked, locked by higher levels 110 * (c) const until freeing 111 * (?) yet to be determined 112 */ 113 114/* 115 * Per-device datastructure. 116 */ 117 118struct vt_device { 119 struct vt_window *vd_windows[VT_MAXWINDOWS]; /* (c) Windows. */ 120 struct vt_window *vd_curwindow; /* (d) Current window. */ 121 struct vt_window *vd_savedwindow;/* (?) Saved for suspend. */ 122 struct vt_window *vd_markedwin; /* (?) Copy/paste buf owner. */ 123 const struct vt_driver *vd_driver; /* (c) Graphics driver. */ 124 void *vd_softc; /* (u) Driver data. */ 125 uint16_t vd_mx; /* (?) Mouse X. */ 126 uint16_t vd_my; /* (?) Mouse Y. */ 127 vt_axis_t vd_mdirtyx; /* (?) Screen width. */ 128 vt_axis_t vd_mdirtyy; /* (?) Screen height. */ 129 uint32_t vd_mstate; /* (?) Mouse state. */ 130 term_pos_t vd_offset; /* (?) Pixel offset. */ 131 vt_axis_t vd_width; /* (?) Screen width. */ 132 vt_axis_t vd_height; /* (?) Screen height. */ 133 struct mtx vd_lock; /* Per-device lock. */ 134 struct cv vd_winswitch; /* (d) Window switch notify. */ 135 struct callout vd_timer; /* (d) Display timer. */ 136 int vd_flags; /* (d) Device flags. */ 137#define VDF_TEXTMODE 0x01 /* Do text mode rendering. */ 138#define VDF_SPLASH 0x02 /* Splash screen active. */ 139#define VDF_ASYNC 0x04 /* vt_timer() running. */ 140#define VDF_INVALID 0x08 /* Entire screen should be re-rendered. */ 141#define VDF_DEAD 0x10 /* Early probing found nothing. */ 142#define VDF_INITIALIZED 0x20 /* vtterm_cnprobe already done. */ 143#define VDF_MOUSECURSOR 0x40 /* Mouse cursor visible. */ 144#define VDF_QUIET_BELL 0x80 /* Disable bell. */ 145 int vd_keyboard; /* (G) Keyboard index. */ 146 unsigned int vd_kbstate; /* (?) Device unit. */ 147 unsigned int vd_unit; /* (c) Device unit. */ 148}; 149 150/* 151 * Per-window terminal screen buffer. 152 * 153 * Because redrawing is performed asynchronously, the buffer keeps track 154 * of a rectangle that needs to be redrawn (vb_dirtyrect). Because this 155 * approach seemed to cause suboptimal performance (when the top left 156 * and the bottom right of the screen are modified), it also uses a set 157 * of bitmasks to keep track of the rows and columns (mod 64) that have 158 * been modified. 159 */ 160 161struct vt_bufmask { 162 uint64_t vbm_row, vbm_col; 163#define VBM_DIRTY UINT64_MAX 164}; 165 166struct vt_buf { 167 struct mtx vb_lock; /* Buffer lock. */ 168 term_pos_t vb_scr_size; /* (b) Screen dimensions. */ 169 int vb_flags; /* (b) Flags. */ 170#define VBF_CURSOR 0x1 /* Cursor visible. */ 171#define VBF_STATIC 0x2 /* Buffer is statically allocated. */ 172#define VBF_MTX_INIT 0x4 /* Mutex initialized. */ 173#define VBF_SCROLL 0x8 /* scroll locked mode. */ 174#define VBF_HISTORY_FULL 0x10 /* All rows filled. */ 175 int vb_history_size; 176#define VBF_DEFAULT_HISTORY_SIZE 500 177 int vb_roffset; /* (b) History rows offset. */ 178 int vb_curroffset; /* (b) Saved rows offset. */ 179 term_pos_t vb_cursor; /* (u) Cursor position. */ 180 term_pos_t vb_mark_start; /* (b) Copy region start. */ 181 term_pos_t vb_mark_end; /* (b) Copy region end. */ 182 int vb_mark_last; /* Last mouse event. */ 183 term_rect_t vb_dirtyrect; /* (b) Dirty rectangle. */ 184 struct vt_bufmask vb_dirtymask; /* (b) Dirty bitmasks. */ 185 term_char_t *vb_buffer; /* (u) Data buffer. */ 186 term_char_t **vb_rows; /* (u) Array of rows */ 187}; 188 189void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *); 190void vtbuf_fill_locked(struct vt_buf *, const term_rect_t *, term_char_t); 191void vtbuf_init_early(struct vt_buf *); 192void vtbuf_init(struct vt_buf *, const term_pos_t *); 193void vtbuf_grow(struct vt_buf *, const term_pos_t *, int); 194void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t); 195void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *); 196void vtbuf_scroll_mode(struct vt_buf *vb, int yes); 197void vtbuf_undirty(struct vt_buf *, term_rect_t *, struct vt_bufmask *); 198void vtbuf_sethistory_size(struct vt_buf *, int); 199int vtbuf_iscursor(struct vt_buf *vb, int row, int col); 200void vtbuf_cursor_visibility(struct vt_buf *, int); 201#ifndef SC_NO_CUTPASTE 202void vtbuf_mouse_cursor_position(struct vt_buf *vb, int col, int row); 203int vtbuf_set_mark(struct vt_buf *vb, int type, int col, int row); 204int vtbuf_get_marked_len(struct vt_buf *vb); 205void vtbuf_extract_marked(struct vt_buf *vb, term_char_t *buf, int sz); 206#endif 207 208#define VTB_MARK_NONE 0 209#define VTB_MARK_END 1 210#define VTB_MARK_START 2 211#define VTB_MARK_WORD 3 212#define VTB_MARK_ROW 4 213#define VTB_MARK_EXTEND 5 214#define VTB_MARK_MOVE 6 215 216#define VTBUF_SLCK_ENABLE(vb) vtbuf_scroll_mode((vb), 1) 217#define VTBUF_SLCK_DISABLE(vb) vtbuf_scroll_mode((vb), 0) 218 219#define VTBUF_MAX_HEIGHT(vb) \ 220 ((vb)->vb_history_size) 221#define VTBUF_GET_ROW(vb, r) \ 222 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)]) 223#define VTBUF_GET_FIELD(vb, r, c) \ 224 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 225#define VTBUF_FIELD(vb, r, c) \ 226 ((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 227#define VTBUF_ISCURSOR(vb, r, c) \ 228 vtbuf_iscursor((vb), (r), (c)) 229#define VTBUF_DIRTYROW(mask, row) \ 230 ((mask)->vbm_row & ((uint64_t)1 << ((row) % 64))) 231#define VTBUF_DIRTYCOL(mask, col) \ 232 ((mask)->vbm_col & ((uint64_t)1 << ((col) % 64))) 233#define VTBUF_SPACE_CHAR (' ' | TC_WHITE << 26 | TC_BLACK << 29) 234 235#define VHS_SET 0 236#define VHS_CUR 1 237#define VHS_END 2 238int vthistory_seek(struct vt_buf *, int offset, int whence); 239void vthistory_addlines(struct vt_buf *vb, int offset); 240void vthistory_getpos(const struct vt_buf *, unsigned int *offset); 241 242/* 243 * Per-window datastructure. 244 */ 245 246struct vt_window { 247 struct vt_device *vw_device; /* (c) Device. */ 248 struct terminal *vw_terminal; /* (c) Terminal. */ 249 struct vt_buf vw_buf; /* (u) Screen buffer. */ 250 struct vt_font *vw_font; /* (d) Graphical font. */ 251 unsigned int vw_number; /* (c) Window number. */ 252 int vw_kbdmode; /* (?) Keyboard mode. */ 253 char *vw_kbdsq; /* Escape sequence queue*/ 254 unsigned int vw_flags; /* (d) Per-window flags. */ 255 int vw_mouse_level;/* Mouse op mode. */ 256#define VWF_BUSY 0x1 /* Busy reconfiguring device. */ 257#define VWF_OPENED 0x2 /* TTY in use. */ 258#define VWF_SCROLL 0x4 /* Keys influence scrollback. */ 259#define VWF_CONSOLE 0x8 /* Kernel message console window. */ 260#define VWF_VTYLOCK 0x10 /* Prevent window switch. */ 261#define VWF_MOUSE_HIDE 0x20 /* Disable mouse events processing. */ 262#define VWF_READY 0x40 /* Window fully initialized. */ 263#define VWF_SWWAIT_REL 0x10000 /* Program wait for VT acquire is done. */ 264#define VWF_SWWAIT_ACQ 0x20000 /* Program wait for VT release is done. */ 265 pid_t vw_pid; /* Terminal holding process */ 266 struct proc *vw_proc; 267 struct vt_mode vw_smode; /* switch mode */ 268 struct callout vw_proc_dead_timer; 269 struct vt_window *vw_switch_to; 270}; 271 272#define VT_AUTO 0 /* switching is automatic */ 273#define VT_PROCESS 1 /* switching controlled by prog */ 274#define VT_KERNEL 255 /* switching controlled in kernel */ 275 276#define IS_VT_PROC_MODE(vw) ((vw)->vw_smode.mode == VT_PROCESS) 277 278/* 279 * Per-device driver routines. 280 * 281 * vd_bitbltchr is used when the driver operates in graphics mode, while 282 * vd_putchar is used when the driver operates in text mode 283 * (VDF_TEXTMODE). 284 */ 285 286typedef int vd_init_t(struct vt_device *vd); 287typedef int vd_probe_t(struct vt_device *vd); 288typedef void vd_postswitch_t(struct vt_device *vd); 289typedef void vd_blank_t(struct vt_device *vd, term_color_t color); 290typedef void vd_bitbltchr_t(struct vt_device *vd, const uint8_t *src, 291 const uint8_t *mask, int bpl, vt_axis_t top, vt_axis_t left, 292 unsigned int width, unsigned int height, term_color_t fg, term_color_t bg); 293typedef void vd_maskbitbltchr_t(struct vt_device *vd, const uint8_t *src, 294 const uint8_t *mask, int bpl, vt_axis_t top, vt_axis_t left, 295 unsigned int width, unsigned int height, term_color_t fg, term_color_t bg); 296typedef void vd_putchar_t(struct vt_device *vd, term_char_t, 297 vt_axis_t top, vt_axis_t left, term_color_t fg, term_color_t bg); 298typedef int vd_fb_ioctl_t(struct vt_device *, u_long, caddr_t, struct thread *); 299typedef int vd_fb_mmap_t(struct vt_device *, vm_ooffset_t, vm_paddr_t *, int, 300 vm_memattr_t *); 301typedef void vd_drawrect_t(struct vt_device *, int, int, int, int, int, 302 term_color_t); 303typedef void vd_setpixel_t(struct vt_device *, int, int, term_color_t); 304 305struct vt_driver { 306 char vd_name[16]; 307 /* Console attachment. */ 308 vd_probe_t *vd_probe; 309 vd_init_t *vd_init; 310 311 /* Drawing. */ 312 vd_blank_t *vd_blank; 313 vd_bitbltchr_t *vd_bitbltchr; 314 vd_maskbitbltchr_t *vd_maskbitbltchr; 315 vd_drawrect_t *vd_drawrect; 316 vd_setpixel_t *vd_setpixel; 317 318 /* Framebuffer ioctls, if present. */ 319 vd_fb_ioctl_t *vd_fb_ioctl; 320 321 /* Framebuffer mmap, if present. */ 322 vd_fb_mmap_t *vd_fb_mmap; 323 324 /* Text mode operation. */ 325 vd_putchar_t *vd_putchar; 326 327 /* Update display setting on vt switch. */ 328 vd_postswitch_t *vd_postswitch; 329 330 /* Priority to know which one can override */ 331 int vd_priority; 332#define VD_PRIORITY_DUMB 10 333#define VD_PRIORITY_GENERIC 100 334#define VD_PRIORITY_SPECIFIC 1000 335}; 336 337/* 338 * Console device madness. 339 * 340 * Utility macro to make early vt(4) instances work. 341 */ 342 343extern const struct terminal_class vt_termclass; 344void vt_upgrade(struct vt_device *vd); 345 346#define PIXEL_WIDTH(w) ((w) / 8) 347#define PIXEL_HEIGHT(h) ((h) / 16) 348 349#ifndef VT_FB_DEFAULT_WIDTH 350#define VT_FB_DEFAULT_WIDTH 2048 351#endif 352#ifndef VT_FB_DEFAULT_HEIGHT 353#define VT_FB_DEFAULT_HEIGHT 1200 354#endif 355 356#define VT_CONSDEV_DECLARE(driver, width, height, softc) \ 357static struct terminal driver ## _consterm; \ 358static struct vt_window driver ## _conswindow; \ 359static struct vt_device driver ## _consdev = { \ 360 .vd_driver = &driver, \ 361 .vd_softc = (softc), \ 362 .vd_flags = VDF_INVALID, \ 363 .vd_windows = { [VT_CONSWINDOW] = &driver ## _conswindow, }, \ 364 .vd_curwindow = &driver ## _conswindow, \ 365 .vd_markedwin = NULL, \ 366 .vd_kbstate = 0, \ 367}; \ 368static term_char_t driver ## _constextbuf[(width) * \ 369 (VBF_DEFAULT_HISTORY_SIZE)]; \ 370static term_char_t *driver ## _constextbufrows[ \ 371 VBF_DEFAULT_HISTORY_SIZE]; \ 372static struct vt_window driver ## _conswindow = { \ 373 .vw_number = VT_CONSWINDOW, \ 374 .vw_flags = VWF_CONSOLE, \ 375 .vw_buf = { \ 376 .vb_buffer = driver ## _constextbuf, \ 377 .vb_rows = driver ## _constextbufrows, \ 378 .vb_history_size = VBF_DEFAULT_HISTORY_SIZE, \ 379 .vb_curroffset = 0, \ 380 .vb_roffset = 0, \ 381 .vb_flags = VBF_STATIC, \ 382 .vb_mark_start = { \ 383 .tp_row = 0, \ 384 .tp_col = 0, \ 385 }, \ 386 .vb_mark_end = { \ 387 .tp_row = 0, \ 388 .tp_col = 0, \ 389 }, \ 390 .vb_scr_size = { \ 391 .tp_row = height, \ 392 .tp_col = width, \ 393 }, \ 394 }, \ 395 .vw_device = &driver ## _consdev, \ 396 .vw_terminal = &driver ## _consterm, \ 397 .vw_kbdmode = K_XLATE, \ 398}; \ 399TERMINAL_DECLARE_EARLY(driver ## _consterm, vt_termclass, \ 400 &driver ## _conswindow); \ 401SYSINIT(vt_early_cons, SI_SUB_INT_CONFIG_HOOKS, SI_ORDER_ANY, \ 402 vt_upgrade, &driver ## _consdev) 403 404/* name argument is not used yet. */ 405#define VT_DRIVER_DECLARE(name, drv) DATA_SET(vt_drv_set, drv) 406 407/* 408 * Fonts. 409 * 410 * Remapping tables are used to map Unicode points to glyphs. They need 411 * to be sorted, because vtfont_lookup() performs a binary search. Each 412 * font has two remapping tables, for normal and bold. When a character 413 * is not present in bold, it uses a normal glyph. When no glyph is 414 * available, it uses glyph 0, which is normally equal to U+FFFD. 415 */ 416 417struct vt_font_map { 418 uint32_t vfm_src; 419 uint16_t vfm_dst; 420 uint16_t vfm_len; 421}; 422 423struct vt_font { 424 struct vt_font_map *vf_map[VFNT_MAPS]; 425 uint8_t *vf_bytes; 426 unsigned int vf_height, vf_width; 427 unsigned int vf_map_count[VFNT_MAPS]; 428 unsigned int vf_refcount; 429}; 430 431#ifndef SC_NO_CUTPASTE 432struct mouse_cursor { 433 uint8_t map[64 * 64 / 8]; 434 uint8_t mask[64 * 64 / 8]; 435 uint8_t w; 436 uint8_t h; 437}; 438#endif 439 440const uint8_t *vtfont_lookup(const struct vt_font *vf, term_char_t c); 441struct vt_font *vtfont_ref(struct vt_font *vf); 442void vtfont_unref(struct vt_font *vf); 443int vtfont_load(vfnt_t *f, struct vt_font **ret); 444 445/* Sysmouse. */ 446void sysmouse_process_event(mouse_info_t *mi); 447#ifndef SC_NO_CUTPASTE 448void vt_mouse_event(int type, int x, int y, int event, int cnt, int mlevel); 449void vt_mouse_state(int show); 450#endif 451#define VT_MOUSE_SHOW 1 452#define VT_MOUSE_HIDE 0 453 454#endif /* !_DEV_VT_VT_H_ */ 455 456