tty.h 23.2 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
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 */
Alan Cox's avatar
Alan Cox committed
33
#define N_GSM0710	21	/* GSM 0710 Mux */
Alan Cox's avatar
Alan Cox committed
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
54
55
56
#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 */

Linus Torvalds's avatar
Linus Torvalds committed
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'

Alan Cox's avatar
Alan Cox committed
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;
Paul Fulghum's avatar
Paul Fulghum committed
70
71
	int commit;
	int read;
Alan Cox's avatar
Alan Cox committed
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


Alan Cox's avatar
Alan Cox committed
87
struct tty_bufhead {
88
	struct work_struct work;
89
	spinlock_t lock;
Alan Cox's avatar
Alan Cox committed
90
91
92
	struct tty_buffer *head;	/* Queue head */
	struct tty_buffer *tail;	/* Active buffer */
	struct tty_buffer *free;	/* Free queue head */
Alan Cox's avatar
Alan Cox committed
93
94
	int memory_used;		/* Buffer space used excluding
								free queue */
Linus Torvalds's avatar
Linus Torvalds committed
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
};
/*
 * 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])

Alan Cox's avatar
Alan Cox committed
124
125
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
#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)
186
#define L_EXTPROC(tty)	_L_FLAG((tty), EXTPROC)
Linus Torvalds's avatar
Linus Torvalds committed
187
188

struct device;
Miloslav Trmac's avatar
Miloslav Trmac committed
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.
 */
Alan Cox's avatar
Alan Cox committed
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);
Alan Cox's avatar
Alan Cox committed
207
	/* Control the DTR line */
208
	void (*dtr_rts)(struct tty_port *port, int raise);
Alan Cox's avatar
Alan Cox committed
209
	/* Called when the last close completes or a hangup finishes
210
211
	   IFF the port was initialized. Do not use to free resources. Called
	   under the port mutex to serialize against activate/shutdowns */
Alan Cox's avatar
Alan Cox committed
212
213
	void (*shutdown)(struct tty_port *port);
	void (*drop)(struct tty_port *port);
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 */
Alan Cox's avatar
Alan Cox committed
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
};

Linus Torvalds's avatar
Linus Torvalds committed
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
 */
Alan Cox's avatar
Alan Cox committed
256
257
258

struct tty_operations;

Linus Torvalds's avatar
Linus Torvalds committed
259
260
struct tty_struct {
	int	magic;
Alan Cox's avatar
Alan Cox committed
261
	struct kref kref;
262
	struct device *dev;
Linus Torvalds's avatar
Linus Torvalds committed
263
	struct tty_driver *driver;
Alan Cox's avatar
Alan Cox committed
264
	const struct tty_operations *ops;
Linus Torvalds's avatar
Linus Torvalds committed
265
	int index;
Alan Cox's avatar
Alan Cox committed
266
267
268
269
270

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

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

	struct tty_struct *link;
	struct fasync_struct *fasync;
Alan Cox's avatar
Alan Cox committed
289
	struct tty_bufhead buf;		/* Locked internally */
Linus Torvalds's avatar
Linus Torvalds committed
290
291
292
293
294
295
296
297
298
	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
299

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

Nick Piggin's avatar
Nick Piggin committed
336
337
338
339
340
341
342
/* 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;
};

Linus Torvalds's avatar
Linus Torvalds committed
343
344
345
346
347
/* tty magic number */
#define TTY_MAGIC		0x5401

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

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

extern void tty_write_flush(struct tty_struct *);

378
extern struct ktermios tty_std_termios;
Linus Torvalds's avatar
Linus Torvalds committed
379
380
381
382

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

383
384
extern struct class *tty_class;

Alan Cox's avatar
Alan Cox committed
385
386
387
388
389
390
391
392
393
/**
 *	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
 */

394
static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
Alan Cox's avatar
Alan Cox committed
395
396
397
398
399
400
401
{
	if (tty)
		kref_get(&tty->kref);
	return tty;
}
extern void tty_kref_put(struct tty_struct *tty);

Linus Torvalds's avatar
Linus Torvalds committed
402
403
404
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);
Alan Cox's avatar
Alan Cox committed
405
406
407
408
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);
Linus Torvalds's avatar
Linus Torvalds committed
409
410
extern int tty_register_driver(struct tty_driver *driver);
extern int tty_unregister_driver(struct tty_driver *driver);
411
412
extern struct device *tty_register_device(struct tty_driver *driver,
					  unsigned index, struct device *dev);
