]>
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> |
ae92c1f5 | 14 | |
ae92c1f5 FF |
15 | |
16 | ||
17 | /* | |
18 | * (Note: the *_driver.minor_start values 1, 64, 128, 192 are | |
19 | * hardcoded at present.) | |
20 | */ | |
21 | #define NR_UNIX98_PTY_DEFAULT 4096 /* Default maximum for Unix98 ptys */ | |
e9aba515 | 22 | #define NR_UNIX98_PTY_RESERVE 1024 /* Default reserve for main devpts */ |
ae92c1f5 FF |
23 | #define NR_UNIX98_PTY_MAX (1 << MINORBITS) /* Absolute limit */ |
24 | ||
1da177e4 LT |
25 | /* |
26 | * This character is the same as _POSIX_VDISABLE: it cannot be used as | |
27 | * a c_cc[] character, but indicates that a particular special character | |
28 | * isn't in use (eg VINTR has no character etc) | |
29 | */ | |
30 | #define __DISABLED_CHAR '\0' | |
31 | ||
33f0f88f AC |
32 | struct tty_buffer { |
33 | struct tty_buffer *next; | |
33f0f88f AC |
34 | int used; |
35 | int size; | |
8977d929 PF |
36 | int commit; |
37 | int read; | |
33f0f88f AC |
38 | /* Data points here */ |
39 | unsigned long data[0]; | |
40 | }; | |
41 | ||
1fc359fc PH |
42 | static inline unsigned char *char_buf_ptr(struct tty_buffer *b, int ofs) |
43 | { | |
44 | return ((unsigned char *)b->data) + ofs; | |
45 | } | |
46 | ||
47 | static inline char *flag_buf_ptr(struct tty_buffer *b, int ofs) | |
48 | { | |
49 | return (char *)char_buf_ptr(b, ofs) + b->size; | |
50 | } | |
51 | ||
d9661adf AC |
52 | /* |
53 | * We default to dicing tty buffer allocations to this many characters | |
352fa6ad MG |
54 | * in order to avoid multiple page allocations. We know the size of |
55 | * tty_buffer itself but it must also be taken into account that the | |
56 | * the buffer is 256 byte aligned. See tty_buffer_find for the allocation | |
57 | * logic this must match | |
d9661adf AC |
58 | */ |
59 | ||
352fa6ad | 60 | #define TTY_BUFFER_PAGE (((PAGE_SIZE - sizeof(struct tty_buffer)) / 2) & ~0xFF) |
d9661adf AC |
61 | |
62 | ||
33f0f88f | 63 | struct tty_bufhead { |
f23eb2b2 | 64 | struct work_struct work; |
808249ce | 65 | spinlock_t lock; |
33f0f88f AC |
66 | struct tty_buffer *head; /* Queue head */ |
67 | struct tty_buffer *tail; /* Active buffer */ | |
68 | struct tty_buffer *free; /* Free queue head */ | |
7a4d29f4 AC |
69 | int memory_used; /* Buffer space used excluding |
70 | free queue */ | |
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) | |
146 | ||
147 | #define L_ISIG(tty) _L_FLAG((tty), ISIG) | |
148 | #define L_ICANON(tty) _L_FLAG((tty), ICANON) | |
149 | #define L_XCASE(tty) _L_FLAG((tty), XCASE) | |
150 | #define L_ECHO(tty) _L_FLAG((tty), ECHO) | |
151 | #define L_ECHOE(tty) _L_FLAG((tty), ECHOE) | |
152 | #define L_ECHOK(tty) _L_FLAG((tty), ECHOK) | |
153 | #define L_ECHONL(tty) _L_FLAG((tty), ECHONL) | |
154 | #define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH) | |
155 | #define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP) | |
156 | #define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL) | |
157 | #define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT) | |
158 | #define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE) | |
159 | #define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO) | |
160 | #define L_PENDIN(tty) _L_FLAG((tty), PENDIN) | |
161 | #define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN) | |
26df6d13 | 162 | #define L_EXTPROC(tty) _L_FLAG((tty), EXTPROC) |
1da177e4 LT |
163 | |
164 | struct device; | |
522ed776 | 165 | struct signal_struct; |
6f67048c AC |
166 | |
167 | /* | |
168 | * Port level information. Each device keeps its own port level information | |
169 | * so provide a common structure for those ports wanting to use common support | |
170 | * routines. | |
171 | * | |
172 | * The tty port has a different lifetime to the tty so must be kept apart. | |
173 | * In addition be careful as tty -> port mappings are valid for the life | |
174 | * of the tty object but in many cases port -> tty mappings are valid only | |
175 | * until a hangup so don't use the wrong path. | |
176 | */ | |
7a4d29f4 | 177 | |
31f35939 AC |
178 | struct tty_port; |
179 | ||
180 | struct tty_port_operations { | |
181 | /* Return 1 if the carrier is raised */ | |
182 | int (*carrier_raised)(struct tty_port *port); | |
7ca0ff9a | 183 | /* Control the DTR line */ |
fcc8ac18 | 184 | void (*dtr_rts)(struct tty_port *port, int raise); |
7ca0ff9a | 185 | /* Called when the last close completes or a hangup finishes |
64bc3979 AC |
186 | IFF the port was initialized. Do not use to free resources. Called |
187 | under the port mutex to serialize against activate/shutdowns */ | |
7ca0ff9a AC |
188 | void (*shutdown)(struct tty_port *port); |
189 | void (*drop)(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 AC |
197 | }; |
198 | ||
6f67048c | 199 | struct tty_port { |
ecbbfd44 | 200 | struct tty_bufhead buf; /* Locked internally */ |
6f67048c | 201 | struct tty_struct *tty; /* Back pointer */ |
967fab69 | 202 | struct tty_struct *itty; /* internal back ptr */ |
31f35939 | 203 | const struct tty_port_operations *ops; /* Port operations */ |
4a90f09b | 204 | spinlock_t lock; /* Lock protecting tty field */ |
6f67048c AC |
205 | int blocked_open; /* Waiting to open */ |
206 | int count; /* Usage count */ | |
207 | wait_queue_head_t open_wait; /* Open waiters */ | |
208 | wait_queue_head_t close_wait; /* Close waiters */ | |
bdc04e31 | 209 | wait_queue_head_t delta_msr_wait; /* Modem status change */ |
6f67048c | 210 | unsigned long flags; /* TTY flags ASY_*/ |
2fc20661 JS |
211 | unsigned long iflags; /* TTYP_ internal flags */ |
212 | #define TTYP_FLUSHING 1 /* Flushing to ldisc in progress */ | |
213 | #define TTYP_FLUSHPENDING 2 /* Queued buffer flush pending */ | |
d6c53c0e JS |
214 | unsigned char console:1, /* port is a console */ |
215 | low_latency:1; /* direct buffer flush */ | |
6f67048c | 216 | struct mutex mutex; /* Locking */ |
44e4909e | 217 | struct mutex buf_mutex; /* Buffer alloc lock */ |
6f67048c | 218 | unsigned char *xmit_buf; /* Optional buffer */ |
5e99df56 AC |
219 | unsigned int close_delay; /* Close port delay */ |
220 | unsigned int closing_wait; /* Delay for output */ | |
1ec739be AC |
221 | int drain_delay; /* Set to zero if no pure time |
222 | based drain is needed else | |
223 | set to size of fifo */ | |
568aafc6 | 224 | struct kref kref; /* Ref counter */ |
6f67048c AC |
225 | }; |
226 | ||
1da177e4 LT |
227 | /* |
228 | * Where all of the state associated with a tty is kept while the tty | |
229 | * is open. Since the termios state should be kept even if the tty | |
230 | * has been closed --- for things like the baud rate, etc --- it is | |
231 | * not stored here, but rather a pointer to the real state is stored | |
232 | * here. Possible the winsize structure should have the same | |
233 | * treatment, but (1) the default 80x24 is usually right and (2) it's | |
234 | * most often used by a windowing system, which will set the correct | |
235 | * size each time the window is created or resized anyway. | |
236 | * - TYT, 9/14/92 | |
237 | */ | |
f34d7a5b AC |
238 | |
239 | struct tty_operations; | |
240 | ||
1da177e4 LT |
241 | struct tty_struct { |
242 | int magic; | |
9c9f4ded | 243 | struct kref kref; |
30004ac9 | 244 | struct device *dev; |
1da177e4 | 245 | struct tty_driver *driver; |
f34d7a5b | 246 | const struct tty_operations *ops; |
1da177e4 | 247 | int index; |
c65c9bc3 AC |
248 | |
249 | /* Protects ldisc changes: Lock tty not pty */ | |
36697529 | 250 | struct ld_semaphore ldisc_sem; |
c65c9bc3 AC |
251 | struct tty_ldisc *ldisc; |
252 | ||
bddc7152 | 253 | struct mutex atomic_write_lock; |
89c8d91e | 254 | struct mutex legacy_mutex; |
d8c1f929 | 255 | struct mutex throttle_mutex; |
6a1c0680 | 256 | struct rw_semaphore termios_rwsem; |
04f378b1 | 257 | spinlock_t ctrl_lock; |
6a1c0680 | 258 | /* Termios values are protected by the termios rwsem */ |
adc8d746 | 259 | struct ktermios termios, termios_locked; |
1d65b4a0 | 260 | struct termiox *termiox; /* May be NULL for unsupported */ |
1da177e4 | 261 | char name[64]; |
47f86834 | 262 | struct pid *pgrp; /* Protected by ctrl lock */ |
ab521dc0 | 263 | struct pid *session; |
1da177e4 LT |
264 | unsigned long flags; |
265 | int count; | |
6a1c0680 | 266 | struct winsize winsize; /* termios rwsem */ |
1da177e4 | 267 | unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1; |
47f86834 | 268 | unsigned char ctrl_status; /* ctrl_lock */ |
33f0f88f | 269 | unsigned int receive_room; /* Bytes free for queue */ |
70bc1264 | 270 | int flow_change; |
1da177e4 LT |
271 | |
272 | struct tty_struct *link; | |
273 | struct fasync_struct *fasync; | |
1da177e4 LT |
274 | int alt_speed; /* For magic substitution of 38400 bps */ |
275 | wait_queue_head_t write_wait; | |
276 | wait_queue_head_t read_wait; | |
277 | struct work_struct hangup_work; | |
278 | void *disc_data; | |
279 | void *driver_data; | |
280 | struct list_head tty_files; | |
281 | ||
282 | #define N_TTY_BUF_SIZE 4096 | |
6f67048c | 283 | |
1da177e4 | 284 | unsigned char closing:1; |
1da177e4 LT |
285 | unsigned char *write_buf; |
286 | int write_cnt; | |
1da177e4 LT |
287 | /* If the tty has a pending do_SAK, queue it here - akpm */ |
288 | struct work_struct SAK_work; | |
6f67048c | 289 | struct tty_port *port; |
1da177e4 LT |
290 | }; |
291 | ||
d996b62a NP |
292 | /* Each of a tty's open files has private_data pointing to tty_file_private */ |
293 | struct tty_file_private { | |
294 | struct tty_struct *tty; | |
295 | struct file *file; | |
296 | struct list_head list; | |
297 | }; | |
298 | ||
1da177e4 LT |
299 | /* tty magic number */ |
300 | #define TTY_MAGIC 0x5401 | |
301 | ||
302 | /* | |
303 | * These bits are used in the flags field of the tty structure. | |
7a4d29f4 | 304 | * |
1da177e4 LT |
305 | * So that interrupts won't be able to mess up the queues, |
306 | * copy_to_cooked must be atomic with respect to itself, as must | |
307 | * tty->write. Thus, you must use the inline functions set_bit() and | |
308 | * clear_bit() to make things atomic. | |
309 | */ | |
310 | #define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */ | |
7a4d29f4 | 311 | #define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */ |
1da177e4 LT |
312 | #define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */ |
313 | #define TTY_EXCLUSIVE 3 /* Exclusive open mode */ | |
314 | #define TTY_DEBUG 4 /* Debugging */ | |
315 | #define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */ | |
316 | #define TTY_PUSH 6 /* n_tty private */ | |
317 | #define TTY_CLOSING 7 /* ->close() in progress */ | |
c65c9bc3 | 318 | #define TTY_LDISC_OPEN 11 /* Line discipline is open */ |
1da177e4 LT |
319 | #define TTY_PTY_LOCK 16 /* pty private */ |
320 | #define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */ | |
321 | #define TTY_HUPPED 18 /* Post driver->hangup() */ | |
acfa747b | 322 | #define TTY_HUPPING 21 /* ->hangup() in progress */ |
21622939 | 323 | #define TTY_LDISC_HALTED 22 /* Line discipline is halted */ |
1da177e4 LT |
324 | |
325 | #define TTY_WRITE_FLUSH(tty) tty_write_flush((tty)) | |
326 | ||
70bc1264 PH |
327 | /* Values for tty->flow_change */ |
328 | #define TTY_THROTTLE_SAFE 1 | |
329 | #define TTY_UNTHROTTLE_SAFE 2 | |
330 | ||
331 | static inline void __tty_set_flow_change(struct tty_struct *tty, int val) | |
332 | { | |
333 | tty->flow_change = val; | |
334 | } | |
335 | ||
336 | static inline void tty_set_flow_change(struct tty_struct *tty, int val) | |
337 | { | |
338 | tty->flow_change = val; | |
339 | smp_mb(); | |
340 | } | |
341 | ||
4f73bc4d JM |
342 | #ifdef CONFIG_TTY |
343 | extern void console_init(void); | |
344 | extern void tty_kref_put(struct tty_struct *tty); | |
345 | extern struct pid *tty_get_pgrp(struct tty_struct *tty); | |
346 | extern void tty_vhangup_self(void); | |
347 | extern void disassociate_ctty(int priv); | |
348 | extern dev_t tty_devnum(struct tty_struct *tty); | |
349 | extern void proc_clear_tty(struct task_struct *p); | |
350 | extern struct tty_struct *get_current_tty(void); | |
351 | /* tty_io.c */ | |
352 | extern int __init tty_init(void); | |
353 | #else | |
354 | static inline void console_init(void) | |
355 | { } | |
356 | static inline void tty_kref_put(struct tty_struct *tty) | |
357 | { } | |
358 | static inline struct pid *tty_get_pgrp(struct tty_struct *tty) | |
359 | { return NULL; } | |
360 | static inline void tty_vhangup_self(void) | |
361 | { } | |
362 | static inline void disassociate_ctty(int priv) | |
363 | { } | |
364 | static inline dev_t tty_devnum(struct tty_struct *tty) | |
365 | { return 0; } | |
366 | static inline void proc_clear_tty(struct task_struct *p) | |
367 | { } | |
368 | static inline struct tty_struct *get_current_tty(void) | |
369 | { return NULL; } | |
370 | /* tty_io.c */ | |
371 | static inline int __init tty_init(void) | |
372 | { return 0; } | |
373 | #endif | |
374 | ||
1da177e4 LT |
375 | extern void tty_write_flush(struct tty_struct *); |
376 | ||
edc6afc5 | 377 | extern struct ktermios tty_std_termios; |
1da177e4 | 378 | |
1da177e4 LT |
379 | extern int vcs_init(void); |
380 | ||
d81ed103 AC |
381 | extern struct class *tty_class; |
382 | ||
9c9f4ded AC |
383 | /** |
384 | * tty_kref_get - get a tty reference | |
385 | * @tty: tty device | |
386 | * | |
387 | * Return a new reference to a tty object. The caller must hold | |
388 | * sufficient locks/counts to ensure that their existing reference cannot | |
389 | * go away | |
390 | */ | |
391 | ||
14bfc987 | 392 | static inline struct tty_struct *tty_kref_get(struct tty_struct *tty) |
9c9f4ded AC |
393 | { |
394 | if (tty) | |
395 | kref_get(&tty->kref); | |
396 | return tty; | |
397 | } | |
9c9f4ded | 398 | |
1da177e4 LT |
399 | extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode, |
400 | const char *routine); | |
401 | extern char *tty_name(struct tty_struct *tty, char *buf); | |
7a4d29f4 AC |
402 | extern void tty_wait_until_sent(struct tty_struct *tty, long timeout); |
403 | extern int tty_check_change(struct tty_struct *tty); | |
404 | extern void stop_tty(struct tty_struct *tty); | |
405 | extern void start_tty(struct tty_struct *tty); | |
1da177e4 LT |
406 | extern int tty_register_driver(struct tty_driver *driver); |
407 | extern int tty_unregister_driver(struct tty_driver *driver); | |
01107d34 GKH |
408 | extern struct device *tty_register_device(struct tty_driver *driver, |
409 | unsigned index, struct device *dev); | |
6915c0e4 TH |
410 | extern struct device *tty_register_device_attr(struct tty_driver *driver, |
411 | unsigned index, struct device *device, | |
412 | void *drvdata, | |
413 | const struct attribute_group **attr_grp); | |
1da177e4 LT |
414 | extern void tty_unregister_device(struct tty_driver *driver, unsigned index); |
415 | extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp, | |
416 | int buflen); | |
417 | extern void tty_write_message(struct tty_struct *tty, char *msg); | |
f34d7a5b AC |
418 | extern int tty_put_char(struct tty_struct *tty, unsigned char c); |
419 | extern int tty_chars_in_buffer(struct tty_struct *tty); | |
420 | extern int tty_write_room(struct tty_struct *tty); | |
421 | extern void tty_driver_flush_buffer(struct tty_struct *tty); | |
39c2e60f AC |
422 | extern void tty_throttle(struct tty_struct *tty); |
423 | extern void tty_unthrottle(struct tty_struct *tty); | |
70bc1264 PH |
424 | extern int tty_throttle_safe(struct tty_struct *tty); |
425 | extern int tty_unthrottle_safe(struct tty_struct *tty); | |
fc6f6238 | 426 | extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws); |
24d406a6 JS |
427 | extern void tty_driver_remove_tty(struct tty_driver *driver, |
428 | struct tty_struct *tty); | |
feebed65 | 429 | extern void tty_free_termios(struct tty_struct *tty); |
3e7cd6c4 | 430 | extern int is_current_pgrp_orphaned(void); |
1da177e4 LT |
431 | extern int is_ignored(int sig); |
432 | extern int tty_signal(int sig, struct tty_struct *tty); | |
7a4d29f4 AC |
433 | extern void tty_hangup(struct tty_struct *tty); |
434 | extern void tty_vhangup(struct tty_struct *tty); | |
ddcd9fb6 | 435 | extern void tty_vhangup_locked(struct tty_struct *tty); |
1da177e4 | 436 | extern void tty_unhangup(struct file *filp); |
7a4d29f4 | 437 | extern int tty_hung_up_p(struct file *filp); |
1da177e4 | 438 | extern void do_SAK(struct tty_struct *tty); |
8b6312f4 | 439 | extern void __do_SAK(struct tty_struct *tty); |
98a27ba4 | 440 | extern void no_tty(void); |
e043e42b | 441 | extern void tty_flush_to_ldisc(struct tty_struct *tty); |
ecbbfd44 | 442 | extern void tty_buffer_free_all(struct tty_port *port); |
e0495736 | 443 | extern void tty_buffer_flush(struct tty_struct *tty); |
ecbbfd44 | 444 | extern void tty_buffer_init(struct tty_port *port); |
edc6afc5 AC |
445 | extern speed_t tty_termios_baud_rate(struct ktermios *termios); |
446 | extern speed_t tty_termios_input_baud_rate(struct ktermios *termios); | |
7a4d29f4 AC |
447 | extern void tty_termios_encode_baud_rate(struct ktermios *termios, |
448 | speed_t ibaud, speed_t obaud); | |
449 | extern void tty_encode_baud_rate(struct tty_struct *tty, | |
450 | speed_t ibaud, speed_t obaud); | |
6865ff22 JS |
451 | |
452 | /** | |
453 | * tty_get_baud_rate - get tty bit rates | |
454 | * @tty: tty to query | |
455 | * | |
456 | * Returns the baud rate as an integer for this terminal. The | |
457 | * termios lock must be held by the caller and the terminal bit | |
458 | * flags may be updated. | |
459 | * | |
460 | * Locking: none | |
461 | */ | |
462 | static inline speed_t tty_get_baud_rate(struct tty_struct *tty) | |
463 | { | |
464 | return tty_termios_baud_rate(&tty->termios); | |
465 | } | |
466 | ||
5f519d72 | 467 | extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old); |
bf5e5834 | 468 | extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b); |
8d075b19 | 469 | extern int tty_set_termios(struct tty_struct *tty, struct ktermios *kt); |
1da177e4 LT |
470 | |
471 | extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *); | |
472 | extern void tty_ldisc_deref(struct tty_ldisc *); | |
473 | extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *); | |
c65c9bc3 | 474 | extern void tty_ldisc_hangup(struct tty_struct *tty); |
a352def2 | 475 | extern const struct file_operations tty_ldiscs_proc_fops; |
1da177e4 LT |
476 | |
477 | extern void tty_wakeup(struct tty_struct *tty); | |
478 | extern void tty_ldisc_flush(struct tty_struct *tty); | |
479 | ||
04f378b1 | 480 | extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg); |
0fc00e24 AC |
481 | extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file, |
482 | unsigned int cmd, unsigned long arg); | |
483 | extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg); | |
d81ed103 | 484 | extern void tty_default_fops(struct file_operations *fops); |
bf970ee4 | 485 | extern struct tty_struct *alloc_tty_struct(void); |
fa90e1c9 JS |
486 | extern int tty_alloc_file(struct file *file); |
487 | extern void tty_add_file(struct tty_struct *tty, struct file *file); | |
488 | extern void tty_free_file(struct file *file); | |
bf970ee4 AC |
489 | extern void free_tty_struct(struct tty_struct *tty); |
490 | extern void initialize_tty_struct(struct tty_struct *tty, | |
491 | struct tty_driver *driver, int idx); | |
6716671d | 492 | extern void deinitialize_tty_struct(struct tty_struct *tty); |
593a27c4 | 493 | extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx); |
eeb89d91 | 494 | extern int tty_release(struct inode *inode, struct file *filp); |
bf970ee4 | 495 | extern int tty_init_termios(struct tty_struct *tty); |
66d450e8 JS |
496 | extern int tty_standard_install(struct tty_driver *driver, |
497 | struct tty_struct *tty); | |
24ec839c | 498 | |
e8b70e7d AC |
499 | extern struct tty_struct *tty_pair_get_tty(struct tty_struct *tty); |
500 | extern struct tty_struct *tty_pair_get_pty(struct tty_struct *tty); | |
501 | ||
70522e12 | 502 | extern struct mutex tty_mutex; |
ee2ffa0d | 503 | extern spinlock_t tty_files_lock; |
1da177e4 | 504 | |
9c1729db AC |
505 | extern void tty_write_unlock(struct tty_struct *tty); |
506 | extern int tty_write_lock(struct tty_struct *tty, int ndelay); | |
507 | #define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock)) | |
508 | ||
6f67048c | 509 | extern void tty_port_init(struct tty_port *port); |
2cb4ca02 JS |
510 | extern void tty_port_link_device(struct tty_port *port, |
511 | struct tty_driver *driver, unsigned index); | |
057eb856 JS |
512 | extern struct device *tty_port_register_device(struct tty_port *port, |
513 | struct tty_driver *driver, unsigned index, | |
514 | struct device *device); | |
b1b79916 TH |
515 | extern struct device *tty_port_register_device_attr(struct tty_port *port, |
516 | struct tty_driver *driver, unsigned index, | |
517 | struct device *device, void *drvdata, | |
518 | const struct attribute_group **attr_grp); | |
6f67048c AC |
519 | extern int tty_port_alloc_xmit_buf(struct tty_port *port); |
520 | extern void tty_port_free_xmit_buf(struct tty_port *port); | |
de274bfe | 521 | extern void tty_port_destroy(struct tty_port *port); |
568aafc6 AC |
522 | extern void tty_port_put(struct tty_port *port); |
523 | ||
2427b8e3 | 524 | static inline struct tty_port *tty_port_get(struct tty_port *port) |
568aafc6 AC |
525 | { |
526 | if (port) | |
527 | kref_get(&port->kref); | |
528 | return port; | |
529 | } | |
530 | ||
f21ec3d2 HS |
531 | /* If the cts flow control is enabled, return true. */ |
532 | static inline bool tty_port_cts_enabled(struct tty_port *port) | |
533 | { | |
534 | return port->flags & ASYNC_CTS_FLOW; | |
535 | } | |
536 | ||
4a90f09b AC |
537 | extern struct tty_struct *tty_port_tty_get(struct tty_port *port); |
538 | extern void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty); | |
31f35939 | 539 | extern int tty_port_carrier_raised(struct tty_port *port); |
5d951fb4 | 540 | extern void tty_port_raise_dtr_rts(struct tty_port *port); |
fcc8ac18 | 541 | extern void tty_port_lower_dtr_rts(struct tty_port *port); |
3e61696b | 542 | extern void tty_port_hangup(struct tty_port *port); |
aa27a094 | 543 | extern void tty_port_tty_hangup(struct tty_port *port, bool check_clocal); |
6aad04f2 | 544 | extern void tty_port_tty_wakeup(struct tty_port *port); |
36c621d8 AC |
545 | extern int tty_port_block_til_ready(struct tty_port *port, |
546 | struct tty_struct *tty, struct file *filp); | |
a6614999 AC |
547 | extern int tty_port_close_start(struct tty_port *port, |
548 | struct tty_struct *tty, struct file *filp); | |
549 | extern void tty_port_close_end(struct tty_port *port, struct tty_struct *tty); | |
7ca0ff9a AC |
550 | extern void tty_port_close(struct tty_port *port, |
551 | struct tty_struct *tty, struct file *filp); | |
695586ca JS |
552 | extern int tty_port_install(struct tty_port *port, struct tty_driver *driver, |
553 | struct tty_struct *tty); | |
64bc3979 AC |
554 | extern int tty_port_open(struct tty_port *port, |
555 | struct tty_struct *tty, struct file *filp); | |
2427b8e3 | 556 | static inline int tty_port_users(struct tty_port *port) |
b58d13a0 AC |
557 | { |
558 | return port->count + port->blocked_open; | |
559 | } | |
560 | ||
01e1abb2 AC |
561 | extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc); |
562 | extern int tty_unregister_ldisc(int disc); | |
563 | extern int tty_set_ldisc(struct tty_struct *tty, int ldisc); | |
564 | extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty); | |
565 | extern void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty); | |
566 | extern void tty_ldisc_init(struct tty_struct *tty); | |
6716671d | 567 | extern void tty_ldisc_deinit(struct tty_struct *tty); |
01e1abb2 | 568 | extern void tty_ldisc_begin(void); |
9c1729db | 569 | |
24a89d1c PH |
570 | static inline int tty_ldisc_receive_buf(struct tty_ldisc *ld, unsigned char *p, |
571 | char *f, int count) | |
572 | { | |
573 | if (ld->ops->receive_buf2) | |
574 | count = ld->ops->receive_buf2(ld->tty, p, f, count); | |
575 | else { | |
576 | count = min_t(int, count, ld->tty->receive_room); | |
577 | if (count) | |
578 | ld->ops->receive_buf(ld->tty, p, f, count); | |
579 | } | |
580 | return count; | |
581 | } | |
582 | ||
9c1729db | 583 | |
1da177e4 | 584 | /* n_tty.c */ |
a352def2 | 585 | extern struct tty_ldisc_ops tty_ldisc_N_TTY; |
572b9adb | 586 | extern void n_tty_inherit_ops(struct tty_ldisc_ops *ops); |
1da177e4 | 587 | |
522ed776 MT |
588 | /* tty_audit.c */ |
589 | #ifdef CONFIG_AUDIT | |
590 | extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data, | |
6c633f27 | 591 | size_t size, unsigned icanon); |
522ed776 MT |
592 | extern void tty_audit_exit(void); |
593 | extern void tty_audit_fork(struct signal_struct *sig); | |
1e641743 | 594 | extern void tty_audit_tiocsti(struct tty_struct *tty, char ch); |
522ed776 | 595 | extern void tty_audit_push(struct tty_struct *tty); |
152f497b | 596 | extern int tty_audit_push_current(void); |
522ed776 MT |
597 | #else |
598 | static inline void tty_audit_add_data(struct tty_struct *tty, | |
6c633f27 | 599 | unsigned char *data, size_t size, unsigned icanon) |
522ed776 MT |
600 | { |
601 | } | |
1e641743 AV |
602 | static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch) |
603 | { | |
604 | } | |
522ed776 MT |
605 | static inline void tty_audit_exit(void) |
606 | { | |
607 | } | |
608 | static inline void tty_audit_fork(struct signal_struct *sig) | |
609 | { | |
610 | } | |
611 | static inline void tty_audit_push(struct tty_struct *tty) | |
612 | { | |
613 | } | |
152f497b | 614 | static inline int tty_audit_push_current(void) |
522ed776 | 615 | { |
3c80fe4a | 616 | return 0; |
522ed776 | 617 | } |
522ed776 MT |
618 | #endif |
619 | ||
1da177e4 | 620 | /* tty_ioctl.c */ |
47afa7a5 | 621 | extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file, |
1da177e4 | 622 | unsigned int cmd, unsigned long arg); |
8193c429 TM |
623 | extern long n_tty_compat_ioctl_helper(struct tty_struct *tty, struct file *file, |
624 | unsigned int cmd, unsigned long arg); | |
1da177e4 LT |
625 | |
626 | /* serial.c */ | |
627 | ||
628 | extern void serial_console_init(void); | |
7a4d29f4 | 629 | |
1da177e4 LT |
630 | /* pcxx.c */ |
631 | ||
632 | extern int pcxe_open(struct tty_struct *tty, struct file *filp); | |
633 | ||
1da177e4 LT |
634 | /* vt.c */ |
635 | ||
6caa76b7 | 636 | extern int vt_ioctl(struct tty_struct *tty, |
1da177e4 LT |
637 | unsigned int cmd, unsigned long arg); |
638 | ||
94c2273d | 639 | extern long vt_compat_ioctl(struct tty_struct *tty, |
e9216651 AB |
640 | unsigned int cmd, unsigned long arg); |
641 | ||
b07471fa | 642 | /* tty_mutex.c */ |
ec79d605 | 643 | /* functions for preparation of BKL removal */ |
89c8d91e AC |
644 | extern void __lockfunc tty_lock(struct tty_struct *tty); |
645 | extern void __lockfunc tty_unlock(struct tty_struct *tty); | |
646 | extern void __lockfunc tty_lock_pair(struct tty_struct *tty, | |
647 | struct tty_struct *tty2); | |
648 | extern void __lockfunc tty_unlock_pair(struct tty_struct *tty, | |
649 | struct tty_struct *tty2); | |
ec79d605 | 650 | |
a57a7bf3 JS |
651 | /* |
652 | * this shall be called only from where BTM is held (like close) | |
653 | * | |
654 | * We need this to ensure nobody waits for us to finish while we are waiting. | |
655 | * Without this we were encountering system stalls. | |
656 | * | |
657 | * This should be indeed removed with BTM removal later. | |
658 | * | |
659 | * Locking: BTM required. Nobody is allowed to hold port->mutex. | |
660 | */ | |
661 | static inline void tty_wait_until_sent_from_close(struct tty_struct *tty, | |
662 | long timeout) | |
663 | { | |
89c8d91e | 664 | tty_unlock(tty); /* tty->ops->close holds the BTM, drop it while waiting */ |
a57a7bf3 | 665 | tty_wait_until_sent(tty, timeout); |
89c8d91e | 666 | tty_lock(tty); |
a57a7bf3 | 667 | } |
ec79d605 | 668 | |
be1bc288 AB |
669 | /* |
670 | * wait_event_interruptible_tty -- wait for a condition with the tty lock held | |
671 | * | |
672 | * The condition we are waiting for might take a long time to | |
673 | * become true, or might depend on another thread taking the | |
674 | * BTM. In either case, we need to drop the BTM to guarantee | |
675 | * forward progress. This is a leftover from the conversion | |
676 | * from the BKL and should eventually get removed as the BTM | |
677 | * falls out of use. | |
678 | * | |
679 | * Do not use in new code. | |
680 | */ | |
89c8d91e | 681 | #define wait_event_interruptible_tty(tty, wq, condition) \ |
be1bc288 AB |
682 | ({ \ |
683 | int __ret = 0; \ | |
684 | if (!(condition)) { \ | |
89c8d91e | 685 | __wait_event_interruptible_tty(tty, wq, condition, __ret); \ |
be1bc288 AB |
686 | } \ |
687 | __ret; \ | |
688 | }) | |
689 | ||
89c8d91e | 690 | #define __wait_event_interruptible_tty(tty, wq, condition, ret) \ |
be1bc288 AB |
691 | do { \ |
692 | DEFINE_WAIT(__wait); \ | |
693 | \ | |
694 | for (;;) { \ | |
695 | prepare_to_wait(&wq, &__wait, TASK_INTERRUPTIBLE); \ | |
696 | if (condition) \ | |
697 | break; \ | |
698 | if (!signal_pending(current)) { \ | |
89c8d91e | 699 | tty_unlock(tty); \ |
be1bc288 | 700 | schedule(); \ |
89c8d91e | 701 | tty_lock(tty); \ |
be1bc288 AB |
702 | continue; \ |
703 | } \ | |
704 | ret = -ERESTARTSYS; \ | |
705 | break; \ | |
706 | } \ | |
707 | finish_wait(&wq, &__wait); \ | |
708 | } while (0) | |
709 | ||
34db8aaf DH |
710 | #ifdef CONFIG_PROC_FS |
711 | extern void proc_tty_register_driver(struct tty_driver *); | |
712 | extern void proc_tty_unregister_driver(struct tty_driver *); | |
713 | #else | |
714 | static inline void proc_tty_register_driver(struct tty_driver *d) {} | |
715 | static inline void proc_tty_unregister_driver(struct tty_driver *d) {} | |
716 | #endif | |
be1bc288 | 717 | |
1da177e4 | 718 | #endif |