projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
serial: omap: define helpers for pdata function pointers
[linux-2.6-block.git] / include / linux / tty.h
CommitLineData
1da177e4
LT		 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
1ff454ef 8#define NR_LDISCS 30
4564f9e5
TS		 9
10/* line disciplines */
11#define N_TTY 0
12#define N_SLIP 1
13#define N_MOUSE 2
14#define N_PPP 3
15#define N_STRIP 4
16#define N_AX25 5
17#define N_X25 6 /* X.25 async */
18#define N_6PACK 7
19#define N_MASC 8 /* Reserved for Mobitex module <kaz@cafe.net> */
20#define N_R3964 9 /* Reserved for Simatic R3964 module */
44d1b980 21#define N_PROFIBUS_FDL 10 /* Reserved for Profibus */
4564f9e5
TS		 22#define N_IRDA 11 /* Linux IrDa - http://irda.sourceforge.net/ */
23#define N_SMSBLOCK 12 /* SMS block mode - for talking to GSM data */
24 /* cards about SMS messages */
25#define N_HDLC 13 /* synchronous HDLC */
26#define N_SYNC_PPP 14 /* synchronous PPP */
27#define N_HCI 15 /* Bluetooth HCI UART */
28#define N_GIGASET_M101 16 /* Siemens Gigaset M101 serial DECT adapter */
cd05acfe 29#define N_SLCAN 17 /* Serial / USB serial CAN Adaptors */
348eb12e 30#define N_PPS 18 /* Pulse per Second */
b7b8f9bf 31#define N_V253 19 /* Codec control over voice modem */
9b27105b 32#define N_CAIF 20 /* CAIF protocol for talking to modems */
e1eaea46 33#define N_GSM0710 21 /* GSM 0710 Mux */
65f8e441 34#define N_TI_WL 22 /* for TI's WL BT, FM, GPS combo chips */
ee4f6b4b
F		 35#define N_TRACESINK 23 /* Trace data routing for MIPI P1149.7 */
36#define N_TRACEROUTER 24 /* Trace data routing for MIPI P1149.7 */
78ed73e8 37
ae92c1f5
FF		 38#ifdef __KERNEL__
39#include <linux/fs.h>
40#include <linux/major.h>
41#include <linux/termios.h>
42#include <linux/workqueue.h>
43#include <linux/tty_driver.h>
44#include <linux/tty_ldisc.h>
45#include <linux/mutex.h>
ba3fe7ab 46#include <linux/tty_flags.h>
ae92c1f5 47
ae92c1f5
FF		 48
49
50/*
51 * (Note: the *_driver.minor_start values 1, 64, 128, 192 are
52 * hardcoded at present.)
53 */
54#define NR_UNIX98_PTY_DEFAULT 4096 /* Default maximum for Unix98 ptys */
e9aba515 55#define NR_UNIX98_PTY_RESERVE 1024 /* Default reserve for main devpts */
ae92c1f5
FF		 56#define NR_UNIX98_PTY_MAX (1 << MINORBITS) /* Absolute limit */
57
1da177e4
LT		 58/*
59 * This character is the same as _POSIX_VDISABLE: it cannot be used as
60 * a c_cc[] character, but indicates that a particular special character
61 * isn't in use (eg VINTR has no character etc)
62 */
63#define __DISABLED_CHAR '\0'
64
33f0f88f
AC		 65struct tty_buffer {
66 struct tty_buffer *next;
67 char *char_buf_ptr;
68 unsigned char *flag_buf_ptr;
69 int used;
70 int size;
8977d929
PF		 71 int commit;
72 int read;
33f0f88f
AC		 73 /* Data points here */
74 unsigned long data[0];
75};
76
d9661adf
AC		 77/*
78 * We default to dicing tty buffer allocations to this many characters
352fa6ad
MG		 79 * in order to avoid multiple page allocations. We know the size of
80 * tty_buffer itself but it must also be taken into account that the
81 * the buffer is 256 byte aligned. See tty_buffer_find for the allocation
82 * logic this must match
d9661adf
AC		 83 */
84
352fa6ad 85#define TTY_BUFFER_PAGE (((PAGE_SIZE - sizeof(struct tty_buffer)) / 2) & ~0xFF)
d9661adf
AC		 86
87
33f0f88f 88struct tty_bufhead {
f23eb2b2 89 struct work_struct work;
808249ce 90 spinlock_t lock;
33f0f88f
AC		 91 struct tty_buffer *head; /* Queue head */
92 struct tty_buffer *tail; /* Active buffer */
93 struct tty_buffer *free; /* Free queue head */
7a4d29f4
AC		 94 int memory_used; /* Buffer space used excluding
95 free queue */
1da177e4 96};
1da177e4
LT		 97/*
98 * When a break, frame error, or parity error happens, these codes are
99 * stuffed into the flags buffer.
100 */
101#define TTY_NORMAL 0
102#define TTY_BREAK 1
103#define TTY_FRAME 2
104#define TTY_PARITY 3
105#define TTY_OVERRUN 4
106
adc8d746
AC		 107#define INTR_CHAR(tty) ((tty)->termios.c_cc[VINTR])
108#define QUIT_CHAR(tty) ((tty)->termios.c_cc[VQUIT])
109#define ERASE_CHAR(tty) ((tty)->termios.c_cc[VERASE])
110#define KILL_CHAR(tty) ((tty)->termios.c_cc[VKILL])
111#define EOF_CHAR(tty) ((tty)->termios.c_cc[VEOF])
112#define TIME_CHAR(tty) ((tty)->termios.c_cc[VTIME])
113#define MIN_CHAR(tty) ((tty)->termios.c_cc[VMIN])
114#define SWTC_CHAR(tty) ((tty)->termios.c_cc[VSWTC])
115#define START_CHAR(tty) ((tty)->termios.c_cc[VSTART])
116#define STOP_CHAR(tty) ((tty)->termios.c_cc[VSTOP])
117#define SUSP_CHAR(tty) ((tty)->termios.c_cc[VSUSP])
118#define EOL_CHAR(tty) ((tty)->termios.c_cc[VEOL])
119#define REPRINT_CHAR(tty) ((tty)->termios.c_cc[VREPRINT])
120#define DISCARD_CHAR(tty) ((tty)->termios.c_cc[VDISCARD])
121#define WERASE_CHAR(tty) ((tty)->termios.c_cc[VWERASE])
122#define LNEXT_CHAR(tty) ((tty)->termios.c_cc[VLNEXT])
123#define EOL2_CHAR(tty) ((tty)->termios.c_cc[VEOL2])
1da177e4 124
adc8d746
AC		 125#define _I_FLAG(tty, f) ((tty)->termios.c_iflag & (f))
126#define _O_FLAG(tty, f) ((tty)->termios.c_oflag & (f))
127#define _C_FLAG(tty, f) ((tty)->termios.c_cflag & (f))
128#define _L_FLAG(tty, f) ((tty)->termios.c_lflag & (f))
7a4d29f4
AC		 129
130#define I_IGNBRK(tty) _I_FLAG((tty), IGNBRK)
131#define I_BRKINT(tty) _I_FLAG((tty), BRKINT)
132#define I_IGNPAR(tty) _I_FLAG((tty), IGNPAR)
133#define I_PARMRK(tty) _I_FLAG((tty), PARMRK)
134#define I_INPCK(tty) _I_FLAG((tty), INPCK)
135#define I_ISTRIP(tty) _I_FLAG((tty), ISTRIP)
136#define I_INLCR(tty) _I_FLAG((tty), INLCR)
137#define I_IGNCR(tty) _I_FLAG((tty), IGNCR)
138#define I_ICRNL(tty) _I_FLAG((tty), ICRNL)
139#define I_IUCLC(tty) _I_FLAG((tty), IUCLC)
140#define I_IXON(tty) _I_FLAG((tty), IXON)
141#define I_IXANY(tty) _I_FLAG((tty), IXANY)
142#define I_IXOFF(tty) _I_FLAG((tty), IXOFF)
143#define I_IMAXBEL(tty) _I_FLAG((tty), IMAXBEL)
144#define I_IUTF8(tty) _I_FLAG((tty), IUTF8)
145
146#define O_OPOST(tty) _O_FLAG((tty), OPOST)
147#define O_OLCUC(tty) _O_FLAG((tty), OLCUC)
148#define O_ONLCR(tty) _O_FLAG((tty), ONLCR)
149#define O_OCRNL(tty) _O_FLAG((tty), OCRNL)
150#define O_ONOCR(tty) _O_FLAG((tty), ONOCR)
151#define O_ONLRET(tty) _O_FLAG((tty), ONLRET)
152#define O_OFILL(tty) _O_FLAG((tty), OFILL)
153#define O_OFDEL(tty) _O_FLAG((tty), OFDEL)
154#define O_NLDLY(tty) _O_FLAG((tty), NLDLY)
155#define O_CRDLY(tty) _O_FLAG((tty), CRDLY)
156#define O_TABDLY(tty) _O_FLAG((tty), TABDLY)
157#define O_BSDLY(tty) _O_FLAG((tty), BSDLY)
158#define O_VTDLY(tty) _O_FLAG((tty), VTDLY)
159#define O_FFDLY(tty) _O_FLAG((tty), FFDLY)
160
161#define C_BAUD(tty) _C_FLAG((tty), CBAUD)
162#define C_CSIZE(tty) _C_FLAG((tty), CSIZE)
163#define C_CSTOPB(tty) _C_FLAG((tty), CSTOPB)
164#define C_CREAD(tty) _C_FLAG((tty), CREAD)
165#define C_PARENB(tty) _C_FLAG((tty), PARENB)
166#define C_PARODD(tty) _C_FLAG((tty), PARODD)
167#define C_HUPCL(tty) _C_FLAG((tty), HUPCL)
168#define C_CLOCAL(tty) _C_FLAG((tty), CLOCAL)
169#define C_CIBAUD(tty) _C_FLAG((tty), CIBAUD)
170#define C_CRTSCTS(tty) _C_FLAG((tty), CRTSCTS)
171
172#define L_ISIG(tty) _L_FLAG((tty), ISIG)
173#define L_ICANON(tty) _L_FLAG((tty), ICANON)
174#define L_XCASE(tty) _L_FLAG((tty), XCASE)
175#define L_ECHO(tty) _L_FLAG((tty), ECHO)
176#define L_ECHOE(tty) _L_FLAG((tty), ECHOE)
177#define L_ECHOK(tty) _L_FLAG((tty), ECHOK)
178#define L_ECHONL(tty) _L_FLAG((tty), ECHONL)
179#define L_NOFLSH(tty) _L_FLAG((tty), NOFLSH)
180#define L_TOSTOP(tty) _L_FLAG((tty), TOSTOP)
181#define L_ECHOCTL(tty) _L_FLAG((tty), ECHOCTL)
182#define L_ECHOPRT(tty) _L_FLAG((tty), ECHOPRT)
183#define L_ECHOKE(tty) _L_FLAG((tty), ECHOKE)
184#define L_FLUSHO(tty) _L_FLAG((tty), FLUSHO)
185#define L_PENDIN(tty) _L_FLAG((tty), PENDIN)
186#define L_IEXTEN(tty) _L_FLAG((tty), IEXTEN)
26df6d13 187#define L_EXTPROC(tty) _L_FLAG((tty), EXTPROC)
1da177e4
LT		 188
189struct device;
522ed776 190struct signal_struct;
6f67048c
AC		 191
192/*
193 * Port level information. Each device keeps its own port level information
194 * so provide a common structure for those ports wanting to use common support
195 * routines.
196 *
197 * The tty port has a different lifetime to the tty so must be kept apart.
198 * In addition be careful as tty -> port mappings are valid for the life
199 * of the tty object but in many cases port -> tty mappings are valid only
200 * until a hangup so don't use the wrong path.
201 */
7a4d29f4 202
31f35939
AC		 203struct tty_port;
204
205struct tty_port_operations {
206 /* Return 1 if the carrier is raised */
207 int (*carrier_raised)(struct tty_port *port);
7ca0ff9a 208 /* Control the DTR line */
fcc8ac18 209 void (*dtr_rts)(struct tty_port *port, int raise);
7ca0ff9a 210 /* Called when the last close completes or a hangup finishes
64bc3979
AC		 211 IFF the port was initialized. Do not use to free resources. Called
212 under the port mutex to serialize against activate/shutdowns */
7ca0ff9a
AC		 213 void (*shutdown)(struct tty_port *port);
214 void (*drop)(struct tty_port *port);
64bc3979
AC		 215 /* Called under the port mutex from tty_port_open, serialized using
216 the port mutex */
217 /* FIXME: long term getting the tty argument *out* of this would be
218 good for consoles */
219 int (*activate)(struct tty_port *port, struct tty_struct *tty);
568aafc6
AC		 220 /* Called on the final put of a port */
221 void (*destruct)(struct tty_port *port);
31f35939
AC		 222};
223
6f67048c
AC		 224struct tty_port {
225 struct tty_struct *tty; /* Back pointer */
31f35939 226 const struct tty_port_operations *ops; /* Port operations */
4a90f09b 227 spinlock_t lock; /* Lock protecting tty field */
6f67048c
AC		 228 int blocked_open; /* Waiting to open */
229 int count; /* Usage count */
230 wait_queue_head_t open_wait; /* Open waiters */
231 wait_queue_head_t close_wait; /* Close waiters */
bdc04e31 232 wait_queue_head_t delta_msr_wait; /* Modem status change */
6f67048c 233 unsigned long flags; /* TTY flags ASY_*/
336cee42 234 unsigned char console:1; /* port is a console */
6f67048c 235 struct mutex mutex; /* Locking */
44e4909e 236 struct mutex buf_mutex; /* Buffer alloc lock */
6f67048c 237 unsigned char *xmit_buf; /* Optional buffer */
5e99df56
AC		 238 unsigned int close_delay; /* Close port delay */
239 unsigned int closing_wait; /* Delay for output */
1ec739be
AC		 240 int drain_delay; /* Set to zero if no pure time
241 based drain is needed else
242 set to size of fifo */
568aafc6 243 struct kref kref; /* Ref counter */
6f67048c
AC		 244};
245
1da177e4
LT		 246/*
247 * Where all of the state associated with a tty is kept while the tty
248 * is open. Since the termios state should be kept even if the tty
249 * has been closed --- for things like the baud rate, etc --- it is
250 * not stored here, but rather a pointer to the real state is stored
251 * here. Possible the winsize structure should have the same
252 * treatment, but (1) the default 80x24 is usually right and (2) it's
253 * most often used by a windowing system, which will set the correct
254 * size each time the window is created or resized anyway.
255 * - TYT, 9/14/92
256 */
f34d7a5b
AC		 257
258struct tty_operations;
259
1da177e4
LT		 260struct tty_struct {
261 int magic;
9c9f4ded 262 struct kref kref;
30004ac9 263 struct device *dev;
1da177e4 264 struct tty_driver *driver;
f34d7a5b 265 const struct tty_operations *ops;
1da177e4 266 int index;
c65c9bc3
AC		 267
268 /* Protects ldisc changes: Lock tty not pty */
269 struct mutex ldisc_mutex;
270 struct tty_ldisc *ldisc;
271
89c8d91e 272 struct mutex legacy_mutex;
5785c95b 273 struct mutex termios_mutex;
04f378b1 274 spinlock_t ctrl_lock;
47f86834 275 /* Termios values are protected by the termios mutex */
adc8d746 276 struct ktermios termios, termios_locked;
1d65b4a0 277 struct termiox *termiox; /* May be NULL for unsupported */
1da177e4 278 char name[64];
47f86834 279 struct pid *pgrp; /* Protected by ctrl lock */
ab521dc0 280 struct pid *session;
1da177e4
LT		 281 unsigned long flags;
282 int count;
47f86834 283 struct winsize winsize; /* termios mutex */
1da177e4
LT		 284 unsigned char stopped:1, hw_stopped:1, flow_stopped:1, packet:1;
285 unsigned char low_latency:1, warned:1;
47f86834 286 unsigned char ctrl_status; /* ctrl_lock */
33f0f88f 287 unsigned int receive_room; /* Bytes free for queue */
1da177e4
LT		 288
289 struct tty_struct *link;
290 struct fasync_struct *fasync;
47f86834 291 struct tty_bufhead buf; /* Locked internally */
1da177e4
LT		 292 int alt_speed; /* For magic substitution of 38400 bps */
293 wait_queue_head_t write_wait;
294 wait_queue_head_t read_wait;
295 struct work_struct hangup_work;
296 void *disc_data;
297 void *driver_data;
298 struct list_head tty_files;
299
300#define N_TTY_BUF_SIZE 4096
6f67048c 301
1da177e4
LT		 302 /*
303 * The following is data for the N_TTY line discipline. For
304 * historical reasons, this is included in the tty structure.
47f86834 305 * Mostly locked by the BKL.
1da177e4
LT		 306 */
307 unsigned int column;
308 unsigned char lnext:1, erasing:1, raw:1, real_raw:1, icanon:1;
309 unsigned char closing:1;
a88a69c9 310 unsigned char echo_overrun:1;
1da177e4
LT		 311 unsigned short minimum_to_wake;
312 unsigned long overrun_time;
313 int num_overrun;
314 unsigned long process_char_map[256/(8*sizeof(unsigned long))];
315 char *read_buf;
316 int read_head;
317 int read_tail;
318 int read_cnt;
319 unsigned long read_flags[N_TTY_BUF_SIZE/(8*sizeof(unsigned long))];
a88a69c9
JP		 320 unsigned char *echo_buf;
321 unsigned int echo_pos;
322 unsigned int echo_cnt;
1da177e4
LT		 323 int canon_data;
324 unsigned long canon_head;
325 unsigned int canon_column;
70522e12
IM		 326 struct mutex atomic_read_lock;
327 struct mutex atomic_write_lock;
a88a69c9
JP		 328 struct mutex output_lock;
329 struct mutex echo_lock;
1da177e4
LT		 330 unsigned char *write_buf;
331 int write_cnt;
332 spinlock_t read_lock;
333 /* If the tty has a pending do_SAK, queue it here - akpm */
334 struct work_struct SAK_work;
6f67048c 335 struct tty_port *port;
1da177e4
LT		 336};
337
d996b62a
NP		 338/* Each of a tty's open files has private_data pointing to tty_file_private */
339struct tty_file_private {
340 struct tty_struct *tty;
341 struct file *file;
342 struct list_head list;
343};
344
1da177e4
LT		 345/* tty magic number */
346#define TTY_MAGIC 0x5401
347
348/*
349 * These bits are used in the flags field of the tty structure.
7a4d29f4 350 *
1da177e4
LT		 351 * So that interrupts won't be able to mess up the queues,
352 * copy_to_cooked must be atomic with respect to itself, as must
353 * tty->write. Thus, you must use the inline functions set_bit() and
354 * clear_bit() to make things atomic.
355 */
356#define TTY_THROTTLED 0 /* Call unthrottle() at threshold min */
7a4d29f4 357#define TTY_IO_ERROR 1 /* Cause an I/O error (may be no ldisc too) */
1da177e4
LT		 358#define TTY_OTHER_CLOSED 2 /* Other side (if any) has closed */
359#define TTY_EXCLUSIVE 3 /* Exclusive open mode */
360#define TTY_DEBUG 4 /* Debugging */
361#define TTY_DO_WRITE_WAKEUP 5 /* Call write_wakeup after queuing new */
362#define TTY_PUSH 6 /* n_tty private */
363#define TTY_CLOSING 7 /* ->close() in progress */
1da177e4 364#define TTY_LDISC 9 /* Line discipline attached */
c9b3976e 365#define TTY_LDISC_CHANGING 10 /* Line discipline changing */
c65c9bc3 366#define TTY_LDISC_OPEN 11 /* Line discipline is open */
1da177e4
LT		 367#define TTY_HW_COOK_OUT 14 /* Hardware can do output cooking */
368#define TTY_HW_COOK_IN 15 /* Hardware can do input cooking */
369#define TTY_PTY_LOCK 16 /* pty private */
370#define TTY_NO_WRITE_SPLIT 17 /* Preserve write boundaries to driver */
371#define TTY_HUPPED 18 /* Post driver->hangup() */
42fd552e
AC		 372#define TTY_FLUSHING 19 /* Flushing to ldisc in progress */
373#define TTY_FLUSHPENDING 20 /* Queued buffer flush pending */
acfa747b 374#define TTY_HUPPING 21 /* ->hangup() in progress */
1da177e4
LT		 375
376#define TTY_WRITE_FLUSH(tty) tty_write_flush((tty))
377
378extern void tty_write_flush(struct tty_struct *);
379
edc6afc5 380extern struct ktermios tty_std_termios;
1da177e4 381
1da177e4
LT		 382extern void console_init(void);
383extern int vcs_init(void);
384
d81ed103
AC		 385extern struct class *tty_class;
386
9c9f4ded
AC		 387/**
388 * tty_kref_get - get a tty reference
389 * @tty: tty device
390 *
391 * Return a new reference to a tty object. The caller must hold
392 * sufficient locks/counts to ensure that their existing reference cannot
393 * go away
394 */
395
14bfc987 396static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
9c9f4ded
AC		 397{
398 if (tty)
399 kref_get(&tty->kref);
400 return tty;
401}
402extern void tty_kref_put(struct tty_struct *tty);
403
1da177e4
LT		 404extern int tty_paranoia_check(struct tty_struct *tty, struct inode *inode,
405 const char *routine);
406extern char *tty_name(struct tty_struct *tty, char *buf);
7a4d29f4
AC		 407extern void tty_wait_until_sent(struct tty_struct *tty, long timeout);
408extern int tty_check_change(struct tty_struct *tty);
409extern void stop_tty(struct tty_struct *tty);
410extern void start_tty(struct tty_struct *tty);
1da177e4
LT		 411extern int tty_register_driver(struct tty_driver *driver);
412extern int tty_unregister_driver(struct tty_driver *driver);
01107d34
GKH		 413extern struct device *tty_register_device(struct tty_driver *driver,
414 unsigned index, struct device *dev);
1da177e4
LT		 415extern void tty_unregister_device(struct tty_driver *driver, unsigned index);
416extern int tty_read_raw_data(struct tty_struct *tty, unsigned char *bufp,
417 int buflen);
418extern void tty_write_message(struct tty_struct *tty, char *msg);
f34d7a5b
AC		 419extern int tty_put_char(struct tty_struct *tty, unsigned char c);
420extern int tty_chars_in_buffer(struct tty_struct *tty);
421extern int tty_write_room(struct tty_struct *tty);
422extern void tty_driver_flush_buffer(struct tty_struct *tty);
39c2e60f
AC		 423extern void tty_throttle(struct tty_struct *tty);
424extern void tty_unthrottle(struct tty_struct *tty);
fc6f6238 425extern int tty_do_resize(struct tty_struct *tty, struct winsize *ws);
24d406a6
JS		 426extern void tty_driver_remove_tty(struct tty_driver *driver,
427 struct tty_struct *tty);
feebed65 428extern void tty_free_termios(struct tty_struct *tty);
3e7cd6c4 429extern int is_current_pgrp_orphaned(void);
5d0fdf1e 430extern struct pid *tty_get_pgrp(struct tty_struct *tty);
1da177e4
LT		 431extern int is_ignored(int sig);
432extern int tty_signal(int sig, struct tty_struct *tty);
7a4d29f4
AC		 433extern void tty_hangup(struct tty_struct *tty);
434extern void tty_vhangup(struct tty_struct *tty);
ddcd9fb6 435extern void tty_vhangup_locked(struct tty_struct *tty);
2cb5998b 436extern void tty_vhangup_self(void);
1da177e4 437extern void tty_unhangup(struct file *filp);
7a4d29f4 438extern int tty_hung_up_p(struct file *filp);
1da177e4 439extern void do_SAK(struct tty_struct *tty);
8b6312f4 440extern void __do_SAK(struct tty_struct *tty);
1da177e4 441extern void disassociate_ctty(int priv);
98a27ba4 442extern void no_tty(void);
1da177e4 443extern void tty_flip_buffer_push(struct tty_struct *tty);
e043e42b 444extern void tty_flush_to_ldisc(struct tty_struct *tty);
e0495736
AC		 445extern void tty_buffer_free_all(struct tty_struct *tty);
446extern void tty_buffer_flush(struct tty_struct *tty);
447extern void tty_buffer_init(struct tty_struct *tty);
edc6afc5
AC		 448extern speed_t tty_get_baud_rate(struct tty_struct *tty);
449extern speed_t tty_termios_baud_rate(struct ktermios *termios);
450extern speed_t tty_termios_input_baud_rate(struct ktermios *termios);
7a4d29f4
AC		 451extern void tty_termios_encode_baud_rate(struct ktermios *termios,
452 speed_t ibaud, speed_t obaud);
453extern void tty_encode_baud_rate(struct tty_struct *tty,
454 speed_t ibaud, speed_t obaud);
5f519d72 455extern void tty_termios_copy_hw(struct ktermios *new, struct ktermios *old);
bf5e5834 456extern int tty_termios_hw_change(struct ktermios *a, struct ktermios *b);
8d075b19 457extern int tty_set_termios(struct tty_struct *tty, struct ktermios *kt);
1da177e4
LT		 458
459extern struct tty_ldisc *tty_ldisc_ref(struct tty_struct *);
460extern void tty_ldisc_deref(struct tty_ldisc *);
461extern struct tty_ldisc *tty_ldisc_ref_wait(struct tty_struct *);
c65c9bc3 462extern void tty_ldisc_hangup(struct tty_struct *tty);
a352def2 463extern const struct file_operations tty_ldiscs_proc_fops;
1da177e4
LT		 464
465extern void tty_wakeup(struct tty_struct *tty);
466extern void tty_ldisc_flush(struct tty_struct *tty);
467
04f378b1 468extern long tty_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
0fc00e24
AC		 469extern int tty_mode_ioctl(struct tty_struct *tty, struct file *file,
470 unsigned int cmd, unsigned long arg);
471extern int tty_perform_flush(struct tty_struct *tty, unsigned long arg);
24ec839c
PZ		 472extern dev_t tty_devnum(struct tty_struct *tty);
473extern void proc_clear_tty(struct task_struct *p);
24ec839c 474extern struct tty_struct *get_current_tty(void);
d81ed103 475extern void tty_default_fops(struct file_operations *fops);
bf970ee4 476extern struct tty_struct *alloc_tty_struct(void);
fa90e1c9
JS		 477extern int tty_alloc_file(struct file *file);
478extern void tty_add_file(struct tty_struct *tty, struct file *file);
479extern void tty_free_file(struct file *file);
bf970ee4
AC		 480extern void free_tty_struct(struct tty_struct *tty);
481extern void initialize_tty_struct(struct tty_struct *tty,
482 struct tty_driver *driver, int idx);
6716671d 483extern void deinitialize_tty_struct(struct tty_struct *tty);
593a27c4 484extern struct tty_struct *tty_init_dev(struct tty_driver *driver, int idx);
eeb89d91 485extern int tty_release(struct inode *inode, struct file *filp);
bf970ee4 486extern int tty_init_termios(struct tty_struct *tty);
66d450e8
JS		 487extern int tty_standard_install(struct tty_driver *driver,
488 struct tty_struct *tty);
24ec839c 489
e8b70e7d
AC		 490extern struct tty_struct *tty_pair_get_tty(struct tty_struct *tty);
491extern struct tty_struct *tty_pair_get_pty(struct tty_struct *tty);
492
70522e12 493extern struct mutex tty_mutex;
ee2ffa0d 494extern spinlock_t tty_files_lock;
1da177e4 495
9c1729db
AC		 496extern void tty_write_unlock(struct tty_struct *tty);
497extern int tty_write_lock(struct tty_struct *tty, int ndelay);
498#define tty_is_writelocked(tty) (mutex_is_locked(&tty->atomic_write_lock))
499
6f67048c 500extern void tty_port_init(struct tty_port *port);
2cb4ca02
JS		 501extern void tty_port_link_device(struct tty_port *port,
502 struct tty_driver *driver, unsigned index);
057eb856
JS		 503extern struct device *tty_port_register_device(struct tty_port *port,
504 struct tty_driver *driver, unsigned index,
505 struct device *device);
6f67048c
AC		 506extern int tty_port_alloc_xmit_buf(struct tty_port *port);
507extern void tty_port_free_xmit_buf(struct tty_port *port);
568aafc6
AC		 508extern void tty_port_put(struct tty_port *port);
509
2427b8e3 510static inline struct tty_port *tty_port_get(struct tty_port *port)
568aafc6
AC		 511{
512 if (port)
513 kref_get(&port->kref);
514 return port;
515}
516
4a90f09b
AC		 517extern struct tty_struct *tty_port_tty_get(struct tty_port *port);
518extern void tty_port_tty_set(struct tty_port *port, struct tty_struct *tty);
31f35939 519extern int tty_port_carrier_raised(struct tty_port *port);
5d951fb4 520extern void tty_port_raise_dtr_rts(struct tty_port *port);
fcc8ac18 521extern void tty_port_lower_dtr_rts(struct tty_port *port);
3e61696b 522extern void tty_port_hangup(struct tty_port *port);
36c621d8
AC		 523extern int tty_port_block_til_ready(struct tty_port *port,
524 struct tty_struct *tty, struct file *filp);
a6614999
AC		 525extern int tty_port_close_start(struct tty_port *port,
526 struct tty_struct *tty, struct file *filp);
527extern void tty_port_close_end(struct tty_port *port, struct tty_struct *tty);
7ca0ff9a
AC		 528extern void tty_port_close(struct tty_port *port,
529 struct tty_struct *tty, struct file *filp);
695586ca
JS		 530extern int tty_port_install(struct tty_port *port, struct tty_driver *driver,
531 struct tty_struct *tty);
64bc3979
AC		 532extern int tty_port_open(struct tty_port *port,
533 struct tty_struct *tty, struct file *filp);
2427b8e3 534static inline int tty_port_users(struct tty_port *port)
b58d13a0
AC		 535{
536 return port->count + port->blocked_open;
537}
538
01e1abb2
AC		 539extern int tty_register_ldisc(int disc, struct tty_ldisc_ops *new_ldisc);
540extern int tty_unregister_ldisc(int disc);
541extern int tty_set_ldisc(struct tty_struct *tty, int ldisc);
542extern int tty_ldisc_setup(struct tty_struct *tty, struct tty_struct *o_tty);
543extern void tty_ldisc_release(struct tty_struct *tty, struct tty_struct *o_tty);
544extern void tty_ldisc_init(struct tty_struct *tty);
6716671d 545extern void tty_ldisc_deinit(struct tty_struct *tty);
01e1abb2
AC		 546extern void tty_ldisc_begin(void);
547/* This last one is just for the tty layer internals and shouldn't be used elsewhere */
548extern void tty_ldisc_enable(struct tty_struct *tty);
9c1729db
AC		 549
550
1da177e4 551/* n_tty.c */
a352def2 552extern struct tty_ldisc_ops tty_ldisc_N_TTY;
572b9adb 553extern void n_tty_inherit_ops(struct tty_ldisc_ops *ops);
1da177e4 554
522ed776
MT		 555/* tty_audit.c */
556#ifdef CONFIG_AUDIT
557extern void tty_audit_add_data(struct tty_struct *tty, unsigned char *data,
558 size_t size);
559extern void tty_audit_exit(void);
560extern void tty_audit_fork(struct signal_struct *sig);
1e641743 561extern void tty_audit_tiocsti(struct tty_struct *tty, char ch);
522ed776 562extern void tty_audit_push(struct tty_struct *tty);
3c80fe4a
TG		 563extern int tty_audit_push_task(struct task_struct *tsk,
564 uid_t loginuid, u32 sessionid);
522ed776
MT		 565#else
566static inline void tty_audit_add_data(struct tty_struct *tty,
567 unsigned char *data, size_t size)
568{
569}
1e641743
AV		 570static inline void tty_audit_tiocsti(struct tty_struct *tty, char ch)
571{
572}
522ed776
MT		 573static inline void tty_audit_exit(void)
574{
575}
576static inline void tty_audit_fork(struct signal_struct *sig)
577{
578}
579static inline void tty_audit_push(struct tty_struct *tty)
580{
581}
3c80fe4a
TG		 582static inline int tty_audit_push_task(struct task_struct *tsk,
583 uid_t loginuid, u32 sessionid)
522ed776 584{
3c80fe4a 585 return 0;
522ed776 586}
522ed776
MT		 587#endif
588
31d1d48e
DH		 589/* tty_io.c */
590extern int __init tty_init(void);
591
1da177e4 592/* tty_ioctl.c */
47afa7a5 593extern int n_tty_ioctl_helper(struct tty_struct *tty, struct file *file,
1da177e4 594 unsigned int cmd, unsigned long arg);
8193c429
TM		 595extern long n_tty_compat_ioctl_helper(struct tty_struct *tty, struct file *file,
596 unsigned int cmd, unsigned long arg);
1da177e4
LT		 597
598/* serial.c */
599
600extern void serial_console_init(void);
7a4d29f4 601
1da177e4
LT		 602/* pcxx.c */
603
604extern int pcxe_open(struct tty_struct *tty, struct file *filp);
605
1da177e4
LT		 606/* vt.c */
607
6caa76b7 608extern int vt_ioctl(struct tty_struct *tty,
1da177e4
LT		 609 unsigned int cmd, unsigned long arg);
610
94c2273d 611extern long vt_compat_ioctl(struct tty_struct *tty,
e9216651
AB		 612 unsigned int cmd, unsigned long arg);
613
b07471fa 614/* tty_mutex.c */
ec79d605 615/* functions for preparation of BKL removal */
89c8d91e
AC		 616extern void __lockfunc tty_lock(struct tty_struct *tty);
617extern void __lockfunc tty_unlock(struct tty_struct *tty);
618extern void __lockfunc tty_lock_pair(struct tty_struct *tty,
619 struct tty_struct *tty2);
620extern void __lockfunc tty_unlock_pair(struct tty_struct *tty,
621 struct tty_struct *tty2);
ec79d605 622
a57a7bf3
JS		 623/*
624 * this shall be called only from where BTM is held (like close)
625 *
626 * We need this to ensure nobody waits for us to finish while we are waiting.
627 * Without this we were encountering system stalls.
628 *
629 * This should be indeed removed with BTM removal later.
630 *
631 * Locking: BTM required. Nobody is allowed to hold port->mutex.
632 */
633static inline void tty_wait_until_sent_from_close(struct tty_struct *tty,
634 long timeout)
635{
89c8d91e 636 tty_unlock(tty); /* tty->ops->close holds the BTM, drop it while waiting */
a57a7bf3 637 tty_wait_until_sent(tty, timeout);
89c8d91e 638 tty_lock(tty);
a57a7bf3 639}
ec79d605 640
be1bc288
AB		 641/*
642 * wait_event_interruptible_tty -- wait for a condition with the tty lock held
643 *
644 * The condition we are waiting for might take a long time to
645 * become true, or might depend on another thread taking the
646 * BTM. In either case, we need to drop the BTM to guarantee
647 * forward progress. This is a leftover from the conversion
648 * from the BKL and should eventually get removed as the BTM
649 * falls out of use.
650 *
651 * Do not use in new code.
652 */
89c8d91e 653#define wait_event_interruptible_tty(tty, wq, condition) \
be1bc288
AB		 654({ \
655 int __ret = 0; \
656 if (!(condition)) { \
89c8d91e 657 __wait_event_interruptible_tty(tty, wq, condition, __ret); \
be1bc288
AB		 658 } \
659 __ret; \
660})
661
89c8d91e 662#define __wait_event_interruptible_tty(tty, wq, condition, ret) \
be1bc288
AB		 663do { \
664 DEFINE_WAIT(__wait); \
665 \
666 for (;;) { \
667 prepare_to_wait(&wq, &__wait, TASK_INTERRUPTIBLE); \
668 if (condition) \
669 break; \
670 if (!signal_pending(current)) { \
89c8d91e 671 tty_unlock(tty); \
be1bc288 672 schedule(); \
89c8d91e 673 tty_lock(tty); \
be1bc288
AB		 674 continue; \
675 } \
676 ret = -ERESTARTSYS; \
677 break; \
678 } \
679 finish_wait(&wq, &__wait); \
680} while (0)
681
682
1da177e4
LT		 683#endif /* __KERNEL__ */
684#endif
Linux 6.x block layer and io_uring tree(s)