Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (C) 1991, 1992, 1993, 1994 Linus Torvalds
4 *
5 * Modified by Fred N. van Kempen, 01/29/93, to add line disciplines
6 * which can be dynamically activated and de-activated by the line
7 * discipline handling modules (like SLIP).
8 */
9
10#include <linux/types.h>
11#include <linux/termios.h>
12#include <linux/errno.h>
13#include <linux/sched/signal.h>
14#include <linux/kernel.h>
15#include <linux/major.h>
16#include <linux/tty.h>
17#include <linux/fcntl.h>
18#include <linux/string.h>
19#include <linux/mm.h>
20#include <linux/module.h>
21#include <linux/bitops.h>
22#include <linux/mutex.h>
23#include <linux/compat.h>
24
25#include <asm/io.h>
26#include <linux/uaccess.h>
27
28#undef TTY_DEBUG_WAIT_UNTIL_SENT
29
30#ifdef TTY_DEBUG_WAIT_UNTIL_SENT
31# define tty_debug_wait_until_sent(tty, f, args...) tty_debug(tty, f, ##args)
32#else
33# define tty_debug_wait_until_sent(tty, f, args...) do {} while (0)
34#endif
35
36#undef DEBUG
37
38/*
39 * Internal flag options for termios setting behavior
40 */
41#define TERMIOS_FLUSH 1
42#define TERMIOS_WAIT 2
43#define TERMIOS_TERMIO 4
44#define TERMIOS_OLD 8
45
46
47/**
48 * tty_chars_in_buffer - characters pending
49 * @tty: terminal
50 *
51 * Return the number of bytes of data in the device private
52 * output queue. If no private method is supplied there is assumed
53 * to be no queue on the device.
54 */
55
56int tty_chars_in_buffer(struct tty_struct *tty)
57{
58 if (tty->ops->chars_in_buffer)
59 return tty->ops->chars_in_buffer(tty);
60 else
61 return 0;
62}
63EXPORT_SYMBOL(tty_chars_in_buffer);
64
65/**
66 * tty_write_room - write queue space
67 * @tty: terminal
68 *
69 * Return the number of bytes that can be queued to this device
70 * at the present time. The result should be treated as a guarantee
71 * and the driver cannot offer a value it later shrinks by more than
72 * the number of bytes written. If no method is provided 2K is always
73 * returned and data may be lost as there will be no flow control.
74 */
75
76int tty_write_room(struct tty_struct *tty)
77{
78 if (tty->ops->write_room)
79 return tty->ops->write_room(tty);
80 return 2048;
81}
82EXPORT_SYMBOL(tty_write_room);
83
84/**
85 * tty_driver_flush_buffer - discard internal buffer
86 * @tty: terminal
87 *
88 * Discard the internal output buffer for this device. If no method
89 * is provided then either the buffer cannot be hardware flushed or
90 * there is no buffer driver side.
91 */
92void tty_driver_flush_buffer(struct tty_struct *tty)
93{
94 if (tty->ops->flush_buffer)
95 tty->ops->flush_buffer(tty);
96}
97EXPORT_SYMBOL(tty_driver_flush_buffer);
98
99/**
100 * tty_throttle - flow control
101 * @tty: terminal
102 *
103 * Indicate that a tty should stop transmitting data down the stack.
104 * Takes the termios rwsem to protect against parallel throttle/unthrottle
105 * and also to ensure the driver can consistently reference its own
106 * termios data at this point when implementing software flow control.
107 */
108
109void tty_throttle(struct tty_struct *tty)
110{
111 down_write(&tty->termios_rwsem);
112 /* check TTY_THROTTLED first so it indicates our state */
113 if (!test_and_set_bit(TTY_THROTTLED, &tty->flags) &&
114 tty->ops->throttle)
115 tty->ops->throttle(tty);
116 tty->flow_change = 0;
117 up_write(&tty->termios_rwsem);
118}
119EXPORT_SYMBOL(tty_throttle);
120
121/**
122 * tty_unthrottle - flow control
123 * @tty: terminal
124 *
125 * Indicate that a tty may continue transmitting data down the stack.
126 * Takes the termios rwsem to protect against parallel throttle/unthrottle
127 * and also to ensure the driver can consistently reference its own
128 * termios data at this point when implementing software flow control.
129 *
130 * Drivers should however remember that the stack can issue a throttle,
131 * then change flow control method, then unthrottle.
132 */
133
134void tty_unthrottle(struct tty_struct *tty)
135{
136 down_write(&tty->termios_rwsem);
137 if (test_and_clear_bit(TTY_THROTTLED, &tty->flags) &&
138 tty->ops->unthrottle)
139 tty->ops->unthrottle(tty);
140 tty->flow_change = 0;
141 up_write(&tty->termios_rwsem);
142}
143EXPORT_SYMBOL(tty_unthrottle);
144
145/**
146 * tty_throttle_safe - flow control
147 * @tty: terminal
148 *
149 * Similar to tty_throttle() but will only attempt throttle
150 * if tty->flow_change is TTY_THROTTLE_SAFE. Prevents an accidental
151 * throttle due to race conditions when throttling is conditional
152 * on factors evaluated prior to throttling.
153 *
154 * Returns 0 if tty is throttled (or was already throttled)
155 */
156
157int tty_throttle_safe(struct tty_struct *tty)
158{
159 int ret = 0;
160
161 mutex_lock(&tty->throttle_mutex);
162 if (!tty_throttled(tty)) {
163 if (tty->flow_change != TTY_THROTTLE_SAFE)
164 ret = 1;
165 else {
166 set_bit(TTY_THROTTLED, &tty->flags);
167 if (tty->ops->throttle)
168 tty->ops->throttle(tty);
169 }
170 }
171 mutex_unlock(&tty->throttle_mutex);
172
173 return ret;
174}
175
176/**
177 * tty_unthrottle_safe - flow control
178 * @tty: terminal
179 *
180 * Similar to tty_unthrottle() but will only attempt unthrottle
181 * if tty->flow_change is TTY_UNTHROTTLE_SAFE. Prevents an accidental
182 * unthrottle due to race conditions when unthrottling is conditional
183 * on factors evaluated prior to unthrottling.
184 *
185 * Returns 0 if tty is unthrottled (or was already unthrottled)
186 */
187
188int tty_unthrottle_safe(struct tty_struct *tty)
189{
190 int ret = 0;
191
192 mutex_lock(&tty->throttle_mutex);
193 if (tty_throttled(tty)) {
194 if (tty->flow_change != TTY_UNTHROTTLE_SAFE)
195 ret = 1;
196 else {
197 clear_bit(TTY_THROTTLED, &tty->flags);
198 if (tty->ops->unthrottle)
199 tty->ops->unthrottle(tty);
200 }
201 }
202 mutex_unlock(&tty->throttle_mutex);
203
204 return ret;
205}
206
207/**
208 * tty_wait_until_sent - wait for I/O to finish
209 * @tty: tty we are waiting for
210 * @timeout: how long we will wait
211 *
212 * Wait for characters pending in a tty driver to hit the wire, or
213 * for a timeout to occur (eg due to flow control)
214 *
215 * Locking: none
216 */
217
218void tty_wait_until_sent(struct tty_struct *tty, long timeout)
219{
220 tty_debug_wait_until_sent(tty, "wait until sent, timeout=%ld\n", timeout);
221
222 if (!timeout)
223 timeout = MAX_SCHEDULE_TIMEOUT;
224
225 timeout = wait_event_interruptible_timeout(tty->write_wait,
226 !tty_chars_in_buffer(tty), timeout);
227 if (timeout <= 0)
228 return;
229
230 if (timeout == MAX_SCHEDULE_TIMEOUT)
231 timeout = 0;
232
233 if (tty->ops->wait_until_sent)
234 tty->ops->wait_until_sent(tty, timeout);
235}
236EXPORT_SYMBOL(tty_wait_until_sent);
237
238
239/*
240 * Termios Helper Methods
241 */
242
243static void unset_locked_termios(struct tty_struct *tty, struct ktermios *old)
244{
245 struct ktermios *termios = &tty->termios;
246 struct ktermios *locked = &tty->termios_locked;
247 int i;
248
249#define NOSET_MASK(x, y, z) (x = ((x) & ~(z)) | ((y) & (z)))
250
251 NOSET_MASK(termios->c_iflag, old->c_iflag, locked->c_iflag);
252 NOSET_MASK(termios->c_oflag, old->c_oflag, locked->c_oflag);
253 NOSET_MASK(termios->c_cflag, old->c_cflag, locked->c_cflag);
254 NOSET_MASK(termios->c_lflag, old->c_lflag, locked->c_lflag);
255 termios->c_line = locked->c_line ? old->c_line : termios->c_line;
256 for (i = 0; i < NCCS; i++)
257 termios->c_cc[i] = locked->c_cc[i] ?
258 old->c_cc[i] : termios->c_cc[i];
259 /* FIXME: What should we do for i/ospeed */
260}
261
262/**
263 * tty_termios_copy_hw - copy hardware settings
264 * @new: New termios
265 * @old: Old termios
266 *
267 * Propagate the hardware specific terminal setting bits from
268 * the old termios structure to the new one. This is used in cases
269 * where the hardware does not support reconfiguration or as a helper
270 * in some cases where only minimal reconfiguration is supported
271 */
272
273void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old)
274{
275 /* The bits a dumb device handles in software. Smart devices need
276 to always provide a set_termios method */
277 new->c_cflag &= HUPCL | CREAD | CLOCAL;
278 new->c_cflag |= old->c_cflag & ~(HUPCL | CREAD | CLOCAL);
279 new->c_ispeed = old->c_ispeed;
280 new->c_ospeed = old->c_ospeed;
281}
282EXPORT_SYMBOL(tty_termios_copy_hw);
283
284/**
285 * tty_termios_hw_change - check for setting change
286 * @a: termios
287 * @b: termios to compare
288 *
289 * Check if any of the bits that affect a dumb device have changed
290 * between the two termios structures, or a speed change is needed.
291 */
292
293int tty_termios_hw_change(const struct ktermios *a, const struct ktermios *b)
294{
295 if (a->c_ispeed != b->c_ispeed || a->c_ospeed != b->c_ospeed)
296 return 1;
297 if ((a->c_cflag ^ b->c_cflag) & ~(HUPCL | CREAD | CLOCAL))
298 return 1;
299 return 0;
300}
301EXPORT_SYMBOL(tty_termios_hw_change);
302
303/**
304 * tty_set_termios - update termios values
305 * @tty: tty to update
306 * @new_termios: desired new value
307 *
308 * Perform updates to the termios values set on this terminal.
309 * A master pty's termios should never be set.
310 *
311 * Locking: termios_rwsem
312 */
313
314int tty_set_termios(struct tty_struct *tty, struct ktermios *new_termios)
315{
316 struct ktermios old_termios;
317 struct tty_ldisc *ld;
318
319 WARN_ON(tty->driver->type == TTY_DRIVER_TYPE_PTY &&
320 tty->driver->subtype == PTY_TYPE_MASTER);
321 /*
322 * Perform the actual termios internal changes under lock.
323 */
324
325
326 /* FIXME: we need to decide on some locking/ordering semantics
327 for the set_termios notification eventually */
328 down_write(&tty->termios_rwsem);
329 old_termios = tty->termios;
330 tty->termios = *new_termios;
331 unset_locked_termios(tty, &old_termios);
332
333 if (tty->ops->set_termios)
334 tty->ops->set_termios(tty, &old_termios);
335 else
336 tty_termios_copy_hw(&tty->termios, &old_termios);
337
338 ld = tty_ldisc_ref(tty);
339 if (ld != NULL) {
340 if (ld->ops->set_termios)
341 ld->ops->set_termios(tty, &old_termios);
342 tty_ldisc_deref(ld);
343 }
344 up_write(&tty->termios_rwsem);
345 return 0;
346}
347EXPORT_SYMBOL_GPL(tty_set_termios);
348
349/**
350 * set_termios - set termios values for a tty
351 * @tty: terminal device
352 * @arg: user data
353 * @opt: option information
354 *
355 * Helper function to prepare termios data and run necessary other
356 * functions before using tty_set_termios to do the actual changes.
357 *
358 * Locking:
359 * Called functions take ldisc and termios_rwsem locks
360 */
361
362static int set_termios(struct tty_struct *tty, void __user *arg, int opt)
363{
364 struct ktermios tmp_termios;
365 struct tty_ldisc *ld;
366 int retval = tty_check_change(tty);
367
368 if (retval)
369 return retval;
370
371 down_read(&tty->termios_rwsem);
372 tmp_termios = tty->termios;
373 up_read(&tty->termios_rwsem);
374
375 if (opt & TERMIOS_TERMIO) {
376 if (user_termio_to_kernel_termios(&tmp_termios,
377 (struct termio __user *)arg))
378 return -EFAULT;
379#ifdef TCGETS2
380 } else if (opt & TERMIOS_OLD) {
381 if (user_termios_to_kernel_termios_1(&tmp_termios,
382 (struct termios __user *)arg))
383 return -EFAULT;
384 } else {
385 if (user_termios_to_kernel_termios(&tmp_termios,
386 (struct termios2 __user *)arg))
387 return -EFAULT;
388 }
389#else
390 } else if (user_termios_to_kernel_termios(&tmp_termios,
391 (struct termios __user *)arg))
392 return -EFAULT;
393#endif
394
395 /* If old style Bfoo values are used then load c_ispeed/c_ospeed
396 * with the real speed so its unconditionally usable */
397 tmp_termios.c_ispeed = tty_termios_input_baud_rate(&tmp_termios);
398 tmp_termios.c_ospeed = tty_termios_baud_rate(&tmp_termios);
399
400 ld = tty_ldisc_ref(tty);
401
402 if (ld != NULL) {
403 if ((opt & TERMIOS_FLUSH) && ld->ops->flush_buffer)
404 ld->ops->flush_buffer(tty);
405 tty_ldisc_deref(ld);
406 }
407
408 if (opt & TERMIOS_WAIT) {
409 tty_wait_until_sent(tty, 0);
410 if (signal_pending(current))
411 return -ERESTARTSYS;
412 }
413
414 tty_set_termios(tty, &tmp_termios);
415
416 /* FIXME: Arguably if tmp_termios == tty->termios AND the
417 actual requested termios was not tmp_termios then we may
418 want to return an error as no user requested change has
419 succeeded */
420 return 0;
421}
422
423static void copy_termios(struct tty_struct *tty, struct ktermios *kterm)
424{
425 down_read(&tty->termios_rwsem);
426 *kterm = tty->termios;
427 up_read(&tty->termios_rwsem);
428}
429
430static void copy_termios_locked(struct tty_struct *tty, struct ktermios *kterm)
431{
432 down_read(&tty->termios_rwsem);
433 *kterm = tty->termios_locked;
434 up_read(&tty->termios_rwsem);
435}
436
437static int get_termio(struct tty_struct *tty, struct termio __user *termio)
438{
439 struct ktermios kterm;
440 copy_termios(tty, &kterm);
441 if (kernel_termios_to_user_termio(termio, &kterm))
442 return -EFAULT;
443 return 0;
444}
445
446
447#ifdef TCGETX
448
449/**
450 * set_termiox - set termiox fields if possible
451 * @tty: terminal
452 * @arg: termiox structure from user
453 * @opt: option flags for ioctl type
454 *
455 * Implement the device calling points for the SYS5 termiox ioctl
456 * interface in Linux
457 */
458
459static int set_termiox(struct tty_struct *tty, void __user *arg, int opt)
460{
461 struct termiox tnew;
462 struct tty_ldisc *ld;
463
464 if (tty->termiox == NULL)
465 return -EINVAL;
466 if (copy_from_user(&tnew, arg, sizeof(struct termiox)))
467 return -EFAULT;
468
469 ld = tty_ldisc_ref(tty);
470 if (ld != NULL) {
471 if ((opt & TERMIOS_FLUSH) && ld->ops->flush_buffer)
472 ld->ops->flush_buffer(tty);
473 tty_ldisc_deref(ld);
474 }
475 if (opt & TERMIOS_WAIT) {
476 tty_wait_until_sent(tty, 0);
477 if (signal_pending(current))
478 return -ERESTARTSYS;
479 }
480
481 down_write(&tty->termios_rwsem);
482 if (tty->ops->set_termiox)
483 tty->ops->set_termiox(tty, &tnew);
484 up_write(&tty->termios_rwsem);
485 return 0;
486}
487
488#endif
489
490
491#ifdef TIOCGETP
492/*
493 * These are deprecated, but there is limited support..
494 *
495 * The "sg_flags" translation is a joke..
496 */
497static int get_sgflags(struct tty_struct *tty)
498{
499 int flags = 0;
500
501 if (!L_ICANON(tty)) {
502 if (L_ISIG(tty))
503 flags |= 0x02; /* cbreak */
504 else
505 flags |= 0x20; /* raw */
506 }
507 if (L_ECHO(tty))
508 flags |= 0x08; /* echo */
509 if (O_OPOST(tty))
510 if (O_ONLCR(tty))
511 flags |= 0x10; /* crmod */
512 return flags;
513}
514
515static int get_sgttyb(struct tty_struct *tty, struct sgttyb __user *sgttyb)
516{
517 struct sgttyb tmp;
518
519 down_read(&tty->termios_rwsem);
520 tmp.sg_ispeed = tty->termios.c_ispeed;
521 tmp.sg_ospeed = tty->termios.c_ospeed;
522 tmp.sg_erase = tty->termios.c_cc[VERASE];
523 tmp.sg_kill = tty->termios.c_cc[VKILL];
524 tmp.sg_flags = get_sgflags(tty);
525 up_read(&tty->termios_rwsem);
526
527 return copy_to_user(sgttyb, &tmp, sizeof(tmp)) ? -EFAULT : 0;
528}
529
530static void set_sgflags(struct ktermios *termios, int flags)
531{
532 termios->c_iflag = ICRNL | IXON;
533 termios->c_oflag = 0;
534 termios->c_lflag = ISIG | ICANON;
535 if (flags & 0x02) { /* cbreak */
536 termios->c_iflag = 0;
537 termios->c_lflag &= ~ICANON;
538 }
539 if (flags & 0x08) { /* echo */
540 termios->c_lflag |= ECHO | ECHOE | ECHOK |
541 ECHOCTL | ECHOKE | IEXTEN;
542 }
543 if (flags & 0x10) { /* crmod */
544 termios->c_oflag |= OPOST | ONLCR;
545 }
546 if (flags & 0x20) { /* raw */
547 termios->c_iflag = 0;
548 termios->c_lflag &= ~(ISIG | ICANON);
549 }
550 if (!(termios->c_lflag & ICANON)) {
551 termios->c_cc[VMIN] = 1;
552 termios->c_cc[VTIME] = 0;
553 }
554}
555
556/**
557 * set_sgttyb - set legacy terminal values
558 * @tty: tty structure
559 * @sgttyb: pointer to old style terminal structure
560 *
561 * Updates a terminal from the legacy BSD style terminal information
562 * structure.
563 *
564 * Locking: termios_rwsem
565 */
566
567static int set_sgttyb(struct tty_struct *tty, struct sgttyb __user *sgttyb)
568{
569 int retval;
570 struct sgttyb tmp;
571 struct ktermios termios;
572
573 retval = tty_check_change(tty);
574 if (retval)
575 return retval;
576
577 if (copy_from_user(&tmp, sgttyb, sizeof(tmp)))
578 return -EFAULT;
579
580 down_write(&tty->termios_rwsem);
581 termios = tty->termios;
582 termios.c_cc[VERASE] = tmp.sg_erase;
583 termios.c_cc[VKILL] = tmp.sg_kill;
584 set_sgflags(&termios, tmp.sg_flags);
585 /* Try and encode into Bfoo format */
586#ifdef BOTHER
587 tty_termios_encode_baud_rate(&termios, termios.c_ispeed,
588 termios.c_ospeed);
589#endif
590 up_write(&tty->termios_rwsem);
591 tty_set_termios(tty, &termios);
592 return 0;
593}
594#endif
595
596#ifdef TIOCGETC
597static int get_tchars(struct tty_struct *tty, struct tchars __user *tchars)
598{
599 struct tchars tmp;
600
601 down_read(&tty->termios_rwsem);
602 tmp.t_intrc = tty->termios.c_cc[VINTR];
603 tmp.t_quitc = tty->termios.c_cc[VQUIT];
604 tmp.t_startc = tty->termios.c_cc[VSTART];
605 tmp.t_stopc = tty->termios.c_cc[VSTOP];
606 tmp.t_eofc = tty->termios.c_cc[VEOF];
607 tmp.t_brkc = tty->termios.c_cc[VEOL2]; /* what is brkc anyway? */
608 up_read(&tty->termios_rwsem);
609 return copy_to_user(tchars, &tmp, sizeof(tmp)) ? -EFAULT : 0;
610}
611
612static int set_tchars(struct tty_struct *tty, struct tchars __user *tchars)
613{
614 struct tchars tmp;
615
616 if (copy_from_user(&tmp, tchars, sizeof(tmp)))
617 return -EFAULT;
618 down_write(&tty->termios_rwsem);
619 tty->termios.c_cc[VINTR] = tmp.t_intrc;
620 tty->termios.c_cc[VQUIT] = tmp.t_quitc;
621 tty->termios.c_cc[VSTART] = tmp.t_startc;
622 tty->termios.c_cc[VSTOP] = tmp.t_stopc;
623 tty->termios.c_cc[VEOF] = tmp.t_eofc;
624 tty->termios.c_cc[VEOL2] = tmp.t_brkc; /* what is brkc anyway? */
625 up_write(&tty->termios_rwsem);
626 return 0;
627}
628#endif
629
630#ifdef TIOCGLTC
631static int get_ltchars(struct tty_struct *tty, struct ltchars __user *ltchars)
632{
633 struct ltchars tmp;
634
635 down_read(&tty->termios_rwsem);
636 tmp.t_suspc = tty->termios.c_cc[VSUSP];
637 /* what is dsuspc anyway? */
638 tmp.t_dsuspc = tty->termios.c_cc[VSUSP];
639 tmp.t_rprntc = tty->termios.c_cc[VREPRINT];
640 /* what is flushc anyway? */
641 tmp.t_flushc = tty->termios.c_cc[VEOL2];
642 tmp.t_werasc = tty->termios.c_cc[VWERASE];
643 tmp.t_lnextc = tty->termios.c_cc[VLNEXT];
644 up_read(&tty->termios_rwsem);
645 return copy_to_user(ltchars, &tmp, sizeof(tmp)) ? -EFAULT : 0;
646}
647
648static int set_ltchars(struct tty_struct *tty, struct ltchars __user *ltchars)
649{
650 struct ltchars tmp;
651
652 if (copy_from_user(&tmp, ltchars, sizeof(tmp)))
653 return -EFAULT;
654
655 down_write(&tty->termios_rwsem);
656 tty->termios.c_cc[VSUSP] = tmp.t_suspc;
657 /* what is dsuspc anyway? */
658 tty->termios.c_cc[VEOL2] = tmp.t_dsuspc;
659 tty->termios.c_cc[VREPRINT] = tmp.t_rprntc;
660 /* what is flushc anyway? */
661 tty->termios.c_cc[VEOL2] = tmp.t_flushc;
662 tty->termios.c_cc[VWERASE] = tmp.t_werasc;
663 tty->termios.c_cc[VLNEXT] = tmp.t_lnextc;
664 up_write(&tty->termios_rwsem);
665 return 0;
666}
667#endif
668
669/**
670 * tty_change_softcar - carrier change ioctl helper
671 * @tty: tty to update
672 * @arg: enable/disable CLOCAL
673 *
674 * Perform a change to the CLOCAL state and call into the driver
675 * layer to make it visible. All done with the termios rwsem
676 */
677
678static int tty_change_softcar(struct tty_struct *tty, int arg)
679{
680 int ret = 0;
681 int bit = arg ? CLOCAL : 0;
682 struct ktermios old;
683
684 down_write(&tty->termios_rwsem);
685 old = tty->termios;
686 tty->termios.c_cflag &= ~CLOCAL;
687 tty->termios.c_cflag |= bit;
688 if (tty->ops->set_termios)
689 tty->ops->set_termios(tty, &old);
690 if (C_CLOCAL(tty) != bit)
691 ret = -EINVAL;
692 up_write(&tty->termios_rwsem);
693 return ret;
694}
695
696/**
697 * tty_mode_ioctl - mode related ioctls
698 * @tty: tty for the ioctl
699 * @file: file pointer for the tty
700 * @cmd: command
701 * @arg: ioctl argument
702 *
703 * Perform non line discipline specific mode control ioctls. This
704 * is designed to be called by line disciplines to ensure they provide
705 * consistent mode setting.
706 */
707
708int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
709 unsigned int cmd, unsigned long arg)
710{
711 struct tty_struct *real_tty;
712 void __user *p = (void __user *)arg;
713 int ret = 0;
714 struct ktermios kterm;
715
716 BUG_ON(file == NULL);
717
718 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
719 tty->driver->subtype == PTY_TYPE_MASTER)
720 real_tty = tty->link;
721 else
722 real_tty = tty;
723
724 switch (cmd) {
725#ifdef TIOCGETP
726 case TIOCGETP:
727 return get_sgttyb(real_tty, (struct sgttyb __user *) arg);
728 case TIOCSETP:
729 case TIOCSETN:
730 return set_sgttyb(real_tty, (struct sgttyb __user *) arg);
731#endif
732#ifdef TIOCGETC
733 case TIOCGETC:
734 return get_tchars(real_tty, p);
735 case TIOCSETC:
736 return set_tchars(real_tty, p);
737#endif
738#ifdef TIOCGLTC
739 case TIOCGLTC:
740 return get_ltchars(real_tty, p);
741 case TIOCSLTC:
742 return set_ltchars(real_tty, p);
743#endif
744 case TCSETSF:
745 return set_termios(real_tty, p, TERMIOS_FLUSH | TERMIOS_WAIT | TERMIOS_OLD);
746 case TCSETSW:
747 return set_termios(real_tty, p, TERMIOS_WAIT | TERMIOS_OLD);
748 case TCSETS:
749 return set_termios(real_tty, p, TERMIOS_OLD);
750#ifndef TCGETS2
751 case TCGETS:
752 copy_termios(real_tty, &kterm);
753 if (kernel_termios_to_user_termios((struct termios __user *)arg, &kterm))
754 ret = -EFAULT;
755 return ret;
756#else
757 case TCGETS:
758 copy_termios(real_tty, &kterm);
759 if (kernel_termios_to_user_termios_1((struct termios __user *)arg, &kterm))
760 ret = -EFAULT;
761 return ret;
762 case TCGETS2:
763 copy_termios(real_tty, &kterm);
764 if (kernel_termios_to_user_termios((struct termios2 __user *)arg, &kterm))
765 ret = -EFAULT;
766 return ret;
767 case TCSETSF2:
768 return set_termios(real_tty, p, TERMIOS_FLUSH | TERMIOS_WAIT);
769 case TCSETSW2:
770 return set_termios(real_tty, p, TERMIOS_WAIT);
771 case TCSETS2:
772 return set_termios(real_tty, p, 0);
773#endif
774 case TCGETA:
775 return get_termio(real_tty, p);
776 case TCSETAF:
777 return set_termios(real_tty, p, TERMIOS_FLUSH | TERMIOS_WAIT | TERMIOS_TERMIO);
778 case TCSETAW:
779 return set_termios(real_tty, p, TERMIOS_WAIT | TERMIOS_TERMIO);
780 case TCSETA:
781 return set_termios(real_tty, p, TERMIOS_TERMIO);
782#ifndef TCGETS2
783 case TIOCGLCKTRMIOS:
784 copy_termios_locked(real_tty, &kterm);
785 if (kernel_termios_to_user_termios((struct termios __user *)arg, &kterm))
786 ret = -EFAULT;
787 return ret;
788 case TIOCSLCKTRMIOS:
789 if (!capable(CAP_SYS_ADMIN))
790 return -EPERM;
791 copy_termios_locked(real_tty, &kterm);
792 if (user_termios_to_kernel_termios(&kterm,
793 (struct termios __user *) arg))
794 return -EFAULT;
795 down_write(&real_tty->termios_rwsem);
796 real_tty->termios_locked = kterm;
797 up_write(&real_tty->termios_rwsem);
798 return 0;
799#else
800 case TIOCGLCKTRMIOS:
801 copy_termios_locked(real_tty, &kterm);
802 if (kernel_termios_to_user_termios_1((struct termios __user *)arg, &kterm))
803 ret = -EFAULT;
804 return ret;
805 case TIOCSLCKTRMIOS:
806 if (!capable(CAP_SYS_ADMIN))
807 return -EPERM;
808 copy_termios_locked(real_tty, &kterm);
809 if (user_termios_to_kernel_termios_1(&kterm,
810 (struct termios __user *) arg))
811 return -EFAULT;
812 down_write(&real_tty->termios_rwsem);
813 real_tty->termios_locked = kterm;
814 up_write(&real_tty->termios_rwsem);
815 return ret;
816#endif
817#ifdef TCGETX
818 case TCGETX: {
819 struct termiox ktermx;
820 if (real_tty->termiox == NULL)
821 return -EINVAL;
822 down_read(&real_tty->termios_rwsem);
823 memcpy(&ktermx, real_tty->termiox, sizeof(struct termiox));
824 up_read(&real_tty->termios_rwsem);
825 if (copy_to_user(p, &ktermx, sizeof(struct termiox)))
826 ret = -EFAULT;
827 return ret;
828 }
829 case TCSETX:
830 return set_termiox(real_tty, p, 0);
831 case TCSETXW:
832 return set_termiox(real_tty, p, TERMIOS_WAIT);
833 case TCSETXF:
834 return set_termiox(real_tty, p, TERMIOS_FLUSH);
835#endif
836 case TIOCGSOFTCAR:
837 copy_termios(real_tty, &kterm);
838 ret = put_user((kterm.c_cflag & CLOCAL) ? 1 : 0,
839 (int __user *)arg);
840 return ret;
841 case TIOCSSOFTCAR:
842 if (get_user(arg, (unsigned int __user *) arg))
843 return -EFAULT;
844 return tty_change_softcar(real_tty, arg);
845 default:
846 return -ENOIOCTLCMD;
847 }
848}
849EXPORT_SYMBOL_GPL(tty_mode_ioctl);
850
851
852/* Caller guarantees ldisc reference is held */
853static int __tty_perform_flush(struct tty_struct *tty, unsigned long arg)
854{
855 struct tty_ldisc *ld = tty->ldisc;
856
857 switch (arg) {
858 case TCIFLUSH:
859 if (ld && ld->ops->flush_buffer) {
860 ld->ops->flush_buffer(tty);
861 tty_unthrottle(tty);
862 }
863 break;
864 case TCIOFLUSH:
865 if (ld && ld->ops->flush_buffer) {
866 ld->ops->flush_buffer(tty);
867 tty_unthrottle(tty);
868 }
869 fallthrough;
870 case TCOFLUSH:
871 tty_driver_flush_buffer(tty);
872 break;
873 default:
874 return -EINVAL;
875 }
876 return 0;
877}
878
879int tty_perform_flush(struct tty_struct *tty, unsigned long arg)
880{
881 struct tty_ldisc *ld;
882 int retval = tty_check_change(tty);
883 if (retval)
884 return retval;
885
886 ld = tty_ldisc_ref_wait(tty);
887 retval = __tty_perform_flush(tty, arg);
888 if (ld)
889 tty_ldisc_deref(ld);
890 return retval;
891}
892EXPORT_SYMBOL_GPL(tty_perform_flush);
893
894int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
895 unsigned int cmd, unsigned long arg)
896{
897 int retval;
898
899 switch (cmd) {
900 case TCXONC:
901 retval = tty_check_change(tty);
902 if (retval)
903 return retval;
904 switch (arg) {
905 case TCOOFF:
906 spin_lock_irq(&tty->flow_lock);
907 if (!tty->flow_stopped) {
908 tty->flow_stopped = 1;
909 __stop_tty(tty);
910 }
911 spin_unlock_irq(&tty->flow_lock);
912 break;
913 case TCOON:
914 spin_lock_irq(&tty->flow_lock);
915 if (tty->flow_stopped) {
916 tty->flow_stopped = 0;
917 __start_tty(tty);
918 }
919 spin_unlock_irq(&tty->flow_lock);
920 break;
921 case TCIOFF:
922 if (STOP_CHAR(tty) != __DISABLED_CHAR)
923 retval = tty_send_xchar(tty, STOP_CHAR(tty));
924 break;
925 case TCION:
926 if (START_CHAR(tty) != __DISABLED_CHAR)
927 retval = tty_send_xchar(tty, START_CHAR(tty));
928 break;
929 default:
930 return -EINVAL;
931 }
932 return retval;
933 case TCFLSH:
934 retval = tty_check_change(tty);
935 if (retval)
936 return retval;
937 return __tty_perform_flush(tty, arg);
938 default:
939 /* Try the mode commands */
940 return tty_mode_ioctl(tty, file, cmd, arg);
941 }
942}
943EXPORT_SYMBOL(n_tty_ioctl_helper);
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (C) 1991, 1992, 1993, 1994 Linus Torvalds
4 *
5 * Modified by Fred N. van Kempen, 01/29/93, to add line disciplines
6 * which can be dynamically activated and de-activated by the line
7 * discipline handling modules (like SLIP).
8 */
9
10#include <linux/types.h>
11#include <linux/termios.h>
12#include <linux/errno.h>
13#include <linux/sched/signal.h>
14#include <linux/kernel.h>
15#include <linux/major.h>
16#include <linux/tty.h>
17#include <linux/fcntl.h>
18#include <linux/string.h>
19#include <linux/mm.h>
20#include <linux/module.h>
21#include <linux/bitops.h>
22#include <linux/mutex.h>
23#include <linux/compat.h>
24#include "tty.h"
25
26#include <asm/io.h>
27#include <linux/uaccess.h>
28
29#undef TTY_DEBUG_WAIT_UNTIL_SENT
30
31#ifdef TTY_DEBUG_WAIT_UNTIL_SENT
32# define tty_debug_wait_until_sent(tty, f, args...) tty_debug(tty, f, ##args)
33#else
34# define tty_debug_wait_until_sent(tty, f, args...) do {} while (0)
35#endif
36
37#undef DEBUG
38
39/*
40 * Internal flag options for termios setting behavior
41 */
42#define TERMIOS_FLUSH 1
43#define TERMIOS_WAIT 2
44#define TERMIOS_TERMIO 4
45#define TERMIOS_OLD 8
46
47
48/**
49 * tty_chars_in_buffer - characters pending
50 * @tty: terminal
51 *
52 * Return the number of bytes of data in the device private
53 * output queue. If no private method is supplied there is assumed
54 * to be no queue on the device.
55 */
56
57unsigned int tty_chars_in_buffer(struct tty_struct *tty)
58{
59 if (tty->ops->chars_in_buffer)
60 return tty->ops->chars_in_buffer(tty);
61 return 0;
62}
63EXPORT_SYMBOL(tty_chars_in_buffer);
64
65/**
66 * tty_write_room - write queue space
67 * @tty: terminal
68 *
69 * Return the number of bytes that can be queued to this device
70 * at the present time. The result should be treated as a guarantee
71 * and the driver cannot offer a value it later shrinks by more than
72 * the number of bytes written. If no method is provided 2K is always
73 * returned and data may be lost as there will be no flow control.
74 */
75
76unsigned int tty_write_room(struct tty_struct *tty)
77{
78 if (tty->ops->write_room)
79 return tty->ops->write_room(tty);
80 return 2048;
81}
82EXPORT_SYMBOL(tty_write_room);
83
84/**
85 * tty_driver_flush_buffer - discard internal buffer
86 * @tty: terminal
87 *
88 * Discard the internal output buffer for this device. If no method
89 * is provided then either the buffer cannot be hardware flushed or
90 * there is no buffer driver side.
91 */
92void tty_driver_flush_buffer(struct tty_struct *tty)
93{
94 if (tty->ops->flush_buffer)
95 tty->ops->flush_buffer(tty);
96}
97EXPORT_SYMBOL(tty_driver_flush_buffer);
98
99/**
100 * tty_unthrottle - flow control
101 * @tty: terminal
102 *
103 * Indicate that a tty may continue transmitting data down the stack.
104 * Takes the termios rwsem to protect against parallel throttle/unthrottle
105 * and also to ensure the driver can consistently reference its own
106 * termios data at this point when implementing software flow control.
107 *
108 * Drivers should however remember that the stack can issue a throttle,
109 * then change flow control method, then unthrottle.
110 */
111
112void tty_unthrottle(struct tty_struct *tty)
113{
114 down_write(&tty->termios_rwsem);
115 if (test_and_clear_bit(TTY_THROTTLED, &tty->flags) &&
116 tty->ops->unthrottle)
117 tty->ops->unthrottle(tty);
118 tty->flow_change = 0;
119 up_write(&tty->termios_rwsem);
120}
121EXPORT_SYMBOL(tty_unthrottle);
122
123/**
124 * tty_throttle_safe - flow control
125 * @tty: terminal
126 *
127 * Indicate that a tty should stop transmitting data down the stack.
128 * tty_throttle_safe will only attempt throttle if tty->flow_change is
129 * TTY_THROTTLE_SAFE. Prevents an accidental throttle due to race
130 * conditions when throttling is conditional on factors evaluated prior to
131 * throttling.
132 *
133 * Returns 0 if tty is throttled (or was already throttled)
134 */
135
136int tty_throttle_safe(struct tty_struct *tty)
137{
138 int ret = 0;
139
140 mutex_lock(&tty->throttle_mutex);
141 if (!tty_throttled(tty)) {
142 if (tty->flow_change != TTY_THROTTLE_SAFE)
143 ret = 1;
144 else {
145 set_bit(TTY_THROTTLED, &tty->flags);
146 if (tty->ops->throttle)
147 tty->ops->throttle(tty);
148 }
149 }
150 mutex_unlock(&tty->throttle_mutex);
151
152 return ret;
153}
154
155/**
156 * tty_unthrottle_safe - flow control
157 * @tty: terminal
158 *
159 * Similar to tty_unthrottle() but will only attempt unthrottle
160 * if tty->flow_change is TTY_UNTHROTTLE_SAFE. Prevents an accidental
161 * unthrottle due to race conditions when unthrottling is conditional
162 * on factors evaluated prior to unthrottling.
163 *
164 * Returns 0 if tty is unthrottled (or was already unthrottled)
165 */
166
167int tty_unthrottle_safe(struct tty_struct *tty)
168{
169 int ret = 0;
170
171 mutex_lock(&tty->throttle_mutex);
172 if (tty_throttled(tty)) {
173 if (tty->flow_change != TTY_UNTHROTTLE_SAFE)
174 ret = 1;
175 else {
176 clear_bit(TTY_THROTTLED, &tty->flags);
177 if (tty->ops->unthrottle)
178 tty->ops->unthrottle(tty);
179 }
180 }
181 mutex_unlock(&tty->throttle_mutex);
182
183 return ret;
184}
185
186/**
187 * tty_wait_until_sent - wait for I/O to finish
188 * @tty: tty we are waiting for
189 * @timeout: how long we will wait
190 *
191 * Wait for characters pending in a tty driver to hit the wire, or
192 * for a timeout to occur (eg due to flow control)
193 *
194 * Locking: none
195 */
196
197void tty_wait_until_sent(struct tty_struct *tty, long timeout)
198{
199 tty_debug_wait_until_sent(tty, "wait until sent, timeout=%ld\n", timeout);
200
201 if (!timeout)
202 timeout = MAX_SCHEDULE_TIMEOUT;
203
204 timeout = wait_event_interruptible_timeout(tty->write_wait,
205 !tty_chars_in_buffer(tty), timeout);
206 if (timeout <= 0)
207 return;
208
209 if (timeout == MAX_SCHEDULE_TIMEOUT)
210 timeout = 0;
211
212 if (tty->ops->wait_until_sent)
213 tty->ops->wait_until_sent(tty, timeout);
214}
215EXPORT_SYMBOL(tty_wait_until_sent);
216
217
218/*
219 * Termios Helper Methods
220 */
221
222static void unset_locked_termios(struct tty_struct *tty, struct ktermios *old)
223{
224 struct ktermios *termios = &tty->termios;
225 struct ktermios *locked = &tty->termios_locked;
226 int i;
227
228#define NOSET_MASK(x, y, z) (x = ((x) & ~(z)) | ((y) & (z)))
229
230 NOSET_MASK(termios->c_iflag, old->c_iflag, locked->c_iflag);
231 NOSET_MASK(termios->c_oflag, old->c_oflag, locked->c_oflag);
232 NOSET_MASK(termios->c_cflag, old->c_cflag, locked->c_cflag);
233 NOSET_MASK(termios->c_lflag, old->c_lflag, locked->c_lflag);
234 termios->c_line = locked->c_line ? old->c_line : termios->c_line;
235 for (i = 0; i < NCCS; i++)
236 termios->c_cc[i] = locked->c_cc[i] ?
237 old->c_cc[i] : termios->c_cc[i];
238 /* FIXME: What should we do for i/ospeed */
239}
240
241/**
242 * tty_termios_copy_hw - copy hardware settings
243 * @new: New termios
244 * @old: Old termios
245 *
246 * Propagate the hardware specific terminal setting bits from
247 * the old termios structure to the new one. This is used in cases
248 * where the hardware does not support reconfiguration or as a helper
249 * in some cases where only minimal reconfiguration is supported
250 */
251
252void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old)
253{
254 /* The bits a dumb device handles in software. Smart devices need
255 to always provide a set_termios method */
256 new->c_cflag &= HUPCL | CREAD | CLOCAL;
257 new->c_cflag |= old->c_cflag & ~(HUPCL | CREAD | CLOCAL);
258 new->c_ispeed = old->c_ispeed;
259 new->c_ospeed = old->c_ospeed;
260}
261EXPORT_SYMBOL(tty_termios_copy_hw);
262
263/**
264 * tty_termios_hw_change - check for setting change
265 * @a: termios
266 * @b: termios to compare
267 *
268 * Check if any of the bits that affect a dumb device have changed
269 * between the two termios structures, or a speed change is needed.
270 */
271
272int tty_termios_hw_change(const struct ktermios *a, const struct ktermios *b)
273{
274 if (a->c_ispeed != b->c_ispeed || a->c_ospeed != b->c_ospeed)
275 return 1;
276 if ((a->c_cflag ^ b->c_cflag) & ~(HUPCL | CREAD | CLOCAL))
277 return 1;
278 return 0;
279}
280EXPORT_SYMBOL(tty_termios_hw_change);
281
282/**
283 * tty_get_char_size - get size of a character
284 * @cflag: termios cflag value
285 *
286 * Get the size (in bits) of a character depending on @cflag's %CSIZE
287 * setting.
288 */
289unsigned char tty_get_char_size(unsigned int cflag)
290{
291 switch (cflag & CSIZE) {
292 case CS5:
293 return 5;
294 case CS6:
295 return 6;
296 case CS7:
297 return 7;
298 case CS8:
299 default:
300 return 8;
301 }
302}
303EXPORT_SYMBOL_GPL(tty_get_char_size);
304
305/**
306 * tty_get_frame_size - get size of a frame
307 * @cflag: termios cflag value
308 *
309 * Get the size (in bits) of a frame depending on @cflag's %CSIZE, %CSTOPB,
310 * and %PARENB setting. The result is a sum of character size, start and
311 * stop bits -- one bit each -- second stop bit (if set), and parity bit
312 * (if set).
313 */
314unsigned char tty_get_frame_size(unsigned int cflag)
315{
316 unsigned char bits = 2 + tty_get_char_size(cflag);
317
318 if (cflag & CSTOPB)
319 bits++;
320 if (cflag & PARENB)
321 bits++;
322
323 return bits;
324}
325EXPORT_SYMBOL_GPL(tty_get_frame_size);
326
327/**
328 * tty_set_termios - update termios values
329 * @tty: tty to update
330 * @new_termios: desired new value
331 *
332 * Perform updates to the termios values set on this terminal.
333 * A master pty's termios should never be set.
334 *
335 * Locking: termios_rwsem
336 */
337
338int tty_set_termios(struct tty_struct *tty, struct ktermios *new_termios)
339{
340 struct ktermios old_termios;
341 struct tty_ldisc *ld;
342
343 WARN_ON(tty->driver->type == TTY_DRIVER_TYPE_PTY &&
344 tty->driver->subtype == PTY_TYPE_MASTER);
345 /*
346 * Perform the actual termios internal changes under lock.
347 */
348
349
350 /* FIXME: we need to decide on some locking/ordering semantics
351 for the set_termios notification eventually */
352 down_write(&tty->termios_rwsem);
353 old_termios = tty->termios;
354 tty->termios = *new_termios;
355 unset_locked_termios(tty, &old_termios);
356
357 if (tty->ops->set_termios)
358 tty->ops->set_termios(tty, &old_termios);
359 else
360 tty_termios_copy_hw(&tty->termios, &old_termios);
361
362 ld = tty_ldisc_ref(tty);
363 if (ld != NULL) {
364 if (ld->ops->set_termios)
365 ld->ops->set_termios(tty, &old_termios);
366 tty_ldisc_deref(ld);
367 }
368 up_write(&tty->termios_rwsem);
369 return 0;
370}
371EXPORT_SYMBOL_GPL(tty_set_termios);
372
373/**
374 * set_termios - set termios values for a tty
375 * @tty: terminal device
376 * @arg: user data
377 * @opt: option information
378 *
379 * Helper function to prepare termios data and run necessary other
380 * functions before using tty_set_termios to do the actual changes.
381 *
382 * Locking:
383 * Called functions take ldisc and termios_rwsem locks
384 */
385
386static int set_termios(struct tty_struct *tty, void __user *arg, int opt)
387{
388 struct ktermios tmp_termios;
389 struct tty_ldisc *ld;
390 int retval = tty_check_change(tty);
391
392 if (retval)
393 return retval;
394
395 down_read(&tty->termios_rwsem);
396 tmp_termios = tty->termios;
397 up_read(&tty->termios_rwsem);
398
399 if (opt & TERMIOS_TERMIO) {
400 if (user_termio_to_kernel_termios(&tmp_termios,
401 (struct termio __user *)arg))
402 return -EFAULT;
403#ifdef TCGETS2
404 } else if (opt & TERMIOS_OLD) {
405 if (user_termios_to_kernel_termios_1(&tmp_termios,
406 (struct termios __user *)arg))
407 return -EFAULT;
408 } else {
409 if (user_termios_to_kernel_termios(&tmp_termios,
410 (struct termios2 __user *)arg))
411 return -EFAULT;
412 }
413#else
414 } else if (user_termios_to_kernel_termios(&tmp_termios,
415 (struct termios __user *)arg))
416 return -EFAULT;
417#endif
418
419 /* If old style Bfoo values are used then load c_ispeed/c_ospeed
420 * with the real speed so its unconditionally usable */
421 tmp_termios.c_ispeed = tty_termios_input_baud_rate(&tmp_termios);
422 tmp_termios.c_ospeed = tty_termios_baud_rate(&tmp_termios);
423
424 ld = tty_ldisc_ref(tty);
425
426 if (ld != NULL) {
427 if ((opt & TERMIOS_FLUSH) && ld->ops->flush_buffer)
428 ld->ops->flush_buffer(tty);
429 tty_ldisc_deref(ld);
430 }
431
432 if (opt & TERMIOS_WAIT) {
433 tty_wait_until_sent(tty, 0);
434 if (signal_pending(current))
435 return -ERESTARTSYS;
436 }
437
438 tty_set_termios(tty, &tmp_termios);
439
440 /* FIXME: Arguably if tmp_termios == tty->termios AND the
441 actual requested termios was not tmp_termios then we may
442 want to return an error as no user requested change has
443 succeeded */
444 return 0;
445}
446
447static void copy_termios(struct tty_struct *tty, struct ktermios *kterm)
448{
449 down_read(&tty->termios_rwsem);
450 *kterm = tty->termios;
451 up_read(&tty->termios_rwsem);
452}
453
454static void copy_termios_locked(struct tty_struct *tty, struct ktermios *kterm)
455{
456 down_read(&tty->termios_rwsem);
457 *kterm = tty->termios_locked;
458 up_read(&tty->termios_rwsem);
459}
460
461static int get_termio(struct tty_struct *tty, struct termio __user *termio)
462{
463 struct ktermios kterm;
464 copy_termios(tty, &kterm);
465 if (kernel_termios_to_user_termio(termio, &kterm))
466 return -EFAULT;
467 return 0;
468}
469
470#ifdef TIOCGETP
471/*
472 * These are deprecated, but there is limited support..
473 *
474 * The "sg_flags" translation is a joke..
475 */
476static int get_sgflags(struct tty_struct *tty)
477{
478 int flags = 0;
479
480 if (!L_ICANON(tty)) {
481 if (L_ISIG(tty))
482 flags |= 0x02; /* cbreak */
483 else
484 flags |= 0x20; /* raw */
485 }
486 if (L_ECHO(tty))
487 flags |= 0x08; /* echo */
488 if (O_OPOST(tty))
489 if (O_ONLCR(tty))
490 flags |= 0x10; /* crmod */
491 return flags;
492}
493
494static int get_sgttyb(struct tty_struct *tty, struct sgttyb __user *sgttyb)
495{
496 struct sgttyb tmp;
497
498 down_read(&tty->termios_rwsem);
499 tmp.sg_ispeed = tty->termios.c_ispeed;
500 tmp.sg_ospeed = tty->termios.c_ospeed;
501 tmp.sg_erase = tty->termios.c_cc[VERASE];
502 tmp.sg_kill = tty->termios.c_cc[VKILL];
503 tmp.sg_flags = get_sgflags(tty);
504 up_read(&tty->termios_rwsem);
505
506 return copy_to_user(sgttyb, &tmp, sizeof(tmp)) ? -EFAULT : 0;
507}
508
509static void set_sgflags(struct ktermios *termios, int flags)
510{
511 termios->c_iflag = ICRNL | IXON;
512 termios->c_oflag = 0;
513 termios->c_lflag = ISIG | ICANON;
514 if (flags & 0x02) { /* cbreak */
515 termios->c_iflag = 0;
516 termios->c_lflag &= ~ICANON;
517 }
518 if (flags & 0x08) { /* echo */
519 termios->c_lflag |= ECHO | ECHOE | ECHOK |
520 ECHOCTL | ECHOKE | IEXTEN;
521 }
522 if (flags & 0x10) { /* crmod */
523 termios->c_oflag |= OPOST | ONLCR;
524 }
525 if (flags & 0x20) { /* raw */
526 termios->c_iflag = 0;
527 termios->c_lflag &= ~(ISIG | ICANON);
528 }
529 if (!(termios->c_lflag & ICANON)) {
530 termios->c_cc[VMIN] = 1;
531 termios->c_cc[VTIME] = 0;
532 }
533}
534
535/**
536 * set_sgttyb - set legacy terminal values
537 * @tty: tty structure
538 * @sgttyb: pointer to old style terminal structure
539 *
540 * Updates a terminal from the legacy BSD style terminal information
541 * structure.
542 *
543 * Locking: termios_rwsem
544 */
545
546static int set_sgttyb(struct tty_struct *tty, struct sgttyb __user *sgttyb)
547{
548 int retval;
549 struct sgttyb tmp;
550 struct ktermios termios;
551
552 retval = tty_check_change(tty);
553 if (retval)
554 return retval;
555
556 if (copy_from_user(&tmp, sgttyb, sizeof(tmp)))
557 return -EFAULT;
558
559 down_write(&tty->termios_rwsem);
560 termios = tty->termios;
561 termios.c_cc[VERASE] = tmp.sg_erase;
562 termios.c_cc[VKILL] = tmp.sg_kill;
563 set_sgflags(&termios, tmp.sg_flags);
564 /* Try and encode into Bfoo format */
565#ifdef BOTHER
566 tty_termios_encode_baud_rate(&termios, termios.c_ispeed,
567 termios.c_ospeed);
568#endif
569 up_write(&tty->termios_rwsem);
570 tty_set_termios(tty, &termios);
571 return 0;
572}
573#endif
574
575#ifdef TIOCGETC
576static int get_tchars(struct tty_struct *tty, struct tchars __user *tchars)
577{
578 struct tchars tmp;
579
580 down_read(&tty->termios_rwsem);
581 tmp.t_intrc = tty->termios.c_cc[VINTR];
582 tmp.t_quitc = tty->termios.c_cc[VQUIT];
583 tmp.t_startc = tty->termios.c_cc[VSTART];
584 tmp.t_stopc = tty->termios.c_cc[VSTOP];
585 tmp.t_eofc = tty->termios.c_cc[VEOF];
586 tmp.t_brkc = tty->termios.c_cc[VEOL2]; /* what is brkc anyway? */
587 up_read(&tty->termios_rwsem);
588 return copy_to_user(tchars, &tmp, sizeof(tmp)) ? -EFAULT : 0;
589}
590
591static int set_tchars(struct tty_struct *tty, struct tchars __user *tchars)
592{
593 struct tchars tmp;
594
595 if (copy_from_user(&tmp, tchars, sizeof(tmp)))
596 return -EFAULT;
597 down_write(&tty->termios_rwsem);
598 tty->termios.c_cc[VINTR] = tmp.t_intrc;
599 tty->termios.c_cc[VQUIT] = tmp.t_quitc;
600 tty->termios.c_cc[VSTART] = tmp.t_startc;
601 tty->termios.c_cc[VSTOP] = tmp.t_stopc;
602 tty->termios.c_cc[VEOF] = tmp.t_eofc;
603 tty->termios.c_cc[VEOL2] = tmp.t_brkc; /* what is brkc anyway? */
604 up_write(&tty->termios_rwsem);
605 return 0;
606}
607#endif
608
609#ifdef TIOCGLTC
610static int get_ltchars(struct tty_struct *tty, struct ltchars __user *ltchars)
611{
612 struct ltchars tmp;
613
614 down_read(&tty->termios_rwsem);
615 tmp.t_suspc = tty->termios.c_cc[VSUSP];
616 /* what is dsuspc anyway? */
617 tmp.t_dsuspc = tty->termios.c_cc[VSUSP];
618 tmp.t_rprntc = tty->termios.c_cc[VREPRINT];
619 /* what is flushc anyway? */
620 tmp.t_flushc = tty->termios.c_cc[VEOL2];
621 tmp.t_werasc = tty->termios.c_cc[VWERASE];
622 tmp.t_lnextc = tty->termios.c_cc[VLNEXT];
623 up_read(&tty->termios_rwsem);
624 return copy_to_user(ltchars, &tmp, sizeof(tmp)) ? -EFAULT : 0;
625}
626
627static int set_ltchars(struct tty_struct *tty, struct ltchars __user *ltchars)
628{
629 struct ltchars tmp;
630
631 if (copy_from_user(&tmp, ltchars, sizeof(tmp)))
632 return -EFAULT;
633
634 down_write(&tty->termios_rwsem);
635 tty->termios.c_cc[VSUSP] = tmp.t_suspc;
636 /* what is dsuspc anyway? */
637 tty->termios.c_cc[VEOL2] = tmp.t_dsuspc;
638 tty->termios.c_cc[VREPRINT] = tmp.t_rprntc;
639 /* what is flushc anyway? */
640 tty->termios.c_cc[VEOL2] = tmp.t_flushc;
641 tty->termios.c_cc[VWERASE] = tmp.t_werasc;
642 tty->termios.c_cc[VLNEXT] = tmp.t_lnextc;
643 up_write(&tty->termios_rwsem);
644 return 0;
645}
646#endif
647
648/**
649 * tty_change_softcar - carrier change ioctl helper
650 * @tty: tty to update
651 * @arg: enable/disable CLOCAL
652 *
653 * Perform a change to the CLOCAL state and call into the driver
654 * layer to make it visible. All done with the termios rwsem
655 */
656
657static int tty_change_softcar(struct tty_struct *tty, int arg)
658{
659 int ret = 0;
660 int bit = arg ? CLOCAL : 0;
661 struct ktermios old;
662
663 down_write(&tty->termios_rwsem);
664 old = tty->termios;
665 tty->termios.c_cflag &= ~CLOCAL;
666 tty->termios.c_cflag |= bit;
667 if (tty->ops->set_termios)
668 tty->ops->set_termios(tty, &old);
669 if (C_CLOCAL(tty) != bit)
670 ret = -EINVAL;
671 up_write(&tty->termios_rwsem);
672 return ret;
673}
674
675/**
676 * tty_mode_ioctl - mode related ioctls
677 * @tty: tty for the ioctl
678 * @file: file pointer for the tty
679 * @cmd: command
680 * @arg: ioctl argument
681 *
682 * Perform non line discipline specific mode control ioctls. This
683 * is designed to be called by line disciplines to ensure they provide
684 * consistent mode setting.
685 */
686
687int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
688 unsigned int cmd, unsigned long arg)
689{
690 struct tty_struct *real_tty;
691 void __user *p = (void __user *)arg;
692 int ret = 0;
693 struct ktermios kterm;
694
695 BUG_ON(file == NULL);
696
697 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
698 tty->driver->subtype == PTY_TYPE_MASTER)
699 real_tty = tty->link;
700 else
701 real_tty = tty;
702
703 switch (cmd) {
704#ifdef TIOCGETP
705 case TIOCGETP:
706 return get_sgttyb(real_tty, (struct sgttyb __user *) arg);
707 case TIOCSETP:
708 case TIOCSETN:
709 return set_sgttyb(real_tty, (struct sgttyb __user *) arg);
710#endif
711#ifdef TIOCGETC
712 case TIOCGETC:
713 return get_tchars(real_tty, p);
714 case TIOCSETC:
715 return set_tchars(real_tty, p);
716#endif
717#ifdef TIOCGLTC
718 case TIOCGLTC:
719 return get_ltchars(real_tty, p);
720 case TIOCSLTC:
721 return set_ltchars(real_tty, p);
722#endif
723 case TCSETSF:
724 return set_termios(real_tty, p, TERMIOS_FLUSH | TERMIOS_WAIT | TERMIOS_OLD);
725 case TCSETSW:
726 return set_termios(real_tty, p, TERMIOS_WAIT | TERMIOS_OLD);
727 case TCSETS:
728 return set_termios(real_tty, p, TERMIOS_OLD);
729#ifndef TCGETS2
730 case TCGETS:
731 copy_termios(real_tty, &kterm);
732 if (kernel_termios_to_user_termios((struct termios __user *)arg, &kterm))
733 ret = -EFAULT;
734 return ret;
735#else
736 case TCGETS:
737 copy_termios(real_tty, &kterm);
738 if (kernel_termios_to_user_termios_1((struct termios __user *)arg, &kterm))
739 ret = -EFAULT;
740 return ret;
741 case TCGETS2:
742 copy_termios(real_tty, &kterm);
743 if (kernel_termios_to_user_termios((struct termios2 __user *)arg, &kterm))
744 ret = -EFAULT;
745 return ret;
746 case TCSETSF2:
747 return set_termios(real_tty, p, TERMIOS_FLUSH | TERMIOS_WAIT);
748 case TCSETSW2:
749 return set_termios(real_tty, p, TERMIOS_WAIT);
750 case TCSETS2:
751 return set_termios(real_tty, p, 0);
752#endif
753 case TCGETA:
754 return get_termio(real_tty, p);
755 case TCSETAF:
756 return set_termios(real_tty, p, TERMIOS_FLUSH | TERMIOS_WAIT | TERMIOS_TERMIO);
757 case TCSETAW:
758 return set_termios(real_tty, p, TERMIOS_WAIT | TERMIOS_TERMIO);
759 case TCSETA:
760 return set_termios(real_tty, p, TERMIOS_TERMIO);
761#ifndef TCGETS2
762 case TIOCGLCKTRMIOS:
763 copy_termios_locked(real_tty, &kterm);
764 if (kernel_termios_to_user_termios((struct termios __user *)arg, &kterm))
765 ret = -EFAULT;
766 return ret;
767 case TIOCSLCKTRMIOS:
768 if (!capable(CAP_SYS_ADMIN))
769 return -EPERM;
770 copy_termios_locked(real_tty, &kterm);
771 if (user_termios_to_kernel_termios(&kterm,
772 (struct termios __user *) arg))
773 return -EFAULT;
774 down_write(&real_tty->termios_rwsem);
775 real_tty->termios_locked = kterm;
776 up_write(&real_tty->termios_rwsem);
777 return 0;
778#else
779 case TIOCGLCKTRMIOS:
780 copy_termios_locked(real_tty, &kterm);
781 if (kernel_termios_to_user_termios_1((struct termios __user *)arg, &kterm))
782 ret = -EFAULT;
783 return ret;
784 case TIOCSLCKTRMIOS:
785 if (!capable(CAP_SYS_ADMIN))
786 return -EPERM;
787 copy_termios_locked(real_tty, &kterm);
788 if (user_termios_to_kernel_termios_1(&kterm,
789 (struct termios __user *) arg))
790 return -EFAULT;
791 down_write(&real_tty->termios_rwsem);
792 real_tty->termios_locked = kterm;
793 up_write(&real_tty->termios_rwsem);
794 return ret;
795#endif
796#ifdef TCGETX
797 case TCGETX:
798 case TCSETX:
799 case TCSETXW:
800 case TCSETXF:
801 return -ENOTTY;
802#endif
803 case TIOCGSOFTCAR:
804 copy_termios(real_tty, &kterm);
805 ret = put_user((kterm.c_cflag & CLOCAL) ? 1 : 0,
806 (int __user *)arg);
807 return ret;
808 case TIOCSSOFTCAR:
809 if (get_user(arg, (unsigned int __user *) arg))
810 return -EFAULT;
811 return tty_change_softcar(real_tty, arg);
812 default:
813 return -ENOIOCTLCMD;
814 }
815}
816EXPORT_SYMBOL_GPL(tty_mode_ioctl);
817
818
819/* Caller guarantees ldisc reference is held */
820static int __tty_perform_flush(struct tty_struct *tty, unsigned long arg)
821{
822 struct tty_ldisc *ld = tty->ldisc;
823
824 switch (arg) {
825 case TCIFLUSH:
826 if (ld && ld->ops->flush_buffer) {
827 ld->ops->flush_buffer(tty);
828 tty_unthrottle(tty);
829 }
830 break;
831 case TCIOFLUSH:
832 if (ld && ld->ops->flush_buffer) {
833 ld->ops->flush_buffer(tty);
834 tty_unthrottle(tty);
835 }
836 fallthrough;
837 case TCOFLUSH:
838 tty_driver_flush_buffer(tty);
839 break;
840 default:
841 return -EINVAL;
842 }
843 return 0;
844}
845
846int tty_perform_flush(struct tty_struct *tty, unsigned long arg)
847{
848 struct tty_ldisc *ld;
849 int retval = tty_check_change(tty);
850 if (retval)
851 return retval;
852
853 ld = tty_ldisc_ref_wait(tty);
854 retval = __tty_perform_flush(tty, arg);
855 if (ld)
856 tty_ldisc_deref(ld);
857 return retval;
858}
859EXPORT_SYMBOL_GPL(tty_perform_flush);
860
861int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
862 unsigned int cmd, unsigned long arg)
863{
864 int retval;
865
866 switch (cmd) {
867 case TCXONC:
868 retval = tty_check_change(tty);
869 if (retval)
870 return retval;
871 switch (arg) {
872 case TCOOFF:
873 spin_lock_irq(&tty->flow.lock);
874 if (!tty->flow.tco_stopped) {
875 tty->flow.tco_stopped = true;
876 __stop_tty(tty);
877 }
878 spin_unlock_irq(&tty->flow.lock);
879 break;
880 case TCOON:
881 spin_lock_irq(&tty->flow.lock);
882 if (tty->flow.tco_stopped) {
883 tty->flow.tco_stopped = false;
884 __start_tty(tty);
885 }
886 spin_unlock_irq(&tty->flow.lock);
887 break;
888 case TCIOFF:
889 if (STOP_CHAR(tty) != __DISABLED_CHAR)
890 retval = tty_send_xchar(tty, STOP_CHAR(tty));
891 break;
892 case TCION:
893 if (START_CHAR(tty) != __DISABLED_CHAR)
894 retval = tty_send_xchar(tty, START_CHAR(tty));
895 break;
896 default:
897 return -EINVAL;
898 }
899 return retval;
900 case TCFLSH:
901 retval = tty_check_change(tty);
902 if (retval)
903 return retval;
904 return __tty_perform_flush(tty, arg);
905 default:
906 /* Try the mode commands */
907 return tty_mode_ioctl(tty, file, cmd, arg);
908 }
909}
910EXPORT_SYMBOL(n_tty_ioctl_helper);