0001 .. SPDX-License-Identifier: GPL-2.0
0002
0003 ==========
0004 TTY Struct
0005 ==========
0006
0007 .. contents:: :local:
0008
0009 struct tty_struct is allocated by the TTY layer upon the first open of the TTY
0010 device and released after the last close. The TTY layer passes this structure
0011 to most of struct tty_operation's hooks. Members of tty_struct are documented
0012 in `TTY Struct Reference`_ at the bottom.
0013
0014 Initialization
0015 ==============
0016
0017 .. kernel-doc:: drivers/tty/tty_io.c
0018 :identifiers: tty_init_termios
0019
0020 Name
0021 ====
0022
0023 .. kernel-doc:: drivers/tty/tty_io.c
0024 :identifiers: tty_name
0025
0026 Reference counting
0027 ==================
0028
0029 .. kernel-doc:: include/linux/tty.h
0030 :identifiers: tty_kref_get
0031
0032 .. kernel-doc:: drivers/tty/tty_io.c
0033 :identifiers: tty_kref_put
0034
0035 Install
0036 =======
0037
0038 .. kernel-doc:: drivers/tty/tty_io.c
0039 :identifiers: tty_standard_install
0040
0041 Read & Write
0042 ============
0043
0044 .. kernel-doc:: drivers/tty/tty_io.c
0045 :identifiers: tty_put_char
0046
0047 Start & Stop
0048 ============
0049
0050 .. kernel-doc:: drivers/tty/tty_io.c
0051 :identifiers: start_tty stop_tty
0052
0053 Wakeup
0054 ======
0055
0056 .. kernel-doc:: drivers/tty/tty_io.c
0057 :identifiers: tty_wakeup
0058
0059 Hangup
0060 ======
0061
0062 .. kernel-doc:: drivers/tty/tty_io.c
0063 :identifiers: tty_hangup tty_vhangup tty_hung_up_p
0064
0065 Misc
0066 ====
0067
0068 .. kernel-doc:: drivers/tty/tty_io.c
0069 :identifiers: tty_do_resize
0070
0071 TTY Struct Flags
0072 ================
0073
0074 .. kernel-doc:: include/linux/tty.h
0075 :doc: TTY Struct Flags
0076
0077 TTY Struct Reference
0078 ====================
0079
0080 .. kernel-doc:: include/linux/tty.h
0081 :identifiers: tty_struct
