blob: 97d660ed70c1901407dac9ea49bd1036840e649c [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>
Peter Hurley6a1c0682013-06-15 09:14:23 -040013#include <linux/rwsem.h>
Peter Hurley809850b2013-06-15 09:36:06 -040014#include <linux/llist.h>
Florian Fainelliae92c1f2011-05-24 10:43:03 +020015
Florian Fainelliae92c1f2011-05-24 10:43:03 +020016
17
18/*
19 * (Note: the *_driver.minor_start values 1, 64, 128, 192 are
20 * hardcoded at present.)
21 */
22#define NR_UNIX98_PTY_DEFAULT 4096 /* Default maximum for Unix98 ptys */
Konstantin Khlebnikove9aba512012-01-05 13:06:11 +040023#define NR_UNIX98_PTY_RESERVE 1024 /* Default reserve for main devpts */
Florian Fainelliae92c1f2011-05-24 10:43:03 +020024#define NR_UNIX98_PTY_MAX (1 << MINORBITS) /* Absolute limit */
25
Linus Torvalds1da177e2005-04-16 15:20:36 -070026/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070027 * This character is the same as _POSIX_VDISABLE: it cannot be used as
28 * a c_cc[] character, but indicates that a particular special character
29 * isn't in use (eg VINTR has no character etc)
30 */
31#define __DISABLED_CHAR '\0'
32
Alan Cox33f0f882006-01-09 20:54:13 -080033struct tty_buffer {
Peter Hurley809850b2013-06-15 09:36:06 -040034 union {
35 struct tty_buffer *next;
36 struct llist_node free;
37 };
Alan Cox33f0f882006-01-09 20:54:13 -080038 int used;
39 int size;
Paul Fulghum8977d922006-02-10 01:51:14 -080040 int commit;
41 int read;
Alan Cox33f0f882006-01-09 20:54:13 -080042 /* Data points here */
43 unsigned long data[0];
44};
45
Peter Hurley1fc359f2013-06-15 09:36:01 -040046static inline unsigned char *char_buf_ptr(struct tty_buffer *b, int ofs)
47{
48 return ((unsigned char *)b->data) + ofs;
49}
50
51static inline char *flag_buf_ptr(struct tty_buffer *b, int ofs)
52{
53 return (char *)char_buf_ptr(b, ofs) + b->size;
54}
55
Alan Cox33f0f882006-01-09 20:54:13 -080056struct tty_bufhead {
Peter Hurley8c1fb492013-06-15 09:36:12 -040057 struct tty_buffer *head; /* Queue head */
Linus Torvaldsf23eb2b2011-03-22 16:17:32 -070058 struct work_struct work;
Peter Hurleya7c8d582013-06-15 09:36:15 -040059 struct mutex lock;
60 atomic_t priority;
Peter Hurley7391ee12013-06-15 09:36:07 -040061 struct tty_buffer sentinel;
Peter Hurley809850b2013-06-15 09:36:06 -040062 struct llist_head free; /* Free queue head */
Peter Hurley7bfe0b72013-06-15 09:36:08 -040063 atomic_t memory_used; /* In-use buffers excluding free list */
Peter Hurley8c1fb492013-06-15 09:36:12 -040064 struct tty_buffer *tail; /* Active buffer */
Linus Torvalds1da177e2005-04-16 15:20:36 -070065};
66/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 * When a break, frame error, or parity error happens, these codes are
68 * stuffed into the flags buffer.
69 */
70#define TTY_NORMAL 0
71#define TTY_BREAK 1
72#define TTY_FRAME 2
73#define TTY_PARITY 3
74#define TTY_OVERRUN 4
75
Alan Coxadc8d742012-07-14 15:31:47 +010076#define INTR_CHAR(tty) ((tty)->termios.c_cc[VINTR])
77#define QUIT_CHAR(tty) ((tty)->termios.c_cc[VQUIT])
78#define ERASE_CHAR(tty) ((tty)->termios.c_cc[VERASE])
79#define KILL_CHAR(tty) ((tty)->termios.c_cc[VKILL])
80#define EOF_CHAR(tty) ((tty)->termios.c_cc[VEOF])
81#define TIME_CHAR(tty) ((tty)->termios.c_cc[VTIME])
82#define MIN_CHAR(tty) ((tty)->termios.c_cc[VMIN])
83#define SWTC_CHAR(tty) ((tty)->termios.c_cc[VSWTC])
84#define START_CHAR(tty) ((tty)->termios.c_cc[VSTART])
85#define STOP_CHAR(tty) ((tty)->termios.c_cc[VSTOP])
86#define SUSP_CHAR(tty) ((tty)->termios.c_cc[VSUSP])
87#define EOL_CHAR(tty) ((tty)->termios.c_cc[VEOL])
88#define REPRINT_CHAR(tty) ((tty)->termios.c_cc[VREPRINT])
89#define DISCARD_CHAR(tty) ((tty)->termios.c_cc[VDISCARD])
90#define WERASE_CHAR(tty) ((tty)->termios.c_cc[VWERASE])
91#define LNEXT_CHAR(tty) ((tty)->termios.c_cc[VLNEXT])
92#define EOL2_CHAR(tty) ((tty)->termios.c_cc[VEOL2])
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Alan Coxadc8d742012-07-14 15:31:47 +010094#define _I_FLAG(tty, f) ((tty)->termios.c_iflag & (f))
95#define _O_FLAG(tty, f) ((tty)->termios.c_oflag & (f))
96#define _C_FLAG(tty, f) ((tty)->termios.c_cflag & (f))
97#define _L_FLAG(tty, f) ((tty)->termios.c_lflag & (f))
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Alan Cox7a4d29f2008-07-16 21:54:54 +010099#define I_IGNBRK(tty) _I_FLAG((tty), IGNBRK)
100#define I_BRKINT(tty) _I_FLAG((tty), BRKINT)
101#define I_IGNPAR(tty) _I_FLAG((tty), IGNPAR)
102#define I_PARMRK(tty) _I_FLAG((tty), PARMRK)
103#define I_INPCK(tty) _I_FLAG((tty), INPCK)
104#define I_ISTRIP(tty) _I_FLAG((tty), ISTRIP)
105#define I_INLCR(tty) _I_FLAG((tty), INLCR)
106#define I_IGNCR(tty) _I_FLAG((tty), IGNCR)
107#define I_ICRNL(tty) _I_FLAG((tty), ICRNL)
108#define I_IUCLC(tty) _I_FLAG((tty), IUCLC)
109#define I_IXON(tty) _I_FLAG((tty), IXON)
110#define I_IXANY(tty) _I_FLAG((tty), IXANY)
111#define I_IXOFF(tty) _I_FLAG((tty), IXOFF)
112#define I_IMAXBEL(tty) _I_FLAG((tty), IMAXBEL)
113#define I_IUTF8(tty) _I_FLAG((tty), IUTF8)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
Alan Cox7a4d29f2008-07-16 21:54:54 +0100115#define O_OPOST(tty) _O_FLAG((tty), OPOST)
116#define O_OLCUC(tty) _O_FLAG((tty), OLCUC)
117#define O_ONLCR(tty) _O_FLAG((tty), ONLCR)
118#define O_OCRNL(tty) _O_FLAG((tty), OCRNL)
119#define O_ONOCR(tty) _O_FLAG((tty), ONOCR)
120#define O_ONLRET(tty) _O_FLAG((tty), ONLRET)
121#define O_OFILL(tty) _O_FLAG((tty), OFILL)
122#define O_OFDEL(tty) _O_FLAG((tty), OFDEL)
123#define O_NLDLY(tty) _O_FLAG((tty), NLDLY)
124#define O_CRDLY(tty) _O_FLAG((tty), CRDLY)
125#define O_TABDLY(tty) _O_FLAG((tty), TABDLY)
126#define O_BSDLY(tty) _O_FLAG((tty), BSDLY)
127#define O_VTDLY(tty) _O_FLAG((tty), VTDLY)
128#define O_FFDLY(tty) _O_FLAG((tty), FFDLY)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
Alan Cox7a4d29f2008-07-16 21:54:54 +0100130#define C_BAUD(tty) _C_FLAG((tty), CBAUD)
131#define C_CSIZE(tty) _C_FLAG((tty), CSIZE)
132#define C_CSTOPB(tty) _C_FLAG((tty), CSTOPB)
133#define C_CREAD(tty) _C_FLAG((tty), CREAD)
134#define C_PARENB(tty) _C_FLAG((tty), PARENB)
135#define C_PARODD(tty) _C_FLAG((tty), PARODD)
136#define C_HUPCL(tty) _C_FLAG((tty), HUPCL)
137#define C_CLOCAL(tty) _C_FLAG((tty), CLOCAL)
138#define C_CIBAUD(tty) _C_FLAG((tty), CIBAUD)
139#define C_CRTSCTS(tty) _C_FLAG((tty), CRTSCTS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
Alan Cox7a4d29f2008-07-16 21:54:54 +0100141#define L_ISIG(tty) _L_FLAG((tty), ISIG)
142#define L_ICANON(tty) _L_FLAG((tty), ICANON)
143#define L_XCASE(tty) _L_FLAG((tty), XCASE)
144#define L_ECHO(tty) _L_FLAG((tty), ECHO)
145#define L_ECHOE(tty) _L_FLAG((tty), ECHOE)
146#define L_ECHOK(tty) _L_FLAG((tty), ECHOK)
147#define L_ECHONL(tty) _L_FLAG((tty), ECHONL)
148#define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH)
149#define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP)
150#define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL)
151#define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT)
152#define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE)
153#define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO)
154#define L_PENDIN(tty) _L_FLAG((tty), PENDIN)
155#define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN)
hyc@symas.com26df6d12010-06-22 10:14:49 -0700156#define L_EXTPROC(tty) _L_FLAG((tty), EXTPROC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158struct device;
Miloslav Trmac522ed772007-07-15 23:40:56 -0700159struct signal_struct;
Alan Cox6f670482008-07-16 21:53:41 +0100160
161/*
162 * Port level information. Each device keeps its own port level information
163 * so provide a common structure for those ports wanting to use common support
164 * routines.
165 *
166 * The tty port has a different lifetime to the tty so must be kept apart.
167 * In addition be careful as tty -> port mappings are valid for the life
168 * of the tty object but in many cases port -> tty mappings are valid only
169 * until a hangup so don't use the wrong path.
170 */
Alan Cox7a4d29f2008-07-16 21:54:54 +0100171
Alan Cox31f35932009-01-02 13:45:05 +0000172struct tty_port;
173
174struct tty_port_operations {
175 /* Return 1 if the carrier is raised */
176 int (*carrier_raised)(struct tty_port *port);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700177 /* Control the DTR line */
Alan Coxfcc8ac12009-06-11 12:24:17 +0100178 void (*dtr_rts)(struct tty_port *port, int raise);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700179 /* Called when the last close completes or a hangup finishes
Alan Cox64bc3972009-10-06 16:06:11 +0100180 IFF the port was initialized. Do not use to free resources. Called
181 under the port mutex to serialize against activate/shutdowns */
Alan Cox7ca0ff92009-09-19 13:13:20 -0700182 void (*shutdown)(struct tty_port *port);
Alan Cox64bc3972009-10-06 16:06:11 +0100183 /* Called under the port mutex from tty_port_open, serialized using
184 the port mutex */
185 /* FIXME: long term getting the tty argument *out* of this would be
186 good for consoles */
187 int (*activate)(struct tty_port *port, struct tty_struct *tty);
Alan Cox568aafc2009-11-30 13:17:14 +0000188 /* Called on the final put of a port */
189 void (*destruct)(struct tty_port *port);
Alan Cox31f35932009-01-02 13:45:05 +0000190};
191
Alan Cox6f670482008-07-16 21:53:41 +0100192struct tty_port {
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200193 struct tty_bufhead buf; /* Locked internally */
Alan Cox6f670482008-07-16 21:53:41 +0100194 struct tty_struct *tty; /* Back pointer */
Jiri Slaby967fab62012-10-18 22:26:46 +0200195 struct tty_struct *itty; /* internal back ptr */
Alan Cox31f35932009-01-02 13:45:05 +0000196 const struct tty_port_operations *ops; /* Port operations */
Alan Cox4a90f092008-10-13 10:39:46 +0100197 spinlock_t lock; /* Lock protecting tty field */
Alan Cox6f670482008-07-16 21:53:41 +0100198 int blocked_open; /* Waiting to open */
199 int count; /* Usage count */
200 wait_queue_head_t open_wait; /* Open waiters */
201 wait_queue_head_t close_wait; /* Close waiters */
Alan Coxbdc04e32009-09-19 13:13:31 -0700202 wait_queue_head_t delta_msr_wait; /* Modem status change */
Alan Cox6f670482008-07-16 21:53:41 +0100203 unsigned long flags; /* TTY flags ASY_*/
Jiri Slabyd6c53c02013-01-03 15:53:05 +0100204 unsigned char console:1, /* port is a console */
205 low_latency:1; /* direct buffer flush */
Alan Cox6f670482008-07-16 21:53:41 +0100206 struct mutex mutex; /* Locking */
Alan Cox44e49092009-11-30 13:16:41 +0000207 struct mutex buf_mutex; /* Buffer alloc lock */
Alan Cox6f670482008-07-16 21:53:41 +0100208 unsigned char *xmit_buf; /* Optional buffer */
Alan Cox5e99df52009-09-19 13:13:28 -0700209 unsigned int close_delay; /* Close port delay */
210 unsigned int closing_wait; /* Delay for output */
Alan Cox1ec739b2009-06-11 12:25:25 +0100211 int drain_delay; /* Set to zero if no pure time
212 based drain is needed else
213 set to size of fifo */
Alan Cox568aafc2009-11-30 13:17:14 +0000214 struct kref kref; /* Ref counter */
Alan Cox6f670482008-07-16 21:53:41 +0100215};
216
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217/*
218 * Where all of the state associated with a tty is kept while the tty
219 * is open. Since the termios state should be kept even if the tty
220 * has been closed --- for things like the baud rate, etc --- it is
221 * not stored here, but rather a pointer to the real state is stored
222 * here. Possible the winsize structure should have the same
223 * treatment, but (1) the default 80x24 is usually right and (2) it's
224 * most often used by a windowing system, which will set the correct
225 * size each time the window is created or resized anyway.
226 * - TYT, 9/14/92
227 */
Alan Coxf34d7a52008-04-30 00:54:13 -0700228
229struct tty_operations;
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231struct tty_struct {
232 int magic;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100233 struct kref kref;
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +0400234 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 struct tty_driver *driver;
Alan Coxf34d7a52008-04-30 00:54:13 -0700236 const struct tty_operations *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 int index;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100238
239 /* Protects ldisc changes: Lock tty not pty */
Peter Hurley36697522013-06-15 07:04:48 -0400240 struct ld_semaphore ldisc_sem;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100241 struct tty_ldisc *ldisc;
242
Jiri Slabybddc7152012-10-18 22:26:42 +0200243 struct mutex atomic_write_lock;
Alan Cox89c8d912012-08-08 16:30:13 +0100244 struct mutex legacy_mutex;
Peter Hurleyd8c1f922013-06-15 09:14:31 -0400245 struct mutex throttle_mutex;
Peter Hurley6a1c0682013-06-15 09:14:23 -0400246 struct rw_semaphore termios_rwsem;
Peter Hurleydee4a0b2013-07-24 16:43:51 -0400247 struct mutex winsize_mutex;
Alan Cox04f378b2008-04-30 00:53:29 -0700248 spinlock_t ctrl_lock;
Peter Hurley6a1c0682013-06-15 09:14:23 -0400249 /* Termios values are protected by the termios rwsem */
Alan Coxadc8d742012-07-14 15:31:47 +0100250 struct ktermios termios, termios_locked;
Alan Cox1d65b4a2008-10-13 10:38:18 +0100251 struct termiox *termiox; /* May be NULL for unsupported */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 char name[64];
Alan Cox47f86832008-04-30 00:53:30 -0700253 struct pid *pgrp; /* Protected by ctrl lock */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800254 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 unsigned long flags;
256 int count;
Peter Hurleydee4a0b2013-07-24 16:43:51 -0400257 struct winsize winsize; /* winsize_mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
Alan Cox47f86832008-04-30 00:53:30 -0700259 unsigned char ctrl_status; /* ctrl_lock */
Alan Cox33f0f882006-01-09 20:54:13 -0800260 unsigned int receive_room; /* Bytes free for queue */
Peter Hurley70bc1262013-03-06 08:20:52 -0500261 int flow_change;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
263 struct tty_struct *link;
264 struct fasync_struct *fasync;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 int alt_speed; /* For magic substitution of 38400 bps */
266 wait_queue_head_t write_wait;
267 wait_queue_head_t read_wait;
268 struct work_struct hangup_work;
269 void *disc_data;
270 void *driver_data;
271 struct list_head tty_files;
272
273#define N_TTY_BUF_SIZE 4096
Alan Cox6f670482008-07-16 21:53:41 +0100274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 unsigned char closing:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 unsigned char *write_buf;
277 int write_cnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 /* If the tty has a pending do_SAK, queue it here - akpm */
279 struct work_struct SAK_work;
Alan Cox6f670482008-07-16 21:53:41 +0100280 struct tty_port *port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281};
282
Nick Piggind996b622010-08-18 04:37:36 +1000283/* Each of a tty's open files has private_data pointing to tty_file_private */
284struct tty_file_private {
285 struct tty_struct *tty;
286 struct file *file;
287 struct list_head list;
288};
289
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290/* tty magic number */
291#define TTY_MAGIC 0x5401
292
293/*
294 * These bits are used in the flags field of the tty structure.
Alan Cox7a4d29f2008-07-16 21:54:54 +0100295 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 * So that interrupts won't be able to mess up the queues,
297 * copy_to_cooked must be atomic with respect to itself, as must
298 * tty->write. Thus, you must use the inline functions set_bit() and
299 * clear_bit() to make things atomic.
300 */
301#define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
Alan Cox7a4d29f2008-07-16 21:54:54 +0100302#define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303#define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
304#define TTY_EXCLUSIVE 3 /* Exclusive open mode */
305#define TTY_DEBUG 4 /* Debugging */
306#define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307#define TTY_CLOSING 7 /* ->close() in progress */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100308#define TTY_LDISC_OPEN 11 /* Line discipline is open */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309#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() */
Jiri Slabyacfa7472010-11-29 10:16:54 +0100312#define TTY_HUPPING 21 /* ->hangup() in progress */
Peter Hurley21622932013-03-11 16:44:21 -0400313#define TTY_LDISC_HALTED 22 /* Line discipline is halted */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
315#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
316
Peter Hurley70bc1262013-03-06 08:20:52 -0500317/* Values for tty->flow_change */
318#define TTY_THROTTLE_SAFE 1
319#define TTY_UNTHROTTLE_SAFE 2
320
321static inline void __tty_set_flow_change(struct tty_struct *tty, int val)
322{
323 tty->flow_change = val;
324}
325
326static inline void tty_set_flow_change(struct tty_struct *tty, int val)
327{
328 tty->flow_change = val;
329 smp_mb();
330}
331
Joe Millenbach4f73bc42013-01-17 22:44:22 -0800332#ifdef CONFIG_TTY
333extern void console_init(void);
334extern void tty_kref_put(struct tty_struct *tty);
335extern struct pid *tty_get_pgrp(struct tty_struct *tty);
336extern void tty_vhangup_self(void);
337extern void disassociate_ctty(int priv);
338extern dev_t tty_devnum(struct tty_struct *tty);
339extern void proc_clear_tty(struct task_struct *p);
340extern struct tty_struct *get_current_tty(void);
341/* tty_io.c */
342extern int __init tty_init(void);
343#else
344static inline void console_init(void)
345{ }
346static inline void tty_kref_put(struct tty_struct *tty)
347{ }
348static inline struct pid *tty_get_pgrp(struct tty_struct *tty)
349{ return NULL; }
350static inline void tty_vhangup_self(void)
351{ }
352static inline void disassociate_ctty(int priv)
353{ }
354static inline dev_t tty_devnum(struct tty_struct *tty)
355{ return 0; }
356static inline void proc_clear_tty(struct task_struct *p)
357{ }
358static inline struct tty_struct *get_current_tty(void)
359{ return NULL; }
360/* tty_io.c */
361static inline int __init tty_init(void)
362{ return 0; }
363#endif
364
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365extern void tty_write_flush(struct tty_struct *);
366
Alan Coxedc6afc2006-12-08 02:38:44 -0800367extern struct ktermios tty_std_termios;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369extern int vcs_init(void);
370
Alan Coxd81ed102008-10-13 10:41:42 +0100371extern struct class *tty_class;
372
Alan Cox9c9f4de2008-10-13 10:37:26 +0100373/**
374 * tty_kref_get - get a tty reference
375 * @tty: tty device
376 *
377 * Return a new reference to a tty object. The caller must hold
378 * sufficient locks/counts to ensure that their existing reference cannot
379 * go away
380 */
381
Ingo Molnar14bfc982008-11-25 08:58:11 +0100382static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
Alan Cox9c9f4de2008-10-13 10:37:26 +0100383{
384 if (tty)
385 kref_get(&tty->kref);
386 return tty;
387}
Alan Cox9c9f4de2008-10-13 10:37:26 +0100388
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
390 const char *routine);
391extern char *tty_name(struct tty_struct *tty, char *buf);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100392extern void tty_wait_until_sent(struct tty_struct *tty, long timeout);
393extern int tty_check_change(struct tty_struct *tty);
394extern void stop_tty(struct tty_struct *tty);
395extern void start_tty(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396extern int tty_register_driver(struct tty_driver *driver);
397extern int tty_unregister_driver(struct tty_driver *driver);
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -0700398extern struct device *tty_register_device(struct tty_driver *driver,
399 unsigned index, struct device *dev);
Tomas Hlavacek6915c0e2012-09-06 03:17:18 +0200400extern struct device *tty_register_device_attr(struct tty_driver *driver,
401 unsigned index, struct device *device,
402 void *drvdata,
403 const struct attribute_group **attr_grp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
405extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
406 int buflen);
407extern void tty_write_message(struct tty_struct *tty, char *msg);
Alan Coxf34d7a52008-04-30 00:54:13 -0700408extern int tty_put_char(struct tty_struct *tty, unsigned char c);
409extern int tty_chars_in_buffer(struct tty_struct *tty);
410extern int tty_write_room(struct tty_struct *tty);
411extern void tty_driver_flush_buffer(struct tty_struct *tty);
Alan Cox39c2e602008-04-30 00:54:18 -0700412extern void tty_throttle(struct tty_struct *tty);
413extern void tty_unthrottle(struct tty_struct *tty);
Peter Hurley70bc1262013-03-06 08:20:52 -0500414extern int tty_throttle_safe(struct tty_struct *tty);
415extern int tty_unthrottle_safe(struct tty_struct *tty);
Alan Coxfc6f6232009-01-02 13:43:17 +0000416extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
Jiri Slaby24d406a2011-08-10 14:59:28 +0200417extern void tty_driver_remove_tty(struct tty_driver *driver,
418 struct tty_struct *tty);
Alan Coxfeebed62008-10-13 10:41:30 +0100419extern void tty_free_termios(struct tty_struct *tty);
Eric W. Biederman3e7cd6c2007-02-12 00:52:58 -0800420extern int is_current_pgrp_orphaned(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421extern int is_ignored(int sig);
422extern int tty_signal(int sig, struct tty_struct *tty);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100423extern void tty_hangup(struct tty_struct *tty);
424extern void tty_vhangup(struct tty_struct *tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200425extern void tty_vhangup_locked(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426extern void tty_unhangup(struct file *filp);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100427extern int tty_hung_up_p(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428extern void do_SAK(struct tty_struct *tty);
Eric W. Biederman8b6312f2007-02-10 01:44:34 -0800429extern void __do_SAK(struct tty_struct *tty);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700430extern void no_tty(void);
OGAWA Hirofumie043e422009-07-29 12:15:56 -0700431extern void tty_flush_to_ldisc(struct tty_struct *tty);
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200432extern void tty_buffer_free_all(struct tty_port *port);
Alan Coxe0495732008-10-13 10:36:58 +0100433extern void tty_buffer_flush(struct tty_struct *tty);
Jiri Slabyecbbfd42012-10-18 22:26:47 +0200434extern void tty_buffer_init(struct tty_port *port);
Alan Coxedc6afc2006-12-08 02:38:44 -0800435extern speed_t tty_termios_baud_rate(struct ktermios *termios);
436extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100437extern void tty_termios_encode_baud_rate(struct ktermios *termios,
438 speed_t ibaud, speed_t obaud);
439extern void tty_encode_baud_rate(struct tty_struct *tty,
440 speed_t ibaud, speed_t obaud);
Jiri Slaby6865ff22013-03-07 13:12:27 +0100441
442/**
443 * tty_get_baud_rate - get tty bit rates
444 * @tty: tty to query
445 *
446 * Returns the baud rate as an integer for this terminal. The
447 * termios lock must be held by the caller and the terminal bit
448 * flags may be updated.
449 *
450 * Locking: none
451 */
452static inline speed_t tty_get_baud_rate(struct tty_struct *tty)
453{
454 return tty_termios_baud_rate(&tty->termios);
455}
456
Alan Cox5f519d72007-10-16 23:30:07 -0700457extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
Alan Coxbf5e5832008-01-08 14:55:51 +0000458extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
Alan Cox8d075b12011-02-14 16:27:53 +0000459extern int tty_set_termios(struct tty_struct *tty, struct ktermios *kt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
461extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
462extern void tty_ldisc_deref(struct tty_ldisc *);
463extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100464extern void tty_ldisc_hangup(struct tty_struct *tty);
Alan Coxa352def2008-07-16 21:53:12 +0100465extern const struct file_operations tty_ldiscs_proc_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466
467extern void tty_wakeup(struct tty_struct *tty);
468extern void tty_ldisc_flush(struct tty_struct *tty);
469
Alan Cox04f378b2008-04-30 00:53:29 -0700470extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Alan Cox0fc00e22007-11-07 01:24:56 -0800471extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
472 unsigned int cmd, unsigned long arg);
473extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
Alan Coxd81ed102008-10-13 10:41:42 +0100474extern void tty_default_fops(struct file_operations *fops);
Alan Coxbf970ee2008-10-13 10:42:39 +0100475extern struct tty_struct *alloc_tty_struct(void);
Jiri Slabyfa90e1c2011-10-12 11:32:43 +0200476extern int tty_alloc_file(struct file *file);
477extern void tty_add_file(struct tty_struct *tty, struct file *file);
478extern void tty_free_file(struct file *file);
Alan Coxbf970ee2008-10-13 10:42:39 +0100479extern void free_tty_struct(struct tty_struct *tty);
480extern void initialize_tty_struct(struct tty_struct *tty,
481 struct tty_driver *driver, int idx);
Jiri Slaby67166712011-03-23 10:48:35 +0100482extern void deinitialize_tty_struct(struct tty_struct *tty);
Konstantin Khlebnikov593a27c2012-01-05 13:04:21 +0400483extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx);
Alan Coxeeb89d92009-11-30 13:18:29 +0000484extern int tty_release(struct inode *inode, struct file *filp);
Alan Coxbf970ee2008-10-13 10:42:39 +0100485extern int tty_init_termios(struct tty_struct *tty);
Jiri Slaby66d450e2012-01-30 21:14:28 +0100486extern int tty_standard_install(struct tty_driver *driver,
487 struct tty_struct *tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800488
Alan Coxe8b70e72009-06-11 12:48:02 +0100489extern struct tty_struct *tty_pair_get_tty(struct tty_struct *tty);
490extern struct tty_struct *tty_pair_get_pty(struct tty_struct *tty);
491
Ingo Molnar70522e12006-03-23 03:00:31 -0800492extern struct mutex tty_mutex;
Nick Pigginee2ffa02010-08-18 04:37:35 +1000493extern spinlock_t tty_files_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494
Alan Cox9c1729d2007-07-15 23:39:43 -0700495extern void tty_write_unlock(struct tty_struct *tty);
496extern int tty_write_lock(struct tty_struct *tty, int ndelay);
497#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
498
Alan Cox6f670482008-07-16 21:53:41 +0100499extern void tty_port_init(struct tty_port *port);
Jiri Slaby2cb4ca02012-08-07 21:47:50 +0200500extern void tty_port_link_device(struct tty_port *port,
501 struct tty_driver *driver, unsigned index);
Jiri Slaby057eb852012-06-04 13:35:37 +0200502extern struct device *tty_port_register_device(struct tty_port *port,
503 struct tty_driver *driver, unsigned index,
504 struct device *device);
Tomas Hlavacekb1b79912012-09-06 23:17:47 +0200505extern struct device *tty_port_register_device_attr(struct tty_port *port,
506 struct tty_driver *driver, unsigned index,
507 struct device *device, void *drvdata,
508 const struct attribute_group **attr_grp);
Alan Cox6f670482008-07-16 21:53:41 +0100509extern int tty_port_alloc_xmit_buf(struct tty_port *port);
510extern void tty_port_free_xmit_buf(struct tty_port *port);
Jiri Slabyde274bf2012-11-15 09:49:54 +0100511extern void tty_port_destroy(struct tty_port *port);
Alan Cox568aafc2009-11-30 13:17:14 +0000512extern void tty_port_put(struct tty_port *port);
513
Randy Dunlap2427b8e2010-01-15 17:01:11 -0800514static inline struct tty_port *tty_port_get(struct tty_port *port)
Alan Cox568aafc2009-11-30 13:17:14 +0000515{
516 if (port)
517 kref_get(&port->kref);
518 return port;
519}
520
Huang Shijief21ec3d2012-08-22 22:13:36 -0400521/* If the cts flow control is enabled, return true. */
522static inline bool tty_port_cts_enabled(struct tty_port *port)
523{
524 return port->flags & ASYNC_CTS_FLOW;
525}
526
Alan Cox4a90f092008-10-13 10:39:46 +0100527extern struct tty_struct *tty_port_tty_get(struct tty_port *port);
528extern void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty);
Alan Cox31f35932009-01-02 13:45:05 +0000529extern int tty_port_carrier_raised(struct tty_port *port);
Alan Cox5d951fb2009-01-02 13:45:19 +0000530extern void tty_port_raise_dtr_rts(struct tty_port *port);
Alan Coxfcc8ac12009-06-11 12:24:17 +0100531extern void tty_port_lower_dtr_rts(struct tty_port *port);
Alan Cox3e616962009-01-02 13:45:26 +0000532extern void tty_port_hangup(struct tty_port *port);
Jiri Slabyaa27a092013-03-07 13:12:30 +0100533extern void tty_port_tty_hangup(struct tty_port *port, bool check_clocal);
Jiri Slaby6aad04f2013-03-07 13:12:29 +0100534extern void tty_port_tty_wakeup(struct tty_port *port);
Alan Cox36c621d2009-01-02 13:46:10 +0000535extern int tty_port_block_til_ready(struct tty_port *port,
536 struct tty_struct *tty, struct file *filp);
Alan Coxa6614992009-01-02 13:46:50 +0000537extern int tty_port_close_start(struct tty_port *port,
538 struct tty_struct *tty, struct file *filp);
539extern void tty_port_close_end(struct tty_port *port, struct tty_struct *tty);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700540extern void tty_port_close(struct tty_port *port,
541 struct tty_struct *tty, struct file *filp);
Jiri Slaby695586c2012-06-04 13:35:32 +0200542extern int tty_port_install(struct tty_port *port, struct tty_driver *driver,
543 struct tty_struct *tty);
Alan Cox64bc3972009-10-06 16:06:11 +0100544extern int tty_port_open(struct tty_port *port,
545 struct tty_struct *tty, struct file *filp);
Randy Dunlap2427b8e2010-01-15 17:01:11 -0800546static inline int tty_port_users(struct tty_port *port)
Alan Coxb58d13a2009-09-19 13:13:32 -0700547{
548 return port->count + port->blocked_open;
549}
550
Alan Cox01e1abb2008-07-22 11:16:55 +0100551extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
552extern int tty_unregister_ldisc(int disc);
553extern int tty_set_ldisc(struct tty_struct *tty, int ldisc);
554extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty);
555extern void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty);
556extern void tty_ldisc_init(struct tty_struct *tty);
Jiri Slaby67166712011-03-23 10:48:35 +0100557extern void tty_ldisc_deinit(struct tty_struct *tty);
Alan Cox01e1abb2008-07-22 11:16:55 +0100558extern void tty_ldisc_begin(void);
Alan Cox9c1729d2007-07-15 23:39:43 -0700559
Peter Hurley24a89d12013-06-15 09:14:15 -0400560static inline int tty_ldisc_receive_buf(struct tty_ldisc *ld, unsigned char *p,
561 char *f, int count)
562{
563 if (ld->ops->receive_buf2)
564 count = ld->ops->receive_buf2(ld->tty, p, f, count);
565 else {
566 count = min_t(int, count, ld->tty->receive_room);
567 if (count)
568 ld->ops->receive_buf(ld->tty, p, f, count);
569 }
570 return count;
571}
572
Alan Cox9c1729d2007-07-15 23:39:43 -0700573
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574/* n_tty.c */
Alan Coxa352def2008-07-16 21:53:12 +0100575extern struct tty_ldisc_ops tty_ldisc_N_TTY;
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -0800576extern void n_tty_inherit_ops(struct tty_ldisc_ops *ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577
Miloslav Trmac522ed772007-07-15 23:40:56 -0700578/* tty_audit.c */
579#ifdef CONFIG_AUDIT
580extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data,
Jiri Slaby6c633f22012-10-18 22:26:37 +0200581 size_t size, unsigned icanon);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700582extern void tty_audit_exit(void);
583extern void tty_audit_fork(struct signal_struct *sig);
Al Viro1e641742008-12-09 09:23:33 +0000584extern void tty_audit_tiocsti(struct tty_struct *tty, char ch);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700585extern void tty_audit_push(struct tty_struct *tty);
Eric Paris152f4972013-04-19 13:56:11 -0400586extern int tty_audit_push_current(void);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700587#else
588static inline void tty_audit_add_data(struct tty_struct *tty,
Jiri Slaby6c633f22012-10-18 22:26:37 +0200589 unsigned char *data, size_t size, unsigned icanon)
Miloslav Trmac522ed772007-07-15 23:40:56 -0700590{
591}
Al Viro1e641742008-12-09 09:23:33 +0000592static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch)
593{
594}
Miloslav Trmac522ed772007-07-15 23:40:56 -0700595static inline void tty_audit_exit(void)
596{
597}
598static inline void tty_audit_fork(struct signal_struct *sig)
599{
600}
601static inline void tty_audit_push(struct tty_struct *tty)
602{
603}
Eric Paris152f4972013-04-19 13:56:11 -0400604static inline int tty_audit_push_current(void)
Miloslav Trmac522ed772007-07-15 23:40:56 -0700605{
Thomas Gleixner3c80fe42009-12-09 14:19:31 +0000606 return 0;
Miloslav Trmac522ed772007-07-15 23:40:56 -0700607}
Miloslav Trmac522ed772007-07-15 23:40:56 -0700608#endif
609
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610/* tty_ioctl.c */
Alan Cox47afa7a2008-10-13 10:44:17 +0100611extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 unsigned int cmd, unsigned long arg);
Thomas Meyer8193c422011-10-05 23:13:13 +0200613extern long n_tty_compat_ioctl_helper(struct tty_struct *tty, struct file *file,
614 unsigned int cmd, unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
616/* serial.c */
617
618extern void serial_console_init(void);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100619
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620/* pcxx.c */
621
622extern int pcxe_open(struct tty_struct *tty, struct file *filp);
623
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624/* vt.c */
625
Alan Cox6caa76b2011-02-14 16:27:22 +0000626extern int vt_ioctl(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 unsigned int cmd, unsigned long arg);
628
Greg Kroah-Hartman94c22732011-02-17 12:02:51 -0800629extern long vt_compat_ioctl(struct tty_struct *tty,
Arnd Bergmanne9216652009-08-06 15:09:28 +0200630 unsigned int cmd, unsigned long arg);
631
Arnd Bergmannb07471f2010-08-06 21:40:30 +0200632/* tty_mutex.c */
Arnd Bergmannec79d602010-06-01 22:53:01 +0200633/* functions for preparation of BKL removal */
Alan Cox89c8d912012-08-08 16:30:13 +0100634extern void __lockfunc tty_lock(struct tty_struct *tty);
635extern void __lockfunc tty_unlock(struct tty_struct *tty);
636extern void __lockfunc tty_lock_pair(struct tty_struct *tty,
637 struct tty_struct *tty2);
638extern void __lockfunc tty_unlock_pair(struct tty_struct *tty,
639 struct tty_struct *tty2);
Arnd Bergmannec79d602010-06-01 22:53:01 +0200640
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200641/*
Jiri Slabya57a7bf2011-08-25 15:12:06 +0200642 * this shall be called only from where BTM is held (like close)
643 *
644 * We need this to ensure nobody waits for us to finish while we are waiting.
645 * Without this we were encountering system stalls.
646 *
647 * This should be indeed removed with BTM removal later.
648 *
649 * Locking: BTM required. Nobody is allowed to hold port->mutex.
650 */
651static inline void tty_wait_until_sent_from_close(struct tty_struct *tty,
652 long timeout)
653{
Alan Cox89c8d912012-08-08 16:30:13 +0100654 tty_unlock(tty); /* tty->ops->close holds the BTM, drop it while waiting */
Jiri Slabya57a7bf2011-08-25 15:12:06 +0200655 tty_wait_until_sent(tty, timeout);
Alan Cox89c8d912012-08-08 16:30:13 +0100656 tty_lock(tty);
Jiri Slabya57a7bf2011-08-25 15:12:06 +0200657}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200659/*
660 * wait_event_interruptible_tty -- wait for a condition with the tty lock held
661 *
662 * The condition we are waiting for might take a long time to
663 * become true, or might depend on another thread taking the
664 * BTM. In either case, we need to drop the BTM to guarantee
665 * forward progress. This is a leftover from the conversion
666 * from the BKL and should eventually get removed as the BTM
667 * falls out of use.
668 *
669 * Do not use in new code.
670 */
Alan Cox89c8d912012-08-08 16:30:13 +0100671#define wait_event_interruptible_tty(tty, wq, condition) \
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200672({ \
673 int __ret = 0; \
Peter Zijlstra35a2af92013-10-02 11:22:33 +0200674 if (!(condition)) \
675 __ret = __wait_event_interruptible_tty(tty, wq, \
676 condition); \
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200677 __ret; \
678})
679
Peter Zijlstra35a2af92013-10-02 11:22:33 +0200680#define __wait_event_interruptible_tty(tty, wq, condition) \
681 ___wait_event(wq, condition, TASK_INTERRUPTIBLE, 0, 0, \
Peter Zijlstra0d1e1c82013-10-02 11:22:30 +0200682 tty_unlock(tty); \
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200683 schedule(); \
Peter Zijlstra0d1e1c82013-10-02 11:22:30 +0200684 tty_lock(tty))
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200685
David Howells34db8aa2013-04-12 02:29:19 +0100686#ifdef CONFIG_PROC_FS
687extern void proc_tty_register_driver(struct tty_driver *);
688extern void proc_tty_unregister_driver(struct tty_driver *);
689#else
690static inline void proc_tty_register_driver(struct tty_driver *d) {}
691static inline void proc_tty_unregister_driver(struct tty_driver *d) {}
692#endif
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200693
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694#endif