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/tty.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  * Copyright (c) 1982, 1986, 1993
    3  *      The Regents of the University of California.  All rights reserved.
    4  * (c) UNIX System Laboratories, Inc.
    5  * All or some portions of this file are derived from material licensed
    6  * to the University of California by American Telephone and Telegraph
    7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
    8  * the permission of UNIX System Laboratories, Inc.
    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  * 3. All advertising materials mentioning features or use of this software
   19  *    must display the following acknowledgement:
   20  *      This product includes software developed by the University of
   21  *      California, Berkeley and its contributors.
   22  * 4. Neither the name of the University nor the names of its contributors
   23  *    may be used to endorse or promote products derived from this software
   24  *    without specific prior written permission.
   25  *
   26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   36  * SUCH DAMAGE.
   37  *
   38  *      @(#)tty.h       8.6 (Berkeley) 1/21/94
   39  * $FreeBSD: stable/4/sys/sys/tty.h 73061 2001-02-26 04:23:21Z jlemon $
   40  */
   41 
   42 #ifndef _SYS_TTY_H_
   43 #define _SYS_TTY_H_
   44 
   45 #include <sys/termios.h>
   46 #include <sys/select.h>         /* For struct selinfo. */
   47 #include <sys/queue.h>
   48 
   49 /*
   50  * Clists are character lists, which is a variable length linked list
   51  * of cblocks, with a count of the number of characters in the list.
   52  */
   53 struct clist {
   54         int     c_cc;           /* Number of characters in the clist. */
   55         int     c_cbcount;      /* Number of cblocks. */
   56         int     c_cbmax;        /* Max # cblocks allowed for this clist. */
   57         int     c_cbreserved;   /* # cblocks reserved for this clist. */
   58         char    *c_cf;          /* Pointer to the first cblock. */
   59         char    *c_cl;          /* Pointer to the last cblock. */
   60 };
   61 
   62 /*
   63  * Per-tty structure.
   64  *
   65  * Should be split in two, into device and tty drivers.
   66  * Glue could be masks of what to echo and circular buffer
   67  * (low, high, timeout).
   68  */
   69 struct tty {
   70         struct  clist t_rawq;           /* Device raw input queue. */
   71         long    t_rawcc;                /* Raw input queue statistics. */
   72         struct  clist t_canq;           /* Device canonical queue. */
   73         long    t_cancc;                /* Canonical queue statistics. */
   74         struct  clist t_outq;           /* Device output queue. */
   75         long    t_outcc;                /* Output queue statistics. */
   76         int     t_line;                 /* Interface to device drivers. */
   77         dev_t   t_dev;                  /* Device. */
   78         int     t_state;                /* Device and driver (TS*) state. */
   79         int     t_flags;                /* Tty flags. */
   80         int     t_timeout;              /* Timeout for ttywait() */
   81         struct  pgrp *t_pgrp;           /* Foreground process group. */
   82         struct  session *t_session;     /* Enclosing session. */
   83         struct  sigio *t_sigio;         /* Information for async I/O. */
   84         struct  selinfo t_rsel;         /* Tty read/oob select. */
   85         struct  selinfo t_wsel;         /* Tty write select. */
   86         struct  termios t_termios;      /* Termios state. */
   87         struct  winsize t_winsize;      /* Window size. */
   88                                         /* Start output. */
   89         void    (*t_oproc) __P((struct tty *));
   90                                         /* Stop output. */
   91         void    (*t_stop) __P((struct tty *, int));
   92                                         /* Set hardware state. */
   93         int     (*t_param) __P((struct tty *, struct termios *));
   94         void    *t_sc;                  /* XXX: net/if_sl.c:sl_softc. */
   95         int     t_column;               /* Tty output column. */
   96         int     t_rocount, t_rocol;     /* Tty. */
   97         int     t_ififosize;            /* Total size of upstream fifos. */
   98         int     t_ihiwat;               /* High water mark for input. */
   99         int     t_ilowat;               /* Low water mark for input. */
  100         speed_t t_ispeedwat;            /* t_ispeed override for watermarks. */
  101         int     t_ohiwat;               /* High water mark for output. */
  102         int     t_olowat;               /* Low water mark for output. */
  103         speed_t t_ospeedwat;            /* t_ospeed override for watermarks. */
  104         int     t_gen;                  /* Generation number. */
  105         SLIST_ENTRY(tty) t_list;        /* Global chain of ttys for pstat(8) */
  106 };
  107 
  108 #define t_cc            t_termios.c_cc
  109 #define t_cflag         t_termios.c_cflag
  110 #define t_iflag         t_termios.c_iflag
  111 #define t_ispeed        t_termios.c_ispeed
  112 #define t_lflag         t_termios.c_lflag
  113 #define t_min           t_termios.c_min
  114 #define t_oflag         t_termios.c_oflag
  115 #define t_ospeed        t_termios.c_ospeed
  116 #define t_time          t_termios.c_time
  117 
  118 #define TTIPRI  25                      /* Sleep priority for tty reads. */
  119 #define TTOPRI  26                      /* Sleep priority for tty writes. */
  120 
  121 /*
  122  * User data unfortunately has to be copied through buffers on the way to
  123  * and from clists.  The buffers are on the stack so their sizes must be
  124  * fairly small.
  125  */
  126 #define IBUFSIZ 384                     /* Should be >= max value of MIN. */
  127 #define OBUFSIZ 100
  128 
  129 #ifndef TTYHOG
  130 #define TTYHOG  1024
  131 #endif
  132 
  133 #ifdef _KERNEL
  134 #define TTMAXHIWAT      roundup(2048, CBSIZE)
  135 #define TTMINHIWAT      roundup(100, CBSIZE)
  136 #define TTMAXLOWAT      256
  137 #define TTMINLOWAT      32
  138 #endif
  139 
  140 /* These flags are kept in t_state. */
  141 #define TS_SO_OLOWAT    0x00001         /* Wake up when output <= low water. */
  142 #define TS_ASYNC        0x00002         /* Tty in async I/O mode. */
  143 #define TS_BUSY         0x00004         /* Draining output. */
  144 #define TS_CARR_ON      0x00008         /* Carrier is present. */
  145 #define TS_FLUSH        0x00010         /* Outq has been flushed during DMA. */
  146 #define TS_ISOPEN       0x00020         /* Open has completed. */
  147 #define TS_TBLOCK       0x00040         /* Further input blocked. */
  148 #define TS_TIMEOUT      0x00080         /* Wait for output char processing. */
  149 #define TS_TTSTOP       0x00100         /* Output paused. */
  150 #ifdef notyet
  151 #define TS_WOPEN        0x00200         /* Open in progress. */
  152 #endif
  153 #define TS_XCLUDE       0x00400         /* Tty requires exclusivity. */
  154 
  155 /* State for intra-line fancy editing work. */
  156 #define TS_BKSL         0x00800         /* State for lowercase \ work. */
  157 #define TS_CNTTB        0x01000         /* Counting tab width, ignore FLUSHO. */
  158 #define TS_ERASE        0x02000         /* Within a \.../ for PRTRUB. */
  159 #define TS_LNCH         0x04000         /* Next character is literal. */
  160 #define TS_TYPEN        0x08000         /* Retyping suspended input (PENDIN). */
  161 #define TS_LOCAL        (TS_BKSL | TS_CNTTB | TS_ERASE | TS_LNCH | TS_TYPEN)
  162 
  163 /* Extras. */
  164 #define TS_CAN_BYPASS_L_RINT 0x010000   /* Device in "raw" mode. */
  165 #define TS_CONNECTED    0x020000        /* Connection open. */
  166 #define TS_SNOOP        0x040000        /* Device is being snooped on. */
  167 #define TS_SO_OCOMPLETE 0x080000        /* Wake up when output completes. */
  168 #define TS_ZOMBIE       0x100000        /* Connection lost. */
  169 
  170 /* Hardware flow-control-invoked bits. */
  171 #define TS_CAR_OFLOW    0x200000        /* For MDMBUF (XXX handle in driver). */
  172 #ifdef notyet
  173 #define TS_CTS_OFLOW    0x400000        /* For CCTS_OFLOW. */
  174 #define TS_DSR_OFLOW    0x800000        /* For CDSR_OFLOW. */
  175 #endif
  176 
  177 /* Character type information. */
  178 #define ORDINARY        0
  179 #define CONTROL         1
  180 #define BACKSPACE       2
  181 #define NEWLINE         3
  182 #define TAB             4
  183 #define VTAB            5
  184 #define RETURN          6
  185 
  186 struct speedtab {
  187         int sp_speed;                   /* Speed. */
  188         int sp_code;                    /* Code. */
  189 };
  190 
  191 /* Modem control commands (driver). */
  192 #define DMSET           0
  193 #define DMBIS           1
  194 #define DMBIC           2
  195 #define DMGET           3
  196 
  197 /* Flags on a character passed to ttyinput. */
  198 #define TTY_CHARMASK    0x000000ff      /* Character mask */
  199 #define TTY_QUOTE       0x00000100      /* Character quoted */
  200 #define TTY_ERRORMASK   0xff000000      /* Error mask */
  201 #define TTY_FE          0x01000000      /* Framing error */
  202 #define TTY_PE          0x02000000      /* Parity error */
  203 #define TTY_OE          0x04000000      /* Overrun error */
  204 #define TTY_BI          0x08000000      /* Break condition */
  205 
  206 /* Is tp controlling terminal for p? */
  207 #define isctty(p, tp)                                                   \
  208         ((p)->p_session == (tp)->t_session && (p)->p_flag & P_CONTROLT)
  209 
  210 /* Is p in background of tp? */
  211 #define isbackground(p, tp)                                             \
  212         (isctty((p), (tp)) && (p)->p_pgrp != (tp)->t_pgrp)
  213 
  214 /* Unique sleep addresses. */
  215 #define TSA_CARR_ON(tp)         ((void *)&(tp)->t_rawq)
  216 #define TSA_HUP_OR_INPUT(tp)    ((void *)&(tp)->t_rawq.c_cf)
  217 #define TSA_OCOMPLETE(tp)       ((void *)&(tp)->t_outq.c_cl)
  218 #define TSA_OLOWAT(tp)          ((void *)&(tp)->t_outq)
  219 #define TSA_PTC_READ(tp)        ((void *)&(tp)->t_outq.c_cf)
  220 #define TSA_PTC_WRITE(tp)       ((void *)&(tp)->t_rawq.c_cl)
  221 #define TSA_PTS_READ(tp)        ((void *)&(tp)->t_canq)
  222 
  223 #ifdef _KERNEL
  224 #ifdef MALLOC_DECLARE
  225 MALLOC_DECLARE(M_TTYS);
  226 #endif
  227 extern  struct tty *constty;    /* Temporary virtual console. */
  228 
  229 int      b_to_q __P((char *cp, int cc, struct clist *q));
  230 void     catq __P((struct clist *from, struct clist *to));
  231 void     clist_alloc_cblocks __P((struct clist *q, int ccmax, int ccres));
  232 void     clist_free_cblocks __P((struct clist *q));
  233 int      getc __P((struct clist *q));
  234 void     ndflush __P((struct clist *q, int cc));
  235 char    *nextc __P((struct clist *q, char *cp, int *c));
  236 void     nottystop __P((struct tty *tp, int rw));
  237 int      putc __P((int c, struct clist *q));
  238 int      q_to_b __P((struct clist *q, char *cp, int cc));
  239 void     termioschars __P((struct termios *t));
  240 int      tputchar __P((int c, struct tty *tp));
  241 int      ttcompat __P((struct tty *tp, u_long com, caddr_t data, int flag));
  242 int      ttioctl __P((struct tty *tp, u_long com, void *data, int flag));
  243 int      ttread __P((struct tty *tp, struct uio *uio, int flag));
  244 void     ttrstrt __P((void *tp));
  245 int      ttsetcompat __P((struct tty *tp, u_long *com, caddr_t data,
  246             struct termios *term));
  247 void     ttsetwater __P((struct tty *tp));
  248 int      ttspeedtab __P((int speed, struct speedtab *table));
  249 int      ttstart __P((struct tty *tp));
  250 void     ttwakeup __P((struct tty *tp));
  251 int      ttwrite __P((struct tty *tp, struct uio *uio, int flag));
  252 void     ttwwakeup __P((struct tty *tp));
  253 void     ttyblock __P((struct tty *tp));
  254 void     ttychars __P((struct tty *tp));
  255 int      ttycheckoutq __P((struct tty *tp, int wait));
  256 int      ttyclose __P((struct tty *tp));
  257 void     ttyflush __P((struct tty *tp, int rw));
  258 void     ttyfree __P((struct tty *tp));
  259 void     ttyinfo __P((struct tty *tp));
  260 int      ttyinput __P((int c, struct tty *tp));
  261 int      ttylclose __P((struct tty *tp, int flag));
  262 struct tty *ttymalloc __P((struct tty *tp));
  263 int      ttymodem __P((struct tty *tp, int flag));
  264 int      ttyopen __P((dev_t device, struct tty *tp));
  265 int      ttypoll __P((dev_t dev, int events, struct proc *p));
  266 int      ttykqfilter __P((dev_t dev, struct knote *kn));
  267 int      ttyread __P((dev_t dev, struct uio *uio, int flag));
  268 void     ttyregister __P((struct tty *tp));
  269 int      ttysleep __P((struct tty *tp, void *chan, int pri, char *wmesg,
  270             int timeout));
  271 int      ttywait __P((struct tty *tp));
  272 int      ttywrite __P((dev_t dev, struct uio *uio, int flag));
  273 int      unputc __P((struct clist *q));
  274 
  275 #endif /* _KERNEL */
  276 
  277 #endif /* !_SYS_TTY_H_ */

Cache object: ce6d347cef0f8f131f15aec40cb1045d


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