blob: dd8e08fe88551a3d9c9ca2529226bfa55631e69b [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 */
Oliver Hartkoppcd05acf2007-12-16 15:59:24 -080026#define NR_LDISCS 18
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 */
39#define N_PROFIBUS_FDL 10 /* Reserved for Profibus <Dave@mvhi.com> */
40#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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 * This character is the same as _POSIX_VDISABLE: it cannot be used as
51 * a c_cc[] character, but indicates that a particular special character
52 * isn't in use (eg VINTR has no character etc)
53 */
54#define __DISABLED_CHAR '\0'
55
Alan Cox33f0f882006-01-09 20:54:13 -080056struct tty_buffer {
57 struct tty_buffer *next;
58 char *char_buf_ptr;
59 unsigned char *flag_buf_ptr;
60 int used;
61 int size;
Paul Fulghum8977d922006-02-10 01:51:14 -080062 int commit;
63 int read;
Alan Cox33f0f882006-01-09 20:54:13 -080064 /* Data points here */
65 unsigned long data[0];
66};
67
68struct tty_bufhead {
David Howells52bad642006-11-22 14:54:01 +000069 struct delayed_work work;
Paul Fulghum808249c2006-02-03 03:04:41 -080070 spinlock_t lock;
Alan Cox33f0f882006-01-09 20:54:13 -080071 struct tty_buffer *head; /* Queue head */
72 struct tty_buffer *tail; /* Active buffer */
73 struct tty_buffer *free; /* Free queue head */
Alan Cox01da5fd2006-08-27 01:24:02 -070074 int memory_used; /* Buffer space used excluding free queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -070075};
76/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 * When a break, frame error, or parity error happens, these codes are
78 * stuffed into the flags buffer.
79 */
80#define TTY_NORMAL 0
81#define TTY_BREAK 1
82#define TTY_FRAME 2
83#define TTY_PARITY 3
84#define TTY_OVERRUN 4
85
86#define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
87#define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
88#define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
89#define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
90#define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
91#define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
92#define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
93#define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
94#define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
95#define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
96#define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
97#define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
98#define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
99#define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
100#define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
101#define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
102#define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
103
104#define _I_FLAG(tty,f) ((tty)->termios->c_iflag & (f))
105#define _O_FLAG(tty,f) ((tty)->termios->c_oflag & (f))
106#define _C_FLAG(tty,f) ((tty)->termios->c_cflag & (f))
107#define _L_FLAG(tty,f) ((tty)->termios->c_lflag & (f))
108
109#define I_IGNBRK(tty) _I_FLAG((tty),IGNBRK)
110#define I_BRKINT(tty) _I_FLAG((tty),BRKINT)
111#define I_IGNPAR(tty) _I_FLAG((tty),IGNPAR)
112#define I_PARMRK(tty) _I_FLAG((tty),PARMRK)
113#define I_INPCK(tty) _I_FLAG((tty),INPCK)
114#define I_ISTRIP(tty) _I_FLAG((tty),ISTRIP)
115#define I_INLCR(tty) _I_FLAG((tty),INLCR)
116#define I_IGNCR(tty) _I_FLAG((tty),IGNCR)
117#define I_ICRNL(tty) _I_FLAG((tty),ICRNL)
118#define I_IUCLC(tty) _I_FLAG((tty),IUCLC)
119#define I_IXON(tty) _I_FLAG((tty),IXON)
120#define I_IXANY(tty) _I_FLAG((tty),IXANY)
121#define I_IXOFF(tty) _I_FLAG((tty),IXOFF)
122#define I_IMAXBEL(tty) _I_FLAG((tty),IMAXBEL)
123#define I_IUTF8(tty) _I_FLAG((tty),IUTF8)
124
125#define O_OPOST(tty) _O_FLAG((tty),OPOST)
126#define O_OLCUC(tty) _O_FLAG((tty),OLCUC)
127#define O_ONLCR(tty) _O_FLAG((tty),ONLCR)
128#define O_OCRNL(tty) _O_FLAG((tty),OCRNL)
129#define O_ONOCR(tty) _O_FLAG((tty),ONOCR)
130#define O_ONLRET(tty) _O_FLAG((tty),ONLRET)
131#define O_OFILL(tty) _O_FLAG((tty),OFILL)
132#define O_OFDEL(tty) _O_FLAG((tty),OFDEL)
133#define O_NLDLY(tty) _O_FLAG((tty),NLDLY)
134#define O_CRDLY(tty) _O_FLAG((tty),CRDLY)
135#define O_TABDLY(tty) _O_FLAG((tty),TABDLY)
136#define O_BSDLY(tty) _O_FLAG((tty),BSDLY)
137#define O_VTDLY(tty) _O_FLAG((tty),VTDLY)
138#define O_FFDLY(tty) _O_FLAG((tty),FFDLY)
139
140#define C_BAUD(tty) _C_FLAG((tty),CBAUD)
141#define C_CSIZE(tty) _C_FLAG((tty),CSIZE)
142#define C_CSTOPB(tty) _C_FLAG((tty),CSTOPB)
143#define C_CREAD(tty) _C_FLAG((tty),CREAD)
144#define C_PARENB(tty) _C_FLAG((tty),PARENB)
145#define C_PARODD(tty) _C_FLAG((tty),PARODD)
146#define C_HUPCL(tty) _C_FLAG((tty),HUPCL)
147#define C_CLOCAL(tty) _C_FLAG((tty),CLOCAL)
148#define C_CIBAUD(tty) _C_FLAG((tty),CIBAUD)
149#define C_CRTSCTS(tty) _C_FLAG((tty),CRTSCTS)
150
151#define L_ISIG(tty) _L_FLAG((tty),ISIG)
152#define L_ICANON(tty) _L_FLAG((tty),ICANON)
153#define L_XCASE(tty) _L_FLAG((tty),XCASE)
154#define L_ECHO(tty) _L_FLAG((tty),ECHO)
155#define L_ECHOE(tty) _L_FLAG((tty),ECHOE)
156#define L_ECHOK(tty) _L_FLAG((tty),ECHOK)
157#define L_ECHONL(tty) _L_FLAG((tty),ECHONL)
158#define L_NOFLSH(tty) _L_FLAG((tty),NOFLSH)
159#define L_TOSTOP(tty) _L_FLAG((tty),TOSTOP)
160#define L_ECHOCTL(tty) _L_FLAG((tty),ECHOCTL)
161#define L_ECHOPRT(tty) _L_FLAG((tty),ECHOPRT)
162#define L_ECHOKE(tty) _L_FLAG((tty),ECHOKE)
163#define L_FLUSHO(tty) _L_FLAG((tty),FLUSHO)
164#define L_PENDIN(tty) _L_FLAG((tty),PENDIN)
165#define L_IEXTEN(tty) _L_FLAG((tty),IEXTEN)
166
167struct device;
Miloslav Trmac522ed772007-07-15 23:40:56 -0700168struct signal_struct;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169/*
170 * Where all of the state associated with a tty is kept while the tty
171 * is open. Since the termios state should be kept even if the tty
172 * has been closed --- for things like the baud rate, etc --- it is
173 * not stored here, but rather a pointer to the real state is stored
174 * here. Possible the winsize structure should have the same
175 * treatment, but (1) the default 80x24 is usually right and (2) it's
176 * most often used by a windowing system, which will set the correct
177 * size each time the window is created or resized anyway.
178 * - TYT, 9/14/92
179 */
180struct tty_struct {
181 int magic;
182 struct tty_driver *driver;
183 int index;
184 struct tty_ldisc ldisc;
Arjan van de Ven5785c952006-09-29 02:00:43 -0700185 struct mutex termios_mutex;
Alan Coxedc6afc2006-12-08 02:38:44 -0800186 struct ktermios *termios, *termios_locked;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 char name[64];
Eric W. Biedermanab521dc2007-02-12 00:53:00 -0800188 struct pid *pgrp;
189 struct pid *session;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 unsigned long flags;
191 int count;
192 struct winsize winsize;
193 unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
194 unsigned char low_latency:1, warned:1;
195 unsigned char ctrl_status;
Alan Cox33f0f882006-01-09 20:54:13 -0800196 unsigned int receive_room; /* Bytes free for queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
198 struct tty_struct *link;
199 struct fasync_struct *fasync;
Alan Cox33f0f882006-01-09 20:54:13 -0800200 struct tty_bufhead buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 int alt_speed; /* For magic substitution of 38400 bps */
202 wait_queue_head_t write_wait;
203 wait_queue_head_t read_wait;
204 struct work_struct hangup_work;
205 void *disc_data;
206 void *driver_data;
207 struct list_head tty_files;
208
209#define N_TTY_BUF_SIZE 4096
210
211 /*
212 * The following is data for the N_TTY line discipline. For
213 * historical reasons, this is included in the tty structure.
214 */
215 unsigned int column;
216 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
217 unsigned char closing:1;
218 unsigned short minimum_to_wake;
219 unsigned long overrun_time;
220 int num_overrun;
221 unsigned long process_char_map[256/(8*sizeof(unsigned long))];
222 char *read_buf;
223 int read_head;
224 int read_tail;
225 int read_cnt;
226 unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
227 int canon_data;
228 unsigned long canon_head;
229 unsigned int canon_column;
Ingo Molnar70522e12006-03-23 03:00:31 -0800230 struct mutex atomic_read_lock;
231 struct mutex atomic_write_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 unsigned char *write_buf;
233 int write_cnt;
234 spinlock_t read_lock;
235 /* If the tty has a pending do_SAK, queue it here - akpm */
236 struct work_struct SAK_work;
237};
238
239/* tty magic number */
240#define TTY_MAGIC 0x5401
241
242/*
243 * These bits are used in the flags field of the tty structure.
244 *
245 * So that interrupts won't be able to mess up the queues,
246 * copy_to_cooked must be atomic with respect to itself, as must
247 * tty->write. Thus, you must use the inline functions set_bit() and
248 * clear_bit() to make things atomic.
249 */
250#define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
251#define TTY_IO_ERROR 1 /* Canse an I/O error (may be no ldisc too) */
252#define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
253#define TTY_EXCLUSIVE 3 /* Exclusive open mode */
254#define TTY_DEBUG 4 /* Debugging */
255#define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
256#define TTY_PUSH 6 /* n_tty private */
257#define TTY_CLOSING 7 /* ->close() in progress */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258#define TTY_LDISC 9 /* Line discipline attached */
259#define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */
260#define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */
261#define TTY_PTY_LOCK 16 /* pty private */
262#define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
263#define TTY_HUPPED 18 /* Post driver->hangup() */
Alan Cox42fd5522007-08-10 13:01:05 -0700264#define TTY_FLUSHING 19 /* Flushing to ldisc in progress */
265#define TTY_FLUSHPENDING 20 /* Queued buffer flush pending */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
267#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
268
269extern void tty_write_flush(struct tty_struct *);
270
Alan Coxedc6afc2006-12-08 02:38:44 -0800271extern struct ktermios tty_std_termios;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
273extern int kmsg_redirect;
274
275extern void console_init(void);
276extern int vcs_init(void);
277
278extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
279 const char *routine);
280extern char *tty_name(struct tty_struct *tty, char *buf);
281extern void tty_wait_until_sent(struct tty_struct * tty, long timeout);
282extern int tty_check_change(struct tty_struct * tty);
283extern void stop_tty(struct tty_struct * tty);
284extern void start_tty(struct tty_struct * tty);
285extern int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc);
Alexey Dobriyanbfb07592005-06-23 00:10:32 -0700286extern int tty_unregister_ldisc(int disc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287extern int tty_register_driver(struct tty_driver *driver);
288extern int tty_unregister_driver(struct tty_driver *driver);
Greg Kroah-Hartman01107d32006-08-07 22:19:37 -0700289extern struct device *tty_register_device(struct tty_driver *driver,
290 unsigned index, struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
292extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
293 int buflen);
294extern void tty_write_message(struct tty_struct *tty, char *msg);
295
Eric W. Biederman3e7cd6c2007-02-12 00:52:58 -0800296extern int is_current_pgrp_orphaned(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297extern int is_ignored(int sig);
298extern int tty_signal(int sig, struct tty_struct *tty);
299extern void tty_hangup(struct tty_struct * tty);
300extern void tty_vhangup(struct tty_struct * tty);
301extern void tty_unhangup(struct file *filp);
302extern int tty_hung_up_p(struct file * filp);
Miloslav Trmac522ed772007-07-15 23:40:56 -0700303extern int is_tty(struct file *filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304extern void do_SAK(struct tty_struct *tty);
Eric W. Biederman8b6312f2007-02-10 01:44:34 -0800305extern void __do_SAK(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306extern void disassociate_ctty(int priv);
Eric W. Biederman98a27ba2007-05-08 00:26:56 -0700307extern void no_tty(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308extern void tty_flip_buffer_push(struct tty_struct *tty);
Alan Coxedc6afc2006-12-08 02:38:44 -0800309extern speed_t tty_get_baud_rate(struct tty_struct *tty);
310extern speed_t tty_termios_baud_rate(struct ktermios *termios);
311extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
Alan Cox5f519d72007-10-16 23:30:07 -0700312extern void tty_termios_encode_baud_rate(struct ktermios *termios, speed_t ibaud, speed_t obaud);
313extern void tty_encode_baud_rate(struct tty_struct *tty, speed_t ibaud, speed_t obaud);
314extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
Alan Coxbf5e5832008-01-08 14:55:51 +0000315extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
317extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
318extern void tty_ldisc_deref(struct tty_ldisc *);
319extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
320
321extern struct tty_ldisc *tty_ldisc_get(int);
322extern void tty_ldisc_put(int);
323
324extern void tty_wakeup(struct tty_struct *tty);
325extern void tty_ldisc_flush(struct tty_struct *tty);
326
David Howells07f3f052006-09-30 20:52:18 +0200327extern int tty_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
328 unsigned long arg);
Alan Cox0fc00e22007-11-07 01:24:56 -0800329extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
330 unsigned int cmd, unsigned long arg);
331extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800332extern dev_t tty_devnum(struct tty_struct *tty);
333extern void proc_clear_tty(struct task_struct *p);
Peter Zijlstra24ec8392006-12-08 02:36:04 -0800334extern struct tty_struct *get_current_tty(void);
335
Ingo Molnar70522e12006-03-23 03:00:31 -0800336extern struct mutex tty_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
Alan Cox9c1729d2007-07-15 23:39:43 -0700338extern void tty_write_unlock(struct tty_struct *tty);
339extern int tty_write_lock(struct tty_struct *tty, int ndelay);
340#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
341
342
343
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344/* n_tty.c */
345extern struct tty_ldisc tty_ldisc_N_TTY;
346
Miloslav Trmac522ed772007-07-15 23:40:56 -0700347/* tty_audit.c */
348#ifdef CONFIG_AUDIT
349extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data,
350 size_t size);
351extern void tty_audit_exit(void);
352extern void tty_audit_fork(struct signal_struct *sig);
353extern void tty_audit_push(struct tty_struct *tty);
354extern void tty_audit_push_task(struct task_struct *tsk, uid_t loginuid);
355extern void tty_audit_opening(void);
356#else
357static inline void tty_audit_add_data(struct tty_struct *tty,
358 unsigned char *data, size_t size)
359{
360}
361static inline void tty_audit_exit(void)
362{
363}
364static inline void tty_audit_fork(struct signal_struct *sig)
365{
366}
367static inline void tty_audit_push(struct tty_struct *tty)
368{
369}
370static inline void tty_audit_push_task(struct task_struct *tsk, uid_t loginuid)
371{
372}
373static inline void tty_audit_opening(void)
374{
375}
376#endif
377
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378/* tty_ioctl.c */
379extern int n_tty_ioctl(struct tty_struct * tty, struct file * file,
380 unsigned int cmd, unsigned long arg);
381
382/* serial.c */
383
384extern void serial_console_init(void);
385
386/* pcxx.c */
387
388extern int pcxe_open(struct tty_struct *tty, struct file *filp);
389
390/* printk.c */
391
392extern void console_print(const char *);
393
394/* vt.c */
395
396extern int vt_ioctl(struct tty_struct *tty, struct file * file,
397 unsigned int cmd, unsigned long arg);
398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399#endif /* __KERNEL__ */
400#endif