[linux-2.6-block.git] / include / linux / tty.h

#ifndef _LINUX_TTY_H
#define _LINUX_TTY_H

/*
 * 'tty.h' defines some structures used by tty_io.c and some defines.
 */

#ifdef __KERNEL__
#include <linux/fs.h>
#include <linux/major.h>
#include <linux/termios.h>
#include <linux/workqueue.h>
#include <linux/tty_driver.h>
#include <linux/tty_ldisc.h>
#include <linux/mutex.h>

#include <asm/system.h>


/*
 * (Note: the *_driver.minor_start values 1, 64, 128, 192 are
 * hardcoded at present.)
 */
#define NR_UNIX98_PTY_DEFAULT	4096      /* Default maximum for Unix98 ptys */
#define NR_UNIX98_PTY_MAX	(1 << MINORBITS) /* Absolute limit */
#define NR_LDISCS		18

/* line disciplines */
#define N_TTY		0
#define N_SLIP		1
#define N_MOUSE		2
#define N_PPP		3
#define N_STRIP		4
#define N_AX25		5
#define N_X25		6	/* X.25 async */
#define N_6PACK		7
#define N_MASC		8	/* Reserved for Mobitex module <kaz@cafe.net> */
#define N_R3964		9	/* Reserved for Simatic R3964 module */
#define N_PROFIBUS_FDL	10	/* Reserved for Profibus <Dave@mvhi.com> */
#define N_IRDA		11	/* Linux IrDa - http://irda.sourceforge.net/ */
#define N_SMSBLOCK	12	/* SMS block mode - for talking to GSM data */
				/* cards about SMS messages */
#define N_HDLC		13	/* synchronous HDLC */
#define N_SYNC_PPP	14	/* synchronous PPP */
#define N_HCI		15	/* Bluetooth HCI UART */
#define N_GIGASET_M101	16	/* Siemens Gigaset M101 serial DECT adapter */
#define N_SLCAN		17	/* Serial / USB serial CAN Adaptors */

/*
 * This character is the same as _POSIX_VDISABLE: it cannot be used as
 * a c_cc[] character, but indicates that a particular special character
 * isn't in use (eg VINTR has no character etc)
 */
#define __DISABLED_CHAR '\0'

struct tty_buffer {
	struct tty_buffer *next;
	char *char_buf_ptr;
	unsigned char *flag_buf_ptr;
	int used;
	int size;
	int commit;
	int read;
	/* Data points here */
	unsigned long data[0];
};

struct tty_bufhead {
	struct delayed_work work;
	spinlock_t lock;
	struct tty_buffer *head;	/* Queue head */
	struct tty_buffer *tail;	/* Active buffer */
	struct tty_buffer *free;	/* Free queue head */
	int memory_used;		/* Buffer space used excluding free queue */
};
/*
 * When a break, frame error, or parity error happens, these codes are
 * stuffed into the flags buffer.
 */
#define TTY_NORMAL	0
#define TTY_BREAK	1
#define TTY_FRAME	2
#define TTY_PARITY	3
#define TTY_OVERRUN	4

#define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
#define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
#define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
#define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
#define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
#define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
#define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
#define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
#define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
#define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
#define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
#define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
#define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
#define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
#define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
#define LNEXT_CHAR(tty)	((tty)->termios->c_cc[VLNEXT])
#define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])

#define _I_FLAG(tty,f)	((tty)->termios->c_iflag & (f))
#define _O_FLAG(tty,f)	((tty)->termios->c_oflag & (f))
#define _C_FLAG(tty,f)	((tty)->termios->c_cflag & (f))
#define _L_FLAG(tty,f)	((tty)->termios->c_lflag & (f))

#define I_IGNBRK(tty)	_I_FLAG((tty),IGNBRK)
#define I_BRKINT(tty)	_I_FLAG((tty),BRKINT)
#define I_IGNPAR(tty)	_I_FLAG((tty),IGNPAR)
#define I_PARMRK(tty)	_I_FLAG((tty),PARMRK)
#define I_INPCK(tty)	_I_FLAG((tty),INPCK)
#define I_ISTRIP(tty)	_I_FLAG((tty),ISTRIP)
#define I_INLCR(tty)	_I_FLAG((tty),INLCR)
#define I_IGNCR(tty)	_I_FLAG((tty),IGNCR)
#define I_ICRNL(tty)	_I_FLAG((tty),ICRNL)
#define I_IUCLC(tty)	_I_FLAG((tty),IUCLC)
#define I_IXON(tty)	_I_FLAG((tty),IXON)
#define I_IXANY(tty)	_I_FLAG((tty),IXANY)
#define I_IXOFF(tty)	_I_FLAG((tty),IXOFF)
#define I_IMAXBEL(tty)	_I_FLAG((tty),IMAXBEL)
#define I_IUTF8(tty)	_I_FLAG((tty),IUTF8)

