1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_TTY_DRIVER_H
3 #define _LINUX_TTY_DRIVER_H
5 #include <linux/export.h>
7 #include <linux/kref.h>
8 #include <linux/list.h>
9 #include <linux/cdev.h>
10 #include <linux/uaccess.h>
11 #include <linux/termios.h>
12 #include <linux/seq_file.h>
16 struct serial_icounter_struct;
20 * struct tty_operations -- interface between driver and tty
22 * @lookup: ``struct tty_struct *()(struct tty_driver *self, struct file *,
25 * Return the tty device corresponding to @idx, %NULL if there is not
26 * one currently in use and an %ERR_PTR value on error. Called under
27 * %tty_mutex (for now!)
29 * Optional method. Default behaviour is to use the @self->ttys array.
31 * @install: ``int ()(struct tty_driver *self, struct tty_struct *tty)``
33 * Install a new @tty into the @self's internal tables. Used in
34 * conjunction with @lookup and @remove methods.
36 * Optional method. Default behaviour is to use the @self->ttys array.
38 * @remove: ``void ()(struct tty_driver *self, struct tty_struct *tty)``
40 * Remove a closed @tty from the @self's internal tables. Used in
41 * conjunction with @lookup and @remove methods.
43 * Optional method. Default behaviour is to use the @self->ttys array.
45 * @open: ``int ()(struct tty_struct *tty, struct file *)``
47 * This routine is called when a particular @tty device is opened. This
48 * routine is mandatory; if this routine is not filled in, the attempted
49 * open will fail with %ENODEV.
51 * Required method. Called with tty lock held. May sleep.
53 * @close: ``void ()(struct tty_struct *tty, struct file *)``
55 * This routine is called when a particular @tty device is closed. At the
56 * point of return from this call the driver must make no further ldisc
59 * Remark: called even if the corresponding @open() failed.
61 * Required method. Called with tty lock held. May sleep.
63 * @shutdown: ``void ()(struct tty_struct *tty)``
65 * This routine is called under the tty lock when a particular @tty device
66 * is closed for the last time. It executes before the @tty resources
67 * are freed so may execute while another function holds a @tty kref.
69 * @cleanup: ``void ()(struct tty_struct *tty)``
71 * This routine is called asynchronously when a particular @tty device
72 * is closed for the last time freeing up the resources. This is
73 * actually the second part of shutdown for routines that might sleep.
75 * @write: ``ssize_t ()(struct tty_struct *tty, const u8 *buf, size_t count)``
77 * This routine is called by the kernel to write a series (@count) of
78 * characters (@buf) to the @tty device. The characters may come from
79 * user space or kernel space. This routine will return the
80 * number of characters actually accepted for writing.
82 * May occur in parallel in special cases. Because this includes panic
83 * paths drivers generally shouldn't try and do clever locking here.
85 * Optional: Required for writable devices. May not sleep.
87 * @put_char: ``int ()(struct tty_struct *tty, u8 ch)``
89 * This routine is called by the kernel to write a single character @ch to
90 * the @tty device. If the kernel uses this routine, it must call the
91 * @flush_chars() routine (if defined) when it is done stuffing characters
92 * into the driver. If there is no room in the queue, the character is
95 * Optional: Kernel will use the @write method if not provided. Do not
96 * call this function directly, call tty_put_char().
98 * @flush_chars: ``void ()(struct tty_struct *tty)``
100 * This routine is called by the kernel after it has written a
101 * series of characters to the tty device using @put_char().
103 * Optional. Do not call this function directly, call
104 * tty_driver_flush_chars().
106 * @write_room: ``unsigned int ()(struct tty_struct *tty)``
108 * This routine returns the numbers of characters the @tty driver
109 * will accept for queuing to be written. This number is subject
110 * to change as output buffers get emptied, or if the output flow
113 * The ldisc is responsible for being intelligent about multi-threading of
114 * write_room/write calls
116 * Required if @write method is provided else not needed. Do not call this
117 * function directly, call tty_write_room()
119 * @chars_in_buffer: ``unsigned int ()(struct tty_struct *tty)``
121 * This routine returns the number of characters in the device private
122 * output queue. Used in tty_wait_until_sent() and for poll()
125 * Optional: if not provided, it is assumed there is no queue on the
126 * device. Do not call this function directly, call tty_chars_in_buffer().
128 * @ioctl: ``int ()(struct tty_struct *tty, unsigned int cmd,
129 * unsigned long arg)``
131 * This routine allows the @tty driver to implement device-specific
132 * ioctls. If the ioctl number passed in @cmd is not recognized by the
133 * driver, it should return %ENOIOCTLCMD.
137 * @compat_ioctl: ``long ()(struct tty_struct *tty, unsigned int cmd,
138 * unsigned long arg)``
140 * Implement ioctl processing for 32 bit process on 64 bit system.
144 * @set_termios: ``void ()(struct tty_struct *tty, const struct ktermios *old)``
146 * This routine allows the @tty driver to be notified when device's
147 * termios settings have changed. New settings are in @tty->termios.
148 * Previous settings are passed in the @old argument.
150 * The API is defined such that the driver should return the actual modes
151 * selected. This means that the driver is responsible for modifying any
152 * bits in @tty->termios it cannot fulfill to indicate the actual modes
155 * Optional. Called under the @tty->termios_rwsem. May sleep.
157 * @set_ldisc: ``void ()(struct tty_struct *tty)``
159 * This routine allows the @tty driver to be notified when the device's
160 * line discipline is being changed. At the point this is done the
161 * discipline is not yet usable.
163 * Optional. Called under the @tty->ldisc_sem and @tty->termios_rwsem.
165 * @throttle: ``void ()(struct tty_struct *tty)``
167 * This routine notifies the @tty driver that input buffers for the line
168 * discipline are close to full, and it should somehow signal that no more
169 * characters should be sent to the @tty.
171 * Serialization including with @unthrottle() is the job of the ldisc
174 * Optional: Always invoke via tty_throttle_safe(). Called under the
175 * @tty->termios_rwsem.
177 * @unthrottle: ``void ()(struct tty_struct *tty)``
179 * This routine notifies the @tty driver that it should signal that
180 * characters can now be sent to the @tty without fear of overrunning the
181 * input buffers of the line disciplines.
183 * Optional. Always invoke via tty_unthrottle(). Called under the
184 * @tty->termios_rwsem.
186 * @stop: ``void ()(struct tty_struct *tty)``
188 * This routine notifies the @tty driver that it should stop outputting
189 * characters to the tty device.
191 * Called with @tty->flow.lock held. Serialized with @start() method.
193 * Optional. Always invoke via stop_tty().
195 * @start: ``void ()(struct tty_struct *tty)``
197 * This routine notifies the @tty driver that it resumed sending
198 * characters to the @tty device.
200 * Called with @tty->flow.lock held. Serialized with stop() method.
202 * Optional. Always invoke via start_tty().
204 * @hangup: ``void ()(struct tty_struct *tty)``
206 * This routine notifies the @tty driver that it should hang up the @tty
209 * Optional. Called with tty lock held.
211 * @break_ctl: ``int ()(struct tty_struct *tty, int state)``
213 * This optional routine requests the @tty driver to turn on or off BREAK
214 * status on the RS-232 port. If @state is -1, then the BREAK status
215 * should be turned on; if @state is 0, then BREAK should be turned off.
217 * If this routine is implemented, the high-level tty driver will handle
218 * the following ioctls: %TCSBRK, %TCSBRKP, %TIOCSBRK, %TIOCCBRK.
220 * If the driver sets %TTY_DRIVER_HARDWARE_BREAK in tty_alloc_driver(),
221 * then the interface will also be called with actual times and the
222 * hardware is expected to do the delay work itself. 0 and -1 are still
225 * Optional: Required for %TCSBRK/%BRKP/etc. handling. May sleep.
227 * @flush_buffer: ``void ()(struct tty_struct *tty)``
229 * This routine discards device private output buffer. Invoked on close,
230 * hangup, to implement %TCOFLUSH ioctl and similar.
232 * Optional: if not provided, it is assumed there is no queue on the
233 * device. Do not call this function directly, call
234 * tty_driver_flush_buffer().
236 * @wait_until_sent: ``void ()(struct tty_struct *tty, int timeout)``
238 * This routine waits until the device has written out all of the
239 * characters in its transmitter FIFO. Or until @timeout (in jiffies) is
242 * Optional: If not provided, the device is assumed to have no FIFO.
243 * Usually correct to invoke via tty_wait_until_sent(). May sleep.
245 * @send_xchar: ``void ()(struct tty_struct *tty, u8 ch)``
247 * This routine is used to send a high-priority XON/XOFF character (@ch)
248 * to the @tty device.
250 * Optional: If not provided, then the @write method is called under
251 * the @tty->atomic_write_lock to keep it serialized with the ldisc.
253 * @tiocmget: ``int ()(struct tty_struct *tty)``
255 * This routine is used to obtain the modem status bits from the @tty
258 * Optional: If not provided, then %ENOTTY is returned from the %TIOCMGET
259 * ioctl. Do not call this function directly, call tty_tiocmget().
261 * @tiocmset: ``int ()(struct tty_struct *tty,
262 * unsigned int set, unsigned int clear)``
264 * This routine is used to set the modem status bits to the @tty driver.
265 * First, @clear bits should be cleared, then @set bits set.
267 * Optional: If not provided, then %ENOTTY is returned from the %TIOCMSET
268 * ioctl. Do not call this function directly, call tty_tiocmset().
270 * @resize: ``int ()(struct tty_struct *tty, struct winsize *ws)``
272 * Called when a termios request is issued which changes the requested
273 * terminal geometry to @ws.
275 * Optional: the default action is to update the termios structure
276 * without error. This is usually the correct behaviour. Drivers should
277 * not force errors here if they are not resizable objects (e.g. a serial
278 * line). See tty_do_resize() if you need to wrap the standard method
279 * in your own logic -- the usual case.
281 * @get_icount: ``int ()(struct tty_struct *tty,
282 * struct serial_icounter *icount)``
284 * Called when the @tty device receives a %TIOCGICOUNT ioctl. Passed a
285 * kernel structure @icount to complete.
287 * Optional: called only if provided, otherwise %ENOTTY will be returned.
289 * @get_serial: ``int ()(struct tty_struct *tty, struct serial_struct *p)``
291 * Called when the @tty device receives a %TIOCGSERIAL ioctl. Passed a
292 * kernel structure @p (&struct serial_struct) to complete.
294 * Optional: called only if provided, otherwise %ENOTTY will be returned.
295 * Do not call this function directly, call tty_tiocgserial().
297 * @set_serial: ``int ()(struct tty_struct *tty, struct serial_struct *p)``
299 * Called when the @tty device receives a %TIOCSSERIAL ioctl. Passed a
300 * kernel structure @p (&struct serial_struct) to set the values from.
302 * Optional: called only if provided, otherwise %ENOTTY will be returned.
303 * Do not call this function directly, call tty_tiocsserial().
305 * @show_fdinfo: ``void ()(struct tty_struct *tty, struct seq_file *m)``
307 * Called when the @tty device file descriptor receives a fdinfo request
308 * from VFS (to show in /proc/<pid>/fdinfo/). @m should be filled with
311 * Optional: called only if provided, otherwise nothing is written to @m.
312 * Do not call this function directly, call tty_show_fdinfo().
314 * @poll_init: ``int ()(struct tty_driver *driver, int line, char *options)``
316 * kgdboc support (Documentation/dev-tools/kgdb.rst). This routine is
317 * called to initialize the HW for later use by calling @poll_get_char or
320 * Optional: called only if provided, otherwise skipped as a non-polling
323 * @poll_get_char: ``int ()(struct tty_driver *driver, int line)``
325 * kgdboc support (see @poll_init). @driver should read a character from a
326 * tty identified by @line and return it.
328 * Optional: called only if @poll_init provided.
330 * @poll_put_char: ``void ()(struct tty_driver *driver, int line, char ch)``
332 * kgdboc support (see @poll_init). @driver should write character @ch to
333 * a tty identified by @line.
335 * Optional: called only if @poll_init provided.
337 * @proc_show: ``int ()(struct seq_file *m, void *driver)``
339 * Driver @driver (cast to &struct tty_driver) can show additional info in
340 * /proc/tty/driver/<driver_name>. It is enough to fill in the information
343 * Optional: called only if provided, otherwise no /proc entry created.
345 * This structure defines the interface between the low-level tty driver and
346 * the tty routines. These routines can be defined. Unless noted otherwise,
347 * they are optional, and can be filled in with a %NULL pointer.
349 struct tty_operations {
350 struct tty_struct * (*lookup)(struct tty_driver *driver,
351 struct file *filp, int idx);
352 int (*install)(struct tty_driver *driver, struct tty_struct *tty);
353 void (*remove)(struct tty_driver *driver, struct tty_struct *tty);
354 int (*open)(struct tty_struct * tty, struct file * filp);
355 void (*close)(struct tty_struct * tty, struct file * filp);
356 void (*shutdown)(struct tty_struct *tty);
357 void (*cleanup)(struct tty_struct *tty);
358 ssize_t (*write)(struct tty_struct *tty, const u8 *buf, size_t count);
359 int (*put_char)(struct tty_struct *tty, u8 ch);
360 void (*flush_chars)(struct tty_struct *tty);
361 unsigned int (*write_room)(struct tty_struct *tty);
362 unsigned int (*chars_in_buffer)(struct tty_struct *tty);
363 int (*ioctl)(struct tty_struct *tty,
364 unsigned int cmd, unsigned long arg);
365 long (*compat_ioctl)(struct tty_struct *tty,
366 unsigned int cmd, unsigned long arg);
367 void (*set_termios)(struct tty_struct *tty, const struct ktermios *old);
368 void (*throttle)(struct tty_struct * tty);
369 void (*unthrottle)(struct tty_struct * tty);
370 void (*stop)(struct tty_struct *tty);
371 void (*start)(struct tty_struct *tty);
372 void (*hangup)(struct tty_struct *tty);
373 int (*break_ctl)(struct tty_struct *tty, int state);
374 void (*flush_buffer)(struct tty_struct *tty);
375 void (*set_ldisc)(struct tty_struct *tty);
376 void (*wait_until_sent)(struct tty_struct *tty, int timeout);
377 void (*send_xchar)(struct tty_struct *tty, u8 ch);
378 int (*tiocmget)(struct tty_struct *tty);
379 int (*tiocmset)(struct tty_struct *tty,
380 unsigned int set, unsigned int clear);
381 int (*resize)(struct tty_struct *tty, struct winsize *ws);
382 int (*get_icount)(struct tty_struct *tty,
383 struct serial_icounter_struct *icount);
384 int (*get_serial)(struct tty_struct *tty, struct serial_struct *p);
385 int (*set_serial)(struct tty_struct *tty, struct serial_struct *p);
386 void (*show_fdinfo)(struct tty_struct *tty, struct seq_file *m);
387 #ifdef CONFIG_CONSOLE_POLL
388 int (*poll_init)(struct tty_driver *driver, int line, char *options);
389 int (*poll_get_char)(struct tty_driver *driver, int line);
390 void (*poll_put_char)(struct tty_driver *driver, int line, char ch);
392 int (*proc_show)(struct seq_file *m, void *driver);
393 } __randomize_layout;
396 * struct tty_driver -- driver for TTY devices
398 * @kref: reference counting. Reaching zero frees all the internals and the
400 * @cdevs: allocated/registered character /dev devices
401 * @owner: modules owning this driver. Used drivers cannot be rmmod'ed.
402 * Automatically set by tty_alloc_driver().
403 * @driver_name: name of the driver used in /proc/tty
404 * @name: used for constructing /dev node name
405 * @name_base: used as a number base for constructing /dev node name
406 * @major: major /dev device number (zero for autoassignment)
407 * @minor_start: the first minor /dev device number
408 * @num: number of devices allocated
409 * @type: type of tty driver (%TTY_DRIVER_TYPE_)
410 * @subtype: subtype of tty driver (%SYSTEM_TYPE_, %PTY_TYPE_, %SERIAL_TYPE_)
411 * @init_termios: termios to set to each tty initially (e.g. %tty_std_termios)
412 * @flags: tty driver flags (%TTY_DRIVER_)
413 * @proc_entry: proc fs entry, used internally
414 * @other: driver of the linked tty; only used for the PTY driver
415 * @ttys: array of active &struct tty_struct, set by tty_standard_install()
416 * @ports: array of &struct tty_port; can be set during initialization by
417 * tty_port_link_device() and similar
418 * @termios: storage for termios at each TTY close for the next open
419 * @driver_state: pointer to driver's arbitrary data
420 * @ops: driver hooks for TTYs. Set them using tty_set_operations(). Use &struct
421 * tty_port helpers in them as much as possible.
422 * @tty_drivers: used internally to link tty_drivers together
424 * The usual handling of &struct tty_driver is to allocate it by
425 * tty_alloc_driver(), set up all the necessary members, and register it by
426 * tty_register_driver(). At last, the driver is torn down by calling
427 * tty_unregister_driver() followed by tty_driver_kref_put().
429 * The fields required to be set before calling tty_register_driver() include
430 * @driver_name, @name, @type, @subtype, @init_termios, and @ops.
435 struct module *owner;
436 const char *driver_name;
444 struct ktermios init_termios;
446 struct proc_dir_entry *proc_entry;
447 struct tty_driver *other;
450 * Pointer to the tty data structures
452 struct tty_struct **ttys;
453 struct tty_port **ports;
454 struct ktermios **termios;
461 const struct tty_operations *ops;
462 struct list_head tty_drivers;
463 } __randomize_layout;
465 extern struct list_head tty_drivers;
467 struct tty_driver *__tty_alloc_driver(unsigned int lines, struct module *owner,
468 unsigned long flags);
469 struct tty_driver *tty_find_polling_driver(char *name, int *line);
471 void tty_driver_kref_put(struct tty_driver *driver);
473 /* Use TTY_DRIVER_* flags below */
474 #define tty_alloc_driver(lines, flags) \
475 __tty_alloc_driver(lines, THIS_MODULE, flags)
477 static inline struct tty_driver *tty_driver_kref_get(struct tty_driver *d)
483 static inline void tty_set_operations(struct tty_driver *driver,
484 const struct tty_operations *op)
490 * DOC: TTY Driver Flags
492 * TTY_DRIVER_RESET_TERMIOS
493 * Requests the tty layer to reset the termios setting when the last
494 * process has closed the device. Used for PTYs, in particular.
496 * TTY_DRIVER_REAL_RAW
497 * Indicates that the driver will guarantee not to set any special
498 * character handling flags if this is set for the tty:
500 * ``(IGNBRK || (!BRKINT && !PARMRK)) && (IGNPAR || !INPCK)``
502 * That is, if there is no reason for the driver to
503 * send notifications of parity and break characters up to the line
504 * driver, it won't do so. This allows the line driver to optimize for
505 * this case if this flag is set. (Note that there is also a promise, if
506 * the above case is true, not to signal overruns, either.)
508 * TTY_DRIVER_DYNAMIC_DEV
509 * The individual tty devices need to be registered with a call to
510 * tty_register_device() when the device is found in the system and
511 * unregistered with a call to tty_unregister_device() so the devices will
512 * be show up properly in sysfs. If not set, all &tty_driver.num entries
513 * will be created by the tty core in sysfs when tty_register_driver() is
514 * called. This is to be used by drivers that have tty devices that can
515 * appear and disappear while the main tty driver is registered with the
518 * TTY_DRIVER_DEVPTS_MEM
519 * Don't use the standard arrays (&tty_driver.ttys and
520 * &tty_driver.termios), instead use dynamic memory keyed through the
521 * devpts filesystem. This is only applicable to the PTY driver.
523 * TTY_DRIVER_HARDWARE_BREAK
524 * Hardware handles break signals. Pass the requested timeout to the
525 * &tty_operations.break_ctl instead of using a simple on/off interface.
527 * TTY_DRIVER_DYNAMIC_ALLOC
528 * Do not allocate structures which are needed per line for this driver
529 * (&tty_driver.ports) as it would waste memory. The driver will take
530 * care. This is only applicable to the PTY driver.
532 * TTY_DRIVER_UNNUMBERED_NODE
533 * Do not create numbered ``/dev`` nodes. For example, create
534 * ``/dev/ttyprintk`` and not ``/dev/ttyprintk0``. Applicable only when a
535 * driver for a single tty device is being allocated.
537 #define TTY_DRIVER_INSTALLED 0x0001
538 #define TTY_DRIVER_RESET_TERMIOS 0x0002
539 #define TTY_DRIVER_REAL_RAW 0x0004
540 #define TTY_DRIVER_DYNAMIC_DEV 0x0008
541 #define TTY_DRIVER_DEVPTS_MEM 0x0010
542 #define TTY_DRIVER_HARDWARE_BREAK 0x0020
543 #define TTY_DRIVER_DYNAMIC_ALLOC 0x0040
544 #define TTY_DRIVER_UNNUMBERED_NODE 0x0080
546 /* tty driver types */
547 #define TTY_DRIVER_TYPE_SYSTEM 0x0001
548 #define TTY_DRIVER_TYPE_CONSOLE 0x0002
549 #define TTY_DRIVER_TYPE_SERIAL 0x0003
550 #define TTY_DRIVER_TYPE_PTY 0x0004
551 #define TTY_DRIVER_TYPE_SCC 0x0005 /* scc driver */
552 #define TTY_DRIVER_TYPE_SYSCONS 0x0006
554 /* system subtypes (magic, used by tty_io.c) */
555 #define SYSTEM_TYPE_TTY 0x0001
556 #define SYSTEM_TYPE_CONSOLE 0x0002
557 #define SYSTEM_TYPE_SYSCONS 0x0003
558 #define SYSTEM_TYPE_SYSPTMX 0x0004
560 /* pty subtypes (magic, used by tty_io.c) */
561 #define PTY_TYPE_MASTER 0x0001
562 #define PTY_TYPE_SLAVE 0x0002
564 /* serial subtype definitions */
565 #define SERIAL_TYPE_NORMAL 1
567 int tty_register_driver(struct tty_driver *driver);
568 void tty_unregister_driver(struct tty_driver *driver);
569 struct device *tty_register_device(struct tty_driver *driver, unsigned index,
571 struct device *tty_register_device_attr(struct tty_driver *driver,
572 unsigned index, struct device *device, void *drvdata,
573 const struct attribute_group **attr_grp);
574 void tty_unregister_device(struct tty_driver *driver, unsigned index);
576 #ifdef CONFIG_PROC_FS
577 void proc_tty_register_driver(struct tty_driver *);
578 void proc_tty_unregister_driver(struct tty_driver *);
580 static inline void proc_tty_register_driver(struct tty_driver *d) {}
581 static inline void proc_tty_unregister_driver(struct tty_driver *d) {}
584 #endif /* #ifdef _LINUX_TTY_DRIVER_H */