Linus Torvalds's avatar
Linus Torvalds committed
413
414
415
416
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);
Alan Cox's avatar
Alan Cox committed
417
418
419
420
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);
421
422
extern void tty_throttle(struct tty_struct *tty);
extern void tty_unthrottle(struct tty_struct *tty);
Alan Cox's avatar
Alan Cox committed
423
extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
Jiri Slaby's avatar
Jiri Slaby committed
424
425
extern void tty_driver_remove_tty(struct tty_driver *driver,
				  struct tty_struct *tty);
Alan Cox's avatar
Alan Cox committed
426
427
extern void tty_shutdown(struct tty_struct *tty);
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);
Linus Torvalds's avatar
Linus Torvalds committed
430
431
extern int is_ignored(int sig);
extern int tty_signal(int sig, struct tty_struct *tty);
Alan Cox's avatar
Alan Cox committed
432
433
extern void tty_hangup(struct tty_struct *tty);
extern void tty_vhangup(struct tty_struct *tty);
Arnd Bergmann's avatar
Arnd Bergmann committed
434
extern void tty_vhangup_locked(struct tty_struct *tty);
Alan Cox's avatar
Alan Cox committed
435
extern void tty_vhangup_self(void);
Linus Torvalds's avatar
Linus Torvalds committed
436
extern void tty_unhangup(struct file *filp);
Alan Cox's avatar
Alan Cox committed
437
extern int tty_hung_up_p(struct file *filp);
Linus Torvalds's avatar
Linus Torvalds committed
438
extern void do_SAK(struct tty_struct *tty);
439
extern void __do_SAK(struct tty_struct *tty);
Linus Torvalds's avatar
Linus Torvalds committed
440
extern void disassociate_ctty(int priv);
441
extern void no_tty(void);
Linus Torvalds's avatar
Linus Torvalds committed
442
extern void tty_flip_buffer_push(struct tty_struct *tty);
443
extern void tty_flush_to_ldisc(struct tty_struct *tty);
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);
Alan Cox's avatar
Alan Cox committed
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);
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);
Linus Torvalds's avatar
Linus Torvalds committed
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 *);
Alan Cox's avatar
Alan Cox committed
461
extern void tty_ldisc_hangup(struct tty_struct *tty);
Alan Cox's avatar
Alan Cox committed
462
extern const struct file_operations tty_ldiscs_proc_fops;
Linus Torvalds's avatar
Linus Torvalds committed
463
464
465
466

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

Alan Cox's avatar
Alan Cox committed
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);
476
extern int tty_add_file(struct tty_struct *tty, struct file *file);
477
478
479
extern void free_tty_struct(struct tty_struct *tty);
extern void initialize_tty_struct(struct tty_struct *tty,
		struct tty_driver *driver, int idx);
480
extern void deinitialize_tty_struct(struct tty_struct *tty);
481
482
extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx,
								int first_ok);
483
extern int tty_release(struct inode *inode, struct file *filp);
484
extern int tty_init_termios(struct tty_struct *tty);
485

486
487
488
extern struct tty_struct *tty_pair_get_tty(struct tty_struct *tty);
extern struct tty_struct *tty_pair_get_pty(struct tty_struct *tty);

Ingo Molnar's avatar
Ingo Molnar committed
489
extern struct mutex tty_mutex;
Nick Piggin's avatar
Nick Piggin committed
490
extern spinlock_t tty_files_lock;
Linus Torvalds's avatar
Linus Torvalds committed
491

492
493
494
495
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))

496
497
498
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);
499
500
extern void tty_port_put(struct tty_port *port);

501
static inline struct tty_port *tty_port_get(struct tty_port *port)
502
503
504
505
506
507
{
	if (port)
		kref_get(&port->kref);
	return port;
}

Alan Cox's avatar
Alan Cox committed
508
509
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);
510
extern int tty_port_carrier_raised(struct tty_port *port);
511
extern void tty_port_raise_dtr_rts(struct tty_port *port);
512
extern void tty_port_lower_dtr_rts(struct tty_port *port);
513
extern void tty_port_hangup(struct tty_port *port);
514
515
extern int tty_port_block_til_ready(struct tty_port *port,
				struct tty_struct *tty, struct file *filp);
