blob: 268b62768f2b41eab5f7db4d4c5c8b9111f248b6 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * n_tty.c --- implements the N_TTY line discipline.
Alan Cox4edf1822008-02-08 04:18:44 -08003 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * This code used to be in tty_io.c, but things are getting hairy
5 * enough that it made sense to split things off. (The N_TTY
6 * processing has changed so much that it's hardly recognizable,
7 * anyway...)
8 *
9 * Note that the open routine for N_TTY is guaranteed never to return
10 * an error. This is because Linux will fall back to setting a line
Alan Cox4edf1822008-02-08 04:18:44 -080011 * to N_TTY if it can not switch to any other line discipline.
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 *
13 * Written by Theodore Ts'o, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080014 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 * This file also contains code originally written by Linus Torvalds,
16 * Copyright 1991, 1992, 1993, and by Julian Cowley, Copyright 1994.
Alan Cox4edf1822008-02-08 04:18:44 -080017 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 * This file may be redistributed under the terms of the GNU General Public
19 * License.
20 *
21 * Reduced memory usage for older ARM systems - Russell King.
22 *
Alan Cox4edf1822008-02-08 04:18:44 -080023 * 2000/01/20 Fixed SMP locking on put_tty_queue using bits of
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 * the patch by Andrew J. Kroll <ag784@freenet.buffalo.edu>
25 * who actually finally proved there really was a race.
26 *
27 * 2002/03/18 Implemented n_tty_wakeup to send SIGIO POLL_OUTs to
28 * waiting writing processes-Sapan Bhatia <sapan@corewars.org>.
Alan Cox11a96d12008-10-13 10:46:24 +010029 * Also fixed a bug in BLOCKING mode where n_tty_write returns
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 * EAGAIN
31 */
32
33#include <linux/types.h>
34#include <linux/major.h>
35#include <linux/errno.h>
36#include <linux/signal.h>
37#include <linux/fcntl.h>
38#include <linux/sched.h>
39#include <linux/interrupt.h>
40#include <linux/tty.h>
41#include <linux/timer.h>
42#include <linux/ctype.h>
43#include <linux/mm.h>
44#include <linux/string.h>
45#include <linux/slab.h>
46#include <linux/poll.h>
47#include <linux/bitops.h>
Miloslav Trmac522ed772007-07-15 23:40:56 -070048#include <linux/audit.h>
49#include <linux/file.h>
Alan Cox300a6202009-01-02 13:41:04 +000050#include <linux/uaccess.h>
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -080051#include <linux/module.h>
George Spelvin593fb1ae42013-02-12 02:00:43 -050052#include <linux/ratelimit.h>
Peter Hurley86e35ae2013-07-24 09:30:05 -040053#include <linux/vmalloc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56/* number of characters left in xmit buffer before select has we have room */
57#define WAKEUP_CHARS 256
58
59/*
60 * This defines the low- and high-watermarks for throttling and
61 * unthrottling the TTY driver. These watermarks are used for
62 * controlling the space in the read buffer.
63 */
64#define TTY_THRESHOLD_THROTTLE 128 /* now based on remaining room */
Thorsten Wißmannbbd20752011-12-08 17:47:33 +010065#define TTY_THRESHOLD_UNTHROTTLE 128
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Joe Petersona88a69c2009-01-02 13:40:53 +000067/*
68 * Special byte codes used in the echo buffer to represent operations
69 * or special handling of characters. Bytes in the echo buffer that
70 * are not part of such special blocks are treated as normal character
71 * codes.
72 */
73#define ECHO_OP_START 0xff
74#define ECHO_OP_MOVE_BACK_COL 0x80
75#define ECHO_OP_SET_CANON_COL 0x81
76#define ECHO_OP_ERASE_TAB 0x82
77
Peter Hurleycbfd0342013-06-15 10:04:26 -040078#define ECHO_COMMIT_WATERMARK 256
79#define ECHO_BLOCK 256
80#define ECHO_DISCARD_WATERMARK N_TTY_BUF_SIZE - (ECHO_BLOCK + 32)
81
82
Peter Hurley32f13522013-06-15 09:14:17 -040083#undef N_TTY_TRACE
84#ifdef N_TTY_TRACE
85# define n_tty_trace(f, args...) trace_printk(f, ##args)
86#else
87# define n_tty_trace(f, args...)
88#endif
89
Jiri Slaby70ece7a2012-10-18 22:26:38 +020090struct n_tty_data {
Peter Hurleyfb7aa032013-06-15 09:14:30 -040091 /* producer-published */
92 size_t read_head;
93 size_t canon_head;
Peter Hurley9dfd16d2013-06-15 10:04:29 -040094 size_t echo_head;
95 size_t echo_commit;
Peter Hurley1bb9d562013-06-15 10:21:20 -040096 DECLARE_BITMAP(char_map, 256);
Peter Hurleyfb7aa032013-06-15 09:14:30 -040097
98 /* private to n_tty_receive_overrun (single-threaded) */
Jiri Slaby53c5ee22012-10-18 22:26:39 +020099 unsigned long overrun_time;
100 int num_overrun;
101
Peter Hurley24a89d12013-06-15 09:14:15 -0400102 /* non-atomic */
103 bool no_room;
104
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400105 /* must hold exclusive termios_rwsem to reset these */
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200106 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200107
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400108 /* shared by producer and consumer */
Peter Hurley20bafb32013-06-15 10:21:19 -0400109 char read_buf[N_TTY_BUF_SIZE];
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200110 DECLARE_BITMAP(read_flags, N_TTY_BUF_SIZE);
Peter Hurley20bafb32013-06-15 10:21:19 -0400111 unsigned char echo_buf[N_TTY_BUF_SIZE];
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200112
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -0400113 int minimum_to_wake;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200114
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400115 /* consumer-published */
116 size_t read_tail;
Peter Hurley40d5e092013-06-15 10:21:17 -0400117 size_t line_start;
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400118
Peter Hurleyfb7aa032013-06-15 09:14:30 -0400119 /* protected by output lock */
120 unsigned int column;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200121 unsigned int canon_column;
Peter Hurley9dfd16d2013-06-15 10:04:29 -0400122 size_t echo_tail;
Jiri Slabybddc7152012-10-18 22:26:42 +0200123
124 struct mutex atomic_read_lock;
125 struct mutex output_lock;
Jiri Slaby70ece7a2012-10-18 22:26:38 +0200126};
127
Peter Hurleyce741172013-06-15 09:14:20 -0400128static inline size_t read_cnt(struct n_tty_data *ldata)
129{
Peter Hurleya2f73be2013-06-15 09:14:22 -0400130 return ldata->read_head - ldata->read_tail;
Peter Hurleyce741172013-06-15 09:14:20 -0400131}
132
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400133static inline unsigned char read_buf(struct n_tty_data *ldata, size_t i)
134{
135 return ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
136}
137
138static inline unsigned char *read_buf_addr(struct n_tty_data *ldata, size_t i)
139{
140 return &ldata->read_buf[i & (N_TTY_BUF_SIZE - 1)];
141}
142
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400143static inline unsigned char echo_buf(struct n_tty_data *ldata, size_t i)
144{
145 return ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
146}
147
148static inline unsigned char *echo_buf_addr(struct n_tty_data *ldata, size_t i)
149{
150 return &ldata->echo_buf[i & (N_TTY_BUF_SIZE - 1)];
151}
152
Miloslav Trmac522ed772007-07-15 23:40:56 -0700153static inline int tty_put_user(struct tty_struct *tty, unsigned char x,
154 unsigned char __user *ptr)
155{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200156 struct n_tty_data *ldata = tty->disc_data;
157
158 tty_audit_add_data(tty, &x, 1, ldata->icanon);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700159 return put_user(x, ptr);
160}
161
Peter Hurley24a89d12013-06-15 09:14:15 -0400162static int receive_room(struct tty_struct *tty)
Linus Torvalds55db4c62011-06-04 06:33:24 +0900163{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200164 struct n_tty_data *ldata = tty->disc_data;
Jaeden Amero090abf72012-07-27 08:43:11 -0500165 int left;
Peter Hurleyb8483052013-06-15 07:28:30 -0400166
Jaeden Amero090abf72012-07-27 08:43:11 -0500167 if (I_PARMRK(tty)) {
168 /* Multiply read_cnt by 3, since each byte might take up to
169 * three times as many spaces when PARMRK is set (depending on
170 * its flags, e.g. parity error). */
Peter Hurleyce741172013-06-15 09:14:20 -0400171 left = N_TTY_BUF_SIZE - read_cnt(ldata) * 3 - 1;
Jaeden Amero090abf72012-07-27 08:43:11 -0500172 } else
Peter Hurleyce741172013-06-15 09:14:20 -0400173 left = N_TTY_BUF_SIZE - read_cnt(ldata) - 1;
Jaeden Amero090abf72012-07-27 08:43:11 -0500174
Linus Torvalds55db4c62011-06-04 06:33:24 +0900175 /*
176 * If we are doing input canonicalization, and there are no
177 * pending newlines, let characters through without limit, so
178 * that erase characters will be handled. Other excess
179 * characters will be beeped.
180 */
181 if (left <= 0)
Peter Hurleya73d3d62013-06-15 09:14:25 -0400182 left = ldata->icanon && ldata->canon_head == ldata->read_tail;
Linus Torvalds55db4c62011-06-04 06:33:24 +0900183
Peter Hurley24a89d12013-06-15 09:14:15 -0400184 return left;
Peter Hurley7879a9f2013-06-15 07:28:31 -0400185}
186
Peter Hurley24a89d12013-06-15 09:14:15 -0400187/**
188 * n_tty_set_room - receive space
189 * @tty: terminal
190 *
191 * Re-schedules the flip buffer work if space just became available.
192 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400193 * Caller holds exclusive termios_rwsem
194 * or
195 * n_tty_read()/consumer path:
196 * holds non-exclusive termios_rwsem
Peter Hurley24a89d12013-06-15 09:14:15 -0400197 */
198
Peter Hurley7879a9f2013-06-15 07:28:31 -0400199static void n_tty_set_room(struct tty_struct *tty)
200{
Peter Hurley24a89d12013-06-15 09:14:15 -0400201 struct n_tty_data *ldata = tty->disc_data;
202
Linus Torvalds55db4c62011-06-04 06:33:24 +0900203 /* Did this open up the receive buffer? We may need to flip */
Peter Hurley24a89d12013-06-15 09:14:15 -0400204 if (unlikely(ldata->no_room) && receive_room(tty)) {
205 ldata->no_room = 0;
206
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200207 WARN_RATELIMIT(tty->port->itty == NULL,
Sasha Levincadf7482012-10-25 14:26:35 -0400208 "scheduling with invalid itty\n");
Peter Hurley21622932013-03-11 16:44:21 -0400209 /* see if ldisc has been killed - if so, this means that
210 * even though the ldisc has been halted and ->buf.work
211 * cancelled, ->buf.work is about to be rescheduled
212 */
213 WARN_RATELIMIT(test_bit(TTY_LDISC_HALTED, &tty->flags),
214 "scheduling buffer work for halted ldisc\n");
Peter Hurleyf0f947c2013-06-15 09:14:36 -0400215 queue_work(system_unbound_wq, &tty->port->buf.work);
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200216 }
Linus Torvalds55db4c62011-06-04 06:33:24 +0900217}
218
Peter Hurley9a4aec22013-06-15 09:14:32 -0400219static ssize_t chars_in_buffer(struct tty_struct *tty)
220{
221 struct n_tty_data *ldata = tty->disc_data;
222 ssize_t n = 0;
223
224 if (!ldata->icanon)
225 n = read_cnt(ldata);
226 else
227 n = ldata->canon_head - ldata->read_tail;
228 return n;
229}
230
Peter Hurleyee0bab82013-06-15 09:14:34 -0400231/**
232 * n_tty_write_wakeup - asynchronous I/O notifier
233 * @tty: tty device
234 *
235 * Required for the ptys, serial driver etc. since processes
236 * that attach themselves to the master and rely on ASYNC
237 * IO must be woken up
238 */
239
240static void n_tty_write_wakeup(struct tty_struct *tty)
241{
242 if (tty->fasync && test_and_clear_bit(TTY_DO_WRITE_WAKEUP, &tty->flags))
243 kill_fasync(&tty->fasync, SIGIO, POLL_OUT);
244}
245
Peter Hurley4a23a4d2013-06-15 10:21:22 -0400246static void n_tty_check_throttle(struct tty_struct *tty)
Peter Hurley6367ca72013-06-15 09:14:33 -0400247{
Peter Hurley3afb1b392013-07-23 08:47:30 -0400248 if (tty->driver->type == TTY_DRIVER_TYPE_PTY)
249 return;
Peter Hurley6367ca72013-06-15 09:14:33 -0400250 /*
251 * Check the remaining room for the input canonicalization
252 * mode. We don't want to throttle the driver if we're in
253 * canonical mode and don't have a newline yet!
254 */
255 while (1) {
256 int throttled;
257 tty_set_flow_change(tty, TTY_THROTTLE_SAFE);
258 if (receive_room(tty) >= TTY_THRESHOLD_THROTTLE)
259 break;
260 throttled = tty_throttle_safe(tty);
261 if (!throttled)
262 break;
263 }
264 __tty_set_flow_change(tty, 0);
265}
266
Peter Hurley4b293492013-07-24 08:29:55 -0400267static void n_tty_check_unthrottle(struct tty_struct *tty)
Peter Hurley6367ca72013-06-15 09:14:33 -0400268{
Peter Hurley3afb1b392013-07-23 08:47:30 -0400269 if (tty->driver->type == TTY_DRIVER_TYPE_PTY &&
270 tty->link->ldisc->ops->write_wakeup == n_tty_write_wakeup) {
271 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
272 return;
273 if (!tty->count)
274 return;
275 n_tty_set_room(tty);
276 n_tty_write_wakeup(tty->link);
277 wake_up_interruptible_poll(&tty->link->write_wait, POLLOUT);
278 return;
279 }
280
Peter Hurley6367ca72013-06-15 09:14:33 -0400281 /* If there is enough space in the read buffer now, let the
282 * low-level driver know. We use chars_in_buffer() to
283 * check the buffer, as it now knows about canonical mode.
284 * Otherwise, if the driver is throttled and the line is
285 * longer than TTY_THRESHOLD_UNTHROTTLE in canonical mode,
286 * we won't get any more characters.
287 */
288
289 while (1) {
290 int unthrottled;
291 tty_set_flow_change(tty, TTY_UNTHROTTLE_SAFE);
292 if (chars_in_buffer(tty) > TTY_THRESHOLD_UNTHROTTLE)
293 break;
294 if (!tty->count)
295 break;
296 n_tty_set_room(tty);
297 unthrottled = tty_unthrottle_safe(tty);
298 if (!unthrottled)
299 break;
300 }
301 __tty_set_flow_change(tty, 0);
302}
303
Alan Cox17b82062008-10-13 10:45:06 +0100304/**
305 * put_tty_queue - add character to tty
306 * @c: character
Jiri Slaby57c94122012-10-18 22:26:43 +0200307 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100308 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400309 * Add a character to the tty read_buf queue.
310 *
311 * n_tty_receive_buf()/producer path:
312 * caller holds non-exclusive termios_rwsem
313 * modifies read_head
314 *
315 * read_head is only considered 'published' if canonical mode is
316 * not active.
Alan Cox17b82062008-10-13 10:45:06 +0100317 */
318
Peter Hurley19e2ad62013-07-24 08:29:54 -0400319static inline void put_tty_queue(unsigned char c, struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320{
Peter Hurley19e2ad62013-07-24 08:29:54 -0400321 *read_buf_addr(ldata, ldata->read_head++) = c;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322}
323
324/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 * reset_buffer_flags - reset buffer state
326 * @tty: terminal to reset
327 *
Peter Hurley25518c62013-03-11 16:44:31 -0400328 * Reset the read buffer counters and clear the flags.
329 * Called from n_tty_open() and n_tty_flush_buffer().
Alan Cox17b82062008-10-13 10:45:06 +0100330 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400331 * Locking: caller holds exclusive termios_rwsem
332 * (or locking is not required)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000334
Peter Hurleyb66f4fa2013-03-11 16:44:32 -0400335static void reset_buffer_flags(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336{
Peter Hurleya73d3d62013-06-15 09:14:25 -0400337 ldata->read_head = ldata->canon_head = ldata->read_tail = 0;
Peter Hurley17bd7902013-06-15 10:04:24 -0400338 ldata->echo_head = ldata->echo_tail = ldata->echo_commit = 0;
Peter Hurley40d5e092013-06-15 10:21:17 -0400339 ldata->line_start = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000340
Peter Hurleya73d3d62013-06-15 09:14:25 -0400341 ldata->erasing = 0;
Jiri Slaby3fe780b2012-10-18 22:26:40 +0200342 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343}
344
Peter Hurleya30737a2013-03-11 16:44:22 -0400345static void n_tty_packet_mode_flush(struct tty_struct *tty)
346{
347 unsigned long flags;
348
349 spin_lock_irqsave(&tty->ctrl_lock, flags);
350 if (tty->link->packet) {
351 tty->ctrl_status |= TIOCPKT_FLUSHREAD;
352 wake_up_interruptible(&tty->link->read_wait);
353 }
354 spin_unlock_irqrestore(&tty->ctrl_lock, flags);
355}
356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357/**
358 * n_tty_flush_buffer - clean input queue
359 * @tty: terminal device
360 *
Peter Hurley25518c62013-03-11 16:44:31 -0400361 * Flush the input buffer. Called when the tty layer wants the
362 * buffer flushed (eg at hangup) or when the N_TTY line discipline
363 * internally has to clean the pending queue (for example some signals).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400365 * Holds termios_rwsem to exclude producer/consumer while
366 * buffer indices are reset.
367 *
368 * Locking: ctrl_lock, exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 */
Alan Cox4edf1822008-02-08 04:18:44 -0800370
371static void n_tty_flush_buffer(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372{
Peter Hurley6d76bd22013-06-15 09:14:26 -0400373 down_write(&tty->termios_rwsem);
Peter Hurleyb66f4fa2013-03-11 16:44:32 -0400374 reset_buffer_flags(tty->disc_data);
375 n_tty_set_room(tty);
Alan Cox4edf1822008-02-08 04:18:44 -0800376
Peter Hurleya30737a2013-03-11 16:44:22 -0400377 if (tty->link)
378 n_tty_packet_mode_flush(tty);
Peter Hurley6d76bd22013-06-15 09:14:26 -0400379 up_write(&tty->termios_rwsem);
380}
381
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382/**
383 * n_tty_chars_in_buffer - report available bytes
384 * @tty: tty device
385 *
386 * Report the number of characters buffered to be delivered to user
Alan Cox4edf1822008-02-08 04:18:44 -0800387 * at this instant in time.
Alan Cox17b82062008-10-13 10:45:06 +0100388 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400389 * Locking: exclusive termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 */
Alan Cox4edf1822008-02-08 04:18:44 -0800391
Peter Hurleya19d0c62013-06-15 09:14:18 -0400392static ssize_t n_tty_chars_in_buffer(struct tty_struct *tty)
393{
Peter Hurley6d76bd22013-06-15 09:14:26 -0400394 ssize_t n;
395
Peter Hurley47534082013-06-15 09:14:19 -0400396 WARN_ONCE(1, "%s is deprecated and scheduled for removal.", __func__);
Peter Hurley6d76bd22013-06-15 09:14:26 -0400397
398 down_write(&tty->termios_rwsem);
399 n = chars_in_buffer(tty);
400 up_write(&tty->termios_rwsem);
401 return n;
Peter Hurleya19d0c62013-06-15 09:14:18 -0400402}
403
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404/**
405 * is_utf8_continuation - utf8 multibyte check
406 * @c: byte to check
407 *
408 * Returns true if the utf8 character 'c' is a multibyte continuation
409 * character. We use this to correctly compute the on screen size
410 * of the character when printing
411 */
Alan Cox4edf1822008-02-08 04:18:44 -0800412
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413static inline int is_utf8_continuation(unsigned char c)
414{
415 return (c & 0xc0) == 0x80;
416}
417
418/**
419 * is_continuation - multibyte check
420 * @c: byte to check
421 *
422 * Returns true if the utf8 character 'c' is a multibyte continuation
423 * character and the terminal is in unicode mode.
424 */
Alan Cox4edf1822008-02-08 04:18:44 -0800425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426static inline int is_continuation(unsigned char c, struct tty_struct *tty)
427{
428 return I_IUTF8(tty) && is_utf8_continuation(c);
429}
430
431/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000432 * do_output_char - output one character
433 * @c: character (or partial unicode symbol)
434 * @tty: terminal device
435 * @space: space available in tty driver write buffer
436 *
437 * This is a helper function that handles one output character
438 * (including special characters like TAB, CR, LF, etc.),
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600439 * doing OPOST processing and putting the results in the
440 * tty driver's write buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000441 *
442 * Note that Linux currently ignores TABDLY, CRDLY, VTDLY, FFDLY
443 * and NLDLY. They simply aren't relevant in the world today.
444 * If you ever need them, add them here.
445 *
446 * Returns the number of bytes of buffer space used or -1 if
447 * no space left.
448 *
449 * Locking: should be called under the output_lock to protect
450 * the column state and space left in the buffer
451 */
452
453static int do_output_char(unsigned char c, struct tty_struct *tty, int space)
454{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200455 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000456 int spaces;
457
458 if (!space)
459 return -1;
Alan Cox300a6202009-01-02 13:41:04 +0000460
Joe Petersona88a69c2009-01-02 13:40:53 +0000461 switch (c) {
462 case '\n':
463 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200464 ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000465 if (O_ONLCR(tty)) {
466 if (space < 2)
467 return -1;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200468 ldata->canon_column = ldata->column = 0;
Linus Torvalds37f81fa2009-09-05 12:46:07 -0700469 tty->ops->write(tty, "\r\n", 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000470 return 2;
471 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200472 ldata->canon_column = ldata->column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000473 break;
474 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200475 if (O_ONOCR(tty) && ldata->column == 0)
Joe Petersona88a69c2009-01-02 13:40:53 +0000476 return 0;
477 if (O_OCRNL(tty)) {
478 c = '\n';
479 if (O_ONLRET(tty))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200480 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000481 break;
482 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200483 ldata->canon_column = ldata->column = 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000484 break;
485 case '\t':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200486 spaces = 8 - (ldata->column & 7);
Joe Petersona88a69c2009-01-02 13:40:53 +0000487 if (O_TABDLY(tty) == XTABS) {
488 if (space < spaces)
489 return -1;
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200490 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000491 tty->ops->write(tty, " ", spaces);
492 return spaces;
493 }
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200494 ldata->column += spaces;
Joe Petersona88a69c2009-01-02 13:40:53 +0000495 break;
496 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200497 if (ldata->column > 0)
498 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000499 break;
500 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000501 if (!iscntrl(c)) {
502 if (O_OLCUC(tty))
503 c = toupper(c);
504 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200505 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000506 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000507 break;
508 }
509
510 tty_put_char(tty, c);
511 return 1;
512}
513
514/**
515 * process_output - output post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 * @c: character (or partial unicode symbol)
517 * @tty: terminal device
518 *
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600519 * Output one character with OPOST processing.
520 * Returns -1 when the output device is full and the character
521 * must be retried.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000523 * Locking: output_lock to protect column state and space left
524 * (also, this is called from n_tty_write under the
525 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 */
Alan Cox4edf1822008-02-08 04:18:44 -0800527
Joe Petersona88a69c2009-01-02 13:40:53 +0000528static int process_output(unsigned char c, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529{
Jiri Slabybddc7152012-10-18 22:26:42 +0200530 struct n_tty_data *ldata = tty->disc_data;
Joe Petersona88a69c2009-01-02 13:40:53 +0000531 int space, retval;
532
Jiri Slabybddc7152012-10-18 22:26:42 +0200533 mutex_lock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
Alan Coxf34d7a52008-04-30 00:54:13 -0700535 space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000536 retval = do_output_char(c, tty, space);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
Jiri Slabybddc7152012-10-18 22:26:42 +0200538 mutex_unlock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000539 if (retval < 0)
540 return -1;
541 else
542 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543}
544
545/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000546 * process_output_block - block post processor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 * @tty: terminal device
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600548 * @buf: character buffer
549 * @nr: number of bytes to output
550 *
551 * Output a block of characters with OPOST processing.
552 * Returns the number of characters output.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 *
554 * This path is used to speed up block console writes, among other
555 * things when processing blocks of output data. It handles only
556 * the simple cases normally found and helps to generate blocks of
557 * symbols for the console driver and thus improve performance.
558 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000559 * Locking: output_lock to protect column state and space left
560 * (also, this is called from n_tty_write under the
561 * tty layer write lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 */
Alan Cox4edf1822008-02-08 04:18:44 -0800563
Joe Petersona88a69c2009-01-02 13:40:53 +0000564static ssize_t process_output_block(struct tty_struct *tty,
565 const unsigned char *buf, unsigned int nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200567 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 int space;
Thorsten Wißmannbbd20752011-12-08 17:47:33 +0100569 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 const unsigned char *cp;
571
Jiri Slabybddc7152012-10-18 22:26:42 +0200572 mutex_lock(&ldata->output_lock);
Joe Petersona88a69c2009-01-02 13:40:53 +0000573
Alan Coxf34d7a52008-04-30 00:54:13 -0700574 space = tty_write_room(tty);
Alan Cox300a6202009-01-02 13:41:04 +0000575 if (!space) {
Jiri Slabybddc7152012-10-18 22:26:42 +0200576 mutex_unlock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 return 0;
Joe Petersona88a69c2009-01-02 13:40:53 +0000578 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 if (nr > space)
580 nr = space;
581
582 for (i = 0, cp = buf; i < nr; i++, cp++) {
Joe Petersona59c0d62009-01-02 13:43:25 +0000583 unsigned char c = *cp;
584
585 switch (c) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 case '\n':
587 if (O_ONLRET(tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200588 ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 if (O_ONLCR(tty))
590 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200591 ldata->canon_column = ldata->column;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 break;
593 case '\r':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200594 if (O_ONOCR(tty) && ldata->column == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 goto break_out;
596 if (O_OCRNL(tty))
597 goto break_out;
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200598 ldata->canon_column = ldata->column = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 break;
600 case '\t':
601 goto break_out;
602 case '\b':
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200603 if (ldata->column > 0)
604 ldata->column--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 break;
606 default:
Joe Petersona59c0d62009-01-02 13:43:25 +0000607 if (!iscntrl(c)) {
608 if (O_OLCUC(tty))
609 goto break_out;
610 if (!is_continuation(c, tty))
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200611 ldata->column++;
Joe Petersona59c0d62009-01-02 13:43:25 +0000612 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 break;
614 }
615 }
616break_out:
Alan Coxf34d7a52008-04-30 00:54:13 -0700617 i = tty->ops->write(tty, buf, i);
Joe Petersona88a69c2009-01-02 13:40:53 +0000618
Jiri Slabybddc7152012-10-18 22:26:42 +0200619 mutex_unlock(&ldata->output_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 return i;
621}
622
Joe Petersona88a69c2009-01-02 13:40:53 +0000623/**
624 * process_echoes - write pending echo characters
625 * @tty: terminal device
626 *
627 * Write previously buffered echo (and other ldisc-generated)
628 * characters to the tty.
629 *
630 * Characters generated by the ldisc (including echoes) need to
631 * be buffered because the driver's write buffer can fill during
632 * heavy program output. Echoing straight to the driver will
633 * often fail under these conditions, causing lost characters and
634 * resulting mismatches of ldisc state information.
635 *
636 * Since the ldisc state must represent the characters actually sent
637 * to the driver at the time of the write, operations like certain
638 * changes in column state are also saved in the buffer and executed
639 * here.
640 *
641 * A circular fifo buffer is used so that the most recent characters
642 * are prioritized. Also, when control characters are echoed with a
643 * prefixed "^", the pair is treated atomically and thus not separated.
644 *
Peter Hurley019ebdf2013-06-15 10:04:25 -0400645 * Locking: callers must hold output_lock
Joe Petersona88a69c2009-01-02 13:40:53 +0000646 */
647
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400648static size_t __process_echoes(struct tty_struct *tty)
Joe Petersona88a69c2009-01-02 13:40:53 +0000649{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200650 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400651 int space, old_space;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400652 size_t tail;
Joe Petersona88a69c2009-01-02 13:40:53 +0000653 unsigned char c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000654
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400655 old_space = space = tty_write_room(tty);
Joe Petersona88a69c2009-01-02 13:40:53 +0000656
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400657 tail = ldata->echo_tail;
Peter Hurley29c7c5c2013-06-15 10:04:28 -0400658 while (ldata->echo_commit != tail) {
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400659 c = echo_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +0000660 if (c == ECHO_OP_START) {
661 unsigned char op;
Joe Petersona88a69c2009-01-02 13:40:53 +0000662 int no_space_left = 0;
663
664 /*
665 * If the buffer byte is the start of a multi-byte
666 * operation, get the next byte, which is either the
667 * op code or a control character value.
668 */
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400669 op = echo_buf(ldata, tail + 1);
Alan Cox300a6202009-01-02 13:41:04 +0000670
Joe Petersona88a69c2009-01-02 13:40:53 +0000671 switch (op) {
672 unsigned int num_chars, num_bs;
673
674 case ECHO_OP_ERASE_TAB:
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400675 num_chars = echo_buf(ldata, tail + 2);
Joe Petersona88a69c2009-01-02 13:40:53 +0000676
677 /*
678 * Determine how many columns to go back
679 * in order to erase the tab.
680 * This depends on the number of columns
681 * used by other characters within the tab
682 * area. If this (modulo 8) count is from
683 * the start of input rather than from a
684 * previous tab, we offset by canon column.
685 * Otherwise, tab spacing is normal.
686 */
687 if (!(num_chars & 0x80))
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200688 num_chars += ldata->canon_column;
Joe Petersona88a69c2009-01-02 13:40:53 +0000689 num_bs = 8 - (num_chars & 7);
690
691 if (num_bs > space) {
692 no_space_left = 1;
693 break;
694 }
695 space -= num_bs;
696 while (num_bs--) {
697 tty_put_char(tty, '\b');
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200698 if (ldata->column > 0)
699 ldata->column--;
Joe Petersona88a69c2009-01-02 13:40:53 +0000700 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400701 tail += 3;
Joe Petersona88a69c2009-01-02 13:40:53 +0000702 break;
703
704 case ECHO_OP_SET_CANON_COL:
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200705 ldata->canon_column = ldata->column;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400706 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000707 break;
708
709 case ECHO_OP_MOVE_BACK_COL:
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200710 if (ldata->column > 0)
711 ldata->column--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400712 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000713 break;
714
715 case ECHO_OP_START:
716 /* This is an escaped echo op start code */
717 if (!space) {
718 no_space_left = 1;
719 break;
720 }
721 tty_put_char(tty, ECHO_OP_START);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200722 ldata->column++;
Joe Petersona88a69c2009-01-02 13:40:53 +0000723 space--;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400724 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000725 break;
726
727 default:
Joe Petersona88a69c2009-01-02 13:40:53 +0000728 /*
Joe Peterson62b26352009-09-09 15:03:47 -0600729 * If the op is not a special byte code,
730 * it is a ctrl char tagged to be echoed
731 * as "^X" (where X is the letter
732 * representing the control char).
733 * Note that we must ensure there is
734 * enough space for the whole ctrl pair.
735 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000736 */
Joe Peterson62b26352009-09-09 15:03:47 -0600737 if (space < 2) {
738 no_space_left = 1;
739 break;
740 }
741 tty_put_char(tty, '^');
742 tty_put_char(tty, op ^ 0100);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200743 ldata->column += 2;
Joe Peterson62b26352009-09-09 15:03:47 -0600744 space -= 2;
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400745 tail += 2;
Joe Petersona88a69c2009-01-02 13:40:53 +0000746 }
747
748 if (no_space_left)
749 break;
750 } else {
Peter Hurley582f5592013-05-17 12:49:48 -0400751 if (O_OPOST(tty)) {
Joe Petersonee5aa7b2009-09-09 15:03:13 -0600752 int retval = do_output_char(c, tty, space);
753 if (retval < 0)
754 break;
755 space -= retval;
756 } else {
757 if (!space)
758 break;
759 tty_put_char(tty, c);
760 space -= 1;
761 }
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400762 tail += 1;
Joe Petersona88a69c2009-01-02 13:40:53 +0000763 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000764 }
765
Peter Hurleycbfd0342013-06-15 10:04:26 -0400766 /* If the echo buffer is nearly full (so that the possibility exists
767 * of echo overrun before the next commit), then discard enough
768 * data at the tail to prevent a subsequent overrun */
769 while (ldata->echo_commit - tail >= ECHO_DISCARD_WATERMARK) {
Roel Kluinc476f652013-10-11 22:08:49 +0200770 if (echo_buf(ldata, tail) == ECHO_OP_START) {
Peter Hurley6f222532013-11-08 09:42:18 -0500771 if (echo_buf(ldata, tail + 1) == ECHO_OP_ERASE_TAB)
Peter Hurleycbfd0342013-06-15 10:04:26 -0400772 tail += 3;
773 else
774 tail += 2;
775 } else
776 tail++;
777 }
778
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400779 ldata->echo_tail = tail;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400780 return old_space - space;
Joe Petersona88a69c2009-01-02 13:40:53 +0000781}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
Peter Hurley17bd7902013-06-15 10:04:24 -0400783static void commit_echoes(struct tty_struct *tty)
784{
785 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400786 size_t nr, old, echoed;
Peter Hurleycbfd0342013-06-15 10:04:26 -0400787 size_t head;
788
789 head = ldata->echo_head;
790 old = ldata->echo_commit - ldata->echo_tail;
791
792 /* Process committed echoes if the accumulated # of bytes
793 * is over the threshold (and try again each time another
794 * block is accumulated) */
795 nr = head - ldata->echo_tail;
796 if (nr < ECHO_COMMIT_WATERMARK || (nr % ECHO_BLOCK > old % ECHO_BLOCK))
797 return;
Peter Hurley17bd7902013-06-15 10:04:24 -0400798
Peter Hurley019ebdf2013-06-15 10:04:25 -0400799 mutex_lock(&ldata->output_lock);
Peter Hurleycbfd0342013-06-15 10:04:26 -0400800 ldata->echo_commit = head;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400801 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400802 mutex_unlock(&ldata->output_lock);
803
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400804 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400805 tty->ops->flush_chars(tty);
806}
807
808static void process_echoes(struct tty_struct *tty)
809{
810 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400811 size_t echoed;
Peter Hurley019ebdf2013-06-15 10:04:25 -0400812
Peter Hurley39434ab2013-11-29 12:56:10 -0500813 if ((!L_ECHO(tty) && !L_ECHONL(tty)) ||
814 ldata->echo_commit == ldata->echo_tail)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400815 return;
816
817 mutex_lock(&ldata->output_lock);
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400818 echoed = __process_echoes(tty);
Peter Hurley019ebdf2013-06-15 10:04:25 -0400819 mutex_unlock(&ldata->output_lock);
820
Peter Hurleybc5b1ec2013-06-15 10:04:27 -0400821 if (echoed && tty->ops->flush_chars)
Peter Hurley019ebdf2013-06-15 10:04:25 -0400822 tty->ops->flush_chars(tty);
Peter Hurley17bd7902013-06-15 10:04:24 -0400823}
824
Peter Hurleycbfd0342013-06-15 10:04:26 -0400825static void flush_echoes(struct tty_struct *tty)
826{
827 struct n_tty_data *ldata = tty->disc_data;
828
Peter Hurley39434ab2013-11-29 12:56:10 -0500829 if ((!L_ECHO(tty) && !L_ECHONL(tty)) ||
830 ldata->echo_commit == ldata->echo_head)
Peter Hurleycbfd0342013-06-15 10:04:26 -0400831 return;
832
833 mutex_lock(&ldata->output_lock);
834 ldata->echo_commit = ldata->echo_head;
835 __process_echoes(tty);
836 mutex_unlock(&ldata->output_lock);
837}
838
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000840 * add_echo_byte - add a byte to the echo buffer
841 * @c: unicode byte to echo
Jiri Slaby57c94122012-10-18 22:26:43 +0200842 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000843 *
844 * Add a character or operation byte to the echo buffer.
Joe Petersona88a69c2009-01-02 13:40:53 +0000845 */
846
Peter Hurleycbfd0342013-06-15 10:04:26 -0400847static inline void add_echo_byte(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000848{
Peter Hurleyaddaebc2013-06-15 10:04:22 -0400849 *echo_buf_addr(ldata, ldata->echo_head++) = c;
Joe Petersona88a69c2009-01-02 13:40:53 +0000850}
851
852/**
853 * echo_move_back_col - add operation to move back a column
Jiri Slaby57c94122012-10-18 22:26:43 +0200854 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000855 *
856 * Add an operation to the echo buffer to move back one column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000857 */
858
Jiri Slaby57c94122012-10-18 22:26:43 +0200859static void echo_move_back_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000860{
Jiri Slaby57c94122012-10-18 22:26:43 +0200861 add_echo_byte(ECHO_OP_START, ldata);
862 add_echo_byte(ECHO_OP_MOVE_BACK_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000863}
864
865/**
866 * echo_set_canon_col - add operation to set the canon column
Jiri Slaby57c94122012-10-18 22:26:43 +0200867 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000868 *
869 * Add an operation to the echo buffer to set the canon column
870 * to the current column.
Joe Petersona88a69c2009-01-02 13:40:53 +0000871 */
872
Jiri Slaby57c94122012-10-18 22:26:43 +0200873static void echo_set_canon_col(struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000874{
Jiri Slaby57c94122012-10-18 22:26:43 +0200875 add_echo_byte(ECHO_OP_START, ldata);
876 add_echo_byte(ECHO_OP_SET_CANON_COL, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000877}
878
879/**
880 * echo_erase_tab - add operation to erase a tab
881 * @num_chars: number of character columns already used
882 * @after_tab: true if num_chars starts after a previous tab
Jiri Slaby57c94122012-10-18 22:26:43 +0200883 * @ldata: n_tty data
Joe Petersona88a69c2009-01-02 13:40:53 +0000884 *
885 * Add an operation to the echo buffer to erase a tab.
886 *
887 * Called by the eraser function, which knows how many character
888 * columns have been used since either a previous tab or the start
889 * of input. This information will be used later, along with
890 * canon column (if applicable), to go back the correct number
891 * of columns.
Joe Petersona88a69c2009-01-02 13:40:53 +0000892 */
893
894static void echo_erase_tab(unsigned int num_chars, int after_tab,
Jiri Slaby57c94122012-10-18 22:26:43 +0200895 struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000896{
Jiri Slaby57c94122012-10-18 22:26:43 +0200897 add_echo_byte(ECHO_OP_START, ldata);
898 add_echo_byte(ECHO_OP_ERASE_TAB, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000899
900 /* We only need to know this modulo 8 (tab spacing) */
901 num_chars &= 7;
902
903 /* Set the high bit as a flag if num_chars is after a previous tab */
904 if (after_tab)
905 num_chars |= 0x80;
Alan Cox300a6202009-01-02 13:41:04 +0000906
Jiri Slaby57c94122012-10-18 22:26:43 +0200907 add_echo_byte(num_chars, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000908}
909
910/**
911 * echo_char_raw - echo a character raw
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 * @c: unicode byte to echo
913 * @tty: terminal device
914 *
Alan Cox4edf1822008-02-08 04:18:44 -0800915 * Echo user input back onto the screen. This must be called only when
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 * L_ECHO(tty) is true. Called from the driver receive_buf path.
Alan Cox17b82062008-10-13 10:45:06 +0100917 *
Joe Petersona88a69c2009-01-02 13:40:53 +0000918 * This variant does not treat control characters specially.
Joe Petersona88a69c2009-01-02 13:40:53 +0000919 */
920
Jiri Slaby57c94122012-10-18 22:26:43 +0200921static void echo_char_raw(unsigned char c, struct n_tty_data *ldata)
Joe Petersona88a69c2009-01-02 13:40:53 +0000922{
Joe Petersona88a69c2009-01-02 13:40:53 +0000923 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200924 add_echo_byte(ECHO_OP_START, ldata);
925 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000926 } else {
Jiri Slaby57c94122012-10-18 22:26:43 +0200927 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000928 }
Joe Petersona88a69c2009-01-02 13:40:53 +0000929}
930
931/**
932 * echo_char - echo a character
933 * @c: unicode byte to echo
934 * @tty: terminal device
935 *
936 * Echo user input back onto the screen. This must be called only when
937 * L_ECHO(tty) is true. Called from the driver receive_buf path.
938 *
Joe Peterson62b26352009-09-09 15:03:47 -0600939 * This variant tags control characters to be echoed as "^X"
940 * (where X is the letter representing the control char).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 */
942
943static void echo_char(unsigned char c, struct tty_struct *tty)
944{
Jiri Slabybddc7152012-10-18 22:26:42 +0200945 struct n_tty_data *ldata = tty->disc_data;
946
Joe Petersona88a69c2009-01-02 13:40:53 +0000947 if (c == ECHO_OP_START) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200948 add_echo_byte(ECHO_OP_START, ldata);
949 add_echo_byte(ECHO_OP_START, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000950 } else {
Joe Peterson62b26352009-09-09 15:03:47 -0600951 if (L_ECHOCTL(tty) && iscntrl(c) && c != '\t')
Jiri Slaby57c94122012-10-18 22:26:43 +0200952 add_echo_byte(ECHO_OP_START, ldata);
953 add_echo_byte(c, ldata);
Joe Petersona88a69c2009-01-02 13:40:53 +0000954 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955}
956
Alan Cox17b82062008-10-13 10:45:06 +0100957/**
Joe Petersona88a69c2009-01-02 13:40:53 +0000958 * finish_erasing - complete erase
Jiri Slaby57c94122012-10-18 22:26:43 +0200959 * @ldata: n_tty data
Alan Cox17b82062008-10-13 10:45:06 +0100960 */
Joe Petersona88a69c2009-01-02 13:40:53 +0000961
Jiri Slaby57c94122012-10-18 22:26:43 +0200962static inline void finish_erasing(struct n_tty_data *ldata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200964 if (ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +0200965 echo_char_raw('/', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200966 ldata->erasing = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 }
968}
969
970/**
971 * eraser - handle erase function
972 * @c: character input
973 * @tty: terminal device
974 *
Robert P. J. Day3a4fa0a2007-10-19 23:10:43 +0200975 * Perform erase and necessary output when an erase character is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 * present in the stream from the driver layer. Handles the complexities
977 * of UTF-8 multibyte symbols.
Alan Cox17b82062008-10-13 10:45:06 +0100978 *
Peter Hurley6d76bd22013-06-15 09:14:26 -0400979 * n_tty_receive_buf()/producer path:
980 * caller holds non-exclusive termios_rwsem
981 * modifies read_head
982 *
983 * Modifying the read_head is not considered a publish in this context
984 * because canonical mode is active -- only canon_head publishes
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 */
Alan Cox4edf1822008-02-08 04:18:44 -0800986
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987static void eraser(unsigned char c, struct tty_struct *tty)
988{
Jiri Slaby53c5ee22012-10-18 22:26:39 +0200989 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 enum { ERASE, WERASE, KILL } kill_type;
Peter Hurleybc5a5e32013-06-15 09:14:21 -0400991 size_t head;
992 size_t cnt;
993 int seen_alnums;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994
Jiri Slabyba2e68a2012-10-18 22:26:41 +0200995 if (ldata->read_head == ldata->canon_head) {
Joe Peterson7e94b1d2009-01-02 13:43:40 +0000996 /* process_output('\a', tty); */ /* what do you think? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 return;
998 }
999 if (c == ERASE_CHAR(tty))
1000 kill_type = ERASE;
1001 else if (c == WERASE_CHAR(tty))
1002 kill_type = WERASE;
1003 else {
1004 if (!L_ECHO(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001005 ldata->read_head = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 return;
1007 }
1008 if (!L_ECHOK(tty) || !L_ECHOKE(tty) || !L_ECHOE(tty)) {
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001009 ldata->read_head = ldata->canon_head;
Jiri Slaby57c94122012-10-18 22:26:43 +02001010 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 echo_char(KILL_CHAR(tty), tty);
1012 /* Add a newline if ECHOK is on and ECHOKE is off. */
1013 if (L_ECHOK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001014 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 return;
1016 }
1017 kill_type = KILL;
1018 }
1019
1020 seen_alnums = 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001021 while (ldata->read_head != ldata->canon_head) {
1022 head = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023
1024 /* erase a single possibly multibyte character */
1025 do {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001026 head--;
1027 c = read_buf(ldata, head);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001028 } while (is_continuation(c, tty) && head != ldata->canon_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029
1030 /* do not partially erase */
1031 if (is_continuation(c, tty))
1032 break;
1033
1034 if (kill_type == WERASE) {
1035 /* Equivalent to BSD's ALTWERASE. */
1036 if (isalnum(c) || c == '_')
1037 seen_alnums++;
1038 else if (seen_alnums)
1039 break;
1040 }
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001041 cnt = ldata->read_head - head;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001042 ldata->read_head = head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 if (L_ECHO(tty)) {
1044 if (L_ECHOPRT(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001045 if (!ldata->erasing) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001046 echo_char_raw('\\', ldata);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001047 ldata->erasing = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 }
1049 /* if cnt > 1, output a multi-byte character */
1050 echo_char(c, tty);
1051 while (--cnt > 0) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001052 head++;
1053 echo_char_raw(read_buf(ldata, head), ldata);
Jiri Slaby57c94122012-10-18 22:26:43 +02001054 echo_move_back_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 }
1056 } else if (kill_type == ERASE && !L_ECHOE(tty)) {
1057 echo_char(ERASE_CHAR(tty), tty);
1058 } else if (c == '\t') {
Joe Petersona88a69c2009-01-02 13:40:53 +00001059 unsigned int num_chars = 0;
1060 int after_tab = 0;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001061 size_t tail = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062
Joe Petersona88a69c2009-01-02 13:40:53 +00001063 /*
1064 * Count the columns used for characters
1065 * since the start of input or after a
1066 * previous tab.
1067 * This info is used to go back the correct
1068 * number of columns.
1069 */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001070 while (tail != ldata->canon_head) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001071 tail--;
1072 c = read_buf(ldata, tail);
Joe Petersona88a69c2009-01-02 13:40:53 +00001073 if (c == '\t') {
1074 after_tab = 1;
1075 break;
Alan Cox300a6202009-01-02 13:41:04 +00001076 } else if (iscntrl(c)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 if (L_ECHOCTL(tty))
Joe Petersona88a69c2009-01-02 13:40:53 +00001078 num_chars += 2;
1079 } else if (!is_continuation(c, tty)) {
1080 num_chars++;
1081 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001083 echo_erase_tab(num_chars, after_tab, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084 } else {
1085 if (iscntrl(c) && L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001086 echo_char_raw('\b', ldata);
1087 echo_char_raw(' ', ldata);
1088 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 }
1090 if (!iscntrl(c) || L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001091 echo_char_raw('\b', ldata);
1092 echo_char_raw(' ', ldata);
1093 echo_char_raw('\b', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 }
1095 }
1096 }
1097 if (kill_type == ERASE)
1098 break;
1099 }
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001100 if (ldata->read_head == ldata->canon_head && L_ECHO(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001101 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102}
1103
1104/**
1105 * isig - handle the ISIG optio
1106 * @sig: signal
1107 * @tty: terminal
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001109 * Called when a signal is being sent due to terminal input.
1110 * Called from the driver receive_buf path so serialized.
Alan Cox17b82062008-10-13 10:45:06 +01001111 *
Peter Hurley8c985d12013-03-06 08:38:19 -05001112 * Locking: ctrl_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 */
Alan Cox4edf1822008-02-08 04:18:44 -08001114
Peter Hurley4b293492013-07-24 08:29:55 -04001115static void isig(int sig, struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116{
Peter Hurley8c985d12013-03-06 08:38:19 -05001117 struct pid *tty_pgrp = tty_get_pgrp(tty);
1118 if (tty_pgrp) {
1119 kill_pgrp(tty_pgrp, sig, 1);
1120 put_pid(tty_pgrp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 }
1122}
1123
1124/**
1125 * n_tty_receive_break - handle break
1126 * @tty: terminal
1127 *
1128 * An RS232 break event has been hit in the incoming bitstream. This
1129 * can cause a variety of events depending upon the termios settings.
1130 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001131 * n_tty_receive_buf()/producer path:
1132 * caller holds non-exclusive termios_rwsem
1133 * publishes read_head via put_tty_queue()
1134 *
1135 * Note: may get exclusive termios_rwsem if flushing input buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 */
Alan Cox4edf1822008-02-08 04:18:44 -08001137
Peter Hurley4b293492013-07-24 08:29:55 -04001138static void n_tty_receive_break(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139{
Jiri Slaby57c94122012-10-18 22:26:43 +02001140 struct n_tty_data *ldata = tty->disc_data;
1141
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 if (I_IGNBRK(tty))
1143 return;
1144 if (I_BRKINT(tty)) {
Peter Hurley8c985d12013-03-06 08:38:19 -05001145 isig(SIGINT, tty);
1146 if (!L_NOFLSH(tty)) {
Peter Hurley6d76bd22013-06-15 09:14:26 -04001147 /* flushing needs exclusive termios_rwsem */
1148 up_read(&tty->termios_rwsem);
Peter Hurley8c985d12013-03-06 08:38:19 -05001149 n_tty_flush_buffer(tty);
1150 tty_driver_flush_buffer(tty);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001151 down_read(&tty->termios_rwsem);
Peter Hurley8c985d12013-03-06 08:38:19 -05001152 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153 return;
1154 }
1155 if (I_PARMRK(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001156 put_tty_queue('\377', ldata);
1157 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 }
Jiri Slaby57c94122012-10-18 22:26:43 +02001159 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 wake_up_interruptible(&tty->read_wait);
1161}
1162
1163/**
1164 * n_tty_receive_overrun - handle overrun reporting
1165 * @tty: terminal
1166 *
1167 * Data arrived faster than we could process it. While the tty
1168 * driver has flagged this the bits that were missed are gone
1169 * forever.
1170 *
1171 * Called from the receive_buf path so single threaded. Does not
1172 * need locking as num_overrun and overrun_time are function
1173 * private.
1174 */
Alan Cox4edf1822008-02-08 04:18:44 -08001175
Peter Hurley4b293492013-07-24 08:29:55 -04001176static void n_tty_receive_overrun(struct tty_struct *tty)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001178 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 char buf[64];
1180
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001181 ldata->num_overrun++;
1182 if (time_after(jiffies, ldata->overrun_time + HZ) ||
1183 time_after(ldata->overrun_time, jiffies)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 printk(KERN_WARNING "%s: %d input overrun(s)\n",
1185 tty_name(tty, buf),
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001186 ldata->num_overrun);
1187 ldata->overrun_time = jiffies;
1188 ldata->num_overrun = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 }
1190}
1191
1192/**
1193 * n_tty_receive_parity_error - error notifier
1194 * @tty: terminal device
1195 * @c: character
1196 *
1197 * Process a parity error and queue the right data to indicate
Peter Hurley6d76bd22013-06-15 09:14:26 -04001198 * the error case if necessary.
1199 *
1200 * n_tty_receive_buf()/producer path:
1201 * caller holds non-exclusive termios_rwsem
1202 * publishes read_head via put_tty_queue()
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 */
Peter Hurley4b293492013-07-24 08:29:55 -04001204static void n_tty_receive_parity_error(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205{
Jiri Slaby57c94122012-10-18 22:26:43 +02001206 struct n_tty_data *ldata = tty->disc_data;
1207
Alan Cox4edf1822008-02-08 04:18:44 -08001208 if (I_IGNPAR(tty))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 if (I_PARMRK(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001211 put_tty_queue('\377', ldata);
1212 put_tty_queue('\0', ldata);
1213 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 } else if (I_INPCK(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02001215 put_tty_queue('\0', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 else
Jiri Slaby57c94122012-10-18 22:26:43 +02001217 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 wake_up_interruptible(&tty->read_wait);
1219}
1220
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001221static void
1222n_tty_receive_signal_char(struct tty_struct *tty, int signal, unsigned char c)
1223{
1224 if (!L_NOFLSH(tty)) {
1225 /* flushing needs exclusive termios_rwsem */
1226 up_read(&tty->termios_rwsem);
1227 n_tty_flush_buffer(tty);
1228 tty_driver_flush_buffer(tty);
1229 down_read(&tty->termios_rwsem);
1230 }
1231 if (I_IXON(tty))
1232 start_tty(tty);
1233 if (L_ECHO(tty)) {
1234 echo_char(c, tty);
1235 commit_echoes(tty);
1236 }
1237 isig(signal, tty);
1238 return;
1239}
1240
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241/**
1242 * n_tty_receive_char - perform processing
1243 * @tty: terminal device
1244 * @c: character
1245 *
1246 * Process an individual character of input received from the driver.
Alan Cox4edf1822008-02-08 04:18:44 -08001247 * This is serialized with respect to itself by the rules for the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 * driver above.
Peter Hurley6d76bd22013-06-15 09:14:26 -04001249 *
1250 * n_tty_receive_buf()/producer path:
1251 * caller holds non-exclusive termios_rwsem
1252 * publishes canon_head if canonical mode is active
1253 * otherwise, publishes read_head via put_tty_queue()
Peter Hurleye60d27c2013-07-24 08:29:56 -04001254 *
1255 * Returns 1 if LNEXT was received, else returns 0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256 */
1257
Peter Hurleye60d27c2013-07-24 08:29:56 -04001258static int
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001259n_tty_receive_char_special(struct tty_struct *tty, unsigned char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001261 struct n_tty_data *ldata = tty->disc_data;
Joe Petersonacc71bb2009-01-02 13:43:32 +00001262 int parmrk;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 if (I_IXON(tty)) {
1265 if (c == START_CHAR(tty)) {
1266 start_tty(tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001267 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001268 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 }
1270 if (c == STOP_CHAR(tty)) {
1271 stop_tty(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001272 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 }
1274 }
Joe Peterson575537b32008-04-30 00:53:30 -07001275
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 if (L_ISIG(tty)) {
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001277 if (c == INTR_CHAR(tty)) {
1278 n_tty_receive_signal_char(tty, SIGINT, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001279 return 0;
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001280 } else if (c == QUIT_CHAR(tty)) {
1281 n_tty_receive_signal_char(tty, SIGQUIT, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001282 return 0;
Peter Hurleyb0ac50b2013-06-15 10:21:23 -04001283 } else if (c == SUSP_CHAR(tty)) {
1284 n_tty_receive_signal_char(tty, SIGTSTP, c);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001285 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 }
1287 }
Joe Peterson575537b32008-04-30 00:53:30 -07001288
Peter Hurley855df3c2013-07-24 08:29:50 -04001289 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1290 start_tty(tty);
1291 process_echoes(tty);
1292 }
1293
Joe Peterson575537b32008-04-30 00:53:30 -07001294 if (c == '\r') {
1295 if (I_IGNCR(tty))
Peter Hurleye60d27c2013-07-24 08:29:56 -04001296 return 0;
Joe Peterson575537b32008-04-30 00:53:30 -07001297 if (I_ICRNL(tty))
1298 c = '\n';
1299 } else if (c == '\n' && I_INLCR(tty))
1300 c = '\r';
1301
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001302 if (ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 if (c == ERASE_CHAR(tty) || c == KILL_CHAR(tty) ||
1304 (c == WERASE_CHAR(tty) && L_IEXTEN(tty))) {
1305 eraser(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001306 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001307 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 }
1309 if (c == LNEXT_CHAR(tty) && L_IEXTEN(tty)) {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001310 ldata->lnext = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001312 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 if (L_ECHOCTL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001314 echo_char_raw('^', ldata);
1315 echo_char_raw('\b', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001316 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 }
1318 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001319 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001321 if (c == REPRINT_CHAR(tty) && L_ECHO(tty) && L_IEXTEN(tty)) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001322 size_t tail = ldata->canon_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
Jiri Slaby57c94122012-10-18 22:26:43 +02001324 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 echo_char(c, tty);
Jiri Slaby57c94122012-10-18 22:26:43 +02001326 echo_char_raw('\n', ldata);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001327 while (tail != ldata->read_head) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001328 echo_char(read_buf(ldata, tail), tty);
1329 tail++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001331 commit_echoes(tty);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001332 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 }
1334 if (c == '\n') {
Joe Petersonacc71bb2009-01-02 13:43:32 +00001335 if (L_ECHO(tty) || L_ECHONL(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001336 echo_char_raw('\n', ldata);
Peter Hurley17bd7902013-06-15 10:04:24 -04001337 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 }
1339 goto handle_newline;
1340 }
1341 if (c == EOF_CHAR(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 c = __DISABLED_CHAR;
1343 goto handle_newline;
1344 }
1345 if ((c == EOL_CHAR(tty)) ||
1346 (c == EOL2_CHAR(tty) && L_IEXTEN(tty))) {
Joe Petersonacc71bb2009-01-02 13:43:32 +00001347 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty))
1348 ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 /*
1350 * XXX are EOL_CHAR and EOL2_CHAR echoed?!?
1351 */
1352 if (L_ECHO(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001354 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001355 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 echo_char(c, tty);
Peter Hurley17bd7902013-06-15 10:04:24 -04001357 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 }
1359 /*
1360 * XXX does PARMRK doubling happen for
1361 * EOL_CHAR and EOL2_CHAR?
1362 */
Joe Petersonacc71bb2009-01-02 13:43:32 +00001363 if (parmrk)
Jiri Slaby57c94122012-10-18 22:26:43 +02001364 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365
Alan Cox4edf1822008-02-08 04:18:44 -08001366handle_newline:
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001367 set_bit(ldata->read_head & (N_TTY_BUF_SIZE - 1), ldata->read_flags);
Peter Hurley6d76bd22013-06-15 09:14:26 -04001368 put_tty_queue(c, ldata);
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001369 ldata->canon_head = ldata->read_head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1371 if (waitqueue_active(&tty->read_wait))
1372 wake_up_interruptible(&tty->read_wait);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001373 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 }
1375 }
Alan Cox4edf1822008-02-08 04:18:44 -08001376
Joe Petersonacc71bb2009-01-02 13:43:32 +00001377 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty)) ? 1 : 0;
Joe Petersonacc71bb2009-01-02 13:43:32 +00001378 if (L_ECHO(tty)) {
Jiri Slaby57c94122012-10-18 22:26:43 +02001379 finish_erasing(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 if (c == '\n')
Jiri Slaby57c94122012-10-18 22:26:43 +02001381 echo_char_raw('\n', ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 else {
1383 /* Record the column of first canon char. */
Jiri Slabyba2e68a2012-10-18 22:26:41 +02001384 if (ldata->canon_head == ldata->read_head)
Jiri Slaby57c94122012-10-18 22:26:43 +02001385 echo_set_canon_col(ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386 echo_char(c, tty);
1387 }
Peter Hurley17bd7902013-06-15 10:04:24 -04001388 commit_echoes(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 }
1390
Joe Petersonacc71bb2009-01-02 13:43:32 +00001391 if (parmrk)
Jiri Slaby57c94122012-10-18 22:26:43 +02001392 put_tty_queue(c, ldata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393
Jiri Slaby57c94122012-10-18 22:26:43 +02001394 put_tty_queue(c, ldata);
Peter Hurleye60d27c2013-07-24 08:29:56 -04001395 return 0;
Alan Cox4edf1822008-02-08 04:18:44 -08001396}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397
Peter Hurleye60d27c2013-07-24 08:29:56 -04001398static inline void
1399n_tty_receive_char_inline(struct tty_struct *tty, unsigned char c)
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001400{
1401 struct n_tty_data *ldata = tty->disc_data;
1402 int parmrk;
1403
Peter Hurleye60d27c2013-07-24 08:29:56 -04001404 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1405 start_tty(tty);
1406 process_echoes(tty);
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001407 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001408 if (L_ECHO(tty)) {
1409 finish_erasing(ldata);
1410 /* Record the column of first canon char. */
1411 if (ldata->canon_head == ldata->read_head)
1412 echo_set_canon_col(ldata);
1413 echo_char(c, tty);
1414 commit_echoes(tty);
1415 }
1416 parmrk = (c == (unsigned char) '\377' && I_PARMRK(tty)) ? 1 : 0;
1417 if (parmrk)
1418 put_tty_queue(c, ldata);
1419 put_tty_queue(c, ldata);
1420}
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001421
Peter Hurleye60d27c2013-07-24 08:29:56 -04001422static inline void n_tty_receive_char(struct tty_struct *tty, unsigned char c)
1423{
1424 n_tty_receive_char_inline(tty, c);
Peter Hurley4b1f79c2013-07-24 08:29:51 -04001425}
1426
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001427static inline void
Peter Hurley7de971b2013-07-24 08:29:53 -04001428n_tty_receive_char_fast(struct tty_struct *tty, unsigned char c)
1429{
1430 struct n_tty_data *ldata = tty->disc_data;
1431
Peter Hurleye60d27c2013-07-24 08:29:56 -04001432 if (tty->stopped && !tty->flow_stopped && I_IXON(tty) && I_IXANY(tty)) {
1433 start_tty(tty);
1434 process_echoes(tty);
Peter Hurley7de971b2013-07-24 08:29:53 -04001435 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001436 if (L_ECHO(tty)) {
1437 finish_erasing(ldata);
1438 /* Record the column of first canon char. */
1439 if (ldata->canon_head == ldata->read_head)
1440 echo_set_canon_col(ldata);
1441 echo_char(c, tty);
1442 commit_echoes(tty);
1443 }
1444 put_tty_queue(c, ldata);
Peter Hurley7de971b2013-07-24 08:29:53 -04001445}
1446
1447static inline void
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001448n_tty_receive_char_closing(struct tty_struct *tty, unsigned char c)
1449{
1450 if (I_ISTRIP(tty))
1451 c &= 0x7f;
1452 if (I_IUCLC(tty) && L_IEXTEN(tty))
1453 c = tolower(c);
1454
1455 if (I_IXON(tty)) {
1456 if (c == STOP_CHAR(tty))
1457 stop_tty(tty);
1458 else if (c == START_CHAR(tty) ||
1459 (tty->stopped && !tty->flow_stopped && I_IXANY(tty) &&
1460 c != INTR_CHAR(tty) && c != QUIT_CHAR(tty) &&
1461 c != SUSP_CHAR(tty))) {
1462 start_tty(tty);
1463 process_echoes(tty);
1464 }
1465 }
1466}
1467
Peter Hurleyd2f8d7a2013-06-15 10:21:24 -04001468static void
1469n_tty_receive_char_flagged(struct tty_struct *tty, unsigned char c, char flag)
1470{
1471 char buf[64];
1472
1473 switch (flag) {
1474 case TTY_BREAK:
1475 n_tty_receive_break(tty);
1476 break;
1477 case TTY_PARITY:
1478 case TTY_FRAME:
1479 n_tty_receive_parity_error(tty, c);
1480 break;
1481 case TTY_OVERRUN:
1482 n_tty_receive_overrun(tty);
1483 break;
1484 default:
1485 printk(KERN_ERR "%s: unknown flag %d\n",
1486 tty_name(tty, buf), flag);
1487 break;
1488 }
1489}
1490
Peter Hurleye60d27c2013-07-24 08:29:56 -04001491static void
1492n_tty_receive_char_lnext(struct tty_struct *tty, unsigned char c, char flag)
1493{
1494 struct n_tty_data *ldata = tty->disc_data;
1495
1496 ldata->lnext = 0;
1497 if (likely(flag == TTY_NORMAL)) {
1498 if (I_ISTRIP(tty))
1499 c &= 0x7f;
1500 if (I_IUCLC(tty) && L_IEXTEN(tty))
1501 c = tolower(c);
1502 n_tty_receive_char(tty, c);
1503 } else
1504 n_tty_receive_char_flagged(tty, c, flag);
1505}
1506
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507/**
1508 * n_tty_receive_buf - data receive
1509 * @tty: terminal device
1510 * @cp: buffer
1511 * @fp: flag buffer
1512 * @count: characters
1513 *
1514 * Called by the terminal driver when a block of characters has
1515 * been received. This function must be called from soft contexts
1516 * not from interrupt context. The driver is responsible for making
1517 * calls one at a time and in order (or using flush_to_ldisc)
Peter Hurley6d76bd22013-06-15 09:14:26 -04001518 *
1519 * n_tty_receive_buf()/producer path:
1520 * claims non-exclusive termios_rwsem
1521 * publishes read_head and canon_head
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 */
Alan Cox4edf1822008-02-08 04:18:44 -08001523
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001524static void
1525n_tty_receive_buf_real_raw(struct tty_struct *tty, const unsigned char *cp,
1526 char *fp, int count)
1527{
1528 struct n_tty_data *ldata = tty->disc_data;
1529 size_t n, head;
1530
1531 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1532 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1533 n = min_t(size_t, count, n);
1534 memcpy(read_buf_addr(ldata, head), cp, n);
1535 ldata->read_head += n;
1536 cp += n;
1537 count -= n;
1538
1539 head = ldata->read_head & (N_TTY_BUF_SIZE - 1);
1540 n = N_TTY_BUF_SIZE - max(read_cnt(ldata), head);
1541 n = min_t(size_t, count, n);
1542 memcpy(read_buf_addr(ldata, head), cp, n);
1543 ldata->read_head += n;
1544}
1545
Peter Hurley554117b2013-06-15 10:21:25 -04001546static void
1547n_tty_receive_buf_raw(struct tty_struct *tty, const unsigned char *cp,
1548 char *fp, int count)
1549{
1550 struct n_tty_data *ldata = tty->disc_data;
1551 char flag = TTY_NORMAL;
1552
1553 while (count--) {
1554 if (fp)
1555 flag = *fp++;
1556 if (likely(flag == TTY_NORMAL))
1557 put_tty_queue(*cp++, ldata);
1558 else
1559 n_tty_receive_char_flagged(tty, *cp++, flag);
1560 }
1561}
1562
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001563static void
1564n_tty_receive_buf_closing(struct tty_struct *tty, const unsigned char *cp,
1565 char *fp, int count)
1566{
1567 char flag = TTY_NORMAL;
1568
1569 while (count--) {
1570 if (fp)
1571 flag = *fp++;
1572 if (likely(flag == TTY_NORMAL))
1573 n_tty_receive_char_closing(tty, *cp++);
1574 else
1575 n_tty_receive_char_flagged(tty, *cp++, flag);
1576 }
1577}
1578
Peter Hurley7d88d632013-07-24 08:29:49 -04001579static void
1580n_tty_receive_buf_standard(struct tty_struct *tty, const unsigned char *cp,
Peter Hurley6baad002013-07-24 08:29:52 -04001581 char *fp, int count)
1582{
1583 struct n_tty_data *ldata = tty->disc_data;
1584 char flag = TTY_NORMAL;
1585
1586 while (count--) {
1587 if (fp)
1588 flag = *fp++;
1589 if (likely(flag == TTY_NORMAL)) {
1590 unsigned char c = *cp++;
1591
1592 if (I_ISTRIP(tty))
1593 c &= 0x7f;
1594 if (I_IUCLC(tty) && L_IEXTEN(tty))
1595 c = tolower(c);
1596 if (L_EXTPROC(tty)) {
1597 put_tty_queue(c, ldata);
1598 continue;
1599 }
Peter Hurleye60d27c2013-07-24 08:29:56 -04001600 if (!test_bit(c, ldata->char_map))
1601 n_tty_receive_char_inline(tty, c);
1602 else if (n_tty_receive_char_special(tty, c) && count) {
1603 if (fp)
1604 flag = *fp++;
1605 n_tty_receive_char_lnext(tty, *cp++, flag);
1606 count--;
1607 }
Peter Hurley6baad002013-07-24 08:29:52 -04001608 } else
1609 n_tty_receive_char_flagged(tty, *cp++, flag);
1610 }
1611}
1612
1613static void
1614n_tty_receive_buf_fast(struct tty_struct *tty, const unsigned char *cp,
1615 char *fp, int count)
Peter Hurley7d88d632013-07-24 08:29:49 -04001616{
Peter Hurleye60d27c2013-07-24 08:29:56 -04001617 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley7d88d632013-07-24 08:29:49 -04001618 char flag = TTY_NORMAL;
1619
1620 while (count--) {
1621 if (fp)
1622 flag = *fp++;
Peter Hurleye60d27c2013-07-24 08:29:56 -04001623 if (likely(flag == TTY_NORMAL)) {
1624 unsigned char c = *cp++;
1625
1626 if (!test_bit(c, ldata->char_map))
1627 n_tty_receive_char_fast(tty, c);
1628 else if (n_tty_receive_char_special(tty, c) && count) {
1629 if (fp)
1630 flag = *fp++;
1631 n_tty_receive_char_lnext(tty, *cp++, flag);
1632 count--;
1633 }
1634 } else
Peter Hurley7d88d632013-07-24 08:29:49 -04001635 n_tty_receive_char_flagged(tty, *cp++, flag);
1636 }
1637}
1638
Peter Hurley24a89d12013-06-15 09:14:15 -04001639static void __receive_buf(struct tty_struct *tty, const unsigned char *cp,
1640 char *fp, int count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001642 struct n_tty_data *ldata = tty->disc_data;
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001643 bool preops = I_ISTRIP(tty) || (I_IUCLC(tty) && L_IEXTEN(tty));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001645 if (ldata->real_raw)
1646 n_tty_receive_buf_real_raw(tty, cp, fp, count);
Peter Hurleya1dd30e2013-06-15 10:21:26 -04001647 else if (ldata->raw || (L_EXTPROC(tty) && !preops))
Peter Hurley554117b2013-06-15 10:21:25 -04001648 n_tty_receive_buf_raw(tty, cp, fp, count);
Peter Hurleyad0cc7b2013-06-15 10:21:27 -04001649 else if (tty->closing && !L_EXTPROC(tty))
1650 n_tty_receive_buf_closing(tty, cp, fp, count);
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001651 else {
Peter Hurleye60d27c2013-07-24 08:29:56 -04001652 if (ldata->lnext) {
1653 char flag = TTY_NORMAL;
1654
1655 if (fp)
1656 flag = *fp++;
1657 n_tty_receive_char_lnext(tty, *cp++, flag);
1658 count--;
1659 }
1660
Peter Hurley7de971b2013-07-24 08:29:53 -04001661 if (!preops && !I_PARMRK(tty))
Peter Hurley6baad002013-07-24 08:29:52 -04001662 n_tty_receive_buf_fast(tty, cp, fp, count);
1663 else
1664 n_tty_receive_buf_standard(tty, cp, fp, count);
Peter Hurleycbfd0342013-06-15 10:04:26 -04001665
1666 flush_echoes(tty);
Alan Coxf34d7a52008-04-30 00:54:13 -07001667 if (tty->ops->flush_chars)
1668 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 }
1670
Peter Hurleyce741172013-06-15 09:14:20 -04001671 if ((!ldata->icanon && (read_cnt(ldata) >= ldata->minimum_to_wake)) ||
hyc@symas.com26df6d12010-06-22 10:14:49 -07001672 L_EXTPROC(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 kill_fasync(&tty->fasync, SIGIO, POLL_IN);
1674 if (waitqueue_active(&tty->read_wait))
1675 wake_up_interruptible(&tty->read_wait);
1676 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677}
1678
Peter Hurley24a89d12013-06-15 09:14:15 -04001679static void n_tty_receive_buf(struct tty_struct *tty, const unsigned char *cp,
1680 char *fp, int count)
1681{
Peter Hurley19e2ad62013-07-24 08:29:54 -04001682 int room, n;
1683
Peter Hurley9356b532013-06-15 09:14:24 -04001684 down_read(&tty->termios_rwsem);
Peter Hurley19e2ad62013-07-24 08:29:54 -04001685
1686 while (1) {
1687 room = receive_room(tty);
1688 n = min(count, room);
1689 if (!n)
1690 break;
1691 __receive_buf(tty, cp, fp, n);
1692 cp += n;
1693 if (fp)
1694 fp += n;
1695 count -= n;
1696 }
1697
1698 tty->receive_room = room;
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001699 n_tty_check_throttle(tty);
Peter Hurley9356b532013-06-15 09:14:24 -04001700 up_read(&tty->termios_rwsem);
Peter Hurley24a89d12013-06-15 09:14:15 -04001701}
1702
1703static int n_tty_receive_buf2(struct tty_struct *tty, const unsigned char *cp,
1704 char *fp, int count)
1705{
1706 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley19e2ad62013-07-24 08:29:54 -04001707 int room, n, rcvd = 0;
Peter Hurley24a89d12013-06-15 09:14:15 -04001708
Peter Hurley9356b532013-06-15 09:14:24 -04001709 down_read(&tty->termios_rwsem);
1710
Peter Hurley19e2ad62013-07-24 08:29:54 -04001711 while (1) {
1712 room = receive_room(tty);
1713 n = min(count, room);
1714 if (!n) {
1715 if (!room)
1716 ldata->no_room = 1;
1717 break;
1718 }
1719 __receive_buf(tty, cp, fp, n);
1720 cp += n;
1721 if (fp)
1722 fp += n;
1723 count -= n;
1724 rcvd += n;
Peter Hurley4a23a4d2013-06-15 10:21:22 -04001725 }
Peter Hurley24a89d12013-06-15 09:14:15 -04001726
Peter Hurley19e2ad62013-07-24 08:29:54 -04001727 tty->receive_room = room;
1728 n_tty_check_throttle(tty);
Peter Hurley9356b532013-06-15 09:14:24 -04001729 up_read(&tty->termios_rwsem);
1730
Peter Hurley19e2ad62013-07-24 08:29:54 -04001731 return rcvd;
Peter Hurley24a89d12013-06-15 09:14:15 -04001732}
1733
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734int is_ignored(int sig)
1735{
1736 return (sigismember(&current->blocked, sig) ||
Alan Cox4edf1822008-02-08 04:18:44 -08001737 current->sighand->action[sig-1].sa.sa_handler == SIG_IGN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738}
1739
1740/**
1741 * n_tty_set_termios - termios data changed
1742 * @tty: terminal
1743 * @old: previous data
1744 *
1745 * Called by the tty layer when the user changes termios flags so
1746 * that the line discipline can plan ahead. This function cannot sleep
Alan Cox4edf1822008-02-08 04:18:44 -08001747 * and is protected from re-entry by the tty layer. The user is
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 * guaranteed that this function will not be re-entered or in progress
1749 * when the ldisc is closed.
Alan Cox17b82062008-10-13 10:45:06 +01001750 *
Peter Hurley6a1c0682013-06-15 09:14:23 -04001751 * Locking: Caller holds tty->termios_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752 */
Alan Cox4edf1822008-02-08 04:18:44 -08001753
1754static void n_tty_set_termios(struct tty_struct *tty, struct ktermios *old)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001756 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01001757
Peter Hurleyc786f742013-09-17 12:53:35 -04001758 if (!old || (old->c_lflag ^ tty->termios.c_lflag) & ICANON) {
Jiri Slaby3fe780b2012-10-18 22:26:40 +02001759 bitmap_zero(ldata->read_flags, N_TTY_BUF_SIZE);
Peter Hurley93a8d412013-09-17 12:34:14 -04001760 ldata->line_start = ldata->canon_head = ldata->read_tail;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001761 ldata->erasing = 0;
Peter Hurley6f9b0282013-06-15 09:14:27 -04001762 ldata->lnext = 0;
Alan Cox47afa7a2008-10-13 10:44:17 +01001763 }
1764
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001765 ldata->icanon = (L_ICANON(tty) != 0);
Peter Hurley582f5592013-05-17 12:49:48 -04001766
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 if (I_ISTRIP(tty) || I_IUCLC(tty) || I_IGNCR(tty) ||
1768 I_ICRNL(tty) || I_INLCR(tty) || L_ICANON(tty) ||
1769 I_IXON(tty) || L_ISIG(tty) || L_ECHO(tty) ||
1770 I_PARMRK(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001771 bitmap_zero(ldata->char_map, 256);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772
1773 if (I_IGNCR(tty) || I_ICRNL(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001774 set_bit('\r', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775 if (I_INLCR(tty))
Peter Hurley1bb9d562013-06-15 10:21:20 -04001776 set_bit('\n', ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777
1778 if (L_ICANON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001779 set_bit(ERASE_CHAR(tty), ldata->char_map);
1780 set_bit(KILL_CHAR(tty), ldata->char_map);
1781 set_bit(EOF_CHAR(tty), ldata->char_map);
1782 set_bit('\n', ldata->char_map);
1783 set_bit(EOL_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 if (L_IEXTEN(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001785 set_bit(WERASE_CHAR(tty), ldata->char_map);
1786 set_bit(LNEXT_CHAR(tty), ldata->char_map);
1787 set_bit(EOL2_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788 if (L_ECHO(tty))
1789 set_bit(REPRINT_CHAR(tty),
Peter Hurley1bb9d562013-06-15 10:21:20 -04001790 ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 }
1792 }
1793 if (I_IXON(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001794 set_bit(START_CHAR(tty), ldata->char_map);
1795 set_bit(STOP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 }
1797 if (L_ISIG(tty)) {
Peter Hurley1bb9d562013-06-15 10:21:20 -04001798 set_bit(INTR_CHAR(tty), ldata->char_map);
1799 set_bit(QUIT_CHAR(tty), ldata->char_map);
1800 set_bit(SUSP_CHAR(tty), ldata->char_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801 }
Peter Hurley1bb9d562013-06-15 10:21:20 -04001802 clear_bit(__DISABLED_CHAR, ldata->char_map);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001803 ldata->raw = 0;
1804 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805 } else {
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001806 ldata->raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807 if ((I_IGNBRK(tty) || (!I_BRKINT(tty) && !I_PARMRK(tty))) &&
1808 (I_IGNPAR(tty) || !I_INPCK(tty)) &&
1809 (tty->driver->flags & TTY_DRIVER_REAL_RAW))
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001810 ldata->real_raw = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 else
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001812 ldata->real_raw = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 }
Linus Torvalds55db4c62011-06-04 06:33:24 +09001814 n_tty_set_room(tty);
Wang YanQingdab73b42013-05-09 14:16:47 +08001815 /*
1816 * Fix tty hang when I_IXON(tty) is cleared, but the tty
1817 * been stopped by STOP_CHAR(tty) before it.
1818 */
Peter Hurley103fcbe22013-09-17 12:53:36 -04001819 if (!I_IXON(tty) && old && (old->c_iflag & IXON) && !tty->flow_stopped)
Wang YanQingdab73b42013-05-09 14:16:47 +08001820 start_tty(tty);
Wang YanQingdab73b42013-05-09 14:16:47 +08001821
Alan Coxf34d7a52008-04-30 00:54:13 -07001822 /* The termios change make the tty ready for I/O */
1823 wake_up_interruptible(&tty->write_wait);
1824 wake_up_interruptible(&tty->read_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825}
1826
1827/**
1828 * n_tty_close - close the ldisc for this tty
1829 * @tty: device
1830 *
Alan Cox4edf1822008-02-08 04:18:44 -08001831 * Called from the terminal layer when this line discipline is
1832 * being shut down, either because of a close or becsuse of a
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 * discipline change. The function will not be called while other
1834 * ldisc methods are in progress.
1835 */
Alan Cox4edf1822008-02-08 04:18:44 -08001836
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837static void n_tty_close(struct tty_struct *tty)
1838{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001839 struct n_tty_data *ldata = tty->disc_data;
1840
Peter Hurley79901312013-03-11 16:44:23 -04001841 if (tty->link)
1842 n_tty_packet_mode_flush(tty);
1843
Peter Hurley20bafb32013-06-15 10:21:19 -04001844 vfree(ldata);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001845 tty->disc_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846}
1847
1848/**
1849 * n_tty_open - open an ldisc
1850 * @tty: terminal to open
1851 *
Alan Cox4edf1822008-02-08 04:18:44 -08001852 * Called when this line discipline is being attached to the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853 * terminal device. Can sleep. Called serialized so that no
1854 * other events will occur in parallel. No further open will occur
1855 * until a close.
1856 */
1857
1858static int n_tty_open(struct tty_struct *tty)
1859{
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001860 struct n_tty_data *ldata;
1861
Peter Hurley20bafb32013-06-15 10:21:19 -04001862 /* Currently a malloc failure here can panic */
1863 ldata = vmalloc(sizeof(*ldata));
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001864 if (!ldata)
1865 goto err;
1866
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001867 ldata->overrun_time = jiffies;
Jiri Slabybddc7152012-10-18 22:26:42 +02001868 mutex_init(&ldata->atomic_read_lock);
1869 mutex_init(&ldata->output_lock);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001870
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001871 tty->disc_data = ldata;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001872 reset_buffer_flags(tty->disc_data);
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001873 ldata->column = 0;
Peter Hurley20bafb32013-06-15 10:21:19 -04001874 ldata->canon_column = 0;
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04001875 ldata->minimum_to_wake = 1;
Peter Hurley20bafb32013-06-15 10:21:19 -04001876 ldata->num_overrun = 0;
1877 ldata->no_room = 0;
1878 ldata->lnext = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879 tty->closing = 0;
Peter Hurleyb66f4fa2013-03-11 16:44:32 -04001880 /* indicate buffer work may resume */
1881 clear_bit(TTY_LDISC_HALTED, &tty->flags);
1882 n_tty_set_termios(tty, NULL);
1883 tty_unthrottle(tty);
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001884
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 return 0;
Jiri Slaby70ece7a2012-10-18 22:26:38 +02001886err:
Jiri Slabyb91939f2012-10-18 22:26:35 +02001887 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888}
1889
1890static inline int input_available_p(struct tty_struct *tty, int amt)
1891{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001892 struct n_tty_data *ldata = tty->disc_data;
1893
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001894 if (ldata->icanon && !L_EXTPROC(tty)) {
Peter Hurleya73d3d62013-06-15 09:14:25 -04001895 if (ldata->canon_head != ldata->read_tail)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 return 1;
Peter Hurleyce741172013-06-15 09:14:20 -04001897 } else if (read_cnt(ldata) >= (amt ? amt : 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 return 1;
1899
1900 return 0;
1901}
1902
1903/**
Thorsten Wißmannbbd20752011-12-08 17:47:33 +01001904 * copy_from_read_buf - copy read data directly
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905 * @tty: terminal device
1906 * @b: user data
1907 * @nr: size of data
1908 *
Alan Cox11a96d12008-10-13 10:46:24 +01001909 * Helper function to speed up n_tty_read. It is only called when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 * ICANON is off; it copies characters straight from the tty queue to
1911 * user space directly. It can be profitably called twice; once to
1912 * drain the space from the tail pointer to the (physical) end of the
1913 * buffer, and once to drain the space from the (physical) beginning of
1914 * the buffer to head pointer.
1915 *
Jiri Slabybddc7152012-10-18 22:26:42 +02001916 * Called under the ldata->atomic_read_lock sem
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917 *
Peter Hurley6d76bd22013-06-15 09:14:26 -04001918 * n_tty_read()/consumer path:
1919 * caller holds non-exclusive termios_rwsem
1920 * read_tail published
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 */
Alan Cox4edf1822008-02-08 04:18:44 -08001922
Alan Cox33f0f882006-01-09 20:54:13 -08001923static int copy_from_read_buf(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924 unsigned char __user **b,
1925 size_t *nr)
1926
1927{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001928 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 int retval;
1930 size_t n;
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001931 bool is_eof;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001932 size_t tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933
1934 retval = 0;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001935 n = min(read_cnt(ldata), N_TTY_BUF_SIZE - tail);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 n = min(*nr, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 if (n) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001938 retval = copy_to_user(*b, read_buf_addr(ldata, tail), n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 n -= retval;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001940 is_eof = n == 1 && read_buf(ldata, tail) == EOF_CHAR(tty);
1941 tty_audit_add_data(tty, read_buf_addr(ldata, tail), n,
Jiri Slaby53c5ee22012-10-18 22:26:39 +02001942 ldata->icanon);
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001943 ldata->read_tail += n;
hyc@symas.com26df6d12010-06-22 10:14:49 -07001944 /* Turn single EOF into zero-length read */
Peter Hurleyce741172013-06-15 09:14:20 -04001945 if (L_EXTPROC(tty) && ldata->icanon && is_eof && !read_cnt(ldata))
Jiri Slaby3fa10cc2012-04-26 20:13:00 +02001946 n = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 *b += n;
1948 *nr -= n;
1949 }
1950 return retval;
1951}
1952
Peter Hurley88bb0de2013-06-15 09:14:16 -04001953/**
Peter Hurley32f13522013-06-15 09:14:17 -04001954 * canon_copy_from_read_buf - copy read data in canonical mode
Peter Hurley88bb0de2013-06-15 09:14:16 -04001955 * @tty: terminal device
1956 * @b: user data
1957 * @nr: size of data
1958 *
1959 * Helper function for n_tty_read. It is only called when ICANON is on;
Peter Hurley32f13522013-06-15 09:14:17 -04001960 * it copies one line of input up to and including the line-delimiting
1961 * character into the user-space buffer.
Peter Hurley88bb0de2013-06-15 09:14:16 -04001962 *
1963 * Called under the atomic_read_lock mutex
Peter Hurley6d76bd22013-06-15 09:14:26 -04001964 *
1965 * n_tty_read()/consumer path:
1966 * caller holds non-exclusive termios_rwsem
1967 * read_tail published
Peter Hurley88bb0de2013-06-15 09:14:16 -04001968 */
1969
Peter Hurley32f13522013-06-15 09:14:17 -04001970static int canon_copy_from_read_buf(struct tty_struct *tty,
1971 unsigned char __user **b,
1972 size_t *nr)
Peter Hurley88bb0de2013-06-15 09:14:16 -04001973{
1974 struct n_tty_data *ldata = tty->disc_data;
Peter Hurley32f13522013-06-15 09:14:17 -04001975 size_t n, size, more, c;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001976 size_t eol;
1977 size_t tail;
1978 int ret, found = 0;
Peter Hurley40d5e092013-06-15 10:21:17 -04001979 bool eof_push = 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04001980
1981 /* N.B. avoid overrun if nr == 0 */
Peter Hurleyce741172013-06-15 09:14:20 -04001982 n = min(*nr, read_cnt(ldata));
Peter Hurley6d76bd22013-06-15 09:14:26 -04001983 if (!n)
Peter Hurley32f13522013-06-15 09:14:17 -04001984 return 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04001985
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001986 tail = ldata->read_tail & (N_TTY_BUF_SIZE - 1);
Peter Hurley32f13522013-06-15 09:14:17 -04001987 size = min_t(size_t, tail + n, N_TTY_BUF_SIZE);
1988
Peter Hurleybc5a5e32013-06-15 09:14:21 -04001989 n_tty_trace("%s: nr:%zu tail:%zu n:%zu size:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04001990 __func__, *nr, tail, n, size);
1991
1992 eol = find_next_bit(ldata->read_flags, size, tail);
1993 more = n - (size - tail);
1994 if (eol == N_TTY_BUF_SIZE && more) {
1995 /* scan wrapped without finding set bit */
1996 eol = find_next_bit(ldata->read_flags, more, 0);
1997 if (eol != more)
1998 found = 1;
1999 } else if (eol != size)
2000 found = 1;
2001
2002 size = N_TTY_BUF_SIZE - tail;
Peter Hurleyc77569d2013-11-22 07:16:25 -05002003 n = eol - tail;
2004 if (n > 4096)
2005 n += 4096;
2006 n += found;
Peter Hurley32f13522013-06-15 09:14:17 -04002007 c = n;
2008
Peter Hurley40d5e092013-06-15 10:21:17 -04002009 if (found && read_buf(ldata, eol) == __DISABLED_CHAR) {
Peter Hurley32f13522013-06-15 09:14:17 -04002010 n--;
Peter Hurley40d5e092013-06-15 10:21:17 -04002011 eof_push = !n && ldata->read_tail != ldata->line_start;
2012 }
Peter Hurley32f13522013-06-15 09:14:17 -04002013
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002014 n_tty_trace("%s: eol:%zu found:%d n:%zu c:%zu size:%zu more:%zu\n",
Peter Hurley32f13522013-06-15 09:14:17 -04002015 __func__, eol, found, n, c, size, more);
2016
Peter Hurley32f13522013-06-15 09:14:17 -04002017 if (n > size) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002018 ret = copy_to_user(*b, read_buf_addr(ldata, tail), size);
Peter Hurley32f13522013-06-15 09:14:17 -04002019 if (ret)
2020 return -EFAULT;
2021 ret = copy_to_user(*b + size, ldata->read_buf, n - size);
2022 } else
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002023 ret = copy_to_user(*b, read_buf_addr(ldata, tail), n);
Peter Hurley32f13522013-06-15 09:14:17 -04002024
2025 if (ret)
2026 return -EFAULT;
2027 *b += n;
2028 *nr -= n;
2029
Peter Hurleya73d3d62013-06-15 09:14:25 -04002030 if (found)
Peter Hurley6d76bd22013-06-15 09:14:26 -04002031 clear_bit(eol, ldata->read_flags);
2032 smp_mb__after_clear_bit();
2033 ldata->read_tail += c;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002034
Peter Hurley40d5e092013-06-15 10:21:17 -04002035 if (found) {
2036 ldata->line_start = ldata->read_tail;
Peter Hurley32f13522013-06-15 09:14:17 -04002037 tty_audit_push(tty);
Peter Hurley40d5e092013-06-15 10:21:17 -04002038 }
2039 return eof_push ? -EAGAIN : 0;
Peter Hurley88bb0de2013-06-15 09:14:16 -04002040}
2041
Al Virocc4191d2008-03-29 03:08:48 +00002042extern ssize_t redirected_tty_write(struct file *, const char __user *,
Alan Cox4edf1822008-02-08 04:18:44 -08002043 size_t, loff_t *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044
2045/**
2046 * job_control - check job control
2047 * @tty: tty
2048 * @file: file handle
2049 *
2050 * Perform job control management checks on this file/tty descriptor
Alan Cox4edf1822008-02-08 04:18:44 -08002051 * and if appropriate send any needed signals and return a negative
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052 * error code if action should be taken.
Alan Cox04f378b2008-04-30 00:53:29 -07002053 *
Peter Hurley01a5e442013-03-06 08:38:20 -05002054 * Locking: redirected write test is safe
2055 * current->signal->tty check is safe
2056 * ctrl_lock to safely reference tty->pgrp
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057 */
Alan Cox4edf1822008-02-08 04:18:44 -08002058
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059static int job_control(struct tty_struct *tty, struct file *file)
2060{
2061 /* Job control check -- must be done at start and after
2062 every sleep (POSIX.1 7.1.1.4). */
2063 /* NOTE: not yet done after every sleep pending a thorough
2064 check of the logic of this change. -- jlc */
2065 /* don't stop on /dev/console */
Peter Hurley01a5e442013-03-06 08:38:20 -05002066 if (file->f_op->write == redirected_tty_write ||
2067 current->signal->tty != tty)
2068 return 0;
2069
2070 spin_lock_irq(&tty->ctrl_lock);
2071 if (!tty->pgrp)
2072 printk(KERN_ERR "n_tty_read: no tty->pgrp!\n");
2073 else if (task_pgrp(current) != tty->pgrp) {
2074 spin_unlock_irq(&tty->ctrl_lock);
2075 if (is_ignored(SIGTTIN) || is_current_pgrp_orphaned())
2076 return -EIO;
2077 kill_pgrp(task_pgrp(current), SIGTTIN, 1);
2078 set_thread_flag(TIF_SIGPENDING);
2079 return -ERESTARTSYS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080 }
Peter Hurley01a5e442013-03-06 08:38:20 -05002081 spin_unlock_irq(&tty->ctrl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 return 0;
2083}
Alan Cox4edf1822008-02-08 04:18:44 -08002084
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085
2086/**
Alan Cox11a96d12008-10-13 10:46:24 +01002087 * n_tty_read - read function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088 * @tty: tty device
2089 * @file: file object
2090 * @buf: userspace buffer pointer
2091 * @nr: size of I/O
2092 *
2093 * Perform reads for the line discipline. We are guaranteed that the
2094 * line discipline will not be closed under us but we may get multiple
2095 * parallel readers and must handle this ourselves. We may also get
2096 * a hangup. Always called in user context, may sleep.
2097 *
2098 * This code must be sure never to sleep through a hangup.
Peter Hurley6d76bd22013-06-15 09:14:26 -04002099 *
2100 * n_tty_read()/consumer path:
2101 * claims non-exclusive termios_rwsem
2102 * publishes read_tail
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 */
Alan Cox4edf1822008-02-08 04:18:44 -08002104
Alan Cox11a96d12008-10-13 10:46:24 +01002105static ssize_t n_tty_read(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 unsigned char __user *buf, size_t nr)
2107{
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002108 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 unsigned char __user *b = buf;
2110 DECLARE_WAITQUEUE(wait, current);
2111 int c;
2112 int minimum, time;
2113 ssize_t retval = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 long timeout;
2115 unsigned long flags;
Alan Cox04f378b2008-04-30 00:53:29 -07002116 int packet;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 c = job_control(tty, file);
Alan Cox4edf1822008-02-08 04:18:44 -08002119 if (c < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120 return c;
Alan Cox4edf1822008-02-08 04:18:44 -08002121
Peter Hurleyaefceaf2013-08-11 08:04:23 -04002122 /*
2123 * Internal serialization of reads.
2124 */
2125 if (file->f_flags & O_NONBLOCK) {
2126 if (!mutex_trylock(&ldata->atomic_read_lock))
2127 return -EAGAIN;
2128 } else {
2129 if (mutex_lock_interruptible(&ldata->atomic_read_lock))
2130 return -ERESTARTSYS;
2131 }
2132
Peter Hurley9356b532013-06-15 09:14:24 -04002133 down_read(&tty->termios_rwsem);
2134
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 minimum = time = 0;
2136 timeout = MAX_SCHEDULE_TIMEOUT;
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002137 if (!ldata->icanon) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 minimum = MIN_CHAR(tty);
2139 if (minimum) {
Peter Hurleya6e54312013-06-15 07:28:29 -04002140 time = (HZ / 10) * TIME_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 if (time)
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002142 ldata->minimum_to_wake = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 else if (!waitqueue_active(&tty->read_wait) ||
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002144 (ldata->minimum_to_wake > minimum))
2145 ldata->minimum_to_wake = minimum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 } else {
Peter Hurleya6e54312013-06-15 07:28:29 -04002147 timeout = (HZ / 10) * TIME_CHAR(tty);
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002148 ldata->minimum_to_wake = minimum = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 }
2150 }
2151
Alan Cox04f378b2008-04-30 00:53:29 -07002152 packet = tty->packet;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153
2154 add_wait_queue(&tty->read_wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 while (nr) {
2156 /* First test for status change. */
Alan Cox04f378b2008-04-30 00:53:29 -07002157 if (packet && tty->link->ctrl_status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 unsigned char cs;
2159 if (b != buf)
2160 break;
Alan Cox04f378b2008-04-30 00:53:29 -07002161 spin_lock_irqsave(&tty->link->ctrl_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 cs = tty->link->ctrl_status;
2163 tty->link->ctrl_status = 0;
Alan Cox04f378b2008-04-30 00:53:29 -07002164 spin_unlock_irqrestore(&tty->link->ctrl_lock, flags);
Miloslav Trmac522ed772007-07-15 23:40:56 -07002165 if (tty_put_user(tty, cs, b++)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 retval = -EFAULT;
2167 b--;
2168 break;
2169 }
2170 nr--;
2171 break;
2172 }
2173 /* This statement must be first before checking for input
2174 so that any interrupt will set the state back to
2175 TASK_RUNNING. */
2176 set_current_state(TASK_INTERRUPTIBLE);
Alan Cox4edf1822008-02-08 04:18:44 -08002177
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002178 if (((minimum - (b - buf)) < ldata->minimum_to_wake) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 ((minimum - (b - buf)) >= 1))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002180 ldata->minimum_to_wake = (minimum - (b - buf));
Alan Cox4edf1822008-02-08 04:18:44 -08002181
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 if (!input_available_p(tty, 0)) {
2183 if (test_bit(TTY_OTHER_CLOSED, &tty->flags)) {
Peter Hurleyf8747d42013-09-27 13:27:05 -04002184 up_read(&tty->termios_rwsem);
2185 tty_flush_to_ldisc(tty);
2186 down_read(&tty->termios_rwsem);
2187 if (!input_available_p(tty, 0)) {
2188 retval = -EIO;
2189 break;
2190 }
2191 } else {
2192 if (tty_hung_up_p(file))
2193 break;
2194 if (!timeout)
2195 break;
2196 if (file->f_flags & O_NONBLOCK) {
2197 retval = -EAGAIN;
2198 break;
2199 }
2200 if (signal_pending(current)) {
2201 retval = -ERESTARTSYS;
2202 break;
2203 }
2204 n_tty_set_room(tty);
2205 up_read(&tty->termios_rwsem);
Peter Hurley9356b532013-06-15 09:14:24 -04002206
Peter Hurleyf8747d42013-09-27 13:27:05 -04002207 timeout = schedule_timeout(timeout);
Peter Hurley9356b532013-06-15 09:14:24 -04002208
Peter Hurleyf8747d42013-09-27 13:27:05 -04002209 down_read(&tty->termios_rwsem);
2210 continue;
2211 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 }
2213 __set_current_state(TASK_RUNNING);
2214
2215 /* Deal with packet mode. */
Alan Cox04f378b2008-04-30 00:53:29 -07002216 if (packet && b == buf) {
Miloslav Trmac522ed772007-07-15 23:40:56 -07002217 if (tty_put_user(tty, TIOCPKT_DATA, b++)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 retval = -EFAULT;
2219 b--;
2220 break;
2221 }
2222 nr--;
2223 }
2224
Jiri Slaby53c5ee22012-10-18 22:26:39 +02002225 if (ldata->icanon && !L_EXTPROC(tty)) {
Peter Hurley32f13522013-06-15 09:14:17 -04002226 retval = canon_copy_from_read_buf(tty, &b, &nr);
Peter Hurley40d5e092013-06-15 10:21:17 -04002227 if (retval == -EAGAIN) {
2228 retval = 0;
2229 continue;
2230 } else if (retval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231 break;
2232 } else {
2233 int uncopied;
Alan Cox04f378b2008-04-30 00:53:29 -07002234 /* The copy function takes the read lock and handles
2235 locking internally for this case */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 uncopied = copy_from_read_buf(tty, &b, &nr);
2237 uncopied += copy_from_read_buf(tty, &b, &nr);
2238 if (uncopied) {
2239 retval = -EFAULT;
2240 break;
2241 }
2242 }
2243
Peter Hurley6367ca72013-06-15 09:14:33 -04002244 n_tty_check_unthrottle(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245
2246 if (b - buf >= minimum)
2247 break;
2248 if (time)
2249 timeout = time;
2250 }
Peter Hurley42458f42013-11-07 13:59:46 -05002251 n_tty_set_room(tty);
2252 up_read(&tty->termios_rwsem);
2253
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 remove_wait_queue(&tty->read_wait, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255 if (!waitqueue_active(&tty->read_wait))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002256 ldata->minimum_to_wake = minimum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257
Peter Hurleyaebf04532013-11-07 14:01:57 -05002258 mutex_unlock(&ldata->atomic_read_lock);
2259
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 __set_current_state(TASK_RUNNING);
Peter Hurley40d5e092013-06-15 10:21:17 -04002261 if (b - buf)
2262 retval = b - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263
2264 return retval;
2265}
2266
2267/**
Alan Cox11a96d12008-10-13 10:46:24 +01002268 * n_tty_write - write function for tty
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269 * @tty: tty device
2270 * @file: file object
2271 * @buf: userspace buffer pointer
2272 * @nr: size of I/O
2273 *
Joe Petersona88a69c2009-01-02 13:40:53 +00002274 * Write function of the terminal device. This is serialized with
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 * respect to other write callers but not to termios changes, reads
Joe Petersona88a69c2009-01-02 13:40:53 +00002276 * and other such events. Since the receive code will echo characters,
2277 * thus calling driver write methods, the output_lock is used in
2278 * the output processing functions called here as well as in the
2279 * echo processing function to protect the column state and space
2280 * left in the buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281 *
2282 * This code must be sure never to sleep through a hangup.
Joe Petersona88a69c2009-01-02 13:40:53 +00002283 *
2284 * Locking: output_lock to protect column state and space left
2285 * (note that the process_output*() functions take this
2286 * lock themselves)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 */
Alan Cox4edf1822008-02-08 04:18:44 -08002288
Alan Cox11a96d12008-10-13 10:46:24 +01002289static ssize_t n_tty_write(struct tty_struct *tty, struct file *file,
Joe Petersona88a69c2009-01-02 13:40:53 +00002290 const unsigned char *buf, size_t nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291{
2292 const unsigned char *b = buf;
2293 DECLARE_WAITQUEUE(wait, current);
2294 int c;
2295 ssize_t retval = 0;
2296
2297 /* Job control check -- must be done at start (POSIX.1 7.1.1.4). */
2298 if (L_TOSTOP(tty) && file->f_op->write != redirected_tty_write) {
2299 retval = tty_check_change(tty);
2300 if (retval)
2301 return retval;
2302 }
2303
Peter Hurley9356b532013-06-15 09:14:24 -04002304 down_read(&tty->termios_rwsem);
2305
Joe Petersona88a69c2009-01-02 13:40:53 +00002306 /* Write out any echoed characters that are still pending */
2307 process_echoes(tty);
Alan Cox300a6202009-01-02 13:41:04 +00002308
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309 add_wait_queue(&tty->write_wait, &wait);
2310 while (1) {
2311 set_current_state(TASK_INTERRUPTIBLE);
2312 if (signal_pending(current)) {
2313 retval = -ERESTARTSYS;
2314 break;
2315 }
2316 if (tty_hung_up_p(file) || (tty->link && !tty->link->count)) {
2317 retval = -EIO;
2318 break;
2319 }
Peter Hurley582f5592013-05-17 12:49:48 -04002320 if (O_OPOST(tty)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321 while (nr > 0) {
Joe Petersona88a69c2009-01-02 13:40:53 +00002322 ssize_t num = process_output_block(tty, b, nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323 if (num < 0) {
2324 if (num == -EAGAIN)
2325 break;
2326 retval = num;
2327 goto break_out;
2328 }
2329 b += num;
2330 nr -= num;
2331 if (nr == 0)
2332 break;
2333 c = *b;
Joe Petersona88a69c2009-01-02 13:40:53 +00002334 if (process_output(c, tty) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 break;
2336 b++; nr--;
2337 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002338 if (tty->ops->flush_chars)
2339 tty->ops->flush_chars(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340 } else {
Roman Zippeld6afe272005-07-07 17:56:55 -07002341 while (nr > 0) {
Alan Coxf34d7a52008-04-30 00:54:13 -07002342 c = tty->ops->write(tty, b, nr);
Roman Zippeld6afe272005-07-07 17:56:55 -07002343 if (c < 0) {
2344 retval = c;
2345 goto break_out;
2346 }
2347 if (!c)
2348 break;
2349 b += c;
2350 nr -= c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352 }
2353 if (!nr)
2354 break;
2355 if (file->f_flags & O_NONBLOCK) {
2356 retval = -EAGAIN;
2357 break;
2358 }
Peter Hurley9356b532013-06-15 09:14:24 -04002359 up_read(&tty->termios_rwsem);
2360
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361 schedule();
Peter Hurley9356b532013-06-15 09:14:24 -04002362
2363 down_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364 }
2365break_out:
2366 __set_current_state(TASK_RUNNING);
2367 remove_wait_queue(&tty->write_wait, &wait);
Thomas Pfaffff8cb0f2009-01-02 13:47:13 +00002368 if (b - buf != nr && tty->fasync)
2369 set_bit(TTY_DO_WRITE_WAKEUP, &tty->flags);
Peter Hurley9356b532013-06-15 09:14:24 -04002370 up_read(&tty->termios_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371 return (b - buf) ? b - buf : retval;
2372}
2373
2374/**
Alan Cox11a96d12008-10-13 10:46:24 +01002375 * n_tty_poll - poll method for N_TTY
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376 * @tty: terminal device
2377 * @file: file accessing it
2378 * @wait: poll table
2379 *
2380 * Called when the line discipline is asked to poll() for data or
2381 * for special events. This code is not serialized with respect to
2382 * other events save open/close.
2383 *
2384 * This code must be sure never to sleep through a hangup.
2385 * Called without the kernel lock held - fine
Linus Torvalds1da177e2005-04-16 15:20:36 -07002386 */
Alan Cox4edf1822008-02-08 04:18:44 -08002387
Alan Cox11a96d12008-10-13 10:46:24 +01002388static unsigned int n_tty_poll(struct tty_struct *tty, struct file *file,
Alan Cox4edf1822008-02-08 04:18:44 -08002389 poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390{
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002391 struct n_tty_data *ldata = tty->disc_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392 unsigned int mask = 0;
2393
2394 poll_wait(file, &tty->read_wait, wait);
2395 poll_wait(file, &tty->write_wait, wait);
2396 if (input_available_p(tty, TIME_CHAR(tty) ? 0 : MIN_CHAR(tty)))
2397 mask |= POLLIN | POLLRDNORM;
2398 if (tty->packet && tty->link->ctrl_status)
2399 mask |= POLLPRI | POLLIN | POLLRDNORM;
2400 if (test_bit(TTY_OTHER_CLOSED, &tty->flags))
2401 mask |= POLLHUP;
2402 if (tty_hung_up_p(file))
2403 mask |= POLLHUP;
2404 if (!(mask & (POLLHUP | POLLIN | POLLRDNORM))) {
2405 if (MIN_CHAR(tty) && !TIME_CHAR(tty))
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002406 ldata->minimum_to_wake = MIN_CHAR(tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407 else
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002408 ldata->minimum_to_wake = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 }
Alan Coxf34d7a52008-04-30 00:54:13 -07002410 if (tty->ops->write && !tty_is_writelocked(tty) &&
2411 tty_chars_in_buffer(tty) < WAKEUP_CHARS &&
2412 tty_write_room(tty) > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 mask |= POLLOUT | POLLWRNORM;
2414 return mask;
2415}
2416
Jiri Slaby57c94122012-10-18 22:26:43 +02002417static unsigned long inq_canon(struct n_tty_data *ldata)
Alan Cox47afa7a2008-10-13 10:44:17 +01002418{
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002419 size_t nr, head, tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002420
Peter Hurleya73d3d62013-06-15 09:14:25 -04002421 if (ldata->canon_head == ldata->read_tail)
Alan Cox47afa7a2008-10-13 10:44:17 +01002422 return 0;
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002423 head = ldata->canon_head;
2424 tail = ldata->read_tail;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002425 nr = head - tail;
Alan Cox47afa7a2008-10-13 10:44:17 +01002426 /* Skip EOF-chars.. */
2427 while (head != tail) {
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002428 if (test_bit(tail & (N_TTY_BUF_SIZE - 1), ldata->read_flags) &&
2429 read_buf(ldata, tail) == __DISABLED_CHAR)
Alan Cox47afa7a2008-10-13 10:44:17 +01002430 nr--;
Peter Hurleybc5a5e32013-06-15 09:14:21 -04002431 tail++;
Alan Cox47afa7a2008-10-13 10:44:17 +01002432 }
2433 return nr;
2434}
2435
2436static int n_tty_ioctl(struct tty_struct *tty, struct file *file,
2437 unsigned int cmd, unsigned long arg)
2438{
Jiri Slabyba2e68a2012-10-18 22:26:41 +02002439 struct n_tty_data *ldata = tty->disc_data;
Alan Cox47afa7a2008-10-13 10:44:17 +01002440 int retval;
2441
2442 switch (cmd) {
2443 case TIOCOUTQ:
2444 return put_user(tty_chars_in_buffer(tty), (int __user *) arg);
2445 case TIOCINQ:
Peter Hurley6d76bd22013-06-15 09:14:26 -04002446 down_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002447 if (L_ICANON(tty))
Jiri Slaby57c94122012-10-18 22:26:43 +02002448 retval = inq_canon(ldata);
Peter Hurley6d76bd22013-06-15 09:14:26 -04002449 else
2450 retval = read_cnt(ldata);
2451 up_write(&tty->termios_rwsem);
Alan Cox47afa7a2008-10-13 10:44:17 +01002452 return put_user(retval, (unsigned int __user *) arg);
2453 default:
2454 return n_tty_ioctl_helper(tty, file, cmd, arg);
2455 }
2456}
2457
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002458static void n_tty_fasync(struct tty_struct *tty, int on)
2459{
2460 struct n_tty_data *ldata = tty->disc_data;
2461
2462 if (!waitqueue_active(&tty->read_wait)) {
2463 if (on)
2464 ldata->minimum_to_wake = 1;
2465 else if (!tty->fasync)
2466 ldata->minimum_to_wake = N_TTY_BUF_SIZE;
2467 }
2468}
2469
Alan Coxa352def2008-07-16 21:53:12 +01002470struct tty_ldisc_ops tty_ldisc_N_TTY = {
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002471 .magic = TTY_LDISC_MAGIC,
2472 .name = "n_tty",
2473 .open = n_tty_open,
2474 .close = n_tty_close,
2475 .flush_buffer = n_tty_flush_buffer,
2476 .chars_in_buffer = n_tty_chars_in_buffer,
Alan Cox11a96d12008-10-13 10:46:24 +01002477 .read = n_tty_read,
2478 .write = n_tty_write,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002479 .ioctl = n_tty_ioctl,
2480 .set_termios = n_tty_set_termios,
Alan Cox11a96d12008-10-13 10:46:24 +01002481 .poll = n_tty_poll,
Paul Fulghume10cc1d2007-05-10 22:22:50 -07002482 .receive_buf = n_tty_receive_buf,
Peter Hurleyf6c8dbe2013-06-15 07:28:28 -04002483 .write_wakeup = n_tty_write_wakeup,
2484 .fasync = n_tty_fasync,
Peter Hurley24a89d12013-06-15 09:14:15 -04002485 .receive_buf2 = n_tty_receive_buf2,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486};
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002487
2488/**
2489 * n_tty_inherit_ops - inherit N_TTY methods
2490 * @ops: struct tty_ldisc_ops where to save N_TTY methods
2491 *
George Spelvin593fb1ae42013-02-12 02:00:43 -05002492 * Enables a 'subclass' line discipline to 'inherit' N_TTY
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -08002493 * methods.
2494 */
2495
2496void n_tty_inherit_ops(struct tty_ldisc_ops *ops)
2497{
2498 *ops = tty_ldisc_N_TTY;
2499 ops->owner = NULL;
2500 ops->refcount = ops->flags = 0;
2501}
2502EXPORT_SYMBOL_GPL(n_tty_inherit_ops);