bsd/sys/tty.h

   1 /*
   2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* Copyright (c) 1997 Apple Computer, Inc. All Rights Reserved */
  29 /*-
  30  * Copyright (c) 1982, 1986, 1993
  31  *      The Regents of the University of California.  All rights reserved.
  32  * (c) UNIX System Laboratories, Inc.
  33  * All or some portions of this file are derived from material licensed
  34  * to the University of California by American Telephone and Telegraph
  35  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  36  * the permission of UNIX System Laboratories, Inc.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  * 1. Redistributions of source code must retain the above copyright
  42  *    notice, this list of conditions and the following disclaimer.
  43  * 2. Redistributions in binary form must reproduce the above copyright
  44  *    notice, this list of conditions and the following disclaimer in the
  45  *    documentation and/or other materials provided with the distribution.
  46  * 3. All advertising materials mentioning features or use of this software
  47  *    must display the following acknowledgement:
  48  *      This product includes software developed by the University of
  49  *      California, Berkeley and its contributors.
  50  * 4. Neither the name of the University nor the names of its contributors
  51  *    may be used to endorse or promote products derived from this software
  52  *    without specific prior written permission.
  53  *
  54  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  55  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  56  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  57  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  58  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  59  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  60  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  61  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  62  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  63  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  64  * SUCH DAMAGE.
  65  *
  66  *      @(#)tty.h       8.6 (Berkeley) 1/21/94
  67  */
  68
  69 #ifndef _SYS_TTY_H_
  70 #define _SYS_TTY_H_
  71
  72 #include <sys/appleapiopts.h>
  73 #include <sys/cdefs.h>
  74 #include <sys/termios.h>
  75 #include <sys/select.h>         /* For struct selinfo. */
  76
  77
  78 #ifdef KERNEL
  79 /*
  80  * NetBSD Clists are actually ring buffers. The c_cc, c_cf, c_cl fields have
  81  * exactly the same behaviour as in true clists.
  82  * if c_cq is NULL, the ring buffer has no TTY_QUOTE functionality
  83  * (but, saves memory and cpu time)
  84  *
  85  * *DON'T* play with c_cs, c_ce, c_cq, or c_cl outside tty_subr.c!!!
  86  */
  87 struct clist {
  88         int     c_cc;           /* count of characters in queue */
  89         int     c_cn;           /* total ring buffer length */
  90         u_char  *c_cf;          /* points to first character */
  91         u_char  *c_cl;          /* points to next open character */
  92         u_char  *c_cs;          /* start of ring buffer */
  93         u_char  *c_ce;          /* c_ce + c_len */
  94         u_char  *c_cq;          /* N bits/bytes long, see tty_subr.c */
  95 };
  96
  97 #ifndef TTYCLSIZE
  98 #define TTYCLSIZE 1024
  99 #endif
 100
 101
 102 /*
 103  * Per-tty structure.
 104  *
 105  * Should be split in two, into device and tty drivers.
 106  * Glue could be masks of what to echo and circular buffer
 107  * (low, high, timeout).
 108  */
 109 struct tty {
 110         struct  clist t_rawq;           /* Device raw input queue. */
 111         long    t_rawcc;                /* Raw input queue statistics. */
 112         struct  clist t_canq;           /* Device canonical queue. */
 113         long    t_cancc;                /* Canonical queue statistics. */
 114         struct  clist t_outq;           /* Device output queue. */
 115         long    t_outcc;                /* Output queue statistics. */
 116         int     t_line;                 /* Interface to device drivers. */
 117         dev_t   t_dev;                  /* Device. */
 118         int     t_state;                /* Device and driver (TS*) state. */
 119         int     t_flags;                /* Tty flags. */
 120         int     t_timeout;              /* Timeout for ttywait() */
 121         struct  pgrp *t_pgrp;           /* Foreground process group. */
 122         struct  session *t_session;     /* Enclosing session. */
 123         struct  selinfo t_rsel;         /* Tty read/oob select. */
 124         struct  selinfo t_wsel;         /* Tty write select. */
 125         struct  termios t_termios;      /* Termios state. */
 126         struct  winsize t_winsize;      /* Window size. */
 127                                         /* Start output. */
 128         void    (*t_oproc)(struct tty *);
 129                                         /* Stop output. */
 130         void    (*t_stop)(struct tty *, int);
 131                                         /* Set hardware state. */
 132         int     (*t_param)(struct tty *, struct termios *);
 133         void    *t_sc;                  /* XXX: net/if_sl.c:sl_softc. */
 134         int     t_column;               /* Tty output column. */
 135         int     t_rocount, t_rocol;     /* Tty. */
 136         int     t_hiwat;                /* High water mark. */
 137         int     t_lowat;                /* Low water mark. */
 138         int     t_gen;                  /* Generation number. */
 139 };
 140
 141 #define t_cc            t_termios.c_cc
 142 #define t_cflag         t_termios.c_cflag
 143 #define t_iflag         t_termios.c_iflag
 144 #define t_ispeed        t_termios.c_ispeed
 145 #define t_lflag         t_termios.c_lflag
 146 #define t_min           t_termios.c_min
 147 #define t_oflag         t_termios.c_oflag
 148 #define t_ospeed        t_termios.c_ospeed
 149 #define t_time          t_termios.c_time
 150
 151
 152 #define TTIPRI  25                      /* Sleep priority for tty reads. */
 153 #define TTOPRI  26                      /* Sleep priority for tty writes. */
 154
 155 /*
 156  * User data unfortunately has to be copied through buffers on the way to
 157  * and from clists.  The buffers are on the stack so their sizes must be
 158  * fairly small.
 159  */
 160 #define IBUFSIZ 384                     /* Should be >= max value of MIN. */
 161 #define OBUFSIZ 100
 162
 163 #ifndef TTYHOG
 164 #define TTYHOG  1024
 165 #endif
 166
 167 #define TTMAXHIWAT      roundup(2048, CBSIZE)
 168 #define TTMINHIWAT      roundup(100, CBSIZE)
 169 #define TTMAXLOWAT      256
 170 #define TTMINLOWAT      32
 171 #else
 172 struct tty;
 173 struct clist;
 174 #endif /* KERNEL */
 175
 176 /* These flags are kept in t_state. */
 177 #define TS_SO_OLOWAT    0x00001         /* Wake up when output <= low water. */
 178 #define TS_ASYNC        0x00002         /* Tty in async I/O mode. */
 179 #define TS_BUSY         0x00004         /* Draining output. */
 180 #define TS_CARR_ON      0x00008         /* Carrier is present. */
 181 #define TS_FLUSH        0x00010         /* Outq has been flushed during DMA. */
 182 #define TS_ISOPEN       0x00020         /* Open has completed. */
 183 #define TS_TBLOCK       0x00040         /* Further input blocked. */
 184 #define TS_TIMEOUT      0x00080         /* Wait for output char processing. */
 185 #define TS_TTSTOP       0x00100         /* Output paused. */
 186 #ifdef notyet
 187 #define TS_WOPEN        0x00200         /* Open in progress. */
 188 #endif
 189 #define TS_XCLUDE       0x00400         /* Tty requires exclusivity. */
 190
 191 /* State for intra-line fancy editing work. */
 192 #define TS_BKSL         0x00800         /* State for lowercase \ work. */
 193 #define TS_CNTTB        0x01000         /* Counting tab width, ignore FLUSHO. */
 194 #define TS_ERASE        0x02000         /* Within a \.../ for PRTRUB. */
 195 #define TS_LNCH         0x04000         /* Next character is literal. */
 196 #define TS_TYPEN        0x08000         /* Retyping suspended input (PENDIN). */
 197 #define TS_LOCAL        (TS_BKSL | TS_CNTTB | TS_ERASE | TS_LNCH | TS_TYPEN)
 198
 199 /* Extras. */
 200 #define TS_CAN_BYPASS_L_RINT 0x010000   /* Device in "raw" mode. */
 201 #define TS_CONNECTED    0x020000        /* Connection open. */
 202 #define TS_SNOOP        0x040000        /* Device is being snooped on. */
 203 #define TS_SO_OCOMPLETE 0x080000        /* Wake up when output completes. */
 204 #define TS_ZOMBIE       0x100000        /* Connection lost. */
 205
 206 /* Hardware flow-control-invoked bits. */
 207 #define TS_CAR_OFLOW    0x200000        /* For MDMBUF (XXX handle in driver). */
 208 #ifdef notyet
 209 #define TS_CTS_OFLOW    0x400000        /* For CCTS_OFLOW. */
 210 #define TS_DSR_OFLOW    0x800000        /* For CDSR_OFLOW. */
 211 #endif
 212
 213
 214 /* Character type information. */
 215 #define ORDINARY        0
 216 #define CONTROL         1
 217 #define BACKSPACE       2
 218 #define NEWLINE         3
 219 #define TAB             4
 220 #define VTAB            5
 221 #define RETURN          6
 222
 223 struct speedtab {
 224         int sp_speed;                   /* Speed. */
 225         int sp_code;                    /* Code. */
 226 };
 227
 228 /* Modem control commands (driver). */
 229 #define DMSET           0
 230 #define DMBIS           1
 231 #define DMBIC           2
 232 #define DMGET           3
 233
 234 /* Flags on a character passed to ttyinput. */
 235 #define TTY_CHARMASK    0x000000ff      /* Character mask */
 236 #define TTY_QUOTE       0x00000100      /* Character quoted */
 237 #define TTY_ERRORMASK   0xff000000      /* Error mask */
 238 #define TTY_FE          0x01000000      /* Framing error */
 239 #define TTY_PE          0x02000000      /* Parity error */
 240 #define TTY_OE          0x04000000      /* Overrun error */
 241 #define TTY_BI          0x08000000      /* Break condition */
 242
 243 #ifdef KERNEL
 244 /* Is tp controlling terminal for p? */
 245 #define isctty(p, tp)                                                   \
 246         ((p)->p_session == (tp)->t_session && (p)->p_flag & P_CONTROLT)
 247
 248 /* Is p in background of tp? */
 249 #define isbackground(p, tp)                                             \
 250         (isctty((p), (tp)) && (p)->p_pgrp != (tp)->t_pgrp)
 251
 252 /* Unique sleep addresses. */
 253 #define TSA_CARR_ON(tp)         ((void *)&(tp)->t_rawq)
 254 #define TSA_HUP_OR_INPUT(tp)    ((void *)&(tp)->t_rawq.c_cf)
 255 #define TSA_OCOMPLETE(tp)       ((void *)&(tp)->t_outq.c_cl)
 256 #define TSA_OLOWAT(tp)          ((void *)&(tp)->t_outq)
 257 #define TSA_PTC_READ(tp)        ((void *)&(tp)->t_outq.c_cf)
 258 #define TSA_PTC_WRITE(tp)       ((void *)&(tp)->t_rawq.c_cl)
 259 #define TSA_PTS_READ(tp)        ((void *)&(tp)->t_canq)
 260
 261
 262 __BEGIN_DECLS
 263
 264 int      b_to_q(const u_char *cp, int cc, struct clist *q);
 265 void     catq(struct clist *from, struct clist *to);
 266 void     clist_init(void);
 267 int      getc(struct clist *q);
 268 void     ndflush(struct clist *q, int cc);
 269 int      ndqb(struct clist *q, int flag);
 270 u_char  *firstc          (struct clist *clp, int *c);
 271 u_char  *nextc(struct clist *q, u_char *cp, int *c);
 272 int      putc(int c, struct clist *q);
 273 int      q_to_b(struct clist *q, u_char *cp, int cc);
 274 int      unputc(struct clist *q);
 275 int      clalloc(struct clist *clp, int size, int quot);
 276 void     clfree(struct clist *clp);
 277 void    cinit(void);
 278 void    clrbits(u_char *cp, int off, int len);
 279
 280 #ifdef KERNEL_PRIVATE
 281 int     ttcompat(struct tty *tp, u_long com, caddr_t data, int flag,
 282             struct proc *p);
 283 int     ttsetcompat(struct tty *tp, u_long *com, caddr_t data, struct termios *term);
 284 #endif /* KERNEL_PRIVATE */
 285
 286 void     termioschars(struct termios *t);
 287 int      tputchar(int c, struct tty *tp);
 288 int      ttioctl(struct tty *tp, u_long com, caddr_t data, int flag,
 289             struct proc *p);
 290 int      ttread(struct tty *tp, struct uio *uio, int flag);
 291 void     ttrstrt(void *tp);
 292 int      ttyselect(struct tty *tp, int rw, void * wql, struct proc *p);
 293 int      ttselect(dev_t dev, int rw, void * wql, struct proc *p);
 294 void     ttsetwater(struct tty *tp);
 295 int      ttspeedtab(int speed, struct speedtab *table);
 296 int      ttstart(struct tty *tp);
 297 void     ttwakeup(struct tty *tp);
 298 int      ttwrite(struct tty *tp, struct uio *uio, int flag);
 299 void     ttwwakeup(struct tty *tp);
 300 void     ttyblock(struct tty *tp);
 301 void     ttychars(struct tty *tp);
 302 int      ttycheckoutq(struct tty *tp, int wait);
 303 int      ttyclose(struct tty *tp);
 304 void     ttyflush(struct tty *tp, int rw);
 305 void     ttyinfo(struct tty *tp);
 306 int      ttyinput(int c, struct tty *tp);
 307 int      ttylclose(struct tty *tp, int flag);
 308 int      ttymodem(struct tty *tp, int flag);
 309 int      ttyopen(dev_t device, struct tty *tp);
 310 int      ttysleep(struct tty *tp,
 311             void *chan, int pri, const char *wmesg, int timeout);
 312 int      ttywait(struct tty *tp);
 313 struct tty *ttymalloc(void);
 314 void     ttyfree(struct tty *);
 315
 316 __END_DECLS
 317
 318 #endif /* KERNEL */
 319
 320
 321 #endif /* !_SYS_TTY_H_ */