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 */
48 #define N_PPS 18 /* Pulse per Second */
50 #define N_V253 19 /* Codec control over voice modem */
53 * This character is the same as _POSIX_VDISABLE: it cannot be used as
54 * a c_cc[] character, but indicates that a particular special character
55 * isn't in use (eg VINTR has no character etc)
57 #define __DISABLED_CHAR '\0'
60 struct tty_buffer *next;
62 unsigned char *flag_buf_ptr;
67 /* Data points here */
68 unsigned long data[0];
72 struct delayed_work work;
74 struct tty_buffer *head; /* Queue head */
75 struct tty_buffer *tail; /* Active buffer */
76 struct tty_buffer *free; /* Free queue head */
77 int memory_used; /* Buffer space used excluding
81 * When a break, frame error, or parity error happens, these codes are
82 * stuffed into the flags buffer.
90 #define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
91 #define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
92 #define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
93 #define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
94 #define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
95 #define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
96 #define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
97 #define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
98 #define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
99 #define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
100 #define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
101 #define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
102 #define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
103 #define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
104 #define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
105 #define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
106 #define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
108 #define _I_FLAG(tty, f) ((tty)->termios->c_iflag & (f))
109 #define _O_FLAG(tty, f) ((tty)->termios->c_oflag & (f))
110 #define _C_FLAG(tty, f) ((tty)->termios->c_cflag & (f))
111 #define _L_FLAG(tty, f) ((tty)->termios->c_lflag & (f))
113 #define I_IGNBRK(tty) _I_FLAG((tty), IGNBRK)
114 #define I_BRKINT(tty) _I_FLAG((tty), BRKINT)
115 #define I_IGNPAR(tty) _I_FLAG((tty), IGNPAR)
116 #define I_PARMRK(tty) _I_FLAG((tty), PARMRK)
117 #define I_INPCK(tty) _I_FLAG((tty), INPCK)
118 #define I_ISTRIP(tty) _I_FLAG((tty), ISTRIP)
119 #define I_INLCR(tty) _I_FLAG((tty), INLCR)
120 #define I_IGNCR(tty) _I_FLAG((tty), IGNCR)
121 #define I_ICRNL(tty) _I_FLAG((tty), ICRNL)
122 #define I_IUCLC(tty) _I_FLAG((tty), IUCLC)
123 #define I_IXON(tty) _I_FLAG((tty), IXON)
124 #define I_IXANY(tty) _I_FLAG((tty), IXANY)
125 #define I_IXOFF(tty) _I_FLAG((tty), IXOFF)
126 #define I_IMAXBEL(tty) _I_FLAG((tty), IMAXBEL)
127 #define I_IUTF8(tty) _I_FLAG((tty), IUTF8)
129 #define O_OPOST(tty) _O_FLAG((tty), OPOST)
130 #define O_OLCUC(tty) _O_FLAG((tty), OLCUC)
131 #define O_ONLCR(tty) _O_FLAG((tty), ONLCR)
132 #define O_OCRNL(tty) _O_FLAG((tty), OCRNL)
133 #define O_ONOCR(tty) _O_FLAG((tty), ONOCR)
134 #define O_ONLRET(tty) _O_FLAG((tty), ONLRET)
135 #define O_OFILL(tty) _O_FLAG((tty), OFILL)
136 #define O_OFDEL(tty) _O_FLAG((tty), OFDEL)
137 #define O_NLDLY(tty) _O_FLAG((tty), NLDLY)
138 #define O_CRDLY(tty) _O_FLAG((tty), CRDLY)
139 #define O_TABDLY(tty) _O_FLAG((tty), TABDLY)
140 #define O_BSDLY(tty) _O_FLAG((tty), BSDLY)
141 #define O_VTDLY(tty) _O_FLAG((tty), VTDLY)
142 #define O_FFDLY(tty) _O_FLAG((tty), FFDLY)
144 #define C_BAUD(tty) _C_FLAG((tty), CBAUD)
145 #define C_CSIZE(tty) _C_FLAG((tty), CSIZE)
146 #define C_CSTOPB(tty) _C_FLAG((tty), CSTOPB)
147 #define C_CREAD(tty) _C_FLAG((tty), CREAD)
148 #define C_PARENB(tty) _C_FLAG((tty), PARENB)
149 #define C_PARODD(tty) _C_FLAG((tty), PARODD)
150 #define C_HUPCL(tty) _C_FLAG((tty), HUPCL)
151 #define C_CLOCAL(tty) _C_FLAG((tty), CLOCAL)
152 #define C_CIBAUD(tty) _C_FLAG((tty), CIBAUD)
153 #define C_CRTSCTS(tty) _C_FLAG((tty), CRTSCTS)
155 #define L_ISIG(tty) _L_FLAG((tty), ISIG)
156 #define L_ICANON(tty) _L_FLAG((tty), ICANON)
157 #define L_XCASE(tty) _L_FLAG((tty), XCASE)
158 #define L_ECHO(tty) _L_FLAG((tty), ECHO)
159 #define L_ECHOE(tty) _L_FLAG((tty), ECHOE)
160 #define L_ECHOK(tty) _L_FLAG((tty), ECHOK)
161 #define L_ECHONL(tty) _L_FLAG((tty), ECHONL)
162 #define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH)
163 #define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP)
164 #define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL)
165 #define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT)
166 #define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE)
167 #define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO)
168 #define L_PENDIN(tty) _L_FLAG((tty), PENDIN)
169 #define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN)
172 struct signal_struct;
175 * Port level information. Each device keeps its own port level information
176 * so provide a common structure for those ports wanting to use common support
179 * The tty port has a different lifetime to the tty so must be kept apart.
180 * In addition be careful as tty -> port mappings are valid for the life
181 * of the tty object but in many cases port -> tty mappings are valid only
182 * until a hangup so don't use the wrong path.
187 struct tty_port_operations {
188 /* Return 1 if the carrier is raised */
189 int (*carrier_raised)(struct tty_port *port);
190 /* Control the DTR line */
191 void (*dtr_rts)(struct tty_port *port, int raise);
192 /* Called when the last close completes or a hangup finishes
193 IFF the port was initialized. Do not use to free resources. Called
194 under the port mutex to serialize against activate/shutdowns */
195 void (*shutdown)(struct tty_port *port);
196 void (*drop)(struct tty_port *port);
197 /* Called under the port mutex from tty_port_open, serialized using
199 /* FIXME: long term getting the tty argument *out* of this would be
201 int (*activate)(struct tty_port *port, struct tty_struct *tty);
202 /* Called on the final put of a port */
203 void (*destruct)(struct tty_port *port);
207 struct tty_struct *tty; /* Back pointer */
208 const struct tty_port_operations *ops; /* Port operations */
209 spinlock_t lock; /* Lock protecting tty field */
210 int blocked_open; /* Waiting to open */
211 int count; /* Usage count */
212 wait_queue_head_t open_wait; /* Open waiters */
213 wait_queue_head_t close_wait; /* Close waiters */
214 wait_queue_head_t delta_msr_wait; /* Modem status change */
215 unsigned long flags; /* TTY flags ASY_*/
216 struct mutex mutex; /* Locking */
217 struct mutex buf_mutex; /* Buffer alloc lock */
218 unsigned char *xmit_buf; /* Optional buffer */
219 unsigned int close_delay; /* Close port delay */
220 unsigned int closing_wait; /* Delay for output */
221 int drain_delay; /* Set to zero if no pure time
222 based drain is needed else
223 set to size of fifo */
224 struct kref kref; /* Ref counter */
228 * Where all of the state associated with a tty is kept while the tty
229 * is open. Since the termios state should be kept even if the tty
230 * has been closed --- for things like the baud rate, etc --- it is
231 * not stored here, but rather a pointer to the real state is stored
232 * here. Possible the winsize structure should have the same
233 * treatment, but (1) the default 80x24 is usually right and (2) it's
234 * most often used by a windowing system, which will set the correct
235 * size each time the window is created or resized anyway.
239 struct tty_operations;
244 struct tty_driver *driver;
245 const struct tty_operations *ops;
248 /* Protects ldisc changes: Lock tty not pty */
249 struct mutex ldisc_mutex;
250 struct tty_ldisc *ldisc;
252 struct mutex termios_mutex;
253 spinlock_t ctrl_lock;
254 /* Termios values are protected by the termios mutex */
255 struct ktermios *termios, *termios_locked;
256 struct termiox *termiox; /* May be NULL for unsupported */
258 struct pid *pgrp; /* Protected by ctrl lock */
262 struct winsize winsize; /* termios mutex */
263 unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
264 unsigned char low_latency:1, warned:1;
265 unsigned char ctrl_status; /* ctrl_lock */
266 unsigned int receive_room; /* Bytes free for queue */
268 struct tty_struct *link;
269 struct fasync_struct *fasync;
270 struct tty_bufhead buf; /* Locked internally */
271 int alt_speed; /* For magic substitution of 38400 bps */
272 wait_queue_head_t write_wait;
273 wait_queue_head_t read_wait;
274 struct work_struct hangup_work;
277 struct list_head tty_files;
279 #define N_TTY_BUF_SIZE 4096
282 * The following is data for the N_TTY line discipline. For
283 * historical reasons, this is included in the tty structure.
284 * Mostly locked by the BKL.
287 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
288 unsigned char closing:1;
289 unsigned char echo_overrun:1;
290 unsigned short minimum_to_wake;
291 unsigned long overrun_time;
293 unsigned long process_char_map[256/(8*sizeof(unsigned long))];
298 unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
299 unsigned char *echo_buf;
300 unsigned int echo_pos;
301 unsigned int echo_cnt;
303 unsigned long canon_head;
304 unsigned int canon_column;
305 struct mutex atomic_read_lock;
306 struct mutex atomic_write_lock;
307 struct mutex output_lock;
308 struct mutex echo_lock;
309 unsigned char *write_buf;
311 spinlock_t read_lock;
312 /* If the tty has a pending do_SAK, queue it here - akpm */
313 struct work_struct SAK_work;
314 struct tty_port *port;
317 /* tty magic number */
318 #define TTY_MAGIC 0x5401
321 * These bits are used in the flags field of the tty structure.
323 * So that interrupts won't be able to mess up the queues,
324 * copy_to_cooked must be atomic with respect to itself, as must
325 * tty->write. Thus, you must use the inline functions set_bit() and
326 * clear_bit() to make things atomic.
328 #define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
329 #define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */
330 #define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
331 #define TTY_EXCLUSIVE 3 /* Exclusive open mode */
332 #define TTY_DEBUG 4 /* Debugging */
333 #define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
334 #define TTY_PUSH 6 /* n_tty private */
335 #define TTY_CLOSING 7 /* ->close() in progress */
336 #define TTY_LDISC 9 /* Line discipline attached */
337 #define TTY_LDISC_CHANGING 10 /* Line discipline changing */
338 #define TTY_LDISC_OPEN 11 /* Line discipline is open */
339 #define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */
340 #define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */
341 #define TTY_PTY_LOCK 16 /* pty private */
342 #define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
343 #define TTY_HUPPED 18 /* Post driver->hangup() */
344 #define TTY_FLUSHING 19 /* Flushing to ldisc in progress */
345 #define TTY_FLUSHPENDING 20 /* Queued buffer flush pending */
347 #define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
349 extern void tty_write_flush(struct tty_struct *);
351 extern struct ktermios tty_std_termios;
353 extern void console_init(void);
354 extern int vcs_init(void);
356 extern struct class *tty_class;
359 * tty_kref_get - get a tty reference
362 * Return a new reference to a tty object. The caller must hold
363 * sufficient locks/counts to ensure that their existing reference cannot
367 static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
370 kref_get(&tty->kref);
373 extern void tty_kref_put(struct tty_struct *tty);
375 extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
376 const char *routine);
377 extern char *tty_name(struct tty_struct *tty, char *buf);
378 extern void tty_wait_until_sent(struct tty_struct *tty, long timeout);
379 extern int tty_check_change(struct tty_struct *tty);
380 extern void stop_tty(struct tty_struct *tty);
381 extern void start_tty(struct tty_struct *tty);
382 extern int tty_register_driver(struct tty_driver *driver);
383 extern int tty_unregister_driver(struct tty_driver *driver);
384 extern struct device *tty_register_device(struct tty_driver *driver,
385 unsigned index, struct device *dev);
386 extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
387 extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
389 extern void tty_write_message(struct tty_struct *tty, char *msg);
390 extern int tty_put_char(struct tty_struct *tty, unsigned char c);
391 extern int tty_chars_in_buffer(struct tty_struct *tty);
392 extern int tty_write_room(struct tty_struct *tty);
393 extern void tty_driver_flush_buffer(struct tty_struct *tty);
394 extern void tty_throttle(struct tty_struct *tty);
395 extern void tty_unthrottle(struct tty_struct *tty);
396 extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
397 extern void tty_shutdown(struct tty_struct *tty);
398 extern void tty_free_termios(struct tty_struct *tty);
399 extern int is_current_pgrp_orphaned(void);
400 extern struct pid *tty_get_pgrp(struct tty_struct *tty);
401 extern int is_ignored(int sig);
402 extern int tty_signal(int sig, struct tty_struct *tty);
403 extern void tty_hangup(struct tty_struct *tty);
404 extern void tty_vhangup(struct tty_struct *tty);
405 extern void tty_vhangup_self(void);
406 extern void tty_unhangup(struct file *filp);
407 extern int tty_hung_up_p(struct file *filp);
408 extern void do_SAK(struct tty_struct *tty);
409 extern void __do_SAK(struct tty_struct *tty);
410 extern void disassociate_ctty(int priv);
411 extern void no_tty(void);
412 extern void tty_flip_buffer_push(struct tty_struct *tty);
413 extern void tty_flush_to_ldisc(struct tty_struct *tty);
414 extern void tty_buffer_free_all(struct tty_struct *tty);
415 extern void tty_buffer_flush(struct tty_struct *tty);
416 extern void tty_buffer_init(struct tty_struct *tty);
417 extern speed_t tty_get_baud_rate(struct tty_struct *tty);
418 extern speed_t tty_termios_baud_rate(struct ktermios *termios);
419 extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
420 extern void tty_termios_encode_baud_rate(struct ktermios *termios,
421 speed_t ibaud, speed_t obaud);
422 extern void tty_encode_baud_rate(struct tty_struct *tty,
423 speed_t ibaud, speed_t obaud);
424 extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
425 extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
427 extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
428 extern void tty_ldisc_deref(struct tty_ldisc *);
429 extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
430 extern void tty_ldisc_hangup(struct tty_struct *tty);
431 extern const struct file_operations tty_ldiscs_proc_fops;
433 extern void tty_wakeup(struct tty_struct *tty);
434 extern void tty_ldisc_flush(struct tty_struct *tty);
436 extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
437 extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
438 unsigned int cmd, unsigned long arg);
439 extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
440 extern dev_t tty_devnum(struct tty_struct *tty);
441 extern void proc_clear_tty(struct task_struct *p);
442 extern struct tty_struct *get_current_tty(void);
443 extern void tty_default_fops(struct file_operations *fops);
444 extern struct tty_struct *alloc_tty_struct(void);
445 extern void free_tty_struct(struct tty_struct *tty);
446 extern void initialize_tty_struct(struct tty_struct *tty,
447 struct tty_driver *driver, int idx);
448 extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx,
450 extern int tty_release(struct inode *inode, struct file *filp);
451 extern int tty_init_termios(struct tty_struct *tty);
453 extern struct tty_struct *tty_pair_get_tty(struct tty_struct *tty);
454 extern struct tty_struct *tty_pair_get_pty(struct tty_struct *tty);
456 extern struct mutex tty_mutex;
458 extern void tty_write_unlock(struct tty_struct *tty);
459 extern int tty_write_lock(struct tty_struct *tty, int ndelay);
460 #define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
462 extern void tty_port_init(struct tty_port *port);
463 extern int tty_port_alloc_xmit_buf(struct tty_port *port);
464 extern void tty_port_free_xmit_buf(struct tty_port *port);
465 extern void tty_port_put(struct tty_port *port);
467 extern inline struct tty_port *tty_port_get(struct tty_port *port)
470 kref_get(&port->kref);
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 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_open(struct tty_port *port,
488 struct tty_struct *tty, struct file *filp);
489 extern inline int tty_port_users(struct tty_port *port)
491 return port->count + port->blocked_open;
494 extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
495 extern int tty_unregister_ldisc(int disc);
496 extern int tty_set_ldisc(struct tty_struct *tty, int ldisc);
497 extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty);
498 extern void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty);
499 extern void tty_ldisc_init(struct tty_struct *tty);
500 extern void tty_ldisc_begin(void);
501 /* This last one is just for the tty layer internals and shouldn't be used elsewhere */
502 extern void tty_ldisc_enable(struct tty_struct *tty);
506 extern struct tty_ldisc_ops tty_ldisc_N_TTY;
510 extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data,
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 void tty_audit_push_task(struct task_struct *tsk,
517 uid_t loginuid, u32 sessionid);
519 static inline void tty_audit_add_data(struct tty_struct *tty,
520 unsigned char *data, size_t size)
523 static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch)
526 static inline void tty_audit_exit(void)
529 static inline void tty_audit_fork(struct signal_struct *sig)
532 static inline void tty_audit_push(struct tty_struct *tty)
535 static inline void tty_audit_push_task(struct task_struct *tsk,
536 uid_t loginuid, u32 sessionid)
542 extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
543 unsigned int cmd, unsigned long arg);
547 extern void serial_console_init(void);
551 extern int pcxe_open(struct tty_struct *tty, struct file *filp);
555 extern int vt_ioctl(struct tty_struct *tty, struct file *file,
556 unsigned int cmd, unsigned long arg);
558 extern long vt_compat_ioctl(struct tty_struct *tty, struct file * file,
559 unsigned int cmd, unsigned long arg);
561 #endif /* __KERNEL__ */