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