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