[apple/xnu.git] / bsd / sys / tty.h

/*
 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1997 Apple Computer, Inc. All Rights Reserved */
/*-
 * Copyright (c) 1982, 1986, 1993
 *	The Regents of the University of California.  All rights reserved.
 * (c) UNIX System Laboratories, Inc.
 * All or some portions of this file are derived from material licensed
 * to the University of California by American Telephone and Telegraph
 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
 * the permission of UNIX System Laboratories, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by the University of
 *      California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)tty.h	8.6 (Berkeley) 1/21/94
 */

#ifndef _SYS_TTY_H_
#define	_SYS_TTY_H_

#include <sys/appleapiopts.h>
#include <sys/cdefs.h>
#include <sys/termios.h>
#include <sys/select.h>		/* For struct selinfo. */


#ifdef KERNEL

__BEGIN_DECLS
#include <kern/locks.h>
__END_DECLS

/*
 * NetBSD Clists are actually ring buffers. The c_cc, c_cf, c_cl fields have
 * exactly the same behaviour as in true clists.
 * if c_cq is NULL, the ring buffer has no TTY_QUOTE functionality
 * (but, saves memory and cpu time)
 * 
 * *DON'T* play with c_cs, c_ce, c_cq, or c_cl outside tty_subr.c!!!
 */
struct clist {
	int	c_cc;		/* count of characters in queue */
	int	c_cn;		/* total ring buffer length */
	u_char	*c_cf;		/* points to first character */
	u_char	*c_cl;		/* points to next open character */
	u_char	*c_cs;		/* start of ring buffer */
	u_char	*c_ce;		/* c_ce + c_len */
	u_char	*c_cq;		/* N bits/bytes long, see tty_subr.c */
};

#ifndef TTYCLSIZE
#define TTYCLSIZE 1024
#endif


/*
 * Per-tty structure.
 *
 * Should be split in two, into device and tty drivers.
 * Glue could be masks of what to echo and circular buffer
 * (low, high, timeout).
 */
struct tty {
	lck_mtx_t	t_lock;		/* Per tty lock */

	struct	clist t_rawq;		/* Device raw input queue. */
	long	t_rawcc;		/* Raw input queue statistics. */
	struct	clist t_canq;		/* Device canonical queue. */
	long	t_cancc;		/* Canonical queue statistics. */
	struct	clist t_outq;		/* Device output queue. */
	long	t_outcc;		/* Output queue statistics. */
	int	t_line;			/* Interface to device drivers. */
	dev_t	t_dev;			/* Device. */
	int	t_state;		/* Device and driver (TS*) state. */
	int	t_flags;		/* Tty flags. */
	int     t_timeout;              /* Timeout for ttywait() */
	struct	pgrp *t_pgrp;		/* Foreground process group. */
	struct	session *t_session;	/* Enclosing session. */
	struct	selinfo t_rsel;		/* Tty read/oob select. */
	struct	selinfo t_wsel;		/* Tty write select. */
	struct	termios t_termios;	/* Termios state. */
	struct	winsize t_winsize;	/* Window size. */
					/* Start output. */
	void	(*t_oproc)(struct tty *);
					/* Stop output. */
	void	(*t_stop)(struct tty *, int);
					/* Set hardware state. */
	int	(*t_param)(struct tty *, struct termios *);
	void	*t_sc;			/* XXX: net/if_sl.c:sl_softc. */
	int	t_column;		/* Tty output column. */
	int	t_rocount, t_rocol;	/* Tty. */
	int	t_hiwat;		/* High water mark. */
	int	t_lowat;		/* Low water mark. */
	int	t_gen;			/* Generation number. */
	void	*t_iokit;		/* IOKit management */
};

#define TTY_NULL (struct tty *)0

#define	t_cc		t_termios.c_cc
#define	t_cflag		t_termios.c_cflag
#define	t_iflag		t_termios.c_iflag
#define	t_ispeed	t_termios.c_ispeed
#define	t_lflag		t_termios.c_lflag
#define	t_min		t_termios.c_min
#define	t_oflag		t_termios.c_oflag
#define	t_ospeed	t_termios.c_ospeed
#define	t_time		t_termios.c_time


