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