root/include/linux/tty.h

/* */

INCLUDED FROM

   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 #ifdef __KERNEL__
   9 #include <linux/fs.h>
  10 #include <linux/termios.h>
  11 #include <linux/tqueue.h>
  12 #include <linux/tty_driver.h>
  13 #include <linux/tty_ldisc.h>
  14 
  15 #include <asm/system.h>
  16 
  17 
  18 /*
  19  * Note: don't mess with NR_PTYS until you understand the tty minor 
  20  * number allocation game...
  21  * (Note: the *_driver.minor_start values 1, 64, 128, 192 are
  22  * hardcoded at present.)
  23  */
  24 #define MIN_NR_CONSOLES 1       /* must be at least 1 */
  25 #define MAX_NR_CONSOLES 63      /* serial lines start at 64 */
  26 #define MAX_NR_USER_CONSOLES 63 /* must be root to allocate above this */
  27                 /* Note: the ioctl VT_GETSTATE does not work for
  28                    consoles 16 and higher (since it returns a short) */
  29 #define NR_PTYS         256
  30 #define NR_LDISCS       16
  31 
  32 /*
  33  * These are set up by the setup-routine at boot-time:
  34  */
  35 
  36 struct screen_info {
  37         unsigned char  orig_x;
  38         unsigned char  orig_y;
  39         unsigned char  unused1[2];
  40         unsigned short orig_video_page;
  41         unsigned char  orig_video_mode;
  42         unsigned char  orig_video_cols;
  43         unsigned short unused2;
  44         unsigned short orig_video_ega_bx;
  45         unsigned short unused3;
  46         unsigned char  orig_video_lines;
  47         unsigned char  orig_video_isVGA;
  48         unsigned short orig_video_points;
  49 };
  50 
  51 extern struct screen_info screen_info;
  52 
  53 #define ORIG_X                  (screen_info.orig_x)
  54 #define ORIG_Y                  (screen_info.orig_y)
  55 #define ORIG_VIDEO_MODE         (screen_info.orig_video_mode)
  56 #define ORIG_VIDEO_COLS         (screen_info.orig_video_cols)
  57 #define ORIG_VIDEO_EGA_BX       (screen_info.orig_video_ega_bx)
  58 #define ORIG_VIDEO_LINES        (screen_info.orig_video_lines)
  59 #define ORIG_VIDEO_ISVGA        (screen_info.orig_video_isVGA)
  60 #define ORIG_VIDEO_POINTS       (screen_info.orig_video_points)
  61 
  62 #define VIDEO_TYPE_MDA          0x10    /* Monochrome Text Display      */
  63 #define VIDEO_TYPE_CGA          0x11    /* CGA Display                  */
  64 #define VIDEO_TYPE_EGAM         0x20    /* EGA/VGA in Monochrome Mode   */
  65 #define VIDEO_TYPE_EGAC         0x21    /* EGA in Color Mode            */
  66 #define VIDEO_TYPE_VGAC         0x22    /* VGA+ in Color Mode           */
  67 
  68 #define VIDEO_TYPE_TGAC         0x40    /* DEC TGA */
  69 
  70 /*
  71  * This character is the same as _POSIX_VDISABLE: it cannot be used as
  72  * a c_cc[] character, but indicates that a particular special character
  73  * isn't in use (eg VINTR has no character etc)
  74  */
  75 #define __DISABLED_CHAR '\0'
  76 
  77 /*
  78  * This is the flip buffer used for the tty driver.  The buffer is
  79  * located in the tty structure, and is used as a high speed interface
  80  * between the tty driver and the tty line discipline.
  81  */
  82 #define TTY_FLIPBUF_SIZE 512
  83 
  84 struct tty_flip_buffer {
  85         struct tq_struct tqueue;
  86         unsigned char   char_buf[2*TTY_FLIPBUF_SIZE];
  87         char            flag_buf[2*TTY_FLIPBUF_SIZE];
  88         char            *char_buf_ptr;
  89         unsigned char   *flag_buf_ptr;
  90         int             count;
  91         int             buf_num;
  92 };
  93 
  94 /*
  95  * When a break, frame error, or parity error happens, these codes are
  96  * stuffed into the flags buffer.
  97  */
  98 #define TTY_NORMAL      0
  99 #define TTY_BREAK       1
 100 #define TTY_FRAME       2
 101 #define TTY_PARITY      3
 102 #define TTY_OVERRUN     4
 103 
 104 #define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
 105 #define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
 106 #define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
 107 #define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
 108 #define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
 109 #define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
 110 #define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
 111 #define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
 112 #define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
 113 #define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
 114 #define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
 115 #define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
 116 #define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
 117 #define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
 118 #define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
 119 #define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
 120 #define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
 121 
 122 #define _I_FLAG(tty,f)  ((tty)->termios->c_iflag & (f))
 123 #define _O_FLAG(tty,f)  ((tty)->termios->c_oflag & (f))
 124 #define _C_FLAG(tty,f)  ((tty)->termios->c_cflag & (f))
 125 #define _L_FLAG(tty,f)  ((tty)->termios->c_lflag & (f))
 126 
 127 #define I_IGNBRK(tty)   _I_FLAG((tty),IGNBRK)
 128 #define I_BRKINT(tty)   _I_FLAG((tty),BRKINT)
 129 #define I_IGNPAR(tty)   _I_FLAG((tty),IGNPAR)
 130 #define I_PARMRK(tty)   _I_FLAG((tty),PARMRK)
 131 #define I_INPCK(tty)    _I_FLAG((tty),INPCK)
 132 #define I_ISTRIP(tty)   _I_FLAG((tty),ISTRIP)
 133 #define I_INLCR(tty)    _I_FLAG((tty),INLCR)
 134 #define I_IGNCR(tty)    _I_FLAG((tty),IGNCR)
 135 #define I_ICRNL(tty)    _I_FLAG((tty),ICRNL)
 136 #define I_IUCLC(tty)    _I_FLAG((tty),IUCLC)
 137 #define I_IXON(tty)     _I_FLAG((tty),IXON)
 138 #define I_IXANY(tty)    _I_FLAG((tty),IXANY)
 139 #define I_IXOFF(tty)    _I_FLAG((tty),IXOFF)
 140 #define I_IMAXBEL(tty)  _I_FLAG((tty),IMAXBEL)
 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 
 184 /*
 185  * Where all of the state associated with a tty is kept while the tty
 186  * is open.  Since the termios state should be kept even if the tty
 187  * has been closed --- for things like the baud rate, etc --- it is
 188  * not stored here, but rather a pointer to the real state is stored
 189  * here.  Possible the winsize structure should have the same
 190  * treatment, but (1) the default 80x24 is usually right and (2) it's
 191  * most often used by a windowing system, which will set the correct
 192  * size each time the window is created or resized anyway.
 193  * IMPORTANT: since this structure is dynamically allocated, it must
 194  * be no larger than 4096 bytes.  Changing TTY_BUF_SIZE will change
 195  * the size of this structure, and it needs to be done with care.
 196  *                                              - TYT, 9/14/92
 197  */
 198 struct tty_struct {
 199         int     magic;
 200         struct tty_driver driver;
 201         struct tty_ldisc ldisc;
 202         struct termios *termios, *termios_locked;
 203         int pgrp;
 204         int session;
 205         kdev_t  device;
 206         unsigned long flags;
 207         int count;
 208         struct winsize winsize;
 209         unsigned char stopped:1, hw_stopped:1, packet:1;
 210         unsigned char ctrl_status;
 211 
 212         struct tty_struct *link;
 213         struct fasync_struct *fasync;
 214         struct tty_flip_buffer flip;
 215         int max_flip_cnt;
 216         struct wait_queue *write_wait;
 217         struct wait_queue *read_wait;
 218         void *disc_data;
 219         void *driver_data;
 220 
 221 #define N_TTY_BUF_SIZE 4096
 222         
 223         /*
 224          * The following is data for the N_TTY line discipline.  For
 225          * historical reasons, this is included in the tty structure.
 226          */
 227         unsigned int column;
 228         unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
 229         unsigned char closing:1;
 230         unsigned short minimum_to_wake;
 231         unsigned overrun_time;
 232         int num_overrun;
 233         unsigned long process_char_map[256/(8*sizeof(unsigned long))];
 234         char *read_buf;
 235         int read_head;
 236         int read_tail;
 237         int read_cnt;
 238         unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
 239         int canon_data;
 240         unsigned long canon_head;
 241         unsigned int canon_column;
 242 };
 243 
 244 /* tty magic number */
 245 #define TTY_MAGIC               0x5401
 246 
 247 /*
 248  * These bits are used in the flags field of the tty structure.
 249  * 
 250  * So that interrupts won't be able to mess up the queues,
 251  * copy_to_cooked must be atomic with respect to itself, as must
 252  * tty->write.  Thus, you must use the inline functions set_bit() and
 253  * clear_bit() to make things atomic.
 254  */
 255 #define TTY_THROTTLED 0
 256 #define TTY_IO_ERROR 1
 257 #define TTY_SLAVE_CLOSED 2
 258 #define TTY_EXCLUSIVE 3
 259 #define TTY_DEBUG 4
 260 #define TTY_DO_WRITE_WAKEUP 5
 261 #define TTY_PUSH 6
 262 #define TTY_CLOSING 7
 263 
 264 #define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
 265 
 266 extern void tty_write_flush(struct tty_struct *);
 267 
 268 extern struct termios tty_std_termios;
 269 extern struct tty_struct * redirect;
 270 extern struct tty_ldisc ldiscs[];
 271 extern int fg_console, last_console, want_console;
 272 
 273 extern int kmsg_redirect;
 274 extern struct wait_queue * keypress_wait;
 275 
 276 extern unsigned long con_init(unsigned long);
 277 
 278 extern int rs_init(void);
 279 extern int lp_init(void);
 280 extern int pty_init(void);
 281 extern int tty_init(void);
 282 extern int vcs_init(void);
 283 extern int cy_init(void);
 284 extern int stl_init(void);
 285 extern int stli_init(void);
 286 
 287 extern int tty_paranoia_check(struct tty_struct *tty, kdev_t device,
 288                               const char *routine);
 289 extern char *_tty_name(struct tty_struct *tty, char *buf);
 290 extern char *tty_name(struct tty_struct *tty);
 291 extern void tty_wait_until_sent(struct tty_struct * tty, int timeout);
 292 extern int tty_check_change(struct tty_struct * tty);
 293 extern void stop_tty(struct tty_struct * tty);
 294 extern void start_tty(struct tty_struct * tty);
 295 extern int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc);
 296 extern int tty_register_driver(struct tty_driver *driver);
 297 extern int tty_unregister_driver(struct tty_driver *driver);
 298 extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
 299                              int buflen);
 300 extern void tty_write_message(struct tty_struct *tty, char *msg);
 301 
 302 extern int is_orphaned_pgrp(int pgrp);
 303 extern int is_ignored(int sig);
 304 extern int tty_signal(int sig, struct tty_struct *tty);
 305 extern void tty_hangup(struct tty_struct * tty);
 306 extern void tty_vhangup(struct tty_struct * tty);
 307 extern void tty_unhangup(struct file *filp);
 308 extern int tty_hung_up_p(struct file * filp);
 309 extern void do_SAK(struct tty_struct *tty);
 310 extern void disassociate_ctty(int priv);
 311 
 312 /* n_tty.c */
 313 extern struct tty_ldisc tty_ldisc_N_TTY;
 314 
 315 /* tty_ioctl.c */
 316 extern int n_tty_ioctl(struct tty_struct * tty, struct file * file,
 317                        unsigned int cmd, unsigned long arg);
 318 
 319 /* serial.c */
 320 
 321 extern int  rs_open(struct tty_struct * tty, struct file * filp);
 322 
 323 /* pty.c */
 324 
 325 extern int  pty_open(struct tty_struct * tty, struct file * filp);
 326 
 327 /* console.c */
 328 
 329 extern int con_open(struct tty_struct * tty, struct file * filp);
 330 extern void update_screen(int new_console);
 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 #endif /* __KERNEL__ */
 339 #endif

/* */