#define O_OPOST(tty)	_O_FLAG((tty),OPOST)
#define O_OLCUC(tty)	_O_FLAG((tty),OLCUC)
#define O_ONLCR(tty)	_O_FLAG((tty),ONLCR)
#define O_OCRNL(tty)	_O_FLAG((tty),OCRNL)
#define O_ONOCR(tty)	_O_FLAG((tty),ONOCR)
#define O_ONLRET(tty)	_O_FLAG((tty),ONLRET)
#define O_OFILL(tty)	_O_FLAG((tty),OFILL)
#define O_OFDEL(tty)	_O_FLAG((tty),OFDEL)
#define O_NLDLY(tty)	_O_FLAG((tty),NLDLY)
#define O_CRDLY(tty)	_O_FLAG((tty),CRDLY)
#define O_TABDLY(tty)	_O_FLAG((tty),TABDLY)
#define O_BSDLY(tty)	_O_FLAG((tty),BSDLY)
#define O_VTDLY(tty)	_O_FLAG((tty),VTDLY)
#define O_FFDLY(tty)	_O_FLAG((tty),FFDLY)

#define C_BAUD(tty)	_C_FLAG((tty),CBAUD)
#define C_CSIZE(tty)	_C_FLAG((tty),CSIZE)
#define C_CSTOPB(tty)	_C_FLAG((tty),CSTOPB)
#define C_CREAD(tty)	_C_FLAG((tty),CREAD)
#define C_PARENB(tty)	_C_FLAG((tty),PARENB)
#define C_PARODD(tty)	_C_FLAG((tty),PARODD)
#define C_HUPCL(tty)	_C_FLAG((tty),HUPCL)
#define C_CLOCAL(tty)	_C_FLAG((tty),CLOCAL)
#define C_CIBAUD(tty)	_C_FLAG((tty),CIBAUD)
#define C_CRTSCTS(tty)	_C_FLAG((tty),CRTSCTS)

#define L_ISIG(tty)	_L_FLAG((tty),ISIG)
#define L_ICANON(tty)	_L_FLAG((tty),ICANON)
#define L_XCASE(tty)	_L_FLAG((tty),XCASE)
#define L_ECHO(tty)	_L_FLAG((tty),ECHO)
#define L_ECHOE(tty)	_L_FLAG((tty),ECHOE)
#define L_ECHOK(tty)	_L_FLAG((tty),ECHOK)
#define L_ECHONL(tty)	_L_FLAG((tty),ECHONL)
#define L_NOFLSH(tty)	_L_FLAG((tty),NOFLSH)
#define L_TOSTOP(tty)	_L_FLAG((tty),TOSTOP)
#define L_ECHOCTL(tty)	_L_FLAG((tty),ECHOCTL)
#define L_ECHOPRT(tty)	_L_FLAG((tty),ECHOPRT)
#define L_ECHOKE(tty)	_L_FLAG((tty),ECHOKE)
#define L_FLUSHO(tty)	_L_FLAG((tty),FLUSHO)
#define L_PENDIN(tty)	_L_FLAG((tty),PENDIN)
#define L_IEXTEN(tty)	_L_FLAG((tty),IEXTEN)

struct device;
struct signal_struct;
/*
 * Where all of the state associated with a tty is kept while the tty
 * is open.  Since the termios state should be kept even if the tty
 * has been closed --- for things like the baud rate, etc --- it is
 * not stored here, but rather a pointer to the real state is stored
 * here.  Possible the winsize structure should have the same
 * treatment, but (1) the default 80x24 is usually right and (2) it's
 * most often used by a windowing system, which will set the correct
 * size each time the window is created or resized anyway.
 * 						- TYT, 9/14/92
 */
struct tty_struct {
	int	magic;
	struct tty_driver *driver;
	int index;
	struct tty_ldisc ldisc;
	struct mutex termios_mutex;
	spinlock_t ctrl_lock;
	/* Termios values are protected by the termios mutex */
	struct ktermios *termios, *termios_locked;
	char name[64];
	struct pid *pgrp;		/* Protected by ctrl lock */
	struct pid *session;
	unsigned long flags;
	int count;
	struct winsize winsize;		/* termios mutex */
	unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
	unsigned char low_latency:1, warned:1;
	unsigned char ctrl_status;	/* ctrl_lock */
	unsigned int receive_room;	/* Bytes free for queue */

