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/major.h> 11 #include <linux/termios.h> 12 #include <linux/workqueue.h> 13 #include <linux/tty_driver.h> 14 #include <linux/tty_ldisc.h> 15 #include <linux/mutex.h> 16 17 #include <asm/system.h> 18 19 20 /* 21 * (Note: the *_driver.minor_start values 1, 64, 128, 192 are 22 * hardcoded at present.) 23 */ 24 #define NR_PTYS CONFIG_LEGACY_PTY_COUNT /* Number of legacy ptys */ 25 #define NR_UNIX98_PTY_DEFAULT 4096 /* Default maximum for Unix98 ptys */ 26 #define NR_UNIX98_PTY_MAX (1 << MINORBITS) /* Absolute limit */ 27 #define NR_LDISCS 16 28 29 /* 30 * This character is the same as _POSIX_VDISABLE: it cannot be used as 31 * a c_cc[] character, but indicates that a particular special character 32 * isn't in use (eg VINTR has no character etc) 33 */ 34 #define __DISABLED_CHAR '\0' 35 36 /* 37 * This is the flip buffer used for the tty driver. The buffer is 38 * located in the tty structure, and is used as a high speed interface 39 * between the tty driver and the tty line discipline. 40 */ 41 #define TTY_FLIPBUF_SIZE 512 42 43 struct tty_buffer { 44 struct tty_buffer *next; 45 char *char_buf_ptr; 46 unsigned char *flag_buf_ptr; 47 int used; 48 int size; 49 int commit; 50 int read; 51 /* Data points here */ 52 unsigned long data[0]; 53 }; 54 55 struct tty_bufhead { 56 struct work_struct work; 57 struct semaphore pty_sem; 58 spinlock_t lock; 59 struct tty_buffer *head; /* Queue head */ 60 struct tty_buffer *tail; /* Active buffer */ 61 struct tty_buffer *free; /* Free queue head */ 62 int memory_used; /* Buffer space used excluding free queue */ 63 }; 64 /* 65 * The pty uses char_buf and flag_buf as a contiguous buffer 66 */ 67 #define PTY_BUF_SIZE 4*TTY_FLIPBUF_SIZE 68 69 /* 70 * When a break, frame error, or parity error happens, these codes are 71 * stuffed into the flags buffer. 72 */ 73 #define TTY_NORMAL 0 74 #define TTY_BREAK 1 75 #define TTY_FRAME 2 76 #define TTY_PARITY 3 77 #define TTY_OVERRUN 4 78 79 #define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR]) 80 #define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT]) 81 #define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE]) 82 #define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL]) 83 #define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF]) 84 #define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME]) 85 #define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN]) 86 #define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC]) 87 #define START_CHAR(tty) ((tty)->termios->c_cc[VSTART]) 88 #define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP]) 89 #define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP]) 90 #define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL]) 91 #define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT]) 92 #define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD]) 93 #define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE]) 94 #define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT]) 95 #define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2]) 96 97 #define _I_FLAG(tty,f) ((tty)->termios->c_iflag & (f)) 98 #define _O_FLAG(tty,f) ((tty)->termios->c_oflag & (f)) 99 #define _C_FLAG(tty,f) ((tty)->termios->c_cflag & (f)) 100 #define _L_FLAG(tty,f) ((tty)->termios->c_lflag & (f)) 101 102 #define I_IGNBRK(tty) _I_FLAG((tty),IGNBRK) 103 #define I_BRKINT(tty) _I_FLAG((tty),BRKINT) 104 #define I_IGNPAR(tty) _I_FLAG((tty),IGNPAR) 105 #define I_PARMRK(tty) _I_FLAG((tty),PARMRK) 106 #define I_INPCK(tty) _I_FLAG((tty),INPCK) 107 #define I_ISTRIP(tty) _I_FLAG((tty),ISTRIP) 108 #define I_INLCR(tty) _I_FLAG((tty),INLCR) 109 #define I_IGNCR(tty) _I_FLAG((tty),IGNCR) 110 #define I_ICRNL(tty) _I_FLAG((tty),ICRNL) 111 #define I_IUCLC(tty) _I_FLAG((tty),IUCLC) 112 #define I_IXON(tty) _I_FLAG((tty),IXON) 113 #define I_IXANY(tty) _I_FLAG((tty),IXANY) 114 #define I_IXOFF(tty) _I_FLAG((tty),IXOFF) 115 #define I_IMAXBEL(tty) _I_FLAG((tty),IMAXBEL) 116 #define I_IUTF8(tty) _I_FLAG((tty),IUTF8) 117 118 #define O_OPOST(tty) _O_FLAG((tty),OPOST) 119 #define O_OLCUC(tty) _O_FLAG((tty),OLCUC) 120 #define O_ONLCR(tty) _O_FLAG((tty),ONLCR) 121 #define O_OCRNL(tty) _O_FLAG((tty),OCRNL) 122 #define O_ONOCR(tty) _O_FLAG((tty),ONOCR) 123 #define O_ONLRET(tty) _O_FLAG((tty),ONLRET) 124 #define O_OFILL(tty) _O_FLAG((tty),OFILL) 125 #define O_OFDEL(tty) _O_FLAG((tty),OFDEL) 126 #define O_NLDLY(tty) _O_FLAG((tty),NLDLY) 127 #define O_CRDLY(tty) _O_FLAG((tty),CRDLY) 128 #define O_TABDLY(tty) _O_FLAG((tty),TABDLY) 129 #define O_BSDLY(tty) _O_FLAG((tty),BSDLY) 130 #define O_VTDLY(tty) _O_FLAG((tty),VTDLY) 131 #define O_FFDLY(tty) _O_FLAG((tty),FFDLY) 132 133 #define C_BAUD(tty) _C_FLAG((tty),CBAUD) 134 #define C_CSIZE(tty) _C_FLAG((tty),CSIZE) 135 #define C_CSTOPB(tty) _C_FLAG((tty),CSTOPB) 136 #define C_CREAD(tty) _C_FLAG((tty),CREAD) 137 #define C_PARENB(tty) _C_FLAG((tty),PARENB) 138 #define C_PARODD(tty) _C_FLAG((tty),PARODD) 139 #define C_HUPCL(tty) _C_FLAG((tty),HUPCL) 140 #define C_CLOCAL(tty) _C_FLAG((tty),CLOCAL) 141 #define C_CIBAUD(tty) _C_FLAG((tty),CIBAUD) 142 #define C_CRTSCTS(tty) _C_FLAG((tty),CRTSCTS) 143 144 #define L_ISIG(tty) _L_FLAG((tty),ISIG) 145 #define L_ICANON(tty) _L_FLAG((tty),ICANON) 146 #define L_XCASE(tty) _L_FLAG((tty),XCASE) 147 #define L_ECHO(tty) _L_FLAG((tty),ECHO) 148 #define L_ECHOE(tty) _L_FLAG((tty),ECHOE) 149 #define L_ECHOK(tty) _L_FLAG((tty),ECHOK) 150 #define L_ECHONL(tty) _L_FLAG((tty),ECHONL) 151 #define L_NOFLSH(tty) _L_FLAG((tty),NOFLSH) 152 #define L_TOSTOP(tty) _L_FLAG((tty),TOSTOP) 153 #define L_ECHOCTL(tty) _L_FLAG((tty),ECHOCTL) 154 #define L_ECHOPRT(tty) _L_FLAG((tty),ECHOPRT) 155 #define L_ECHOKE(tty) _L_FLAG((tty),ECHOKE) 156 #define L_FLUSHO(tty) _L_FLAG((tty),FLUSHO) 157 #define L_PENDIN(tty) _L_FLAG((tty),PENDIN) 158 #define L_IEXTEN(tty) _L_FLAG((tty),IEXTEN) 159 160 struct device; 161 /* 162 * Where all of the state associated with a tty is kept while the tty 163 * is open. Since the termios state should be kept even if the tty 164 * has been closed --- for things like the baud rate, etc --- it is 165 * not stored here, but rather a pointer to the real state is stored 166 * here. Possible the winsize structure should have the same 167 * treatment, but (1) the default 80x24 is usually right and (2) it's 168 * most often used by a windowing system, which will set the correct 169 * size each time the window is created or resized anyway. 170 * - TYT, 9/14/92 171 */ 172 struct tty_struct { 173 int magic; 174 struct tty_driver *driver; 175 int index; 176 struct tty_ldisc ldisc; 177 struct semaphore termios_sem; 178 struct termios *termios, *termios_locked; 179 char name[64]; 180 int pgrp; 181 int session; 182 unsigned long flags; 183 int count; 184 struct winsize winsize; 185 unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1; 186 unsigned char low_latency:1, warned:1; 187 unsigned char ctrl_status; 188 unsigned int receive_room; /* Bytes free for queue */ 189 190 struct tty_struct *link; 191 struct fasync_struct *fasync; 192 struct tty_bufhead buf; 193 int max_flip_cnt; 194 int alt_speed; /* For magic substitution of 38400 bps */ 195 wait_queue_head_t write_wait; 196 wait_queue_head_t read_wait; 197 struct work_struct hangup_work; 198 void *disc_data; 199 void *driver_data; 200 struct list_head tty_files; 201 202 #define N_TTY_BUF_SIZE 4096 203 204 /* 205 * The following is data for the N_TTY line discipline. For 206 * historical reasons, this is included in the tty structure. 207 */ 208 unsigned int column; 209 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1; 210 unsigned char closing:1; 211 unsigned short minimum_to_wake; 212 unsigned long overrun_time; 213 int num_overrun; 214 unsigned long process_char_map[256/(8*sizeof(unsigned long))]; 215 char *read_buf; 216 int read_head; 217 int read_tail; 218 int read_cnt; 219 unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))]; 220 int canon_data; 221 unsigned long canon_head; 222 unsigned int canon_column; 223 struct mutex atomic_read_lock; 224 struct mutex atomic_write_lock; 225 unsigned char *write_buf; 226 int write_cnt; 227 spinlock_t read_lock; 228 /* If the tty has a pending do_SAK, queue it here - akpm */ 229 struct work_struct SAK_work; 230 }; 231 232 /* tty magic number */ 233 #define TTY_MAGIC 0x5401 234 235 /* 236 * These bits are used in the flags field of the tty structure. 237 * 238 * So that interrupts won't be able to mess up the queues, 239 * copy_to_cooked must be atomic with respect to itself, as must 240 * tty->write. Thus, you must use the inline functions set_bit() and 241 * clear_bit() to make things atomic. 242 */ 243 #define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */ 244 #define TTY_IO_ERROR 1 /* Canse an I/O error (may be no ldisc too) */ 245 #define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */ 246 #define TTY_EXCLUSIVE 3 /* Exclusive open mode */ 247 #define TTY_DEBUG 4 /* Debugging */ 248 #define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */ 249 #define TTY_PUSH 6 /* n_tty private */ 250 #define TTY_CLOSING 7 /* ->close() in progress */ 251 #define TTY_LDISC 9 /* Line discipline attached */ 252 #define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */ 253 #define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */ 254 #define TTY_PTY_LOCK 16 /* pty private */ 255 #define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */ 256 #define TTY_HUPPED 18 /* Post driver->hangup() */ 257 258 #define TTY_WRITE_FLUSH(tty) tty_write_flush((tty)) 259 260 extern void tty_write_flush(struct tty_struct *); 261 262 extern struct termios tty_std_termios; 263 264 extern int kmsg_redirect; 265 266 extern void console_init(void); 267 extern int vcs_init(void); 268 269 extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode, 270 const char *routine); 271 extern char *tty_name(struct tty_struct *tty, char *buf); 272 extern void tty_wait_until_sent(struct tty_struct * tty, long timeout); 273 extern int tty_check_change(struct tty_struct * tty); 274 extern void stop_tty(struct tty_struct * tty); 275 extern void start_tty(struct tty_struct * tty); 276 extern int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc); 277 extern int tty_unregister_ldisc(int disc); 278 extern int tty_register_driver(struct tty_driver *driver); 279 extern int tty_unregister_driver(struct tty_driver *driver); 280 extern struct class_device *tty_register_device(struct tty_driver *driver, 281 unsigned index, 282 struct device *dev); 283 extern void tty_unregister_device(struct tty_driver *driver, unsigned index); 284 extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp, 285 int buflen); 286 extern void tty_write_message(struct tty_struct *tty, char *msg); 287 288 extern int is_orphaned_pgrp(int pgrp); 289 extern int is_ignored(int sig); 290 extern int tty_signal(int sig, struct tty_struct *tty); 291 extern void tty_hangup(struct tty_struct * tty); 292 extern void tty_vhangup(struct tty_struct * tty); 293 extern void tty_unhangup(struct file *filp); 294 extern int tty_hung_up_p(struct file * filp); 295 extern void do_SAK(struct tty_struct *tty); 296 extern void disassociate_ctty(int priv); 297 extern void tty_flip_buffer_push(struct tty_struct *tty); 298 extern int tty_get_baud_rate(struct tty_struct *tty); 299 extern int tty_termios_baud_rate(struct termios *termios); 300 301 extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *); 302 extern void tty_ldisc_deref(struct tty_ldisc *); 303 extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *); 304 305 extern struct tty_ldisc *tty_ldisc_get(int); 306 extern void tty_ldisc_put(int); 307 308 extern void tty_wakeup(struct tty_struct *tty); 309 extern void tty_ldisc_flush(struct tty_struct *tty); 310 311 extern struct mutex tty_mutex; 312 313 /* n_tty.c */ 314 extern struct tty_ldisc tty_ldisc_N_TTY; 315 316 /* tty_ioctl.c */ 317 extern int n_tty_ioctl(struct tty_struct * tty, struct file * file, 318 unsigned int cmd, unsigned long arg); 319 320 /* serial.c */ 321 322 extern void serial_console_init(void); 323 324 /* pcxx.c */ 325 326 extern int pcxe_open(struct tty_struct *tty, struct file *filp); 327 328 /* printk.c */ 329 330 extern void console_print(const char *); 331 332 /* vt.c */ 333 334 extern int vt_ioctl(struct tty_struct *tty, struct file * file, 335 unsigned int cmd, unsigned long arg); 336 337 static inline dev_t tty_devnum(struct tty_struct *tty) 338 { 339 return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index; 340 } 341 342 #endif /* __KERNEL__ */ 343 #endif 344