[mirror_ubuntu-artful-kernel.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		19

/* 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 */
#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 */
#define N_PPS		18	/* Pulse per Second */

/*
 * 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;

/*
 * Port level information. Each device keeps its own port level information
 * so provide a common structure for those ports wanting to use common support
 * routines.
 *
 * The tty port has a different lifetime to the tty so must be kept apart.
 * In addition be careful as tty -> port mappings are valid for the life
 * of the tty object but in many cases port -> tty mappings are valid only
 * until a hangup so don't use the wrong path.
 */

struct tty_port {
	struct tty_struct	*tty;		/* Back pointer */
	spinlock_t		lock;		/* Lock protecting tty field */
	int			blocked_open;	/* Waiting to open */
	int			count;		/* Usage count */
	wait_queue_head_t	open_wait;	/* Open waiters */
	wait_queue_head_t	close_wait;	/* Close waiters */
	unsigned long		flags;		/* TTY flags ASY_*/
	struct mutex		mutex;		/* Locking */
	unsigned char		*xmit_buf;	/* Optional buffer */
	int			close_delay;	/* Close port delay */
	int			closing_wait;	/* Delay for output */
};

/*
 * 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_operations;

struct tty_struct {
	int	magic;
	struct kref kref;
	struct tty_driver *driver;
	const struct tty_operations *ops;
	int index;
	/* The ldisc objects are protected by tty_ldisc_lock at the moment */
	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;
	struct termiox *termiox;	/* May be NULL for unsupported */
	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;
	struct tty_port *port;
};

/* 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	/* Cause 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);

/**
 *	tty_kref_get		-	get a tty reference
 *	@tty: tty device
 *
 *	Return a new reference to a tty object. The caller must hold
 *	sufficient locks/counts to ensure that their existing reference cannot
 *	go away
 */

extern inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
{
	if (tty)
		kref_get(&tty->kref);
	return tty;
}
extern void tty_kref_put(struct tty_struct *tty);

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_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 tty_put_char(struct tty_struct *tty, unsigned char c);
extern int tty_chars_in_buffer(struct tty_struct *tty);
extern int tty_write_room(struct tty_struct *tty);
extern void tty_driver_flush_buffer(struct tty_struct *tty);
extern void tty_throttle(struct tty_struct *tty);
extern void tty_unthrottle(struct tty_struct *tty);
extern int tty_do_resize(struct tty_struct *tty, struct tty_struct *real_tty,
						struct winsize *ws);

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 void tty_buffer_free_all(struct tty_struct *tty);
extern void tty_buffer_flush(struct tty_struct *tty);
extern void tty_buffer_init(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 const struct file_operations tty_ldiscs_proc_fops;

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))

extern void tty_port_init(struct tty_port *port);
extern int tty_port_alloc_xmit_buf(struct tty_port *port);
extern void tty_port_free_xmit_buf(struct tty_port *port);
extern struct tty_struct *tty_port_tty_get(struct tty_port *port);
extern void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty);

extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
extern int tty_unregister_ldisc(int disc);
extern int tty_set_ldisc(struct tty_struct *tty, int ldisc);
extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty);
extern void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty);
extern void tty_ldisc_init(struct tty_struct *tty);
extern void tty_ldisc_begin(void);
/* This last one is just for the tty layer internals and shouldn't be used elsewhere */
extern void tty_ldisc_enable(struct tty_struct *tty);


/* n_tty.c */
extern struct tty_ldisc_ops 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 */
348eb12e	26	#define NR_LDISCS 19
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 */
44d1b980	39	#define N_PROFIBUS_FDL 10 /* Reserved for Profibus */
4564f9e5 TS	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 */
348eb12e	48	#define N_PPS 18 /* Pulse per Second */
1da177e4	49
1da177e4 LT	50	/*
	51	* This character is the same as _POSIX_VDISABLE: it cannot be used as
	52	* a c_cc[] character, but indicates that a particular special character
	53	* isn't in use (eg VINTR has no character etc)
	54	*/
	55	#define __DISABLED_CHAR '\0'
	56
