1#ifndef _LINUX_TTY_H
2#define _LINUX_TTY_H
3
4
5
6
7
8#define NR_LDISCS 30
9
10
11#define N_TTY 0
12#define N_SLIP 1
13#define N_MOUSE 2
14#define N_PPP 3
15#define N_STRIP 4
16#define N_AX25 5
17#define N_X25 6
18#define N_6PACK 7
19#define N_MASC 8
20#define N_R3964 9
21#define N_PROFIBUS_FDL 10
22#define N_IRDA 11
23#define N_SMSBLOCK 12
24
25#define N_HDLC 13
26#define N_SYNC_PPP 14
27#define N_HCI 15
28#define N_GIGASET_M101 16
29#define N_SLCAN 17
30#define N_PPS 18
31#define N_V253 19
32#define N_CAIF 20
33#define N_GSM0710 21
34#define N_TI_WL 22
35#define N_TRACESINK 23
36#define N_TRACEROUTER 24
37
38#ifdef __KERNEL__
39#include <linux/fs.h>
40#include <linux/major.h>
41#include <linux/termios.h>
42#include <linux/workqueue.h>
43#include <linux/tty_driver.h>
44#include <linux/tty_ldisc.h>
45#include <linux/mutex.h>
46
47
48
49
50
51
52
53#define NR_UNIX98_PTY_DEFAULT 4096
54#define NR_UNIX98_PTY_RESERVE 1024
55#define NR_UNIX98_PTY_MAX (1 << MINORBITS)
56
57
58
59
60
61
62#define __DISABLED_CHAR '\0'
63
64struct tty_buffer {
65 struct tty_buffer *next;
66 char *char_buf_ptr;
67 unsigned char *flag_buf_ptr;
68 int used;
69 int size;
70 int commit;
71 int read;
72
73 unsigned long data[0];
74};
75
76
77
78
79
80
81
82
83
84#define TTY_BUFFER_PAGE (((PAGE_SIZE - sizeof(struct tty_buffer)) / 2) & ~0xFF)
85
86
87struct tty_bufhead {
88 struct work_struct work;
89 spinlock_t lock;
90 struct tty_buffer *head;
91 struct tty_buffer *tail;
92 struct tty_buffer *free;
93 int memory_used;
94
95};
96
97
98
99
100#define TTY_NORMAL 0
101#define TTY_BREAK 1
102#define TTY_FRAME 2
103#define TTY_PARITY 3
104#define TTY_OVERRUN 4
105
106#define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
107#define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
108#define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
109#define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
110#define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
111#define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
112#define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
113#define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
114#define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
115#define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
116#define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
117#define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
118#define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
119#define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
120#define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
121#define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
122#define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
123
124#define _I_FLAG(tty, f) ((tty)->termios->c_iflag & (f))
125#define _O_FLAG(tty, f) ((tty)->termios->c_oflag & (f))
126#define _C_FLAG(tty, f) ((tty)->termios->c_cflag & (f))
127#define _L_FLAG(tty, f) ((tty)->termios->c_lflag & (f))
128
129#define I_IGNBRK(tty) _I_FLAG((tty), IGNBRK)
130#define I_BRKINT(tty) _I_FLAG((tty), BRKINT)
131#define I_IGNPAR(tty) _I_FLAG((tty), IGNPAR)
132#define I_PARMRK(tty) _I_FLAG((tty), PARMRK)
133#define I_INPCK(tty) _I_FLAG((tty), INPCK)
134#define I_ISTRIP(tty) _I_FLAG((tty), ISTRIP)
135#define I_INLCR(tty) _I_FLAG((tty), INLCR)
136#define I_IGNCR(tty) _I_FLAG((tty), IGNCR)
137#define I_ICRNL(tty) _I_FLAG((tty), ICRNL)
138#define I_IUCLC(tty) _I_FLAG((tty), IUCLC)
139#define I_IXON(tty) _I_FLAG((tty), IXON)
140#define I_IXANY(tty) _I_FLAG((tty), IXANY)
141#define I_IXOFF(tty) _I_FLAG((tty), IXOFF)
142#define I_IMAXBEL(tty) _I_FLAG((tty), IMAXBEL)
143#define I_IUTF8(tty) _I_FLAG((tty), IUTF8)
144
145#define O_OPOST(tty) _O_FLAG((tty), OPOST)
146#define O_OLCUC(tty) _O_FLAG((tty), OLCUC)
147#define O_ONLCR(tty) _O_FLAG((tty), ONLCR)
148#define O_OCRNL(tty) _O_FLAG((tty), OCRNL)
149#define O_ONOCR(tty) _O_FLAG((tty), ONOCR)
150#define O_ONLRET(tty) _O_FLAG((tty), ONLRET)
151#define O_OFILL(tty) _O_FLAG((tty), OFILL)
152#define O_OFDEL(tty) _O_FLAG((tty), OFDEL)
153#define O_NLDLY(tty) _O_FLAG((tty), NLDLY)
154#define O_CRDLY(tty) _O_FLAG((tty), CRDLY)
155#define O_TABDLY(tty) _O_FLAG((tty), TABDLY)
156#define O_BSDLY(tty) _O_FLAG((tty), BSDLY)
157#define O_VTDLY(tty) _O_FLAG((tty), VTDLY)
158#define O_FFDLY(tty) _O_FLAG((tty), FFDLY)
159
160#define C_BAUD(tty) _C_FLAG((tty), CBAUD)
161#define C_CSIZE(tty) _C_FLAG((tty), CSIZE)
162#define C_CSTOPB(tty) _C_FLAG((tty), CSTOPB)
163#define C_CREAD(tty) _C_FLAG((tty), CREAD)
164#define C_PARENB(tty) _C_FLAG((tty), PARENB)
165#define C_PARODD(tty) _C_FLAG((tty), PARODD)
166#define C_HUPCL(tty) _C_FLAG((tty), HUPCL)
167#define C_CLOCAL(tty) _C_FLAG((tty), CLOCAL)
168#define C_CIBAUD(tty) _C_FLAG((tty), CIBAUD)
169#define C_CRTSCTS(tty) _C_FLAG((tty), CRTSCTS)
170
171#define L_ISIG(tty) _L_FLAG((tty), ISIG)
172#define L_ICANON(tty) _L_FLAG((tty), ICANON)
173#define L_XCASE(tty) _L_FLAG((tty), XCASE)
174#define L_ECHO(tty) _L_FLAG((tty), ECHO)
175#define L_ECHOE(tty) _L_FLAG((tty), ECHOE)
176#define L_ECHOK(tty) _L_FLAG((tty), ECHOK)
177#define L_ECHONL(tty) _L_FLAG((tty), ECHONL)
178#define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH)
179#define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP)
180#define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL)
181#define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT)
182#define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE)
183#define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO)
184#define L_PENDIN(tty) _L_FLAG((tty), PENDIN)
185#define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN)
186#define L_EXTPROC(tty) _L_FLAG((tty), EXTPROC)
187
188struct device;
189struct signal_struct;
190
191
192
193
194
195
196
197
198
199
200
201
202struct tty_port;
203
204struct tty_port_operations {
205
206 int (*carrier_raised)(struct tty_port *port);
207
208 void (*dtr_rts)(struct tty_port *port, int raise);
209
210
211
212 void (*shutdown)(struct tty_port *port);
213 void (*drop)(struct tty_port *port);
214
215
216
217
218 int (*activate)(struct tty_port *port, struct tty_struct *tty);
219
220 void (*destruct)(struct tty_port *port);
221};
222
223struct tty_port {
224 struct tty_struct *tty;
225 const struct tty_port_operations *ops;
226 spinlock_t lock;
227 int blocked_open;
228 int count;
229 wait_queue_head_t open_wait;
230 wait_queue_head_t close_wait;
231 wait_queue_head_t delta_msr_wait;
232 unsigned long flags;
233 unsigned char console:1;
234 struct mutex mutex;
235 struct mutex buf_mutex;
236 unsigned char *xmit_buf;
237 unsigned int close_delay;
238 unsigned int closing_wait;
239 int drain_delay;
240
241
242 struct kref kref;
243};
244
245
246
247
248
249
250
251
252
253
254
255
256
257struct tty_operations;
258
259struct tty_struct {
260 int magic;
261 struct kref kref;
262 struct device *dev;
263 struct tty_driver *driver;
264 const struct tty_operations *ops;
265 int index;
266
267
268 struct mutex ldisc_mutex;
269 struct tty_ldisc *ldisc;
270
271 struct mutex termios_mutex;
272 spinlock_t ctrl_lock;
273
274 struct ktermios *termios, *termios_locked;
275 struct termiox *termiox;
276 char name[64];
277 struct pid *pgrp;
278 struct pid *session;
279 unsigned long flags;
280 int count;
281 struct winsize winsize;
282 unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
283 unsigned char low_latency:1, warned:1;
284 unsigned char ctrl_status;
285 unsigned int receive_room;
286
287 struct tty_struct *link;
288 struct fasync_struct *fasync;
289 struct tty_bufhead buf;
290 int alt_speed;
291 wait_queue_head_t write_wait;
292 wait_queue_head_t read_wait;
293 struct work_struct hangup_work;
294 void *disc_data;
295 void *driver_data;
296 struct list_head tty_files;
297
298#define N_TTY_BUF_SIZE 4096
299
300
301
302
303
304
305 unsigned int column;
306 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
307 unsigned char closing:1;
308 unsigned char echo_overrun:1;
309 unsigned short minimum_to_wake;
310 unsigned long overrun_time;
311 int num_overrun;
312 unsigned long process_char_map[256/(8*sizeof(unsigned long))];
313 char *read_buf;
314 int read_head;
315 int read_tail;
316 int read_cnt;
317 unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
318 unsigned char *echo_buf;
319 unsigned int echo_pos;
320 unsigned int echo_cnt;
321 int canon_data;
322 unsigned long canon_head;
323 unsigned int canon_column;
324 struct mutex atomic_read_lock;
325 struct mutex atomic_write_lock;
326 struct mutex output_lock;
327 struct mutex echo_lock;
328 unsigned char *write_buf;
329 int write_cnt;
330 spinlock_t read_lock;
331
332 struct work_struct SAK_work;
333 struct tty_port *port;
334};
335
336
337struct tty_file_private {
338 struct tty_struct *tty;
339 struct file *file;
340 struct list_head list;
341};
342
343
344#define TTY_MAGIC 0x5401
345
346
347
348
349
350
351
352
353
354#define TTY_THROTTLED 0
355#define TTY_IO_ERROR 1
356#define TTY_OTHER_CLOSED 2
357#define TTY_EXCLUSIVE 3
358#define TTY_DEBUG 4
359#define TTY_DO_WRITE_WAKEUP 5
360#define TTY_PUSH 6
361#define TTY_CLOSING 7
362#define TTY_LDISC 9
363#define TTY_LDISC_CHANGING 10
364#define TTY_LDISC_OPEN 11
365#define TTY_HW_COOK_OUT 14
366#define TTY_HW_COOK_IN 15
367#define TTY_PTY_LOCK 16
368#define TTY_NO_WRITE_SPLIT 17
369#define TTY_HUPPED 18
370#define TTY_FLUSHING 19
371#define TTY_FLUSHPENDING 20
372#define TTY_HUPPING 21
373
374#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
375
376extern void tty_write_flush(struct tty_struct *);
377
378extern struct ktermios tty_std_termios;
379
380extern void console_init(void);
381extern int vcs_init(void);
382
383extern struct class *tty_class;
384
385
386
387
388
389
390
391
392
393
394static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
395{
396 if (tty)
397 kref_get(&tty->kref);
398 return tty;
399}
400extern void tty_kref_put(struct tty_struct *tty);
401
402extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
403 const char *routine);
404extern char *tty_name(struct tty_struct *tty, char *buf);
405extern void tty_wait_until_sent(struct tty_struct *tty, long timeout);
406extern int tty_check_change(struct tty_struct *tty);
407extern void stop_tty(struct tty_struct *tty);
408extern void start_tty(struct tty_struct *tty);
409extern int tty_register_driver(struct tty_driver *driver);
410extern int tty_unregister_driver(struct tty_driver *driver);
411extern struct device *tty_register_device(struct tty_driver *driver,
412 unsigned index, struct device *dev);
413extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
414extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
415 int buflen);
416extern void tty_write_message(struct tty_struct *tty, char *msg);
417extern int tty_put_char(struct tty_struct *tty, unsigned char c);
418extern int tty_chars_in_buffer(struct tty_struct *tty);
419extern int tty_write_room(struct tty_struct *tty);
420extern void tty_driver_flush_buffer(struct tty_struct *tty);
421extern void tty_throttle(struct tty_struct *tty);
422extern void tty_unthrottle(struct tty_struct *tty);
423extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
424extern void tty_driver_remove_tty(struct tty_driver *driver,
425 struct tty_struct *tty);
426extern void tty_shutdown(struct tty_struct *tty);
427extern void tty_free_termios(struct tty_struct *tty);
428extern int is_current_pgrp_orphaned(void);
429extern struct pid *tty_get_pgrp(struct tty_struct *tty);
430extern int is_ignored(int sig);
431extern int tty_signal(int sig, struct tty_struct *tty);
432extern void tty_hangup(struct tty_struct *tty);
433extern void tty_vhangup(struct tty_struct *tty);
434extern void tty_vhangup_locked(struct tty_struct *tty);
435extern void tty_vhangup_self(void);
436extern void tty_unhangup(struct file *filp);
437extern int tty_hung_up_p(struct file *filp);
438extern void do_SAK(struct tty_struct *tty);
439extern void __do_SAK(struct tty_struct *tty);
440extern void disassociate_ctty(int priv);
441extern void no_tty(void);
442extern void tty_flip_buffer_push(struct tty_struct *tty);
443extern void tty_flush_to_ldisc(struct tty_struct *tty);
444extern void tty_buffer_free_all(struct tty_struct *tty);
445extern void tty_buffer_flush(struct tty_struct *tty);
446extern void tty_buffer_init(struct tty_struct *tty);
447extern speed_t tty_get_baud_rate(struct tty_struct *tty);
448extern speed_t tty_termios_baud_rate(struct ktermios *termios);
449extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
450extern void tty_termios_encode_baud_rate(struct ktermios *termios,
451 speed_t ibaud, speed_t obaud);
452extern void tty_encode_baud_rate(struct tty_struct *tty,
453 speed_t ibaud, speed_t obaud);
454extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
455extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
456extern int tty_set_termios(struct tty_struct *tty, struct ktermios *kt);
457
458extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
459extern void tty_ldisc_deref(struct tty_ldisc *);
460extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
461extern void tty_ldisc_hangup(struct tty_struct *tty);
462extern const struct file_operations tty_ldiscs_proc_fops;
463
464extern void tty_wakeup(struct tty_struct *tty);
465extern void tty_ldisc_flush(struct tty_struct *tty);
466
467extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
468extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
469 unsigned int cmd, unsigned long arg);
470extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
471extern dev_t tty_devnum(struct tty_struct *tty);
472extern void proc_clear_tty(struct task_struct *p);
473extern struct tty_struct *get_current_tty(void);
474extern void tty_default_fops(struct file_operations *fops);
475extern struct tty_struct *alloc_tty_struct(void);
476extern int tty_alloc_file(struct file *file);
477extern void tty_add_file(struct tty_struct *tty, struct file *file);
478extern void tty_free_file(struct file *file);
479extern void free_tty_struct(struct tty_struct *tty);
480extern void initialize_tty_struct(struct tty_struct *tty,
481 struct tty_driver *driver, int idx);
482extern void deinitialize_tty_struct(struct tty_struct *tty);
483extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx);
484extern int tty_release(struct inode *inode, struct file *filp);
485extern int tty_init_termios(struct tty_struct *tty);
486extern int tty_standard_install(struct tty_driver *driver,
487 struct tty_struct *tty);
488
489extern struct tty_struct *tty_pair_get_tty(struct tty_struct *tty);
490extern struct tty_struct *tty_pair_get_pty(struct tty_struct *tty);
491
492extern struct mutex tty_mutex;
493extern spinlock_t tty_files_lock;
494
495extern void tty_write_unlock(struct tty_struct *tty);
496extern int tty_write_lock(struct tty_struct *tty, int ndelay);
497#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
498
499extern void tty_port_init(struct tty_port *port);
500extern int tty_port_alloc_xmit_buf(struct tty_port *port);
501extern void tty_port_free_xmit_buf(struct tty_port *port);
502extern void tty_port_put(struct tty_port *port);
503
504static inline struct tty_port *tty_port_get(struct tty_port *port)
505{
506 if (port)
507 kref_get(&port->kref);
508 return port;
509}
510
511extern struct tty_struct *tty_port_tty_get(struct tty_port *port);
512extern void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty);
513extern int tty_port_carrier_raised(struct tty_port *port);
514extern void tty_port_raise_dtr_rts(struct tty_port *port);
515extern void tty_port_lower_dtr_rts(struct tty_port *port);
516extern void tty_port_hangup(struct tty_port *port);
517extern int tty_port_block_til_ready(struct tty_port *port,
518 struct tty_struct *tty, struct file *filp);
519extern int tty_port_close_start(struct tty_port *port,
520 struct tty_struct *tty, struct file *filp);
521extern void tty_port_close_end(struct tty_port *port, struct tty_struct *tty);
522extern void tty_port_close(struct tty_port *port,
523 struct tty_struct *tty, struct file *filp);
524extern int tty_port_open(struct tty_port *port,
525 struct tty_struct *tty, struct file *filp);
526static inline int tty_port_users(struct tty_port *port)
527{
528 return port->count + port->blocked_open;
529}
530
531extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
532extern int tty_unregister_ldisc(int disc);
533extern int tty_set_ldisc(struct tty_struct *tty, int ldisc);
534extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty);
535extern void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty);
536extern void tty_ldisc_init(struct tty_struct *tty);
537extern void tty_ldisc_deinit(struct tty_struct *tty);
538extern void tty_ldisc_begin(void);
539
540extern void tty_ldisc_enable(struct tty_struct *tty);
541
542
543
544extern struct tty_ldisc_ops tty_ldisc_N_TTY;
545extern void n_tty_inherit_ops(struct tty_ldisc_ops *ops);
546
547
548#ifdef CONFIG_AUDIT
549extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data,
550 size_t size);
551extern void tty_audit_exit(void);
552extern void tty_audit_fork(struct signal_struct *sig);
553extern void tty_audit_tiocsti(struct tty_struct *tty, char ch);
554extern void tty_audit_push(struct tty_struct *tty);
555extern int tty_audit_push_task(struct task_struct *tsk,
556 uid_t loginuid, u32 sessionid);
557#else
558static inline void tty_audit_add_data(struct tty_struct *tty,
559 unsigned char *data, size_t size)
560{
561}
562static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch)
563{
564}
565static inline void tty_audit_exit(void)
566{
567}
568static inline void tty_audit_fork(struct signal_struct *sig)
569{
570}
571static inline void tty_audit_push(struct tty_struct *tty)
572{
573}
574static inline int tty_audit_push_task(struct task_struct *tsk,
575 uid_t loginuid, u32 sessionid)
576{
577 return 0;
578}
579#endif
580
581
582extern int __init tty_init(void);
583
584
585extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
586 unsigned int cmd, unsigned long arg);
587extern long n_tty_compat_ioctl_helper(struct tty_struct *tty, struct file *file,
588 unsigned int cmd, unsigned long arg);
589
590
591
592extern void serial_console_init(void);
593
594
595
596extern int pcxe_open(struct tty_struct *tty, struct file *filp);
597
598
599
600extern int vt_ioctl(struct tty_struct *tty,
601 unsigned int cmd, unsigned long arg);
602
603extern long vt_compat_ioctl(struct tty_struct *tty,
604 unsigned int cmd, unsigned long arg);
605
606
607
608extern void __lockfunc tty_lock(void) __acquires(tty_lock);
609extern void __lockfunc tty_unlock(void) __releases(tty_lock);
610
611
612
613
614
615
616
617
618
619
620
621static inline void tty_wait_until_sent_from_close(struct tty_struct *tty,
622 long timeout)
623{
624 tty_unlock();
625 tty_wait_until_sent(tty, timeout);
626 tty_lock();
627}
628
629
630
631
632
633
634
635
636
637
638
639
640
641#define wait_event_interruptible_tty(wq, condition) \
642({ \
643 int __ret = 0; \
644 if (!(condition)) { \
645 __wait_event_interruptible_tty(wq, condition, __ret); \
646 } \
647 __ret; \
648})
649
650#define __wait_event_interruptible_tty(wq, condition, ret) \
651do { \
652 DEFINE_WAIT(__wait); \
653 \
654 for (;;) { \
655 prepare_to_wait(&wq, &__wait, TASK_INTERRUPTIBLE); \
656 if (condition) \
657 break; \
658 if (!signal_pending(current)) { \
659 tty_unlock(); \
660 schedule(); \
661 tty_lock(); \
662 continue; \
663 } \
664 ret = -ERESTARTSYS; \
665 break; \
666 } \
667 finish_wait(&wq, &__wait); \
668} while (0)
669
670
671#endif
672#endif
673