1.. SPDX-License-Identifier: GPL-2.0
2
3========
4TTY Port
5========
6
7.. contents:: :local:
8
9The TTY drivers are advised to use struct tty_port helpers as much as possible.
10If the drivers implement :c:member:`tty_port.ops.activate()` and
11:c:member:`tty_port.ops.shutdown()`, they can use tty_port_open(),
12tty_port_close(), and tty_port_hangup() in respective
13:c:member:`tty_struct.ops` hooks.
14
15The reference and details are contained in the `TTY Port Reference`_ and `TTY
16Port Operations Reference`_ sections at the bottom.
17
18TTY Port Functions
19==================
20
21Init & Destroy
22--------------
23
24.. kernel-doc::  drivers/tty/tty_port.c
25   :identifiers: tty_port_init tty_port_destroy
26        tty_port_get tty_port_put
27
28Open/Close/Hangup Helpers
29-------------------------
30
31.. kernel-doc::  drivers/tty/tty_port.c
32   :identifiers: tty_port_install tty_port_open tty_port_block_til_ready
33        tty_port_close tty_port_close_start tty_port_close_end tty_port_hangup
34        tty_port_shutdown
35
36TTY Refcounting
37---------------
38
39.. kernel-doc::  drivers/tty/tty_port.c
40   :identifiers: tty_port_tty_get tty_port_tty_set
41
42TTY Helpers
43-----------
44
45.. kernel-doc::  include/linux/tty_port.h
46   :identifiers: tty_port_tty_hangup tty_port_tty_vhangup
47.. kernel-doc::  drivers/tty/tty_port.c
48   :identifiers: tty_port_tty_wakeup
49
50Modem Signals
51-------------
52
53.. kernel-doc::  drivers/tty/tty_port.c
54   :identifiers: tty_port_carrier_raised tty_port_raise_dtr_rts
55        tty_port_lower_dtr_rts
56
57----
58
59TTY Port Reference
60==================
61
62.. kernel-doc:: include/linux/tty_port.h
63   :identifiers: tty_port
64
65----
66
67TTY Port Operations Reference
68=============================
69
70.. kernel-doc:: include/linux/tty_port.h
71   :identifiers: tty_port_operations
72