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