vt.h revision 256527
1/*- 2 * Copyright (c) 2009 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 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * $FreeBSD: user/ed/newcons/sys/dev/vt/vt.h 256527 2013-10-15 12:28:24Z ray $ 30 */ 31 32#ifndef _DEV_VT_VT_H_ 33#define _DEV_VT_VT_H_ 34 35#include <sys/param.h> 36#include <sys/_lock.h> 37#include <sys/_mutex.h> 38#include <sys/callout.h> 39#include <sys/condvar.h> 40#include <sys/consio.h> 41#include <sys/kbio.h> 42#include <sys/terminal.h> 43#include <sys/sysctl.h> 44 45#define VT_MAXWINDOWS 12 46#define VT_CONSWINDOW 0 47 48#define SC_DRIVER_NAME "vt" 49#define DPRINTF(_l, ...) if (vt_debug > (_l)) printf( __VA_ARGS__ ) 50#define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG) 51 52#define VT_SYSCTL_INT(_name, _default, _descr) \ 53static int vt_##_name = _default; \ 54SYSCTL_INT(_kern_vt, OID_AUTO, _name, CTLFLAG_RW, &vt_##_name, _default,\ 55 _descr); \ 56TUNABLE_INT("kern.vt." #_name, &vt_##_name); 57 58struct vt_driver; 59 60void vt_allocate(struct vt_driver *, void *); 61 62typedef unsigned int vt_axis_t; 63 64/* 65 * List of locks 66 * (d) locked by vd_lock 67 * (b) locked by vb_lock 68 * (G) locked by Giant 69 * (u) unlocked, locked by higher levels 70 * (c) const until freeing 71 * (?) yet to be determined 72 */ 73 74/* 75 * Per-device datastructure. 76 */ 77 78struct vt_device { 79 struct vt_window *vd_windows[VT_MAXWINDOWS]; /* (c) Windows. */ 80 struct vt_window *vd_curwindow; /* (d) Current window. */ 81 const struct vt_driver *vd_driver; /* (c) Graphics driver. */ 82 void *vd_softc; /* (u) Driver data. */ 83 vt_axis_t vd_width; /* (?) Screen width. */ 84 vt_axis_t vd_height; /* (?) Screen height. */ 85 struct mtx vd_lock; /* Per-device lock. */ 86 struct cv vd_winswitch; /* (d) Window switch notify. */ 87 struct callout vd_timer; /* (d) Display timer. */ 88 int vd_flags; /* (d) Device flags. */ 89#define VDF_TEXTMODE 0x01 /* Do text mode rendering. */ 90#define VDF_SPLASH 0x02 /* Splash screen active. */ 91#define VDF_ASYNC 0x04 /* vt_timer() running. */ 92#define VDF_INVALID 0x08 /* Entire screen should be re-rendered. */ 93#define VDF_DEAD 0x10 /* Early probing found nothing. */ 94#define VDF_INITIALIZED 0x20 /* vtterm_cnprobe already done. */ 95 int vd_keyboard; /* (G) Keyboard index. */ 96 unsigned int vd_unit; /* (c) Device unit. */ 97}; 98 99/* 100 * Per-window terminal screen buffer. 101 * 102 * Because redrawing is performed asynchronously, the buffer keeps track 103 * of a rectangle that needs to be redrawn (vb_dirtyrect). Because this 104 * approach seemed to cause suboptimal performance (when the top left 105 * and the bottom right of the screen are modified), it also uses a set 106 * of bitmasks to keep track of the rows and columns (mod 64) that have 107 * been modified. 108 */ 109 110struct vt_bufmask { 111 uint64_t vbm_row, vbm_col; 112#define VBM_DIRTY UINT64_MAX 113}; 114 115struct vt_buf { 116 struct mtx vb_lock; /* Buffer lock. */ 117 term_pos_t vb_scr_size; /* (b) Screen dimensions. */ 118 int vb_flags; /* (b) Flags. */ 119#define VBF_CURSOR 0x1 /* Cursor visible. */ 120#define VBF_STATIC 0x2 /* Buffer is statically allocated. */ 121#define VBF_MTX_INIT 0x4 /* Mutex initialized. */ 122#define VBF_SCROLL 0x8 /* scroll locked mode. */ 123 int vb_history_size; 124#define VBF_DEFAULT_HISTORY_SIZE 200 125 int vb_roffset; /* (b) History rows offset. */ 126 int vb_curroffset; /* (b) Saved rows offset. */ 127 term_pos_t vb_cursor; /* (u) Cursor position. */ 128 term_rect_t vb_dirtyrect; /* (b) Dirty rectangle. */ 129 struct vt_bufmask vb_dirtymask; /* (b) Dirty bitmasks. */ 130 term_char_t *vb_buffer; /* (u) Data buffer. */ 131 term_char_t **vb_rows; /* (u) Array of rows */ 132}; 133 134void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *); 135void vtbuf_fill_locked(struct vt_buf *, const term_rect_t *, term_char_t); 136void vtbuf_init_early(struct vt_buf *); 137void vtbuf_init(struct vt_buf *, const term_pos_t *); 138void vtbuf_grow(struct vt_buf *, const term_pos_t *, int); 139void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t); 140void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *); 141void vtbuf_cursor_visibility(struct vt_buf *, int); 142void vtbuf_undirty(struct vt_buf *, term_rect_t *, struct vt_bufmask *); 143void vtbuf_sethistory_size(struct vt_buf *, int); 144 145#define VTBUF_SLCK_ENABLE(vb) (vb)->vb_flags |= VBF_SCROLL 146#define VTBUF_SLCK_DISABLE(vb) (vb)->vb_flags &= ~VBF_SCROLL 147 148#define VTBUF_MAX_HEIGHT(vb) \ 149 ((vb)->vb_history_size) 150#define VTBUF_GET_ROW(vb, r) \ 151 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)]) 152#define VTBUF_GET_FIELD(vb, r, c) \ 153 ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 154#define VTBUF_FIELD(vb, r, c) \ 155 ((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)]) 156#define VTBUF_ISCURSOR(vb, r, c) \ 157 ((vb)->vb_flags & VBF_CURSOR && \ 158 (vb)->vb_cursor.tp_row == (r) && (vb)->vb_cursor.tp_col == (c)) 159#define VTBUF_DIRTYROW(mask, row) \ 160 ((mask)->vbm_row & ((uint64_t)1 << ((row) % 64))) 161#define VTBUF_DIRTYCOL(mask, col) \ 162 ((mask)->vbm_col & ((uint64_t)1 << ((col) % 64))) 163#define VTBUF_SPACE_CHAR (' ' | TC_WHITE << 26 | TC_BLACK << 29) 164 165#define VHS_SET 0 166#define VHS_CUR 1 167#define VHS_END 2 168int vthistory_seek(struct vt_buf *, int offset, int whence); 169void vthistory_addlines(struct vt_buf *vb, int offset); 170void vthistory_getpos(const struct vt_buf *, unsigned int *offset); 171 172/* 173 * Per-window datastructure. 174 */ 175 176struct vt_window { 177 struct vt_device *vw_device; /* (c) Device. */ 178 struct terminal *vw_terminal; /* (c) Terminal. */ 179 struct vt_buf vw_buf; /* (u) Screen buffer. */ 180 struct vt_font *vw_font; /* (d) Graphical font. */ 181 unsigned int vw_number; /* (c) Window number. */ 182 int vw_kbdmode; /* (?) Keyboard mode. */ 183 unsigned int vw_flags; /* (d) Per-window flags. */ 184#define VWF_BUSY 0x1 /* Busy reconfiguring device. */ 185#define VWF_OPENED 0x2 /* TTY in use. */ 186#define VWF_SCROLL 0x4 /* Keys influence scrollback. */ 187#define VWF_CONSOLE 0x8 /* Kernel message console window. */ 188#define VWF_VTYLOCK 0x10 /* Prevent window switch. */ 189#define VWF_SWWAIT_REL 0x10000 /* Program wait for VT acquire is done. */ 190#define VWF_SWWAIT_ACQ 0x20000 /* Program wait for VT release is done. */ 191 pid_t vw_pid; /* Terminal holding process */ 192 struct proc *vw_proc; 193 struct vt_mode vw_smode; /* switch mode */ 194 struct callout vw_proc_dead_timer; 195 struct vt_window *vw_switch_to; 196}; 197 198#define VT_AUTO 0 /* switching is automatic */ 199#define VT_PROCESS 1 /* switching controlled by prog */ 200#define VT_KERNEL 255 /* switching controlled in kernel */ 201 202#define IS_VT_PROC_MODE(vw) ((vw)->vw_smode.mode == VT_PROCESS) 203 204/* 205 * Per-device driver routines. 206 * 207 * vd_bitbltchr is used when the driver operates in graphics mode, while 208 * vd_putchar is used when the driver operates in text mode 209 * (VDF_TEXTMODE). 210 */ 211 212typedef int vd_init_t(struct vt_device *vd); 213typedef void vd_postswitch_t(struct vt_device *vd); 214typedef void vd_blank_t(struct vt_device *vd, term_color_t color); 215typedef void vd_bitbltchr_t(struct vt_device *vd, const uint8_t *src, 216 vt_axis_t top, vt_axis_t left, unsigned int width, unsigned int height, 217 term_color_t fg, term_color_t bg); 218typedef void vd_putchar_t(struct vt_device *vd, term_char_t, 219 vt_axis_t top, vt_axis_t left, term_color_t fg, term_color_t bg); 220 221struct vt_driver { 222 /* Console attachment. */ 223 vd_init_t *vd_init; 224 225 /* Drawing. */ 226 vd_blank_t *vd_blank; 227 vd_bitbltchr_t *vd_bitbltchr; 228 229 /* Text mode operation. */ 230 vd_putchar_t *vd_putchar; 231 232 /* Update display setting on vt switch. */ 233 vd_postswitch_t *vd_postswitch; 234 235 /* Priority to know which one can override */ 236 int vd_priority; 237#define VD_PRIORITY_DUMB 10000 238#define VD_PRIORITY_GENERIC 1000 239#define VD_PRIORITY_SPECIFIC 100 240}; 241 242/* 243 * Console device madness. 244 * 245 * Utility macro to make early vt(4) instances work. 246 */ 247 248extern const struct terminal_class vt_termclass; 249void vt_upgrade(struct vt_device *vd); 250 251#define PIXEL_WIDTH(w) ((w) / 8) 252#define PIXEL_HEIGHT(h) ((h) / 16) 253 254#define VT_CONSDEV_DECLARE(driver, width, height, softc) \ 255static struct terminal driver ## _consterm; \ 256static struct vt_window driver ## _conswindow; \ 257static struct vt_device driver ## _consdev = { \ 258 .vd_driver = &driver, \ 259 .vd_softc = (softc), \ 260 .vd_flags = VDF_INVALID, \ 261 .vd_windows = { [VT_CONSWINDOW] = &driver ## _conswindow, }, \ 262 .vd_curwindow = &driver ## _conswindow, \ 263}; \ 264static term_char_t driver ## _constextbuf[(width) * \ 265 (VBF_DEFAULT_HISTORY_SIZE)]; \ 266static term_char_t *driver ## _constextbufrows[ \ 267 VBF_DEFAULT_HISTORY_SIZE]; \ 268static struct vt_window driver ## _conswindow = { \ 269 .vw_number = VT_CONSWINDOW, \ 270 .vw_flags = VWF_CONSOLE, \ 271 .vw_buf = { \ 272 .vb_buffer = driver ## _constextbuf, \ 273 .vb_rows = driver ## _constextbufrows, \ 274 .vb_history_size = VBF_DEFAULT_HISTORY_SIZE, \ 275 .vb_curroffset = 0, \ 276 .vb_roffset = 0, \ 277 .vb_flags = VBF_STATIC, \ 278 .vb_scr_size = { \ 279 .tp_row = height, \ 280 .tp_col = width, \ 281 }, \ 282 }, \ 283 .vw_device = &driver ## _consdev, \ 284 .vw_terminal = &driver ## _consterm, \ 285 .vw_kbdmode = K_XLATE, \ 286}; \ 287TERMINAL_DECLARE_EARLY(driver ## _consterm, vt_termclass, \ 288 &driver ## _conswindow); \ 289SYSINIT(vt_early_cons, SI_SUB_INT_CONFIG_HOOKS, SI_ORDER_ANY, \ 290 vt_upgrade, &driver ## _consdev) 291 292/* 293 * Fonts. 294 * 295 * Remapping tables are used to map Unicode points to glyphs. They need 296 * to be sorted, because vtfont_lookup() performs a binary search. Each 297 * font has two remapping tables, for normal and bold. When a character 298 * is not present in bold, it uses a normal glyph. When no glyph is 299 * available, it uses glyph 0, which is normally equal to U+FFFD. 300 */ 301 302struct vt_font_map { 303 uint32_t vfm_src; 304 uint16_t vfm_dst; 305 uint16_t vfm_len; 306}; 307 308struct vt_font { 309 struct vt_font_map *vf_bold; 310 struct vt_font_map *vf_normal; 311 uint8_t *vf_bytes; 312 unsigned int vf_height, vf_width, 313 vf_normal_length, vf_bold_length; 314 unsigned int vf_refcount; 315}; 316 317const uint8_t *vtfont_lookup(const struct vt_font *vf, term_char_t c); 318struct vt_font *vtfont_ref(struct vt_font *vf); 319void vtfont_unref(struct vt_font *vf); 320int vtfont_load(vfnt_t *f, struct vt_font **ret); 321 322/* Sysmouse. */ 323void sysmouse_process_event(mouse_info_t *mi); 324 325#endif /* !_DEV_VT_VT_H_ */ 326