blob: 8481b29d5b3a70d015bcc3f0afcb6a2cfdbc02e8 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * Copyright (C) 1991, 1992, 1993, 1994 Linus Torvalds
3 *
4 * Modified by Fred N. van Kempen, 01/29/93, to add line disciplines
5 * which can be dynamically activated and de-activated by the line
6 * discipline handling modules (like SLIP).
7 */
8
9#include <linux/types.h>
10#include <linux/termios.h>
11#include <linux/errno.h>
12#include <linux/sched.h>
13#include <linux/kernel.h>
14#include <linux/major.h>
15#include <linux/tty.h>
16#include <linux/fcntl.h>
17#include <linux/string.h>
18#include <linux/mm.h>
19#include <linux/module.h>
20#include <linux/bitops.h>
Arjan van de Ven5785c952006-09-29 02:00:43 -070021#include <linux/mutex.h>
Thomas Meyer8193c422011-10-05 23:13:13 +020022#include <linux/compat.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24#include <asm/io.h>
25#include <asm/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
27#undef TTY_DEBUG_WAIT_UNTIL_SENT
28
29#undef DEBUG
30
31/*
32 * Internal flag options for termios setting behavior
33 */
34#define TERMIOS_FLUSH 1
35#define TERMIOS_WAIT 2
36#define TERMIOS_TERMIO 4
Alan Coxedc6afc2006-12-08 02:38:44 -080037#define TERMIOS_OLD 8
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Alan Coxaf9b8972006-08-27 01:24:01 -070039
Alan Coxd81ed102008-10-13 10:41:42 +010040/**
41 * tty_chars_in_buffer - characters pending
42 * @tty: terminal
43 *
44 * Return the number of bytes of data in the device private
45 * output queue. If no private method is supplied there is assumed
46 * to be no queue on the device.
47 */
48
Alan Coxf34d7a52008-04-30 00:54:13 -070049int tty_chars_in_buffer(struct tty_struct *tty)
50{
51 if (tty->ops->chars_in_buffer)
52 return tty->ops->chars_in_buffer(tty);
53 else
54 return 0;
55}
Alan Coxf34d7a52008-04-30 00:54:13 -070056EXPORT_SYMBOL(tty_chars_in_buffer);
57
Alan Coxd81ed102008-10-13 10:41:42 +010058/**
59 * tty_write_room - write queue space
60 * @tty: terminal
61 *
62 * Return the number of bytes that can be queued to this device
63 * at the present time. The result should be treated as a guarantee
64 * and the driver cannot offer a value it later shrinks by more than
65 * the number of bytes written. If no method is provided 2K is always
66 * returned and data may be lost as there will be no flow control.
67 */
68
Alan Coxf34d7a52008-04-30 00:54:13 -070069int tty_write_room(struct tty_struct *tty)
70{
71 if (tty->ops->write_room)
72 return tty->ops->write_room(tty);
73 return 2048;
74}
Alan Coxf34d7a52008-04-30 00:54:13 -070075EXPORT_SYMBOL(tty_write_room);
76
Alan Coxd81ed102008-10-13 10:41:42 +010077/**
78 * tty_driver_flush_buffer - discard internal buffer
79 * @tty: terminal
80 *
81 * Discard the internal output buffer for this device. If no method
82 * is provided then either the buffer cannot be hardware flushed or
83 * there is no buffer driver side.
84 */
Alan Coxf34d7a52008-04-30 00:54:13 -070085void tty_driver_flush_buffer(struct tty_struct *tty)
86{
87 if (tty->ops->flush_buffer)
88 tty->ops->flush_buffer(tty);
89}
Alan Coxf34d7a52008-04-30 00:54:13 -070090EXPORT_SYMBOL(tty_driver_flush_buffer);
91
Alan Coxd81ed102008-10-13 10:41:42 +010092/**
93 * tty_throttle - flow control
94 * @tty: terminal
95 *
96 * Indicate that a tty should stop transmitting data down the stack.
Alan Cox38db8972009-06-11 12:44:17 +010097 * Takes the termios mutex to protect against parallel throttle/unthrottle
98 * and also to ensure the driver can consistently reference its own
99 * termios data at this point when implementing software flow control.
Alan Coxd81ed102008-10-13 10:41:42 +0100100 */
101
Alan Cox39c2e602008-04-30 00:54:18 -0700102void tty_throttle(struct tty_struct *tty)
103{
Alan Cox38db8972009-06-11 12:44:17 +0100104 mutex_lock(&tty->termios_mutex);
Alan Cox39c2e602008-04-30 00:54:18 -0700105 /* check TTY_THROTTLED first so it indicates our state */
106 if (!test_and_set_bit(TTY_THROTTLED, &tty->flags) &&
107 tty->ops->throttle)
108 tty->ops->throttle(tty);
Alan Cox38db8972009-06-11 12:44:17 +0100109 mutex_unlock(&tty->termios_mutex);
Alan Cox39c2e602008-04-30 00:54:18 -0700110}
111EXPORT_SYMBOL(tty_throttle);
112
Alan Coxd81ed102008-10-13 10:41:42 +0100113/**
114 * tty_unthrottle - flow control
115 * @tty: terminal
116 *
117 * Indicate that a tty may continue transmitting data down the stack.
Alan Cox38db8972009-06-11 12:44:17 +0100118 * Takes the termios mutex to protect against parallel throttle/unthrottle
119 * and also to ensure the driver can consistently reference its own
120 * termios data at this point when implementing software flow control.
121 *
122 * Drivers should however remember that the stack can issue a throttle,
123 * then change flow control method, then unthrottle.
Alan Coxd81ed102008-10-13 10:41:42 +0100124 */
125
Alan Cox39c2e602008-04-30 00:54:18 -0700126void tty_unthrottle(struct tty_struct *tty)
127{
Alan Cox38db8972009-06-11 12:44:17 +0100128 mutex_lock(&tty->termios_mutex);
Alan Cox39c2e602008-04-30 00:54:18 -0700129 if (test_and_clear_bit(TTY_THROTTLED, &tty->flags) &&
130 tty->ops->unthrottle)
131 tty->ops->unthrottle(tty);
Alan Cox38db8972009-06-11 12:44:17 +0100132 mutex_unlock(&tty->termios_mutex);
Alan Cox39c2e602008-04-30 00:54:18 -0700133}
134EXPORT_SYMBOL(tty_unthrottle);
Alan Coxf34d7a52008-04-30 00:54:13 -0700135
Alan Coxaf9b8972006-08-27 01:24:01 -0700136/**
137 * tty_wait_until_sent - wait for I/O to finish
138 * @tty: tty we are waiting for
139 * @timeout: how long we will wait
140 *
141 * Wait for characters pending in a tty driver to hit the wire, or
142 * for a timeout to occur (eg due to flow control)
143 *
144 * Locking: none
145 */
146
Alan Cox355d95a2008-02-08 04:18:48 -0800147void tty_wait_until_sent(struct tty_struct *tty, long timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149#ifdef TTY_DEBUG_WAIT_UNTIL_SENT
150 char buf[64];
Alan Cox355d95a2008-02-08 04:18:48 -0800151
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 printk(KERN_DEBUG "%s wait until sent...\n", tty_name(tty, buf));
153#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 if (!timeout)
155 timeout = MAX_SCHEDULE_TIMEOUT;
Jiri Slaby5a52bd42007-07-15 23:40:18 -0700156 if (wait_event_interruptible_timeout(tty->write_wait,
Alan Coxf34d7a52008-04-30 00:54:13 -0700157 !tty_chars_in_buffer(tty), timeout) >= 0) {
158 if (tty->ops->wait_until_sent)
159 tty->ops->wait_until_sent(tty, timeout);
Alan Cox0ee9cbb2008-04-30 00:53:32 -0700160 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162EXPORT_SYMBOL(tty_wait_until_sent);
163
Alan Coxd81ed102008-10-13 10:41:42 +0100164
165/*
166 * Termios Helper Methods
167 */
168
Alan Coxedc6afc2006-12-08 02:38:44 -0800169static void unset_locked_termios(struct ktermios *termios,
170 struct ktermios *old,
171 struct ktermios *locked)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172{
173 int i;
Alan Cox355d95a2008-02-08 04:18:48 -0800174
175#define NOSET_MASK(x, y, z) (x = ((x) & ~(z)) | ((y) & (z)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177 if (!locked) {
178 printk(KERN_WARNING "Warning?!? termios_locked is NULL.\n");
179 return;
180 }
181
182 NOSET_MASK(termios->c_iflag, old->c_iflag, locked->c_iflag);
183 NOSET_MASK(termios->c_oflag, old->c_oflag, locked->c_oflag);
184 NOSET_MASK(termios->c_cflag, old->c_cflag, locked->c_cflag);
185 NOSET_MASK(termios->c_lflag, old->c_lflag, locked->c_lflag);
186 termios->c_line = locked->c_line ? old->c_line : termios->c_line;
Alan Cox355d95a2008-02-08 04:18:48 -0800187 for (i = 0; i < NCCS; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 termios->c_cc[i] = locked->c_cc[i] ?
189 old->c_cc[i] : termios->c_cc[i];
Alan Coxedc6afc2006-12-08 02:38:44 -0800190 /* FIXME: What should we do for i/ospeed */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191}
192
Alan Coxedc6afc2006-12-08 02:38:44 -0800193/*
194 * Routine which returns the baud rate of the tty
195 *
196 * Note that the baud_table needs to be kept in sync with the
197 * include/asm/termbits.h file.
198 */
199static const speed_t baud_table[] = {
200 0, 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800,
201 9600, 19200, 38400, 57600, 115200, 230400, 460800,
202#ifdef __sparc__
203 76800, 153600, 307200, 614400, 921600
204#else
205 500000, 576000, 921600, 1000000, 1152000, 1500000, 2000000,
206 2500000, 3000000, 3500000, 4000000
207#endif
208};
209
210#ifndef __sparc__
211static const tcflag_t baud_bits[] = {
212 B0, B50, B75, B110, B134, B150, B200, B300, B600,
213 B1200, B1800, B2400, B4800, B9600, B19200, B38400,
214 B57600, B115200, B230400, B460800, B500000, B576000,
215 B921600, B1000000, B1152000, B1500000, B2000000, B2500000,
216 B3000000, B3500000, B4000000
217};
218#else
219static const tcflag_t baud_bits[] = {
220 B0, B50, B75, B110, B134, B150, B200, B300, B600,
221 B1200, B1800, B2400, B4800, B9600, B19200, B38400,
222 B57600, B115200, B230400, B460800, B76800, B153600,
223 B307200, B614400, B921600
224};
225#endif
226
227static int n_baud_table = ARRAY_SIZE(baud_table);
228
229/**
230 * tty_termios_baud_rate
231 * @termios: termios structure
232 *
233 * Convert termios baud rate data into a speed. This should be called
234 * with the termios lock held if this termios is a terminal termios
235 * structure. May change the termios data. Device drivers can call this
236 * function but should use ->c_[io]speed directly as they are updated.
237 *
238 * Locking: none
239 */
240
241speed_t tty_termios_baud_rate(struct ktermios *termios)
242{
243 unsigned int cbaud;
244
245 cbaud = termios->c_cflag & CBAUD;
246
247#ifdef BOTHER
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300248 /* Magic token for arbitrary speed via c_ispeed/c_ospeed */
Alan Coxedc6afc2006-12-08 02:38:44 -0800249 if (cbaud == BOTHER)
250 return termios->c_ospeed;
251#endif
252 if (cbaud & CBAUDEX) {
253 cbaud &= ~CBAUDEX;
254
255 if (cbaud < 1 || cbaud + 15 > n_baud_table)
256 termios->c_cflag &= ~CBAUDEX;
257 else
258 cbaud += 15;
259 }
260 return baud_table[cbaud];
261}
Alan Coxedc6afc2006-12-08 02:38:44 -0800262EXPORT_SYMBOL(tty_termios_baud_rate);
263
264/**
265 * tty_termios_input_baud_rate
266 * @termios: termios structure
267 *
268 * Convert termios baud rate data into a speed. This should be called
269 * with the termios lock held if this termios is a terminal termios
270 * structure. May change the termios data. Device drivers can call this
271 * function but should use ->c_[io]speed directly as they are updated.
272 *
273 * Locking: none
274 */
275
276speed_t tty_termios_input_baud_rate(struct ktermios *termios)
277{
278#ifdef IBSHIFT
279 unsigned int cbaud = (termios->c_cflag >> IBSHIFT) & CBAUD;
280
281 if (cbaud == B0)
282 return tty_termios_baud_rate(termios);
283
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300284 /* Magic token for arbitrary speed via c_ispeed*/
Alan Coxedc6afc2006-12-08 02:38:44 -0800285 if (cbaud == BOTHER)
286 return termios->c_ispeed;
287
288 if (cbaud & CBAUDEX) {
289 cbaud &= ~CBAUDEX;
290
291 if (cbaud < 1 || cbaud + 15 > n_baud_table)
292 termios->c_cflag &= ~(CBAUDEX << IBSHIFT);
293 else
294 cbaud += 15;
295 }
296 return baud_table[cbaud];
297#else
298 return tty_termios_baud_rate(termios);
299#endif
300}
Alan Coxedc6afc2006-12-08 02:38:44 -0800301EXPORT_SYMBOL(tty_termios_input_baud_rate);
302
Alan Coxedc6afc2006-12-08 02:38:44 -0800303/**
304 * tty_termios_encode_baud_rate
Alan Cox78137e32007-02-10 01:45:57 -0800305 * @termios: ktermios structure holding user requested state
Alan Coxedc6afc2006-12-08 02:38:44 -0800306 * @ispeed: input speed
307 * @ospeed: output speed
308 *
309 * Encode the speeds set into the passed termios structure. This is
Uwe Kleine-Königf98e5b82011-04-12 09:59:29 +0200310 * used as a library helper for drivers so that they can report back
Alan Coxedc6afc2006-12-08 02:38:44 -0800311 * the actual speed selected when it differs from the speed requested
312 *
Alan Cox78137e32007-02-10 01:45:57 -0800313 * For maximal back compatibility with legacy SYS5/POSIX *nix behaviour
314 * we need to carefully set the bits when the user does not get the
315 * desired speed. We allow small margins and preserve as much of possible
Dirk Hohndel06fe9fb2009-09-28 21:43:57 -0400316 * of the input intent to keep compatibility.
Alan Coxedc6afc2006-12-08 02:38:44 -0800317 *
318 * Locking: Caller should hold termios lock. This is already held
319 * when calling this function from the driver termios handler.
Alan Cox5f519d72007-10-16 23:30:07 -0700320 *
321 * The ifdefs deal with platforms whose owners have yet to update them
322 * and will all go away once this is done.
Alan Coxedc6afc2006-12-08 02:38:44 -0800323 */
324
Maciej W. Rozycki75e8b712007-10-18 03:04:35 -0700325void tty_termios_encode_baud_rate(struct ktermios *termios,
326 speed_t ibaud, speed_t obaud)
Alan Coxedc6afc2006-12-08 02:38:44 -0800327{
328 int i = 0;
Alan Cox78137e32007-02-10 01:45:57 -0800329 int ifound = -1, ofound = -1;
330 int iclose = ibaud/50, oclose = obaud/50;
331 int ibinput = 0;
Alan Coxedc6afc2006-12-08 02:38:44 -0800332
Alan Cox5f519d72007-10-16 23:30:07 -0700333 if (obaud == 0) /* CD dropped */
334 ibaud = 0; /* Clear ibaud to be sure */
335
Alan Coxedc6afc2006-12-08 02:38:44 -0800336 termios->c_ispeed = ibaud;
337 termios->c_ospeed = obaud;
338
Alan Cox5f519d72007-10-16 23:30:07 -0700339#ifdef BOTHER
Alan Cox78137e32007-02-10 01:45:57 -0800340 /* If the user asked for a precise weird speed give a precise weird
341 answer. If they asked for a Bfoo speed they many have problems
342 digesting non-exact replies so fuzz a bit */
343
344 if ((termios->c_cflag & CBAUD) == BOTHER)
345 oclose = 0;
346 if (((termios->c_cflag >> IBSHIFT) & CBAUD) == BOTHER)
347 iclose = 0;
348 if ((termios->c_cflag >> IBSHIFT) & CBAUD)
349 ibinput = 1; /* An input speed was specified */
Alan Cox5f519d72007-10-16 23:30:07 -0700350#endif
Alan Coxedc6afc2006-12-08 02:38:44 -0800351 termios->c_cflag &= ~CBAUD;
Alan Coxedc6afc2006-12-08 02:38:44 -0800352
Alan Cox5f519d72007-10-16 23:30:07 -0700353 /*
354 * Our goal is to find a close match to the standard baud rate
355 * returned. Walk the baud rate table and if we get a very close
356 * match then report back the speed as a POSIX Bxxxx value by
357 * preference
358 */
359
Alan Coxedc6afc2006-12-08 02:38:44 -0800360 do {
Maciej W. Rozycki75e8b712007-10-18 03:04:35 -0700361 if (obaud - oclose <= baud_table[i] &&
362 obaud + oclose >= baud_table[i]) {
Alan Coxedc6afc2006-12-08 02:38:44 -0800363 termios->c_cflag |= baud_bits[i];
Alan Cox78137e32007-02-10 01:45:57 -0800364 ofound = i;
Alan Coxedc6afc2006-12-08 02:38:44 -0800365 }
Maciej W. Rozycki75e8b712007-10-18 03:04:35 -0700366 if (ibaud - iclose <= baud_table[i] &&
367 ibaud + iclose >= baud_table[i]) {
368 /* For the case input == output don't set IBAUD bits
369 if the user didn't do so */
Alan Cox5f519d72007-10-16 23:30:07 -0700370 if (ofound == i && !ibinput)
371 ifound = i;
372#ifdef IBSHIFT
373 else {
374 ifound = i;
Alan Cox78137e32007-02-10 01:45:57 -0800375 termios->c_cflag |= (baud_bits[i] << IBSHIFT);
Alan Cox5f519d72007-10-16 23:30:07 -0700376 }
377#endif
Alan Coxedc6afc2006-12-08 02:38:44 -0800378 }
Jiri Slaby68043962007-07-15 23:40:18 -0700379 } while (++i < n_baud_table);
Alan Cox5f519d72007-10-16 23:30:07 -0700380
381 /*
382 * If we found no match then use BOTHER if provided or warn
383 * the user their platform maintainer needs to wake up if not.
384 */
385#ifdef BOTHER
Alan Cox78137e32007-02-10 01:45:57 -0800386 if (ofound == -1)
Alan Coxedc6afc2006-12-08 02:38:44 -0800387 termios->c_cflag |= BOTHER;
Alan Cox78137e32007-02-10 01:45:57 -0800388 /* Set exact input bits only if the input and output differ or the
389 user already did */
Jiri Slaby68043962007-07-15 23:40:18 -0700390 if (ifound == -1 && (ibaud != obaud || ibinput))
Alan Coxedc6afc2006-12-08 02:38:44 -0800391 termios->c_cflag |= (BOTHER << IBSHIFT);
Alan Cox5f519d72007-10-16 23:30:07 -0700392#else
393 if (ifound == -1 || ofound == -1) {
Marcin Slusarz9074d962009-08-09 21:54:03 +0200394 printk_once(KERN_WARNING "tty: Unable to return correct "
Alan Cox5f519d72007-10-16 23:30:07 -0700395 "speed data as your architecture needs updating.\n");
396 }
397#endif
Alan Coxedc6afc2006-12-08 02:38:44 -0800398}
Alan Coxedc6afc2006-12-08 02:38:44 -0800399EXPORT_SYMBOL_GPL(tty_termios_encode_baud_rate);
400
Alan Coxd81ed102008-10-13 10:41:42 +0100401/**
402 * tty_encode_baud_rate - set baud rate of the tty
403 * @ibaud: input baud rate
404 * @obad: output baud rate
405 *
406 * Update the current termios data for the tty with the new speed
407 * settings. The caller must hold the termios_mutex for the tty in
408 * question.
409 */
410
Alan Cox5f519d72007-10-16 23:30:07 -0700411void tty_encode_baud_rate(struct tty_struct *tty, speed_t ibaud, speed_t obaud)
412{
Alan Coxadc8d742012-07-14 15:31:47 +0100413 tty_termios_encode_baud_rate(&tty->termios, ibaud, obaud);
Alan Cox5f519d72007-10-16 23:30:07 -0700414}
415EXPORT_SYMBOL_GPL(tty_encode_baud_rate);
Alan Coxedc6afc2006-12-08 02:38:44 -0800416
417/**
418 * tty_get_baud_rate - get tty bit rates
419 * @tty: tty to query
420 *
421 * Returns the baud rate as an integer for this terminal. The
422 * termios lock must be held by the caller and the terminal bit
423 * flags may be updated.
424 *
425 * Locking: none
426 */
427
428speed_t tty_get_baud_rate(struct tty_struct *tty)
429{
Alan Coxadc8d742012-07-14 15:31:47 +0100430 speed_t baud = tty_termios_baud_rate(&tty->termios);
Alan Coxedc6afc2006-12-08 02:38:44 -0800431
432 if (baud == 38400 && tty->alt_speed) {
433 if (!tty->warned) {
434 printk(KERN_WARNING "Use of setserial/setrocket to "
435 "set SPD_* flags is deprecated\n");
436 tty->warned = 1;
437 }
438 baud = tty->alt_speed;
439 }
440
441 return baud;
442}
Alan Coxedc6afc2006-12-08 02:38:44 -0800443EXPORT_SYMBOL(tty_get_baud_rate);
444
Alan Coxaf9b8972006-08-27 01:24:01 -0700445/**
Alan Cox5f519d72007-10-16 23:30:07 -0700446 * tty_termios_copy_hw - copy hardware settings
447 * @new: New termios
448 * @old: Old termios
449 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300450 * Propagate the hardware specific terminal setting bits from
Alan Cox5f519d72007-10-16 23:30:07 -0700451 * the old termios structure to the new one. This is used in cases
452 * where the hardware does not support reconfiguration or as a helper
453 * in some cases where only minimal reconfiguration is supported
454 */
455
456void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old)
457{
458 /* The bits a dumb device handles in software. Smart devices need
459 to always provide a set_termios method */
460 new->c_cflag &= HUPCL | CREAD | CLOCAL;
461 new->c_cflag |= old->c_cflag & ~(HUPCL | CREAD | CLOCAL);
462 new->c_ispeed = old->c_ispeed;
463 new->c_ospeed = old->c_ospeed;
464}
Alan Cox5f519d72007-10-16 23:30:07 -0700465EXPORT_SYMBOL(tty_termios_copy_hw);
466
467/**
Alan Coxbf5e5832008-01-08 14:55:51 +0000468 * tty_termios_hw_change - check for setting change
469 * @a: termios
470 * @b: termios to compare
471 *
472 * Check if any of the bits that affect a dumb device have changed
473 * between the two termios structures, or a speed change is needed.
474 */
475
476int tty_termios_hw_change(struct ktermios *a, struct ktermios *b)
477{
478 if (a->c_ispeed != b->c_ispeed || a->c_ospeed != b->c_ospeed)
479 return 1;
480 if ((a->c_cflag ^ b->c_cflag) & ~(HUPCL | CREAD | CLOCAL))
481 return 1;
482 return 0;
483}
484EXPORT_SYMBOL(tty_termios_hw_change);
485
486/**
Alan Cox8d075b12011-02-14 16:27:53 +0000487 * tty_set_termios - update termios values
Alan Coxaf9b8972006-08-27 01:24:01 -0700488 * @tty: tty to update
489 * @new_termios: desired new value
490 *
491 * Perform updates to the termios values set on this terminal. There
492 * is a bit of layering violation here with n_tty in terms of the
493 * internal knowledge of this function.
494 *
Alan Coxd81ed102008-10-13 10:41:42 +0100495 * Locking: termios_mutex
Alan Coxaf9b8972006-08-27 01:24:01 -0700496 */
497
Alan Cox8d075b12011-02-14 16:27:53 +0000498int tty_set_termios(struct tty_struct *tty, struct ktermios *new_termios)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499{
Alan Cox978e5952008-04-30 00:53:59 -0700500 struct ktermios old_termios;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 struct tty_ldisc *ld;
Alan Cox04f378b2008-04-30 00:53:29 -0700502 unsigned long flags;
Alan Cox355d95a2008-02-08 04:18:48 -0800503
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 /*
505 * Perform the actual termios internal changes under lock.
506 */
Alan Cox355d95a2008-02-08 04:18:48 -0800507
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
509 /* FIXME: we need to decide on some locking/ordering semantics
510 for the set_termios notification eventually */
Arjan van de Ven5785c952006-09-29 02:00:43 -0700511 mutex_lock(&tty->termios_mutex);
Alan Coxadc8d742012-07-14 15:31:47 +0100512 old_termios = tty->termios;
513 tty->termios = *new_termios;
514 unset_locked_termios(&tty->termios, &old_termios, &tty->termios_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
516 /* See if packet mode change of state. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 if (tty->link && tty->link->packet) {
hyc@symas.com26df6d12010-06-22 10:14:49 -0700518 int extproc = (old_termios.c_lflag & EXTPROC) |
Alan Coxadc8d742012-07-14 15:31:47 +0100519 (tty->termios.c_lflag & EXTPROC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 int old_flow = ((old_termios.c_iflag & IXON) &&
521 (old_termios.c_cc[VSTOP] == '\023') &&
522 (old_termios.c_cc[VSTART] == '\021'));
523 int new_flow = (I_IXON(tty) &&
524 STOP_CHAR(tty) == '\023' &&
525 START_CHAR(tty) == '\021');
hyc@symas.com26df6d12010-06-22 10:14:49 -0700526 if ((old_flow != new_flow) || extproc) {
Alan Cox04f378b2008-04-30 00:53:29 -0700527 spin_lock_irqsave(&tty->ctrl_lock, flags);
hyc@symas.com26df6d12010-06-22 10:14:49 -0700528 if (old_flow != new_flow) {
529 tty->ctrl_status &= ~(TIOCPKT_DOSTOP | TIOCPKT_NOSTOP);
530 if (new_flow)
531 tty->ctrl_status |= TIOCPKT_DOSTOP;
532 else
533 tty->ctrl_status |= TIOCPKT_NOSTOP;
534 }
535 if (extproc)
536 tty->ctrl_status |= TIOCPKT_IOCTL;
Alan Cox04f378b2008-04-30 00:53:29 -0700537 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 wake_up_interruptible(&tty->link->read_wait);
539 }
540 }
Alan Cox355d95a2008-02-08 04:18:48 -0800541
Alan Coxf34d7a52008-04-30 00:54:13 -0700542 if (tty->ops->set_termios)
543 (*tty->ops->set_termios)(tty, &old_termios);
Alan Cox5f519d72007-10-16 23:30:07 -0700544 else
Alan Coxadc8d742012-07-14 15:31:47 +0100545 tty_termios_copy_hw(&tty->termios, &old_termios);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
547 ld = tty_ldisc_ref(tty);
548 if (ld != NULL) {
Alan Coxa352def2008-07-16 21:53:12 +0100549 if (ld->ops->set_termios)
550 (ld->ops->set_termios)(tty, &old_termios);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 tty_ldisc_deref(ld);
552 }
Arjan van de Ven5785c952006-09-29 02:00:43 -0700553 mutex_unlock(&tty->termios_mutex);
Alan Cox8d075b12011-02-14 16:27:53 +0000554 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555}
Alan Cox8d075b12011-02-14 16:27:53 +0000556EXPORT_SYMBOL_GPL(tty_set_termios);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
Alan Coxaf9b8972006-08-27 01:24:01 -0700558/**
559 * set_termios - set termios values for a tty
560 * @tty: terminal device
561 * @arg: user data
562 * @opt: option information
563 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200564 * Helper function to prepare termios data and run necessary other
Alan Cox8d075b12011-02-14 16:27:53 +0000565 * functions before using tty_set_termios to do the actual changes.
Alan Coxaf9b8972006-08-27 01:24:01 -0700566 *
567 * Locking:
Alan Coxd81ed102008-10-13 10:41:42 +0100568 * Called functions take ldisc and termios_mutex locks
Alan Coxaf9b8972006-08-27 01:24:01 -0700569 */
570
Alan Cox355d95a2008-02-08 04:18:48 -0800571static int set_termios(struct tty_struct *tty, void __user *arg, int opt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572{
Alan Coxedc6afc2006-12-08 02:38:44 -0800573 struct ktermios tmp_termios;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 struct tty_ldisc *ld;
575 int retval = tty_check_change(tty);
576
577 if (retval)
578 return retval;
579
Alan Cox978e5952008-04-30 00:53:59 -0700580 mutex_lock(&tty->termios_mutex);
Alan Coxadc8d742012-07-14 15:31:47 +0100581 tmp_termios = tty->termios;
Alan Cox978e5952008-04-30 00:53:59 -0700582 mutex_unlock(&tty->termios_mutex);
Alan Cox64bb6c52006-12-08 02:38:47 -0800583
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 if (opt & TERMIOS_TERMIO) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 if (user_termio_to_kernel_termios(&tmp_termios,
586 (struct termio __user *)arg))
587 return -EFAULT;
Alan Coxedc6afc2006-12-08 02:38:44 -0800588#ifdef TCGETS2
589 } else if (opt & TERMIOS_OLD) {
Alan Coxedc6afc2006-12-08 02:38:44 -0800590 if (user_termios_to_kernel_termios_1(&tmp_termios,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 (struct termios __user *)arg))
592 return -EFAULT;
Alan Cox64bb6c52006-12-08 02:38:47 -0800593 } else {
594 if (user_termios_to_kernel_termios(&tmp_termios,
595 (struct termios2 __user *)arg))
596 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 }
Alan Cox64bb6c52006-12-08 02:38:47 -0800598#else
599 } else if (user_termios_to_kernel_termios(&tmp_termios,
600 (struct termios __user *)arg))
601 return -EFAULT;
602#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
Alan Cox355d95a2008-02-08 04:18:48 -0800604 /* If old style Bfoo values are used then load c_ispeed/c_ospeed
605 * with the real speed so its unconditionally usable */
Alan Coxedc6afc2006-12-08 02:38:44 -0800606 tmp_termios.c_ispeed = tty_termios_input_baud_rate(&tmp_termios);
607 tmp_termios.c_ospeed = tty_termios_baud_rate(&tmp_termios);
608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 ld = tty_ldisc_ref(tty);
Alan Cox355d95a2008-02-08 04:18:48 -0800610
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 if (ld != NULL) {
Alan Coxa352def2008-07-16 21:53:12 +0100612 if ((opt & TERMIOS_FLUSH) && ld->ops->flush_buffer)
613 ld->ops->flush_buffer(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 tty_ldisc_deref(ld);
615 }
Alan Cox355d95a2008-02-08 04:18:48 -0800616
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 if (opt & TERMIOS_WAIT) {
618 tty_wait_until_sent(tty, 0);
619 if (signal_pending(current))
620 return -EINTR;
621 }
622
Alan Cox8d075b12011-02-14 16:27:53 +0000623 tty_set_termios(tty, &tmp_termios);
Alan Cox5f519d72007-10-16 23:30:07 -0700624
625 /* FIXME: Arguably if tmp_termios == tty->termios AND the
626 actual requested termios was not tmp_termios then we may
627 want to return an error as no user requested change has
628 succeeded */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 return 0;
630}
631
Alan Cox26a2e202009-06-11 14:03:13 +0100632static void copy_termios(struct tty_struct *tty, struct ktermios *kterm)
633{
634 mutex_lock(&tty->termios_mutex);
Alan Coxadc8d742012-07-14 15:31:47 +0100635 *kterm = tty->termios;
Alan Cox26a2e202009-06-11 14:03:13 +0100636 mutex_unlock(&tty->termios_mutex);
637}
638
639static void copy_termios_locked(struct tty_struct *tty, struct ktermios *kterm)
640{
641 mutex_lock(&tty->termios_mutex);
Alan Coxadc8d742012-07-14 15:31:47 +0100642 *kterm = tty->termios_locked;
Alan Cox26a2e202009-06-11 14:03:13 +0100643 mutex_unlock(&tty->termios_mutex);
644}
645
Alan Cox355d95a2008-02-08 04:18:48 -0800646static int get_termio(struct tty_struct *tty, struct termio __user *termio)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647{
Alan Cox26a2e202009-06-11 14:03:13 +0100648 struct ktermios kterm;
649 copy_termios(tty, &kterm);
650 if (kernel_termios_to_user_termio(termio, &kterm))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 return -EFAULT;
652 return 0;
653}
654
Alan Cox1d65b4a2008-10-13 10:38:18 +0100655
656#ifdef TCGETX
657
658/**
659 * set_termiox - set termiox fields if possible
660 * @tty: terminal
661 * @arg: termiox structure from user
662 * @opt: option flags for ioctl type
663 *
664 * Implement the device calling points for the SYS5 termiox ioctl
665 * interface in Linux
666 */
667
668static int set_termiox(struct tty_struct *tty, void __user *arg, int opt)
669{
670 struct termiox tnew;
671 struct tty_ldisc *ld;
672
673 if (tty->termiox == NULL)
674 return -EINVAL;
675 if (copy_from_user(&tnew, arg, sizeof(struct termiox)))
676 return -EFAULT;
677
678 ld = tty_ldisc_ref(tty);
679 if (ld != NULL) {
680 if ((opt & TERMIOS_FLUSH) && ld->ops->flush_buffer)
681 ld->ops->flush_buffer(tty);
682 tty_ldisc_deref(ld);
683 }
684 if (opt & TERMIOS_WAIT) {
685 tty_wait_until_sent(tty, 0);
686 if (signal_pending(current))
687 return -EINTR;
688 }
689
690 mutex_lock(&tty->termios_mutex);
691 if (tty->ops->set_termiox)
692 tty->ops->set_termiox(tty, &tnew);
693 mutex_unlock(&tty->termios_mutex);
694 return 0;
695}
696
697#endif
698
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699
700#ifdef TIOCGETP
701/*
702 * These are deprecated, but there is limited support..
703 *
704 * The "sg_flags" translation is a joke..
705 */
Alan Cox355d95a2008-02-08 04:18:48 -0800706static int get_sgflags(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707{
708 int flags = 0;
709
Alan Coxadc8d742012-07-14 15:31:47 +0100710 if (!(tty->termios.c_lflag & ICANON)) {
711 if (tty->termios.c_lflag & ISIG)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 flags |= 0x02; /* cbreak */
713 else
714 flags |= 0x20; /* raw */
715 }
Alan Coxadc8d742012-07-14 15:31:47 +0100716 if (tty->termios.c_lflag & ECHO)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 flags |= 0x08; /* echo */
Alan Coxadc8d742012-07-14 15:31:47 +0100718 if (tty->termios.c_oflag & OPOST)
719 if (tty->termios.c_oflag & ONLCR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 flags |= 0x10; /* crmod */
721 return flags;
722}
723
Alan Cox355d95a2008-02-08 04:18:48 -0800724static int get_sgttyb(struct tty_struct *tty, struct sgttyb __user *sgttyb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725{
726 struct sgttyb tmp;
727
Arjan van de Ven5785c952006-09-29 02:00:43 -0700728 mutex_lock(&tty->termios_mutex);
Alan Coxadc8d742012-07-14 15:31:47 +0100729 tmp.sg_ispeed = tty->termios.c_ispeed;
730 tmp.sg_ospeed = tty->termios.c_ospeed;
731 tmp.sg_erase = tty->termios.c_cc[VERASE];
732 tmp.sg_kill = tty->termios.c_cc[VKILL];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 tmp.sg_flags = get_sgflags(tty);
Arjan van de Ven5785c952006-09-29 02:00:43 -0700734 mutex_unlock(&tty->termios_mutex);
Alan Cox355d95a2008-02-08 04:18:48 -0800735
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 return copy_to_user(sgttyb, &tmp, sizeof(tmp)) ? -EFAULT : 0;
737}
738
Alan Cox355d95a2008-02-08 04:18:48 -0800739static void set_sgflags(struct ktermios *termios, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740{
Alan Cox9833fac2012-07-17 17:05:40 +0100741 termios->c_iflag = ICRNL | IXON;
742 termios->c_oflag = 0;
743 termios->c_lflag = ISIG | ICANON;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 if (flags & 0x02) { /* cbreak */
Alan Cox9833fac2012-07-17 17:05:40 +0100745 termios->c_iflag = 0;
746 termios->c_lflag &= ~ICANON;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 }
748 if (flags & 0x08) { /* echo */
Alan Cox9833fac2012-07-17 17:05:40 +0100749 termios->c_lflag |= ECHO | ECHOE | ECHOK |
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 ECHOCTL | ECHOKE | IEXTEN;
751 }
752 if (flags & 0x10) { /* crmod */
Alan Cox9833fac2012-07-17 17:05:40 +0100753 termios->c_oflag |= OPOST | ONLCR;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 }
755 if (flags & 0x20) { /* raw */
Alan Cox9833fac2012-07-17 17:05:40 +0100756 termios->c_iflag = 0;
757 termios->c_lflag &= ~(ISIG | ICANON);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 }
Alan Cox9833fac2012-07-17 17:05:40 +0100759 if (!(termios->c_lflag & ICANON)) {
760 termios->c_cc[VMIN] = 1;
761 termios->c_cc[VTIME] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 }
763}
764
Alan Coxaf9b8972006-08-27 01:24:01 -0700765/**
766 * set_sgttyb - set legacy terminal values
767 * @tty: tty structure
768 * @sgttyb: pointer to old style terminal structure
769 *
770 * Updates a terminal from the legacy BSD style terminal information
771 * structure.
772 *
Alan Coxd81ed102008-10-13 10:41:42 +0100773 * Locking: termios_mutex
Alan Coxaf9b8972006-08-27 01:24:01 -0700774 */
775
Alan Cox355d95a2008-02-08 04:18:48 -0800776static int set_sgttyb(struct tty_struct *tty, struct sgttyb __user *sgttyb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777{
778 int retval;
779 struct sgttyb tmp;
Alan Coxedc6afc2006-12-08 02:38:44 -0800780 struct ktermios termios;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781
782 retval = tty_check_change(tty);
783 if (retval)
784 return retval;
Alan Cox355d95a2008-02-08 04:18:48 -0800785
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 if (copy_from_user(&tmp, sgttyb, sizeof(tmp)))
787 return -EFAULT;
788
Arjan van de Ven5785c952006-09-29 02:00:43 -0700789 mutex_lock(&tty->termios_mutex);
Alan Coxadc8d742012-07-14 15:31:47 +0100790 termios = tty->termios;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 termios.c_cc[VERASE] = tmp.sg_erase;
792 termios.c_cc[VKILL] = tmp.sg_kill;
793 set_sgflags(&termios, tmp.sg_flags);
Alan Coxedc6afc2006-12-08 02:38:44 -0800794 /* Try and encode into Bfoo format */
795#ifdef BOTHER
Alan Cox355d95a2008-02-08 04:18:48 -0800796 tty_termios_encode_baud_rate(&termios, termios.c_ispeed,
797 termios.c_ospeed);
Alan Coxedc6afc2006-12-08 02:38:44 -0800798#endif
Arjan van de Ven5785c952006-09-29 02:00:43 -0700799 mutex_unlock(&tty->termios_mutex);
Alan Cox8d075b12011-02-14 16:27:53 +0000800 tty_set_termios(tty, &termios);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 return 0;
802}
803#endif
804
805#ifdef TIOCGETC
Alan Cox355d95a2008-02-08 04:18:48 -0800806static int get_tchars(struct tty_struct *tty, struct tchars __user *tchars)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807{
808 struct tchars tmp;
809
Alan Cox978e5952008-04-30 00:53:59 -0700810 mutex_lock(&tty->termios_mutex);
Alan Coxadc8d742012-07-14 15:31:47 +0100811 tmp.t_intrc = tty->termios.c_cc[VINTR];
812 tmp.t_quitc = tty->termios.c_cc[VQUIT];
813 tmp.t_startc = tty->termios.c_cc[VSTART];
814 tmp.t_stopc = tty->termios.c_cc[VSTOP];
815 tmp.t_eofc = tty->termios.c_cc[VEOF];
816 tmp.t_brkc = tty->termios.c_cc[VEOL2]; /* what is brkc anyway? */
Alan Cox978e5952008-04-30 00:53:59 -0700817 mutex_unlock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 return copy_to_user(tchars, &tmp, sizeof(tmp)) ? -EFAULT : 0;
819}
820
Alan Cox355d95a2008-02-08 04:18:48 -0800821static int set_tchars(struct tty_struct *tty, struct tchars __user *tchars)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822{
823 struct tchars tmp;
824
825 if (copy_from_user(&tmp, tchars, sizeof(tmp)))
826 return -EFAULT;
Alan Cox978e5952008-04-30 00:53:59 -0700827 mutex_lock(&tty->termios_mutex);
Alan Coxadc8d742012-07-14 15:31:47 +0100828 tty->termios.c_cc[VINTR] = tmp.t_intrc;
829 tty->termios.c_cc[VQUIT] = tmp.t_quitc;
830 tty->termios.c_cc[VSTART] = tmp.t_startc;
831 tty->termios.c_cc[VSTOP] = tmp.t_stopc;
832 tty->termios.c_cc[VEOF] = tmp.t_eofc;
833 tty->termios.c_cc[VEOL2] = tmp.t_brkc; /* what is brkc anyway? */
Alan Cox978e5952008-04-30 00:53:59 -0700834 mutex_unlock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 return 0;
836}
837#endif
838
839#ifdef TIOCGLTC
Alan Cox355d95a2008-02-08 04:18:48 -0800840static int get_ltchars(struct tty_struct *tty, struct ltchars __user *ltchars)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841{
842 struct ltchars tmp;
843
Alan Cox978e5952008-04-30 00:53:59 -0700844 mutex_lock(&tty->termios_mutex);
Alan Coxadc8d742012-07-14 15:31:47 +0100845 tmp.t_suspc = tty->termios.c_cc[VSUSP];
Alan Cox355d95a2008-02-08 04:18:48 -0800846 /* what is dsuspc anyway? */
Alan Coxadc8d742012-07-14 15:31:47 +0100847 tmp.t_dsuspc = tty->termios.c_cc[VSUSP];
848 tmp.t_rprntc = tty->termios.c_cc[VREPRINT];
Alan Cox355d95a2008-02-08 04:18:48 -0800849 /* what is flushc anyway? */
Alan Coxadc8d742012-07-14 15:31:47 +0100850 tmp.t_flushc = tty->termios.c_cc[VEOL2];
851 tmp.t_werasc = tty->termios.c_cc[VWERASE];
852 tmp.t_lnextc = tty->termios.c_cc[VLNEXT];
Alan Cox978e5952008-04-30 00:53:59 -0700853 mutex_unlock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 return copy_to_user(ltchars, &tmp, sizeof(tmp)) ? -EFAULT : 0;
855}
856
Alan Cox355d95a2008-02-08 04:18:48 -0800857static int set_ltchars(struct tty_struct *tty, struct ltchars __user *ltchars)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858{
859 struct ltchars tmp;
860
861 if (copy_from_user(&tmp, ltchars, sizeof(tmp)))
862 return -EFAULT;
863
Alan Cox978e5952008-04-30 00:53:59 -0700864 mutex_lock(&tty->termios_mutex);
Alan Coxadc8d742012-07-14 15:31:47 +0100865 tty->termios.c_cc[VSUSP] = tmp.t_suspc;
Alan Cox355d95a2008-02-08 04:18:48 -0800866 /* what is dsuspc anyway? */
Alan Coxadc8d742012-07-14 15:31:47 +0100867 tty->termios.c_cc[VEOL2] = tmp.t_dsuspc;
868 tty->termios.c_cc[VREPRINT] = tmp.t_rprntc;
Alan Cox355d95a2008-02-08 04:18:48 -0800869 /* what is flushc anyway? */
Alan Coxadc8d742012-07-14 15:31:47 +0100870 tty->termios.c_cc[VEOL2] = tmp.t_flushc;
871 tty->termios.c_cc[VWERASE] = tmp.t_werasc;
872 tty->termios.c_cc[VLNEXT] = tmp.t_lnextc;
Alan Cox978e5952008-04-30 00:53:59 -0700873 mutex_unlock(&tty->termios_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 return 0;
875}
876#endif
877
Alan Coxaf9b8972006-08-27 01:24:01 -0700878/**
879 * send_prio_char - send priority character
880 *
881 * Send a high priority character to the tty even if stopped
882 *
Alan Cox5f412b22006-09-29 02:01:40 -0700883 * Locking: none for xchar method, write ordering for write method.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 */
Alan Coxaf9b8972006-08-27 01:24:01 -0700885
Alan Cox5f412b22006-09-29 02:01:40 -0700886static int send_prio_char(struct tty_struct *tty, char ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887{
888 int was_stopped = tty->stopped;
889
Alan Coxf34d7a52008-04-30 00:54:13 -0700890 if (tty->ops->send_xchar) {
891 tty->ops->send_xchar(tty, ch);
Alan Cox5f412b22006-09-29 02:01:40 -0700892 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 }
Alan Cox5f412b22006-09-29 02:01:40 -0700894
Alan Cox9c1729d2007-07-15 23:39:43 -0700895 if (tty_write_lock(tty, 0) < 0)
Alan Cox5f412b22006-09-29 02:01:40 -0700896 return -ERESTARTSYS;
897
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 if (was_stopped)
899 start_tty(tty);
Alan Coxf34d7a52008-04-30 00:54:13 -0700900 tty->ops->write(tty, &ch, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 if (was_stopped)
902 stop_tty(tty);
Alan Cox9c1729d2007-07-15 23:39:43 -0700903 tty_write_unlock(tty);
Alan Cox5f412b22006-09-29 02:01:40 -0700904 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905}
906
Alan Cox0fc00e22007-11-07 01:24:56 -0800907/**
Alan Cox1c2630c2008-04-30 00:53:34 -0700908 * tty_change_softcar - carrier change ioctl helper
909 * @tty: tty to update
910 * @arg: enable/disable CLOCAL
911 *
912 * Perform a change to the CLOCAL state and call into the driver
913 * layer to make it visible. All done with the termios mutex
914 */
915
916static int tty_change_softcar(struct tty_struct *tty, int arg)
917{
918 int ret = 0;
919 int bit = arg ? CLOCAL : 0;
Alan Coxf34d7a52008-04-30 00:54:13 -0700920 struct ktermios old;
Alan Cox1c2630c2008-04-30 00:53:34 -0700921
922 mutex_lock(&tty->termios_mutex);
Alan Coxadc8d742012-07-14 15:31:47 +0100923 old = tty->termios;
924 tty->termios.c_cflag &= ~CLOCAL;
925 tty->termios.c_cflag |= bit;
Alan Coxf34d7a52008-04-30 00:54:13 -0700926 if (tty->ops->set_termios)
927 tty->ops->set_termios(tty, &old);
Alan Coxadc8d742012-07-14 15:31:47 +0100928 if ((tty->termios.c_cflag & CLOCAL) != bit)
Alan Cox1c2630c2008-04-30 00:53:34 -0700929 ret = -EINVAL;
930 mutex_unlock(&tty->termios_mutex);
931 return ret;
932}
933
934/**
Alan Cox0fc00e22007-11-07 01:24:56 -0800935 * tty_mode_ioctl - mode related ioctls
936 * @tty: tty for the ioctl
937 * @file: file pointer for the tty
938 * @cmd: command
939 * @arg: ioctl argument
940 *
941 * Perform non line discipline specific mode control ioctls. This
942 * is designed to be called by line disciplines to ensure they provide
943 * consistent mode setting.
944 */
945
Alan Cox355d95a2008-02-08 04:18:48 -0800946int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
Alan Cox0fc00e22007-11-07 01:24:56 -0800947 unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948{
Alan Cox355d95a2008-02-08 04:18:48 -0800949 struct tty_struct *real_tty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 void __user *p = (void __user *)arg;
Alan Cox8f520022008-10-13 10:38:46 +0100951 int ret = 0;
Alan Cox26a2e202009-06-11 14:03:13 +0100952 struct ktermios kterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953
Alan Cox8d075b12011-02-14 16:27:53 +0000954 BUG_ON(file == NULL);
955
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
957 tty->driver->subtype == PTY_TYPE_MASTER)
958 real_tty = tty->link;
959 else
960 real_tty = tty;
961
962 switch (cmd) {
963#ifdef TIOCGETP
Alan Cox355d95a2008-02-08 04:18:48 -0800964 case TIOCGETP:
965 return get_sgttyb(real_tty, (struct sgttyb __user *) arg);
966 case TIOCSETP:
967 case TIOCSETN:
968 return set_sgttyb(real_tty, (struct sgttyb __user *) arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969#endif
970#ifdef TIOCGETC
Alan Cox355d95a2008-02-08 04:18:48 -0800971 case TIOCGETC:
972 return get_tchars(real_tty, p);
973 case TIOCSETC:
974 return set_tchars(real_tty, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975#endif
976#ifdef TIOCGLTC
Alan Cox355d95a2008-02-08 04:18:48 -0800977 case TIOCGLTC:
978 return get_ltchars(real_tty, p);
979 case TIOCSLTC:
980 return set_ltchars(real_tty, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981#endif
Alan Cox355d95a2008-02-08 04:18:48 -0800982 case TCSETSF:
983 return set_termios(real_tty, p, TERMIOS_FLUSH | TERMIOS_WAIT | TERMIOS_OLD);
984 case TCSETSW:
985 return set_termios(real_tty, p, TERMIOS_WAIT | TERMIOS_OLD);
986 case TCSETS:
987 return set_termios(real_tty, p, TERMIOS_OLD);
Alan Coxedc6afc2006-12-08 02:38:44 -0800988#ifndef TCGETS2
Alan Cox355d95a2008-02-08 04:18:48 -0800989 case TCGETS:
Alan Cox26a2e202009-06-11 14:03:13 +0100990 copy_termios(real_tty, &kterm);
991 if (kernel_termios_to_user_termios((struct termios __user *)arg, &kterm))
Alan Cox8f520022008-10-13 10:38:46 +0100992 ret = -EFAULT;
Alan Cox8f520022008-10-13 10:38:46 +0100993 return ret;
Alan Coxedc6afc2006-12-08 02:38:44 -0800994#else
Alan Cox355d95a2008-02-08 04:18:48 -0800995 case TCGETS:
Alan Cox26a2e202009-06-11 14:03:13 +0100996 copy_termios(real_tty, &kterm);
997 if (kernel_termios_to_user_termios_1((struct termios __user *)arg, &kterm))
Alan Cox8f520022008-10-13 10:38:46 +0100998 ret = -EFAULT;
Alan Cox8f520022008-10-13 10:38:46 +0100999 return ret;
Alan Cox355d95a2008-02-08 04:18:48 -08001000 case TCGETS2:
Alan Cox26a2e202009-06-11 14:03:13 +01001001 copy_termios(real_tty, &kterm);
1002 if (kernel_termios_to_user_termios((struct termios2 __user *)arg, &kterm))
Alan Cox8f520022008-10-13 10:38:46 +01001003 ret = -EFAULT;
Alan Cox8f520022008-10-13 10:38:46 +01001004 return ret;
Alan Cox355d95a2008-02-08 04:18:48 -08001005 case TCSETSF2:
1006 return set_termios(real_tty, p, TERMIOS_FLUSH | TERMIOS_WAIT);
1007 case TCSETSW2:
1008 return set_termios(real_tty, p, TERMIOS_WAIT);
1009 case TCSETS2:
1010 return set_termios(real_tty, p, 0);
Alan Coxedc6afc2006-12-08 02:38:44 -08001011#endif
Alan Cox355d95a2008-02-08 04:18:48 -08001012 case TCGETA:
1013 return get_termio(real_tty, p);
1014 case TCSETAF:
1015 return set_termios(real_tty, p, TERMIOS_FLUSH | TERMIOS_WAIT | TERMIOS_TERMIO);
1016 case TCSETAW:
1017 return set_termios(real_tty, p, TERMIOS_WAIT | TERMIOS_TERMIO);
1018 case TCSETA:
1019 return set_termios(real_tty, p, TERMIOS_TERMIO);
Alan Cox0fc00e22007-11-07 01:24:56 -08001020#ifndef TCGETS2
Alan Cox355d95a2008-02-08 04:18:48 -08001021 case TIOCGLCKTRMIOS:
Alan Cox26a2e202009-06-11 14:03:13 +01001022 copy_termios_locked(real_tty, &kterm);
1023 if (kernel_termios_to_user_termios((struct termios __user *)arg, &kterm))
Alan Cox8f520022008-10-13 10:38:46 +01001024 ret = -EFAULT;
Alan Cox8f520022008-10-13 10:38:46 +01001025 return ret;
Alan Cox355d95a2008-02-08 04:18:48 -08001026 case TIOCSLCKTRMIOS:
1027 if (!capable(CAP_SYS_ADMIN))
1028 return -EPERM;
Alan Cox26a2e202009-06-11 14:03:13 +01001029 copy_termios_locked(real_tty, &kterm);
1030 if (user_termios_to_kernel_termios(&kterm,
Alan Cox355d95a2008-02-08 04:18:48 -08001031 (struct termios __user *) arg))
Alan Cox26a2e202009-06-11 14:03:13 +01001032 return -EFAULT;
1033 mutex_lock(&real_tty->termios_mutex);
Alan Coxadc8d742012-07-14 15:31:47 +01001034 real_tty->termios_locked = kterm;
Alan Cox8f520022008-10-13 10:38:46 +01001035 mutex_unlock(&real_tty->termios_mutex);
Alan Cox26a2e202009-06-11 14:03:13 +01001036 return 0;
Alan Cox0fc00e22007-11-07 01:24:56 -08001037#else
Alan Cox355d95a2008-02-08 04:18:48 -08001038 case TIOCGLCKTRMIOS:
Alan Cox26a2e202009-06-11 14:03:13 +01001039 copy_termios_locked(real_tty, &kterm);
1040 if (kernel_termios_to_user_termios_1((struct termios __user *)arg, &kterm))
Alan Cox8f520022008-10-13 10:38:46 +01001041 ret = -EFAULT;
Alan Cox8f520022008-10-13 10:38:46 +01001042 return ret;
Alan Cox355d95a2008-02-08 04:18:48 -08001043 case TIOCSLCKTRMIOS:
1044 if (!capable(CAP_SYS_ADMIN))
Alan Cox26a2e202009-06-11 14:03:13 +01001045 return -EPERM;
1046 copy_termios_locked(real_tty, &kterm);
1047 if (user_termios_to_kernel_termios_1(&kterm,
Alan Cox355d95a2008-02-08 04:18:48 -08001048 (struct termios __user *) arg))
Alan Cox26a2e202009-06-11 14:03:13 +01001049 return -EFAULT;
1050 mutex_lock(&real_tty->termios_mutex);
Alan Coxadc8d742012-07-14 15:31:47 +01001051 real_tty->termios_locked = kterm;
Alan Cox8f520022008-10-13 10:38:46 +01001052 mutex_unlock(&real_tty->termios_mutex);
1053 return ret;
Alan Cox0fc00e22007-11-07 01:24:56 -08001054#endif
Alan Cox1d65b4a2008-10-13 10:38:18 +01001055#ifdef TCGETX
Mike Frysinger5dca6072009-06-16 17:01:02 +01001056 case TCGETX: {
1057 struct termiox ktermx;
Alan Cox1d65b4a2008-10-13 10:38:18 +01001058 if (real_tty->termiox == NULL)
1059 return -EINVAL;
Alan Cox8f520022008-10-13 10:38:46 +01001060 mutex_lock(&real_tty->termios_mutex);
Alan Cox26a2e202009-06-11 14:03:13 +01001061 memcpy(&ktermx, real_tty->termiox, sizeof(struct termiox));
Alan Cox8f520022008-10-13 10:38:46 +01001062 mutex_unlock(&real_tty->termios_mutex);
Alan Cox26a2e202009-06-11 14:03:13 +01001063 if (copy_to_user(p, &ktermx, sizeof(struct termiox)))
1064 ret = -EFAULT;
Alan Cox8f520022008-10-13 10:38:46 +01001065 return ret;
Mike Frysinger5dca6072009-06-16 17:01:02 +01001066 }
Alan Cox1d65b4a2008-10-13 10:38:18 +01001067 case TCSETX:
1068 return set_termiox(real_tty, p, 0);
1069 case TCSETXW:
1070 return set_termiox(real_tty, p, TERMIOS_WAIT);
1071 case TCSETXF:
1072 return set_termiox(real_tty, p, TERMIOS_FLUSH);
1073#endif
Alan Cox355d95a2008-02-08 04:18:48 -08001074 case TIOCGSOFTCAR:
Alan Cox26a2e202009-06-11 14:03:13 +01001075 copy_termios(real_tty, &kterm);
1076 ret = put_user((kterm.c_cflag & CLOCAL) ? 1 : 0,
Alan Cox355d95a2008-02-08 04:18:48 -08001077 (int __user *)arg);
Alan Cox8f520022008-10-13 10:38:46 +01001078 return ret;
Alan Cox355d95a2008-02-08 04:18:48 -08001079 case TIOCSSOFTCAR:
1080 if (get_user(arg, (unsigned int __user *) arg))
1081 return -EFAULT;
Alan Coxf753f322008-08-26 19:52:47 +01001082 return tty_change_softcar(real_tty, arg);
Alan Cox355d95a2008-02-08 04:18:48 -08001083 default:
1084 return -ENOIOCTLCMD;
Alan Cox0fc00e22007-11-07 01:24:56 -08001085 }
1086}
Alan Cox0fc00e22007-11-07 01:24:56 -08001087EXPORT_SYMBOL_GPL(tty_mode_ioctl);
1088
1089int tty_perform_flush(struct tty_struct *tty, unsigned long arg)
1090{
1091 struct tty_ldisc *ld;
1092 int retval = tty_check_change(tty);
1093 if (retval)
1094 return retval;
1095
Alan Coxc0253ee2009-01-15 13:30:25 +00001096 ld = tty_ldisc_ref_wait(tty);
Alan Cox0fc00e22007-11-07 01:24:56 -08001097 switch (arg) {
1098 case TCIFLUSH:
Alan Coxa352def2008-07-16 21:53:12 +01001099 if (ld && ld->ops->flush_buffer)
1100 ld->ops->flush_buffer(tty);
Alan Cox0fc00e22007-11-07 01:24:56 -08001101 break;
1102 case TCIOFLUSH:
Alan Coxa352def2008-07-16 21:53:12 +01001103 if (ld && ld->ops->flush_buffer)
1104 ld->ops->flush_buffer(tty);
Alan Cox0fc00e22007-11-07 01:24:56 -08001105 /* fall through */
1106 case TCOFLUSH:
Alan Coxf34d7a52008-04-30 00:54:13 -07001107 tty_driver_flush_buffer(tty);
Alan Cox0fc00e22007-11-07 01:24:56 -08001108 break;
1109 default:
1110 tty_ldisc_deref(ld);
1111 return -EINVAL;
1112 }
1113 tty_ldisc_deref(ld);
1114 return 0;
1115}
Alan Cox0fc00e22007-11-07 01:24:56 -08001116EXPORT_SYMBOL_GPL(tty_perform_flush);
1117
Alan Cox47afa7a2008-10-13 10:44:17 +01001118int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
Alan Cox0fc00e22007-11-07 01:24:56 -08001119 unsigned int cmd, unsigned long arg)
1120{
Alan Cox0fc00e22007-11-07 01:24:56 -08001121 int retval;
1122
Alan Cox0fc00e22007-11-07 01:24:56 -08001123 switch (cmd) {
Alan Cox355d95a2008-02-08 04:18:48 -08001124 case TCXONC:
1125 retval = tty_check_change(tty);
1126 if (retval)
1127 return retval;
1128 switch (arg) {
1129 case TCOOFF:
1130 if (!tty->flow_stopped) {
1131 tty->flow_stopped = 1;
1132 stop_tty(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 }
Alan Cox355d95a2008-02-08 04:18:48 -08001134 break;
1135 case TCOON:
1136 if (tty->flow_stopped) {
1137 tty->flow_stopped = 0;
1138 start_tty(tty);
1139 }
1140 break;
1141 case TCIOFF:
1142 if (STOP_CHAR(tty) != __DISABLED_CHAR)
1143 return send_prio_char(tty, STOP_CHAR(tty));
1144 break;
1145 case TCION:
1146 if (START_CHAR(tty) != __DISABLED_CHAR)
1147 return send_prio_char(tty, START_CHAR(tty));
1148 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 default:
Alan Cox355d95a2008-02-08 04:18:48 -08001150 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 }
Alan Cox355d95a2008-02-08 04:18:48 -08001152 return 0;
1153 case TCFLSH:
1154 return tty_perform_flush(tty, arg);
Alan Cox355d95a2008-02-08 04:18:48 -08001155 default:
1156 /* Try the mode commands */
1157 return tty_mode_ioctl(tty, file, cmd, arg);
1158 }
1159}
Alan Cox47afa7a2008-10-13 10:44:17 +01001160EXPORT_SYMBOL(n_tty_ioctl_helper);
Thomas Meyer8193c422011-10-05 23:13:13 +02001161
1162#ifdef CONFIG_COMPAT
1163long n_tty_compat_ioctl_helper(struct tty_struct *tty, struct file *file,
1164 unsigned int cmd, unsigned long arg)
1165{
1166 switch (cmd) {
1167 case TIOCGLCKTRMIOS:
1168 case TIOCSLCKTRMIOS:
1169 return tty_mode_ioctl(tty, file, cmd, (unsigned long) compat_ptr(arg));
1170 default:
1171 return -ENOIOCTLCMD;
1172 }
1173}
1174EXPORT_SYMBOL(n_tty_compat_ioctl_helper);
1175#endif
1176