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