tty.h 23.3 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3
#ifndef _LINUX_TTY_H
#define _LINUX_TTY_H

4 5 6 7 8 9 10
#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>
11
#include <linux/tty_flags.h>
12
#include <uapi/linux/tty.h>
13
#include <linux/rwsem.h>
14
#include <linux/llist.h>
15 16


17 18 19 20 21 22 23 24 25 26 27
/*
 * Lock subclasses for tty locks
 *
 * TTY_LOCK_NORMAL is for normal ttys and master ptys.
 * TTY_LOCK_SLAVE is for slave ptys only.
 *
 * Lock subclasses are necessary for handling nested locking with pty pairs.
 * tty locks which use nested locking:
 *
 * legacy_mutex - Nested tty locks are necessary for releasing pty pairs.
 *		  The stable lock order is master pty first, then slave pty.
28 29 30
 * termios_rwsem - The stable lock order is tty_buffer lock->termios_rwsem.
 *		   Subclassing this lock enables the slave pty to hold its
 *		   termios_rwsem when claiming the master tty_buffer lock.
P
Peter Hurley 已提交
31 32 33
 * tty_buffer lock - slave ptys can claim nested buffer lock when handling
 *		     signal chars. The stable lock order is slave pty, then
 *		     master.
34 35 36 37 38 39
 */

enum {
	TTY_LOCK_NORMAL = 0,
	TTY_LOCK_SLAVE,
};
40 41 42 43 44 45

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

L
Linus Torvalds 已提交
49 50 51 52 53 54 55
/*
 * 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 已提交
56
struct tty_buffer {
57 58 59 60
	union {
		struct tty_buffer *next;
		struct llist_node free;
	};
A
Alan Cox 已提交
61 62
	int used;
	int size;
P
Paul Fulghum 已提交
63 64
	int commit;
	int read;
65
	int flags;
A
Alan Cox 已提交
66 67 68 69
	/* Data points here */
	unsigned long data[0];
};

70 71 72
/* Values for .flags field of tty_buffer */
#define TTYB_NORMAL	1	/* buffer has no flags buffer */

P
Peter Hurley 已提交
73 74 75 76 77 78 79 80 81 82
static inline unsigned char *char_buf_ptr(struct tty_buffer *b, int ofs)
{
	return ((unsigned char *)b->data) + ofs;
}

static inline char *flag_buf_ptr(struct tty_buffer *b, int ofs)
{
	return (char *)char_buf_ptr(b, ofs) + b->size;
}

A
Alan Cox 已提交
83
struct tty_bufhead {
84
	struct tty_buffer *head;	/* Queue head */
85
	struct work_struct work;
86 87
	struct mutex	   lock;
	atomic_t	   priority;
88
	struct tty_buffer sentinel;
89
	struct llist_head free;		/* Free queue head */
90
	atomic_t	   mem_used;    /* In-use buffers excluding free list */
91
	int		   mem_limit;
92
	struct tty_buffer *tail;	/* Active buffer */
L
Linus Torvalds 已提交
93 94 95 96 97 98 99 100 101 102 103
};
/*
 * 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

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
#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 已提交
121

122 123 124 125
#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 已提交
126 127 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

#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)
A
Andrew Lunn 已提交
168
#define C_CMSPAR(tty)	_C_FLAG((tty), CMSPAR)
A
Alan Cox 已提交
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184

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

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

/*
 * 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 已提交
200

201 202 203 204 205
struct tty_port;

struct tty_port_operations {
	/* Return 1 if the carrier is raised */
	int (*carrier_raised)(struct tty_port *port);
A
Alan Cox 已提交
206
	/* Control the DTR line */
207
	void (*dtr_rts)(struct tty_port *port, int raise);
A
Alan Cox 已提交
208
	/* Called when the last close completes or a hangup finishes
A
Alan Cox 已提交
209 210
	   IFF the port was initialized. Do not use to free resources. Called
	   under the port mutex to serialize against activate/shutdowns */
A
Alan Cox 已提交
211
	void (*shutdown)(struct tty_port *port);
A
Alan Cox 已提交
212 213 214 215 216
	/* 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);
217 218
	/* Called on the final put of a port */
	void (*destruct)(struct tty_port *port);
219 220
};
	
