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>
18 * Lock subclasses for tty locks
20 * TTY_LOCK_NORMAL is for normal ttys and master ptys.
21 * TTY_LOCK_SLAVE is for slave ptys only.
23 * Lock subclasses are necessary for handling nested locking with pty pairs.
24 * tty locks which use nested locking:
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 * termios_rwsem - The stable lock order is tty_buffer lock->termios_rwsem.
29 * Subclassing this lock enables the slave pty to hold its
30 * termios_rwsem when claiming the master tty_buffer lock.
31 * tty_buffer lock - slave ptys can claim nested buffer lock when handling
32 * signal chars. The stable lock order is slave pty, then
42 * (Note: the *_driver.minor_start values 1, 64, 128, 192 are
43 * hardcoded at present.)
45 #define NR_UNIX98_PTY_DEFAULT 4096 /* Default maximum for Unix98 ptys */
46 #define NR_UNIX98_PTY_RESERVE 1024 /* Default reserve for main devpts */
47 #define NR_UNIX98_PTY_MAX (1 << MINORBITS) /* Absolute limit */
50 * This character is the same as _POSIX_VDISABLE: it cannot be used as
51 * a c_cc[] character, but indicates that a particular special character
52 * isn't in use (eg VINTR has no character etc)
54 #define __DISABLED_CHAR '\0'
58 struct tty_buffer *next;
59 struct llist_node free;
66 /* Data points here */
67 unsigned long data[0];
70 /* Values for .flags field of tty_buffer */
71 #define TTYB_NORMAL 1 /* buffer has no flags buffer */
73 static inline unsigned char *char_buf_ptr(struct tty_buffer *b, int ofs)
75 return ((unsigned char *)b->data) + ofs;
78 static inline char *flag_buf_ptr(struct tty_buffer *b, int ofs)
80 return (char *)char_buf_ptr(b, ofs) + b->size;
84 struct tty_buffer *head; /* Queue head */
85 struct work_struct work;
88 struct tty_buffer sentinel;
89 struct llist_head free; /* Free queue head */
90 atomic_t mem_used; /* In-use buffers excluding free list */
92 struct tty_buffer *tail; /* Active buffer */
95 * When a break, frame error, or parity error happens, these codes are
96 * stuffed into the flags buffer.
102 #define TTY_OVERRUN 4
104 #define INTR_CHAR(tty) ((tty)->termios.c_cc[VINTR])
105 #define QUIT_CHAR(tty) ((tty)->termios.c_cc[VQUIT])
106 #define ERASE_CHAR(tty) ((tty)->termios.c_cc[VERASE])
107 #define KILL_CHAR(tty) ((tty)->termios.c_cc[VKILL])
108 #define EOF_CHAR(tty) ((tty)->termios.c_cc[VEOF])
109 #define TIME_CHAR(tty) ((tty)->termios.c_cc[VTIME])
110 #define MIN_CHAR(tty) ((tty)->termios.c_cc[VMIN])
111 #define SWTC_CHAR(tty) ((tty)->termios.c_cc[VSWTC])
112 #define START_CHAR(tty) ((tty)->termios.c_cc[VSTART])
113 #define STOP_CHAR(tty) ((tty)->termios.c_cc[VSTOP])
114 #define SUSP_CHAR(tty) ((tty)->termios.c_cc[VSUSP])
115 #define EOL_CHAR(tty) ((tty)->termios.c_cc[VEOL])
116 #define REPRINT_CHAR(tty) ((tty)->termios.c_cc[VREPRINT])
117 #define DISCARD_CHAR(tty) ((tty)->termios.c_cc[VDISCARD])
118 #define WERASE_CHAR(tty) ((tty)->termios.c_cc[VWERASE])
119 #define LNEXT_CHAR(tty) ((tty)->termios.c_cc[VLNEXT])
120 #define EOL2_CHAR(tty) ((tty)->termios.c_cc[VEOL2])
122 #define _I_FLAG(tty, f) ((tty)->termios.c_iflag & (f))
123 #define _O_FLAG(tty, f) ((tty)->termios.c_oflag & (f))
124 #define _C_FLAG(tty, f) ((tty)->termios.c_cflag & (f))
125 #define _L_FLAG(tty, f) ((tty)->termios.c_lflag & (f))
127 #define I_IGNBRK(tty) _I_FLAG((tty), IGNBRK)
128 #define I_BRKINT(tty) _I_FLAG((tty), BRKINT)
129 #define I_IGNPAR(tty) _I_FLAG((tty), IGNPAR)
130 #define I_PARMRK(tty) _I_FLAG((tty), PARMRK)
131 #define I_INPCK(tty) _I_FLAG((tty), INPCK)
132 #define I_ISTRIP(tty) _I_FLAG((tty), ISTRIP)
133 #define I_INLCR(tty) _I_FLAG((tty), INLCR)
134 #define I_IGNCR(tty) _I_FLAG((tty), IGNCR)
135 #define I_ICRNL(tty) _I_FLAG((tty), ICRNL)
136 #define I_IUCLC(tty) _I_FLAG((tty), IUCLC)
137 #define I_IXON(tty) _I_FLAG((tty), IXON)
138 #define I_IXANY(tty) _I_FLAG((tty), IXANY)
139 #define I_IXOFF(tty) _I_FLAG((tty), IXOFF)
140 #define I_IMAXBEL(tty) _I_FLAG((tty), IMAXBEL)
141 #define I_IUTF8(tty) _I_FLAG((tty), IUTF8)
143 #define O_OPOST(tty) _O_FLAG((tty), OPOST)
144 #define O_OLCUC(tty) _O_FLAG((tty), OLCUC)
145 #define O_ONLCR(tty) _O_FLAG((tty), ONLCR)
146 #define O_OCRNL(tty) _O_FLAG((tty), OCRNL)
147 #define O_ONOCR(tty) _O_FLAG((tty), ONOCR)
148 #define O_ONLRET(tty) _O_FLAG((tty), ONLRET)
149 #define O_OFILL(tty) _O_FLAG((tty), OFILL)
150 #define O_OFDEL(tty) _O_FLAG((tty), OFDEL)
151 #define O_NLDLY(tty) _O_FLAG((tty), NLDLY)
152 #define O_CRDLY(tty) _O_FLAG((tty), CRDLY)
153 #define O_TABDLY(tty) _O_FLAG((tty), TABDLY)
154 #define O_BSDLY(tty) _O_FLAG((tty), BSDLY)
155 #define O_VTDLY(tty) _O_FLAG((tty), VTDLY)
156 #define O_FFDLY(tty) _O_FLAG((tty), FFDLY)
158 #define C_BAUD(tty) _C_FLAG((tty), CBAUD)
159 #define C_CSIZE(tty) _C_FLAG((tty), CSIZE)
160 #define C_CSTOPB(tty) _C_FLAG((tty), CSTOPB)
161 #define C_CREAD(tty) _C_FLAG((tty), CREAD)
162 #define C_PARENB(tty) _C_FLAG((tty), PARENB)
163 #define C_PARODD(tty) _C_FLAG((tty), PARODD)
164 #define C_HUPCL(tty) _C_FLAG((tty), HUPCL)
165 #define C_CLOCAL(tty) _C_FLAG((tty), CLOCAL)
166 #define C_CIBAUD(tty) _C_FLAG((tty), CIBAUD)
167 #define C_CRTSCTS(tty) _C_FLAG((tty), CRTSCTS)
168 #define C_CMSPAR(tty) _C_FLAG((tty), CMSPAR)
170 #define L_ISIG(tty) _L_FLAG((tty), ISIG)
171 #define L_ICANON(tty) _L_FLAG((tty), ICANON)
172 #define L_XCASE(tty) _L_FLAG((tty), XCASE)
173 #define L_ECHO(tty) _L_FLAG((tty), ECHO)
174 #define L_ECHOE(tty) _L_FLAG((tty), ECHOE)
175 #define L_ECHOK(tty) _L_FLAG((tty), ECHOK)
176 #define L_ECHONL(tty) _L_FLAG((tty), ECHONL)
177 #define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH)
178 #define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP)
179 #define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL)
180 #define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT)
181 #define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE)
182 #define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO)
183 #define L_PENDIN(tty) _L_FLAG((tty), PENDIN)
184 #define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN)
185 #define L_EXTPROC(tty) _L_FLAG((tty), EXTPROC)
188 struct signal_struct;
191 * Port level information. Each device keeps its own port level information
192 * so provide a common structure for those ports wanting to use common support
195 * The tty port has a different lifetime to the tty so must be kept apart.
196 * In addition be careful as tty -> port mappings are valid for the life
197 * of the tty object but in many cases port -> tty mappings are valid only
198 * until a hangup so don't use the wrong path.
203 struct tty_port_operations {
204 /* Return 1 if the carrier is raised */
205 int (*carrier_raised)(struct tty_port *port);
206 /* Control the DTR line */
207 void (*dtr_rts)(struct tty_port *port, int raise);
208 /* Called when the last close completes or a hangup finishes
209 IFF the port was initialized. Do not use to free resources. Called
210 under the port mutex to serialize against activate/shutdowns */
211 void (*shutdown)(struct tty_port *port);
212 /* Called under the port mutex from tty_port_open, serialized using
214 /* FIXME: long term getting the tty argument *out* of this would be
216 int (*activate)(struct tty_port *port, struct tty_struct *tty);
217 /* Called on the final put of a port */
218 void (*destruct)(struct tty_port *port);
221 struct tty_port_client_operations {
222 int (*receive_buf)(struct tty_port *port, const unsigned char *, const unsigned char *, size_t);
223 void (*write_wakeup)(struct tty_port *port);
227 struct tty_bufhead buf; /* Locked internally */
228 struct tty_struct *tty; /* Back pointer */
229 struct tty_struct *itty; /* internal back ptr */
230 const struct tty_port_operations *ops; /* Port operations */
231 const struct tty_port_client_operations *client_ops; /* Port client operations */
232 spinlock_t lock; /* Lock protecting tty field */
233 int blocked_open; /* Waiting to open */
234 int count; /* Usage count */
235 wait_queue_head_t open_wait; /* Open waiters */
236 wait_queue_head_t delta_msr_wait; /* Modem status change */
237 unsigned long flags; /* User TTY flags ASYNC_ */
238 unsigned long iflags; /* Internal flags TTY_PORT_ */
239 unsigned char console:1, /* port is a console */
240 low_latency:1; /* optional: tune for latency */
241 struct mutex mutex; /* Locking */
242 struct mutex buf_mutex; /* Buffer alloc lock */
243 unsigned char *xmit_buf; /* Optional buffer */
244 unsigned int close_delay; /* Close port delay */
245 unsigned int closing_wait; /* Delay for output */
246 int drain_delay; /* Set to zero if no pure time
247 based drain is needed else
248 set to size of fifo */
249 struct kref kref; /* Ref counter */
253 /* tty_port::iflags bits -- use atomic bit ops */
254 #define TTY_PORT_INITIALIZED 0 /* device is initialized */
255 #define TTY_PORT_SUSPENDED 1 /* device is suspended */
256 #define TTY_PORT_ACTIVE 2 /* device is open */
259 * uart drivers: use the uart_port::status field and the UPSTAT_* defines
260 * for s/w-based flow control steering and carrier detection status
262 #define TTY_PORT_CTS_FLOW 3 /* h/w flow control enabled */
263 #define TTY_PORT_CHECK_CD 4 /* carrier detect enabled */
264 #define TTY_PORT_KOPENED 5 /* device exclusively opened by
268 * Where all of the state associated with a tty is kept while the tty
269 * is open. Since the termios state should be kept even if the tty
270 * has been closed --- for things like the baud rate, etc --- it is
271 * not stored here, but rather a pointer to the real state is stored
272 * here. Possible the winsize structure should have the same
273 * treatment, but (1) the default 80x24 is usually right and (2) it's
274 * most often used by a windowing system, which will set the correct
275 * size each time the window is created or resized anyway.
279 struct tty_operations;
285 struct tty_driver *driver;
286 const struct tty_operations *ops;
289 /* Protects ldisc changes: Lock tty not pty */
290 struct ld_semaphore ldisc_sem;
291 struct tty_ldisc *ldisc;
293 struct mutex atomic_write_lock;
294 struct mutex legacy_mutex;
295 struct mutex throttle_mutex;
296 struct rw_semaphore termios_rwsem;
297 struct mutex winsize_mutex;
298 spinlock_t ctrl_lock;
299 spinlock_t flow_lock;
300 /* Termios values are protected by the termios rwsem */
301 struct ktermios termios, termios_locked;
302 struct termiox *termiox; /* May be NULL for unsupported */
304 struct pid *pgrp; /* Protected by ctrl lock */
308 struct winsize winsize; /* winsize_mutex */
309 unsigned long stopped:1, /* flow_lock */
311 unused:BITS_PER_LONG - 2;
313 unsigned long ctrl_status:8, /* ctrl_lock */
315 unused_ctrl:BITS_PER_LONG - 9;
316 unsigned int receive_room; /* Bytes free for queue */
319 struct tty_struct *link;
320 struct fasync_struct *fasync;
321 wait_queue_head_t write_wait;
322 wait_queue_head_t read_wait;
323 struct work_struct hangup_work;
326 spinlock_t files_lock; /* protects tty_files list */
327 struct list_head tty_files;
329 #define N_TTY_BUF_SIZE 4096
332 unsigned char *write_buf;
334 /* If the tty has a pending do_SAK, queue it here - akpm */
335 struct work_struct SAK_work;
336 struct tty_port *port;
337 } __randomize_layout;
339 /* Each of a tty's open files has private_data pointing to tty_file_private */
340 struct tty_file_private {
341 struct tty_struct *tty;
343 struct list_head list;
346 /* tty magic number */
347 #define TTY_MAGIC 0x5401
350 * These bits are used in the flags field of the tty structure.
352 * So that interrupts won't be able to mess up the queues,
353 * copy_to_cooked must be atomic with respect to itself, as must
354 * tty->write. Thus, you must use the inline functions set_bit() and
355 * clear_bit() to make things atomic.
357 #define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
358 #define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */
359 #define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
360 #define TTY_EXCLUSIVE 3 /* Exclusive open mode */
361 #define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
362 #define TTY_LDISC_OPEN 11 /* Line discipline is open */
363 #define TTY_PTY_LOCK 16 /* pty private */
364 #define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
365 #define TTY_HUPPED 18 /* Post driver->hangup() */
366 #define TTY_LDISC_HALTED 22 /* Line discipline is halted */
368 /* Values for tty->flow_change */
369 #define TTY_THROTTLE_SAFE 1
370 #define TTY_UNTHROTTLE_SAFE 2
372 static inline void __tty_set_flow_change(struct tty_struct *tty, int val)
374 tty->flow_change = val;
377 static inline void tty_set_flow_change(struct tty_struct *tty, int val)
379 tty->flow_change = val;
383 static inline bool tty_io_error(struct tty_struct *tty)
385 return test_bit(TTY_IO_ERROR, &tty->flags);
388 static inline bool tty_throttled(struct tty_struct *tty)
390 return test_bit(TTY_THROTTLED, &tty->flags);
394 extern void tty_kref_put(struct tty_struct *tty);
395 extern struct pid *tty_get_pgrp(struct tty_struct *tty);
396 extern void tty_vhangup_self(void);
397 extern void disassociate_ctty(int priv);
398 extern dev_t tty_devnum(struct tty_struct *tty);
399 extern void proc_clear_tty(struct task_struct *p);
400 extern struct tty_struct *get_current_tty(void);
402 extern int __init tty_init(void);
403 extern const char *tty_name(const struct tty_struct *tty);
404 extern struct tty_struct *tty_kopen(dev_t device);
405 extern void tty_kclose(struct tty_struct *tty);
406 extern int tty_dev_name_to_number(const char *name, dev_t *number);
408 static inline void tty_kref_put(struct tty_struct *tty)
410 static inline struct pid *tty_get_pgrp(struct tty_struct *tty)
412 static inline void tty_vhangup_self(void)
414 static inline void disassociate_ctty(int priv)
416 static inline dev_t tty_devnum(struct tty_struct *tty)
418 static inline void proc_clear_tty(struct task_struct *p)
420 static inline struct tty_struct *get_current_tty(void)
423 static inline int __init tty_init(void)
425 static inline const char *tty_name(const struct tty_struct *tty)
427 static inline struct tty_struct *tty_kopen(dev_t device)
428 { return ERR_PTR(-ENODEV); }
429 static inline void tty_kclose(struct tty_struct *tty)
431 static inline int tty_dev_name_to_number(const char *name, dev_t *number)
432 { return -ENOTSUPP; }
435 extern struct ktermios tty_std_termios;
437 extern int vcs_init(void);
439 extern struct class *tty_class;
442 * tty_kref_get - get a tty reference
445 * Return a new reference to a tty object. The caller must hold
446 * sufficient locks/counts to ensure that their existing reference cannot
450 static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
453 kref_get(&tty->kref);
457 extern const char *tty_driver_name(const struct tty_struct *tty);
458 extern void tty_wait_until_sent(struct tty_struct *tty, long timeout);
459 extern int __tty_check_change(struct tty_struct *tty, int sig);
460 extern int tty_check_change(struct tty_struct *tty);
461 extern void __stop_tty(struct tty_struct *tty);
462 extern void stop_tty(struct tty_struct *tty);
463 extern void __start_tty(struct tty_struct *tty);
464 extern void start_tty(struct tty_struct *tty);
465 extern int tty_register_driver(struct tty_driver *driver);
466 extern int tty_unregister_driver(struct tty_driver *driver);
467 extern struct device *tty_register_device(struct tty_driver *driver,
468 unsigned index, struct device *dev);
469 extern struct device *tty_register_device_attr(struct tty_driver *driver,
470 unsigned index, struct device *device,
472 const struct attribute_group **attr_grp);
473 extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
474 extern void tty_write_message(struct tty_struct *tty, char *msg);
475 extern int tty_send_xchar(struct tty_struct *tty, char ch);
476 extern int tty_put_char(struct tty_struct *tty, unsigned char c);
477 extern int tty_chars_in_buffer(struct tty_struct *tty);
478 extern int tty_write_room(struct tty_struct *tty);
479 extern void tty_driver_flush_buffer(struct tty_struct *tty);
480 extern void tty_throttle(struct tty_struct *tty);
481 extern void tty_unthrottle(struct tty_struct *tty);
482 extern int tty_throttle_safe(struct tty_struct *tty);
483 extern int tty_unthrottle_safe(struct tty_struct *tty);
484 extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
485 extern int is_current_pgrp_orphaned(void);
486 extern void tty_hangup(struct tty_struct *tty);
487 extern void tty_vhangup(struct tty_struct *tty);
488 extern void tty_vhangup_session(struct tty_struct *tty);
489 extern int tty_hung_up_p(struct file *filp);
490 extern void do_SAK(struct tty_struct *tty);
491 extern void __do_SAK(struct tty_struct *tty);
492 extern void tty_open_proc_set_tty(struct file *filp, struct tty_struct *tty);
493 extern int tty_signal_session_leader(struct tty_struct *tty, int exit_session);
494 extern void session_clear_tty(struct pid *session);
495 extern void no_tty(void);
496 extern void tty_buffer_free_all(struct tty_port *port);
497 extern void tty_buffer_flush(struct tty_struct *tty, struct tty_ldisc *ld);
498 extern void tty_buffer_init(struct tty_port *port);
499 extern void tty_buffer_set_lock_subclass(struct tty_port *port);
500 extern bool tty_buffer_restart_work(struct tty_port *port);
501 extern bool tty_buffer_cancel_work(struct tty_port *port);
502 extern void tty_buffer_flush_work(struct tty_port *port);
503 extern speed_t tty_termios_baud_rate(struct ktermios *termios);
504 extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
505 extern void tty_termios_encode_baud_rate(struct ktermios *termios,
506 speed_t ibaud, speed_t obaud);
507 extern void tty_encode_baud_rate(struct tty_struct *tty,
508 speed_t ibaud, speed_t obaud);
511 * tty_get_baud_rate - get tty bit rates
514 * Returns the baud rate as an integer for this terminal. The
515 * termios lock must be held by the caller and the terminal bit
516 * flags may be updated.
520 static inline speed_t tty_get_baud_rate(struct tty_struct *tty)
522 return tty_termios_baud_rate(&tty->termios);
525 extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
526 extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
527 extern int tty_set_termios(struct tty_struct *tty, struct ktermios *kt);
529 extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
530 extern void tty_ldisc_deref(struct tty_ldisc *);
531 extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
532 extern void tty_ldisc_hangup(struct tty_struct *tty, bool reset);
533 extern int tty_ldisc_reinit(struct tty_struct *tty, int disc);
534 extern const struct file_operations tty_ldiscs_proc_fops;
536 extern void tty_wakeup(struct tty_struct *tty);
537 extern void tty_ldisc_flush(struct tty_struct *tty);
539 extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
540 extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
541 unsigned int cmd, unsigned long arg);
542 extern long tty_jobctrl_ioctl(struct tty_struct *tty, struct tty_struct *real_tty,
543 struct file *file, unsigned int cmd, unsigned long arg);
544 extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
545 extern void tty_default_fops(struct file_operations *fops);
546 extern struct tty_struct *alloc_tty_struct(struct tty_driver *driver, int idx);
547 extern int tty_alloc_file(struct file *file);
548 extern void tty_add_file(struct tty_struct *tty, struct file *file);
549 extern void tty_free_file(struct file *file);
550 extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx);
551 extern void tty_release_struct(struct tty_struct *tty, int idx);
552 extern int tty_release(struct inode *inode, struct file *filp);
553 extern void tty_init_termios(struct tty_struct *tty);
554 extern int tty_standard_install(struct tty_driver *driver,
555 struct tty_struct *tty);
557 extern struct mutex tty_mutex;
559 #define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
561 extern void tty_port_init(struct tty_port *port);
562 extern void tty_port_link_device(struct tty_port *port,
563 struct tty_driver *driver, unsigned index);
564 extern struct device *tty_port_register_device(struct tty_port *port,
565 struct tty_driver *driver, unsigned index,
566 struct device *device);
567 extern struct device *tty_port_register_device_attr(struct tty_port *port,
568 struct tty_driver *driver, unsigned index,
569 struct device *device, void *drvdata,
570 const struct attribute_group **attr_grp);
571 extern struct device *tty_port_register_device_serdev(struct tty_port *port,
572 struct tty_driver *driver, unsigned index,
573 struct device *device);
574 extern struct device *tty_port_register_device_attr_serdev(struct tty_port *port,
575 struct tty_driver *driver, unsigned index,
576 struct device *device, void *drvdata,
577 const struct attribute_group **attr_grp);
578 extern void tty_port_unregister_device(struct tty_port *port,
579 struct tty_driver *driver, unsigned index);
580 extern int tty_port_alloc_xmit_buf(struct tty_port *port);
581 extern void tty_port_free_xmit_buf(struct tty_port *port);
582 extern void tty_port_destroy(struct tty_port *port);
583 extern void tty_port_put(struct tty_port *port);
585 static inline struct tty_port *tty_port_get(struct tty_port *port)
587 if (port && kref_get_unless_zero(&port->kref))
592 /* If the cts flow control is enabled, return true. */
593 static inline bool tty_port_cts_enabled(struct tty_port *port)
595 return test_bit(TTY_PORT_CTS_FLOW, &port->iflags);
598 static inline void tty_port_set_cts_flow(struct tty_port *port, bool val)
601 set_bit(TTY_PORT_CTS_FLOW, &port->iflags);
603 clear_bit(TTY_PORT_CTS_FLOW, &port->iflags);
606 static inline bool tty_port_active(struct tty_port *port)
608 return test_bit(TTY_PORT_ACTIVE, &port->iflags);
611 static inline void tty_port_set_active(struct tty_port *port, bool val)
614 set_bit(TTY_PORT_ACTIVE, &port->iflags);
616 clear_bit(TTY_PORT_ACTIVE, &port->iflags);
619 static inline bool tty_port_check_carrier(struct tty_port *port)
621 return test_bit(TTY_PORT_CHECK_CD, &port->iflags);
624 static inline void tty_port_set_check_carrier(struct tty_port *port, bool val)
627 set_bit(TTY_PORT_CHECK_CD, &port->iflags);
629 clear_bit(TTY_PORT_CHECK_CD, &port->iflags);
632 static inline bool tty_port_suspended(struct tty_port *port)
634 return test_bit(TTY_PORT_SUSPENDED, &port->iflags);
637 static inline void tty_port_set_suspended(struct tty_port *port, bool val)
640 set_bit(TTY_PORT_SUSPENDED, &port->iflags);
642 clear_bit(TTY_PORT_SUSPENDED, &port->iflags);
645 static inline bool tty_port_initialized(struct tty_port *port)
647 return test_bit(TTY_PORT_INITIALIZED, &port->iflags);
650 static inline void tty_port_set_initialized(struct tty_port *port, bool val)
653 set_bit(TTY_PORT_INITIALIZED, &port->iflags);
655 clear_bit(TTY_PORT_INITIALIZED, &port->iflags);
658 static inline bool tty_port_kopened(struct tty_port *port)
660 return test_bit(TTY_PORT_KOPENED, &port->iflags);
663 static inline void tty_port_set_kopened(struct tty_port *port, bool val)
666 set_bit(TTY_PORT_KOPENED, &port->iflags);
668 clear_bit(TTY_PORT_KOPENED, &port->iflags);
671 extern struct tty_struct *tty_port_tty_get(struct tty_port *port);
672 extern void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty);
673 extern int tty_port_carrier_raised(struct tty_port *port);
674 extern void tty_port_raise_dtr_rts(struct tty_port *port);
675 extern void tty_port_lower_dtr_rts(struct tty_port *port);
676 extern void tty_port_hangup(struct tty_port *port);
677 extern void tty_port_tty_hangup(struct tty_port *port, bool check_clocal);
678 extern void tty_port_tty_wakeup(struct tty_port *port);
679 extern int tty_port_block_til_ready(struct tty_port *port,
680 struct tty_struct *tty, struct file *filp);
681 extern int tty_port_close_start(struct tty_port *port,
682 struct tty_struct *tty, struct file *filp);
683 extern void tty_port_close_end(struct tty_port *port, struct tty_struct *tty);
684 extern void tty_port_close(struct tty_port *port,
685 struct tty_struct *tty, struct file *filp);
686 extern int tty_port_install(struct tty_port *port, struct tty_driver *driver,
687 struct tty_struct *tty);
688 extern int tty_port_open(struct tty_port *port,
689 struct tty_struct *tty, struct file *filp);
690 static inline int tty_port_users(struct tty_port *port)
692 return port->count + port->blocked_open;
695 extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
696 extern int tty_unregister_ldisc(int disc);
697 extern int tty_set_ldisc(struct tty_struct *tty, int disc);
698 extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty);
699 extern void tty_ldisc_release(struct tty_struct *tty);
700 extern void tty_ldisc_init(struct tty_struct *tty);
701 extern void tty_ldisc_deinit(struct tty_struct *tty);
702 extern int tty_ldisc_receive_buf(struct tty_ldisc *ld, const unsigned char *p,
706 extern void n_tty_inherit_ops(struct tty_ldisc_ops *ops);
708 extern void __init n_tty_init(void);
710 static inline void n_tty_init(void) { }
715 extern void tty_audit_add_data(struct tty_struct *tty, const void *data,
717 extern void tty_audit_exit(void);
718 extern void tty_audit_fork(struct signal_struct *sig);
719 extern void tty_audit_tiocsti(struct tty_struct *tty, char ch);
720 extern int tty_audit_push(void);
722 static inline void tty_audit_add_data(struct tty_struct *tty, const void *data,
726 static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch)
729 static inline void tty_audit_exit(void)
732 static inline void tty_audit_fork(struct signal_struct *sig)
735 static inline int tty_audit_push(void)
742 extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
743 unsigned int cmd, unsigned long arg);
744 extern long n_tty_compat_ioctl_helper(struct tty_struct *tty, struct file *file,
745 unsigned int cmd, unsigned long arg);
749 extern int vt_ioctl(struct tty_struct *tty,
750 unsigned int cmd, unsigned long arg);
752 extern long vt_compat_ioctl(struct tty_struct *tty,
753 unsigned int cmd, unsigned long arg);
756 /* functions for preparation of BKL removal */
757 extern void tty_lock(struct tty_struct *tty);
758 extern int tty_lock_interruptible(struct tty_struct *tty);
759 extern void tty_unlock(struct tty_struct *tty);
760 extern void tty_lock_slave(struct tty_struct *tty);
761 extern void tty_unlock_slave(struct tty_struct *tty);
762 extern void tty_set_lock_subclass(struct tty_struct *tty);
764 #ifdef CONFIG_PROC_FS
765 extern void proc_tty_register_driver(struct tty_driver *);
766 extern void proc_tty_unregister_driver(struct tty_driver *);
768 static inline void proc_tty_register_driver(struct tty_driver *d) {}
769 static inline void proc_tty_unregister_driver(struct tty_driver *d) {}
772 #define tty_msg(fn, tty, f, ...) \
773 fn("%s %s: " f, tty_driver_name(tty), tty_name(tty), ##__VA_ARGS__)
775 #define tty_debug(tty, f, ...) tty_msg(pr_debug, tty, f, ##__VA_ARGS__)
776 #define tty_info(tty, f, ...) tty_msg(pr_info, tty, f, ##__VA_ARGS__)
777 #define tty_notice(tty, f, ...) tty_msg(pr_notice, tty, f, ##__VA_ARGS__)
778 #define tty_warn(tty, f, ...) tty_msg(pr_warn, tty, f, ##__VA_ARGS__)
779 #define tty_err(tty, f, ...) tty_msg(pr_err, tty, f, ##__VA_ARGS__)
781 #define tty_info_ratelimited(tty, f, ...) \
782 tty_msg(pr_info_ratelimited, tty, f, ##__VA_ARGS__)