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