tty: Ldisc revamp
[linux-2.6-block.git] / include / linux / tty.h
CommitLineData
1da177e4
LT
1#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
1da177e4 8#ifdef __KERNEL__
1da177e4
LT
9#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>
70522e12 15#include <linux/mutex.h>
1da177e4
LT
16
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 */
1da177e4
LT
24#define NR_UNIX98_PTY_DEFAULT 4096 /* Default maximum for Unix98 ptys */
25#define NR_UNIX98_PTY_MAX (1 << MINORBITS) /* Absolute limit */
cd05acfe 26#define NR_LDISCS 18
4564f9e5
TS
27
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 */
44d1b980 39#define N_PROFIBUS_FDL 10 /* Reserved for Profibus */
4564f9e5
TS
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 */
cd05acfe 47#define N_SLCAN 17 /* Serial / USB serial CAN Adaptors */
1da177e4 48
1da177e4
LT
49/*
50 * 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
33f0f88f
AC
56struct tty_buffer {
57 struct tty_buffer *next;
58 char *char_buf_ptr;
59 unsigned char *flag_buf_ptr;
60 int used;
61 int size;
8977d929
PF
62 int commit;
63 int read;
33f0f88f
AC
64 /* Data points here */
65 unsigned long data[0];
66};
67
68struct tty_bufhead {
52bad64d 69 struct delayed_work work;
808249ce 70 spinlock_t lock;
33f0f88f
AC
71 struct tty_buffer *head; /* Queue head */
72 struct tty_buffer *tail; /* Active buffer */
73 struct tty_buffer *free; /* Free queue head */
01da5fd8 74 int memory_used; /* Buffer space used excluding free queue */
1da177e4 75};
1da177e4
LT
76/*
77 * 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;
522ed776 168struct signal_struct;
1da177e4
LT
169/*
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 */
f34d7a5b
AC
180
181struct tty_operations;
182
1da177e4
LT
183struct tty_struct {
184 int magic;
185 struct tty_driver *driver;
f34d7a5b 186 const struct tty_operations *ops;
1da177e4 187 int index;
a352def2 188 /* The ldisc objects are protected by tty_ldisc_lock at the moment */
1da177e4 189 struct tty_ldisc ldisc;
5785c95b 190 struct mutex termios_mutex;
04f378b1 191 spinlock_t ctrl_lock;
47f86834 192 /* Termios values are protected by the termios mutex */
edc6afc5 193 struct ktermios *termios, *termios_locked;
1da177e4 194 char name[64];
47f86834 195 struct pid *pgrp; /* Protected by ctrl lock */
ab521dc0 196 struct pid *session;
1da177e4
LT
197 unsigned long flags;
198 int count;
47f86834 199 struct winsize winsize; /* termios mutex */
1da177e4
LT
200 unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
201 unsigned char low_latency:1, warned:1;
47f86834 202 unsigned char ctrl_status; /* ctrl_lock */
33f0f88f 203 unsigned int receive_room; /* Bytes free for queue */
1da177e4
LT
204
205 struct tty_struct *link;
206 struct fasync_struct *fasync;
47f86834 207 struct tty_bufhead buf; /* Locked internally */
1da177e4
LT
208 int alt_speed; /* For magic substitution of 38400 bps */
209 wait_queue_head_t write_wait;
210 wait_queue_head_t read_wait;
211 struct work_struct hangup_work;
212 void *disc_data;
213 void *driver_data;
214 struct list_head tty_files;
215
216#define N_TTY_BUF_SIZE 4096
217
218 /*
219 * The following is data for the N_TTY line discipline. For
220 * historical reasons, this is included in the tty structure.
47f86834 221 * Mostly locked by the BKL.
1da177e4
LT
222 */
223 unsigned int column;
224 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
225 unsigned char closing:1;
226 unsigned short minimum_to_wake;
227 unsigned long overrun_time;
228 int num_overrun;
229 unsigned long process_char_map[256/(8*sizeof(unsigned long))];
230 char *read_buf;
231 int read_head;
232 int read_tail;
233 int read_cnt;
234 unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
235 int canon_data;
236 unsigned long canon_head;
237 unsigned int canon_column;
70522e12
IM
238 struct mutex atomic_read_lock;
239 struct mutex atomic_write_lock;
1da177e4
LT
240 unsigned char *write_buf;
241 int write_cnt;
242 spinlock_t read_lock;
243 /* If the tty has a pending do_SAK, queue it here - akpm */
244 struct work_struct SAK_work;
245};
246
247/* tty magic number */
248#define TTY_MAGIC 0x5401
249
250/*
251 * These bits are used in the flags field of the tty structure.
252 *
253 * So that interrupts won't be able to mess up the queues,
254 * copy_to_cooked must be atomic with respect to itself, as must
255 * tty->write. Thus, you must use the inline functions set_bit() and
256 * clear_bit() to make things atomic.
257 */
258#define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
259#define TTY_IO_ERROR 1 /* Canse an I/O error (may be no ldisc too) */
260#define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
261#define TTY_EXCLUSIVE 3 /* Exclusive open mode */
262#define TTY_DEBUG 4 /* Debugging */
263#define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
264#define TTY_PUSH 6 /* n_tty private */
265#define TTY_CLOSING 7 /* ->close() in progress */
1da177e4
LT
266#define TTY_LDISC 9 /* Line discipline attached */
267#define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */
268#define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */
269#define TTY_PTY_LOCK 16 /* pty private */
270#define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
271#define TTY_HUPPED 18 /* Post driver->hangup() */
42fd552e
AC
272#define TTY_FLUSHING 19 /* Flushing to ldisc in progress */
273#define TTY_FLUSHPENDING 20 /* Queued buffer flush pending */
1da177e4
LT
274
275#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
276
277extern void tty_write_flush(struct tty_struct *);
278
edc6afc5 279extern struct ktermios tty_std_termios;
1da177e4
LT
280
281extern int kmsg_redirect;
282
283extern void console_init(void);
284extern int vcs_init(void);
285
286extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
287 const char *routine);
288extern char *tty_name(struct tty_struct *tty, char *buf);
289extern void tty_wait_until_sent(struct tty_struct * tty, long timeout);
290extern int tty_check_change(struct tty_struct * tty);
291extern void stop_tty(struct tty_struct * tty);
292extern void start_tty(struct tty_struct * tty);
a352def2 293extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
bfb07599 294extern int tty_unregister_ldisc(int disc);
1da177e4
LT
295extern int tty_register_driver(struct tty_driver *driver);
296extern int tty_unregister_driver(struct tty_driver *driver);
01107d34
GKH
297extern struct device *tty_register_device(struct tty_driver *driver,
298 unsigned index, struct device *dev);
1da177e4
LT
299extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
300extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
301 int buflen);
302extern void tty_write_message(struct tty_struct *tty, char *msg);
f34d7a5b
AC
303extern int tty_put_char(struct tty_struct *tty, unsigned char c);
304extern int tty_chars_in_buffer(struct tty_struct *tty);
305extern int tty_write_room(struct tty_struct *tty);
306extern void tty_driver_flush_buffer(struct tty_struct *tty);
39c2e60f
AC
307extern void tty_throttle(struct tty_struct *tty);
308extern void tty_unthrottle(struct tty_struct *tty);
1da177e4 309
3e7cd6c4 310extern int is_current_pgrp_orphaned(void);
5d0fdf1e 311extern struct pid *tty_get_pgrp(struct tty_struct *tty);
1da177e4
LT
312extern int is_ignored(int sig);
313extern int tty_signal(int sig, struct tty_struct *tty);
314extern void tty_hangup(struct tty_struct * tty);
315extern void tty_vhangup(struct tty_struct * tty);
316extern void tty_unhangup(struct file *filp);
317extern int tty_hung_up_p(struct file * filp);
318extern void do_SAK(struct tty_struct *tty);
8b6312f4 319extern void __do_SAK(struct tty_struct *tty);
1da177e4 320extern void disassociate_ctty(int priv);
98a27ba4 321extern void no_tty(void);
1da177e4 322extern void tty_flip_buffer_push(struct tty_struct *tty);
edc6afc5
AC
323extern speed_t tty_get_baud_rate(struct tty_struct *tty);
324extern speed_t tty_termios_baud_rate(struct ktermios *termios);
325extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
5f519d72
AC
326extern void tty_termios_encode_baud_rate(struct ktermios *termios, speed_t ibaud, speed_t obaud);
327extern void tty_encode_baud_rate(struct tty_struct *tty, speed_t ibaud, speed_t obaud);
328extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
bf5e5834 329extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
1da177e4
LT
330
331extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
332extern void tty_ldisc_deref(struct tty_ldisc *);
333extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
a352def2 334extern const struct file_operations tty_ldiscs_proc_fops;
1da177e4
LT
335
336extern void tty_wakeup(struct tty_struct *tty);
337extern void tty_ldisc_flush(struct tty_struct *tty);
338
04f378b1 339extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
0fc00e24
AC
340extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
341 unsigned int cmd, unsigned long arg);
342extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
24ec839c
PZ
343extern dev_t tty_devnum(struct tty_struct *tty);
344extern void proc_clear_tty(struct task_struct *p);
24ec839c
PZ
345extern struct tty_struct *get_current_tty(void);
346
70522e12 347extern struct mutex tty_mutex;
1da177e4 348
9c1729db
AC
349extern void tty_write_unlock(struct tty_struct *tty);
350extern int tty_write_lock(struct tty_struct *tty, int ndelay);
351#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
352
353
354
1da177e4 355/* n_tty.c */
a352def2 356extern struct tty_ldisc_ops tty_ldisc_N_TTY;
1da177e4 357
522ed776
MT
358/* tty_audit.c */
359#ifdef CONFIG_AUDIT
360extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data,
361 size_t size);
362extern void tty_audit_exit(void);
363extern void tty_audit_fork(struct signal_struct *sig);
364extern void tty_audit_push(struct tty_struct *tty);
2532386f 365extern void tty_audit_push_task(struct task_struct *tsk, uid_t loginuid, u32 sessionid);
522ed776
MT
366#else
367static inline void tty_audit_add_data(struct tty_struct *tty,
368 unsigned char *data, size_t size)
369{
370}
371static inline void tty_audit_exit(void)
372{
373}
374static inline void tty_audit_fork(struct signal_struct *sig)
375{
376}
377static inline void tty_audit_push(struct tty_struct *tty)
378{
379}
2532386f 380static inline void tty_audit_push_task(struct task_struct *tsk, uid_t loginuid, u32 sessionid)
522ed776
MT
381{
382}
522ed776
MT
383#endif
384
1da177e4
LT
385/* tty_ioctl.c */
386extern int n_tty_ioctl(struct tty_struct * tty, struct file * file,
387 unsigned int cmd, unsigned long arg);
388
389/* serial.c */
390
391extern void serial_console_init(void);
392
393/* pcxx.c */
394
395extern int pcxe_open(struct tty_struct *tty, struct file *filp);
396
397/* printk.c */
398
399extern void console_print(const char *);
400
401/* vt.c */
402
403extern int vt_ioctl(struct tty_struct *tty, struct file * file,
404 unsigned int cmd, unsigned long arg);
405
1da177e4
LT
406#endif /* __KERNEL__ */
407#endif