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