]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/tty.h
TTY: move ldisc data from tty_struct: read_* and echo_* and canon_* stuff
[mirror_ubuntu-bionic-kernel.git] / include / linux / tty.h
CommitLineData
1da177e4
LT
1#ifndef _LINUX_TTY_H
2#define _LINUX_TTY_H
3
ae92c1f5
FF
4#include <linux/fs.h>
5#include <linux/major.h>
6#include <linux/termios.h>
7#include <linux/workqueue.h>
8#include <linux/tty_driver.h>
9#include <linux/tty_ldisc.h>
10#include <linux/mutex.h>
ba3fe7ab 11#include <linux/tty_flags.h>
607ca46e 12#include <uapi/linux/tty.h>
ae92c1f5 13
ae92c1f5
FF
14
15
16/*
17 * (Note: the *_driver.minor_start values 1, 64, 128, 192 are
18 * hardcoded at present.)
19 */
20#define NR_UNIX98_PTY_DEFAULT 4096 /* Default maximum for Unix98 ptys */
e9aba515 21#define NR_UNIX98_PTY_RESERVE 1024 /* Default reserve for main devpts */
ae92c1f5
FF
22#define NR_UNIX98_PTY_MAX (1 << MINORBITS) /* Absolute limit */
23
1da177e4
LT
24/*
25 * This character is the same as _POSIX_VDISABLE: it cannot be used as
26 * a c_cc[] character, but indicates that a particular special character
27 * isn't in use (eg VINTR has no character etc)
28 */
29#define __DISABLED_CHAR '\0'
30
33f0f88f
AC
31struct tty_buffer {
32 struct tty_buffer *next;
33 char *char_buf_ptr;
34 unsigned char *flag_buf_ptr;
35 int used;
36 int size;
8977d929
PF
37 int commit;
38 int read;
33f0f88f
AC
39 /* Data points here */
40 unsigned long data[0];
41};
42
d9661adf
AC
43/*
44 * We default to dicing tty buffer allocations to this many characters
352fa6ad
MG
45 * in order to avoid multiple page allocations. We know the size of
46 * tty_buffer itself but it must also be taken into account that the
47 * the buffer is 256 byte aligned. See tty_buffer_find for the allocation
48 * logic this must match
d9661adf
AC
49 */
50
352fa6ad 51#define TTY_BUFFER_PAGE (((PAGE_SIZE - sizeof(struct tty_buffer)) / 2) & ~0xFF)
d9661adf
AC
52
53
33f0f88f 54struct tty_bufhead {
f23eb2b2 55 struct work_struct work;
808249ce 56 spinlock_t lock;
33f0f88f
AC
57 struct tty_buffer *head; /* Queue head */
58 struct tty_buffer *tail; /* Active buffer */
59 struct tty_buffer *free; /* Free queue head */
7a4d29f4
AC
60 int memory_used; /* Buffer space used excluding
61 free queue */
1da177e4 62};
1da177e4
LT
63/*
64 * When a break, frame error, or parity error happens, these codes are
65 * stuffed into the flags buffer.
66 */
67#define TTY_NORMAL 0
68#define TTY_BREAK 1
69#define TTY_FRAME 2
70#define TTY_PARITY 3
71#define TTY_OVERRUN 4
72
adc8d746
AC
73#define INTR_CHAR(tty) ((tty)->termios.c_cc[VINTR])
74#define QUIT_CHAR(tty) ((tty)->termios.c_cc[VQUIT])
75#define ERASE_CHAR(tty) ((tty)->termios.c_cc[VERASE])
76#define KILL_CHAR(tty) ((tty)->termios.c_cc[VKILL])
77#define EOF_CHAR(tty) ((tty)->termios.c_cc[VEOF])
78#define TIME_CHAR(tty) ((tty)->termios.c_cc[VTIME])
79#define MIN_CHAR(tty) ((tty)->termios.c_cc[VMIN])
80#define SWTC_CHAR(tty) ((tty)->termios.c_cc[VSWTC])
81#define START_CHAR(tty) ((tty)->termios.c_cc[VSTART])
82#define STOP_CHAR(tty) ((tty)->termios.c_cc[VSTOP])
83#define SUSP_CHAR(tty) ((tty)->termios.c_cc[VSUSP])
84#define EOL_CHAR(tty) ((tty)->termios.c_cc[VEOL])
85#define REPRINT_CHAR(tty) ((tty)->termios.c_cc[VREPRINT])
86#define DISCARD_CHAR(tty) ((tty)->termios.c_cc[VDISCARD])
87#define WERASE_CHAR(tty) ((tty)->termios.c_cc[VWERASE])
88#define LNEXT_CHAR(tty) ((tty)->termios.c_cc[VLNEXT])
89#define EOL2_CHAR(tty) ((tty)->termios.c_cc[VEOL2])
1da177e4 90
adc8d746
AC
91#define _I_FLAG(tty, f) ((tty)->termios.c_iflag & (f))
92#define _O_FLAG(tty, f) ((tty)->termios.c_oflag & (f))
93#define _C_FLAG(tty, f) ((tty)->termios.c_cflag & (f))
94#define _L_FLAG(tty, f) ((tty)->termios.c_lflag & (f))
7a4d29f4
AC
95
96#define I_IGNBRK(tty) _I_FLAG((tty), IGNBRK)
97#define I_BRKINT(tty) _I_FLAG((tty), BRKINT)
98#define I_IGNPAR(tty) _I_FLAG((tty), IGNPAR)
99#define I_PARMRK(tty) _I_FLAG((tty), PARMRK)
100#define I_INPCK(tty) _I_FLAG((tty), INPCK)
101#define I_ISTRIP(tty) _I_FLAG((tty), ISTRIP)
102#define I_INLCR(tty) _I_FLAG((tty), INLCR)
103#define I_IGNCR(tty) _I_FLAG((tty), IGNCR)
104#define I_ICRNL(tty) _I_FLAG((tty), ICRNL)
105#define I_IUCLC(tty) _I_FLAG((tty), IUCLC)
106#define I_IXON(tty) _I_FLAG((tty), IXON)
107#define I_IXANY(tty) _I_FLAG((tty), IXANY)
108#define I_IXOFF(tty) _I_FLAG((tty), IXOFF)
109#define I_IMAXBEL(tty) _I_FLAG((tty), IMAXBEL)
110#define I_IUTF8(tty) _I_FLAG((tty), IUTF8)
111
112#define O_OPOST(tty) _O_FLAG((tty), OPOST)
113#define O_OLCUC(tty) _O_FLAG((tty), OLCUC)
114#define O_ONLCR(tty) _O_FLAG((tty), ONLCR)
115#define O_OCRNL(tty) _O_FLAG((tty), OCRNL)
116#define O_ONOCR(tty) _O_FLAG((tty), ONOCR)
117#define O_ONLRET(tty) _O_FLAG((tty), ONLRET)
118#define O_OFILL(tty) _O_FLAG((tty), OFILL)
119#define O_OFDEL(tty) _O_FLAG((tty), OFDEL)
120#define O_NLDLY(tty) _O_FLAG((tty), NLDLY)
121#define O_CRDLY(tty) _O_FLAG((tty), CRDLY)
122#define O_TABDLY(tty) _O_FLAG((tty), TABDLY)
123#define O_BSDLY(tty) _O_FLAG((tty), BSDLY)
124#define O_VTDLY(tty) _O_FLAG((tty), VTDLY)
125#define O_FFDLY(tty) _O_FLAG((tty), FFDLY)
126
127#define C_BAUD(tty) _C_FLAG((tty), CBAUD)
128#define C_CSIZE(tty) _C_FLAG((tty), CSIZE)
129#define C_CSTOPB(tty) _C_FLAG((tty), CSTOPB)
130#define C_CREAD(tty) _C_FLAG((tty), CREAD)
131#define C_PARENB(tty) _C_FLAG((tty), PARENB)
132#define C_PARODD(tty) _C_FLAG((tty), PARODD)
133#define C_HUPCL(tty) _C_FLAG((tty), HUPCL)
134#define C_CLOCAL(tty) _C_FLAG((tty), CLOCAL)
135#define C_CIBAUD(tty) _C_FLAG((tty), CIBAUD)
136#define C_CRTSCTS(tty) _C_FLAG((tty), CRTSCTS)
137
138#define L_ISIG(tty) _L_FLAG((tty), ISIG)
139#define L_ICANON(tty) _L_FLAG((tty), ICANON)
140#define L_XCASE(tty) _L_FLAG((tty), XCASE)
141#define L_ECHO(tty) _L_FLAG((tty), ECHO)
142#define L_ECHOE(tty) _L_FLAG((tty), ECHOE)
143#define L_ECHOK(tty) _L_FLAG((tty), ECHOK)
144#define L_ECHONL(tty) _L_FLAG((tty), ECHONL)
145#define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH)
146#define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP)
147#define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL)
148#define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT)
149#define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE)
150#define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO)
151#define L_PENDIN(tty) _L_FLAG((tty), PENDIN)
152#define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN)
26df6d13 153#define L_EXTPROC(tty) _L_FLAG((tty), EXTPROC)
1da177e4
LT
154
155struct device;
522ed776 156struct signal_struct;
6f67048c
AC
157
158/*
159 * Port level information. Each device keeps its own port level information
160 * so provide a common structure for those ports wanting to use common support
161 * routines.
162 *
163 * The tty port has a different lifetime to the tty so must be kept apart.
164 * In addition be careful as tty -> port mappings are valid for the life
165 * of the tty object but in many cases port -> tty mappings are valid only
166 * until a hangup so don't use the wrong path.
167 */
7a4d29f4 168
31f35939
AC
169struct tty_port;
170
171struct tty_port_operations {
172 /* Return 1 if the carrier is raised */
173 int (*carrier_raised)(struct tty_port *port);
7ca0ff9a 174 /* Control the DTR line */
fcc8ac18 175 void (*dtr_rts)(struct tty_port *port, int raise);
7ca0ff9a 176 /* Called when the last close completes or a hangup finishes
64bc3979
AC
177 IFF the port was initialized. Do not use to free resources. Called
178 under the port mutex to serialize against activate/shutdowns */
7ca0ff9a
AC
179 void (*shutdown)(struct tty_port *port);
180 void (*drop)(struct tty_port *port);
64bc3979
AC
181 /* Called under the port mutex from tty_port_open, serialized using
182 the port mutex */
183 /* FIXME: long term getting the tty argument *out* of this would be
184 good for consoles */
185 int (*activate)(struct tty_port *port, struct tty_struct *tty);
568aafc6
AC
186 /* Called on the final put of a port */
187 void (*destruct)(struct tty_port *port);
31f35939
AC
188};
189
6f67048c
AC
190struct tty_port {
191 struct tty_struct *tty; /* Back pointer */
31f35939 192 const struct tty_port_operations *ops; /* Port operations */
4a90f09b 193 spinlock_t lock; /* Lock protecting tty field */
6f67048c
AC
194 int blocked_open; /* Waiting to open */
195 int count; /* Usage count */
196 wait_queue_head_t open_wait; /* Open waiters */
197 wait_queue_head_t close_wait; /* Close waiters */
bdc04e31 198 wait_queue_head_t delta_msr_wait; /* Modem status change */
6f67048c 199 unsigned long flags; /* TTY flags ASY_*/
336cee42 200 unsigned char console:1; /* port is a console */
6f67048c 201 struct mutex mutex; /* Locking */
44e4909e 202 struct mutex buf_mutex; /* Buffer alloc lock */
6f67048c 203 unsigned char *xmit_buf; /* Optional buffer */
5e99df56
AC
204 unsigned int close_delay; /* Close port delay */
205 unsigned int closing_wait; /* Delay for output */
1ec739be
AC
206 int drain_delay; /* Set to zero if no pure time
207 based drain is needed else
208 set to size of fifo */
568aafc6 209 struct kref kref; /* Ref counter */
6f67048c
AC
210};
211
1da177e4
LT
212/*
213 * Where all of the state associated with a tty is kept while the tty
214 * is open. Since the termios state should be kept even if the tty
215 * has been closed --- for things like the baud rate, etc --- it is
216 * not stored here, but rather a pointer to the real state is stored
217 * here. Possible the winsize structure should have the same
218 * treatment, but (1) the default 80x24 is usually right and (2) it's
219 * most often used by a windowing system, which will set the correct
220 * size each time the window is created or resized anyway.
221 * - TYT, 9/14/92
222 */
f34d7a5b
AC
223
224struct tty_operations;
225
1da177e4
LT
226struct tty_struct {
227 int magic;
9c9f4ded 228 struct kref kref;
30004ac9 229 struct device *dev;
1da177e4 230 struct tty_driver *driver;
f34d7a5b 231 const struct tty_operations *ops;
1da177e4 232 int index;
c65c9bc3
AC
233
234 /* Protects ldisc changes: Lock tty not pty */
235 struct mutex ldisc_mutex;
236 struct tty_ldisc *ldisc;
237
89c8d91e 238 struct mutex legacy_mutex;
5785c95b 239 struct mutex termios_mutex;
04f378b1 240 spinlock_t ctrl_lock;
47f86834 241 /* Termios values are protected by the termios mutex */
adc8d746 242 struct ktermios termios, termios_locked;
1d65b4a0 243 struct termiox *termiox; /* May be NULL for unsupported */
1da177e4 244 char name[64];
47f86834 245 struct pid *pgrp; /* Protected by ctrl lock */
ab521dc0 246 struct pid *session;
1da177e4
LT
247 unsigned long flags;
248 int count;
47f86834 249 struct winsize winsize; /* termios mutex */
1da177e4
LT
250 unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
251 unsigned char low_latency:1, warned:1;
47f86834 252 unsigned char ctrl_status; /* ctrl_lock */
33f0f88f 253 unsigned int receive_room; /* Bytes free for queue */
1da177e4
LT
254
255 struct tty_struct *link;
256 struct fasync_struct *fasync;
47f86834 257 struct tty_bufhead buf; /* Locked internally */
1da177e4
LT
258 int alt_speed; /* For magic substitution of 38400 bps */
259 wait_queue_head_t write_wait;
260 wait_queue_head_t read_wait;
261 struct work_struct hangup_work;
262 void *disc_data;
263 void *driver_data;
264 struct list_head tty_files;
265
266#define N_TTY_BUF_SIZE 4096
6f67048c 267
1da177e4
LT
268 /*
269 * The following is data for the N_TTY line discipline. For
270 * historical reasons, this is included in the tty structure.
47f86834 271 * Mostly locked by the BKL.
1da177e4 272 */
1da177e4
LT
273 unsigned char closing:1;
274 unsigned short minimum_to_wake;
70522e12
IM
275 struct mutex atomic_read_lock;
276 struct mutex atomic_write_lock;
a88a69c9
JP
277 struct mutex output_lock;
278 struct mutex echo_lock;
1da177e4
LT
279 unsigned char *write_buf;
280 int write_cnt;
281 spinlock_t read_lock;
282 /* If the tty has a pending do_SAK, queue it here - akpm */
283 struct work_struct SAK_work;
6f67048c 284 struct tty_port *port;
1da177e4
LT
285};
286
d996b62a
NP
287/* Each of a tty's open files has private_data pointing to tty_file_private */
288struct tty_file_private {
289 struct tty_struct *tty;
290 struct file *file;
291 struct list_head list;
292};
293
1da177e4
LT
294/* tty magic number */
295#define TTY_MAGIC 0x5401
296
297/*
298 * These bits are used in the flags field of the tty structure.
7a4d29f4 299 *
1da177e4
LT
300 * So that interrupts won't be able to mess up the queues,
301 * copy_to_cooked must be atomic with respect to itself, as must
302 * tty->write. Thus, you must use the inline functions set_bit() and
303 * clear_bit() to make things atomic.
304 */
305#define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
7a4d29f4 306#define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */
1da177e4
LT
307#define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
308#define TTY_EXCLUSIVE 3 /* Exclusive open mode */
309#define TTY_DEBUG 4 /* Debugging */
310#define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
311#define TTY_PUSH 6 /* n_tty private */
312#define TTY_CLOSING 7 /* ->close() in progress */
1da177e4 313#define TTY_LDISC 9 /* Line discipline attached */
c9b3976e 314#define TTY_LDISC_CHANGING 10 /* Line discipline changing */
c65c9bc3 315#define TTY_LDISC_OPEN 11 /* Line discipline is open */
1da177e4
LT
316#define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */
317#define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */
318#define TTY_PTY_LOCK 16 /* pty private */
319#define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
320#define TTY_HUPPED 18 /* Post driver->hangup() */
42fd552e
AC
321#define TTY_FLUSHING 19 /* Flushing to ldisc in progress */
322#define TTY_FLUSHPENDING 20 /* Queued buffer flush pending */
acfa747b 323#define TTY_HUPPING 21 /* ->hangup() in progress */
1da177e4
LT
324
325#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
326
327extern void tty_write_flush(struct tty_struct *);
328
edc6afc5 329extern struct ktermios tty_std_termios;
1da177e4 330
1da177e4
LT
331extern void console_init(void);
332extern int vcs_init(void);
333
d81ed103
AC
334extern struct class *tty_class;
335
9c9f4ded
AC
336/**
337 * tty_kref_get - get a tty reference
338 * @tty: tty device
339 *
340 * Return a new reference to a tty object. The caller must hold
341 * sufficient locks/counts to ensure that their existing reference cannot
342 * go away
343 */
344
14bfc987 345static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
9c9f4ded
AC
346{
347 if (tty)
348 kref_get(&tty->kref);
349 return tty;
350}
351extern void tty_kref_put(struct tty_struct *tty);
352
1da177e4
LT
353extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
354 const char *routine);
355extern char *tty_name(struct tty_struct *tty, char *buf);
7a4d29f4
AC
356extern void tty_wait_until_sent(struct tty_struct *tty, long timeout);
357extern int tty_check_change(struct tty_struct *tty);
358extern void stop_tty(struct tty_struct *tty);
359extern void start_tty(struct tty_struct *tty);
1da177e4
LT
360extern int tty_register_driver(struct tty_driver *driver);
361extern int tty_unregister_driver(struct tty_driver *driver);
01107d34
GKH
362extern struct device *tty_register_device(struct tty_driver *driver,
363 unsigned index, struct device *dev);
6915c0e4
TH
364extern struct device *tty_register_device_attr(struct tty_driver *driver,
365 unsigned index, struct device *device,
366 void *drvdata,
367 const struct attribute_group **attr_grp);
1da177e4
LT
368extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
369extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
370 int buflen);
371extern void tty_write_message(struct tty_struct *tty, char *msg);
f34d7a5b
AC
372extern int tty_put_char(struct tty_struct *tty, unsigned char c);
373extern int tty_chars_in_buffer(struct tty_struct *tty);
374extern int tty_write_room(struct tty_struct *tty);
375extern void tty_driver_flush_buffer(struct tty_struct *tty);
39c2e60f
AC
376extern void tty_throttle(struct tty_struct *tty);
377extern void tty_unthrottle(struct tty_struct *tty);
fc6f6238 378extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
24d406a6
JS
379extern void tty_driver_remove_tty(struct tty_driver *driver,
380 struct tty_struct *tty);
feebed65 381extern void tty_free_termios(struct tty_struct *tty);
3e7cd6c4 382extern int is_current_pgrp_orphaned(void);
5d0fdf1e 383extern struct pid *tty_get_pgrp(struct tty_struct *tty);
1da177e4
LT
384extern int is_ignored(int sig);
385extern int tty_signal(int sig, struct tty_struct *tty);
7a4d29f4
AC
386extern void tty_hangup(struct tty_struct *tty);
387extern void tty_vhangup(struct tty_struct *tty);
ddcd9fb6 388extern void tty_vhangup_locked(struct tty_struct *tty);
2cb5998b 389extern void tty_vhangup_self(void);
1da177e4 390extern void tty_unhangup(struct file *filp);
7a4d29f4 391extern int tty_hung_up_p(struct file *filp);
1da177e4 392extern void do_SAK(struct tty_struct *tty);
8b6312f4 393extern void __do_SAK(struct tty_struct *tty);
1da177e4 394extern void disassociate_ctty(int priv);
98a27ba4 395extern void no_tty(void);
1da177e4 396extern void tty_flip_buffer_push(struct tty_struct *tty);
e043e42b 397extern void tty_flush_to_ldisc(struct tty_struct *tty);
e0495736
AC
398extern void tty_buffer_free_all(struct tty_struct *tty);
399extern void tty_buffer_flush(struct tty_struct *tty);
400extern void tty_buffer_init(struct tty_struct *tty);
edc6afc5
AC
401extern speed_t tty_get_baud_rate(struct tty_struct *tty);
402extern speed_t tty_termios_baud_rate(struct ktermios *termios);
403extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
7a4d29f4
AC
404extern void tty_termios_encode_baud_rate(struct ktermios *termios,
405 speed_t ibaud, speed_t obaud);
406extern void tty_encode_baud_rate(struct tty_struct *tty,
407 speed_t ibaud, speed_t obaud);
5f519d72 408extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
bf5e5834 409extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
8d075b19 410extern int tty_set_termios(struct tty_struct *tty, struct ktermios *kt);
1da177e4
LT
411
412extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
413extern void tty_ldisc_deref(struct tty_ldisc *);
414extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
c65c9bc3 415extern void tty_ldisc_hangup(struct tty_struct *tty);
a352def2 416extern const struct file_operations tty_ldiscs_proc_fops;
1da177e4
LT
417
418extern void tty_wakeup(struct tty_struct *tty);
419extern void tty_ldisc_flush(struct tty_struct *tty);
420
04f378b1 421extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
0fc00e24
AC
422extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
423 unsigned int cmd, unsigned long arg);
424extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
24ec839c
PZ
425extern dev_t tty_devnum(struct tty_struct *tty);
426extern void proc_clear_tty(struct task_struct *p);
24ec839c 427extern struct tty_struct *get_current_tty(void);
d81ed103 428extern void tty_default_fops(struct file_operations *fops);
bf970ee4 429extern struct tty_struct *alloc_tty_struct(void);
fa90e1c9
JS
430extern int tty_alloc_file(struct file *file);
431extern void tty_add_file(struct tty_struct *tty, struct file *file);
432extern void tty_free_file(struct file *file);
bf970ee4
AC
433extern void free_tty_struct(struct tty_struct *tty);
434extern void initialize_tty_struct(struct tty_struct *tty,
435 struct tty_driver *driver, int idx);
6716671d 436extern void deinitialize_tty_struct(struct tty_struct *tty);
593a27c4 437extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx);
eeb89d91 438extern int tty_release(struct inode *inode, struct file *filp);
bf970ee4 439extern int tty_init_termios(struct tty_struct *tty);
66d450e8
JS
440extern int tty_standard_install(struct tty_driver *driver,
441 struct tty_struct *tty);
24ec839c 442
e8b70e7d
AC
443extern struct tty_struct *tty_pair_get_tty(struct tty_struct *tty);
444extern struct tty_struct *tty_pair_get_pty(struct tty_struct *tty);
445
70522e12 446extern struct mutex tty_mutex;
ee2ffa0d 447extern spinlock_t tty_files_lock;
1da177e4 448
9c1729db
AC
449extern void tty_write_unlock(struct tty_struct *tty);
450extern int tty_write_lock(struct tty_struct *tty, int ndelay);
451#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
452
6f67048c 453extern void tty_port_init(struct tty_port *port);
2cb4ca02
JS
454extern void tty_port_link_device(struct tty_port *port,
455 struct tty_driver *driver, unsigned index);
057eb856
JS
456extern struct device *tty_port_register_device(struct tty_port *port,
457 struct tty_driver *driver, unsigned index,
458 struct device *device);
b1b79916
TH
459extern struct device *tty_port_register_device_attr(struct tty_port *port,
460 struct tty_driver *driver, unsigned index,
461 struct device *device, void *drvdata,
462 const struct attribute_group **attr_grp);
6f67048c
AC
463extern int tty_port_alloc_xmit_buf(struct tty_port *port);
464extern void tty_port_free_xmit_buf(struct tty_port *port);
568aafc6
AC
465extern void tty_port_put(struct tty_port *port);
466
2427b8e3 467static inline struct tty_port *tty_port_get(struct tty_port *port)
568aafc6
AC
468{
469 if (port)
470 kref_get(&port->kref);
471 return port;
472}
473
f21ec3d2
HS
474/* If the cts flow control is enabled, return true. */
475static inline bool tty_port_cts_enabled(struct tty_port *port)
476{
477 return port->flags & ASYNC_CTS_FLOW;
478}
479
4a90f09b
AC
480extern struct tty_struct *tty_port_tty_get(struct tty_port *port);
481extern void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty);
31f35939 482extern int tty_port_carrier_raised(struct tty_port *port);
5d951fb4 483extern void tty_port_raise_dtr_rts(struct tty_port *port);
fcc8ac18 484extern void tty_port_lower_dtr_rts(struct tty_port *port);
3e61696b 485extern void tty_port_hangup(struct tty_port *port);
36c621d8
AC
486extern int tty_port_block_til_ready(struct tty_port *port,
487 struct tty_struct *tty, struct file *filp);
a6614999
AC
488extern int tty_port_close_start(struct tty_port *port,
489 struct tty_struct *tty, struct file *filp);
490extern void tty_port_close_end(struct tty_port *port, struct tty_struct *tty);
7ca0ff9a
AC
491extern void tty_port_close(struct tty_port *port,
492 struct tty_struct *tty, struct file *filp);
695586ca
JS
493extern int tty_port_install(struct tty_port *port, struct tty_driver *driver,
494 struct tty_struct *tty);
64bc3979
AC
495extern int tty_port_open(struct tty_port *port,
496 struct tty_struct *tty, struct file *filp);
2427b8e3 497static inline int tty_port_users(struct tty_port *port)
b58d13a0
AC
498{
499 return port->count + port->blocked_open;
500}
501
01e1abb2
AC
502extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
503extern int tty_unregister_ldisc(int disc);
504extern int tty_set_ldisc(struct tty_struct *tty, int ldisc);
505extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty);
506extern void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty);
507extern void tty_ldisc_init(struct tty_struct *tty);
6716671d 508extern void tty_ldisc_deinit(struct tty_struct *tty);
01e1abb2
AC
509extern void tty_ldisc_begin(void);
510/* This last one is just for the tty layer internals and shouldn't be used elsewhere */
511extern void tty_ldisc_enable(struct tty_struct *tty);
9c1729db
AC
512
513
1da177e4 514/* n_tty.c */
a352def2 515extern struct tty_ldisc_ops tty_ldisc_N_TTY;
572b9adb 516extern void n_tty_inherit_ops(struct tty_ldisc_ops *ops);
1da177e4 517
522ed776
MT
518/* tty_audit.c */
519#ifdef CONFIG_AUDIT
520extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data,
6c633f27 521 size_t size, unsigned icanon);
522ed776
MT
522extern void tty_audit_exit(void);
523extern void tty_audit_fork(struct signal_struct *sig);
1e641743 524extern void tty_audit_tiocsti(struct tty_struct *tty, char ch);
522ed776 525extern void tty_audit_push(struct tty_struct *tty);
3c80fe4a 526extern int tty_audit_push_task(struct task_struct *tsk,
e1760bd5 527 kuid_t loginuid, u32 sessionid);
522ed776
MT
528#else
529static inline void tty_audit_add_data(struct tty_struct *tty,
6c633f27 530 unsigned char *data, size_t size, unsigned icanon)
522ed776
MT
531{
532}
1e641743
AV
533static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch)
534{
535}
522ed776
MT
536static inline void tty_audit_exit(void)
537{
538}
539static inline void tty_audit_fork(struct signal_struct *sig)
540{
541}
542static inline void tty_audit_push(struct tty_struct *tty)
543{
544}
3c80fe4a 545static inline int tty_audit_push_task(struct task_struct *tsk,
e1760bd5 546 kuid_t loginuid, u32 sessionid)
522ed776 547{
3c80fe4a 548 return 0;
522ed776 549}
522ed776
MT
550#endif
551
31d1d48e
DH
552/* tty_io.c */
553extern int __init tty_init(void);
554
1da177e4 555/* tty_ioctl.c */
47afa7a5 556extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
1da177e4 557 unsigned int cmd, unsigned long arg);
8193c429
TM
558extern long n_tty_compat_ioctl_helper(struct tty_struct *tty, struct file *file,
559 unsigned int cmd, unsigned long arg);
1da177e4
LT
560
561/* serial.c */
562
563extern void serial_console_init(void);
7a4d29f4 564
1da177e4
LT
565/* pcxx.c */
566
567extern int pcxe_open(struct tty_struct *tty, struct file *filp);
568
1da177e4
LT
569/* vt.c */
570
6caa76b7 571extern int vt_ioctl(struct tty_struct *tty,
1da177e4
LT
572 unsigned int cmd, unsigned long arg);
573
94c2273d 574extern long vt_compat_ioctl(struct tty_struct *tty,
e9216651
AB
575 unsigned int cmd, unsigned long arg);
576
b07471fa 577/* tty_mutex.c */
ec79d605 578/* functions for preparation of BKL removal */
89c8d91e
AC
579extern void __lockfunc tty_lock(struct tty_struct *tty);
580extern void __lockfunc tty_unlock(struct tty_struct *tty);
581extern void __lockfunc tty_lock_pair(struct tty_struct *tty,
582 struct tty_struct *tty2);
583extern void __lockfunc tty_unlock_pair(struct tty_struct *tty,
584 struct tty_struct *tty2);
ec79d605 585
a57a7bf3
JS
586/*
587 * this shall be called only from where BTM is held (like close)
588 *
589 * We need this to ensure nobody waits for us to finish while we are waiting.
590 * Without this we were encountering system stalls.
591 *
592 * This should be indeed removed with BTM removal later.
593 *
594 * Locking: BTM required. Nobody is allowed to hold port->mutex.
595 */
596static inline void tty_wait_until_sent_from_close(struct tty_struct *tty,
597 long timeout)
598{
89c8d91e 599 tty_unlock(tty); /* tty->ops->close holds the BTM, drop it while waiting */
a57a7bf3 600 tty_wait_until_sent(tty, timeout);
89c8d91e 601 tty_lock(tty);
a57a7bf3 602}
ec79d605 603
be1bc288
AB
604/*
605 * wait_event_interruptible_tty -- wait for a condition with the tty lock held
606 *
607 * The condition we are waiting for might take a long time to
608 * become true, or might depend on another thread taking the
609 * BTM. In either case, we need to drop the BTM to guarantee
610 * forward progress. This is a leftover from the conversion
611 * from the BKL and should eventually get removed as the BTM
612 * falls out of use.
613 *
614 * Do not use in new code.
615 */
89c8d91e 616#define wait_event_interruptible_tty(tty, wq, condition) \
be1bc288
AB
617({ \
618 int __ret = 0; \
619 if (!(condition)) { \
89c8d91e 620 __wait_event_interruptible_tty(tty, wq, condition, __ret); \
be1bc288
AB
621 } \
622 __ret; \
623})
624
89c8d91e 625#define __wait_event_interruptible_tty(tty, wq, condition, ret) \
be1bc288
AB
626do { \
627 DEFINE_WAIT(__wait); \
628 \
629 for (;;) { \
630 prepare_to_wait(&wq, &__wait, TASK_INTERRUPTIBLE); \
631 if (condition) \
632 break; \
633 if (!signal_pending(current)) { \
89c8d91e 634 tty_unlock(tty); \
be1bc288 635 schedule(); \
89c8d91e 636 tty_lock(tty); \
be1bc288
AB
637 continue; \
638 } \
639 ret = -ERESTARTSYS; \
640 break; \
641 } \
642 finish_wait(&wq, &__wait); \
643} while (0)
644
645
1da177e4 646#endif