#define	TTIPRI	25			/* Sleep priority for tty reads. */
#define	TTOPRI	26			/* Sleep priority for tty writes. */

/*
 * User data unfortunately has to be copied through buffers on the way to
 * and from clists.  The buffers are on the stack so their sizes must be
 * fairly small.
 */
#define	IBUFSIZ	384			/* Should be >= max value of MIN. */
#define	OBUFSIZ	100

#ifndef TTYHOG
#define	TTYHOG	1024
#endif

#define	TTMAXHIWAT	roundup(2048, CBSIZE)
#define	TTMINHIWAT	roundup(100, CBSIZE)
#define	TTMAXLOWAT	256
#define	TTMINLOWAT	32
#else
struct tty;
struct clist;
#endif /* KERNEL */

/* These flags are kept in t_state. */
#define	TS_SO_OLOWAT	0x00001		/* Wake up when output <= low water. */
#define	TS_ASYNC	0x00002		/* Tty in async I/O mode. */
#define	TS_BUSY		0x00004		/* Draining output. */
#define	TS_CARR_ON	0x00008		/* Carrier is present. */
#define	TS_FLUSH	0x00010		/* Outq has been flushed during DMA. */
#define	TS_ISOPEN	0x00020		/* Open has completed. */
#define	TS_TBLOCK	0x00040		/* Further input blocked. */
#define	TS_TIMEOUT	0x00080		/* Wait for output char processing. */
#define	TS_TTSTOP	0x00100		/* Output paused. */
#ifdef notyet
#define	TS_WOPEN	0x00200		/* Open in progress. */
#endif
#define	TS_XCLUDE	0x00400		/* Tty requires exclusivity. */

/* State for intra-line fancy editing work. */
#define	TS_BKSL		0x00800		/* State for lowercase \ work. */
#define	TS_CNTTB	0x01000		/* Counting tab width, ignore FLUSHO. */
#define	TS_ERASE	0x02000		/* Within a \.../ for PRTRUB. */
#define	TS_LNCH		0x04000		/* Next character is literal. */
#define	TS_TYPEN	0x08000		/* Retyping suspended input (PENDIN). */
#define	TS_LOCAL	(TS_BKSL | TS_CNTTB | TS_ERASE | TS_LNCH | TS_TYPEN)

/* Extras. */
#define	TS_CAN_BYPASS_L_RINT 0x010000	/* Device in "raw" mode. */
#define	TS_CONNECTED	0x020000	/* Connection open. */
#define	TS_SNOOP	0x040000	/* Device is being snooped on. */
#define	TS_SO_OCOMPLETE	0x080000	/* Wake up when output completes. */
#define	TS_ZOMBIE	0x100000	/* Connection lost. */

/* Hardware flow-control-invoked bits. */
#define	TS_CAR_OFLOW	0x200000	/* For MDMBUF (XXX handle in driver). */
#ifdef notyet
#define	TS_CTS_OFLOW	0x400000	/* For CCTS_OFLOW. */
#define	TS_DSR_OFLOW	0x800000	/* For CDSR_OFLOW. */
#endif

#define	TS_IOCTL_NOT_OK	0x1000000	/* Workaround <rdar://....> */


/* Character type information. */
#define	ORDINARY	0
#define	CONTROL		1
#define	BACKSPACE	2
#define	NEWLINE		3
#define	TAB		4
#define	VTAB		5
#define	RETURN		6

struct speedtab {
	int sp_speed;			/* Speed. */
	int sp_code;			/* Code. */
};

/* Modem control commands (driver). */
#define	DMSET		0
#define	DMBIS		1
#define	DMBIC		2
#define	DMGET		3

/* Flags on a character passed to ttyinput. */
#define	TTY_CHARMASK	0x000000ff	/* Character mask */
#define	TTY_QUOTE	0x00000100	/* Character quoted */
#define	TTY_ERRORMASK	0xff000000	/* Error mask */
#define	TTY_FE		0x01000000	/* Framing error */
#define	TTY_PE		0x02000000	/* Parity error */
#define	TTY_OE		0x04000000	/* Overrun error */
#define	TTY_BI		0x08000000	/* Break condition */

