sys/sys/tty.h

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