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