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 #include <linux/termios.h>
   9 
  10 #include <asm/system.h>
  11 
  12 #define NR_CONSOLES     8
  13 #define NR_LDISCS       16
  14 
  15 /*
  16  * These are set up by the setup-routine at boot-time:
  17  */
  18 
  19 struct screen_info {
  20         unsigned char  orig_x;
  21         unsigned char  orig_y;
  22         unsigned char  unused1[2];
  23         unsigned short orig_video_page;
  24         unsigned char  orig_video_mode;
  25         unsigned char  orig_video_cols;
  26         unsigned short orig_video_ega_ax;
  27         unsigned short orig_video_ega_bx;
  28         unsigned short orig_video_ega_cx;
  29         unsigned char  orig_video_lines;
  30 };
  31 
  32 extern struct screen_info screen_info;
  33 
  34 #define ORIG_X                  (screen_info.orig_x)
  35 #define ORIG_Y                  (screen_info.orig_y)
  36 #define ORIG_VIDEO_PAGE         (screen_info.orig_video_page)
  37 #define ORIG_VIDEO_MODE         (screen_info.orig_video_mode)
  38 #define ORIG_VIDEO_COLS         (screen_info.orig_video_cols)
  39 #define ORIG_VIDEO_EGA_AX       (screen_info.orig_video_ega_ax)
  40 #define ORIG_VIDEO_EGA_BX       (screen_info.orig_video_ega_bx)
  41 #define ORIG_VIDEO_EGA_CX       (screen_info.orig_video_ega_cx)
  42 #define ORIG_VIDEO_LINES        (screen_info.orig_video_lines)
  43 
  44 #define VIDEO_TYPE_MDA          0x10    /* Monochrome Text Display      */
  45 #define VIDEO_TYPE_CGA          0x11    /* CGA Display                  */
  46 #define VIDEO_TYPE_EGAM         0x20    /* EGA/VGA in Monochrome Mode   */
  47 #define VIDEO_TYPE_EGAC         0x21    /* EGA/VGA in Color Mode        */
  48 
  49 /*
  50  * This character is the same as _POSIX_VDISABLE: it cannot be used as
  51  * a c_cc[] character, but indicates that a particular special character
  52  * isn't in use (eg VINTR ahs no character etc)
  53  */
  54 #define __DISABLED_CHAR '\0'
  55 
  56 /*
  57  * See comment for the tty_struct structure before changing
  58  * TTY_BUF_SIZE.  Actually, there should be different sized tty_queue
  59  * structures for different purposes.  1024 bytes for the transmit
  60  * queue is way overkill.  TYT, 9/14/92
  61  */
  62 #define TTY_BUF_SIZE 1024       /* Must be a power of 2 */
  63 
  64 struct tty_queue {
  65         unsigned long data;
  66         unsigned long head;
  67         unsigned long tail;
  68         struct wait_queue * proc_list;
  69         unsigned char buf[TTY_BUF_SIZE];
  70 };
  71 
  72 struct serial_struct {
  73         int     type;
  74         int     line;
  75         int     port;
  76         int     irq;
  77         int     flags;
  78         int     xmit_fifo_size;
  79         int     custom_divisor;
  80         int     baud_base;
  81         char    close_delay;
  82         char    reserved_char[3];
  83         int     reserved[6];
  84 };
  85 
  86 /*
  87  * These are the supported serial types.
  88  */
  89 #define PORT_UNKNOWN    0
  90 #define PORT_8250       1
  91 #define PORT_16450      2
  92 #define PORT_16550      3
  93 #define PORT_16550A     4
  94 #define PORT_MAX        4
  95 
  96 /*
  97  * Definitions for async_struct (and serial_struct) flags field
  98  */
  99 #define ASYNC_HUP_NOTIFY 0x0001 /* Notify blocked open on hangups */
 100 #define ASYNC_FOURPORT  0x0002  /* Set OU1, OUT2 per AST Fourport settings */
 101 #define ASYNC_SAK       0x0004  /* Secure Attention Key (Orange book) */
 102 
 103 #define ASYNC_SPD_MASK  0x0030
 104 #define ASYNC_SPD_HI    0x0010  /* Use 56000 instead of 38400 bps */
 105 #define ASYNC_SPD_VHI   0x0020  /* Use 115200 instead of 38400 bps */
 106 #define ASYNC_SPD_CUST  0x0030  /* Use user-specified divisor */
 107 
 108 #define ASYNC_FLAGS     0x0037  /* Possible legal async flags */
 109 
 110 /* Internal flags used only by kernel/chr_drv/serial.c */
 111 #define ASYNC_INITIALIZED       0x80000000 /* Serial port was initialized */
 112 #define ASYNC_CALLOUT_ACTIVE    0x40000000 /* Call out device is active */
 113 #define ASYNC_NORMAL_ACTIVE     0x20000000 /* Normal device is active */
 114 
 115 #define IS_A_CONSOLE(min)       (((min) & 0xC0) == 0x00)
 116 #define IS_A_SERIAL(min)        (((min) & 0xC0) == 0x40)
 117 #define IS_A_PTY(min)           ((min) & 0x80)
 118 #define IS_A_PTY_MASTER(min)    (((min) & 0xC0) == 0x80)
 119 #define IS_A_PTY_SLAVE(min)     (((min) & 0xC0) == 0xC0)
 120 #define PTY_OTHER(min)          ((min) ^ 0x40)
 121 
 122 #define SL_TO_DEV(line)         ((line) | 0x40)
 123 #define DEV_TO_SL(min)          ((min) & 0x3F)
 124 
 125 #define INC(a) ((a) = ((a)+1) & (TTY_BUF_SIZE-1))
 126 #define DEC(a) ((a) = ((a)-1) & (TTY_BUF_SIZE-1))
 127 #define EMPTY(a) ((a)->head == (a)->tail)
 128 #define LEFT(a) (((a)->tail-(a)->head-1)&(TTY_BUF_SIZE-1))
 129 #define LAST(a) ((a)->buf[(TTY_BUF_SIZE-1)&((a)->head-1)])
 130 #define FULL(a) (!LEFT(a))
 131 #define CHARS(a) (((a)->head-(a)->tail)&(TTY_BUF_SIZE-1))
 132 
 133 extern void put_tty_queue(char c, struct tty_queue * queue);
 134 extern int get_tty_queue(struct tty_queue * queue);
 135 
 136 #define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
 137 #define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
 138 #define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
 139 #define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
 140 #define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
 141 #define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
 142 #define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
 143 #define SUSPEND_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
 144 #define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
 145 
 146 #define _L_FLAG(tty,f)  ((tty)->termios->c_lflag & f)
 147 #define _I_FLAG(tty,f)  ((tty)->termios->c_iflag & f)
 148 #define _O_FLAG(tty,f)  ((tty)->termios->c_oflag & f)
 149 #define _C_FLAG(tty,f)  ((tty)->termios->c_cflag & f)
 150 
 151 #define L_CANON(tty)    _L_FLAG((tty),ICANON)
 152 #define L_ISIG(tty)     _L_FLAG((tty),ISIG)
 153 #define L_ECHO(tty)     _L_FLAG((tty),ECHO)
 154 #define L_ECHOE(tty)    _L_FLAG((tty),ECHOE)
 155 #define L_ECHOK(tty)    _L_FLAG((tty),ECHOK)
 156 #define L_ECHONL(tty)   _L_FLAG((tty),ECHONL)
 157 #define L_ECHOCTL(tty)  _L_FLAG((tty),ECHOCTL)
 158 #define L_ECHOKE(tty)   _L_FLAG((tty),ECHOKE)
 159 #define L_TOSTOP(tty)   _L_FLAG((tty),TOSTOP)
 160 
 161 #define I_IGNBRK(tty)   _I_FLAG((tty),IGNBRK)
 162 #define I_BRKINT(tty)   _I_FLAG((tty),BRKINT)
 163 #define I_IGNPAR(tty)   _I_FLAG((tty),IGNPAR)
 164 #define I_PARMRK(tty)   _I_FLAG((tty),PARMRK)
 165 #define I_INPCK(tty)    _I_FLAG((tty),INPCK)
 166 #define I_UCLC(tty)     _I_FLAG((tty),IUCLC)
 167 #define I_NLCR(tty)     _I_FLAG((tty),INLCR)
 168 #define I_CRNL(tty)     _I_FLAG((tty),ICRNL)
 169 #define I_NOCR(tty)     _I_FLAG((tty),IGNCR)
 170 #define I_IXON(tty)     _I_FLAG((tty),IXON)
 171 #define I_IXANY(tty)    _I_FLAG((tty),IXANY)
 172 #define I_STRP(tty)     _I_FLAG((tty),ISTRIP)
 173 
 174 #define O_POST(tty)     _O_FLAG((tty),OPOST)
 175 #define O_NLCR(tty)     _O_FLAG((tty),ONLCR)
 176 #define O_CRNL(tty)     _O_FLAG((tty),OCRNL)
 177 #define O_NLRET(tty)    _O_FLAG((tty),ONLRET)
 178 #define O_LCUC(tty)     _O_FLAG((tty),OLCUC)
 179 
 180 #define C_LOCAL(tty)    _C_FLAG((tty),CLOCAL)
 181 #define C_RTSCTS(tty)   _C_FLAG((tty),CRTSCTS)
 182 #define C_SPEED(tty)    ((tty)->termios->c_cflag & CBAUD)
 183 #define C_HUP(tty)      (C_SPEED((tty)) == B0)
 184 
 185 /*
 186  * Where all of the state associated with a tty is kept while the tty
 187  * is open.  Since the termios state should be kept even if the tty
 188  * has been closed --- for things like the baud rate, etc --- it is
 189  * not stored here, but rather a pointer to the real state is stored
 190  * here.  Possible the winsize structure should have the same
 191  * treatment, but (1) the default 80x24 is usually right and (2) it's
 192  * most often used by a windowing system, which will set the correct
 193  * size each time the window is created or resized anyway.
 194  * IMPORTANT: since this structure is dynamically allocated, it must
 195  * be no larger than 4096 bytes.  Changing TTY_BUF_SIZE will change
 196  * the size of this structure, and it needs to be done with care.
 197  *                                              - TYT, 9/14/92
 198  */
 199 struct tty_struct {
 200         struct termios *termios;
 201         int pgrp;
 202         int session;
 203         unsigned char stopped:1, status_changed:1, packet:1, lnext:1;
 204         unsigned char char_error:2;
 205         unsigned char ctrl_status;
 206         short line;
 207         int disc;
 208         int flags;
 209         int count;
 210         struct winsize winsize;
 211         int  (*open)(struct tty_struct * tty, struct file * filp);
 212         void (*close)(struct tty_struct * tty, struct file * filp);
 213         void (*write)(struct tty_struct * tty);
 214         int  (*ioctl)(struct tty_struct *tty, struct file * file,
 215                     unsigned int cmd, unsigned int arg);
 216         void (*throttle)(struct tty_struct * tty, int status);
 217         void (*set_termios)(struct tty_struct *tty, struct termios * old);
 218         struct tty_struct *link;
 219         unsigned char *write_data_ptr;
 220         int write_data_cnt;
 221         void (*write_data_callback)(void * data);
 222         void * write_data_arg;
 223         int readq_flags[TTY_BUF_SIZE/32];
 224         struct tty_queue read_q;
 225         struct tty_queue write_q;
 226         struct tty_queue secondary;
 227         };
 228 
 229 struct tty_ldisc {
 230         int     flags;
 231         /*
 232          * The following routines are called from above.
 233          */
 234         int     (*open)(struct tty_struct *);
 235         void    (*close)(struct tty_struct *);
 236         int     (*read)(struct tty_struct * tty, struct file * file,
 237                         char * buf, int nr);
 238         int     (*write)(struct tty_struct * tty, struct file * file,
 239                          char * buf, int nr);   
 240         int     (*ioctl)(struct tty_struct * tty, struct file * file,
 241                          unsigned int cmd, unsigned int arg);
 242         /*
 243          * The following routines are called from below.
 244          */
 245         void    (*handler)(struct tty_struct *);
 246 };
 247 
 248 #define LDISC_FLAG_DEFINED      0x00000001
 249 
 250 /*
 251  * These are the different types of thottle status which can be sent
 252  * to the low-level tty driver.  The tty_io.c layer is responsible for
 253  * notifying the low-level tty driver of the following conditions:
 254  * secondary queue full, secondary queue available, and read queue
 255  * available.  The low-level driver must send the read queue full
 256  * command to itself, if it is interested in that condition.
 257  *
 258  * Note that the low-level tty driver may elect to ignore one or both
 259  * of these conditions; normally, however, it will use ^S/^Q or some
 260  * sort of hardware flow control to regulate the input to try to avoid
 261  * overflow.  While the low-level driver is responsible for all
 262  * receiving flow control, note that the ^S/^Q handling (but not
 263  * hardware flow control) is handled by the upper layer, in
 264  * copy_to_cooked.  
 265  */
 266 #define TTY_THROTTLE_SQ_FULL    1
 267 #define TTY_THROTTLE_SQ_AVAIL   2
 268 #define TTY_THROTTLE_RQ_FULL    3
 269 #define TTY_THROTTLE_RQ_AVAIL   4
 270 
 271 /*
 272  * This defines the low- and high-watermarks for the various conditions.
 273  * Again, the low-level driver is free to ignore any of these, and has
 274  * to implement RQ_THREHOLD_LW for itself if it wants it.
 275  */
 276 #define SQ_THRESHOLD_LW 16
 277 #define SQ_THRESHOLD_HW 768
 278 #define RQ_THRESHOLD_LW 16
 279 #define RQ_THRESHOLD_HW 768
 280 
 281 /*
 282  * These bits are used in the flags field of the tty structure.
 283  * 
 284  * So that interrupts won't be able to mess up the queues,
 285  * copy_to_cooked must be atomic with repect to itself, as must
 286  * tty->write.  Thus, you must use the inline functions set_bit() and
 287  * clear_bit() to make things atomic.
 288  */
 289 #define TTY_WRITE_BUSY 0
 290 #define TTY_READ_BUSY 1
 291 #define TTY_CR_PENDING 2
 292 #define TTY_SQ_THROTTLED 3
 293 #define TTY_RQ_THROTTLED 4
 294 #define TTY_IO_ERROR 5
 295 
 296 /*
 297  * When a break, frame error, or parity error happens, these codes are
 298  * stuffed into the read queue, and the relevant bit in readq_flag bit
 299  * array is set.
 300  */
 301 #define TTY_BREAK       1
 302 #define TTY_FRAME       2
 303 #define TTY_PARITY      3
 304 
 305 #define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
 306 #define TTY_READ_FLUSH(tty) tty_read_flush((tty))
 307 
 308 extern void tty_write_flush(struct tty_struct *);
 309 extern void tty_read_flush(struct tty_struct *);
 310 
 311 extern struct tty_struct *tty_table[];
 312 extern int tty_check_write[];
 313 extern struct tty_struct * redirect;
 314 extern struct tty_ldisc ldiscs[];
 315 extern int fg_console;
 316 extern unsigned long video_num_columns;
 317 extern unsigned long video_num_lines;
 318 extern struct wait_queue * keypress_wait;
 319 
 320 #define TTY_TABLE_IDX(nr)       ((nr) ? (nr) : (fg_console+1))
 321 #define TTY_TABLE(nr)           (tty_table[TTY_TABLE_IDX(nr)])
 322 
 323 /*      intr=^C         quit=^|         erase=del       kill=^U
 324         eof=^D          vtime=\0        vmin=\1         sxtc=\0
 325         start=^Q        stop=^S         susp=^Z         eol=\0
 326         reprint=^R      discard=^U      werase=^W       lnext=^V
 327         eol2=\0
 328 */
 329 #define INIT_C_CC "\003\034\177\025\004\0\1\0\021\023\032\0\022\017\027\026\0"
 330 
 331 extern long rs_init(long);
 332 extern long lp_init(long);
 333 extern long con_init(long);
 334 extern long tty_init(long);
 335 
 336 extern void flush_input(struct tty_struct * tty);
 337 extern void flush_output(struct tty_struct * tty);
 338 extern void wait_until_sent(struct tty_struct * tty);
 339 extern void copy_to_cooked(struct tty_struct * tty);
 340 extern int tty_register_ldisc(int disc, struct tty_ldisc *new);
 341 
 342 extern int tty_ioctl(struct inode *, struct file *, unsigned int, unsigned int);
 343 extern int is_orphaned_pgrp(int pgrp);
 344 extern int is_ignored(int sig);
 345 extern int tty_signal(int sig, struct tty_struct *tty);
 346 extern int kill_pg(int pgrp, int sig, int priv);
 347 extern int kill_sl(int sess, int sig, int priv);
 348 extern void tty_hangup(struct tty_struct * tty);
 349 extern void tty_vhangup(struct tty_struct * tty);
 350 extern void tty_unhangup(struct file *filp);
 351 extern int tty_hung_up_p(struct file * filp);
 352 extern void do_SAK(struct tty_struct *tty);
 353 
 354 /* tty write functions */
 355 
 356 extern void rs_write(struct tty_struct * tty);
 357 extern void con_write(struct tty_struct * tty);
 358 
 359 /* serial.c */
 360 
 361 extern int  rs_open(struct tty_struct * tty, struct file * filp);
 362 
 363 /* pty.c */
 364 
 365 extern int  pty_open(struct tty_struct * tty, struct file * filp);
 366 
 367 /* console.c */
 368 
 369 extern int con_open(struct tty_struct * tty, struct file * filp);
 370 extern void update_screen(int new_console);
 371 extern void blank_screen(void);
 372 extern void unblank_screen(void);
 373 
 374 /* vt.c */
 375 
 376 extern int vt_ioctl(struct tty_struct *tty, struct file * file,
 377                     unsigned int cmd, unsigned int arg);
 378 
 379 #endif
/* */
root/include/linux/tty.h

INCLUDED FROM
