blob: ef3a2947b1026a43dfebf0945132d0b1e1fc91c2 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
17#include <asm/system.h>
18
19
20/*
21 * (Note: the *_driver.minor_start values 1, 64, 128, 192 are
22 * hardcoded at present.)
23 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#define NR_UNIX98_PTY_DEFAULT 4096 /* Default maximum for Unix98 ptys */
25#define NR_UNIX98_PTY_MAX (1 << MINORBITS) /* Absolute limit */
Janusz Krzysztofik78ed73e2009-07-22 05:22:37 +020026#define NR_LDISCS 20
Tilman Schmidt4564f9e2007-02-10 01:45:00 -080027
28/* line disciplines */
29#define N_TTY 0
30#define N_SLIP 1
31#define N_MOUSE 2
32#define N_PPP 3
33#define N_STRIP 4
34#define N_AX25 5
35#define N_X25 6 /* X.25 async */
36#define N_6PACK 7
37#define N_MASC 8 /* Reserved for Mobitex module <kaz@cafe.net> */
38#define N_R3964 9 /* Reserved for Simatic R3964 module */
David Woodhouse44d1b982008-06-05 22:46:18 -070039#define N_PROFIBUS_FDL 10 /* Reserved for Profibus */
Tilman Schmidt4564f9e2007-02-10 01:45:00 -080040#define N_IRDA 11 /* Linux IrDa - http://irda.sourceforge.net/ */
41#define N_SMSBLOCK 12 /* SMS block mode - for talking to GSM data */
42 /* cards about SMS messages */
43#define N_HDLC 13 /* synchronous HDLC */
44#define N_SYNC_PPP 14 /* synchronous PPP */
45#define N_HCI 15 /* Bluetooth HCI UART */
46#define N_GIGASET_M101 16 /* Siemens Gigaset M101 serial DECT adapter */
Oliver Hartkoppcd05acf2007-12-16 15:59:24 -080047#define N_SLCAN 17 /* Serial / USB serial CAN Adaptors */
Alan Cox348eb122008-10-13 10:37:17 +010048#define N_PPS 18 /* Pulse per Second */
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Janusz Krzysztofikb7b8f9b2009-08-06 13:07:32 +020050#define N_V253 19 /* Codec control over voice modem */
Janusz Krzysztofik78ed73e2009-07-22 05:22:37 +020051
Linus Torvalds1da177e2005-04-16 15:20:36 -070052/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 * This character is the same as _POSIX_VDISABLE: it cannot be used as
54 * a c_cc[] character, but indicates that a particular special character
55 * isn't in use (eg VINTR has no character etc)
56 */
57#define __DISABLED_CHAR '\0'
58
Alan Cox33f0f882006-01-09 20:54:13 -080059struct tty_buffer {
60 struct tty_buffer *next;
61 char *char_buf_ptr;
62 unsigned char *flag_buf_ptr;
63 int used;
64 int size;
Paul Fulghum8977d922006-02-10 01:51:14 -080065 int commit;
66 int read;
Alan Cox33f0f882006-01-09 20:54:13 -080067 /* Data points here */
68 unsigned long data[0];
69};
70
71struct tty_bufhead {
David Howells52bad642006-11-22 14:54:01 +000072 struct delayed_work work;
Paul Fulghum808249c2006-02-03 03:04:41 -080073 spinlock_t lock;
Alan Cox33f0f882006-01-09 20:54:13 -080074 struct tty_buffer *head; /* Queue head */
75 struct tty_buffer *tail; /* Active buffer */
76 struct tty_buffer *free; /* Free queue head */
Alan Cox7a4d29f2008-07-16 21:54:54 +010077 int memory_used; /* Buffer space used excluding
78 free queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -070079};
80/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 * When a break, frame error, or parity error happens, these codes are
82 * stuffed into the flags buffer.
83 */
84#define TTY_NORMAL 0
85#define TTY_BREAK 1
86#define TTY_FRAME 2
87#define TTY_PARITY 3
88#define TTY_OVERRUN 4
89
90#define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
91#define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
92#define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
93#define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
94#define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
95#define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
96#define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
97#define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
98#define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
99#define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
100#define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
101#define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
102#define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
103#define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
104#define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
105#define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
106#define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
107
Alan Cox7a4d29f2008-07-16 21:54:54 +0100108#define _I_FLAG(tty, f) ((tty)->termios->c_iflag & (f))
109#define _O_FLAG(tty, f) ((tty)->termios->c_oflag & (f))
110#define _C_FLAG(tty, f) ((tty)->termios->c_cflag & (f))
111#define _L_FLAG(tty, f) ((tty)->termios->c_lflag & (f))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
Alan Cox7a4d29f2008-07-16 21:54:54 +0100113#define I_IGNBRK(tty) _I_FLAG((tty), IGNBRK)
114#define I_BRKINT(tty) _I_FLAG((tty), BRKINT)
115#define I_IGNPAR(tty) _I_FLAG((tty), IGNPAR)
116#define I_PARMRK(tty) _I_FLAG((tty), PARMRK)
117#define I_INPCK(tty) _I_FLAG((tty), INPCK)
118#define I_ISTRIP(tty) _I_FLAG((tty), ISTRIP)
119#define I_INLCR(tty) _I_FLAG((tty), INLCR)
120#define I_IGNCR(tty) _I_FLAG((tty), IGNCR)
121#define I_ICRNL(tty) _I_FLAG((tty), ICRNL)
122#define I_IUCLC(tty) _I_FLAG((tty), IUCLC)
123#define I_IXON(tty) _I_FLAG((tty), IXON)
124#define I_IXANY(tty) _I_FLAG((tty), IXANY)
125#define I_IXOFF(tty) _I_FLAG((tty), IXOFF)
126#define I_IMAXBEL(tty) _I_FLAG((tty), IMAXBEL)
127#define I_IUTF8(tty) _I_FLAG((tty), IUTF8)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Alan Cox7a4d29f2008-07-16 21:54:54 +0100129#define O_OPOST(tty) _O_FLAG((tty), OPOST)
130#define O_OLCUC(tty) _O_FLAG((tty), OLCUC)
131#define O_ONLCR(tty) _O_FLAG((tty), ONLCR)
132#define O_OCRNL(tty) _O_FLAG((tty), OCRNL)
133#define O_ONOCR(tty) _O_FLAG((tty), ONOCR)
134#define O_ONLRET(tty) _O_FLAG((tty), ONLRET)
135#define O_OFILL(tty) _O_FLAG((tty), OFILL)
136#define O_OFDEL(tty) _O_FLAG((tty), OFDEL)
137#define O_NLDLY(tty) _O_FLAG((tty), NLDLY)
138#define O_CRDLY(tty) _O_FLAG((tty), CRDLY)
139#define O_TABDLY(tty) _O_FLAG((tty), TABDLY)
140#define O_BSDLY(tty) _O_FLAG((tty), BSDLY)
141#define O_VTDLY(tty) _O_FLAG((tty), VTDLY)
142#define O_FFDLY(tty) _O_FLAG((tty), FFDLY)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
Alan Cox7a4d29f2008-07-16 21:54:54 +0100144#define C_BAUD(tty) _C_FLAG((tty), CBAUD)
145#define C_CSIZE(tty) _C_FLAG((tty), CSIZE)
146#define C_CSTOPB(tty) _C_FLAG((tty), CSTOPB)
147#define C_CREAD(tty) _C_FLAG((tty), CREAD)
148#define C_PARENB(tty) _C_FLAG((tty), PARENB)
149#define C_PARODD(tty) _C_FLAG((tty), PARODD)
150#define C_HUPCL(tty) _C_FLAG((tty), HUPCL)
151#define C_CLOCAL(tty) _C_FLAG((tty), CLOCAL)
152#define C_CIBAUD(tty) _C_FLAG((tty), CIBAUD)
153#define C_CRTSCTS(tty) _C_FLAG((tty), CRTSCTS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Alan Cox7a4d29f2008-07-16 21:54:54 +0100155#define L_ISIG(tty) _L_FLAG((tty), ISIG)
156#define L_ICANON(tty) _L_FLAG((tty), ICANON)
157#define L_XCASE(tty) _L_FLAG((tty), XCASE)
158#define L_ECHO(tty) _L_FLAG((tty), ECHO)
159#define L_ECHOE(tty) _L_FLAG((tty), ECHOE)
160#define L_ECHOK(tty) _L_FLAG((tty), ECHOK)
161#define L_ECHONL(tty) _L_FLAG((tty), ECHONL)
162#define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH)
163#define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP)
164#define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL)
165#define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT)
166#define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE)
167#define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO)
168#define L_PENDIN(tty) _L_FLAG((tty), PENDIN)
169#define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
171struct device;
Miloslav Trmac522ed772007-07-15 23:40:56 -0700172struct signal_struct;
Alan Cox6f670482008-07-16 21:53:41 +0100173
174/*
175 * Port level information. Each device keeps its own port level information
176 * so provide a common structure for those ports wanting to use common support
177 * routines.
178 *
179 * The tty port has a different lifetime to the tty so must be kept apart.
180 * In addition be careful as tty -> port mappings are valid for the life
181 * of the tty object but in many cases port -> tty mappings are valid only
182 * until a hangup so don't use the wrong path.
183 */
Alan Cox7a4d29f2008-07-16 21:54:54 +0100184
Alan Cox31f35932009-01-02 13:45:05 +0000185struct tty_port;
186
187struct tty_port_operations {
188 /* Return 1 if the carrier is raised */
189 int (*carrier_raised)(struct tty_port *port);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700190 /* Control the DTR line */
Alan Coxfcc8ac12009-06-11 12:24:17 +0100191 void (*dtr_rts)(struct tty_port *port, int raise);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700192 /* Called when the last close completes or a hangup finishes
Alan Cox64bc3972009-10-06 16:06:11 +0100193 IFF the port was initialized. Do not use to free resources. Called
194 under the port mutex to serialize against activate/shutdowns */
Alan Cox7ca0ff92009-09-19 13:13:20 -0700195 void (*shutdown)(struct tty_port *port);
196 void (*drop)(struct tty_port *port);
Alan Cox64bc3972009-10-06 16:06:11 +0100197 /* Called under the port mutex from tty_port_open, serialized using
198 the port mutex */
199 /* FIXME: long term getting the tty argument *out* of this would be
200 good for consoles */
201 int (*activate)(struct tty_port *port, struct tty_struct *tty);
Alan Cox568aafc2009-11-30 13:17:14 +0000202 /* Called on the final put of a port */
203 void (*destruct)(struct tty_port *port);
Alan Cox31f35932009-01-02 13:45:05 +0000204};
205
Alan Cox6f670482008-07-16 21:53:41 +0100206struct tty_port {
207 struct tty_struct *tty; /* Back pointer */
Alan Cox31f35932009-01-02 13:45:05 +0000208 const struct tty_port_operations *ops; /* Port operations */
Alan Cox4a90f092008-10-13 10:39:46 +0100209 spinlock_t lock; /* Lock protecting tty field */
Alan Cox6f670482008-07-16 21:53:41 +0100210 int blocked_open; /* Waiting to open */
211 int count; /* Usage count */
212 wait_queue_head_t open_wait; /* Open waiters */
213 wait_queue_head_t close_wait; /* Close waiters */
Alan Coxbdc04e32009-09-19 13:13:31 -0700214 wait_queue_head_t delta_msr_wait; /* Modem status change */
Alan Cox6f670482008-07-16 21:53:41 +0100215 unsigned long flags; /* TTY flags ASY_*/
216 struct mutex mutex; /* Locking */
Alan Cox44e49092009-11-30 13:16:41 +0000217 struct mutex buf_mutex; /* Buffer alloc lock */
Alan Cox6f670482008-07-16 21:53:41 +0100218 unsigned char *xmit_buf; /* Optional buffer */
Alan Cox5e99df52009-09-19 13:13:28 -0700219 unsigned int close_delay; /* Close port delay */
220 unsigned int closing_wait; /* Delay for output */
Alan Cox1ec739b2009-06-11 12:25:25 +0100221 int drain_delay; /* Set to zero if no pure time
222 based drain is needed else
223 set to size of fifo */
Alan Cox568aafc2009-11-30 13:17:14 +0000224 struct kref kref; /* Ref counter */
Alan Cox6f670482008-07-16 21:53:41 +0100225};
226
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227/*
228 * Where all of the state associated with a tty is kept while the tty
229 * is open. Since the termios state should be kept even if the tty
230 * has been closed --- for things like the baud rate, etc --- it is
231 * not stored here, but rather a pointer to the real state is stored
232 * here. Possible the winsize structure should have the same
233 * treatment, but (1) the default 80x24 is usually right and (2) it's
234 * most often used by a windowing system, which will set the correct
235 * size each time the window is created or resized anyway.
236 * - TYT, 9/14/92
237 */
Alan Coxf34d7a52008-04-30 00:54:13 -0700238
239struct tty_operations;
240
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241struct tty_struct {
242 int magic;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100243 struct kref kref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 struct tty_driver *driver;
Alan Coxf34d7a52008-04-30 00:54:13 -0700245 const struct tty_operations *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 int index;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100247
248 /* Protects ldisc changes: Lock tty not pty */
249 struct mutex ldisc_mutex;
250 struct tty_ldisc *ldisc;
251
Arjan van de Ven5785c952006-09-29 02:00:43 -0700252 struct mutex termios_mutex;
Alan Cox04f378b2008-04-30 00:53:29 -0700253 spinlock_t ctrl_lock;
Alan Cox47f86832008-04-30 00:53:30 -0700254 /* Termios values are protected by the termios mutex */
Alan Coxedc6afc2006-12-08 02:38:44 -0800255 struct ktermios *termios, *termios_locked;
Alan Cox1d65b4a2008-10-13 10:38:18 +0100256 struct termiox *termiox; /* May be NULL for unsupported */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 char name[64];
Alan Cox47f86832008-04-30 00:53:30 -0700258 struct pid *pgrp; /* Protected by ctrl lock */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800259 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 unsigned long flags;
261 int count;
Alan Cox47f86832008-04-30 00:53:30 -0700262 struct winsize winsize; /* termios mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
264 unsigned char low_latency:1, warned:1;
Alan Cox47f86832008-04-30 00:53:30 -0700265 unsigned char ctrl_status; /* ctrl_lock */
Alan Cox33f0f882006-01-09 20:54:13 -0800266 unsigned int receive_room; /* Bytes free for queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
268 struct tty_struct *link;
269 struct fasync_struct *fasync;
Alan Cox47f86832008-04-30 00:53:30 -0700270 struct tty_bufhead buf; /* Locked internally */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 int alt_speed; /* For magic substitution of 38400 bps */
272 wait_queue_head_t write_wait;
273 wait_queue_head_t read_wait;
274 struct work_struct hangup_work;
275 void *disc_data;
276 void *driver_data;
277 struct list_head tty_files;
278
279#define N_TTY_BUF_SIZE 4096
Alan Cox6f670482008-07-16 21:53:41 +0100280
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 /*
282 * The following is data for the N_TTY line discipline. For
283 * historical reasons, this is included in the tty structure.
Alan Cox47f86832008-04-30 00:53:30 -0700284 * Mostly locked by the BKL.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 */
286 unsigned int column;
287 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
288 unsigned char closing:1;
Joe Petersona88a69c2009-01-02 13:40:53 +0000289 unsigned char echo_overrun:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 unsigned short minimum_to_wake;
291 unsigned long overrun_time;
292 int num_overrun;
293 unsigned long process_char_map[256/(8*sizeof(unsigned long))];
294 char *read_buf;
295 int read_head;
296 int read_tail;
297 int read_cnt;
298 unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
Joe Petersona88a69c2009-01-02 13:40:53 +0000299 unsigned char *echo_buf;
300 unsigned int echo_pos;
301 unsigned int echo_cnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 int canon_data;
303 unsigned long canon_head;
304 unsigned int canon_column;
Ingo Molnar70522e12006-03-23 03:00:31 -0800305 struct mutex atomic_read_lock;
306 struct mutex atomic_write_lock;
Joe Petersona88a69c2009-01-02 13:40:53 +0000307 struct mutex output_lock;
308 struct mutex echo_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 unsigned char *write_buf;
310 int write_cnt;
311 spinlock_t read_lock;
312 /* If the tty has a pending do_SAK, queue it here - akpm */
313 struct work_struct SAK_work;
Alan Cox6f670482008-07-16 21:53:41 +0100314 struct tty_port *port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315};
316
317/* tty magic number */
318#define TTY_MAGIC 0x5401
319
320/*
321 * These bits are used in the flags field of the tty structure.
Alan Cox7a4d29f2008-07-16 21:54:54 +0100322 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 * So that interrupts won't be able to mess up the queues,
324 * copy_to_cooked must be atomic with respect to itself, as must
325 * tty->write. Thus, you must use the inline functions set_bit() and
326 * clear_bit() to make things atomic.
327 */
328#define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
Alan Cox7a4d29f2008-07-16 21:54:54 +0100329#define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330#define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
331#define TTY_EXCLUSIVE 3 /* Exclusive open mode */
332#define TTY_DEBUG 4 /* Debugging */
333#define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
334#define TTY_PUSH 6 /* n_tty private */
335#define TTY_CLOSING 7 /* ->close() in progress */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336#define TTY_LDISC 9 /* Line discipline attached */
Alan Coxc9b39762009-01-02 13:44:56 +0000337#define TTY_LDISC_CHANGING 10 /* Line discipline changing */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100338#define TTY_LDISC_OPEN 11 /* Line discipline is open */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339#define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */
340#define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */
341#define TTY_PTY_LOCK 16 /* pty private */
342#define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
343#define TTY_HUPPED 18 /* Post driver->hangup() */
Alan Cox42fd5522007-08-10 13:01:05 -0700344#define TTY_FLUSHING 19 /* Flushing to ldisc in progress */
345#define TTY_FLUSHPENDING 20 /* Queued buffer flush pending */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
347#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
348
349extern void tty_write_flush(struct tty_struct *);
350
Alan Coxedc6afc2006-12-08 02:38:44 -0800351extern struct ktermios tty_std_termios;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353extern void console_init(void);
354extern int vcs_init(void);
355
Alan Coxd81ed102008-10-13 10:41:42 +0100356extern struct class *tty_class;
357
Alan Cox9c9f4de2008-10-13 10:37:26 +0100358/**
359 * tty_kref_get - get a tty reference
360 * @tty: tty device
361 *
362 * Return a new reference to a tty object. The caller must hold
363 * sufficient locks/counts to ensure that their existing reference cannot
364 * go away
365 */
366
Ingo Molnar14bfc982008-11-25 08:58:11 +0100367static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
Alan Cox9c9f4de2008-10-13 10:37:26 +0100368{
369 if (tty)
370 kref_get(&tty->kref);
371 return tty;
372}
373extern void tty_kref_put(struct tty_struct *tty);
374
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
376 const char *routine);
377extern char *tty_name(struct tty_struct *tty, char *buf);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100378extern void tty_wait_until_sent(struct tty_struct *tty, long timeout);
379extern int tty_check_change(struct tty_struct *tty);
380extern void stop_tty(struct tty_struct *tty);
381extern void start_tty(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382extern int tty_register_driver(struct tty_driver *driver);
383extern int tty_unregister_driver(struct tty_driver *driver);
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -0700384extern struct device *tty_register_device(struct tty_driver *driver,
385 unsigned index, struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
387extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
388 int buflen);
389extern void tty_write_message(struct tty_struct *tty, char *msg);
Alan Coxf34d7a52008-04-30 00:54:13 -0700390extern int tty_put_char(struct tty_struct *tty, unsigned char c);
391extern int tty_chars_in_buffer(struct tty_struct *tty);
392extern int tty_write_room(struct tty_struct *tty);
393extern void tty_driver_flush_buffer(struct tty_struct *tty);
Alan Cox39c2e602008-04-30 00:54:18 -0700394extern void tty_throttle(struct tty_struct *tty);
395extern void tty_unthrottle(struct tty_struct *tty);
Alan Coxfc6f6232009-01-02 13:43:17 +0000396extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
Alan Coxfeebed62008-10-13 10:41:30 +0100397extern void tty_shutdown(struct tty_struct *tty);
398extern void tty_free_termios(struct tty_struct *tty);
Eric W. Biederman3e7cd6c2007-02-12 00:52:58 -0800399extern int is_current_pgrp_orphaned(void);
Alan Cox5d0fdf12008-04-30 00:53:31 -0700400extern struct pid *tty_get_pgrp(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401extern int is_ignored(int sig);
402extern int tty_signal(int sig, struct tty_struct *tty);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100403extern void tty_hangup(struct tty_struct *tty);
404extern void tty_vhangup(struct tty_struct *tty);
Alan Cox2cb59982008-10-13 10:40:30 +0100405extern void tty_vhangup_self(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406extern void tty_unhangup(struct file *filp);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100407extern int tty_hung_up_p(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408extern void do_SAK(struct tty_struct *tty);
Eric W. Biederman8b6312f2007-02-10 01:44:34 -0800409extern void __do_SAK(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410extern void disassociate_ctty(int priv);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700411extern void no_tty(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412extern void tty_flip_buffer_push(struct tty_struct *tty);
OGAWA Hirofumie043e422009-07-29 12:15:56 -0700413extern void tty_flush_to_ldisc(struct tty_struct *tty);
Alan Coxe0495732008-10-13 10:36:58 +0100414extern void tty_buffer_free_all(struct tty_struct *tty);
415extern void tty_buffer_flush(struct tty_struct *tty);
416extern void tty_buffer_init(struct tty_struct *tty);
Alan Coxedc6afc2006-12-08 02:38:44 -0800417extern speed_t tty_get_baud_rate(struct tty_struct *tty);
418extern speed_t tty_termios_baud_rate(struct ktermios *termios);
419extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100420extern void tty_termios_encode_baud_rate(struct ktermios *termios,
421 speed_t ibaud, speed_t obaud);
422extern void tty_encode_baud_rate(struct tty_struct *tty,
423 speed_t ibaud, speed_t obaud);
Alan Cox5f519d72007-10-16 23:30:07 -0700424extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
Alan Coxbf5e5832008-01-08 14:55:51 +0000425extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
427extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
428extern void tty_ldisc_deref(struct tty_ldisc *);
429extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100430extern void tty_ldisc_hangup(struct tty_struct *tty);
Alan Coxa352def2008-07-16 21:53:12 +0100431extern const struct file_operations tty_ldiscs_proc_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432
433extern void tty_wakeup(struct tty_struct *tty);
434extern void tty_ldisc_flush(struct tty_struct *tty);
435
Alan Cox04f378b2008-04-30 00:53:29 -0700436extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Alan Cox0fc00e22007-11-07 01:24:56 -0800437extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
438 unsigned int cmd, unsigned long arg);
439extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800440extern dev_t tty_devnum(struct tty_struct *tty);
441extern void proc_clear_tty(struct task_struct *p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800442extern struct tty_struct *get_current_tty(void);
Alan Coxd81ed102008-10-13 10:41:42 +0100443extern void tty_default_fops(struct file_operations *fops);
Alan Coxbf970ee2008-10-13 10:42:39 +0100444extern struct tty_struct *alloc_tty_struct(void);
445extern void free_tty_struct(struct tty_struct *tty);
446extern void initialize_tty_struct(struct tty_struct *tty,
447 struct tty_driver *driver, int idx);
Alan Cox73ec06f2008-10-13 10:42:29 +0100448extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx,
449 int first_ok);
Alan Coxeeb89d92009-11-30 13:18:29 +0000450extern int tty_release(struct inode *inode, struct file *filp);
Alan Coxbf970ee2008-10-13 10:42:39 +0100451extern int tty_init_termios(struct tty_struct *tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800452
Alan Coxe8b70e72009-06-11 12:48:02 +0100453extern struct tty_struct *tty_pair_get_tty(struct tty_struct *tty);
454extern struct tty_struct *tty_pair_get_pty(struct tty_struct *tty);
455
Ingo Molnar70522e12006-03-23 03:00:31 -0800456extern struct mutex tty_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
Alan Cox9c1729d2007-07-15 23:39:43 -0700458extern void tty_write_unlock(struct tty_struct *tty);
459extern int tty_write_lock(struct tty_struct *tty, int ndelay);
460#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
461
Alan Cox6f670482008-07-16 21:53:41 +0100462extern void tty_port_init(struct tty_port *port);
463extern int tty_port_alloc_xmit_buf(struct tty_port *port);
464extern void tty_port_free_xmit_buf(struct tty_port *port);
Alan Cox568aafc2009-11-30 13:17:14 +0000465extern void tty_port_put(struct tty_port *port);
466
467extern inline struct tty_port *tty_port_get(struct tty_port *port)
468{
469 if (port)
470 kref_get(&port->kref);
471 return port;
472}
473
Alan Cox4a90f092008-10-13 10:39:46 +0100474extern struct tty_struct *tty_port_tty_get(struct tty_port *port);
475extern void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty);
Alan Cox31f35932009-01-02 13:45:05 +0000476extern int tty_port_carrier_raised(struct tty_port *port);
Alan Cox5d951fb2009-01-02 13:45:19 +0000477extern void tty_port_raise_dtr_rts(struct tty_port *port);
Alan Coxfcc8ac12009-06-11 12:24:17 +0100478extern void tty_port_lower_dtr_rts(struct tty_port *port);
Alan Cox3e616962009-01-02 13:45:26 +0000479extern void tty_port_hangup(struct tty_port *port);
Alan Cox36c621d2009-01-02 13:46:10 +0000480extern int tty_port_block_til_ready(struct tty_port *port,
481 struct tty_struct *tty, struct file *filp);
Alan Coxa6614992009-01-02 13:46:50 +0000482extern int tty_port_close_start(struct tty_port *port,
483 struct tty_struct *tty, struct file *filp);
484extern void tty_port_close_end(struct tty_port *port, struct tty_struct *tty);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700485extern void tty_port_close(struct tty_port *port,
486 struct tty_struct *tty, struct file *filp);
Alan Cox64bc3972009-10-06 16:06:11 +0100487extern int tty_port_open(struct tty_port *port,
488 struct tty_struct *tty, struct file *filp);
Alan Coxb58d13a2009-09-19 13:13:32 -0700489extern inline int tty_port_users(struct tty_port *port)
490{
491 return port->count + port->blocked_open;
492}
493
Alan Cox01e1abb2008-07-22 11:16:55 +0100494extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
495extern int tty_unregister_ldisc(int disc);
496extern int tty_set_ldisc(struct tty_struct *tty, int ldisc);
497extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty);
498extern void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty);
499extern void tty_ldisc_init(struct tty_struct *tty);
500extern void tty_ldisc_begin(void);
501/* This last one is just for the tty layer internals and shouldn't be used elsewhere */
502extern void tty_ldisc_enable(struct tty_struct *tty);
Alan Cox9c1729d2007-07-15 23:39:43 -0700503
504
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505/* n_tty.c */
Alan Coxa352def2008-07-16 21:53:12 +0100506extern struct tty_ldisc_ops tty_ldisc_N_TTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507
Miloslav Trmac522ed772007-07-15 23:40:56 -0700508/* tty_audit.c */
509#ifdef CONFIG_AUDIT
510extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data,
511 size_t size);
512extern void tty_audit_exit(void);
513extern void tty_audit_fork(struct signal_struct *sig);
Al Viro1e641742008-12-09 09:23:33 +0000514extern void tty_audit_tiocsti(struct tty_struct *tty, char ch);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700515extern void tty_audit_push(struct tty_struct *tty);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100516extern void tty_audit_push_task(struct task_struct *tsk,
517 uid_t loginuid, u32 sessionid);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700518#else
519static inline void tty_audit_add_data(struct tty_struct *tty,
520 unsigned char *data, size_t size)
521{
522}
Al Viro1e641742008-12-09 09:23:33 +0000523static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch)
524{
525}
Miloslav Trmac522ed772007-07-15 23:40:56 -0700526static inline void tty_audit_exit(void)
527{
528}
529static inline void tty_audit_fork(struct signal_struct *sig)
530{
531}
532static inline void tty_audit_push(struct tty_struct *tty)
533{
534}
Alan Cox7a4d29f2008-07-16 21:54:54 +0100535static inline void tty_audit_push_task(struct task_struct *tsk,
536 uid_t loginuid, u32 sessionid)
Miloslav Trmac522ed772007-07-15 23:40:56 -0700537{
538}
Miloslav Trmac522ed772007-07-15 23:40:56 -0700539#endif
540
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541/* tty_ioctl.c */
Alan Cox47afa7a2008-10-13 10:44:17 +0100542extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 unsigned int cmd, unsigned long arg);
544
545/* serial.c */
546
547extern void serial_console_init(void);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100548
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549/* pcxx.c */
550
551extern int pcxe_open(struct tty_struct *tty, struct file *filp);
552
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553/* vt.c */
554
Alan Cox7a4d29f2008-07-16 21:54:54 +0100555extern int vt_ioctl(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 unsigned int cmd, unsigned long arg);
557
Arnd Bergmanne9216652009-08-06 15:09:28 +0200558extern long vt_compat_ioctl(struct tty_struct *tty, struct file * file,
559 unsigned int cmd, unsigned long arg);
560
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561#endif /* __KERNEL__ */
562#endif