	struct tty_struct *link;
	struct fasync_struct *fasync;
	struct tty_bufhead buf;		/* Locked internally */
	int alt_speed;		/* For magic substitution of 38400 bps */
	wait_queue_head_t write_wait;
	wait_queue_head_t read_wait;
	struct work_struct hangup_work;
	void *disc_data;
	void *driver_data;
	struct list_head tty_files;

#define N_TTY_BUF_SIZE 4096
	
	/*
	 * The following is data for the N_TTY line discipline.  For
	 * historical reasons, this is included in the tty structure.
	 * Mostly locked by the BKL.
	 */
	unsigned int column;
	unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
	unsigned char closing:1;
	unsigned short minimum_to_wake;
	unsigned long overrun_time;
	int num_overrun;
	unsigned long process_char_map[256/(8*sizeof(unsigned long))];
	char *read_buf;
	int read_head;
	int read_tail;
	int read_cnt;
	unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
	int canon_data;
	unsigned long canon_head;
	unsigned int canon_column;
	struct mutex atomic_read_lock;
	struct mutex atomic_write_lock;
	unsigned char *write_buf;
	int write_cnt;
	spinlock_t read_lock;
	/* If the tty has a pending do_SAK, queue it here - akpm */
	struct work_struct SAK_work;
};

/* tty magic number */
#define TTY_MAGIC		0x5401

/*
 * These bits are used in the flags field of the tty structure.
 * 
 * So that interrupts won't be able to mess up the queues,
 * copy_to_cooked must be atomic with respect to itself, as must
 * tty->write.  Thus, you must use the inline functions set_bit() and
 * clear_bit() to make things atomic.
 */
#define TTY_THROTTLED 		0	/* Call unthrottle() at threshold min */
#define TTY_IO_ERROR 		1	/* Canse an I/O error (may be no ldisc too) */
#define TTY_OTHER_CLOSED 	2	/* Other side (if any) has closed */
#define TTY_EXCLUSIVE 		3	/* Exclusive open mode */
#define TTY_DEBUG 		4	/* Debugging */
#define TTY_DO_WRITE_WAKEUP 	5	/* Call write_wakeup after queuing new */
#define TTY_PUSH 		6	/* n_tty private */
#define TTY_CLOSING 		7	/* ->close() in progress */
#define TTY_LDISC 		9	/* Line discipline attached */
#define TTY_HW_COOK_OUT 	14	/* Hardware can do output cooking */
#define TTY_HW_COOK_IN 		15	/* Hardware can do input cooking */
#define TTY_PTY_LOCK 		16	/* pty private */
#define TTY_NO_WRITE_SPLIT 	17	/* Preserve write boundaries to driver */
#define TTY_HUPPED 		18	/* Post driver->hangup() */
#define TTY_FLUSHING		19	/* Flushing to ldisc in progress */
#define TTY_FLUSHPENDING	20	/* Queued buffer flush pending */

#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))

extern void tty_write_flush(struct tty_struct *);

extern struct ktermios tty_std_termios;

extern int kmsg_redirect;

extern void console_init(void);
extern int vcs_init(void);

extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
			      const char *routine);
extern char *tty_name(struct tty_struct *tty, char *buf);
extern void tty_wait_until_sent(struct tty_struct * tty, long timeout);
extern int tty_check_change(struct tty_struct * tty);
extern void stop_tty(struct tty_struct * tty);
extern void start_tty(struct tty_struct * tty);
extern int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc);
extern int tty_unregister_ldisc(int disc);
extern int tty_register_driver(struct tty_driver *driver);
extern int tty_unregister_driver(struct tty_driver *driver);
extern struct device *tty_register_device(struct tty_driver *driver,
					  unsigned index, struct device *dev);
extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
			     int buflen);
extern void tty_write_message(struct tty_struct *tty, char *msg);

extern int is_current_pgrp_orphaned(void);
extern struct pid *tty_get_pgrp(struct tty_struct *tty);
extern int is_ignored(int sig);
extern int tty_signal(int sig, struct tty_struct *tty);
extern void tty_hangup(struct tty_struct * tty);
extern void tty_vhangup(struct tty_struct * tty);
extern void tty_unhangup(struct file *filp);
extern int tty_hung_up_p(struct file * filp);
extern void do_SAK(struct tty_struct *tty);
extern void __do_SAK(struct tty_struct *tty);
extern void disassociate_ctty(int priv);
extern void no_tty(void);
extern void tty_flip_buffer_push(struct tty_struct *tty);
extern speed_t tty_get_baud_rate(struct tty_struct *tty);
extern speed_t tty_termios_baud_rate(struct ktermios *termios);
extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
extern void tty_termios_encode_baud_rate(struct ktermios *termios, speed_t ibaud, speed_t obaud);
extern void tty_encode_baud_rate(struct tty_struct *tty, speed_t ibaud, speed_t obaud);
extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);

extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
extern void tty_ldisc_deref(struct tty_ldisc *);
extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);

extern struct tty_ldisc *tty_ldisc_get(int);
extern void tty_ldisc_put(int);

extern void tty_wakeup(struct tty_struct *tty);
extern void tty_ldisc_flush(struct tty_struct *tty);

extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
			unsigned int cmd, unsigned long arg);
extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
extern dev_t tty_devnum(struct tty_struct *tty);
extern void proc_clear_tty(struct task_struct *p);
extern struct tty_struct *get_current_tty(void);

extern struct mutex tty_mutex;

extern void tty_write_unlock(struct tty_struct *tty);
extern int tty_write_lock(struct tty_struct *tty, int ndelay);
#define tty_is_writelocked(tty)  (mutex_is_locked(&tty->atomic_write_lock))


/* n_tty.c */
extern struct tty_ldisc tty_ldisc_N_TTY;

/* tty_audit.c */
#ifdef CONFIG_AUDIT
extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data,
			       size_t size);
extern void tty_audit_exit(void);
extern void tty_audit_fork(struct signal_struct *sig);
extern void tty_audit_push(struct tty_struct *tty);
extern void tty_audit_push_task(struct task_struct *tsk, uid_t loginuid, u32 sessionid);
#else
static inline void tty_audit_add_data(struct tty_struct *tty,
				      unsigned char *data, size_t size)
{
}
static inline void tty_audit_exit(void)
{
}
static inline void tty_audit_fork(struct signal_struct *sig)
{
}
static inline void tty_audit_push(struct tty_struct *tty)
{
}
static inline void tty_audit_push_task(struct task_struct *tsk, uid_t loginuid, u32 sessionid)
{
}
#endif

/* tty_ioctl.c */
extern int n_tty_ioctl(struct tty_struct * tty, struct file * file,
		       unsigned int cmd, unsigned long arg);

/* serial.c */

extern void serial_console_init(void);
 
/* pcxx.c */

extern int pcxe_open(struct tty_struct *tty, struct file *filp);

/* printk.c */

extern void console_print(const char *);

/* vt.c */

extern int vt_ioctl(struct tty_struct *tty, struct file * file,
		    unsigned int cmd, unsigned long arg);

#endif /* __KERNEL__ */
#endif
Commit	Line	Data
1da177e4 LT	1	#ifndef _LINUX_TTY_H
	2	#define _LINUX_TTY_H
	3
	4	/*
	5	* 'tty.h' defines some structures used by tty_io.c and some defines.
	6	*/
	7
1da177e4	8	#ifdef __KERNEL__
1da177e4 LT	9	#include <linux/fs.h>
	10	#include <linux/major.h>
	11	#include <linux/termios.h>
	12	#include <linux/workqueue.h>
	13	#include <linux/tty_driver.h>
	14	#include <linux/tty_ldisc.h>
70522e12	15	#include <linux/mutex.h>
1da177e4 LT	16
	17	#include <asm/system.h>
	18
	19
	20	/*
	21	* (Note: the *_driver.minor_start values 1, 64, 128, 192 are
	22	* hardcoded at present.)
	23	*/
1da177e4 LT	24	#define NR_UNIX98_PTY_DEFAULT 4096 /* Default maximum for Unix98 ptys */
1da177e4 LT	25	#define NR_UNIX98_PTY_MAX (1 << MINORBITS) /* Absolute limit */
cd05acfe	26	#define NR_LDISCS 18
4564f9e5 TS	27
	28	/* line disciplines */
	29	#define N_TTY 0
	30	#define N_SLIP 1
	31	#define N_MOUSE 2
	32	#define N_PPP 3
	33	#define N_STRIP 4
	34	#define N_AX25 5
	35	#define N_X25 6 /* X.25 async */
	36	#define N_6PACK 7
	37	#define N_MASC 8 /* Reserved for Mobitex module <kaz@cafe.net> */
	38	#define N_R3964 9 /* Reserved for Simatic R3964 module */
	39	#define N_PROFIBUS_FDL 10 /* Reserved for Profibus <Dave@mvhi.com> */
	40	#define N_IRDA 11 /* Linux IrDa - http://irda.sourceforge.net/ */
	41	#define N_SMSBLOCK 12 /* SMS block mode - for talking to GSM data */
	42	/* cards about SMS messages */
	43	#define N_HDLC 13 /* synchronous HDLC */
	44	#define N_SYNC_PPP 14 /* synchronous PPP */
	45	#define N_HCI 15 /* Bluetooth HCI UART */
	46	#define N_GIGASET_M101 16 /* Siemens Gigaset M101 serial DECT adapter */
