Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | #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 Cox | 99f1fe1 | 2008-10-13 10:42:00 +0100 | [diff] [blame] | 10 | * 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 Cox | 8b0a88d | 2008-10-13 10:42:19 +0100 | [diff] [blame] | 18 | * 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 32 | * 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 Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 37 | * |
| 38 | * Required method. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 39 | * |
| 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 Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 44 | * Required method. |
| 45 | * |
Alan Cox | feebed6 | 2008-10-13 10:41:30 +0100 | [diff] [blame] | 46 | * void (*shutdown)(struct tty_struct * tty); |
| 47 | * |
Dave Young | f278a2f | 2009-09-27 16:00:42 +0000 | [diff] [blame] | 48 | * 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 Cox | feebed6 | 2008-10-13 10:41:30 +0100 | [diff] [blame] | 58 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 59 | * 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 Cox | 36c7343 | 2008-06-23 12:06:52 +0100 | [diff] [blame] | 65 | * number of characters actually accepted for writing. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 66 | * |
Alan Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 67 | * Optional: Required for writable devices. |
| 68 | * |
| 69 | * int (*put_char)(struct tty_struct *tty, unsigned char ch); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 70 | * |
| 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 Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 77 | * 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 81 | * 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 Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 85 | * |
| 86 | * Optional: |
| 87 | * |
| 88 | * Note: Do not call this function directly, call tty_driver_flush_chars |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 89 | * |
| 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 Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 96 | * |
| 97 | * Required if write method is provided else not needed. |
| 98 | * |
| 99 | * Note: Do not call this function directly, call tty_write_room |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 100 | * |
| 101 | * int (*ioctl)(struct tty_struct *tty, struct file * file, |
| 102 | * unsigned int cmd, unsigned long arg); |
| 103 | * |
| 104 | * This routine allows the tty driver to implement |
Timur Tabi | 6ce5b1c | 2010-12-13 14:08:53 -0600 | [diff] [blame] | 105 | * device-specific ioctls. If the ioctl number passed in cmd |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 106 | * is not recognized by the driver, it should return ENOIOCTLCMD. |
Paul Fulghum | e10cc1d | 2007-05-10 22:22:50 -0700 | [diff] [blame] | 107 | * |
Alan Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 108 | * Optional |
| 109 | * |
Paul Fulghum | e10cc1d | 2007-05-10 22:22:50 -0700 | [diff] [blame] | 110 | * long (*compat_ioctl)(struct tty_struct *tty, struct file * file, |
| 111 | * unsigned int cmd, unsigned long arg); |
| 112 | * |
| 113 | * implement ioctl processing for 32 bit process on 64 bit system |
Alan Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 114 | * |
| 115 | * Optional |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 116 | * |
Alan Cox | edc6afc | 2006-12-08 02:38:44 -0800 | [diff] [blame] | 117 | * void (*set_termios)(struct tty_struct *tty, struct ktermios * old); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 118 | * |
| 119 | * This routine allows the tty driver to be notified when |
Alan Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 120 | * device's termios settings have changed. |
| 121 | * |
| 122 | * Optional: Called under the termios lock |
| 123 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 124 | * |
| 125 | * void (*set_ldisc)(struct tty_struct *tty); |
| 126 | * |
| 127 | * This routine allows the tty driver to be notified when the |
| 128 | * device's termios settings have changed. |
Alan Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 129 | * |
| 130 | * Optional: Called under BKL (currently) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 131 | * |
| 132 | * void (*throttle)(struct tty_struct * tty); |
| 133 | * |
| 134 | * This routine notifies the tty driver that input buffers for |
| 135 | * the line discipline are close to full, and it should somehow |
| 136 | * signal that no more characters should be sent to the tty. |
Alan Cox | 39c2e60 | 2008-04-30 00:54:18 -0700 | [diff] [blame] | 137 | * |
Alan Cox | 38db897 | 2009-06-11 12:44:17 +0100 | [diff] [blame] | 138 | * Optional: Always invoke via tty_throttle(), called under the |
| 139 | * termios lock. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 140 | * |
| 141 | * void (*unthrottle)(struct tty_struct * tty); |
| 142 | * |
| 143 | * This routine notifies the tty drivers that it should signals |
| 144 | * that characters can now be sent to the tty without fear of |
| 145 | * overrunning the input buffers of the line disciplines. |
| 146 | * |
Alan Cox | 38db897 | 2009-06-11 12:44:17 +0100 | [diff] [blame] | 147 | * Optional: Always invoke via tty_unthrottle(), called under the |
| 148 | * termios lock. |
Alan Cox | 39c2e60 | 2008-04-30 00:54:18 -0700 | [diff] [blame] | 149 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 150 | * void (*stop)(struct tty_struct *tty); |
| 151 | * |
| 152 | * This routine notifies the tty driver that it should stop |
| 153 | * outputting characters to the tty device. |
Alan Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 154 | * |
| 155 | * Optional: |
| 156 | * |
| 157 | * Note: Call stop_tty not this method. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 158 | * |
| 159 | * void (*start)(struct tty_struct *tty); |
| 160 | * |
| 161 | * This routine notifies the tty driver that it resume sending |
| 162 | * characters to the tty device. |
Alan Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 163 | * |
| 164 | * Optional: |
| 165 | * |
| 166 | * Note: Call start_tty not this method. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 167 | * |
| 168 | * void (*hangup)(struct tty_struct *tty); |
| 169 | * |
Timur Tabi | 6ce5b1c | 2010-12-13 14:08:53 -0600 | [diff] [blame] | 170 | * This routine notifies the tty driver that it should hang up the |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 171 | * tty device. |
| 172 | * |
Alan Cox | 36c7343 | 2008-06-23 12:06:52 +0100 | [diff] [blame] | 173 | * Optional: |
Alan Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 174 | * |
Timur Tabi | 6ce5b1c | 2010-12-13 14:08:53 -0600 | [diff] [blame] | 175 | * int (*break_ctl)(struct tty_struct *tty, int state); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 176 | * |
| 177 | * This optional routine requests the tty driver to turn on or |
| 178 | * off BREAK status on the RS-232 port. If state is -1, |
| 179 | * then the BREAK status should be turned on; if state is 0, then |
| 180 | * BREAK should be turned off. |
| 181 | * |
| 182 | * If this routine is implemented, the high-level tty driver will |
| 183 | * handle the following ioctls: TCSBRK, TCSBRKP, TIOCSBRK, |
Alan Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 184 | * TIOCCBRK. |
| 185 | * |
Alan Cox | 9e98966 | 2008-07-22 11:18:03 +0100 | [diff] [blame] | 186 | * If the driver sets TTY_DRIVER_HARDWARE_BREAK then the interface |
| 187 | * will also be called with actual times and the hardware is expected |
| 188 | * to do the delay work itself. 0 and -1 are still used for on/off. |
| 189 | * |
Alan Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 190 | * Optional: Required for TCSBRK/BRKP/etc handling. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 191 | * |
| 192 | * void (*wait_until_sent)(struct tty_struct *tty, int timeout); |
| 193 | * |
| 194 | * This routine waits until the device has written out all of the |
| 195 | * characters in its transmitter FIFO. |
| 196 | * |
Alan Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 197 | * Optional: If not provided the device is assumed to have no FIFO |
| 198 | * |
| 199 | * Note: Usually correct to call tty_wait_until_sent |
| 200 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 201 | * void (*send_xchar)(struct tty_struct *tty, char ch); |
| 202 | * |
| 203 | * This routine is used to send a high-priority XON/XOFF |
| 204 | * character to the device. |
Alan Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 205 | * |
| 206 | * Optional: If not provided then the write method is called under |
| 207 | * the atomic write lock to keep it serialized with the ldisc. |
Alan Cox | 8c9a9dd | 2008-08-15 10:39:38 +0100 | [diff] [blame] | 208 | * |
Alan Cox | fc6f623 | 2009-01-02 13:43:17 +0000 | [diff] [blame] | 209 | * int (*resize)(struct tty_struct *tty, struct winsize *ws) |
Alan Cox | 8c9a9dd | 2008-08-15 10:39:38 +0100 | [diff] [blame] | 210 | * |
| 211 | * Called when a termios request is issued which changes the |
| 212 | * requested terminal geometry. |
| 213 | * |
| 214 | * Optional: the default action is to update the termios structure |
| 215 | * without error. This is usually the correct behaviour. Drivers should |
| 216 | * not force errors here if they are not resizable objects (eg a serial |
| 217 | * line). See tty_do_resize() if you need to wrap the standard method |
| 218 | * in your own logic - the usual case. |
Alan Cox | 1d65b4a | 2008-10-13 10:38:18 +0100 | [diff] [blame] | 219 | * |
| 220 | * void (*set_termiox)(struct tty_struct *tty, struct termiox *new); |
| 221 | * |
| 222 | * Called when the device receives a termiox based ioctl. Passes down |
| 223 | * the requested data from user space. This method will not be invoked |
| 224 | * unless the tty also has a valid tty->termiox pointer. |
| 225 | * |
| 226 | * Optional: Called under the termios lock |
Alan Cox | d281da7 | 2010-09-16 18:21:24 +0100 | [diff] [blame] | 227 | * |
| 228 | * int (*get_icount)(struct tty_struct *tty, struct serial_icounter *icount); |
| 229 | * |
| 230 | * Called when the device receives a TIOCGICOUNT ioctl. Passed a kernel |
| 231 | * structure to complete. This method is optional and will only be called |
| 232 | * if provided (otherwise EINVAL will be returned). |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 233 | */ |
| 234 | |
| 235 | #include <linux/fs.h> |
| 236 | #include <linux/list.h> |
| 237 | #include <linux/cdev.h> |
Jiri Slaby | 3dfbd04 | 2010-11-04 16:20:23 +0100 | [diff] [blame] | 238 | #include <linux/termios.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 239 | |
| 240 | struct tty_struct; |
Jason Wessel | f2d937f | 2008-04-17 20:05:37 +0200 | [diff] [blame] | 241 | struct tty_driver; |
Alan Cox | d281da7 | 2010-09-16 18:21:24 +0100 | [diff] [blame] | 242 | struct serial_icounter_struct; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 243 | |
| 244 | struct tty_operations { |
Sukadev Bhattiprolu | 15f1a63 | 2008-10-13 10:42:59 +0100 | [diff] [blame] | 245 | struct tty_struct * (*lookup)(struct tty_driver *driver, |
| 246 | struct inode *inode, int idx); |
Alan Cox | 8b0a88d | 2008-10-13 10:42:19 +0100 | [diff] [blame] | 247 | int (*install)(struct tty_driver *driver, struct tty_struct *tty); |
| 248 | void (*remove)(struct tty_driver *driver, struct tty_struct *tty); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 249 | int (*open)(struct tty_struct * tty, struct file * filp); |
| 250 | void (*close)(struct tty_struct * tty, struct file * filp); |
Alan Cox | feebed6 | 2008-10-13 10:41:30 +0100 | [diff] [blame] | 251 | void (*shutdown)(struct tty_struct *tty); |
Dave Young | f278a2f | 2009-09-27 16:00:42 +0000 | [diff] [blame] | 252 | void (*cleanup)(struct tty_struct *tty); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 253 | int (*write)(struct tty_struct * tty, |
| 254 | const unsigned char *buf, int count); |
Alan Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 255 | int (*put_char)(struct tty_struct *tty, unsigned char ch); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 256 | void (*flush_chars)(struct tty_struct *tty); |
| 257 | int (*write_room)(struct tty_struct *tty); |
| 258 | int (*chars_in_buffer)(struct tty_struct *tty); |
| 259 | int (*ioctl)(struct tty_struct *tty, struct file * file, |
| 260 | unsigned int cmd, unsigned long arg); |
Paul Fulghum | e10cc1d | 2007-05-10 22:22:50 -0700 | [diff] [blame] | 261 | long (*compat_ioctl)(struct tty_struct *tty, struct file * file, |
| 262 | unsigned int cmd, unsigned long arg); |
Alan Cox | edc6afc | 2006-12-08 02:38:44 -0800 | [diff] [blame] | 263 | void (*set_termios)(struct tty_struct *tty, struct ktermios * old); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 264 | void (*throttle)(struct tty_struct * tty); |
| 265 | void (*unthrottle)(struct tty_struct * tty); |
| 266 | void (*stop)(struct tty_struct *tty); |
| 267 | void (*start)(struct tty_struct *tty); |
| 268 | void (*hangup)(struct tty_struct *tty); |
Alan Cox | 9e98966 | 2008-07-22 11:18:03 +0100 | [diff] [blame] | 269 | int (*break_ctl)(struct tty_struct *tty, int state); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 270 | void (*flush_buffer)(struct tty_struct *tty); |
| 271 | void (*set_ldisc)(struct tty_struct *tty); |
| 272 | void (*wait_until_sent)(struct tty_struct *tty, int timeout); |
| 273 | void (*send_xchar)(struct tty_struct *tty, char ch); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 274 | int (*tiocmget)(struct tty_struct *tty, struct file *file); |
| 275 | int (*tiocmset)(struct tty_struct *tty, struct file *file, |
| 276 | unsigned int set, unsigned int clear); |
Alan Cox | fc6f623 | 2009-01-02 13:43:17 +0000 | [diff] [blame] | 277 | int (*resize)(struct tty_struct *tty, struct winsize *ws); |
Alan Cox | 1d65b4a | 2008-10-13 10:38:18 +0100 | [diff] [blame] | 278 | int (*set_termiox)(struct tty_struct *tty, struct termiox *tnew); |
Alan Cox | d281da7 | 2010-09-16 18:21:24 +0100 | [diff] [blame] | 279 | int (*get_icount)(struct tty_struct *tty, |
| 280 | struct serial_icounter_struct *icount); |
Jason Wessel | f2d937f | 2008-04-17 20:05:37 +0200 | [diff] [blame] | 281 | #ifdef CONFIG_CONSOLE_POLL |
| 282 | int (*poll_init)(struct tty_driver *driver, int line, char *options); |
| 283 | int (*poll_get_char)(struct tty_driver *driver, int line); |
| 284 | void (*poll_put_char)(struct tty_driver *driver, int line, char ch); |
| 285 | #endif |
Alexey Dobriyan | ae149b6 | 2009-03-31 15:19:15 -0700 | [diff] [blame] | 286 | const struct file_operations *proc_fops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 287 | }; |
| 288 | |
| 289 | struct tty_driver { |
| 290 | int magic; /* magic number for this structure */ |
Alan Cox | 7d7b93c | 2008-10-13 10:42:09 +0100 | [diff] [blame] | 291 | struct kref kref; /* Reference management */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 292 | struct cdev cdev; |
| 293 | struct module *owner; |
| 294 | const char *driver_name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 295 | const char *name; |
| 296 | int name_base; /* offset of printed name */ |
| 297 | int major; /* major device number */ |
| 298 | int minor_start; /* start of minor device number */ |
| 299 | int minor_num; /* number of *possible* devices */ |
| 300 | int num; /* number of devices allocated */ |
| 301 | short type; /* type of tty driver */ |
| 302 | short subtype; /* subtype of tty driver */ |
Alan Cox | edc6afc | 2006-12-08 02:38:44 -0800 | [diff] [blame] | 303 | struct ktermios init_termios; /* Initial termios */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 304 | int flags; /* tty driver flags */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 305 | struct proc_dir_entry *proc_entry; /* /proc fs entry */ |
| 306 | struct tty_driver *other; /* only used for the PTY driver */ |
| 307 | |
| 308 | /* |
| 309 | * Pointer to the tty data structures |
| 310 | */ |
| 311 | struct tty_struct **ttys; |
Alan Cox | edc6afc | 2006-12-08 02:38:44 -0800 | [diff] [blame] | 312 | struct ktermios **termios; |
| 313 | struct ktermios **termios_locked; |
Alan Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 314 | void *driver_state; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 315 | |
Alan Cox | f34d7a5 | 2008-04-30 00:54:13 -0700 | [diff] [blame] | 316 | /* |
| 317 | * Driver methods |
| 318 | */ |
| 319 | |
| 320 | const struct tty_operations *ops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 321 | struct list_head tty_drivers; |
| 322 | }; |
| 323 | |
| 324 | extern struct list_head tty_drivers; |
| 325 | |
Alan Cox | 7d7b93c | 2008-10-13 10:42:09 +0100 | [diff] [blame] | 326 | extern struct tty_driver *alloc_tty_driver(int lines); |
| 327 | extern void put_tty_driver(struct tty_driver *driver); |
| 328 | extern void tty_set_operations(struct tty_driver *driver, |
Jeff Dike | b68e31d | 2006-10-02 02:17:18 -0700 | [diff] [blame] | 329 | const struct tty_operations *op); |
Jason Wessel | f2d937f | 2008-04-17 20:05:37 +0200 | [diff] [blame] | 330 | extern struct tty_driver *tty_find_polling_driver(char *name, int *line); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 331 | |
Alan Cox | 7d7b93c | 2008-10-13 10:42:09 +0100 | [diff] [blame] | 332 | extern void tty_driver_kref_put(struct tty_driver *driver); |
Adrian Bunk | f786ddd | 2009-04-07 16:48:07 +0100 | [diff] [blame] | 333 | |
| 334 | static inline struct tty_driver *tty_driver_kref_get(struct tty_driver *d) |
Alan Cox | 7d7b93c | 2008-10-13 10:42:09 +0100 | [diff] [blame] | 335 | { |
| 336 | kref_get(&d->kref); |
| 337 | return d; |
| 338 | } |
| 339 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 340 | /* tty driver magic number */ |
| 341 | #define TTY_DRIVER_MAGIC 0x5402 |
| 342 | |
| 343 | /* |
| 344 | * tty driver flags |
| 345 | * |
| 346 | * TTY_DRIVER_RESET_TERMIOS --- requests the tty layer to reset the |
| 347 | * termios setting when the last process has closed the device. |
| 348 | * Used for PTY's, in particular. |
| 349 | * |
| 350 | * TTY_DRIVER_REAL_RAW --- if set, indicates that the driver will |
| 351 | * guarantee never not to set any special character handling |
| 352 | * flags if ((IGNBRK || (!BRKINT && !PARMRK)) && (IGNPAR || |
| 353 | * !INPCK)). That is, if there is no reason for the driver to |
| 354 | * send notifications of parity and break characters up to the |
| 355 | * line driver, it won't do so. This allows the line driver to |
| 356 | * optimize for this case if this flag is set. (Note that there |
| 357 | * is also a promise, if the above case is true, not to signal |
| 358 | * overruns, either.) |
| 359 | * |
Greg Kroah-Hartman | 331b831 | 2005-06-20 21:15:16 -0700 | [diff] [blame] | 360 | * TTY_DRIVER_DYNAMIC_DEV --- if set, the individual tty devices need |
Timur Tabi | 6ce5b1c | 2010-12-13 14:08:53 -0600 | [diff] [blame] | 361 | * to be registered with a call to tty_register_device() when the |
Greg Kroah-Hartman | 331b831 | 2005-06-20 21:15:16 -0700 | [diff] [blame] | 362 | * device is found in the system and unregistered with a call to |
| 363 | * tty_unregister_device() so the devices will be show up |
| 364 | * properly in sysfs. If not set, driver->num entries will be |
| 365 | * created by the tty core in sysfs when tty_register_driver() is |
| 366 | * called. This is to be used by drivers that have tty devices |
| 367 | * that can appear and disappear while the main tty driver is |
| 368 | * registered with the tty core. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 369 | * |
| 370 | * TTY_DRIVER_DEVPTS_MEM -- don't use the standard arrays, instead |
| 371 | * use dynamic memory keyed through the devpts filesystem. This |
| 372 | * is only applicable to the pty driver. |
Alan Cox | 9e98966 | 2008-07-22 11:18:03 +0100 | [diff] [blame] | 373 | * |
| 374 | * TTY_DRIVER_HARDWARE_BREAK -- hardware handles break signals. Pass |
| 375 | * the requested timeout to the caller instead of using a simple |
| 376 | * on/off interface. |
| 377 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 378 | */ |
| 379 | #define TTY_DRIVER_INSTALLED 0x0001 |
| 380 | #define TTY_DRIVER_RESET_TERMIOS 0x0002 |
| 381 | #define TTY_DRIVER_REAL_RAW 0x0004 |
Greg Kroah-Hartman | 331b831 | 2005-06-20 21:15:16 -0700 | [diff] [blame] | 382 | #define TTY_DRIVER_DYNAMIC_DEV 0x0008 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 383 | #define TTY_DRIVER_DEVPTS_MEM 0x0010 |
Alan Cox | 9e98966 | 2008-07-22 11:18:03 +0100 | [diff] [blame] | 384 | #define TTY_DRIVER_HARDWARE_BREAK 0x0020 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 385 | |
| 386 | /* tty driver types */ |
| 387 | #define TTY_DRIVER_TYPE_SYSTEM 0x0001 |
| 388 | #define TTY_DRIVER_TYPE_CONSOLE 0x0002 |
| 389 | #define TTY_DRIVER_TYPE_SERIAL 0x0003 |
| 390 | #define TTY_DRIVER_TYPE_PTY 0x0004 |
| 391 | #define TTY_DRIVER_TYPE_SCC 0x0005 /* scc driver */ |
| 392 | #define TTY_DRIVER_TYPE_SYSCONS 0x0006 |
| 393 | |
| 394 | /* system subtypes (magic, used by tty_io.c) */ |
| 395 | #define SYSTEM_TYPE_TTY 0x0001 |
| 396 | #define SYSTEM_TYPE_CONSOLE 0x0002 |
| 397 | #define SYSTEM_TYPE_SYSCONS 0x0003 |
| 398 | #define SYSTEM_TYPE_SYSPTMX 0x0004 |
| 399 | |
| 400 | /* pty subtypes (magic, used by tty_io.c) */ |
| 401 | #define PTY_TYPE_MASTER 0x0001 |
| 402 | #define PTY_TYPE_SLAVE 0x0002 |
| 403 | |
| 404 | /* serial subtype definitions */ |
| 405 | #define SERIAL_TYPE_NORMAL 1 |
| 406 | |
| 407 | #endif /* #ifdef _LINUX_TTY_DRIVER_H */ |