sys/dev/vt/vt.h

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