]>
Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 LT |
2 | #ifndef _LINUX_TTY_H |
3 | #define _LINUX_TTY_H | |
4 | ||
ae92c1f5 FF |
5 | #include <linux/fs.h> |
6 | #include <linux/major.h> | |
7 | #include <linux/termios.h> | |
8 | #include <linux/workqueue.h> | |
9 | #include <linux/tty_driver.h> | |
10 | #include <linux/tty_ldisc.h> | |
11 | #include <linux/mutex.h> | |
ba3fe7ab | 12 | #include <linux/tty_flags.h> |
fddda2b7 | 13 | #include <linux/seq_file.h> |
607ca46e | 14 | #include <uapi/linux/tty.h> |
6a1c0680 | 15 | #include <linux/rwsem.h> |
809850b7 | 16 | #include <linux/llist.h> |
ae92c1f5 | 17 | |
ae92c1f5 | 18 | |
ae92c1f5 FF |
19 | /* |
20 | * (Note: the *_driver.minor_start values 1, 64, 128, 192 are | |
21 | * hardcoded at present.) | |
22 | */ | |
23 | #define NR_UNIX98_PTY_DEFAULT 4096 /* Default maximum for Unix98 ptys */ | |
e9aba515 | 24 | #define NR_UNIX98_PTY_RESERVE 1024 /* Default reserve for main devpts */ |
ae92c1f5 FF |
25 | #define NR_UNIX98_PTY_MAX (1 << MINORBITS) /* Absolute limit */ |
26 | ||
1da177e4 LT |
27 | /* |
28 | * This character is the same as _POSIX_VDISABLE: it cannot be used as | |
29 | * a c_cc[] character, but indicates that a particular special character | |
30 | * isn't in use (eg VINTR has no character etc) | |
31 | */ | |
32 | #define __DISABLED_CHAR '\0' | |
33 | ||
33f0f88f | 34 | struct tty_buffer { |
809850b7 PH |
35 | union { |
36 | struct tty_buffer *next; | |
37 | struct llist_node free; | |
38 | }; | |
33f0f88f AC |
39 | int used; |
40 | int size; | |
8977d929 PF |
41 | int commit; |
42 | int read; | |
acc0f67f | 43 | int flags; |
33f0f88f | 44 | /* Data points here */ |
9d82973e | 45 | unsigned long data[]; |
33f0f88f AC |
46 | }; |
47 | ||
acc0f67f PH |
48 | /* Values for .flags field of tty_buffer */ |
49 | #define TTYB_NORMAL 1 /* buffer has no flags buffer */ | |
50 | ||
1fc359fc PH |
51 | static inline unsigned char *char_buf_ptr(struct tty_buffer *b, int ofs) |
52 | { | |
53 | return ((unsigned char *)b->data) + ofs; | |
54 | } | |
55 | ||
56 | static inline char *flag_buf_ptr(struct tty_buffer *b, int ofs) | |
57 | { | |
58 | return (char *)char_buf_ptr(b, ofs) + b->size; | |
59 | } | |
60 | ||
33f0f88f | 61 | struct tty_bufhead { |
8c1fb49b | 62 | struct tty_buffer *head; /* Queue head */ |
f23eb2b2 | 63 | struct work_struct work; |
a7c8d58c PH |
64 | struct mutex lock; |
65 | atomic_t priority; | |
7391ee16 | 66 | struct tty_buffer sentinel; |
809850b7 | 67 | struct llist_head free; /* Free queue head */ |
5dda4ca5 | 68 | atomic_t mem_used; /* In-use buffers excluding free list */ |
4d18e6ef | 69 | int mem_limit; |
8c1fb49b | 70 | struct tty_buffer *tail; /* Active buffer */ |
1da177e4 | 71 | }; |
1da177e4 LT |
72 | /* |
73 | * When a break, frame error, or parity error happens, these codes are | |
74 | * stuffed into the flags buffer. | |
75 | */ | |
76 | #define TTY_NORMAL 0 | |
77 | #define TTY_BREAK 1 | |
78 | #define TTY_FRAME 2 | |
79 | #define TTY_PARITY 3 | |
80 | #define TTY_OVERRUN 4 | |
81 | ||
adc8d746 AC |
82 | #define INTR_CHAR(tty) ((tty)->termios.c_cc[VINTR]) |
83 | #define QUIT_CHAR(tty) ((tty)->termios.c_cc[VQUIT]) | |
84 | #define ERASE_CHAR(tty) ((tty)->termios.c_cc[VERASE]) | |
85 | #define KILL_CHAR(tty) ((tty)->termios.c_cc[VKILL]) | |
86 | #define EOF_CHAR(tty) ((tty)->termios.c_cc[VEOF]) | |
87 | #define TIME_CHAR(tty) ((tty)->termios.c_cc[VTIME]) | |
88 | #define MIN_CHAR(tty) ((tty)->termios.c_cc[VMIN]) | |
89 | #define SWTC_CHAR(tty) ((tty)->termios.c_cc[VSWTC]) | |
90 | #define START_CHAR(tty) ((tty)->termios.c_cc[VSTART]) | |
91 | #define STOP_CHAR(tty) ((tty)->termios.c_cc[VSTOP]) | |
92 | #define SUSP_CHAR(tty) ((tty)->termios.c_cc[VSUSP]) | |
93 | #define EOL_CHAR(tty) ((tty)->termios.c_cc[VEOL]) | |
94 | #define REPRINT_CHAR(tty) ((tty)->termios.c_cc[VREPRINT]) | |
95 | #define DISCARD_CHAR(tty) ((tty)->termios.c_cc[VDISCARD]) | |
96 | #define WERASE_CHAR(tty) ((tty)->termios.c_cc[VWERASE]) | |
97 | #define LNEXT_CHAR(tty) ((tty)->termios.c_cc[VLNEXT]) | |
98 | #define EOL2_CHAR(tty) ((tty)->termios.c_cc[VEOL2]) | |
1da177e4 | 99 | |
adc8d746 AC |
100 | #define _I_FLAG(tty, f) ((tty)->termios.c_iflag & (f)) |
101 | #define _O_FLAG(tty, f) ((tty)->termios.c_oflag & (f)) | |
102 | #define _C_FLAG(tty, f) ((tty)->termios.c_cflag & (f)) | |
103 | #define _L_FLAG(tty, f) ((tty)->termios.c_lflag & (f)) | |
7a4d29f4 AC |
104 | |
105 | #define I_IGNBRK(tty) _I_FLAG((tty), IGNBRK) | |
106 | #define I_BRKINT(tty) _I_FLAG((tty), BRKINT) | |
107 | #define I_IGNPAR(tty) _I_FLAG((tty), IGNPAR) | |
108 | #define I_PARMRK(tty) _I_FLAG((tty), PARMRK) | |
109 | #define I_INPCK(tty) _I_FLAG((tty), INPCK) | |
110 | #define I_ISTRIP(tty) _I_FLAG((tty), ISTRIP) | |
111 | #define I_INLCR(tty) _I_FLAG((tty), INLCR) | |
112 | #define I_IGNCR(tty) _I_FLAG((tty), IGNCR) | |
113 | #define I_ICRNL(tty) _I_FLAG((tty), ICRNL) | |
114 | #define I_IUCLC(tty) _I_FLAG((tty), IUCLC) | |
115 | #define I_IXON(tty) _I_FLAG((tty), IXON) | |
116 | #define I_IXANY(tty) _I_FLAG((tty), IXANY) | |
117 | #define I_IXOFF(tty) _I_FLAG((tty), IXOFF) | |
118 | #define I_IMAXBEL(tty) _I_FLAG((tty), IMAXBEL) | |
119 | #define I_IUTF8(tty) _I_FLAG((tty), IUTF8) | |
120 | ||
121 | #define O_OPOST(tty) _O_FLAG((tty), OPOST) | |
122 | #define O_OLCUC(tty) _O_FLAG((tty), OLCUC) | |
123 | #define O_ONLCR(tty) _O_FLAG((tty), ONLCR) | |
124 | #define O_OCRNL(tty) _O_FLAG((tty), OCRNL) | |
125 | #define O_ONOCR(tty) _O_FLAG((tty), ONOCR) | |
126 | #define O_ONLRET(tty) _O_FLAG((tty), ONLRET) | |
127 | #define O_OFILL(tty) _O_FLAG((tty), OFILL) | |
128 | #define O_OFDEL(tty) _O_FLAG((tty), OFDEL) | |
129 | #define O_NLDLY(tty) _O_FLAG((tty), NLDLY) | |
130 | #define O_CRDLY(tty) _O_FLAG((tty), CRDLY) | |
131 | #define O_TABDLY(tty) _O_FLAG((tty), TABDLY) | |
132 | #define O_BSDLY(tty) _O_FLAG((tty), BSDLY) | |
133 | #define O_VTDLY(tty) _O_FLAG((tty), VTDLY) | |
134 | #define O_FFDLY(tty) _O_FLAG((tty), FFDLY) | |
135 | ||
136 | #define C_BAUD(tty) _C_FLAG((tty), CBAUD) | |
137 | #define C_CSIZE(tty) _C_FLAG((tty), CSIZE) | |
138 | #define C_CSTOPB(tty) _C_FLAG((tty), CSTOPB) | |
139 | #define C_CREAD(tty) _C_FLAG((tty), CREAD) | |
140 | #define C_PARENB(tty) _C_FLAG((tty), PARENB) | |
141 | #define C_PARODD(tty) _C_FLAG((tty), PARODD) | |
142 | #define C_HUPCL(tty) _C_FLAG((tty), HUPCL) | |
143 | #define C_CLOCAL(tty) _C_FLAG((tty), CLOCAL) | |
144 | #define C_CIBAUD(tty) _C_FLAG((tty), CIBAUD) | |
145 | #define C_CRTSCTS(tty) _C_FLAG((tty), CRTSCTS) | |
e58b57a3 | 146 | #define C_CMSPAR(tty) _C_FLAG((tty), CMSPAR) |
7a4d29f4 AC |
147 | |
148 | #define L_ISIG(tty) _L_FLAG((tty), ISIG) | |
149 | #define L_ICANON(tty) _L_FLAG((tty), ICANON) | |
150 | #define L_XCASE(tty) _L_FLAG((tty), XCASE) | |
151 | #define L_ECHO(tty) _L_FLAG((tty), ECHO) | |
152 | #define L_ECHOE(tty) _L_FLAG((tty), ECHOE) | |
153 | #define L_ECHOK(tty) _L_FLAG((tty), ECHOK) | |
154 | #define L_ECHONL(tty) _L_FLAG((tty), ECHONL) | |
155 | #define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH) | |
156 | #define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP) | |
157 | #define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL) | |
158 | #define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT) | |
159 | #define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE) | |
160 | #define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO) | |
161 | #define L_PENDIN(tty) _L_FLAG((tty), PENDIN) | |
162 | #define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN) | |
26df6d13 | 163 | #define L_EXTPROC(tty) _L_FLAG((tty), EXTPROC) |
1da177e4 LT |
164 | |
165 | struct device; | |
522ed776 | 166 | struct signal_struct; |
6f67048c AC |
167 | |
168 | /* | |
169 | * Port level information. Each device keeps its own port level information | |
170 | * so provide a common structure for those ports wanting to use common support | |
171 | * routines. | |
172 | * | |
173 | * The tty port has a different lifetime to the tty so must be kept apart. | |
174 | * In addition be careful as tty -> port mappings are valid for the life | |
175 | * of the tty object but in many cases port -> tty mappings are valid only | |
176 | * until a hangup so don't use the wrong path. | |
177 | */ | |
7a4d29f4 | 178 | |
31f35939 AC |
179 | struct tty_port; |
180 | ||
181 | struct tty_port_operations { | |
182 | /* Return 1 if the carrier is raised */ | |
183 | int (*carrier_raised)(struct tty_port *port); | |
7ca0ff9a | 184 | /* Control the DTR line */ |
fcc8ac18 | 185 | void (*dtr_rts)(struct tty_port *port, int raise); |
7ca0ff9a | 186 | /* Called when the last close completes or a hangup finishes |
64bc3979 AC |
187 | IFF the port was initialized. Do not use to free resources. Called |
188 | under the port mutex to serialize against activate/shutdowns */ | |
7ca0ff9a | 189 | void (*shutdown)(struct tty_port *port); |
64bc3979 AC |
190 | /* Called under the port mutex from tty_port_open, serialized using |
191 | the port mutex */ | |
192 | /* FIXME: long term getting the tty argument *out* of this would be | |
193 | good for consoles */ | |
194 | int (*activate)(struct tty_port *port, struct tty_struct *tty); | |
568aafc6 AC |
195 | /* Called on the final put of a port */ |
196 | void (*destruct)(struct tty_port *port); | |
31f35939 | 197 | }; |
c3485ee0 RH |
198 | |
199 | struct tty_port_client_operations { | |
200 | int (*receive_buf)(struct tty_port *port, const unsigned char *, const unsigned char *, size_t); | |
201 | void (*write_wakeup)(struct tty_port *port); | |
202 | }; | |
203 | ||
0c5aae59 JH |
204 | extern const struct tty_port_client_operations tty_port_default_client_ops; |
205 | ||
6f67048c | 206 | struct tty_port { |
ecbbfd44 | 207 | struct tty_bufhead buf; /* Locked internally */ |
6f67048c | 208 | struct tty_struct *tty; /* Back pointer */ |
967fab69 | 209 | struct tty_struct *itty; /* internal back ptr */ |
31f35939 | 210 | const struct tty_port_operations *ops; /* Port operations */ |
c3485ee0 | 211 | const struct tty_port_client_operations *client_ops; /* Port client operations */ |
4a90f09b | 212 | spinlock_t lock; /* Lock protecting tty field */ |
6f67048c AC |
213 | int blocked_open; /* Waiting to open */ |
214 | int count; /* Usage count */ | |
215 | wait_queue_head_t open_wait; /* Open waiters */ | |
bdc04e31 | 216 | wait_queue_head_t delta_msr_wait; /* Modem status change */ |
e4d38f33 PH |
217 | unsigned long flags; /* User TTY flags ASYNC_ */ |
218 | unsigned long iflags; /* Internal flags TTY_PORT_ */ | |
0bc1bd09 | 219 | unsigned char console:1; /* port is a console */ |
6f67048c | 220 | struct mutex mutex; /* Locking */ |
44e4909e | 221 | struct mutex buf_mutex; /* Buffer alloc lock */ |
6f67048c | 222 | unsigned char *xmit_buf; /* Optional buffer */ |
5e99df56 AC |
223 | unsigned int close_delay; /* Close port delay */ |
224 | unsigned int closing_wait; /* Delay for output */ | |
1ec739be AC |
225 | int drain_delay; /* Set to zero if no pure time |
226 | based drain is needed else | |
227 | set to size of fifo */ | |
568aafc6 | 228 | struct kref kref; /* Ref counter */ |
c3485ee0 | 229 | void *client_data; |
6f67048c AC |
230 | }; |
231 | ||
e4d38f33 PH |
232 | /* tty_port::iflags bits -- use atomic bit ops */ |
233 | #define TTY_PORT_INITIALIZED 0 /* device is initialized */ | |
234 | #define TTY_PORT_SUSPENDED 1 /* device is suspended */ | |
235 | #define TTY_PORT_ACTIVE 2 /* device is open */ | |
236 | ||
237 | /* | |
238 | * uart drivers: use the uart_port::status field and the UPSTAT_* defines | |
239 | * for s/w-based flow control steering and carrier detection status | |
240 | */ | |
241 | #define TTY_PORT_CTS_FLOW 3 /* h/w flow control enabled */ | |
242 | #define TTY_PORT_CHECK_CD 4 /* carrier detect enabled */ | |
a09ac397 OK |
243 | #define TTY_PORT_KOPENED 5 /* device exclusively opened by |
244 | kernel */ | |
e4d38f33 | 245 | |
f34d7a5b AC |
246 | struct tty_operations; |
247 | ||
6e94dbc7 JS |
248 | /** |
249 | * struct tty_struct - state associated with a tty while open | |
250 | * | |
251 | * @flow.lock: lock for flow members | |
252 | * @flow.stopped: tty stopped/started by tty_stop/tty_start | |
253 | * @flow.tco_stopped: tty stopped/started by TCOOFF/TCOON ioctls (it has | |
254 | * precedense over @flow.stopped) | |
255 | * @flow.unused: alignment for Alpha, so that no members other than @flow.* are | |
256 | * modified by the same 64b word store. The @flow's __aligned is | |
257 | * there for the very same reason. | |
64d608db JS |
258 | * @ctrl.lock: lock for ctrl members |
259 | * @ctrl.pgrp: process group of this tty (setpgrp(2)) | |
260 | * @ctrl.session: session of this tty (setsid(2)). Writes are protected by both | |
261 | * @ctrl.lock and legacy mutex, readers must use at least one of | |
262 | * them. | |
263 | * @ctrl.pktstatus: packet mode status (bitwise OR of TIOCPKT_* constants) | |
264 | * @ctrl.packet: packet mode enabled | |
6e94dbc7 JS |
265 | * |
266 | * All of the state associated with a tty while the tty is open. Persistent | |
267 | * storage for tty devices is referenced here as @port in struct tty_port. | |
268 | */ | |
1da177e4 LT |
269 | struct tty_struct { |
270 | int magic; | |
9c9f4ded | 271 | struct kref kref; |
86b20677 | 272 | struct device *dev; /* class device or NULL (e.g. ptys, serdev) */ |
1da177e4 | 273 | struct tty_driver *driver; |
f34d7a5b | 274 | const struct tty_operations *ops; |
1da177e4 | 275 | int index; |
c65c9bc3 AC |
276 | |
277 | /* Protects ldisc changes: Lock tty not pty */ | |
36697529 | 278 | struct ld_semaphore ldisc_sem; |
c65c9bc3 AC |
279 | struct tty_ldisc *ldisc; |
280 | ||
bddc7152 | 281 | struct mutex atomic_write_lock; |
89c8d91e | 282 | struct mutex legacy_mutex; |
d8c1f929 | 283 | struct mutex throttle_mutex; |
6a1c0680 | 284 | struct rw_semaphore termios_rwsem; |
dee4a0be | 285 | struct mutex winsize_mutex; |
6a1c0680 | 286 | /* Termios values are protected by the termios rwsem */ |
adc8d746 | 287 | struct ktermios termios, termios_locked; |
1da177e4 | 288 | char name[64]; |
1da177e4 LT |
289 | unsigned long flags; |
290 | int count; | |
dee4a0be | 291 | struct winsize winsize; /* winsize_mutex */ |
6e94dbc7 JS |
292 | |
293 | struct { | |
294 | spinlock_t lock; | |
295 | bool stopped; | |
296 | bool tco_stopped; | |
297 | unsigned long unused[0]; | |
298 | } __aligned(sizeof(unsigned long)) flow; | |
299 | ||
64d608db JS |
300 | struct { |
301 | spinlock_t lock; | |
302 | struct pid *pgrp; | |
303 | struct pid *session; | |
304 | unsigned char pktstatus; | |
305 | bool packet; | |
306 | unsigned long unused[0]; | |
307 | } __aligned(sizeof(unsigned long)) ctrl; | |
308 | ||
d7a855bd | 309 | int hw_stopped; |
33f0f88f | 310 | unsigned int receive_room; /* Bytes free for queue */ |
70bc1264 | 311 | int flow_change; |
1da177e4 LT |
312 | |
313 | struct tty_struct *link; | |
314 | struct fasync_struct *fasync; | |
1da177e4 LT |
315 | wait_queue_head_t write_wait; |
316 | wait_queue_head_t read_wait; | |
317 | struct work_struct hangup_work; | |
318 | void *disc_data; | |
319 | void *driver_data; | |
4a510969 | 320 | spinlock_t files_lock; /* protects tty_files list */ |
1da177e4 LT |
321 | struct list_head tty_files; |
322 | ||
323 | #define N_TTY_BUF_SIZE 4096 | |
6f67048c | 324 | |
413ba638 | 325 | int closing; |
1da177e4 LT |
326 | unsigned char *write_buf; |
327 | int write_cnt; | |
1da177e4 LT |
328 | /* If the tty has a pending do_SAK, queue it here - akpm */ |
329 | struct work_struct SAK_work; | |
6f67048c | 330 | struct tty_port *port; |
3859a271 | 331 | } __randomize_layout; |
1da177e4 | 332 | |
d996b62a NP |
333 | /* Each of a tty's open files has private_data pointing to tty_file_private */ |
334 | struct tty_file_private { | |
335 | struct tty_struct *tty; | |
336 | struct file *file; | |
337 | struct list_head list; | |
338 | }; | |
339 | ||
1da177e4 LT |
340 | /* tty magic number */ |
341 | #define TTY_MAGIC 0x5401 | |
342 | ||
343 | /* | |
344 | * These bits are used in the flags field of the tty structure. | |
7a4d29f4 | 345 | * |
1da177e4 LT |
346 | * So that interrupts won't be able to mess up the queues, |
347 | * copy_to_cooked must be atomic with respect to itself, as must | |
348 | * tty->write. Thus, you must use the inline functions set_bit() and | |
349 | * clear_bit() to make things atomic. | |
350 | */ | |
351 | #define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */ | |
7a4d29f4 | 352 | #define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */ |
1da177e4 LT |
353 | #define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */ |
354 | #define TTY_EXCLUSIVE 3 /* Exclusive open mode */ | |
1da177e4 | 355 | #define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */ |
c65c9bc3 | 356 | #define TTY_LDISC_OPEN 11 /* Line discipline is open */ |
1da177e4 LT |
357 | #define TTY_PTY_LOCK 16 /* pty private */ |
358 | #define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */ | |
359 | #define TTY_HUPPED 18 /* Post driver->hangup() */ | |
28b0f8a6 | 360 | #define TTY_HUPPING 19 /* Hangup in progress */ |
c96cf923 | 361 | #define TTY_LDISC_CHANGING 20 /* Change pending - non-block IO */ |
21622939 | 362 | #define TTY_LDISC_HALTED 22 /* Line discipline is halted */ |
1da177e4 | 363 | |
c96cf923 DS |
364 | static inline bool tty_io_nonblock(struct tty_struct *tty, struct file *file) |
365 | { | |
366 | return file->f_flags & O_NONBLOCK || | |
367 | test_bit(TTY_LDISC_CHANGING, &tty->flags); | |
368 | } | |
369 | ||
18900ca6 PH |
370 | static inline bool tty_io_error(struct tty_struct *tty) |
371 | { | |
372 | return test_bit(TTY_IO_ERROR, &tty->flags); | |
373 | } | |
374 | ||
97ef38b8 PH |
375 | static inline bool tty_throttled(struct tty_struct *tty) |
376 | { | |
377 | return test_bit(TTY_THROTTLED, &tty->flags); | |
378 | } | |
379 | ||
4f73bc4d | 380 | #ifdef CONFIG_TTY |
4f73bc4d JM |
381 | extern void tty_kref_put(struct tty_struct *tty); |
382 | extern struct pid *tty_get_pgrp(struct tty_struct *tty); | |
383 | extern void tty_vhangup_self(void); | |
384 | extern void disassociate_ctty(int priv); | |
385 | extern dev_t tty_devnum(struct tty_struct *tty); | |
386 | extern void proc_clear_tty(struct task_struct *p); | |
387 | extern struct tty_struct *get_current_tty(void); | |
388 | /* tty_io.c */ | |
389 | extern int __init tty_init(void); | |
188e3c5c | 390 | extern const char *tty_name(const struct tty_struct *tty); |
4ea3cd65 UKK |
391 | extern struct tty_struct *tty_kopen_exclusive(dev_t device); |
392 | extern struct tty_struct *tty_kopen_shared(dev_t device); | |
a09ac397 | 393 | extern void tty_kclose(struct tty_struct *tty); |
fc61ed51 | 394 | extern int tty_dev_name_to_number(const char *name, dev_t *number); |
4f73bc4d | 395 | #else |
4f73bc4d JM |
396 | static inline void tty_kref_put(struct tty_struct *tty) |
397 | { } | |
398 | static inline struct pid *tty_get_pgrp(struct tty_struct *tty) | |
399 | { return NULL; } | |
400 | static inline void tty_vhangup_self(void) | |
401 | { } | |
402 | static inline void disassociate_ctty(int priv) | |
403 | { } | |
404 | static inline dev_t tty_devnum(struct tty_struct *tty) | |
405 | { return 0; } | |
406 | static inline void proc_clear_tty(struct task_struct *p) | |
407 | { } | |
408 | static inline struct tty_struct *get_current_tty(void) | |
409 | { return NULL; } | |
410 | /* tty_io.c */ | |
411 | static inline int __init tty_init(void) | |
412 | { return 0; } | |
188e3c5c AB |
413 | static inline const char *tty_name(const struct tty_struct *tty) |
414 | { return "(none)"; } | |
4ea3cd65 | 415 | static inline struct tty_struct *tty_kopen_exclusive(dev_t device) |
a09ac397 OK |
416 | { return ERR_PTR(-ENODEV); } |
417 | static inline void tty_kclose(struct tty_struct *tty) | |
418 | { } | |
fc61ed51 OK |
419 | static inline int tty_dev_name_to_number(const char *name, dev_t *number) |
420 | { return -ENOTSUPP; } | |
4f73bc4d JM |
421 | #endif |
422 | ||
edc6afc5 | 423 | extern struct ktermios tty_std_termios; |
1da177e4 | 424 | |
1da177e4 LT |
425 | extern int vcs_init(void); |
426 | ||
d81ed103 AC |
427 | extern struct class *tty_class; |
428 | ||
9c9f4ded AC |
429 | /** |
430 | * tty_kref_get - get a tty reference | |
431 | * @tty: tty device | |
432 | * | |
433 | * Return a new reference to a tty object. The caller must hold | |
434 | * sufficient locks/counts to ensure that their existing reference cannot | |
435 | * go away | |
436 | */ | |
437 | ||
14bfc987 | 438 | static inline struct tty_struct *tty_kref_get(struct tty_struct *tty) |
9c9f4ded AC |
439 | { |
440 | if (tty) | |
441 | kref_get(&tty->kref); | |
442 | return tty; | |
443 | } | |
9c9f4ded | 444 | |
0a083edd | 445 | extern const char *tty_driver_name(const struct tty_struct *tty); |
7a4d29f4 | 446 | extern void tty_wait_until_sent(struct tty_struct *tty, long timeout); |
7a4d29f4 AC |
447 | extern void stop_tty(struct tty_struct *tty); |
448 | extern void start_tty(struct tty_struct *tty); | |
1da177e4 | 449 | extern int tty_register_driver(struct tty_driver *driver); |
a872ab4d | 450 | extern void tty_unregister_driver(struct tty_driver *driver); |
01107d34 GKH |
451 | extern struct device *tty_register_device(struct tty_driver *driver, |
452 | unsigned index, struct device *dev); | |
6915c0e4 TH |
453 | extern struct device *tty_register_device_attr(struct tty_driver *driver, |
454 | unsigned index, struct device *device, | |
455 | void *drvdata, | |
456 | const struct attribute_group **attr_grp); | |
1da177e4 | 457 | extern void tty_unregister_device(struct tty_driver *driver, unsigned index); |
1da177e4 | 458 | extern void tty_write_message(struct tty_struct *tty, char *msg); |
136d5258 | 459 | extern int tty_send_xchar(struct tty_struct *tty, char ch); |
f34d7a5b | 460 | extern int tty_put_char(struct tty_struct *tty, unsigned char c); |
fff4ef17 | 461 | extern unsigned int tty_chars_in_buffer(struct tty_struct *tty); |
03b3b1a2 | 462 | extern unsigned int tty_write_room(struct tty_struct *tty); |
f34d7a5b | 463 | extern void tty_driver_flush_buffer(struct tty_struct *tty); |
39c2e60f | 464 | extern void tty_unthrottle(struct tty_struct *tty); |
70bc1264 PH |
465 | extern int tty_throttle_safe(struct tty_struct *tty); |
466 | extern int tty_unthrottle_safe(struct tty_struct *tty); | |
fc6f6238 | 467 | extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws); |
d20c219c UKK |
468 | extern int tty_get_icount(struct tty_struct *tty, |
469 | struct serial_icounter_struct *icount); | |
3e7cd6c4 | 470 | extern int is_current_pgrp_orphaned(void); |
7a4d29f4 AC |
471 | extern void tty_hangup(struct tty_struct *tty); |
472 | extern void tty_vhangup(struct tty_struct *tty); | |
7a4d29f4 | 473 | extern int tty_hung_up_p(struct file *filp); |
1da177e4 | 474 | extern void do_SAK(struct tty_struct *tty); |
8b6312f4 | 475 | extern void __do_SAK(struct tty_struct *tty); |
98a27ba4 | 476 | extern void no_tty(void); |
edc6afc5 | 477 | extern speed_t tty_termios_baud_rate(struct ktermios *termios); |
7a4d29f4 AC |
478 | extern void tty_termios_encode_baud_rate(struct ktermios *termios, |
479 | speed_t ibaud, speed_t obaud); | |
480 | extern void tty_encode_baud_rate(struct tty_struct *tty, | |
481 | speed_t ibaud, speed_t obaud); | |
6865ff22 JS |
482 | |
483 | /** | |
484 | * tty_get_baud_rate - get tty bit rates | |
485 | * @tty: tty to query | |
486 | * | |
487 | * Returns the baud rate as an integer for this terminal. The | |
488 | * termios lock must be held by the caller and the terminal bit | |
489 | * flags may be updated. | |
490 | * | |
491 | * Locking: none | |
492 | */ | |
493 | static inline speed_t tty_get_baud_rate(struct tty_struct *tty) | |
494 | { | |
495 | return tty_termios_baud_rate(&tty->termios); | |
496 | } | |
497 | ||
654ee49b JS |
498 | unsigned char tty_get_char_size(unsigned int cflag); |
499 | unsigned char tty_get_frame_size(unsigned int cflag); | |
500 | ||
5f519d72 | 501 | extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old); |
7b0c6b38 | 502 | extern int tty_termios_hw_change(const struct ktermios *a, const struct ktermios *b); |
b00f5c2d | 503 | extern int tty_set_termios(struct tty_struct *tty, struct ktermios *kt); |
1da177e4 LT |
504 | |
505 | extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *); | |
506 | extern void tty_ldisc_deref(struct tty_ldisc *); | |
507 | extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *); | |
fddda2b7 | 508 | extern const struct seq_operations tty_ldiscs_seq_ops; |
1da177e4 LT |
509 | |
510 | extern void tty_wakeup(struct tty_struct *tty); | |
511 | extern void tty_ldisc_flush(struct tty_struct *tty); | |
512 | ||
0fc00e24 AC |
513 | extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file, |
514 | unsigned int cmd, unsigned long arg); | |
515 | extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg); | |
593a27c4 | 516 | extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx); |
9ed90d20 | 517 | extern void tty_release_struct(struct tty_struct *tty, int idx); |
a3123fd0 | 518 | extern void tty_init_termios(struct tty_struct *tty); |
f51ccf46 | 519 | extern void tty_save_termios(struct tty_struct *tty); |
66d450e8 JS |
520 | extern int tty_standard_install(struct tty_driver *driver, |
521 | struct tty_struct *tty); | |
24ec839c | 522 | |
70522e12 | 523 | extern struct mutex tty_mutex; |
1da177e4 | 524 | |
6f67048c | 525 | extern void tty_port_init(struct tty_port *port); |
2cb4ca02 JS |
526 | extern void tty_port_link_device(struct tty_port *port, |
527 | struct tty_driver *driver, unsigned index); | |
057eb856 JS |
528 | extern struct device *tty_port_register_device(struct tty_port *port, |
529 | struct tty_driver *driver, unsigned index, | |
530 | struct device *device); | |
b1b79916 TH |
531 | extern struct device *tty_port_register_device_attr(struct tty_port *port, |
532 | struct tty_driver *driver, unsigned index, | |
533 | struct device *device, void *drvdata, | |
534 | const struct attribute_group **attr_grp); | |
8cde11b2 JH |
535 | extern struct device *tty_port_register_device_serdev(struct tty_port *port, |
536 | struct tty_driver *driver, unsigned index, | |
537 | struct device *device); | |
538 | extern struct device *tty_port_register_device_attr_serdev(struct tty_port *port, | |
539 | struct tty_driver *driver, unsigned index, | |
540 | struct device *device, void *drvdata, | |
541 | const struct attribute_group **attr_grp); | |
542 | extern void tty_port_unregister_device(struct tty_port *port, | |
543 | struct tty_driver *driver, unsigned index); | |
6f67048c AC |
544 | extern int tty_port_alloc_xmit_buf(struct tty_port *port); |
545 | extern void tty_port_free_xmit_buf(struct tty_port *port); | |
de274bfe | 546 | extern void tty_port_destroy(struct tty_port *port); |
568aafc6 AC |
547 | extern void tty_port_put(struct tty_port *port); |
548 | ||
2427b8e3 | 549 | static inline struct tty_port *tty_port_get(struct tty_port *port) |
568aafc6 | 550 | { |
c0fdfb80 PH |
551 | if (port && kref_get_unless_zero(&port->kref)) |
552 | return port; | |
553 | return NULL; | |
568aafc6 AC |
554 | } |
555 | ||
f21ec3d2 | 556 | /* If the cts flow control is enabled, return true. */ |
9e179272 | 557 | static inline bool tty_port_cts_enabled(const struct tty_port *port) |
f21ec3d2 | 558 | { |
5604a98e | 559 | return test_bit(TTY_PORT_CTS_FLOW, &port->iflags); |
f21ec3d2 HS |
560 | } |
561 | ||
5604a98e PH |
562 | static inline void tty_port_set_cts_flow(struct tty_port *port, bool val) |
563 | { | |
af633212 | 564 | assign_bit(TTY_PORT_CTS_FLOW, &port->iflags, val); |
5604a98e PH |
565 | } |
566 | ||
9e179272 | 567 | static inline bool tty_port_active(const struct tty_port *port) |
807c8d81 PH |
568 | { |
569 | return test_bit(TTY_PORT_ACTIVE, &port->iflags); | |
570 | } | |
571 | ||
572 | static inline void tty_port_set_active(struct tty_port *port, bool val) | |
573 | { | |
af633212 | 574 | assign_bit(TTY_PORT_ACTIVE, &port->iflags, val); |
807c8d81 | 575 | } |
5604a98e | 576 | |
9e179272 | 577 | static inline bool tty_port_check_carrier(const struct tty_port *port) |
2d68655d PH |
578 | { |
579 | return test_bit(TTY_PORT_CHECK_CD, &port->iflags); | |
580 | } | |
581 | ||
582 | static inline void tty_port_set_check_carrier(struct tty_port *port, bool val) | |
583 | { | |
af633212 | 584 | assign_bit(TTY_PORT_CHECK_CD, &port->iflags, val); |
2d68655d PH |
585 | } |
586 | ||
9e179272 | 587 | static inline bool tty_port_suspended(const struct tty_port *port) |
80f02d54 PH |
588 | { |
589 | return test_bit(TTY_PORT_SUSPENDED, &port->iflags); | |
590 | } | |
591 | ||
592 | static inline void tty_port_set_suspended(struct tty_port *port, bool val) | |
593 | { | |
af633212 | 594 | assign_bit(TTY_PORT_SUSPENDED, &port->iflags, val); |
80f02d54 PH |
595 | } |
596 | ||
9e179272 | 597 | static inline bool tty_port_initialized(const struct tty_port *port) |
d41861ca PH |
598 | { |
599 | return test_bit(TTY_PORT_INITIALIZED, &port->iflags); | |
600 | } | |
601 | ||
602 | static inline void tty_port_set_initialized(struct tty_port *port, bool val) | |
603 | { | |
af633212 | 604 | assign_bit(TTY_PORT_INITIALIZED, &port->iflags, val); |
f21ec3d2 HS |
605 | } |
606 | ||
9e179272 | 607 | static inline bool tty_port_kopened(const struct tty_port *port) |
a09ac397 OK |
608 | { |
609 | return test_bit(TTY_PORT_KOPENED, &port->iflags); | |
610 | } | |
611 | ||
612 | static inline void tty_port_set_kopened(struct tty_port *port, bool val) | |
613 | { | |
af633212 | 614 | assign_bit(TTY_PORT_KOPENED, &port->iflags, val); |
a09ac397 OK |
615 | } |
616 | ||
4a90f09b AC |
617 | extern struct tty_struct *tty_port_tty_get(struct tty_port *port); |
618 | extern void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty); | |
31f35939 | 619 | extern int tty_port_carrier_raised(struct tty_port *port); |
5d951fb4 | 620 | extern void tty_port_raise_dtr_rts(struct tty_port *port); |
fcc8ac18 | 621 | extern void tty_port_lower_dtr_rts(struct tty_port *port); |
3e61696b | 622 | extern void tty_port_hangup(struct tty_port *port); |
aa27a094 | 623 | extern void tty_port_tty_hangup(struct tty_port *port, bool check_clocal); |
6aad04f2 | 624 | extern void tty_port_tty_wakeup(struct tty_port *port); |
36c621d8 AC |
625 | extern int tty_port_block_til_ready(struct tty_port *port, |
626 | struct tty_struct *tty, struct file *filp); | |
a6614999 AC |
627 | extern int tty_port_close_start(struct tty_port *port, |
628 | struct tty_struct *tty, struct file *filp); | |
629 | extern void tty_port_close_end(struct tty_port *port, struct tty_struct *tty); | |
7ca0ff9a AC |
630 | extern void tty_port_close(struct tty_port *port, |
631 | struct tty_struct *tty, struct file *filp); | |
695586ca JS |
632 | extern int tty_port_install(struct tty_port *port, struct tty_driver *driver, |
633 | struct tty_struct *tty); | |
64bc3979 AC |
634 | extern int tty_port_open(struct tty_port *port, |
635 | struct tty_struct *tty, struct file *filp); | |
2427b8e3 | 636 | static inline int tty_port_users(struct tty_port *port) |
b58d13a0 AC |
637 | { |
638 | return port->count + port->blocked_open; | |
639 | } | |
640 | ||
fbadf70a | 641 | extern int tty_register_ldisc(struct tty_ldisc_ops *new_ldisc); |
f6f19595 | 642 | extern void tty_unregister_ldisc(struct tty_ldisc_ops *ldisc); |
c12da96f | 643 | extern int tty_set_ldisc(struct tty_struct *tty, int disc); |
c92d781f | 644 | extern int tty_ldisc_receive_buf(struct tty_ldisc *ld, const unsigned char *p, |
0f3dcf3b | 645 | const char *f, int count); |
9c1729db | 646 | |
1da177e4 | 647 | /* n_tty.c */ |
572b9adb | 648 | extern void n_tty_inherit_ops(struct tty_ldisc_ops *ops); |
0c688614 | 649 | #ifdef CONFIG_TTY |
27228732 | 650 | extern void __init n_tty_init(void); |
0c688614 NP |
651 | #else |
652 | static inline void n_tty_init(void) { } | |
653 | #endif | |
1da177e4 | 654 | |
522ed776 MT |
655 | /* tty_audit.c */ |
656 | #ifdef CONFIG_AUDIT | |
522ed776 MT |
657 | extern void tty_audit_exit(void); |
658 | extern void tty_audit_fork(struct signal_struct *sig); | |
37282a77 | 659 | extern int tty_audit_push(void); |
522ed776 | 660 | #else |
522ed776 MT |
661 | static inline void tty_audit_exit(void) |
662 | { | |
663 | } | |
664 | static inline void tty_audit_fork(struct signal_struct *sig) | |
665 | { | |
666 | } | |
37282a77 | 667 | static inline int tty_audit_push(void) |
522ed776 | 668 | { |
3c80fe4a | 669 | return 0; |
522ed776 | 670 | } |
522ed776 MT |
671 | #endif |
672 | ||
1da177e4 | 673 | /* tty_ioctl.c */ |
47afa7a5 | 674 | extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file, |
1da177e4 LT |
675 | unsigned int cmd, unsigned long arg); |
676 | ||
1da177e4 LT |
677 | /* vt.c */ |
678 | ||
6caa76b7 | 679 | extern int vt_ioctl(struct tty_struct *tty, |
1da177e4 LT |
680 | unsigned int cmd, unsigned long arg); |
681 | ||
94c2273d | 682 | extern long vt_compat_ioctl(struct tty_struct *tty, |
e9216651 AB |
683 | unsigned int cmd, unsigned long arg); |
684 | ||
b07471fa | 685 | /* tty_mutex.c */ |
ec79d605 | 686 | /* functions for preparation of BKL removal */ |
c2bb524b | 687 | extern void tty_lock(struct tty_struct *tty); |
0bfd464d | 688 | extern int tty_lock_interruptible(struct tty_struct *tty); |
c2bb524b PH |
689 | extern void tty_unlock(struct tty_struct *tty); |
690 | extern void tty_lock_slave(struct tty_struct *tty); | |
691 | extern void tty_unlock_slave(struct tty_struct *tty); | |
2febdb63 | 692 | extern void tty_set_lock_subclass(struct tty_struct *tty); |
be1bc288 | 693 | |
34db8aaf DH |
694 | #ifdef CONFIG_PROC_FS |
695 | extern void proc_tty_register_driver(struct tty_driver *); | |
696 | extern void proc_tty_unregister_driver(struct tty_driver *); | |
697 | #else | |
698 | static inline void proc_tty_register_driver(struct tty_driver *d) {} | |
699 | static inline void proc_tty_unregister_driver(struct tty_driver *d) {} | |
700 | #endif | |
be1bc288 | 701 | |
1da177e4 | 702 | #endif |