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