33f0f88f AC	57	struct tty_buffer {
	58	struct tty_buffer *next;
	59	char *char_buf_ptr;
	60	unsigned char *flag_buf_ptr;
	61	int used;
	62	int size;
8977d929 PF	63	int commit;
8977d929 PF	64	int read;
33f0f88f AC	65	/* Data points here */
	66	unsigned long data[0];
	67	};
	68
	69	struct tty_bufhead {
52bad64d	70	struct delayed_work work;
808249ce	71	spinlock_t lock;
33f0f88f AC	72	struct tty_buffer head; / Queue head */
	73	struct tty_buffer tail; / Active buffer */
	74	struct tty_buffer free; / Free queue head */
7a4d29f4 AC	75	int memory_used; /* Buffer space used excluding
7a4d29f4 AC	76	free queue */
1da177e4	77	};
1da177e4 LT	78	/*
	79	* When a break, frame error, or parity error happens, these codes are
	80	* stuffed into the flags buffer.
	81	*/
	82	#define TTY_NORMAL 0
	83	#define TTY_BREAK 1
	84	#define TTY_FRAME 2
	85	#define TTY_PARITY 3
	86	#define TTY_OVERRUN 4
	87
	88	#define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
	89	#define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
	90	#define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
	91	#define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
	92	#define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
	93	#define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
	94	#define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
	95	#define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
	96	#define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
	97	#define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
	98	#define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
	99	#define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
	100	#define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
	101	#define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
	102	#define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
	103	#define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
	104	#define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
	105
7a4d29f4 AC	106	#define _I_FLAG(tty, f) ((tty)->termios->c_iflag & (f))
	107	#define _O_FLAG(tty, f) ((tty)->termios->c_oflag & (f))
	108	#define _C_FLAG(tty, f) ((tty)->termios->c_cflag & (f))
	109	#define _L_FLAG(tty, f) ((tty)->termios->c_lflag & (f))
	110
	111	#define I_IGNBRK(tty) _I_FLAG((tty), IGNBRK)
	112	#define I_BRKINT(tty) _I_FLAG((tty), BRKINT)
	113	#define I_IGNPAR(tty) _I_FLAG((tty), IGNPAR)
	114	#define I_PARMRK(tty) _I_FLAG((tty), PARMRK)
	115	#define I_INPCK(tty) _I_FLAG((tty), INPCK)
	116	#define I_ISTRIP(tty) _I_FLAG((tty), ISTRIP)
	117	#define I_INLCR(tty) _I_FLAG((tty), INLCR)
	118	#define I_IGNCR(tty) _I_FLAG((tty), IGNCR)
	119	#define I_ICRNL(tty) _I_FLAG((tty), ICRNL)
	120	#define I_IUCLC(tty) _I_FLAG((tty), IUCLC)
	121	#define I_IXON(tty) _I_FLAG((tty), IXON)
	122	#define I_IXANY(tty) _I_FLAG((tty), IXANY)
	123	#define I_IXOFF(tty) _I_FLAG((tty), IXOFF)
	124	#define I_IMAXBEL(tty) _I_FLAG((tty), IMAXBEL)
	125	#define I_IUTF8(tty) _I_FLAG((tty), IUTF8)
	126
	127	#define O_OPOST(tty) _O_FLAG((tty), OPOST)
	128	#define O_OLCUC(tty) _O_FLAG((tty), OLCUC)
	129	#define O_ONLCR(tty) _O_FLAG((tty), ONLCR)
	130	#define O_OCRNL(tty) _O_FLAG((tty), OCRNL)
	131	#define O_ONOCR(tty) _O_FLAG((tty), ONOCR)
	132	#define O_ONLRET(tty) _O_FLAG((tty), ONLRET)
	133	#define O_OFILL(tty) _O_FLAG((tty), OFILL)
	134	#define O_OFDEL(tty) _O_FLAG((tty), OFDEL)
	135	#define O_NLDLY(tty) _O_FLAG((tty), NLDLY)
	136	#define O_CRDLY(tty) _O_FLAG((tty), CRDLY)
	137	#define O_TABDLY(tty) _O_FLAG((tty), TABDLY)
	138	#define O_BSDLY(tty) _O_FLAG((tty), BSDLY)
	139	#define O_VTDLY(tty) _O_FLAG((tty), VTDLY)
	140	#define O_FFDLY(tty) _O_FLAG((tty), FFDLY)
	141
	142	#define C_BAUD(tty) _C_FLAG((tty), CBAUD)
	143	#define C_CSIZE(tty) _C_FLAG((tty), CSIZE)
	144	#define C_CSTOPB(tty) _C_FLAG((tty), CSTOPB)
	145	#define C_CREAD(tty) _C_FLAG((tty), CREAD)
	146	#define C_PARENB(tty) _C_FLAG((tty), PARENB)
	147	#define C_PARODD(tty) _C_FLAG((tty), PARODD)
	148	#define C_HUPCL(tty) _C_FLAG((tty), HUPCL)
	149	#define C_CLOCAL(tty) _C_FLAG((tty), CLOCAL)
	150	#define C_CIBAUD(tty) _C_FLAG((tty), CIBAUD)
	151	#define C_CRTSCTS(tty) _C_FLAG((tty), CRTSCTS)
	152
	153	#define L_ISIG(tty) _L_FLAG((tty), ISIG)
	154	#define L_ICANON(tty) _L_FLAG((tty), ICANON)
	155	#define L_XCASE(tty) _L_FLAG((tty), XCASE)
	156	#define L_ECHO(tty) _L_FLAG((tty), ECHO)
	157	#define L_ECHOE(tty) _L_FLAG((tty), ECHOE)
	158	#define L_ECHOK(tty) _L_FLAG((tty), ECHOK)
	159	#define L_ECHONL(tty) _L_FLAG((tty), ECHONL)
	160	#define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH)
	161	#define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP)
	162	#define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL)
	163	#define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT)
	164	#define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE)
	165	#define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO)
	166	#define L_PENDIN(tty) _L_FLAG((tty), PENDIN)
	167	#define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN)
