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