blob: 08787ece3fdc152358493f9fa3085adc377224e4 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_TTY_H
2#define _LINUX_TTY_H
3
Florian Fainelliae92c1f2011-05-24 10:43:03 +02004#include <linux/fs.h>
5#include <linux/major.h>
6#include <linux/termios.h>
7#include <linux/workqueue.h>
8#include <linux/tty_driver.h>
9#include <linux/tty_ldisc.h>
10#include <linux/mutex.h>
Alan Coxba3fe7a2012-09-04 16:35:08 +010011#include <linux/tty_flags.h>
David Howells607ca462012-10-13 10:46:48 +010012#include <uapi/linux/tty.h>
Florian Fainelliae92c1f2011-05-24 10:43:03 +020013
Florian Fainelliae92c1f2011-05-24 10:43:03 +020014
15
16/*
17 * (Note: the *_driver.minor_start values 1, 64, 128, 192 are
18 * hardcoded at present.)
19 */
20#define NR_UNIX98_PTY_DEFAULT 4096 /* Default maximum for Unix98 ptys */
Konstantin Khlebnikove9aba512012-01-05 13:06:11 +040021#define NR_UNIX98_PTY_RESERVE 1024 /* Default reserve for main devpts */
Florian Fainelliae92c1f2011-05-24 10:43:03 +020022#define NR_UNIX98_PTY_MAX (1 << MINORBITS) /* Absolute limit */
23
Linus Torvalds1da177e2005-04-16 15:20:36 -070024/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 * This character is the same as _POSIX_VDISABLE: it cannot be used as
26 * a c_cc[] character, but indicates that a particular special character
27 * isn't in use (eg VINTR has no character etc)
28 */
29#define __DISABLED_CHAR '\0'
30
Alan Cox33f0f882006-01-09 20:54:13 -080031struct tty_buffer {
32 struct tty_buffer *next;
33 char *char_buf_ptr;
34 unsigned char *flag_buf_ptr;
35 int used;
36 int size;
Paul Fulghum8977d922006-02-10 01:51:14 -080037 int commit;
38 int read;
Alan Cox33f0f882006-01-09 20:54:13 -080039 /* Data points here */
40 unsigned long data[0];
41};
42
Alan Coxd9661ad2010-02-18 16:43:47 +000043/*
44 * We default to dicing tty buffer allocations to this many characters
Mel Gorman352fa6a2010-03-02 22:24:19 +000045 * in order to avoid multiple page allocations. We know the size of
46 * tty_buffer itself but it must also be taken into account that the
47 * the buffer is 256 byte aligned. See tty_buffer_find for the allocation
48 * logic this must match
Alan Coxd9661ad2010-02-18 16:43:47 +000049 */
50
Mel Gorman352fa6a2010-03-02 22:24:19 +000051#define TTY_BUFFER_PAGE (((PAGE_SIZE - sizeof(struct tty_buffer)) / 2) & ~0xFF)
Alan Coxd9661ad2010-02-18 16:43:47 +000052
53
Alan Cox33f0f882006-01-09 20:54:13 -080054struct tty_bufhead {
Linus Torvaldsf23eb2b2011-03-22 16:17:32 -070055 struct work_struct work;
Paul Fulghum808249c2006-02-03 03:04:41 -080056 spinlock_t lock;
Alan Cox33f0f882006-01-09 20:54:13 -080057 struct tty_buffer *head; /* Queue head */
58 struct tty_buffer *tail; /* Active buffer */
59 struct tty_buffer *free; /* Free queue head */
Alan Cox7a4d29f2008-07-16 21:54:54 +010060 int memory_used; /* Buffer space used excluding
61 free queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -070062};
63/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 * When a break, frame error, or parity error happens, these codes are
65 * stuffed into the flags buffer.
66 */
67#define TTY_NORMAL 0
68#define TTY_BREAK 1
69#define TTY_FRAME 2
70#define TTY_PARITY 3
71#define TTY_OVERRUN 4
72
Alan Coxadc8d742012-07-14 15:31:47 +010073#define INTR_CHAR(tty) ((tty)->termios.c_cc[VINTR])
74#define QUIT_CHAR(tty) ((tty)->termios.c_cc[VQUIT])
75#define ERASE_CHAR(tty) ((tty)->termios.c_cc[VERASE])
76#define KILL_CHAR(tty) ((tty)->termios.c_cc[VKILL])
77#define EOF_CHAR(tty) ((tty)->termios.c_cc[VEOF])
78#define TIME_CHAR(tty) ((tty)->termios.c_cc[VTIME])
79#define MIN_CHAR(tty) ((tty)->termios.c_cc[VMIN])
80#define SWTC_CHAR(tty) ((tty)->termios.c_cc[VSWTC])
81#define START_CHAR(tty) ((tty)->termios.c_cc[VSTART])
82#define STOP_CHAR(tty) ((tty)->termios.c_cc[VSTOP])
83#define SUSP_CHAR(tty) ((tty)->termios.c_cc[VSUSP])
84#define EOL_CHAR(tty) ((tty)->termios.c_cc[VEOL])
85#define REPRINT_CHAR(tty) ((tty)->termios.c_cc[VREPRINT])
86#define DISCARD_CHAR(tty) ((tty)->termios.c_cc[VDISCARD])
87#define WERASE_CHAR(tty) ((tty)->termios.c_cc[VWERASE])
88#define LNEXT_CHAR(tty) ((tty)->termios.c_cc[VLNEXT])
89#define EOL2_CHAR(tty) ((tty)->termios.c_cc[VEOL2])
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Alan Coxadc8d742012-07-14 15:31:47 +010091#define _I_FLAG(tty, f) ((tty)->termios.c_iflag & (f))
92#define _O_FLAG(tty, f) ((tty)->termios.c_oflag & (f))
93#define _C_FLAG(tty, f) ((tty)->termios.c_cflag & (f))
94#define _L_FLAG(tty, f) ((tty)->termios.c_lflag & (f))
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
Alan Cox7a4d29f2008-07-16 21:54:54 +010096#define I_IGNBRK(tty) _I_FLAG((tty), IGNBRK)
97#define I_BRKINT(tty) _I_FLAG((tty), BRKINT)
98#define I_IGNPAR(tty) _I_FLAG((tty), IGNPAR)
99#define I_PARMRK(tty) _I_FLAG((tty), PARMRK)
100#define I_INPCK(tty) _I_FLAG((tty), INPCK)
101#define I_ISTRIP(tty) _I_FLAG((tty), ISTRIP)
102#define I_INLCR(tty) _I_FLAG((tty), INLCR)
103#define I_IGNCR(tty) _I_FLAG((tty), IGNCR)
104#define I_ICRNL(tty) _I_FLAG((tty), ICRNL)
105#define I_IUCLC(tty) _I_FLAG((tty), IUCLC)
106#define I_IXON(tty) _I_FLAG((tty), IXON)
107#define I_IXANY(tty) _I_FLAG((tty), IXANY)
108#define I_IXOFF(tty) _I_FLAG((tty), IXOFF)
109#define I_IMAXBEL(tty) _I_FLAG((tty), IMAXBEL)
110#define I_IUTF8(tty) _I_FLAG((tty), IUTF8)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Alan Cox7a4d29f2008-07-16 21:54:54 +0100112#define O_OPOST(tty) _O_FLAG((tty), OPOST)
113#define O_OLCUC(tty) _O_FLAG((tty), OLCUC)
114#define O_ONLCR(tty) _O_FLAG((tty), ONLCR)
115#define O_OCRNL(tty) _O_FLAG((tty), OCRNL)
116#define O_ONOCR(tty) _O_FLAG((tty), ONOCR)
117#define O_ONLRET(tty) _O_FLAG((tty), ONLRET)
118#define O_OFILL(tty) _O_FLAG((tty), OFILL)
119#define O_OFDEL(tty) _O_FLAG((tty), OFDEL)
120#define O_NLDLY(tty) _O_FLAG((tty), NLDLY)
121#define O_CRDLY(tty) _O_FLAG((tty), CRDLY)
122#define O_TABDLY(tty) _O_FLAG((tty), TABDLY)
123#define O_BSDLY(tty) _O_FLAG((tty), BSDLY)
124#define O_VTDLY(tty) _O_FLAG((tty), VTDLY)
125#define O_FFDLY(tty) _O_FLAG((tty), FFDLY)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Alan Cox7a4d29f2008-07-16 21:54:54 +0100127#define C_BAUD(tty) _C_FLAG((tty), CBAUD)
128#define C_CSIZE(tty) _C_FLAG((tty), CSIZE)
129#define C_CSTOPB(tty) _C_FLAG((tty), CSTOPB)
130#define C_CREAD(tty) _C_FLAG((tty), CREAD)
131#define C_PARENB(tty) _C_FLAG((tty), PARENB)
132#define C_PARODD(tty) _C_FLAG((tty), PARODD)
133#define C_HUPCL(tty) _C_FLAG((tty), HUPCL)
134#define C_CLOCAL(tty) _C_FLAG((tty), CLOCAL)
135#define C_CIBAUD(tty) _C_FLAG((tty), CIBAUD)
136#define C_CRTSCTS(tty) _C_FLAG((tty), CRTSCTS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
Alan Cox7a4d29f2008-07-16 21:54:54 +0100138#define L_ISIG(tty) _L_FLAG((tty), ISIG)
139#define L_ICANON(tty) _L_FLAG((tty), ICANON)
140#define L_XCASE(tty) _L_FLAG((tty), XCASE)
141#define L_ECHO(tty) _L_FLAG((tty), ECHO)
142#define L_ECHOE(tty) _L_FLAG((tty), ECHOE)
143#define L_ECHOK(tty) _L_FLAG((tty), ECHOK)
144#define L_ECHONL(tty) _L_FLAG((tty), ECHONL)
145#define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH)
146#define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP)
147#define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL)
148#define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT)
149#define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE)
150#define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO)
151#define L_PENDIN(tty) _L_FLAG((tty), PENDIN)
152#define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN)
hyc@symas.com26df6d12010-06-22 10:14:49 -0700153#define L_EXTPROC(tty) _L_FLAG((tty), EXTPROC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
155struct device;
Miloslav Trmac522ed772007-07-15 23:40:56 -0700156struct signal_struct;
Alan Cox6f670482008-07-16 21:53:41 +0100157
158/*
159 * Port level information. Each device keeps its own port level information
160 * so provide a common structure for those ports wanting to use common support
161 * routines.
162 *
163 * The tty port has a different lifetime to the tty so must be kept apart.
164 * In addition be careful as tty -> port mappings are valid for the life
165 * of the tty object but in many cases port -> tty mappings are valid only
166 * until a hangup so don't use the wrong path.
167 */
Alan Cox7a4d29f2008-07-16 21:54:54 +0100168
Alan Cox31f35932009-01-02 13:45:05 +0000169struct tty_port;
170
171struct tty_port_operations {
172 /* Return 1 if the carrier is raised */
173 int (*carrier_raised)(struct tty_port *port);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700174 /* Control the DTR line */
Alan Coxfcc8ac12009-06-11 12:24:17 +0100175 void (*dtr_rts)(struct tty_port *port, int raise);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700176 /* Called when the last close completes or a hangup finishes
Alan Cox64bc3972009-10-06 16:06:11 +0100177 IFF the port was initialized. Do not use to free resources. Called
178 under the port mutex to serialize against activate/shutdowns */
Alan Cox7ca0ff92009-09-19 13:13:20 -0700179 void (*shutdown)(struct tty_port *port);
180 void (*drop)(struct tty_port *port);
Alan Cox64bc3972009-10-06 16:06:11 +0100181 /* Called under the port mutex from tty_port_open, serialized using
182 the port mutex */
183 /* FIXME: long term getting the tty argument *out* of this would be
184 good for consoles */
185 int (*activate)(struct tty_port *port, struct tty_struct *tty);
Alan Cox568aafc2009-11-30 13:17:14 +0000186 /* Called on the final put of a port */
187 void (*destruct)(struct tty_port *port);
Alan Cox31f35932009-01-02 13:45:05 +0000188};
189
Alan Cox6f670482008-07-16 21:53:41 +0100190struct tty_port {
191 struct tty_struct *tty; /* Back pointer */
Alan Cox31f35932009-01-02 13:45:05 +0000192 const struct tty_port_operations *ops; /* Port operations */
Alan Cox4a90f092008-10-13 10:39:46 +0100193 spinlock_t lock; /* Lock protecting tty field */
Alan Cox6f670482008-07-16 21:53:41 +0100194 int blocked_open; /* Waiting to open */
195 int count; /* Usage count */
196 wait_queue_head_t open_wait; /* Open waiters */
197 wait_queue_head_t close_wait; /* Close waiters */
Alan Coxbdc04e32009-09-19 13:13:31 -0700198 wait_queue_head_t delta_msr_wait; /* Modem status change */
Alan Cox6f670482008-07-16 21:53:41 +0100199 unsigned long flags; /* TTY flags ASY_*/
Jason Wessel336cee42010-03-08 21:50:11 -0600200 unsigned char console:1; /* port is a console */
Alan Cox6f670482008-07-16 21:53:41 +0100201 struct mutex mutex; /* Locking */
Alan Cox44e49092009-11-30 13:16:41 +0000202 struct mutex buf_mutex; /* Buffer alloc lock */
Alan Cox6f670482008-07-16 21:53:41 +0100203 unsigned char *xmit_buf; /* Optional buffer */
Alan Cox5e99df52009-09-19 13:13:28 -0700204 unsigned int close_delay; /* Close port delay */
205 unsigned int closing_wait; /* Delay for output */
Alan Cox1ec739b2009-06-11 12:25:25 +0100206 int drain_delay; /* Set to zero if no pure time
207 based drain is needed else
208 set to size of fifo */
Alan Cox568aafc2009-11-30 13:17:14 +0000209 struct kref kref; /* Ref counter */
Alan Cox6f670482008-07-16 21:53:41 +0100210};
211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212/*
213 * Where all of the state associated with a tty is kept while the tty
214 * is open. Since the termios state should be kept even if the tty
215 * has been closed --- for things like the baud rate, etc --- it is
216 * not stored here, but rather a pointer to the real state is stored
217 * here. Possible the winsize structure should have the same
218 * treatment, but (1) the default 80x24 is usually right and (2) it's
219 * most often used by a windowing system, which will set the correct
220 * size each time the window is created or resized anyway.
221 * - TYT, 9/14/92
222 */
Alan Coxf34d7a52008-04-30 00:54:13 -0700223
224struct tty_operations;
225
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226struct tty_struct {
227 int magic;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100228 struct kref kref;
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +0400229 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 struct tty_driver *driver;
Alan Coxf34d7a52008-04-30 00:54:13 -0700231 const struct tty_operations *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 int index;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100233
234 /* Protects ldisc changes: Lock tty not pty */
235 struct mutex ldisc_mutex;
236 struct tty_ldisc *ldisc;
237
Jiri Slabybddc7152012-10-18 22:26:42 +0200238 struct mutex atomic_write_lock;
Alan Cox89c8d912012-08-08 16:30:13 +0100239 struct mutex legacy_mutex;
Arjan van de Ven5785c952006-09-29 02:00:43 -0700240 struct mutex termios_mutex;
Alan Cox04f378b2008-04-30 00:53:29 -0700241 spinlock_t ctrl_lock;
Alan Cox47f86832008-04-30 00:53:30 -0700242 /* Termios values are protected by the termios mutex */
Alan Coxadc8d742012-07-14 15:31:47 +0100243 struct ktermios termios, termios_locked;
Alan Cox1d65b4a2008-10-13 10:38:18 +0100244 struct termiox *termiox; /* May be NULL for unsupported */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 char name[64];
Alan Cox47f86832008-04-30 00:53:30 -0700246 struct pid *pgrp; /* Protected by ctrl lock */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800247 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 unsigned long flags;
249 int count;
Alan Cox47f86832008-04-30 00:53:30 -0700250 struct winsize winsize; /* termios mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
252 unsigned char low_latency:1, warned:1;
Alan Cox47f86832008-04-30 00:53:30 -0700253 unsigned char ctrl_status; /* ctrl_lock */
Alan Cox33f0f882006-01-09 20:54:13 -0800254 unsigned int receive_room; /* Bytes free for queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256 struct tty_struct *link;
257 struct fasync_struct *fasync;
Alan Cox47f86832008-04-30 00:53:30 -0700258 struct tty_bufhead buf; /* Locked internally */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 int alt_speed; /* For magic substitution of 38400 bps */
260 wait_queue_head_t write_wait;
261 wait_queue_head_t read_wait;
262 struct work_struct hangup_work;
263 void *disc_data;
264 void *driver_data;
265 struct list_head tty_files;
266
267#define N_TTY_BUF_SIZE 4096
Alan Cox6f670482008-07-16 21:53:41 +0100268
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 unsigned char closing:1;
270 unsigned short minimum_to_wake;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 unsigned char *write_buf;
272 int write_cnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 /* If the tty has a pending do_SAK, queue it here - akpm */
274 struct work_struct SAK_work;
Alan Cox6f670482008-07-16 21:53:41 +0100275 struct tty_port *port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276};
277
Nick Piggind996b622010-08-18 04:37:36 +1000278/* Each of a tty's open files has private_data pointing to tty_file_private */
279struct tty_file_private {
280 struct tty_struct *tty;
281 struct file *file;
282 struct list_head list;
283};
284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285/* tty magic number */
286#define TTY_MAGIC 0x5401
287
288/*
289 * These bits are used in the flags field of the tty structure.
Alan Cox7a4d29f2008-07-16 21:54:54 +0100290 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 * So that interrupts won't be able to mess up the queues,
292 * copy_to_cooked must be atomic with respect to itself, as must
293 * tty->write. Thus, you must use the inline functions set_bit() and
294 * clear_bit() to make things atomic.
295 */
296#define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
Alan Cox7a4d29f2008-07-16 21:54:54 +0100297#define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298#define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
299#define TTY_EXCLUSIVE 3 /* Exclusive open mode */
300#define TTY_DEBUG 4 /* Debugging */
301#define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
302#define TTY_PUSH 6 /* n_tty private */
303#define TTY_CLOSING 7 /* ->close() in progress */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304#define TTY_LDISC 9 /* Line discipline attached */
Alan Coxc9b39762009-01-02 13:44:56 +0000305#define TTY_LDISC_CHANGING 10 /* Line discipline changing */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100306#define TTY_LDISC_OPEN 11 /* Line discipline is open */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307#define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */
308#define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */
309#define TTY_PTY_LOCK 16 /* pty private */
310#define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
311#define TTY_HUPPED 18 /* Post driver->hangup() */
Alan Cox42fd5522007-08-10 13:01:05 -0700312#define TTY_FLUSHING 19 /* Flushing to ldisc in progress */
313#define TTY_FLUSHPENDING 20 /* Queued buffer flush pending */
Jiri Slabyacfa7472010-11-29 10:16:54 +0100314#define TTY_HUPPING 21 /* ->hangup() in progress */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
316#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
317
318extern void tty_write_flush(struct tty_struct *);
319
Alan Coxedc6afc2006-12-08 02:38:44 -0800320extern struct ktermios tty_std_termios;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322extern void console_init(void);
323extern int vcs_init(void);
324
Alan Coxd81ed102008-10-13 10:41:42 +0100325extern struct class *tty_class;
326
Alan Cox9c9f4de2008-10-13 10:37:26 +0100327/**
328 * tty_kref_get - get a tty reference
329 * @tty: tty device
330 *
331 * Return a new reference to a tty object. The caller must hold
332 * sufficient locks/counts to ensure that their existing reference cannot
333 * go away
334 */
335
Ingo Molnar14bfc982008-11-25 08:58:11 +0100336static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
Alan Cox9c9f4de2008-10-13 10:37:26 +0100337{
338 if (tty)
339 kref_get(&tty->kref);
340 return tty;
341}
342extern void tty_kref_put(struct tty_struct *tty);
343
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
345 const char *routine);
346extern char *tty_name(struct tty_struct *tty, char *buf);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100347extern void tty_wait_until_sent(struct tty_struct *tty, long timeout);
348extern int tty_check_change(struct tty_struct *tty);
349extern void stop_tty(struct tty_struct *tty);
350extern void start_tty(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351extern int tty_register_driver(struct tty_driver *driver);
352extern int tty_unregister_driver(struct tty_driver *driver);
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -0700353extern struct device *tty_register_device(struct tty_driver *driver,
354 unsigned index, struct device *dev);
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +0200355extern struct device *tty_register_device_attr(struct tty_driver *driver,
356 unsigned index, struct device *device,
357 void *drvdata,
358 const struct attribute_group **attr_grp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
360extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
361 int buflen);
362extern void tty_write_message(struct tty_struct *tty, char *msg);
Alan Coxf34d7a52008-04-30 00:54:13 -0700363extern int tty_put_char(struct tty_struct *tty, unsigned char c);
364extern int tty_chars_in_buffer(struct tty_struct *tty);
365extern int tty_write_room(struct tty_struct *tty);
366extern void tty_driver_flush_buffer(struct tty_struct *tty);
Alan Cox39c2e602008-04-30 00:54:18 -0700367extern void tty_throttle(struct tty_struct *tty);
368extern void tty_unthrottle(struct tty_struct *tty);
Alan Coxfc6f6232009-01-02 13:43:17 +0000369extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
Jiri Slaby24d406a2011-08-10 14:59:28 +0200370extern void tty_driver_remove_tty(struct tty_driver *driver,
371 struct tty_struct *tty);
Alan Coxfeebed62008-10-13 10:41:30 +0100372extern void tty_free_termios(struct tty_struct *tty);
Eric W. Biederman3e7cd6c2007-02-12 00:52:58 -0800373extern int is_current_pgrp_orphaned(void);
Alan Cox5d0fdf12008-04-30 00:53:31 -0700374extern struct pid *tty_get_pgrp(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375extern int is_ignored(int sig);
376extern int tty_signal(int sig, struct tty_struct *tty);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100377extern void tty_hangup(struct tty_struct *tty);
378extern void tty_vhangup(struct tty_struct *tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200379extern void tty_vhangup_locked(struct tty_struct *tty);
Alan Cox2cb59982008-10-13 10:40:30 +0100380extern void tty_vhangup_self(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381extern void tty_unhangup(struct file *filp);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100382extern int tty_hung_up_p(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383extern void do_SAK(struct tty_struct *tty);
Eric W. Biederman8b6312f2007-02-10 01:44:34 -0800384extern void __do_SAK(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385extern void disassociate_ctty(int priv);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700386extern void no_tty(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387extern void tty_flip_buffer_push(struct tty_struct *tty);
OGAWA Hirofumie043e422009-07-29 12:15:56 -0700388extern void tty_flush_to_ldisc(struct tty_struct *tty);
Alan Coxe0495732008-10-13 10:36:58 +0100389extern void tty_buffer_free_all(struct tty_struct *tty);
390extern void tty_buffer_flush(struct tty_struct *tty);
391extern void tty_buffer_init(struct tty_struct *tty);
Alan Coxedc6afc2006-12-08 02:38:44 -0800392extern speed_t tty_get_baud_rate(struct tty_struct *tty);
393extern speed_t tty_termios_baud_rate(struct ktermios *termios);
394extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100395extern void tty_termios_encode_baud_rate(struct ktermios *termios,
396 speed_t ibaud, speed_t obaud);
397extern void tty_encode_baud_rate(struct tty_struct *tty,
398 speed_t ibaud, speed_t obaud);
Alan Cox5f519d72007-10-16 23:30:07 -0700399extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
Alan Coxbf5e5832008-01-08 14:55:51 +0000400extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
Alan Cox8d075b12011-02-14 16:27:53 +0000401extern int tty_set_termios(struct tty_struct *tty, struct ktermios *kt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402
403extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
404extern void tty_ldisc_deref(struct tty_ldisc *);
405extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100406extern void tty_ldisc_hangup(struct tty_struct *tty);
Alan Coxa352def2008-07-16 21:53:12 +0100407extern const struct file_operations tty_ldiscs_proc_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
409extern void tty_wakeup(struct tty_struct *tty);
410extern void tty_ldisc_flush(struct tty_struct *tty);
411
Alan Cox04f378b2008-04-30 00:53:29 -0700412extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Alan Cox0fc00e22007-11-07 01:24:56 -0800413extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
414 unsigned int cmd, unsigned long arg);
415extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800416extern dev_t tty_devnum(struct tty_struct *tty);
417extern void proc_clear_tty(struct task_struct *p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800418extern struct tty_struct *get_current_tty(void);
Alan Coxd81ed102008-10-13 10:41:42 +0100419extern void tty_default_fops(struct file_operations *fops);
Alan Coxbf970ee2008-10-13 10:42:39 +0100420extern struct tty_struct *alloc_tty_struct(void);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200421extern int tty_alloc_file(struct file *file);
422extern void tty_add_file(struct tty_struct *tty, struct file *file);
423extern void tty_free_file(struct file *file);
Alan Coxbf970ee2008-10-13 10:42:39 +0100424extern void free_tty_struct(struct tty_struct *tty);
425extern void initialize_tty_struct(struct tty_struct *tty,
426 struct tty_driver *driver, int idx);
Jiri Slaby67166712011-03-23 10:48:35 +0100427extern void deinitialize_tty_struct(struct tty_struct *tty);
Konstantin Khlebnikov593a27c2012-01-05 13:04:21 +0400428extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx);
Alan Coxeeb89d92009-11-30 13:18:29 +0000429extern int tty_release(struct inode *inode, struct file *filp);
Alan Coxbf970ee2008-10-13 10:42:39 +0100430extern int tty_init_termios(struct tty_struct *tty);
Jiri Slaby66d450e2012-01-30 21:14:28 +0100431extern int tty_standard_install(struct tty_driver *driver,
432 struct tty_struct *tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800433
Alan Coxe8b70e72009-06-11 12:48:02 +0100434extern struct tty_struct *tty_pair_get_tty(struct tty_struct *tty);
435extern struct tty_struct *tty_pair_get_pty(struct tty_struct *tty);
436
Ingo Molnar70522e12006-03-23 03:00:31 -0800437extern struct mutex tty_mutex;
Nick Pigginee2ffa02010-08-18 04:37:35 +1000438extern spinlock_t tty_files_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
Alan Cox9c1729d2007-07-15 23:39:43 -0700440extern void tty_write_unlock(struct tty_struct *tty);
441extern int tty_write_lock(struct tty_struct *tty, int ndelay);
442#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
443
Alan Cox6f670482008-07-16 21:53:41 +0100444extern void tty_port_init(struct tty_port *port);
Jiri Slaby2cb4ca02012-08-07 21:47:50 +0200445extern void tty_port_link_device(struct tty_port *port,
446 struct tty_driver *driver, unsigned index);
Jiri Slaby057eb852012-06-04 13:35:37 +0200447extern struct device *tty_port_register_device(struct tty_port *port,
448 struct tty_driver *driver, unsigned index,
449 struct device *device);
Tomas Hlavacekb1b79912012-09-06 23:17:47 +0200450extern struct device *tty_port_register_device_attr(struct tty_port *port,
451 struct tty_driver *driver, unsigned index,
452 struct device *device, void *drvdata,
453 const struct attribute_group **attr_grp);
Alan Cox6f670482008-07-16 21:53:41 +0100454extern int tty_port_alloc_xmit_buf(struct tty_port *port);
455extern void tty_port_free_xmit_buf(struct tty_port *port);
Alan Cox568aafc2009-11-30 13:17:14 +0000456extern void tty_port_put(struct tty_port *port);
457
Randy Dunlap2427b8e2010-01-15 17:01:11 -0800458static inline struct tty_port *tty_port_get(struct tty_port *port)
Alan Cox568aafc2009-11-30 13:17:14 +0000459{
460 if (port)
461 kref_get(&port->kref);
462 return port;
463}
464
Huang Shijief21ec3d2012-08-22 22:13:36 -0400465/* If the cts flow control is enabled, return true. */
466static inline bool tty_port_cts_enabled(struct tty_port *port)
467{
468 return port->flags & ASYNC_CTS_FLOW;
469}
470
Alan Cox4a90f092008-10-13 10:39:46 +0100471extern struct tty_struct *tty_port_tty_get(struct tty_port *port);
472extern void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty);
Alan Cox31f35932009-01-02 13:45:05 +0000473extern int tty_port_carrier_raised(struct tty_port *port);
Alan Cox5d951fb2009-01-02 13:45:19 +0000474extern void tty_port_raise_dtr_rts(struct tty_port *port);
Alan Coxfcc8ac12009-06-11 12:24:17 +0100475extern void tty_port_lower_dtr_rts(struct tty_port *port);
Alan Cox3e616962009-01-02 13:45:26 +0000476extern void tty_port_hangup(struct tty_port *port);
Alan Cox36c621d2009-01-02 13:46:10 +0000477extern int tty_port_block_til_ready(struct tty_port *port,
478 struct tty_struct *tty, struct file *filp);
Alan Coxa6614992009-01-02 13:46:50 +0000479extern int tty_port_close_start(struct tty_port *port,
480 struct tty_struct *tty, struct file *filp);
481extern void tty_port_close_end(struct tty_port *port, struct tty_struct *tty);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700482extern void tty_port_close(struct tty_port *port,
483 struct tty_struct *tty, struct file *filp);
Jiri Slaby695586c2012-06-04 13:35:32 +0200484extern int tty_port_install(struct tty_port *port, struct tty_driver *driver,
485 struct tty_struct *tty);
Alan Cox64bc3972009-10-06 16:06:11 +0100486extern int tty_port_open(struct tty_port *port,
487 struct tty_struct *tty, struct file *filp);
Randy Dunlap2427b8e2010-01-15 17:01:11 -0800488static inline int tty_port_users(struct tty_port *port)
Alan Coxb58d13a2009-09-19 13:13:32 -0700489{
490 return port->count + port->blocked_open;
491}
492
Alan Cox01e1abb2008-07-22 11:16:55 +0100493extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
494extern int tty_unregister_ldisc(int disc);
495extern int tty_set_ldisc(struct tty_struct *tty, int ldisc);
496extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty);
497extern void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty);
498extern void tty_ldisc_init(struct tty_struct *tty);
Jiri Slaby67166712011-03-23 10:48:35 +0100499extern void tty_ldisc_deinit(struct tty_struct *tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100500extern void tty_ldisc_begin(void);
501/* This last one is just for the tty layer internals and shouldn't be used elsewhere */
502extern void tty_ldisc_enable(struct tty_struct *tty);
Alan Cox9c1729d2007-07-15 23:39:43 -0700503
504
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505/* n_tty.c */
Alan Coxa352def2008-07-16 21:53:12 +0100506extern struct tty_ldisc_ops tty_ldisc_N_TTY;
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -0800507extern void n_tty_inherit_ops(struct tty_ldisc_ops *ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
Miloslav Trmac522ed772007-07-15 23:40:56 -0700509/* tty_audit.c */
510#ifdef CONFIG_AUDIT
511extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data,
Jiri Slaby6c633f22012-10-18 22:26:37 +0200512 size_t size, unsigned icanon);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700513extern void tty_audit_exit(void);
514extern void tty_audit_fork(struct signal_struct *sig);
Al Viro1e641742008-12-09 09:23:33 +0000515extern void tty_audit_tiocsti(struct tty_struct *tty, char ch);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700516extern void tty_audit_push(struct tty_struct *tty);
Thomas Gleixner3c80fe42009-12-09 14:19:31 +0000517extern int tty_audit_push_task(struct task_struct *tsk,
Eric W. Biedermane1760bd2012-09-10 22:39:43 -0700518 kuid_t loginuid, u32 sessionid);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700519#else
520static inline void tty_audit_add_data(struct tty_struct *tty,
Jiri Slaby6c633f22012-10-18 22:26:37 +0200521 unsigned char *data, size_t size, unsigned icanon)
Miloslav Trmac522ed772007-07-15 23:40:56 -0700522{
523}
Al Viro1e641742008-12-09 09:23:33 +0000524static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch)
525{
526}
Miloslav Trmac522ed772007-07-15 23:40:56 -0700527static inline void tty_audit_exit(void)
528{
529}
530static inline void tty_audit_fork(struct signal_struct *sig)
531{
532}
533static inline void tty_audit_push(struct tty_struct *tty)
534{
535}
Thomas Gleixner3c80fe42009-12-09 14:19:31 +0000536static inline int tty_audit_push_task(struct task_struct *tsk,
Eric W. Biedermane1760bd2012-09-10 22:39:43 -0700537 kuid_t loginuid, u32 sessionid)
Miloslav Trmac522ed772007-07-15 23:40:56 -0700538{
Thomas Gleixner3c80fe42009-12-09 14:19:31 +0000539 return 0;
Miloslav Trmac522ed772007-07-15 23:40:56 -0700540}
Miloslav Trmac522ed772007-07-15 23:40:56 -0700541#endif
542
David Howells31d1d482010-08-06 16:34:43 +0100543/* tty_io.c */
544extern int __init tty_init(void);
545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546/* tty_ioctl.c */
Alan Cox47afa7a2008-10-13 10:44:17 +0100547extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 unsigned int cmd, unsigned long arg);
Thomas Meyer8193c422011-10-05 23:13:13 +0200549extern long n_tty_compat_ioctl_helper(struct tty_struct *tty, struct file *file,
550 unsigned int cmd, unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
552/* serial.c */
553
554extern void serial_console_init(void);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100555
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556/* pcxx.c */
557
558extern int pcxe_open(struct tty_struct *tty, struct file *filp);
559
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560/* vt.c */
561
Alan Cox6caa76b2011-02-14 16:27:22 +0000562extern int vt_ioctl(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 unsigned int cmd, unsigned long arg);
564
Greg Kroah-Hartman94c22732011-02-17 12:02:51 -0800565extern long vt_compat_ioctl(struct tty_struct *tty,
Arnd Bergmanne9216652009-08-06 15:09:28 +0200566 unsigned int cmd, unsigned long arg);
567
Arnd Bergmannb07471f2010-08-06 21:40:30 +0200568/* tty_mutex.c */
Arnd Bergmannec79d602010-06-01 22:53:01 +0200569/* functions for preparation of BKL removal */
Alan Cox89c8d912012-08-08 16:30:13 +0100570extern void __lockfunc tty_lock(struct tty_struct *tty);
571extern void __lockfunc tty_unlock(struct tty_struct *tty);
572extern void __lockfunc tty_lock_pair(struct tty_struct *tty,
573 struct tty_struct *tty2);
574extern void __lockfunc tty_unlock_pair(struct tty_struct *tty,
575 struct tty_struct *tty2);
Arnd Bergmannec79d602010-06-01 22:53:01 +0200576
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200577/*
Jiri Slabya57a7bf2011-08-25 15:12:06 +0200578 * this shall be called only from where BTM is held (like close)
579 *
580 * We need this to ensure nobody waits for us to finish while we are waiting.
581 * Without this we were encountering system stalls.
582 *
583 * This should be indeed removed with BTM removal later.
584 *
585 * Locking: BTM required. Nobody is allowed to hold port->mutex.
586 */
587static inline void tty_wait_until_sent_from_close(struct tty_struct *tty,
588 long timeout)
589{
Alan Cox89c8d912012-08-08 16:30:13 +0100590 tty_unlock(tty); /* tty->ops->close holds the BTM, drop it while waiting */
Jiri Slabya57a7bf2011-08-25 15:12:06 +0200591 tty_wait_until_sent(tty, timeout);
Alan Cox89c8d912012-08-08 16:30:13 +0100592 tty_lock(tty);
Jiri Slabya57a7bf2011-08-25 15:12:06 +0200593}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200595/*
596 * wait_event_interruptible_tty -- wait for a condition with the tty lock held
597 *
598 * The condition we are waiting for might take a long time to
599 * become true, or might depend on another thread taking the
600 * BTM. In either case, we need to drop the BTM to guarantee
601 * forward progress. This is a leftover from the conversion
602 * from the BKL and should eventually get removed as the BTM
603 * falls out of use.
604 *
605 * Do not use in new code.
606 */
Alan Cox89c8d912012-08-08 16:30:13 +0100607#define wait_event_interruptible_tty(tty, wq, condition) \
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200608({ \
609 int __ret = 0; \
610 if (!(condition)) { \
Alan Cox89c8d912012-08-08 16:30:13 +0100611 __wait_event_interruptible_tty(tty, wq, condition, __ret); \
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200612 } \
613 __ret; \
614})
615
Alan Cox89c8d912012-08-08 16:30:13 +0100616#define __wait_event_interruptible_tty(tty, wq, condition, ret) \
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200617do { \
618 DEFINE_WAIT(__wait); \
619 \
620 for (;;) { \
621 prepare_to_wait(&wq, &__wait, TASK_INTERRUPTIBLE); \
622 if (condition) \
623 break; \
624 if (!signal_pending(current)) { \
Alan Cox89c8d912012-08-08 16:30:13 +0100625 tty_unlock(tty); \
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200626 schedule(); \
Alan Cox89c8d912012-08-08 16:30:13 +0100627 tty_lock(tty); \
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200628 continue; \
629 } \
630 ret = -ERESTARTSYS; \
631 break; \
632 } \
633 finish_wait(&wq, &__wait); \
634} while (0)
635
636
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637#endif