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