~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/tty.h

Version: ~ [ linux-5.13-rc5 ] ~ [ linux-5.12.9 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.42 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.124 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.193 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.235 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.271 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.271 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp