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