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