blob: d94eb86266c4259a08f9f5ab6f1592b4c212f146 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_TTY_H
2#define _LINUX_TTY_H
3
4/*
5 * 'tty.h' defines some structures used by tty_io.c and some defines.
6 */
7
Linus Torvalds1da177e2005-04-16 15:20:36 -07008#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/fs.h>
10#include <linux/major.h>
11#include <linux/termios.h>
12#include <linux/workqueue.h>
13#include <linux/tty_driver.h>
14#include <linux/tty_ldisc.h>
Ingo Molnar70522e12006-03-23 03:00:31 -080015#include <linux/mutex.h>
Arnd Bergmannec79d602010-06-01 22:53:01 +020016#include <linux/smp_lock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
18#include <asm/system.h>
19
20
21/*
22 * (Note: the *_driver.minor_start values 1, 64, 128, 192 are
23 * hardcoded at present.)
24 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#define NR_UNIX98_PTY_DEFAULT 4096 /* Default maximum for Unix98 ptys */
26#define NR_UNIX98_PTY_MAX (1 << MINORBITS) /* Absolute limit */
Pavan Savoy1ff454e2010-04-08 13:16:52 -050027#define NR_LDISCS 30
Tilman Schmidt4564f9e2007-02-10 01:45:00 -080028
29/* line disciplines */
30#define N_TTY 0
31#define N_SLIP 1
32#define N_MOUSE 2
33#define N_PPP 3
34#define N_STRIP 4
35#define N_AX25 5
36#define N_X25 6 /* X.25 async */
37#define N_6PACK 7
38#define N_MASC 8 /* Reserved for Mobitex module <kaz@cafe.net> */
39#define N_R3964 9 /* Reserved for Simatic R3964 module */
David Woodhouse44d1b982008-06-05 22:46:18 -070040#define N_PROFIBUS_FDL 10 /* Reserved for Profibus */
Tilman Schmidt4564f9e2007-02-10 01:45:00 -080041#define N_IRDA 11 /* Linux IrDa - http://irda.sourceforge.net/ */
42#define N_SMSBLOCK 12 /* SMS block mode - for talking to GSM data */
43 /* cards about SMS messages */
44#define N_HDLC 13 /* synchronous HDLC */
45#define N_SYNC_PPP 14 /* synchronous PPP */
46#define N_HCI 15 /* Bluetooth HCI UART */
47#define N_GIGASET_M101 16 /* Siemens Gigaset M101 serial DECT adapter */
Oliver Hartkoppcd05acf2007-12-16 15:59:24 -080048#define N_SLCAN 17 /* Serial / USB serial CAN Adaptors */
Alan Cox348eb122008-10-13 10:37:17 +010049#define N_PPS 18 /* Pulse per Second */
Janusz Krzysztofikb7b8f9b2009-08-06 13:07:32 +020050#define N_V253 19 /* Codec control over voice modem */
Sjur Braendeland9b271052010-03-30 13:56:30 +000051#define N_CAIF 20 /* CAIF protocol for talking to modems */
Alan Coxe1eaea42010-03-26 11:32:54 +000052#define N_GSM0710 21 /* GSM 0710 Mux */
Janusz Krzysztofik78ed73e2009-07-22 05:22:37 +020053
Linus Torvalds1da177e2005-04-16 15:20:36 -070054/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 * This character is the same as _POSIX_VDISABLE: it cannot be used as
56 * a c_cc[] character, but indicates that a particular special character
57 * isn't in use (eg VINTR has no character etc)
58 */
59#define __DISABLED_CHAR '\0'
60
Alan Cox33f0f882006-01-09 20:54:13 -080061struct tty_buffer {
62 struct tty_buffer *next;
63 char *char_buf_ptr;
64 unsigned char *flag_buf_ptr;
65 int used;
66 int size;
Paul Fulghum8977d922006-02-10 01:51:14 -080067 int commit;
68 int read;
Alan Cox33f0f882006-01-09 20:54:13 -080069 /* Data points here */
70 unsigned long data[0];
71};
72
Alan Coxd9661ad2010-02-18 16:43:47 +000073/*
74 * We default to dicing tty buffer allocations to this many characters
Mel Gorman352fa6a2010-03-02 22:24:19 +000075 * in order to avoid multiple page allocations. We know the size of
76 * tty_buffer itself but it must also be taken into account that the
77 * the buffer is 256 byte aligned. See tty_buffer_find for the allocation
78 * logic this must match
Alan Coxd9661ad2010-02-18 16:43:47 +000079 */
80
Mel Gorman352fa6a2010-03-02 22:24:19 +000081#define TTY_BUFFER_PAGE (((PAGE_SIZE - sizeof(struct tty_buffer)) / 2) & ~0xFF)
Alan Coxd9661ad2010-02-18 16:43:47 +000082
83
Alan Cox33f0f882006-01-09 20:54:13 -080084struct tty_bufhead {
David Howells52bad642006-11-22 14:54:01 +000085 struct delayed_work work;
Paul Fulghum808249c2006-02-03 03:04:41 -080086 spinlock_t lock;
Alan Cox33f0f882006-01-09 20:54:13 -080087 struct tty_buffer *head; /* Queue head */
88 struct tty_buffer *tail; /* Active buffer */
89 struct tty_buffer *free; /* Free queue head */
Alan Cox7a4d29f2008-07-16 21:54:54 +010090 int memory_used; /* Buffer space used excluding
91 free queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -070092};
93/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 * When a break, frame error, or parity error happens, these codes are
95 * stuffed into the flags buffer.
96 */
97#define TTY_NORMAL 0
98#define TTY_BREAK 1
99#define TTY_FRAME 2
100#define TTY_PARITY 3
101#define TTY_OVERRUN 4
102
103#define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
104#define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
105#define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
106#define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
107#define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
108#define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
109#define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
110#define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
111#define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
112#define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
113#define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
114#define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
115#define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
116#define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
117#define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
118#define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
119#define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
120
Alan Cox7a4d29f2008-07-16 21:54:54 +0100121#define _I_FLAG(tty, f) ((tty)->termios->c_iflag & (f))
122#define _O_FLAG(tty, f) ((tty)->termios->c_oflag & (f))
123#define _C_FLAG(tty, f) ((tty)->termios->c_cflag & (f))
124#define _L_FLAG(tty, f) ((tty)->termios->c_lflag & (f))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
Alan Cox7a4d29f2008-07-16 21:54:54 +0100126#define I_IGNBRK(tty) _I_FLAG((tty), IGNBRK)
127#define I_BRKINT(tty) _I_FLAG((tty), BRKINT)
128#define I_IGNPAR(tty) _I_FLAG((tty), IGNPAR)
129#define I_PARMRK(tty) _I_FLAG((tty), PARMRK)
130#define I_INPCK(tty) _I_FLAG((tty), INPCK)
131#define I_ISTRIP(tty) _I_FLAG((tty), ISTRIP)
132#define I_INLCR(tty) _I_FLAG((tty), INLCR)
133#define I_IGNCR(tty) _I_FLAG((tty), IGNCR)
134#define I_ICRNL(tty) _I_FLAG((tty), ICRNL)
135#define I_IUCLC(tty) _I_FLAG((tty), IUCLC)
136#define I_IXON(tty) _I_FLAG((tty), IXON)
137#define I_IXANY(tty) _I_FLAG((tty), IXANY)
138#define I_IXOFF(tty) _I_FLAG((tty), IXOFF)
139#define I_IMAXBEL(tty) _I_FLAG((tty), IMAXBEL)
140#define I_IUTF8(tty) _I_FLAG((tty), IUTF8)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Alan Cox7a4d29f2008-07-16 21:54:54 +0100142#define O_OPOST(tty) _O_FLAG((tty), OPOST)
143#define O_OLCUC(tty) _O_FLAG((tty), OLCUC)
144#define O_ONLCR(tty) _O_FLAG((tty), ONLCR)
145#define O_OCRNL(tty) _O_FLAG((tty), OCRNL)
146#define O_ONOCR(tty) _O_FLAG((tty), ONOCR)
147#define O_ONLRET(tty) _O_FLAG((tty), ONLRET)
148#define O_OFILL(tty) _O_FLAG((tty), OFILL)
149#define O_OFDEL(tty) _O_FLAG((tty), OFDEL)
150#define O_NLDLY(tty) _O_FLAG((tty), NLDLY)
151#define O_CRDLY(tty) _O_FLAG((tty), CRDLY)
152#define O_TABDLY(tty) _O_FLAG((tty), TABDLY)
153#define O_BSDLY(tty) _O_FLAG((tty), BSDLY)
154#define O_VTDLY(tty) _O_FLAG((tty), VTDLY)
155#define O_FFDLY(tty) _O_FLAG((tty), FFDLY)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Alan Cox7a4d29f2008-07-16 21:54:54 +0100157#define C_BAUD(tty) _C_FLAG((tty), CBAUD)
158#define C_CSIZE(tty) _C_FLAG((tty), CSIZE)
159#define C_CSTOPB(tty) _C_FLAG((tty), CSTOPB)
160#define C_CREAD(tty) _C_FLAG((tty), CREAD)
161#define C_PARENB(tty) _C_FLAG((tty), PARENB)
162#define C_PARODD(tty) _C_FLAG((tty), PARODD)
163#define C_HUPCL(tty) _C_FLAG((tty), HUPCL)
164#define C_CLOCAL(tty) _C_FLAG((tty), CLOCAL)
165#define C_CIBAUD(tty) _C_FLAG((tty), CIBAUD)
166#define C_CRTSCTS(tty) _C_FLAG((tty), CRTSCTS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Alan Cox7a4d29f2008-07-16 21:54:54 +0100168#define L_ISIG(tty) _L_FLAG((tty), ISIG)
169#define L_ICANON(tty) _L_FLAG((tty), ICANON)
170#define L_XCASE(tty) _L_FLAG((tty), XCASE)
171#define L_ECHO(tty) _L_FLAG((tty), ECHO)
172#define L_ECHOE(tty) _L_FLAG((tty), ECHOE)
173#define L_ECHOK(tty) _L_FLAG((tty), ECHOK)
174#define L_ECHONL(tty) _L_FLAG((tty), ECHONL)
175#define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH)
176#define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP)
177#define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL)
178#define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT)
179#define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE)
180#define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO)
181#define L_PENDIN(tty) _L_FLAG((tty), PENDIN)
182#define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN)
hyc@symas.com26df6d12010-06-22 10:14:49 -0700183#define L_EXTPROC(tty) _L_FLAG((tty), EXTPROC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185struct device;
Miloslav Trmac522ed772007-07-15 23:40:56 -0700186struct signal_struct;
Alan Cox6f670482008-07-16 21:53:41 +0100187
188/*
189 * Port level information. Each device keeps its own port level information
190 * so provide a common structure for those ports wanting to use common support
191 * routines.
192 *
193 * The tty port has a different lifetime to the tty so must be kept apart.
194 * In addition be careful as tty -> port mappings are valid for the life
195 * of the tty object but in many cases port -> tty mappings are valid only
196 * until a hangup so don't use the wrong path.
197 */
Alan Cox7a4d29f2008-07-16 21:54:54 +0100198
Alan Cox31f35932009-01-02 13:45:05 +0000199struct tty_port;
200
201struct tty_port_operations {
202 /* Return 1 if the carrier is raised */
203 int (*carrier_raised)(struct tty_port *port);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700204 /* Control the DTR line */
Alan Coxfcc8ac12009-06-11 12:24:17 +0100205 void (*dtr_rts)(struct tty_port *port, int raise);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700206 /* Called when the last close completes or a hangup finishes
Alan Cox64bc3972009-10-06 16:06:11 +0100207 IFF the port was initialized. Do not use to free resources. Called
208 under the port mutex to serialize against activate/shutdowns */
Alan Cox7ca0ff92009-09-19 13:13:20 -0700209 void (*shutdown)(struct tty_port *port);
210 void (*drop)(struct tty_port *port);
Alan Cox64bc3972009-10-06 16:06:11 +0100211 /* Called under the port mutex from tty_port_open, serialized using
212 the port mutex */
213 /* FIXME: long term getting the tty argument *out* of this would be
214 good for consoles */
215 int (*activate)(struct tty_port *port, struct tty_struct *tty);
Alan Cox568aafc2009-11-30 13:17:14 +0000216 /* Called on the final put of a port */
217 void (*destruct)(struct tty_port *port);
Alan Cox31f35932009-01-02 13:45:05 +0000218};
219
Alan Cox6f670482008-07-16 21:53:41 +0100220struct tty_port {
221 struct tty_struct *tty; /* Back pointer */
Alan Cox31f35932009-01-02 13:45:05 +0000222 const struct tty_port_operations *ops; /* Port operations */
Alan Cox4a90f092008-10-13 10:39:46 +0100223 spinlock_t lock; /* Lock protecting tty field */
Alan Cox6f670482008-07-16 21:53:41 +0100224 int blocked_open; /* Waiting to open */
225 int count; /* Usage count */
226 wait_queue_head_t open_wait; /* Open waiters */
227 wait_queue_head_t close_wait; /* Close waiters */
Alan Coxbdc04e32009-09-19 13:13:31 -0700228 wait_queue_head_t delta_msr_wait; /* Modem status change */
Alan Cox6f670482008-07-16 21:53:41 +0100229 unsigned long flags; /* TTY flags ASY_*/
Jason Wessel336cee42010-03-08 21:50:11 -0600230 unsigned char console:1; /* port is a console */
Alan Cox6f670482008-07-16 21:53:41 +0100231 struct mutex mutex; /* Locking */
Alan Cox44e49092009-11-30 13:16:41 +0000232 struct mutex buf_mutex; /* Buffer alloc lock */
Alan Cox6f670482008-07-16 21:53:41 +0100233 unsigned char *xmit_buf; /* Optional buffer */
Alan Cox5e99df52009-09-19 13:13:28 -0700234 unsigned int close_delay; /* Close port delay */
235 unsigned int closing_wait; /* Delay for output */
Alan Cox1ec739b2009-06-11 12:25:25 +0100236 int drain_delay; /* Set to zero if no pure time
237 based drain is needed else
238 set to size of fifo */
Alan Cox568aafc2009-11-30 13:17:14 +0000239 struct kref kref; /* Ref counter */
Alan Cox6f670482008-07-16 21:53:41 +0100240};
241
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242/*
243 * Where all of the state associated with a tty is kept while the tty
244 * is open. Since the termios state should be kept even if the tty
245 * has been closed --- for things like the baud rate, etc --- it is
246 * not stored here, but rather a pointer to the real state is stored
247 * here. Possible the winsize structure should have the same
248 * treatment, but (1) the default 80x24 is usually right and (2) it's
249 * most often used by a windowing system, which will set the correct
250 * size each time the window is created or resized anyway.
251 * - TYT, 9/14/92
252 */
Alan Coxf34d7a52008-04-30 00:54:13 -0700253
254struct tty_operations;
255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256struct tty_struct {
257 int magic;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100258 struct kref kref;
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +0400259 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 struct tty_driver *driver;
Alan Coxf34d7a52008-04-30 00:54:13 -0700261 const struct tty_operations *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 int index;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100263
264 /* Protects ldisc changes: Lock tty not pty */
265 struct mutex ldisc_mutex;
266 struct tty_ldisc *ldisc;
267
Arjan van de Ven5785c952006-09-29 02:00:43 -0700268 struct mutex termios_mutex;
Alan Cox04f378b2008-04-30 00:53:29 -0700269 spinlock_t ctrl_lock;
Alan Cox47f86832008-04-30 00:53:30 -0700270 /* Termios values are protected by the termios mutex */
Alan Coxedc6afc2006-12-08 02:38:44 -0800271 struct ktermios *termios, *termios_locked;
Alan Cox1d65b4a2008-10-13 10:38:18 +0100272 struct termiox *termiox; /* May be NULL for unsupported */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 char name[64];
Alan Cox47f86832008-04-30 00:53:30 -0700274 struct pid *pgrp; /* Protected by ctrl lock */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800275 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 unsigned long flags;
277 int count;
Alan Cox47f86832008-04-30 00:53:30 -0700278 struct winsize winsize; /* termios mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
280 unsigned char low_latency:1, warned:1;
Alan Cox47f86832008-04-30 00:53:30 -0700281 unsigned char ctrl_status; /* ctrl_lock */
Alan Cox33f0f882006-01-09 20:54:13 -0800282 unsigned int receive_room; /* Bytes free for queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283
284 struct tty_struct *link;
285 struct fasync_struct *fasync;
Alan Cox47f86832008-04-30 00:53:30 -0700286 struct tty_bufhead buf; /* Locked internally */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 int alt_speed; /* For magic substitution of 38400 bps */
288 wait_queue_head_t write_wait;
289 wait_queue_head_t read_wait;
290 struct work_struct hangup_work;
291 void *disc_data;
292 void *driver_data;
293 struct list_head tty_files;
294
295#define N_TTY_BUF_SIZE 4096
Alan Cox6f670482008-07-16 21:53:41 +0100296
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 /*
298 * The following is data for the N_TTY line discipline. For
299 * historical reasons, this is included in the tty structure.
Alan Cox47f86832008-04-30 00:53:30 -0700300 * Mostly locked by the BKL.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 */
302 unsigned int column;
303 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
304 unsigned char closing:1;
Joe Petersona88a69c2009-01-02 13:40:53 +0000305 unsigned char echo_overrun:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 unsigned short minimum_to_wake;
307 unsigned long overrun_time;
308 int num_overrun;
309 unsigned long process_char_map[256/(8*sizeof(unsigned long))];
310 char *read_buf;
311 int read_head;
312 int read_tail;
313 int read_cnt;
314 unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
Joe Petersona88a69c2009-01-02 13:40:53 +0000315 unsigned char *echo_buf;
316 unsigned int echo_pos;
317 unsigned int echo_cnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 int canon_data;
319 unsigned long canon_head;
320 unsigned int canon_column;
Ingo Molnar70522e12006-03-23 03:00:31 -0800321 struct mutex atomic_read_lock;
322 struct mutex atomic_write_lock;
Joe Petersona88a69c2009-01-02 13:40:53 +0000323 struct mutex output_lock;
324 struct mutex echo_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 unsigned char *write_buf;
326 int write_cnt;
327 spinlock_t read_lock;
328 /* If the tty has a pending do_SAK, queue it here - akpm */
329 struct work_struct SAK_work;
Alan Cox6f670482008-07-16 21:53:41 +0100330 struct tty_port *port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331};
332
Nick Piggind996b622010-08-18 04:37:36 +1000333/* Each of a tty's open files has private_data pointing to tty_file_private */
334struct tty_file_private {
335 struct tty_struct *tty;
336 struct file *file;
337 struct list_head list;
338};
339
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340/* tty magic number */
341#define TTY_MAGIC 0x5401
342
343/*
344 * These bits are used in the flags field of the tty structure.
Alan Cox7a4d29f2008-07-16 21:54:54 +0100345 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 * So that interrupts won't be able to mess up the queues,
347 * copy_to_cooked must be atomic with respect to itself, as must
348 * tty->write. Thus, you must use the inline functions set_bit() and
349 * clear_bit() to make things atomic.
350 */
351#define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
Alan Cox7a4d29f2008-07-16 21:54:54 +0100352#define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353#define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
354#define TTY_EXCLUSIVE 3 /* Exclusive open mode */
355#define TTY_DEBUG 4 /* Debugging */
356#define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
357#define TTY_PUSH 6 /* n_tty private */
358#define TTY_CLOSING 7 /* ->close() in progress */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359#define TTY_LDISC 9 /* Line discipline attached */
Alan Coxc9b39762009-01-02 13:44:56 +0000360#define TTY_LDISC_CHANGING 10 /* Line discipline changing */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100361#define TTY_LDISC_OPEN 11 /* Line discipline is open */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362#define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */
363#define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */
364#define TTY_PTY_LOCK 16 /* pty private */
365#define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
366#define TTY_HUPPED 18 /* Post driver->hangup() */
Alan Cox42fd5522007-08-10 13:01:05 -0700367#define TTY_FLUSHING 19 /* Flushing to ldisc in progress */
368#define TTY_FLUSHPENDING 20 /* Queued buffer flush pending */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
370#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
371
372extern void tty_write_flush(struct tty_struct *);
373
Alan Coxedc6afc2006-12-08 02:38:44 -0800374extern struct ktermios tty_std_termios;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376extern void console_init(void);
377extern int vcs_init(void);
378
Alan Coxd81ed102008-10-13 10:41:42 +0100379extern struct class *tty_class;
380
Alan Cox9c9f4de2008-10-13 10:37:26 +0100381/**
382 * tty_kref_get - get a tty reference
383 * @tty: tty device
384 *
385 * Return a new reference to a tty object. The caller must hold
386 * sufficient locks/counts to ensure that their existing reference cannot
387 * go away
388 */
389
Ingo Molnar14bfc982008-11-25 08:58:11 +0100390static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
Alan Cox9c9f4de2008-10-13 10:37:26 +0100391{
392 if (tty)
393 kref_get(&tty->kref);
394 return tty;
395}
396extern void tty_kref_put(struct tty_struct *tty);
397
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
399 const char *routine);
400extern char *tty_name(struct tty_struct *tty, char *buf);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100401extern void tty_wait_until_sent(struct tty_struct *tty, long timeout);
402extern int tty_check_change(struct tty_struct *tty);
403extern void stop_tty(struct tty_struct *tty);
404extern void start_tty(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405extern int tty_register_driver(struct tty_driver *driver);
406extern int tty_unregister_driver(struct tty_driver *driver);
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -0700407extern struct device *tty_register_device(struct tty_driver *driver,
408 unsigned index, struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
410extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
411 int buflen);
412extern void tty_write_message(struct tty_struct *tty, char *msg);
Alan Coxf34d7a52008-04-30 00:54:13 -0700413extern int tty_put_char(struct tty_struct *tty, unsigned char c);
414extern int tty_chars_in_buffer(struct tty_struct *tty);
415extern int tty_write_room(struct tty_struct *tty);
416extern void tty_driver_flush_buffer(struct tty_struct *tty);
Alan Cox39c2e602008-04-30 00:54:18 -0700417extern void tty_throttle(struct tty_struct *tty);
418extern void tty_unthrottle(struct tty_struct *tty);
Alan Coxfc6f6232009-01-02 13:43:17 +0000419extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
Alan Coxfeebed62008-10-13 10:41:30 +0100420extern void tty_shutdown(struct tty_struct *tty);
421extern void tty_free_termios(struct tty_struct *tty);
Eric W. Biederman3e7cd6c2007-02-12 00:52:58 -0800422extern int is_current_pgrp_orphaned(void);
Alan Cox5d0fdf12008-04-30 00:53:31 -0700423extern struct pid *tty_get_pgrp(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424extern int is_ignored(int sig);
425extern int tty_signal(int sig, struct tty_struct *tty);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100426extern void tty_hangup(struct tty_struct *tty);
427extern void tty_vhangup(struct tty_struct *tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200428extern void tty_vhangup_locked(struct tty_struct *tty);
Alan Cox2cb59982008-10-13 10:40:30 +0100429extern void tty_vhangup_self(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430extern void tty_unhangup(struct file *filp);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100431extern int tty_hung_up_p(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432extern void do_SAK(struct tty_struct *tty);
Eric W. Biederman8b6312f2007-02-10 01:44:34 -0800433extern void __do_SAK(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434extern void disassociate_ctty(int priv);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700435extern void no_tty(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436extern void tty_flip_buffer_push(struct tty_struct *tty);
OGAWA Hirofumie043e422009-07-29 12:15:56 -0700437extern void tty_flush_to_ldisc(struct tty_struct *tty);
Alan Coxe0495732008-10-13 10:36:58 +0100438extern void tty_buffer_free_all(struct tty_struct *tty);
439extern void tty_buffer_flush(struct tty_struct *tty);
440extern void tty_buffer_init(struct tty_struct *tty);
Alan Coxedc6afc2006-12-08 02:38:44 -0800441extern speed_t tty_get_baud_rate(struct tty_struct *tty);
442extern speed_t tty_termios_baud_rate(struct ktermios *termios);
443extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100444extern void tty_termios_encode_baud_rate(struct ktermios *termios,
445 speed_t ibaud, speed_t obaud);
446extern void tty_encode_baud_rate(struct tty_struct *tty,
447 speed_t ibaud, speed_t obaud);
Alan Cox5f519d72007-10-16 23:30:07 -0700448extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
Alan Coxbf5e5832008-01-08 14:55:51 +0000449extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
451extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
452extern void tty_ldisc_deref(struct tty_ldisc *);
453extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100454extern void tty_ldisc_hangup(struct tty_struct *tty);
Alan Coxa352def2008-07-16 21:53:12 +0100455extern const struct file_operations tty_ldiscs_proc_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
457extern void tty_wakeup(struct tty_struct *tty);
458extern void tty_ldisc_flush(struct tty_struct *tty);
459
Alan Cox04f378b2008-04-30 00:53:29 -0700460extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Alan Cox0fc00e22007-11-07 01:24:56 -0800461extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
462 unsigned int cmd, unsigned long arg);
463extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800464extern dev_t tty_devnum(struct tty_struct *tty);
465extern void proc_clear_tty(struct task_struct *p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800466extern struct tty_struct *get_current_tty(void);
Alan Coxd81ed102008-10-13 10:41:42 +0100467extern void tty_default_fops(struct file_operations *fops);
Alan Coxbf970ee2008-10-13 10:42:39 +0100468extern struct tty_struct *alloc_tty_struct(void);
Nick Piggind996b622010-08-18 04:37:36 +1000469extern void tty_add_file(struct tty_struct *tty, struct file *file);
Alan Coxbf970ee2008-10-13 10:42:39 +0100470extern void free_tty_struct(struct tty_struct *tty);
471extern void initialize_tty_struct(struct tty_struct *tty,
472 struct tty_driver *driver, int idx);
Alan Cox73ec06f2008-10-13 10:42:29 +0100473extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx,
474 int first_ok);
Alan Coxeeb89d92009-11-30 13:18:29 +0000475extern int tty_release(struct inode *inode, struct file *filp);
Alan Coxbf970ee2008-10-13 10:42:39 +0100476extern int tty_init_termios(struct tty_struct *tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800477
Alan Coxe8b70e72009-06-11 12:48:02 +0100478extern struct tty_struct *tty_pair_get_tty(struct tty_struct *tty);
479extern struct tty_struct *tty_pair_get_pty(struct tty_struct *tty);
480
Ingo Molnar70522e12006-03-23 03:00:31 -0800481extern struct mutex tty_mutex;
Nick Pigginee2ffa02010-08-18 04:37:35 +1000482extern spinlock_t tty_files_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
Alan Cox9c1729d2007-07-15 23:39:43 -0700484extern void tty_write_unlock(struct tty_struct *tty);
485extern int tty_write_lock(struct tty_struct *tty, int ndelay);
486#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
487
Alan Cox6f670482008-07-16 21:53:41 +0100488extern void tty_port_init(struct tty_port *port);
489extern int tty_port_alloc_xmit_buf(struct tty_port *port);
490extern void tty_port_free_xmit_buf(struct tty_port *port);
Alan Cox568aafc2009-11-30 13:17:14 +0000491extern void tty_port_put(struct tty_port *port);
492
Randy Dunlap2427b8e2010-01-15 17:01:11 -0800493static inline struct tty_port *tty_port_get(struct tty_port *port)
Alan Cox568aafc2009-11-30 13:17:14 +0000494{
495 if (port)
496 kref_get(&port->kref);
497 return port;
498}
499
Alan Cox4a90f092008-10-13 10:39:46 +0100500extern struct tty_struct *tty_port_tty_get(struct tty_port *port);
501extern void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty);
Alan Cox31f35932009-01-02 13:45:05 +0000502extern int tty_port_carrier_raised(struct tty_port *port);
Alan Cox5d951fb2009-01-02 13:45:19 +0000503extern void tty_port_raise_dtr_rts(struct tty_port *port);
Alan Coxfcc8ac12009-06-11 12:24:17 +0100504extern void tty_port_lower_dtr_rts(struct tty_port *port);
Alan Cox3e616962009-01-02 13:45:26 +0000505extern void tty_port_hangup(struct tty_port *port);
Alan Cox36c621d2009-01-02 13:46:10 +0000506extern int tty_port_block_til_ready(struct tty_port *port,
507 struct tty_struct *tty, struct file *filp);
Alan Coxa6614992009-01-02 13:46:50 +0000508extern int tty_port_close_start(struct tty_port *port,
509 struct tty_struct *tty, struct file *filp);
510extern void tty_port_close_end(struct tty_port *port, struct tty_struct *tty);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700511extern void tty_port_close(struct tty_port *port,
512 struct tty_struct *tty, struct file *filp);
Alan Cox64bc3972009-10-06 16:06:11 +0100513extern int tty_port_open(struct tty_port *port,
514 struct tty_struct *tty, struct file *filp);
Randy Dunlap2427b8e2010-01-15 17:01:11 -0800515static inline int tty_port_users(struct tty_port *port)
Alan Coxb58d13a2009-09-19 13:13:32 -0700516{
517 return port->count + port->blocked_open;
518}
519
Alan Cox01e1abb2008-07-22 11:16:55 +0100520extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
521extern int tty_unregister_ldisc(int disc);
522extern int tty_set_ldisc(struct tty_struct *tty, int ldisc);
523extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty);
524extern void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty);
525extern void tty_ldisc_init(struct tty_struct *tty);
526extern void tty_ldisc_begin(void);
527/* This last one is just for the tty layer internals and shouldn't be used elsewhere */
528extern void tty_ldisc_enable(struct tty_struct *tty);
Alan Cox9c1729d2007-07-15 23:39:43 -0700529
530
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531/* n_tty.c */
Alan Coxa352def2008-07-16 21:53:12 +0100532extern struct tty_ldisc_ops tty_ldisc_N_TTY;
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -0800533extern void n_tty_inherit_ops(struct tty_ldisc_ops *ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
Miloslav Trmac522ed772007-07-15 23:40:56 -0700535/* tty_audit.c */
536#ifdef CONFIG_AUDIT
537extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data,
538 size_t size);
539extern void tty_audit_exit(void);
540extern void tty_audit_fork(struct signal_struct *sig);
Al Viro1e641742008-12-09 09:23:33 +0000541extern void tty_audit_tiocsti(struct tty_struct *tty, char ch);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700542extern void tty_audit_push(struct tty_struct *tty);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100543extern void tty_audit_push_task(struct task_struct *tsk,
544 uid_t loginuid, u32 sessionid);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700545#else
546static inline void tty_audit_add_data(struct tty_struct *tty,
547 unsigned char *data, size_t size)
548{
549}
Al Viro1e641742008-12-09 09:23:33 +0000550static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch)
551{
552}
Miloslav Trmac522ed772007-07-15 23:40:56 -0700553static inline void tty_audit_exit(void)
554{
555}
556static inline void tty_audit_fork(struct signal_struct *sig)
557{
558}
559static inline void tty_audit_push(struct tty_struct *tty)
560{
561}
Alan Cox7a4d29f2008-07-16 21:54:54 +0100562static inline void tty_audit_push_task(struct task_struct *tsk,
563 uid_t loginuid, u32 sessionid)
Miloslav Trmac522ed772007-07-15 23:40:56 -0700564{
565}
Miloslav Trmac522ed772007-07-15 23:40:56 -0700566#endif
567
David Howells31d1d482010-08-06 16:34:43 +0100568/* tty_io.c */
569extern int __init tty_init(void);
570
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571/* tty_ioctl.c */
Alan Cox47afa7a2008-10-13 10:44:17 +0100572extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 unsigned int cmd, unsigned long arg);
574
575/* serial.c */
576
577extern void serial_console_init(void);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100578
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579/* pcxx.c */
580
581extern int pcxe_open(struct tty_struct *tty, struct file *filp);
582
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583/* vt.c */
584
Alan Cox7a4d29f2008-07-16 21:54:54 +0100585extern int vt_ioctl(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 unsigned int cmd, unsigned long arg);
587
Arnd Bergmanne9216652009-08-06 15:09:28 +0200588extern long vt_compat_ioctl(struct tty_struct *tty, struct file * file,
589 unsigned int cmd, unsigned long arg);
590
Arnd Bergmannb07471f2010-08-06 21:40:30 +0200591/* tty_mutex.c */
Arnd Bergmannec79d602010-06-01 22:53:01 +0200592/* functions for preparation of BKL removal */
Arnd Bergmannb07471f2010-08-06 21:40:30 +0200593extern void __lockfunc tty_lock(void) __acquires(tty_lock);
594extern void __lockfunc tty_unlock(void) __releases(tty_lock);
595extern struct task_struct *__big_tty_mutex_owner;
596#define tty_locked() (current == __big_tty_mutex_owner)
Arnd Bergmannec79d602010-06-01 22:53:01 +0200597
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200598/*
599 * wait_event_interruptible_tty -- wait for a condition with the tty lock held
600 *
601 * The condition we are waiting for might take a long time to
602 * become true, or might depend on another thread taking the
603 * BTM. In either case, we need to drop the BTM to guarantee
604 * forward progress. This is a leftover from the conversion
605 * from the BKL and should eventually get removed as the BTM
606 * falls out of use.
607 *
608 * Do not use in new code.
609 */
610#define wait_event_interruptible_tty(wq, condition) \
611({ \
612 int __ret = 0; \
613 if (!(condition)) { \
614 __wait_event_interruptible_tty(wq, condition, __ret); \
615 } \
616 __ret; \
617})
618
619#define __wait_event_interruptible_tty(wq, condition, ret) \
620do { \
621 DEFINE_WAIT(__wait); \
622 \
623 for (;;) { \
624 prepare_to_wait(&wq, &__wait, TASK_INTERRUPTIBLE); \
625 if (condition) \
626 break; \
627 if (!signal_pending(current)) { \
628 tty_unlock(); \
629 schedule(); \
630 tty_lock(); \
631 continue; \
632 } \
633 ret = -ERESTARTSYS; \
634 break; \
635 } \
636 finish_wait(&wq, &__wait); \
637} while (0)
638
639
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640#endif /* __KERNEL__ */
641#endif