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