include/linux/tty.h

   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
   8 /*
   9  * These constants are also useful for user-level apps (e.g., VC
  10  * resizing).
  11  */
  12 #define MIN_NR_CONSOLES 1       /* must be at least 1 */
  13 #define MAX_NR_CONSOLES 63      /* serial lines start at 64 */
  14 #define MAX_NR_USER_CONSOLES 63 /* must be root to allocate above this */
  15                 /* Note: the ioctl VT_GETSTATE does not work for
  16                    consoles 16 and higher (since it returns a short) */
  17
  18 #ifdef __KERNEL__
  19 #include <linux/config.h>
  20 #include <linux/fs.h>
  21 #include <linux/major.h>
  22 #include <linux/termios.h>
  23 #include <linux/workqueue.h>
  24 #include <linux/tty_driver.h>
  25 #include <linux/tty_ldisc.h>
  26 #include <linux/screen_info.h>
  27
  28 #include <asm/system.h>
  29
  30
  31 /*
  32  * (Note: the *_driver.minor_start values 1, 64, 128, 192 are
  33  * hardcoded at present.)
  34  */
  35 #define NR_PTYS CONFIG_LEGACY_PTY_COUNT   /* Number of legacy ptys */
  36 #define NR_UNIX98_PTY_DEFAULT   4096      /* Default maximum for Unix98 ptys */
  37 #define NR_UNIX98_PTY_MAX       (1 << MINORBITS) /* Absolute limit */
  38 #define NR_LDISCS               16
  39
  40 /*
  41  * This character is the same as _POSIX_VDISABLE: it cannot be used as
  42  * a c_cc[] character, but indicates that a particular special character
  43  * isn't in use (eg VINTR has no character etc)
  44  */
  45 #define __DISABLED_CHAR '\0'
  46
  47 /*
  48  * This is the flip buffer used for the tty driver.  The buffer is
  49  * located in the tty structure, and is used as a high speed interface
  50  * between the tty driver and the tty line discipline.
  51  */
  52 #define TTY_FLIPBUF_SIZE 512
  53
  54 struct tty_flip_buffer {
  55         struct work_struct              work;
  56         struct semaphore pty_sem;
  57         char            *char_buf_ptr;
  58         unsigned char   *flag_buf_ptr;
  59         int             count;
  60         int             buf_num;
  61         unsigned char   char_buf[2*TTY_FLIPBUF_SIZE];
  62         char            flag_buf[2*TTY_FLIPBUF_SIZE];
  63         unsigned char   slop[4]; /* N.B. bug overwrites buffer by 1 */
  64 };
  65 /*
  66  * The pty uses char_buf and flag_buf as a contiguous buffer
  67  */
  68 #define PTY_BUF_SIZE    4*TTY_FLIPBUF_SIZE
  69
  70 /*
  71  * When a break, frame error, or parity error happens, these codes are
  72  * stuffed into the flags buffer.
  73  */
  74 #define TTY_NORMAL      0
  75 #define TTY_BREAK       1
  76 #define TTY_FRAME       2
  77 #define TTY_PARITY      3
  78 #define TTY_OVERRUN     4
  79
  80 #define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
  81 #define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
  82 #define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
  83 #define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
  84 #define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
  85 #define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
  86 #define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
  87 #define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
  88 #define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
  89 #define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
  90 #define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
  91 #define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
  92 #define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
  93 #define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
  94 #define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
  95 #define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
  96 #define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
  97
  98 #define _I_FLAG(tty,f)  ((tty)->termios->c_iflag & (f))
  99 #define _O_FLAG(tty,f)  ((tty)->termios->c_oflag & (f))
 100 #define _C_FLAG(tty,f)  ((tty)->termios->c_cflag & (f))
 101 #define _L_FLAG(tty,f)  ((tty)->termios->c_lflag & (f))
 102
 103 #define I_IGNBRK(tty)   _I_FLAG((tty),IGNBRK)
 104 #define I_BRKINT(tty)   _I_FLAG((tty),BRKINT)
 105 #define I_IGNPAR(tty)   _I_FLAG((tty),IGNPAR)
 106 #define I_PARMRK(tty)   _I_FLAG((tty),PARMRK)
 107 #define I_INPCK(tty)    _I_FLAG((tty),INPCK)
 108 #define I_ISTRIP(tty)   _I_FLAG((tty),ISTRIP)
 109 #define I_INLCR(tty)    _I_FLAG((tty),INLCR)
 110 #define I_IGNCR(tty)    _I_FLAG((tty),IGNCR)
 111 #define I_ICRNL(tty)    _I_FLAG((tty),ICRNL)
 112 #define I_IUCLC(tty)    _I_FLAG((tty),IUCLC)
 113 #define I_IXON(tty)     _I_FLAG((tty),IXON)
 114 #define I_IXANY(tty)    _I_FLAG((tty),IXANY)
 115 #define I_IXOFF(tty)    _I_FLAG((tty),IXOFF)
 116 #define I_IMAXBEL(tty)  _I_FLAG((tty),IMAXBEL)
 117 #define I_IUTF8(tty)    _I_FLAG((tty),IUTF8)
 118
 119 #define O_OPOST(tty)    _O_FLAG((tty),OPOST)
 120 #define O_OLCUC(tty)    _O_FLAG((tty),OLCUC)
 121 #define O_ONLCR(tty)    _O_FLAG((tty),ONLCR)
 122 #define O_OCRNL(tty)    _O_FLAG((tty),OCRNL)
 123 #define O_ONOCR(tty)    _O_FLAG((tty),ONOCR)
 124 #define O_ONLRET(tty)   _O_FLAG((tty),ONLRET)
 125 #define O_OFILL(tty)    _O_FLAG((tty),OFILL)
 126 #define O_OFDEL(tty)    _O_FLAG((tty),OFDEL)
 127 #define O_NLDLY(tty)    _O_FLAG((tty),NLDLY)
 128 #define O_CRDLY(tty)    _O_FLAG((tty),CRDLY)
 129 #define O_TABDLY(tty)   _O_FLAG((tty),TABDLY)
 130 #define O_BSDLY(tty)    _O_FLAG((tty),BSDLY)
 131 #define O_VTDLY(tty)    _O_FLAG((tty),VTDLY)
 132 #define O_FFDLY(tty)    _O_FLAG((tty),FFDLY)
 133
 134 #define C_BAUD(tty)     _C_FLAG((tty),CBAUD)
 135 #define C_CSIZE(tty)    _C_FLAG((tty),CSIZE)
 136 #define C_CSTOPB(tty)   _C_FLAG((tty),CSTOPB)
 137 #define C_CREAD(tty)    _C_FLAG((tty),CREAD)
 138 #define C_PARENB(tty)   _C_FLAG((tty),PARENB)
 139 #define C_PARODD(tty)   _C_FLAG((tty),PARODD)
 140 #define C_HUPCL(tty)    _C_FLAG((tty),HUPCL)
 141 #define C_CLOCAL(tty)   _C_FLAG((tty),CLOCAL)
 142 #define C_CIBAUD(tty)   _C_FLAG((tty),CIBAUD)
 143 #define C_CRTSCTS(tty)  _C_FLAG((tty),CRTSCTS)
 144
 145 #define L_ISIG(tty)     _L_FLAG((tty),ISIG)
 146 #define L_ICANON(tty)   _L_FLAG((tty),ICANON)
 147 #define L_XCASE(tty)    _L_FLAG((tty),XCASE)
 148 #define L_ECHO(tty)     _L_FLAG((tty),ECHO)
 149 #define L_ECHOE(tty)    _L_FLAG((tty),ECHOE)
 150 #define L_ECHOK(tty)    _L_FLAG((tty),ECHOK)
 151 #define L_ECHONL(tty)   _L_FLAG((tty),ECHONL)
 152 #define L_NOFLSH(tty)   _L_FLAG((tty),NOFLSH)
 153 #define L_TOSTOP(tty)   _L_FLAG((tty),TOSTOP)
 154 #define L_ECHOCTL(tty)  _L_FLAG((tty),ECHOCTL)
 155 #define L_ECHOPRT(tty)  _L_FLAG((tty),ECHOPRT)
 156 #define L_ECHOKE(tty)   _L_FLAG((tty),ECHOKE)
 157 #define L_FLUSHO(tty)   _L_FLAG((tty),FLUSHO)
 158 #define L_PENDIN(tty)   _L_FLAG((tty),PENDIN)
 159 #define L_IEXTEN(tty)   _L_FLAG((tty),IEXTEN)
 160
 161 struct device;
 162 /*
 163  * Where all of the state associated with a tty is kept while the tty
 164  * is open.  Since the termios state should be kept even if the tty
 165  * has been closed --- for things like the baud rate, etc --- it is
 166  * not stored here, but rather a pointer to the real state is stored
 167  * here.  Possible the winsize structure should have the same
 168  * treatment, but (1) the default 80x24 is usually right and (2) it's
 169  * most often used by a windowing system, which will set the correct
 170  * size each time the window is created or resized anyway.
 171  *                                              - TYT, 9/14/92
 172  */
 173 struct tty_struct {
 174         int     magic;
 175         struct tty_driver *driver;
 176         int index;
 177         struct tty_ldisc ldisc;
 178         struct semaphore termios_sem;
 179         struct termios *termios, *termios_locked;
 180         char name[64];
 181         int pgrp;
 182         int session;
 183         unsigned long flags;
 184         int count;
 185         struct winsize winsize;
 186         unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
 187         unsigned char low_latency:1, warned:1;
 188         unsigned char ctrl_status;
 189
 190         struct tty_struct *link;
 191         struct fasync_struct *fasync;
 192         struct tty_flip_buffer flip;
 193         int max_flip_cnt;
 194         int alt_speed;          /* For magic substitution of 38400 bps */
 195         wait_queue_head_t write_wait;
 196         wait_queue_head_t read_wait;
 197         struct work_struct hangup_work;
 198         void *disc_data;
 199         void *driver_data;
 200         struct list_head tty_files;
 201
 202 #define N_TTY_BUF_SIZE 4096
 203
 204         /*
 205          * The following is data for the N_TTY line discipline.  For
 206          * historical reasons, this is included in the tty structure.
 207          */
 208         unsigned int column;
 209         unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
 210         unsigned char closing:1;
 211         unsigned short minimum_to_wake;
 212         unsigned long overrun_time;
 213         int num_overrun;
 214         unsigned long process_char_map[256/(8*sizeof(unsigned long))];
 215         char *read_buf;
 216         int read_head;
 217         int read_tail;
 218         int read_cnt;
 219         unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
 220         int canon_data;
 221         unsigned long canon_head;
 222         unsigned int canon_column;
 223         struct semaphore atomic_read;
 224         struct semaphore atomic_write;
 225         unsigned char *write_buf;
 226         int write_cnt;
 227         spinlock_t read_lock;
 228         /* If the tty has a pending do_SAK, queue it here - akpm */
 229         struct work_struct SAK_work;
 230 };
 231
 232 /* tty magic number */
 233 #define TTY_MAGIC               0x5401
 234
 235 /*
 236  * These bits are used in the flags field of the tty structure.
 237  *
 238  * So that interrupts won't be able to mess up the queues,
 239  * copy_to_cooked must be atomic with respect to itself, as must
 240  * tty->write.  Thus, you must use the inline functions set_bit() and
 241  * clear_bit() to make things atomic.
 242  */
 243 #define TTY_THROTTLED           0       /* Call unthrottle() at threshold min */
 244 #define TTY_IO_ERROR            1       /* Canse an I/O error (may be no ldisc too) */
 245 #define TTY_OTHER_CLOSED        2       /* Other side (if any) has closed */
 246 #define TTY_EXCLUSIVE           3       /* Exclusive open mode */
 247 #define TTY_DEBUG               4       /* Debugging */
 248 #define TTY_DO_WRITE_WAKEUP     5       /* Call write_wakeup after queuing new */
 249 #define TTY_PUSH                6       /* n_tty private */
 250 #define TTY_CLOSING             7       /* ->close() in progress */
 251 #define TTY_DONT_FLIP           8       /* Defer buffer flip */
 252 #define TTY_LDISC               9       /* Line discipline attached */
 253 #define TTY_HW_COOK_OUT         14      /* Hardware can do output cooking */
 254 #define TTY_HW_COOK_IN          15      /* Hardware can do input cooking */
 255 #define TTY_PTY_LOCK            16      /* pty private */
 256 #define TTY_NO_WRITE_SPLIT      17      /* Preserve write boundaries to driver */
 257 #define TTY_HUPPED              18      /* Post driver->hangup() */
 258
 259 #define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
 260
 261 extern void tty_write_flush(struct tty_struct *);
 262
 263 extern struct termios tty_std_termios;
 264 extern int fg_console, last_console, want_console;
 265
 266 extern int kmsg_redirect;
 267
 268 extern void console_init(void);
 269 extern int vcs_init(void);
 270
 271 extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
 272                               const char *routine);
 273 extern char *tty_name(struct tty_struct *tty, char *buf);
 274 extern void tty_wait_until_sent(struct tty_struct * tty, long timeout);
 275 extern int tty_check_change(struct tty_struct * tty);
 276 extern void stop_tty(struct tty_struct * tty);
 277 extern void start_tty(struct tty_struct * tty);
 278 extern int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc);
 279 extern int tty_unregister_ldisc(int disc);
 280 extern int tty_register_driver(struct tty_driver *driver);
 281 extern int tty_unregister_driver(struct tty_driver *driver);
 282 extern void tty_register_device(struct tty_driver *driver, unsigned index, struct device *dev);
 283 extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
 284 extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
 285                              int buflen);
 286 extern void tty_write_message(struct tty_struct *tty, char *msg);
 287
 288 extern int is_orphaned_pgrp(int pgrp);
 289 extern int is_ignored(int sig);
 290 extern int tty_signal(int sig, struct tty_struct *tty);
 291 extern void tty_hangup(struct tty_struct * tty);
 292 extern void tty_vhangup(struct tty_struct * tty);
 293 extern void tty_unhangup(struct file *filp);
 294 extern int tty_hung_up_p(struct file * filp);
 295 extern void do_SAK(struct tty_struct *tty);
 296 extern void disassociate_ctty(int priv);
 297 extern void tty_flip_buffer_push(struct tty_struct *tty);
 298 extern int tty_get_baud_rate(struct tty_struct *tty);
 299 extern int tty_termios_baud_rate(struct termios *termios);
 300
 301 extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
 302 extern void tty_ldisc_deref(struct tty_ldisc *);
 303 extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
 304
 305 extern struct tty_ldisc *tty_ldisc_get(int);
 306 extern void tty_ldisc_put(int);
 307
 308 extern void tty_wakeup(struct tty_struct *tty);
 309 extern void tty_ldisc_flush(struct tty_struct *tty);
 310
 311 struct semaphore;
 312 extern struct semaphore tty_sem;
 313
 314 /* n_tty.c */
 315 extern struct tty_ldisc tty_ldisc_N_TTY;
 316
 317 /* tty_ioctl.c */
 318 extern int n_tty_ioctl(struct tty_struct * tty, struct file * file,
 319                        unsigned int cmd, unsigned long arg);
 320
 321 /* serial.c */
 322
 323 extern void serial_console_init(void);
 324
 325 /* pcxx.c */
 326
 327 extern int pcxe_open(struct tty_struct *tty, struct file *filp);
 328
 329 /* printk.c */
 330
 331 extern void console_print(const char *);
 332
 333 /* vt.c */
 334
 335 extern int vt_ioctl(struct tty_struct *tty, struct file * file,
 336                     unsigned int cmd, unsigned long arg);
 337
 338 static inline dev_t tty_devnum(struct tty_struct *tty)
 339 {
 340         return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index;
 341 }
 342
 343 #endif /* __KERNEL__ */
 344 #endif