LXR linux-old/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/tqueue.h>
  24#include <linux/tty_driver.h>
  25#include <linux/tty_ldisc.h>
  26
  27#include <asm/system.h>
  28
  29
  30/*
  31 * Note: don't mess with NR_PTYS until you understand the tty minor 
  32 * number allocation game...
  33 * (Note: the *_driver.minor_start values 1, 64, 128, 192 are
  34 * hardcoded at present.)
  35 */
  36#define NR_PTYS         256     /* ptys/major */
  37#define NR_LDISCS       16
  38
  39/*
  40 * Unix98 PTY's can be defined as any multiple of NR_PTYS up to
  41 * UNIX98_PTY_MAJOR_COUNT; this section defines what we need from the
  42 * config options
  43 */
  44#ifdef CONFIG_UNIX98_PTYS
  45# define UNIX98_NR_MAJORS ((CONFIG_UNIX98_PTY_COUNT+NR_PTYS-1)/NR_PTYS)
  46# if UNIX98_NR_MAJORS <= 0
  47#  undef CONFIG_UNIX98_PTYS
  48# elif UNIX98_NR_MAJORS > UNIX98_PTY_MAJOR_COUNT
  49#  error  Too many Unix98 ptys defined
  50#  undef  UNIX98_NR_MAJORS
  51#  define UNIX98_NR_MAJORS UNIX98_PTY_MAJOR_COUNT
  52# endif
  53#endif
  54
  55/*
  56 * These are set up by the setup-routine at boot-time:
  57 */
  58
  59struct screen_info {
  60        u8  orig_x;             /* 0x00 */
  61        u8  orig_y;             /* 0x01 */
  62        u16 dontuse1;           /* 0x02 -- EXT_MEM_K sits here */
  63        u16 orig_video_page;    /* 0x04 */
  64        u8  orig_video_mode;    /* 0x06 */
  65        u8  orig_video_cols;    /* 0x07 */
  66        u16 unused2;            /* 0x08 */
  67        u16 orig_video_ega_bx;  /* 0x0a */
  68        u16 unused3;            /* 0x0c */
  69        u8  orig_video_lines;   /* 0x0e */
  70        u8  orig_video_isVGA;   /* 0x0f */
  71        u16 orig_video_points;  /* 0x10 */
  72
  73        /* VESA graphic mode -- linear frame buffer */
  74        u16 lfb_width;                          /* 0x12 */
  75        u16 lfb_height;         /* 0x14 */
  76        u16 lfb_depth;          /* 0x16 */
  77        u32 lfb_base;           /* 0x18 */
  78        u32 lfb_size;           /* 0x1c */
  79        u16 dontuse2, dontuse3; /* 0x20 -- CL_MAGIC and CL_OFFSET here */
  80        u16 lfb_linelength;     /* 0x24 */
  81        u8  red_size;           /* 0x26 */
  82        u8  red_pos;            /* 0x27 */
  83        u8  green_size;         /* 0x28 */
  84        u8  green_pos;          /* 0x29 */
  85        u8  blue_size;          /* 0x2a */
  86        u8  blue_pos;           /* 0x2b */
  87        u8  rsvd_size;          /* 0x2c */
  88        u8  rsvd_pos;           /* 0x2d */
  89        u16 vesapm_seg;         /* 0x2e */
  90        u16 vesapm_off;         /* 0x30 */
  91        u16 pages;              /* 0x32 */
  92                                                /* 0x34 -- 0x3f reserved for future expansion */
  93};
  94
  95extern struct screen_info screen_info;
  96
  97#define ORIG_X                  (screen_info.orig_x)
  98#define ORIG_Y                  (screen_info.orig_y)
  99#define ORIG_VIDEO_MODE         (screen_info.orig_video_mode)
 100#define ORIG_VIDEO_COLS         (screen_info.orig_video_cols)
 101#define ORIG_VIDEO_EGA_BX       (screen_info.orig_video_ega_bx)
 102#define ORIG_VIDEO_LINES        (screen_info.orig_video_lines)
 103#define ORIG_VIDEO_ISVGA        (screen_info.orig_video_isVGA)
 104#define ORIG_VIDEO_POINTS       (screen_info.orig_video_points)
 105
 106#define VIDEO_TYPE_MDA          0x10    /* Monochrome Text Display      */
 107#define VIDEO_TYPE_CGA          0x11    /* CGA Display                  */
 108#define VIDEO_TYPE_EGAM         0x20    /* EGA/VGA in Monochrome Mode   */
 109#define VIDEO_TYPE_EGAC         0x21    /* EGA in Color Mode            */
 110#define VIDEO_TYPE_VGAC         0x22    /* VGA+ in Color Mode           */
 111#define VIDEO_TYPE_VLFB         0x23    /* VESA VGA in graphic mode     */
 112
 113#define VIDEO_TYPE_PICA_S3      0x30    /* ACER PICA-61 local S3 video  */
 114#define VIDEO_TYPE_MIPS_G364    0x31    /* MIPS Magnum 4000 G364 video  */
 115#define VIDEO_TYPE_SNI_RM       0x32    /* SNI RM200 PCI video          */
 116#define VIDEO_TYPE_SGI          0x33    /* Various SGI graphics hardware */
 117
 118#define VIDEO_TYPE_TGAC         0x40    /* DEC TGA */
 119
 120#define VIDEO_TYPE_SUN          0x50    /* Sun frame buffer. */
 121#define VIDEO_TYPE_SUNPCI       0x51    /* Sun PCI based frame buffer. */
 122
 123#define VIDEO_TYPE_PMAC         0x60    /* PowerMacintosh frame buffer. */
 124
 125/*
 126 * This character is the same as _POSIX_VDISABLE: it cannot be used as
 127 * a c_cc[] character, but indicates that a particular special character
 128 * isn't in use (eg VINTR has no character etc)
 129 */
 130#define __DISABLED_CHAR '\0'
 131
 132/*
 133 * This is the flip buffer used for the tty driver.  The buffer is
 134 * located in the tty structure, and is used as a high speed interface
 135 * between the tty driver and the tty line discipline.
 136 */
 137#define TTY_FLIPBUF_SIZE 512
 138
 139struct tty_flip_buffer {
 140        struct tq_struct tqueue;
 141        struct semaphore pty_sem;
 142        char            *char_buf_ptr;
 143        unsigned char   *flag_buf_ptr;
 144        int             count;
 145        int             buf_num;
 146        unsigned char   char_buf[2*TTY_FLIPBUF_SIZE];
 147        char            flag_buf[2*TTY_FLIPBUF_SIZE];
 148        unsigned char   slop[4]; /* N.B. bug overwrites buffer by 1 */
 149};
 150/*
 151 * The pty uses char_buf and flag_buf as a contiguous buffer
 152 */
 153#define PTY_BUF_SIZE    4*TTY_FLIPBUF_SIZE
 154
 155/*
 156 * When a break, frame error, or parity error happens, these codes are
 157 * stuffed into the flags buffer.
 158 */
 159#define TTY_NORMAL      0
 160#define TTY_BREAK       1
 161#define TTY_FRAME       2
 162#define TTY_PARITY      3
 163#define TTY_OVERRUN     4
 164
 165#define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
 166#define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
 167#define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
 168#define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
 169#define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
 170#define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
 171#define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
 172#define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
 173#define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
 174#define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
 175#define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
 176#define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
 177#define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
 178#define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
 179#define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
 180#define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
 181#define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
 182
 183#define _I_FLAG(tty,f)  ((tty)->termios->c_iflag & (f))
 184#define _O_FLAG(tty,f)  ((tty)->termios->c_oflag & (f))
 185#define _C_FLAG(tty,f)  ((tty)->termios->c_cflag & (f))
 186#define _L_FLAG(tty,f)  ((tty)->termios->c_lflag & (f))
 187
 188#define I_IGNBRK(tty)   _I_FLAG((tty),IGNBRK)
 189#define I_BRKINT(tty)   _I_FLAG((tty),BRKINT)
 190#define I_IGNPAR(tty)   _I_FLAG((tty),IGNPAR)
 191#define I_PARMRK(tty)   _I_FLAG((tty),PARMRK)
 192#define I_INPCK(tty)    _I_FLAG((tty),INPCK)
 193#define I_ISTRIP(tty)   _I_FLAG((tty),ISTRIP)
 194#define I_INLCR(tty)    _I_FLAG((tty),INLCR)
 195#define I_IGNCR(tty)    _I_FLAG((tty),IGNCR)
 196#define I_ICRNL(tty)    _I_FLAG((tty),ICRNL)
 197#define I_IUCLC(tty)    _I_FLAG((tty),IUCLC)
 198#define I_IXON(tty)     _I_FLAG((tty),IXON)
 199#define I_IXANY(tty)    _I_FLAG((tty),IXANY)
 200#define I_IXOFF(tty)    _I_FLAG((tty),IXOFF)
 201#define I_IMAXBEL(tty)  _I_FLAG((tty),IMAXBEL)
 202
 203#define O_OPOST(tty)    _O_FLAG((tty),OPOST)
 204#define O_OLCUC(tty)    _O_FLAG((tty),OLCUC)
 205#define O_ONLCR(tty)    _O_FLAG((tty),ONLCR)
 206#define O_OCRNL(tty)    _O_FLAG((tty),OCRNL)
 207#define O_ONOCR(tty)    _O_FLAG((tty),ONOCR)
 208#define O_ONLRET(tty)   _O_FLAG((tty),ONLRET)
 209#define O_OFILL(tty)    _O_FLAG((tty),OFILL)
 210#define O_OFDEL(tty)    _O_FLAG((tty),OFDEL)
 211#define O_NLDLY(tty)    _O_FLAG((tty),NLDLY)
 212#define O_CRDLY(tty)    _O_FLAG((tty),CRDLY)
 213#define O_TABDLY(tty)   _O_FLAG((tty),TABDLY)
 214#define O_BSDLY(tty)    _O_FLAG((tty),BSDLY)
 215#define O_VTDLY(tty)    _O_FLAG((tty),VTDLY)
 216#define O_FFDLY(tty)    _O_FLAG((tty),FFDLY)
 217
 218#define C_BAUD(tty)     _C_FLAG((tty),CBAUD)
 219#define C_CSIZE(tty)    _C_FLAG((tty),CSIZE)
 220#define C_CSTOPB(tty)   _C_FLAG((tty),CSTOPB)
 221#define C_CREAD(tty)    _C_FLAG((tty),CREAD)
 222#define C_PARENB(tty)   _C_FLAG((tty),PARENB)
 223#define C_PARODD(tty)   _C_FLAG((tty),PARODD)
 224#define C_HUPCL(tty)    _C_FLAG((tty),HUPCL)
 225#define C_CLOCAL(tty)   _C_FLAG((tty),CLOCAL)
 226#define C_CIBAUD(tty)   _C_FLAG((tty),CIBAUD)
 227#define C_CRTSCTS(tty)  _C_FLAG((tty),CRTSCTS)
 228
 229#define L_ISIG(tty)     _L_FLAG((tty),ISIG)
 230#define L_ICANON(tty)   _L_FLAG((tty),ICANON)
 231#define L_XCASE(tty)    _L_FLAG((tty),XCASE)
 232#define L_ECHO(tty)     _L_FLAG((tty),ECHO)
 233#define L_ECHOE(tty)    _L_FLAG((tty),ECHOE)
 234#define L_ECHOK(tty)    _L_FLAG((tty),ECHOK)
 235#define L_ECHONL(tty)   _L_FLAG((tty),ECHONL)
 236#define L_NOFLSH(tty)   _L_FLAG((tty),NOFLSH)
 237#define L_TOSTOP(tty)   _L_FLAG((tty),TOSTOP)
 238#define L_ECHOCTL(tty)  _L_FLAG((tty),ECHOCTL)
 239#define L_ECHOPRT(tty)  _L_FLAG((tty),ECHOPRT)
 240#define L_ECHOKE(tty)   _L_FLAG((tty),ECHOKE)
 241#define L_FLUSHO(tty)   _L_FLAG((tty),FLUSHO)
 242#define L_PENDIN(tty)   _L_FLAG((tty),PENDIN)
 243#define L_IEXTEN(tty)   _L_FLAG((tty),IEXTEN)
 244
 245/*
 246 * Where all of the state associated with a tty is kept while the tty
 247 * is open.  Since the termios state should be kept even if the tty
 248 * has been closed --- for things like the baud rate, etc --- it is
 249 * not stored here, but rather a pointer to the real state is stored
 250 * here.  Possible the winsize structure should have the same
 251 * treatment, but (1) the default 80x24 is usually right and (2) it's
 252 * most often used by a windowing system, which will set the correct
 253 * size each time the window is created or resized anyway.
 254 * IMPORTANT: since this structure is dynamically allocated, it must
 255 * be no larger than 4096 bytes.  Changing TTY_FLIPBUF_SIZE will change
 256 * the size of this structure, and it needs to be done with care.
 257 *                                              - TYT, 9/14/92
 258 */
 259struct tty_struct {
 260        int     magic;
 261        struct tty_driver driver;
 262        struct tty_ldisc ldisc;
 263        struct semaphore termios_sem;
 264        struct termios *termios, *termios_locked;
 265        int pgrp;
 266        int session;
 267        kdev_t  device;
 268        unsigned long flags;
 269        int count;
 270        struct winsize winsize;
 271        unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
 272        unsigned char low_latency:1, warned:1;
 273        unsigned char ctrl_status;
 274
 275        struct tty_struct *link;
 276        struct fasync_struct *fasync;
 277        struct tty_flip_buffer flip;
 278        int max_flip_cnt;
 279        int alt_speed;          /* For magic substitution of 38400 bps */
 280        wait_queue_head_t write_wait;
 281        wait_queue_head_t read_wait;
 282        struct tq_struct tq_hangup;
 283        void *disc_data;
 284        void *driver_data;
 285        struct list_head tty_files;
 286
 287#define N_TTY_BUF_SIZE 4096
 288        
 289        /*
 290         * The following is data for the N_TTY line discipline.  For
 291         * historical reasons, this is included in the tty structure.
 292         */
 293        unsigned int column;
 294        unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
 295        unsigned char closing:1;
 296        unsigned short minimum_to_wake;
 297        unsigned long overrun_time;
 298        int num_overrun;
 299        unsigned long process_char_map[256/(8*sizeof(unsigned long))];
 300        char *read_buf;
 301        int read_head;
 302        int read_tail;
 303        int read_cnt;
 304        unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
 305        int canon_data;
 306        unsigned long canon_head;
 307        unsigned int canon_column;
 308        struct semaphore atomic_read;
 309        struct semaphore atomic_write;
 310        spinlock_t read_lock;
 311        /* If the tty has a pending do_SAK, queue it here - akpm */
 312        struct tq_struct SAK_tq;
 313};
 314
 315/* tty magic number */
 316#define TTY_MAGIC               0x5401
 317
 318/*
 319 * These bits are used in the flags field of the tty structure.
 320 * 
 321 * So that interrupts won't be able to mess up the queues,
 322 * copy_to_cooked must be atomic with respect to itself, as must
 323 * tty->write.  Thus, you must use the inline functions set_bit() and
 324 * clear_bit() to make things atomic.
 325 */
 326#define TTY_THROTTLED           0       /* Call unthrottle() at threshold min */
 327#define TTY_IO_ERROR            1       /* Canse an I/O error (may be no ldisc too) */
 328#define TTY_OTHER_CLOSED        2       /* Other side (if any) has closed */
 329#define TTY_EXCLUSIVE           3       /* Exclusive open mode */
 330#define TTY_DEBUG               4       /* Debugging */
 331#define TTY_DO_WRITE_WAKEUP     5       /* Call write_wakeup after queuing new */
 332#define TTY_PUSH                6       /* n_tty private */
 333#define TTY_CLOSING             7       /* ->close() in progress */
 334#define TTY_DONT_FLIP           8       /* Defer buffer flip */
 335#define TTY_LDISC               9       /* Line discipline attached */
 336#define TTY_HW_COOK_OUT         14      /* Hardware can do output cooking */
 337#define TTY_HW_COOK_IN  15      /* Hardware can do input cooking */
 338#define TTY_PTY_LOCK            16      /* pty private */
 339#define TTY_NO_WRITE_SPLIT      17      /* Preserve write boundaries to driver */
 340#define TTY_HUPPED              18      /* Post driver->hangup() */
 341
 342#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
 343
 344extern void tty_write_flush(struct tty_struct *);
 345
 346extern struct termios tty_std_termios;
 347extern struct tty_ldisc tty_ldiscs[];
 348extern int fg_console, last_console, want_console;
 349
 350extern int kmsg_redirect;
 351
 352extern void con_init(void);
 353extern void console_init(void);
 354
 355extern int lp_init(void);
 356extern int pty_init(void);
 357extern void tty_init(void);
 358extern int mxser_init(void);
 359extern int moxa_init(void);
 360extern int ip2_init(void);
 361extern int pcxe_init(void);
 362extern int pc_init(void);
 363extern int vcs_init(void);
 364extern int rp_init(void);
 365extern int cy_init(void);
 366extern int stl_init(void);
 367extern int stli_init(void);
 368extern int specialix_init(void);
 369extern int espserial_init(void);
 370extern int macserial_init(void);
 371extern int a2232board_init(void);
 372
 373extern int tty_paranoia_check(struct tty_struct *tty, kdev_t device,
 374                              const char *routine);
 375extern char *tty_name(struct tty_struct *tty, char *buf);
 376extern void tty_wait_until_sent(struct tty_struct * tty, long timeout);
 377extern int tty_check_change(struct tty_struct * tty);
 378extern void stop_tty(struct tty_struct * tty);
 379extern void start_tty(struct tty_struct * tty);
 380extern int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc);
 381extern int tty_register_driver(struct tty_driver *driver);
 382extern int tty_unregister_driver(struct tty_driver *driver);
 383extern void tty_register_devfs (struct tty_driver *driver, unsigned int flags,
 384                                unsigned minor);
 385extern void tty_unregister_devfs (struct tty_driver *driver, unsigned minor);
 386extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
 387                             int buflen);
 388extern void tty_write_message(struct tty_struct *tty, char *msg);
 389
 390extern int is_orphaned_pgrp(int pgrp);
 391extern int is_ignored(int sig);
 392extern int tty_signal(int sig, struct tty_struct *tty);
 393extern void tty_hangup(struct tty_struct * tty);
 394extern void tty_vhangup(struct tty_struct * tty);
 395extern void tty_unhangup(struct file *filp);
 396extern int tty_hung_up_p(struct file * filp);
 397extern void do_SAK(struct tty_struct *tty);
 398extern void disassociate_ctty(int priv);
 399extern void tty_flip_buffer_push(struct tty_struct *tty);
 400extern int tty_get_baud_rate(struct tty_struct *tty);
 401
 402extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
 403extern void tty_ldisc_deref(struct tty_ldisc *);
 404extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
 405
 406extern struct tty_ldisc *tty_ldisc_get(int);
 407extern void tty_ldisc_put(int);
 408
 409extern void tty_wakeup(struct tty_struct *tty);
 410extern void tty_ldisc_flush(struct tty_struct *tty);
 411
 412
 413/* n_tty.c */
 414extern struct tty_ldisc tty_ldisc_N_TTY;
 415
 416/* tty_ioctl.c */
 417extern int n_tty_ioctl(struct tty_struct * tty, struct file * file,
 418                       unsigned int cmd, unsigned long arg);
 419
 420/* serial.c */
 421
 422extern void serial_console_init(void);
 423 
 424/* pcxx.c */
 425
 426extern int pcxe_open(struct tty_struct *tty, struct file *filp);
 427
 428/* printk.c */
 429
 430extern void console_print(const char *);
 431
 432/* vt.c */
 433
 434extern int vt_ioctl(struct tty_struct *tty, struct file * file,
 435                    unsigned int cmd, unsigned long arg);
 436
 437#endif /* __KERNEL__ */
 438#endif
 439