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