cd05acfe	47	#define N_SLCAN 17 /* Serial / USB serial CAN Adaptors */
1da177e4	48
1da177e4 LT	49	/*
	50	* This character is the same as _POSIX_VDISABLE: it cannot be used as
	51	* a c_cc[] character, but indicates that a particular special character
	52	* isn't in use (eg VINTR has no character etc)
	53	*/
	54	#define __DISABLED_CHAR '\0'
	55
33f0f88f AC	56	struct tty_buffer {
	57	struct tty_buffer *next;
	58	char *char_buf_ptr;
	59	unsigned char *flag_buf_ptr;
	60	int used;
	61	int size;
8977d929 PF	62	int commit;
8977d929 PF	63	int read;
33f0f88f AC	64	/* Data points here */
	65	unsigned long data[0];
	66	};
	67
	68	struct tty_bufhead {
52bad64d	69	struct delayed_work work;
808249ce	70	spinlock_t lock;
33f0f88f AC	71	struct tty_buffer head; / Queue head */
	72	struct tty_buffer tail; / Active buffer */
	73	struct tty_buffer free; / Free queue head */
01da5fd8	74	int memory_used; /* Buffer space used excluding free queue */
1da177e4	75	};
1da177e4 LT	76	/*
	77	* When a break, frame error, or parity error happens, these codes are
	78	* stuffed into the flags buffer.
	79	*/
	80	#define TTY_NORMAL 0
	81	#define TTY_BREAK 1
	82	#define TTY_FRAME 2
	83	#define TTY_PARITY 3
	84	#define TTY_OVERRUN 4
	85
	86	#define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
	87	#define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
	88	#define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
	89	#define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
	90	#define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
	91	#define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
	92	#define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
	93	#define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
	94	#define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
	95	#define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
	96	#define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
	97	#define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
	98	#define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
	99	#define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
	100	#define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
	101	#define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
	102	#define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
	103
	104	#define _I_FLAG(tty,f) ((tty)->termios->c_iflag & (f))
	105	#define _O_FLAG(tty,f) ((tty)->termios->c_oflag & (f))
	106	#define _C_FLAG(tty,f) ((tty)->termios->c_cflag & (f))
	107	#define _L_FLAG(tty,f) ((tty)->termios->c_lflag & (f))
	108
	109	#define I_IGNBRK(tty) _I_FLAG((tty),IGNBRK)
	110	#define I_BRKINT(tty) _I_FLAG((tty),BRKINT)
	111	#define I_IGNPAR(tty) _I_FLAG((tty),IGNPAR)
	112	#define I_PARMRK(tty) _I_FLAG((tty),PARMRK)
	113	#define I_INPCK(tty) _I_FLAG((tty),INPCK)
	114	#define I_ISTRIP(tty) _I_FLAG((tty),ISTRIP)
	115	#define I_INLCR(tty) _I_FLAG((tty),INLCR)
	116	#define I_IGNCR(tty) _I_FLAG((tty),IGNCR)
	117	#define I_ICRNL(tty) _I_FLAG((tty),ICRNL)
	118	#define I_IUCLC(tty) _I_FLAG((tty),IUCLC)
	119	#define I_IXON(tty) _I_FLAG((tty),IXON)
	120	#define I_IXANY(tty) _I_FLAG((tty),IXANY)
	121	#define I_IXOFF(tty) _I_FLAG((tty),IXOFF)
	122	#define I_IMAXBEL(tty) _I_FLAG((tty),IMAXBEL)
	123	#define I_IUTF8(tty) _I_FLAG((tty),IUTF8)
	124
	125	#define O_OPOST(tty) _O_FLAG((tty),OPOST)
	126	#define O_OLCUC(tty) _O_FLAG((tty),OLCUC)
	127	#define O_ONLCR(tty) _O_FLAG((tty),ONLCR)
	128	#define O_OCRNL(tty) _O_FLAG((tty),OCRNL)
	129	#define O_ONOCR(tty) _O_FLAG((tty),ONOCR)
	130	#define O_ONLRET(tty) _O_FLAG((tty),ONLRET)
	131	#define O_OFILL(tty) _O_FLAG((tty),OFILL)
	132	#define O_OFDEL(tty) _O_FLAG((tty),OFDEL)
	133	#define O_NLDLY(tty) _O_FLAG((tty),NLDLY)
	134	#define O_CRDLY(tty) _O_FLAG((tty),CRDLY)
	135	#define O_TABDLY(tty) _O_FLAG((tty),TABDLY)
	136	#define O_BSDLY(tty) _O_FLAG((tty),BSDLY)
	137	#define O_VTDLY(tty) _O_FLAG((tty),VTDLY)
	138	#define O_FFDLY(tty) _O_FLAG((tty),FFDLY)
	139
