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