221
struct tty_port {
J
Jiri Slaby 已提交
222
	struct tty_bufhead	buf;		/* Locked internally */
223
	struct tty_struct	*tty;		/* Back pointer */
J
Jiri Slaby 已提交
224
	struct tty_struct	*itty;		/* internal back ptr */
225
	const struct tty_port_operations *ops;	/* Port operations */
A
Alan Cox 已提交
226
	spinlock_t		lock;		/* Lock protecting tty field */
227 228 229
	int			blocked_open;	/* Waiting to open */
	int			count;		/* Usage count */
	wait_queue_head_t	open_wait;	/* Open waiters */
230
	wait_queue_head_t	delta_msr_wait;	/* Modem status change */
231
	unsigned long		flags;		/* TTY flags ASY_*/
J
Jiri Slaby 已提交
232
	unsigned char		console:1,	/* port is a console */
P
Peter Hurley 已提交
233
				low_latency:1;	/* optional: tune for latency */
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

	/* Protects ldisc changes: Lock tty not pty */
268
	struct ld_semaphore ldisc_sem;
A
Alan Cox 已提交
269 270
	struct tty_ldisc *ldisc;

271
	struct mutex atomic_write_lock;
A
Alan Cox 已提交
272
	struct mutex legacy_mutex;
273
	struct mutex throttle_mutex;
274
	struct rw_semaphore termios_rwsem;
275
	struct mutex winsize_mutex;
A
Alan Cox 已提交
276
	spinlock_t ctrl_lock;
277
	spinlock_t flow_lock;
278
	/* Termios values are protected by the termios rwsem */
279
	struct ktermios termios, termios_locked;
A
Alan Cox 已提交
280
	struct termiox *termiox;	/* May be NULL for unsupported */
L
Linus Torvalds 已提交
281
	char name[64];
A
Alan Cox 已提交
282
	struct pid *pgrp;		/* Protected by ctrl lock */
283
	struct pid *session;
L
Linus Torvalds 已提交
284 285
	unsigned long flags;
	int count;
286
	struct winsize winsize;		/* winsize_mutex */
287 288
	unsigned long stopped:1,	/* flow_lock */
		      flow_stopped:1,
289
		      unused:BITS_PER_LONG - 2;
290
	int hw_stopped;
291 292
	unsigned long ctrl_status:8,	/* ctrl_lock */
		      packet:1,
293
		      unused_ctrl:BITS_PER_LONG - 9;
A
Alan Cox 已提交
294
	unsigned int receive_room;	/* Bytes free for queue */
295
	int flow_change;
L
Linus Torvalds 已提交
296 297 298 299 300 301 302 303 304

	struct tty_struct *link;
	struct fasync_struct *fasync;
	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;
P
Peter Hurley 已提交
305
	spinlock_t files_lock;		/* protects tty_files list */
L
Linus Torvalds 已提交
306 307 308
	struct list_head tty_files;

#define N_TTY_BUF_SIZE 4096
309

P
Peter Hurley 已提交
310
	int closing;
L
Linus Torvalds 已提交
311 312 313 314
	unsigned char *write_buf;
	int write_cnt;
	/* If the tty has a pending do_SAK, queue it here - akpm */
	struct work_struct SAK_work;
315
	struct tty_port *port;
L
Linus Torvalds 已提交
316 317
};

N
Nick Piggin 已提交
318 319 320 321 322 323 324
/* 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 已提交
325 326 327 328 329
/* tty magic number */
#define TTY_MAGIC		0x5401

/*
 * These bits are used in the flags field of the tty structure.
A
Alan Cox 已提交
330
 *
L
Linus Torvalds 已提交
331 332 333 334 335 336
 * 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 已提交
337
#define TTY_IO_ERROR 		1	/* Cause an I/O error (may be no ldisc too) */
L
Linus Torvalds 已提交
338 339 340
#define TTY_OTHER_CLOSED 	2	/* Other side (if any) has closed */
#define TTY_EXCLUSIVE 		3	/* Exclusive open mode */
#define TTY_DO_WRITE_WAKEUP 	5	/* Call write_wakeup after queuing new */
P
Peter Hurley 已提交
341
#define TTY_OTHER_DONE		6	/* Closed pty has completed input processing */
A
Alan Cox 已提交
342
#define TTY_LDISC_OPEN	 	11	/* Line discipline is open */
L
Linus Torvalds 已提交
343 344 345
#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() */
346
#define TTY_LDISC_HALTED	22	/* Line discipline is halted */
L
Linus Torvalds 已提交
347

348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
/* Values for tty->flow_change */
#define TTY_THROTTLE_SAFE 1
#define TTY_UNTHROTTLE_SAFE 2

static inline void __tty_set_flow_change(struct tty_struct *tty, int val)
{
	tty->flow_change = val;
}

static inline void tty_set_flow_change(struct tty_struct *tty, int val)
{
	tty->flow_change = val;
	smp_mb();
}

