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