1da177e4 LT	168
1da177e4 LT	169	struct device;
522ed776	170	struct signal_struct;
6f67048c AC	171
	172	/*
	173	* Port level information. Each device keeps its own port level information
	174	* so provide a common structure for those ports wanting to use common support
	175	* routines.
	176	*
	177	* The tty port has a different lifetime to the tty so must be kept apart.
	178	* In addition be careful as tty -> port mappings are valid for the life
	179	* of the tty object but in many cases port -> tty mappings are valid only
	180	* until a hangup so don't use the wrong path.
	181	*/
7a4d29f4	182
6f67048c AC	183	struct tty_port {
6f67048c AC	184	struct tty_struct tty; / Back pointer */
4a90f09b	185	spinlock_t lock; /* Lock protecting tty field */
6f67048c AC	186	int blocked_open; /* Waiting to open */
	187	int count; /* Usage count */
	188	wait_queue_head_t open_wait; /* Open waiters */
	189	wait_queue_head_t close_wait; /* Close waiters */
	190	unsigned long flags; /* TTY flags ASY_*/
	191	struct mutex mutex; /* Locking */
	192	unsigned char xmit_buf; / Optional buffer */
44b7d1b3 AC	193	int close_delay; /* Close port delay */
44b7d1b3 AC	194	int closing_wait; /* Delay for output */
6f67048c AC	195	};
6f67048c AC	196
1da177e4 LT	197	/*
	198	* Where all of the state associated with a tty is kept while the tty
	199	* is open. Since the termios state should be kept even if the tty
	200	* has been closed --- for things like the baud rate, etc --- it is
	201	* not stored here, but rather a pointer to the real state is stored
	202	* here. Possible the winsize structure should have the same
	203	* treatment, but (1) the default 80x24 is usually right and (2) it's
	204	* most often used by a windowing system, which will set the correct
	205	* size each time the window is created or resized anyway.
	206	* - TYT, 9/14/92
	207	*/
f34d7a5b AC	208
	209	struct tty_operations;
	210
