Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 8 | #ifdef __KERNEL__ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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> |
Ingo Molnar | 70522e1 | 2006-03-23 03:00:31 -0800 | [diff] [blame] | 15 | #include <linux/mutex.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Alan Cox | 33f0f88 | 2006-01-09 20:54:13 -0800 | [diff] [blame] | 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; |
Paul Fulghum | 8977d92 | 2006-02-10 01:51:14 -0800 | [diff] [blame] | 49 | int commit; |
| 50 | int read; |
Alan Cox | 33f0f88 | 2006-01-09 20:54:13 -0800 | [diff] [blame] | 51 | /* Data points here */ |
| 52 | unsigned long data[0]; |
| 53 | }; |
| 54 | |
| 55 | struct tty_bufhead { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 56 | struct work_struct work; |
| 57 | struct semaphore pty_sem; |
Paul Fulghum | 808249c | 2006-02-03 03:04:41 -0800 | [diff] [blame] | 58 | spinlock_t lock; |
Alan Cox | 33f0f88 | 2006-01-09 20:54:13 -0800 | [diff] [blame] | 59 | struct tty_buffer *head; /* Queue head */ |
| 60 | struct tty_buffer *tail; /* Active buffer */ |
| 61 | struct tty_buffer *free; /* Free queue head */ |
Alan Cox | 01da5fd | 2006-08-27 01:24:02 -0700 | [diff] [blame] | 62 | int memory_used; /* Buffer space used excluding free queue */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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; |
Arjan van de Ven | 5785c95 | 2006-09-29 02:00:43 -0700 | [diff] [blame] | 177 | struct mutex termios_mutex; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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; |
Alan Cox | 33f0f88 | 2006-01-09 20:54:13 -0800 | [diff] [blame] | 188 | unsigned int receive_room; /* Bytes free for queue */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 189 | |
| 190 | struct tty_struct *link; |
| 191 | struct fasync_struct *fasync; |
Alan Cox | 33f0f88 | 2006-01-09 20:54:13 -0800 | [diff] [blame] | 192 | struct tty_bufhead buf; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 193 | int alt_speed; /* For magic substitution of 38400 bps */ |
| 194 | wait_queue_head_t write_wait; |
| 195 | wait_queue_head_t read_wait; |
| 196 | struct work_struct hangup_work; |
| 197 | void *disc_data; |
| 198 | void *driver_data; |
| 199 | struct list_head tty_files; |
| 200 | |
| 201 | #define N_TTY_BUF_SIZE 4096 |
| 202 | |
| 203 | /* |
| 204 | * The following is data for the N_TTY line discipline. For |
| 205 | * historical reasons, this is included in the tty structure. |
| 206 | */ |
| 207 | unsigned int column; |
| 208 | unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1; |
| 209 | unsigned char closing:1; |
| 210 | unsigned short minimum_to_wake; |
| 211 | unsigned long overrun_time; |
| 212 | int num_overrun; |
| 213 | unsigned long process_char_map[256/(8*sizeof(unsigned long))]; |
| 214 | char *read_buf; |
| 215 | int read_head; |
| 216 | int read_tail; |
| 217 | int read_cnt; |
| 218 | unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))]; |
| 219 | int canon_data; |
| 220 | unsigned long canon_head; |
| 221 | unsigned int canon_column; |
Ingo Molnar | 70522e1 | 2006-03-23 03:00:31 -0800 | [diff] [blame] | 222 | struct mutex atomic_read_lock; |
| 223 | struct mutex atomic_write_lock; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 224 | unsigned char *write_buf; |
| 225 | int write_cnt; |
| 226 | spinlock_t read_lock; |
| 227 | /* If the tty has a pending do_SAK, queue it here - akpm */ |
| 228 | struct work_struct SAK_work; |
| 229 | }; |
| 230 | |
| 231 | /* tty magic number */ |
| 232 | #define TTY_MAGIC 0x5401 |
| 233 | |
| 234 | /* |
| 235 | * These bits are used in the flags field of the tty structure. |
| 236 | * |
| 237 | * So that interrupts won't be able to mess up the queues, |
| 238 | * copy_to_cooked must be atomic with respect to itself, as must |
| 239 | * tty->write. Thus, you must use the inline functions set_bit() and |
| 240 | * clear_bit() to make things atomic. |
| 241 | */ |
| 242 | #define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */ |
| 243 | #define TTY_IO_ERROR 1 /* Canse an I/O error (may be no ldisc too) */ |
| 244 | #define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */ |
| 245 | #define TTY_EXCLUSIVE 3 /* Exclusive open mode */ |
| 246 | #define TTY_DEBUG 4 /* Debugging */ |
| 247 | #define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */ |
| 248 | #define TTY_PUSH 6 /* n_tty private */ |
| 249 | #define TTY_CLOSING 7 /* ->close() in progress */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 250 | #define TTY_LDISC 9 /* Line discipline attached */ |
| 251 | #define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */ |
| 252 | #define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */ |
| 253 | #define TTY_PTY_LOCK 16 /* pty private */ |
| 254 | #define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */ |
| 255 | #define TTY_HUPPED 18 /* Post driver->hangup() */ |
| 256 | |
| 257 | #define TTY_WRITE_FLUSH(tty) tty_write_flush((tty)) |
| 258 | |
| 259 | extern void tty_write_flush(struct tty_struct *); |
| 260 | |
| 261 | extern struct termios tty_std_termios; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 262 | |
| 263 | extern int kmsg_redirect; |
| 264 | |
| 265 | extern void console_init(void); |
| 266 | extern int vcs_init(void); |
| 267 | |
| 268 | extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode, |
| 269 | const char *routine); |
| 270 | extern char *tty_name(struct tty_struct *tty, char *buf); |
| 271 | extern void tty_wait_until_sent(struct tty_struct * tty, long timeout); |
| 272 | extern int tty_check_change(struct tty_struct * tty); |
| 273 | extern void stop_tty(struct tty_struct * tty); |
| 274 | extern void start_tty(struct tty_struct * tty); |
| 275 | extern int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc); |
Alexey Dobriyan | bfb0759 | 2005-06-23 00:10:32 -0700 | [diff] [blame] | 276 | extern int tty_unregister_ldisc(int disc); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 277 | extern int tty_register_driver(struct tty_driver *driver); |
| 278 | extern int tty_unregister_driver(struct tty_driver *driver); |
Hansjoerg Lipp | 1cdcb6b | 2006-04-22 18:36:53 +0200 | [diff] [blame] | 279 | extern struct class_device *tty_register_device(struct tty_driver *driver, |
| 280 | unsigned index, |
| 281 | struct device *dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 282 | extern void tty_unregister_device(struct tty_driver *driver, unsigned index); |
| 283 | extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp, |
| 284 | int buflen); |
| 285 | extern void tty_write_message(struct tty_struct *tty, char *msg); |
| 286 | |
| 287 | extern int is_orphaned_pgrp(int pgrp); |
| 288 | extern int is_ignored(int sig); |
| 289 | extern int tty_signal(int sig, struct tty_struct *tty); |
| 290 | extern void tty_hangup(struct tty_struct * tty); |
| 291 | extern void tty_vhangup(struct tty_struct * tty); |
| 292 | extern void tty_unhangup(struct file *filp); |
| 293 | extern int tty_hung_up_p(struct file * filp); |
| 294 | extern void do_SAK(struct tty_struct *tty); |
| 295 | extern void disassociate_ctty(int priv); |
| 296 | extern void tty_flip_buffer_push(struct tty_struct *tty); |
| 297 | extern int tty_get_baud_rate(struct tty_struct *tty); |
| 298 | extern int tty_termios_baud_rate(struct termios *termios); |
| 299 | |
| 300 | extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *); |
| 301 | extern void tty_ldisc_deref(struct tty_ldisc *); |
| 302 | extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *); |
| 303 | |
| 304 | extern struct tty_ldisc *tty_ldisc_get(int); |
| 305 | extern void tty_ldisc_put(int); |
| 306 | |
| 307 | extern void tty_wakeup(struct tty_struct *tty); |
| 308 | extern void tty_ldisc_flush(struct tty_struct *tty); |
| 309 | |
Ingo Molnar | 70522e1 | 2006-03-23 03:00:31 -0800 | [diff] [blame] | 310 | extern struct mutex tty_mutex; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 311 | |
| 312 | /* n_tty.c */ |
| 313 | extern struct tty_ldisc tty_ldisc_N_TTY; |
| 314 | |
| 315 | /* tty_ioctl.c */ |
| 316 | extern int n_tty_ioctl(struct tty_struct * tty, struct file * file, |
| 317 | unsigned int cmd, unsigned long arg); |
| 318 | |
| 319 | /* serial.c */ |
| 320 | |
| 321 | extern void serial_console_init(void); |
| 322 | |
| 323 | /* pcxx.c */ |
| 324 | |
| 325 | extern int pcxe_open(struct tty_struct *tty, struct file *filp); |
| 326 | |
| 327 | /* printk.c */ |
| 328 | |
| 329 | extern void console_print(const char *); |
| 330 | |
| 331 | /* vt.c */ |
| 332 | |
| 333 | extern int vt_ioctl(struct tty_struct *tty, struct file * file, |
| 334 | unsigned int cmd, unsigned long arg); |
| 335 | |
| 336 | static inline dev_t tty_devnum(struct tty_struct *tty) |
| 337 | { |
| 338 | return MKDEV(tty->driver->major, tty->driver->minor_start) + tty->index; |
| 339 | } |
| 340 | |
| 341 | #endif /* __KERNEL__ */ |
| 342 | #endif |