tty.h 24 KB

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