1da177e4 LT	211	struct tty_struct {
1da177e4 LT	212	int magic;
9c9f4ded	213	struct kref kref;
1da177e4	214	struct tty_driver *driver;
f34d7a5b	215	const struct tty_operations *ops;
1da177e4	216	int index;
a352def2	217	/* The ldisc objects are protected by tty_ldisc_lock at the moment */
1da177e4	218	struct tty_ldisc ldisc;
5785c95b	219	struct mutex termios_mutex;
04f378b1	220	spinlock_t ctrl_lock;
47f86834	221	/* Termios values are protected by the termios mutex */
edc6afc5	222	struct ktermios termios, termios_locked;
1d65b4a0	223	struct termiox termiox; / May be NULL for unsupported */
1da177e4	224	char name[64];
47f86834	225	struct pid pgrp; / Protected by ctrl lock */
ab521dc0	226	struct pid *session;
1da177e4 LT	227	unsigned long flags;
1da177e4 LT	228	int count;
47f86834	229	struct winsize winsize; /* termios mutex */
1da177e4 LT	230	unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
1da177e4 LT	231	unsigned char low_latency:1, warned:1;
47f86834	232	unsigned char ctrl_status; /* ctrl_lock */
33f0f88f	233	unsigned int receive_room; /* Bytes free for queue */
1da177e4 LT	234
	235	struct tty_struct *link;
	236	struct fasync_struct *fasync;
47f86834	237	struct tty_bufhead buf; /* Locked internally */
1da177e4 LT	238	int alt_speed; /* For magic substitution of 38400 bps */
	239	wait_queue_head_t write_wait;
	240	wait_queue_head_t read_wait;
	241	struct work_struct hangup_work;
	242	void *disc_data;
	243	void *driver_data;
	244	struct list_head tty_files;
	245
	246	#define N_TTY_BUF_SIZE 4096
6f67048c	247
1da177e4 LT	248	/*
	249	* The following is data for the N_TTY line discipline. For
	250	* historical reasons, this is included in the tty structure.
47f86834	251	* Mostly locked by the BKL.
1da177e4 LT	252	*/
	253	unsigned int column;
	254	unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
	255	unsigned char closing:1;
	256	unsigned short minimum_to_wake;
	257	unsigned long overrun_time;
	258	int num_overrun;
	259	unsigned long process_char_map[256/(8*sizeof(unsigned long))];
	260	char *read_buf;
	261	int read_head;
	262	int read_tail;
	263	int read_cnt;
	264	unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
	265	int canon_data;
	266	unsigned long canon_head;
	267	unsigned int canon_column;
70522e12 IM	268	struct mutex atomic_read_lock;
70522e12 IM	269	struct mutex atomic_write_lock;
1da177e4 LT	270	unsigned char *write_buf;
	271	int write_cnt;
	272	spinlock_t read_lock;
	273	/* If the tty has a pending do_SAK, queue it here - akpm */
	274	struct work_struct SAK_work;
6f67048c	275	struct tty_port *port;
1da177e4 LT	276	};
	277
	278	/* tty magic number */
	279	#define TTY_MAGIC 0x5401
	280
	281	/*
	282	* These bits are used in the flags field of the tty structure.
7a4d29f4	283	*
1da177e4 LT	284	* So that interrupts won't be able to mess up the queues,
	285	* copy_to_cooked must be atomic with respect to itself, as must
	286	* tty->write. Thus, you must use the inline functions set_bit() and
	287	* clear_bit() to make things atomic.
	288	*/
	289	#define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
7a4d29f4	290	#define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */
1da177e4 LT	291	#define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
	292	#define TTY_EXCLUSIVE 3 /* Exclusive open mode */
	293	#define TTY_DEBUG 4 /* Debugging */
	294	#define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
	295	#define TTY_PUSH 6 /* n_tty private */
	296	#define TTY_CLOSING 7 /* ->close() in progress */
1da177e4 LT	297	#define TTY_LDISC 9 /* Line discipline attached */
	298	#define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */
	299	#define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */
	300	#define TTY_PTY_LOCK 16 /* pty private */
	301	#define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
	302	#define TTY_HUPPED 18 /* Post driver->hangup() */
42fd552e AC	303	#define TTY_FLUSHING 19 /* Flushing to ldisc in progress */
42fd552e AC	304	#define TTY_FLUSHPENDING 20 /* Queued buffer flush pending */
1da177e4 LT	305
	306	#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
	307
	308	extern void tty_write_flush(struct tty_struct *);
	309
edc6afc5	310	extern struct ktermios tty_std_termios;
1da177e4 LT	311
	312	extern int kmsg_redirect;
	313
	314	extern void console_init(void);
	315	extern int vcs_init(void);
	316
9c9f4ded AC	317	/**
	318	* tty_kref_get - get a tty reference
	319	* @tty: tty device
	320	*
	321	* Return a new reference to a tty object. The caller must hold
	322	* sufficient locks/counts to ensure that their existing reference cannot
	323	* go away
	324	*/
	325
	326	extern inline struct tty_struct tty_kref_get(struct tty_struct tty)
	327	{
	328	if (tty)
	329	kref_get(&tty->kref);
	330	return tty;
	331	}
	332	extern void tty_kref_put(struct tty_struct *tty);
	333
