mirror of
git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2025-08-05 16:54:27 +00:00
a72f418703
Convert TTY_* macros (flags) to an enum. This allows for easier kernel-doc (the comment needed fine tuning), grouping of these nicely, and proper checking. Note that these are bit positions. So they are used such as test_bit(TTY_THROTTLED, ...). Given these are not the user API (only in-kernel API/ABI), the bit positions are NOT preserved in this patch. All are renumbered naturally using the enum-auto-numbering. Signed-off-by: Jiri Slaby (SUSE) <jirislaby@kernel.org> Link: https://lore.kernel.org/r/20250317070046.24386-2-jirislaby@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
81 lines
1.5 KiB
ReStructuredText
81 lines
1.5 KiB
ReStructuredText
.. SPDX-License-Identifier: GPL-2.0
|
|
|
|
==========
|
|
TTY Struct
|
|
==========
|
|
|
|
.. contents:: :local:
|
|
|
|
struct tty_struct is allocated by the TTY layer upon the first open of the TTY
|
|
device and released after the last close. The TTY layer passes this structure
|
|
to most of struct tty_operation's hooks. Members of tty_struct are documented
|
|
in `TTY Struct Reference`_ at the bottom.
|
|
|
|
Initialization
|
|
==============
|
|
|
|
.. kernel-doc:: drivers/tty/tty_io.c
|
|
:identifiers: tty_init_termios
|
|
|
|
Name
|
|
====
|
|
|
|
.. kernel-doc:: drivers/tty/tty_io.c
|
|
:identifiers: tty_name
|
|
|
|
Reference counting
|
|
==================
|
|
|
|
.. kernel-doc:: include/linux/tty.h
|
|
:identifiers: tty_kref_get
|
|
|
|
.. kernel-doc:: drivers/tty/tty_io.c
|
|
:identifiers: tty_kref_put
|
|
|
|
Install
|
|
=======
|
|
|
|
.. kernel-doc:: drivers/tty/tty_io.c
|
|
:identifiers: tty_standard_install
|
|
|
|
Read & Write
|
|
============
|
|
|
|
.. kernel-doc:: drivers/tty/tty_io.c
|
|
:identifiers: tty_put_char
|
|
|
|
Start & Stop
|
|
============
|
|
|
|
.. kernel-doc:: drivers/tty/tty_io.c
|
|
:identifiers: start_tty stop_tty
|
|
|
|
Wakeup
|
|
======
|
|
|
|
.. kernel-doc:: drivers/tty/tty_io.c
|
|
:identifiers: tty_wakeup
|
|
|
|
Hangup
|
|
======
|
|
|
|
.. kernel-doc:: drivers/tty/tty_io.c
|
|
:identifiers: tty_hangup tty_vhangup tty_hung_up_p
|
|
|
|
Misc
|
|
====
|
|
|
|
.. kernel-doc:: drivers/tty/tty_io.c
|
|
:identifiers: tty_do_resize
|
|
|
|
TTY Struct Flags
|
|
================
|
|
|
|
.. kernel-doc:: include/linux/tty.h
|
|
:identifiers: tty_struct_flags
|
|
|
|
TTY Struct Reference
|
|
====================
|
|
|
|
.. kernel-doc:: include/linux/tty.h
|
|
:identifiers: tty_struct
|