blob: d96e5882f12912038eabbd21e790c13fa689533c [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
Alan Coxd9661ad2010-02-18 16:43:47 +000071/*
72 * We default to dicing tty buffer allocations to this many characters
73 * in order to avoid multiple page allocations. We assume tty_buffer itself
74 * is under 256 bytes. See tty_buffer_find for the allocation logic this
75 * must match
76 */
77
78#define TTY_BUFFER_PAGE ((PAGE_SIZE - 256) / 2)
79
80
Alan Cox33f0f882006-01-09 20:54:13 -080081struct tty_bufhead {
David Howells52bad642006-11-22 14:54:01 +000082 struct delayed_work work;
Paul Fulghum808249c2006-02-03 03:04:41 -080083 spinlock_t lock;
Alan Cox33f0f882006-01-09 20:54:13 -080084 struct tty_buffer *head; /* Queue head */
85 struct tty_buffer *tail; /* Active buffer */
86 struct tty_buffer *free; /* Free queue head */
Alan Cox7a4d29f2008-07-16 21:54:54 +010087 int memory_used; /* Buffer space used excluding
88 free queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -070089};
90/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 * When a break, frame error, or parity error happens, these codes are
92 * stuffed into the flags buffer.
93 */
94#define TTY_NORMAL 0
95#define TTY_BREAK 1
96#define TTY_FRAME 2
97#define TTY_PARITY 3
98#define TTY_OVERRUN 4
99
100#define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
101#define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
102#define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
103#define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
104#define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
105#define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
106#define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
107#define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
108#define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
109#define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
110#define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
111#define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
112#define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
113#define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
114#define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
115#define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
116#define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
117
Alan Cox7a4d29f2008-07-16 21:54:54 +0100118#define _I_FLAG(tty, f) ((tty)->termios->c_iflag & (f))
119#define _O_FLAG(tty, f) ((tty)->termios->c_oflag & (f))
120#define _C_FLAG(tty, f) ((tty)->termios->c_cflag & (f))
121#define _L_FLAG(tty, f) ((tty)->termios->c_lflag & (f))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Alan Cox7a4d29f2008-07-16 21:54:54 +0100123#define I_IGNBRK(tty) _I_FLAG((tty), IGNBRK)
124#define I_BRKINT(tty) _I_FLAG((tty), BRKINT)
125#define I_IGNPAR(tty) _I_FLAG((tty), IGNPAR)
126#define I_PARMRK(tty) _I_FLAG((tty), PARMRK)
127#define I_INPCK(tty) _I_FLAG((tty), INPCK)
128#define I_ISTRIP(tty) _I_FLAG((tty), ISTRIP)
129#define I_INLCR(tty) _I_FLAG((tty), INLCR)
130#define I_IGNCR(tty) _I_FLAG((tty), IGNCR)
131#define I_ICRNL(tty) _I_FLAG((tty), ICRNL)
132#define I_IUCLC(tty) _I_FLAG((tty), IUCLC)
133#define I_IXON(tty) _I_FLAG((tty), IXON)
134#define I_IXANY(tty) _I_FLAG((tty), IXANY)
135#define I_IXOFF(tty) _I_FLAG((tty), IXOFF)
136#define I_IMAXBEL(tty) _I_FLAG((tty), IMAXBEL)
137#define I_IUTF8(tty) _I_FLAG((tty), IUTF8)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Alan Cox7a4d29f2008-07-16 21:54:54 +0100139#define O_OPOST(tty) _O_FLAG((tty), OPOST)
140#define O_OLCUC(tty) _O_FLAG((tty), OLCUC)
141#define O_ONLCR(tty) _O_FLAG((tty), ONLCR)
142#define O_OCRNL(tty) _O_FLAG((tty), OCRNL)
143#define O_ONOCR(tty) _O_FLAG((tty), ONOCR)
144#define O_ONLRET(tty) _O_FLAG((tty), ONLRET)
145#define O_OFILL(tty) _O_FLAG((tty), OFILL)
146#define O_OFDEL(tty) _O_FLAG((tty), OFDEL)
147#define O_NLDLY(tty) _O_FLAG((tty), NLDLY)
148#define O_CRDLY(tty) _O_FLAG((tty), CRDLY)
149#define O_TABDLY(tty) _O_FLAG((tty), TABDLY)
150#define O_BSDLY(tty) _O_FLAG((tty), BSDLY)
151#define O_VTDLY(tty) _O_FLAG((tty), VTDLY)
152#define O_FFDLY(tty) _O_FLAG((tty), FFDLY)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
Alan Cox7a4d29f2008-07-16 21:54:54 +0100154#define C_BAUD(tty) _C_FLAG((tty), CBAUD)
155#define C_CSIZE(tty) _C_FLAG((tty), CSIZE)
156#define C_CSTOPB(tty) _C_FLAG((tty), CSTOPB)
157#define C_CREAD(tty) _C_FLAG((tty), CREAD)
158#define C_PARENB(tty) _C_FLAG((tty), PARENB)
159#define C_PARODD(tty) _C_FLAG((tty), PARODD)
160#define C_HUPCL(tty) _C_FLAG((tty), HUPCL)
161#define C_CLOCAL(tty) _C_FLAG((tty), CLOCAL)
162#define C_CIBAUD(tty) _C_FLAG((tty), CIBAUD)
163#define C_CRTSCTS(tty) _C_FLAG((tty), CRTSCTS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Alan Cox7a4d29f2008-07-16 21:54:54 +0100165#define L_ISIG(tty) _L_FLAG((tty), ISIG)
166#define L_ICANON(tty) _L_FLAG((tty), ICANON)
167#define L_XCASE(tty) _L_FLAG((tty), XCASE)
168#define L_ECHO(tty) _L_FLAG((tty), ECHO)
169#define L_ECHOE(tty) _L_FLAG((tty), ECHOE)
170#define L_ECHOK(tty) _L_FLAG((tty), ECHOK)
171#define L_ECHONL(tty) _L_FLAG((tty), ECHONL)
172#define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH)
173#define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP)
174#define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL)
175#define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT)
176#define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE)
177#define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO)
178#define L_PENDIN(tty) _L_FLAG((tty), PENDIN)
179#define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
181struct device;
Miloslav Trmac522ed772007-07-15 23:40:56 -0700182struct signal_struct;
Alan Cox6f670482008-07-16 21:53:41 +0100183
184/*
185 * Port level information. Each device keeps its own port level information
186 * so provide a common structure for those ports wanting to use common support
187 * routines.
188 *
189 * The tty port has a different lifetime to the tty so must be kept apart.
190 * In addition be careful as tty -> port mappings are valid for the life
191 * of the tty object but in many cases port -> tty mappings are valid only
192 * until a hangup so don't use the wrong path.
193 */
Alan Cox7a4d29f2008-07-16 21:54:54 +0100194
Alan Cox31f35932009-01-02 13:45:05 +0000195struct tty_port;
196
197struct tty_port_operations {
198 /* Return 1 if the carrier is raised */
199 int (*carrier_raised)(struct tty_port *port);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700200 /* Control the DTR line */
Alan Coxfcc8ac12009-06-11 12:24:17 +0100201 void (*dtr_rts)(struct tty_port *port, int raise);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700202 /* Called when the last close completes or a hangup finishes
Alan Cox64bc3972009-10-06 16:06:11 +0100203 IFF the port was initialized. Do not use to free resources. Called
204 under the port mutex to serialize against activate/shutdowns */
Alan Cox7ca0ff92009-09-19 13:13:20 -0700205 void (*shutdown)(struct tty_port *port);
206 void (*drop)(struct tty_port *port);
Alan Cox64bc3972009-10-06 16:06:11 +0100207 /* Called under the port mutex from tty_port_open, serialized using
208 the port mutex */
209 /* FIXME: long term getting the tty argument *out* of this would be
210 good for consoles */
211 int (*activate)(struct tty_port *port, struct tty_struct *tty);
Alan Cox568aafc2009-11-30 13:17:14 +0000212 /* Called on the final put of a port */
213 void (*destruct)(struct tty_port *port);
Alan Cox31f35932009-01-02 13:45:05 +0000214};
215
Alan Cox6f670482008-07-16 21:53:41 +0100216struct tty_port {
217 struct tty_struct *tty; /* Back pointer */
Alan Cox31f35932009-01-02 13:45:05 +0000218 const struct tty_port_operations *ops; /* Port operations */
Alan Cox4a90f092008-10-13 10:39:46 +0100219 spinlock_t lock; /* Lock protecting tty field */
Alan Cox6f670482008-07-16 21:53:41 +0100220 int blocked_open; /* Waiting to open */
221 int count; /* Usage count */
222 wait_queue_head_t open_wait; /* Open waiters */
223 wait_queue_head_t close_wait; /* Close waiters */
Alan Coxbdc04e32009-09-19 13:13:31 -0700224 wait_queue_head_t delta_msr_wait; /* Modem status change */
Alan Cox6f670482008-07-16 21:53:41 +0100225 unsigned long flags; /* TTY flags ASY_*/
226 struct mutex mutex; /* Locking */
Alan Cox44e49092009-11-30 13:16:41 +0000227 struct mutex buf_mutex; /* Buffer alloc lock */
Alan Cox6f670482008-07-16 21:53:41 +0100228 unsigned char *xmit_buf; /* Optional buffer */
Alan Cox5e99df52009-09-19 13:13:28 -0700229 unsigned int close_delay; /* Close port delay */
230 unsigned int closing_wait; /* Delay for output */
Alan Cox1ec739b2009-06-11 12:25:25 +0100231 int drain_delay; /* Set to zero if no pure time
232 based drain is needed else
233 set to size of fifo */
Alan Cox568aafc2009-11-30 13:17:14 +0000234 struct kref kref; /* Ref counter */
Alan Cox6f670482008-07-16 21:53:41 +0100235};
236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237/*
238 * Where all of the state associated with a tty is kept while the tty
239 * is open. Since the termios state should be kept even if the tty
240 * has been closed --- for things like the baud rate, etc --- it is
241 * not stored here, but rather a pointer to the real state is stored
242 * here. Possible the winsize structure should have the same
243 * treatment, but (1) the default 80x24 is usually right and (2) it's
244 * most often used by a windowing system, which will set the correct
245 * size each time the window is created or resized anyway.
246 * - TYT, 9/14/92
247 */
Alan Coxf34d7a52008-04-30 00:54:13 -0700248
249struct tty_operations;
250
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251struct tty_struct {
252 int magic;
Alan Cox9c9f4de2008-10-13 10:37:26 +0100253 struct kref kref;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 struct tty_driver *driver;
Alan Coxf34d7a52008-04-30 00:54:13 -0700255 const struct tty_operations *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 int index;
Alan Coxc65c9bc2009-06-11 12:50:12 +0100257
258 /* Protects ldisc changes: Lock tty not pty */
259 struct mutex ldisc_mutex;
260 struct tty_ldisc *ldisc;
261
Arjan van de Ven5785c952006-09-29 02:00:43 -0700262 struct mutex termios_mutex;
Alan Cox04f378b2008-04-30 00:53:29 -0700263 spinlock_t ctrl_lock;
Alan Cox47f86832008-04-30 00:53:30 -0700264 /* Termios values are protected by the termios mutex */
Alan Coxedc6afc2006-12-08 02:38:44 -0800265 struct ktermios *termios, *termios_locked;
Alan Cox1d65b4a2008-10-13 10:38:18 +0100266 struct termiox *termiox; /* May be NULL for unsupported */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 char name[64];
Alan Cox47f86832008-04-30 00:53:30 -0700268 struct pid *pgrp; /* Protected by ctrl lock */
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800269 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 unsigned long flags;
271 int count;
Alan Cox47f86832008-04-30 00:53:30 -0700272 struct winsize winsize; /* termios mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
274 unsigned char low_latency:1, warned:1;
Alan Cox47f86832008-04-30 00:53:30 -0700275 unsigned char ctrl_status; /* ctrl_lock */
Alan Cox33f0f882006-01-09 20:54:13 -0800276 unsigned int receive_room; /* Bytes free for queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
278 struct tty_struct *link;
279 struct fasync_struct *fasync;
Alan Cox47f86832008-04-30 00:53:30 -0700280 struct tty_bufhead buf; /* Locked internally */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 int alt_speed; /* For magic substitution of 38400 bps */
282 wait_queue_head_t write_wait;
283 wait_queue_head_t read_wait;
284 struct work_struct hangup_work;
285 void *disc_data;
286 void *driver_data;
287 struct list_head tty_files;
288
289#define N_TTY_BUF_SIZE 4096
Alan Cox6f670482008-07-16 21:53:41 +0100290
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 /*
292 * The following is data for the N_TTY line discipline. For
293 * historical reasons, this is included in the tty structure.
Alan Cox47f86832008-04-30 00:53:30 -0700294 * Mostly locked by the BKL.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 */
296 unsigned int column;
297 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
298 unsigned char closing:1;
Joe Petersona88a69c2009-01-02 13:40:53 +0000299 unsigned char echo_overrun:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 unsigned short minimum_to_wake;
301 unsigned long overrun_time;
302 int num_overrun;
303 unsigned long process_char_map[256/(8*sizeof(unsigned long))];
304 char *read_buf;
305 int read_head;
306 int read_tail;
307 int read_cnt;
308 unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
Joe Petersona88a69c2009-01-02 13:40:53 +0000309 unsigned char *echo_buf;
310 unsigned int echo_pos;
311 unsigned int echo_cnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 int canon_data;
313 unsigned long canon_head;
314 unsigned int canon_column;
Ingo Molnar70522e12006-03-23 03:00:31 -0800315 struct mutex atomic_read_lock;
316 struct mutex atomic_write_lock;
Joe Petersona88a69c2009-01-02 13:40:53 +0000317 struct mutex output_lock;
318 struct mutex echo_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 unsigned char *write_buf;
320 int write_cnt;
321 spinlock_t read_lock;
322 /* If the tty has a pending do_SAK, queue it here - akpm */
323 struct work_struct SAK_work;
Alan Cox6f670482008-07-16 21:53:41 +0100324 struct tty_port *port;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325};
326
327/* tty magic number */
328#define TTY_MAGIC 0x5401
329
330/*
331 * These bits are used in the flags field of the tty structure.
Alan Cox7a4d29f2008-07-16 21:54:54 +0100332 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 * So that interrupts won't be able to mess up the queues,
334 * copy_to_cooked must be atomic with respect to itself, as must
335 * tty->write. Thus, you must use the inline functions set_bit() and
336 * clear_bit() to make things atomic.
337 */
338#define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
Alan Cox7a4d29f2008-07-16 21:54:54 +0100339#define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340#define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
341#define TTY_EXCLUSIVE 3 /* Exclusive open mode */
342#define TTY_DEBUG 4 /* Debugging */
343#define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
344#define TTY_PUSH 6 /* n_tty private */
345#define TTY_CLOSING 7 /* ->close() in progress */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346#define TTY_LDISC 9 /* Line discipline attached */
Alan Coxc9b39762009-01-02 13:44:56 +0000347#define TTY_LDISC_CHANGING 10 /* Line discipline changing */
Alan Coxc65c9bc2009-06-11 12:50:12 +0100348#define TTY_LDISC_OPEN 11 /* Line discipline is open */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349#define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */
350#define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */
351#define TTY_PTY_LOCK 16 /* pty private */
352#define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
353#define TTY_HUPPED 18 /* Post driver->hangup() */
Alan Cox42fd5522007-08-10 13:01:05 -0700354#define TTY_FLUSHING 19 /* Flushing to ldisc in progress */
355#define TTY_FLUSHPENDING 20 /* Queued buffer flush pending */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356
357#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
358
359extern void tty_write_flush(struct tty_struct *);
360
Alan Coxedc6afc2006-12-08 02:38:44 -0800361extern struct ktermios tty_std_termios;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363extern void console_init(void);
364extern int vcs_init(void);
365
Alan Coxd81ed102008-10-13 10:41:42 +0100366extern struct class *tty_class;
367
Alan Cox9c9f4de2008-10-13 10:37:26 +0100368/**
369 * tty_kref_get - get a tty reference
370 * @tty: tty device
371 *
372 * Return a new reference to a tty object. The caller must hold
373 * sufficient locks/counts to ensure that their existing reference cannot
374 * go away
375 */
376
Ingo Molnar14bfc982008-11-25 08:58:11 +0100377static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
Alan Cox9c9f4de2008-10-13 10:37:26 +0100378{
379 if (tty)
380 kref_get(&tty->kref);
381 return tty;
382}
383extern void tty_kref_put(struct tty_struct *tty);
384
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
386 const char *routine);
387extern char *tty_name(struct tty_struct *tty, char *buf);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100388extern void tty_wait_until_sent(struct tty_struct *tty, long timeout);
389extern int tty_check_change(struct tty_struct *tty);
390extern void stop_tty(struct tty_struct *tty);
391extern void start_tty(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392extern int tty_register_driver(struct tty_driver *driver);
393extern int tty_unregister_driver(struct tty_driver *driver);
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -0700394extern struct device *tty_register_device(struct tty_driver *driver,
395 unsigned index, struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
397extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
398 int buflen);
399extern void tty_write_message(struct tty_struct *tty, char *msg);
Alan Coxf34d7a52008-04-30 00:54:13 -0700400extern int tty_put_char(struct tty_struct *tty, unsigned char c);
401extern int tty_chars_in_buffer(struct tty_struct *tty);
402extern int tty_write_room(struct tty_struct *tty);
403extern void tty_driver_flush_buffer(struct tty_struct *tty);
Alan Cox39c2e602008-04-30 00:54:18 -0700404extern void tty_throttle(struct tty_struct *tty);
405extern void tty_unthrottle(struct tty_struct *tty);
Alan Coxfc6f6232009-01-02 13:43:17 +0000406extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
Alan Coxfeebed62008-10-13 10:41:30 +0100407extern void tty_shutdown(struct tty_struct *tty);
408extern void tty_free_termios(struct tty_struct *tty);
Eric W. Biederman3e7cd6c2007-02-12 00:52:58 -0800409extern int is_current_pgrp_orphaned(void);
Alan Cox5d0fdf12008-04-30 00:53:31 -0700410extern struct pid *tty_get_pgrp(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411extern int is_ignored(int sig);
412extern int tty_signal(int sig, struct tty_struct *tty);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100413extern void tty_hangup(struct tty_struct *tty);
414extern void tty_vhangup(struct tty_struct *tty);
Alan Cox2cb59982008-10-13 10:40:30 +0100415extern void tty_vhangup_self(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416extern void tty_unhangup(struct file *filp);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100417extern int tty_hung_up_p(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418extern void do_SAK(struct tty_struct *tty);
Eric W. Biederman8b6312f2007-02-10 01:44:34 -0800419extern void __do_SAK(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420extern void disassociate_ctty(int priv);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700421extern void no_tty(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422extern void tty_flip_buffer_push(struct tty_struct *tty);
OGAWA Hirofumie043e422009-07-29 12:15:56 -0700423extern void tty_flush_to_ldisc(struct tty_struct *tty);
Alan Coxe0495732008-10-13 10:36:58 +0100424extern void tty_buffer_free_all(struct tty_struct *tty);
425extern void tty_buffer_flush(struct tty_struct *tty);
426extern void tty_buffer_init(struct tty_struct *tty);
Alan Coxedc6afc2006-12-08 02:38:44 -0800427extern speed_t tty_get_baud_rate(struct tty_struct *tty);
428extern speed_t tty_termios_baud_rate(struct ktermios *termios);
429extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100430extern void tty_termios_encode_baud_rate(struct ktermios *termios,
431 speed_t ibaud, speed_t obaud);
432extern void tty_encode_baud_rate(struct tty_struct *tty,
433 speed_t ibaud, speed_t obaud);
Alan Cox5f519d72007-10-16 23:30:07 -0700434extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
Alan Coxbf5e5832008-01-08 14:55:51 +0000435extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
437extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
438extern void tty_ldisc_deref(struct tty_ldisc *);
439extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
Alan Coxc65c9bc2009-06-11 12:50:12 +0100440extern void tty_ldisc_hangup(struct tty_struct *tty);
Alan Coxa352def2008-07-16 21:53:12 +0100441extern const struct file_operations tty_ldiscs_proc_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
443extern void tty_wakeup(struct tty_struct *tty);
444extern void tty_ldisc_flush(struct tty_struct *tty);
445
Alan Cox04f378b2008-04-30 00:53:29 -0700446extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
Alan Cox0fc00e22007-11-07 01:24:56 -0800447extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
448 unsigned int cmd, unsigned long arg);
449extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800450extern dev_t tty_devnum(struct tty_struct *tty);
451extern void proc_clear_tty(struct task_struct *p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800452extern struct tty_struct *get_current_tty(void);
Alan Coxd81ed102008-10-13 10:41:42 +0100453extern void tty_default_fops(struct file_operations *fops);
Alan Coxbf970ee2008-10-13 10:42:39 +0100454extern struct tty_struct *alloc_tty_struct(void);
455extern void free_tty_struct(struct tty_struct *tty);
456extern void initialize_tty_struct(struct tty_struct *tty,
457 struct tty_driver *driver, int idx);
Alan Cox73ec06f2008-10-13 10:42:29 +0100458extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx,
459 int first_ok);
Alan Coxeeb89d92009-11-30 13:18:29 +0000460extern int tty_release(struct inode *inode, struct file *filp);
Alan Coxbf970ee2008-10-13 10:42:39 +0100461extern int tty_init_termios(struct tty_struct *tty);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800462
Alan Coxe8b70e72009-06-11 12:48:02 +0100463extern struct tty_struct *tty_pair_get_tty(struct tty_struct *tty);
464extern struct tty_struct *tty_pair_get_pty(struct tty_struct *tty);
465
Ingo Molnar70522e12006-03-23 03:00:31 -0800466extern struct mutex tty_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
Alan Cox9c1729d2007-07-15 23:39:43 -0700468extern void tty_write_unlock(struct tty_struct *tty);
469extern int tty_write_lock(struct tty_struct *tty, int ndelay);
470#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
471
Alan Cox6f670482008-07-16 21:53:41 +0100472extern void tty_port_init(struct tty_port *port);
473extern int tty_port_alloc_xmit_buf(struct tty_port *port);
474extern void tty_port_free_xmit_buf(struct tty_port *port);
Alan Cox568aafc2009-11-30 13:17:14 +0000475extern void tty_port_put(struct tty_port *port);
476
Randy Dunlap2427b8e2010-01-15 17:01:11 -0800477static inline struct tty_port *tty_port_get(struct tty_port *port)
Alan Cox568aafc2009-11-30 13:17:14 +0000478{
479 if (port)
480 kref_get(&port->kref);
481 return port;
482}
483
Alan Cox4a90f092008-10-13 10:39:46 +0100484extern struct tty_struct *tty_port_tty_get(struct tty_port *port);
485extern void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty);
Alan Cox31f35932009-01-02 13:45:05 +0000486extern int tty_port_carrier_raised(struct tty_port *port);
Alan Cox5d951fb2009-01-02 13:45:19 +0000487extern void tty_port_raise_dtr_rts(struct tty_port *port);
Alan Coxfcc8ac12009-06-11 12:24:17 +0100488extern void tty_port_lower_dtr_rts(struct tty_port *port);
Alan Cox3e616962009-01-02 13:45:26 +0000489extern void tty_port_hangup(struct tty_port *port);
Alan Cox36c621d2009-01-02 13:46:10 +0000490extern int tty_port_block_til_ready(struct tty_port *port,
491 struct tty_struct *tty, struct file *filp);
Alan Coxa6614992009-01-02 13:46:50 +0000492extern int tty_port_close_start(struct tty_port *port,
493 struct tty_struct *tty, struct file *filp);
494extern void tty_port_close_end(struct tty_port *port, struct tty_struct *tty);
Alan Cox7ca0ff92009-09-19 13:13:20 -0700495extern void tty_port_close(struct tty_port *port,
496 struct tty_struct *tty, struct file *filp);
Alan Cox64bc3972009-10-06 16:06:11 +0100497extern int tty_port_open(struct tty_port *port,
498 struct tty_struct *tty, struct file *filp);
Randy Dunlap2427b8e2010-01-15 17:01:11 -0800499static inline int tty_port_users(struct tty_port *port)
Alan Coxb58d13a2009-09-19 13:13:32 -0700500{
501 return port->count + port->blocked_open;
502}
503
Alan Cox01e1abb2008-07-22 11:16:55 +0100504extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
505extern int tty_unregister_ldisc(int disc);
506extern int tty_set_ldisc(struct tty_struct *tty, int ldisc);
507extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty);
508extern void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty);
509extern void tty_ldisc_init(struct tty_struct *tty);
510extern void tty_ldisc_begin(void);
511/* This last one is just for the tty layer internals and shouldn't be used elsewhere */
512extern void tty_ldisc_enable(struct tty_struct *tty);
Alan Cox9c1729d2007-07-15 23:39:43 -0700513
514
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515/* n_tty.c */
Alan Coxa352def2008-07-16 21:53:12 +0100516extern struct tty_ldisc_ops tty_ldisc_N_TTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
Miloslav Trmac522ed772007-07-15 23:40:56 -0700518/* tty_audit.c */
519#ifdef CONFIG_AUDIT
520extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data,
521 size_t size);
522extern void tty_audit_exit(void);
523extern void tty_audit_fork(struct signal_struct *sig);
Al Viro1e641742008-12-09 09:23:33 +0000524extern void tty_audit_tiocsti(struct tty_struct *tty, char ch);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700525extern void tty_audit_push(struct tty_struct *tty);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100526extern void tty_audit_push_task(struct task_struct *tsk,
527 uid_t loginuid, u32 sessionid);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700528#else
529static inline void tty_audit_add_data(struct tty_struct *tty,
530 unsigned char *data, size_t size)
531{
532}
Al Viro1e641742008-12-09 09:23:33 +0000533static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch)
534{
535}
Miloslav Trmac522ed772007-07-15 23:40:56 -0700536static inline void tty_audit_exit(void)
537{
538}
539static inline void tty_audit_fork(struct signal_struct *sig)
540{
541}
542static inline void tty_audit_push(struct tty_struct *tty)
543{
544}
Alan Cox7a4d29f2008-07-16 21:54:54 +0100545static inline void tty_audit_push_task(struct task_struct *tsk,
546 uid_t loginuid, u32 sessionid)
Miloslav Trmac522ed772007-07-15 23:40:56 -0700547{
548}
Miloslav Trmac522ed772007-07-15 23:40:56 -0700549#endif
550
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551/* tty_ioctl.c */
Alan Cox47afa7a2008-10-13 10:44:17 +0100552extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 unsigned int cmd, unsigned long arg);
554
555/* serial.c */
556
557extern void serial_console_init(void);
Alan Cox7a4d29f2008-07-16 21:54:54 +0100558
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559/* pcxx.c */
560
561extern int pcxe_open(struct tty_struct *tty, struct file *filp);
562
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563/* vt.c */
564
Alan Cox7a4d29f2008-07-16 21:54:54 +0100565extern int vt_ioctl(struct tty_struct *tty, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 unsigned int cmd, unsigned long arg);
567
Arnd Bergmanne9216652009-08-06 15:09:28 +0200568extern long vt_compat_ioctl(struct tty_struct *tty, struct file * file,
569 unsigned int cmd, unsigned long arg);
570
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571#endif /* __KERNEL__ */
572#endif