140	#define C_BAUD(tty) _C_FLAG((tty),CBAUD)
141	#define C_CSIZE(tty) _C_FLAG((tty),CSIZE)
142	#define C_CSTOPB(tty) _C_FLAG((tty),CSTOPB)
143	#define C_CREAD(tty) _C_FLAG((tty),CREAD)
144	#define C_PARENB(tty) _C_FLAG((tty),PARENB)
145	#define C_PARODD(tty) _C_FLAG((tty),PARODD)
146	#define C_HUPCL(tty) _C_FLAG((tty),HUPCL)
147	#define C_CLOCAL(tty) _C_FLAG((tty),CLOCAL)
148	#define C_CIBAUD(tty) _C_FLAG((tty),CIBAUD)
149	#define C_CRTSCTS(tty) _C_FLAG((tty),CRTSCTS)
150
151	#define L_ISIG(tty) _L_FLAG((tty),ISIG)
152	#define L_ICANON(tty) _L_FLAG((tty),ICANON)
153	#define L_XCASE(tty) _L_FLAG((tty),XCASE)
154	#define L_ECHO(tty) _L_FLAG((tty),ECHO)
155	#define L_ECHOE(tty) _L_FLAG((tty),ECHOE)
156	#define L_ECHOK(tty) _L_FLAG((tty),ECHOK)
157	#define L_ECHONL(tty) _L_FLAG((tty),ECHONL)
158	#define L_NOFLSH(tty) _L_FLAG((tty),NOFLSH)
159	#define L_TOSTOP(tty) _L_FLAG((tty),TOSTOP)
160	#define L_ECHOCTL(tty) _L_FLAG((tty),ECHOCTL)
161	#define L_ECHOPRT(tty) _L_FLAG((tty),ECHOPRT)
162	#define L_ECHOKE(tty) _L_FLAG((tty),ECHOKE)
163	#define L_FLUSHO(tty) _L_FLAG((tty),FLUSHO)
164	#define L_PENDIN(tty) _L_FLAG((tty),PENDIN)
165	#define L_IEXTEN(tty) _L_FLAG((tty),IEXTEN)
166
167	struct device;
522ed776	168	struct signal_struct;
1da177e4 LT	169	/*
	170	* Where all of the state associated with a tty is kept while the tty
	171	* is open. Since the termios state should be kept even if the tty
	172	* has been closed --- for things like the baud rate, etc --- it is
	173	* not stored here, but rather a pointer to the real state is stored
	174	* here. Possible the winsize structure should have the same
	175	* treatment, but (1) the default 80x24 is usually right and (2) it's
	176	* most often used by a windowing system, which will set the correct
	177	* size each time the window is created or resized anyway.
	178	* - TYT, 9/14/92
	179	*/
	180	struct tty_struct {
	181	int magic;
	182	struct tty_driver *driver;
	183	int index;
	184	struct tty_ldisc ldisc;
5785c95b	185	struct mutex termios_mutex;
04f378b1	186	spinlock_t ctrl_lock;
47f86834	187	/* Termios values are protected by the termios mutex */
edc6afc5	188	struct ktermios termios, termios_locked;
1da177e4	189	char name[64];
47f86834	190	struct pid pgrp; / Protected by ctrl lock */
ab521dc0	191	struct pid *session;
1da177e4 LT	192	unsigned long flags;
1da177e4 LT	193	int count;
47f86834	194	struct winsize winsize; /* termios mutex */
1da177e4 LT	195	unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
1da177e4 LT	196	unsigned char low_latency:1, warned:1;
47f86834	197	unsigned char ctrl_status; /* ctrl_lock */
33f0f88f	198	unsigned int receive_room; /* Bytes free for queue */
1da177e4 LT	199
	200	struct tty_struct *link;
	201	struct fasync_struct *fasync;
47f86834	202	struct tty_bufhead buf; /* Locked internally */
1da177e4 LT	203	int alt_speed; /* For magic substitution of 38400 bps */
	204	wait_queue_head_t write_wait;
	205	wait_queue_head_t read_wait;
	206	struct work_struct hangup_work;
	207	void *disc_data;
	208	void *driver_data;
	209	struct list_head tty_files;
	210
	211	#define N_TTY_BUF_SIZE 4096
	212
	213	/*
	214	* The following is data for the N_TTY line discipline. For
	215	* historical reasons, this is included in the tty structure.
47f86834	216	* Mostly locked by the BKL.
1da177e4 LT	217	*/
	218	unsigned int column;
	219	unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
	220	unsigned char closing:1;
	221	unsigned short minimum_to_wake;
	222	unsigned long overrun_time;
	223	int num_overrun;
	224	unsigned long process_char_map[256/(8*sizeof(unsigned long))];
	225	char *read_buf;
	226	int read_head;
	227	int read_tail;
	228	int read_cnt;
	229	unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
	230	int canon_data;
	231	unsigned long canon_head;
	232	unsigned int canon_column;
70522e12 IM	233	struct mutex atomic_read_lock;
70522e12 IM	234	struct mutex atomic_write_lock;
1da177e4 LT	235	unsigned char *write_buf;
	236	int write_cnt;
	237	spinlock_t read_lock;
	238	/* If the tty has a pending do_SAK, queue it here - akpm */
	239	struct work_struct SAK_work;
	240	};
	241
	242	/* tty magic number */
	243	#define TTY_MAGIC 0x5401
	244
	245	/*
	246	* These bits are used in the flags field of the tty structure.
	247	*
	248	* So that interrupts won't be able to mess up the queues,
	249	* copy_to_cooked must be atomic with respect to itself, as must
	250	* tty->write. Thus, you must use the inline functions set_bit() and
	251	* clear_bit() to make things atomic.
	252	*/
	253	#define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
	254	#define TTY_IO_ERROR 1 /* Canse an I/O error (may be no ldisc too) */
	255	#define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
	256	#define TTY_EXCLUSIVE 3 /* Exclusive open mode */
	257	#define TTY_DEBUG 4 /* Debugging */
	258	#define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
	259	#define TTY_PUSH 6 /* n_tty private */
	260	#define TTY_CLOSING 7 /* ->close() in progress */
