blob: 2a754748dd5f3ea049ee293acf8d548aea927da9 [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 */
Pavan Savoy40fb29a72010-09-30 16:13:28 -040053#define N_TI_WL 22 /* for TI's WL BT, FM, GPS combo chips */
Janusz Krzysztofik78ed73e2009-07-22 05:22:37 +020054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 * This character is the same as _POSIX_VDISABLE: it cannot be used as
57 * a c_cc[] character, but indicates that a particular special character
58 * isn't in use (eg VINTR has no character etc)
59 */
60#define __DISABLED_CHAR '\0'
61
Alan Cox33f0f882006-01-09 20:54:13 -080062struct tty_buffer {
63 struct tty_buffer *next;
64 char *char_buf_ptr;
65 unsigned char *flag_buf_ptr;
66 int used;
67 int size;
Paul Fulghum8977d922006-02-10 01:51:14 -080068 int commit;
69 int read;
Alan Cox33f0f882006-01-09 20:54:13 -080070 /* Data points here */
71 unsigned long data[0];
72};
73
Alan Coxd9661ad2010-02-18 16:43:47 +000074/*
75 * We default to dicing tty buffer allocations to this many characters
Mel Gorman352fa6a2010-03-02 22:24:19 +000076 * in order to avoid multiple page allocations. We know the size of
77 * tty_buffer itself but it must also be taken into account that the
78 * the buffer is 256 byte aligned. See tty_buffer_find for the allocation
79 * logic this must match
Alan Coxd9661ad2010-02-18 16:43:47 +000080 */
81
Mel Gorman352fa6a2010-03-02 22:24:19 +000082#define TTY_BUFFER_PAGE (((PAGE_SIZE - sizeof(struct tty_buffer)) / 2) & ~0xFF)
Alan Coxd9661ad2010-02-18 16:43:47 +000083
84
Alan Cox33f0f882006-01-09 20:54:13 -080085struct tty_bufhead {
David Howells52bad642006-11-22 14:54:01 +000086 struct delayed_work work;
Paul Fulghum808249c2006-02-03 03:04:41 -080087 spinlock_t lock;
Alan Cox33f0f882006-01-09 20:54:13 -080088 struct tty_buffer *head; /* Queue head */
89 struct tty_buffer *tail; /* Active buffer */
90 struct tty_buffer *free; /* Free queue head */
Alan Cox7a4d29f2008-07-16 21:54:54 +010091 int memory_used; /* Buffer space used excluding
92 free queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -070093};
94/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 * When a break, frame error, or parity error happens, these codes are
96 * stuffed into the flags buffer.
97 */
98#define TTY_NORMAL 0
99#define TTY_BREAK 1
100#define TTY_FRAME 2
101#define TTY_PARITY 3
102#define TTY_OVERRUN 4
103
104#define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
105#define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
106#define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
107#define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
108#define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
109#define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
110#define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
111#define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
112#define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
113#define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
114#define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
115#define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
116#define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
117#define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
118#define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
119#define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
120#define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
121
Alan Cox7a4d29f2008-07-16 21:54:54 +0100122#define _I_FLAG(tty, f) ((tty)->termios->c_iflag & (f))
123#define _O_FLAG(tty, f) ((tty)->termios->c_oflag & (f))
124#define _C_FLAG(tty, f) ((tty)->termios->c_cflag & (f))
125#define _L_FLAG(tty, f) ((tty)->termios->c_lflag & (f))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Alan Cox7a4d29f2008-07-16 21:54:54 +0100127#define I_IGNBRK(tty) _I_FLAG((tty), IGNBRK)
128#define I_BRKINT(tty) _I_FLAG((tty), BRKINT)
129#define I_IGNPAR(tty) _I_FLAG((tty), IGNPAR)
130#define I_PARMRK(tty) _I_FLAG((tty), PARMRK)
131#define I_INPCK(tty) _I_FLAG((tty), INPCK)
132#define I_ISTRIP(tty) _I_FLAG((tty), ISTRIP)
133#define I_INLCR(tty) _I_FLAG((tty), INLCR)
134#define I_IGNCR(tty) _I_FLAG((tty), IGNCR)
135#define I_ICRNL(tty) _I_FLAG((tty), ICRNL)
136#define I_IUCLC(tty) _I_FLAG((tty), IUCLC)
137#define I_IXON(tty) _I_FLAG((tty), IXON)
138#define I_IXANY(tty) _I_FLAG((tty), IXANY)
139#define I_IXOFF(tty) _I_FLAG((tty), IXOFF)
140#define I_IMAXBEL(tty) _I_FLAG((tty), IMAXBEL)
141#define I_IUTF8(tty) _I_FLAG((tty), IUTF8)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
Alan Cox7a4d29f2008-07-16 21:54:54 +0100143#define O_OPOST(tty) _O_FLAG((tty), OPOST)
144#define O_OLCUC(tty) _O_FLAG((tty), OLCUC)
145#define O_ONLCR(tty) _O_FLAG((tty), ONLCR)
146#define O_OCRNL(tty) _O_FLAG((tty), OCRNL)
147#define O_ONOCR(tty) _O_FLAG((tty), ONOCR)
148#define O_ONLRET(tty) _O_FLAG((tty), ONLRET)
149#define O_OFILL(tty) _O_FLAG((tty), OFILL)
150#define O_OFDEL(tty) _O_FLAG((tty), OFDEL)
151#define O_NLDLY(tty) _O_FLAG((tty), NLDLY)
152#define O_CRDLY(tty) _O_FLAG((tty), CRDLY)
153#define O_TABDLY(tty) _O_FLAG((tty), TABDLY)
154#define O_BSDLY(tty) _O_FLAG((tty), BSDLY)
155#define O_VTDLY(tty) _O_FLAG((tty), VTDLY)
156#define O_FFDLY(tty) _O_FLAG((tty), FFDLY)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
Alan Cox7a4d29f2008-07-16 21:54:54 +0100158#define C_BAUD(tty) _C_FLAG((tty), CBAUD)
159#define C_CSIZE(tty) _C_FLAG((tty), CSIZE)
160#define C_CSTOPB(tty) _C_FLAG((tty), CSTOPB)
161#define C_CREAD(tty) _C_FLAG((tty), CREAD)
162#define C_PARENB(tty) _C_FLAG((tty), PARENB)
163#define C_PARODD(tty) _C_FLAG((tty), PARODD)
164#define C_HUPCL(tty) _C_FLAG((tty), HUPCL)
165#define C_CLOCAL(tty) _C_FLAG((tty), CLOCAL)
166#define C_CIBAUD(tty) _C_FLAG((tty), CIBAUD)
167#define C_CRTSCTS(tty) _C_FLAG((tty), CRTSCTS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
Alan Cox7a4d29f2008-07-16 21:54:54 +0100169#define L_ISIG(tty) _L_FLAG((tty), ISIG)
170#define L_ICANON(tty) _L_FLAG((tty), ICANON)
171#define L_XCASE(tty) _L_FLAG((tty), XCASE)
172#define L_ECHO(tty) _L_FLAG((tty), ECHO)
173#define L_ECHOE(tty) _L_FLAG((tty), ECHOE)
174#define L_ECHOK(tty) _L_FLAG((tty), ECHOK)
175#define L_ECHONL(tty) _L_FLAG((tty), ECHONL)
176#define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH)
177#define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP)
178#define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL)
179#define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT)
180#define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE)
181#define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO)
182#define L_PENDIN(tty) _L_FLAG((tty), PENDIN)
183#define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN)
hyc@symas.com26df6d12010-06-22 10:14:49 -0700184#define L_EXTPROC(tty) _L_FLAG((tty), EXTPROC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186struct device;
Miloslav Trmac522ed772007-07-15 23:40:56 -0700187struct signal_struct;
Alan Cox6f670482008-07-16 21:53:41 +0100188
189/*
190 * Port level information. Each device keeps its own port level information
191 * so provide a common structure for those ports wanting to use common support
192 * routines.
193 *
194 * The tty port has a different lifetime to the tty so must be kept apart.
195 * In addition be careful as tty -> port mappings are valid for the life
196 * of the tty object but in many cases port -> tty mappings are valid only
197 * until a hangup so don't use the wrong path.
198 */
Alan Cox7a4d29f2008-07-16 21:54:54 +0100199
Alan Cox31f35932009-01-02 13:45:05 +0000200struct tty_port;
201
202struct tty_port_operations {
203 /* Return 1 if the carrier is raised */
204 int (*carrier_raised)(struct tty_port *port);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700205 /* Control the DTR line */
Alan Coxfcc8ac12009-06-11 12:24:17 +0100206 void (*dtr_rts)(struct tty_port *port, int raise);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700207 /* Called when the last close completes or a hangup finishes
Alan Cox64bc3972009-10-06 16:06:11 +0100208 IFF the port was initialized. Do not use to free resources. Called
209 under the port mutex to serialize against activate/shutdowns */
Alan Cox7ca0ff92009-09-19 13:13:20 -0700210 void (*shutdown)(struct tty_port *port);
211 void (*drop)(struct tty_port *port);
Alan Cox64bc3972009-10-06 16:06:11 +0100212 /* Called under the port mutex from tty_port_open, serialized using
213 the port mutex */
214 /* FIXME: long term getting the tty argument *out* of this would be
215 good for consoles */
216 int (*activate)(struct tty_port *port, struct tty_struct *tty);
Alan Cox568aafc2009-11-30 13:17:14 +0000217 /* Called on the final put of a port */
218 void (*destruct)(struct tty_port *port);
Alan Cox31f35932009-01-02 13:45:05 +0000219};
220
Alan Cox6f670482008-07-16 21:53:41 +0100221struct tty_port {
222 struct tty_struct *tty; /* Back pointer */
Alan Cox31f35932009-01-02 13:45:05 +0000223 const struct tty_port_operations *ops; /* Port operations */
Alan Cox4a90f092008-10-13 10:39:46 +0100224 spinlock_t lock; /* Lock protecting tty field */
Alan Cox6f670482008-07-16 21:53:41 +0100225 int blocked_open; /* Waiting to open */
226 int count; /* Usage count */
227 wait_queue_head_t open_wait; /* Open waiters */
228 wait_queue_head_t close_wait; /* Close waiters */
Alan Coxbdc04e32009-09-19 13:13:31 -0700229 wait_queue_head_t delta_msr_wait; /* Modem status change */
Alan Cox6f670482008-07-16 21:53:41 +0100230 unsigned long flags; /* TTY flags ASY_*/
Jason Wessel336cee42010-03-08 21:50:11 -0600231 unsigned char console:1; /* port is a console */
Alan Cox6f670482008-07-16 21:53:41 +0100232 struct mutex mutex; /* Locking */
Alan Cox44e49092009-11-30 13:16:41 +0000233 struct mutex buf_mutex; /* Buffer alloc lock */
Alan Cox6f670482008-07-16 21:53:41 +0100234 unsigned char *xmit_buf; /* Optional buffer */
Alan Cox5e99df52009-09-19 13:13:28 -0700235 unsigned int close_delay; /* Close port delay */
236 unsigned int closing_wait; /* Delay for output */
Alan Cox1ec739b2009-06-11 12:25:25 +0100237 int drain_delay; /* Set to zero if no pure time
238 based drain is needed else
239 set to size of fifo */
Alan Cox568aafc2009-11-30 13:17:14 +0000240 struct kref kref; /* Ref counter */
Alan Cox6f670482008-07-16 21:53:41 +0100241};
242
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243/*
244 * Where all of the state associated with a tty is kept while the tty
245 * is open. Since the termios state should be kept even if the tty
246 * has been closed --- for things like the baud rate, etc --- it is
247 * not stored here, but rather a pointer to the real state is stored
248 * here. Possible the winsize structure should have the same
249 * treatment, but (1) the default 80x24 is usually right and (2) it's
250 * most often used by a windowing system, which will set the correct
251 * size each time the window is created or resized anyway.
252 * - TYT, 9/14/92
253 */
Alan Coxf34d7a52008-04-30 00:54:13 -0700254
255struct tty_operations;
256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257struct tty_struct {
258 int magic;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100259 struct kref kref;
Dmitry Eremin-Solenikov30004ac2010-08-09 18:22:49 +0400260 struct device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 struct tty_driver *driver;
Alan Coxf34d7a52008-04-30 00:54:13 -0700262 const struct tty_operations *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 int index;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100264
265 /* Protects ldisc changes: Lock tty not pty */
266 struct mutex ldisc_mutex;
267 struct tty_ldisc *ldisc;
268
Arjan van de Ven5785c952006-09-29 02:00:43 -0700269 struct mutex termios_mutex;
Alan Cox04f378b2008-04-30 00:53:29 -0700270 spinlock_t ctrl_lock;
Alan Cox47f86832008-04-30 00:53:30 -0700271 /* Termios values are protected by the termios mutex */
Alan Coxedc6afc2006-12-08 02:38:44 -0800272 struct ktermios *termios, *termios_locked;
Alan Cox1d65b4a2008-10-13 10:38:18 +0100273 struct termiox *termiox; /* May be NULL for unsupported */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 char name[64];
Alan Cox47f86832008-04-30 00:53:30 -0700275 struct pid *pgrp; /* Protected by ctrl lock */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800276 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 unsigned long flags;
278 int count;
Alan Cox47f86832008-04-30 00:53:30 -0700279 struct winsize winsize; /* termios mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
281 unsigned char low_latency:1, warned:1;
Alan Cox47f86832008-04-30 00:53:30 -0700282 unsigned char ctrl_status; /* ctrl_lock */
Alan Cox33f0f882006-01-09 20:54:13 -0800283 unsigned int receive_room; /* Bytes free for queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
285 struct tty_struct *link;
286 struct fasync_struct *fasync;
Alan Cox47f86832008-04-30 00:53:30 -0700287 struct tty_bufhead buf; /* Locked internally */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 int alt_speed; /* For magic substitution of 38400 bps */
289 wait_queue_head_t write_wait;
290 wait_queue_head_t read_wait;
291 struct work_struct hangup_work;
292 void *disc_data;
293 void *driver_data;
294 struct list_head tty_files;
295
296#define N_TTY_BUF_SIZE 4096
Alan Cox6f670482008-07-16 21:53:41 +0100297
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 /*
299 * The following is data for the N_TTY line discipline. For
300 * historical reasons, this is included in the tty structure.
Alan Cox47f86832008-04-30 00:53:30 -0700301 * Mostly locked by the BKL.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 */
303 unsigned int column;
304 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
305 unsigned char closing:1;
Joe Petersona88a69c2009-01-02 13:40:53 +0000306 unsigned char echo_overrun:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 unsigned short minimum_to_wake;
308 unsigned long overrun_time;
309 int num_overrun;
310 unsigned long process_char_map[256/(8*sizeof(unsigned long))];
311 char *read_buf;
312 int read_head;
313 int read_tail;
314 int read_cnt;
315 unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
Joe Petersona88a69c2009-01-02 13:40:53 +0000316 unsigned char *echo_buf;
317 unsigned int echo_pos;
318 unsigned int echo_cnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 int canon_data;
320 unsigned long canon_head;
321 unsigned int canon_column;
Ingo Molnar70522e12006-03-23 03:00:31 -0800322 struct mutex atomic_read_lock;
323 struct mutex atomic_write_lock;
Joe Petersona88a69c2009-01-02 13:40:53 +0000324 struct mutex output_lock;
325 struct mutex echo_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 unsigned char *write_buf;
327 int write_cnt;
328 spinlock_t read_lock;
329 /* If the tty has a pending do_SAK, queue it here - akpm */
330 struct work_struct SAK_work;
Alan Cox6f670482008-07-16 21:53:41 +0100331 struct tty_port *port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332};
333
Nick Piggind996b622010-08-18 04:37:36 +1000334/* Each of a tty's open files has private_data pointing to tty_file_private */
335struct tty_file_private {
336 struct tty_struct *tty;
337 struct file *file;
338 struct list_head list;
339};
340
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341/* tty magic number */
342#define TTY_MAGIC 0x5401
343
344/*
345 * These bits are used in the flags field of the tty structure.
Alan Cox7a4d29f2008-07-16 21:54:54 +0100346 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 * So that interrupts won't be able to mess up the queues,
348 * copy_to_cooked must be atomic with respect to itself, as must
349 * tty->write. Thus, you must use the inline functions set_bit() and
350 * clear_bit() to make things atomic.
351 */
352#define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
Alan Cox7a4d29f2008-07-16 21:54:54 +0100353#define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354#define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
355#define TTY_EXCLUSIVE 3 /* Exclusive open mode */
356#define TTY_DEBUG 4 /* Debugging */
357#define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
358#define TTY_PUSH 6 /* n_tty private */
359#define TTY_CLOSING 7 /* ->close() in progress */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360#define TTY_LDISC 9 /* Line discipline attached */
Alan Coxc9b39762009-01-02 13:44:56 +0000361#define TTY_LDISC_CHANGING 10 /* Line discipline changing */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100362#define TTY_LDISC_OPEN 11 /* Line discipline is open */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363#define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */
364#define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */
365#define TTY_PTY_LOCK 16 /* pty private */
366#define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
367#define TTY_HUPPED 18 /* Post driver->hangup() */
Alan Cox42fd5522007-08-10 13:01:05 -0700368#define TTY_FLUSHING 19 /* Flushing to ldisc in progress */
369#define TTY_FLUSHPENDING 20 /* Queued buffer flush pending */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
371#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
372
373extern void tty_write_flush(struct tty_struct *);
374
Alan Coxedc6afc2006-12-08 02:38:44 -0800375extern struct ktermios tty_std_termios;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377extern void console_init(void);
378extern int vcs_init(void);
379
Alan Coxd81ed102008-10-13 10:41:42 +0100380extern struct class *tty_class;
381
Alan Cox9c9f4de2008-10-13 10:37:26 +0100382/**
383 * tty_kref_get - get a tty reference
384 * @tty: tty device
385 *
386 * Return a new reference to a tty object. The caller must hold
387 * sufficient locks/counts to ensure that their existing reference cannot
388 * go away
389 */
390
Ingo Molnar14bfc982008-11-25 08:58:11 +0100391static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
Alan Cox9c9f4de2008-10-13 10:37:26 +0100392{
393 if (tty)
394 kref_get(&tty->kref);
395 return tty;
396}
397extern void tty_kref_put(struct tty_struct *tty);
398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
400 const char *routine);
401extern char *tty_name(struct tty_struct *tty, char *buf);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100402extern void tty_wait_until_sent(struct tty_struct *tty, long timeout);
403extern int tty_check_change(struct tty_struct *tty);
404extern void stop_tty(struct tty_struct *tty);
405extern void start_tty(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406extern int tty_register_driver(struct tty_driver *driver);
407extern int tty_unregister_driver(struct tty_driver *driver);
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -0700408extern struct device *tty_register_device(struct tty_driver *driver,
409 unsigned index, struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
411extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
412 int buflen);
413extern void tty_write_message(struct tty_struct *tty, char *msg);
Alan Coxf34d7a52008-04-30 00:54:13 -0700414extern int tty_put_char(struct tty_struct *tty, unsigned char c);
415extern int tty_chars_in_buffer(struct tty_struct *tty);
416extern int tty_write_room(struct tty_struct *tty);
417extern void tty_driver_flush_buffer(struct tty_struct *tty);
Alan Cox39c2e602008-04-30 00:54:18 -0700418extern void tty_throttle(struct tty_struct *tty);
419extern void tty_unthrottle(struct tty_struct *tty);
Alan Coxfc6f6232009-01-02 13:43:17 +0000420extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
Alan Coxfeebed62008-10-13 10:41:30 +0100421extern void tty_shutdown(struct tty_struct *tty);
422extern void tty_free_termios(struct tty_struct *tty);
Eric W. Biederman3e7cd6c2007-02-12 00:52:58 -0800423extern int is_current_pgrp_orphaned(void);
Alan Cox5d0fdf12008-04-30 00:53:31 -0700424extern struct pid *tty_get_pgrp(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425extern int is_ignored(int sig);
426extern int tty_signal(int sig, struct tty_struct *tty);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100427extern void tty_hangup(struct tty_struct *tty);
428extern void tty_vhangup(struct tty_struct *tty);
Arnd Bergmannddcd9fb2010-06-01 22:53:08 +0200429extern void tty_vhangup_locked(struct tty_struct *tty);
Alan Cox2cb59982008-10-13 10:40:30 +0100430extern void tty_vhangup_self(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431extern void tty_unhangup(struct file *filp);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100432extern int tty_hung_up_p(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433extern void do_SAK(struct tty_struct *tty);
Eric W. Biederman8b6312f2007-02-10 01:44:34 -0800434extern void __do_SAK(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435extern void disassociate_ctty(int priv);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700436extern void no_tty(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437extern void tty_flip_buffer_push(struct tty_struct *tty);
OGAWA Hirofumie043e422009-07-29 12:15:56 -0700438extern void tty_flush_to_ldisc(struct tty_struct *tty);
Alan Coxe0495732008-10-13 10:36:58 +0100439extern void tty_buffer_free_all(struct tty_struct *tty);
440extern void tty_buffer_flush(struct tty_struct *tty);
441extern void tty_buffer_init(struct tty_struct *tty);
Alan Coxedc6afc2006-12-08 02:38:44 -0800442extern speed_t tty_get_baud_rate(struct tty_struct *tty);
443extern speed_t tty_termios_baud_rate(struct ktermios *termios);
444extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100445extern void tty_termios_encode_baud_rate(struct ktermios *termios,
446 speed_t ibaud, speed_t obaud);
447extern void tty_encode_baud_rate(struct tty_struct *tty,
448 speed_t ibaud, speed_t obaud);
Alan Cox5f519d72007-10-16 23:30:07 -0700449extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
Alan Coxbf5e5832008-01-08 14:55:51 +0000450extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
452extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
453extern void tty_ldisc_deref(struct tty_ldisc *);
454extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100455extern void tty_ldisc_hangup(struct tty_struct *tty);
Alan Coxa352def2008-07-16 21:53:12 +0100456extern const struct file_operations tty_ldiscs_proc_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
458extern void tty_wakeup(struct tty_struct *tty);
459extern void tty_ldisc_flush(struct tty_struct *tty);
460
Alan Cox04f378b2008-04-30 00:53:29 -0700461extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Alan Cox0fc00e22007-11-07 01:24:56 -0800462extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
463 unsigned int cmd, unsigned long arg);
464extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800465extern dev_t tty_devnum(struct tty_struct *tty);
466extern void proc_clear_tty(struct task_struct *p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800467extern struct tty_struct *get_current_tty(void);
Alan Coxd81ed102008-10-13 10:41:42 +0100468extern void tty_default_fops(struct file_operations *fops);
Alan Coxbf970ee2008-10-13 10:42:39 +0100469extern struct tty_struct *alloc_tty_struct(void);
Pekka Enbergf573bd12010-08-24 07:48:34 +0300470extern int tty_add_file(struct tty_struct *tty, struct file *file);
Alan Coxbf970ee2008-10-13 10:42:39 +0100471extern void free_tty_struct(struct tty_struct *tty);
472extern void initialize_tty_struct(struct tty_struct *tty,
473 struct tty_driver *driver, int idx);
Alan Cox73ec06f2008-10-13 10:42:29 +0100474extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx,
475 int first_ok);
Alan Coxeeb89d92009-11-30 13:18:29 +0000476extern int tty_release(struct inode *inode, struct file *filp);
Alan Coxbf970ee2008-10-13 10:42:39 +0100477extern int tty_init_termios(struct tty_struct *tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800478
Alan Coxe8b70e72009-06-11 12:48:02 +0100479extern struct tty_struct *tty_pair_get_tty(struct tty_struct *tty);
480extern struct tty_struct *tty_pair_get_pty(struct tty_struct *tty);
481
Ingo Molnar70522e12006-03-23 03:00:31 -0800482extern struct mutex tty_mutex;
Nick Pigginee2ffa02010-08-18 04:37:35 +1000483extern spinlock_t tty_files_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484
Alan Cox9c1729d2007-07-15 23:39:43 -0700485extern void tty_write_unlock(struct tty_struct *tty);
486extern int tty_write_lock(struct tty_struct *tty, int ndelay);
487#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
488
Alan Cox6f670482008-07-16 21:53:41 +0100489extern void tty_port_init(struct tty_port *port);
490extern int tty_port_alloc_xmit_buf(struct tty_port *port);
491extern void tty_port_free_xmit_buf(struct tty_port *port);
Alan Cox568aafc2009-11-30 13:17:14 +0000492extern void tty_port_put(struct tty_port *port);
493
Randy Dunlap2427b8e2010-01-15 17:01:11 -0800494static inline struct tty_port *tty_port_get(struct tty_port *port)
Alan Cox568aafc2009-11-30 13:17:14 +0000495{
496 if (port)
497 kref_get(&port->kref);
498 return port;
499}
500
Alan Cox4a90f092008-10-13 10:39:46 +0100501extern struct tty_struct *tty_port_tty_get(struct tty_port *port);
502extern void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty);
Alan Cox31f35932009-01-02 13:45:05 +0000503extern int tty_port_carrier_raised(struct tty_port *port);
Alan Cox5d951fb2009-01-02 13:45:19 +0000504extern void tty_port_raise_dtr_rts(struct tty_port *port);
Alan Coxfcc8ac12009-06-11 12:24:17 +0100505extern void tty_port_lower_dtr_rts(struct tty_port *port);
Alan Cox3e616962009-01-02 13:45:26 +0000506extern void tty_port_hangup(struct tty_port *port);
Alan Cox36c621d2009-01-02 13:46:10 +0000507extern int tty_port_block_til_ready(struct tty_port *port,
508 struct tty_struct *tty, struct file *filp);
Alan Coxa6614992009-01-02 13:46:50 +0000509extern int tty_port_close_start(struct tty_port *port,
510 struct tty_struct *tty, struct file *filp);
511extern void tty_port_close_end(struct tty_port *port, struct tty_struct *tty);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700512extern void tty_port_close(struct tty_port *port,
513 struct tty_struct *tty, struct file *filp);
Alan Cox64bc3972009-10-06 16:06:11 +0100514extern int tty_port_open(struct tty_port *port,
515 struct tty_struct *tty, struct file *filp);
Randy Dunlap2427b8e2010-01-15 17:01:11 -0800516static inline int tty_port_users(struct tty_port *port)
Alan Coxb58d13a2009-09-19 13:13:32 -0700517{
518 return port->count + port->blocked_open;
519}
520
Alan Cox01e1abb2008-07-22 11:16:55 +0100521extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
522extern int tty_unregister_ldisc(int disc);
523extern int tty_set_ldisc(struct tty_struct *tty, int ldisc);
524extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty);
525extern void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty);
526extern void tty_ldisc_init(struct tty_struct *tty);
527extern void tty_ldisc_begin(void);
528/* This last one is just for the tty layer internals and shouldn't be used elsewhere */
529extern void tty_ldisc_enable(struct tty_struct *tty);
Alan Cox9c1729d2007-07-15 23:39:43 -0700530
531
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532/* n_tty.c */
Alan Coxa352def2008-07-16 21:53:12 +0100533extern struct tty_ldisc_ops tty_ldisc_N_TTY;
Rodolfo Giometti572b9ad2010-03-10 15:23:46 -0800534extern void n_tty_inherit_ops(struct tty_ldisc_ops *ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
Miloslav Trmac522ed772007-07-15 23:40:56 -0700536/* tty_audit.c */
537#ifdef CONFIG_AUDIT
538extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data,
539 size_t size);
540extern void tty_audit_exit(void);
541extern void tty_audit_fork(struct signal_struct *sig);
Al Viro1e641742008-12-09 09:23:33 +0000542extern void tty_audit_tiocsti(struct tty_struct *tty, char ch);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700543extern void tty_audit_push(struct tty_struct *tty);
Thomas Gleixner3c80fe42009-12-09 14:19:31 +0000544extern int tty_audit_push_task(struct task_struct *tsk,
545 uid_t loginuid, u32 sessionid);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700546#else
547static inline void tty_audit_add_data(struct tty_struct *tty,
548 unsigned char *data, size_t size)
549{
550}
Al Viro1e641742008-12-09 09:23:33 +0000551static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch)
552{
553}
Miloslav Trmac522ed772007-07-15 23:40:56 -0700554static inline void tty_audit_exit(void)
555{
556}
557static inline void tty_audit_fork(struct signal_struct *sig)
558{
559}
560static inline void tty_audit_push(struct tty_struct *tty)
561{
562}
Thomas Gleixner3c80fe42009-12-09 14:19:31 +0000563static inline int tty_audit_push_task(struct task_struct *tsk,
564 uid_t loginuid, u32 sessionid)
Miloslav Trmac522ed772007-07-15 23:40:56 -0700565{
Thomas Gleixner3c80fe42009-12-09 14:19:31 +0000566 return 0;
Miloslav Trmac522ed772007-07-15 23:40:56 -0700567}
Miloslav Trmac522ed772007-07-15 23:40:56 -0700568#endif
569
David Howells31d1d482010-08-06 16:34:43 +0100570/* tty_io.c */
571extern int __init tty_init(void);
572
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573/* tty_ioctl.c */
Alan Cox47afa7a2008-10-13 10:44:17 +0100574extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 unsigned int cmd, unsigned long arg);
576
577/* serial.c */
578
579extern void serial_console_init(void);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581/* pcxx.c */
582
583extern int pcxe_open(struct tty_struct *tty, struct file *filp);
584
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585/* vt.c */
586
Alan Cox7a4d29f2008-07-16 21:54:54 +0100587extern int vt_ioctl(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 unsigned int cmd, unsigned long arg);
589
Arnd Bergmanne9216652009-08-06 15:09:28 +0200590extern long vt_compat_ioctl(struct tty_struct *tty, struct file * file,
591 unsigned int cmd, unsigned long arg);
592
Arnd Bergmannb07471f2010-08-06 21:40:30 +0200593/* tty_mutex.c */
Arnd Bergmannec79d602010-06-01 22:53:01 +0200594/* functions for preparation of BKL removal */
Arnd Bergmannb07471f2010-08-06 21:40:30 +0200595extern void __lockfunc tty_lock(void) __acquires(tty_lock);
596extern void __lockfunc tty_unlock(void) __releases(tty_lock);
597extern struct task_struct *__big_tty_mutex_owner;
598#define tty_locked() (current == __big_tty_mutex_owner)
Arnd Bergmannec79d602010-06-01 22:53:01 +0200599
Arnd Bergmannbe1bc282010-06-01 22:53:05 +0200600/*
601 * wait_event_interruptible_tty -- wait for a condition with the tty lock held
602 *
603 * The condition we are waiting for might take a long time to
604 * become true, or might depend on another thread taking the
605 * BTM. In either case, we need to drop the BTM to guarantee
606 * forward progress. This is a leftover from the conversion
607 * from the BKL and should eventually get removed as the BTM
608 * falls out of use.
609 *
610 * Do not use in new code.
611 */
612#define wait_event_interruptible_tty(wq, condition) \
613({ \
614 int __ret = 0; \
615 if (!(condition)) { \
616 __wait_event_interruptible_tty(wq, condition, __ret); \
617 } \
618 __ret; \
619})
620
621#define __wait_event_interruptible_tty(wq, condition, ret) \
622do { \
623 DEFINE_WAIT(__wait); \
624 \
625 for (;;) { \
626 prepare_to_wait(&wq, &__wait, TASK_INTERRUPTIBLE); \
627 if (condition) \
628 break; \
629 if (!signal_pending(current)) { \
630 tty_unlock(); \
631 schedule(); \
632 tty_lock(); \
633 continue; \
634 } \
635 ret = -ERESTARTSYS; \
636 break; \
637 } \
638 finish_wait(&wq, &__wait); \
639} while (0)
640
641
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642#endif /* __KERNEL__ */
643#endif