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/3/sys/sys/tty.h 50583 1999-08-29 16:33:42Z peter $
   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 
   48 /*
   49  * Clists are character lists, which is a variable length linked list
   50  * of cblocks, with a count of the number of characters in the list.
   51  */
   52 struct clist {
   53         int     c_cc;           /* Number of characters in the clist. */
   54         int     c_cbcount;      /* Number of cblocks. */
   55         int     c_cbmax;        /* Max # cblocks allowed for this clist. */
   56         int     c_cbreserved;   /* # cblocks reserved for this clist. */
   57         char    *c_cf;          /* Pointer to the first cblock. */
   58         char    *c_cl;          /* Pointer to the last cblock. */
   59 };
   60 
   61 /*
   62  * Per-tty structure.
   63  *
   64  * Should be split in two, into device and tty drivers.
   65  * Glue could be masks of what to echo and circular buffer
   66  * (low, high, timeout).
   67  */
   68 struct tty {
   69         struct  clist t_rawq;           /* Device raw input queue. */
   70         long    t_rawcc;                /* Raw input queue statistics. */
   71         struct  clist t_canq;           /* Device canonical queue. */
   72         long    t_cancc;                /* Canonical queue statistics. */
   73         struct  clist t_outq;           /* Device output queue. */
   74         long    t_outcc;                /* Output queue statistics. */
   75         int     t_line;                 /* Interface to device drivers. */
   76         dev_t   t_dev;                  /* Device. */
   77         int     t_state;                /* Device and driver (TS*) state. */
   78         int     t_flags;                /* Tty flags. */
   79         int     t_timeout;              /* Timeout for ttywait() */
   80         struct  pgrp *t_pgrp;           /* Foreground process group. */
   81         struct  session *t_session;     /* Enclosing session. */
   82         struct  sigio *t_sigio;         /* Information for async I/O. */
   83         struct  selinfo t_rsel;         /* Tty read/oob select. */
   84         struct  selinfo t_wsel;         /* Tty write select. */
   85         struct  termios t_termios;      /* Termios state. */
   86         struct  winsize t_winsize;      /* Window size. */
   87                                         /* Start output. */
   88         void    (*t_oproc) __P((struct tty *));
   89                                         /* Stop output. */
   90         void    (*t_stop) __P((struct tty *, int));
   91                                         /* Set hardware state. */
   92         int     (*t_param) __P((struct tty *, struct termios *));
   93         void    *t_sc;                  /* XXX: net/if_sl.c:sl_softc. */
   94         int     t_column;               /* Tty output column. */
   95         int     t_rocount, t_rocol;     /* Tty. */
   96         int     t_ififosize;            /* Total size of upstream fifos. */
   97         int     t_ihiwat;               /* High water mark for input. */
   98         int     t_ilowat;               /* Low water mark for input. */
   99         speed_t t_ispeedwat;            /* t_ispeed override for watermarks. */
  100         int     t_ohiwat;               /* High water mark for output. */
  101         int     t_olowat;               /* Low water mark for output. */
  102         speed_t t_ospeedwat;            /* t_ospeed override for watermarks. */
  103         int     t_gen;                  /* Generation number. */
  104 };
  105 
  106 #define t_cc            t_termios.c_cc
  107 #define t_cflag         t_termios.c_cflag
  108 #define t_iflag         t_termios.c_iflag
  109 #define t_ispeed        t_termios.c_ispeed
  110 #define t_lflag         t_termios.c_lflag
  111 #define t_min           t_termios.c_min
  112 #define t_oflag         t_termios.c_oflag
  113 #define t_ospeed        t_termios.c_ospeed
  114 #define t_time          t_termios.c_time
  115 
  116 #define TTIPRI  25                      /* Sleep priority for tty reads. */
  117 #define TTOPRI  26                      /* Sleep priority for tty writes. */
  118 
  119 /*
  120  * User data unfortunately has to be copied through buffers on the way to
  121  * and from clists.  The buffers are on the stack so their sizes must be
  122  * fairly small.
  123  */
  124 #define IBUFSIZ 384                     /* Should be >= max value of MIN. */
  125 #define OBUFSIZ 100
  126 
  127 #ifndef TTYHOG
  128 #define TTYHOG  1024
  129 #endif
  130 
  131 #ifdef KERNEL
  132 #define TTMAXHIWAT      roundup(2048, CBSIZE)
  133 #define TTMINHIWAT      roundup(100, CBSIZE)
  134 #define TTMAXLOWAT      256
  135 #define TTMINLOWAT      32
  136 #endif
  137 
  138 /* These flags are kept in t_state. */
  139 #define TS_SO_OLOWAT    0x00001         /* Wake up when output <= low water. */
  140 #define TS_ASYNC        0x00002         /* Tty in async I/O mode. */
  141 #define TS_BUSY         0x00004         /* Draining output. */
  142 #define TS_CARR_ON      0x00008         /* Carrier is present. */
  143 #define TS_FLUSH        0x00010         /* Outq has been flushed during DMA. */
  144 #define TS_ISOPEN       0x00020         /* Open has completed. */
  145 #define TS_TBLOCK       0x00040         /* Further input blocked. */
  146 #define TS_TIMEOUT      0x00080         /* Wait for output char processing. */
  147 #define TS_TTSTOP       0x00100         /* Output paused. */
  148 #ifdef notyet
  149 #define TS_WOPEN        0x00200         /* Open in progress. */
  150 #endif
  151 #define TS_XCLUDE       0x00400         /* Tty requires exclusivity. */
  152 
  153 /* State for intra-line fancy editing work. */
  154 #define TS_BKSL         0x00800         /* State for lowercase \ work. */
  155 #define TS_CNTTB        0x01000         /* Counting tab width, ignore FLUSHO. */
  156 #define TS_ERASE        0x02000         /* Within a \.../ for PRTRUB. */
  157 #define TS_LNCH         0x04000         /* Next character is literal. */
  158 #define TS_TYPEN        0x08000         /* Retyping suspended input (PENDIN). */
  159 #define TS_LOCAL        (TS_BKSL | TS_CNTTB | TS_ERASE | TS_LNCH | TS_TYPEN)
  160 
  161 /* Extras. */
  162 #define TS_CAN_BYPASS_L_RINT 0x010000   /* Device in "raw" mode. */
  163 #define TS_CONNECTED    0x020000        /* Connection open. */
  164 #define TS_SNOOP        0x040000        /* Device is being snooped on. */
  165 #define TS_SO_OCOMPLETE 0x080000        /* Wake up when output completes. */
  166 #define TS_ZOMBIE       0x100000        /* Connection lost. */
  167 
  168 /* Hardware flow-control-invoked bits. */
  169 #define TS_CAR_OFLOW    0x200000        /* For MDMBUF (XXX handle in driver). */
  170 #ifdef notyet
  171 #define TS_CTS_OFLOW    0x400000        /* For CCTS_OFLOW. */
  172 #define TS_DSR_OFLOW    0x800000        /* For CDSR_OFLOW. */
  173 #endif
  174 
  175 /* Character type information. */
  176 #define ORDINARY        0
  177 #define CONTROL         1
  178 #define BACKSPACE       2
  179 #define NEWLINE         3
  180 #define TAB             4
  181 #define VTAB            5
  182 #define RETURN          6
  183 
  184 struct speedtab {
  185         int sp_speed;                   /* Speed. */
  186         int sp_code;                    /* Code. */
  187 };
  188 
  189 /* Modem control commands (driver). */
  190 #define DMSET           0
  191 #define DMBIS           1
  192 #define DMBIC           2
  193 #define DMGET           3
  194 
  195 /* Flags on a character passed to ttyinput. */
  196 #define TTY_CHARMASK    0x000000ff      /* Character mask */
  197 #define TTY_QUOTE       0x00000100      /* Character quoted */
  198 #define TTY_ERRORMASK   0xff000000      /* Error mask */
  199 #define TTY_FE          0x01000000      /* Framing error */
  200 #define TTY_PE          0x02000000      /* Parity error */
  201 #define TTY_OE          0x04000000      /* Overrun error */
  202 #define TTY_BI          0x08000000      /* Break condition */
  203 
  204 /* Is tp controlling terminal for p? */
  205 #define isctty(p, tp)                                                   \
  206         ((p)->p_session == (tp)->t_session && (p)->p_flag & P_CONTROLT)
  207 
  208 /* Is p in background of tp? */
  209 #define isbackground(p, tp)                                             \
  210         (isctty((p), (tp)) && (p)->p_pgrp != (tp)->t_pgrp)
  211 
  212 /* Unique sleep addresses. */
  213 #define TSA_CARR_ON(tp)         ((void *)&(tp)->t_rawq)
  214 #define TSA_HUP_OR_INPUT(tp)    ((void *)&(tp)->t_rawq.c_cf)
  215 #define TSA_OCOMPLETE(tp)       ((void *)&(tp)->t_outq.c_cl)
  216 #define TSA_OLOWAT(tp)          ((void *)&(tp)->t_outq)
  217 #define TSA_PTC_READ(tp)        ((void *)&(tp)->t_outq.c_cf)
  218 #define TSA_PTC_WRITE(tp)       ((void *)&(tp)->t_rawq.c_cl)
  219 #define TSA_PTS_READ(tp)        ((void *)&(tp)->t_canq)
  220 
  221 #ifdef KERNEL
  222 #ifdef MALLOC_DECLARE
  223 MALLOC_DECLARE(M_TTYS);
  224 #endif
  225 extern  struct tty *constty;    /* Temporary virtual console. */
  226 
  227 int      b_to_q __P((char *cp, int cc, struct clist *q));
  228 void     catq __P((struct clist *from, struct clist *to));
  229 void     clist_alloc_cblocks __P((struct clist *q, int ccmax, int ccres));
  230 void     clist_free_cblocks __P((struct clist *q));
  231 /* void  clist_init __P((void)); */ /* defined in systm.h for main() */
  232 int      getc __P((struct clist *q));
  233 void     ndflush __P((struct clist *q, int cc));
  234 int      ndqb __P((struct clist *q, int flag));
  235 char    *nextc __P((struct clist *q, char *cp, int *c));
  236 int      putc __P((int c, struct clist *q));
  237 int      q_to_b __P((struct clist *q, char *cp, int cc));
  238 int      unputc __P((struct clist *q));
  239 
  240 int     ttcompat __P((struct tty *tp, u_long com, caddr_t data, int flag));
  241 int     ttsetcompat __P((struct tty *tp, u_long *com, caddr_t data, struct termios *term));
  242 
  243 void     termioschars __P((struct termios *t));
  244 int      tputchar __P((int c, struct tty *tp));
  245 int      ttioctl __P((struct tty *tp, u_long com, void *data, int flag));
  246 int      ttread __P((struct tty *tp, struct uio *uio, int flag));
  247 void     ttrstrt __P((void *tp));
  248 int      ttypoll __P((struct tty *tp, int events, struct proc *p));
  249 int      ttpoll __P((dev_t dev, int events, struct proc *p));
  250 void     ttsetwater __P((struct tty *tp));
  251 int      ttspeedtab __P((int speed, struct speedtab *table));
  252 int      ttstart __P((struct tty *tp));
  253 void     ttwakeup __P((struct tty *tp));
  254 int      ttwrite __P((struct tty *tp, struct uio *uio, int flag));
  255 void     ttwwakeup __P((struct tty *tp));
  256 void     ttyblock __P((struct tty *tp));
  257 void     ttychars __P((struct tty *tp));
  258 int      ttycheckoutq __P((struct tty *tp, int wait));
  259 int      ttyclose __P((struct tty *tp));
  260 void     ttyflush __P((struct tty *tp, int rw));
  261 void     ttyinfo __P((struct tty *tp));
  262 int      ttyinput __P((int c, struct tty *tp));
  263 int      ttylclose __P((struct tty *tp, int flag));
  264 int      ttymodem __P((struct tty *tp, int flag));
  265 int      ttyopen __P((dev_t device, struct tty *tp));
  266 int      ttysleep __P((struct tty *tp,
  267             void *chan, int pri, char *wmesg, int timeout));
  268 int      ttywait __P((struct tty *tp));
  269 struct tty *ttymalloc __P((void));
  270 void     ttyfree __P((struct tty *));
  271 
  272 #endif /* KERNEL */
  273 
  274 #endif /* !_SYS_TTY_H_ */

Cache object: 7968fc5b7b5d6acb097ed821cbc78cd6


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