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-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
    3  *
    4  * Copyright (c) 2009 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  * Redistribution and use in source and binary forms, with or without
   11  * modification, are permitted provided that the following conditions
   12  * are met:
   13  * 1. Redistributions of source code must retain the above copyright
   14  *    notice, this list of conditions and the following disclaimer.
   15  * 2. Redistributions in binary form must reproduce the above copyright
   16  *    notice, this list of conditions and the following disclaimer in the
   17  *    documentation and/or other materials provided with the distribution.
   18  *
   19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
   20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
   23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   29  * SUCH DAMAGE.
   30  *
   31  * $FreeBSD: stable/12/sys/sys/terminal.h 333669 2018-05-16 09:01:02Z dumbbell $
   32  */
   33 
   34 #ifndef _SYS_TERMINAL_H_
   35 #define _SYS_TERMINAL_H_
   36 
   37 #include <sys/param.h>
   38 #include <sys/_lock.h>
   39 #include <sys/_mutex.h>
   40 #include <sys/cons.h>
   41 #include <sys/linker_set.h>
   42 #include <sys/ttycom.h>
   43 
   44 #include <teken/teken.h>
   45 
   46 #include "opt_syscons.h"
   47 #include "opt_teken.h"
   48 
   49 struct terminal;
   50 struct thread;
   51 struct tty;
   52 
   53 /*
   54  * The terminal layer is an abstraction on top of the TTY layer and the
   55  * console interface.  It can be used by system console drivers to
   56  * easily interact with the kernel console and TTYs.
   57  *
   58  * Terminals contain terminal emulators, which means console drivers
   59  * don't need to implement their own terminal emulator. The terminal
   60  * emulator deals with UTF-8 exclusively. This means that term_char_t,
   61  * the data type used to store input/output characters will always
   62  * contain Unicode codepoints.
   63  *
   64  * To save memory usage, the top bits of term_char_t will contain other
   65  * attributes, like colors. Right now term_char_t is composed as
   66  * follows:
   67  *
   68  *  Bits  Meaning
   69  *  0-20: Character value
   70  * 21-25: Bold, underline, blink, reverse, right part of CJK fullwidth character
   71  * 26-28: Foreground color
   72  * 29-31: Background color
   73  */
   74 
   75 typedef uint32_t term_char_t;
   76 #define TCHAR_CHARACTER(c)      ((c) & 0x1fffff)
   77 #define TCHAR_FORMAT(c)         (((c) >> 21) & 0x1f)
   78 #define TCHAR_FGCOLOR(c)        (((c) >> 26) & 0x7)
   79 #define TCHAR_BGCOLOR(c)        (((c) >> 29) & 0x7)
   80 
   81 typedef teken_attr_t term_attr_t;
   82 
   83 typedef teken_color_t term_color_t;
   84 #define TCOLOR_FG(c)    (((c) & 0x7) << 26)
   85 #define TCOLOR_BG(c)    (((c) & 0x7) << 29)
   86 #define TCOLOR_LIGHT(c) ((c) | 0x8)
   87 #define TCOLOR_DARK(c)  ((c) & ~0x8)
   88 
   89 #define TFORMAT(c)      (((c) & 0x1f) << 21)
   90 
   91 /* syscons(4) compatible color attributes for foreground text */
   92 #define FG_BLACK                TCOLOR_FG(TC_BLACK)
   93 #define FG_BLUE                 TCOLOR_FG(TC_BLUE)
   94 #define FG_GREEN                TCOLOR_FG(TC_GREEN)
   95 #define FG_CYAN                 TCOLOR_FG(TC_CYAN)
   96 #define FG_RED                  TCOLOR_FG(TC_RED)
   97 #define FG_MAGENTA              TCOLOR_FG(TC_MAGENTA)
   98 #define FG_BROWN                TCOLOR_FG(TC_BROWN)
   99 #define FG_LIGHTGREY            TCOLOR_FG(TC_WHITE)
  100 #define FG_DARKGREY             (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_BLACK))
  101 #define FG_LIGHTBLUE            (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_BLUE))
  102 #define FG_LIGHTGREEN           (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_GREEN))
  103 #define FG_LIGHTCYAN            (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_CYAN))
  104 #define FG_LIGHTRED             (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_RED))
  105 #define FG_LIGHTMAGENTA         (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_MAGENTA))
  106 #define FG_YELLOW               (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_BROWN))
  107 #define FG_WHITE                (TFORMAT(TF_BOLD) | TCOLOR_FG(TC_WHITE))
  108 #define FG_BLINK                TFORMAT(TF_BLINK)
  109 
  110 /* syscons(4) compatible color attributes for text background */
  111 #define BG_BLACK                TCOLOR_BG(TC_BLACK)
  112 #define BG_BLUE                 TCOLOR_BG(TC_BLUE)
  113 #define BG_GREEN                TCOLOR_BG(TC_GREEN)
  114 #define BG_CYAN                 TCOLOR_BG(TC_CYAN)
  115 #define BG_RED                  TCOLOR_BG(TC_RED)
  116 #define BG_MAGENTA              TCOLOR_BG(TC_MAGENTA)
  117 #define BG_BROWN                TCOLOR_BG(TC_BROWN)
  118 #define BG_LIGHTGREY            TCOLOR_BG(TC_WHITE)
  119 #define BG_DARKGREY             (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_BLACK))
  120 #define BG_LIGHTBLUE            (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_BLUE))
  121 #define BG_LIGHTGREEN           (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_GREEN))
  122 #define BG_LIGHTCYAN            (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_CYAN))
  123 #define BG_LIGHTRED             (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_RED))
  124 #define BG_LIGHTMAGENTA         (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_MAGENTA))
  125 #define BG_YELLOW               (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_BROWN))
  126 #define BG_WHITE                (TFORMAT(TF_BOLD) | TCOLOR_BG(TC_WHITE))
  127 
  128 #ifndef TERMINAL_NORM_ATTR
  129 #ifdef SC_NORM_ATTR
  130 #define TERMINAL_NORM_ATTR      SC_NORM_ATTR
  131 #else
  132 #define TERMINAL_NORM_ATTR      (FG_LIGHTGREY | BG_BLACK)
  133 #endif
  134 #endif
  135 
  136 #ifndef TERMINAL_KERN_ATTR
  137 #ifdef SC_KERNEL_CONS_ATTR
  138 #define TERMINAL_KERN_ATTR      SC_KERNEL_CONS_ATTR
  139 #else
  140 #define TERMINAL_KERN_ATTR      (FG_WHITE | BG_BLACK)
  141 #endif
  142 #endif
  143 
  144 typedef teken_pos_t term_pos_t;
  145 typedef teken_rect_t term_rect_t;
  146 
  147 typedef void tc_cursor_t(struct terminal *tm, const term_pos_t *p);
  148 typedef void tc_putchar_t(struct terminal *tm, const term_pos_t *p,
  149     term_char_t c);
  150 typedef void tc_fill_t(struct terminal *tm, const term_rect_t *r,
  151     term_char_t c);
  152 typedef void tc_copy_t(struct terminal *tm, const term_rect_t *r,
  153     const term_pos_t *p);
  154 typedef void tc_pre_input_t(struct terminal *tm);
  155 typedef void tc_post_input_t(struct terminal *tm);
  156 typedef void tc_param_t(struct terminal *tm, int cmd, unsigned int arg);
  157 typedef void tc_done_t(struct terminal *tm);
  158 
  159 typedef void tc_cnprobe_t(struct terminal *tm, struct consdev *cd);
  160 typedef int tc_cngetc_t(struct terminal *tm);
  161 
  162 typedef void tc_cngrab_t(struct terminal *tm);
  163 typedef void tc_cnungrab_t(struct terminal *tm);
  164 
  165 typedef void tc_opened_t(struct terminal *tm, int opened);
  166 typedef int tc_ioctl_t(struct terminal *tm, u_long cmd, caddr_t data,
  167     struct thread *td);
  168 typedef int tc_mmap_t(struct terminal *tm, vm_ooffset_t offset,
  169     vm_paddr_t * paddr, int nprot, vm_memattr_t *memattr);
  170 typedef void tc_bell_t(struct terminal *tm);
  171 
  172 struct terminal_class {
  173         /* Terminal emulator. */
  174         tc_cursor_t     *tc_cursor;
  175         tc_putchar_t    *tc_putchar;
  176         tc_fill_t       *tc_fill;
  177         tc_copy_t       *tc_copy;
  178         tc_pre_input_t  *tc_pre_input;
  179         tc_post_input_t *tc_post_input;
  180         tc_param_t      *tc_param;
  181         tc_done_t       *tc_done;
  182 
  183         /* Low-level console interface. */
  184         tc_cnprobe_t    *tc_cnprobe;
  185         tc_cngetc_t     *tc_cngetc;
  186 
  187         /* DDB & panic handling. */
  188         tc_cngrab_t     *tc_cngrab;
  189         tc_cnungrab_t   *tc_cnungrab;
  190 
  191         /* Misc. */
  192         tc_opened_t     *tc_opened;
  193         tc_ioctl_t      *tc_ioctl;
  194         tc_mmap_t       *tc_mmap;
  195         tc_bell_t       *tc_bell;
  196 };
  197 
  198 struct terminal {
  199         const struct terminal_class *tm_class;
  200         void            *tm_softc;
  201         struct mtx       tm_mtx;
  202         struct tty      *tm_tty;
  203         teken_t          tm_emulator;
  204         struct winsize   tm_winsize;
  205         unsigned int     tm_flags;
  206 #define TF_MUTE         0x1     /* Drop incoming data. */
  207 #define TF_BELL         0x2     /* Bell needs to be sent. */
  208 #define TF_CONS         0x4     /* Console device (needs spinlock). */
  209         struct consdev  *consdev;
  210 };
  211 
  212 #ifdef _KERNEL
  213 
  214 struct terminal *terminal_alloc(const struct terminal_class *tc, void *softc);
  215 void    terminal_maketty(struct terminal *tm, const char *fmt, ...);
  216 void    terminal_set_cursor(struct terminal *tm, const term_pos_t *pos);
  217 void    terminal_set_winsize_blank(struct terminal *tm,
  218     const struct winsize *size, int blank, const term_attr_t *attr);
  219 void    terminal_set_winsize(struct terminal *tm, const struct winsize *size);
  220 void    terminal_mute(struct terminal *tm, int yes);
  221 void    terminal_input_char(struct terminal *tm, term_char_t c);
  222 void    terminal_input_raw(struct terminal *tm, char c);
  223 void    terminal_input_special(struct terminal *tm, unsigned int k);
  224 
  225 void    termcn_cnregister(struct terminal *tm);
  226 
  227 /* Kernel console helper interface. */
  228 extern const struct consdev_ops termcn_cnops;
  229 
  230 #define TERMINAL_DECLARE_EARLY(name, class, softc)                      \
  231         static struct terminal name = {                                 \
  232                 .tm_class = &class,                                     \
  233                 .tm_softc = softc,                                      \
  234                 .tm_flags = TF_CONS,                                    \
  235         };                                                              \
  236         CONSOLE_DEVICE(name ## _consdev, termcn_cnops, &name)
  237 
  238 #endif /* _KERNEL */
  239 
  240 #endif /* !_SYS_TERMINAL_H_ */

Cache object: cad2a2768ca7cec1fa61cadec4048417


[ 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.