isdn/gigaset: reset tty->receive_room when attaching ser_gigaset
[pandora-kernel.git] / drivers / tty / tty_ldisc.c
1 #include <linux/types.h>
2 #include <linux/major.h>
3 #include <linux/errno.h>
4 #include <linux/signal.h>
5 #include <linux/fcntl.h>
6 #include <linux/sched.h>
7 #include <linux/interrupt.h>
8 #include <linux/tty.h>
9 #include <linux/tty_driver.h>
10 #include <linux/tty_flip.h>
11 #include <linux/devpts_fs.h>
12 #include <linux/file.h>
13 #include <linux/console.h>
14 #include <linux/timer.h>
15 #include <linux/ctype.h>
16 #include <linux/kd.h>
17 #include <linux/mm.h>
18 #include <linux/string.h>
19 #include <linux/slab.h>
20 #include <linux/poll.h>
21 #include <linux/proc_fs.h>
22 #include <linux/init.h>
23 #include <linux/module.h>
24 #include <linux/device.h>
25 #include <linux/wait.h>
26 #include <linux/bitops.h>
27 #include <linux/delay.h>
28 #include <linux/seq_file.h>
29
30 #include <linux/uaccess.h>
31 #include <asm/system.h>
32
33 #include <linux/kbd_kern.h>
34 #include <linux/vt_kern.h>
35 #include <linux/selection.h>
36
37 #include <linux/kmod.h>
38 #include <linux/nsproxy.h>
39 #include <linux/ratelimit.h>
40
41 /*
42  *      This guards the refcounted line discipline lists. The lock
43  *      must be taken with irqs off because there are hangup path
44  *      callers who will do ldisc lookups and cannot sleep.
45  */
46
47 static DEFINE_SPINLOCK(tty_ldisc_lock);
48 static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_wait);
49 static DECLARE_WAIT_QUEUE_HEAD(tty_ldisc_idle);
50 /* Line disc dispatch table */
51 static struct tty_ldisc_ops *tty_ldiscs[NR_LDISCS];
52
53 static inline struct tty_ldisc *get_ldisc(struct tty_ldisc *ld)
54 {
55         if (ld)
56                 atomic_inc(&ld->users);
57         return ld;
58 }
59
60 static void put_ldisc(struct tty_ldisc *ld)
61 {
62         unsigned long flags;
63
64         if (WARN_ON_ONCE(!ld))
65                 return;
66
67         /*
68          * If this is the last user, free the ldisc, and
69          * release the ldisc ops.
70          *
71          * We really want an "atomic_dec_and_lock_irqsave()",
72          * but we don't have it, so this does it by hand.
73          */
74         local_irq_save(flags);
75         if (atomic_dec_and_lock(&ld->users, &tty_ldisc_lock)) {
76                 struct tty_ldisc_ops *ldo = ld->ops;
77
78                 ldo->refcount--;
79                 module_put(ldo->owner);
80                 spin_unlock_irqrestore(&tty_ldisc_lock, flags);
81
82                 kfree(ld);
83                 return;
84         }
85         local_irq_restore(flags);
86         wake_up(&tty_ldisc_idle);
87 }
88
89 /**
90  *      tty_register_ldisc      -       install a line discipline
91  *      @disc: ldisc number
92  *      @new_ldisc: pointer to the ldisc object
93  *
94  *      Installs a new line discipline into the kernel. The discipline
95  *      is set up as unreferenced and then made available to the kernel
96  *      from this point onwards.
97  *
98  *      Locking:
99  *              takes tty_ldisc_lock to guard against ldisc races
100  */
101
102 int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc)
103 {
104         unsigned long flags;
105         int ret = 0;
106
107         if (disc < N_TTY || disc >= NR_LDISCS)
108                 return -EINVAL;
109
110         spin_lock_irqsave(&tty_ldisc_lock, flags);
111         tty_ldiscs[disc] = new_ldisc;
112         new_ldisc->num = disc;
113         new_ldisc->refcount = 0;
114         spin_unlock_irqrestore(&tty_ldisc_lock, flags);
115
116         return ret;
117 }
118 EXPORT_SYMBOL(tty_register_ldisc);
119
120 /**
121  *      tty_unregister_ldisc    -       unload a line discipline
122  *      @disc: ldisc number
123  *      @new_ldisc: pointer to the ldisc object
124  *
125  *      Remove a line discipline from the kernel providing it is not
126  *      currently in use.
127  *
128  *      Locking:
129  *              takes tty_ldisc_lock to guard against ldisc races
130  */
131
132 int tty_unregister_ldisc(int disc)
133 {
134         unsigned long flags;
135         int ret = 0;
136
137         if (disc < N_TTY || disc >= NR_LDISCS)
138                 return -EINVAL;
139
140         spin_lock_irqsave(&tty_ldisc_lock, flags);
141         if (tty_ldiscs[disc]->refcount)
142                 ret = -EBUSY;
143         else
144                 tty_ldiscs[disc] = NULL;
145         spin_unlock_irqrestore(&tty_ldisc_lock, flags);
146
147         return ret;
148 }
149 EXPORT_SYMBOL(tty_unregister_ldisc);
150
151 static struct tty_ldisc_ops *get_ldops(int disc)
152 {
153         unsigned long flags;
154         struct tty_ldisc_ops *ldops, *ret;
155
156         spin_lock_irqsave(&tty_ldisc_lock, flags);
157         ret = ERR_PTR(-EINVAL);
158         ldops = tty_ldiscs[disc];
159         if (ldops) {
160                 ret = ERR_PTR(-EAGAIN);
161                 if (try_module_get(ldops->owner)) {
162                         ldops->refcount++;
163                         ret = ldops;
164                 }
165         }
166         spin_unlock_irqrestore(&tty_ldisc_lock, flags);
167         return ret;
168 }
169
170 static void put_ldops(struct tty_ldisc_ops *ldops)
171 {
172         unsigned long flags;
173
174         spin_lock_irqsave(&tty_ldisc_lock, flags);
175         ldops->refcount--;
176         module_put(ldops->owner);
177         spin_unlock_irqrestore(&tty_ldisc_lock, flags);
178 }
179
180 /**
181  *      tty_ldisc_get           -       take a reference to an ldisc
182  *      @disc: ldisc number
183  *
184  *      Takes a reference to a line discipline. Deals with refcounts and
185  *      module locking counts. Returns NULL if the discipline is not available.
186  *      Returns a pointer to the discipline and bumps the ref count if it is
187  *      available
188  *
189  *      Locking:
190  *              takes tty_ldisc_lock to guard against ldisc races
191  */
192
193 static struct tty_ldisc *tty_ldisc_get(int disc)
194 {
195         struct tty_ldisc *ld;
196         struct tty_ldisc_ops *ldops;
197
198         if (disc < N_TTY || disc >= NR_LDISCS)
199                 return ERR_PTR(-EINVAL);
200
201         /*
202          * Get the ldisc ops - we may need to request them to be loaded
203          * dynamically and try again.
204          */
205         ldops = get_ldops(disc);
206         if (IS_ERR(ldops)) {
207                 request_module("tty-ldisc-%d", disc);
208                 ldops = get_ldops(disc);
209                 if (IS_ERR(ldops))
210                         return ERR_CAST(ldops);
211         }
212
213         ld = kmalloc(sizeof(struct tty_ldisc), GFP_KERNEL);
214         if (ld == NULL) {
215                 put_ldops(ldops);
216                 return ERR_PTR(-ENOMEM);
217         }
218
219         ld->ops = ldops;
220         atomic_set(&ld->users, 1);
221         return ld;
222 }
223
224 static void *tty_ldiscs_seq_start(struct seq_file *m, loff_t *pos)
225 {
226         return (*pos < NR_LDISCS) ? pos : NULL;
227 }
228
229 static void *tty_ldiscs_seq_next(struct seq_file *m, void *v, loff_t *pos)
230 {
231         (*pos)++;
232         return (*pos < NR_LDISCS) ? pos : NULL;
233 }
234
235 static void tty_ldiscs_seq_stop(struct seq_file *m, void *v)
236 {
237 }
238
239 static int tty_ldiscs_seq_show(struct seq_file *m, void *v)
240 {
241         int i = *(loff_t *)v;
242         struct tty_ldisc_ops *ldops;
243
244         ldops = get_ldops(i);
245         if (IS_ERR(ldops))
246                 return 0;
247         seq_printf(m, "%-10s %2d\n", ldops->name ? ldops->name : "???", i);
248         put_ldops(ldops);
249         return 0;
250 }
251
252 static const struct seq_operations tty_ldiscs_seq_ops = {
253         .start  = tty_ldiscs_seq_start,
254         .next   = tty_ldiscs_seq_next,
255         .stop   = tty_ldiscs_seq_stop,
256         .show   = tty_ldiscs_seq_show,
257 };
258
259 static int proc_tty_ldiscs_open(struct inode *inode, struct file *file)
260 {
261         return seq_open(file, &tty_ldiscs_seq_ops);
262 }
263
264 const struct file_operations tty_ldiscs_proc_fops = {
265         .owner          = THIS_MODULE,
266         .open           = proc_tty_ldiscs_open,
267         .read           = seq_read,
268         .llseek         = seq_lseek,
269         .release        = seq_release,
270 };
271
272 /**
273  *      tty_ldisc_assign        -       set ldisc on a tty
274  *      @tty: tty to assign
275  *      @ld: line discipline
276  *
277  *      Install an instance of a line discipline into a tty structure. The
278  *      ldisc must have a reference count above zero to ensure it remains.
279  *      The tty instance refcount starts at zero.
280  *
281  *      Locking:
282  *              Caller must hold references
283  */
284
285 static void tty_ldisc_assign(struct tty_struct *tty, struct tty_ldisc *ld)
286 {
287         tty->ldisc = ld;
288 }
289
290 /**
291  *      tty_ldisc_try           -       internal helper
292  *      @tty: the tty
293  *
294  *      Make a single attempt to grab and bump the refcount on
295  *      the tty ldisc. Return 0 on failure or 1 on success. This is
296  *      used to implement both the waiting and non waiting versions
297  *      of tty_ldisc_ref
298  *
299  *      Locking: takes tty_ldisc_lock
300  */
301
302 static struct tty_ldisc *tty_ldisc_try(struct tty_struct *tty)
303 {
304         unsigned long flags;
305         struct tty_ldisc *ld;
306
307         spin_lock_irqsave(&tty_ldisc_lock, flags);
308         ld = NULL;
309         if (test_bit(TTY_LDISC, &tty->flags))
310                 ld = get_ldisc(tty->ldisc);
311         spin_unlock_irqrestore(&tty_ldisc_lock, flags);
312         return ld;
313 }
314
315 /**
316  *      tty_ldisc_ref_wait      -       wait for the tty ldisc
317  *      @tty: tty device
318  *
319  *      Dereference the line discipline for the terminal and take a
320  *      reference to it. If the line discipline is in flux then
321  *      wait patiently until it changes.
322  *
323  *      Note: Must not be called from an IRQ/timer context. The caller
324  *      must also be careful not to hold other locks that will deadlock
325  *      against a discipline change, such as an existing ldisc reference
326  *      (which we check for)
327  *
328  *      Locking: call functions take tty_ldisc_lock
329  */
330
331 struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *tty)
332 {
333         struct tty_ldisc *ld;
334
335         /* wait_event is a macro */
336         wait_event(tty_ldisc_wait, (ld = tty_ldisc_try(tty)) != NULL);
337         return ld;
338 }
339 EXPORT_SYMBOL_GPL(tty_ldisc_ref_wait);
340
341 /**
342  *      tty_ldisc_ref           -       get the tty ldisc
343  *      @tty: tty device
344  *
345  *      Dereference the line discipline for the terminal and take a
346  *      reference to it. If the line discipline is in flux then
347  *      return NULL. Can be called from IRQ and timer functions.
348  *
349  *      Locking: called functions take tty_ldisc_lock
350  */
351
352 struct tty_ldisc *tty_ldisc_ref(struct tty_struct *tty)
353 {
354         return tty_ldisc_try(tty);
355 }
356 EXPORT_SYMBOL_GPL(tty_ldisc_ref);
357
358 /**
359  *      tty_ldisc_deref         -       free a tty ldisc reference
360  *      @ld: reference to free up
361  *
362  *      Undoes the effect of tty_ldisc_ref or tty_ldisc_ref_wait. May
363  *      be called in IRQ context.
364  *
365  *      Locking: takes tty_ldisc_lock
366  */
367
368 void tty_ldisc_deref(struct tty_ldisc *ld)
369 {
370         put_ldisc(ld);
371 }
372 EXPORT_SYMBOL_GPL(tty_ldisc_deref);
373
374 static inline void tty_ldisc_put(struct tty_ldisc *ld)
375 {
376         put_ldisc(ld);
377 }
378
379 /**
380  *      tty_ldisc_enable        -       allow ldisc use
381  *      @tty: terminal to activate ldisc on
382  *
383  *      Set the TTY_LDISC flag when the line discipline can be called
384  *      again. Do necessary wakeups for existing sleepers. Clear the LDISC
385  *      changing flag to indicate any ldisc change is now over.
386  *
387  *      Note: nobody should set the TTY_LDISC bit except via this function.
388  *      Clearing directly is allowed.
389  */
390
391 void tty_ldisc_enable(struct tty_struct *tty)
392 {
393         set_bit(TTY_LDISC, &tty->flags);
394         clear_bit(TTY_LDISC_CHANGING, &tty->flags);
395         wake_up(&tty_ldisc_wait);
396 }
397
398 /**
399  *      tty_ldisc_flush -       flush line discipline queue
400  *      @tty: tty
401  *
402  *      Flush the line discipline queue (if any) for this tty. If there
403  *      is no line discipline active this is a no-op.
404  */
405
406 void tty_ldisc_flush(struct tty_struct *tty)
407 {
408         struct tty_ldisc *ld = tty_ldisc_ref(tty);
409         if (ld) {
410                 if (ld->ops->flush_buffer)
411                         ld->ops->flush_buffer(tty);
412                 tty_ldisc_deref(ld);
413         }
414         tty_buffer_flush(tty);
415 }
416 EXPORT_SYMBOL_GPL(tty_ldisc_flush);
417
418 /**
419  *      tty_set_termios_ldisc           -       set ldisc field
420  *      @tty: tty structure
421  *      @num: line discipline number
422  *
423  *      This is probably overkill for real world processors but
424  *      they are not on hot paths so a little discipline won't do
425  *      any harm.
426  *
427  *      Locking: takes termios_mutex
428  */
429
430 static void tty_set_termios_ldisc(struct tty_struct *tty, int num)
431 {
432         mutex_lock(&tty->termios_mutex);
433         tty->termios->c_line = num;
434         mutex_unlock(&tty->termios_mutex);
435 }
436
437 /**
438  *      tty_ldisc_open          -       open a line discipline
439  *      @tty: tty we are opening the ldisc on
440  *      @ld: discipline to open
441  *
442  *      A helper opening method. Also a convenient debugging and check
443  *      point.
444  *
445  *      Locking: always called with BTM already held.
446  */
447
448 static int tty_ldisc_open(struct tty_struct *tty, struct tty_ldisc *ld)
449 {
450         WARN_ON(test_and_set_bit(TTY_LDISC_OPEN, &tty->flags));
451         if (ld->ops->open) {
452                 int ret;
453                 /* BTM here locks versus a hangup event */
454                 ret = ld->ops->open(tty);
455                 if (ret)
456                         clear_bit(TTY_LDISC_OPEN, &tty->flags);
457                 return ret;
458         }
459         return 0;
460 }
461
462 /**
463  *      tty_ldisc_close         -       close a line discipline
464  *      @tty: tty we are opening the ldisc on
465  *      @ld: discipline to close
466  *
467  *      A helper close method. Also a convenient debugging and check
468  *      point.
469  */
470
471 static void tty_ldisc_close(struct tty_struct *tty, struct tty_ldisc *ld)
472 {
473         WARN_ON(!test_bit(TTY_LDISC_OPEN, &tty->flags));
474         clear_bit(TTY_LDISC_OPEN, &tty->flags);
475         if (ld->ops->close)
476                 ld->ops->close(tty);
477 }
478
479 /**
480  *      tty_ldisc_restore       -       helper for tty ldisc change
481  *      @tty: tty to recover
482  *      @old: previous ldisc
483  *
484  *      Restore the previous line discipline or N_TTY when a line discipline
485  *      change fails due to an open error
486  */
487
488 static void tty_ldisc_restore(struct tty_struct *tty, struct tty_ldisc *old)
489 {
490         char buf[64];
491         struct tty_ldisc *new_ldisc;
492         int r;
493
494         /* There is an outstanding reference here so this is safe */
495         old = tty_ldisc_get(old->ops->num);
496         WARN_ON(IS_ERR(old));
497         tty_ldisc_assign(tty, old);
498         tty_set_termios_ldisc(tty, old->ops->num);
499         if (tty_ldisc_open(tty, old) < 0) {
500                 tty_ldisc_put(old);
501                 /* This driver is always present */
502                 new_ldisc = tty_ldisc_get(N_TTY);
503                 if (IS_ERR(new_ldisc))
504                         panic("n_tty: get");
505                 tty_ldisc_assign(tty, new_ldisc);
506                 tty_set_termios_ldisc(tty, N_TTY);
507                 r = tty_ldisc_open(tty, new_ldisc);
508                 if (r < 0)
509                         panic("Couldn't open N_TTY ldisc for "
510                               "%s --- error %d.",
511                               tty_name(tty, buf), r);
512         }
513 }
514
515 /**
516  *      tty_ldisc_halt          -       shut down the line discipline
517  *      @tty: tty device
518  *
519  *      Shut down the line discipline and work queue for this tty device.
520  *      The TTY_LDISC flag being cleared ensures no further references can
521  *      be obtained while the delayed work queue halt ensures that no more
522  *      data is fed to the ldisc.
523  *
524  *      You need to do a 'flush_scheduled_work()' (outside the ldisc_mutex)
525  *      in order to make sure any currently executing ldisc work is also
526  *      flushed.
527  */
528
529 static int tty_ldisc_halt(struct tty_struct *tty)
530 {
531         clear_bit(TTY_LDISC, &tty->flags);
532         return cancel_work_sync(&tty->buf.work);
533 }
534
535 /**
536  *      tty_ldisc_flush_works   -       flush all works of a tty
537  *      @tty: tty device to flush works for
538  *
539  *      Sync flush all works belonging to @tty.
540  */
541 static void tty_ldisc_flush_works(struct tty_struct *tty)
542 {
543         flush_work_sync(&tty->hangup_work);
544         flush_work_sync(&tty->SAK_work);
545         flush_work_sync(&tty->buf.work);
546 }
547
548 /**
549  *      tty_ldisc_wait_idle     -       wait for the ldisc to become idle
550  *      @tty: tty to wait for
551  *      @timeout: for how long to wait at most
552  *
553  *      Wait for the line discipline to become idle. The discipline must
554  *      have been halted for this to guarantee it remains idle.
555  */
556 static int tty_ldisc_wait_idle(struct tty_struct *tty, long timeout)
557 {
558         long ret;
559         ret = wait_event_timeout(tty_ldisc_idle,
560                         atomic_read(&tty->ldisc->users) == 1, timeout);
561         if (ret < 0)
562                 return ret;
563         return ret > 0 ? 0 : -EBUSY;
564 }
565
566 /**
567  *      tty_set_ldisc           -       set line discipline
568  *      @tty: the terminal to set
569  *      @ldisc: the line discipline
570  *
571  *      Set the discipline of a tty line. Must be called from a process
572  *      context. The ldisc change logic has to protect itself against any
573  *      overlapping ldisc change (including on the other end of pty pairs),
574  *      the close of one side of a tty/pty pair, and eventually hangup.
575  *
576  *      Locking: takes tty_ldisc_lock, termios_mutex
577  */
578
579 int tty_set_ldisc(struct tty_struct *tty, int ldisc)
580 {
581         int retval;
582         struct tty_ldisc *o_ldisc, *new_ldisc;
583         int work, o_work = 0;
584         struct tty_struct *o_tty;
585
586         new_ldisc = tty_ldisc_get(ldisc);
587         if (IS_ERR(new_ldisc))
588                 return PTR_ERR(new_ldisc);
589
590         tty_lock();
591         /*
592          *      We need to look at the tty locking here for pty/tty pairs
593          *      when both sides try to change in parallel.
594          */
595
596         o_tty = tty->link;      /* o_tty is the pty side or NULL */
597
598
599         /*
600          *      Check the no-op case
601          */
602
603         if (tty->ldisc->ops->num == ldisc) {
604                 tty_unlock();
605                 tty_ldisc_put(new_ldisc);
606                 return 0;
607         }
608
609         tty_unlock();
610         /*
611          *      Problem: What do we do if this blocks ?
612          *      We could deadlock here
613          */
614
615         tty_wait_until_sent(tty, 0);
616
617         tty_lock();
618         mutex_lock(&tty->ldisc_mutex);
619
620         /*
621          *      We could be midstream of another ldisc change which has
622          *      dropped the lock during processing. If so we need to wait.
623          */
624
625         while (test_bit(TTY_LDISC_CHANGING, &tty->flags)) {
626                 mutex_unlock(&tty->ldisc_mutex);
627                 tty_unlock();
628                 wait_event(tty_ldisc_wait,
629                         test_bit(TTY_LDISC_CHANGING, &tty->flags) == 0);
630                 tty_lock();
631                 mutex_lock(&tty->ldisc_mutex);
632         }
633
634         set_bit(TTY_LDISC_CHANGING, &tty->flags);
635
636         /*
637          *      No more input please, we are switching. The new ldisc
638          *      will update this value in the ldisc open function
639          */
640
641         tty->receive_room = 0;
642
643         o_ldisc = tty->ldisc;
644
645         tty_unlock();
646         /*
647          *      Make sure we don't change while someone holds a
648          *      reference to the line discipline. The TTY_LDISC bit
649          *      prevents anyone taking a reference once it is clear.
650          *      We need the lock to avoid racing reference takers.
651          *
652          *      We must clear the TTY_LDISC bit here to avoid a livelock
653          *      with a userspace app continually trying to use the tty in
654          *      parallel to the change and re-referencing the tty.
655          */
656
657         work = tty_ldisc_halt(tty);
658         if (o_tty)
659                 o_work = tty_ldisc_halt(o_tty);
660
661         /*
662          * Wait for ->hangup_work and ->buf.work handlers to terminate.
663          * We must drop the mutex here in case a hangup is also in process.
664          */
665
666         mutex_unlock(&tty->ldisc_mutex);
667
668         tty_ldisc_flush_works(tty);
669
670         retval = tty_ldisc_wait_idle(tty, 5 * HZ);
671
672         tty_lock();
673         mutex_lock(&tty->ldisc_mutex);
674
675         /* handle wait idle failure locked */
676         if (retval) {
677                 tty_ldisc_put(new_ldisc);
678                 goto enable;
679         }
680
681         if (test_bit(TTY_HUPPED, &tty->flags)) {
682                 /* We were raced by the hangup method. It will have stomped
683                    the ldisc data and closed the ldisc down */
684                 clear_bit(TTY_LDISC_CHANGING, &tty->flags);
685                 mutex_unlock(&tty->ldisc_mutex);
686                 tty_ldisc_put(new_ldisc);
687                 tty_unlock();
688                 return -EIO;
689         }
690
691         /* Shutdown the current discipline. */
692         tty_ldisc_close(tty, o_ldisc);
693
694         /* Now set up the new line discipline. */
695         tty_ldisc_assign(tty, new_ldisc);
696         tty_set_termios_ldisc(tty, ldisc);
697
698         retval = tty_ldisc_open(tty, new_ldisc);
699         if (retval < 0) {
700                 /* Back to the old one or N_TTY if we can't */
701                 tty_ldisc_put(new_ldisc);
702                 tty_ldisc_restore(tty, o_ldisc);
703         }
704
705         /* At this point we hold a reference to the new ldisc and a
706            a reference to the old ldisc. If we ended up flipping back
707            to the existing ldisc we have two references to it */
708
709         if (tty->ldisc->ops->num != o_ldisc->ops->num && tty->ops->set_ldisc)
710                 tty->ops->set_ldisc(tty);
711
712         tty_ldisc_put(o_ldisc);
713
714 enable:
715         /*
716          *      Allow ldisc referencing to occur again
717          */
718
719         tty_ldisc_enable(tty);
720         if (o_tty)
721                 tty_ldisc_enable(o_tty);
722
723         /* Restart the work queue in case no characters kick it off. Safe if
724            already running */
725         if (work)
726                 schedule_work(&tty->buf.work);
727         if (o_work)
728                 schedule_work(&o_tty->buf.work);
729         mutex_unlock(&tty->ldisc_mutex);
730         tty_unlock();
731         return retval;
732 }
733
734 /**
735  *      tty_reset_termios       -       reset terminal state
736  *      @tty: tty to reset
737  *
738  *      Restore a terminal to the driver default state.
739  */
740
741 static void tty_reset_termios(struct tty_struct *tty)
742 {
743         mutex_lock(&tty->termios_mutex);
744         *tty->termios = tty->driver->init_termios;
745         tty->termios->c_ispeed = tty_termios_input_baud_rate(tty->termios);
746         tty->termios->c_ospeed = tty_termios_baud_rate(tty->termios);
747         mutex_unlock(&tty->termios_mutex);
748 }
749
750
751 /**
752  *      tty_ldisc_reinit        -       reinitialise the tty ldisc
753  *      @tty: tty to reinit
754  *      @ldisc: line discipline to reinitialize
755  *
756  *      Switch the tty to a line discipline and leave the ldisc
757  *      state closed
758  */
759
760 static int tty_ldisc_reinit(struct tty_struct *tty, int ldisc)
761 {
762         struct tty_ldisc *ld = tty_ldisc_get(ldisc);
763
764         if (IS_ERR(ld))
765                 return -1;
766
767         tty_ldisc_close(tty, tty->ldisc);
768         tty_ldisc_put(tty->ldisc);
769         tty->ldisc = NULL;
770         /*
771          *      Switch the line discipline back
772          */
773         tty_ldisc_assign(tty, ld);
774         tty_set_termios_ldisc(tty, ldisc);
775
776         return 0;
777 }
778
779 /**
780  *      tty_ldisc_hangup                -       hangup ldisc reset
781  *      @tty: tty being hung up
782  *
783  *      Some tty devices reset their termios when they receive a hangup
784  *      event. In that situation we must also switch back to N_TTY properly
785  *      before we reset the termios data.
786  *
787  *      Locking: We can take the ldisc mutex as the rest of the code is
788  *      careful to allow for this.
789  *
790  *      In the pty pair case this occurs in the close() path of the
791  *      tty itself so we must be careful about locking rules.
792  */
793
794 void tty_ldisc_hangup(struct tty_struct *tty)
795 {
796         struct tty_ldisc *ld;
797         int reset = tty->driver->flags & TTY_DRIVER_RESET_TERMIOS;
798         int err = 0;
799
800         /*
801          * FIXME! What are the locking issues here? This may me overdoing
802          * things... This question is especially important now that we've
803          * removed the irqlock.
804          */
805         ld = tty_ldisc_ref(tty);
806         if (ld != NULL) {
807                 /* We may have no line discipline at this point */
808                 if (ld->ops->flush_buffer)
809                         ld->ops->flush_buffer(tty);
810                 tty_driver_flush_buffer(tty);
811                 if ((test_bit(TTY_DO_WRITE_WAKEUP, &tty->flags)) &&
812                     ld->ops->write_wakeup)
813                         ld->ops->write_wakeup(tty);
814                 if (ld->ops->hangup)
815                         ld->ops->hangup(tty);
816                 tty_ldisc_deref(ld);
817         }
818         /*
819          * FIXME: Once we trust the LDISC code better we can wait here for
820          * ldisc completion and fix the driver call race
821          */
822         wake_up_interruptible_poll(&tty->write_wait, POLLOUT);
823         wake_up_interruptible_poll(&tty->read_wait, POLLIN);
824         /*
825          * Shutdown the current line discipline, and reset it to
826          * N_TTY if need be.
827          *
828          * Avoid racing set_ldisc or tty_ldisc_release
829          */
830         mutex_lock(&tty->ldisc_mutex);
831
832         /*
833          * this is like tty_ldisc_halt, but we need to give up
834          * the BTM before calling cancel_work_sync, which may
835          * need to wait for another function taking the BTM
836          */
837         clear_bit(TTY_LDISC, &tty->flags);
838         tty_unlock();
839         cancel_work_sync(&tty->buf.work);
840         mutex_unlock(&tty->ldisc_mutex);
841 retry:
842         tty_lock();
843         mutex_lock(&tty->ldisc_mutex);
844
845         /* At this point we have a closed ldisc and we want to
846            reopen it. We could defer this to the next open but
847            it means auditing a lot of other paths so this is
848            a FIXME */
849         if (tty->ldisc) {       /* Not yet closed */
850                 if (atomic_read(&tty->ldisc->users) != 1) {
851                         char cur_n[TASK_COMM_LEN], tty_n[64];
852                         long timeout = 3 * HZ;
853                         tty_unlock();
854
855                         while (tty_ldisc_wait_idle(tty, timeout) == -EBUSY) {
856                                 timeout = MAX_SCHEDULE_TIMEOUT;
857                                 printk_ratelimited(KERN_WARNING
858                                         "%s: waiting (%s) for %s took too long, but we keep waiting...\n",
859                                         __func__, get_task_comm(cur_n, current),
860                                         tty_name(tty, tty_n));
861                         }
862                         mutex_unlock(&tty->ldisc_mutex);
863                         goto retry;
864                 }
865
866                 if (reset == 0) {
867
868                         if (!tty_ldisc_reinit(tty, tty->termios->c_line))
869                                 err = tty_ldisc_open(tty, tty->ldisc);
870                         else
871                                 err = 1;
872                 }
873                 /* If the re-open fails or we reset then go to N_TTY. The
874                    N_TTY open cannot fail */
875                 if (reset || err) {
876                         BUG_ON(tty_ldisc_reinit(tty, N_TTY));
877                         WARN_ON(tty_ldisc_open(tty, tty->ldisc));
878                 }
879                 tty_ldisc_enable(tty);
880         }
881         mutex_unlock(&tty->ldisc_mutex);
882         if (reset)
883                 tty_reset_termios(tty);
884 }
885
886 /**
887  *      tty_ldisc_setup                 -       open line discipline
888  *      @tty: tty being shut down
889  *      @o_tty: pair tty for pty/tty pairs
890  *
891  *      Called during the initial open of a tty/pty pair in order to set up the
892  *      line disciplines and bind them to the tty. This has no locking issues
893  *      as the device isn't yet active.
894  */
895
896 int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty)
897 {
898         struct tty_ldisc *ld = tty->ldisc;
899         int retval;
900
901         retval = tty_ldisc_open(tty, ld);
902         if (retval)
903                 return retval;
904
905         if (o_tty) {
906                 retval = tty_ldisc_open(o_tty, o_tty->ldisc);
907                 if (retval) {
908                         tty_ldisc_close(tty, ld);
909                         return retval;
910                 }
911                 tty_ldisc_enable(o_tty);
912         }
913         tty_ldisc_enable(tty);
914         return 0;
915 }
916 /**
917  *      tty_ldisc_release               -       release line discipline
918  *      @tty: tty being shut down
919  *      @o_tty: pair tty for pty/tty pairs
920  *
921  *      Called during the final close of a tty/pty pair in order to shut down
922  *      the line discpline layer. On exit the ldisc assigned is N_TTY and the
923  *      ldisc has not been opened.
924  */
925
926 void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty)
927 {
928         /*
929          * Prevent flush_to_ldisc() from rescheduling the work for later.  Then
930          * kill any delayed work. As this is the final close it does not
931          * race with the set_ldisc code path.
932          */
933
934         tty_unlock();
935         tty_ldisc_halt(tty);
936         tty_ldisc_flush_works(tty);
937         tty_lock();
938
939         mutex_lock(&tty->ldisc_mutex);
940         /*
941          * Now kill off the ldisc
942          */
943         tty_ldisc_close(tty, tty->ldisc);
944         tty_ldisc_put(tty->ldisc);
945         /* Force an oops if we mess this up */
946         tty->ldisc = NULL;
947
948         /* Ensure the next open requests the N_TTY ldisc */
949         tty_set_termios_ldisc(tty, N_TTY);
950         mutex_unlock(&tty->ldisc_mutex);
951
952         /* This will need doing differently if we need to lock */
953         if (o_tty)
954                 tty_ldisc_release(o_tty, NULL);
955
956         /* And the memory resources remaining (buffers, termios) will be
957            disposed of when the kref hits zero */
958 }
959
960 /**
961  *      tty_ldisc_init          -       ldisc setup for new tty
962  *      @tty: tty being allocated
963  *
964  *      Set up the line discipline objects for a newly allocated tty. Note that
965  *      the tty structure is not completely set up when this call is made.
966  */
967
968 void tty_ldisc_init(struct tty_struct *tty)
969 {
970         struct tty_ldisc *ld = tty_ldisc_get(N_TTY);
971         if (IS_ERR(ld))
972                 panic("n_tty: init_tty");
973         tty_ldisc_assign(tty, ld);
974 }
975
976 /**
977  *      tty_ldisc_init          -       ldisc cleanup for new tty
978  *      @tty: tty that was allocated recently
979  *
980  *      The tty structure must not becompletely set up (tty_ldisc_setup) when
981  *      this call is made.
982  */
983 void tty_ldisc_deinit(struct tty_struct *tty)
984 {
985         put_ldisc(tty->ldisc);
986         tty_ldisc_assign(tty, NULL);
987 }
988
989 void tty_ldisc_begin(void)
990 {
991         /* Setup the default TTY line discipline. */
992         (void) tty_register_ldisc(N_TTY, &tty_ldisc_N_TTY);
993 }