Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | * | |
10 | * int (*open)(struct tty_struct * tty, struct file * filp); | |
11 | * | |
12 | * This routine is called when a particular tty device is opened. | |
13 | * This routine is mandatory; if this routine is not filled in, | |
14 | * the attempted open will fail with ENODEV. | |
15 | * | |
16 | * void (*close)(struct tty_struct * tty, struct file * filp); | |
17 | * | |
18 | * This routine is called when a particular tty device is closed. | |
19 | * | |
20 | * int (*write)(struct tty_struct * tty, | |
21 | * const unsigned char *buf, int count); | |
22 | * | |
23 | * This routine is called by the kernel to write a series of | |
24 | * characters to the tty device. The characters may come from | |
25 | * user space or kernel space. This routine will return the | |
26 | * number of characters actually accepted for writing. This | |
27 | * routine is mandatory. | |
28 | * | |
29 | * void (*put_char)(struct tty_struct *tty, unsigned char ch); | |
30 | * | |
31 | * This routine is called by the kernel to write a single | |
32 | * character to the tty device. If the kernel uses this routine, | |
33 | * it must call the flush_chars() routine (if defined) when it is | |
34 | * done stuffing characters into the driver. If there is no room | |
35 | * in the queue, the character is ignored. | |
36 | * | |
37 | * void (*flush_chars)(struct tty_struct *tty); | |
38 | * | |
39 | * This routine is called by the kernel after it has written a | |
40 | * series of characters to the tty device using put_char(). | |
41 | * | |
42 | * int (*write_room)(struct tty_struct *tty); | |
43 | * | |
44 | * This routine returns the numbers of characters the tty driver | |
45 | * will accept for queuing to be written. This number is subject | |
46 | * to change as output buffers get emptied, or if the output flow | |
47 | * control is acted. | |
48 | * | |
49 | * int (*ioctl)(struct tty_struct *tty, struct file * file, | |
50 | * unsigned int cmd, unsigned long arg); | |
51 | * | |
52 | * This routine allows the tty driver to implement | |
53 | * device-specific ioctl's. If the ioctl number passed in cmd | |
54 | * is not recognized by the driver, it should return ENOIOCTLCMD. | |
e10cc1df PF |
55 | * |
56 | * long (*compat_ioctl)(struct tty_struct *tty, struct file * file, | |
57 | * unsigned int cmd, unsigned long arg); | |
58 | * | |
59 | * implement ioctl processing for 32 bit process on 64 bit system | |
1da177e4 | 60 | * |
edc6afc5 | 61 | * void (*set_termios)(struct tty_struct *tty, struct ktermios * old); |
1da177e4 LT |
62 | * |
63 | * This routine allows the tty driver to be notified when | |
64 | * device's termios settings have changed. Note that a | |
65 | * well-designed tty driver should be prepared to accept the case | |
66 | * where old == NULL, and try to do something rational. | |
67 | * | |
68 | * void (*set_ldisc)(struct tty_struct *tty); | |
69 | * | |
70 | * This routine allows the tty driver to be notified when the | |
71 | * device's termios settings have changed. | |
72 | * | |
73 | * void (*throttle)(struct tty_struct * tty); | |
74 | * | |
75 | * This routine notifies the tty driver that input buffers for | |
76 | * the line discipline are close to full, and it should somehow | |
77 | * signal that no more characters should be sent to the tty. | |
78 | * | |
79 | * void (*unthrottle)(struct tty_struct * tty); | |
80 | * | |
81 | * This routine notifies the tty drivers that it should signals | |
82 | * that characters can now be sent to the tty without fear of | |
83 | * overrunning the input buffers of the line disciplines. | |
84 | * | |
85 | * void (*stop)(struct tty_struct *tty); | |
86 | * | |
87 | * This routine notifies the tty driver that it should stop | |
88 | * outputting characters to the tty device. | |
89 | * | |
90 | * void (*start)(struct tty_struct *tty); | |
91 | * | |
92 | * This routine notifies the tty driver that it resume sending | |
93 | * characters to the tty device. | |
94 | * | |
95 | * void (*hangup)(struct tty_struct *tty); | |
96 | * | |
97 | * This routine notifies the tty driver that it should hangup the | |
98 | * tty device. | |
99 | * | |
100 | * void (*break_ctl)(struct tty_stuct *tty, int state); | |
101 | * | |
102 | * This optional routine requests the tty driver to turn on or | |
103 | * off BREAK status on the RS-232 port. If state is -1, | |
104 | * then the BREAK status should be turned on; if state is 0, then | |
105 | * BREAK should be turned off. | |
106 | * | |
107 | * If this routine is implemented, the high-level tty driver will | |
108 | * handle the following ioctls: TCSBRK, TCSBRKP, TIOCSBRK, | |
109 | * TIOCCBRK. Otherwise, these ioctls will be passed down to the | |
110 | * driver to handle. | |
111 | * | |
112 | * void (*wait_until_sent)(struct tty_struct *tty, int timeout); | |
113 | * | |
114 | * This routine waits until the device has written out all of the | |
115 | * characters in its transmitter FIFO. | |
116 | * | |
117 | * void (*send_xchar)(struct tty_struct *tty, char ch); | |
118 | * | |
119 | * This routine is used to send a high-priority XON/XOFF | |
120 | * character to the device. | |
121 | */ | |
122 | ||
123 | #include <linux/fs.h> | |
124 | #include <linux/list.h> | |
125 | #include <linux/cdev.h> | |
126 | ||
127 | struct tty_struct; | |
f2d937f3 | 128 | struct tty_driver; |
1da177e4 LT |
129 | |
130 | struct tty_operations { | |
131 | int (*open)(struct tty_struct * tty, struct file * filp); | |
132 | void (*close)(struct tty_struct * tty, struct file * filp); | |
133 | int (*write)(struct tty_struct * tty, | |
134 | const unsigned char *buf, int count); | |
135 | void (*put_char)(struct tty_struct *tty, unsigned char ch); | |
136 | void (*flush_chars)(struct tty_struct *tty); | |
137 | int (*write_room)(struct tty_struct *tty); | |
138 | int (*chars_in_buffer)(struct tty_struct *tty); | |
139 | int (*ioctl)(struct tty_struct *tty, struct file * file, | |
140 | unsigned int cmd, unsigned long arg); | |
e10cc1df PF |
141 | long (*compat_ioctl)(struct tty_struct *tty, struct file * file, |
142 | unsigned int cmd, unsigned long arg); | |
edc6afc5 | 143 | void (*set_termios)(struct tty_struct *tty, struct ktermios * old); |
1da177e4 LT |
144 | void (*throttle)(struct tty_struct * tty); |
145 | void (*unthrottle)(struct tty_struct * tty); | |
146 | void (*stop)(struct tty_struct *tty); | |
147 | void (*start)(struct tty_struct *tty); | |
148 | void (*hangup)(struct tty_struct *tty); | |
149 | void (*break_ctl)(struct tty_struct *tty, int state); | |
150 | void (*flush_buffer)(struct tty_struct *tty); | |
151 | void (*set_ldisc)(struct tty_struct *tty); | |
152 | void (*wait_until_sent)(struct tty_struct *tty, int timeout); | |
153 | void (*send_xchar)(struct tty_struct *tty, char ch); | |
154 | int (*read_proc)(char *page, char **start, off_t off, | |
155 | int count, int *eof, void *data); | |
156 | int (*write_proc)(struct file *file, const char __user *buffer, | |
157 | unsigned long count, void *data); | |
158 | int (*tiocmget)(struct tty_struct *tty, struct file *file); | |
159 | int (*tiocmset)(struct tty_struct *tty, struct file *file, | |
160 | unsigned int set, unsigned int clear); | |
f2d937f3 JW |
161 | #ifdef CONFIG_CONSOLE_POLL |
162 | int (*poll_init)(struct tty_driver *driver, int line, char *options); | |
163 | int (*poll_get_char)(struct tty_driver *driver, int line); | |
164 | void (*poll_put_char)(struct tty_driver *driver, int line, char ch); | |
165 | #endif | |
1da177e4 LT |
166 | }; |
167 | ||
168 | struct tty_driver { | |
169 | int magic; /* magic number for this structure */ | |
170 | struct cdev cdev; | |
171 | struct module *owner; | |
172 | const char *driver_name; | |
1da177e4 LT |
173 | const char *name; |
174 | int name_base; /* offset of printed name */ | |
175 | int major; /* major device number */ | |
176 | int minor_start; /* start of minor device number */ | |
177 | int minor_num; /* number of *possible* devices */ | |
178 | int num; /* number of devices allocated */ | |
179 | short type; /* type of tty driver */ | |
180 | short subtype; /* subtype of tty driver */ | |
edc6afc5 | 181 | struct ktermios init_termios; /* Initial termios */ |
1da177e4 LT |
182 | int flags; /* tty driver flags */ |
183 | int refcount; /* for loadable tty drivers */ | |
184 | struct proc_dir_entry *proc_entry; /* /proc fs entry */ | |
185 | struct tty_driver *other; /* only used for the PTY driver */ | |
186 | ||
187 | /* | |
188 | * Pointer to the tty data structures | |
189 | */ | |
190 | struct tty_struct **ttys; | |
edc6afc5 AC |
191 | struct ktermios **termios; |
192 | struct ktermios **termios_locked; | |
1da177e4 LT |
193 | void *driver_state; /* only used for the PTY driver */ |
194 | ||
195 | /* | |
196 | * Interface routines from the upper tty layer to the tty | |
197 | * driver. Will be replaced with struct tty_operations. | |
198 | */ | |
199 | int (*open)(struct tty_struct * tty, struct file * filp); | |
200 | void (*close)(struct tty_struct * tty, struct file * filp); | |
201 | int (*write)(struct tty_struct * tty, | |
202 | const unsigned char *buf, int count); | |
203 | void (*put_char)(struct tty_struct *tty, unsigned char ch); | |
204 | void (*flush_chars)(struct tty_struct *tty); | |
205 | int (*write_room)(struct tty_struct *tty); | |
206 | int (*chars_in_buffer)(struct tty_struct *tty); | |
207 | int (*ioctl)(struct tty_struct *tty, struct file * file, | |
208 | unsigned int cmd, unsigned long arg); | |
e10cc1df PF |
209 | long (*compat_ioctl)(struct tty_struct *tty, struct file * file, |
210 | unsigned int cmd, unsigned long arg); | |
edc6afc5 | 211 | void (*set_termios)(struct tty_struct *tty, struct ktermios * old); |
1da177e4 LT |
212 | void (*throttle)(struct tty_struct * tty); |
213 | void (*unthrottle)(struct tty_struct * tty); | |
214 | void (*stop)(struct tty_struct *tty); | |
215 | void (*start)(struct tty_struct *tty); | |
216 | void (*hangup)(struct tty_struct *tty); | |
217 | void (*break_ctl)(struct tty_struct *tty, int state); | |
218 | void (*flush_buffer)(struct tty_struct *tty); | |
219 | void (*set_ldisc)(struct tty_struct *tty); | |
220 | void (*wait_until_sent)(struct tty_struct *tty, int timeout); | |
221 | void (*send_xchar)(struct tty_struct *tty, char ch); | |
222 | int (*read_proc)(char *page, char **start, off_t off, | |
223 | int count, int *eof, void *data); | |
224 | int (*write_proc)(struct file *file, const char __user *buffer, | |
225 | unsigned long count, void *data); | |
226 | int (*tiocmget)(struct tty_struct *tty, struct file *file); | |
227 | int (*tiocmset)(struct tty_struct *tty, struct file *file, | |
228 | unsigned int set, unsigned int clear); | |
f2d937f3 JW |
229 | #ifdef CONFIG_CONSOLE_POLL |
230 | int (*poll_init)(struct tty_driver *driver, int line, char *options); | |
231 | int (*poll_get_char)(struct tty_driver *driver, int line); | |
232 | void (*poll_put_char)(struct tty_driver *driver, int line, char ch); | |
233 | #endif | |
1da177e4 LT |
234 | |
235 | struct list_head tty_drivers; | |
236 | }; | |
237 | ||
238 | extern struct list_head tty_drivers; | |
239 | ||
240 | struct tty_driver *alloc_tty_driver(int lines); | |
241 | void put_tty_driver(struct tty_driver *driver); | |
b68e31d0 JD |
242 | void tty_set_operations(struct tty_driver *driver, |
243 | const struct tty_operations *op); | |
f2d937f3 | 244 | extern struct tty_driver *tty_find_polling_driver(char *name, int *line); |
1da177e4 LT |
245 | |
246 | /* tty driver magic number */ | |
247 | #define TTY_DRIVER_MAGIC 0x5402 | |
248 | ||
249 | /* | |
250 | * tty driver flags | |
251 | * | |
252 | * TTY_DRIVER_RESET_TERMIOS --- requests the tty layer to reset the | |
253 | * termios setting when the last process has closed the device. | |
254 | * Used for PTY's, in particular. | |
255 | * | |
256 | * TTY_DRIVER_REAL_RAW --- if set, indicates that the driver will | |
257 | * guarantee never not to set any special character handling | |
258 | * flags if ((IGNBRK || (!BRKINT && !PARMRK)) && (IGNPAR || | |
259 | * !INPCK)). That is, if there is no reason for the driver to | |
260 | * send notifications of parity and break characters up to the | |
261 | * line driver, it won't do so. This allows the line driver to | |
262 | * optimize for this case if this flag is set. (Note that there | |
263 | * is also a promise, if the above case is true, not to signal | |
264 | * overruns, either.) | |
265 | * | |
331b8319 GKH |
266 | * TTY_DRIVER_DYNAMIC_DEV --- if set, the individual tty devices need |
267 | * to be registered with a call to tty_register_driver() when the | |
268 | * device is found in the system and unregistered with a call to | |
269 | * tty_unregister_device() so the devices will be show up | |
270 | * properly in sysfs. If not set, driver->num entries will be | |
271 | * created by the tty core in sysfs when tty_register_driver() is | |
272 | * called. This is to be used by drivers that have tty devices | |
273 | * that can appear and disappear while the main tty driver is | |
274 | * registered with the tty core. | |
1da177e4 LT |
275 | * |
276 | * TTY_DRIVER_DEVPTS_MEM -- don't use the standard arrays, instead | |
277 | * use dynamic memory keyed through the devpts filesystem. This | |
278 | * is only applicable to the pty driver. | |
279 | */ | |
280 | #define TTY_DRIVER_INSTALLED 0x0001 | |
281 | #define TTY_DRIVER_RESET_TERMIOS 0x0002 | |
282 | #define TTY_DRIVER_REAL_RAW 0x0004 | |
331b8319 | 283 | #define TTY_DRIVER_DYNAMIC_DEV 0x0008 |
1da177e4 LT |
284 | #define TTY_DRIVER_DEVPTS_MEM 0x0010 |
285 | ||
286 | /* tty driver types */ | |
287 | #define TTY_DRIVER_TYPE_SYSTEM 0x0001 | |
288 | #define TTY_DRIVER_TYPE_CONSOLE 0x0002 | |
289 | #define TTY_DRIVER_TYPE_SERIAL 0x0003 | |
290 | #define TTY_DRIVER_TYPE_PTY 0x0004 | |
291 | #define TTY_DRIVER_TYPE_SCC 0x0005 /* scc driver */ | |
292 | #define TTY_DRIVER_TYPE_SYSCONS 0x0006 | |
293 | ||
294 | /* system subtypes (magic, used by tty_io.c) */ | |
295 | #define SYSTEM_TYPE_TTY 0x0001 | |
296 | #define SYSTEM_TYPE_CONSOLE 0x0002 | |
297 | #define SYSTEM_TYPE_SYSCONS 0x0003 | |
298 | #define SYSTEM_TYPE_SYSPTMX 0x0004 | |
299 | ||
300 | /* pty subtypes (magic, used by tty_io.c) */ | |
301 | #define PTY_TYPE_MASTER 0x0001 | |
302 | #define PTY_TYPE_SLAVE 0x0002 | |
303 | ||
304 | /* serial subtype definitions */ | |
305 | #define SERIAL_TYPE_NORMAL 1 | |
306 | ||
307 | #endif /* #ifdef _LINUX_TTY_DRIVER_H */ |