vt.h revision 257973
150276Speter/*- 250276Speter * Copyright (c) 2009, 2013 The FreeBSD Foundation 350276Speter * All rights reserved. 450276Speter * 550276Speter * This software was developed by Ed Schouten under sponsorship from the 650276Speter * FreeBSD Foundation. 750276Speter * 850276Speter * Portions of this software were developed by Oleksandr Rybalko 950276Speter * under sponsorship from the FreeBSD Foundation. 1050276Speter * 1150276Speter * Redistribution and use in source and binary forms, with or without 1250276Speter * modification, are permitted provided that the following conditions 1350276Speter * are met: 1450276Speter * 1. Redistributions of source code must retain the above copyright 1550276Speter * notice, this list of conditions and the following disclaimer. 1650276Speter * 2. Redistributions in binary form must reproduce the above copyright 1750276Speter * notice, this list of conditions and the following disclaimer in the 1850276Speter * documentation and/or other materials provided with the distribution. 1950276Speter * 2050276Speter * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 2150276Speter * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2250276Speter * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2350276Speter * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 2450276Speter * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2550276Speter * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2650276Speter * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2750276Speter * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2850276Speter * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2950276Speter * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 3050276Speter * SUCH DAMAGE. 3150276Speter * 3250276Speter * $FreeBSD: user/ed/newcons/sys/dev/vt/vt.h 257973 2013-11-11 11:55:22Z ray $ 3350276Speter */ 3450276Speter 3550276Speter#ifndef _DEV_VT_VT_H_ 3650276Speter#define _DEV_VT_VT_H_ 3750276Speter 3850276Speter#include <sys/param.h> 3950276Speter#include <sys/_lock.h> 4050276Speter#include <sys/_mutex.h> 4150276Speter#include <sys/callout.h> 4250276Speter#include <sys/condvar.h> 4350276Speter#include <sys/consio.h> 4450276Speter#include <sys/kbio.h> 4550276Speter#include <sys/terminal.h> 4650276Speter#include <sys/sysctl.h> 4750276Speter 4850276Speter#include "opt_syscons.h" 4950276Speter 5050276Speter#ifndef VT_MAXWINDOWS 5150276Speter#ifdef MAXCONS 5250276Speter#define VT_MAXWINDOWS MAXCONS 5350276Speter#else 5450276Speter#define VT_MAXWINDOWS 12 5550276Speter#endif 5650276Speter#endif 5750276Speter 5850276Speter#define VT_CONSWINDOW 0 5950276Speter 6050276Speter#if defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) 6150276Speter#define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON3DOWN /* right button */ 6250276Speter#define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON2DOWN /* not really used */ 6350276Speter#else 6450276Speter#define VT_MOUSE_PASTEBUTTON MOUSE_BUTTON2DOWN /* middle button */ 6550276Speter#define VT_MOUSE_EXTENDBUTTON MOUSE_BUTTON3DOWN /* right button */ 6650276Speter#endif /* defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) */ 6750276Speter 6850276Speter#define SC_DRIVER_NAME "vt" 69#define DPRINTF(_l, ...) if (vt_debug > (_l)) printf( __VA_ARGS__ ) 70#define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG) 71 72#define VT_SYSCTL_INT(_name, _default, _descr) \ 73static int vt_##_name = _default; \ 74SYSCTL_INT(_kern_vt, OID_AUTO, _name, CTLFLAG_RW, &vt_##_name, _default,\ 75 _descr); \ 76TUNABLE_INT("kern.vt." #_name, &vt_##_name); 77 78struct vt_driver; 79 80void vt_allocate(struct vt_driver *, void *); 81void vt_resume(void); 82void vt_suspend(void); 83 84typedef unsigned int vt_axis_t; 85 86/* 87 * List of locks 88 * (d) locked by vd_lock 89 * (b) locked by vb_lock 90 * (G) locked by Giant 91 * (u) unlocked, locked by higher levels 92 * (c) const until freeing 93 * (?) yet to be determined 94 */ 95 96/* 97 * Per-device datastructure. 98 */ 99 100struct vt_device { 101 struct vt_window *vd_windows[VT_MAXWINDOWS]; /* (c) Windows. */ 102 struct vt_window *vd_curwindow; /* (d) Current window. */ 103 struct vt_window *vd_savedwindow;/* (?) Saved for suspend. */ 104 const struct vt_driver *vd_driver; /* (c) Graphics driver. */ 105 void *vd_softc; /* (u) Driver data. */ 106 vt_axis_t vd_width; /* (?) Screen width. */ 107 vt_axis_t vd_height; /* (?) Screen height. */ 108 struct mtx vd_lock; /* Per-device lock. */ 109 struct cv vd_winswitch; /* (d) Window switch notify. */ 110 struct callout vd_timer; /* (d) Display timer. */ 111 int vd_flags; /* (d) Device flags. */ 112#define VDF_TEXTMODE 0x01 /* Do text mode rendering. */ 113#define VDF_SPLASH 0x02 /* Splash screen active. */ 114#define VDF_ASYNC 0x04 /* vt_timer() running. */ 115#define VDF_INVALID 0x08 /* Entire screen should be re-rendered. */ 116#define VDF_DEAD 0x10 /* Early probing found nothing. */ 117#define VDF_INITIALIZED 0x20 /* vtterm_cnprobe already done. */ 118 int vd_keyboard; /* (G) Keyboard index. */ 119 unsigned int vd_unit; /* (c) Device unit. */ 120}; 121 122/* 123 * Per-window terminal screen buffer. 124 * 125 * Because redrawing is performed asynchronously, the buffer keeps track 126 * of a rectangle that needs to be redrawn (vb_dirtyrect). Because this 127 * approach seemed to cause suboptimal performance (when the top left 128 * and the bottom right of the screen are modified), it also uses a set 129 * of bitmasks to keep track of the rows and columns (mod 64) that have 130 * been modified. 131 */ 132 133struct vt_bufmask { 134 uint64_t vbm_row, vbm_col; 135#define VBM_DIRTY UINT64_MAX 136}; 137 138struct vt_buf { 139 struct mtx vb_lock; /* Buffer lock. */ 140 term_pos_t vb_scr_size; /* (b) Screen dimensions. */ 141 int vb_flags; /* (b) Flags. */ 142#define VBF_CURSOR 0x1 /* Cursor visible. */ 143#define VBF_STATIC 0x2 /* Buffer is statically allocated. */ 144#define VBF_MTX_INIT 0x4 /* Mutex initialized. */ 145#define VBF_SCROLL 0x8 /* scroll locked mode. */ 146#define VBF_HISTORY_FULL 0x10 /* All rows filled. */ 147 int vb_history_size; 148#define VBF_DEFAULT_HISTORY_SIZE 500 149 int vb_roffset; /* (b) History rows offset. */ 150 int vb_curroffset; /* (b) Saved rows offset. */ 151 term_pos_t vb_cursor; /* (u) Cursor position. */ 152 term_pos_t vb_mark_start; /* (b) Copy region start. */ 153 term_pos_t vb_mark_end; /* (b) Copy region end. */ 154 term_rect_t vb_dirtyrect; /* (b) Dirty rectangle. */ 155 struct vt_bufmask vb_dirtymask; /* (b) Dirty bitmasks. */ 156 term_char_t *vb_buffer; /* (u) Data buffer. */ 157 term_char_t **vb_rows; /* (u) Array of rows */ 158}; 159 160void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *); 161void vtbuf_fill_locked(struct vt_buf *, const term_rect_t *, term_char_t); 162void vtbuf_init_early(struct vt_buf *); 163void vtbuf_init(struct vt_buf *, const term_pos_t *); 164void vtbuf_grow(struct vt_buf *, const term_pos_t *, int); 165void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t); 166void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *); 167void vtbuf_mouse_cursor_position(struct vt_buf *vb, int col, int row); 168void vtbuf_cursor_visibility(struct vt_buf *, int); 169void vtbuf_undirty(struct vt_buf *, term_rect_t *, struct vt_bufmask *); 170void vtbuf_sethistory_size(struct vt_buf *, int); 171void vtbuf_set_mark(struct vt_buf *vb, int type, int col, int row); 172int vtbuf_iscursor(struct vt_buf *vb, int row, int col); 173 174#define VTB_MARK_END 1 175#define VTB_MARK_START 2 176#define VTB_MARK_WORD 3 177#define VTB_MARK_ROW 4 178#define VTB_MARK_EXTEND 5 179 180#define VTBUF_SLCK_ENABLE(vb) (vb)->vb_flags |= VBF_SCROLL 181#define VTBUF_SLCK_DISABLE(vb) (vb)->vb_flags &= ~VBF_SCROLL 182 183#define VTBUF_MAX_HEIGHT(vb) \ 184 ((vb)->vb_history_size) 185#define VTBUF_GET_ROW(vb, r) \ 186 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)]) 187#define VTBUF_GET_FIELD(vb, r, c) \ 188 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 189#define VTBUF_FIELD(vb, r, c) \ 190 ((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 191#define VTBUF_ISCURSOR(vb, r, c) \ 192 ((vb)->vb_flags & VBF_CURSOR && \ 193 (vb)->vb_cursor.tp_row == (r) && (vb)->vb_cursor.tp_col == (c)) 194#define VTBUF_DIRTYROW(mask, row) \ 195 ((mask)->vbm_row & ((uint64_t)1 << ((row) % 64))) 196#define VTBUF_DIRTYCOL(mask, col) \ 197 ((mask)->vbm_col & ((uint64_t)1 << ((col) % 64))) 198#define VTBUF_SPACE_CHAR (' ' | TC_WHITE << 26 | TC_BLACK << 29) 199 200#define VHS_SET 0 201#define VHS_CUR 1 202#define VHS_END 2 203int vthistory_seek(struct vt_buf *, int offset, int whence); 204void vthistory_addlines(struct vt_buf *vb, int offset); 205void vthistory_getpos(const struct vt_buf *, unsigned int *offset); 206 207/* 208 * Per-window datastructure. 209 */ 210 211struct vt_window { 212 struct vt_device *vw_device; /* (c) Device. */ 213 struct terminal *vw_terminal; /* (c) Terminal. */ 214 struct vt_buf vw_buf; /* (u) Screen buffer. */ 215 struct vt_font *vw_font; /* (d) Graphical font. */ 216 unsigned int vw_number; /* (c) Window number. */ 217 int vw_kbdmode; /* (?) Keyboard mode. */ 218 char *vw_kbdsq; /* Escape sequence queue*/ 219 unsigned int vw_flags; /* (d) Per-window flags. */ 220#define VWF_BUSY 0x1 /* Busy reconfiguring device. */ 221#define VWF_OPENED 0x2 /* TTY in use. */ 222#define VWF_SCROLL 0x4 /* Keys influence scrollback. */ 223#define VWF_CONSOLE 0x8 /* Kernel message console window. */ 224#define VWF_VTYLOCK 0x10 /* Prevent window switch. */ 225#define VWF_SWWAIT_REL 0x10000 /* Program wait for VT acquire is done. */ 226#define VWF_SWWAIT_ACQ 0x20000 /* Program wait for VT release is done. */ 227 pid_t vw_pid; /* Terminal holding process */ 228 struct proc *vw_proc; 229 struct vt_mode vw_smode; /* switch mode */ 230 struct callout vw_proc_dead_timer; 231 struct vt_window *vw_switch_to; 232}; 233 234#define VT_AUTO 0 /* switching is automatic */ 235#define VT_PROCESS 1 /* switching controlled by prog */ 236#define VT_KERNEL 255 /* switching controlled in kernel */ 237 238#define IS_VT_PROC_MODE(vw) ((vw)->vw_smode.mode == VT_PROCESS) 239 240/* 241 * Per-device driver routines. 242 * 243 * vd_bitbltchr is used when the driver operates in graphics mode, while 244 * vd_putchar is used when the driver operates in text mode 245 * (VDF_TEXTMODE). 246 */ 247 248typedef int vd_init_t(struct vt_device *vd); 249typedef void vd_postswitch_t(struct vt_device *vd); 250typedef void vd_blank_t(struct vt_device *vd, term_color_t color); 251typedef void vd_bitbltchr_t(struct vt_device *vd, const uint8_t *src, 252 vt_axis_t top, vt_axis_t left, unsigned int width, unsigned int height, 253 term_color_t fg, term_color_t bg); 254typedef void vd_putchar_t(struct vt_device *vd, term_char_t, 255 vt_axis_t top, vt_axis_t left, term_color_t fg, term_color_t bg); 256 257struct vt_driver { 258 /* Console attachment. */ 259 vd_init_t *vd_init; 260 261 /* Drawing. */ 262 vd_blank_t *vd_blank; 263 vd_bitbltchr_t *vd_bitbltchr; 264 265 /* Text mode operation. */ 266 vd_putchar_t *vd_putchar; 267 268 /* Update display setting on vt switch. */ 269 vd_postswitch_t *vd_postswitch; 270 271 /* Priority to know which one can override */ 272 int vd_priority; 273#define VD_PRIORITY_DUMB 10 274#define VD_PRIORITY_GENERIC 100 275#define VD_PRIORITY_SPECIFIC 1000 276}; 277 278/* 279 * Console device madness. 280 * 281 * Utility macro to make early vt(4) instances work. 282 */ 283 284extern const struct terminal_class vt_termclass; 285void vt_upgrade(struct vt_device *vd); 286 287#define PIXEL_WIDTH(w) ((w) / 8) 288#define PIXEL_HEIGHT(h) ((h) / 16) 289 290#ifndef VT_FB_DEFAULT_WIDTH 291#define VT_FB_DEFAULT_WIDTH 640 292#endif 293#ifndef VT_FB_DEFAULT_HEIGHT 294#define VT_FB_DEFAULT_HEIGHT 480 295#endif 296 297#define VT_CONSDEV_DECLARE(driver, width, height, softc) \ 298static struct terminal driver ## _consterm; \ 299static struct vt_window driver ## _conswindow; \ 300static struct vt_device driver ## _consdev = { \ 301 .vd_driver = &driver, \ 302 .vd_softc = (softc), \ 303 .vd_flags = VDF_INVALID, \ 304 .vd_windows = { [VT_CONSWINDOW] = &driver ## _conswindow, }, \ 305 .vd_curwindow = &driver ## _conswindow, \ 306}; \ 307static term_char_t driver ## _constextbuf[(width) * \ 308 (VBF_DEFAULT_HISTORY_SIZE)]; \ 309static term_char_t *driver ## _constextbufrows[ \ 310 VBF_DEFAULT_HISTORY_SIZE]; \ 311static struct vt_window driver ## _conswindow = { \ 312 .vw_number = VT_CONSWINDOW, \ 313 .vw_flags = VWF_CONSOLE, \ 314 .vw_buf = { \ 315 .vb_buffer = driver ## _constextbuf, \ 316 .vb_rows = driver ## _constextbufrows, \ 317 .vb_history_size = VBF_DEFAULT_HISTORY_SIZE, \ 318 .vb_curroffset = 0, \ 319 .vb_roffset = 0, \ 320 .vb_flags = VBF_STATIC, \ 321 .vb_mark_start = { \ 322 .tp_row = 0, \ 323 .tp_col = 0, \ 324 }, \ 325 .vb_mark_end = { \ 326 .tp_row = 0, \ 327 .tp_col = 0, \ 328 }, \ 329 .vb_scr_size = { \ 330 .tp_row = height, \ 331 .tp_col = width, \ 332 }, \ 333 }, \ 334 .vw_device = &driver ## _consdev, \ 335 .vw_terminal = &driver ## _consterm, \ 336 .vw_kbdmode = K_XLATE, \ 337}; \ 338TERMINAL_DECLARE_EARLY(driver ## _consterm, vt_termclass, \ 339 &driver ## _conswindow); \ 340SYSINIT(vt_early_cons, SI_SUB_INT_CONFIG_HOOKS, SI_ORDER_ANY, \ 341 vt_upgrade, &driver ## _consdev) 342 343/* 344 * Fonts. 345 * 346 * Remapping tables are used to map Unicode points to glyphs. They need 347 * to be sorted, because vtfont_lookup() performs a binary search. Each 348 * font has two remapping tables, for normal and bold. When a character 349 * is not present in bold, it uses a normal glyph. When no glyph is 350 * available, it uses glyph 0, which is normally equal to U+FFFD. 351 */ 352 353struct vt_font_map { 354 uint32_t vfm_src; 355 uint16_t vfm_dst; 356 uint16_t vfm_len; 357}; 358 359struct vt_font { 360 struct vt_font_map *vf_bold; 361 struct vt_font_map *vf_normal; 362 uint8_t *vf_bytes; 363 unsigned int vf_height, vf_width, 364 vf_normal_length, vf_bold_length; 365 unsigned int vf_refcount; 366}; 367 368struct mouse_cursor { 369 uint8_t map[64 * 64 / 8]; 370 uint8_t mask[64 * 64 / 8]; 371 uint8_t w; 372 uint8_t h; 373}; 374 375const uint8_t *vtfont_lookup(const struct vt_font *vf, term_char_t c); 376struct vt_font *vtfont_ref(struct vt_font *vf); 377void vtfont_unref(struct vt_font *vf); 378int vtfont_load(vfnt_t *f, struct vt_font **ret); 379 380/* Sysmouse. */ 381void sysmouse_process_event(mouse_info_t *mi); 382 383#endif /* !_DEV_VT_VT_H_ */ 384