root/include/linux/tty.h

/* [previous][next][first][last][top][bottom][index][help] */

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

/* [previous][next][first][last][top][bottom][index][help] */