363 364 365 366 367 368 369 370 371 372 373
#ifdef CONFIG_TTY
extern void console_init(void);
extern void tty_kref_put(struct tty_struct *tty);
extern struct pid *tty_get_pgrp(struct tty_struct *tty);
extern void tty_vhangup_self(void);
extern void disassociate_ctty(int priv);
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);
/* tty_io.c */
extern int __init tty_init(void);
374
extern const char *tty_name(const struct tty_struct *tty);
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
#else
static inline void console_init(void)
{ }
static inline void tty_kref_put(struct tty_struct *tty)
{ }
static inline struct pid *tty_get_pgrp(struct tty_struct *tty)
{ return NULL; }
static inline void tty_vhangup_self(void)
{ }
static inline void disassociate_ctty(int priv)
{ }
static inline dev_t tty_devnum(struct tty_struct *tty)
{ return 0; }
static inline void proc_clear_tty(struct task_struct *p)
{ }
static inline struct tty_struct *get_current_tty(void)
{ return NULL; }
/* tty_io.c */
static inline int __init tty_init(void)
{ return 0; }
395 396
static inline const char *tty_name(const struct tty_struct *tty)
{ return "(none)"; }
397 398
#endif

399
extern struct ktermios tty_std_termios;
L
Linus Torvalds 已提交
400 401 402

extern int vcs_init(void);

403 404
extern struct class *tty_class;

A
Alan Cox 已提交
405 406 407 408 409 410 411 412 413
/**
 *	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
 */

414
static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
A
Alan Cox 已提交
415 416 417 418 419 420
{
	if (tty)
		kref_get(&tty->kref);
	return tty;
}

421
extern const char *tty_driver_name(const struct tty_struct *tty);
A
Alan Cox 已提交
422
extern void tty_wait_until_sent(struct tty_struct *tty, long timeout);
423
extern int __tty_check_change(struct tty_struct *tty, int sig);
A
Alan Cox 已提交
424
extern int tty_check_change(struct tty_struct *tty);
425
extern void __stop_tty(struct tty_struct *tty);
A
Alan Cox 已提交
426
extern void stop_tty(struct tty_struct *tty);
427
extern void __start_tty(struct tty_struct *tty);
A
Alan Cox 已提交
428
extern void start_tty(struct tty_struct *tty);
L
Linus Torvalds 已提交
429 430
extern int tty_register_driver(struct tty_driver *driver);
extern int tty_unregister_driver(struct tty_driver *driver);
431 432
extern struct device *tty_register_device(struct tty_driver *driver,
					  unsigned index, struct device *dev);
433 434 435 436
extern struct device *tty_register_device_attr(struct tty_driver *driver,
				unsigned index, struct device *device,
				void *drvdata,
				const struct attribute_group **attr_grp);
L
Linus Torvalds 已提交
437 438
extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
extern void tty_write_message(struct tty_struct *tty, char *msg);
439
extern int tty_send_xchar(struct tty_struct *tty, char ch);
A
Alan Cox 已提交
440 441 442 443
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 已提交
444 445
extern void tty_throttle(struct tty_struct *tty);
extern void tty_unthrottle(struct tty_struct *tty);
446 447
extern int tty_throttle_safe(struct tty_struct *tty);
extern int tty_unthrottle_safe(struct tty_struct *tty);
A
Alan Cox 已提交
448
extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
449
extern int is_current_pgrp_orphaned(void);
A
Alan Cox 已提交
450 451 452
extern void tty_hangup(struct tty_struct *tty);
extern void tty_vhangup(struct tty_struct *tty);
extern int tty_hung_up_p(struct file *filp);
L
Linus Torvalds 已提交
453
extern void do_SAK(struct tty_struct *tty);
454
extern void __do_SAK(struct tty_struct *tty);
455
extern void no_tty(void);
J
Jiri Slaby 已提交
456
extern void tty_buffer_free_all(struct tty_port *port);
457
extern void tty_buffer_flush(struct tty_struct *tty, struct tty_ldisc *ld);
J
Jiri Slaby 已提交
458
extern void tty_buffer_init(struct tty_port *port);
P
Peter Hurley 已提交
459
extern void tty_buffer_set_lock_subclass(struct tty_port *port);
P
Peter Hurley 已提交
460 461
extern bool tty_buffer_restart_work(struct tty_port *port);
extern bool tty_buffer_cancel_work(struct tty_port *port);
462 463
extern speed_t tty_termios_baud_rate(struct ktermios *termios);
extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
A
Alan Cox 已提交
464 465 466 467
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);
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483

