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