tty.h 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473
  1. #ifndef _LINUX_TTY_H
  2. #define _LINUX_TTY_H
  3. /*
  4. * 'tty.h' defines some structures used by tty_io.c and some defines.
  5. */
  6. #ifdef __KERNEL__
  7. #include <linux/fs.h>
  8. #include <linux/major.h>
  9. #include <linux/termios.h>
  10. #include <linux/workqueue.h>
  11. #include <linux/tty_driver.h>
  12. #include <linux/tty_ldisc.h>
  13. #include <linux/mutex.h>
  14. #include <asm/system.h>
  15. /*
  16. * (Note: the *_driver.minor_start values 1, 64, 128, 192 are
  17. * hardcoded at present.)
  18. */
  19. #define NR_UNIX98_PTY_DEFAULT 4096 /* Default maximum for Unix98 ptys */
  20. #define NR_UNIX98_PTY_MAX (1 << MINORBITS) /* Absolute limit */
  21. #define NR_LDISCS 19
  22. /* line disciplines */
  23. #define N_TTY 0
  24. #define N_SLIP 1
  25. #define N_MOUSE 2
  26. #define N_PPP 3
  27. #define N_STRIP 4
  28. #define N_AX25 5
  29. #define N_X25 6 /* X.25 async */
  30. #define N_6PACK 7
  31. #define N_MASC 8 /* Reserved for Mobitex module <kaz@cafe.net> */
  32. #define N_R3964 9 /* Reserved for Simatic R3964 module */
  33. #define N_PROFIBUS_FDL 10 /* Reserved for Profibus */
  34. #define N_IRDA 11 /* Linux IrDa - http://irda.sourceforge.net/ */
  35. #define N_SMSBLOCK 12 /* SMS block mode - for talking to GSM data */
  36. /* cards about SMS messages */
  37. #define N_HDLC 13 /* synchronous HDLC */
  38. #define N_SYNC_PPP 14 /* synchronous PPP */
  39. #define N_HCI 15 /* Bluetooth HCI UART */
  40. #define N_GIGASET_M101 16 /* Siemens Gigaset M101 serial DECT adapter */
  41. #define N_SLCAN 17 /* Serial / USB serial CAN Adaptors */
  42. #define N_PPS 18 /* Pulse per Second */
  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. struct tty_buffer *next;
  51. char *char_buf_ptr;
  52. unsigned char *flag_buf_ptr;
  53. int used;
  54. int size;
  55. int commit;
  56. int read;
  57. /* Data points here */
  58. unsigned long data[0];
  59. };
  60. struct tty_bufhead {
  61. struct delayed_work work;
  62. spinlock_t lock;
  63. struct tty_buffer *head; /* Queue head */
  64. struct tty_buffer *tail; /* Active buffer */
  65. struct tty_buffer *free; /* Free queue head */
  66. int memory_used; /* Buffer space used excluding
  67. free queue */
  68. };
  69. /*
  70. * When a break, frame error, or parity error happens, these codes are
  71. * stuffed into the flags buffer.
  72. */
  73. #define TTY_NORMAL 0
  74. #define TTY_BREAK 1
  75. #define TTY_FRAME 2
  76. #define TTY_PARITY 3
  77. #define TTY_OVERRUN 4
  78. #define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
  79. #define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
  80. #define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
  81. #define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
  82. #define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
  83. #define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
  84. #define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
  85. #define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
  86. #define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
  87. #define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
  88. #define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
  89. #define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
  90. #define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
  91. #define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
  92. #define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
  93. #define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
  94. #define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
  95. #define _I_FLAG(tty, f) ((tty)->termios->c_iflag & (f))
  96. #define _O_FLAG(tty, f) ((tty)->termios->c_oflag & (f))
  97. #define _C_FLAG(tty, f) ((tty)->termios->c_cflag & (f))
  98. #define _L_FLAG(tty, f) ((tty)->termios->c_lflag & (f))
  99. #define I_IGNBRK(tty) _I_FLAG((tty), IGNBRK)
  100. #define I_BRKINT(tty) _I_FLAG((tty), BRKINT)
  101. #define I_IGNPAR(tty) _I_FLAG((tty), IGNPAR)
  102. #define I_PARMRK(tty) _I_FLAG((tty), PARMRK)
  103. #define I_INPCK(tty) _I_FLAG((tty), INPCK)
  104. #define I_ISTRIP(tty) _I_FLAG((tty), ISTRIP)
  105. #define I_INLCR(tty) _I_FLAG((tty), INLCR)
  106. #define I_IGNCR(tty) _I_FLAG((tty), IGNCR)
  107. #define I_ICRNL(tty) _I_FLAG((tty), ICRNL)
  108. #define I_IUCLC(tty) _I_FLAG((tty), IUCLC)
  109. #define I_IXON(tty) _I_FLAG((tty), IXON)
  110. #define I_IXANY(tty) _I_FLAG((tty), IXANY)
  111. #define I_IXOFF(tty) _I_FLAG((tty), IXOFF)
  112. #define I_IMAXBEL(tty) _I_FLAG((tty), IMAXBEL)
  113. #define I_IUTF8(tty) _I_FLAG((tty), IUTF8)
  114. #define O_OPOST(tty) _O_FLAG((tty), OPOST)
  115. #define O_OLCUC(tty) _O_FLAG((tty), OLCUC)
  116. #define O_ONLCR(tty) _O_FLAG((tty), ONLCR)
  117. #define O_OCRNL(tty) _O_FLAG((tty), OCRNL)
  118. #define O_ONOCR(tty) _O_FLAG((tty), ONOCR)
  119. #define O_ONLRET(tty) _O_FLAG((tty), ONLRET)
  120. #define O_OFILL(tty) _O_FLAG((tty), OFILL)
  121. #define O_OFDEL(tty) _O_FLAG((tty), OFDEL)
  122. #define O_NLDLY(tty) _O_FLAG((tty), NLDLY)
  123. #define O_CRDLY(tty) _O_FLAG((tty), CRDLY)
  124. #define O_TABDLY(tty) _O_FLAG((tty), TABDLY)
  125. #define O_BSDLY(tty) _O_FLAG((tty), BSDLY)
  126. #define O_VTDLY(tty) _O_FLAG((tty), VTDLY)
  127. #define O_FFDLY(tty) _O_FLAG((tty), FFDLY)
  128. #define C_BAUD(tty) _C_FLAG((tty), CBAUD)
  129. #define C_CSIZE(tty) _C_FLAG((tty), CSIZE)
  130. #define C_CSTOPB(tty) _C_FLAG((tty), CSTOPB)
  131. #define C_CREAD(tty) _C_FLAG((tty), CREAD)
  132. #define C_PARENB(tty) _C_FLAG((tty), PARENB)
  133. #define C_PARODD(tty) _C_FLAG((tty), PARODD)
  134. #define C_HUPCL(tty) _C_FLAG((tty), HUPCL)
  135. #define C_CLOCAL(tty) _C_FLAG((tty), CLOCAL)
  136. #define C_CIBAUD(tty) _C_FLAG((tty), CIBAUD)
  137. #define C_CRTSCTS(tty) _C_FLAG((tty), CRTSCTS)
  138. #define L_ISIG(tty) _L_FLAG((tty), ISIG)
  139. #define L_ICANON(tty) _L_FLAG((tty), ICANON)
  140. #define L_XCASE(tty) _L_FLAG((tty), XCASE)
  141. #define L_ECHO(tty) _L_FLAG((tty), ECHO)
  142. #define L_ECHOE(tty) _L_FLAG((tty), ECHOE)
  143. #define L_ECHOK(tty) _L_FLAG((tty), ECHOK)
  144. #define L_ECHONL(tty) _L_FLAG((tty), ECHONL)
  145. #define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH)
  146. #define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP)
  147. #define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL)
  148. #define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT)
  149. #define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE)
  150. #define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO)
  151. #define L_PENDIN(tty) _L_FLAG((tty), PENDIN)
  152. #define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN)
  153. struct device;
  154. struct signal_struct;
  155. /*
  156. * Port level information. Each device keeps its own port level information
  157. * so provide a common structure for those ports wanting to use common support
  158. * routines.
  159. *
  160. * The tty port has a different lifetime to the tty so must be kept apart.
  161. * In addition be careful as tty -> port mappings are valid for the life
  162. * of the tty object but in many cases port -> tty mappings are valid only
  163. * until a hangup so don't use the wrong path.
  164. */
  165. struct tty_port {
  166. struct tty_struct *tty; /* Back pointer */
  167. int blocked_open; /* Waiting to open */
  168. int count; /* Usage count */
  169. wait_queue_head_t open_wait; /* Open waiters */
  170. wait_queue_head_t close_wait; /* Close waiters */
  171. unsigned long flags; /* TTY flags ASY_*/
  172. struct mutex mutex; /* Locking */
  173. unsigned char *xmit_buf; /* Optional buffer */
  174. int close_delay; /* Close port delay */
  175. int closing_wait; /* Delay for output */
  176. };
  177. /*
  178. * Where all of the state associated with a tty is kept while the tty
  179. * is open. Since the termios state should be kept even if the tty
  180. * has been closed --- for things like the baud rate, etc --- it is
  181. * not stored here, but rather a pointer to the real state is stored
  182. * here. Possible the winsize structure should have the same
  183. * treatment, but (1) the default 80x24 is usually right and (2) it's
  184. * most often used by a windowing system, which will set the correct
  185. * size each time the window is created or resized anyway.
  186. * - TYT, 9/14/92
  187. */
  188. struct tty_operations;
  189. struct tty_struct {
  190. int magic;
  191. struct kref kref;
  192. struct tty_driver *driver;
  193. const struct tty_operations *ops;
  194. int index;
  195. /* The ldisc objects are protected by tty_ldisc_lock at the moment */
  196. struct tty_ldisc ldisc;
  197. struct mutex termios_mutex;
  198. spinlock_t ctrl_lock;
  199. /* Termios values are protected by the termios mutex */
  200. struct ktermios *termios, *termios_locked;
  201. char name[64];
  202. struct pid *pgrp; /* Protected by ctrl lock */
  203. struct pid *session;
  204. unsigned long flags;
  205. int count;
  206. struct winsize winsize; /* termios mutex */
  207. unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
  208. unsigned char low_latency:1, warned:1;
  209. unsigned char ctrl_status; /* ctrl_lock */
  210. unsigned int receive_room; /* Bytes free for queue */
  211. struct tty_struct *link;
  212. struct fasync_struct *fasync;
  213. struct tty_bufhead buf; /* Locked internally */
  214. int alt_speed; /* For magic substitution of 38400 bps */
  215. wait_queue_head_t write_wait;
  216. wait_queue_head_t read_wait;
  217. struct work_struct hangup_work;
  218. void *disc_data;
  219. void *driver_data;
  220. struct list_head tty_files;
  221. #define N_TTY_BUF_SIZE 4096
  222. /*
  223. * The following is data for the N_TTY line discipline. For
  224. * historical reasons, this is included in the tty structure.
  225. * Mostly locked by the BKL.
  226. */
  227. unsigned int column;
  228. unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
  229. unsigned char closing:1;
  230. unsigned short minimum_to_wake;
  231. unsigned long overrun_time;
  232. int num_overrun;
  233. unsigned long process_char_map[256/(8*sizeof(unsigned long))];
  234. char *read_buf;
  235. int read_head;
  236. int read_tail;
  237. int read_cnt;
  238. unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
  239. int canon_data;
  240. unsigned long canon_head;
  241. unsigned int canon_column;
  242. struct mutex atomic_read_lock;
  243. struct mutex atomic_write_lock;
  244. unsigned char *write_buf;
  245. int write_cnt;
  246. spinlock_t read_lock;
  247. /* If the tty has a pending do_SAK, queue it here - akpm */
  248. struct work_struct SAK_work;
  249. struct tty_port *port;
  250. };
  251. /* tty magic number */
  252. #define TTY_MAGIC 0x5401
  253. /*
  254. * These bits are used in the flags field of the tty structure.
  255. *
  256. * So that interrupts won't be able to mess up the queues,
  257. * copy_to_cooked must be atomic with respect to itself, as must
  258. * tty->write. Thus, you must use the inline functions set_bit() and
  259. * clear_bit() to make things atomic.
  260. */
  261. #define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
  262. #define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */
  263. #define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
  264. #define TTY_EXCLUSIVE 3 /* Exclusive open mode */
  265. #define TTY_DEBUG 4 /* Debugging */
  266. #define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
  267. #define TTY_PUSH 6 /* n_tty private */
  268. #define TTY_CLOSING 7 /* ->close() in progress */
  269. #define TTY_LDISC 9 /* Line discipline attached */
  270. #define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */
  271. #define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */
  272. #define TTY_PTY_LOCK 16 /* pty private */
  273. #define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
  274. #define TTY_HUPPED 18 /* Post driver->hangup() */
  275. #define TTY_FLUSHING 19 /* Flushing to ldisc in progress */
  276. #define TTY_FLUSHPENDING 20 /* Queued buffer flush pending */
  277. #define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
  278. extern void tty_write_flush(struct tty_struct *);
  279. extern struct ktermios tty_std_termios;
  280. extern int kmsg_redirect;
  281. extern void console_init(void);
  282. extern int vcs_init(void);
  283. /**
  284. * tty_kref_get - get a tty reference
  285. * @tty: tty device
  286. *
  287. * Return a new reference to a tty object. The caller must hold
  288. * sufficient locks/counts to ensure that their existing reference cannot
  289. * go away
  290. */
  291. extern inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
  292. {
  293. if (tty)
  294. kref_get(&tty->kref);
  295. return tty;
  296. }
  297. extern void tty_kref_put(struct tty_struct *tty);
  298. extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
  299. const char *routine);
  300. extern char *tty_name(struct tty_struct *tty, char *buf);
  301. extern void tty_wait_until_sent(struct tty_struct *tty, long timeout);
  302. extern int tty_check_change(struct tty_struct *tty);
  303. extern void stop_tty(struct tty_struct *tty);
  304. extern void start_tty(struct tty_struct *tty);
  305. extern int tty_register_driver(struct tty_driver *driver);
  306. extern int tty_unregister_driver(struct tty_driver *driver);
  307. extern struct device *tty_register_device(struct tty_driver *driver,
  308. unsigned index, struct device *dev);
  309. extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
  310. extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
  311. int buflen);
  312. extern void tty_write_message(struct tty_struct *tty, char *msg);
  313. extern int tty_put_char(struct tty_struct *tty, unsigned char c);
  314. extern int tty_chars_in_buffer(struct tty_struct *tty);
  315. extern int tty_write_room(struct tty_struct *tty);
  316. extern void tty_driver_flush_buffer(struct tty_struct *tty);
  317. extern void tty_throttle(struct tty_struct *tty);
  318. extern void tty_unthrottle(struct tty_struct *tty);
  319. extern int tty_do_resize(struct tty_struct *tty, struct tty_struct *real_tty,
  320. struct winsize *ws);
  321. extern int is_current_pgrp_orphaned(void);
  322. extern struct pid *tty_get_pgrp(struct tty_struct *tty);
  323. extern int is_ignored(int sig);
  324. extern int tty_signal(int sig, struct tty_struct *tty);
  325. extern void tty_hangup(struct tty_struct *tty);
  326. extern void tty_vhangup(struct tty_struct *tty);
  327. extern void tty_unhangup(struct file *filp);
  328. extern int tty_hung_up_p(struct file *filp);
  329. extern void do_SAK(struct tty_struct *tty);
  330. extern void __do_SAK(struct tty_struct *tty);
  331. extern void disassociate_ctty(int priv);
  332. extern void no_tty(void);
  333. extern void tty_flip_buffer_push(struct tty_struct *tty);
  334. extern void tty_buffer_free_all(struct tty_struct *tty);
  335. extern void tty_buffer_flush(struct tty_struct *tty);
  336. extern void tty_buffer_init(struct tty_struct *tty);
  337. extern speed_t tty_get_baud_rate(struct tty_struct *tty);
  338. extern speed_t tty_termios_baud_rate(struct ktermios *termios);
  339. extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
  340. extern void tty_termios_encode_baud_rate(struct ktermios *termios,
  341. speed_t ibaud, speed_t obaud);
  342. extern void tty_encode_baud_rate(struct tty_struct *tty,
  343. speed_t ibaud, speed_t obaud);
  344. extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
  345. extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
  346. extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
  347. extern void tty_ldisc_deref(struct tty_ldisc *);
  348. extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
  349. extern const struct file_operations tty_ldiscs_proc_fops;
  350. extern void tty_wakeup(struct tty_struct *tty);
  351. extern void tty_ldisc_flush(struct tty_struct *tty);
  352. extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
  353. extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
  354. unsigned int cmd, unsigned long arg);
  355. extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
  356. extern dev_t tty_devnum(struct tty_struct *tty);
  357. extern void proc_clear_tty(struct task_struct *p);
  358. extern struct tty_struct *get_current_tty(void);
  359. extern struct mutex tty_mutex;
  360. extern void tty_write_unlock(struct tty_struct *tty);
  361. extern int tty_write_lock(struct tty_struct *tty, int ndelay);
  362. #define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
  363. extern void tty_port_init(struct tty_port *port);
  364. extern int tty_port_alloc_xmit_buf(struct tty_port *port);
  365. extern void tty_port_free_xmit_buf(struct tty_port *port);
  366. extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
  367. extern int tty_unregister_ldisc(int disc);
  368. extern int tty_set_ldisc(struct tty_struct *tty, int ldisc);
  369. extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty);
  370. extern void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty);
  371. extern void tty_ldisc_init(struct tty_struct *tty);
  372. extern void tty_ldisc_begin(void);
  373. /* This last one is just for the tty layer internals and shouldn't be used elsewhere */
  374. extern void tty_ldisc_enable(struct tty_struct *tty);
  375. /* n_tty.c */
  376. extern struct tty_ldisc_ops tty_ldisc_N_TTY;
  377. /* tty_audit.c */
  378. #ifdef CONFIG_AUDIT
  379. extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data,
  380. size_t size);
  381. extern void tty_audit_exit(void);
  382. extern void tty_audit_fork(struct signal_struct *sig);
  383. extern void tty_audit_push(struct tty_struct *tty);
  384. extern void tty_audit_push_task(struct task_struct *tsk,
  385. uid_t loginuid, u32 sessionid);
  386. #else
  387. static inline void tty_audit_add_data(struct tty_struct *tty,
  388. unsigned char *data, size_t size)
  389. {
  390. }
  391. static inline void tty_audit_exit(void)
  392. {
  393. }
  394. static inline void tty_audit_fork(struct signal_struct *sig)
  395. {
  396. }
  397. static inline void tty_audit_push(struct tty_struct *tty)
  398. {
  399. }
  400. static inline void tty_audit_push_task(struct task_struct *tsk,
  401. uid_t loginuid, u32 sessionid)
  402. {
  403. }
  404. #endif
  405. /* tty_ioctl.c */
  406. extern int n_tty_ioctl(struct tty_struct *tty, struct file *file,
  407. unsigned int cmd, unsigned long arg);
  408. /* serial.c */
  409. extern void serial_console_init(void);
  410. /* pcxx.c */
  411. extern int pcxe_open(struct tty_struct *tty, struct file *filp);
  412. /* printk.c */
  413. extern void console_print(const char *);
  414. /* vt.c */
  415. extern int vt_ioctl(struct tty_struct *tty, struct file *file,
  416. unsigned int cmd, unsigned long arg);
  417. #endif /* __KERNEL__ */
  418. #endif