#ifdef KERNEL

/* Unique sleep addresses. */
#define	TSA_CARR_ON(tp)		((void *)&(tp)->t_rawq)
#define	TSA_HUP_OR_INPUT(tp)	((void *)&(tp)->t_rawq.c_cf)
#define	TSA_OCOMPLETE(tp)	((void *)&(tp)->t_outq.c_cl)
#define	TSA_OLOWAT(tp)		((void *)&(tp)->t_outq)
#define	TSA_PTC_READ(tp)	((void *)&(tp)->t_outq.c_cf)
#define	TSA_PTC_WRITE(tp)	((void *)&(tp)->t_rawq.c_cl)
#define	TSA_PTS_READ(tp)	((void *)&(tp)->t_canq)


__BEGIN_DECLS

int	 b_to_q(const u_char *cp, int cc, struct clist *q);
void	 catq(struct clist *from, struct clist *to);
void	 clist_init(void);
int	 getc(struct clist *q);
void	 ndflush(struct clist *q, int cc);
int	 ndqb(struct clist *q, int flag);
u_char	*firstc          (struct clist *clp, int *c);
u_char	*nextc(struct clist *q, u_char *cp, int *c);
int	 putc(int c, struct clist *q);
int	 q_to_b(struct clist *q, u_char *cp, int cc);
int	 unputc(struct clist *q);
int	 clalloc(struct clist *clp, int size, int quot);
void	 clfree(struct clist *clp);
void	cinit(void);
void	clrbits(u_char *cp, int off, int len);

#ifdef KERNEL_PRIVATE
void	tty_init(void);
/*
 * The locked version of this function is used from routines which hold
 * the tty_lock(), such as ttcompat() in tty_compat.c
 */
int	ttioctl_locked(struct tty *tp, u_long com, caddr_t data, int flag,
	    struct proc *p);

int	ttcompat(struct tty *tp, u_long com, caddr_t data, int flag,
	    struct proc *p);
#endif /* KERNEL_PRIVATE */

void tty_lock(struct tty *tp);
void tty_unlock(struct tty *tp);

void	 termioschars(struct termios *t);
int	 tputchar(int c, struct tty *tp);
int	 ttioctl(struct tty *tp, u_long com, caddr_t data, int flag,
	    struct proc *p);
int	 ttread(struct tty *tp, struct uio *uio, int flag);
int	 ttyselect(struct tty *tp, int rw, void * wql, struct proc *p);
int	 ttselect(dev_t dev, int rw, void * wql, struct proc *p);
void	 ttsetwater(struct tty *tp);
int	 ttspeedtab(int speed, struct speedtab *table);
int	 ttstart(struct tty *tp);
void	 ttwakeup(struct tty *tp);
int	 ttwrite(struct tty *tp, struct uio *uio, int flag);
void	 ttwwakeup(struct tty *tp);
void	 ttyblock(struct tty *tp);
int	 ttycheckoutq(struct tty *tp, int wait);
int	 ttyclose(struct tty *tp);	/* LEGACY: avoid using */
void	 ttyflush(struct tty *tp, int rw);
void	 ttyinfo(struct tty *tp);
void	 ttyinfo_locked(struct tty *tp);
int	 ttyinput(int c, struct tty *tp);
int	 ttylclose(struct tty *tp, int flag);
int	 ttymodem(struct tty *tp, int flag);
int	 ttyopen(dev_t device, struct tty *tp);
int	 ttysleep(struct tty *tp,
	    void *chan, int pri, const char *wmesg, int timeout);
int	 ttywait(struct tty *tp);
struct tty *ttymalloc(void);
void     ttyfree(struct tty *);

__END_DECLS

#endif /* KERNEL */


#endif /* !_SYS_TTY_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	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
9bccf70c	72	#include <sys/appleapiopts.h>
1c79356b	73	#include <sys/cdefs.h>
1c79356b A	74	#include <sys/termios.h>
	75	#include <sys/select.h> /* For struct selinfo. */
	76
