projects/linux·blob v4.8 · refs

737 lines · 25.4 KiB

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 * 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
33 * master.
34 */
35
36enum {
37 TTY_LOCK_NORMAL = 0,
38 TTY_LOCK_SLAVE,
39};
40
41/*
42 * (Note: the *_driver.minor_start values 1, 64, 128, 192 are
43 * hardcoded at present.)
44 */
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 */
48
49/*
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)
53 */
54#define __DISABLED_CHAR '\0'
55
56struct tty_buffer {
57 union {
58 struct tty_buffer *next;
59 struct llist_node free;
60 };
61 int used;
62 int size;
63 int commit;
64 int read;
65 int flags;
66 /* Data points here */
67 unsigned long data[0];
68};
69
70/* Values for .flags field of tty_buffer */
71#define TTYB_NORMAL 1 /* buffer has no flags buffer */
72
73static inline unsigned char *char_buf_ptr(struct tty_buffer *b, int ofs)
74{
75 return ((unsigned char *)b->data) + ofs;
76}
77
78static inline char *flag_buf_ptr(struct tty_buffer *b, int ofs)
79{
80 return (char *)char_buf_ptr(b, ofs) + b->size;
81}
82
83struct tty_bufhead {
84 struct tty_buffer *head; /* Queue head */
85 struct work_struct work;
86 struct mutex lock;
87 atomic_t priority;
88 struct tty_buffer sentinel;
89 struct llist_head free; /* Free queue head */
90 atomic_t mem_used; /* In-use buffers excluding free list */
91 int mem_limit;
92 struct tty_buffer *tail; /* Active buffer */
93};
94/*
95 * When a break, frame error, or parity error happens, these codes are
96 * stuffed into the flags buffer.
97 */
98#define TTY_NORMAL 0
99#define TTY_BREAK 1
100#define TTY_FRAME 2
101#define TTY_PARITY 3
102#define TTY_OVERRUN 4
103
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])
121
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))
126
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)
142
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)
157
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)
169
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)
186
187struct device;
188struct signal_struct;
189
190/*
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
193 * routines.
194 *
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.
199 */
200
201struct tty_port;
202
203struct 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
213 the port mutex */
214 /* FIXME: long term getting the tty argument *out* of this would be
215 good for consoles */
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);
219};
220
221struct tty_port {
222 struct tty_bufhead buf; /* Locked internally */
223 struct tty_struct *tty; /* Back pointer */
224 struct tty_struct *itty; /* internal back ptr */
225 const struct tty_port_operations *ops; /* Port operations */
226 spinlock_t lock; /* Lock protecting tty field */
227 int blocked_open; /* Waiting to open */
228 int count; /* Usage count */
229 wait_queue_head_t open_wait; /* Open waiters */
230 wait_queue_head_t delta_msr_wait; /* Modem status change */
231 unsigned long flags; /* User TTY flags ASYNC_ */
232 unsigned long iflags; /* Internal flags TTY_PORT_ */
233 unsigned char console:1, /* port is a console */
234 low_latency:1; /* optional: tune for latency */
235 struct mutex mutex; /* Locking */
236 struct mutex buf_mutex; /* Buffer alloc lock */
237 unsigned char *xmit_buf; /* Optional buffer */
238 unsigned int close_delay; /* Close port delay */
239 unsigned int closing_wait; /* Delay for output */
240 int drain_delay; /* Set to zero if no pure time
241 based drain is needed else
242 set to size of fifo */
243 struct kref kref; /* Ref counter */
244};
245
246/* tty_port::iflags bits -- use atomic bit ops */
247#define TTY_PORT_INITIALIZED 0 /* device is initialized */
248#define TTY_PORT_SUSPENDED 1 /* device is suspended */
249#define TTY_PORT_ACTIVE 2 /* device is open */
250
251/*
252 * uart drivers: use the uart_port::status field and the UPSTAT_* defines
253 * for s/w-based flow control steering and carrier detection status
254 */
255#define TTY_PORT_CTS_FLOW 3 /* h/w flow control enabled */
256#define TTY_PORT_CHECK_CD 4 /* carrier detect enabled */
257
258/*
259 * Where all of the state associated with a tty is kept while the tty
260 * is open. Since the termios state should be kept even if the tty
261 * has been closed --- for things like the baud rate, etc --- it is
262 * not stored here, but rather a pointer to the real state is stored
263 * here. Possible the winsize structure should have the same
264 * treatment, but (1) the default 80x24 is usually right and (2) it's
265 * most often used by a windowing system, which will set the correct
266 * size each time the window is created or resized anyway.
267 * - TYT, 9/14/92
268 */
269
270struct tty_operations;
271
272struct tty_struct {
273 int magic;
274 struct kref kref;
275 struct device *dev;
276 struct tty_driver *driver;
277 const struct tty_operations *ops;
278 int index;
279
280 /* Protects ldisc changes: Lock tty not pty */
281 struct ld_semaphore ldisc_sem;
282 struct tty_ldisc *ldisc;
283
284 struct mutex atomic_write_lock;
285 struct mutex legacy_mutex;
286 struct mutex throttle_mutex;
287 struct rw_semaphore termios_rwsem;
288 struct mutex winsize_mutex;
289 spinlock_t ctrl_lock;
290 spinlock_t flow_lock;
291 /* Termios values are protected by the termios rwsem */
292 struct ktermios termios, termios_locked;
293 struct termiox *termiox; /* May be NULL for unsupported */
294 char name[64];
295 struct pid *pgrp; /* Protected by ctrl lock */
296 struct pid *session;
297 unsigned long flags;
298 int count;
299 struct winsize winsize; /* winsize_mutex */
300 unsigned long stopped:1, /* flow_lock */
301 flow_stopped:1,
302 unused:BITS_PER_LONG - 2;
303 int hw_stopped;
304 unsigned long ctrl_status:8, /* ctrl_lock */
305 packet:1,
306 unused_ctrl:BITS_PER_LONG - 9;
307 unsigned int receive_room; /* Bytes free for queue */
308 int flow_change;
309
310 struct tty_struct *link;
311 struct fasync_struct *fasync;
312 int alt_speed; /* For magic substitution of 38400 bps */
313 wait_queue_head_t write_wait;
314 wait_queue_head_t read_wait;
315 struct work_struct hangup_work;
316 void *disc_data;
317 void *driver_data;
318 spinlock_t files_lock; /* protects tty_files list */
319 struct list_head tty_files;
320
321#define N_TTY_BUF_SIZE 4096
322
323 int closing;
324 unsigned char *write_buf;
325 int write_cnt;
326 /* If the tty has a pending do_SAK, queue it here - akpm */
327 struct work_struct SAK_work;
328 struct tty_port *port;
329};
330
331/* Each of a tty's open files has private_data pointing to tty_file_private */
332struct tty_file_private {
333 struct tty_struct *tty;
334 struct file *file;
335 struct list_head list;
336};
337
338/* tty magic number */
339#define TTY_MAGIC 0x5401
340
341/*
342 * These bits are used in the flags field of the tty structure.
343 *
344 * So that interrupts won't be able to mess up the queues,
345 * copy_to_cooked must be atomic with respect to itself, as must
346 * tty->write. Thus, you must use the inline functions set_bit() and
347 * clear_bit() to make things atomic.
348 */
349#define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
350#define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */
351#define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
352#define TTY_EXCLUSIVE 3 /* Exclusive open mode */
353#define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
354#define TTY_LDISC_OPEN 11 /* Line discipline is open */
355#define TTY_PTY_LOCK 16 /* pty private */
356#define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
357#define TTY_HUPPED 18 /* Post driver->hangup() */
358#define TTY_LDISC_HALTED 22 /* Line discipline is halted */
359
360/* Values for tty->flow_change */
361#define TTY_THROTTLE_SAFE 1
362#define TTY_UNTHROTTLE_SAFE 2
363
364static inline void __tty_set_flow_change(struct tty_struct *tty, int val)
365{
366 tty->flow_change = val;
367}
368
369static inline void tty_set_flow_change(struct tty_struct *tty, int val)
370{
371 tty->flow_change = val;
372 smp_mb();
373}
374
375static inline bool tty_io_error(struct tty_struct *tty)
376{
377 return test_bit(TTY_IO_ERROR, &tty->flags);
378}
379
380static inline bool tty_throttled(struct tty_struct *tty)
381{
382 return test_bit(TTY_THROTTLED, &tty->flags);
383}
384
385#ifdef CONFIG_TTY
386extern void console_init(void);
387extern void tty_kref_put(struct tty_struct *tty);
388extern struct pid *tty_get_pgrp(struct tty_struct *tty);
389extern void tty_vhangup_self(void);
390extern void disassociate_ctty(int priv);
391extern dev_t tty_devnum(struct tty_struct *tty);
392extern void proc_clear_tty(struct task_struct *p);
393extern struct tty_struct *get_current_tty(void);
394/* tty_io.c */
395extern int __init tty_init(void);
396extern const char *tty_name(const struct tty_struct *tty);
397#else
398static inline void console_init(void)
399{ }
400static inline void tty_kref_put(struct tty_struct *tty)
401{ }
402static inline struct pid *tty_get_pgrp(struct tty_struct *tty)
403{ return NULL; }
404static inline void tty_vhangup_self(void)
405{ }
406static inline void disassociate_ctty(int priv)
407{ }
408static inline dev_t tty_devnum(struct tty_struct *tty)
409{ return 0; }
410static inline void proc_clear_tty(struct task_struct *p)
411{ }
412static inline struct tty_struct *get_current_tty(void)
413{ return NULL; }
414/* tty_io.c */
415static inline int __init tty_init(void)
416{ return 0; }
417static inline const char *tty_name(const struct tty_struct *tty)
418{ return "(none)"; }
419#endif
420
421extern struct ktermios tty_std_termios;
422
423extern int vcs_init(void);
424
425extern struct class *tty_class;
426
427/**
428 * tty_kref_get - get a tty reference
429 * @tty: tty device
430 *
431 * Return a new reference to a tty object. The caller must hold
432 * sufficient locks/counts to ensure that their existing reference cannot
433 * go away
434 */
435
436static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
437{
438 if (tty)
439 kref_get(&tty->kref);
440 return tty;
441}
442
443extern const char *tty_driver_name(const struct tty_struct *tty);
444extern void tty_wait_until_sent(struct tty_struct *tty, long timeout);
445extern int __tty_check_change(struct tty_struct *tty, int sig);
446extern int tty_check_change(struct tty_struct *tty);
447extern void __stop_tty(struct tty_struct *tty);
448extern void stop_tty(struct tty_struct *tty);
449extern void __start_tty(struct tty_struct *tty);
450extern void start_tty(struct tty_struct *tty);
451extern int tty_register_driver(struct tty_driver *driver);
452extern int tty_unregister_driver(struct tty_driver *driver);
453extern struct device *tty_register_device(struct tty_driver *driver,
454 unsigned index, struct device *dev);
455extern struct device *tty_register_device_attr(struct tty_driver *driver,
456 unsigned index, struct device *device,
457 void *drvdata,
458 const struct attribute_group **attr_grp);
459extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
460extern void tty_write_message(struct tty_struct *tty, char *msg);
461extern int tty_send_xchar(struct tty_struct *tty, char ch);
462extern int tty_put_char(struct tty_struct *tty, unsigned char c);
463extern int tty_chars_in_buffer(struct tty_struct *tty);
464extern int tty_write_room(struct tty_struct *tty);
465extern void tty_driver_flush_buffer(struct tty_struct *tty);
466extern void tty_throttle(struct tty_struct *tty);
467extern void tty_unthrottle(struct tty_struct *tty);
468extern int tty_throttle_safe(struct tty_struct *tty);
469extern int tty_unthrottle_safe(struct tty_struct *tty);
470extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
471extern int is_current_pgrp_orphaned(void);
472extern void tty_hangup(struct tty_struct *tty);
473extern void tty_vhangup(struct tty_struct *tty);
474extern int tty_hung_up_p(struct file *filp);
475extern void do_SAK(struct tty_struct *tty);
476extern void __do_SAK(struct tty_struct *tty);
477extern void no_tty(void);
478extern void tty_buffer_free_all(struct tty_port *port);
479extern void tty_buffer_flush(struct tty_struct *tty, struct tty_ldisc *ld);
480extern void tty_buffer_init(struct tty_port *port);
481extern void tty_buffer_set_lock_subclass(struct tty_port *port);
482extern bool tty_buffer_restart_work(struct tty_port *port);
483extern bool tty_buffer_cancel_work(struct tty_port *port);
484extern void tty_buffer_flush_work(struct tty_port *port);
485extern speed_t tty_termios_baud_rate(struct ktermios *termios);
486extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
487extern void tty_termios_encode_baud_rate(struct ktermios *termios,
488 speed_t ibaud, speed_t obaud);
489extern void tty_encode_baud_rate(struct tty_struct *tty,
490 speed_t ibaud, speed_t obaud);
491
492/**
493 * tty_get_baud_rate - get tty bit rates
494 * @tty: tty to query
495 *
496 * Returns the baud rate as an integer for this terminal. The
497 * termios lock must be held by the caller and the terminal bit
498 * flags may be updated.
499 *
500 * Locking: none
501 */
502static inline speed_t tty_get_baud_rate(struct tty_struct *tty)
503{
504 return tty_termios_baud_rate(&tty->termios);
505}
506
507extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
508extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
509extern int tty_set_termios(struct tty_struct *tty, struct ktermios *kt);
510
511extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
512extern void tty_ldisc_deref(struct tty_ldisc *);
513extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
514extern void tty_ldisc_hangup(struct tty_struct *tty, bool reset);
515extern int tty_ldisc_reinit(struct tty_struct *tty, int disc);
516extern const struct file_operations tty_ldiscs_proc_fops;
517
518extern void tty_wakeup(struct tty_struct *tty);
519extern void tty_ldisc_flush(struct tty_struct *tty);
520
521extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
522extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
523 unsigned int cmd, unsigned long arg);
524extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
525extern void tty_default_fops(struct file_operations *fops);
526extern struct tty_struct *alloc_tty_struct(struct tty_driver *driver, int idx);
527extern int tty_alloc_file(struct file *file);
528extern void tty_add_file(struct tty_struct *tty, struct file *file);
529extern void tty_free_file(struct file *file);
530extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx);
531extern int tty_release(struct inode *inode, struct file *filp);
532extern void tty_init_termios(struct tty_struct *tty);
533extern int tty_standard_install(struct tty_driver *driver,
534 struct tty_struct *tty);
535
536extern struct mutex tty_mutex;
537
538#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
539
540extern void tty_port_init(struct tty_port *port);
541extern void tty_port_link_device(struct tty_port *port,
542 struct tty_driver *driver, unsigned index);
543extern struct device *tty_port_register_device(struct tty_port *port,
544 struct tty_driver *driver, unsigned index,
545 struct device *device);
546extern struct device *tty_port_register_device_attr(struct tty_port *port,
547 struct tty_driver *driver, unsigned index,
548 struct device *device, void *drvdata,
549 const struct attribute_group **attr_grp);
550extern int tty_port_alloc_xmit_buf(struct tty_port *port);
551extern void tty_port_free_xmit_buf(struct tty_port *port);
552extern void tty_port_destroy(struct tty_port *port);
553extern void tty_port_put(struct tty_port *port);
554
555static inline struct tty_port *tty_port_get(struct tty_port *port)
556{
557 if (port && kref_get_unless_zero(&port->kref))
558 return port;
559 return NULL;
560}
561
562/* If the cts flow control is enabled, return true. */
563static inline bool tty_port_cts_enabled(struct tty_port *port)
564{
565 return test_bit(TTY_PORT_CTS_FLOW, &port->iflags);
566}
567
568static inline void tty_port_set_cts_flow(struct tty_port *port, bool val)
569{
570 if (val)
571 set_bit(TTY_PORT_CTS_FLOW, &port->iflags);
572 else
573 clear_bit(TTY_PORT_CTS_FLOW, &port->iflags);
574}
575
576static inline bool tty_port_active(struct tty_port *port)
577{
578 return test_bit(TTY_PORT_ACTIVE, &port->iflags);
579}
580
581static inline void tty_port_set_active(struct tty_port *port, bool val)
582{
583 if (val)
584 set_bit(TTY_PORT_ACTIVE, &port->iflags);
585 else
586 clear_bit(TTY_PORT_ACTIVE, &port->iflags);
587}
588
589static inline bool tty_port_check_carrier(struct tty_port *port)
590{
591 return test_bit(TTY_PORT_CHECK_CD, &port->iflags);
592}
593
594static inline void tty_port_set_check_carrier(struct tty_port *port, bool val)
595{
596 if (val)
597 set_bit(TTY_PORT_CHECK_CD, &port->iflags);
598 else
599 clear_bit(TTY_PORT_CHECK_CD, &port->iflags);
600}
601
602static inline bool tty_port_suspended(struct tty_port *port)
603{
604 return test_bit(TTY_PORT_SUSPENDED, &port->iflags);
605}
606
607static inline void tty_port_set_suspended(struct tty_port *port, bool val)
608{
609 if (val)
610 set_bit(TTY_PORT_SUSPENDED, &port->iflags);
611 else
612 clear_bit(TTY_PORT_SUSPENDED, &port->iflags);
613}
614
615static inline bool tty_port_initialized(struct tty_port *port)
616{
617 return test_bit(TTY_PORT_INITIALIZED, &port->iflags);
618}
619
620static inline void tty_port_set_initialized(struct tty_port *port, bool val)
621{
622 if (val)
623 set_bit(TTY_PORT_INITIALIZED, &port->iflags);
624 else
625 clear_bit(TTY_PORT_INITIALIZED, &port->iflags);
626}
627
628extern struct tty_struct *tty_port_tty_get(struct tty_port *port);
629extern void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty);
630extern int tty_port_carrier_raised(struct tty_port *port);
631extern void tty_port_raise_dtr_rts(struct tty_port *port);
632extern void tty_port_lower_dtr_rts(struct tty_port *port);
633extern void tty_port_hangup(struct tty_port *port);
634extern void tty_port_tty_hangup(struct tty_port *port, bool check_clocal);
635extern void tty_port_tty_wakeup(struct tty_port *port);
636extern int tty_port_block_til_ready(struct tty_port *port,
637 struct tty_struct *tty, struct file *filp);
638extern int tty_port_close_start(struct tty_port *port,
639 struct tty_struct *tty, struct file *filp);
640extern void tty_port_close_end(struct tty_port *port, struct tty_struct *tty);
641extern void tty_port_close(struct tty_port *port,
642 struct tty_struct *tty, struct file *filp);
643extern int tty_port_install(struct tty_port *port, struct tty_driver *driver,
644 struct tty_struct *tty);
645extern int tty_port_open(struct tty_port *port,
646 struct tty_struct *tty, struct file *filp);
647static inline int tty_port_users(struct tty_port *port)
648{
649 return port->count + port->blocked_open;
650}
651
652extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
653extern int tty_unregister_ldisc(int disc);
654extern int tty_set_ldisc(struct tty_struct *tty, int disc);
655extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty);
656extern void tty_ldisc_release(struct tty_struct *tty);
657extern void tty_ldisc_init(struct tty_struct *tty);
658extern void tty_ldisc_deinit(struct tty_struct *tty);
659extern int tty_ldisc_receive_buf(struct tty_ldisc *ld, unsigned char *p,
660 char *f, int count);
661
662/* n_tty.c */
663extern void n_tty_inherit_ops(struct tty_ldisc_ops *ops);
664extern void __init n_tty_init(void);
665
666/* tty_audit.c */
667#ifdef CONFIG_AUDIT
668extern void tty_audit_add_data(struct tty_struct *tty, const void *data,
669 size_t size);
670extern void tty_audit_exit(void);
671extern void tty_audit_fork(struct signal_struct *sig);
672extern void tty_audit_tiocsti(struct tty_struct *tty, char ch);
673extern int tty_audit_push(void);
674#else
675static inline void tty_audit_add_data(struct tty_struct *tty, const void *data,
676 size_t size)
677{
678}
679static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch)
680{
681}
682static inline void tty_audit_exit(void)
683{
684}
685static inline void tty_audit_fork(struct signal_struct *sig)
686{
687}
688static inline int tty_audit_push(void)
689{
690 return 0;
691}
692#endif
693
694/* tty_ioctl.c */
695extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
696 unsigned int cmd, unsigned long arg);
697extern long n_tty_compat_ioctl_helper(struct tty_struct *tty, struct file *file,
698 unsigned int cmd, unsigned long arg);
699
700/* vt.c */
701
702extern int vt_ioctl(struct tty_struct *tty,
703 unsigned int cmd, unsigned long arg);
704
705extern long vt_compat_ioctl(struct tty_struct *tty,
706 unsigned int cmd, unsigned long arg);
707
708/* tty_mutex.c */
709/* functions for preparation of BKL removal */
710extern void tty_lock(struct tty_struct *tty);
711extern int tty_lock_interruptible(struct tty_struct *tty);
712extern void tty_unlock(struct tty_struct *tty);
713extern void tty_lock_slave(struct tty_struct *tty);
714extern void tty_unlock_slave(struct tty_struct *tty);
715extern void tty_set_lock_subclass(struct tty_struct *tty);
716
717#ifdef CONFIG_PROC_FS
718extern void proc_tty_register_driver(struct tty_driver *);
719extern void proc_tty_unregister_driver(struct tty_driver *);
720#else
721static inline void proc_tty_register_driver(struct tty_driver *d) {}
722static inline void proc_tty_unregister_driver(struct tty_driver *d) {}
723#endif
724
725#define tty_msg(fn, tty, f, ...) \
726 fn("%s %s: " f, tty_driver_name(tty), tty_name(tty), ##__VA_ARGS__)
727
728#define tty_debug(tty, f, ...) tty_msg(pr_debug, tty, f, ##__VA_ARGS__)
729#define tty_info(tty, f, ...) tty_msg(pr_info, tty, f, ##__VA_ARGS__)
730#define tty_notice(tty, f, ...) tty_msg(pr_notice, tty, f, ##__VA_ARGS__)
731#define tty_warn(tty, f, ...) tty_msg(pr_warn, tty, f, ##__VA_ARGS__)
732#define tty_err(tty, f, ...) tty_msg(pr_err, tty, f, ##__VA_ARGS__)
733
734#define tty_info_ratelimited(tty, f, ...) \
735 tty_msg(pr_info_ratelimited, tty, f, ##__VA_ARGS__)
736
737#endif