vt.h revision 271465
1251881Speter/*- 2251881Speter * Copyright (c) 2009, 2013 The FreeBSD Foundation 3251881Speter * All rights reserved. 4251881Speter * 5251881Speter * This software was developed by Ed Schouten under sponsorship from the 6251881Speter * FreeBSD Foundation. 7251881Speter * 8251881Speter * Portions of this software were developed by Oleksandr Rybalko 9251881Speter * under sponsorship from the FreeBSD Foundation. 10251881Speter * 11251881Speter * Redistribution and use in source and binary forms, with or without 12251881Speter * modification, are permitted provided that the following conditions 13251881Speter * are met: 14251881Speter * 1. Redistributions of source code must retain the above copyright 15251881Speter * notice, this list of conditions and the following disclaimer. 16251881Speter * 2. Redistributions in binary form must reproduce the above copyright 17251881Speter * notice, this list of conditions and the following disclaimer in the 18251881Speter * documentation and/or other materials provided with the distribution. 19251881Speter * 20251881Speter * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 21251881Speter * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22251881Speter * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23251881Speter * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 24251881Speter * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25251881Speter * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26251881Speter * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27251881Speter * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28251881Speter * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29251881Speter * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30251881Speter * SUCH DAMAGE. 31251881Speter * 32251881Speter * $FreeBSD: head/sys/dev/vt/vt.h 271465 2014-09-12 14:16:10Z ray $ 33251881Speter */ 34251881Speter 35251881Speter#ifndef _DEV_VT_VT_H_ 36251881Speter#define _DEV_VT_VT_H_ 37251881Speter 38251881Speter#include <sys/param.h> 39251881Speter#include <sys/_lock.h> 40251881Speter#include <sys/_mutex.h> 41251881Speter#include <sys/callout.h> 42251881Speter#include <sys/condvar.h> 43251881Speter#include <sys/conf.h> 44251881Speter#include <sys/consio.h> 45251881Speter#include <sys/kbio.h> 46251881Speter#include <sys/mouse.h> 47251881Speter#include <sys/terminal.h> 48251881Speter#include <sys/sysctl.h> 49251881Speter 50251881Speter#include "opt_syscons.h" 51251881Speter#include "opt_splash.h" 52251881Speter 53251881Speter#ifndef VT_MAXWINDOWS 54251881Speter#ifdef MAXCONS 55251881Speter#define VT_MAXWINDOWS MAXCONS 56251881Speter#else 57251881Speter#define VT_MAXWINDOWS 12 58251881Speter#endif 59251881Speter#endif 60251881Speter 61251881Speter#ifndef VT_ALT_TO_ESC_HACK 62251881Speter#define VT_ALT_TO_ESC_HACK 1 63251881Speter#endif 64251881Speter 65251881Speter#define VT_CONSWINDOW 0 66251881Speter 67251881Speter#if defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) 68251881Speter#define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON3DOWN /* right button */ 69251881Speter#define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON2DOWN /* not really used */ 70251881Speter#else 71251881Speter#define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON2DOWN /* middle button */ 72251881Speter#define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON3DOWN /* right button */ 73251881Speter#endif /* defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) */ 74251881Speter 75251881Speter#define SC_DRIVER_NAME "vt" 76251881Speter#ifdef VT_DEBUG 77251881Speter#define DPRINTF(_l, ...) if (vt_debug > (_l)) printf( __VA_ARGS__ ) 78251881Speter#define VT_CONSOLECTL_DEBUG 79251881Speter#define VT_SYSMOUSE_DEBUG 80251881Speter#else 81251881Speter#define DPRINTF(_l, ...) do {} while (0) 82251881Speter#endif 83251881Speter#define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG) 84251881Speter 85251881Speter#define VT_SYSCTL_INT(_name, _default, _descr) \ 86251881Speterstatic int vt_##_name = _default; \ 87251881SpeterSYSCTL_INT(_kern_vt, OID_AUTO, _name, CTLFLAG_RWTUN, &vt_##_name, _default,\ 88251881Speter _descr); 89251881Speter 90251881Speterstruct vt_driver; 91251881Speter 92251881Spetervoid vt_allocate(struct vt_driver *, void *); 93251881Spetervoid vt_resume(void); 94251881Spetervoid vt_suspend(void); 95251881Speter 96251881Spetertypedef unsigned int vt_axis_t; 97251881Speter 98251881Speter/* 99251881Speter * List of locks 100251881Speter * (d) locked by vd_lock 101251881Speter * (b) locked by vb_lock 102251881Speter * (G) locked by Giant 103251881Speter * (u) unlocked, locked by higher levels 104251881Speter * (c) const until freeing 105251881Speter * (?) yet to be determined 106251881Speter */ 107251881Speter 108251881Speter/* 109251881Speter * Per-device datastructure. 110251881Speter */ 111251881Speter 112251881Speter#ifndef SC_NO_CUTPASTE 113251881Speterstruct vt_mouse_cursor; 114251881Speter#endif 115251881Speter 116251881Speterstruct vt_pastebuf { 117251881Speter term_char_t *vpb_buf; /* Copy-paste buffer. */ 118251881Speter unsigned int vpb_bufsz; /* Buffer size. */ 119251881Speter unsigned int vpb_len; /* Length of a last selection. */ 120251881Speter}; 121251881Speter 122251881Speterstruct vt_device { 123251881Speter struct vt_window *vd_windows[VT_MAXWINDOWS]; /* (c) Windows. */ 124251881Speter struct vt_window *vd_curwindow; /* (d) Current window. */ 125251881Speter struct vt_window *vd_savedwindow;/* (?) Saved for suspend. */ 126251881Speter struct vt_pastebuf vd_pastebuf; /* (?) Copy/paste buf. */ 127251881Speter const struct vt_driver *vd_driver; /* (c) Graphics driver. */ 128251881Speter void *vd_softc; /* (u) Driver data. */ 129251881Speter#ifndef SC_NO_CUTPASTE 130251881Speter struct vt_mouse_cursor *vd_mcursor; /* (?) Cursor bitmap. */ 131251881Speter term_color_t vd_mcursor_fg; /* (?) Cursor fg color. */ 132251881Speter term_color_t vd_mcursor_bg; /* (?) Cursor bg color. */ 133251881Speter vt_axis_t vd_mx_drawn; /* (?) Mouse X and Y */ 134251881Speter vt_axis_t vd_my_drawn; /* as of last redraw. */ 135251881Speter int vd_mshown; /* (?) Mouse shown during */ 136251881Speter#endif /* last redrawn. */ 137251881Speter uint16_t vd_mx; /* (?) Current mouse X. */ 138251881Speter uint16_t vd_my; /* (?) current mouse Y. */ 139251881Speter uint32_t vd_mstate; /* (?) Mouse state. */ 140251881Speter vt_axis_t vd_width; /* (?) Screen width. */ 141251881Speter vt_axis_t vd_height; /* (?) Screen height. */ 142251881Speter struct mtx vd_lock; /* Per-device lock. */ 143251881Speter struct cv vd_winswitch; /* (d) Window switch notify. */ 144251881Speter struct callout vd_timer; /* (d) Display timer. */ 145251881Speter volatile unsigned int vd_timer_armed;/* (?) Display timer started.*/ 146251881Speter int vd_flags; /* (d) Device flags. */ 147251881Speter#define VDF_TEXTMODE 0x01 /* Do text mode rendering. */ 148251881Speter#define VDF_SPLASH 0x02 /* Splash screen active. */ 149251881Speter#define VDF_ASYNC 0x04 /* vt_timer() running. */ 150251881Speter#define VDF_INVALID 0x08 /* Entire screen should be re-rendered. */ 151251881Speter#define VDF_DEAD 0x10 /* Early probing found nothing. */ 152251881Speter#define VDF_INITIALIZED 0x20 /* vtterm_cnprobe already done. */ 153251881Speter#define VDF_MOUSECURSOR 0x40 /* Mouse cursor visible. */ 154251881Speter#define VDF_QUIET_BELL 0x80 /* Disable bell. */ 155251881Speter int vd_keyboard; /* (G) Keyboard index. */ 156251881Speter unsigned int vd_kbstate; /* (?) Device unit. */ 157251881Speter unsigned int vd_unit; /* (c) Device unit. */ 158251881Speter}; 159251881Speter 160251881Speter#define VD_PASTEBUF(vd) ((vd)->vd_pastebuf.vpb_buf) 161251881Speter#define VD_PASTEBUFSZ(vd) ((vd)->vd_pastebuf.vpb_bufsz) 162251881Speter#define VD_PASTEBUFLEN(vd) ((vd)->vd_pastebuf.vpb_len) 163251881Speter 164251881Speter/* 165251881Speter * Per-window terminal screen buffer. 166251881Speter * 167251881Speter * Because redrawing is performed asynchronously, the buffer keeps track 168251881Speter * of a rectangle that needs to be redrawn (vb_dirtyrect). Because this 169251881Speter * approach seemed to cause suboptimal performance (when the top left 170251881Speter * and the bottom right of the screen are modified), it also uses a set 171251881Speter * of bitmasks to keep track of the rows and columns (mod 64) that have 172251881Speter * been modified. 173251881Speter */ 174251881Speter 175251881Speterstruct vt_bufmask { 176251881Speter uint64_t vbm_row, vbm_col; 177251881Speter#define VBM_DIRTY UINT64_MAX 178251881Speter}; 179251881Speter 180251881Speterstruct vt_buf { 181251881Speter struct mtx vb_lock; /* Buffer lock. */ 182251881Speter term_pos_t vb_scr_size; /* (b) Screen dimensions. */ 183251881Speter int vb_flags; /* (b) Flags. */ 184251881Speter#define VBF_CURSOR 0x1 /* Cursor visible. */ 185251881Speter#define VBF_STATIC 0x2 /* Buffer is statically allocated. */ 186251881Speter#define VBF_MTX_INIT 0x4 /* Mutex initialized. */ 187251881Speter#define VBF_SCROLL 0x8 /* scroll locked mode. */ 188251881Speter#define VBF_HISTORY_FULL 0x10 /* All rows filled. */ 189251881Speter unsigned int vb_history_size; 190251881Speter#define VBF_DEFAULT_HISTORY_SIZE 500 191251881Speter int vb_roffset; /* (b) History rows offset. */ 192251881Speter int vb_curroffset; /* (b) Saved rows offset. */ 193251881Speter term_pos_t vb_cursor; /* (u) Cursor position. */ 194251881Speter term_pos_t vb_mark_start; /* (b) Copy region start. */ 195251881Speter term_pos_t vb_mark_end; /* (b) Copy region end. */ 196251881Speter int vb_mark_last; /* Last mouse event. */ 197251881Speter term_rect_t vb_dirtyrect; /* (b) Dirty rectangle. */ 198251881Speter struct vt_bufmask vb_dirtymask; /* (b) Dirty bitmasks. */ 199251881Speter term_char_t *vb_buffer; /* (u) Data buffer. */ 200251881Speter term_char_t **vb_rows; /* (u) Array of rows */ 201251881Speter}; 202251881Speter 203251881Spetervoid vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *); 204251881Spetervoid vtbuf_fill_locked(struct vt_buf *, const term_rect_t *, term_char_t); 205251881Spetervoid vtbuf_init_early(struct vt_buf *); 206251881Spetervoid vtbuf_init(struct vt_buf *, const term_pos_t *); 207251881Spetervoid vtbuf_grow(struct vt_buf *, const term_pos_t *, unsigned int); 208251881Spetervoid vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t); 209251881Spetervoid vtbuf_cursor_position(struct vt_buf *, const term_pos_t *); 210251881Spetervoid vtbuf_scroll_mode(struct vt_buf *vb, int yes); 211251881Spetervoid vtbuf_dirty(struct vt_buf *vb, const term_rect_t *area); 212251881Spetervoid vtbuf_undirty(struct vt_buf *, term_rect_t *, struct vt_bufmask *); 213251881Spetervoid vtbuf_sethistory_size(struct vt_buf *, int); 214251881Speterint vtbuf_iscursor(const struct vt_buf *vb, int row, int col); 215251881Spetervoid vtbuf_cursor_visibility(struct vt_buf *, int); 216251881Speter#ifndef SC_NO_CUTPASTE 217251881Speterint vtbuf_set_mark(struct vt_buf *vb, int type, int col, int row); 218251881Speterint vtbuf_get_marked_len(struct vt_buf *vb); 219251881Spetervoid vtbuf_extract_marked(struct vt_buf *vb, term_char_t *buf, int sz); 220251881Speter#endif 221251881Speter 222251881Speter#define VTB_MARK_NONE 0 223251881Speter#define VTB_MARK_END 1 224251881Speter#define VTB_MARK_START 2 225251881Speter#define VTB_MARK_WORD 3 226251881Speter#define VTB_MARK_ROW 4 227251881Speter#define VTB_MARK_EXTEND 5 228251881Speter#define VTB_MARK_MOVE 6 229251881Speter 230251881Speter#define VTBUF_SLCK_ENABLE(vb) vtbuf_scroll_mode((vb), 1) 231251881Speter#define VTBUF_SLCK_DISABLE(vb) vtbuf_scroll_mode((vb), 0) 232251881Speter 233251881Speter#define VTBUF_MAX_HEIGHT(vb) \ 234251881Speter ((vb)->vb_history_size) 235251881Speter#define VTBUF_GET_ROW(vb, r) \ 236251881Speter ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)]) 237251881Speter#define VTBUF_GET_FIELD(vb, r, c) \ 238251881Speter ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 239251881Speter#define VTBUF_FIELD(vb, r, c) \ 240251881Speter ((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 241251881Speter#define VTBUF_ISCURSOR(vb, r, c) \ 242251881Speter vtbuf_iscursor((vb), (r), (c)) 243251881Speter#define VTBUF_DIRTYROW(mask, row) \ 244251881Speter ((mask)->vbm_row & ((uint64_t)1 << ((row) % 64))) 245251881Speter#define VTBUF_DIRTYCOL(mask, col) \ 246251881Speter ((mask)->vbm_col & ((uint64_t)1 << ((col) % 64))) 247251881Speter#define VTBUF_SPACE_CHAR(attr) (' ' | (attr)) 248251881Speter 249251881Speter#define VHS_SET 0 250251881Speter#define VHS_CUR 1 251251881Speter#define VHS_END 2 252251881Speterint vthistory_seek(struct vt_buf *, int offset, int whence); 253251881Spetervoid vthistory_addlines(struct vt_buf *vb, int offset); 254251881Spetervoid vthistory_getpos(const struct vt_buf *, unsigned int *offset); 255251881Speter 256251881Speter/* 257251881Speter * Per-window datastructure. 258251881Speter */ 259251881Speter 260251881Speterstruct vt_window { 261251881Speter struct vt_device *vw_device; /* (c) Device. */ 262251881Speter struct terminal *vw_terminal; /* (c) Terminal. */ 263251881Speter struct vt_buf vw_buf; /* (u) Screen buffer. */ 264251881Speter struct vt_font *vw_font; /* (d) Graphical font. */ 265251881Speter term_rect_t vw_draw_area; /* (?) Drawable area. */ 266251881Speter unsigned int vw_number; /* (c) Window number. */ 267251881Speter int vw_kbdmode; /* (?) Keyboard mode. */ 268251881Speter int vw_prev_kbdmode;/* (?) Previous mode. */ 269251881Speter int vw_grabbed; /* (?) Grab count. */ 270251881Speter char *vw_kbdsq; /* Escape sequence queue*/ 271251881Speter unsigned int vw_flags; /* (d) Per-window flags. */ 272251881Speter int vw_mouse_level;/* Mouse op mode. */ 273251881Speter#define VWF_BUSY 0x1 /* Busy reconfiguring device. */ 274251881Speter#define VWF_OPENED 0x2 /* TTY in use. */ 275251881Speter#define VWF_SCROLL 0x4 /* Keys influence scrollback. */ 276251881Speter#define VWF_CONSOLE 0x8 /* Kernel message console window. */ 277251881Speter#define VWF_VTYLOCK 0x10 /* Prevent window switch. */ 278251881Speter#define VWF_MOUSE_HIDE 0x20 /* Disable mouse events processing. */ 279251881Speter#define VWF_READY 0x40 /* Window fully initialized. */ 280251881Speter#define VWF_GRAPHICS 0x80 /* Window in graphics mode (KDSETMODE). */ 281251881Speter#define VWF_SWWAIT_REL 0x10000 /* Program wait for VT acquire is done. */ 282251881Speter#define VWF_SWWAIT_ACQ 0x20000 /* Program wait for VT release is done. */ 283251881Speter pid_t vw_pid; /* Terminal holding process */ 284251881Speter struct proc *vw_proc; 285251881Speter struct vt_mode vw_smode; /* switch mode */ 286251881Speter struct callout vw_proc_dead_timer; 287251881Speter struct vt_window *vw_switch_to; 288251881Speter}; 289251881Speter 290251881Speter#define VT_AUTO 0 /* switching is automatic */ 291251881Speter#define VT_PROCESS 1 /* switching controlled by prog */ 292251881Speter#define VT_KERNEL 255 /* switching controlled in kernel */ 293251881Speter 294251881Speter#define IS_VT_PROC_MODE(vw) ((vw)->vw_smode.mode == VT_PROCESS) 295251881Speter 296251881Speter/* 297251881Speter * Per-device driver routines. 298251881Speter */ 299251881Speter 300251881Spetertypedef int vd_init_t(struct vt_device *vd); 301251881Spetertypedef int vd_probe_t(struct vt_device *vd); 302251881Spetertypedef void vd_postswitch_t(struct vt_device *vd); 303251881Spetertypedef void vd_blank_t(struct vt_device *vd, term_color_t color); 304251881Spetertypedef void vd_bitblt_text_t(struct vt_device *vd, const struct vt_window *vw, 305251881Speter const term_rect_t *area); 306251881Spetertypedef void vd_bitblt_bmp_t(struct vt_device *vd, const struct vt_window *vw, 307251881Speter const uint8_t *pattern, const uint8_t *mask, 308251881Speter unsigned int width, unsigned int height, 309251881Speter unsigned int x, unsigned int y, term_color_t fg, term_color_t bg); 310251881Spetertypedef int vd_fb_ioctl_t(struct vt_device *, u_long, caddr_t, struct thread *); 311251881Spetertypedef int vd_fb_mmap_t(struct vt_device *, vm_ooffset_t, vm_paddr_t *, int, 312251881Speter vm_memattr_t *); 313251881Spetertypedef void vd_drawrect_t(struct vt_device *, int, int, int, int, int, 314251881Speter term_color_t); 315251881Spetertypedef void vd_setpixel_t(struct vt_device *, int, int, term_color_t); 316251881Speter 317251881Speterstruct vt_driver { 318251881Speter char vd_name[16]; 319251881Speter /* Console attachment. */ 320251881Speter vd_probe_t *vd_probe; 321251881Speter vd_init_t *vd_init; 322251881Speter 323251881Speter /* Drawing. */ 324251881Speter vd_blank_t *vd_blank; 325251881Speter vd_drawrect_t *vd_drawrect; 326251881Speter vd_setpixel_t *vd_setpixel; 327251881Speter vd_bitblt_text_t *vd_bitblt_text; 328 vd_bitblt_bmp_t *vd_bitblt_bmp; 329 330 /* Framebuffer ioctls, if present. */ 331 vd_fb_ioctl_t *vd_fb_ioctl; 332 333 /* Framebuffer mmap, if present. */ 334 vd_fb_mmap_t *vd_fb_mmap; 335 336 /* Update display setting on vt switch. */ 337 vd_postswitch_t *vd_postswitch; 338 339 /* Priority to know which one can override */ 340 int vd_priority; 341#define VD_PRIORITY_DUMB 10 342#define VD_PRIORITY_GENERIC 100 343#define VD_PRIORITY_SPECIFIC 1000 344}; 345 346/* 347 * Console device madness. 348 * 349 * Utility macro to make early vt(4) instances work. 350 */ 351 352extern const struct terminal_class vt_termclass; 353void vt_upgrade(struct vt_device *vd); 354 355#define PIXEL_WIDTH(w) ((w) / 8) 356#define PIXEL_HEIGHT(h) ((h) / 16) 357 358#ifndef VT_FB_DEFAULT_WIDTH 359#define VT_FB_DEFAULT_WIDTH 2048 360#endif 361#ifndef VT_FB_DEFAULT_HEIGHT 362#define VT_FB_DEFAULT_HEIGHT 1200 363#endif 364 365/* name argument is not used yet. */ 366#define VT_DRIVER_DECLARE(name, drv) DATA_SET(vt_drv_set, drv) 367 368/* 369 * Fonts. 370 * 371 * Remapping tables are used to map Unicode points to glyphs. They need 372 * to be sorted, because vtfont_lookup() performs a binary search. Each 373 * font has two remapping tables, for normal and bold. When a character 374 * is not present in bold, it uses a normal glyph. When no glyph is 375 * available, it uses glyph 0, which is normally equal to U+FFFD. 376 */ 377 378struct vt_font_map { 379 uint32_t vfm_src; 380 uint16_t vfm_dst; 381 uint16_t vfm_len; 382}; 383 384struct vt_font { 385 struct vt_font_map *vf_map[VFNT_MAPS]; 386 uint8_t *vf_bytes; 387 unsigned int vf_height, vf_width; 388 unsigned int vf_map_count[VFNT_MAPS]; 389 unsigned int vf_refcount; 390}; 391 392#ifndef SC_NO_CUTPASTE 393struct vt_mouse_cursor { 394 uint8_t map[64 * 64 / 8]; 395 uint8_t mask[64 * 64 / 8]; 396 uint8_t width; 397 uint8_t height; 398}; 399#endif 400 401const uint8_t *vtfont_lookup(const struct vt_font *vf, term_char_t c); 402struct vt_font *vtfont_ref(struct vt_font *vf); 403void vtfont_unref(struct vt_font *vf); 404int vtfont_load(vfnt_t *f, struct vt_font **ret); 405 406/* Sysmouse. */ 407void sysmouse_process_event(mouse_info_t *mi); 408#ifndef SC_NO_CUTPASTE 409void vt_mouse_event(int type, int x, int y, int event, int cnt, int mlevel); 410void vt_mouse_state(int show); 411#endif 412#define VT_MOUSE_SHOW 1 413#define VT_MOUSE_HIDE 0 414 415/* Utilities. */ 416void vt_determine_colors(term_char_t c, int cursor, 417 term_color_t *fg, term_color_t *bg); 418int vt_is_cursor_in_area(const struct vt_device *vd, 419 const term_rect_t *area); 420 421#endif /* !_DEV_VT_VT_H_ */ 422 423