Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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 18
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 <Dave@mvhi.com> */
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
49/*
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)
53 */
54#define __DISABLED_CHAR '\0'
55
56/*
57 * This is the flip buffer used for the tty driver. The buffer is
58 * located in the tty structure, and is used as a high speed interface
59 * between the tty driver and the tty line discipline.
60 */
61#define TTY_FLIPBUF_SIZE 512
62
63struct tty_buffer {
64 struct tty_buffer *next;
65 char *char_buf_ptr;
66 unsigned char *flag_buf_ptr;
67 int used;
68 int size;
69 int commit;
70 int read;
71 /* Data points here */
72 unsigned long data[0];
73};
74
75struct tty_bufhead {
76 struct delayed_work work;
77 struct semaphore pty_sem;
78 spinlock_t lock;
79 struct tty_buffer *head; /* Queue head */
80 struct tty_buffer *tail; /* Active buffer */
81 struct tty_buffer *free; /* Free queue head */
82 int memory_used; /* Buffer space used excluding free queue */
83};
84/*
85 * When a break, frame error, or parity error happens, these codes are
86 * stuffed into the flags buffer.
87 */
88#define TTY_NORMAL 0
89#define TTY_BREAK 1
90#define TTY_FRAME 2
91#define TTY_PARITY 3
92#define TTY_OVERRUN 4
93
94#define INTR_CHAR(tty) ((tty)->termios->c_cc[VINTR])
95#define QUIT_CHAR(tty) ((tty)->termios->c_cc[VQUIT])
96#define ERASE_CHAR(tty) ((tty)->termios->c_cc[VERASE])
97#define KILL_CHAR(tty) ((tty)->termios->c_cc[VKILL])
98#define EOF_CHAR(tty) ((tty)->termios->c_cc[VEOF])
99#define TIME_CHAR(tty) ((tty)->termios->c_cc[VTIME])
100#define MIN_CHAR(tty) ((tty)->termios->c_cc[VMIN])
101#define SWTC_CHAR(tty) ((tty)->termios->c_cc[VSWTC])
102#define START_CHAR(tty) ((tty)->termios->c_cc[VSTART])
103#define STOP_CHAR(tty) ((tty)->termios->c_cc[VSTOP])
104#define SUSP_CHAR(tty) ((tty)->termios->c_cc[VSUSP])
105#define EOL_CHAR(tty) ((tty)->termios->c_cc[VEOL])
106#define REPRINT_CHAR(tty) ((tty)->termios->c_cc[VREPRINT])
107#define DISCARD_CHAR(tty) ((tty)->termios->c_cc[VDISCARD])
108#define WERASE_CHAR(tty) ((tty)->termios->c_cc[VWERASE])
109#define LNEXT_CHAR(tty) ((tty)->termios->c_cc[VLNEXT])
110#define EOL2_CHAR(tty) ((tty)->termios->c_cc[VEOL2])
111
112#define _I_FLAG(tty,f) ((tty)->termios->c_iflag & (f))
113#define _O_FLAG(tty,f) ((tty)->termios->c_oflag & (f))
114#define _C_FLAG(tty,f) ((tty)->termios->c_cflag & (f))
115#define _L_FLAG(tty,f) ((tty)->termios->c_lflag & (f))
116
117#define I_IGNBRK(tty) _I_FLAG((tty),IGNBRK)
118#define I_BRKINT(tty) _I_FLAG((tty),BRKINT)
119#define I_IGNPAR(tty) _I_FLAG((tty),IGNPAR)
120#define I_PARMRK(tty) _I_FLAG((tty),PARMRK)
121#define I_INPCK(tty) _I_FLAG((tty),INPCK)
122#define I_ISTRIP(tty) _I_FLAG((tty),ISTRIP)
123#define I_INLCR(tty) _I_FLAG((tty),INLCR)
124#define I_IGNCR(tty) _I_FLAG((tty),IGNCR)
125#define I_ICRNL(tty) _I_FLAG((tty),ICRNL)
126#define I_IUCLC(tty) _I_FLAG((tty),IUCLC)
127#define I_IXON(tty) _I_FLAG((tty),IXON)
128#define I_IXANY(tty) _I_FLAG((tty),IXANY)
129#define I_IXOFF(tty) _I_FLAG((tty),IXOFF)
130#define I_IMAXBEL(tty) _I_FLAG((tty),IMAXBEL)
131#define I_IUTF8(tty) _I_FLAG((tty),IUTF8)
132
133#define O_OPOST(tty) _O_FLAG((tty),OPOST)
134#define O_OLCUC(tty) _O_FLAG((tty),OLCUC)
135#define O_ONLCR(tty) _O_FLAG((tty),ONLCR)
136#define O_OCRNL(tty) _O_FLAG((tty),OCRNL)
137#define O_ONOCR(tty) _O_FLAG((tty),ONOCR)
138#define O_ONLRET(tty) _O_FLAG((tty),ONLRET)
139#define O_OFILL(tty) _O_FLAG((tty),OFILL)
140#define O_OFDEL(tty) _O_FLAG((tty),OFDEL)
141#define O_NLDLY(tty) _O_FLAG((tty),NLDLY)
142#define O_CRDLY(tty) _O_FLAG((tty),CRDLY)
143#define O_TABDLY(tty) _O_FLAG((tty),TABDLY)
144#define O_BSDLY(tty) _O_FLAG((tty),BSDLY)
145#define O_VTDLY(tty) _O_FLAG((tty),VTDLY)
146#define O_FFDLY(tty) _O_FLAG((tty),FFDLY)
147
148#define C_BAUD(tty) _C_FLAG((tty),CBAUD)
149#define C_CSIZE(tty) _C_FLAG((tty),CSIZE)
150#define C_CSTOPB(tty) _C_FLAG((tty),CSTOPB)
151#define C_CREAD(tty) _C_FLAG((tty),CREAD)
152#define C_PARENB(tty) _C_FLAG((tty),PARENB)
153#define C_PARODD(tty) _C_FLAG((tty),PARODD)
154#define C_HUPCL(tty) _C_FLAG((tty),HUPCL)
155#define C_CLOCAL(tty) _C_FLAG((tty),CLOCAL)
156#define C_CIBAUD(tty) _C_FLAG((tty),CIBAUD)
157#define C_CRTSCTS(tty) _C_FLAG((tty),CRTSCTS)
158
159#define L_ISIG(tty) _L_FLAG((tty),ISIG)
160#define L_ICANON(tty) _L_FLAG((tty),ICANON)
161#define L_XCASE(tty) _L_FLAG((tty),XCASE)
162#define L_ECHO(tty) _L_FLAG((tty),ECHO)
163#define L_ECHOE(tty) _L_FLAG((tty),ECHOE)
164#define L_ECHOK(tty) _L_FLAG((tty),ECHOK)
165#define L_ECHONL(tty) _L_FLAG((tty),ECHONL)
166#define L_NOFLSH(tty) _L_FLAG((tty),NOFLSH)
167#define L_TOSTOP(tty) _L_FLAG((tty),TOSTOP)
168#define L_ECHOCTL(tty) _L_FLAG((tty),ECHOCTL)
169#define L_ECHOPRT(tty) _L_FLAG((tty),ECHOPRT)
170#define L_ECHOKE(tty) _L_FLAG((tty),ECHOKE)
171#define L_FLUSHO(tty) _L_FLAG((tty),FLUSHO)
172#define L_PENDIN(tty) _L_FLAG((tty),PENDIN)
173#define L_IEXTEN(tty) _L_FLAG((tty),IEXTEN)
174
175struct device;
176struct signal_struct;
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 */
188struct tty_struct {
189 int magic;
190 struct tty_driver *driver;
191 int index;
192 struct tty_ldisc ldisc;
193 struct mutex termios_mutex;
194 struct ktermios *termios, *termios_locked;
195 char name[64];
196 struct pid *pgrp;
197 struct pid *session;
198 unsigned long flags;
199 int count;
200 struct winsize winsize;
201 unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
202 unsigned char low_latency:1, warned:1;
203 unsigned char ctrl_status;
204 unsigned int receive_room; /* Bytes free for queue */
205
206 struct tty_struct *link;
207 struct fasync_struct *fasync;
208 struct tty_bufhead buf;
209 int alt_speed; /* For magic substitution of 38400 bps */
210 wait_queue_head_t write_wait;
211 wait_queue_head_t read_wait;
212 struct work_struct hangup_work;
213 void *disc_data;
214 void *driver_data;
215 struct list_head tty_files;
216
217#define N_TTY_BUF_SIZE 4096
218
219 /*
220 * The following is data for the N_TTY line discipline. For
221 * historical reasons, this is included in the tty structure.
222 */
223 unsigned int column;
224 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
225 unsigned char closing:1;
226 unsigned short minimum_to_wake;
227 unsigned long overrun_time;
228 int num_overrun;
229 unsigned long process_char_map[256/(8*sizeof(unsigned long))];
230 char *read_buf;
231 int read_head;
232 int read_tail;
233 int read_cnt;
234 unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
235 int canon_data;
236 unsigned long canon_head;
237 unsigned int canon_column;
238 struct mutex atomic_read_lock;
239 struct mutex atomic_write_lock;
240 unsigned char *write_buf;
241 int write_cnt;
242 spinlock_t read_lock;
243 /* If the tty has a pending do_SAK, queue it here - akpm */
244 struct work_struct SAK_work;
245};
246
247/* tty magic number */
248#define TTY_MAGIC 0x5401
249
250/*
251 * These bits are used in the flags field of the tty structure.
252 *
253 * So that interrupts won't be able to mess up the queues,
254 * copy_to_cooked must be atomic with respect to itself, as must
255 * tty->write. Thus, you must use the inline functions set_bit() and
256 * clear_bit() to make things atomic.
257 */
258#define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
259#define TTY_IO_ERROR 1 /* Canse an I/O error (may be no ldisc too) */
260#define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
261#define TTY_EXCLUSIVE 3 /* Exclusive open mode */
262#define TTY_DEBUG 4 /* Debugging */
263#define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
264#define TTY_PUSH 6 /* n_tty private */
265#define TTY_CLOSING 7 /* ->close() in progress */
266#define TTY_LDISC 9 /* Line discipline attached */
267#define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */
268#define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */
269#define TTY_PTY_LOCK 16 /* pty private */
270#define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
271#define TTY_HUPPED 18 /* Post driver->hangup() */
272#define TTY_FLUSHING 19 /* Flushing to ldisc in progress */
273#define TTY_FLUSHPENDING 20 /* Queued buffer flush pending */
274
275#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
276
277extern void tty_write_flush(struct tty_struct *);
278
279extern struct ktermios tty_std_termios;
280
281extern int kmsg_redirect;
282
283extern void console_init(void);
284extern int vcs_init(void);
285
286extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
287 const char *routine);
288extern char *tty_name(struct tty_struct *tty, char *buf);
289extern void tty_wait_until_sent(struct tty_struct * tty, long timeout);
290extern int tty_check_change(struct tty_struct * tty);
291extern void stop_tty(struct tty_struct * tty);
292extern void start_tty(struct tty_struct * tty);
293extern int tty_register_ldisc(int disc, struct tty_ldisc *new_ldisc);
294extern int tty_unregister_ldisc(int disc);
295extern int tty_register_driver(struct tty_driver *driver);
296extern int tty_unregister_driver(struct tty_driver *driver);
297extern struct device *tty_register_device(struct tty_driver *driver,
298 unsigned index, struct device *dev);
299extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
300extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
301 int buflen);
302extern void tty_write_message(struct tty_struct *tty, char *msg);
303
304extern int is_current_pgrp_orphaned(void);
305extern int is_ignored(int sig);
306extern int tty_signal(int sig, struct tty_struct *tty);
307extern void tty_hangup(struct tty_struct * tty);
308extern void tty_vhangup(struct tty_struct * tty);
309extern void tty_unhangup(struct file *filp);
310extern int tty_hung_up_p(struct file * filp);
311extern int is_tty(struct file *filp);
312extern void do_SAK(struct tty_struct *tty);
313extern void __do_SAK(struct tty_struct *tty);
314extern void disassociate_ctty(int priv);
315extern void no_tty(void);
316extern void tty_flip_buffer_push(struct tty_struct *tty);
317extern speed_t tty_get_baud_rate(struct tty_struct *tty);
318extern speed_t tty_termios_baud_rate(struct ktermios *termios);
319extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
320extern void tty_termios_encode_baud_rate(struct ktermios *termios, speed_t ibaud, speed_t obaud);
321extern void tty_encode_baud_rate(struct tty_struct *tty, speed_t ibaud, speed_t obaud);
322extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
323extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
324
325extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
326extern void tty_ldisc_deref(struct tty_ldisc *);
327extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
328
329extern struct tty_ldisc *tty_ldisc_get(int);
330extern void tty_ldisc_put(int);
331
332extern void tty_wakeup(struct tty_struct *tty);
333extern void tty_ldisc_flush(struct tty_struct *tty);
334
335extern int tty_ioctl(struct inode *inode, struct file *file, unsigned int cmd,
336 unsigned long arg);
337extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
338 unsigned int cmd, unsigned long arg);
339extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
340extern dev_t tty_devnum(struct tty_struct *tty);
341extern void proc_clear_tty(struct task_struct *p);
342extern struct tty_struct *get_current_tty(void);
343
344extern struct mutex tty_mutex;
345
346extern void tty_write_unlock(struct tty_struct *tty);
347extern int tty_write_lock(struct tty_struct *tty, int ndelay);
348#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
349
350
351
352/* n_tty.c */
353extern struct tty_ldisc tty_ldisc_N_TTY;
354
355/* tty_audit.c */
356#ifdef CONFIG_AUDIT
357extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data,
358 size_t size);
359extern void tty_audit_exit(void);
360extern void tty_audit_fork(struct signal_struct *sig);
361extern void tty_audit_push(struct tty_struct *tty);
362extern void tty_audit_push_task(struct task_struct *tsk, uid_t loginuid);
363extern void tty_audit_opening(void);
364#else
365static inline void tty_audit_add_data(struct tty_struct *tty,
366 unsigned char *data, size_t size)
367{
368}
369static inline void tty_audit_exit(void)
370{
371}
372static inline void tty_audit_fork(struct signal_struct *sig)
373{
374}
375static inline void tty_audit_push(struct tty_struct *tty)
376{
377}
378static inline void tty_audit_push_task(struct task_struct *tsk, uid_t loginuid)
379{
380}
381static inline void tty_audit_opening(void)
382{
383}
384#endif
385
386/* tty_ioctl.c */
387extern int n_tty_ioctl(struct tty_struct * tty, struct file * file,
388 unsigned int cmd, unsigned long arg);
389
390/* serial.c */
391
392extern void serial_console_init(void);
393
394/* pcxx.c */
395
396extern int pcxe_open(struct tty_struct *tty, struct file *filp);
397
398/* printk.c */
399
400extern void console_print(const char *);
401
402/* vt.c */
403
404extern int vt_ioctl(struct tty_struct *tty, struct file * file,
405 unsigned int cmd, unsigned long arg);
406
407#endif /* __KERNEL__ */
408#endif