sys/sys/terminal.h

   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 struct terminal;
  45 struct thread;
  46 struct tty;
  47
  48 /*
  49  * The terminal layer is an abstraction on top of the TTY layer and the
  50  * console interface.  It can be used by system console drivers to
  51  * easily interact with the kernel console and TTYs.
  52  *
  53  * Terminals contain terminal emulators, which means console drivers
  54  * don't need to implement their own terminal emulator. The terminal
  55  * emulator deals with UTF-8 exclusively. This means that term_char_t,
  56  * the data type used to store input/output characters will always
  57  * contain Unicode codepoints.
  58  *
  59  * To save memory usage, the top bits of term_char_t will contain other
  60  * attributes, like colors. Right now term_char_t is composed as
  61  * follows:
  62  *
  63  *  Bits  Meaning
  64  *  0-20: Character value
  65  *    21: Unused
  66  * 22-25: Bold, underline, blink, reverse
  67  * 26-28: Foreground color
  68  * 29-31: Background color
  69  */
  70
  71 typedef uint32_t term_char_t;
  72 #define TCHAR_CHARACTER(c)      ((c) & 0x1fffff)
  73 #define TCHAR_FORMAT(c)         (((c) >> 22) & 0xf)
  74 #define TCHAR_FGCOLOR(c)        (((c) >> 26) & 0x7)
  75 #define TCHAR_BGCOLOR(c)        ((c) >> 29)
  76
  77 typedef teken_color_t term_color_t;
  78 #define TCOLOR_LIGHT(c) ((c) | 0x8)
  79 #define TCOLOR_DARK(c)  ((c) & ~0x8)
  80 typedef teken_pos_t term_pos_t;
  81 typedef teken_rect_t term_rect_t;
  82
  83 typedef void tc_cursor_t(struct terminal *tm, const term_pos_t *p);
  84 typedef void tc_putchar_t(struct terminal *tm, const term_pos_t *p,
  85     term_char_t c);
  86 typedef void tc_fill_t(struct terminal *tm, const term_rect_t *r,
  87     term_char_t c);
  88 typedef void tc_copy_t(struct terminal *tm, const term_rect_t *r,
  89     const term_pos_t *p);
  90 typedef void tc_param_t(struct terminal *tm, int cmd, unsigned int arg);
  91 typedef void tc_done_t(struct terminal *tm);
  92
  93 typedef void tc_cnprobe_t(struct terminal *tm, struct consdev *cd);
  94 typedef int tc_cngetc_t(struct terminal *tm);
  95
  96 typedef void tc_opened_t(struct terminal *tm, int opened);
  97 typedef int tc_ioctl_t(struct terminal *tm, u_long cmd, caddr_t data,
  98     struct thread *td);
  99 typedef void tc_bell_t(struct terminal *tm);
 100
 101 struct terminal_class {
 102         /* Terminal emulator. */
 103         tc_cursor_t     *tc_cursor;
 104         tc_putchar_t    *tc_putchar;
 105         tc_fill_t       *tc_fill;
 106         tc_copy_t       *tc_copy;
 107         tc_param_t      *tc_param;
 108         tc_done_t       *tc_done;
 109
 110         /* Low-level console interface. */
 111         tc_cnprobe_t    *tc_cnprobe;
 112         tc_cngetc_t     *tc_cngetc;
 113
 114         /* Misc. */
 115         tc_opened_t     *tc_opened;
 116         tc_ioctl_t      *tc_ioctl;
 117         tc_bell_t       *tc_bell;
 118 };
 119
 120 struct terminal {
 121         const struct terminal_class *tm_class;
 122         void            *tm_softc;
 123         struct mtx       tm_mtx;
 124         struct tty      *tm_tty;
 125         teken_t          tm_emulator;
 126         struct winsize   tm_winsize;
 127         unsigned int     tm_flags;
 128 #define TF_MUTE         0x1     /* Drop incoming data. */
 129 #define TF_BELL         0x2     /* Bell needs to be sent. */
 130 #define TF_CONS         0x4     /* Console device (needs spinlock). */
 131 };
 132
 133 #ifdef _KERNEL
 134
 135 struct terminal *terminal_alloc(const struct terminal_class *tc, void *softc);
 136 void    terminal_maketty(struct terminal *tm, const char *fmt, ...);
 137 void    terminal_set_winsize(struct terminal *tm, const struct winsize *size);
 138 void    terminal_mute(struct terminal *tm, int yes);
 139 void    terminal_input_char(struct terminal *tm, term_char_t c);
 140 void    terminal_input_raw(struct terminal *tm, char c);
 141 void    terminal_input_special(struct terminal *tm, unsigned int k);
 142
 143 /* Kernel console helper interface. */
 144 extern const struct consdev_ops termcn_ops;
 145
 146 #define TERMINAL_DECLARE_EARLY(name, class, softc)                      \
 147         static struct terminal name = {                                 \
 148                 .tm_class = &class,                                     \
 149                 .tm_softc = softc,                                      \
 150                 .tm_flags = TF_CONS,                                    \
 151         };                                                              \
 152         CONSOLE_DEVICE(name ## _consdev, termcn_ops, &name)
 153
 154 #endif /* _KERNEL */
 155
 156 #endif /* !_SYS_TERMINAL_H_ */