sys/dev/syscons/syscons.h

   1 /*-
   2  * Copyright (c) 1995-1998 Søren Schmidt
   3  * All rights reserved.
   4  *
   5  * This code is derived from software contributed to The DragonFly Project
   6  * by Sascha Wildner <saw@online.de>
   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  *    without modification, immediately at the beginning of the file.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. The name of the author may not be used to endorse or promote products
  18  *    derived from this software without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  23  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  25  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  *
  31  * $FreeBSD$
  32  */
  33
  34 #ifndef _DEV_SYSCONS_SYSCONS_H_
  35 #define _DEV_SYSCONS_SYSCONS_H_
  36
  37 #include <sys/lock.h>
  38 #include <sys/mutex.h>
  39
  40 /* machine-dependent part of the header */
  41
  42 #ifdef PC98
  43 #include <pc98/cbus/sc_machdep.h>
  44 #elif defined(__i386__)
  45 /* nothing for the moment */
  46 #endif
  47
  48 /* default values for configuration options */
  49
  50 #ifndef MAXCONS
  51 #define MAXCONS         16
  52 #endif
  53
  54 #ifdef SC_NO_SYSMOUSE
  55 #undef SC_NO_CUTPASTE
  56 #define SC_NO_CUTPASTE  1
  57 #endif
  58
  59 #ifdef SC_NO_MODE_CHANGE
  60 #undef SC_PIXEL_MODE
  61 #endif
  62
  63 /* Always load font data if the pixel (raster text) mode is to be used. */
  64 #ifdef SC_PIXEL_MODE
  65 #undef SC_NO_FONT_LOADING
  66 #endif
  67
  68 /*
  69  * If font data is not available, the `arrow'-shaped mouse cursor cannot
  70  * be drawn.  Use the alternative drawing method.
  71  */
  72 #ifdef SC_NO_FONT_LOADING
  73 #undef SC_ALT_MOUSE_IMAGE
  74 #define SC_ALT_MOUSE_IMAGE 1
  75 #endif
  76
  77 #ifndef SC_CURSOR_CHAR
  78 #define SC_CURSOR_CHAR  (0x07)
  79 #endif
  80
  81 #ifndef SC_MOUSE_CHAR
  82 #define SC_MOUSE_CHAR   (0xd0)
  83 #endif
  84
  85 #if SC_MOUSE_CHAR <= SC_CURSOR_CHAR && SC_CURSOR_CHAR < (SC_MOUSE_CHAR + 4)
  86 #undef SC_CURSOR_CHAR
  87 #define SC_CURSOR_CHAR  (SC_MOUSE_CHAR + 4)
  88 #endif
  89
  90 #ifndef SC_DEBUG_LEVEL
  91 #define SC_DEBUG_LEVEL  0
  92 #endif
  93
  94 #define DPRINTF(l, p)   if (SC_DEBUG_LEVEL >= (l)) printf p
  95
  96 #ifndef __sparc64__
  97 #define SC_DRIVER_NAME  "sc"
  98 #else
  99 /*
 100  * Use a different driver name on sparc64 so it does not get confused
 101  * with the system controller devices which are also termed 'sc' in OFW.
 102  */
 103 #define SC_DRIVER_NAME  "syscons"
 104 #endif
 105 #define SC_VTY(dev)     minor(dev)
 106 #define SC_DEV(sc, vty) ((sc)->dev[(vty) - (sc)->first_vty])
 107 #define SC_STAT(dev)    (*((scr_stat **)&(dev)->si_drv1))
 108
 109 /* printable chars */
 110 #ifndef PRINTABLE
 111 #define PRINTABLE(ch)   ((ch) > 0x1b || ((ch) > 0x0d && (ch) < 0x1b) \
 112                          || (ch) < 0x07)
 113 #endif
 114
 115 /* macros for "intelligent" screen update */
 116 #define mark_for_update(scp, x) {\
 117                                     if ((x) < scp->start) scp->start = (x);\
 118                                     else if ((x) > scp->end) scp->end = (x);\
 119                                 }
 120 #define mark_all(scp)           {\
 121                                     scp->start = 0;\
 122                                     scp->end = scp->xsize * scp->ysize - 1;\
 123                                 }
 124
 125 /* vty status flags (scp->status) */
 126 #define UNKNOWN_MODE    0x00010         /* unknown video mode */
 127 #define SWITCH_WAIT_REL 0x00080         /* waiting for vty release */
 128 #define SWITCH_WAIT_ACQ 0x00100         /* waiting for vty ack */
 129 #define BUFFER_SAVED    0x00200         /* vty buffer is saved */
 130 #define CURSOR_ENABLED  0x00400         /* text cursor is enabled */
 131 #define MOUSE_MOVED     0x01000         /* mouse cursor has moved */
 132 #define MOUSE_CUTTING   0x02000         /* mouse cursor is cutting text */
 133 #define MOUSE_VISIBLE   0x04000         /* mouse cursor is showing */
 134 #define GRAPHICS_MODE   0x08000         /* vty is in a graphics mode */
 135 #define PIXEL_MODE      0x10000         /* vty is in a raster text mode */
 136 #define SAVER_RUNNING   0x20000         /* screen saver is running */
 137 #define VR_CURSOR_BLINK 0x40000         /* blinking text cursor */
 138 #define VR_CURSOR_ON    0x80000         /* text cursor is on */
 139 #define MOUSE_HIDDEN    0x100000        /* mouse cursor is temporarily hidden */
 140
 141 /* misc defines */
 142 #define FALSE           0
 143 #define TRUE            1
 144
 145 /*
 146    The following #defines are hard-coded for a maximum text
 147    resolution corresponding to a maximum framebuffer
 148    resolution of 1600x1200 with an 8x8 font...
 149 */
 150 #define COL             200
 151 #define ROW             150
 152
 153 #define PCBURST         128
 154
 155 #ifndef BELL_DURATION
 156 #define BELL_DURATION   ((5 * hz + 99) / 100)
 157 #define BELL_PITCH      800
 158 #endif
 159
 160 /* virtual terminal buffer */
 161 typedef struct sc_vtb {
 162         int             vtb_flags;
 163 #define VTB_VALID       (1 << 0)
 164 #define VTB_ALLOCED     (1 << 1)
 165         int             vtb_type;
 166 #define VTB_INVALID     0
 167 #define VTB_MEMORY      1
 168 #define VTB_FRAMEBUFFER 2
 169 #define VTB_RINGBUFFER  3
 170         int             vtb_cols;
 171         int             vtb_rows;
 172         int             vtb_size;
 173         vm_offset_t     vtb_buffer;
 174         int             vtb_tail;       /* valid for VTB_RINGBUFFER only */
 175 } sc_vtb_t;
 176
 177 /* text cursor attributes */
 178 struct cursor_attr {
 179         int             flags;
 180         int             base;
 181         int             height;
 182 };
 183
 184 /* softc */
 185
 186 struct keyboard;
 187 struct video_adapter;
 188 struct scr_stat;
 189 struct tty;
 190
 191 typedef struct sc_softc {
 192         int             unit;                   /* unit # */
 193         int             config;                 /* configuration flags */
 194 #define SC_VESA800X600  (1 << 7)
 195 #define SC_AUTODETECT_KBD (1 << 8)
 196 #define SC_KERNEL_CONSOLE (1 << 9)
 197
 198         int             flags;                  /* status flags */
 199 #define SC_VISUAL_BELL  (1 << 0)
 200 #define SC_QUIET_BELL   (1 << 1)
 201 #if 0 /* not used anymore */
 202 #define SC_BLINK_CURSOR (1 << 2)
 203 #define SC_CHAR_CURSOR  (1 << 3)
 204 #endif
 205 #define SC_MOUSE_ENABLED (1 << 4)
 206 #define SC_SCRN_IDLE    (1 << 5)
 207 #define SC_SCRN_BLANKED (1 << 6)
 208 #define SC_SAVER_FAILED (1 << 7)
 209 #define SC_SCRN_VTYLOCK (1 << 8)
 210
 211 #define SC_INIT_DONE    (1 << 16)
 212 #define SC_SPLASH_SCRN  (1 << 17)
 213
 214         int             keyboard;               /* -1 if unavailable */
 215         struct keyboard *kbd;
 216
 217         int             adapter;
 218         struct video_adapter *adp;
 219         int             initial_mode;           /* initial video mode */
 220
 221         int             first_vty;
 222         int             vtys;
 223         struct cdev **dev;
 224         struct scr_stat *cur_scp;
 225         struct scr_stat *new_scp;
 226         struct scr_stat *old_scp;
 227         int             delayed_next_scr;
 228
 229         char            font_loading_in_progress;
 230         char            switch_in_progress;
 231         char            write_in_progress;
 232         char            blink_in_progress;
 233         struct mtx      video_mtx;
 234
 235         long            scrn_time_stamp;
 236
 237         struct cursor_attr dflt_curs_attr;
 238         struct cursor_attr curs_attr;
 239
 240         u_char          scr_map[256];
 241         u_char          scr_rmap[256];
 242
 243 #ifdef _SC_MD_SOFTC_DECLARED_
 244         sc_md_softc_t   md;                     /* machine dependent vars */
 245 #endif
 246
 247 #ifndef SC_NO_PALETTE_LOADING
 248         u_char          palette[256*3];
 249 #endif
 250
 251 #ifndef SC_NO_FONT_LOADING
 252         int             fonts_loaded;
 253 #define FONT_8          2
 254 #define FONT_14         4
 255 #define FONT_16         8
 256 #define FONT_22         8
 257         u_char          *font_8;
 258         u_char          *font_14;
 259         u_char          *font_16;
 260         u_char          *font_22;
 261 #endif
 262
 263         u_char          cursor_char;
 264         u_char          mouse_char;
 265
 266 } sc_softc_t;
 267
 268 /* virtual screen */
 269 typedef struct scr_stat {
 270         int             index;                  /* index of this vty */
 271         struct sc_softc *sc;                    /* pointer to softc */
 272         struct sc_rndr_sw *rndr;                /* renderer */
 273 #ifndef __sparc64__
 274         sc_vtb_t        scr;
 275 #endif
 276         sc_vtb_t        vtb;
 277
 278         int             xpos;                   /* current X position */
 279         int             ypos;                   /* current Y position */
 280         int             xsize;                  /* X text size */
 281         int             ysize;                  /* Y text size */
 282         int             xpixel;                 /* X graphics size */
 283         int             ypixel;                 /* Y graphics size */
 284         int             xoff;                   /* X offset in pixel mode */
 285         int             yoff;                   /* Y offset in pixel mode */
 286
 287         u_char          *font;                  /* current font */
 288         int             font_size;              /* fontsize in Y direction */
 289         int             font_width;             /* fontsize in X direction */
 290
 291         int             start;                  /* modified area start */
 292         int             end;                    /* modified area end */
 293
 294         struct sc_term_sw *tsw;
 295         void            *ts;
 296
 297         int             status;                 /* status (bitfield) */
 298         int             kbd_mode;               /* keyboard I/O mode */
 299
 300         int             cursor_pos;             /* cursor buffer position */
 301         int             cursor_oldpos;          /* cursor old buffer position */
 302         u_short         cursor_saveunder_char;  /* saved char under cursor */
 303         u_short         cursor_saveunder_attr;  /* saved attr under cursor */
 304         struct cursor_attr dflt_curs_attr;
 305         struct cursor_attr curr_curs_attr;
 306         struct cursor_attr curs_attr;
 307
 308         int             mouse_pos;              /* mouse buffer position */
 309         int             mouse_oldpos;           /* mouse old buffer position */
 310         short           mouse_xpos;             /* mouse x coordinate */
 311         short           mouse_ypos;             /* mouse y coordinate */
 312         short           mouse_oldxpos;          /* mouse previous x coordinate */
 313         short           mouse_oldypos;          /* mouse previous y coordinate */
 314         short           mouse_buttons;          /* mouse buttons */
 315         int             mouse_cut_start;        /* mouse cut start pos */
 316         int             mouse_cut_end;          /* mouse cut end pos */
 317         struct proc     *mouse_proc;            /* proc* of controlling proc */
 318         pid_t           mouse_pid;              /* pid of controlling proc */
 319         int             mouse_signal;           /* signal # to report with */
 320
 321         u_short         bell_duration;
 322         u_short         bell_pitch;
 323
 324         u_char          border;                 /* border color */
 325         int             mode;                   /* mode */
 326         pid_t           pid;                    /* pid of controlling proc */
 327         struct proc     *proc;                  /* proc* of controlling proc */
 328         struct vt_mode  smode;                  /* switch mode */
 329
 330         sc_vtb_t        *history;               /* circular history buffer */
 331         int             history_pos;            /* position shown on screen */
 332         int             history_size;           /* size of history buffer */
 333
 334         int             splash_save_mode;       /* saved mode for splash screen */
 335         int             splash_save_status;     /* saved status for splash screen */
 336         struct mtx      scr_lock;               /* mutex for sc_puts() */
 337 #ifdef _SCR_MD_STAT_DECLARED_
 338         scr_md_stat_t   md;                     /* machine dependent vars */
 339 #endif
 340 } scr_stat;
 341
 342 #ifndef SC_NORM_ATTR
 343 #define SC_NORM_ATTR            (FG_LIGHTGREY | BG_BLACK)
 344 #endif
 345 #ifndef SC_NORM_REV_ATTR
 346 #define SC_NORM_REV_ATTR        (FG_BLACK | BG_LIGHTGREY)
 347 #endif
 348 #ifndef SC_KERNEL_CONS_ATTR
 349 #define SC_KERNEL_CONS_ATTR     (FG_WHITE | BG_BLACK)
 350 #endif
 351 #ifndef SC_KERNEL_CONS_REV_ATTR
 352 #define SC_KERNEL_CONS_REV_ATTR (FG_BLACK | BG_LIGHTGREY)
 353 #endif
 354
 355 /* terminal emulator */
 356
 357 #ifndef SC_DFLT_TERM
 358 #define SC_DFLT_TERM    "*"                     /* any */
 359 #endif
 360
 361 typedef int     sc_term_init_t(scr_stat *scp, void **tcp, int code);
 362 #define SC_TE_COLD_INIT 0
 363 #define SC_TE_WARM_INIT 1
 364 typedef int     sc_term_term_t(scr_stat *scp, void **tcp);
 365 typedef void    sc_term_puts_t(scr_stat *scp, u_char *buf, int len);
 366 typedef int     sc_term_ioctl_t(scr_stat *scp, struct tty *tp, u_long cmd,
 367                                 caddr_t data, int flag, struct thread *td);
 368 typedef int     sc_term_reset_t(scr_stat *scp, int code);
 369 #define SC_TE_HARD_RESET 0
 370 #define SC_TE_SOFT_RESET 1
 371 typedef void    sc_term_default_attr_t(scr_stat *scp, int norm, int rev);
 372 typedef void    sc_term_clear_t(scr_stat *scp);
 373 typedef void    sc_term_notify_t(scr_stat *scp, int event);
 374 #define SC_TE_NOTIFY_VTSWITCH_IN        0
 375 #define SC_TE_NOTIFY_VTSWITCH_OUT       1
 376 typedef int     sc_term_input_t(scr_stat *scp, int c, struct tty *tp);
 377
 378 typedef struct sc_term_sw {
 379         LIST_ENTRY(sc_term_sw)  link;
 380         char                    *te_name;       /* name of the emulator */
 381         char                    *te_desc;       /* description */
 382         char                    *te_renderer;   /* matching renderer */
 383         size_t                  te_size;        /* size of internal buffer */
 384         int                     te_refcount;    /* reference counter */
 385         sc_term_init_t          *te_init;
 386         sc_term_term_t          *te_term;
 387         sc_term_puts_t          *te_puts;
 388         sc_term_ioctl_t         *te_ioctl;
 389         sc_term_reset_t         *te_reset;
 390         sc_term_default_attr_t  *te_default_attr;
 391         sc_term_clear_t         *te_clear;
 392         sc_term_notify_t        *te_notify;
 393         sc_term_input_t         *te_input;
 394 } sc_term_sw_t;
 395
 396 #define SCTERM_MODULE(name, sw)                                 \
 397         DATA_SET(scterm_set, sw);                               \
 398         static int                                              \
 399         scterm_##name##_event(module_t mod, int type, void *data) \
 400         {                                                       \
 401                 switch (type) {                                 \
 402                 case MOD_LOAD:                                  \
 403                         return sc_term_add(&sw);                \
 404                 case MOD_UNLOAD:                                \
 405                         if (sw.te_refcount > 0)                 \
 406                                 return EBUSY;                   \
 407                         return sc_term_remove(&sw);             \
 408                 default:                                        \
 409                         return EOPNOTSUPP;                      \
 410                         break;                                  \
 411                 }                                               \
 412                 return 0;                                       \
 413         }                                                       \
 414         static moduledata_t scterm_##name##_mod = {             \
 415                 "scterm-" #name,                                \
 416                 scterm_##name##_event,                          \
 417                 NULL,                                           \
 418         };                                                      \
 419         DECLARE_MODULE(scterm_##name, scterm_##name##_mod,      \
 420                        SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
 421
 422 /* renderer function table */
 423 typedef void    vr_init_t(scr_stat *scp);
 424 typedef void    vr_clear_t(scr_stat *scp, int c, int attr);
 425 typedef void    vr_draw_border_t(scr_stat *scp, int color);
 426 typedef void    vr_draw_t(scr_stat *scp, int from, int count, int flip);
 427 typedef void    vr_set_cursor_t(scr_stat *scp, int base, int height, int blink);
 428 typedef void    vr_draw_cursor_t(scr_stat *scp, int at, int blink,
 429                                  int on, int flip);
 430 typedef void    vr_blink_cursor_t(scr_stat *scp, int at, int flip);
 431 typedef void    vr_set_mouse_t(scr_stat *scp);
 432 typedef void    vr_draw_mouse_t(scr_stat *scp, int x, int y, int on);
 433
 434 typedef struct sc_rndr_sw {
 435         vr_init_t               *init;
 436         vr_clear_t              *clear;
 437         vr_draw_border_t        *draw_border;
 438         vr_draw_t               *draw;
 439         vr_set_cursor_t         *set_cursor;
 440         vr_draw_cursor_t        *draw_cursor;
 441         vr_blink_cursor_t       *blink_cursor;
 442         vr_set_mouse_t          *set_mouse;
 443         vr_draw_mouse_t         *draw_mouse;
 444 } sc_rndr_sw_t;
 445
 446 typedef struct sc_renderer {
 447         char                    *name;
 448         int                     mode;
 449         sc_rndr_sw_t            *rndrsw;
 450         LIST_ENTRY(sc_renderer) link;
 451 } sc_renderer_t;
 452
 453 #define RENDERER(name, mode, sw, set)                           \
 454         static struct sc_renderer scrndr_##name##_##mode = {    \
 455                 #name, mode, &sw                                \
 456         };                                                      \
 457         DATA_SET(scrndr_set, scrndr_##name##_##mode);           \
 458         DATA_SET(set, scrndr_##name##_##mode)
 459
 460 #define RENDERER_MODULE(name, set)                              \
 461         SET_DECLARE(set, sc_renderer_t);                        \
 462         static int                                              \
 463         scrndr_##name##_event(module_t mod, int type, void *data) \
 464         {                                                       \
 465                 sc_renderer_t **list;                           \
 466                 int error = 0;                                  \
 467                 switch (type) {                                 \
 468                 case MOD_LOAD:                                  \
 469                         SET_FOREACH(list, set) {                \
 470                                 error = sc_render_add(*list);   \
 471                                 if (error)                      \
 472                                         break;                  \
 473                         }                                       \
 474                         break;                                  \
 475                 case MOD_UNLOAD:                                \
 476                         SET_FOREACH(list, set) {                \
 477                                 error = sc_render_remove(*list);\
 478                                 if (error)                      \
 479                                         break;                  \
 480                         }                                       \
 481                         break;                                  \
 482                 default:                                        \
 483                         return EOPNOTSUPP;                      \
 484                         break;                                  \
 485                 }                                               \
 486                 return error;                                   \
 487         }                                                       \
 488         static moduledata_t scrndr_##name##_mod = {             \
 489                 "scrndr-" #name,                                \
 490                 scrndr_##name##_event,                          \
 491                 NULL,                                           \
 492         };                                                      \
 493         DECLARE_MODULE(scrndr_##name, scrndr_##name##_mod,      \
 494                        SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
 495
 496 typedef struct {
 497         int             cursor_start;
 498         int             cursor_end;
 499         int             shift_state;
 500         int             bell_pitch;
 501 } bios_values_t;
 502
 503 /* other macros */
 504 #define ISTEXTSC(scp)   (!((scp)->status                                \
 505                           & (UNKNOWN_MODE | GRAPHICS_MODE | PIXEL_MODE)))
 506 #define ISGRAPHSC(scp)  (((scp)->status                                 \
 507                           & (UNKNOWN_MODE | GRAPHICS_MODE)))
 508 #define ISPIXELSC(scp)  (((scp)->status                                 \
 509                           & (UNKNOWN_MODE | GRAPHICS_MODE | PIXEL_MODE))\
 510                           == PIXEL_MODE)
 511 #define ISUNKNOWNSC(scp) ((scp)->status & UNKNOWN_MODE)
 512
 513 #define ISMOUSEAVAIL(af) ((af) & V_ADP_FONT)
 514 #define ISFONTAVAIL(af) ((af) & V_ADP_FONT)
 515 #define ISPALAVAIL(af)  ((af) & V_ADP_PALETTE)
 516
 517 #define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG)
 518
 519 #define kbd_read_char(kbd, wait)                                        \
 520                 (*kbdsw[(kbd)->kb_index]->read_char)((kbd), (wait))
 521 #define kbd_check_char(kbd)                                             \
 522                 (*kbdsw[(kbd)->kb_index]->check_char)((kbd))
 523 #define kbd_enable(kbd)                                                 \
 524                 (*kbdsw[(kbd)->kb_index]->enable)((kbd))
 525 #define kbd_disable(kbd)                                                \
 526                 (*kbdsw[(kbd)->kb_index]->disable)((kbd))
 527 #define kbd_lock(kbd, lockf)                                            \
 528                 (*kbdsw[(kbd)->kb_index]->lock)((kbd), (lockf))
 529 #define kbd_ioctl(kbd, cmd, arg)                                        \
 530             (((kbd) == NULL) ?                                          \
 531                 ENODEV : (*kbdsw[(kbd)->kb_index]->ioctl)((kbd), (cmd), (arg)))
 532 #define kbd_clear_state(kbd)                                            \
 533                 (*kbdsw[(kbd)->kb_index]->clear_state)((kbd))
 534 #define kbd_get_fkeystr(kbd, fkey, len)                                 \
 535                 (*kbdsw[(kbd)->kb_index]->get_fkeystr)((kbd), (fkey), (len))
 536 #define kbd_poll(kbd, on)                                               \
 537                 (*kbdsw[(kbd)->kb_index]->poll)((kbd), (on))
 538
 539 #define SC_VIDEO_LOCKINIT(sc)                                           \
 540                 mtx_init(&(sc)->video_mtx, "syscons video lock", NULL,  \
 541                     MTX_SPIN | MTX_RECURSE);
 542 #define SC_VIDEO_LOCK(sc)                                               \
 543                 do {                                                    \
 544                         if (!cold)                                      \
 545                                 mtx_lock_spin(&(sc)->video_mtx);        \
 546                 } while(0)
 547 #define SC_VIDEO_UNLOCK(sc)                                             \
 548                 do {                                                    \
 549                         if (!cold)                                      \
 550                                 mtx_unlock_spin(&(sc)->video_mtx);      \
 551                 } while(0)
 552
 553 /* syscons.c */
 554 extern int      (*sc_user_ioctl)(struct cdev *dev, u_long cmd, caddr_t data,
 555                                  int flag, struct thread *td);
 556
 557 int             sc_probe_unit(int unit, int flags);
 558 int             sc_attach_unit(int unit, int flags);
 559
 560 int             set_mode(scr_stat *scp);
 561
 562 void            sc_set_border(scr_stat *scp, int color);
 563 void            sc_load_font(scr_stat *scp, int page, int size, int width,
 564                              u_char *font, int base, int count);
 565 void            sc_save_font(scr_stat *scp, int page, int size, int width,
 566                              u_char *font, int base, int count);
 567 void            sc_show_font(scr_stat *scp, int page);
 568
 569 void            sc_touch_scrn_saver(void);
 570 void            sc_puts(scr_stat *scp, u_char *buf, int len);
 571 void            sc_draw_cursor_image(scr_stat *scp);
 572 void            sc_remove_cursor_image(scr_stat *scp);
 573 void            sc_set_cursor_image(scr_stat *scp);
 574 void            sc_change_cursor_shape(scr_stat *scp, int flags,
 575                                        int base, int height);
 576 int             sc_clean_up(scr_stat *scp);
 577 int             sc_switch_scr(sc_softc_t *sc, u_int next_scr);
 578 void            sc_alloc_scr_buffer(scr_stat *scp, int wait, int discard);
 579 int             sc_init_emulator(scr_stat *scp, char *name);
 580 void            sc_paste(scr_stat *scp, u_char *p, int count);
 581 void            sc_bell(scr_stat *scp, int pitch, int duration);
 582
 583 /* schistory.c */
 584 #ifndef SC_NO_HISTORY
 585 int             sc_alloc_history_buffer(scr_stat *scp, int lines,
 586                                         int prev_ysize, int wait);
 587 void            sc_free_history_buffer(scr_stat *scp, int prev_ysize);
 588 void            sc_hist_save(scr_stat *scp);
 589 #define         sc_hist_save_one_line(scp, from)        \
 590                 sc_vtb_append(&(scp)->vtb, (from), (scp)->history, (scp)->xsize)
 591 int             sc_hist_restore(scr_stat *scp);
 592 void            sc_hist_home(scr_stat *scp);
 593 void            sc_hist_end(scr_stat *scp);
 594 int             sc_hist_up_line(scr_stat *scp);
 595 int             sc_hist_down_line(scr_stat *scp);
 596 int             sc_hist_ioctl(struct tty *tp, u_long cmd, caddr_t data,
 597                               int flag, struct thread *td);
 598 #endif /* SC_NO_HISTORY */
 599
 600 /* scmouse.c */
 601 #ifndef SC_NO_CUTPASTE
 602 void            sc_alloc_cut_buffer(scr_stat *scp, int wait);
 603 void            sc_draw_mouse_image(scr_stat *scp);
 604 void            sc_remove_mouse_image(scr_stat *scp);
 605 int             sc_inside_cutmark(scr_stat *scp, int pos);
 606 void            sc_remove_cutmarking(scr_stat *scp);
 607 void            sc_remove_all_cutmarkings(sc_softc_t *scp);
 608 void            sc_remove_all_mouse(sc_softc_t *scp);
 609 void            sc_mouse_paste(scr_stat *scp);
 610 #else
 611 #define         sc_draw_mouse_image(scp)
 612 #define         sc_remove_mouse_image(scp)
 613 #define         sc_inside_cutmark(scp, pos)     FALSE
 614 #define         sc_remove_cutmarking(scp)
 615 #define         sc_remove_all_cutmarkings(scp)
 616 #define         sc_remove_all_mouse(scp)
 617 #define         sc_mouse_paste(scp)
 618 #endif /* SC_NO_CUTPASTE */
 619 #ifndef SC_NO_SYSMOUSE
 620 void            sc_mouse_move(scr_stat *scp, int x, int y);
 621 int             sc_mouse_ioctl(struct tty *tp, u_long cmd, caddr_t data,
 622                                int flag, struct thread *td);
 623 #endif /* SC_NO_SYSMOUSE */
 624
 625 /* scvidctl.c */
 626 int             sc_set_text_mode(scr_stat *scp, struct tty *tp, int mode,
 627                                  int xsize, int ysize, int fontsize,
 628                                  int font_width);
 629 int             sc_set_graphics_mode(scr_stat *scp, struct tty *tp, int mode);
 630 int             sc_set_pixel_mode(scr_stat *scp, struct tty *tp, int xsize,
 631                                   int ysize, int fontsize, int font_width);
 632 int             sc_vid_ioctl(struct tty *tp, u_long cmd, caddr_t data, int flag,
 633                              struct thread *td);
 634
 635 int             sc_render_add(sc_renderer_t *rndr);
 636 int             sc_render_remove(sc_renderer_t *rndr);
 637 sc_rndr_sw_t    *sc_render_match(scr_stat *scp, char *name, int mode);
 638
 639 /* scvtb.c */
 640 void            sc_vtb_init(sc_vtb_t *vtb, int type, int cols, int rows,
 641                             void *buffer, int wait);
 642 void            sc_vtb_destroy(sc_vtb_t *vtb);
 643 size_t          sc_vtb_size(int cols, int rows);
 644 void            sc_vtb_clear(sc_vtb_t *vtb, int c, int attr);
 645
 646 int             sc_vtb_getc(sc_vtb_t *vtb, int at);
 647 int             sc_vtb_geta(sc_vtb_t *vtb, int at);
 648 void            sc_vtb_putc(sc_vtb_t *vtb, int at, int c, int a);
 649 vm_offset_t     sc_vtb_putchar(sc_vtb_t *vtb, vm_offset_t p, int c, int a);
 650 vm_offset_t     sc_vtb_pointer(sc_vtb_t *vtb, int at);
 651 int             sc_vtb_pos(sc_vtb_t *vtb, int pos, int offset);
 652
 653 #define         sc_vtb_tail(vtb)        ((vtb)->vtb_tail)
 654 #define         sc_vtb_rows(vtb)        ((vtb)->vtb_rows)
 655 #define         sc_vtb_cols(vtb)        ((vtb)->vtb_cols)
 656
 657 void            sc_vtb_copy(sc_vtb_t *vtb1, int from, sc_vtb_t *vtb2, int to,
 658                             int count);
 659 void            sc_vtb_append(sc_vtb_t *vtb1, int from, sc_vtb_t *vtb2,
 660                               int count);
 661 void            sc_vtb_seek(sc_vtb_t *vtb, int pos);
 662 void            sc_vtb_erase(sc_vtb_t *vtb, int at, int count, int c, int attr);
 663 void            sc_vtb_move(sc_vtb_t *vtb, int from, int to, int count);
 664 void            sc_vtb_delete(sc_vtb_t *vtb, int at, int count, int c, int attr);
 665 void            sc_vtb_ins(sc_vtb_t *vtb, int at, int count, int c, int attr);
 666
 667 /* sysmouse.c */
 668 int             sysmouse_event(mouse_info_t *info);
 669
 670 /* scterm.c */
 671 void            sc_move_cursor(scr_stat *scp, int x, int y);
 672 void            sc_clear_screen(scr_stat *scp);
 673 int             sc_term_add(sc_term_sw_t *sw);
 674 int             sc_term_remove(sc_term_sw_t *sw);
 675 sc_term_sw_t    *sc_term_match(char *name);
 676 sc_term_sw_t    *sc_term_match_by_number(int index);
 677
 678 /* machine dependent functions */
 679 int             sc_max_unit(void);
 680 sc_softc_t      *sc_get_softc(int unit, int flags);
 681 sc_softc_t      *sc_find_softc(struct video_adapter *adp, struct keyboard *kbd);
 682 int             sc_get_cons_priority(int *unit, int *flags);
 683 void            sc_get_bios_values(bios_values_t *values);
 684 int             sc_tone(int herz);
 685
 686 #endif /* !_DEV_SYSCONS_SYSCONS_H_ */