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__BEGIN_DECLS 81#include <kern/locks.h> 82__END_DECLS 83 84/* 85 * NetBSD Clists are actually ring buffers. The c_cc, c_cf, c_cl fields have 86 * exactly the same behaviour as in true clists. 87 * if c_cq is NULL, the ring buffer has no TTY_QUOTE functionality 88 * (but, saves memory and cpu time) 89 * 90 * *DON'T* play with c_cs, c_ce, c_cq, or c_cl outside tty_subr.c!!! 91 */ 92struct clist { 93 int c_cc; /* count of characters in queue */ 94 int c_cn; /* total ring buffer length */ 95 u_char *c_cf; /* points to first character */ 96 u_char *c_cl; /* points to next open character */ 97 u_char *c_cs; /* start of ring buffer */ 98 u_char *c_ce; /* c_ce + c_len */ 99 u_char *c_cq; /* N bits/bytes long, see tty_subr.c */ 100}; 101 102#ifndef TTYCLSIZE 103#define TTYCLSIZE 1024 104#endif 105 106 107/* 108 * Per-tty structure. 109 * 110 * Should be split in two, into device and tty drivers. 111 * Glue could be masks of what to echo and circular buffer 112 * (low, high, timeout). 113 */ 114struct tty { 115 lck_mtx_t t_lock; /* Per tty lock */ 116 117 struct clist t_rawq; /* Device raw input queue. */ 118 long t_rawcc; /* Raw input queue statistics. */ 119 struct clist t_canq; /* Device canonical queue. */ 120 long t_cancc; /* Canonical queue statistics. */ 121 struct clist t_outq; /* Device output queue. */ 122 long t_outcc; /* Output queue statistics. */ 123 int t_line; /* Interface to device drivers. */ 124 dev_t t_dev; /* Device. */ 125 int t_state; /* Device and driver (TS*) state. */ 126 int t_flags; /* Tty flags. */ 127 int t_timeout; /* Timeout for ttywait() */ 128 struct pgrp *t_pgrp; /* Foreground process group. */ 129 struct session *t_session; /* Enclosing session. */ 130 struct selinfo t_rsel; /* Tty read/oob select. */ 131 struct selinfo t_wsel; /* Tty write select. */ 132 struct termios t_termios; /* Termios state. */ 133 struct winsize t_winsize; /* Window size. */ 134 /* Start output. */ 135 void (*t_oproc)(struct tty *); 136 /* Stop output. */ 137 void (*t_stop)(struct tty *, int); 138 /* Set hardware state. */ 139 int (*t_param)(struct tty *, struct termios *); 140 void *t_sc; /* XXX: net/if_sl.c:sl_softc. */ 141 int t_column; /* Tty output column. */ 142 int t_rocount, t_rocol; /* Tty. */ 143 int t_hiwat; /* High water mark. */ 144 int t_lowat; /* Low water mark. */ 145 int t_gen; /* Generation number. */ 146 void *t_iokit; /* IOKit management */ 147 int t_refcnt; /* reference count */ 148}; 149 150#define TTY_NULL (struct tty *)0 151 152#define t_cc t_termios.c_cc 153#define t_cflag t_termios.c_cflag 154#define t_iflag t_termios.c_iflag 155#define t_ispeed t_termios.c_ispeed 156#define t_lflag t_termios.c_lflag 157#define t_min t_termios.c_min 158#define t_oflag t_termios.c_oflag 159#define t_ospeed t_termios.c_ospeed 160#define t_time t_termios.c_time 161 162 163#define TTIPRI 25 /* Sleep priority for tty reads. */ 164#define TTOPRI 26 /* Sleep priority for tty writes. */ 165 166/* 167 * User data unfortunately has to be copied through buffers on the way to 168 * and from clists. The buffers are on the stack so their sizes must be 169 * fairly small. 170 */ 171#define IBUFSIZ 384 /* Should be >= max value of MIN. */ 172#define OBUFSIZ 100 173 174#ifndef TTYHOG 175#define TTYHOG 1024 176#endif 177 178#define TTMAXHIWAT roundup(2048, CBSIZE) 179#define TTMINHIWAT roundup(100, CBSIZE) 180#define TTMAXLOWAT 256 181#define TTMINLOWAT 32 182#else 183struct tty; 184struct clist; 185#endif /* KERNEL */ 186 187/* These flags are kept in t_state. */ 188#define TS_SO_OLOWAT 0x00001 /* Wake up when output <= low water. */ 189#define TS_ASYNC 0x00002 /* Tty in async I/O mode. */ 190#define TS_BUSY 0x00004 /* Draining output. */ 191#define TS_CARR_ON 0x00008 /* Carrier is present. */ 192#define TS_FLUSH 0x00010 /* Outq has been flushed during DMA. */ 193#define TS_ISOPEN 0x00020 /* Open has completed. */ 194#define TS_TBLOCK 0x00040 /* Further input blocked. */ 195#define TS_TIMEOUT 0x00080 /* Wait for output char processing. */ 196#define TS_TTSTOP 0x00100 /* Output paused. */ 197#ifdef notyet 198#define TS_WOPEN 0x00200 /* Open in progress. */ 199#endif 200#define TS_XCLUDE 0x00400 /* Tty requires exclusivity. */ 201 202/* State for intra-line fancy editing work. */ 203#define TS_BKSL 0x00800 /* State for lowercase \ work. */ 204#define TS_CNTTB 0x01000 /* Counting tab width, ignore FLUSHO. */ 205#define TS_ERASE 0x02000 /* Within a \.../ for PRTRUB. */ 206#define TS_LNCH 0x04000 /* Next character is literal. */ 207#define TS_TYPEN 0x08000 /* Retyping suspended input (PENDIN). */ 208#define TS_LOCAL (TS_BKSL | TS_CNTTB | TS_ERASE | TS_LNCH | TS_TYPEN) 209 210/* Extras. */ 211#define TS_CAN_BYPASS_L_RINT 0x010000 /* Device in "raw" mode. */ 212#define TS_CONNECTED 0x020000 /* Connection open. */ 213#define TS_SNOOP 0x040000 /* Device is being snooped on. */ 214#define TS_SO_OCOMPLETE 0x080000 /* Wake up when output completes. */ 215#define TS_ZOMBIE 0x100000 /* Connection lost. */ 216 217/* Hardware flow-control-invoked bits. */ 218#define TS_CAR_OFLOW 0x200000 /* For MDMBUF (XXX handle in driver). */ 219#ifdef notyet 220#define TS_CTS_OFLOW 0x400000 /* For CCTS_OFLOW. */ 221#define TS_DSR_OFLOW 0x800000 /* For CDSR_OFLOW. */ 222#endif 223 224#define TS_IOCTL_NOT_OK 0x1000000 /* Workaround <rdar://....> */ 225 226 227/* Character type information. */ 228#define ORDINARY 0 229#define CONTROL 1 230#define BACKSPACE 2 231#define NEWLINE 3 232#define TAB 4 233#define VTAB 5 234#define RETURN 6 235 236struct speedtab { 237 int sp_speed; /* Speed. */ 238 int sp_code; /* Code. */ 239}; 240 241/* Modem control commands (driver). */ 242#define DMSET 0 243#define DMBIS 1 244#define DMBIC 2 245#define DMGET 3 246 247/* Flags on a character passed to ttyinput. */ 248#define TTY_CHARMASK 0x000000ff /* Character mask */ 249#define TTY_QUOTE 0x00000100 /* Character quoted */ 250#define TTY_ERRORMASK 0xff000000 /* Error mask */ 251#define TTY_FE 0x01000000 /* Framing error */ 252#define TTY_PE 0x02000000 /* Parity error */ 253#define TTY_OE 0x04000000 /* Overrun error */ 254#define TTY_BI 0x08000000 /* Break condition */ 255 256#ifdef KERNEL 257 258/* Unique sleep addresses. */ 259#define TSA_CARR_ON(tp) ((void *)&(tp)->t_rawq) 260#define TSA_HUP_OR_INPUT(tp) ((void *)&(tp)->t_rawq.c_cf) 261#define TSA_OCOMPLETE(tp) ((void *)&(tp)->t_outq.c_cl) 262#define TSA_OLOWAT(tp) ((void *)&(tp)->t_outq) 263#define TSA_PTC_READ(tp) ((void *)&(tp)->t_outq.c_cf) 264#define TSA_PTC_WRITE(tp) ((void *)&(tp)->t_rawq.c_cl) 265#define TSA_PTS_READ(tp) ((void *)&(tp)->t_canq) 266 267 268__BEGIN_DECLS 269 270int b_to_q(const u_char *cp, int cc, struct clist *q); 271void catq(struct clist *from, struct clist *to); 272void clist_init(void); 273int getc(struct clist *q); 274void ndflush(struct clist *q, int cc); 275int ndqb(struct clist *q, int flag); 276u_char *firstc (struct clist *clp, int *c); 277u_char *nextc(struct clist *q, u_char *cp, int *c); 278int putc(int c, struct clist *q); 279int q_to_b(struct clist *q, u_char *cp, int cc); 280int unputc(struct clist *q); 281int clalloc(struct clist *clp, int size, int quot); 282void clfree(struct clist *clp); 283void cinit(void); 284void clrbits(u_char *cp, int off, int len); 285 286#ifdef KERNEL_PRIVATE 287void tty_init(void); 288/* 289 * The locked version of this function is used from routines which hold 290 * the tty_lock(), such as ttcompat() in tty_compat.c 291 */ 292int ttioctl_locked(struct tty *tp, u_long com, caddr_t data, int flag, 293 struct proc *p); 294 295int ttcompat(struct tty *tp, u_long com, caddr_t data, int flag, 296 struct proc *p); 297#endif /* KERNEL_PRIVATE */ 298 299void tty_lock(struct tty *tp); 300void tty_unlock(struct tty *tp); 301 302void termioschars(struct termios *t); 303int tputchar(int c, struct tty *tp); 304int ttioctl(struct tty *tp, u_long com, caddr_t data, int flag, 305 struct proc *p); 306int ttread(struct tty *tp, struct uio *uio, int flag); 307int ttyselect(struct tty *tp, int rw, void * wql, struct proc *p); 308int ttselect(dev_t dev, int rw, void * wql, struct proc *p); 309void ttsetwater(struct tty *tp); 310int ttspeedtab(int speed, struct speedtab *table); 311int ttstart(struct tty *tp); 312void ttwakeup(struct tty *tp); 313int ttwrite(struct tty *tp, struct uio *uio, int flag); 314void ttwwakeup(struct tty *tp); 315void ttyblock(struct tty *tp); 316int ttycheckoutq(struct tty *tp, int wait); 317int ttyclose(struct tty *tp); /* LEGACY: avoid using */ 318void ttyflush(struct tty *tp, int rw); 319void ttyinfo(struct tty *tp); 320void ttyinfo_locked(struct tty *tp); 321int ttyinput(int c, struct tty *tp); 322int ttylclose(struct tty *tp, int flag); 323int ttymodem(struct tty *tp, int flag); 324int ttyopen(dev_t device, struct tty *tp); 325int ttysleep(struct tty *tp, 326 void *chan, int pri, const char *wmesg, int timeout); 327int ttywait(struct tty *tp); 328struct tty *ttymalloc(void); 329void ttyfree(struct tty *); 330 331__END_DECLS 332 333#endif /* KERNEL */ 334 335 336#endif /* !_SYS_TTY_H_ */ 337