vt.h revision 270613
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 270613 2014-08-25 19:06:31Z dumbbell $ 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#ifndef VT_MAXWINDOWS 54#ifdef MAXCONS 55#define VT_MAXWINDOWS MAXCONS 56#else 57#define VT_MAXWINDOWS 12 58#endif 59#endif 60 61#ifndef VT_ALT_TO_ESC_HACK 62#define VT_ALT_TO_ESC_HACK 1 63#endif 64 65#define VT_CONSWINDOW 0 66 67#if defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) 68#define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON3DOWN /* right button */ 69#define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON2DOWN /* not really used */ 70#else 71#define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON2DOWN /* middle button */ 72#define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON3DOWN /* right button */ 73#endif /* defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) */ 74 75#define SC_DRIVER_NAME "vt" 76#ifdef VT_DEBUG 77#define DPRINTF(_l, ...) if (vt_debug > (_l)) printf( __VA_ARGS__ ) 78#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_RWTUN, &vt_##_name, _default,\ 88 _descr); 89 90/* Allow to disable some special keys by users. */ 91#define VT_DEBUG_KEY_ENABLED (1 << 0) 92#define VT_REBOOT_KEY_ENABLED (1 << 1) 93#define VT_HALT_KEY_ENABLED (1 << 2) 94#define VT_POWEROFF_KEY_ENABLED (1 << 3) 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 118#ifndef SC_NO_CUTPASTE 119struct vt_mouse_cursor; 120#endif 121 122struct vt_device { 123 struct vt_window *vd_windows[VT_MAXWINDOWS]; /* (c) Windows. */ 124 struct vt_window *vd_curwindow; /* (d) Current window. */ 125 struct vt_window *vd_savedwindow;/* (?) Saved for suspend. */ 126 struct vt_window *vd_markedwin; /* (?) Copy/paste buf owner. */ 127 const struct vt_driver *vd_driver; /* (c) Graphics driver. */ 128 void *vd_softc; /* (u) Driver data. */ 129#ifndef SC_NO_CUTPASTE 130 struct vt_mouse_cursor *vd_mcursor; /* (?) Cursor bitmap. */ 131 term_color_t vd_mcursor_fg; /* (?) Cursor fg color. */ 132 term_color_t vd_mcursor_bg; /* (?) Cursor bg color. */ 133 vt_axis_t vd_mx_drawn; /* (?) Mouse X and Y */ 134 vt_axis_t vd_my_drawn; /* as of last redraw. */ 135 int vd_mshown; /* (?) Mouse shown during */ 136#endif /* last redrawn. */ 137 uint16_t vd_mx; /* (?) Current mouse X. */ 138 uint16_t vd_my; /* (?) current mouse Y. */ 139 uint32_t vd_mstate; /* (?) Mouse state. */ 140 vt_axis_t vd_width; /* (?) Screen width. */ 141 vt_axis_t vd_height; /* (?) Screen height. */ 142 struct mtx vd_lock; /* Per-device lock. */ 143 struct cv vd_winswitch; /* (d) Window switch notify. */ 144 struct callout vd_timer; /* (d) Display timer. */ 145 volatile unsigned int vd_timer_armed;/* (?) Display timer started.*/ 146 int vd_flags; /* (d) Device flags. */ 147#define VDF_TEXTMODE 0x01 /* Do text mode rendering. */ 148#define VDF_SPLASH 0x02 /* Splash screen active. */ 149#define VDF_ASYNC 0x04 /* vt_timer() running. */ 150#define VDF_INVALID 0x08 /* Entire screen should be re-rendered. */ 151#define VDF_DEAD 0x10 /* Early probing found nothing. */ 152#define VDF_INITIALIZED 0x20 /* vtterm_cnprobe already done. */ 153#define VDF_MOUSECURSOR 0x40 /* Mouse cursor visible. */ 154#define VDF_QUIET_BELL 0x80 /* Disable bell. */ 155 int vd_keyboard; /* (G) Keyboard index. */ 156 unsigned int vd_kbstate; /* (?) Device unit. */ 157 unsigned int vd_unit; /* (c) Device unit. */ 158}; 159 160/* 161 * Per-window terminal screen buffer. 162 * 163 * Because redrawing is performed asynchronously, the buffer keeps track 164 * of a rectangle that needs to be redrawn (vb_dirtyrect). Because this 165 * approach seemed to cause suboptimal performance (when the top left 166 * and the bottom right of the screen are modified), it also uses a set 167 * of bitmasks to keep track of the rows and columns (mod 64) that have 168 * been modified. 169 */ 170 171struct vt_bufmask { 172 uint64_t vbm_row, vbm_col; 173#define VBM_DIRTY UINT64_MAX 174}; 175 176struct vt_buf { 177 struct mtx vb_lock; /* Buffer lock. */ 178 term_pos_t vb_scr_size; /* (b) Screen dimensions. */ 179 int vb_flags; /* (b) Flags. */ 180#define VBF_CURSOR 0x1 /* Cursor visible. */ 181#define VBF_STATIC 0x2 /* Buffer is statically allocated. */ 182#define VBF_MTX_INIT 0x4 /* Mutex initialized. */ 183#define VBF_SCROLL 0x8 /* scroll locked mode. */ 184#define VBF_HISTORY_FULL 0x10 /* All rows filled. */ 185 int vb_history_size; 186#define VBF_DEFAULT_HISTORY_SIZE 500 187 int vb_roffset; /* (b) History rows offset. */ 188 int vb_curroffset; /* (b) Saved rows offset. */ 189 term_pos_t vb_cursor; /* (u) Cursor position. */ 190 term_pos_t vb_mark_start; /* (b) Copy region start. */ 191 term_pos_t vb_mark_end; /* (b) Copy region end. */ 192 int vb_mark_last; /* Last mouse event. */ 193 term_rect_t vb_dirtyrect; /* (b) Dirty rectangle. */ 194 struct vt_bufmask vb_dirtymask; /* (b) Dirty bitmasks. */ 195 term_char_t *vb_buffer; /* (u) Data buffer. */ 196 term_char_t **vb_rows; /* (u) Array of rows */ 197}; 198 199void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *); 200void vtbuf_fill_locked(struct vt_buf *, const term_rect_t *, term_char_t); 201void vtbuf_init_early(struct vt_buf *); 202void vtbuf_init(struct vt_buf *, const term_pos_t *); 203void vtbuf_grow(struct vt_buf *, const term_pos_t *, int); 204void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t); 205void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *); 206void vtbuf_scroll_mode(struct vt_buf *vb, int yes); 207void vtbuf_dirty(struct vt_buf *vb, const term_rect_t *area); 208void vtbuf_undirty(struct vt_buf *, term_rect_t *, struct vt_bufmask *); 209void vtbuf_sethistory_size(struct vt_buf *, int); 210int vtbuf_iscursor(const struct vt_buf *vb, int row, int col); 211void vtbuf_cursor_visibility(struct vt_buf *, int); 212#ifndef SC_NO_CUTPASTE 213int vtbuf_set_mark(struct vt_buf *vb, int type, int col, int row); 214int vtbuf_get_marked_len(struct vt_buf *vb); 215void vtbuf_extract_marked(struct vt_buf *vb, term_char_t *buf, int sz); 216#endif 217 218#define VTB_MARK_NONE 0 219#define VTB_MARK_END 1 220#define VTB_MARK_START 2 221#define VTB_MARK_WORD 3 222#define VTB_MARK_ROW 4 223#define VTB_MARK_EXTEND 5 224#define VTB_MARK_MOVE 6 225 226#define VTBUF_SLCK_ENABLE(vb) vtbuf_scroll_mode((vb), 1) 227#define VTBUF_SLCK_DISABLE(vb) vtbuf_scroll_mode((vb), 0) 228 229#define VTBUF_MAX_HEIGHT(vb) \ 230 ((vb)->vb_history_size) 231#define VTBUF_GET_ROW(vb, r) \ 232 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)]) 233#define VTBUF_GET_FIELD(vb, r, c) \ 234 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 235#define VTBUF_FIELD(vb, r, c) \ 236 ((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 237#define VTBUF_ISCURSOR(vb, r, c) \ 238 vtbuf_iscursor((vb), (r), (c)) 239#define VTBUF_DIRTYROW(mask, row) \ 240 ((mask)->vbm_row & ((uint64_t)1 << ((row) % 64))) 241#define VTBUF_DIRTYCOL(mask, col) \ 242 ((mask)->vbm_col & ((uint64_t)1 << ((col) % 64))) 243#define VTBUF_SPACE_CHAR(attr) (' ' | (attr)) 244 245#define VHS_SET 0 246#define VHS_CUR 1 247#define VHS_END 2 248int vthistory_seek(struct vt_buf *, int offset, int whence); 249void vthistory_addlines(struct vt_buf *vb, int offset); 250void vthistory_getpos(const struct vt_buf *, unsigned int *offset); 251 252/* 253 * Per-window datastructure. 254 */ 255 256struct vt_window { 257 struct vt_device *vw_device; /* (c) Device. */ 258 struct terminal *vw_terminal; /* (c) Terminal. */ 259 struct vt_buf vw_buf; /* (u) Screen buffer. */ 260 struct vt_font *vw_font; /* (d) Graphical font. */ 261 term_rect_t vw_draw_area; /* (?) Drawable area. */ 262 unsigned int vw_number; /* (c) Window number. */ 263 int vw_kbdmode; /* (?) Keyboard mode. */ 264 char *vw_kbdsq; /* Escape sequence queue*/ 265 unsigned int vw_flags; /* (d) Per-window flags. */ 266 int vw_mouse_level;/* Mouse op mode. */ 267#define VWF_BUSY 0x1 /* Busy reconfiguring device. */ 268#define VWF_OPENED 0x2 /* TTY in use. */ 269#define VWF_SCROLL 0x4 /* Keys influence scrollback. */ 270#define VWF_CONSOLE 0x8 /* Kernel message console window. */ 271#define VWF_VTYLOCK 0x10 /* Prevent window switch. */ 272#define VWF_MOUSE_HIDE 0x20 /* Disable mouse events processing. */ 273#define VWF_READY 0x40 /* Window fully initialized. */ 274#define VWF_SWWAIT_REL 0x10000 /* Program wait for VT acquire is done. */ 275#define VWF_SWWAIT_ACQ 0x20000 /* Program wait for VT release is done. */ 276 pid_t vw_pid; /* Terminal holding process */ 277 struct proc *vw_proc; 278 struct vt_mode vw_smode; /* switch mode */ 279 struct callout vw_proc_dead_timer; 280 struct vt_window *vw_switch_to; 281}; 282 283#define VT_AUTO 0 /* switching is automatic */ 284#define VT_PROCESS 1 /* switching controlled by prog */ 285#define VT_KERNEL 255 /* switching controlled in kernel */ 286 287#define IS_VT_PROC_MODE(vw) ((vw)->vw_smode.mode == VT_PROCESS) 288 289/* 290 * Per-device driver routines. 291 */ 292 293typedef int vd_init_t(struct vt_device *vd); 294typedef int vd_probe_t(struct vt_device *vd); 295typedef void vd_postswitch_t(struct vt_device *vd); 296typedef void vd_blank_t(struct vt_device *vd, term_color_t color); 297typedef void vd_bitblt_text_t(struct vt_device *vd, const struct vt_window *vw, 298 const term_rect_t *area); 299typedef void vd_bitblt_bmp_t(struct vt_device *vd, const struct vt_window *vw, 300 const uint8_t *pattern, const uint8_t *mask, 301 unsigned int width, unsigned int height, 302 unsigned int x, unsigned int y, term_color_t fg, term_color_t bg); 303typedef int vd_fb_ioctl_t(struct vt_device *, u_long, caddr_t, struct thread *); 304typedef int vd_fb_mmap_t(struct vt_device *, vm_ooffset_t, vm_paddr_t *, int, 305 vm_memattr_t *); 306typedef void vd_drawrect_t(struct vt_device *, int, int, int, int, int, 307 term_color_t); 308typedef void vd_setpixel_t(struct vt_device *, int, int, term_color_t); 309 310struct vt_driver { 311 char vd_name[16]; 312 /* Console attachment. */ 313 vd_probe_t *vd_probe; 314 vd_init_t *vd_init; 315 316 /* Drawing. */ 317 vd_blank_t *vd_blank; 318 vd_drawrect_t *vd_drawrect; 319 vd_setpixel_t *vd_setpixel; 320 vd_bitblt_text_t *vd_bitblt_text; 321 vd_bitblt_bmp_t *vd_bitblt_bmp; 322 323 /* Framebuffer ioctls, if present. */ 324 vd_fb_ioctl_t *vd_fb_ioctl; 325 326 /* Framebuffer mmap, if present. */ 327 vd_fb_mmap_t *vd_fb_mmap; 328 329 /* Update display setting on vt switch. */ 330 vd_postswitch_t *vd_postswitch; 331 332 /* Priority to know which one can override */ 333 int vd_priority; 334#define VD_PRIORITY_DUMB 10 335#define VD_PRIORITY_GENERIC 100 336#define VD_PRIORITY_SPECIFIC 1000 337}; 338 339/* 340 * Console device madness. 341 * 342 * Utility macro to make early vt(4) instances work. 343 */ 344 345extern const struct terminal_class vt_termclass; 346void vt_upgrade(struct vt_device *vd); 347 348#define PIXEL_WIDTH(w) ((w) / 8) 349#define PIXEL_HEIGHT(h) ((h) / 16) 350 351#ifndef VT_FB_DEFAULT_WIDTH 352#define VT_FB_DEFAULT_WIDTH 2048 353#endif 354#ifndef VT_FB_DEFAULT_HEIGHT 355#define VT_FB_DEFAULT_HEIGHT 1200 356#endif 357 358/* name argument is not used yet. */ 359#define VT_DRIVER_DECLARE(name, drv) DATA_SET(vt_drv_set, drv) 360 361/* 362 * Fonts. 363 * 364 * Remapping tables are used to map Unicode points to glyphs. They need 365 * to be sorted, because vtfont_lookup() performs a binary search. Each 366 * font has two remapping tables, for normal and bold. When a character 367 * is not present in bold, it uses a normal glyph. When no glyph is 368 * available, it uses glyph 0, which is normally equal to U+FFFD. 369 */ 370 371struct vt_font_map { 372 uint32_t vfm_src; 373 uint16_t vfm_dst; 374 uint16_t vfm_len; 375}; 376 377struct vt_font { 378 struct vt_font_map *vf_map[VFNT_MAPS]; 379 uint8_t *vf_bytes; 380 unsigned int vf_height, vf_width; 381 unsigned int vf_map_count[VFNT_MAPS]; 382 unsigned int vf_refcount; 383}; 384 385#ifndef SC_NO_CUTPASTE 386struct vt_mouse_cursor { 387 uint8_t map[64 * 64 / 8]; 388 uint8_t mask[64 * 64 / 8]; 389 uint8_t width; 390 uint8_t height; 391}; 392#endif 393 394const uint8_t *vtfont_lookup(const struct vt_font *vf, term_char_t c); 395struct vt_font *vtfont_ref(struct vt_font *vf); 396void vtfont_unref(struct vt_font *vf); 397int vtfont_load(vfnt_t *f, struct vt_font **ret); 398 399/* Sysmouse. */ 400void sysmouse_process_event(mouse_info_t *mi); 401#ifndef SC_NO_CUTPASTE 402void vt_mouse_event(int type, int x, int y, int event, int cnt, int mlevel); 403void vt_mouse_state(int show); 404#endif 405#define VT_MOUSE_SHOW 1 406#define VT_MOUSE_HIDE 0 407 408/* Utilities. */ 409void vt_determine_colors(term_char_t c, int cursor, 410 term_color_t *fg, term_color_t *bg); 411int vt_is_cursor_in_area(const struct vt_device *vd, 412 const term_rect_t *area); 413 414#endif /* !_DEV_VT_VT_H_ */ 415 416