sys/dev/vt/vt.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2009, 2013 The FreeBSD Foundation
   5  * All rights reserved.
   6  *
   7  * This software was developed by Ed Schouten under sponsorship from the
   8  * FreeBSD Foundation.
   9  *
  10  * Portions of this software were developed by Oleksandr Rybalko
  11  * under sponsorship from the FreeBSD Foundation.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $FreeBSD$
  35  */
  36
  37 #ifndef _DEV_VT_VT_H_
  38 #define _DEV_VT_VT_H_
  39
  40 #include <sys/param.h>
  41 #include <sys/_lock.h>
  42 #include <sys/_mutex.h>
  43 #include <sys/callout.h>
  44 #include <sys/condvar.h>
  45 #include <sys/conf.h>
  46 #include <sys/consio.h>
  47 #include <sys/kbio.h>
  48 #include <sys/mouse.h>
  49 #include <sys/terminal.h>
  50 #include <sys/sysctl.h>
  51 #include <sys/font.h>
  52
  53 #include "opt_syscons.h"
  54 #include "opt_splash.h"
  55
  56 #ifndef VT_MAXWINDOWS
  57 #ifdef  MAXCONS
  58 #define VT_MAXWINDOWS   MAXCONS
  59 #else
  60 #define VT_MAXWINDOWS   12
  61 #endif
  62 #endif
  63
  64 #ifndef VT_ALT_TO_ESC_HACK
  65 #define VT_ALT_TO_ESC_HACK      1
  66 #endif
  67
  68 #define VT_CONSWINDOW   0
  69
  70 #if defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE)
  71 #define VT_MOUSE_PASTEBUTTON    MOUSE_BUTTON3DOWN       /* right button */
  72 #define VT_MOUSE_EXTENDBUTTON   MOUSE_BUTTON2DOWN       /* not really used */
  73 #else
  74 #define VT_MOUSE_PASTEBUTTON    MOUSE_BUTTON2DOWN       /* middle button */
  75 #define VT_MOUSE_EXTENDBUTTON   MOUSE_BUTTON3DOWN       /* right button */
  76 #endif /* defined(SC_TWOBUTTON_MOUSE) || defined(VT_TWOBUTTON_MOUSE) */
  77
  78 #define SC_DRIVER_NAME  "vt"
  79 #ifdef VT_DEBUG
  80 #define DPRINTF(_l, ...)        if (vt_debug > (_l)) printf( __VA_ARGS__ )
  81 #define VT_CONSOLECTL_DEBUG
  82 #define VT_SYSMOUSE_DEBUG
  83 #else
  84 #define DPRINTF(_l, ...)        do {} while (0)
  85 #endif
  86 #define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG)
  87
  88 #define VT_SYSCTL_INT(_name, _default, _descr)                          \
  89 int vt_##_name = (_default);                                            \
  90 SYSCTL_INT(_kern_vt, OID_AUTO, _name, CTLFLAG_RWTUN, &vt_##_name, 0, _descr)
  91
  92 struct vt_driver;
  93
  94 void vt_allocate(const struct vt_driver *, void *);
  95 void vt_deallocate(const struct vt_driver *, 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         const struct vt_driver  *vd_prev_driver;/* (?) Previous driver. */
 131         void                    *vd_prev_softc; /* (?) Previous driver data. */
 132         device_t                 vd_video_dev;  /* (?) Video adapter. */
 133 #ifndef SC_NO_CUTPASTE
 134         struct vt_mouse_cursor  *vd_mcursor;    /* (?) Cursor bitmap. */
 135         term_color_t             vd_mcursor_fg; /* (?) Cursor fg color. */
 136         term_color_t             vd_mcursor_bg; /* (?) Cursor bg color. */
 137         vt_axis_t                vd_mx_drawn;   /* (?) Mouse X and Y      */
 138         vt_axis_t                vd_my_drawn;   /*     as of last redraw. */
 139         int                      vd_mshown;     /* (?) Mouse shown during */
 140 #endif                                          /*     last redrawn.      */
 141         uint16_t                 vd_mx;         /* (?) Current mouse X. */
 142         uint16_t                 vd_my;         /* (?) current mouse Y. */
 143         uint32_t                 vd_mstate;     /* (?) Mouse state. */
 144         vt_axis_t                vd_width;      /* (?) Screen width. */
 145         vt_axis_t                vd_height;     /* (?) Screen height. */
 146         size_t                   vd_transpose;  /* (?) Screen offset in FB */
 147         struct mtx               vd_lock;       /* Per-device lock. */
 148         struct cv                vd_winswitch;  /* (d) Window switch notify. */
 149         struct callout           vd_timer;      /* (d) Display timer. */
 150         volatile unsigned int    vd_timer_armed;/* (?) Display timer started.*/
 151         int                      vd_flags;      /* (d) Device flags. */
 152 #define VDF_TEXTMODE    0x01    /* Do text mode rendering. */
 153 #define VDF_SPLASH      0x02    /* Splash screen active. */
 154 #define VDF_ASYNC       0x04    /* vt_timer() running. */
 155 #define VDF_INVALID     0x08    /* Entire screen should be re-rendered. */
 156 #define VDF_DEAD        0x10    /* Early probing found nothing. */
 157 #define VDF_INITIALIZED 0x20    /* vtterm_cnprobe already done. */
 158 #define VDF_MOUSECURSOR 0x40    /* Mouse cursor visible. */
 159 #define VDF_QUIET_BELL  0x80    /* Disable bell. */
 160 #define VDF_SUSPENDED   0x100   /* Device has been suspended. */
 161 #define VDF_DOWNGRADE   0x8000  /* The driver is being downgraded. */
 162         struct keyboard         *vd_keyboard;   /* (G) Keyboard. */
 163         unsigned int             vd_kbstate;    /* (?) Device unit. */
 164         unsigned int             vd_unit;       /* (c) Device unit. */
 165         int                      vd_altbrk;     /* (?) Alt break seq. state */
 166         term_char_t             *vd_drawn;      /* (?) Most recent char drawn. */
 167         term_color_t            *vd_drawnfg;    /* (?) Most recent fg color drawn. */
 168         term_color_t            *vd_drawnbg;    /* (?) Most recent bg color drawn. */
 169 };
 170
 171 #define VD_PASTEBUF(vd) ((vd)->vd_pastebuf.vpb_buf)
 172 #define VD_PASTEBUFSZ(vd)       ((vd)->vd_pastebuf.vpb_bufsz)
 173 #define VD_PASTEBUFLEN(vd)      ((vd)->vd_pastebuf.vpb_len)
 174
 175 #define VT_LOCK(vd)     mtx_lock(&(vd)->vd_lock)
 176 #define VT_UNLOCK(vd)   mtx_unlock(&(vd)->vd_lock)
 177 #define VT_LOCK_ASSERT(vd, what)        mtx_assert(&(vd)->vd_lock, what)
 178
 179 void vt_resume(struct vt_device *vd);
 180 void vt_resume_flush_timer(struct vt_window *vw, int ms);
 181 void vt_suspend(struct vt_device *vd);
 182
 183 /*
 184  * Per-window terminal screen buffer.
 185  *
 186  * Because redrawing is performed asynchronously, the buffer keeps track
 187  * of a rectangle that needs to be redrawn (vb_dirtyrect).  Because this
 188  * approach seemed to cause suboptimal performance (when the top left
 189  * and the bottom right of the screen are modified), it also uses a set
 190  * of bitmasks to keep track of the rows and columns (mod 64) that have
 191  * been modified.
 192  */
 193
 194 struct vt_buf {
 195         struct mtx               vb_lock;       /* Buffer lock. */
 196         struct terminal         *vb_terminal;
 197         term_pos_t               vb_scr_size;   /* (b) Screen dimensions. */
 198         int                      vb_flags;      /* (b) Flags. */
 199 #define VBF_CURSOR      0x1     /* Cursor visible. */
 200 #define VBF_STATIC      0x2     /* Buffer is statically allocated. */
 201 #define VBF_MTX_INIT    0x4     /* Mutex initialized. */
 202 #define VBF_SCROLL      0x8     /* scroll locked mode. */
 203 #define VBF_HISTORY_FULL 0x10   /* All rows filled. */
 204         unsigned int             vb_history_size;
 205         unsigned int             vb_roffset;    /* (b) History rows offset. */
 206         unsigned int             vb_curroffset; /* (b) Saved rows offset. */
 207         term_pos_t               vb_cursor;     /* (u) Cursor position. */
 208         term_pos_t               vb_mark_start; /* (b) Copy region start. */
 209         term_pos_t               vb_mark_end;   /* (b) Copy region end. */
 210         int                      vb_mark_last;  /* Last mouse event. */
 211         term_rect_t              vb_dirtyrect;  /* (b) Dirty rectangle. */
 212         term_char_t             *vb_buffer;     /* (u) Data buffer. */
 213         term_char_t             **vb_rows;      /* (u) Array of rows */
 214 };
 215
 216 #ifdef SC_HISTORY_SIZE
 217 #define VBF_DEFAULT_HISTORY_SIZE        SC_HISTORY_SIZE
 218 #else
 219 #define VBF_DEFAULT_HISTORY_SIZE        500
 220 #endif
 221
 222 void vtbuf_lock(struct vt_buf *);
 223 void vtbuf_unlock(struct vt_buf *);
 224 void vtbuf_copy(struct vt_buf *, const term_rect_t *, const term_pos_t *);
 225 void vtbuf_fill(struct vt_buf *, const term_rect_t *, term_char_t);
 226 void vtbuf_init_early(struct vt_buf *);
 227 void vtbuf_init(struct vt_buf *, const term_pos_t *);
 228 void vtbuf_grow(struct vt_buf *, const term_pos_t *, unsigned int);
 229 void vtbuf_putchar(struct vt_buf *, const term_pos_t *, term_char_t);
 230 void vtbuf_cursor_position(struct vt_buf *, const term_pos_t *);
 231 void vtbuf_scroll_mode(struct vt_buf *vb, int yes);
 232 void vtbuf_dirty(struct vt_buf *vb, const term_rect_t *area);
 233 void vtbuf_undirty(struct vt_buf *, term_rect_t *);
 234 void vtbuf_sethistory_size(struct vt_buf *, unsigned int);
 235 void vtbuf_clearhistory(struct vt_buf *);
 236 int vtbuf_iscursor(const struct vt_buf *vb, int row, int col);
 237 void vtbuf_cursor_visibility(struct vt_buf *, int);
 238 #ifndef SC_NO_CUTPASTE
 239 int vtbuf_set_mark(struct vt_buf *vb, int type, int col, int row);
 240 int vtbuf_get_marked_len(struct vt_buf *vb);
 241 void vtbuf_extract_marked(struct vt_buf *vb, term_char_t *buf, int sz);
 242 #endif
 243
 244 #define VTB_MARK_NONE           0
 245 #define VTB_MARK_END            1
 246 #define VTB_MARK_START          2
 247 #define VTB_MARK_WORD           3
 248 #define VTB_MARK_ROW            4
 249 #define VTB_MARK_EXTEND         5
 250 #define VTB_MARK_MOVE           6
 251
 252 #define VTBUF_SLCK_ENABLE(vb)   vtbuf_scroll_mode((vb), 1)
 253 #define VTBUF_SLCK_DISABLE(vb)  vtbuf_scroll_mode((vb), 0)
 254
 255 #define VTBUF_MAX_HEIGHT(vb) \
 256         ((vb)->vb_history_size)
 257 #define VTBUF_GET_ROW(vb, r) \
 258         ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)])
 259 #define VTBUF_GET_FIELD(vb, r, c) \
 260         ((vb)->vb_rows[((vb)->vb_roffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
 261 #define VTBUF_FIELD(vb, r, c) \
 262         ((vb)->vb_rows[((vb)->vb_curroffset + (r)) % VTBUF_MAX_HEIGHT(vb)][(c)])
 263 #define VTBUF_ISCURSOR(vb, r, c) \
 264         vtbuf_iscursor((vb), (r), (c))
 265 #define VTBUF_DIRTYROW(mask, row) \
 266         ((mask)->vbm_row & ((uint64_t)1 << ((row) % 64)))
 267 #define VTBUF_DIRTYCOL(mask, col) \
 268         ((mask)->vbm_col & ((uint64_t)1 << ((col) % 64)))
 269 #define VTBUF_SPACE_CHAR(attr)  (' ' | (attr))
 270
 271 #define VHS_SET 0
 272 #define VHS_CUR 1
 273 #define VHS_END 2
 274 int vthistory_seek(struct vt_buf *, int offset, int whence);
 275 void vthistory_addlines(struct vt_buf *vb, int offset);
 276 void vthistory_getpos(const struct vt_buf *, unsigned int *offset);
 277
 278 /*
 279  * Per-window datastructure.
 280  */
 281
 282 struct vt_window {
 283         struct vt_device        *vw_device;     /* (c) Device. */
 284         struct terminal         *vw_terminal;   /* (c) Terminal. */
 285         struct vt_buf            vw_buf;        /* (u) Screen buffer. */
 286         struct vt_font          *vw_font;       /* (d) Graphical font. */
 287         term_rect_t              vw_draw_area;  /* (?) Drawable area. */
 288         unsigned int             vw_number;     /* (c) Window number. */
 289         int                      vw_kbdmode;    /* (?) Keyboard mode. */
 290         int                      vw_prev_kbdmode;/* (?) Previous mode. */
 291         int                      vw_kbdstate;   /* (?) Keyboard state. */
 292         int                      vw_grabbed;    /* (?) Grab count. */
 293         char                    *vw_kbdsq;      /* Escape sequence queue*/
 294         unsigned int             vw_flags;      /* (d) Per-window flags. */
 295         int                      vw_mouse_level;/* Mouse op mode. */
 296 #define VWF_BUSY        0x1     /* Busy reconfiguring device. */
 297 #define VWF_OPENED      0x2     /* TTY in use. */
 298 #define VWF_SCROLL      0x4     /* Keys influence scrollback. */
 299 #define VWF_CONSOLE     0x8     /* Kernel message console window. */
 300 #define VWF_VTYLOCK     0x10    /* Prevent window switch. */
 301 #define VWF_MOUSE_HIDE  0x20    /* Disable mouse events processing. */
 302 #define VWF_READY       0x40    /* Window fully initialized. */
 303 #define VWF_GRAPHICS    0x80    /* Window in graphics mode (KDSETMODE). */
 304 #define VWF_SWWAIT_REL  0x10000 /* Program wait for VT acquire is done. */
 305 #define VWF_SWWAIT_ACQ  0x20000 /* Program wait for VT release is done. */
 306         pid_t                    vw_pid;        /* Terminal holding process */
 307         struct proc             *vw_proc;
 308         struct vt_mode           vw_smode;      /* switch mode */
 309         struct callout           vw_proc_dead_timer;
 310         struct vt_window        *vw_switch_to;
 311 };
 312
 313 #define VT_AUTO         0               /* switching is automatic */
 314 #define VT_PROCESS      1               /* switching controlled by prog */
 315 #define VT_KERNEL       255             /* switching controlled in kernel */
 316
 317 #define IS_VT_PROC_MODE(vw)     ((vw)->vw_smode.mode == VT_PROCESS)
 318
 319 /*
 320  * Per-device driver routines.
 321  */
 322
 323 typedef int vd_init_t(struct vt_device *vd);
 324 typedef int vd_probe_t(struct vt_device *vd);
 325 typedef void vd_fini_t(struct vt_device *vd, void *softc);
 326 typedef void vd_postswitch_t(struct vt_device *vd);
 327 typedef void vd_blank_t(struct vt_device *vd, term_color_t color);
 328 typedef void vd_bitblt_text_t(struct vt_device *vd, const struct vt_window *vw,
 329     const term_rect_t *area);
 330 typedef void vd_invalidate_text_t(struct vt_device *vd,
 331     const term_rect_t *area);
 332 typedef void vd_bitblt_bmp_t(struct vt_device *vd, const struct vt_window *vw,
 333     const uint8_t *pattern, const uint8_t *mask,
 334     unsigned int width, unsigned int height,
 335     unsigned int x, unsigned int y, term_color_t fg, term_color_t bg);
 336 typedef int vd_fb_ioctl_t(struct vt_device *, u_long, caddr_t, struct thread *);
 337 typedef int vd_fb_mmap_t(struct vt_device *, vm_ooffset_t, vm_paddr_t *, int,
 338     vm_memattr_t *);
 339 typedef void vd_drawrect_t(struct vt_device *, int, int, int, int, int,
 340     term_color_t);
 341 typedef void vd_setpixel_t(struct vt_device *, int, int, term_color_t);
 342 typedef void vd_suspend_t(struct vt_device *);
 343 typedef void vd_resume_t(struct vt_device *);
 344
 345 struct vt_driver {
 346         char             vd_name[16];
 347         /* Console attachment. */
 348         vd_probe_t      *vd_probe;
 349         vd_init_t       *vd_init;
 350         vd_fini_t       *vd_fini;
 351
 352         /* Drawing. */
 353         vd_blank_t      *vd_blank;
 354         vd_drawrect_t   *vd_drawrect;
 355         vd_setpixel_t   *vd_setpixel;
 356         vd_bitblt_text_t *vd_bitblt_text;
 357         vd_invalidate_text_t *vd_invalidate_text;
 358         vd_bitblt_bmp_t *vd_bitblt_bmp;
 359
 360         /* Framebuffer ioctls, if present. */
 361         vd_fb_ioctl_t   *vd_fb_ioctl;
 362
 363         /* Framebuffer mmap, if present. */
 364         vd_fb_mmap_t    *vd_fb_mmap;
 365
 366         /* Update display setting on vt switch. */
 367         vd_postswitch_t *vd_postswitch;
 368
 369         /* Suspend/resume handlers. */
 370         vd_suspend_t    *vd_suspend;
 371         vd_resume_t     *vd_resume;
 372
 373         /* Priority to know which one can override */
 374         int             vd_priority;
 375 #define VD_PRIORITY_DUMB        10
 376 #define VD_PRIORITY_GENERIC     100
 377 #define VD_PRIORITY_SPECIFIC    1000
 378 };
 379
 380 /*
 381  * Console device madness.
 382  *
 383  * Utility macro to make early vt(4) instances work.
 384  */
 385
 386 extern struct vt_device vt_consdev;
 387 extern struct terminal vt_consterm;
 388 extern const struct terminal_class vt_termclass;
 389 void vt_upgrade(struct vt_device *vd);
 390
 391 #define PIXEL_WIDTH(w)  ((w) / 8)
 392 #define PIXEL_HEIGHT(h) ((h) / 16)
 393
 394 #ifndef VT_FB_MAX_WIDTH
 395 #define VT_FB_MAX_WIDTH 4096
 396 #endif
 397 #ifndef VT_FB_MAX_HEIGHT
 398 #define VT_FB_MAX_HEIGHT        2400
 399 #endif
 400
 401 /* name argument is not used yet. */
 402 #define VT_DRIVER_DECLARE(name, drv) DATA_SET(vt_drv_set, drv)
 403
 404 #ifndef SC_NO_CUTPASTE
 405 struct vt_mouse_cursor {
 406         uint8_t map[64 * 64 / 8];
 407         uint8_t mask[64 * 64 / 8];
 408         uint8_t width;
 409         uint8_t height;
 410 };
 411 #endif
 412
 413 const uint8_t   *vtfont_lookup(const struct vt_font *vf, term_char_t c);
 414 struct vt_font  *vtfont_ref(struct vt_font *vf);
 415 void             vtfont_unref(struct vt_font *vf);
 416 int              vtfont_load(vfnt_t *f, struct vt_font **ret);
 417
 418 /* Sysmouse. */
 419 void sysmouse_process_event(mouse_info_t *mi);
 420 #ifndef SC_NO_CUTPASTE
 421 void vt_mouse_event(int type, int x, int y, int event, int cnt, int mlevel);
 422 void vt_mouse_state(int show);
 423 #endif
 424 #define VT_MOUSE_SHOW 1
 425 #define VT_MOUSE_HIDE 0
 426
 427 /* Utilities. */
 428 void    vt_compute_drawable_area(struct vt_window *);
 429 void    vt_determine_colors(term_char_t c, int cursor,
 430             term_color_t *fg, term_color_t *bg);
 431 int     vt_is_cursor_in_area(const struct vt_device *vd,
 432             const term_rect_t *area);
 433 void    vt_termsize(struct vt_device *, struct vt_font *, term_pos_t *);
 434 void    vt_winsize(struct vt_device *, struct vt_font *, struct winsize *);
 435
 436 /* Logos-on-boot. */
 437 #define VT_LOGOS_DRAW_BEASTIE           0
 438 #define VT_LOGOS_DRAW_ALT_BEASTIE       1
 439 #define VT_LOGOS_DRAW_ORB               2
 440
 441 extern int vt_draw_logo_cpus;
 442 extern int vt_splash_cpu;
 443 extern int vt_splash_ncpu;
 444 extern int vt_splash_cpu_style;
 445 extern int vt_splash_cpu_duration;
 446
 447 extern const unsigned int vt_logo_sprite_height;
 448 extern const unsigned int vt_logo_sprite_width;
 449
 450 void vtterm_draw_cpu_logos(struct vt_device *);
 451
 452 #endif /* !_DEV_VT_VT_H_ */
 453