516
517
518
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);
Alan Cox's avatar
Alan Cox committed
519
520
extern void tty_port_close(struct tty_port *port,
				struct tty_struct *tty, struct file *filp);
521
522
extern int tty_port_open(struct tty_port *port,
				struct tty_struct *tty, struct file *filp);
523
static inline int tty_port_users(struct tty_port *port)
Alan Cox's avatar
Alan Cox committed
524
525
526
527
{
	return port->count + port->blocked_open;
}

528
529
530
531
532
533
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);
534
extern void tty_ldisc_deinit(struct tty_struct *tty);
535
536
537
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);
538
539


Linus Torvalds's avatar
Linus Torvalds committed
540
/* n_tty.c */
Alan Cox's avatar
Alan Cox committed
541
extern struct tty_ldisc_ops tty_ldisc_N_TTY;
542
extern void n_tty_inherit_ops(struct tty_ldisc_ops *ops);
Linus Torvalds's avatar
Linus Torvalds committed
543

Miloslav Trmac's avatar
Miloslav Trmac committed
544
545
546
547
548
549
/* 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);
Al Viro's avatar
Al Viro committed
550
extern void tty_audit_tiocsti(struct tty_struct *tty, char ch);
Miloslav Trmac's avatar
Miloslav Trmac committed
551
extern void tty_audit_push(struct tty_struct *tty);
552
553
extern int tty_audit_push_task(struct task_struct *tsk,
			       uid_t loginuid, u32 sessionid);
Miloslav Trmac's avatar
Miloslav Trmac committed
554
555
556
557
558
#else
static inline void tty_audit_add_data(struct tty_struct *tty,
				      unsigned char *data, size_t size)
{
}
Al Viro's avatar
Al Viro committed
559
560
561
static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch)
{
}
Miloslav Trmac's avatar
Miloslav Trmac committed
562
563
564
565
566
567
568
569
570
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)
{
}
571
572
static inline int tty_audit_push_task(struct task_struct *tsk,
				      uid_t loginuid, u32 sessionid)
Miloslav Trmac's avatar
Miloslav Trmac committed
573
{
574
	return 0;
Miloslav Trmac's avatar
Miloslav Trmac committed
575
576
577
}
#endif

578
579
580
/* tty_io.c */
extern int __init tty_init(void);

Linus Torvalds's avatar
Linus Torvalds committed
581
/* tty_ioctl.c */
582
extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
Linus Torvalds's avatar
Linus Torvalds committed
583
584
585
586
587
		       unsigned int cmd, unsigned long arg);

/* serial.c */

extern void serial_console_init(void);
Alan Cox's avatar
Alan Cox committed
588

Linus Torvalds's avatar
Linus Torvalds committed
589
590
591
592
593
594
/* pcxx.c */

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

/* vt.c */

595
extern int vt_ioctl(struct tty_struct *tty,
Linus Torvalds's avatar
Linus Torvalds committed
596
597
		    unsigned int cmd, unsigned long arg);

598
extern long vt_compat_ioctl(struct tty_struct *tty,
599
600
		     unsigned int cmd, unsigned long arg);

601
/* tty_mutex.c */
602
/* functions for preparation of BKL removal */
603
604
605
606
extern void __lockfunc tty_lock(void) __acquires(tty_lock);
extern void __lockfunc tty_unlock(void) __releases(tty_lock);
extern struct task_struct *__big_tty_mutex_owner;
#define tty_locked()		(current == __big_tty_mutex_owner)
607

608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
/*
 * 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.
 */
#define wait_event_interruptible_tty(wq, condition)			\
({									\
	int __ret = 0;							\
	if (!(condition)) {						\
		__wait_event_interruptible_tty(wq, condition, __ret);	\
	}								\
	__ret;								\
})

#define __wait_event_interruptible_tty(wq, condition, ret)		\
do {									\
	DEFINE_WAIT(__wait);						\
									\
	for (;;) {							\
		prepare_to_wait(&wq, &__wait, TASK_INTERRUPTIBLE);	\
		if (condition)						\
			break;						\
		if (!signal_pending(current)) {				\
			tty_unlock();					\
			schedule();					\
			tty_lock();					\
			continue;					\
		}							\
		ret = -ERESTARTSYS;					\
		break;							\
	}								\
	finish_wait(&wq, &__wait);					\
} while (0)


Linus Torvalds's avatar
Linus Torvalds committed
650
651
#endif /* __KERNEL__ */
#endif