include/linux/tty.h

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