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  */
  22 #define NR_CONSOLES     8
  23 #define NR_PTYS         64
  24 #define NR_LDISCS       16
  25 
  26 /*
  27  * These are set up by the setup-routine at boot-time:
  28  */
  29 
  30 struct screen_info {
  31         unsigned char  orig_x;
  32         unsigned char  orig_y;
  33         unsigned char  unused1[2];
  34         unsigned short orig_video_page;
  35         unsigned char  orig_video_mode;
  36         unsigned char  orig_video_cols;
  37         unsigned short orig_video_ega_ax;
  38         unsigned short orig_video_ega_bx;
  39         unsigned short orig_video_ega_cx;
  40         unsigned char  orig_video_lines;
  41 };
  42 
  43 extern struct screen_info screen_info;
  44 
  45 #define ORIG_X                  (screen_info.orig_x)
  46 #define ORIG_Y                  (screen_info.orig_y)
  47 #define ORIG_VIDEO_PAGE         (screen_info.orig_video_page)
  48 #define ORIG_VIDEO_MODE         (screen_info.orig_video_mode)
  49 #define ORIG_VIDEO_COLS         (screen_info.orig_video_cols)
  50 #define ORIG_VIDEO_EGA_AX       (screen_info.orig_video_ega_ax)
  51 #define ORIG_VIDEO_EGA_BX       (screen_info.orig_video_ega_bx)
  52 #define ORIG_VIDEO_EGA_CX       (screen_info.orig_video_ega_cx)
  53 #define ORIG_VIDEO_LINES        (screen_info.orig_video_lines)
  54 
  55 #define VIDEO_TYPE_MDA          0x10    /* Monochrome Text Display      */
  56 #define VIDEO_TYPE_CGA          0x11    /* CGA Display                  */
  57 #define VIDEO_TYPE_EGAM         0x20    /* EGA/VGA in Monochrome Mode   */
  58 #define VIDEO_TYPE_EGAC         0x21    /* EGA/VGA in Color Mode        */
  59 
  60 /*
  61  * This character is the same as _POSIX_VDISABLE: it cannot be used as
  62  * a c_cc[] character, but indicates that a particular special character
  63  * isn't in use (eg VINTR has no character etc)
  64  */
  65 #define __DISABLED_CHAR '\0'
  66 
  67 /*
  68  * This is the flip buffer used for the tty driver.  The buffer is
  69  * located in the tty structure, and is used as a high speed interface
  70  * between the tty driver and the tty line discipline.
  71  */
  72 #define TTY_FLIPBUF_SIZE 512
  73 
  74 struct tty_flip_buffer {
  75         struct tq_struct tqueue;
  76         unsigned char   char_buf[2*TTY_FLIPBUF_SIZE];
  77         char            flag_buf[2*TTY_FLIPBUF_SIZE];
  78         char            *char_buf_ptr;
  79         unsigned char   *flag_buf_ptr;
  80         int             count;
  81         int             buf_num;
  82 };
  83 
  84 /*
  85  * When a break, frame error, or parity error happens, these codes are
  86  * stuffed into the flags buffer.
  87  */
  88 #define TTY_NORMAL      0
  89 #define TTY_BREAK       1
  90 #define TTY_FRAME       2
  91 #define TTY_PARITY      3
  92 #define TTY_OVERRUN     4
  93 
  94 #define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
  95 #define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
  96 #define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
  97 #define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
  98 #define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
  99 #define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
 100 #define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
 101 #define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
 102 #define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
 103 #define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
 104 #define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
 105 #define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
 106 #define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
 107 #define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
 108 #define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
 109 #define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
 110 #define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
 111 
 112 #define _I_FLAG(tty,f)  ((tty)->termios->c_iflag & (f))
 113 #define _O_FLAG(tty,f)  ((tty)->termios->c_oflag & (f))
 114 #define _C_FLAG(tty,f)  ((tty)->termios->c_cflag & (f))
 115 #define _L_FLAG(tty,f)  ((tty)->termios->c_lflag & (f))
 116 
 117 #define I_IGNBRK(tty)   _I_FLAG((tty),IGNBRK)
 118 #define I_BRKINT(tty)   _I_FLAG((tty),BRKINT)
 119 #define I_IGNPAR(tty)   _I_FLAG((tty),IGNPAR)
 120 #define I_PARMRK(tty)   _I_FLAG((tty),PARMRK)
 121 #define I_INPCK(tty)    _I_FLAG((tty),INPCK)
 122 #define I_ISTRIP(tty)   _I_FLAG((tty),ISTRIP)
 123 #define I_INLCR(tty)    _I_FLAG((tty),INLCR)
 124 #define I_IGNCR(tty)    _I_FLAG((tty),IGNCR)
 125 #define I_ICRNL(tty)    _I_FLAG((tty),ICRNL)
 126 #define I_IUCLC(tty)    _I_FLAG((tty),IUCLC)
 127 #define I_IXON(tty)     _I_FLAG((tty),IXON)
 128 #define I_IXANY(tty)    _I_FLAG((tty),IXANY)
 129 #define I_IXOFF(tty)    _I_FLAG((tty),IXOFF)
 130 #define I_IMAXBEL(tty)  _I_FLAG((tty),IMAXBEL)
 131 
 132 #define O_OPOST(tty)    _O_FLAG((tty),OPOST)
 133 #define O_OLCUC(tty)    _O_FLAG((tty),OLCUC)
 134 #define O_ONLCR(tty)    _O_FLAG((tty),ONLCR)
 135 #define O_OCRNL(tty)    _O_FLAG((tty),OCRNL)
 136 #define O_ONOCR(tty)    _O_FLAG((tty),ONOCR)
 137 #define O_ONLRET(tty)   _O_FLAG((tty),ONLRET)
 138 #define O_OFILL(tty)    _O_FLAG((tty),OFILL)
 139 #define O_OFDEL(tty)    _O_FLAG((tty),OFDEL)
 140 #define O_NLDLY(tty)    _O_FLAG((tty),NLDLY)
 141 #define O_CRDLY(tty)    _O_FLAG((tty),CRDLY)
 142 #define O_TABDLY(tty)   _O_FLAG((tty),TABDLY)
 143 #define O_BSDLY(tty)    _O_FLAG((tty),BSDLY)
 144 #define O_VTDLY(tty)    _O_FLAG((tty),VTDLY)
 145 #define O_FFDLY(tty)    _O_FLAG((tty),FFDLY)
 146 
 147 #define C_BAUD(tty)     _C_FLAG((tty),CBAUD)
 148 #define C_CSIZE(tty)    _C_FLAG((tty),CSIZE)
 149 #define C_CSTOPB(tty)   _C_FLAG((tty),CSTOPB)
 150 #define C_CREAD(tty)    _C_FLAG((tty),CREAD)
 151 #define C_PARENB(tty)   _C_FLAG((tty),PARENB)
 152 #define C_PARODD(tty)   _C_FLAG((tty),PARODD)
 153 #define C_HUPCL(tty)    _C_FLAG((tty),HUPCL)
 154 #define C_CLOCAL(tty)   _C_FLAG((tty),CLOCAL)
 155 #define C_CIBAUD(tty)   _C_FLAG((tty),CIBAUD)
 156 #define C_CRTSCTS(tty)  _C_FLAG((tty),CRTSCTS)
 157 
 158 #define L_ISIG(tty)     _L_FLAG((tty),ISIG)
 159 #define L_ICANON(tty)   _L_FLAG((tty),ICANON)
 160 #define L_XCASE(tty)    _L_FLAG((tty),XCASE)
 161 #define L_ECHO(tty)     _L_FLAG((tty),ECHO)
 162 #define L_ECHOE(tty)    _L_FLAG((tty),ECHOE)
 163 #define L_ECHOK(tty)    _L_FLAG((tty),ECHOK)
 164 #define L_ECHONL(tty)   _L_FLAG((tty),ECHONL)
 165 #define L_NOFLSH(tty)   _L_FLAG((tty),NOFLSH)
 166 #define L_TOSTOP(tty)   _L_FLAG((tty),TOSTOP)
 167 #define L_ECHOCTL(tty)  _L_FLAG((tty),ECHOCTL)
 168 #define L_ECHOPRT(tty)  _L_FLAG((tty),ECHOPRT)
 169 #define L_ECHOKE(tty)   _L_FLAG((tty),ECHOKE)
 170 #define L_FLUSHO(tty)   _L_FLAG((tty),FLUSHO)
 171 #define L_PENDIN(tty)   _L_FLAG((tty),PENDIN)
 172 #define L_IEXTEN(tty)   _L_FLAG((tty),IEXTEN)
 173 
 174 /*
 175  * Where all of the state associated with a tty is kept while the tty
 176  * is open.  Since the termios state should be kept even if the tty
 177  * has been closed --- for things like the baud rate, etc --- it is
 178  * not stored here, but rather a pointer to the real state is stored
 179  * here.  Possible the winsize structure should have the same
 180  * treatment, but (1) the default 80x24 is usually right and (2) it's
 181  * most often used by a windowing system, which will set the correct
 182  * size each time the window is created or resized anyway.
 183  * IMPORTANT: since this structure is dynamically allocated, it must
 184  * be no larger than 4096 bytes.  Changing TTY_BUF_SIZE will change
 185  * the size of this structure, and it needs to be done with care.
 186  *                                              - TYT, 9/14/92
 187  */
 188 struct tty_struct {
 189         int     magic;
 190         struct tty_driver driver;
 191         struct tty_ldisc ldisc;
 192         struct termios *termios, *termios_locked;
 193         int pgrp;
 194         int session;
 195         dev_t   device;
 196         int flags;
 197         int count;
 198         struct winsize winsize;
 199         unsigned char stopped:1, hw_stopped:1, packet:1;
 200         unsigned char ctrl_status;
 201 
 202         struct tty_struct *link;
 203         struct fasync_struct *fasync;
 204         struct tty_flip_buffer flip;
 205         int max_flip_cnt;
 206         struct wait_queue *write_wait;
 207         struct wait_queue *read_wait;
 208         void *disc_data;
 209         void *driver_data;
 210 
 211 #define N_TTY_BUF_SIZE 4096
 212         
 213         /*
 214          * The following is data for the N_TTY line discipline.  For
 215          * historical reasons, this is included in the tty structure.
 216          */
 217         unsigned int column;
 218         unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
 219         unsigned short minimum_to_wake;
 220         unsigned overrun_time;
 221         int num_overrun;
 222         int process_char_map[256/32];
 223         char *read_buf;
 224         int read_head;
 225         int read_tail;
 226         int read_cnt;
 227         int read_flags[N_TTY_BUF_SIZE/32];
 228         int canon_data;
 229         unsigned long canon_head;
 230         unsigned int canon_column;
 231 };
 232 
 233 /* tty magic number */
 234 #define TTY_MAGIC               0x5401
 235 
 236 /*
 237  * These bits are used in the flags field of the tty structure.
 238  * 
 239  * So that interrupts won't be able to mess up the queues,
 240  * copy_to_cooked must be atomic with respect to itself, as must
 241  * tty->write.  Thus, you must use the inline functions set_bit() and
 242  * clear_bit() to make things atomic.
 243  */
 244 #define TTY_THROTTLED 0
 245 #define TTY_IO_ERROR 1
 246 #define TTY_SLAVE_CLOSED 2
 247 #define TTY_EXCLUSIVE 3
 248 #define TTY_DEBUG 4
 249 #define TTY_DO_WRITE_WAKEUP 5
 250 #define TTY_PUSH 6
 251 
 252 #define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
 253 
 254 extern void tty_write_flush(struct tty_struct *);
 255 
 256 extern struct termios tty_std_termios;
 257 extern struct tty_struct * redirect;
 258 extern struct tty_ldisc ldiscs[];
 259 extern int fg_console;
 260 extern unsigned long video_num_columns;
 261 extern unsigned long video_num_lines;
 262 extern struct wait_queue * keypress_wait;
 263 
 264 /*      intr=^C         quit=^|         erase=del       kill=^U
 265         eof=^D          vtime=\0        vmin=\1         sxtc=\0
 266         start=^Q        stop=^S         susp=^Z         eol=\0
 267         reprint=^R      discard=^U      werase=^W       lnext=^V
 268         eol2=\0
 269 */
 270 #define INIT_C_CC "\003\034\177\025\004\0\1\0\021\023\032\0\022\017\027\026\0"
 271 
 272 extern long rs_init(long);
 273 extern long lp_init(long);
 274 extern long con_init(long);
 275 extern long pty_init(long);
 276 extern long tty_init(long);
 277 
 278 extern int tty_paranoia_check(struct tty_struct *tty, dev_t device,
 279                               const char *routine);
 280 extern char *_tty_name(struct tty_struct *tty, char *buf);
 281 extern char *tty_name(struct tty_struct *tty);
 282 extern void wait_until_sent(struct tty_struct * tty, int timeout);
 283 extern int tty_check_change(struct tty_struct * tty);
 284 extern void stop_tty(struct tty_struct * tty);
 285 extern void start_tty(struct tty_struct * tty);
 286 extern int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc);
 287 extern int tty_register_driver(struct tty_driver *driver);
 288 extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
 289                              int buflen);
 290 
 291 extern int is_orphaned_pgrp(int pgrp);
 292 extern int is_ignored(int sig);
 293 extern int tty_signal(int sig, struct tty_struct *tty);
 294 extern void tty_hangup(struct tty_struct * tty);
 295 extern void tty_vhangup(struct tty_struct * tty);
 296 extern void tty_unhangup(struct file *filp);
 297 extern int tty_hung_up_p(struct file * filp);
 298 extern void do_SAK(struct tty_struct *tty);
 299 extern void disassociate_ctty(int priv);
 300 
 301 /* n_tty.c */
 302 extern struct tty_ldisc tty_ldisc_N_TTY;
 303 
 304 /* tty_ioctl.c */
 305 extern int n_tty_ioctl(struct tty_struct * tty, struct file * file,
 306                        unsigned int cmd, unsigned long arg);
 307 
 308 /* serial.c */
 309 
 310 extern int  rs_open(struct tty_struct * tty, struct file * filp);
 311 
 312 /* pty.c */
 313 
 314 extern int  pty_open(struct tty_struct * tty, struct file * filp);
 315 
 316 /* console.c */
 317 
 318 extern int con_open(struct tty_struct * tty, struct file * filp);
 319 extern void update_screen(int new_console);
 320 extern void blank_screen(void);
 321 extern void unblank_screen(void);
 322 
 323 /* vt.c */
 324 
 325 extern int vt_ioctl(struct tty_struct *tty, struct file * file,
 326                     unsigned int cmd, unsigned long arg);
 327 
 328 #endif /* __KERNEL__ */
 329 #endif

/* */