1da177e4 LT	261	#define TTY_LDISC 9 /* Line discipline attached */
	262	#define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */
	263	#define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */
	264	#define TTY_PTY_LOCK 16 /* pty private */
	265	#define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
	266	#define TTY_HUPPED 18 /* Post driver->hangup() */
42fd552e AC	267	#define TTY_FLUSHING 19 /* Flushing to ldisc in progress */
42fd552e AC	268	#define TTY_FLUSHPENDING 20 /* Queued buffer flush pending */
1da177e4 LT	269
	270	#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
	271
	272	extern void tty_write_flush(struct tty_struct *);
	273
edc6afc5	274	extern struct ktermios tty_std_termios;
1da177e4 LT	275
	276	extern int kmsg_redirect;
	277
	278	extern void console_init(void);
	279	extern int vcs_init(void);
	280
	281	extern int tty_paranoia_check(struct tty_struct tty, struct inode inode,
	282	const char *routine);
	283	extern char tty_name(struct tty_struct tty, char *buf);
	284	extern void tty_wait_until_sent(struct tty_struct * tty, long timeout);
	285	extern int tty_check_change(struct tty_struct * tty);
	286	extern void stop_tty(struct tty_struct * tty);
	287	extern void start_tty(struct tty_struct * tty);
	288	extern int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc);
bfb07599	289	extern int tty_unregister_ldisc(int disc);
1da177e4 LT	290	extern int tty_register_driver(struct tty_driver *driver);
1da177e4 LT	291	extern int tty_unregister_driver(struct tty_driver *driver);
01107d34 GKH	292	extern struct device tty_register_device(struct tty_driver driver,
01107d34 GKH	293	unsigned index, struct device *dev);
1da177e4 LT	294	extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
	295	extern int tty_read_raw_data(struct tty_struct tty, unsigned char bufp,
	296	int buflen);
	297	extern void tty_write_message(struct tty_struct tty, char msg);
	298
3e7cd6c4	299	extern int is_current_pgrp_orphaned(void);
5d0fdf1e	300	extern struct pid tty_get_pgrp(struct tty_struct tty);
1da177e4 LT	301	extern int is_ignored(int sig);
	302	extern int tty_signal(int sig, struct tty_struct *tty);
	303	extern void tty_hangup(struct tty_struct * tty);
	304	extern void tty_vhangup(struct tty_struct * tty);
	305	extern void tty_unhangup(struct file *filp);
	306	extern int tty_hung_up_p(struct file * filp);
	307	extern void do_SAK(struct tty_struct *tty);
