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