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