9bccf70c	77
91447636	78	#ifdef KERNEL
b0d623f7 A	79
	80	__BEGIN_DECLS
	81	#include <kern/locks.h>
	82	__END_DECLS
	83
1c79356b A	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	*/
	92	struct 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
1c79356b A	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	*/
	114	struct tty {
b0d623f7 A	115	lck_mtx_t t_lock; /* Per tty lock */
b0d623f7 A	116
1c79356b A	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. */
91447636	135	void (t_oproc)(struct tty );
1c79356b	136	/* Stop output. */
91447636	137	void (t_stop)(struct tty , int);
1c79356b	138	/* Set hardware state. */
91447636	139	int (t_param)(struct tty , struct termios *);
1c79356b A	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. */
b0d623f7	146	void t_iokit; / IOKit management */
1c79356b A	147	};
1c79356b A	148
2d21ac55 A	149	#define TTY_NULL (struct tty *)0
2d21ac55 A	150
1c79356b A	151	#define t_cc t_termios.c_cc
	152	#define t_cflag t_termios.c_cflag
	153	#define t_iflag t_termios.c_iflag
	154	#define t_ispeed t_termios.c_ispeed
	155	#define t_lflag t_termios.c_lflag
	156	#define t_min t_termios.c_min
	157	#define t_oflag t_termios.c_oflag
	158	#define t_ospeed t_termios.c_ospeed
	159	#define t_time t_termios.c_time
	160
9bccf70c	161
1c79356b A	162	#define TTIPRI 25 /* Sleep priority for tty reads. */
	163	#define TTOPRI 26 /* Sleep priority for tty writes. */
	164
	165	/*
	166	* User data unfortunately has to be copied through buffers on the way to
	167	* and from clists. The buffers are on the stack so their sizes must be
	168	* fairly small.
	169	*/
	170	#define IBUFSIZ 384 /* Should be >= max value of MIN. */
	171	#define OBUFSIZ 100
	172
	173	#ifndef TTYHOG
	174	#define TTYHOG 1024
	175	#endif
	176
1c79356b A	177	#define TTMAXHIWAT roundup(2048, CBSIZE)
	178	#define TTMINHIWAT roundup(100, CBSIZE)
	179	#define TTMAXLOWAT 256
	180	#define TTMINLOWAT 32
91447636 A	181	#else
	182	struct tty;
	183	struct clist;
1c79356b A	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
6d2010ae A	223	#define TS_IOCTL_NOT_OK 0x1000000 /* Workaround <rdar://....> */
6d2010ae A	224
9bccf70c	225
1c79356b A	226	/* Character type information. */
	227	#define ORDINARY 0
	228	#define CONTROL 1
	229	#define BACKSPACE 2
	230	#define NEWLINE 3
	231	#define TAB 4
	232	#define VTAB 5
	233	#define RETURN 6
	234
	235	struct speedtab {
	236	int sp_speed; /* Speed. */
	237	int sp_code; /* Code. */
	238	};
	239
	240	/* Modem control commands (driver). */
	241	#define DMSET 0
	242	#define DMBIS 1
	243	#define DMBIC 2
	244	#define DMGET 3
	245
	246	/* Flags on a character passed to ttyinput. */
	247	#define TTY_CHARMASK 0x000000ff /* Character mask */
	248	#define TTY_QUOTE 0x00000100 /* Character quoted */
	249	#define TTY_ERRORMASK 0xff000000 /* Error mask */
	250	#define TTY_FE 0x01000000 /* Framing error */
	251	#define TTY_PE 0x02000000 /* Parity error */
	252	#define TTY_OE 0x04000000 /* Overrun error */
	253	#define TTY_BI 0x08000000 /* Break condition */
	254
