tty.h 24.4 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7
#ifndef _LINUX_TTY_H
#define _LINUX_TTY_H

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

8
#define NR_LDISCS		30
9 10 11 12 13 14 15 16 17 18 19 20

/* 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 */
21
#define N_PROFIBUS_FDL	10	/* Reserved for Profibus */
22 23 24 25 26 27 28
#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 */
29
#define N_SLCAN		17	/* Serial / USB serial CAN Adaptors */
30
#define N_PPS		18	/* Pulse per Second */
31
#define N_V253		19	/* Codec control over voice modem */
32
#define N_CAIF		20      /* CAIF protocol for talking to modems */
A
Alan Cox 已提交
33
#define N_GSM0710	21	/* GSM 0710 Mux */
A
Alan Cox 已提交
34
#define N_TI_WL		22	/* for TI's WL BT, FM, GPS combo chips */
35 36
#define N_TRACESINK	23	/* Trace data routing for MIPI P1149.7 */
#define N_TRACEROUTER	24	/* Trace data routing for MIPI P1149.7 */
37

38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
#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>



/*
 * (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 */
54
#define NR_UNIX98_PTY_RESERVE	1024	  /* Default reserve for main devpts */
55 56
#define NR_UNIX98_PTY_MAX	(1 << MINORBITS) /* Absolute limit */

L
Linus Torvalds 已提交
57 58 59 60 61 62 63
/*
 * 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'

A
Alan Cox 已提交
64 65 66 67 68 69
struct tty_buffer {
	struct tty_buffer *next;
	char *char_buf_ptr;
	unsigned char *flag_buf_ptr;
	int used;
	int size;
P
Paul Fulghum 已提交
70 71
	int commit;
	int read;
A
Alan Cox 已提交
72 73 74 75
	/* Data points here */
	unsigned long data[0];
};

76 77
/*
 * We default to dicing tty buffer allocations to this many characters
78 79 80 81
 * in order to avoid multiple page allocations. We know the size of
 * tty_buffer itself but it must also be taken into account that the
 * the buffer is 256 byte aligned. See tty_buffer_find for the allocation
 * logic this must match
82 83
 */

84
#define TTY_BUFFER_PAGE	(((PAGE_SIZE - sizeof(struct tty_buffer)) / 2) & ~0xFF)
85 86


A
Alan Cox 已提交
87
struct tty_bufhead {
88
	struct work_struct work;
89
	spinlock_t lock;
A
Alan Cox 已提交
90 91 92
	struct tty_buffer *head;	/* Queue head */
	struct tty_buffer *tail;	/* Active buffer */
	struct tty_buffer *free;	/* Free queue head */
A
Alan Cox 已提交
93 94
	int memory_used;		/* Buffer space used excluding
								free queue */
L
Linus Torvalds 已提交
95 96 97 98 99 100 101 102 103 104 105
};
/*
 * 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

106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
#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])
L
Linus Torvalds 已提交
123

124 125 126 127
#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))
A
Alan Cox 已提交
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185

#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)
186
#define L_EXTPROC(tty)	_L_FLAG((tty), EXTPROC)
L
Linus Torvalds 已提交
187 188

struct device;
M
Miloslav Trmac 已提交
189
struct signal_struct;
190 191 192 193 194 195 196 197 198 199 200

/*
 * 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.
 */
A
Alan Cox 已提交
201

202 203 204 205 206
struct tty_port;

struct tty_port_operations {
	/* Return 1 if the carrier is raised */
	int (*carrier_raised)(struct tty_port *port);
A
Alan Cox 已提交
207
	/* Control the DTR line */
208
	void (*dtr_rts)(struct tty_port *port, int raise);
A
Alan Cox 已提交
209
	/* Called when the last close completes or a hangup finishes
A
Alan Cox 已提交
210 211
	   IFF the port was initialized. Do not use to free resources. Called
	   under the port mutex to serialize against activate/shutdowns */
A
Alan Cox 已提交
212 213
	void (*shutdown)(struct tty_port *port);
	void (*drop)(struct tty_port *port);
A
Alan Cox 已提交
214 215 216 217 218
	/* Called under the port mutex from tty_port_open, serialized using
	   the port mutex */
        /* FIXME: long term getting the tty argument *out* of this would be
           good for consoles */
	int (*activate)(struct tty_port *port, struct tty_struct *tty);
219 220
	/* Called on the final put of a port */
	void (*destruct)(struct tty_port *port);
221 222
};
	
