xref: /linux/Documentation/driver-api/tty/tty_struct.rst (revision 446279168e030fd0ed68e2bba336bef8bb3da352)
1.. SPDX-License-Identifier: GPL-2.0
2
3==========
4TTY Struct
5==========
6
7.. contents:: :local:
8
9struct tty_struct is allocated by the TTY layer upon the first open of the TTY
10device and released after the last close. The TTY layer passes this structure
11to most of struct tty_operation's hooks. Members of tty_struct are documented
12in `TTY Struct Reference`_ at the bottom.
13
14Initialization
15==============
16
17.. kernel-doc:: drivers/tty/tty_io.c
18   :identifiers: tty_init_termios
19
20Name
21====
22
23.. kernel-doc:: drivers/tty/tty_io.c
24   :identifiers: tty_name
25
26Reference counting
27==================
28
29.. kernel-doc:: include/linux/tty.h
30   :identifiers: tty_kref_get
31
32.. kernel-doc:: drivers/tty/tty_io.c
33   :identifiers: tty_kref_put
34
35Install
36=======
37
38.. kernel-doc:: drivers/tty/tty_io.c
39   :identifiers: tty_standard_install
40
41Read & Write
42============
43
44.. kernel-doc:: drivers/tty/tty_io.c
45   :identifiers: tty_put_char
46
47Start & Stop
48============
49
50.. kernel-doc:: drivers/tty/tty_io.c
51   :identifiers: start_tty stop_tty
52
53Wakeup
54======
55
56.. kernel-doc:: drivers/tty/tty_io.c
57   :identifiers: tty_wakeup
58
59Hangup
60======
61
62.. kernel-doc:: drivers/tty/tty_io.c
63   :identifiers: tty_hangup tty_vhangup tty_hung_up_p
64
65Misc
66====
67
68.. kernel-doc:: drivers/tty/tty_io.c
69   :identifiers: tty_do_resize
70
71TTY Struct Flags
72================
73
74.. kernel-doc:: include/linux/tty.h
75   :doc: TTY Struct Flags
76
77TTY Struct Reference
78====================
79
80.. kernel-doc:: include/linux/tty.h
81   :identifiers: tty_struct
82