blob: 9deeac85524078f0ef97b140f270c39391509f51 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_TTY_DRIVER_H
2#define _LINUX_TTY_DRIVER_H
3
4/*
5 * This structure defines the interface between the low-level tty
6 * driver and the tty routines. The following routines can be
7 * defined; unless noted otherwise, they are optional, and can be
8 * filled in with a null pointer.
9 *
Alan Cox99f1fe12008-10-13 10:42:00 +010010 * struct tty_struct * (*lookup)(struct tty_driver *self, int idx)
11 *
12 * Return the tty device corresponding to idx, NULL if there is not
13 * one currently in use and an ERR_PTR value on error. Called under
14 * tty_mutex (for now!)
15 *
16 * Optional method. Default behaviour is to use the ttys array
17 *
Alan Cox8b0a88d2008-10-13 10:42:19 +010018 * int (*install)(struct tty_driver *self, struct tty_struct *tty)
19 *
20 * Install a new tty into the tty driver internal tables. Used in
21 * conjunction with lookup and remove methods.
22 *
23 * Optional method. Default behaviour is to use the ttys array
24 *
25 * void (*remove)(struct tty_driver *self, struct tty_struct *tty)
26 *
27 * Remove a closed tty from the tty driver internal tables. Used in
28 * conjunction with lookup and remove methods.
29 *
30 * Optional method. Default behaviour is to use the ttys array
31 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070032 * int (*open)(struct tty_struct * tty, struct file * filp);
33 *
34 * This routine is called when a particular tty device is opened.
35 * This routine is mandatory; if this routine is not filled in,
36 * the attempted open will fail with ENODEV.
Alan Coxf34d7a52008-04-30 00:54:13 -070037 *
38 * Required method.
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 *
40 * void (*close)(struct tty_struct * tty, struct file * filp);
41 *
42 * This routine is called when a particular tty device is closed.
43 *
Alan Coxf34d7a52008-04-30 00:54:13 -070044 * Required method.
45 *
Alan Coxfeebed62008-10-13 10:41:30 +010046 * void (*shutdown)(struct tty_struct * tty);
47 *
Dave Youngf278a2f2009-09-27 16:00:42 +000048 * This routine is called synchronously when a particular tty device
49 * is closed for the last time freeing up the resources.
50 *
51 *
52 * void (*cleanup)(struct tty_struct * tty);
53 *
54 * This routine is called asynchronously when a particular tty device
55 * is closed for the last time freeing up the resources. This is
56 * actually the second part of shutdown for routines that might sleep.
57 *
Alan Coxfeebed62008-10-13 10:41:30 +010058 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 * int (*write)(struct tty_struct * tty,
60 * const unsigned char *buf, int count);
61 *
62 * This routine is called by the kernel to write a series of
63 * characters to the tty device. The characters may come from
64 * user space or kernel space. This routine will return the
Alan Cox36c73432008-06-23 12:06:52 +010065 * number of characters actually accepted for writing.
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 *
Alan Coxf34d7a52008-04-30 00:54:13 -070067 * Optional: Required for writable devices.
68 *
69 * int (*put_char)(struct tty_struct *tty, unsigned char ch);
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 *
71 * This routine is called by the kernel to write a single
72 * character to the tty device. If the kernel uses this routine,
73 * it must call the flush_chars() routine (if defined) when it is
74 * done stuffing characters into the driver. If there is no room
75 * in the queue, the character is ignored.
76 *
Alan Coxf34d7a52008-04-30 00:54:13 -070077 * Optional: Kernel will use the write method if not provided.
78 *
79 * Note: Do not call this function directly, call tty_put_char
80 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 * void (*flush_chars)(struct tty_struct *tty);
82 *
83 * This routine is called by the kernel after it has written a
84 * series of characters to the tty device using put_char().
Alan Coxf34d7a52008-04-30 00:54:13 -070085 *
86 * Optional:
87 *
88 * Note: Do not call this function directly, call tty_driver_flush_chars
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 *
90 * int (*write_room)(struct tty_struct *tty);
91 *
92 * This routine returns the numbers of characters the tty driver
93 * will accept for queuing to be written. This number is subject
94 * to change as output buffers get emptied, or if the output flow
95 * control is acted.
Alan Coxf34d7a52008-04-30 00:54:13 -070096 *
97 * Required if write method is provided else not needed.
98 *
99 * Note: Do not call this function directly, call tty_write_room
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 *
Alan Cox6caa76b2011-02-14 16:27:22 +0000101 * int (*ioctl)(struct tty_struct *tty, unsigned int cmd, unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 *
103 * This routine allows the tty driver to implement
Timur Tabi6ce5b1c2010-12-13 14:08:53 -0600104 * device-specific ioctls. If the ioctl number passed in cmd
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 * is not recognized by the driver, it should return ENOIOCTLCMD.
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700106 *
Alan Coxf34d7a52008-04-30 00:54:13 -0700107 * Optional
108 *
Alan Cox6caa76b2011-02-14 16:27:22 +0000109 * long (*compat_ioctl)(struct tty_struct *tty,,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700110 * unsigned int cmd, unsigned long arg);
111 *
112 * implement ioctl processing for 32 bit process on 64 bit system
Alan Coxf34d7a52008-04-30 00:54:13 -0700113 *
114 * Optional
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 *
Alan Coxedc6afc2006-12-08 02:38:44 -0800116 * void (*set_termios)(struct tty_struct *tty, struct ktermios * old);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 *
118 * This routine allows the tty driver to be notified when
Alan Coxf34d7a52008-04-30 00:54:13 -0700119 * device's termios settings have changed.
120 *
121 * Optional: Called under the termios lock
122 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 *
124 * void (*set_ldisc)(struct tty_struct *tty);
125 *
126 * This routine allows the tty driver to be notified when the
127 * device's termios settings have changed.
Alan Coxf34d7a52008-04-30 00:54:13 -0700128 *
129 * Optional: Called under BKL (currently)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 *
131 * void (*throttle)(struct tty_struct * tty);
132 *
133 * This routine notifies the tty driver that input buffers for
134 * the line discipline are close to full, and it should somehow
135 * signal that no more characters should be sent to the tty.
Alan Cox39c2e602008-04-30 00:54:18 -0700136 *
Alan Cox38db8972009-06-11 12:44:17 +0100137 * Optional: Always invoke via tty_throttle(), called under the
138 * termios lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 *
140 * void (*unthrottle)(struct tty_struct * tty);
141 *
142 * This routine notifies the tty drivers that it should signals
143 * that characters can now be sent to the tty without fear of
144 * overrunning the input buffers of the line disciplines.
145 *
Alan Cox38db8972009-06-11 12:44:17 +0100146 * Optional: Always invoke via tty_unthrottle(), called under the
147 * termios lock.
Alan Cox39c2e602008-04-30 00:54:18 -0700148 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 * void (*stop)(struct tty_struct *tty);
150 *
151 * This routine notifies the tty driver that it should stop
152 * outputting characters to the tty device.
Alan Coxf34d7a52008-04-30 00:54:13 -0700153 *
154 * Optional:
155 *
156 * Note: Call stop_tty not this method.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 *
158 * void (*start)(struct tty_struct *tty);
159 *
160 * This routine notifies the tty driver that it resume sending
161 * characters to the tty device.
Alan Coxf34d7a52008-04-30 00:54:13 -0700162 *
163 * Optional:
164 *
165 * Note: Call start_tty not this method.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 *
167 * void (*hangup)(struct tty_struct *tty);
168 *
Timur Tabi6ce5b1c2010-12-13 14:08:53 -0600169 * This routine notifies the tty driver that it should hang up the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 * tty device.
171 *
Alan Cox36c73432008-06-23 12:06:52 +0100172 * Optional:
Alan Coxf34d7a52008-04-30 00:54:13 -0700173 *
Timur Tabi6ce5b1c2010-12-13 14:08:53 -0600174 * int (*break_ctl)(struct tty_struct *tty, int state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 *
176 * This optional routine requests the tty driver to turn on or
177 * off BREAK status on the RS-232 port. If state is -1,
178 * then the BREAK status should be turned on; if state is 0, then
179 * BREAK should be turned off.
180 *
181 * If this routine is implemented, the high-level tty driver will
182 * handle the following ioctls: TCSBRK, TCSBRKP, TIOCSBRK,
Alan Coxf34d7a52008-04-30 00:54:13 -0700183 * TIOCCBRK.
184 *
Alan Cox9e989662008-07-22 11:18:03 +0100185 * If the driver sets TTY_DRIVER_HARDWARE_BREAK then the interface
186 * will also be called with actual times and the hardware is expected
187 * to do the delay work itself. 0 and -1 are still used for on/off.
188 *
Alan Coxf34d7a52008-04-30 00:54:13 -0700189 * Optional: Required for TCSBRK/BRKP/etc handling.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 *
191 * void (*wait_until_sent)(struct tty_struct *tty, int timeout);
192 *
193 * This routine waits until the device has written out all of the
194 * characters in its transmitter FIFO.
195 *
Alan Coxf34d7a52008-04-30 00:54:13 -0700196 * Optional: If not provided the device is assumed to have no FIFO
197 *
198 * Note: Usually correct to call tty_wait_until_sent
199 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 * void (*send_xchar)(struct tty_struct *tty, char ch);
201 *
202 * This routine is used to send a high-priority XON/XOFF
203 * character to the device.
Alan Coxf34d7a52008-04-30 00:54:13 -0700204 *
205 * Optional: If not provided then the write method is called under
206 * the atomic write lock to keep it serialized with the ldisc.
Alan Cox8c9a9dd2008-08-15 10:39:38 +0100207 *
Alan Coxfc6f6232009-01-02 13:43:17 +0000208 * int (*resize)(struct tty_struct *tty, struct winsize *ws)
Alan Cox8c9a9dd2008-08-15 10:39:38 +0100209 *
210 * Called when a termios request is issued which changes the
211 * requested terminal geometry.
212 *
213 * Optional: the default action is to update the termios structure
214 * without error. This is usually the correct behaviour. Drivers should
215 * not force errors here if they are not resizable objects (eg a serial
216 * line). See tty_do_resize() if you need to wrap the standard method
217 * in your own logic - the usual case.
Alan Cox1d65b4a2008-10-13 10:38:18 +0100218 *
219 * void (*set_termiox)(struct tty_struct *tty, struct termiox *new);
220 *
221 * Called when the device receives a termiox based ioctl. Passes down
222 * the requested data from user space. This method will not be invoked
223 * unless the tty also has a valid tty->termiox pointer.
224 *
225 * Optional: Called under the termios lock
Alan Coxd281da72010-09-16 18:21:24 +0100226 *
227 * int (*get_icount)(struct tty_struct *tty, struct serial_icounter *icount);
228 *
229 * Called when the device receives a TIOCGICOUNT ioctl. Passed a kernel
230 * structure to complete. This method is optional and will only be called
231 * if provided (otherwise EINVAL will be returned).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 */
233
234#include <linux/fs.h>
235#include <linux/list.h>
236#include <linux/cdev.h>
Jiri Slaby3dfbd042010-11-04 16:20:23 +0100237#include <linux/termios.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
239struct tty_struct;
Jason Wesself2d937f2008-04-17 20:05:37 +0200240struct tty_driver;
Alan Coxd281da72010-09-16 18:21:24 +0100241struct serial_icounter_struct;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
243struct tty_operations {
Sukadev Bhattiprolu15f1a632008-10-13 10:42:59 +0100244 struct tty_struct * (*lookup)(struct tty_driver *driver,
245 struct inode *inode, int idx);
Alan Cox8b0a88d2008-10-13 10:42:19 +0100246 int (*install)(struct tty_driver *driver, struct tty_struct *tty);
247 void (*remove)(struct tty_driver *driver, struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 int (*open)(struct tty_struct * tty, struct file * filp);
249 void (*close)(struct tty_struct * tty, struct file * filp);
Alan Coxfeebed62008-10-13 10:41:30 +0100250 void (*shutdown)(struct tty_struct *tty);
Dave Youngf278a2f2009-09-27 16:00:42 +0000251 void (*cleanup)(struct tty_struct *tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 int (*write)(struct tty_struct * tty,
253 const unsigned char *buf, int count);
Alan Coxf34d7a52008-04-30 00:54:13 -0700254 int (*put_char)(struct tty_struct *tty, unsigned char ch);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 void (*flush_chars)(struct tty_struct *tty);
256 int (*write_room)(struct tty_struct *tty);
257 int (*chars_in_buffer)(struct tty_struct *tty);
Alan Cox6caa76b2011-02-14 16:27:22 +0000258 int (*ioctl)(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 unsigned int cmd, unsigned long arg);
Alan Cox6caa76b2011-02-14 16:27:22 +0000260 long (*compat_ioctl)(struct tty_struct *tty,
Paul Fulghume10cc1d2007-05-10 22:22:50 -0700261 unsigned int cmd, unsigned long arg);
Alan Coxedc6afc2006-12-08 02:38:44 -0800262 void (*set_termios)(struct tty_struct *tty, struct ktermios * old);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 void (*throttle)(struct tty_struct * tty);
264 void (*unthrottle)(struct tty_struct * tty);
265 void (*stop)(struct tty_struct *tty);
266 void (*start)(struct tty_struct *tty);
267 void (*hangup)(struct tty_struct *tty);
Alan Cox9e989662008-07-22 11:18:03 +0100268 int (*break_ctl)(struct tty_struct *tty, int state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 void (*flush_buffer)(struct tty_struct *tty);
270 void (*set_ldisc)(struct tty_struct *tty);
271 void (*wait_until_sent)(struct tty_struct *tty, int timeout);
272 void (*send_xchar)(struct tty_struct *tty, char ch);
Alan Cox60b33c12011-02-14 16:26:14 +0000273 int (*tiocmget)(struct tty_struct *tty);
Alan Cox20b9d172011-02-14 16:26:50 +0000274 int (*tiocmset)(struct tty_struct *tty,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 unsigned int set, unsigned int clear);
Alan Coxfc6f6232009-01-02 13:43:17 +0000276 int (*resize)(struct tty_struct *tty, struct winsize *ws);
Alan Cox1d65b4a2008-10-13 10:38:18 +0100277 int (*set_termiox)(struct tty_struct *tty, struct termiox *tnew);
Alan Coxd281da72010-09-16 18:21:24 +0100278 int (*get_icount)(struct tty_struct *tty,
279 struct serial_icounter_struct *icount);
Jason Wesself2d937f2008-04-17 20:05:37 +0200280#ifdef CONFIG_CONSOLE_POLL
281 int (*poll_init)(struct tty_driver *driver, int line, char *options);
282 int (*poll_get_char)(struct tty_driver *driver, int line);
283 void (*poll_put_char)(struct tty_driver *driver, int line, char ch);
284#endif
Alexey Dobriyanae149b62009-03-31 15:19:15 -0700285 const struct file_operations *proc_fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286};
287
288struct tty_driver {
289 int magic; /* magic number for this structure */
Alan Cox7d7b93c2008-10-13 10:42:09 +0100290 struct kref kref; /* Reference management */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 struct cdev cdev;
292 struct module *owner;
293 const char *driver_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 const char *name;
295 int name_base; /* offset of printed name */
296 int major; /* major device number */
297 int minor_start; /* start of minor device number */
298 int minor_num; /* number of *possible* devices */
299 int num; /* number of devices allocated */
300 short type; /* type of tty driver */
301 short subtype; /* subtype of tty driver */
Alan Coxedc6afc2006-12-08 02:38:44 -0800302 struct ktermios init_termios; /* Initial termios */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 int flags; /* tty driver flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 struct proc_dir_entry *proc_entry; /* /proc fs entry */
305 struct tty_driver *other; /* only used for the PTY driver */
306
307 /*
308 * Pointer to the tty data structures
309 */
310 struct tty_struct **ttys;
Alan Coxedc6afc2006-12-08 02:38:44 -0800311 struct ktermios **termios;
312 struct ktermios **termios_locked;
Alan Coxf34d7a52008-04-30 00:54:13 -0700313 void *driver_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Alan Coxf34d7a52008-04-30 00:54:13 -0700315 /*
316 * Driver methods
317 */
318
319 const struct tty_operations *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 struct list_head tty_drivers;
321};
322
323extern struct list_head tty_drivers;
324
Alan Cox7d7b93c2008-10-13 10:42:09 +0100325extern struct tty_driver *alloc_tty_driver(int lines);
326extern void put_tty_driver(struct tty_driver *driver);
327extern void tty_set_operations(struct tty_driver *driver,
Jeff Dikeb68e31d2006-10-02 02:17:18 -0700328 const struct tty_operations *op);
Jason Wesself2d937f2008-04-17 20:05:37 +0200329extern struct tty_driver *tty_find_polling_driver(char *name, int *line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
Alan Cox7d7b93c2008-10-13 10:42:09 +0100331extern void tty_driver_kref_put(struct tty_driver *driver);
Adrian Bunkf786ddd2009-04-07 16:48:07 +0100332
333static inline struct tty_driver *tty_driver_kref_get(struct tty_driver *d)
Alan Cox7d7b93c2008-10-13 10:42:09 +0100334{
335 kref_get(&d->kref);
336 return d;
337}
338
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339/* tty driver magic number */
340#define TTY_DRIVER_MAGIC 0x5402
341
342/*
343 * tty driver flags
344 *
345 * TTY_DRIVER_RESET_TERMIOS --- requests the tty layer to reset the
346 * termios setting when the last process has closed the device.
347 * Used for PTY's, in particular.
348 *
349 * TTY_DRIVER_REAL_RAW --- if set, indicates that the driver will
350 * guarantee never not to set any special character handling
351 * flags if ((IGNBRK || (!BRKINT && !PARMRK)) && (IGNPAR ||
352 * !INPCK)). That is, if there is no reason for the driver to
353 * send notifications of parity and break characters up to the
354 * line driver, it won't do so. This allows the line driver to
355 * optimize for this case if this flag is set. (Note that there
356 * is also a promise, if the above case is true, not to signal
357 * overruns, either.)
358 *
Greg Kroah-Hartman331b8312005-06-20 21:15:16 -0700359 * TTY_DRIVER_DYNAMIC_DEV --- if set, the individual tty devices need
Timur Tabi6ce5b1c2010-12-13 14:08:53 -0600360 * to be registered with a call to tty_register_device() when the
Greg Kroah-Hartman331b8312005-06-20 21:15:16 -0700361 * device is found in the system and unregistered with a call to
362 * tty_unregister_device() so the devices will be show up
363 * properly in sysfs. If not set, driver->num entries will be
364 * created by the tty core in sysfs when tty_register_driver() is
365 * called. This is to be used by drivers that have tty devices
366 * that can appear and disappear while the main tty driver is
367 * registered with the tty core.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 *
369 * TTY_DRIVER_DEVPTS_MEM -- don't use the standard arrays, instead
370 * use dynamic memory keyed through the devpts filesystem. This
371 * is only applicable to the pty driver.
Alan Cox9e989662008-07-22 11:18:03 +0100372 *
373 * TTY_DRIVER_HARDWARE_BREAK -- hardware handles break signals. Pass
374 * the requested timeout to the caller instead of using a simple
375 * on/off interface.
376 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 */
378#define TTY_DRIVER_INSTALLED 0x0001
379#define TTY_DRIVER_RESET_TERMIOS 0x0002
380#define TTY_DRIVER_REAL_RAW 0x0004
Greg Kroah-Hartman331b8312005-06-20 21:15:16 -0700381#define TTY_DRIVER_DYNAMIC_DEV 0x0008
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382#define TTY_DRIVER_DEVPTS_MEM 0x0010
Alan Cox9e989662008-07-22 11:18:03 +0100383#define TTY_DRIVER_HARDWARE_BREAK 0x0020
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
385/* tty driver types */
386#define TTY_DRIVER_TYPE_SYSTEM 0x0001
387#define TTY_DRIVER_TYPE_CONSOLE 0x0002
388#define TTY_DRIVER_TYPE_SERIAL 0x0003
389#define TTY_DRIVER_TYPE_PTY 0x0004
390#define TTY_DRIVER_TYPE_SCC 0x0005 /* scc driver */
391#define TTY_DRIVER_TYPE_SYSCONS 0x0006
392
393/* system subtypes (magic, used by tty_io.c) */
394#define SYSTEM_TYPE_TTY 0x0001
395#define SYSTEM_TYPE_CONSOLE 0x0002
396#define SYSTEM_TYPE_SYSCONS 0x0003
397#define SYSTEM_TYPE_SYSPTMX 0x0004
398
399/* pty subtypes (magic, used by tty_io.c) */
400#define PTY_TYPE_MASTER 0x0001
401#define PTY_TYPE_SLAVE 0x0002
402
403/* serial subtype definitions */
404#define SERIAL_TYPE_NORMAL 1
405
406#endif /* #ifdef _LINUX_TTY_DRIVER_H */