223 224
struct tty_port {
	struct tty_struct	*tty;		/* Back pointer */
225
	const struct tty_port_operations *ops;	/* Port operations */
A
Alan Cox 已提交
226
	spinlock_t		lock;		/* Lock protecting tty field */
227 228 229 230
	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 */
231
	wait_queue_head_t	delta_msr_wait;	/* Modem status change */
232
	unsigned long		flags;		/* TTY flags ASY_*/
233
	unsigned char		console:1;	/* port is a console */
234
	struct mutex		mutex;		/* Locking */
235
	struct mutex		buf_mutex;	/* Buffer alloc lock */
236
	unsigned char		*xmit_buf;	/* Optional buffer */
237 238
	unsigned int		close_delay;	/* Close port delay */
	unsigned int		closing_wait;	/* Delay for output */
239 240 241
	int			drain_delay;	/* Set to zero if no pure time
						   based drain is needed else
						   set to size of fifo */
242
	struct kref		kref;		/* Ref counter */
243 244
};

L
Linus Torvalds 已提交
245 246 247 248 249 250 251 252 253 254 255
/*
 * 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
 */
A
Alan Cox 已提交
256 257 258

struct tty_operations;

L
Linus Torvalds 已提交
259 260
struct tty_struct {
	int	magic;
A
Alan Cox 已提交
261
	struct kref kref;
262
	struct device *dev;
L
Linus Torvalds 已提交
263
	struct tty_driver *driver;
A
Alan Cox 已提交
264
	const struct tty_operations *ops;
L
Linus Torvalds 已提交
265
	int index;
A
Alan Cox 已提交
266 267 268 269 270

	/* Protects ldisc changes: Lock tty not pty */
	struct mutex ldisc_mutex;
	struct tty_ldisc *ldisc;

A
Alan Cox 已提交
271
	struct mutex legacy_mutex;
272
	struct mutex termios_mutex;
A
Alan Cox 已提交
273
	spinlock_t ctrl_lock;
A
Alan Cox 已提交
274
	/* Termios values are protected by the termios mutex */
275
	struct ktermios termios, termios_locked;
A
Alan Cox 已提交
276
	struct termiox *termiox;	/* May be NULL for unsupported */
L
Linus Torvalds 已提交
277
	char name[64];
A
Alan Cox 已提交
278
	struct pid *pgrp;		/* Protected by ctrl lock */
279
	struct pid *session;
L
Linus Torvalds 已提交
280 281
	unsigned long flags;
	int count;
A
Alan Cox 已提交
282
	struct winsize winsize;		/* termios mutex */
L
Linus Torvalds 已提交
283 284
	unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
	unsigned char low_latency:1, warned:1;
A
Alan Cox 已提交
285
	unsigned char ctrl_status;	/* ctrl_lock */
A
Alan Cox 已提交
286
	unsigned int receive_room;	/* Bytes free for queue */
L
Linus Torvalds 已提交
287 288 289

	struct tty_struct *link;
	struct fasync_struct *fasync;
A
Alan Cox 已提交
290
	struct tty_bufhead buf;		/* Locked internally */
L
Linus Torvalds 已提交
291 292 293 294 295 296 297 298 299
	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
300

L
Linus Torvalds 已提交
301 302 303
	/*
	 * The following is data for the N_TTY line discipline.  For
	 * historical reasons, this is included in the tty structure.
A
Alan Cox 已提交
304
	 * Mostly locked by the BKL.
L
Linus Torvalds 已提交
305 306 307 308
	 */
	unsigned int column;
	unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
	unsigned char closing:1;
309
	unsigned char echo_overrun:1;
L
Linus Torvalds 已提交
310 311 312 313 314 315 316 317 318
	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))];
319 320 321
	unsigned char *echo_buf;
	unsigned int echo_pos;
	unsigned int echo_cnt;
L
Linus Torvalds 已提交
322 323 324
	int canon_data;
	unsigned long canon_head;
	unsigned int canon_column;
I
Ingo Molnar 已提交
325 326
	struct mutex atomic_read_lock;
	struct mutex atomic_write_lock;
327 328
	struct mutex output_lock;
	struct mutex echo_lock;
L
Linus Torvalds 已提交
329 330 331 332 333
	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;
334
	struct tty_port *port;
L
Linus Torvalds 已提交
335 336
};

N
Nick Piggin 已提交
337 338 339 340 341 342 343
/* Each of a tty's open files has private_data pointing to tty_file_private */
struct tty_file_private {
	struct tty_struct *tty;
	struct file *file;
	struct list_head list;
};