91447636	255	#ifdef KERNEL
1c79356b A	256
	257	/* Unique sleep addresses. */
	258	#define TSA_CARR_ON(tp) ((void *)&(tp)->t_rawq)
	259	#define TSA_HUP_OR_INPUT(tp) ((void *)&(tp)->t_rawq.c_cf)
	260	#define TSA_OCOMPLETE(tp) ((void *)&(tp)->t_outq.c_cl)
	261	#define TSA_OLOWAT(tp) ((void *)&(tp)->t_outq)
	262	#define TSA_PTC_READ(tp) ((void *)&(tp)->t_outq.c_cf)
	263	#define TSA_PTC_WRITE(tp) ((void *)&(tp)->t_rawq.c_cl)
	264	#define TSA_PTS_READ(tp) ((void *)&(tp)->t_canq)
	265
9bccf70c	266
1c79356b A	267	__BEGIN_DECLS
1c79356b A	268
91447636 A	269	int b_to_q(const u_char cp, int cc, struct clist q);
	270	void catq(struct clist from, struct clist to);
	271	void clist_init(void);
	272	int getc(struct clist *q);
	273	void ndflush(struct clist *q, int cc);
	274	int ndqb(struct clist *q, int flag);
	275	u_char firstc (struct clist clp, int *c);
	276	u_char nextc(struct clist q, u_char cp, int c);
	277	int putc(int c, struct clist *q);
	278	int q_to_b(struct clist q, u_char cp, int cc);
	279	int unputc(struct clist *q);
	280	int clalloc(struct clist *clp, int size, int quot);
	281	void clfree(struct clist *clp);
	282	void cinit(void);
	283	void clrbits(u_char *cp, int off, int len);
1c79356b A	284
1c79356b A	285	#ifdef KERNEL_PRIVATE
b0d623f7 A	286	void tty_init(void);
	287	/*
	288	* The locked version of this function is used from routines which hold
	289	* the tty_lock(), such as ttcompat() in tty_compat.c
	290	*/
	291	int ttioctl_locked(struct tty *tp, u_long com, caddr_t data, int flag,
	292	struct proc *p);
	293
91447636 A	294	int ttcompat(struct tty *tp, u_long com, caddr_t data, int flag,
91447636 A	295	struct proc *p);
1c79356b	296	#endif /* KERNEL_PRIVATE */
1c79356b	297
b0d623f7 A	298	void tty_lock(struct tty *tp);
	299	void tty_unlock(struct tty *tp);
	300
91447636 A	301	void termioschars(struct termios *t);
	302	int tputchar(int c, struct tty *tp);
	303	int ttioctl(struct tty *tp, u_long com, caddr_t data, int flag,
	304	struct proc *p);
	305	int ttread(struct tty tp, struct uio uio, int flag);
91447636 A	306	int ttyselect(struct tty tp, int rw, void wql, struct proc *p);
	307	int ttselect(dev_t dev, int rw, void * wql, struct proc *p);
	308	void ttsetwater(struct tty *tp);
	309	int ttspeedtab(int speed, struct speedtab *table);
	310	int ttstart(struct tty *tp);
	311	void ttwakeup(struct tty *tp);
	312	int ttwrite(struct tty tp, struct uio uio, int flag);
	313	void ttwwakeup(struct tty *tp);
	314	void ttyblock(struct tty *tp);
91447636	315	int ttycheckoutq(struct tty *tp, int wait);
b0d623f7	316	int ttyclose(struct tty tp); / LEGACY: avoid using */
91447636 A	317	void ttyflush(struct tty *tp, int rw);
91447636 A	318	void ttyinfo(struct tty *tp);
b0d623f7	319	void ttyinfo_locked(struct tty *tp);
91447636 A	320	int ttyinput(int c, struct tty *tp);
	321	int ttylclose(struct tty *tp, int flag);
	322	int ttymodem(struct tty *tp, int flag);
	323	int ttyopen(dev_t device, struct tty *tp);
	324	int ttysleep(struct tty *tp,
	325	void chan, int pri, const char wmesg, int timeout);
	326	int ttywait(struct tty *tp);
	327	struct tty *ttymalloc(void);
	328	void ttyfree(struct tty *);
1c79356b A	329
	330	__END_DECLS
	331
	332	#endif /* KERNEL */
	333
9bccf70c	334
1c79356b	335	#endif /* !_SYS_TTY_H_ */