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