L
Linus Torvalds 已提交
344 345 346 347 348
/* tty magic number */
#define TTY_MAGIC		0x5401

/*
 * These bits are used in the flags field of the tty structure.
A
Alan Cox 已提交
349
 *
L
Linus Torvalds 已提交
350 351 352 353 354 355
 * 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 */
A
Alan Cox 已提交
356
#define TTY_IO_ERROR 		1	/* Cause an I/O error (may be no ldisc too) */
L
Linus Torvalds 已提交
357 358 359 360 361 362 363
#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 */
A
Alan Cox 已提交
364
#define TTY_LDISC_CHANGING 	10	/* Line discipline changing */
A
Alan Cox 已提交
365
#define TTY_LDISC_OPEN	 	11	/* Line discipline is open */
L
Linus Torvalds 已提交
366 367 368 369 370
#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() */
A
Alan Cox 已提交
371 372
#define TTY_FLUSHING		19	/* Flushing to ldisc in progress */
#define TTY_FLUSHPENDING	20	/* Queued buffer flush pending */
J
Jiri Slaby 已提交
373
#define TTY_HUPPING 		21	/* ->hangup() in progress */
L
Linus Torvalds 已提交
374 375 376 377 378

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

extern void tty_write_flush(struct tty_struct *);

379
extern struct ktermios tty_std_termios;
L
Linus Torvalds 已提交
380 381 382 383

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

384 385
extern struct class *tty_class;

A
Alan Cox 已提交
386 387 388 389 390 391 392 393 394
/**
 *	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
 */

395
static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
A
Alan Cox 已提交
396 397 398 399 400 401 402
{
	if (tty)
		kref_get(&tty->kref);
	return tty;
}
extern void tty_kref_put(struct tty_struct *tty);

L
Linus Torvalds 已提交
403 404 405
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);
A
Alan Cox 已提交
406 407 408 409
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);
L
Linus Torvalds 已提交
410 411
extern int tty_register_driver(struct tty_driver *driver);
extern int tty_unregister_driver(struct tty_driver *driver);
412 413
extern struct device *tty_register_device(struct tty_driver *driver,
					  unsigned index, struct device *dev);
L
Linus Torvalds 已提交
414 415 416 417
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);
A
Alan Cox 已提交
418 419 420 421
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);
A
Alan Cox 已提交
422 423
extern void tty_throttle(struct tty_struct *tty);
extern void tty_unthrottle(struct tty_struct *tty);
A
Alan Cox 已提交
424
extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
J
Jiri Slaby 已提交
425 426
extern void tty_driver_remove_tty(struct tty_driver *driver,
				  struct tty_struct *tty);
A
Alan Cox 已提交
427
extern void tty_free_termios(struct tty_struct *tty);
428
extern int is_current_pgrp_orphaned(void);
429
extern struct pid *tty_get_pgrp(struct tty_struct *tty);
L
Linus Torvalds 已提交
430 431
extern int is_ignored(int sig);
extern int tty_signal(int sig, struct tty_struct *tty);
A
Alan Cox 已提交
432 433
extern void tty_hangup(struct tty_struct *tty);
extern void tty_vhangup(struct tty_struct *tty);
A
Arnd Bergmann 已提交
434
extern void tty_vhangup_locked(struct tty_struct *tty);
A
Alan Cox 已提交
435
extern void tty_vhangup_self(void);
L
Linus Torvalds 已提交
436
extern void tty_unhangup(struct file *filp);
A
Alan Cox 已提交
437
extern int tty_hung_up_p(struct file *filp);
L
Linus Torvalds 已提交
438
extern void do_SAK(struct tty_struct *tty);
439
extern void __do_SAK(struct tty_struct *tty);
L
Linus Torvalds 已提交
440
extern void disassociate_ctty(int priv);
441
extern void no_tty(void);
L
Linus Torvalds 已提交
442
extern void tty_flip_buffer_push(struct tty_struct *tty);
443
extern void tty_flush_to_ldisc(struct tty_struct *tty);
A
Alan Cox 已提交
444 445 446
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);
447 448 449
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);
A
Alan Cox 已提交
450 451 452 453
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);
454
extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
A
Alan Cox 已提交
455
extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
456
extern int tty_set_termios(struct tty_struct *tty, struct ktermios *kt);
L
Linus Torvalds 已提交
457 458 459 460

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 *);
A
Alan Cox 已提交
461
extern void tty_ldisc_hangup(struct tty_struct *tty);
A
Alan Cox 已提交
462
extern const struct file_operations tty_ldiscs_proc_fops;
L
Linus Torvalds 已提交
463 464 465 466

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

