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