]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - drivers/tty/tty_ldisc.c
rtc: simplify rtc_irq_set_state/rtc_irq_set_freq
[mirror_ubuntu-eoan-kernel.git] / drivers / tty / tty_ldisc.c
CommitLineData
e3b3d0f5 1// SPDX-License-Identifier: GPL-2.0
01e1abb2 2#include <linux/types.h>
01e1abb2 3#include <linux/errno.h>
8b3ffa17 4#include <linux/kmod.h>
01e1abb2
AC
5#include <linux/sched.h>
6#include <linux/interrupt.h>
7#include <linux/tty.h>
8#include <linux/tty_driver.h>
01e1abb2 9#include <linux/file.h>
01e1abb2
AC
10#include <linux/mm.h>
11#include <linux/string.h>
12#include <linux/slab.h>
13#include <linux/poll.h>
14#include <linux/proc_fs.h>
01e1abb2 15#include <linux/module.h>
01e1abb2
AC
16#include <linux/device.h>
17#include <linux/wait.h>
18#include <linux/bitops.h>
01e1abb2 19#include <linux/seq_file.h>
01e1abb2 20#include <linux/uaccess.h>
0c73c08e 21#include <linux/ratelimit.h>
01e1abb2 22
fc575ee6
PH
23#undef LDISC_DEBUG_HANGUP
24
25#ifdef LDISC_DEBUG_HANGUP
0a6adc13 26#define tty_ldisc_debug(tty, f, args...) tty_debug(tty, f, ##args)
fc575ee6
PH
27#else
28#define tty_ldisc_debug(tty, f, args...)
29#endif
30
d2c43890
PH
31/* lockdep nested classes for tty->ldisc_sem */
32enum {
33 LDISC_SEM_NORMAL,
34 LDISC_SEM_OTHER,
35};
36
37
01e1abb2
AC
38/*
39 * This guards the refcounted line discipline lists. The lock
40 * must be taken with irqs off because there are hangup path
41 * callers who will do ldisc lookups and cannot sleep.
42 */
43
137084bb 44static DEFINE_RAW_SPINLOCK(tty_ldiscs_lock);
01e1abb2
AC
45/* Line disc dispatch table */
46static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];
47
48/**
49 * tty_register_ldisc - install a line discipline
50 * @disc: ldisc number
51 * @new_ldisc: pointer to the ldisc object
52 *
53 * Installs a new line discipline into the kernel. The discipline
54 * is set up as unreferenced and then made available to the kernel
55 * from this point onwards.
56 *
57 * Locking:
137084bb 58 * takes tty_ldiscs_lock to guard against ldisc races
01e1abb2
AC
59 */
60
61int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc)
62{
63 unsigned long flags;
64 int ret = 0;
65
66 if (disc < N_TTY || disc >= NR_LDISCS)
67 return -EINVAL;
68
137084bb 69 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
01e1abb2
AC
70 tty_ldiscs[disc] = new_ldisc;
71 new_ldisc->num = disc;
72 new_ldisc->refcount = 0;
137084bb 73 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
01e1abb2
AC
74
75 return ret;
76}
77EXPORT_SYMBOL(tty_register_ldisc);
78
79/**
80 * tty_unregister_ldisc - unload a line discipline
81 * @disc: ldisc number
82 * @new_ldisc: pointer to the ldisc object
83 *
84 * Remove a line discipline from the kernel providing it is not
85 * currently in use.
86 *
87 * Locking:
137084bb 88 * takes tty_ldiscs_lock to guard against ldisc races
01e1abb2
AC
89 */
90
91int tty_unregister_ldisc(int disc)
92{
93 unsigned long flags;
94 int ret = 0;
95
96 if (disc < N_TTY || disc >= NR_LDISCS)
97 return -EINVAL;
98
137084bb 99 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
01e1abb2
AC
100 if (tty_ldiscs[disc]->refcount)
101 ret = -EBUSY;
102 else
103 tty_ldiscs[disc] = NULL;
137084bb 104 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
01e1abb2
AC
105
106 return ret;
107}
108EXPORT_SYMBOL(tty_unregister_ldisc);
109
f0de0e8d
LT
110static struct tty_ldisc_ops *get_ldops(int disc)
111{
112 unsigned long flags;
113 struct tty_ldisc_ops *ldops, *ret;
114
137084bb 115 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
f0de0e8d
LT
116 ret = ERR_PTR(-EINVAL);
117 ldops = tty_ldiscs[disc];
118 if (ldops) {
119 ret = ERR_PTR(-EAGAIN);
120 if (try_module_get(ldops->owner)) {
121 ldops->refcount++;
122 ret = ldops;
123 }
124 }
137084bb 125 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
f0de0e8d
LT
126 return ret;
127}
128
129static void put_ldops(struct tty_ldisc_ops *ldops)
130{
131 unsigned long flags;
132
137084bb 133 raw_spin_lock_irqsave(&tty_ldiscs_lock, flags);
f0de0e8d
LT
134 ldops->refcount--;
135 module_put(ldops->owner);
137084bb 136 raw_spin_unlock_irqrestore(&tty_ldiscs_lock, flags);
f0de0e8d 137}
01e1abb2 138
01e1abb2
AC
139/**
140 * tty_ldisc_get - take a reference to an ldisc
141 * @disc: ldisc number
01e1abb2
AC
142 *
143 * Takes a reference to a line discipline. Deals with refcounts and
c0cc1c5d
PH
144 * module locking counts.
145 *
146 * Returns: -EINVAL if the discipline index is not [N_TTY..NR_LDISCS] or
147 * if the discipline is not registered
148 * -EAGAIN if request_module() failed to load or register the
149 * the discipline
150 * -ENOMEM if allocation failure
151 *
152 * Otherwise, returns a pointer to the discipline and bumps the
153 * ref count
01e1abb2
AC
154 *
155 * Locking:
137084bb 156 * takes tty_ldiscs_lock to guard against ldisc races
01e1abb2
AC
157 */
158
36697529 159static struct tty_ldisc *tty_ldisc_get(struct tty_struct *tty, int disc)
01e1abb2 160{
c65c9bc3 161 struct tty_ldisc *ld;
182274f8 162 struct tty_ldisc_ops *ldops;
01e1abb2
AC
163
164 if (disc < N_TTY || disc >= NR_LDISCS)
c65c9bc3 165 return ERR_PTR(-EINVAL);
182274f8
LT
166
167 /*
168 * Get the ldisc ops - we may need to request them to be loaded
169 * dynamically and try again.
170 */
171 ldops = get_ldops(disc);
172 if (IS_ERR(ldops)) {
01e1abb2 173 request_module("tty-ldisc-%d", disc);
182274f8
LT
174 ldops = get_ldops(disc);
175 if (IS_ERR(ldops))
176 return ERR_CAST(ldops);
177 }
178
bcdd0ca8
TH
179 /*
180 * There is no way to handle allocation failure of only 16 bytes.
181 * Let's simplify error handling and save more memory.
182 */
183 ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL | __GFP_NOFAIL);
182274f8 184 ld->ops = ldops;
36697529 185 ld->tty = tty;
1541f845 186
c65c9bc3 187 return ld;
01e1abb2
AC
188}
189
734de249
PH
190/**
191 * tty_ldisc_put - release the ldisc
192 *
193 * Complement of tty_ldisc_get().
194 */
cb128f69 195static void tty_ldisc_put(struct tty_ldisc *ld)
734de249 196{
734de249
PH
197 if (WARN_ON_ONCE(!ld))
198 return;
199
36697529 200 put_ldops(ld->ops);
734de249 201 kfree(ld);
734de249
PH
202}
203
852e99d2 204static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
01e1abb2
AC
205{
206 return (*pos < NR_LDISCS) ? pos : NULL;
207}
208
852e99d2 209static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
01e1abb2
AC
210{
211 (*pos)++;
212 return (*pos < NR_LDISCS) ? pos : NULL;
213}
214
215static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
216{
217}
218
219static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
220{
221 int i = *(loff_t *)v;
f0de0e8d 222 struct tty_ldisc_ops *ldops;
852e99d2 223
f0de0e8d
LT
224 ldops = get_ldops(i);
225 if (IS_ERR(ldops))
01e1abb2 226 return 0;
f0de0e8d
LT
227 seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
228 put_ldops(ldops);
01e1abb2
AC
229 return 0;
230}
231
fddda2b7 232const struct seq_operations tty_ldiscs_seq_ops = {
01e1abb2
AC
233 .start = tty_ldiscs_seq_start,
234 .next = tty_ldiscs_seq_next,
235 .stop = tty_ldiscs_seq_stop,
236 .show = tty_ldiscs_seq_show,
237};
238
01e1abb2
AC
239/**
240 * tty_ldisc_ref_wait - wait for the tty ldisc
241 * @tty: tty device
242 *
243 * Dereference the line discipline for the terminal and take a
244 * reference to it. If the line discipline is in flux then
245 * wait patiently until it changes.
246 *
892d1fa7
PH
247 * Returns: NULL if the tty has been hungup and not re-opened with
248 * a new file descriptor, otherwise valid ldisc reference
249 *
01e1abb2
AC
250 * Note: Must not be called from an IRQ/timer context. The caller
251 * must also be careful not to hold other locks that will deadlock
252 * against a discipline change, such as an existing ldisc reference
253 * (which we check for)
254 *
e55afd11
PH
255 * Note: a file_operations routine (read/poll/write) should use this
256 * function to wait for any ldisc lifetime events to finish.
01e1abb2
AC
257 */
258
259struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
260{
a4a3e061
DV
261 struct tty_ldisc *ld;
262
36697529 263 ldsem_down_read(&tty->ldisc_sem, MAX_SCHEDULE_TIMEOUT);
a4a3e061
DV
264 ld = tty->ldisc;
265 if (!ld)
a570a49a 266 ldsem_up_read(&tty->ldisc_sem);
a4a3e061 267 return ld;
01e1abb2 268}
01e1abb2
AC
269EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
270
271/**
272 * tty_ldisc_ref - get the tty ldisc
273 * @tty: tty device
274 *
275 * Dereference the line discipline for the terminal and take a
276 * reference to it. If the line discipline is in flux then
277 * return NULL. Can be called from IRQ and timer functions.
01e1abb2
AC
278 */
279
280struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
281{
36697529
PH
282 struct tty_ldisc *ld = NULL;
283
284 if (ldsem_down_read_trylock(&tty->ldisc_sem)) {
285 ld = tty->ldisc;
286 if (!ld)
287 ldsem_up_read(&tty->ldisc_sem);
288 }
289 return ld;
01e1abb2 290}
01e1abb2
AC
291EXPORT_SYMBOL_GPL(tty_ldisc_ref);
292
293/**
294 * tty_ldisc_deref - free a tty ldisc reference
295 * @ld: reference to free up
296 *
297 * Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
298 * be called in IRQ context.
01e1abb2
AC
299 */
300
301void tty_ldisc_deref(struct tty_ldisc *ld)
302{
36697529 303 ldsem_up_read(&ld->tty->ldisc_sem);
01e1abb2 304}
01e1abb2
AC
305EXPORT_SYMBOL_GPL(tty_ldisc_deref);
306
d2c43890 307
c2bb524b 308static inline int
e80a10ee 309__tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
d2c43890
PH
310{
311 return ldsem_down_write(&tty->ldisc_sem, timeout);
312}
313
c2bb524b 314static inline int
e80a10ee 315__tty_ldisc_lock_nested(struct tty_struct *tty, unsigned long timeout)
d2c43890
PH
316{
317 return ldsem_down_write_nested(&tty->ldisc_sem,
318 LDISC_SEM_OTHER, timeout);
319}
320
e80a10ee 321static inline void __tty_ldisc_unlock(struct tty_struct *tty)
d2c43890 322{
52772ea6 323 ldsem_up_write(&tty->ldisc_sem);
d2c43890
PH
324}
325
b027e229 326int tty_ldisc_lock(struct tty_struct *tty, unsigned long timeout)
fae76e9a
PH
327{
328 int ret;
329
330 ret = __tty_ldisc_lock(tty, timeout);
331 if (!ret)
332 return -EBUSY;
333 set_bit(TTY_LDISC_HALTED, &tty->flags);
334 return 0;
335}
336
b027e229 337void tty_ldisc_unlock(struct tty_struct *tty)
fae76e9a
PH
338{
339 clear_bit(TTY_LDISC_HALTED, &tty->flags);
340 __tty_ldisc_unlock(tty);
341}
342
c2bb524b 343static int
d2c43890
PH
344tty_ldisc_lock_pair_timeout(struct tty_struct *tty, struct tty_struct *tty2,
345 unsigned long timeout)
346{
347 int ret;
348
349 if (tty < tty2) {
e80a10ee 350 ret = __tty_ldisc_lock(tty, timeout);
d2c43890 351 if (ret) {
e80a10ee 352 ret = __tty_ldisc_lock_nested(tty2, timeout);
d2c43890 353 if (!ret)
e80a10ee 354 __tty_ldisc_unlock(tty);
d2c43890
PH
355 }
356 } else {
357 /* if this is possible, it has lots of implications */
358 WARN_ON_ONCE(tty == tty2);
359 if (tty2 && tty != tty2) {
e80a10ee 360 ret = __tty_ldisc_lock(tty2, timeout);
d2c43890 361 if (ret) {
e80a10ee 362 ret = __tty_ldisc_lock_nested(tty, timeout);
d2c43890 363 if (!ret)
e80a10ee 364 __tty_ldisc_unlock(tty2);
d2c43890
PH
365 }
366 } else
e80a10ee 367 ret = __tty_ldisc_lock(tty, timeout);
d2c43890
PH
368 }
369
370 if (!ret)
371 return -EBUSY;
372
373 set_bit(TTY_LDISC_HALTED, &tty->flags);
374 if (tty2)
375 set_bit(TTY_LDISC_HALTED, &tty2->flags);
376 return 0;
377}
378
c2bb524b 379static void tty_ldisc_lock_pair(struct tty_struct *tty, struct tty_struct *tty2)
d2c43890
PH
380{
381 tty_ldisc_lock_pair_timeout(tty, tty2, MAX_SCHEDULE_TIMEOUT);
382}
383
c2bb524b
PH
384static void tty_ldisc_unlock_pair(struct tty_struct *tty,
385 struct tty_struct *tty2)
d2c43890 386{
e80a10ee 387 __tty_ldisc_unlock(tty);
d2c43890 388 if (tty2)
e80a10ee 389 __tty_ldisc_unlock(tty2);
d2c43890
PH
390}
391
f2c4c65c
AC
392/**
393 * tty_ldisc_flush - flush line discipline queue
394 * @tty: tty
395 *
86c80a8e
PH
396 * Flush the line discipline queue (if any) and the tty flip buffers
397 * for this tty.
f2c4c65c
AC
398 */
399
400void tty_ldisc_flush(struct tty_struct *tty)
401{
402 struct tty_ldisc *ld = tty_ldisc_ref(tty);
86c80a8e
PH
403
404 tty_buffer_flush(tty, ld);
405 if (ld)
f2c4c65c 406 tty_ldisc_deref(ld);
f2c4c65c 407}
f2c4c65c
AC
408EXPORT_SYMBOL_GPL(tty_ldisc_flush);
409
01e1abb2
AC
410/**
411 * tty_set_termios_ldisc - set ldisc field
412 * @tty: tty structure
c12da96f 413 * @disc: line discipline number
01e1abb2
AC
414 *
415 * This is probably overkill for real world processors but
416 * they are not on hot paths so a little discipline won't do
417 * any harm.
418 *
dd42bf11
PH
419 * The line discipline-related tty_struct fields are reset to
420 * prevent the ldisc driver from re-using stale information for
421 * the new ldisc instance.
422 *
6a1c0680 423 * Locking: takes termios_rwsem
01e1abb2
AC
424 */
425
c12da96f 426static void tty_set_termios_ldisc(struct tty_struct *tty, int disc)
01e1abb2 427{
6a1c0680 428 down_write(&tty->termios_rwsem);
c12da96f 429 tty->termios.c_line = disc;
6a1c0680 430 up_write(&tty->termios_rwsem);
dd42bf11
PH
431
432 tty->disc_data = NULL;
433 tty->receive_room = 0;
01e1abb2
AC
434}
435
c65c9bc3
AC
436/**
437 * tty_ldisc_open - open a line discipline
438 * @tty: tty we are opening the ldisc on
439 * @ld: discipline to open
440 *
441 * A helper opening method. Also a convenient debugging and check
442 * point.
ec79d605
AB
443 *
444 * Locking: always called with BTM already held.
c65c9bc3
AC
445 */
446
447static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
448{
449 WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
f18f9498
AC
450 if (ld->ops->open) {
451 int ret;
ec79d605 452 /* BTM here locks versus a hangup event */
f18f9498 453 ret = ld->ops->open(tty);
7f90cfc5
JS
454 if (ret)
455 clear_bit(TTY_LDISC_OPEN, &tty->flags);
fb6edc91 456
a570a49a 457 tty_ldisc_debug(tty, "%p: opened\n", ld);
f18f9498
AC
458 return ret;
459 }
c65c9bc3
AC
460 return 0;
461}
462
463/**
464 * tty_ldisc_close - close a line discipline
465 * @tty: tty we are opening the ldisc on
466 * @ld: discipline to close
467 *
468 * A helper close method. Also a convenient debugging and check
469 * point.
470 */
471
472static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
473{
474 WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
475 clear_bit(TTY_LDISC_OPEN, &tty->flags);
476 if (ld->ops->close)
477 ld->ops->close(tty);
a570a49a 478 tty_ldisc_debug(tty, "%p: closed\n", ld);
c65c9bc3 479}
01e1abb2 480
8a8dabf2
AC
481/**
482 * tty_ldisc_failto - helper for ldisc failback
483 * @tty: tty to open the ldisc on
484 * @ld: ldisc we are trying to fail back to
485 *
486 * Helper to try and recover a tty when switching back to the old
487 * ldisc fails and we need something attached.
488 */
489
490static int tty_ldisc_failto(struct tty_struct *tty, int ld)
491{
492 struct tty_ldisc *disc = tty_ldisc_get(tty, ld);
493 int r;
494
495 if (IS_ERR(disc))
496 return PTR_ERR(disc);
497 tty->ldisc = disc;
498 tty_set_termios_ldisc(tty, ld);
499 if ((r = tty_ldisc_open(tty, disc)) < 0)
500 tty_ldisc_put(disc);
501 return r;
502}
503
a8983d01
GKH
504/**
505 * tty_ldisc_restore - helper for tty ldisc change
506 * @tty: tty to recover
507 * @old: previous ldisc
508 *
509 * Restore the previous line discipline or N_TTY when a line discipline
510 * change fails due to an open error
511 */
512
513static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
514{
a8983d01 515 /* There is an outstanding reference here so this is safe */
598c2d41
TH
516 if (tty_ldisc_failto(tty, old->ops->num) < 0) {
517 const char *name = tty_name(tty);
518
519 pr_warn("Falling back ldisc for %s.\n", name);
8a8dabf2
AC
520 /* The traditional behaviour is to fall back to N_TTY, we
521 want to avoid falling back to N_NULL unless we have no
522 choice to avoid the risk of breaking anything */
523 if (tty_ldisc_failto(tty, N_TTY) < 0 &&
524 tty_ldisc_failto(tty, N_NULL) < 0)
598c2d41 525 panic("Couldn't open N_NULL ldisc for %s.", name);
a8983d01
GKH
526 }
527}
528
01e1abb2
AC
529/**
530 * tty_set_ldisc - set line discipline
531 * @tty: the terminal to set
532 * @ldisc: the line discipline
533 *
534 * Set the discipline of a tty line. Must be called from a process
c65c9bc3
AC
535 * context. The ldisc change logic has to protect itself against any
536 * overlapping ldisc change (including on the other end of pty pairs),
537 * the close of one side of a tty/pty pair, and eventually hangup.
01e1abb2
AC
538 */
539
c12da96f 540int tty_set_ldisc(struct tty_struct *tty, int disc)
01e1abb2 541{
a8983d01
GKH
542 int retval;
543 struct tty_ldisc *old_ldisc, *new_ldisc;
544
545 new_ldisc = tty_ldisc_get(tty, disc);
546 if (IS_ERR(new_ldisc))
547 return PTR_ERR(new_ldisc);
01e1abb2 548
c8483bc9 549 tty_lock(tty);
276a661a 550 retval = tty_ldisc_lock(tty, 5 * HZ);
63d8cb3f
PH
551 if (retval)
552 goto err;
01e1abb2 553
a570a49a
PH
554 if (!tty->ldisc) {
555 retval = -EIO;
556 goto out;
557 }
558
63d8cb3f 559 /* Check the no-op case */
a8983d01 560 if (tty->ldisc->ops->num == disc)
63d8cb3f 561 goto out;
c65c9bc3 562
63d8cb3f
PH
563 if (test_bit(TTY_HUPPED, &tty->flags)) {
564 /* We were raced by hangup */
565 retval = -EIO;
566 goto out;
01e1abb2
AC
567 }
568
a8983d01
GKH
569 old_ldisc = tty->ldisc;
570
571 /* Shutdown the old discipline. */
572 tty_ldisc_close(tty, old_ldisc);
573
574 /* Now set up the new line discipline. */
575 tty->ldisc = new_ldisc;
576 tty_set_termios_ldisc(tty, disc);
577
578 retval = tty_ldisc_open(tty, new_ldisc);
01e1abb2 579 if (retval < 0) {
c65c9bc3 580 /* Back to the old one or N_TTY if we can't */
a8983d01
GKH
581 tty_ldisc_put(new_ldisc);
582 tty_ldisc_restore(tty, old_ldisc);
01e1abb2 583 }
c65c9bc3 584
a8983d01 585 if (tty->ldisc->ops->num != old_ldisc->ops->num && tty->ops->set_ldisc) {
9191aaaa 586 down_read(&tty->termios_rwsem);
01e1abb2 587 tty->ops->set_ldisc(tty);
9191aaaa
PH
588 up_read(&tty->termios_rwsem);
589 }
01e1abb2 590
a8983d01
GKH
591 /* At this point we hold a reference to the new ldisc and a
592 reference to the old ldisc, or we hold two references to
593 the old ldisc (if it was restored as part of error cleanup
594 above). In either case, releasing a single reference from
595 the old ldisc is correct. */
596 new_ldisc = old_ldisc;
63d8cb3f 597out:
276a661a 598 tty_ldisc_unlock(tty);
01e1abb2 599
c65c9bc3 600 /* Restart the work queue in case no characters kick it off. Safe if
01e1abb2 601 already running */
17a69219 602 tty_buffer_restart_work(tty->port);
63d8cb3f 603err:
a8983d01 604 tty_ldisc_put(new_ldisc); /* drop the extra reference */
89c8d91e 605 tty_unlock(tty);
01e1abb2
AC
606 return retval;
607}
1ab92da3 608EXPORT_SYMBOL_GPL(tty_set_ldisc);
01e1abb2 609
6ffeb4b2
PH
610/**
611 * tty_ldisc_kill - teardown ldisc
612 * @tty: tty being released
613 *
614 * Perform final close of the ldisc and reset tty->ldisc
615 */
616static void tty_ldisc_kill(struct tty_struct *tty)
617{
618 if (!tty->ldisc)
619 return;
620 /*
621 * Now kill off the ldisc
622 */
623 tty_ldisc_close(tty, tty->ldisc);
624 tty_ldisc_put(tty->ldisc);
625 /* Force an oops if we mess this up */
626 tty->ldisc = NULL;
627}
628
c65c9bc3
AC
629/**
630 * tty_reset_termios - reset terminal state
631 * @tty: tty to reset
632 *
633 * Restore a terminal to the driver default state.
634 */
635
636static void tty_reset_termios(struct tty_struct *tty)
637{
6a1c0680 638 down_write(&tty->termios_rwsem);
adc8d746
AC
639 tty->termios = tty->driver->init_termios;
640 tty->termios.c_ispeed = tty_termios_input_baud_rate(&tty->termios);
641 tty->termios.c_ospeed = tty_termios_baud_rate(&tty->termios);
6a1c0680 642 up_write(&tty->termios_rwsem);
c65c9bc3
AC
643}
644
645
646/**
647 * tty_ldisc_reinit - reinitialise the tty ldisc
648 * @tty: tty to reinit
c12da96f 649 * @disc: line discipline to reinitialize
c65c9bc3 650 *
7896f30d 651 * Completely reinitialize the line discipline state, by closing the
892d1fa7
PH
652 * current instance, if there is one, and opening a new instance. If
653 * an error occurs opening the new non-N_TTY instance, the instance
654 * is dropped and tty->ldisc reset to NULL. The caller can then retry
655 * with N_TTY instead.
7896f30d
PH
656 *
657 * Returns 0 if successful, otherwise error code < 0
c65c9bc3
AC
658 */
659
892d1fa7 660int tty_ldisc_reinit(struct tty_struct *tty, int disc)
c65c9bc3 661{
7896f30d
PH
662 struct tty_ldisc *ld;
663 int retval;
1c95ba1e 664
7896f30d 665 ld = tty_ldisc_get(tty, disc);
a8983d01
GKH
666 if (IS_ERR(ld)) {
667 BUG_ON(disc == N_TTY);
7896f30d 668 return PTR_ERR(ld);
a8983d01 669 }
c65c9bc3 670
7896f30d
PH
671 if (tty->ldisc) {
672 tty_ldisc_close(tty, tty->ldisc);
673 tty_ldisc_put(tty->ldisc);
674 }
675
676 /* switch the line discipline */
f4807045 677 tty->ldisc = ld;
c12da96f 678 tty_set_termios_ldisc(tty, disc);
7896f30d
PH
679 retval = tty_ldisc_open(tty, tty->ldisc);
680 if (retval) {
e65c62b1
JW
681 tty_ldisc_put(tty->ldisc);
682 tty->ldisc = NULL;
7896f30d
PH
683 }
684 return retval;
c65c9bc3
AC
685}
686
687/**
688 * tty_ldisc_hangup - hangup ldisc reset
689 * @tty: tty being hung up
690 *
691 * Some tty devices reset their termios when they receive a hangup
692 * event. In that situation we must also switch back to N_TTY properly
693 * before we reset the termios data.
694 *
695 * Locking: We can take the ldisc mutex as the rest of the code is
696 * careful to allow for this.
697 *
698 * In the pty pair case this occurs in the close() path of the
699 * tty itself so we must be careful about locking rules.
700 */
701
892d1fa7 702void tty_ldisc_hangup(struct tty_struct *tty, bool reinit)
c65c9bc3
AC
703{
704 struct tty_ldisc *ld;
705
a570a49a 706 tty_ldisc_debug(tty, "%p: hangup\n", tty->ldisc);
fc575ee6 707
c65c9bc3
AC
708 ld = tty_ldisc_ref(tty);
709 if (ld != NULL) {
c65c9bc3
AC
710 if (ld->ops->flush_buffer)
711 ld->ops->flush_buffer(tty);
712 tty_driver_flush_buffer(tty);
713 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
714 ld->ops->write_wakeup)
715 ld->ops->write_wakeup(tty);
716 if (ld->ops->hangup)
717 ld->ops->hangup(tty);
718 tty_ldisc_deref(ld);
719 }
36697529 720
a9a08845
LT
721 wake_up_interruptible_poll(&tty->write_wait, EPOLLOUT);
722 wake_up_interruptible_poll(&tty->read_wait, EPOLLIN);
36697529 723
c65c9bc3
AC
724 /*
725 * Shutdown the current line discipline, and reset it to
638b9648
AC
726 * N_TTY if need be.
727 *
728 * Avoid racing set_ldisc or tty_ldisc_release
c65c9bc3 729 */
fae76e9a 730 tty_ldisc_lock(tty, MAX_SCHEDULE_TIMEOUT);
60af22d2 731
892d1fa7
PH
732 if (tty->driver->flags & TTY_DRIVER_RESET_TERMIOS)
733 tty_reset_termios(tty);
c8785241 734
892d1fa7
PH
735 if (tty->ldisc) {
736 if (reinit) {
e65c62b1
JW
737 if (tty_ldisc_reinit(tty, tty->termios.c_line) < 0 &&
738 tty_ldisc_reinit(tty, N_TTY) < 0)
739 WARN_ON(tty_ldisc_reinit(tty, N_NULL) < 0);
892d1fa7
PH
740 } else
741 tty_ldisc_kill(tty);
c65c9bc3 742 }
fae76e9a 743 tty_ldisc_unlock(tty);
c65c9bc3 744}
01e1abb2
AC
745
746/**
747 * tty_ldisc_setup - open line discipline
748 * @tty: tty being shut down
749 * @o_tty: pair tty for pty/tty pairs
750 *
751 * Called during the initial open of a tty/pty pair in order to set up the
c65c9bc3
AC
752 * line disciplines and bind them to the tty. This has no locking issues
753 * as the device isn't yet active.
01e1abb2
AC
754 */
755
756int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
757{
9de2a7ce 758 int retval = tty_ldisc_open(tty, tty->ldisc);
c65c9bc3
AC
759 if (retval)
760 return retval;
761
762 if (o_tty) {
763 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
01e1abb2 764 if (retval) {
9de2a7ce 765 tty_ldisc_close(tty, tty->ldisc);
01e1abb2
AC
766 return retval;
767 }
01e1abb2 768 }
01e1abb2
AC
769 return 0;
770}
89c8d91e 771
01e1abb2
AC
772/**
773 * tty_ldisc_release - release line discipline
62462aef 774 * @tty: tty being shut down (or one end of pty pair)
3ee175d9 775 *
62462aef 776 * Called during the final close of a tty or a pty pair in order to shut
5b6e6832 777 * down the line discpline layer. On exit, each tty's ldisc is NULL.
01e1abb2
AC
778 */
779
62462aef 780void tty_ldisc_release(struct tty_struct *tty)
01e1abb2 781{
62462aef
PH
782 struct tty_struct *o_tty = tty->link;
783
01e1abb2 784 /*
a2965b7b
PH
785 * Shutdown this line discipline. As this is the final close,
786 * it does not race with the set_ldisc code path.
01e1abb2 787 */
01e1abb2 788
36697529 789 tty_ldisc_lock_pair(tty, o_tty);
89c8d91e 790 tty_ldisc_kill(tty);
c65c9bc3 791 if (o_tty)
89c8d91e 792 tty_ldisc_kill(o_tty);
36697529
PH
793 tty_ldisc_unlock_pair(tty, o_tty);
794
aef29bc2
AC
795 /* And the memory resources remaining (buffers, termios) will be
796 disposed of when the kref hits zero */
fc575ee6 797
fb6edc91 798 tty_ldisc_debug(tty, "released\n");
01e1abb2 799}
1ab92da3 800EXPORT_SYMBOL_GPL(tty_ldisc_release);
01e1abb2
AC
801
802/**
803 * tty_ldisc_init - ldisc setup for new tty
804 * @tty: tty being allocated
805 *
806 * Set up the line discipline objects for a newly allocated tty. Note that
807 * the tty structure is not completely set up when this call is made.
808 */
809
903f9db1 810int tty_ldisc_init(struct tty_struct *tty)
01e1abb2 811{
36697529 812 struct tty_ldisc *ld = tty_ldisc_get(tty, N_TTY);
c65c9bc3 813 if (IS_ERR(ld))
903f9db1 814 return PTR_ERR(ld);
f4807045 815 tty->ldisc = ld;
903f9db1 816 return 0;
01e1abb2
AC
817}
818
6716671d 819/**
c8b710b3 820 * tty_ldisc_deinit - ldisc cleanup for new tty
6716671d
JS
821 * @tty: tty that was allocated recently
822 *
823 * The tty structure must not becompletely set up (tty_ldisc_setup) when
824 * this call is made.
825 */
826void tty_ldisc_deinit(struct tty_struct *tty)
827{
c8b710b3
PH
828 if (tty->ldisc)
829 tty_ldisc_put(tty->ldisc);
f4807045 830 tty->ldisc = NULL;
6716671d 831}