1da177e4 LT	334	extern int tty_paranoia_check(struct tty_struct tty, struct inode inode,
	335	const char *routine);
	336	extern char tty_name(struct tty_struct tty, char *buf);
7a4d29f4 AC	337	extern void tty_wait_until_sent(struct tty_struct *tty, long timeout);
	338	extern int tty_check_change(struct tty_struct *tty);
	339	extern void stop_tty(struct tty_struct *tty);
	340	extern void start_tty(struct tty_struct *tty);
1da177e4 LT	341	extern int tty_register_driver(struct tty_driver *driver);
1da177e4 LT	342	extern int tty_unregister_driver(struct tty_driver *driver);
01107d34 GKH	343	extern struct device tty_register_device(struct tty_driver driver,
01107d34 GKH	344	unsigned index, struct device *dev);
1da177e4 LT	345	extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
	346	extern int tty_read_raw_data(struct tty_struct tty, unsigned char bufp,
	347	int buflen);
	348	extern void tty_write_message(struct tty_struct tty, char msg);
f34d7a5b AC	349	extern int tty_put_char(struct tty_struct *tty, unsigned char c);
	350	extern int tty_chars_in_buffer(struct tty_struct *tty);
	351	extern int tty_write_room(struct tty_struct *tty);
	352	extern void tty_driver_flush_buffer(struct tty_struct *tty);
39c2e60f AC	353	extern void tty_throttle(struct tty_struct *tty);
39c2e60f AC	354	extern void tty_unthrottle(struct tty_struct *tty);
8c9a9dd0 AC	355	extern int tty_do_resize(struct tty_struct tty, struct tty_struct real_tty,
8c9a9dd0 AC	356	struct winsize *ws);
1da177e4	357
3e7cd6c4	358	extern int is_current_pgrp_orphaned(void);
5d0fdf1e	359	extern struct pid tty_get_pgrp(struct tty_struct tty);
1da177e4 LT	360	extern int is_ignored(int sig);
1da177e4 LT	361	extern int tty_signal(int sig, struct tty_struct *tty);
7a4d29f4 AC	362	extern void tty_hangup(struct tty_struct *tty);
7a4d29f4 AC	363	extern void tty_vhangup(struct tty_struct *tty);
1da177e4	364	extern void tty_unhangup(struct file *filp);
7a4d29f4	365	extern int tty_hung_up_p(struct file *filp);
1da177e4	366	extern void do_SAK(struct tty_struct *tty);
8b6312f4	367	extern void __do_SAK(struct tty_struct *tty);
1da177e4	368	extern void disassociate_ctty(int priv);
98a27ba4	369	extern void no_tty(void);
1da177e4	370	extern void tty_flip_buffer_push(struct tty_struct *tty);
e0495736 AC	371	extern void tty_buffer_free_all(struct tty_struct *tty);
	372	extern void tty_buffer_flush(struct tty_struct *tty);
	373	extern void tty_buffer_init(struct tty_struct *tty);
edc6afc5 AC	374	extern speed_t tty_get_baud_rate(struct tty_struct *tty);
	375	extern speed_t tty_termios_baud_rate(struct ktermios *termios);
	376	extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
7a4d29f4 AC	377	extern void tty_termios_encode_baud_rate(struct ktermios *termios,
	378	speed_t ibaud, speed_t obaud);
	379	extern void tty_encode_baud_rate(struct tty_struct *tty,
	380	speed_t ibaud, speed_t obaud);
5f519d72	381	extern void tty_termios_copy_hw(struct ktermios new, struct ktermios old);
bf5e5834	382	extern int tty_termios_hw_change(struct ktermios a, struct ktermios b);
1da177e4 LT	383
	384	extern struct tty_ldisc tty_ldisc_ref(struct tty_struct );
	385	extern void tty_ldisc_deref(struct tty_ldisc *);
	386	extern struct tty_ldisc tty_ldisc_ref_wait(struct tty_struct );
a352def2	387	extern const struct file_operations tty_ldiscs_proc_fops;
1da177e4 LT	388
	389	extern void tty_wakeup(struct tty_struct *tty);
	390	extern void tty_ldisc_flush(struct tty_struct *tty);
	391
04f378b1	392	extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
0fc00e24 AC	393	extern int tty_mode_ioctl(struct tty_struct tty, struct file file,
	394	unsigned int cmd, unsigned long arg);
	395	extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
24ec839c PZ	396	extern dev_t tty_devnum(struct tty_struct *tty);
24ec839c PZ	397	extern void proc_clear_tty(struct task_struct *p);
24ec839c PZ	398	extern struct tty_struct *get_current_tty(void);
24ec839c PZ	399
70522e12	400	extern struct mutex tty_mutex;
1da177e4	401
9c1729db AC	402	extern void tty_write_unlock(struct tty_struct *tty);
	403	extern int tty_write_lock(struct tty_struct *tty, int ndelay);
	404	#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
	405
6f67048c AC	406	extern void tty_port_init(struct tty_port *port);
	407	extern int tty_port_alloc_xmit_buf(struct tty_port *port);
	408	extern void tty_port_free_xmit_buf(struct tty_port *port);
4a90f09b AC	409	extern struct tty_struct tty_port_tty_get(struct tty_port port);
4a90f09b AC	410	extern void tty_port_tty_set(struct tty_port port, struct tty_struct tty);
6f67048c	411
01e1abb2 AC	412	extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
	413	extern int tty_unregister_ldisc(int disc);
	414	extern int tty_set_ldisc(struct tty_struct *tty, int ldisc);
	415	extern int tty_ldisc_setup(struct tty_struct tty, struct tty_struct o_tty);
	416	extern void tty_ldisc_release(struct tty_struct tty, struct tty_struct o_tty);
	417	extern void tty_ldisc_init(struct tty_struct *tty);
	418	extern void tty_ldisc_begin(void);
	419	/* This last one is just for the tty layer internals and shouldn't be used elsewhere */
	420	extern void tty_ldisc_enable(struct tty_struct *tty);
9c1729db AC	421
9c1729db AC	422
1da177e4	423	/* n_tty.c */
a352def2	424	extern struct tty_ldisc_ops tty_ldisc_N_TTY;
1da177e4	425
522ed776 MT	426	/* tty_audit.c */
	427	#ifdef CONFIG_AUDIT
	428	extern void tty_audit_add_data(struct tty_struct tty, unsigned char data,
	429	size_t size);
	430	extern void tty_audit_exit(void);
	431	extern void tty_audit_fork(struct signal_struct *sig);
	432	extern void tty_audit_push(struct tty_struct *tty);
7a4d29f4 AC	433	extern void tty_audit_push_task(struct task_struct *tsk,
7a4d29f4 AC	434	uid_t loginuid, u32 sessionid);
522ed776 MT	435	#else
	436	static inline void tty_audit_add_data(struct tty_struct *tty,
	437	unsigned char *data, size_t size)
	438	{
	439	}
	440	static inline void tty_audit_exit(void)
	441	{
	442	}
	443	static inline void tty_audit_fork(struct signal_struct *sig)
	444	{
	445	}
	446	static inline void tty_audit_push(struct tty_struct *tty)
	447	{
	448	}
7a4d29f4 AC	449	static inline void tty_audit_push_task(struct task_struct *tsk,
7a4d29f4 AC	450	uid_t loginuid, u32 sessionid)
522ed776 MT	451	{
522ed776 MT	452	}
522ed776 MT	453	#endif
522ed776 MT	454
1da177e4	455	/* tty_ioctl.c */
7a4d29f4	456	extern int n_tty_ioctl(struct tty_struct tty, struct file file,
1da177e4 LT	457	unsigned int cmd, unsigned long arg);
	458
	459	/* serial.c */
	460
	461	extern void serial_console_init(void);
7a4d29f4	462
1da177e4 LT	463	/* pcxx.c */
	464
	465	extern int pcxe_open(struct tty_struct tty, struct file filp);
	466
	467	/* printk.c */
	468
	469	extern void console_print(const char *);
	470
	471	/* vt.c */
	472
7a4d29f4	473	extern int vt_ioctl(struct tty_struct tty, struct file file,
1da177e4 LT	474	unsigned int cmd, unsigned long arg);
1da177e4 LT	475
1da177e4 LT	476	#endif /* __KERNEL__ */
1da177e4 LT	477	#endif