8b6312f4	308	extern void __do_SAK(struct tty_struct *tty);
1da177e4	309	extern void disassociate_ctty(int priv);
98a27ba4	310	extern void no_tty(void);
1da177e4	311	extern void tty_flip_buffer_push(struct tty_struct *tty);
edc6afc5 AC	312	extern speed_t tty_get_baud_rate(struct tty_struct *tty);
	313	extern speed_t tty_termios_baud_rate(struct ktermios *termios);
	314	extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
5f519d72 AC	315	extern void tty_termios_encode_baud_rate(struct ktermios *termios, speed_t ibaud, speed_t obaud);
	316	extern void tty_encode_baud_rate(struct tty_struct *tty, speed_t ibaud, speed_t obaud);
	317	extern void tty_termios_copy_hw(struct ktermios new, struct ktermios old);
bf5e5834	318	extern int tty_termios_hw_change(struct ktermios a, struct ktermios b);
1da177e4 LT	319
	320	extern struct tty_ldisc tty_ldisc_ref(struct tty_struct );
	321	extern void tty_ldisc_deref(struct tty_ldisc *);
	322	extern struct tty_ldisc tty_ldisc_ref_wait(struct tty_struct );
	323
	324	extern struct tty_ldisc *tty_ldisc_get(int);
	325	extern void tty_ldisc_put(int);
	326
	327	extern void tty_wakeup(struct tty_struct *tty);
	328	extern void tty_ldisc_flush(struct tty_struct *tty);
	329
04f378b1	330	extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
0fc00e24 AC	331	extern int tty_mode_ioctl(struct tty_struct tty, struct file file,
	332	unsigned int cmd, unsigned long arg);
	333	extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
24ec839c PZ	334	extern dev_t tty_devnum(struct tty_struct *tty);
24ec839c PZ	335	extern void proc_clear_tty(struct task_struct *p);
24ec839c PZ	336	extern struct tty_struct *get_current_tty(void);
24ec839c PZ	337
70522e12	338	extern struct mutex tty_mutex;
1da177e4	339
9c1729db AC	340	extern void tty_write_unlock(struct tty_struct *tty);
	341	extern int tty_write_lock(struct tty_struct *tty, int ndelay);
	342	#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
	343
	344
	345
1da177e4 LT	346	/* n_tty.c */
	347	extern struct tty_ldisc tty_ldisc_N_TTY;
	348
522ed776 MT	349	/* tty_audit.c */
	350	#ifdef CONFIG_AUDIT
	351	extern void tty_audit_add_data(struct tty_struct tty, unsigned char data,
	352	size_t size);
	353	extern void tty_audit_exit(void);
	354	extern void tty_audit_fork(struct signal_struct *sig);
	355	extern void tty_audit_push(struct tty_struct *tty);
2532386f	356	extern void tty_audit_push_task(struct task_struct *tsk, uid_t loginuid, u32 sessionid);
522ed776 MT	357	#else
	358	static inline void tty_audit_add_data(struct tty_struct *tty,
	359	unsigned char *data, size_t size)
	360	{
	361	}
	362	static inline void tty_audit_exit(void)
	363	{
	364	}
	365	static inline void tty_audit_fork(struct signal_struct *sig)
	366	{
	367	}
	368	static inline void tty_audit_push(struct tty_struct *tty)
	369	{
	370	}
2532386f	371	static inline void tty_audit_push_task(struct task_struct *tsk, uid_t loginuid, u32 sessionid)
522ed776 MT	372	{
522ed776 MT	373	}
522ed776 MT	374	#endif
522ed776 MT	375
1da177e4 LT	376	/* tty_ioctl.c */
	377	extern int n_tty_ioctl(struct tty_struct * tty, struct file * file,
	378	unsigned int cmd, unsigned long arg);
	379
	380	/* serial.c */
	381
	382	extern void serial_console_init(void);
	383
	384	/* pcxx.c */
	385
	386	extern int pcxe_open(struct tty_struct tty, struct file filp);
	387
	388	/* printk.c */
	389
	390	extern void console_print(const char *);
	391
	392	/* vt.c */
	393
	394	extern int vt_ioctl(struct tty_struct tty, struct file file,
	395	unsigned int cmd, unsigned long arg);
	396
1da177e4 LT	397	#endif /* __KERNEL__ */
1da177e4 LT	398	#endif