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