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