/**
 *	tty_get_baud_rate	-	get tty bit rates
 *	@tty: tty to query
 *
 *	Returns the baud rate as an integer for this terminal. The
 *	termios lock must be held by the caller and the terminal bit
 *	flags may be updated.
 *
 *	Locking: none
 */
static inline speed_t tty_get_baud_rate(struct tty_struct *tty)
{
	return tty_termios_baud_rate(&tty->termios);
}

484
extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
A
Alan Cox 已提交
485
extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
486
extern int tty_set_termios(struct tty_struct *tty, struct ktermios *kt);
L
Linus Torvalds 已提交
487 488 489 490

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 *);
491 492
extern void tty_ldisc_hangup(struct tty_struct *tty, bool reset);
extern int tty_ldisc_reinit(struct tty_struct *tty, int disc);
A
Alan Cox 已提交
493
extern const struct file_operations tty_ldiscs_proc_fops;
L
Linus Torvalds 已提交
494 495 496 497

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

A
Alan Cox 已提交
498
extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
499 500 501
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);
502
extern void tty_default_fops(struct file_operations *fops);
503
extern struct tty_struct *alloc_tty_struct(struct tty_driver *driver, int idx);
J
Jiri Slaby 已提交
504 505 506
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);
507
extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx);
508
extern int tty_release(struct inode *inode, struct file *filp);
509
extern void tty_init_termios(struct tty_struct *tty);
510 511
extern int tty_standard_install(struct tty_driver *driver,
		struct tty_struct *tty);
512

I
Ingo Molnar 已提交
513
extern struct mutex tty_mutex;
L
Linus Torvalds 已提交
514

515 516
#define tty_is_writelocked(tty)  (mutex_is_locked(&tty->atomic_write_lock))

517
extern void tty_port_init(struct tty_port *port);
J
Jiri Slaby 已提交
518 519
extern void tty_port_link_device(struct tty_port *port,
		struct tty_driver *driver, unsigned index);
520 521 522
extern struct device *tty_port_register_device(struct tty_port *port,
		struct tty_driver *driver, unsigned index,
		struct device *device);
523 524 525 526
extern struct device *tty_port_register_device_attr(struct tty_port *port,
		struct tty_driver *driver, unsigned index,
		struct device *device, void *drvdata,
		const struct attribute_group **attr_grp);
527 528
extern int tty_port_alloc_xmit_buf(struct tty_port *port);
extern void tty_port_free_xmit_buf(struct tty_port *port);
J
Jiri Slaby 已提交
529
extern void tty_port_destroy(struct tty_port *port);
530 531
extern void tty_port_put(struct tty_port *port);

532
static inline struct tty_port *tty_port_get(struct tty_port *port)
533
{
534 535 536
	if (port && kref_get_unless_zero(&port->kref))
		return port;
	return NULL;
537 538
}

H
Huang Shijie 已提交
539 540 541 542 543 544
/* If the cts flow control is enabled, return true. */
static inline bool tty_port_cts_enabled(struct tty_port *port)
{
	return port->flags & ASYNC_CTS_FLOW;
}

A
Alan Cox 已提交
545 546
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);
547
extern int tty_port_carrier_raised(struct tty_port *port);
A
Alan Cox 已提交
548
extern void tty_port_raise_dtr_rts(struct tty_port *port);
549
extern void tty_port_lower_dtr_rts(struct tty_port *port);
550
extern void tty_port_hangup(struct tty_port *port);
J
Jiri Slaby 已提交
551
extern void tty_port_tty_hangup(struct tty_port *port, bool check_clocal);
J
Jiri Slaby 已提交
552
extern void tty_port_tty_wakeup(struct tty_port *port);
553 554
extern int tty_port_block_til_ready(struct tty_port *port,
				struct tty_struct *tty, struct file *filp);
555 556 557
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 已提交
558 559
extern void tty_port_close(struct tty_port *port,
				struct tty_struct *tty, struct file *filp);
560 561
extern int tty_port_install(struct tty_port *port, struct tty_driver *driver,
				struct tty_struct *tty);
A
Alan Cox 已提交
562 563
extern int tty_port_open(struct tty_port *port,
				struct tty_struct *tty, struct file *filp);
564
static inline int tty_port_users(struct tty_port *port)
A
Alan Cox 已提交
565 566 567 568
{
	return port->count + port->blocked_open;
}

