tty.h 25 KB

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