A
Alan Cox 已提交
467
extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
468 469 470
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);
471 472 473
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);
474
extern void tty_default_fops(struct file_operations *fops);
475
extern struct tty_struct *alloc_tty_struct(void);
J
Jiri Slaby 已提交
476 477 478
extern int tty_alloc_file(struct file *file);
extern void tty_add_file(struct tty_struct *tty, struct file *file);
extern void tty_free_file(struct file *file);
479 480 481
extern void free_tty_struct(struct tty_struct *tty);
extern void initialize_tty_struct(struct tty_struct *tty,
		struct tty_driver *driver, int idx);
482
extern void deinitialize_tty_struct(struct tty_struct *tty);
483
extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx);
484
extern int tty_release(struct inode *inode, struct file *filp);
485
extern int tty_init_termios(struct tty_struct *tty);
486 487
extern int tty_standard_install(struct tty_driver *driver,
		struct tty_struct *tty);
488

489 490 491
extern struct tty_struct *tty_pair_get_tty(struct tty_struct *tty);
extern struct tty_struct *tty_pair_get_pty(struct tty_struct *tty);

I
Ingo Molnar 已提交
492
extern struct mutex tty_mutex;
N
Nick Piggin 已提交
493
extern spinlock_t tty_files_lock;
L
Linus Torvalds 已提交
494

495 496 497 498
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))

499
extern void tty_port_init(struct tty_port *port);
J
Jiri Slaby 已提交
500 501
extern void tty_port_link_device(struct tty_port *port,
		struct tty_driver *driver, unsigned index);
502 503 504
extern struct device *tty_port_register_device(struct tty_port *port,
		struct tty_driver *driver, unsigned index,
		struct device *device);
505 506
extern int tty_port_alloc_xmit_buf(struct tty_port *port);
extern void tty_port_free_xmit_buf(struct tty_port *port);
507 508
extern void tty_port_put(struct tty_port *port);

509
static inline struct tty_port *tty_port_get(struct tty_port *port)
510 511 512 513 514 515
{
	if (port)
		kref_get(&port->kref);
	return port;
}

A
Alan Cox 已提交
516 517
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);
518
extern int tty_port_carrier_raised(struct tty_port *port);
A
Alan Cox 已提交
519
extern void tty_port_raise_dtr_rts(struct tty_port *port);
520
extern void tty_port_lower_dtr_rts(struct tty_port *port);
521
extern void tty_port_hangup(struct tty_port *port);
522 523
extern int tty_port_block_til_ready(struct tty_port *port,
				struct tty_struct *tty, struct file *filp);
524 525 526
extern int tty_port_close_start(struct tty_port *port,
				struct tty_struct *tty, struct file *filp);
extern void tty_port_close_end(struct tty_port *port, struct tty_struct *tty);
A
Alan Cox 已提交
527 528
extern void tty_port_close(struct tty_port *port,
				struct tty_struct *tty, struct file *filp);
529 530
extern int tty_port_install(struct tty_port *port, struct tty_driver *driver,
				struct tty_struct *tty);
A
Alan Cox 已提交
531 532
extern int tty_port_open(struct tty_port *port,
				struct tty_struct *tty, struct file *filp);
533
static inline int tty_port_users(struct tty_port *port)
A
Alan Cox 已提交
534 535 536 537
{
	return port->count + port->blocked_open;
}

538 539 540 541 542 543
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);
544
extern void tty_ldisc_deinit(struct tty_struct *tty);
545 546 547
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);
548 549


L
Linus Torvalds 已提交
550
/* n_tty.c */
A
Alan Cox 已提交
551
extern struct tty_ldisc_ops tty_ldisc_N_TTY;
552
extern void n_tty_inherit_ops(struct tty_ldisc_ops *ops);
L
Linus Torvalds 已提交
553

M
Miloslav Trmac 已提交
554 555 556 557 558 559
/* 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);
A
Al Viro 已提交
560
extern void tty_audit_tiocsti(struct tty_struct *tty, char ch);
M
Miloslav Trmac 已提交
561
extern void tty_audit_push(struct tty_struct *tty);
562 563
extern int tty_audit_push_task(struct task_struct *tsk,
			       uid_t loginuid, u32 sessionid);
M
Miloslav Trmac 已提交
564 565 566 567 568
#else
static inline void tty_audit_add_data(struct tty_struct *tty,
				      unsigned char *data, size_t size)
{
}
A
Al Viro 已提交
569 570 571
static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch)
{
}
M
Miloslav Trmac 已提交
572 573 574 575 576 577 578 579 580
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)
{
}
581 582
static inline int tty_audit_push_task(struct task_struct *tsk,
				      uid_t loginuid, u32 sessionid)
M
Miloslav Trmac 已提交
583
{
584
	return 0;
M
Miloslav Trmac 已提交
585 586 587
}
#endif

588 589 590
/* tty_io.c */
extern int __init tty_init(void);

L
Linus Torvalds 已提交
591
/* tty_ioctl.c */
592
extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
L
Linus Torvalds 已提交
593
		       unsigned int cmd, unsigned long arg);
594 595
extern long n_tty_compat_ioctl_helper(struct tty_struct *tty, struct file *file,
		       unsigned int cmd, unsigned long arg);
L
Linus Torvalds 已提交
596 597 598 599

/* serial.c */

extern void serial_console_init(void);
A
Alan Cox 已提交
600

L
Linus Torvalds 已提交
601 602 603 604 605 606
/* pcxx.c */

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

/* vt.c */

607
extern int vt_ioctl(struct tty_struct *tty,
L
Linus Torvalds 已提交
608 609
		    unsigned int cmd, unsigned long arg);

610
extern long vt_compat_ioctl(struct tty_struct *tty,
611 612
		     unsigned int cmd, unsigned long arg);

613
/* tty_mutex.c */
614
/* functions for preparation of BKL removal */
A
Alan Cox 已提交
615 616 617 618 619 620
extern void __lockfunc tty_lock(struct tty_struct *tty);
extern void __lockfunc tty_unlock(struct tty_struct *tty);
extern void __lockfunc tty_lock_pair(struct tty_struct *tty,
				struct tty_struct *tty2);
extern void __lockfunc tty_unlock_pair(struct tty_struct *tty,
				struct tty_struct *tty2);
621

622 623 624 625 626 627 628 629 630 631 632 633 634
/*
 * this shall be called only from where BTM is held (like close)
 *
 * We need this to ensure nobody waits for us to finish while we are waiting.
 * Without this we were encountering system stalls.
 *
 * This should be indeed removed with BTM removal later.
 *
 * Locking: BTM required. Nobody is allowed to hold port->mutex.
 */
static inline void tty_wait_until_sent_from_close(struct tty_struct *tty,
		long timeout)
{
A
Alan Cox 已提交
635
	tty_unlock(tty); /* tty->ops->close holds the BTM, drop it while waiting */
636
	tty_wait_until_sent(tty, timeout);
A
Alan Cox 已提交
637
	tty_lock(tty);
638
}
639

640 641 642 643 644 645 646 647 648 649 650 651
/*
 * wait_event_interruptible_tty -- wait for a condition with the tty lock held
 *
 * The condition we are waiting for might take a long time to
 * become true, or might depend on another thread taking the
 * BTM. In either case, we need to drop the BTM to guarantee
 * forward progress. This is a leftover from the conversion
 * from the BKL and should eventually get removed as the BTM
 * falls out of use.
 *
 * Do not use in new code.
 */
A
Alan Cox 已提交
652
#define wait_event_interruptible_tty(tty, wq, condition)		\
653 654 655
({									\
	int __ret = 0;							\
	if (!(condition)) {						\
A
Alan Cox 已提交
656
		__wait_event_interruptible_tty(tty, wq, condition, __ret);	\
657 658 659 660
	}								\
	__ret;								\
})

A
Alan Cox 已提交
661
#define __wait_event_interruptible_tty(tty, wq, condition, ret)		\
662 663 664 665 666 667 668 669
do {									\
	DEFINE_WAIT(__wait);						\
									\
	for (;;) {							\
		prepare_to_wait(&wq, &__wait, TASK_INTERRUPTIBLE);	\
		if (condition)						\
			break;						\
		if (!signal_pending(current)) {				\
A
Alan Cox 已提交
670
			tty_unlock(tty);					\
671
			schedule();					\
A
Alan Cox 已提交
672
			tty_lock(tty);					\
673 674 675 676 677 678 679 680 681
			continue;					\
		}							\
		ret = -ERESTARTSYS;					\
		break;							\
	}								\
	finish_wait(&wq, &__wait);					\
} while (0)


L
Linus Torvalds 已提交
682 683
#endif /* __KERNEL__ */
#endif