tty.h revision bddc7152f68bc1e0ee1f55a8055e33531f384101
1#ifndef _LINUX_TTY_H 2#define _LINUX_TTY_H 3 4#include <linux/fs.h> 5#include <linux/major.h> 6#include <linux/termios.h> 7#include <linux/workqueue.h> 8#include <linux/tty_driver.h> 9#include <linux/tty_ldisc.h> 10#include <linux/mutex.h> 11#include <linux/tty_flags.h> 12#include <uapi/linux/tty.h> 13 14 15 16/* 17 * (Note: the *_driver.minor_start values 1, 64, 128, 192 are 18 * hardcoded at present.) 19 */ 20#define NR_UNIX98_PTY_DEFAULT 4096 /* Default maximum for Unix98 ptys */ 21#define NR_UNIX98_PTY_RESERVE 1024 /* Default reserve for main devpts */ 22#define NR_UNIX98_PTY_MAX (1 << MINORBITS) /* Absolute limit */ 23 24/* 25 * This character is the same as _POSIX_VDISABLE: it cannot be used as 26 * a c_cc[] character, but indicates that a particular special character 27 * isn't in use (eg VINTR has no character etc) 28 */ 29#define __DISABLED_CHAR '\0' 30 31struct tty_buffer { 32 struct tty_buffer *next; 33 char *char_buf_ptr; 34 unsigned char *flag_buf_ptr; 35 int used; 36 int size; 37 int commit; 38 int read; 39 /* Data points here */ 40 unsigned long data[0]; 41}; 42 43/* 44 * We default to dicing tty buffer allocations to this many characters 45 * in order to avoid multiple page allocations. We know the size of 46 * tty_buffer itself but it must also be taken into account that the 47 * the buffer is 256 byte aligned. See tty_buffer_find for the allocation 48 * logic this must match 49 */ 50 51#define TTY_BUFFER_PAGE (((PAGE_SIZE - sizeof(struct tty_buffer)) / 2) & ~0xFF) 52 53 54struct tty_bufhead { 55 struct work_struct work; 56 spinlock_t lock; 57 struct tty_buffer *head; /* Queue head */ 58 struct tty_buffer *tail; /* Active buffer */ 59 struct tty_buffer *free; /* Free queue head */ 60 int memory_used; /* Buffer space used excluding 61 free queue */ 62}; 63/* 64 * When a break, frame error, or parity error happens, these codes are 65 * stuffed into the flags buffer. 66 */ 67#define TTY_NORMAL 0 68#define TTY_BREAK 1 69#define TTY_FRAME 2 70#define TTY_PARITY 3 71#define TTY_OVERRUN 4 72 73#define INTR_CHAR(tty) ((tty)->termios.c_cc[VINTR]) 74#define QUIT_CHAR(tty) ((tty)->termios.c_cc[VQUIT]) 75#define ERASE_CHAR(tty) ((tty)->termios.c_cc[VERASE]) 76#define KILL_CHAR(tty) ((tty)->termios.c_cc[VKILL]) 77#define EOF_CHAR(tty) ((tty)->termios.c_cc[VEOF]) 78#define TIME_CHAR(tty) ((tty)->termios.c_cc[VTIME]) 79#define MIN_CHAR(tty) ((tty)->termios.c_cc[VMIN]) 80#define SWTC_CHAR(tty) ((tty)->termios.c_cc[VSWTC]) 81#define START_CHAR(tty) ((tty)->termios.c_cc[VSTART]) 82#define STOP_CHAR(tty) ((tty)->termios.c_cc[VSTOP]) 83#define SUSP_CHAR(tty) ((tty)->termios.c_cc[VSUSP]) 84#define EOL_CHAR(tty) ((tty)->termios.c_cc[VEOL]) 85#define REPRINT_CHAR(tty) ((tty)->termios.c_cc[VREPRINT]) 86#define DISCARD_CHAR(tty) ((tty)->termios.c_cc[VDISCARD]) 87#define WERASE_CHAR(tty) ((tty)->termios.c_cc[VWERASE]) 88#define LNEXT_CHAR(tty) ((tty)->termios.c_cc[VLNEXT]) 89#define EOL2_CHAR(tty) ((tty)->termios.c_cc[VEOL2]) 90 91#define _I_FLAG(tty, f) ((tty)->termios.c_iflag & (f)) 92#define _O_FLAG(tty, f) ((tty)->termios.c_oflag & (f)) 93#define _C_FLAG(tty, f) ((tty)->termios.c_cflag & (f)) 94#define _L_FLAG(tty, f) ((tty)->termios.c_lflag & (f)) 95 96#define I_IGNBRK(tty) _I_FLAG((tty), IGNBRK) 97#define I_BRKINT(tty) _I_FLAG((tty), BRKINT) 98#define I_IGNPAR(tty) _I_FLAG((tty), IGNPAR) 99#define I_PARMRK(tty) _I_FLAG((tty), PARMRK) 100#define I_INPCK(tty) _I_FLAG((tty), INPCK) 101#define I_ISTRIP(tty) _I_FLAG((tty), ISTRIP) 102#define I_INLCR(tty) _I_FLAG((tty), INLCR) 103#define I_IGNCR(tty) _I_FLAG((tty), IGNCR) 104#define I_ICRNL(tty) _I_FLAG((tty), ICRNL) 105#define I_IUCLC(tty) _I_FLAG((tty), IUCLC) 106#define I_IXON(tty) _I_FLAG((tty), IXON) 107#define I_IXANY(tty) _I_FLAG((tty), IXANY) 108#define I_IXOFF(tty) _I_FLAG((tty), IXOFF) 109#define I_IMAXBEL(tty) _I_FLAG((tty), IMAXBEL) 110#define I_IUTF8(tty) _I_FLAG((tty), IUTF8) 111 112#define O_OPOST(tty) _O_FLAG((tty), OPOST) 113#define O_OLCUC(tty) _O_FLAG((tty), OLCUC) 114#define O_ONLCR(tty) _O_FLAG((tty), ONLCR) 115#define O_OCRNL(tty) _O_FLAG((tty), OCRNL) 116#define O_ONOCR(tty) _O_FLAG((tty), ONOCR) 117#define O_ONLRET(tty) _O_FLAG((tty), ONLRET) 118#define O_OFILL(tty) _O_FLAG((tty), OFILL) 119#define O_OFDEL(tty) _O_FLAG((tty), OFDEL) 120#define O_NLDLY(tty) _O_FLAG((tty), NLDLY) 121#define O_CRDLY(tty) _O_FLAG((tty), CRDLY) 122#define O_TABDLY(tty) _O_FLAG((tty), TABDLY) 123#define O_BSDLY(tty) _O_FLAG((tty), BSDLY) 124#define O_VTDLY(tty) _O_FLAG((tty), VTDLY) 125#define O_FFDLY(tty) _O_FLAG((tty), FFDLY) 126 127#define C_BAUD(tty) _C_FLAG((tty), CBAUD) 128#define C_CSIZE(tty) _C_FLAG((tty), CSIZE) 129#define C_CSTOPB(tty) _C_FLAG((tty), CSTOPB) 130#define C_CREAD(tty) _C_FLAG((tty), CREAD) 131#define C_PARENB(tty) _C_FLAG((tty), PARENB) 132#define C_PARODD(tty) _C_FLAG((tty), PARODD) 133#define C_HUPCL(tty) _C_FLAG((tty), HUPCL) 134#define C_CLOCAL(tty) _C_FLAG((tty), CLOCAL) 135#define C_CIBAUD(tty) _C_FLAG((tty), CIBAUD) 136#define C_CRTSCTS(tty) _C_FLAG((tty), CRTSCTS) 137 138#define L_ISIG(tty) _L_FLAG((tty), ISIG) 139#define L_ICANON(tty) _L_FLAG((tty), ICANON) 140#define L_XCASE(tty) _L_FLAG((tty), XCASE) 141#define L_ECHO(tty) _L_FLAG((tty), ECHO) 142#define L_ECHOE(tty) _L_FLAG((tty), ECHOE) 143#define L_ECHOK(tty) _L_FLAG((tty), ECHOK) 144#define L_ECHONL(tty) _L_FLAG((tty), ECHONL) 145#define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH) 146#define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP) 147#define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL) 148#define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT) 149#define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE) 150#define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO) 151#define L_PENDIN(tty) _L_FLAG((tty), PENDIN) 152#define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN) 153#define L_EXTPROC(tty) _L_FLAG((tty), EXTPROC) 154 155struct device; 156struct signal_struct; 157 158/* 159 * Port level information. Each device keeps its own port level information 160 * so provide a common structure for those ports wanting to use common support 161 * routines. 162 * 163 * The tty port has a different lifetime to the tty so must be kept apart. 164 * In addition be careful as tty -> port mappings are valid for the life 165 * of the tty object but in many cases port -> tty mappings are valid only 166 * until a hangup so don't use the wrong path. 167 */ 168 169struct tty_port; 170 171struct tty_port_operations { 172 /* Return 1 if the carrier is raised */ 173 int (*carrier_raised)(struct tty_port *port); 174 /* Control the DTR line */ 175 void (*dtr_rts)(struct tty_port *port, int raise); 176 /* Called when the last close completes or a hangup finishes 177 IFF the port was initialized. Do not use to free resources. Called 178 under the port mutex to serialize against activate/shutdowns */ 179 void (*shutdown)(struct tty_port *port); 180 void (*drop)(struct tty_port *port); 181 /* Called under the port mutex from tty_port_open, serialized using 182 the port mutex */ 183 /* FIXME: long term getting the tty argument *out* of this would be 184 good for consoles */ 185 int (*activate)(struct tty_port *port, struct tty_struct *tty); 186 /* Called on the final put of a port */ 187 void (*destruct)(struct tty_port *port); 188}; 189 190struct tty_port { 191 struct tty_struct *tty; /* Back pointer */ 192 const struct tty_port_operations *ops; /* Port operations */ 193 spinlock_t lock; /* Lock protecting tty field */ 194 int blocked_open; /* Waiting to open */ 195 int count; /* Usage count */ 196 wait_queue_head_t open_wait; /* Open waiters */ 197 wait_queue_head_t close_wait; /* Close waiters */ 198 wait_queue_head_t delta_msr_wait; /* Modem status change */ 199 unsigned long flags; /* TTY flags ASY_*/ 200 unsigned char console:1; /* port is a console */ 201 struct mutex mutex; /* Locking */ 202 struct mutex buf_mutex; /* Buffer alloc lock */ 203 unsigned char *xmit_buf; /* Optional buffer */ 204 unsigned int close_delay; /* Close port delay */ 205 unsigned int closing_wait; /* Delay for output */ 206 int drain_delay; /* Set to zero if no pure time 207 based drain is needed else 208 set to size of fifo */ 209 struct kref kref; /* Ref counter */ 210}; 211 212/* 213 * Where all of the state associated with a tty is kept while the tty 214 * is open. Since the termios state should be kept even if the tty 215 * has been closed --- for things like the baud rate, etc --- it is 216 * not stored here, but rather a pointer to the real state is stored 217 * here. Possible the winsize structure should have the same 218 * treatment, but (1) the default 80x24 is usually right and (2) it's 219 * most often used by a windowing system, which will set the correct 220 * size each time the window is created or resized anyway. 221 * - TYT, 9/14/92 222 */ 223 224struct tty_operations; 225 226struct tty_struct { 227 int magic; 228 struct kref kref; 229 struct device *dev; 230 struct tty_driver *driver; 231 const struct tty_operations *ops; 232 int index; 233 234 /* Protects ldisc changes: Lock tty not pty */ 235 struct mutex ldisc_mutex; 236 struct tty_ldisc *ldisc; 237 238 struct mutex atomic_write_lock; 239 struct mutex legacy_mutex; 240 struct mutex termios_mutex; 241 spinlock_t ctrl_lock; 242 /* Termios values are protected by the termios mutex */ 243 struct ktermios termios, termios_locked; 244 struct termiox *termiox; /* May be NULL for unsupported */ 245 char name[64]; 246 struct pid *pgrp; /* Protected by ctrl lock */ 247 struct pid *session; 248 unsigned long flags; 249 int count; 250 struct winsize winsize; /* termios mutex */ 251 unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1; 252 unsigned char low_latency:1, warned:1; 253 unsigned char ctrl_status; /* ctrl_lock */ 254 unsigned int receive_room; /* Bytes free for queue */ 255 256 struct tty_struct *link; 257 struct fasync_struct *fasync; 258 struct tty_bufhead buf; /* Locked internally */ 259 int alt_speed; /* For magic substitution of 38400 bps */ 260 wait_queue_head_t write_wait; 261 wait_queue_head_t read_wait; 262 struct work_struct hangup_work; 263 void *disc_data; 264 void *driver_data; 265 struct list_head tty_files; 266 267#define N_TTY_BUF_SIZE 4096 268 269 unsigned char closing:1; 270 unsigned short minimum_to_wake; 271 unsigned char *write_buf; 272 int write_cnt; 273 /* If the tty has a pending do_SAK, queue it here - akpm */ 274 struct work_struct SAK_work; 275 struct tty_port *port; 276}; 277 278/* Each of a tty's open files has private_data pointing to tty_file_private */ 279struct tty_file_private { 280 struct tty_struct *tty; 281 struct file *file; 282 struct list_head list; 283}; 284 285/* tty magic number */ 286#define TTY_MAGIC 0x5401 287 288/* 289 * These bits are used in the flags field of the tty structure. 290 * 291 * So that interrupts won't be able to mess up the queues, 292 * copy_to_cooked must be atomic with respect to itself, as must 293 * tty->write. Thus, you must use the inline functions set_bit() and 294 * clear_bit() to make things atomic. 295 */ 296#define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */ 297#define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */ 298#define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */ 299#define TTY_EXCLUSIVE 3 /* Exclusive open mode */ 300#define TTY_DEBUG 4 /* Debugging */ 301#define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */ 302#define TTY_PUSH 6 /* n_tty private */ 303#define TTY_CLOSING 7 /* ->close() in progress */ 304#define TTY_LDISC 9 /* Line discipline attached */ 305#define TTY_LDISC_CHANGING 10 /* Line discipline changing */ 306#define TTY_LDISC_OPEN 11 /* Line discipline is open */ 307#define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */ 308#define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */ 309#define TTY_PTY_LOCK 16 /* pty private */ 310#define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */ 311#define TTY_HUPPED 18 /* Post driver->hangup() */ 312#define TTY_FLUSHING 19 /* Flushing to ldisc in progress */ 313#define TTY_FLUSHPENDING 20 /* Queued buffer flush pending */ 314#define TTY_HUPPING 21 /* ->hangup() in progress */ 315 316#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty)) 317 318extern void tty_write_flush(struct tty_struct *); 319 320extern struct ktermios tty_std_termios; 321 322extern void console_init(void); 323extern int vcs_init(void); 324 325extern struct class *tty_class; 326 327/** 328 * tty_kref_get - get a tty reference 329 * @tty: tty device 330 * 331 * Return a new reference to a tty object. The caller must hold 332 * sufficient locks/counts to ensure that their existing reference cannot 333 * go away 334 */ 335 336static inline struct tty_struct *tty_kref_get(struct tty_struct *tty) 337{ 338 if (tty) 339 kref_get(&tty->kref); 340 return tty; 341} 342extern void tty_kref_put(struct tty_struct *tty); 343 344extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode, 345 const char *routine); 346extern char *tty_name(struct tty_struct *tty, char *buf); 347extern void tty_wait_until_sent(struct tty_struct *tty, long timeout); 348extern int tty_check_change(struct tty_struct *tty); 349extern void stop_tty(struct tty_struct *tty); 350extern void start_tty(struct tty_struct *tty); 351extern int tty_register_driver(struct tty_driver *driver); 352extern int tty_unregister_driver(struct tty_driver *driver); 353extern struct device *tty_register_device(struct tty_driver *driver, 354 unsigned index, struct device *dev); 355extern struct device *tty_register_device_attr(struct tty_driver *driver, 356 unsigned index, struct device *device, 357 void *drvdata, 358 const struct attribute_group **attr_grp); 359extern void tty_unregister_device(struct tty_driver *driver, unsigned index); 360extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp, 361 int buflen); 362extern void tty_write_message(struct tty_struct *tty, char *msg); 363extern int tty_put_char(struct tty_struct *tty, unsigned char c); 364extern int tty_chars_in_buffer(struct tty_struct *tty); 365extern int tty_write_room(struct tty_struct *tty); 366extern void tty_driver_flush_buffer(struct tty_struct *tty); 367extern void tty_throttle(struct tty_struct *tty); 368extern void tty_unthrottle(struct tty_struct *tty); 369extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws); 370extern void tty_driver_remove_tty(struct tty_driver *driver, 371 struct tty_struct *tty); 372extern void tty_free_termios(struct tty_struct *tty); 373extern int is_current_pgrp_orphaned(void); 374extern struct pid *tty_get_pgrp(struct tty_struct *tty); 375extern int is_ignored(int sig); 376extern int tty_signal(int sig, struct tty_struct *tty); 377extern void tty_hangup(struct tty_struct *tty); 378extern void tty_vhangup(struct tty_struct *tty); 379extern void tty_vhangup_locked(struct tty_struct *tty); 380extern void tty_vhangup_self(void); 381extern void tty_unhangup(struct file *filp); 382extern int tty_hung_up_p(struct file *filp); 383extern void do_SAK(struct tty_struct *tty); 384extern void __do_SAK(struct tty_struct *tty); 385extern void disassociate_ctty(int priv); 386extern void no_tty(void); 387extern void tty_flip_buffer_push(struct tty_struct *tty); 388extern void tty_flush_to_ldisc(struct tty_struct *tty); 389extern void tty_buffer_free_all(struct tty_struct *tty); 390extern void tty_buffer_flush(struct tty_struct *tty); 391extern void tty_buffer_init(struct tty_struct *tty); 392extern speed_t tty_get_baud_rate(struct tty_struct *tty); 393extern speed_t tty_termios_baud_rate(struct ktermios *termios); 394extern speed_t tty_termios_input_baud_rate(struct ktermios *termios); 395extern void tty_termios_encode_baud_rate(struct ktermios *termios, 396 speed_t ibaud, speed_t obaud); 397extern void tty_encode_baud_rate(struct tty_struct *tty, 398 speed_t ibaud, speed_t obaud); 399extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old); 400extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b); 401extern int tty_set_termios(struct tty_struct *tty, struct ktermios *kt); 402 403extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *); 404extern void tty_ldisc_deref(struct tty_ldisc *); 405extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *); 406extern void tty_ldisc_hangup(struct tty_struct *tty); 407extern const struct file_operations tty_ldiscs_proc_fops; 408 409extern void tty_wakeup(struct tty_struct *tty); 410extern void tty_ldisc_flush(struct tty_struct *tty); 411 412extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg); 413extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file, 414 unsigned int cmd, unsigned long arg); 415extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg); 416extern dev_t tty_devnum(struct tty_struct *tty); 417extern void proc_clear_tty(struct task_struct *p); 418extern struct tty_struct *get_current_tty(void); 419extern void tty_default_fops(struct file_operations *fops); 420extern struct tty_struct *alloc_tty_struct(void); 421extern int tty_alloc_file(struct file *file); 422extern void tty_add_file(struct tty_struct *tty, struct file *file); 423extern void tty_free_file(struct file *file); 424extern void free_tty_struct(struct tty_struct *tty); 425extern void initialize_tty_struct(struct tty_struct *tty, 426 struct tty_driver *driver, int idx); 427extern void deinitialize_tty_struct(struct tty_struct *tty); 428extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx); 429extern int tty_release(struct inode *inode, struct file *filp); 430extern int tty_init_termios(struct tty_struct *tty); 431extern int tty_standard_install(struct tty_driver *driver, 432 struct tty_struct *tty); 433 434extern struct tty_struct *tty_pair_get_tty(struct tty_struct *tty); 435extern struct tty_struct *tty_pair_get_pty(struct tty_struct *tty); 436 437extern struct mutex tty_mutex; 438extern spinlock_t tty_files_lock; 439 440extern void tty_write_unlock(struct tty_struct *tty); 441extern int tty_write_lock(struct tty_struct *tty, int ndelay); 442#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock)) 443 444extern void tty_port_init(struct tty_port *port); 445extern void tty_port_link_device(struct tty_port *port, 446 struct tty_driver *driver, unsigned index); 447extern struct device *tty_port_register_device(struct tty_port *port, 448 struct tty_driver *driver, unsigned index, 449 struct device *device); 450extern struct device *tty_port_register_device_attr(struct tty_port *port, 451 struct tty_driver *driver, unsigned index, 452 struct device *device, void *drvdata, 453 const struct attribute_group **attr_grp); 454extern int tty_port_alloc_xmit_buf(struct tty_port *port); 455extern void tty_port_free_xmit_buf(struct tty_port *port); 456extern void tty_port_put(struct tty_port *port); 457 458static inline struct tty_port *tty_port_get(struct tty_port *port) 459{ 460 if (port) 461 kref_get(&port->kref); 462 return port; 463} 464 465/* If the cts flow control is enabled, return true. */ 466static inline bool tty_port_cts_enabled(struct tty_port *port) 467{ 468 return port->flags & ASYNC_CTS_FLOW; 469} 470 471extern struct tty_struct *tty_port_tty_get(struct tty_port *port); 472extern void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty); 473extern int tty_port_carrier_raised(struct tty_port *port); 474extern void tty_port_raise_dtr_rts(struct tty_port *port); 475extern void tty_port_lower_dtr_rts(struct tty_port *port); 476extern void tty_port_hangup(struct tty_port *port); 477extern int tty_port_block_til_ready(struct tty_port *port, 478 struct tty_struct *tty, struct file *filp); 479extern int tty_port_close_start(struct tty_port *port, 480 struct tty_struct *tty, struct file *filp); 481extern void tty_port_close_end(struct tty_port *port, struct tty_struct *tty); 482extern void tty_port_close(struct tty_port *port, 483 struct tty_struct *tty, struct file *filp); 484extern int tty_port_install(struct tty_port *port, struct tty_driver *driver, 485 struct tty_struct *tty); 486extern int tty_port_open(struct tty_port *port, 487 struct tty_struct *tty, struct file *filp); 488static inline int tty_port_users(struct tty_port *port) 489{ 490 return port->count + port->blocked_open; 491} 492 493extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc); 494extern int tty_unregister_ldisc(int disc); 495extern int tty_set_ldisc(struct tty_struct *tty, int ldisc); 496extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty); 497extern void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty); 498extern void tty_ldisc_init(struct tty_struct *tty); 499extern void tty_ldisc_deinit(struct tty_struct *tty); 500extern void tty_ldisc_begin(void); 501/* This last one is just for the tty layer internals and shouldn't be used elsewhere */ 502extern void tty_ldisc_enable(struct tty_struct *tty); 503 504 505/* n_tty.c */ 506extern struct tty_ldisc_ops tty_ldisc_N_TTY; 507extern void n_tty_inherit_ops(struct tty_ldisc_ops *ops); 508 509/* tty_audit.c */ 510#ifdef CONFIG_AUDIT 511extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data, 512 size_t size, unsigned icanon); 513extern void tty_audit_exit(void); 514extern void tty_audit_fork(struct signal_struct *sig); 515extern void tty_audit_tiocsti(struct tty_struct *tty, char ch); 516extern void tty_audit_push(struct tty_struct *tty); 517extern int tty_audit_push_task(struct task_struct *tsk, 518 kuid_t loginuid, u32 sessionid); 519#else 520static inline void tty_audit_add_data(struct tty_struct *tty, 521 unsigned char *data, size_t size, unsigned icanon) 522{ 523} 524static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch) 525{ 526} 527static inline void tty_audit_exit(void) 528{ 529} 530static inline void tty_audit_fork(struct signal_struct *sig) 531{ 532} 533static inline void tty_audit_push(struct tty_struct *tty) 534{ 535} 536static inline int tty_audit_push_task(struct task_struct *tsk, 537 kuid_t loginuid, u32 sessionid) 538{ 539 return 0; 540} 541#endif 542 543/* tty_io.c */ 544extern int __init tty_init(void); 545 546/* tty_ioctl.c */ 547extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file, 548 unsigned int cmd, unsigned long arg); 549extern long n_tty_compat_ioctl_helper(struct tty_struct *tty, struct file *file, 550 unsigned int cmd, unsigned long arg); 551 552/* serial.c */ 553 554extern void serial_console_init(void); 555 556/* pcxx.c */ 557 558extern int pcxe_open(struct tty_struct *tty, struct file *filp); 559 560/* vt.c */ 561 562extern int vt_ioctl(struct tty_struct *tty, 563 unsigned int cmd, unsigned long arg); 564 565extern long vt_compat_ioctl(struct tty_struct *tty, 566 unsigned int cmd, unsigned long arg); 567 568/* tty_mutex.c */ 569/* functions for preparation of BKL removal */ 570extern void __lockfunc tty_lock(struct tty_struct *tty); 571extern void __lockfunc tty_unlock(struct tty_struct *tty); 572extern void __lockfunc tty_lock_pair(struct tty_struct *tty, 573 struct tty_struct *tty2); 574extern void __lockfunc tty_unlock_pair(struct tty_struct *tty, 575 struct tty_struct *tty2); 576 577/* 578 * this shall be called only from where BTM is held (like close) 579 * 580 * We need this to ensure nobody waits for us to finish while we are waiting. 581 * Without this we were encountering system stalls. 582 * 583 * This should be indeed removed with BTM removal later. 584 * 585 * Locking: BTM required. Nobody is allowed to hold port->mutex. 586 */ 587static inline void tty_wait_until_sent_from_close(struct tty_struct *tty, 588 long timeout) 589{ 590 tty_unlock(tty); /* tty->ops->close holds the BTM, drop it while waiting */ 591 tty_wait_until_sent(tty, timeout); 592 tty_lock(tty); 593} 594 595/* 596 * wait_event_interruptible_tty -- wait for a condition with the tty lock held 597 * 598 * The condition we are waiting for might take a long time to 599 * become true, or might depend on another thread taking the 600 * BTM. In either case, we need to drop the BTM to guarantee 601 * forward progress. This is a leftover from the conversion 602 * from the BKL and should eventually get removed as the BTM 603 * falls out of use. 604 * 605 * Do not use in new code. 606 */ 607#define wait_event_interruptible_tty(tty, wq, condition) \ 608({ \ 609 int __ret = 0; \ 610 if (!(condition)) { \ 611 __wait_event_interruptible_tty(tty, wq, condition, __ret); \ 612 } \ 613 __ret; \ 614}) 615 616#define __wait_event_interruptible_tty(tty, wq, condition, ret) \ 617do { \ 618 DEFINE_WAIT(__wait); \ 619 \ 620 for (;;) { \ 621 prepare_to_wait(&wq, &__wait, TASK_INTERRUPTIBLE); \ 622 if (condition) \ 623 break; \ 624 if (!signal_pending(current)) { \ 625 tty_unlock(tty); \ 626 schedule(); \ 627 tty_lock(tty); \ 628 continue; \ 629 } \ 630 ret = -ERESTARTSYS; \ 631 break; \ 632 } \ 633 finish_wait(&wq, &__wait); \ 634} while (0) 635 636 637#endif 638