tty.h 24 KB

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