569 570
extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
extern int tty_unregister_ldisc(int disc);
571
extern int tty_set_ldisc(struct tty_struct *tty, int disc);
572
extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty);
573
extern void tty_ldisc_release(struct tty_struct *tty);
574
extern void tty_ldisc_init(struct tty_struct *tty);
575
extern void tty_ldisc_deinit(struct tty_struct *tty);
576 577
extern int tty_ldisc_receive_buf(struct tty_ldisc *ld, unsigned char *p,
				 char *f, int count);
578

L
Linus Torvalds 已提交
579
/* n_tty.c */
580
extern void n_tty_inherit_ops(struct tty_ldisc_ops *ops);
581
extern void __init n_tty_init(void);
L
Linus Torvalds 已提交
582

M
Miloslav Trmac 已提交
583 584
/* tty_audit.c */
#ifdef CONFIG_AUDIT
P
Peter Hurley 已提交
585
extern void tty_audit_add_data(struct tty_struct *tty, const void *data,
586
			       size_t size);
M
Miloslav Trmac 已提交
587 588
extern void tty_audit_exit(void);
extern void tty_audit_fork(struct signal_struct *sig);
A
Al Viro 已提交
589
extern void tty_audit_tiocsti(struct tty_struct *tty, char ch);
590
extern int tty_audit_push(void);
M
Miloslav Trmac 已提交
591
#else
P
Peter Hurley 已提交
592
static inline void tty_audit_add_data(struct tty_struct *tty, const void *data,
593
				      size_t size)
M
Miloslav Trmac 已提交
594 595
{
}
A
Al Viro 已提交
596 597 598
static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch)
{
}
M
Miloslav Trmac 已提交
599 600 601 602 603 604
static inline void tty_audit_exit(void)
{
}
static inline void tty_audit_fork(struct signal_struct *sig)
{
}
605
static inline int tty_audit_push(void)
M
Miloslav Trmac 已提交
606
{
607
	return 0;
M
Miloslav Trmac 已提交
608 609 610
}
#endif

L
Linus Torvalds 已提交
611
/* tty_ioctl.c */
612
extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
L
Linus Torvalds 已提交
613
		       unsigned int cmd, unsigned long arg);
614 615
extern long n_tty_compat_ioctl_helper(struct tty_struct *tty, struct file *file,
		       unsigned int cmd, unsigned long arg);
L
Linus Torvalds 已提交
616 617 618

/* vt.c */

619
extern int vt_ioctl(struct tty_struct *tty,
L
Linus Torvalds 已提交
620 621
		    unsigned int cmd, unsigned long arg);

622
extern long vt_compat_ioctl(struct tty_struct *tty,
623 624
		     unsigned int cmd, unsigned long arg);

625
/* tty_mutex.c */
626
/* functions for preparation of BKL removal */
627
extern void tty_lock(struct tty_struct *tty);
628
extern int  tty_lock_interruptible(struct tty_struct *tty);
629 630 631
extern void tty_unlock(struct tty_struct *tty);
extern void tty_lock_slave(struct tty_struct *tty);
extern void tty_unlock_slave(struct tty_struct *tty);
632
extern void tty_set_lock_subclass(struct tty_struct *tty);
633

634 635 636 637 638 639 640
#ifdef CONFIG_PROC_FS
extern void proc_tty_register_driver(struct tty_driver *);
extern void proc_tty_unregister_driver(struct tty_driver *);
#else
static inline void proc_tty_register_driver(struct tty_driver *d) {}
static inline void proc_tty_unregister_driver(struct tty_driver *d) {}
#endif
641

P
Peter Hurley 已提交
642 643 644
#define tty_msg(fn, tty, f, ...) \
	fn("%s %s: " f, tty_driver_name(tty), tty_name(tty), ##__VA_ARGS__)

645
#define tty_debug(tty, f, ...)	tty_msg(pr_debug, tty, f, ##__VA_ARGS__)
P
Peter Hurley 已提交
646 647 648 649 650 651 652
#define tty_info(tty, f, ...)	tty_msg(pr_info, tty, f, ##__VA_ARGS__)
#define tty_notice(tty, f, ...)	tty_msg(pr_notice, tty, f, ##__VA_ARGS__)
#define tty_warn(tty, f, ...)	tty_msg(pr_warn, tty, f, ##__VA_ARGS__)
#define tty_err(tty, f, ...)	tty_msg(pr_err, tty, f, ##__VA_ARGS__)

#define tty_info_ratelimited(tty, f, ...) \
		tty_msg(pr_info_ratelimited, tty, f, ##__VA_ARGS__)
653

L
Linus Torvalds 已提交
654
#endif