tty.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366
  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_PTYS CONFIG_LEGACY_PTY_COUNT /* Number of legacy ptys */
  20. #define NR_UNIX98_PTY_DEFAULT 4096 /* Default maximum for Unix98 ptys */
  21. #define NR_UNIX98_PTY_MAX (1 << MINORBITS) /* Absolute limit */
  22. #define NR_LDISCS 17
  23. /* line disciplines */
  24. #define N_TTY 0
  25. #define N_SLIP 1
  26. #define N_MOUSE 2
  27. #define N_PPP 3
  28. #define N_STRIP 4
  29. #define N_AX25 5
  30. #define N_X25 6 /* X.25 async */
  31. #define N_6PACK 7
  32. #define N_MASC 8 /* Reserved for Mobitex module <kaz@cafe.net> */
  33. #define N_R3964 9 /* Reserved for Simatic R3964 module */
  34. #define N_PROFIBUS_FDL 10 /* Reserved for Profibus <Dave@mvhi.com> */
  35. #define N_IRDA 11 /* Linux IrDa - http://irda.sourceforge.net/ */
  36. #define N_SMSBLOCK 12 /* SMS block mode - for talking to GSM data */
  37. /* cards about SMS messages */
  38. #define N_HDLC 13 /* synchronous HDLC */
  39. #define N_SYNC_PPP 14 /* synchronous PPP */
  40. #define N_HCI 15 /* Bluetooth HCI UART */
  41. #define N_GIGASET_M101 16 /* Siemens Gigaset M101 serial DECT adapter */
  42. /*
  43. * This character is the same as _POSIX_VDISABLE: it cannot be used as
  44. * a c_cc[] character, but indicates that a particular special character
  45. * isn't in use (eg VINTR has no character etc)
  46. */
  47. #define __DISABLED_CHAR '\0'
  48. /*
  49. * This is the flip buffer used for the tty driver. The buffer is
  50. * located in the tty structure, and is used as a high speed interface
  51. * between the tty driver and the tty line discipline.
  52. */
  53. #define TTY_FLIPBUF_SIZE 512
  54. struct tty_buffer {
  55. struct tty_buffer *next;
  56. char *char_buf_ptr;
  57. unsigned char *flag_buf_ptr;
  58. int used;
  59. int size;
  60. int commit;
  61. int read;
  62. /* Data points here */
  63. unsigned long data[0];
  64. };
  65. struct tty_bufhead {
  66. struct delayed_work work;
  67. struct semaphore pty_sem;
  68. spinlock_t lock;
  69. struct tty_buffer *head; /* Queue head */
  70. struct tty_buffer *tail; /* Active buffer */
  71. struct tty_buffer *free; /* Free queue head */
  72. int memory_used; /* Buffer space used excluding free queue */
  73. };
  74. /*
  75. * The pty uses char_buf and flag_buf as a contiguous buffer
  76. */
  77. #define PTY_BUF_SIZE 4*TTY_FLIPBUF_SIZE
  78. /*
  79. * When a break, frame error, or parity error happens, these codes are
  80. * stuffed into the flags buffer.
  81. */
  82. #define TTY_NORMAL 0
  83. #define TTY_BREAK 1
  84. #define TTY_FRAME 2
  85. #define TTY_PARITY 3
  86. #define TTY_OVERRUN 4
  87. #define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
  88. #define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
  89. #define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
  90. #define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
  91. #define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
  92. #define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
  93. #define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
  94. #define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
  95. #define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
  96. #define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
  97. #define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
  98. #define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
  99. #define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
  100. #define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
  101. #define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
  102. #define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
  103. #define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
  104. #define _I_FLAG(tty,f) ((tty)->termios->c_iflag & (f))
  105. #define _O_FLAG(tty,f) ((tty)->termios->c_oflag & (f))
  106. #define _C_FLAG(tty,f) ((tty)->termios->c_cflag & (f))
  107. #define _L_FLAG(tty,f) ((tty)->termios->c_lflag & (f))
  108. #define I_IGNBRK(tty) _I_FLAG((tty),IGNBRK)
  109. #define I_BRKINT(tty) _I_FLAG((tty),BRKINT)
  110. #define I_IGNPAR(tty) _I_FLAG((tty),IGNPAR)
  111. #define I_PARMRK(tty) _I_FLAG((tty),PARMRK)
  112. #define I_INPCK(tty) _I_FLAG((tty),INPCK)
  113. #define I_ISTRIP(tty) _I_FLAG((tty),ISTRIP)
  114. #define I_INLCR(tty) _I_FLAG((tty),INLCR)
  115. #define I_IGNCR(tty) _I_FLAG((tty),IGNCR)
  116. #define I_ICRNL(tty) _I_FLAG((tty),ICRNL)
  117. #define I_IUCLC(tty) _I_FLAG((tty),IUCLC)
  118. #define I_IXON(tty) _I_FLAG((tty),IXON)
  119. #define I_IXANY(tty) _I_FLAG((tty),IXANY)
  120. #define I_IXOFF(tty) _I_FLAG((tty),IXOFF)
  121. #define I_IMAXBEL(tty) _I_FLAG((tty),IMAXBEL)
  122. #define I_IUTF8(tty) _I_FLAG((tty),IUTF8)
  123. #define O_OPOST(tty) _O_FLAG((tty),OPOST)
  124. #define O_OLCUC(tty) _O_FLAG((tty),OLCUC)
  125. #define O_ONLCR(tty) _O_FLAG((tty),ONLCR)
  126. #define O_OCRNL(tty) _O_FLAG((tty),OCRNL)
  127. #define O_ONOCR(tty) _O_FLAG((tty),ONOCR)
  128. #define O_ONLRET(tty) _O_FLAG((tty),ONLRET)
  129. #define O_OFILL(tty) _O_FLAG((tty),OFILL)
  130. #define O_OFDEL(tty) _O_FLAG((tty),OFDEL)
  131. #define O_NLDLY(tty) _O_FLAG((tty),NLDLY)
  132. #define O_CRDLY(tty) _O_FLAG((tty),CRDLY)
  133. #define O_TABDLY(tty) _O_FLAG((tty),TABDLY)
  134. #define O_BSDLY(tty) _O_FLAG((tty),BSDLY)
  135. #define O_VTDLY(tty) _O_FLAG((tty),VTDLY)
  136. #define O_FFDLY(tty) _O_FLAG((tty),FFDLY)
  137. #define C_BAUD(tty) _C_FLAG((tty),CBAUD)
  138. #define C_CSIZE(tty) _C_FLAG((tty),CSIZE)
  139. #define C_CSTOPB(tty) _C_FLAG((tty),CSTOPB)
  140. #define C_CREAD(tty) _C_FLAG((tty),CREAD)
  141. #define C_PARENB(tty) _C_FLAG((tty),PARENB)
  142. #define C_PARODD(tty) _C_FLAG((tty),PARODD)
  143. #define C_HUPCL(tty) _C_FLAG((tty),HUPCL)
  144. #define C_CLOCAL(tty) _C_FLAG((tty),CLOCAL)
  145. #define C_CIBAUD(tty) _C_FLAG((tty),CIBAUD)
  146. #define C_CRTSCTS(tty) _C_FLAG((tty),CRTSCTS)
  147. #define L_ISIG(tty) _L_FLAG((tty),ISIG)
  148. #define L_ICANON(tty) _L_FLAG((tty),ICANON)
  149. #define L_XCASE(tty) _L_FLAG((tty),XCASE)
  150. #define L_ECHO(tty) _L_FLAG((tty),ECHO)
  151. #define L_ECHOE(tty) _L_FLAG((tty),ECHOE)
  152. #define L_ECHOK(tty) _L_FLAG((tty),ECHOK)
  153. #define L_ECHONL(tty) _L_FLAG((tty),ECHONL)
  154. #define L_NOFLSH(tty) _L_FLAG((tty),NOFLSH)
  155. #define L_TOSTOP(tty) _L_FLAG((tty),TOSTOP)
  156. #define L_ECHOCTL(tty) _L_FLAG((tty),ECHOCTL)
  157. #define L_ECHOPRT(tty) _L_FLAG((tty),ECHOPRT)
  158. #define L_ECHOKE(tty) _L_FLAG((tty),ECHOKE)
  159. #define L_FLUSHO(tty) _L_FLAG((tty),FLUSHO)
  160. #define L_PENDIN(tty) _L_FLAG((tty),PENDIN)
  161. #define L_IEXTEN(tty) _L_FLAG((tty),IEXTEN)
  162. struct device;
  163. /*
  164. * Where all of the state associated with a tty is kept while the tty
  165. * is open. Since the termios state should be kept even if the tty
  166. * has been closed --- for things like the baud rate, etc --- it is
  167. * not stored here, but rather a pointer to the real state is stored
  168. * here. Possible the winsize structure should have the same
  169. * treatment, but (1) the default 80x24 is usually right and (2) it's
  170. * most often used by a windowing system, which will set the correct
  171. * size each time the window is created or resized anyway.
  172. * - TYT, 9/14/92
  173. */
  174. struct tty_struct {
  175. int magic;
  176. struct tty_driver *driver;
  177. int index;
  178. struct tty_ldisc ldisc;
  179. struct mutex termios_mutex;
  180. struct ktermios *termios, *termios_locked;
  181. char name[64];
  182. struct pid *pgrp;
  183. struct pid *session;
  184. unsigned long flags;
  185. int count;
  186. struct winsize winsize;
  187. unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
  188. unsigned char low_latency:1, warned:1;
  189. unsigned char ctrl_status;
  190. unsigned int receive_room; /* Bytes free for queue */
  191. struct tty_struct *link;
  192. struct fasync_struct *fasync;
  193. struct tty_bufhead buf;
  194. int alt_speed; /* For magic substitution of 38400 bps */
  195. wait_queue_head_t write_wait;
  196. wait_queue_head_t read_wait;
  197. struct work_struct hangup_work;
  198. void *disc_data;
  199. void *driver_data;
  200. struct list_head tty_files;
  201. #define N_TTY_BUF_SIZE 4096
  202. /*
  203. * The following is data for the N_TTY line discipline. For
  204. * historical reasons, this is included in the tty structure.
  205. */
  206. unsigned int column;
  207. unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
  208. unsigned char closing:1;
  209. unsigned short minimum_to_wake;
  210. unsigned long overrun_time;
  211. int num_overrun;
  212. unsigned long process_char_map[256/(8*sizeof(unsigned long))];
  213. char *read_buf;
  214. int read_head;
  215. int read_tail;
  216. int read_cnt;
  217. unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
  218. int canon_data;
  219. unsigned long canon_head;
  220. unsigned int canon_column;
  221. struct mutex atomic_read_lock;
  222. struct mutex atomic_write_lock;
  223. unsigned char *write_buf;
  224. int write_cnt;
  225. spinlock_t read_lock;
  226. /* If the tty has a pending do_SAK, queue it here - akpm */
  227. struct work_struct SAK_work;
  228. };
  229. /* tty magic number */
  230. #define TTY_MAGIC 0x5401
  231. /*
  232. * These bits are used in the flags field of the tty structure.
  233. *
  234. * So that interrupts won't be able to mess up the queues,
  235. * copy_to_cooked must be atomic with respect to itself, as must
  236. * tty->write. Thus, you must use the inline functions set_bit() and
  237. * clear_bit() to make things atomic.
  238. */
  239. #define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
  240. #define TTY_IO_ERROR 1 /* Canse an I/O error (may be no ldisc too) */
  241. #define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
  242. #define TTY_EXCLUSIVE 3 /* Exclusive open mode */
  243. #define TTY_DEBUG 4 /* Debugging */
  244. #define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
  245. #define TTY_PUSH 6 /* n_tty private */
  246. #define TTY_CLOSING 7 /* ->close() in progress */
  247. #define TTY_LDISC 9 /* Line discipline attached */
  248. #define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */
  249. #define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */
  250. #define TTY_PTY_LOCK 16 /* pty private */
  251. #define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
  252. #define TTY_HUPPED 18 /* Post driver->hangup() */
  253. #define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
  254. extern void tty_write_flush(struct tty_struct *);
  255. extern struct ktermios tty_std_termios;
  256. extern int kmsg_redirect;
  257. extern void console_init(void);
  258. extern int vcs_init(void);
  259. extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
  260. const char *routine);
  261. extern char *tty_name(struct tty_struct *tty, char *buf);
  262. extern void tty_wait_until_sent(struct tty_struct * tty, long timeout);
  263. extern int tty_check_change(struct tty_struct * tty);
  264. extern void stop_tty(struct tty_struct * tty);
  265. extern void start_tty(struct tty_struct * tty);
  266. extern int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc);
  267. extern int tty_unregister_ldisc(int disc);
  268. extern int tty_register_driver(struct tty_driver *driver);
  269. extern int tty_unregister_driver(struct tty_driver *driver);
  270. extern struct device *tty_register_device(struct tty_driver *driver,
  271. unsigned index, struct device *dev);
  272. extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
  273. extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
  274. int buflen);
  275. extern void tty_write_message(struct tty_struct *tty, char *msg);
  276. extern int is_current_pgrp_orphaned(void);
  277. extern int is_ignored(int sig);
  278. extern int tty_signal(int sig, struct tty_struct *tty);
  279. extern void tty_hangup(struct tty_struct * tty);
  280. extern void tty_vhangup(struct tty_struct * tty);
  281. extern void tty_unhangup(struct file *filp);
  282. extern int tty_hung_up_p(struct file * filp);
  283. extern void do_SAK(struct tty_struct *tty);
  284. extern void __do_SAK(struct tty_struct *tty);
  285. extern void disassociate_ctty(int priv);
  286. extern void tty_flip_buffer_push(struct tty_struct *tty);
  287. extern speed_t tty_get_baud_rate(struct tty_struct *tty);
  288. extern speed_t tty_termios_baud_rate(struct ktermios *termios);
  289. extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
  290. extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
  291. extern void tty_ldisc_deref(struct tty_ldisc *);
  292. extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
  293. extern struct tty_ldisc *tty_ldisc_get(int);
  294. extern void tty_ldisc_put(int);
  295. extern void tty_wakeup(struct tty_struct *tty);
  296. extern void tty_ldisc_flush(struct tty_struct *tty);
  297. extern int tty_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
  298. unsigned long arg);
  299. extern dev_t tty_devnum(struct tty_struct *tty);
  300. extern void proc_clear_tty(struct task_struct *p);
  301. extern void proc_set_tty(struct task_struct *tsk, struct tty_struct *tty);
  302. extern struct tty_struct *get_current_tty(void);
  303. extern struct mutex tty_mutex;
  304. /* n_tty.c */
  305. extern struct tty_ldisc tty_ldisc_N_TTY;
  306. /* tty_ioctl.c */
  307. extern int n_tty_ioctl(struct tty_struct * tty, struct file * file,
  308. unsigned int cmd, unsigned long arg);
  309. /* serial.c */
  310. extern void serial_console_init(void);
  311. /* pcxx.c */
  312. extern int pcxe_open(struct tty_struct *tty, struct file *filp);
  313. /* printk.c */
  314. extern void console_print(const char *);
  315. /* vt.c */
  316. extern int vt_ioctl(struct tty_struct *tty, struct file * file,
  317. unsigned int cmd, unsigned long arg);
  318. #endif /* __KERNEL__ */
  319. #endif