The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/terminal.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10  
    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$
   30  */
   31 
   32 #ifndef _SYS_TERMINAL_H_
   33 #define _SYS_TERMINAL_H_
   34 
   35 #include <sys/param.h>
   36 #include <sys/_lock.h>
   37 #include <sys/_mutex.h>
   38 #include <sys/cons.h>
   39 #include <sys/linker_set.h>
   40 #include <sys/ttycom.h>
   41 
   42 #include <teken/teken.h>
   43 
   44 #include "opt_syscons.h"
   45 #include "opt_teken.h"
   46 
   47 struct terminal;
   48 struct thread;
   49 struct tty;
   50 
   51 /*
   52  * The terminal layer is an abstraction on top of the TTY layer and the
   53  * console interface.  It can be used by system console drivers to
   54  * easily interact with the kernel console and TTYs.
   55  *
   56  * Terminals contain terminal emulators, which means console drivers
   57  * don't need to implement their own terminal emulator. The terminal
   58  * emulator deals with UTF-8 exclusively. This means that term_char_t,
   59  * the data type used to store input/output characters will always
   60  * contain Unicode codepoints.
   61  *
   62  * To save memory usage, the top bits of term_char_t will contain other
   63  * attributes, like colors. Right now term_char_t is composed as
   64  * follows:
   65  *
   66  *  Bits  Meaning
   67  *  0-20: Character value
   68  * 21-25: Bold, underline, blink, reverse, right part of CJK fullwidth character
   69  * 26-28: Foreground color
   70  * 29-31: Background color
   71  */
   72 
   73 typedef uint32_t term_char_t;
   74 #define TCHAR_CHARACTER(c)      ((c) & 0x1fffff)
   75 #define TCHAR_FORMAT(c)         (((c) >> 21) & 0x1f)
   76 #define TCHAR_FGCOLOR(c)        (((c) >> 26) & 0x7)
   77 #define TCHAR_BGCOLOR(c)        (((c) >> 29) & 0x7)
   78 
   79 typedef teken_attr_t term_attr_t;
   80 
   81 typedef teken_color_t term_color_t;
   82 #define TCOLOR_FG(c)    (((c) & 0x7) << 26)
   83 #define TCOLOR_BG(c)    (((c) & 0x7) << 29)
   84 #define TCOLOR_LIGHT(c) ((c) | 0x8)
   85 #define TCOLOR_DARK(c)  ((c) & ~0x8)
   86 
   87 #define TFORMAT(c)      (((c) & 0x1f) << 21)
   88 
   89 /* syscons(4) compatible color attributes for foreground text */
   90 #define FG_BLACK                TCOLOR_FG(TC_BLACK)
   91 #define FG_BLUE                 TCOLOR_FG(TC_BLUE)
   92 #define FG_GREEN                TCOLOR_FG(TC_GREEN)
   93 #define FG_CYAN                 TCOLOR_FG(TC_CYAN)
   94 #define FG_RED                  TCOLOR_FG(TC_RED)
   95 #define FG_MAGENTA              TCOLOR_FG(TC_MAGENTA)
   96 #define FG_BROWN                TCOLOR_FG(TC_BROWN)
   97 #define FG_LIGHTGREY            TCOLOR_FG(TC_WHITE)
   98 #define FG_DARKGREY             (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_BLACK))
   99 #define FG_LIGHTBLUE            (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_BLUE))
  100 #define FG_LIGHTGREEN           (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_GREEN))
  101 #define FG_LIGHTCYAN            (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_CYAN))
  102 #define FG_LIGHTRED             (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_RED))
  103 #define FG_LIGHTMAGENTA         (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_MAGENTA))
  104 #define FG_YELLOW               (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_BROWN))
  105 #define FG_WHITE                (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_WHITE))
  106 #define FG_BLINK                TFORMAT(TF_BLINK)
  107 
  108 /* syscons(4) compatible color attributes for text background */
  109 #define BG_BLACK                TCOLOR_BG(TC_BLACK)
  110 #define BG_BLUE                 TCOLOR_BG(TC_BLUE)
  111 #define BG_GREEN                TCOLOR_BG(TC_GREEN)
  112 #define BG_CYAN                 TCOLOR_BG(TC_CYAN)
  113 #define BG_RED                  TCOLOR_BG(TC_RED)
  114 #define BG_MAGENTA              TCOLOR_BG(TC_MAGENTA)
  115 #define BG_BROWN                TCOLOR_BG(TC_BROWN)
  116 #define BG_LIGHTGREY            TCOLOR_BG(TC_WHITE)
  117 #define BG_DARKGREY             (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_BLACK))
  118 #define BG_LIGHTBLUE            (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_BLUE))
  119 #define BG_LIGHTGREEN           (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_GREEN))
  120 #define BG_LIGHTCYAN            (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_CYAN))
  121 #define BG_LIGHTRED             (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_RED))
  122 #define BG_LIGHTMAGENTA         (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_MAGENTA))
  123 #define BG_YELLOW               (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_BROWN))
  124 #define BG_WHITE                (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_WHITE))
  125 
  126 #ifndef TERMINAL_NORM_ATTR
  127 #ifdef SC_NORM_ATTR
  128 #define TERMINAL_NORM_ATTR      SC_NORM_ATTR
  129 #else
  130 #define TERMINAL_NORM_ATTR      (FG_LIGHTGREY | BG_BLACK)
  131 #endif
  132 #endif
  133 
  134 #ifndef TERMINAL_KERN_ATTR
  135 #ifdef SC_KERNEL_CONS_ATTR
  136 #define TERMINAL_KERN_ATTR      SC_KERNEL_CONS_ATTR
  137 #else
  138 #define TERMINAL_KERN_ATTR      (FG_WHITE | BG_BLACK)
  139 #endif
  140 #endif
  141 
  142 typedef teken_pos_t term_pos_t;
  143 typedef teken_rect_t term_rect_t;
  144 
  145 typedef void tc_cursor_t(struct terminal *tm, const term_pos_t *p);
  146 typedef void tc_putchar_t(struct terminal *tm, const term_pos_t *p,
  147     term_char_t c);
  148 typedef void tc_fill_t(struct terminal *tm, const term_rect_t *r,
  149     term_char_t c);
  150 typedef void tc_copy_t(struct terminal *tm, const term_rect_t *r,
  151     const term_pos_t *p);
  152 typedef void tc_param_t(struct terminal *tm, int cmd, unsigned int arg);
  153 typedef void tc_done_t(struct terminal *tm);
  154 
  155 typedef void tc_cnprobe_t(struct terminal *tm, struct consdev *cd);
  156 typedef int tc_cngetc_t(struct terminal *tm);
  157 
  158 typedef void tc_cngrab_t(struct terminal *tm);
  159 typedef void tc_cnungrab_t(struct terminal *tm);
  160 
  161 typedef void tc_opened_t(struct terminal *tm, int opened);
  162 typedef int tc_ioctl_t(struct terminal *tm, u_long cmd, caddr_t data,
  163     struct thread *td);
  164 typedef int tc_mmap_t(struct terminal *tm, vm_ooffset_t offset,
  165     vm_paddr_t * paddr, int nprot, vm_memattr_t *memattr);
  166 typedef void tc_bell_t(struct terminal *tm);
  167 
  168 struct terminal_class {
  169         /* Terminal emulator. */
  170         tc_cursor_t     *tc_cursor;
  171         tc_putchar_t    *tc_putchar;
  172         tc_fill_t       *tc_fill;
  173         tc_copy_t       *tc_copy;
  174         tc_param_t      *tc_param;
  175         tc_done_t       *tc_done;
  176 
  177         /* Low-level console interface. */
  178         tc_cnprobe_t    *tc_cnprobe;
  179         tc_cngetc_t     *tc_cngetc;
  180 
  181         /* DDB & panic handling. */
  182         tc_cngrab_t     *tc_cngrab;
  183         tc_cnungrab_t   *tc_cnungrab;
  184 
  185         /* Misc. */
  186         tc_opened_t     *tc_opened;
  187         tc_ioctl_t      *tc_ioctl;
  188         tc_mmap_t       *tc_mmap;
  189         tc_bell_t       *tc_bell;
  190 };
  191 
  192 struct terminal {
  193         const struct terminal_class *tm_class;
  194         void            *tm_softc;
  195         struct mtx       tm_mtx;
  196         struct tty      *tm_tty;
  197         teken_t          tm_emulator;
  198         struct winsize   tm_winsize;
  199         unsigned int     tm_flags;
  200 #define TF_MUTE         0x1     /* Drop incoming data. */
  201 #define TF_BELL         0x2     /* Bell needs to be sent. */
  202 #define TF_CONS         0x4     /* Console device (needs spinlock). */
  203         struct consdev  *consdev;
  204 };
  205 
  206 #ifdef _KERNEL
  207 
  208 struct terminal *terminal_alloc(const struct terminal_class *tc, void *softc);
  209 void    terminal_maketty(struct terminal *tm, const char *fmt, ...);
  210 void    terminal_set_cursor(struct terminal *tm, const term_pos_t *pos);
  211 void    terminal_set_winsize_blank(struct terminal *tm,
  212     const struct winsize *size, int blank, const term_attr_t *attr);
  213 void    terminal_set_winsize(struct terminal *tm, const struct winsize *size);
  214 void    terminal_mute(struct terminal *tm, int yes);
  215 void    terminal_input_char(struct terminal *tm, term_char_t c);
  216 void    terminal_input_raw(struct terminal *tm, char c);
  217 void    terminal_input_special(struct terminal *tm, unsigned int k);
  218 
  219 void    termcn_cnregister(struct terminal *tm);
  220 
  221 /* Kernel console helper interface. */
  222 extern const struct consdev_ops termcn_cnops;
  223 
  224 #define TERMINAL_DECLARE_EARLY(name, class, softc)                      \
  225         static struct terminal name = {                                 \
  226                 .tm_class = &class,                                     \
  227                 .tm_softc = softc,                                      \
  228                 .tm_flags = TF_CONS,                                    \
  229         };                                                              \
  230         CONSOLE_DEVICE(name ## _consdev, termcn_cnops, &name)
  231 
  232 #endif /* _KERNEL */
  233 
  234 #endif /* !_SYS_TERMINAL_H_ */

Cache object: b6414fdbc43139e8b61096bed6a98b55

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.